xref: /haiku/headers/posix/sys/socket.h (revision fc1ca2da5cfcb00ffdf791606d5ae97fdd58a638)
1 /*
2  * Copyright 2002-2007, Haiku Inc. All Rights Reserved.
3  * Distributed under the terms of the MIT License.
4  */
5 #ifndef _SYS_SOCKET_H
6 #define _SYS_SOCKET_H
7 
8 
9 #include <stdint.h>
10 #include <sys/param.h>
11 #include <sys/types.h>
12 #include <sys/uio.h>
13 
14 
15 typedef uint32_t socklen_t;
16 
17 /* Address families */
18 #define AF_UNSPEC		0
19 #define AF_INET			1
20 #define AF_APPLETALK	2
21 #define AF_ROUTE		3
22 #define AF_LINK			4
23 #define AF_INET6		5
24 #define AF_DLI			6
25 #define AF_IPX			7
26 #define AF_NOTIFY		8
27 #define AF_LOCAL		9
28 #define AF_UNIX			AF_LOCAL
29 #define AF_MAX			10
30 
31 /* Protocol families, deprecated */
32 #define PF_UNSPEC		AF_UNSPEC
33 #define PF_INET			AF_INET
34 #define PF_ROUTE		AF_ROUTE
35 #define PF_LINK			AF_LINK
36 #define PF_INET6		AF_INET6
37 #define PF_LOCAL		AF_LOCAL
38 #define PF_UNIX			AF_UNIX
39 
40 /* Socket types */
41 #define	SOCK_STREAM	1
42 #define	SOCK_DGRAM	2
43 #define	SOCK_RAW	3
44 #define SOCK_MISC	255
45 
46 /* Socket options for SOL_SOCKET level */
47 #define	SOL_SOCKET		-1
48 
49 #define SO_ACCEPTCONN	0x00000001	/* socket has had listen() */
50 #define SO_BROADCAST	0x00000002	/* permit sending of broadcast msgs */
51 #define	SO_DEBUG		0x00000004	/* turn on debugging info recording */
52 #define	SO_DONTROUTE	0x00000008	/* just use interface addresses */
53 #define	SO_KEEPALIVE	0x00000010	/* keep connections alive */
54 #define SO_OOBINLINE	0x00000020	/* leave received OOB data in line */
55 #define	SO_REUSEADDR	0x00000040	/* allow local address reuse */
56 #define SO_REUSEPORT	0x00000080	/* allow local address & port reuse */
57 #define SO_USELOOPBACK	0x00000100	/* bypass hardware when possible */
58 #define SO_LINGER		0x00000200	/* linger on close if data present */
59 
60 #define SO_SNDBUF		0x40000001	/* send buffer size */
61 #define SO_SNDLOWAT		0x40000002	/* send low-water mark */
62 #define SO_SNDTIMEO		0x40000003	/* send timeout */
63 #define SO_RCVBUF		0x40000004	/* receive buffer size */
64 #define SO_RCVLOWAT		0x40000005	/* receive low-water mark */
65 #define SO_RCVTIMEO		0x40000006	/* receive timeout */
66 #define	SO_ERROR		0x40000007	/* get error status and clear */
67 #define	SO_TYPE			0x40000008	/* get socket type */
68 #define SO_NONBLOCK		0x40000009
69 #define SO_BINDTODEVICE	0x4000000a
70 
71 /* Shutdown options */
72 #define SHUT_RD			0
73 #define SHUT_WR			1
74 #define SHUT_RDWR		2
75 
76 #define SOMAXCONN		32		/* Max listen queue for a socket */
77 
78 struct linger {
79 	int			l_onoff;
80 	int			l_linger;
81 };
82 
83 struct sockaddr {
84 	uint8_t		sa_len;
85 	uint8_t		sa_family;
86 	uint8_t		sa_data[30];
87 };
88 
89 struct sockaddr_storage {
90 	uint8_t		ss_len;			/* total length */
91 	uint8_t		ss_family;		/* address family */
92 	uint8_t		__ss_pad1[6];	/* align to quad */
93 	uint64_t	__ss_pad2;		/* force alignment to 64 bit */
94 	uint8_t		__ss_pad3[112];	/* pad to a total of 128 bytes */
95 };
96 
97 struct msghdr {
98 	void		*msg_name;		/* address we're using (optional) */
99 	socklen_t	msg_namelen;	/* length of address */
100 	struct iovec *msg_iov;		/* scatter/gather array we'll use */
101 	int			msg_iovlen;		/* # elements in msg_iov */
102 	void		*msg_control;	/* extra data */
103 	socklen_t	msg_controllen;	/* length of extra data */
104 	int			msg_flags;		/* flags */
105 };
106 
107 /* Flags for the msghdr.msg_flags field */
108 #define MSG_OOB			0x0001	/* process out-of-band data */
109 #define MSG_PEEK		0x0002	/* peek at incoming message */
110 #define MSG_DONTROUTE	0x0004	/* send without using routing tables */
111 #define MSG_EOR			0x0008	/* data completes record */
112 #define MSG_TRUNC		0x0010	/* data discarded before delivery */
113 #define MSG_CTRUNC		0x0020	/* control data lost before delivery */
114 #define MSG_WAITALL		0x0040	/* wait for full request or error */
115 #define MSG_DONTWAIT	0x0080	/* this message should be nonblocking */
116 #define MSG_BCAST		0x0100	/* this message rec'd as broadcast */
117 #define MSG_MCAST		0x0200	/* this message rec'd as multicast */
118 #define	MSG_EOF			0x0400	/* data completes connection */
119 
120 struct cmsghdr {
121 	socklen_t	cmsg_len;
122 	int			cmsg_level;
123 	int			cmsg_type;
124 	/* data follows */
125 };
126 
127 /* cmsghdr access macros */
128 #define	CMSG_DATA(cmsg) ((unsigned char *)(cmsg) \
129 	+ _ALIGN(sizeof(struct cmsghdr)))
130 #define	CMSG_NXTHDR(mhdr, cmsg)	\
131 	(((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len) \
132 	+ _ALIGN(sizeof(struct cmsghdr)) \
133 		> (char *)(mhdr)->msg_control + (mhdr)->msg_controllen) \
134 		? (struct cmsghdr *)NULL \
135 		: (struct cmsghdr *)((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len)))
136 #define	CMSG_FIRSTHDR(mhdr) \
137 	((mhdr)->msg_controllen >= sizeof(struct cmsghdr) \
138 	? (struct cmsghdr *)(mhdr)->msg_control \
139 	: (struct cmsghdr *)NULL)
140 #define	CMSG_SPACE(len) (_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(len))
141 #define	CMSG_LEN(len)	(_ALIGN(sizeof(struct cmsghdr)) + (len))
142 #define	CMSG_ALIGN(len)	_ALIGN(len)
143 
144 /* SOL_SOCKET control message types */
145 #define SCM_RIGHTS	0x01
146 
147 
148 #if __cplusplus
149 extern "C" {
150 #endif
151 
152 int 	accept(int socket, struct sockaddr *address, socklen_t *_addressLength);
153 int		bind(int socket, const struct sockaddr *address,
154 			socklen_t addressLength);
155 int		connect(int socket, const struct sockaddr *address,
156 			socklen_t addressLength);
157 int     getpeername(int socket, struct sockaddr *address,
158 			socklen_t *_addressLength);
159 int     getsockname(int socket, struct sockaddr *address,
160 			socklen_t *_addressLength);
161 int     getsockopt(int socket, int level, int option, void *value,
162 			socklen_t *_length);
163 int		listen(int socket, int backlog);
164 ssize_t recv(int socket, void *buffer, size_t length, int flags);
165 ssize_t recvfrom(int socket, void *buffer, size_t bufferLength, int flags,
166 			struct sockaddr *address, socklen_t *_addressLength);
167 ssize_t recvmsg(int socket, struct msghdr *message, int flags);
168 ssize_t send(int socket, const void *buffer, size_t length, int flags);
169 ssize_t	sendmsg(int socket, const struct msghdr *message, int flags);
170 ssize_t sendto(int socket, const void *message, size_t length, int flags,
171 			const struct sockaddr *address, socklen_t addressLength);
172 int     setsockopt(int socket, int level, int option, const void *value,
173 			socklen_t length);
174 int		shutdown(int socket, int how);
175 int		socket(int domain, int type, int protocol);
176 int		sockatmark(int socket);
177 int		socketpair(int domain, int type, int protocol, int socketVector[2]);
178 
179 #if __cplusplus
180 }
181 #endif
182 
183 #endif	/* _SYS_SOCKET_H */
184