xref: /f-stack/tools/libutil/libutil.h (revision 2bfe3f2e)
1 /*
2  * Copyright (c) 1996  Peter Wemm <[email protected]>.
3  * All rights reserved.
4  * Copyright (c) 2002 Networks Associates Technology, Inc.
5  * All rights reserved.
6  *
7  * Portions of this software were developed for the FreeBSD Project by
8  * ThinkSec AS and NAI Labs, the Security Research Division of Network
9  * Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
10  * ("CBOSS"), as part of the DARPA CHATS research program.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, is permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. The name of the author may not be used to endorse or promote
21  *    products derived from this software without specific prior written
22  *    permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  * $FreeBSD$
37  */
38 
39 #ifndef _LIBUTIL_H_
40 #define	_LIBUTIL_H_
41 
42 #include <sys/cdefs.h>
43 #include <sys/_types.h>
44 #ifndef FSTACK
45 #include <sys/_stdint.h>
46 #else
47 #include <stdint.h>
48 #endif
49 
50 #ifndef _GID_T_DECLARED
51 typedef	__gid_t		gid_t;
52 #define	_GID_T_DECLARED
53 #endif
54 
55 #ifndef _MODE_T_DECLARED
56 typedef	__mode_t	mode_t;
57 #define	_MODE_T_DECLARED
58 #endif
59 
60 #ifndef _PID_T_DECLARED
61 typedef	__pid_t		pid_t;
62 #define	_PID_T_DECLARED
63 #endif
64 
65 #ifndef _SIZE_T_DECLARED
66 typedef	__size_t	size_t;
67 #define	_SIZE_T_DECLARED
68 #endif
69 
70 #ifndef _UID_T_DECLARED
71 typedef	__uid_t		uid_t;
72 #define	_UID_T_DECLARED
73 #endif
74 
75 #define	PROPERTY_MAX_NAME	64
76 #define	PROPERTY_MAX_VALUE	512
77 
78 /* For properties.c. */
79 typedef struct _property {
80 	struct _property *next;
81 	char	*name;
82 	char	*value;
83 } *properties;
84 
85 /* Avoid pulling in all the include files for no need. */
86 struct in_addr;
87 struct pidfh;
88 struct sockaddr;
89 struct termios;
90 struct winsize;
91 
92 __BEGIN_DECLS
93 char	*auth_getval(const char *_name);
94 void	clean_environment(const char * const *_white,
95 	    const char * const *_more_white);
96 int	expand_number(const char *_buf, uint64_t *_num);
97 int	extattr_namespace_to_string(int _attrnamespace, char **_string);
98 int	extattr_string_to_namespace(const char *_string, int *_attrnamespace);
99 int	flopen(const char *_path, int _flags, ...);
100 int	forkpty(int *_amaster, char *_name,
101 	    struct termios *_termp, struct winsize *_winp);
102 void	hexdump(const void *_ptr, int _length, const char *_hdr, int _flags);
103 int	humanize_number(char *_buf, size_t _len, int64_t _number,
104 	    const char *_suffix, int _scale, int _flags);
105 struct kinfo_file *
106 	kinfo_getfile(pid_t _pid, int *_cntp);
107 struct kinfo_vmentry *
108 	kinfo_getvmmap(pid_t _pid, int *_cntp);
109 struct kinfo_vmobject *
110 	kinfo_getvmobject(int *_cntp);
111 struct kinfo_proc *
112 	kinfo_getallproc(int *_cntp);
113 struct kinfo_proc *
114 	kinfo_getproc(pid_t _pid);
115 int	kld_isloaded(const char *_name);
116 int	kld_load(const char *_name);
117 int	login_tty(int _fd);
118 int	openpty(int *_amaster, int *_aslave, char *_name,
119 	    struct termios *_termp, struct winsize *_winp);
120 int	pidfile_close(struct pidfh *_pfh);
121 int	pidfile_fileno(const struct pidfh *_pfh);
122 struct pidfh *
123 	pidfile_open(const char *_path, mode_t _mode, pid_t *_pidptr);
124 int	pidfile_remove(struct pidfh *_pfh);
125 int	pidfile_write(struct pidfh *_pfh);
126 void	properties_free(properties _list);
127 char	*property_find(properties _list, const char *_name);
128 properties
129 	properties_read(int _fd);
130 int	realhostname(char *_host, size_t _hsize, const struct in_addr *_ip);
131 int	realhostname_sa(char *_host, size_t _hsize, struct sockaddr *_addr,
132 	    int _addrlen);
133 int	_secure_path(const char *_path, uid_t _uid, gid_t _gid);
134 void	trimdomain(char *_fullhost, int _hostsize);
135 const char *
136 	uu_lockerr(int _uu_lockresult);
137 int	uu_lock(const char *_ttyname);
138 int	uu_unlock(const char *_ttyname);
139 int	uu_lock_txfr(const char *_ttyname, pid_t _pid);
140 
141 /*
142  * Conditionally prototype the following functions if the include
143  * files upon which they depend have been included.
144  */
145 #ifdef _STDIO_H_
146 char	*fparseln(FILE *_fp, size_t *_len, size_t *_lineno,
147 	    const char _delim[3], int _flags);
148 #endif
149 
150 #ifdef _PWD_H_
151 int	pw_copy(int _ffd, int _tfd, const struct passwd *_pw,
152 	    struct passwd *_old_pw);
153 struct passwd
154 	*pw_dup(const struct passwd *_pw);
155 int	pw_edit(int _notsetuid);
156 int	pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
157 void	pw_fini(void);
158 int	pw_init(const char *_dir, const char *_master);
159 char	*pw_make(const struct passwd *_pw);
160 char	*pw_make_v7(const struct passwd *_pw);
161 int	pw_mkdb(const char *_user);
162 int	pw_lock(void);
163 struct passwd *
164 	pw_scan(const char *_line, int _flags);
165 const char *
166 	pw_tempname(void);
167 int	pw_tmp(int _mfd);
168 #endif
169 
170 #ifdef _GRP_H_
171 int 	gr_copy(int __ffd, int _tfd, const struct group *_gr,
172 	    struct group *_old_gr);
173 struct group *
174 	gr_dup(const struct group *_gr);
175 struct group *
176 	gr_add(const struct group *_gr, const char *_newmember);
177 int	gr_equal(const struct group *_gr1, const struct group *_gr2);
178 void	gr_fini(void);
179 int	gr_init(const char *_dir, const char *_master);
180 int	gr_lock(void);
181 char	*gr_make(const struct group *_gr);
182 int	gr_mkdb(void);
183 struct group *
184 	gr_scan(const char *_line);
185 int	gr_tmp(int _mdf);
186 #endif
187 
188 #ifdef _UFS_UFS_QUOTA_H_
189 struct fstab;
190 struct quotafile;
191 int	quota_check_path(const struct quotafile *_qf, const char *_path);
192 void	quota_close(struct quotafile *_qf);
193 int	quota_convert(struct quotafile *_qf, int _wordsize);
194 const char *
195 	quota_fsname(const struct quotafile *_qf);
196 int	quota_maxid(struct quotafile *_qf);
197 int	quota_off(struct quotafile *_qf);
198 int	quota_on(struct quotafile *_qf);
199 struct quotafile *
200 	quota_open(struct fstab *_fs, int _quotatype, int _openflags);
201 const char *
202 	quota_qfname(const struct quotafile *_qf);
203 int	quota_read(struct quotafile *_qf, struct dqblk *_dqb, int _id);
204 int	quota_write_limits(struct quotafile *_qf, struct dqblk *_dqb, int _id);
205 int	quota_write_usage(struct quotafile *_qf, struct dqblk *_dqb, int _id);
206 #endif
207 
208 __END_DECLS
209 
210 /* fparseln(3) */
211 #define	FPARSELN_UNESCESC	0x01
212 #define	FPARSELN_UNESCCONT	0x02
213 #define	FPARSELN_UNESCCOMM	0x04
214 #define	FPARSELN_UNESCREST	0x08
215 #define	FPARSELN_UNESCALL	0x0f
216 
217 /* Flags for hexdump(3). */
218 #define	HD_COLUMN_MASK		0xff
219 #define	HD_DELIM_MASK		0xff00
220 #define	HD_OMIT_COUNT		(1 << 16)
221 #define	HD_OMIT_HEX		(1 << 17)
222 #define	HD_OMIT_CHARS		(1 << 18)
223 
224 /* Values for humanize_number(3)'s flags parameter. */
225 #define	HN_DECIMAL		0x01
226 #define	HN_NOSPACE		0x02
227 #define	HN_B			0x04
228 #define	HN_DIVISOR_1000		0x08
229 #define	HN_IEC_PREFIXES		0x10
230 
231 /* Values for humanize_number(3)'s scale parameter. */
232 #define	HN_GETSCALE		0x10
233 #define	HN_AUTOSCALE		0x20
234 
235 /* Return values from realhostname(). */
236 #define	HOSTNAME_FOUND		0
237 #define	HOSTNAME_INCORRECTNAME	1
238 #define	HOSTNAME_INVALIDADDR	2
239 #define	HOSTNAME_INVALIDNAME	3
240 
241 /* Flags for pw_scan(). */
242 #define	PWSCAN_MASTER		0x01
243 #define	PWSCAN_WARN		0x02
244 
245 /* Return values from uu_lock(). */
246 #define	UU_LOCK_INUSE		1
247 #define	UU_LOCK_OK		0
248 #define	UU_LOCK_OPEN_ERR	(-1)
249 #define	UU_LOCK_READ_ERR	(-2)
250 #define	UU_LOCK_CREAT_ERR	(-3)
251 #define	UU_LOCK_WRITE_ERR	(-4)
252 #define	UU_LOCK_LINK_ERR	(-5)
253 #define	UU_LOCK_TRY_ERR		(-6)
254 #define	UU_LOCK_OWNER_ERR	(-7)
255 
256 #endif /* !_LIBUTIL_H_ */
257