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