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