xref: /netbsd-src/include/util.h (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1 /*	$NetBSD: util.h,v 1.55 2010/02/25 18:37:12 joerg 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/ttycom.h>
37 #include <sys/types.h>
38 #include <stdio.h>
39 #include <pwd.h>
40 #include <termios.h>
41 #include <utmp.h>
42 #include <utmpx.h>
43 #include <machine/ansi.h>
44 
45 #ifdef  _BSD_TIME_T_
46 typedef _BSD_TIME_T_    time_t;
47 #undef  _BSD_TIME_T_
48 #endif
49 
50 #define	PIDLOCK_NONBLOCK	1
51 #define	PIDLOCK_USEHOSTNAME	2
52 
53 #define	PW_POLICY_BYSTRING	0
54 #define	PW_POLICY_BYPASSWD	1
55 #define	PW_POLICY_BYGROUP	2
56 
57 __BEGIN_DECLS
58 struct disklabel;
59 struct iovec;
60 struct passwd;
61 struct termios;
62 struct utmp;
63 struct winsize;
64 struct sockaddr;
65 
66 char	       *flags_to_string(unsigned long, const char *);
67 pid_t		forkpty(int *, char *, struct termios *, struct winsize *);
68 const char     *getbootfile(void);
69 off_t		getlabeloffset(void);
70 int		getlabelsector(void);
71 int		getmaxpartitions(void);
72 int		getrawpartition(void);
73 #ifndef __LIBC12_SOURCE__
74 void		login(const struct utmp *) __RENAME(__login50);
75 void		loginx(const struct utmpx *) __RENAME(__loginx50);
76 #endif
77 int		login_tty(int);
78 int		logout(const char *);
79 int		logoutx(const char *, int, int);
80 void		logwtmp(const char *, const char *, const char *);
81 void		logwtmpx(const char *, const char *, const char *, int, int);
82 int		opendisk(const char *, int, char *, size_t, int);
83 int		opendisk1(const char *, int, char *, size_t, int,
84 			  int (*)(const char *, int, ...));
85 int		openpty(int *, int *, char *, struct termios *,
86     struct winsize *);
87 #ifndef __LIBC12_SOURCE__
88 time_t		parsedate(const char *, const time_t *, const int *)
89     __RENAME(__parsedate50);
90 #endif
91 int		pidfile(const char *);
92 int		pidlock(const char *, int, pid_t *, const char *);
93 int		pw_abort(void);
94 #ifndef __LIBC12_SOURCE__
95 void		pw_copy(int, int, struct passwd *, struct passwd *)
96     __RENAME(__pw_copy50);
97 int		pw_copyx(int, int, struct passwd *, struct passwd *,
98     char *, size_t) __RENAME(__pw_copyx50);
99 #endif
100 void		pw_edit(int, const char *);
101 void		pw_error(const char *, int, int);
102 void		pw_getconf(char *, size_t, const char *, const char *);
103 #ifndef __LIBC12_SOURCE__
104 void		pw_getpwconf(char *, size_t, const struct passwd *,
105     const char *) __RENAME(__pw_getpwconf50);
106 #endif
107 const char     *pw_getprefix(void);
108 void		pw_init(void);
109 int		pw_lock(int);
110 int		pw_mkdb(const char *, int);
111 void		pw_prompt(void);
112 int		pw_setprefix(const char *);
113 int		raise_default_signal(int);
114 int		secure_path(const char *);
115 int		snprintb_m(char *, size_t, const char *, uint64_t, size_t);
116 int		snprintb(char *, size_t, const char *, uint64_t);
117 int		sockaddr_snprintf(char *, size_t, const char *,
118     const struct sockaddr *);
119 int		string_to_flags(char **, unsigned long *, unsigned long *);
120 int		ttyaction(const char *, const char *, const char *);
121 int		ttylock(const char *, int, pid_t *);
122 char	       *ttymsg(struct iovec *, int, const char *, int);
123 int		ttyunlock(const char *);
124 
125 uint16_t	disklabel_dkcksum(struct disklabel *);
126 int		disklabel_scan(struct disklabel *, char *, size_t);
127 
128 /* Error checked functions */
129 void		(*esetfunc(void (*)(int, const char *, ...)))
130     (int, const char *, ...);
131 size_t 		estrlcpy(char *, const char *, size_t);
132 size_t 		estrlcat(char *, const char *, size_t);
133 char 		*estrdup(const char *);
134 char 		*estrndup(const char *, size_t);
135 void 		*ecalloc(size_t, size_t);
136 void 		*emalloc(size_t);
137 void 		*erealloc(void *, size_t);
138 struct __sFILE	*efopen(const char *, const char *);
139 int	 	easprintf(char ** __restrict, const char * __restrict, ...)
140 			__printflike(2, 3);
141 int		evasprintf(char ** __restrict, const char * __restrict,
142     _BSD_VA_LIST_)
143 			__printflike(2, 0);
144 __END_DECLS
145 
146 #endif /* !_UTIL_H_ */
147