util.h revision 1.44 
1/*	$NetBSD: util.h,v 1.44 2006/11/20 20:33:33 christos 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	HN_DECIMAL		0x01
54#define	HN_NOSPACE		0x02
55#define	HN_B			0x04
56#define	HN_DIVISOR_1000		0x08
57
58#define	HN_GETSCALE		0x10
59#define	HN_AUTOSCALE		0x20
60
61#define	PW_POLICY_BYSTRING	0
62#define	PW_POLICY_BYPASSWD	1
63#define	PW_POLICY_BYGROUP	2
64
65__BEGIN_DECLS
66struct disklabel;
67struct iovec;
68struct passwd;
69struct termios;
70struct utmp;
71struct winsize;
72struct sockaddr;
73
74typedef struct pw_policy *pw_policy_t;
75
76pid_t		forkpty(int *, char *, struct termios *, struct winsize *);
77const char     *getbootfile(void);
78off_t		getlabeloffset(void);
79int		getlabelsector(void);
80int		getmaxpartitions(void);
81int		getrawpartition(void);
82int		humanize_number(char *, size_t, int64_t, const char *, int,
83		    int);
84void		login(const struct utmp *);
85void		loginx(const struct utmpx *);
86int		login_tty(int);
87int		logout(const char *);
88int		logoutx(const char *, int, int);
89void		logwtmp(const char *, const char *, const char *);
90void		logwtmpx(const char *, const char *, const char *, int, int);
91int		opendisk(const char *, int, char *, size_t, int);
92int		openpty(int *, int *, char *, struct termios *,
93		    struct winsize *);
94time_t		parsedate(const char *, const time_t *, const int *);
95int		pidfile(const char *);
96int		pidlock(const char *, int, pid_t *, const char *);
97int		pw_abort(void);
98void		pw_copy(int, int, struct passwd *, struct passwd *);
99int		pw_copyx(int, int, struct passwd *, struct passwd *,
100			 char *, size_t);
101void		pw_edit(int, const char *);
102void		pw_error(const char *, int, int);
103void		pw_getconf(char *, size_t, const char *, const char *);
104void		pw_getpwconf(char *, size_t, const struct passwd *,
105			     const char *);
106const char     *pw_getprefix(void);
107void		pw_init(void);
108int		pw_lock(int);
109int		pw_mkdb(const char *, int);
110pw_policy_t	pw_policy_load(void *, int);
111int		pw_policy_test(pw_policy_t, char *);
112void		pw_policy_free(pw_policy_t);
113void		pw_prompt(void);
114int		pw_setprefix(const char *);
115int		secure_path(const char *);
116int		snprintb(char *, size_t, const char *, uint64_t);
117int		sockaddr_snprintf(char *, size_t, const char *,
118    const struct sockaddr *);
119int		ttyaction(const char *, const char *, const char *);
120int		ttylock(const char *, int, pid_t *);
121char	       *ttymsg(struct iovec *, int, const char *, int);
122int		ttyunlock(const char *);
123
124uint16_t	disklabel_dkcksum(struct disklabel *);
125int		disklabel_scan(struct disklabel *, char *, size_t);
126
127/* Error checked functions */
128void		(*esetfunc(void (*)(int, const char *, ...)))
129    (int, const char *, ...);
130size_t 		estrlcpy(char *, const char *, size_t);
131size_t 		estrlcat(char *, const char *, size_t);
132char 		*estrdup(const char *);
133void 		*ecalloc(size_t, size_t);
134void 		*emalloc(size_t);
135void 		*erealloc(void *, size_t);
136struct __sFILE	*efopen(const char *, const char *);
137int	 	easprintf(char ** __restrict, const char * __restrict, ...)
138    __attribute__((__format__(__printf__, 2, 3)));
139int		evasprintf(char ** __restrict, const char * __restrict,
140    _BSD_VA_LIST_)
141    __attribute__((__format__(__printf__, 2, 0)));
142
143__END_DECLS
144
145#endif /* !_UTIL_H_ */
146