Home | History | Annotate | Line # | Download | only in include
util.h revision 1.41 
      1 /*	$NetBSD: util.h,v 1.41 2006/08/26 18:11: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 
     44 #define	PIDLOCK_NONBLOCK	1
     45 #define	PIDLOCK_USEHOSTNAME	2
     46 
     47 #define	HN_DECIMAL		0x01
     48 #define	HN_NOSPACE		0x02
     49 #define	HN_B			0x04
     50 #define	HN_DIVISOR_1000		0x08
     51 
     52 #define	HN_GETSCALE		0x10
     53 #define	HN_AUTOSCALE		0x20
     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 typedef struct pw_policy *pw_policy_t;
     69 
     70 pid_t		forkpty(int *, char *, struct termios *, struct winsize *);
     71 const char     *getbootfile(void);
     72 off_t		getlabeloffset(void);
     73 int		getlabelsector(void);
     74 int		getmaxpartitions(void);
     75 int		getrawpartition(void);
     76 int		humanize_number(char *, size_t, int64_t, const char *, int,
     77 		    int);
     78 void		login(const struct utmp *);
     79 void		loginx(const struct utmpx *);
     80 int		login_tty(int);
     81 int		logout(const char *);
     82 int		logoutx(const char *, int, int);
     83 void		logwtmp(const char *, const char *, const char *);
     84 void		logwtmpx(const char *, const char *, const char *, int, int);
     85 int		opendisk(const char *, int, char *, size_t, int);
     86 int		openpty(int *, int *, char *, struct termios *,
     87 		    struct winsize *);
     88 int		pidfile(const char *);
     89 int		pidlock(const char *, int, pid_t *, const char *);
     90 int		pw_abort(void);
     91 void		pw_copy(int, int, struct passwd *, struct passwd *);
     92 int		pw_copyx(int, int, struct passwd *, struct passwd *,
     93 			 char *, size_t);
     94 void		pw_edit(int, const char *);
     95 void		pw_error(const char *, int, int);
     96 void		pw_getconf(char *, size_t, const char *, const char *);
     97 void		pw_getpwconf(char *, size_t, const struct passwd *,
     98 			     const char *);
     99 const char     *pw_getprefix(void);
    100 void		pw_init(void);
    101 int		pw_lock(int);
    102 int		pw_mkdb(const char *, int);
    103 pw_policy_t	pw_policy_load(void *, int);
    104 int		pw_policy_test(pw_policy_t, char *);
    105 void		pw_policy_free(pw_policy_t);
    106 void		pw_prompt(void);
    107 int		pw_setprefix(const char *);
    108 int		secure_path(const char *);
    109 int		snprintb(char *, size_t, const char *, uint64_t);
    110 int		sockaddr_snprintf(char *, size_t, const char *,
    111     const struct sockaddr *);
    112 int		ttyaction(const char *, const char *, const char *);
    113 int		ttylock(const char *, int, pid_t *);
    114 char	       *ttymsg(struct iovec *, int, const char *, int);
    115 int		ttyunlock(const char *);
    116 
    117 uint16_t	disklabel_dkcksum(struct disklabel *);
    118 int		disklabel_scan(struct disklabel *, char *, size_t);
    119 
    120 /* Error checked functions */
    121 void		(*esetfunc(void (*)(int, const char *, ...)))
    122     (int, const char *, ...);
    123 size_t 		estrlcpy(char *, const char *, size_t);
    124 size_t 		estrlcat(char *, const char *, size_t);
    125 char 		*estrdup(const char *);
    126 void 		*ecalloc(size_t, size_t);
    127 void 		*emalloc(size_t);
    128 void 		*erealloc(void *, size_t);
    129 struct __sFILE	*efopen(const char *, const char *);
    130 int	 	easprintf(char ** __restrict, const char * __restrict, ...)
    131     __attribute__((__format__(__printf__, 2, 3)));
    132 int		evasprintf(char ** __restrict, const char * __restrict,
    133     _BSD_VA_LIST_)
    134     __attribute__((__format__(__printf__, 2, 0)));
    135 
    136 __END_DECLS
    137 
    138 #endif /* !_UTIL_H_ */
    139