libutil/libutil.h

   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 _PID_T_DECLARED
  52 typedef __pid_t         pid_t;
  53 #define _PID_T_DECLARED
  54 #endif
  55
  56 #ifndef _SIZE_T_DECLARED
  57 typedef __size_t        size_t;
  58 #define _SIZE_T_DECLARED
  59 #endif
  60
  61 #ifndef _UID_T_DECLARED
  62 typedef __uid_t         uid_t;
  63 #define _UID_T_DECLARED
  64 #endif
  65
  66 #define PROPERTY_MAX_NAME       64
  67 #define PROPERTY_MAX_VALUE      512
  68
  69 /* for properties.c */
  70 typedef struct _property {
  71         struct _property *next;
  72         char    *name;
  73         char    *value;
  74 } *properties;
  75
  76 #ifdef _SYS_PARAM_H_
  77 /* for pidfile.c */
  78 struct pidfh {
  79         int     pf_fd;
  80         char    pf_path[MAXPATHLEN + 1];
  81         __dev_t pf_dev;
  82         ino_t   pf_ino;
  83 };
  84 #endif
  85
  86 /* Avoid pulling in all the include files for no need */
  87 struct in_addr;
  88 struct kinfo_file;
  89 struct kinfo_proc;
  90 struct kinfo_vmentry;
  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     forkpty(int *_amaster, char *_name,
 104             struct termios *_termp, struct winsize *_winp);
 105 void    hexdump(const void *_ptr, int _length, const char *_hdr, int _flags);
 106 int     humanize_number(char *_buf, size_t _len, int64_t _number,
 107             const char *_suffix, int _scale, int _flags);
 108 struct kinfo_file *
 109         kinfo_getfile(pid_t _pid, int *_cntp);
 110 struct kinfo_vmentry *
 111         kinfo_getvmmap(pid_t _pid, 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 void    properties_free(properties _list);
 122 char    *property_find(properties _list, const char *_name);
 123 properties
 124         properties_read(int _fd);
 125 int     realhostname(char *_host, size_t _hsize, const struct in_addr *_ip);
 126 int     realhostname_sa(char *_host, size_t _hsize, struct sockaddr *_addr,
 127             int _addrlen);
 128 int     _secure_path(const char *_path, uid_t _uid, gid_t _gid);
 129 void    trimdomain(char *_fullhost, int _hostsize);
 130 const char *
 131         uu_lockerr(int _uu_lockresult);
 132 int     uu_lock(const char *_ttyname);
 133 int     uu_unlock(const char *_ttyname);
 134 int     uu_lock_txfr(const char *_ttyname, pid_t _pid);
 135
 136 #ifdef _STDIO_H_        /* avoid adding new includes */
 137 char    *fparseln(FILE *_fp, size_t *_len, size_t *_lineno,
 138             const char _delim[3], int _flags);
 139 #endif
 140
 141 #ifdef _PWD_H_
 142 int     pw_copy(int _ffd, int _tfd, const struct passwd *_pw,
 143             struct passwd *_old_pw);
 144 struct passwd
 145         *pw_dup(const struct passwd *_pw);
 146 int     pw_edit(int _notsetuid);
 147 int     pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
 148 void    pw_fini(void);
 149 int     pw_init(const char *_dir, const char *_master);
 150 char    *pw_make(const struct passwd *_pw);
 151 char    *pw_make_v7(const struct passwd *_pw);
 152 int     pw_mkdb(const char *_user);
 153 int     pw_lock(void);
 154 struct passwd
 155         *pw_scan(const char *_line, int _flags);
 156 const char
 157         *pw_tempname(void);
 158 int     pw_tmp(int _mfd);
 159 #endif
 160
 161 #ifdef _GRP_H_
 162 int     gr_copy(int __ffd, int _tfd, const struct group *_gr,
 163             struct group *_old_gr);
 164 struct group
 165         *gr_dup(const struct group *_gr);
 166 int     gr_equal(const struct group *_gr1, const struct group *_gr2);
 167 void    gr_fini(void);
 168 int     gr_init(const char *_dir, const char *_master);
 169 int     gr_lock(void);
 170 char    *gr_make(const struct group *_gr);
 171 int     gr_mkdb(void);
 172 struct group
 173         *gr_scan(const char *_line);
 174 int     gr_tmp(int _mdf);
 175 #endif
 176
 177 #ifdef _SYS_PARAM_H_
 178 int     pidfile_close(struct pidfh *_pfh);
 179 int     pidfile_fileno(const struct pidfh *_pfh);
 180 struct pidfh *
 181         pidfile_open(const char *_path, mode_t _mode, pid_t *_pidptr);
 182 int     pidfile_remove(struct pidfh *_pfh);
 183 int     pidfile_write(struct pidfh *_pfh);
 184 #endif
 185
 186 #ifdef _UFS_UFS_QUOTA_H_
 187 struct fstab;
 188 struct quotafile;
 189 int     quota_check_path(const struct quotafile *_qf, const char *_path);
 190 void    quota_close(struct quotafile *_qf);
 191 int     quota_convert(struct quotafile *_qf, int _wordsize);
 192 const char *
 193         quota_fsname(const struct quotafile *_qf);
 194 int     quota_maxid(struct quotafile *_qf);
 195 int     quota_off(struct quotafile *_qf);
 196 int     quota_on(struct quotafile *_qf);
 197 struct quotafile *
 198         quota_open(struct fstab *_fs, int _quotatype, int _openflags);
 199 const char *
 200         quota_qfname(const struct quotafile *_qf);
 201 int     quota_read(struct quotafile *_qf, struct dqblk *_dqb, int _id);
 202 int     quota_write_limits(struct quotafile *_qf, struct dqblk *_dqb, int _id);
 203 int     quota_write_usage(struct quotafile *_qf, struct dqblk *_dqb, int _id);
 204 #endif
 205
 206 __END_DECLS
 207
 208 #define UU_LOCK_INUSE (1)
 209 #define UU_LOCK_OK (0)
 210 #define UU_LOCK_OPEN_ERR (-1)
 211 #define UU_LOCK_READ_ERR (-2)
 212 #define UU_LOCK_CREAT_ERR (-3)
 213 #define UU_LOCK_WRITE_ERR (-4)
 214 #define UU_LOCK_LINK_ERR (-5)
 215 #define UU_LOCK_TRY_ERR (-6)
 216 #define UU_LOCK_OWNER_ERR (-7)
 217
 218 /* return values from realhostname() */
 219 #define HOSTNAME_FOUND          (0)
 220 #define HOSTNAME_INCORRECTNAME  (1)
 221 #define HOSTNAME_INVALIDADDR    (2)
 222 #define HOSTNAME_INVALIDNAME    (3)
 223
 224 /* fparseln(3) */
 225 #define FPARSELN_UNESCESC       0x01
 226 #define FPARSELN_UNESCCONT      0x02
 227 #define FPARSELN_UNESCCOMM      0x04
 228 #define FPARSELN_UNESCREST      0x08
 229 #define FPARSELN_UNESCALL       0x0f
 230
 231 /* pw_scan() */
 232 #define PWSCAN_MASTER           0x01
 233 #define PWSCAN_WARN             0x02
 234
 235 /* humanize_number(3) */
 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 /* maxscale = 0x07 */
 243 #define HN_GETSCALE             0x10
 244 #define HN_AUTOSCALE            0x20
 245
 246 /* hexdump(3) */
 247 #define HD_COLUMN_MASK          0xff
 248 #define HD_DELIM_MASK           0xff00
 249 #define HD_OMIT_COUNT           (1 << 16)
 250 #define HD_OMIT_HEX             (1 << 17)
 251 #define HD_OMIT_CHARS           (1 << 18)
 252
 253 #endif /* !_LIBUTIL_H_ */