include/util.h

   1 /*      $NetBSD: util.h,v 1.63 2012/04/07 16:44:59 christos Exp $       */
   2
   3 /*-
   4  * Copyright (c) 1995
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #ifndef _UTIL_H_
  33 #define _UTIL_H_
  34
  35 #include <sys/cdefs.h>
  36 #include <sys/ttycom.h>
  37 #include <sys/types.h>
  38 #include <pwd.h>
  39 #include <stdarg.h>
  40 #include <stdio.h>
  41 #include <termios.h>
  42 #include <utmp.h>
  43 #include <utmpx.h>
  44 #include <stdint.h>
  45 #include <machine/ansi.h>
  46
  47 #ifdef  _BSD_TIME_T_
  48 typedef _BSD_TIME_T_    time_t;
  49 #undef  _BSD_TIME_T_
  50 #endif
  51
  52 #define PIDLOCK_NONBLOCK        1
  53 #define PIDLOCK_USEHOSTNAME     2
  54
  55 #define PW_POLICY_BYSTRING      0
  56 #define PW_POLICY_BYPASSWD      1
  57 #define PW_POLICY_BYGROUP       2
  58
  59 __BEGIN_DECLS
  60 struct disklabel;
  61 struct iovec;
  62 struct passwd;
  63 struct termios;
  64 struct utmp;
  65 struct winsize;
  66 struct sockaddr;
  67
  68 char           *flags_to_string(unsigned long, const char *);
  69 pid_t           forkpty(int *, char *, struct termios *, struct winsize *);
  70 const char     *getbootfile(void);
  71 off_t           getlabeloffset(void);
  72 int             getlabelsector(void);
  73 int             getlabelusesmbr(void);
  74 int             getmaxpartitions(void);
  75 int             getrawpartition(void);
  76 const char     *getdiskrawname(char *, size_t, const char *);
  77 const char     *getdiskcookedname(char *, size_t, const char *);
  78 const char     *getfstypename(int);
  79 const char     *getfsspecname(char *, size_t, const char *);
  80 #ifndef __LIBC12_SOURCE__
  81 void            login(const struct utmp *) __RENAME(__login50);
  82 void            loginx(const struct utmpx *) __RENAME(__loginx50);
  83 #endif
  84 int             login_tty(int);
  85 int             logout(const char *);
  86 int             logoutx(const char *, int, int);
  87 void            logwtmp(const char *, const char *, const char *);
  88 void            logwtmpx(const char *, const char *, const char *, int, int);
  89 int             opendisk(const char *, int, char *, size_t, int);
  90 int             opendisk1(const char *, int, char *, size_t, int,
  91                           int (*)(const char *, int, ...));
  92 int             openpty(int *, int *, char *, struct termios *,
  93     struct winsize *);
  94 #ifndef __LIBC12_SOURCE__
  95 time_t          parsedate(const char *, const time_t *, const int *)
  96     __RENAME(__parsedate50);
  97 #endif
  98 int             pidfile(const char *);
  99 int             pidlock(const char *, int, pid_t *, const char *);
 100 int             pw_abort(void);
 101 #ifndef __LIBC12_SOURCE__
 102 void            pw_copy(int, int, struct passwd *, struct passwd *)
 103     __RENAME(__pw_copy50);
 104 int             pw_copyx(int, int, struct passwd *, struct passwd *,
 105     char *, size_t) __RENAME(__pw_copyx50);
 106 #endif
 107 void            pw_edit(int, const char *);
 108 __dead void     pw_error(const char *, int, int);
 109 void            pw_getconf(char *, size_t, const char *, const char *);
 110 #ifndef __LIBC12_SOURCE__
 111 void            pw_getpwconf(char *, size_t, const struct passwd *,
 112     const char *) __RENAME(__pw_getpwconf50);
 113 #endif
 114 const char     *pw_getprefix(void);
 115 void            pw_init(void);
 116 int             pw_lock(int);
 117 int             pw_mkdb(const char *, int);
 118 void            pw_prompt(void);
 119 int             pw_setprefix(const char *);
 120 int             raise_default_signal(int);
 121 int             secure_path(const char *);
 122 int             snprintb_m(char *, size_t, const char *, uint64_t, size_t);
 123 int             snprintb(char *, size_t, const char *, uint64_t);
 124 int             sockaddr_snprintf(char *, size_t, const char *,
 125     const struct sockaddr *);
 126 char           *strpct(char *, size_t, uintmax_t, uintmax_t, size_t);
 127 char           *strspct(char *, size_t, intmax_t, intmax_t, size_t);
 128 int             string_to_flags(char **, unsigned long *, unsigned long *);
 129 int             ttyaction(const char *, const char *, const char *);
 130 int             ttylock(const char *, int, pid_t *);
 131 char           *ttymsg(struct iovec *, int, const char *, int);
 132 int             ttyunlock(const char *);
 133
 134 uint16_t        disklabel_dkcksum(struct disklabel *);
 135 int             disklabel_scan(struct disklabel *, char *, size_t);
 136
 137 /* Error checked functions */
 138 void            (*esetfunc(void (*)(int, const char *, ...)))
 139     (int, const char *, ...);
 140 size_t          estrlcpy(char *, const char *, size_t);
 141 size_t          estrlcat(char *, const char *, size_t);
 142 char            *estrdup(const char *);
 143 char            *estrndup(const char *, size_t);
 144 void            *ecalloc(size_t, size_t);
 145 void            *emalloc(size_t);
 146 void            *erealloc(void *, size_t);
 147 struct __sFILE  *efopen(const char *, const char *);
 148 int             easprintf(char ** __restrict, const char * __restrict, ...)
 149                         __printflike(2, 3);
 150 int             evasprintf(char ** __restrict, const char * __restrict, va_list)
 151                         __printflike(2, 0);
 152 __END_DECLS
 153
 154 #endif /* !_UTIL_H_ */