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