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