libutil.h revision 288453 
1/*
2 * Copyright (c) 1996  Peter Wemm <peter@FreeBSD.org>.
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: stable/10/lib/libutil/libutil.h 288453 2015-10-01 17:09:20Z jhb $
37 */
38
39#ifndef _LIBUTIL_H_
40#define	_LIBUTIL_H_
41
42#include <sys/cdefs.h>
43#include <sys/_types.h>
44#include <sys/_stdint.h>
45
46#ifndef _GID_T_DECLARED
47typedef	__gid_t		gid_t;
48#define	_GID_T_DECLARED
49#endif
50
51#ifndef _MODE_T_DECLARED
52typedef	__mode_t	mode_t;
53#define	_MODE_T_DECLARED
54#endif
55
56#ifndef _PID_T_DECLARED
57typedef	__pid_t		pid_t;
58#define	_PID_T_DECLARED
59#endif
60
61#ifndef _SIZE_T_DECLARED
62typedef	__size_t	size_t;
63#define	_SIZE_T_DECLARED
64#endif
65
66#ifndef _UID_T_DECLARED
67typedef	__uid_t		uid_t;
68#define	_UID_T_DECLARED
69#endif
70
71#define	PROPERTY_MAX_NAME	64
72#define	PROPERTY_MAX_VALUE	512
73
74/* For properties.c. */
75typedef struct _property {
76	struct _property *next;
77	char	*name;
78	char	*value;
79} *properties;
80
81/* Avoid pulling in all the include files for no need. */
82struct in_addr;
83struct pidfh;
84struct sockaddr;
85struct termios;
86struct winsize;
87
88__BEGIN_DECLS
89char	*auth_getval(const char *_name);
90void	clean_environment(const char * const *_white,
91	    const char * const *_more_white);
92int	expand_number(const char *_buf, uint64_t *_num);
93int	extattr_namespace_to_string(int _attrnamespace, char **_string);
94int	extattr_string_to_namespace(const char *_string, int *_attrnamespace);
95int	flopen(const char *_path, int _flags, ...);
96int	forkpty(int *_amaster, char *_name,
97	    struct termios *_termp, struct winsize *_winp);
98void	hexdump(const void *_ptr, int _length, const char *_hdr, int _flags);
99int	humanize_number(char *_buf, size_t _len, int64_t _number,
100	    const char *_suffix, int _scale, int _flags);
101struct kinfo_file *
102	kinfo_getfile(pid_t _pid, int *_cntp);
103struct kinfo_vmentry *
104	kinfo_getvmmap(pid_t _pid, int *_cntp);
105struct kinfo_vmobject *
106	kinfo_getvmobject(int *_cntp);
107struct kinfo_proc *
108	kinfo_getallproc(int *_cntp);
109struct kinfo_proc *
110	kinfo_getproc(pid_t _pid);
111int	kld_isloaded(const char *_name);
112int	kld_load(const char *_name);
113int	login_tty(int _fd);
114int	openpty(int *_amaster, int *_aslave, char *_name,
115	    struct termios *_termp, struct winsize *_winp);
116int	pidfile_close(struct pidfh *_pfh);
117int	pidfile_fileno(const struct pidfh *_pfh);
118struct pidfh *
119	pidfile_open(const char *_path, mode_t _mode, pid_t *_pidptr);
120int	pidfile_remove(struct pidfh *_pfh);
121int	pidfile_write(struct pidfh *_pfh);
122void	properties_free(properties _list);
123char	*property_find(properties _list, const char *_name);
124properties
125	properties_read(int _fd);
126int	realhostname(char *_host, size_t _hsize, const struct in_addr *_ip);
127int	realhostname_sa(char *_host, size_t _hsize, struct sockaddr *_addr,
128	    int _addrlen);
129int	_secure_path(const char *_path, uid_t _uid, gid_t _gid);
130void	trimdomain(char *_fullhost, int _hostsize);
131const char *
132	uu_lockerr(int _uu_lockresult);
133int	uu_lock(const char *_ttyname);
134int	uu_unlock(const char *_ttyname);
135int	uu_lock_txfr(const char *_ttyname, pid_t _pid);
136
137/*
138 * Conditionally prototype the following functions if the include
139 * files upon which they depend have been included.
140 */
141#ifdef _STDIO_H_
142char	*fparseln(FILE *_fp, size_t *_len, size_t *_lineno,
143	    const char _delim[3], int _flags);
144#endif
145
146#ifdef _PWD_H_
147int	pw_copy(int _ffd, int _tfd, const struct passwd *_pw,
148	    struct passwd *_old_pw);
149struct passwd
150	*pw_dup(const struct passwd *_pw);
151int	pw_edit(int _notsetuid);
152int	pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
153void	pw_fini(void);
154int	pw_init(const char *_dir, const char *_master);
155char	*pw_make(const struct passwd *_pw);
156char	*pw_make_v7(const struct passwd *_pw);
157int	pw_mkdb(const char *_user);
158int	pw_lock(void);
159struct passwd *
160	pw_scan(const char *_line, int _flags);
161const char *
162	pw_tempname(void);
163int	pw_tmp(int _mfd);
164#endif
165
166#ifdef _GRP_H_
167int 	gr_copy(int __ffd, int _tfd, const struct group *_gr,
168	    struct group *_old_gr);
169struct group *
170	gr_dup(const struct group *_gr);
171struct group *
172	gr_add(const struct group *_gr, const char *_newmember);
173int	gr_equal(const struct group *_gr1, const struct group *_gr2);
174void	gr_fini(void);
175int	gr_init(const char *_dir, const char *_master);
176int	gr_lock(void);
177char	*gr_make(const struct group *_gr);
178int	gr_mkdb(void);
179struct group *
180	gr_scan(const char *_line);
181int	gr_tmp(int _mdf);
182#endif
183
184#ifdef _UFS_UFS_QUOTA_H_
185struct fstab;
186struct quotafile;
187int	quota_check_path(const struct quotafile *_qf, const char *_path);
188void	quota_close(struct quotafile *_qf);
189int	quota_convert(struct quotafile *_qf, int _wordsize);
190const char *
191	quota_fsname(const struct quotafile *_qf);
192int	quota_maxid(struct quotafile *_qf);
193int	quota_off(struct quotafile *_qf);
194int	quota_on(struct quotafile *_qf);
195struct quotafile *
196	quota_open(struct fstab *_fs, int _quotatype, int _openflags);
197const char *
198	quota_qfname(const struct quotafile *_qf);
199int	quota_read(struct quotafile *_qf, struct dqblk *_dqb, int _id);
200int	quota_write_limits(struct quotafile *_qf, struct dqblk *_dqb, int _id);
201int	quota_write_usage(struct quotafile *_qf, struct dqblk *_dqb, int _id);
202#endif
203
204__END_DECLS
205
206/* fparseln(3) */
207#define	FPARSELN_UNESCESC	0x01
208#define	FPARSELN_UNESCCONT	0x02
209#define	FPARSELN_UNESCCOMM	0x04
210#define	FPARSELN_UNESCREST	0x08
211#define	FPARSELN_UNESCALL	0x0f
212
213/* Flags for hexdump(3). */
214#define	HD_COLUMN_MASK		0xff
215#define	HD_DELIM_MASK		0xff00
216#define	HD_OMIT_COUNT		(1 << 16)
217#define	HD_OMIT_HEX		(1 << 17)
218#define	HD_OMIT_CHARS		(1 << 18)
219
220/* Values for humanize_number(3)'s flags parameter. */
221#define	HN_DECIMAL		0x01
222#define	HN_NOSPACE		0x02
223#define	HN_B			0x04
224#define	HN_DIVISOR_1000		0x08
225#define	HN_IEC_PREFIXES		0x10
226
227/* Values for humanize_number(3)'s scale parameter. */
228#define	HN_GETSCALE		0x10
229#define	HN_AUTOSCALE		0x20
230
231/* Return values from realhostname(). */
232#define	HOSTNAME_FOUND		0
233#define	HOSTNAME_INCORRECTNAME	1
234#define	HOSTNAME_INVALIDADDR	2
235#define	HOSTNAME_INVALIDNAME	3
236
237/* Flags for pw_scan(). */
238#define	PWSCAN_MASTER		0x01
239#define	PWSCAN_WARN		0x02
240
241/* Return values from uu_lock(). */
242#define	UU_LOCK_INUSE		1
243#define	UU_LOCK_OK		0
244#define	UU_LOCK_OPEN_ERR	(-1)
245#define	UU_LOCK_READ_ERR	(-2)
246#define	UU_LOCK_CREAT_ERR	(-3)
247#define	UU_LOCK_WRITE_ERR	(-4)
248#define	UU_LOCK_LINK_ERR	(-5)
249#define	UU_LOCK_TRY_ERR		(-6)
250#define	UU_LOCK_OWNER_ERR	(-7)
251
252#endif /* !_LIBUTIL_H_ */
253