Home | History | Annotate | Line # | Download | only in common
      1 /*	$NetBSD: linux_socket.h,v 1.27 2025/06/28 18:47:36 christos Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1995, 1998 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Frank van der Linden and Eric Haszlakiewicz.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _LINUX_SOCKET_H
     33 #define _LINUX_SOCKET_H
     34 
     35 /*
     36  * Various Linux socket defines. Everything that is not re-defined here
     37  * is the same as in NetBSD.
     38  *
     39  * COMPAT_43 is assumed, and the osockaddr struct is used (it is what
     40  * Linux uses)
     41  */
     42 
     43 /*
     44  * Address families. There are fewer of them, and they're numbered
     45  * a bit different
     46  */
     47 
     48 #define LINUX_AF_UNSPEC		0
     49 #define LINUX_AF_UNIX		1
     50 #define LINUX_AF_INET		2
     51 #define LINUX_AF_AX25		3
     52 #define LINUX_AF_IPX		4
     53 #define LINUX_AF_APPLETALK	5
     54 #define LINUX_AF_NETROM		6
     55 #define LINUX_AF_BRIDGE		7
     56 #define LINUX_AF_ATMPVC		8
     57 #define LINUX_AF_X25		9
     58 #define LINUX_AF_INET6		10
     59 #define LINUX_AF_ROSE		11
     60 #define LINUX_AF_DECnet		12
     61 #define LINUX_AF_NETBEUI	13
     62 #define LINUX_AF_SECURITY	14
     63 #define LINUX_pseudo_AF_KEY	15
     64 #define LINUX_AF_NETLINK	16
     65 #define LINUX_AF_PACKET		17
     66 #define LINUX_AF_ASH		18
     67 #define LINUX_AF_ECONET		19
     68 #define LINUX_AF_ATMSVC		20
     69 #define LINUX_AF_SNA		22
     70 #define LINUX_AF_MAX		32
     71 
     72 /*
     73  * Option levels for [gs]etsockopt(2). Only SOL_SOCKET is different,
     74  * the rest matches IPPROTO_XXX
     75  */
     76 
     77 /* SOL_SOCKET is machine dependent on Linux */
     78 #define LINUX_SOL_IP		0
     79 #define LINUX_SOL_TCP		6
     80 #define LINUX_SOL_UDP		17
     81 #define LINUX_SOL_IPV6		41
     82 /* Unused for now: */
     83 #define LINUX_SOL_ICMPV6	58
     84 #define LINUX_SOL_RAW		255
     85 #define LINUX_SOL_IPX		256
     86 #define LINUX_SOL_AX25		257
     87 #define LINUX_SOL_ATALK		258
     88 #define LINUX_SOL_NETROM	259
     89 #define LINUX_SOL_ROSE		260
     90 #define LINUX_SOL_DECNET	261
     91 #define LINUX_SOL_X25		262
     92 #define LINUX_SOL_PACKET	263
     93 #define LINUX_SOL_ATM		264
     94 #define LINUX_SOL_AAL		265
     95 
     96 /*
     97  * Options for [gs]etsockopt(2), socket level are machine dependent.
     98  */
     99 
    100 /*
    101  * Options for [gs]etsockopt(2), IP level.
    102  */
    103 
    104 #define LINUX_IP_TOS		1
    105 #define LINUX_IP_TTL		2
    106 #define LINUX_IP_HDRINCL	3
    107 #define LINUX_IP_RECVOPTS	6
    108 #define LINUX_IP_RETOPTS	7
    109 #define LINUX_IP_PKTINFO	8
    110 #define LINUX_IP_RECVERR	11
    111 #define LINUX_IP_FREEBIND	15
    112 #define LINUX_IP_MULTICAST_IF	32
    113 #define LINUX_IP_MULTICAST_TTL	33
    114 #define LINUX_IP_MULTICAST_LOOP	34
    115 #define LINUX_IP_ADD_MEMBERSHIP	35
    116 #define LINUX_IP_DROP_MEMBERSHIP 36
    117 #define LINUX_IP_MULTICAST_ALL	49
    118 
    119 /*
    120  * Options for [gs]etsockopt(2), IPV6 level.
    121  */
    122 
    123 #define LINUX_IPV6_V6ONLY		26
    124 #define LINUX_IPV6_MULTICAST_HOPS	18
    125 #define LINUX_IPV6_MULTICAST_ALL	29
    126 
    127 /*
    128  * Options for [gs]etsockopt(2), TCP level.
    129  */
    130 
    131 #define LINUX_TCP_NODELAY	1
    132 #define LINUX_TCP_MAXSEG	2
    133 
    134 /* "Socket"-level control message types: */
    135 #define LINUX_SCM_RIGHTS	1	/* same as SCM_RIGHTS */
    136 #define LINUX_SCM_CREDENTIALS	2	/* accepts ucred rather than sockcred */
    137 #define LINUX_SCM_CONNECT	3	/* not supported in NetBSD */
    138 #define LINUX_SCM_TIMESTAMP	LINUX_SO_TIMESTAMP
    139 				/* not actually implemented in Linux 2.5.15? */
    140 
    141 struct linux_msghdr {
    142 	void		*msg_name;
    143 	int		msg_namelen;
    144 	struct iovec	*msg_iov;
    145 	size_t		msg_iovlen;
    146 	void		*msg_control;
    147 	size_t		msg_controllen;
    148 	unsigned int	msg_flags;
    149 };
    150 
    151 struct linux_mmsghdr {
    152 	struct linux_msghdr msg_hdr;
    153 	unsigned int msg_len;
    154 };
    155 
    156 /*
    157  * Message flags (for sendmsg/recvmsg)
    158  */
    159 #define LINUX_MSG_OOB		0x001
    160 #define LINUX_MSG_PEEK		0x002
    161 #define LINUX_MSG_DONTROUTE	0x004
    162 #define LINUX_MSG_TRYHARD	0x004
    163 #define LINUX_MSG_CTRUNC	0x008
    164 #define LINUX_MSG_PROBE		0x010	/* Don't send, only probe path */
    165 #define LINUX_MSG_TRUNC		0x020
    166 #define LINUX_MSG_DONTWAIT	0x040	/* this msg should be nonblocking */
    167 #define LINUX_MSG_EOR		0x080	/* data completes record */
    168 #define LINUX_MSG_WAITALL	0x100	/* wait for full request or error */
    169 #define LINUX_MSG_FIN		0x200
    170 #define LINUX_MSG_EOF		LINUX_MSG_FIN
    171 #define LINUX_MSG_SYN		0x400
    172 #define LINUX_MSG_CONFIRM	0x800	/* Confirm path validity */
    173 #define LINUX_MSG_RST		0x1000
    174 #define LINUX_MSG_ERRQUEUE	0x2000	/* fetch message from error queue */
    175 #define LINUX_MSG_NOSIGNAL	0x4000	/* do not generate SIGPIPE */
    176 #define LINUX_MSG_MORE		0x8000	/* Sender will send more */
    177 
    178 /*
    179  * Linux alignment requirement for CMSG struct manipulation.
    180  * Linux aligns on (size_t) boundary on all architectures.
    181  * Fortunately for linux, linux_cmsghdr is always size_t aligned !
    182  * since no padding is added between the header and data.
    183  * XXX: this code isn't right for the compat32 code.
    184  */
    185 struct linux_cmsghdr {
    186 	size_t	cmsg_len;	/* NB not socklen_t */
    187 	int	cmsg_level;
    188 	int	cmsg_type;
    189     /*	unsigned char __cmsg_data[0]; */
    190 };
    191 
    192 #define LINUX_CMSG_ALIGN(n)	\
    193 	(((n) + sizeof(size_t)-1) & ~(sizeof(size_t)-1))
    194 /* Linux either uses this, or  &((cmsg)->__cmsg_data) */
    195 #define LINUX_CMSG_DATA(cmsg)	\
    196 	((u_char *)((struct linux_cmsghdr *)(cmsg) + 1))
    197 #define LINUX_CMSG_NXTHDR(mhdr, ucmsg, kcmsg)	\
    198 	((((char *)(ucmsg) + LINUX_CMSG_ALIGN((kcmsg)->cmsg_len) + \
    199 			    sizeof(*(ucmsg))) > \
    200 	    (((char *)(mhdr)->msg_control) + (mhdr)->msg_controllen)) ? \
    201 	    (struct linux_cmsghdr *)NULL : \
    202 	    (struct linux_cmsghdr *)((char *)(ucmsg) + \
    203 	        LINUX_CMSG_ALIGN((kcmsg)->cmsg_len)))
    204 /* This the number of bytes removed from each item (excl. final padding) */
    205 #define LINUX_CMSG_ALIGN_DELTA	\
    206 	(CMSG_ALIGN(sizeof(struct cmsghdr)) - sizeof(struct linux_cmsghdr))
    207 
    208 #define LINUX_CMSG_FIRSTHDR(mhdr) \
    209 	((mhdr)->msg_controllen >= sizeof(struct linux_cmsghdr) ? \
    210 	(struct linux_cmsghdr *)(mhdr)->msg_control : NULL)
    211 
    212 #define LINUX_CMSG_SPACE(l) \
    213 	(sizeof(struct linux_cmsghdr) + LINUX_CMSG_ALIGN(l))
    214 #define LINUX_CMSG_LEN(l) \
    215 	(sizeof(struct linux_cmsghdr) + (l))
    216 
    217 /*
    218  * Machine specific definitions.
    219  */
    220 #if defined(__i386__)
    221 #include <compat/linux/arch/i386/linux_socket.h>
    222 #elif defined(__m68k__)
    223 #include <compat/linux/arch/m68k/linux_socket.h>
    224 #elif defined(__alpha__)
    225 #include <compat/linux/arch/alpha/linux_socket.h>
    226 #elif defined(__powerpc__)
    227 #include <compat/linux/arch/powerpc/linux_socket.h>
    228 #elif defined(__mips__)
    229 #include <compat/linux/arch/mips/linux_socket.h>
    230 #elif defined(__aarch64__)
    231 #include <compat/linux/arch/aarch64/linux_socket.h>
    232 #elif defined(__arm__)
    233 #include <compat/linux/arch/arm/linux_socket.h>
    234 #elif defined(__amd64__)
    235 #include <compat/linux/arch/amd64/linux_socket.h>
    236 #else
    237 #error Undefined linux_socket.h machine type.
    238 #endif
    239 
    240 /*
    241  * Flags for socket().
    242  * These are provided in the "type" parameter.
    243  */
    244 
    245 #define LINUX_SOCK_TYPE_MASK	0xf
    246 #define LINUX_SOCK_CLOEXEC	LINUX_O_CLOEXEC
    247 #ifndef LINUX_SOCK_NONBLOCK
    248 #define LINUX_SOCK_NONBLOCK	LINUX_O_NONBLOCK
    249 #endif
    250 
    251 #endif /* !_LINUX_SOCKET_H */
    252