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