xref: /dragonfly/lib/libutil/libutil.h (revision 49781055)
1 /*
2  * Copyright (c) 1996  Peter Wemm <peter@FreeBSD.org>.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, is permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/lib/libutil/libutil.h,v 1.26.2.3 2000/11/22 03:49:49 murray Exp $
27  * $DragonFly: src/lib/libutil/libutil.h,v 1.7 2005/08/01 16:13:20 joerg Exp $
28  */
29 
30 #ifndef _LIBUTIL_H_
31 #define	_LIBUTIL_H_
32 
33 #include <sys/cdefs.h>
34 
35 #ifdef _PWD_H_
36 #define	_PWSCAN_MASTER	0x01
37 #define	_PWSCAN_WARN	0x02
38 #endif
39 
40 #define PROPERTY_MAX_NAME	64
41 #define PROPERTY_MAX_VALUE	512
42 
43 /* for properties.c */
44 typedef struct _property {
45 	struct _property *next;
46 	char *name;
47 	char *value;
48 } *properties;
49 
50 /* Avoid pulling in all the include files for no need */
51 struct termios;
52 struct winsize;
53 struct utmp;
54 struct in_addr;
55 struct sockaddr;
56 
57 __BEGIN_DECLS
58 void	login(struct utmp *);
59 int	login_tty(int);
60 int	logout(const char *);
61 void	logwtmp(const char *, const char *, const char *);
62 void	trimdomain(char *, int);
63 int	openpty(int *, int *, char *, struct termios *, struct winsize *);
64 int	forkpty(int *, char *, struct termios *, struct winsize *);
65 int	humanize_number(char *, size_t, int64_t, const char *, int, int);
66 const char *uu_lockerr(int);
67 int	uu_lock(const char *);
68 int	uu_unlock(const char *);
69 int	uu_lock_txfr(const char *, pid_t);
70 int	_secure_path(const char *, uid_t, gid_t);
71 int	pidfile(const char *);
72 properties properties_read(int fd);
73 void	properties_free(properties);
74 char	*property_find(properties, const char *);
75 char	*auth_getval(const char *);
76 int	realhostname(char *, size_t, const struct in_addr *);
77 int	realhostname_sa(char *, size_t, struct sockaddr *, int);
78 #ifdef _STDIO_H_	/* avoid adding new includes */
79 char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
80 #endif
81 
82 #ifdef _PWD_H_
83 int	__pw_scan(char *, struct passwd *, int);
84 int	pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw);
85 struct passwd *pw_dup(const struct passwd *_pw);
86 int	pw_edit(int _notsetuid);
87 int	pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
88 void	pw_fini(void);
89 int	pw_init(const char *_dir, const char *_master);
90 char	*pw_make(const struct passwd *_pw);
91 int	pw_mkdb(const char *_user);
92 int	pw_lock(void);
93 struct passwd *pw_scan(const char *_line, int _flags);
94 const char *pw_tempname(void);
95 int	pw_tmp(int _mfd);
96 #endif
97 __END_DECLS
98 
99 #define UU_LOCK_INUSE (1)
100 #define UU_LOCK_OK (0)
101 #define UU_LOCK_OPEN_ERR (-1)
102 #define UU_LOCK_READ_ERR (-2)
103 #define UU_LOCK_CREAT_ERR (-3)
104 #define UU_LOCK_WRITE_ERR (-4)
105 #define UU_LOCK_LINK_ERR (-5)
106 #define UU_LOCK_TRY_ERR (-6)
107 #define UU_LOCK_OWNER_ERR (-7)
108 
109 /* return values from realhostname() */
110 #define HOSTNAME_FOUND		(0)
111 #define HOSTNAME_INCORRECTNAME	(1)
112 #define HOSTNAME_INVALIDADDR	(2)
113 #define HOSTNAME_INVALIDNAME	(3)
114 
115 /* fparseln(3) */
116 #define	FPARSELN_UNESCESC	0x01
117 #define	FPARSELN_UNESCCONT	0x02
118 #define	FPARSELN_UNESCCOMM	0x04
119 #define	FPARSELN_UNESCREST	0x08
120 #define	FPARSELN_UNESCALL	0x0f
121 
122 /* humanize_number(3) */
123 #define HN_DECIMAL		0x01
124 #define HN_NOSPACE		0x02
125 #define HN_B			0x04
126 #define HN_DIVISOR_1000		0x08
127 #define HN_GETSCALE		0x10
128 #define HN_AUTOSCALE		0x20
129 
130 #endif /* !_LIBUTIL_H_ */
131