xref: /freebsd/sys/sys/un.h (revision 0bd8eb3e08d9720ee3814b29da16a9fd0044c83f)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1986, 1993
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 _SYS_UN_H_
33 #define _SYS_UN_H_
34 
35 #include <sys/cdefs.h>
36 #include <sys/_types.h>
37 
38 #ifndef _SA_FAMILY_T_DECLARED
39 typedef	__sa_family_t	sa_family_t;
40 #define	_SA_FAMILY_T_DECLARED
41 #endif
42 
43 /*
44  * Historically, (struct sockaddr) needed to fit inside an mbuf.
45  * For this reason, UNIX domain sockets were therefore limited to
46  * 104 bytes. While this limit is no longer necessary, it is kept for
47  * binary compatibility reasons.
48  */
49 #define	SUNPATHLEN	104
50 
51 /*
52  * Definitions for UNIX IPC domain.
53  */
54 struct sockaddr_un {
55 	unsigned char	sun_len;	/* sockaddr len including null */
56 	sa_family_t	sun_family;	/* AF_UNIX */
57 	char	sun_path[SUNPATHLEN];	/* path name (gag) */
58 };
59 
60 #if __BSD_VISIBLE
61 
62 #define	SOL_LOCAL		0	/* Options for local socket */
63 
64 /* Socket options. */
65 #define	LOCAL_PEERCRED		1	/* retrieve peer credentials */
66 #define	LOCAL_CREDS		2	/* pass credentials to receiver */
67 #define	LOCAL_CREDS_PERSISTENT	3	/* pass credentials to receiver */
68 
69 /* Start of reserved space for third-party socket options. */
70 #define	LOCAL_VENDOR		SO_VENDOR
71 
72 #ifndef _KERNEL
73 
74 /* actual length of an initialized sockaddr_un */
75 #define SUN_LEN(su) \
76 	(sizeof(*(su)) - sizeof((su)->sun_path) + strlen((su)->sun_path))
77 
78 #endif /* !_KERNEL */
79 
80 #endif /* __BSD_VISIBLE */
81 
82 #endif /* !_SYS_UN_H_ */
83