include/util.h

   1 /*      $NetBSD: util.h,v 1.50 2009/01/11 03:04:12 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 <stdio.h>
  39 #include <pwd.h>
  40 #include <termios.h>
  41 #include <utmp.h>
  42 #include <utmpx.h>
  43 #include <machine/ansi.h>
  44
  45 #ifdef  _BSD_TIME_T_
  46 typedef _BSD_TIME_T_    time_t;
  47 #undef  _BSD_TIME_T_
  48 #endif
  49
  50 #define PIDLOCK_NONBLOCK        1
  51 #define PIDLOCK_USEHOSTNAME     2
  52
  53 #define PW_POLICY_BYSTRING      0
  54 #define PW_POLICY_BYPASSWD      1
  55 #define PW_POLICY_BYGROUP       2
  56
  57 __BEGIN_DECLS
  58 struct disklabel;
  59 struct iovec;
  60 struct passwd;
  61 struct termios;
  62 struct utmp;
  63 struct winsize;
  64 struct sockaddr;
  65
  66 typedef struct pw_policy *pw_policy_t;
  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             getmaxpartitions(void);
  74 int             getrawpartition(void);
  75 #ifndef __LIBC12_SOURCE__
  76 void            login(const struct utmp *) __RENAME(__login50);
  77 void            loginx(const struct utmpx *) __RENAME(__loginx50);
  78 #endif
  79 int             login_tty(int);
  80 int             logout(const char *);
  81 int             logoutx(const char *, int, int);
  82 void            logwtmp(const char *, const char *, const char *);
  83 void            logwtmpx(const char *, const char *, const char *, int, int);
  84 int             opendisk(const char *, int, char *, size_t, int);
  85 int             openpty(int *, int *, char *, struct termios *,
  86     struct winsize *);
  87 #ifndef __LIBC12_SOURCE__
  88 time_t          parsedate(const char *, const time_t *, const int *)
  89     __RENAME(__parsedate50);
  90 #endif
  91 int             pidfile(const char *);
  92 int             pidlock(const char *, int, pid_t *, const char *);
  93 int             pw_abort(void);
  94 #ifndef __LIBC12_SOURCE__
  95 void            pw_copy(int, int, struct passwd *, struct passwd *)
  96     __RENAME(__pw_copy50);
  97 int             pw_copyx(int, int, struct passwd *, struct passwd *,
  98     char *, size_t) __RENAME(__pw_copyx50);
  99 #endif
 100 void            pw_edit(int, const char *);
 101 void            pw_error(const char *, int, int);
 102 void            pw_getconf(char *, size_t, const char *, const char *);
 103 #ifndef __LIBC12_SOURCE__
 104 void            pw_getpwconf(char *, size_t, const struct passwd *,
 105     const char *) __RENAME(__pw_getpwconf50);
 106 #endif
 107 const char     *pw_getprefix(void);
 108 void            pw_init(void);
 109 int             pw_lock(int);
 110 int             pw_mkdb(const char *, int);
 111 pw_policy_t     pw_policy_load(void *, int);
 112 int             pw_policy_test(pw_policy_t, char *);
 113 void            pw_policy_free(pw_policy_t);
 114 void            pw_prompt(void);
 115 int             pw_setprefix(const char *);
 116 int             raise_default_signal(int);
 117 int             secure_path(const char *);
 118 int             snprintb_m(char *, size_t, const char *, uint64_t, size_t);
 119 int             snprintb(char *, size_t, const char *, uint64_t);
 120 int             sockaddr_snprintf(char *, size_t, const char *,
 121     const struct sockaddr *);
 122 int             string_to_flags(char **, unsigned long *, unsigned long *);
 123 int             ttyaction(const char *, const char *, const char *);
 124 int             ttylock(const char *, int, pid_t *);
 125 char           *ttymsg(struct iovec *, int, const char *, int);
 126 int             ttyunlock(const char *);
 127
 128 uint16_t        disklabel_dkcksum(struct disklabel *);
 129 int             disklabel_scan(struct disklabel *, char *, size_t);
 130
 131 /* Error checked functions */
 132 void            (*esetfunc(void (*)(int, const char *, ...)))
 133     (int, const char *, ...);
 134 size_t          estrlcpy(char *, const char *, size_t);
 135 size_t          estrlcat(char *, const char *, size_t);
 136 char            *estrdup(const char *);
 137 char            *estrndup(const char *, size_t);
 138 void            *ecalloc(size_t, size_t);
 139 void            *emalloc(size_t);
 140 void            *erealloc(void *, size_t);
 141 struct __sFILE  *efopen(const char *, const char *);
 142 int             easprintf(char ** __restrict, const char * __restrict, ...)
 143     __attribute__((__format__(__printf__, 2, 3)));
 144 int             evasprintf(char ** __restrict, const char * __restrict,
 145     _BSD_VA_LIST_)
 146     __attribute__((__format__(__printf__, 2, 0)));
 147 __END_DECLS
 148
 149 #endif /* !_UTIL_H_ */