xref: /haiku/headers/compatibility/bsd/libutil.h (revision 3ecb7fb4415b319b6aac606551d51efad21037df)
1 /*
2  * Copyright (c) 1996  Peter Wemm <peter@FreeBSD.org>.
3  * All rights reserved.
4  * Copyright (c) 2002 Networks Associates Technology, Inc.
5  * All rights reserved.
6  *
7  * Portions of this software were developed for the FreeBSD Project by
8  * ThinkSec AS and NAI Labs, the Security Research Division of Network
9  * Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
10  * ("CBOSS"), as part of the DARPA CHATS research program.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, is permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. The name of the author may not be used to endorse or promote
21  *    products derived from this software without specific prior written
22  *    permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  * $FreeBSD: src/lib/libutil/libutil.h,v 1.42 2006/02/18 11:25:28 des Exp $
37  */
38 
39 #ifndef _LIBUTIL_H_
40 #define	_LIBUTIL_H_
41 
42 
43 #ifdef _BSD_SOURCE
44 
45 
46 #include <stdint.h>
47 #include <sys/cdefs.h>
48 #include <sys/types.h>
49 
50 #define PROPERTY_MAX_NAME	64
51 #define PROPERTY_MAX_VALUE	512
52 
53 /* for properties.c */
54 typedef struct _property {
55 	struct _property *next;
56 	char *name;
57 	char *value;
58 } *properties;
59 
60 #ifdef _SYS_PARAM_H
61 /* for pidfile.c */
62 struct pidfh {
63 	int	pf_fd;
64 	char	pf_path[MAXPATHLEN + 1];
65 	dev_t	pf_dev;
66 	ino_t	pf_ino;
67 };
68 #endif
69 
70 /* Avoid pulling in all the include files for no need */
71 struct termios;
72 struct winsize;
73 struct utmp;
74 struct in_addr;
75 
76 __BEGIN_DECLS
77 void	clean_environment(const char * const *_white,
78 	    const char * const *_more_white);
79 int	extattr_namespace_to_string(int _attrnamespace, char **_string);
80 int	extattr_string_to_namespace(const char *_string, int *_attrnamespace);
81 void	login(struct utmp *_ut);
82 int	login_tty(int _fd);
83 int	logout(const char *_line);
84 void	logwtmp(const char *_line, const char *_name, const char *_host);
85 void	trimdomain(char *_fullhost, int _hostsize);
86 int	humanize_number(char *_buf, size_t _len, int64_t _number,
87 	    const char *_suffix, int _scale, int _flags);
88 const char *uu_lockerr(int _uu_lockresult);
89 int	uu_lock(const char *_ttyname);
90 int	uu_unlock(const char *_ttyname);
91 int	uu_lock_txfr(const char *_ttyname, pid_t _pid);
92 int	_secure_path(const char *_path, uid_t _uid, gid_t _gid);
93 properties properties_read(int fd);
94 void	properties_free(properties list);
95 char	*property_find(properties list, const char *name);
96 char	*auth_getval(const char *name);
97 int	realhostname(char *host, size_t hsize, const struct in_addr *ip);
98 struct sockaddr;
99 int	realhostname_sa(char *host, size_t hsize, struct sockaddr *addr,
100 			     int addrlen);
101 
102 int	kld_isloaded(const char *name);
103 int	kld_load(const char *name);
104 
105 #ifdef _STDIO_H_	/* avoid adding new includes */
106 char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
107 #endif
108 
109 #ifdef _PWD_H_
110 int	pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw);
111 struct passwd *pw_dup(const struct passwd *_pw);
112 int	pw_edit(int _notsetuid);
113 int	pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
114 void	pw_fini(void);
115 int	pw_init(const char *_dir, const char *_master);
116 char	*pw_make(const struct passwd *_pw);
117 int	pw_mkdb(const char *_user);
118 int	pw_lock(void);
119 struct passwd *pw_scan(const char *_line, int _flags);
120 const char *pw_tempname(void);
121 int	pw_tmp(int _mfd);
122 #endif
123 
124 #ifdef _SYS_PARAM_H
125 struct pidfh *pidfile_open(const char *path, mode_t mode, pid_t *pidptr);
126 int pidfile_write(struct pidfh *pfh);
127 int pidfile_close(struct pidfh *pfh);
128 int pidfile_remove(struct pidfh *pfh);
129 #endif
130 
131 __END_DECLS
132 
133 #define UU_LOCK_INUSE (1)
134 #define UU_LOCK_OK (0)
135 #define UU_LOCK_OPEN_ERR (-1)
136 #define UU_LOCK_READ_ERR (-2)
137 #define UU_LOCK_CREAT_ERR (-3)
138 #define UU_LOCK_WRITE_ERR (-4)
139 #define UU_LOCK_LINK_ERR (-5)
140 #define UU_LOCK_TRY_ERR (-6)
141 #define UU_LOCK_OWNER_ERR (-7)
142 
143 /* return values from realhostname() */
144 #define HOSTNAME_FOUND		(0)
145 #define HOSTNAME_INCORRECTNAME	(1)
146 #define HOSTNAME_INVALIDADDR	(2)
147 #define HOSTNAME_INVALIDNAME	(3)
148 
149 /* fparseln(3) */
150 #define	FPARSELN_UNESCESC	0x01
151 #define	FPARSELN_UNESCCONT	0x02
152 #define	FPARSELN_UNESCCOMM	0x04
153 #define	FPARSELN_UNESCREST	0x08
154 #define	FPARSELN_UNESCALL	0x0f
155 
156 /* pw_scan() */
157 #define PWSCAN_MASTER		0x01
158 #define PWSCAN_WARN		0x02
159 
160 /* humanize_number(3) */
161 #define HN_DECIMAL		0x01
162 #define HN_NOSPACE		0x02
163 #define HN_B			0x04
164 #define HN_DIVISOR_1000		0x08
165 
166 #define HN_GETSCALE		0x10
167 #define HN_AUTOSCALE		0x20
168 
169 
170 #endif
171 
172 
173 #endif /* !_LIBUTIL_H_ */
174