lib/libutil/libutil.h

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