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
  45 #ifndef _GID_T_DECLARED
  46 typedef __gid_t         gid_t;
  47 #define _GID_T_DECLARED
  48 #endif
  49
  50 #ifndef _INT64_T_DECLARED
  51 typedef __int64_t       int64_t;
  52 #define _INT64_T_DECLARED
  53 #endif
  54
  55 #ifndef _PID_T_DECLARED
  56 typedef __pid_t         pid_t;
  57 #define _PID_T_DECLARED
  58 #endif
  59
  60 #ifndef _SIZE_T_DECLARED
  61 typedef __size_t        size_t;
  62 #define _SIZE_T_DECLARED
  63 #endif
  64
  65 #ifndef _UID_T_DECLARED
  66 typedef __uid_t         uid_t;
  67 #define _UID_T_DECLARED
  68 #endif
  69
  70 #define PROPERTY_MAX_NAME       64
  71 #define PROPERTY_MAX_VALUE      512
  72
  73 /* for properties.c */
  74 typedef struct _property {
  75         struct _property *next;
  76         char *name;
  77         char *value;
  78 } *properties;
  79
  80 #ifdef _SYS_PARAM_H_
  81 /* for pidfile.c */
  82 struct pidfh {
  83         int     pf_fd;
  84         char    pf_path[MAXPATHLEN + 1];
  85         __dev_t pf_dev;
  86         ino_t   pf_ino;
  87 };
  88 #endif
  89
  90 /* Avoid pulling in all the include files for no need */
  91 struct termios;
  92 struct winsize;
  93 struct in_addr;
  94 struct kinfo_file;
  95 struct kinfo_vmentry;
  96
  97 __BEGIN_DECLS
  98 void    clean_environment(const char * const *_white,
  99             const char * const *_more_white);
 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 void    hexdump(const void *ptr, int length, const char *hdr, int flags);
 104 int     login_tty(int _fd);
 105 void    trimdomain(char *_fullhost, int _hostsize);
 106 int     openpty(int *_amaster, int *_aslave, char *_name,
 107                      struct termios *_termp, struct winsize *_winp);
 108 int     forkpty(int *_amaster, char *_name,
 109                      struct termios *_termp, struct winsize *_winp);
 110 int     humanize_number(char *_buf, size_t _len, int64_t _number,
 111             const char *_suffix, int _scale, int _flags);
 112 int     expand_number(const char *_buf, uint64_t *_num);
 113 const char *uu_lockerr(int _uu_lockresult);
 114 int     uu_lock(const char *_ttyname);
 115 int     uu_unlock(const char *_ttyname);
 116 int     uu_lock_txfr(const char *_ttyname, pid_t _pid);
 117 int     _secure_path(const char *_path, uid_t _uid, gid_t _gid);
 118 properties properties_read(int fd);
 119 void    properties_free(properties list);
 120 char    *property_find(properties list, const char *name);
 121 char    *auth_getval(const char *name);
 122 int     realhostname(char *host, size_t hsize, const struct in_addr *ip);
 123 struct sockaddr;
 124 int     realhostname_sa(char *host, size_t hsize, struct sockaddr *addr,
 125                              int addrlen);
 126
 127 int     kld_isloaded(const char *name);
 128 int     kld_load(const char *name);
 129 struct kinfo_file *
 130         kinfo_getfile(pid_t _pid, int *_cntp);
 131 struct kinfo_vmentry *
 132         kinfo_getvmmap(pid_t _pid, int *_cntp);
 133
 134 #ifdef _STDIO_H_        /* avoid adding new includes */
 135 char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
 136 #endif
 137
 138 #ifdef _PWD_H_
 139 int     pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw);
 140 struct passwd *pw_dup(const struct passwd *_pw);
 141 int     pw_edit(int _notsetuid);
 142 int     pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
 143 void    pw_fini(void);
 144 int     pw_init(const char *_dir, const char *_master);
 145 char    *pw_make(const struct passwd *_pw);
 146 int     pw_mkdb(const char *_user);
 147 int     pw_lock(void);
 148 struct passwd *pw_scan(const char *_line, int _flags);
 149 const char *pw_tempname(void);
 150 int     pw_tmp(int _mfd);
 151 #endif
 152
 153 #ifdef _GRP_H_
 154 int     gr_equal(const struct group *gr1, const struct group *gr2);
 155 char    *gr_make(const struct group *gr);
 156 struct group *gr_dup(const struct group *gr);
 157 struct group *gr_scan(const char *line);
 158 #endif
 159
 160 #ifdef _SYS_PARAM_H_
 161 struct pidfh *pidfile_open(const char *path, mode_t mode, pid_t *pidptr);
 162 int pidfile_write(struct pidfh *pfh);
 163 int pidfile_close(struct pidfh *pfh);
 164 int pidfile_remove(struct pidfh *pfh);
 165 #endif
 166
 167 #ifdef _UFS_UFS_QUOTA_H_
 168 struct quotafile;
 169 struct fstab;
 170 struct quotafile *quota_open(struct fstab *, int, int);
 171 void quota_close(struct quotafile *);
 172 int quota_on(struct quotafile *);
 173 int quota_off(struct quotafile *);
 174 const char *quota_fsname(const struct quotafile *);
 175 const char *quota_qfname(const struct quotafile *);
 176 int quota_maxid(struct quotafile *);
 177 int quota_check_path(const struct quotafile *, const char *path);
 178 int quota_read(struct quotafile *, struct dqblk *, int);
 179 int quota_write_limits(struct quotafile *, struct dqblk *, int);
 180 int quota_write_usage(struct quotafile *, struct dqblk *, int);
 181 int quota_convert(struct quotafile *, int);
 182 #endif
 183
 184 __END_DECLS
 185
 186 #define UU_LOCK_INUSE (1)
 187 #define UU_LOCK_OK (0)
 188 #define UU_LOCK_OPEN_ERR (-1)
 189 #define UU_LOCK_READ_ERR (-2)
 190 #define UU_LOCK_CREAT_ERR (-3)
 191 #define UU_LOCK_WRITE_ERR (-4)
 192 #define UU_LOCK_LINK_ERR (-5)
 193 #define UU_LOCK_TRY_ERR (-6)
 194 #define UU_LOCK_OWNER_ERR (-7)
 195
 196 /* return values from realhostname() */
 197 #define HOSTNAME_FOUND          (0)
 198 #define HOSTNAME_INCORRECTNAME  (1)
 199 #define HOSTNAME_INVALIDADDR    (2)
 200 #define HOSTNAME_INVALIDNAME    (3)
 201
 202 /* fparseln(3) */
 203 #define FPARSELN_UNESCESC       0x01
 204 #define FPARSELN_UNESCCONT      0x02
 205 #define FPARSELN_UNESCCOMM      0x04
 206 #define FPARSELN_UNESCREST      0x08
 207 #define FPARSELN_UNESCALL       0x0f
 208
 209 /* pw_scan() */
 210 #define PWSCAN_MASTER           0x01
 211 #define PWSCAN_WARN             0x02
 212
 213 /* humanize_number(3) */
 214 #define HN_DECIMAL              0x01
 215 #define HN_NOSPACE              0x02
 216 #define HN_B                    0x04
 217 #define HN_DIVISOR_1000         0x08
 218
 219 #define HN_GETSCALE             0x10
 220 #define HN_AUTOSCALE            0x20
 221
 222 /* hexdump(3) */
 223 #define HD_COLUMN_MASK          0xff
 224 #define HD_DELIM_MASK           0xff00
 225 #define HD_OMIT_COUNT           (1 << 16)
 226 #define HD_OMIT_HEX             (1 << 17)
 227 #define HD_OMIT_CHARS           (1 << 18)
 228
 229 #endif /* !_LIBUTIL_H_ */