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