xref: /openbsd/lib/libutil/util.h (revision 8932bfb7)
1 /*	$OpenBSD: util.h,v 1.29 2010/12/17 19:35:34 millert Exp $	*/
2 /*	$NetBSD: util.h,v 1.2 1996/05/16 07:00:22 thorpej Exp $	*/
3 
4 /*-
5  * Copyright (c) 1995
6  *	The Regents of the University of California.  All rights reserved.
7  * Portions Copyright (c) 1996, Jason Downs.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 #ifndef _UTIL_H_
35 #define _UTIL_H_
36 
37 #include <sys/cdefs.h>
38 #include <sys/types.h>
39 
40 /*
41  * fparseln() specific operation flags.
42  */
43 #define FPARSELN_UNESCESC	0x01
44 #define FPARSELN_UNESCCONT	0x02
45 #define FPARSELN_UNESCCOMM	0x04
46 #define FPARSELN_UNESCREST	0x08
47 #define FPARSELN_UNESCALL	0x0f
48 
49 /*
50  * opendev() specific operation flags.
51  */
52 #define OPENDEV_PART	0x01		/* Try to open the raw partition. */
53 #define OPENDEV_BLCK	0x04		/* Open block, not character device. */
54 
55 /*
56  * uucplock(3) specific flags.
57  */
58 #define UU_LOCK_INUSE (1)
59 #define UU_LOCK_OK (0)
60 #define UU_LOCK_OPEN_ERR (-1)
61 #define UU_LOCK_READ_ERR (-2)
62 #define UU_LOCK_CREAT_ERR (-3)
63 #define UU_LOCK_WRITE_ERR (-4)
64 #define UU_LOCK_LINK_ERR (-5)
65 #define UU_LOCK_TRY_ERR (-6)
66 #define UU_LOCK_OWNER_ERR (-7)
67 
68 /*
69  * fmt_scaled(3) specific flags.
70  */
71 #define	FMT_SCALED_STRSIZE	7	/* minus sign, 4 digits, suffix, null byte */
72 
73 /*
74  * stub struct definitions.
75  */
76 struct __sFILE;
77 struct login_cap;
78 struct passwd;
79 struct termios;
80 struct utmp;
81 struct winsize;
82 
83 __BEGIN_DECLS
84 char   *fparseln(struct __sFILE *, size_t *, size_t *, const char[3], int);
85 void	login(struct utmp *);
86 int	login_tty(int);
87 int	logout(const char *);
88 void	logwtmp(const char *, const char *, const char *);
89 int	opendev(const char *, int, int, char **);
90 int	pidfile(const char *);
91 void	pw_setdir(const char *);
92 char   *pw_file(const char *);
93 int	pw_lock(int retries);
94 int	pw_mkdb(char *, int);
95 int	pw_abort(void);
96 void	pw_init(void);
97 void	pw_edit(int, const char *);
98 void	pw_prompt(void);
99 void	pw_copy(int, int, const struct passwd *, const struct passwd *);
100 int	pw_scan(char *, struct passwd *, int *);
101 void	pw_error(const char *, int, int);
102 int	openpty(int *, int *, char *, struct termios *, struct winsize *);
103 int	opendisk(const char *path, int flags, char *buf, size_t buflen,
104 	    int iscooked);
105 pid_t	forkpty(int *, char *, struct termios *, struct winsize *);
106 int	getmaxpartitions(void);
107 int	getrawpartition(void);
108 void	login_fbtab(const char *, uid_t, gid_t);
109 int	login_check_expire(struct __sFILE *, struct passwd *, char *, int);
110 char   *readlabelfs(char *, int);
111 const char *uu_lockerr(int _uu_lockresult);
112 int     uu_lock(const char *_ttyname);
113 int	uu_lock_txfr(const char *_ttyname, pid_t _pid);
114 int     uu_unlock(const char *_ttyname);
115 int	fmt_scaled(long long number, char *result);
116 int	scan_scaled(char *scaled, long long *result);
117 int	isduid(const char *, int);
118 __END_DECLS
119 
120 #endif /* !_UTIL_H_ */
121