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 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 pidfh; 84 struct sockaddr; 85 struct termios; 86 struct winsize; 87 88 __BEGIN_DECLS 89 void clean_environment(const char * const *_white, 90 const char * const *_more_white); 91 int expand_number(const char *_buf, int64_t *_num); 92 int extattr_namespace_to_string(int _attrnamespace, char **_string); 93 int extattr_string_to_namespace(const char *_string, int *_attrnamespace); 94 int flopen(const char *_path, int _flags, ...); 95 int flopenat(int _dirfd, const char *_path, int _flags, ...); 96 int forkpty(int *_amaster, char *_name, 97 struct termios *_termp, struct winsize *_winp); 98 const char * 99 getlocalbase(void); 100 void hexdump(const void *_ptr, int _length, const char *_hdr, int _flags); 101 int humanize_number(char *_buf, size_t _len, int64_t _number, 102 const char *_suffix, int _scale, int _flags); 103 struct kinfo_file * 104 kinfo_getfile(pid_t _pid, int *_cntp); 105 struct kinfo_vmentry * 106 kinfo_getvmmap(pid_t _pid, int *_cntp); 107 struct kinfo_vmobject * 108 kinfo_getvmobject(int *_cntp); 109 struct kinfo_vmobject * 110 kinfo_getswapvmobject(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 int pidfile_signal(const char *pathp, int sig, pid_t *pidptr); 123 struct pidfh * 124 pidfile_open(const char *_path, mode_t _mode, pid_t *_pidptr); 125 int pidfile_remove(struct pidfh *_pfh); 126 int pidfile_write(struct pidfh *_pfh); 127 void properties_free(properties _list); 128 char *property_find(properties _list, const char *_name); 129 properties 130 properties_read(int _fd); 131 int realhostname(char *_host, size_t _hsize, const struct in_addr *_ip); 132 int realhostname_sa(char *_host, size_t _hsize, struct sockaddr *_addr, 133 int _addrlen); 134 int _secure_path(const char *_path, uid_t _uid, gid_t _gid); 135 void trimdomain(char *_fullhost, int _hostsize); 136 const char * 137 uu_lockerr(int _uu_lockresult); 138 int uu_lock(const char *_ttyname); 139 int uu_unlock(const char *_ttyname); 140 int uu_lock_txfr(const char *_ttyname, pid_t _pid); 141 142 /* 143 * Conditionally prototype the following functions if the include 144 * files upon which they depend have been included. 145 */ 146 #ifdef _STDIO_H_ 147 char *fparseln(FILE *_fp, size_t *_len, size_t *_lineno, 148 const char _delim[3], int _flags); 149 #endif 150 151 #ifdef _PWD_H_ 152 int pw_copy(int _ffd, int _tfd, const struct passwd *_pw, 153 struct passwd *_old_pw); 154 struct passwd 155 *pw_dup(const struct passwd *_pw); 156 int pw_edit(int _notsetuid); 157 int pw_equal(const struct passwd *_pw1, const struct passwd *_pw2); 158 void pw_fini(void); 159 int pw_init(const char *_dir, const char *_master); 160 void pw_initpwd(struct passwd *_pw); 161 char *pw_make(const struct passwd *_pw); 162 char *pw_make_v7(const struct passwd *_pw); 163 int pw_mkdb(const char *_user); 164 int pw_lock(void); 165 struct passwd * 166 pw_scan(const char *_line, int _flags); 167 const char * 168 pw_tempname(void); 169 int pw_tmp(int _mfd); 170 #endif 171 172 #ifdef _GRP_H_ 173 int gr_copy(int __ffd, int _tfd, const struct group *_gr, 174 struct group *_old_gr); 175 struct group * 176 gr_dup(const struct group *_gr); 177 struct group * 178 gr_add(const struct group *_gr, const char *_newmember); 179 int gr_equal(const struct group *_gr1, const struct group *_gr2); 180 void gr_fini(void); 181 int gr_init(const char *_dir, const char *_master); 182 int gr_lock(void); 183 char *gr_make(const struct group *_gr); 184 int gr_mkdb(void); 185 struct group * 186 gr_scan(const char *_line); 187 int gr_tmp(int _mdf); 188 #endif 189 190 #ifdef _UFS_UFS_QUOTA_H_ 191 struct fstab; 192 struct quotafile; 193 int quota_check_path(const struct quotafile *_qf, const char *_path); 194 void quota_close(struct quotafile *_qf); 195 int quota_convert(struct quotafile *_qf, int _wordsize); 196 const char * 197 quota_fsname(const struct quotafile *_qf); 198 int quota_maxid(struct quotafile *_qf); 199 int quota_off(struct quotafile *_qf); 200 int quota_on(struct quotafile *_qf); 201 struct quotafile * 202 quota_open(struct fstab *_fs, int _quotatype, int _openflags); 203 const char * 204 quota_qfname(const struct quotafile *_qf); 205 int quota_read(struct quotafile *_qf, struct dqblk *_dqb, int _id); 206 int quota_write_limits(struct quotafile *_qf, struct dqblk *_dqb, int _id); 207 int quota_write_usage(struct quotafile *_qf, struct dqblk *_dqb, int _id); 208 #endif 209 210 #ifdef _SYS_CPUSET_H_ 211 int cpuset_parselist(const char *list, cpuset_t *mask); 212 #define CPUSET_PARSE_OK 0 213 #define CPUSET_PARSE_GETAFFINITY -1 214 #define CPUSET_PARSE_ERROR -2 215 #define CPUSET_PARSE_OUT_OF_RANGE -3 216 #define CPUSET_PARSE_GETDOMAIN -4 217 #define CPUSET_PARSE_INVALID_CPU CPUSET_PARSE_OUT_OF_RANGE /* backwards compat */ 218 #endif 219 220 #ifdef _SYS_DOMAINSET_H_ 221 int domainset_parselist(const char *list, domainset_t *mask, int *policyp); 222 #endif 223 224 __END_DECLS 225 226 /* fparseln(3) */ 227 #define FPARSELN_UNESCESC 0x01 228 #define FPARSELN_UNESCCONT 0x02 229 #define FPARSELN_UNESCCOMM 0x04 230 #define FPARSELN_UNESCREST 0x08 231 #define FPARSELN_UNESCALL 0x0f 232 233 /* Flags for hexdump(3). */ 234 #define HD_COLUMN_MASK 0xff 235 #define HD_DELIM_MASK 0xff00 236 #define HD_OMIT_COUNT (1 << 16) 237 #define HD_OMIT_HEX (1 << 17) 238 #define HD_OMIT_CHARS (1 << 18) 239 240 /* Values for humanize_number(3)'s flags parameter. */ 241 #define HN_DECIMAL 0x01 242 #define HN_NOSPACE 0x02 243 #define HN_B 0x04 244 #define HN_DIVISOR_1000 0x08 245 #define HN_IEC_PREFIXES 0x10 246 247 /* Values for humanize_number(3)'s scale parameter. */ 248 #define HN_GETSCALE 0x10 249 #define HN_AUTOSCALE 0x20 250 251 /* Return values from realhostname(). */ 252 #define HOSTNAME_FOUND 0 253 #define HOSTNAME_INCORRECTNAME 1 254 #define HOSTNAME_INVALIDADDR 2 255 #define HOSTNAME_INVALIDNAME 3 256 257 /* Flags for pw_scan(). */ 258 #define PWSCAN_MASTER 0x01 259 #define PWSCAN_WARN 0x02 260 261 /* Return values from uu_lock(). */ 262 #define UU_LOCK_INUSE 1 263 #define UU_LOCK_OK 0 264 #define UU_LOCK_OPEN_ERR (-1) 265 #define UU_LOCK_READ_ERR (-2) 266 #define UU_LOCK_CREAT_ERR (-3) 267 #define UU_LOCK_WRITE_ERR (-4) 268 #define UU_LOCK_LINK_ERR (-5) 269 #define UU_LOCK_TRY_ERR (-6) 270 #define UU_LOCK_OWNER_ERR (-7) 271 272 #endif /* !_LIBUTIL_H_ */ 273