1/*	$NetBSD: util.h,v 1.69 2016/04/10 19:05:50 roy Exp $	*/
2
3/*-
4 * Copyright (c) 1995
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 *    may be used to endorse or promote products derived from this software
17 *    without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _UTIL_H_
33#define	_UTIL_H_
34
35#include <sys/cdefs.h>
36#include <sys/types.h>
37#include <sys/ansi.h>
38#include <sys/inttypes.h>
39
40#ifdef  _BSD_TIME_T_
41typedef _BSD_TIME_T_    time_t;
42#undef  _BSD_TIME_T_
43#endif
44#ifdef  _BSD_SIZE_T_
45typedef _BSD_SIZE_T_    size_t;
46#undef  _BSD_SIZE_T_
47#endif
48
49#if defined(_POSIX_C_SOURCE)
50#ifndef __VA_LIST_DECLARED
51typedef __va_list va_list;
52#define __VA_LIST_DECLARED
53#endif
54#endif
55
56#define	PIDLOCK_NONBLOCK	1
57#define	PIDLOCK_USEHOSTNAME	2
58
59#define	PW_POLICY_BYSTRING	0
60#define	PW_POLICY_BYPASSWD	1
61#define	PW_POLICY_BYGROUP	2
62
63__BEGIN_DECLS
64struct disklabel;
65struct iovec;
66struct passwd;
67struct termios;
68struct utmp;
69struct utmpx;
70struct winsize;
71struct sockaddr;
72
73char	       *flags_to_string(unsigned long, const char *);
74pid_t		forkpty(int *, char *, struct termios *, struct winsize *);
75const char     *getbootfile(void);
76int		getbyteorder(void);
77off_t		getlabeloffset(void);
78int		getlabelsector(void);
79int		getlabelusesmbr(void);
80int		getmaxpartitions(void);
81int		getrawpartition(void);
82const char     *getdiskrawname(char *, size_t, const char *);
83const char     *getdiskcookedname(char *, size_t, const char *);
84const char     *getfstypename(int);
85const char     *getfsspecname(char *, size_t, const char *);
86struct kinfo_vmentry *kinfo_getvmmap(pid_t, size_t *);
87#ifndef __LIBC12_SOURCE__
88void		login(const struct utmp *) __RENAME(__login50);
89void		loginx(const struct utmpx *) __RENAME(__loginx50);
90#endif
91int		login_tty(int);
92int		logout(const char *);
93int		logoutx(const char *, int, int);
94void		logwtmp(const char *, const char *, const char *);
95void		logwtmpx(const char *, const char *, const char *, int, int);
96int		opendisk(const char *, int, char *, size_t, int);
97int		opendisk1(const char *, int, char *, size_t, int,
98			  int (*)(const char *, int, ...));
99int		openpty(int *, int *, char *, struct termios *,
100    struct winsize *);
101#ifndef __LIBC12_SOURCE__
102time_t		parsedate(const char *, const time_t *, const int *)
103    __RENAME(__parsedate50);
104#endif
105int		pidfile(const char *);
106pid_t		pidfile_lock(const char *);
107pid_t		pidfile_read(const char *);
108int		pidfile_clean(void);
109int		pidlock(const char *, int, pid_t *, const char *);
110int		pw_abort(void);
111#ifndef __LIBC12_SOURCE__
112void		pw_copy(int, int, struct passwd *, struct passwd *)
113    __RENAME(__pw_copy50);
114int		pw_copyx(int, int, struct passwd *, struct passwd *,
115    char *, size_t) __RENAME(__pw_copyx50);
116#endif
117void		pw_edit(int, const char *);
118__dead void	pw_error(const char *, int, int);
119void		pw_getconf(char *, size_t, const char *, const char *);
120#ifndef __LIBC12_SOURCE__
121void		pw_getpwconf(char *, size_t, const struct passwd *,
122    const char *) __RENAME(__pw_getpwconf50);
123#endif
124const char     *pw_getprefix(void);
125void		pw_init(void);
126int		pw_lock(int);
127int		pw_mkdb(const char *, int);
128void		pw_prompt(void);
129int		pw_setprefix(const char *);
130int		raise_default_signal(int);
131int		secure_path(const char *);
132int		snprintb_m(char *, size_t, const char *, uint64_t, size_t);
133int		snprintb(char *, size_t, const char *, uint64_t);
134int		sockaddr_snprintf(char *, size_t, const char *,
135    const struct sockaddr *);
136char 	       *strpct(char *, size_t, uintmax_t, uintmax_t, size_t);
137char 	       *strspct(char *, size_t, intmax_t, intmax_t, size_t);
138int		string_to_flags(char **, unsigned long *, unsigned long *);
139int		ttyaction(const char *, const char *, const char *);
140int		ttylock(const char *, int, pid_t *);
141char	       *ttymsg(struct iovec *, int, const char *, int);
142int		ttyunlock(const char *);
143
144uint16_t	disklabel_dkcksum(struct disklabel *);
145int		disklabel_scan(struct disklabel *, char *, size_t);
146
147/* Error checked functions */
148void		(*esetfunc(void (*)(int, const char *, ...)))
149    (int, const char *, ...);
150size_t 		estrlcpy(char *, const char *, size_t);
151size_t 		estrlcat(char *, const char *, size_t);
152char 		*estrdup(const char *);
153char 		*estrndup(const char *, size_t);
154intmax_t	estrtoi(const char *, int, intmax_t, intmax_t);
155uintmax_t	estrtou(const char *, int, uintmax_t, uintmax_t);
156void 		*ecalloc(size_t, size_t);
157void 		*emalloc(size_t);
158void 		*erealloc(void *, size_t);
159void 		ereallocarr(void *, size_t, size_t);
160struct __sFILE	*efopen(const char *, const char *);
161int	 	easprintf(char ** __restrict, const char * __restrict, ...)
162			__printflike(2, 3);
163int		evasprintf(char ** __restrict, const char * __restrict,
164    __va_list) __printflike(2, 0);
165__END_DECLS
166
167#endif /* !_UTIL_H_ */
168