Home | History | Annotate | Line # | Download | only in include
      1 /*	$NetBSD: util.h,v 1.70 2024/11/02 03:21:42 riastradh 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/types.h>
     37 #include <sys/ansi.h>
     38 #include <sys/inttypes.h>
     39 #include <sys/featuretest.h>
     40 
     41 #ifdef  _BSD_TIME_T_
     42 typedef _BSD_TIME_T_    time_t;
     43 #undef  _BSD_TIME_T_
     44 #endif
     45 #ifdef  _BSD_SIZE_T_
     46 typedef _BSD_SIZE_T_    size_t;
     47 #undef  _BSD_SIZE_T_
     48 #endif
     49 
     50 #if defined(_POSIX_C_SOURCE)
     51 #ifndef __VA_LIST_DECLARED
     52 typedef __va_list va_list;
     53 #define __VA_LIST_DECLARED
     54 #endif
     55 #endif
     56 
     57 #define	PIDLOCK_NONBLOCK	1
     58 #define	PIDLOCK_USEHOSTNAME	2
     59 
     60 #define	PW_POLICY_BYSTRING	0
     61 #define	PW_POLICY_BYPASSWD	1
     62 #define	PW_POLICY_BYGROUP	2
     63 
     64 __BEGIN_DECLS
     65 struct disklabel;
     66 struct iovec;
     67 struct passwd;
     68 struct termios;
     69 struct utmp;
     70 struct utmpx;
     71 struct winsize;
     72 struct sockaddr;
     73 
     74 char	       *flags_to_string(unsigned long, const char *);
     75 pid_t		forkpty(int *, char *, struct termios *, struct winsize *);
     76 const char     *getbootfile(void);
     77 int		getbyteorder(void);
     78 off_t		getlabeloffset(void);
     79 int		getlabelsector(void);
     80 int		getlabelusesmbr(void);
     81 int		getmaxpartitions(void);
     82 int		getrawpartition(void);
     83 const char     *getdiskrawname(char *, size_t, const char *);
     84 const char     *getdiskcookedname(char *, size_t, const char *);
     85 const char     *getfstypename(int);
     86 const char     *getfsspecname(char *, size_t, const char *);
     87 struct kinfo_vmentry *kinfo_getvmmap(pid_t, size_t *);
     88 #ifndef __LIBC12_SOURCE__
     89 void		login(const struct utmp *) __RENAME(__login50);
     90 void		loginx(const struct utmpx *) __RENAME(__loginx50);
     91 #endif
     92 int		login_tty(int);
     93 int		logout(const char *);
     94 int		logoutx(const char *, int, int);
     95 void		logwtmp(const char *, const char *, const char *);
     96 void		logwtmpx(const char *, const char *, const char *, int, int);
     97 int		opendisk(const char *, int, char *, size_t, int);
     98 int		opendisk1(const char *, int, char *, size_t, int,
     99 			  int (*)(const char *, int, ...));
    100 int		openpty(int *, int *, char *, struct termios *,
    101     struct winsize *);
    102 #ifndef __LIBC12_SOURCE__
    103 time_t		parsedate(const char *, const time_t *, const int *)
    104     __RENAME(__parsedate50);
    105 #endif
    106 int		pidfile(const char *);
    107 pid_t		pidfile_lock(const char *);
    108 pid_t		pidfile_read(const char *);
    109 int		pidfile_clean(void);
    110 int		pidlock(const char *, int, pid_t *, const char *);
    111 int		pw_abort(void);
    112 #ifndef __LIBC12_SOURCE__
    113 void		pw_copy(int, int, struct passwd *, struct passwd *)
    114     __RENAME(__pw_copy50);
    115 int		pw_copyx(int, int, struct passwd *, struct passwd *,
    116     char *, size_t) __RENAME(__pw_copyx50);
    117 #endif
    118 void		pw_edit(int, const char *);
    119 __dead void	pw_error(const char *, int, int);
    120 void		pw_getconf(char *, size_t, const char *, const char *);
    121 #ifndef __LIBC12_SOURCE__
    122 void		pw_getpwconf(char *, size_t, const struct passwd *,
    123     const char *) __RENAME(__pw_getpwconf50);
    124 #endif
    125 const char     *pw_getprefix(void);
    126 void		pw_init(void);
    127 int		pw_lock(int);
    128 int		pw_mkdb(const char *, int);
    129 void		pw_prompt(void);
    130 int		pw_setprefix(const char *);
    131 int		raise_default_signal(int);
    132 int		secure_path(const char *);
    133 int		snprintb_m(char *, size_t, const char *, uint64_t, size_t);
    134 int		snprintb(char *, size_t, const char *, uint64_t);
    135 int		sockaddr_snprintf(char *, size_t, const char *,
    136     const struct sockaddr *);
    137 char 	       *strpct(char *, size_t, uintmax_t, uintmax_t, size_t);
    138 char 	       *strspct(char *, size_t, intmax_t, intmax_t, size_t);
    139 int		string_to_flags(char **, unsigned long *, unsigned long *);
    140 int		ttyaction(const char *, const char *, const char *);
    141 int		ttylock(const char *, int, pid_t *);
    142 char	       *ttymsg(struct iovec *, int, const char *, int);
    143 int		ttyunlock(const char *);
    144 
    145 uint16_t	disklabel_dkcksum(struct disklabel *);
    146 int		disklabel_scan(struct disklabel *, char *, size_t);
    147 
    148 /* Error checked functions */
    149 void		(*esetfunc(void (*)(int, const char *, ...)))
    150     (int, const char *, ...);
    151 size_t 		estrlcpy(char *, const char *, size_t);
    152 size_t 		estrlcat(char *, const char *, size_t);
    153 char 		*estrdup(const char *);
    154 char 		*estrndup(const char *, size_t);
    155 intmax_t	estrtoi(const char *, int, intmax_t, intmax_t);
    156 uintmax_t	estrtou(const char *, int, uintmax_t, uintmax_t);
    157 void 		*ecalloc(size_t, size_t);
    158 void 		*emalloc(size_t);
    159 void 		*erealloc(void *, size_t);
    160 void 		ereallocarr(void *, size_t, size_t);
    161 struct __sFILE	*efopen(const char *, const char *);
    162 int	 	easprintf(char ** __restrict, const char * __restrict, ...)
    163 			__printflike(2, 3);
    164 int		evasprintf(char ** __restrict, const char * __restrict,
    165     __va_list) __printflike(2, 0);
    166 __END_DECLS
    167 
    168 #endif /* !_UTIL_H_ */
    169