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