libutil.h revision 74435 
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: head/lib/libutil/libutil.h 74435 2001-03-19 05:04:30Z rwatson $
27 */
28
29#ifndef _LIBUTIL_H_
30#define	_LIBUTIL_H_
31
32#include <sys/cdefs.h>
33
34#define PROPERTY_MAX_NAME	64
35#define PROPERTY_MAX_VALUE	512
36
37/* for properties.c */
38typedef struct _property {
39	struct _property *next;
40	char *name;
41	char *value;
42} *properties;
43
44/* Avoid pulling in all the include files for no need */
45struct termios;
46struct winsize;
47struct utmp;
48struct in_addr;
49
50__BEGIN_DECLS
51int	extattr_namespace_to_string __P((int attrnamespace, char **string));
52int	extattr_string_to_namespace __P((const char *string,
53					 int *attrnamespace));
54void	login __P((struct utmp *_ut));
55int	login_tty __P((int _fd));
56int	logout __P((const char *_line));
57void	logwtmp __P((const char *_line, const char *_name, const char *_host));
58void	trimdomain __P((char *_fullhost, int _hostsize));
59int	openpty __P((int *_amaster, int *_aslave, char *_name,
60		     struct termios *_termp, struct winsize *_winp));
61int	forkpty __P((int *_amaster, char *_name,
62		     struct termios *_termp, struct winsize *_winp));
63const char *uu_lockerr __P((int _uu_lockresult));
64int	uu_lock __P((const char *_ttyname));
65int	uu_unlock __P((const char *_ttyname));
66int	uu_lock_txfr __P((const char *_ttyname, pid_t _pid));
67int	_secure_path __P((const char *_path, uid_t _uid, gid_t _gid));
68properties properties_read __P((int fd));
69void	properties_free __P((properties list));
70char	*property_find __P((properties list, const char *name));
71char	*auth_getval __P((const char *name));
72int	realhostname __P((char *host, size_t hsize, const struct in_addr *ip));
73struct sockaddr;
74int	realhostname_sa __P((char *host, size_t hsize, struct sockaddr *addr,
75			     int addrlen));
76#ifdef _STDIO_H_	/* avoid adding new includes */
77char   *fparseln __P((FILE *, size_t *, size_t *, const char[3], int));
78#endif
79__END_DECLS
80
81#define UU_LOCK_INUSE (1)
82#define UU_LOCK_OK (0)
83#define UU_LOCK_OPEN_ERR (-1)
84#define UU_LOCK_READ_ERR (-2)
85#define UU_LOCK_CREAT_ERR (-3)
86#define UU_LOCK_WRITE_ERR (-4)
87#define UU_LOCK_LINK_ERR (-5)
88#define UU_LOCK_TRY_ERR (-6)
89#define UU_LOCK_OWNER_ERR (-7)
90
91/* return values from realhostname() */
92#define HOSTNAME_FOUND		(0)
93#define HOSTNAME_INCORRECTNAME	(1)
94#define HOSTNAME_INVALIDADDR	(2)
95#define HOSTNAME_INVALIDNAME	(3)
96
97/* fparseln(3) */
98#define	FPARSELN_UNESCESC	0x01
99#define	FPARSELN_UNESCCONT	0x02
100#define	FPARSELN_UNESCCOMM	0x04
101#define	FPARSELN_UNESCREST	0x08
102#define	FPARSELN_UNESCALL	0x0f
103
104#endif /* !_LIBUTIL_H_ */
105