1 /*
2 * Copyright (c) 2006-2021, RT-Thread Development Team
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 *
6 * Change Logs:
7 * Date Author Notes
8 * 2018-05-24 ChenYong First version
9 */
10
11 #ifndef SAL_SOCKET_H__
12 #define SAL_SOCKET_H__
13
14 #include <stddef.h>
15 #include <arpa/inet.h>
16
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20
21 #if !defined(socklen_t) && !defined(SOCKLEN_T_DEFINED)
22 typedef uint32_t socklen_t;
23 #endif
24
25 #if !defined(sa_family_t) && !defined(SA_FAMILY_T_DEFINED)
26 typedef uint8_t sa_family_t;
27 #endif
28
29 /* If your port already typedef's in_port_t, define IN_PORT_T_DEFINED
30 to prevent this code from redefining it. */
31 #if !defined(in_port_t) && !defined(IN_PORT_T_DEFINED)
32 typedef uint16_t in_port_t;
33 #endif
34
35 /* Socket protocol types (TCP/UDP/RAW) */
36 #define SOCK_STREAM 1
37 #define SOCK_DGRAM 2
38 #define SOCK_RAW 3
39 #define SOCK_PACKET 10
40
41 #define SOCK_NONBLOCK 04000
42 #define SOCK_CLOEXEC 02000000
43
44 #define SOCK_MAX (SOCK_CLOEXEC + 1)
45
46 /* Option flags per-socket. These must match the SOF_ flags in ip.h (checked in init.c) */
47 #define SO_REUSEADDR 0x0004 /* Allow local address reuse */
48 #define SO_KEEPALIVE 0x0008 /* keep connections alive */
49 #define SO_BROADCAST 0x0020 /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */
50
51 #define SO_PASSCRED 16
52 #define SO_PEERCRED 17
53
54 #define SO_BINDTODEVICE 25
55 #define SO_ATTACH_FILTER 26
56 #define SO_DETACH_FILTER 27
57
58 #define SO_SNDBUFFORCE 32
59 #define SO_RCVBUFFORCE 33
60 #define SO_PROTOCOL 38
61 #define SO_DOMAIN 39
62
63 /* Additional options, not kept in so_options */
64 #define SO_DEBUG 0x0001 /* Unimplemented: turn on debugging info recording */
65 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
66 #define SO_DONTROUTE 0x0010 /* Unimplemented: just use interface addresses */
67 #define SO_USELOOPBACK 0x0040 /* Unimplemented: bypass hardware when possible */
68 #define SO_LINGER 0x0080 /* linger on close if data present */
69 #define SO_DONTLINGER ((int)(~SO_LINGER))
70 #define SO_OOBINLINE 0x0100 /* Unimplemented: leave received OOB data in line */
71 #define SO_REUSEPORT 0x0200 /* Unimplemented: allow local address & port reuse */
72 #define SO_SNDBUF 0x1001 /* Unimplemented: send buffer size */
73 #define SO_RCVBUF 0x1002 /* receive buffer size */
74 #define SO_SNDLOWAT 0x1003 /* Unimplemented: send low-water mark */
75 #define SO_RCVLOWAT 0x1004 /* Unimplemented: receive low-water mark */
76 #define SO_SNDTIMEO 0x1005 /* send timeout */
77 #define SO_RCVTIMEO 0x1006 /* receive timeout */
78 #define SO_ERROR 0x1007 /* get error status and clear */
79 #define SO_TYPE 0x1008 /* get socket type */
80 #define SO_CONTIMEO 0x1009 /* Unimplemented: connect timeout */
81 #define SO_NO_CHECK 0x100a /* don't create UDP checksum */
82
83 /* Level number for (get/set)sockopt() to apply to socket itself */
84 #define SOL_SOCKET 0xfff /* options for socket level */
85 #define SOL_NETLINK 270
86
87 #define AF_UNSPEC 0
88 #define AF_UNIX 1
89 #define AF_INET 2
90 #define AF_INET6 10
91 #define AF_NETLINK 16
92 #define AF_CAN 29 /* Controller Area Network */
93 #define AF_AT 45 /* AT socket */
94 #define AF_WIZ 46 /* WIZnet socket */
95 #define PF_UNIX AF_UNIX
96 #define PF_INET AF_INET
97 #define PF_INET6 AF_INET6
98 #define PF_NETLINK AF_NETLINK
99 #define PF_UNSPEC AF_UNSPEC
100 #define PF_CAN AF_CAN
101 #define PF_AT AF_AT
102 #define PF_WIZ AF_WIZ
103
104 #define AF_MAX (AF_WIZ + 1) /* For now.. */
105
106 #define IPPROTO_IP 0
107 #define IPPROTO_ICMP 1
108 #define IPPROTO_TCP 6
109 #define IPPROTO_UDP 17
110 #define IPPROTO_IPV6 41
111 #define IPPROTO_ICMPV6 58
112 #define IPPROTO_UDPLITE 136
113 #define IPPROTO_RAW 255
114
115 /* Flags we can use with send and recv */
116 #define MSG_PEEK 0x01 /* Peeks at an incoming message */
117 #define MSG_WAITALL 0x02 /* Unimplemented: Requests that the function block until the full amount of data requested can be returned */
118 #define MSG_OOB 0x04 /* Unimplemented: Requests out-of-band data. The significance and semantics of out-of-band data are protocol-specific */
119 #define MSG_DONTWAIT 0x08 /* Nonblocking i/o for this operation only */
120 #define MSG_MORE 0x10 /* Sender will send more */
121
122 #define MSG_ERRQUEUE 0x2000 /* Fetch message from error queue */
123 #define MSG_CONFIRM 0x0800 /* Confirm path validity */
124
125 /* Options for level IPPROTO_IP */
126 #define IP_TOS 1
127 #define IP_TTL 2
128
129 /* Options for level IPPROTO_TCP */
130 #define TCP_NODELAY 0x01 /* don't delay send to coalesce packets */
131 #define TCP_KEEPALIVE 0x02 /* send KEEPALIVE probes when idle for pcb->keep_idle milliseconds */
132 #define TCP_KEEPIDLE 0x03 /* set pcb->keep_idle - Same as TCP_KEEPALIVE, but use seconds for get/setsockopt */
133 #define TCP_KEEPINTVL 0x04 /* set pcb->keep_intvl - Use seconds for get/setsockopt */
134 #define TCP_KEEPCNT 0x05 /* set pcb->keep_cnt - Use number of probes sent for get/setsockopt */
135
136 /* Options and types related to multicast membership */
137 #define IP_ADD_MEMBERSHIP 3
138 #define IP_DROP_MEMBERSHIP 4
139 /* Options and types for UDP multicast traffic handling */
140 #define IP_MULTICAST_TTL 5
141 #define IP_MULTICAST_IF 6
142 #define IP_MULTICAST_LOOP 7
143
144 typedef struct ip_mreq
145 {
146 struct in_addr imr_multiaddr; /* IP multicast address of group */
147 struct in_addr imr_interface; /* local IP address of interface */
148 } ip_mreq;
149
150 /* The Type of Service provides an indication of the abstract parameters of the quality of service desired */
151 #define IPTOS_TOS_MASK 0x1E
152 #define IPTOS_TOS(tos) ((tos) & IPTOS_TOS_MASK)
153 #define IPTOS_LOWDELAY 0x10
154 #define IPTOS_THROUGHPUT 0x08
155 #define IPTOS_RELIABILITY 0x04
156 #define IPTOS_LOWCOST 0x02
157 #define IPTOS_MINCOST IPTOS_LOWCOST
158
159 /* The Network Control precedence designation is intended to be used within a network only */
160 #define IPTOS_PREC_MASK 0xe0
161 #define IPTOS_PREC(tos) ((tos) & IPTOS_PREC_MASK)
162 #define IPTOS_PREC_NETCONTROL 0xe0
163 #define IPTOS_PREC_INTERNETCONTROL 0xc0
164 #define IPTOS_PREC_CRITIC_ECP 0xa0
165 #define IPTOS_PREC_FLASHOVERRIDE 0x80
166 #define IPTOS_PREC_FLASH 0x60
167 #define IPTOS_PREC_IMMEDIATE 0x40
168 #define IPTOS_PREC_PRIORITY 0x20
169 #define IPTOS_PREC_ROUTINE 0x00
170
171 #define SCM_RIGHTS 0x01 /* rw: access rights (array of int) */
172 #define SCM_CREDENTIALS 0x02 /* rw: struct ucred */
173 #define SCM_SECURITY 0x03 /* rw: security label */
174
175 /* Options for shatdown type */
176 #ifndef SHUT_RD
177 #define SHUT_RD 0
178 #define SHUT_WR 1
179 #define SHUT_RDWR 2
180 #endif
181
182 struct sockaddr
183 {
184 uint8_t sa_len;
185 sa_family_t sa_family;
186 char sa_data[14];
187 };
188
189 /* Structure describing the address of an AF_LOCAL (aka AF_UNIX) socket. */
190 struct sockaddr_un
191 {
192 unsigned short sa_family;
193 char sun_path[108]; /* Path name. */
194 };
195
196 #if NETDEV_IPV4
197 /* members are in network byte order */
198 struct sockaddr_in
199 {
200 uint8_t sin_len;
201 sa_family_t sin_family;
202 in_port_t sin_port;
203 struct in_addr sin_addr;
204 #define SIN_ZERO_LEN 8
205 char sin_zero[SIN_ZERO_LEN];
206 };
207 #endif /* NETDEV_IPV4 */
208
209 #if NETDEV_IPV6
210 struct sockaddr_in6
211 {
212 uint8_t sin6_len; /* length of this structure */
213 sa_family_t sin6_family; /* AF_INET6 */
214 in_port_t sin6_port; /* Transport layer port # */
215 uint32_t sin6_flowinfo; /* IPv6 flow information */
216 struct in6_addr sin6_addr; /* IPv6 address */
217 uint32_t sin6_scope_id; /* Set of interfaces for scope */
218 };
219 #endif /* NETDEV_IPV6 */
220
221 struct sockaddr_storage
222 {
223 uint8_t s2_len;
224 sa_family_t ss_family;
225 char s2_data1[2];
226 uint32_t s2_data2[3];
227 #if NETDEV_IPV6
228 uint32_t s2_data3[3];
229 #endif /* NETDEV_IPV6 */
230 };
231
232 #ifdef RT_USING_MUSLLIBC
233 #ifndef __DEFINED_struct_iovec
234 struct iovec
235 {
236 void *iov_base;
237 size_t iov_len;
238 };
239 #endif
240 #endif
241
242 struct msghdr
243 {
244 void *msg_name;
245 socklen_t msg_namelen;
246 struct iovec *msg_iov;
247 int msg_iovlen;
248 void *msg_control;
249 socklen_t msg_controllen;
250 int msg_flags;
251 };
252
253 /* RFC 3542, Section 20: Ancillary Data */
254 struct cmsghdr
255 {
256 size_t cmsg_len; /* number of bytes, including header */
257 int cmsg_level; /* originating protocol */
258 int cmsg_type; /* protocol-specific type */
259 };
260
261 #define CMSG_NXTHDR(mhdr, cmsg) cmsg_nxthdr((mhdr), (cmsg))
262
263 #define CMSG_ALIGN(len) (((len) + sizeof(long) - 1) & ~(sizeof(long)-1))
264
265 #define CMSG_DATA(cmsg) ((void *)(cmsg) + sizeof(struct cmsghdr))
266 #define CMSG_SPACE(len) (sizeof(struct cmsghdr) + CMSG_ALIGN(len))
267 #define CMSG_LEN(len) (sizeof(struct cmsghdr) + (len))
268
269 #define __CMSG_FIRSTHDR(ctl, len) \
270 ((len) >= sizeof(struct cmsghdr) ? (struct cmsghdr *)(ctl) : (struct cmsghdr *)NULL)
271
272 #define CMSG_FIRSTHDR(msg) __CMSG_FIRSTHDR((msg)->msg_control, (msg)->msg_controllen)
273 #define CMSG_OK(mhdr, cmsg) \
274 ((cmsg)->cmsg_len >= sizeof(struct cmsghdr) && \
275 (cmsg)->cmsg_len <= (unsigned long)((mhdr)->msg_controllen - ((char *)(cmsg) - (char *)(mhdr)->msg_control)))
276
277 #define for_each_cmsghdr(cmsg, msg) \
278 for (cmsg = CMSG_FIRSTHDR(msg); cmsg; cmsg = CMSG_NXTHDR(msg, cmsg))
279
__cmsg_nxthdr(void * _ctl,size_t _size,struct cmsghdr * _cmsg)280 static inline struct cmsghdr *__cmsg_nxthdr(void *_ctl, size_t _size, struct cmsghdr *_cmsg)
281 {
282 struct cmsghdr *_ptr;
283
284 _ptr = (struct cmsghdr *)(((unsigned char *)_cmsg) + CMSG_ALIGN(_cmsg->cmsg_len));
285
286 if ((unsigned long)((char *)(_ptr + 1) - (char *)_ctl) > _size)
287 {
288 return (struct cmsghdr *)NULL;
289 }
290
291 return _ptr;
292 }
293
cmsg_nxthdr(struct msghdr * _msg,struct cmsghdr * _cmsg)294 static inline struct cmsghdr *cmsg_nxthdr(struct msghdr *_msg, struct cmsghdr *_cmsg)
295 {
296 return __cmsg_nxthdr(_msg->msg_control, _msg->msg_controllen, _cmsg);
297 }
298
299 #define IFNAMSIZ 16
300 struct sal_ifmap
301 {
302 unsigned long int mem_start;
303 unsigned long int mem_end;
304 unsigned short int base_addr;
305 unsigned char irq;
306 unsigned char dma;
307 unsigned char port;
308 };
309
310 struct sal_ifreq
311 {
312 union
313 {
314 char ifrn_name[IFNAMSIZ];
315 } ifr_ifrn;
316 union
317 {
318 struct sockaddr ifru_addr;
319 struct sockaddr ifru_dstaddr;
320 struct sockaddr ifru_broadaddr;
321 struct sockaddr ifru_netmask;
322 struct sockaddr ifru_hwaddr;
323 short int ifru_flags;
324 int ifru_ivalue;
325 int ifru_mtu;
326 struct sal_ifmap ifru_map;
327 char ifru_slave[IFNAMSIZ];
328 char ifru_newname[IFNAMSIZ];
329 char *ifru_data;
330 } ifr_ifru;
331 };
332
333 int sal_accept(int socket, struct sockaddr *addr, socklen_t *addrlen);
334 int sal_bind(int socket, const struct sockaddr *name, socklen_t namelen);
335 int sal_shutdown(int socket, int how);
336 int sal_getpeername (int socket, struct sockaddr *name, socklen_t *namelen);
337 int sal_getsockname (int socket, struct sockaddr *name, socklen_t *namelen);
338 int sal_getsockopt (int socket, int level, int optname, void *optval, socklen_t *optlen);
339 int sal_setsockopt (int socket, int level, int optname, const void *optval, socklen_t optlen);
340 int sal_connect(int socket, const struct sockaddr *name, socklen_t namelen);
341 int sal_listen(int socket, int backlog);
342 int sal_sendmsg(int socket, const struct msghdr *message, int flags);
343 int sal_recvmsg(int socket, struct msghdr *message, int flags);
344 int sal_recvfrom(int socket, void *mem, size_t len, int flags,
345 struct sockaddr *from, socklen_t *fromlen);
346 int sal_sendto(int socket, const void *dataptr, size_t size, int flags,
347 const struct sockaddr *to, socklen_t tolen);
348 int sal_socket(int domain, int type, int protocol);
349 int sal_socketpair(int domain, int type, int protocol, int *fds);
350 int sal_closesocket(int socket);
351 int sal_ioctlsocket(int socket, long cmd, void *arg);
352
353 #ifdef __cplusplus
354 }
355 #endif
356
357 #endif /* SAL_SOCKET_H__ */
358