util.h revision 1.52 
1/*	$NetBSD: util.h,v 1.52 2009/09/08 21:34:57 pooka 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_
46typedef _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
58struct disklabel;
59struct iovec;
60struct passwd;
61struct termios;
62struct utmp;
63struct winsize;
64struct sockaddr;
65
66typedef struct pw_policy *pw_policy_t;
67
68char	       *flags_to_string(unsigned long, const char *);
69pid_t		forkpty(int *, char *, struct termios *, struct winsize *);
70const char     *getbootfile(void);
71off_t		getlabeloffset(void);
72int		getlabelsector(void);
73int		getmaxpartitions(void);
74int		getrawpartition(void);
75#ifndef __LIBC12_SOURCE__
76void		login(const struct utmp *) __RENAME(__login50);
77void		loginx(const struct utmpx *) __RENAME(__loginx50);
78#endif
79int		login_tty(int);
80int		logout(const char *);
81int		logoutx(const char *, int, int);
82void		logwtmp(const char *, const char *, const char *);
83void		logwtmpx(const char *, const char *, const char *, int, int);
84int		opendisk(const char *, int, char *, size_t, int);
85int		opendisk1(const char *, int, char *, size_t, int,
86			  int (*)(const char *, int, mode_t));
87int		openpty(int *, int *, char *, struct termios *,
88    struct winsize *);
89#ifndef __LIBC12_SOURCE__
90time_t		parsedate(const char *, const time_t *, const int *)
91    __RENAME(__parsedate50);
92#endif
93int		pidfile(const char *);
94int		pidlock(const char *, int, pid_t *, const char *);
95int		pw_abort(void);
96#ifndef __LIBC12_SOURCE__
97void		pw_copy(int, int, struct passwd *, struct passwd *)
98    __RENAME(__pw_copy50);
99int		pw_copyx(int, int, struct passwd *, struct passwd *,
100    char *, size_t) __RENAME(__pw_copyx50);
101#endif
102void		pw_edit(int, const char *);
103void		pw_error(const char *, int, int);
104void		pw_getconf(char *, size_t, const char *, const char *);
105#ifndef __LIBC12_SOURCE__
106void		pw_getpwconf(char *, size_t, const struct passwd *,
107    const char *) __RENAME(__pw_getpwconf50);
108#endif
109const char     *pw_getprefix(void);
110void		pw_init(void);
111int		pw_lock(int);
112int		pw_mkdb(const char *, int);
113pw_policy_t	pw_policy_load(void *, int);
114int		pw_policy_test(pw_policy_t, char *);
115void		pw_policy_free(pw_policy_t);
116void		pw_prompt(void);
117int		pw_setprefix(const char *);
118int		raise_default_signal(int);
119int		secure_path(const char *);
120int		snprintb_m(char *, size_t, const char *, uint64_t, size_t);
121int		snprintb(char *, size_t, const char *, uint64_t);
122int		sockaddr_snprintf(char *, size_t, const char *,
123    const struct sockaddr *);
124int		string_to_flags(char **, unsigned long *, unsigned long *);
125int		ttyaction(const char *, const char *, const char *);
126int		ttylock(const char *, int, pid_t *);
127char	       *ttymsg(struct iovec *, int, const char *, int);
128int		ttyunlock(const char *);
129
130uint16_t	disklabel_dkcksum(struct disklabel *);
131int		disklabel_scan(struct disklabel *, char *, size_t);
132
133/* Error checked functions */
134void		(*esetfunc(void (*)(int, const char *, ...)))
135    (int, const char *, ...);
136size_t 		estrlcpy(char *, const char *, size_t);
137size_t 		estrlcat(char *, const char *, size_t);
138char 		*estrdup(const char *);
139char 		*estrndup(const char *, size_t);
140void 		*ecalloc(size_t, size_t);
141void 		*emalloc(size_t);
142void 		*erealloc(void *, size_t);
143struct __sFILE	*efopen(const char *, const char *);
144int	 	easprintf(char ** __restrict, const char * __restrict, ...)
145    __attribute__((__format__(__printf__, 2, 3)));
146int		evasprintf(char ** __restrict, const char * __restrict,
147    _BSD_VA_LIST_)
148    __attribute__((__format__(__printf__, 2, 0)));
149__END_DECLS
150
151#endif /* !_UTIL_H_ */
152