lib/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 termios;
  88 struct winsize;
  89 struct in_addr;
  90 struct kinfo_file;
  91 struct kinfo_proc;
  92 struct kinfo_vmentry;
  93
  94 __BEGIN_DECLS
  95 void    clean_environment(const char * const *_white,
  96             const char * const *_more_white);
  97 int     extattr_namespace_to_string(int _attrnamespace, char **_string);
  98 int     extattr_string_to_namespace(const char *_string, int *_attrnamespace);
  99 int     flopen(const char *_path, int _flags, ...);
 100 void    hexdump(const void *ptr, int length, const char *hdr, int flags);
 101 int     login_tty(int _fd);
 102 void    trimdomain(char *_fullhost, int _hostsize);
 103 int     openpty(int *_amaster, int *_aslave, char *_name,
 104                      struct termios *_termp, struct winsize *_winp);
 105 int     forkpty(int *_amaster, char *_name,
 106                      struct termios *_termp, struct winsize *_winp);
 107 int     humanize_number(char *_buf, size_t _len, int64_t _number,
 108             const char *_suffix, int _scale, int _flags);
 109 int     expand_number(const char *_buf, uint64_t *_num);
 110 const char *uu_lockerr(int _uu_lockresult);
 111 int     uu_lock(const char *_ttyname);
 112 int     uu_unlock(const char *_ttyname);
 113 int     uu_lock_txfr(const char *_ttyname, pid_t _pid);
 114 int     _secure_path(const char *_path, uid_t _uid, gid_t _gid);
 115 properties properties_read(int fd);
 116 void    properties_free(properties list);
 117 char    *property_find(properties list, const char *name);
 118 char    *auth_getval(const char *name);
 119 int     realhostname(char *host, size_t hsize, const struct in_addr *ip);
 120 struct sockaddr;
 121 int     realhostname_sa(char *host, size_t hsize, struct sockaddr *addr,
 122                              int addrlen);
 123
 124 int     kld_isloaded(const char *name);
 125 int     kld_load(const char *name);
 126 struct kinfo_file *
 127         kinfo_getfile(pid_t _pid, int *_cntp);
 128 struct kinfo_vmentry *
 129         kinfo_getvmmap(pid_t _pid, int *_cntp);
 130 struct kinfo_proc *
 131         kinfo_getallproc(int *_cntp);
 132 struct kinfo_proc *
 133         kinfo_getproc(pid_t _pid);
 134
 135 #ifdef _STDIO_H_        /* avoid adding new includes */
 136 char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
 137 #endif
 138
 139 #ifdef _PWD_H_
 140 int     pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw);
 141 struct passwd *pw_dup(const struct passwd *_pw);
 142 int     pw_edit(int _notsetuid);
 143 int     pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
 144 void    pw_fini(void);
 145 int     pw_init(const char *_dir, const char *_master);
 146 char    *pw_make(const struct passwd *_pw);
 147 int     pw_mkdb(const char *_user);
 148 int     pw_lock(void);
 149 struct passwd *pw_scan(const char *_line, int _flags);
 150 const char *pw_tempname(void);
 151 int     pw_tmp(int _mfd);
 152 #endif
 153
 154 #ifdef _GRP_H_
 155 int     gr_equal(const struct group *gr1, const struct group *gr2);
 156 char    *gr_make(const struct group *gr);
 157 struct group *gr_dup(const struct group *gr);
 158 struct group *gr_scan(const char *line);
 159 #endif
 160
 161 #ifdef _SYS_PARAM_H_
 162 struct pidfh *pidfile_open(const char *path, mode_t mode, pid_t *pidptr);
 163 int pidfile_write(struct pidfh *pfh);
 164 int pidfile_close(struct pidfh *pfh);
 165 int pidfile_remove(struct pidfh *pfh);
 166 #endif
 167
 168 #ifdef _UFS_UFS_QUOTA_H_
 169 struct quotafile;
 170 struct fstab;
 171 struct quotafile *quota_open(struct fstab *, int, int);
 172 void quota_close(struct quotafile *);
 173 int quota_on(struct quotafile *);
 174 int quota_off(struct quotafile *);
 175 const char *quota_fsname(const struct quotafile *);
 176 const char *quota_qfname(const struct quotafile *);
 177 int quota_maxid(struct quotafile *);
 178 int quota_check_path(const struct quotafile *, const char *path);
 179 int quota_read(struct quotafile *, struct dqblk *, int);
 180 int quota_write_limits(struct quotafile *, struct dqblk *, int);
 181 int quota_write_usage(struct quotafile *, struct dqblk *, int);
 182 int quota_convert(struct quotafile *, int);
 183 #endif
 184
 185 __END_DECLS
 186
 187 #define UU_LOCK_INUSE (1)
 188 #define UU_LOCK_OK (0)
 189 #define UU_LOCK_OPEN_ERR (-1)
 190 #define UU_LOCK_READ_ERR (-2)
 191 #define UU_LOCK_CREAT_ERR (-3)
 192 #define UU_LOCK_WRITE_ERR (-4)
 193 #define UU_LOCK_LINK_ERR (-5)
 194 #define UU_LOCK_TRY_ERR (-6)
 195 #define UU_LOCK_OWNER_ERR (-7)
 196
 197 /* return values from realhostname() */
 198 #define HOSTNAME_FOUND          (0)
 199 #define HOSTNAME_INCORRECTNAME  (1)
 200 #define HOSTNAME_INVALIDADDR    (2)
 201 #define HOSTNAME_INVALIDNAME    (3)
 202
 203 /* fparseln(3) */
 204 #define FPARSELN_UNESCESC       0x01
 205 #define FPARSELN_UNESCCONT      0x02
 206 #define FPARSELN_UNESCCOMM      0x04
 207 #define FPARSELN_UNESCREST      0x08
 208 #define FPARSELN_UNESCALL       0x0f
 209
 210 /* pw_scan() */
 211 #define PWSCAN_MASTER           0x01
 212 #define PWSCAN_WARN             0x02
 213
 214 /* humanize_number(3) */
 215 #define HN_DECIMAL              0x01
 216 #define HN_NOSPACE              0x02
 217 #define HN_B                    0x04
 218 #define HN_DIVISOR_1000         0x08
 219 #define HN_IEC_PREFIXES         0x10
 220
 221 /* maxscale = 0x07 */
 222 #define HN_GETSCALE             0x10
 223 #define HN_AUTOSCALE            0x20
 224
 225 /* hexdump(3) */
 226 #define HD_COLUMN_MASK          0xff
 227 #define HD_DELIM_MASK           0xff00
 228 #define HD_OMIT_COUNT           (1 << 16)
 229 #define HD_OMIT_HEX             (1 << 17)
 230 #define HD_OMIT_CHARS           (1 << 18)
 231
 232 #endif /* !_LIBUTIL_H_ */