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