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