更新日期: 2022/06/01 来源: https://gitee.com/weharmony/kernel_liteos_a_note
socket.c
浏览该文件的文档.
1/*
2 * Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved.
3 * Copyright (c) 2020-2021 Huawei Device Co., Ltd. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this list of
9 * conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
12 * of conditions and the following disclaimer in the documentation and/or other materials
13 * provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
16 * to endorse or promote products derived from this software without specific prior written
17 * permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
26 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#include <los_config.h>
33#include <arpa/inet.h>
34#include <sys/socket.h>
35
36/**
37
38https://www.cnblogs.com/sparkdev/p/8341134.html
39*/
40
41#ifdef LOSCFG_NET_LWIP_SACK
42#include <lwip/sockets.h>
43
44#if !LWIP_COMPAT_SOCKETS
45
46#define CHECK_NULL_PTR(ptr) do { if (ptr == NULL) { set_errno(EFAULT); return -1; } } while (0)
47
48/**
49 * @brief
50 * @verbatim
51 TCP服务器端依次调用socket()、bind()、listen()之后,就会监听指定的socket地址了。
52 TCP客户端依次调用socket()、connect()之后就向TCP服务器发送了一个连接请求。
53 TCP服务器监听到这个请求之后,就会调用accept()函数取接收请求,这样连接就建立好了。
54 之后就可以开始网络I/O操作了,即类同于普通文件的读写I/O操作。
55 accept函数
56 第一个参数为服务器的socket描述字,
57 第二个参数为指向struct sockaddr *的指针,用于返回客户端的协议地址,
58 第三个参数为客户端协议地址的长度。
59 如果accpet成功,那么其返回值是由内核自动生成的一个全新的描述字,代表与返回客户的TCP连接。
60 注意:accept的第一个参数为服务器的socket描述字,是服务器开始调用socket()函数生成的,称为监听socket描述字;
61 而accept函数返回的是已连接的socket描述字。一个服务器通常通常仅仅只创建一个监听socket描述字,
62 它在该服务器的生命周期内一直存在。内核为每个由服务器进程接受的客户连接创建了一个已连接socket描述字,
63 当服务器完成了对某个客户的服务,相应的已连接socket描述字就被关闭。
64 * @endverbatim
65 * @param s
66 * @param addr
67 * @param addrlen
68 * @return int
69 */
70int accept(int s, struct sockaddr *addr, socklen_t *addrlen)
71{
72 return lwip_accept(s, addr, addrlen);
73}
74
75/**
76 * @brief
77 * @verbatim
78 bind()函数把一个地址族中的特定地址赋给socket。
79 例如对应AF_INET、AF_INET6就是把一个ipv4或ipv6地址和端口号组合赋给socket。
80 函数的三个参数分别为:
81 •sockfd:即socket描述字,它是通过socket()函数创建了,唯一标识一个socket。
82 bind()函数就是将给这个描述字绑定一个名字。
83 •addr:一个const struct sockaddr *指针,指向要绑定给sockfd的协议地址。
84 •addrlen:对应的是地址的长度。
85 通常服务器在启动的时候都会绑定一个众所周知的地址(如ip地址+端口号),用于提供服务,
86 客户就可以通过它来接连服务器;而客户端就不用指定,有系统自动分配一个端口号和自身的ip地址组合。
87 这就是为什么通常服务器端在listen之前会调用bind(),而客户端就不会调用,而是在connect()时由系统随机生成一个。
88 * @endverbatim
89 * @param s
90 * @param name
91 * @param namelen
92 * @return int
93 */
94int bind(int s, const struct sockaddr *name, socklen_t namelen)
95{
96 CHECK_NULL_PTR(name);
97 if (namelen < sizeof(*name)) {
98 set_errno(EINVAL);
99 return -1;
100 }
101 return lwip_bind(s, name, namelen);
102}
103
104/**
105 * @brief
106 * @verbatim
107该函数的行为依赖于how的值
108 SHUT_RD:值为0,关闭连接的读这一半。
109 SHUT_WR:值为1,关闭连接的写这一半。
110 SHUT_RDWR:值为2,连接的读和写都关闭。
111终止网络连接的通用方法是调用close函数。但使用shutdown能更好的控制断连过程(使用第二个参数)。
112
113closesocket 与 shutdown 的区别主要表现在:
114closesocket 函数会关闭套接字ID,如果有其他的进程共享着这个套接字,那么它仍然是打开的,
115 这个连接仍然可以用来读和写,并且有时候这是非常重要的 ,特别是对于多进程并发服务器来说。
116而shutdown会切断进程共享的套接字的所有连接,不管这个套接字的引用计数是否为零,
117 那些试图读得进程将会接收到EOF标识,那些试图写的进程将会检测到SIGPIPE信号,
118 同时可利用shutdown的第二个参数选择断连的方式。
119 * @endverbatim
120 * @param s
121 * @param how
122 * @return int
123 */
124int shutdown(int s, int how)
125{
126 return lwip_shutdown(s, how);
127}
128///获取对等名称 = getsockname
129int getpeername(int s, struct sockaddr *name, socklen_t *namelen)
130{
131 CHECK_NULL_PTR(name);//参数判空检查,这种写法有点意思
132 CHECK_NULL_PTR(namelen);
133 return lwip_getpeername(s, name, namelen);
134}
135///获取socket名称和长度
136int getsockname(int s, struct sockaddr *name, socklen_t *namelen)
137{
138 CHECK_NULL_PTR(name);
139 CHECK_NULL_PTR(namelen);
140 return lwip_getsockname(s, name, namelen);
141}
142///获取 socket 配置项
143int getsockopt(int s, int level, int optname, void *optval, socklen_t *optlen)
144{
145 return lwip_getsockopt(s, level, optname, optval, optlen);
146}
147///设置socket 配置项
148int setsockopt(int s, int level, int optname, const void *optval, socklen_t optlen)
149{
150 return lwip_setsockopt(s, level, optname, optval, optlen);
151}
152
153/**
154 * @brief
155 * @verbatim
156closesocket 一个套接字的默认行为是把套接字标记为已关闭,然后立即返回到调用进程,
157该套接字描述符不能再由调用进程使用,也就是说它不能再作为read或write的第一个参数,
158然而TCP将尝试发送已排队等待发送到对端,发送完毕后发生的是正常的TCP连接终止序列。
159在多进程并发服务器中,父子进程共享着套接字,套接字描述符引用计数记录着共享着的进程个数,
160当父进程或某一子进程close掉套接字时,描述符引用计数会相应的减一,
161当引用计数仍大于零时,这个close调用就不会引发TCP的四路握手断连过程。
162 * @endverbatim
163 * @param s
164 * @return int
165 */
166int closesocket(int s)
167{
168 return lwip_close(s);
169}
170
171/**
172 * @brief
173 * @verbatim
174connect函数由客户端使用,发出连接请求,服务器端就会接收到这个请求
175 第一个参数即为客户端的socket描述字,
176 第二参数为服务器的socket地址,
177 第三个参数为socket地址的长度。
178客户端通过调用connect函数来建立与TCP服务器的连接。
179 * @endverbatim
180 * @param s
181 * @param name
182 * @param namelen
183 * @return int
184 */
185int connect(int s, const struct sockaddr *name, socklen_t namelen)
186{
187 CHECK_NULL_PTR(name);
188 if (namelen < sizeof(*name)) {
189 set_errno(EINVAL);
190 return -1;
191 }
192 return lwip_connect(s, name, namelen);
193}
194
195/**
196 * @brief
197 * @verbatim
198如果作为一个服务器,在调用socket()、bind()之后就会调用listen()来监听这个socket,
199如果客户端这时调用connect()发出连接请求,服务器端就会接收到这个请求。
200listen函数的
201 第一个参数即为要监听的socket描述字,
202 第二个参数为相应socket可以排队的最大连接个数。
203 socket()函数创建的socket默认是一个主动类型的,listen函数将socket变为被动类型的,等待客户的连接请求。
204 * @endverbatim
205 * @param s
206 * @param backlog
207 * @return int
208 */
209int listen(int s, int backlog)
210{
211 return lwip_listen(s, backlog);
212}
213
214/**
215 * @brief
216 * @verbatim
217相当于文件操作的 read 功能,区别是第四个参数
218
219MSG_DONTROUTE:不查找表,是send函数使用的标志,这个标志告诉IP,目的主机在本地网络上,
220 没有必要查找表,这个标志一般用在网络诊断和路由程序里面。
221MSG_OOB:表示可以接收和发送带外数据。
222MSG_PEEK:查看数据,并不从系统缓冲区移走数据。是recv函数使用的标志,
223 表示只是从系统缓冲区中读取内容,而不清楚系统缓冲区的内容。这样在下次读取的时候,
224 依然是一样的内容,一般在有个进程读写数据的时候使用这个标志。
225MSG_WAITALL:等待所有数据,是recv函数的使用标志,表示等到所有的信息到达时才返回,
226 使用这个标志的时候,recv返回一直阻塞,直到指定的条件满足时,或者是发生了错误。
227 * @endverbatim
228 * @param s
229 * @param mem
230 * @param len
231 * @param flags
232 * @return ssize_t
233 */
234ssize_t recv(int s, void *mem, size_t len, int flags)
235{
236 CHECK_NULL_PTR(mem);
237 return lwip_recv(s, mem, len, flags);
238}
239///区别是返回源地址,意思是这些数据是从哪个地址过来的
240ssize_t recvfrom(int s, void *mem, size_t len, int flags,
241 struct sockaddr *from, socklen_t *fromlen)
242{
243 CHECK_NULL_PTR(mem);
244 return lwip_recvfrom(s, mem, len, flags, from, fromlen);
245}
246///只是数据的格式的不同
247ssize_t recvmsg(int s, struct msghdr *message, int flags)
248{
249 CHECK_NULL_PTR(message);
250 if (message->msg_iovlen) {
251 CHECK_NULL_PTR(message->msg_iov);
252 }
253 return lwip_recvmsg(s, message, flags);
254}
255
256/// 相当于文件操作的 write 功能,区别是第四个参数 同 recv
257ssize_t send(int s, const void *dataptr, size_t size, int flags)
258{
259 CHECK_NULL_PTR(dataptr);
260 return lwip_send(s, dataptr, size, flags);
261}
262///只是发送数据的格式的不同
263ssize_t sendmsg(int s, const struct msghdr *message, int flags)
264{
265 return lwip_sendmsg(s, message, flags);
266}
267///区别是送达地址,意思是这些数据要发给哪个地址的
268ssize_t sendto(int s, const void *dataptr, size_t size, int flags,
269 const struct sockaddr *to, socklen_t tolen)
270{
271 CHECK_NULL_PTR(dataptr);
272 if (to && tolen < sizeof(*to)) {
273 set_errno(EINVAL);
274 return -1;
275 }
276 return lwip_sendto(s, dataptr, size, flags, to, tolen);
277}
278
279/**
280 * @brief
281 * @verbatim
282用于创建一个socket描述符(socket descriptor),它唯一标识一个socket。
283这个socket描述符跟文件描述符一样,后续的操作都有用到它,把它作为参数,通过它来进行一些读写操作。
284正如可以给fopen的传入不同参数值,以打开不同的文件。创建socket的时候,也可以指定不同的参数
285创建不同的socket描述符,socket函数的三个参数分别为:
286
287•domain:即协议域,又称为协议族(family)。
288 常用的协议族有,
289 AF_INET(IPv4)、
290 AF_INET6(IPv6)、
291 AF_LOCAL(或称AF_UNIX,Unix域socket)、
292 AF_ROUTE等等。
293 协议族决定了socket的地址类型,在通信中必须采用对应的地址,
294 如AF_INET决定了要用ipv4地址(32位的)与端口号(16位的)的组合、
295 AF_UNIX决定了要用一个绝对路径名作为地址。
296•type:指定socket类型。
297 常用的socket类型有,
298 SOCK_STREAM(流式套接字)、
299 SOCK_DGRAM(数据报式套接字)、
300 SOCK_RAW、SOCK_PACKET、
301 SOCK_SEQPACKET等等
302•protocol:就是指定协议。
303 常用的协议有,
304 IPPROTO_TCP、PPTOTO_UDP、IPPROTO_SCTP、IPPROTO_TIPC等,
305 它们分别对应TCP传输协议、UDP传输协议、STCP传输协议、TIPC传输协议。
306注意:并不是上面的type和protocol可以随意组合的,如SOCK_STREAM不可以跟IPPROTO_UDP组合。
307当protocol为0时,会自动选择type类型对应的默认协议。
308 * @endverbatim
309 * @param domain
310 * @param type
311 * @param protocol
312 * @return int
313 */
314int socket(int domain, int type, int protocol)
315{
316 return lwip_socket(domain, type, protocol);
317}
318/*!
319inet_ntop 函数转换网络二进制结构到ASCII类型的地址,参数的作用和上面相同,
320只是多了一个参数socklen_t cnt,他是所指向缓存区dst的大小,避免溢出,
321如果缓存区太小无法存储地址的值,则返回一个空指针,并将errno置为ENOSPC
322*/
323const char *inet_ntop(int af, const void *src, char *dst, socklen_t size)
324{
325 return lwip_inet_ntop(af, src, dst, size);
326}
327///inet_pton 函数转换字符串到网络地址,第一个参数af是地址族,转换后存在dst中
328int inet_pton(int af, const char *src, void *dst)
329{
330 return lwip_inet_pton(af, src, dst);
331}
332
333#ifndef LWIP_INET_ADDR_FUNC
334in_addr_t inet_addr(const char* cp)
335{
336 return ipaddr_addr(cp);
337}
338#endif
339
340#ifndef LWIP_INET_ATON_FUNC
341int inet_aton(const char* cp, struct in_addr* inp)
342{
343 return ip4addr_aton(cp, (ip4_addr_t*)inp);
344}
345#endif
346
347#ifndef LWIP_INET_NTOA_FUNC
348char* inet_ntoa(struct in_addr in)
349{
350 return ip4addr_ntoa((const ip4_addr_t*)&(in));
351}
352#endif
353
354#endif /* !LWIP_COMPAT_SOCKETS */
355#endif /* LOSCFG_NET_LWIP_SACK */
INT64 ssize_t
Definition: los_typedef.h:79
int inet_aton(const char *cp, struct in_addr *inp)
Definition: socket.c:341
int connect(int s, const struct sockaddr *name, socklen_t namelen)
Definition: socket.c:185
int setsockopt(int s, int level, int optname, const void *optval, socklen_t optlen)
设置socket 配置项
Definition: socket.c:148
ssize_t recvmsg(int s, struct msghdr *message, int flags)
只是数据的格式的不同
Definition: socket.c:247
in_addr_t inet_addr(const char *cp)
Definition: socket.c:334
int getpeername(int s, struct sockaddr *name, socklen_t *namelen)
获取对等名称 = getsockname
Definition: socket.c:129
ssize_t recv(int s, void *mem, size_t len, int flags)
Definition: socket.c:234
int getsockname(int s, struct sockaddr *name, socklen_t *namelen)
获取socket名称和长度
Definition: socket.c:136
int shutdown(int s, int how)
Definition: socket.c:124
ssize_t sendto(int s, const void *dataptr, size_t size, int flags, const struct sockaddr *to, socklen_t tolen)
区别是送达地址,意思是这些数据要发给哪个地址的
Definition: socket.c:268
int bind(int s, const struct sockaddr *name, socklen_t namelen)
Definition: socket.c:94
ssize_t sendmsg(int s, const struct msghdr *message, int flags)
只是发送数据的格式的不同
Definition: socket.c:263
int accept(int s, struct sockaddr *addr, socklen_t *addrlen)
Definition: socket.c:70
int getsockopt(int s, int level, int optname, void *optval, socklen_t *optlen)
获取 socket 配置项
Definition: socket.c:143
char * inet_ntoa(struct in_addr in)
Definition: socket.c:348
const char * inet_ntop(int af, const void *src, char *dst, socklen_t size)
Definition: socket.c:323
int closesocket(int s)
Definition: socket.c:166
int inet_pton(int af, const char *src, void *dst)
inet_pton 函数转换字符串到网络地址,第一个参数af是地址族,转换后存在dst中
Definition: socket.c:328
ssize_t recvfrom(int s, void *mem, size_t len, int flags, struct sockaddr *from, socklen_t *fromlen)
区别是返回源地址,意思是这些数据是从哪个地址过来的
Definition: socket.c:240
int listen(int s, int backlog)
Definition: socket.c:209
ssize_t send(int s, const void *dataptr, size_t size, int flags)
相当于文件操作的 write 功能,区别是第四个参数 同 recv
Definition: socket.c:257
int socket(int domain, int type, int protocol)
Definition: socket.c:314
ssize_t lwip_sendto(int s, const void *dataptr, size_t size, int flags, const struct sockaddr *to, socklen_t tolen)
Definition: sockets.c:90
int lwip_setsockopt(int s, int level, int optname, const void *optval, socklen_t optlen)
Definition: sockets.c:77
int lwip_bind(int s, const struct sockaddr *name, socklen_t namelen)
Definition: sockets.c:83
int lwip_socket(int domain, int type, int protocol)
Definition: sockets.c:71