tcp.cpp@ 96407

最後變更在這個檔案從96407是 96407,由 vboxsync 提交於 3 年前
scm copyright and license note update
屬性 svn:eol-style 設為 `native` 屬性 svn:keywords 設為 `Id Revision`
檔案大小: 37.1 KB

行
1	/* $Id: tcp.cpp 96407 2022-08-22 17:43:14Z vboxsync $ */
2	/** @file
3	* IPRT - TCP/IP.
4	*/
5
6	/*
7	* Copyright (C) 2006-2022 Oracle and/or its affiliates.
8	*
9	* This file is part of VirtualBox base platform packages, as
10	* available from https://www.alldomusa.eu.org.
11	*
12	* This program is free software; you can redistribute it and/or
13	* modify it under the terms of the GNU General Public License
14	* as published by the Free Software Foundation, in version 3 of the
15	* License.
16	*
17	* This program is distributed in the hope that it will be useful, but
18	* WITHOUT ANY WARRANTY; without even the implied warranty of
19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20	* General Public License for more details.
21	*
22	* You should have received a copy of the GNU General Public License
23	* along with this program; if not, see <https://www.gnu.org/licenses>.
24	*
25	* The contents of this file may alternatively be used under the terms
26	* of the Common Development and Distribution License Version 1.0
27	* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28	* in the VirtualBox distribution, in which case the provisions of the
29	* CDDL are applicable instead of those of the GPL.
30	*
31	* You may elect to license modified versions of this file under the
32	* terms and conditions of either the GPL or the CDDL or both.
33	*
34	* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35	*/
36
37
38	/*********************************************************************************************************************************
39	* Header Files *
40	*********************************************************************************************************************************/
41	#ifdef RT_OS_WINDOWS
42	# include <iprt/win/winsock2.h>
43	#else
44	# include <sys/types.h>
45	# include <sys/socket.h>
46	# include <errno.h>
47	# include <netinet/in.h>
48	# include <netinet/tcp.h>
49	# include <arpa/inet.h>
50	# include <netdb.h>
51	# ifdef FIX_FOR_3_2
52	# include <fcntl.h>
53	# endif
54	#endif
55	#include <limits.h>
56
57	#include "internal/iprt.h"
58	#include <iprt/tcp.h>
59
60	#include <iprt/asm.h>
61	#include <iprt/assert.h>
62	#include <iprt/err.h>
63	#include <iprt/log.h>
64	#include <iprt/mempool.h>
65	#include <iprt/mem.h>
66	#include <iprt/string.h>
67	#include <iprt/socket.h>
68	#include <iprt/thread.h>
69	#include <iprt/time.h>
70
71	#include "internal/magics.h"
72	#include "internal/socket.h"
73
74
75	/*********************************************************************************************************************************
76	* Defined Constants And Macros *
77	*********************************************************************************************************************************/
78	/* non-standard linux stuff (it seems). */
79	#ifndef MSG_NOSIGNAL
80	# define MSG_NOSIGNAL 0
81	#endif
82	#ifndef SHUT_RDWR
83	# ifdef SD_BOTH
84	# define SHUT_RDWR SD_BOTH
85	# else
86	# define SHUT_RDWR 2
87	# endif
88	#endif
89	#ifndef SHUT_WR
90	# ifdef SD_SEND
91	# define SHUT_WR SD_SEND
92	# else
93	# define SHUT_WR 1
94	# endif
95	#endif
96
97	/* fixup backlevel OSes. */
98	#if defined(RT_OS_OS2) \|\| defined(RT_OS_WINDOWS)
99	# define socklen_t int
100	#endif
101
102	/** How many pending connection. */
103	#define RTTCP_SERVER_BACKLOG 10
104
105
106	/*********************************************************************************************************************************
107	* Structures and Typedefs *
108	*********************************************************************************************************************************/
109	/**
110	* TCP Server state.
111	*/
112	typedef enum RTTCPSERVERSTATE
113	{
114	/** Invalid. */
115	RTTCPSERVERSTATE_INVALID = 0,
116	/** Created. */
117	RTTCPSERVERSTATE_CREATED,
118	/** Listener thread is starting up. */
119	RTTCPSERVERSTATE_STARTING,
120	/** Accepting client connections. */
121	RTTCPSERVERSTATE_ACCEPTING,
122	/** Serving a client. */
123	RTTCPSERVERSTATE_SERVING,
124	/** Listener terminating. */
125	RTTCPSERVERSTATE_STOPPING,
126	/** Listener terminated. */
127	RTTCPSERVERSTATE_STOPPED,
128	/** Listener cleans up. */
129	RTTCPSERVERSTATE_DESTROYING
130	} RTTCPSERVERSTATE;
131
132	/*
133	* Internal representation of the TCP Server handle.
134	*/
135	typedef struct RTTCPSERVER
136	{
137	/** The magic value (RTTCPSERVER_MAGIC). */
138	uint32_t volatile u32Magic;
139	/** The server state. */
140	RTTCPSERVERSTATE volatile enmState;
141	/** The server thread. */
142	RTTHREAD Thread;
143	/** The server socket. */
144	RTSOCKET volatile hServerSocket;
145	/** The socket to the client currently being serviced.
146	* This is NIL_RTSOCKET when no client is serviced. */
147	RTSOCKET volatile hClientSocket;
148	/** The connection function. */
149	PFNRTTCPSERVE pfnServe;
150	/** Argument to pfnServer. */
151	void *pvUser;
152	} RTTCPSERVER;
153
154
155	/*********************************************************************************************************************************
156	* Internal Functions *
157	*********************************************************************************************************************************/
158	static DECLCALLBACK(int) rtTcpServerThread(RTTHREAD ThreadSelf, void *pvServer);
159	static int rtTcpServerListen(PRTTCPSERVER pServer);
160	static int rtTcpServerListenCleanup(PRTTCPSERVER pServer);
161	static int rtTcpClose(RTSOCKET Sock, const char *pszMsg, bool fTryGracefulShutdown);
162
163
164	/**
165	* Atomicly updates a socket variable.
166	* @returns The old handle value.
167	* @param phSock The socket handle variable to update.
168	* @param hNew The new socket handle value.
169	*/
170	DECLINLINE(RTSOCKET) rtTcpAtomicXchgSock(RTSOCKET volatile *phSock, const RTSOCKET hNew)
171	{
172	RTSOCKET hRet;
173	ASMAtomicXchgHandle(phSock, hNew, &hRet);
174	return hRet;
175	}
176
177
178	/**
179	* Tries to change the TCP server state.
180	*/
181	DECLINLINE(bool) rtTcpServerTrySetState(PRTTCPSERVER pServer, RTTCPSERVERSTATE enmStateNew, RTTCPSERVERSTATE enmStateOld)
182	{
183	bool fRc;
184	ASMAtomicCmpXchgSize(&pServer->enmState, enmStateNew, enmStateOld, fRc);
185	return fRc;
186	}
187
188	/**
189	* Changes the TCP server state.
190	*/
191	DECLINLINE(void) rtTcpServerSetState(PRTTCPSERVER pServer, RTTCPSERVERSTATE enmStateNew, RTTCPSERVERSTATE enmStateOld)
192	{
193	bool fRc;
194	ASMAtomicCmpXchgSize(&pServer->enmState, enmStateNew, enmStateOld, fRc);
195	Assert(fRc); NOREF(fRc);
196	}
197
198
199	/**
200	* Closes the a socket (client or server).
201	*
202	* @returns IPRT status code.
203	*/
204	static int rtTcpServerDestroySocket(RTSOCKET volatile pSock, const char pszMsg, bool fTryGracefulShutdown)
205	{
206	RTSOCKET hSocket = rtTcpAtomicXchgSock(pSock, NIL_RTSOCKET);
207	if (hSocket != NIL_RTSOCKET)
208	{
209	if (!fTryGracefulShutdown)
210	RTSocketShutdown(hSocket, true /fRead/, true /fWrite/);
211	return rtTcpClose(hSocket, pszMsg, fTryGracefulShutdown);
212	}
213	return VINF_TCP_SERVER_NO_CLIENT;
214	}
215
216
217	/**
218	* Create single connection at a time TCP Server in a separate thread.
219	*
220	* The thread will loop accepting connections and call pfnServe for
221	* each of the incoming connections in turn. The pfnServe function can
222	* return VERR_TCP_SERVER_STOP too terminate this loop. RTTcpServerDestroy()
223	* should be used to terminate the server.
224	*
225	* @returns iprt status code.
226	* @param pszAddress The address for creating a listening socket.
227	* If NULL or empty string the server is bound to all interfaces.
228	* @param uPort The port for creating a listening socket.
229	* @param enmType The thread type.
230	* @param pszThrdName The name of the worker thread.
231	* @param pfnServe The function which will serve a new client connection.
232	* @param pvUser User argument passed to pfnServe.
233	* @param ppServer Where to store the serverhandle.
234	*/
235	RTR3DECL(int) RTTcpServerCreate(const char pszAddress, unsigned uPort, RTTHREADTYPE enmType, const char pszThrdName,
236	PFNRTTCPSERVE pfnServe, void *pvUser, PPRTTCPSERVER ppServer)
237	{
238	/*
239	* Validate input.
240	*/
241	AssertReturn(uPort > 0, VERR_INVALID_PARAMETER);
242	AssertPtrReturn(pfnServe, VERR_INVALID_POINTER);
243	AssertPtrReturn(pszThrdName, VERR_INVALID_POINTER);
244	AssertPtrReturn(ppServer, VERR_INVALID_POINTER);
245
246	/*
247	* Create the server.
248	*/
249	PRTTCPSERVER pServer;
250	int rc = RTTcpServerCreateEx(pszAddress, uPort, &pServer);
251	if (RT_SUCCESS(rc))
252	{
253	/*
254	* Create the listener thread.
255	*/
256	RTMemPoolRetain(pServer);
257	pServer->enmState = RTTCPSERVERSTATE_STARTING;
258	pServer->pvUser = pvUser;
259	pServer->pfnServe = pfnServe;
260	rc = RTThreadCreate(&pServer->Thread, rtTcpServerThread, pServer, 0, enmType, /RTTHREADFLAGS_WAITABLE/0, pszThrdName);
261	if (RT_SUCCESS(rc))
262	{
263	/* done */
264	if (ppServer)
265	*ppServer = pServer;
266	else
267	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
268	return rc;
269	}
270	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
271
272	/*
273	* Destroy the server.
274	*/
275	rtTcpServerSetState(pServer, RTTCPSERVERSTATE_CREATED, RTTCPSERVERSTATE_STARTING);
276	RTTcpServerDestroy(pServer);
277	}
278
279	return rc;
280	}
281
282
283	/**
284	* Server thread, loops accepting connections until it's terminated.
285	*
286	* @returns iprt status code. (ignored).
287	* @param ThreadSelf Thread handle.
288	* @param pvServer Server handle.
289	*/
290	static DECLCALLBACK(int) rtTcpServerThread(RTTHREAD ThreadSelf, void *pvServer)
291	{
292	PRTTCPSERVER pServer = (PRTTCPSERVER)pvServer;
293	int rc;
294	if (rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_ACCEPTING, RTTCPSERVERSTATE_STARTING))
295	rc = rtTcpServerListen(pServer);
296	else
297	rc = rtTcpServerListenCleanup(pServer);
298	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
299	NOREF(ThreadSelf);
300	return VINF_SUCCESS;
301	}
302
303
304	/**
305	* Create single connection at a time TCP Server.
306	* The caller must call RTTcpServerListen() to actually start the server.
307	*
308	* @returns iprt status code.
309	* @param pszAddress The address for creating a listening socket.
310	* If NULL the server is bound to all interfaces.
311	* @param uPort The port for creating a listening socket.
312	* @param ppServer Where to store the serverhandle.
313	*/
314	RTR3DECL(int) RTTcpServerCreateEx(const char *pszAddress, uint32_t uPort, PPRTTCPSERVER ppServer)
315	{
316	/*
317	* Validate input.
318	*/
319	AssertReturn(uPort > 0, VERR_INVALID_PARAMETER);
320	AssertPtrReturn(ppServer, VERR_INVALID_PARAMETER);
321
322	/*
323	* Resolve the address.
324	*/
325	RTNETADDR LocalAddr;
326	int rc = RTSocketParseInetAddress(pszAddress, uPort, &LocalAddr);
327	if (RT_FAILURE(rc))
328	return rc;
329
330	/*
331	* Setting up socket.
332	*/
333	RTSOCKET WaitSock;
334	rc = rtSocketCreate(&WaitSock, AF_INET, SOCK_STREAM, IPPROTO_TCP);
335	if (RT_SUCCESS(rc))
336	{
337	RTSocketSetInheritance(WaitSock, false /fInheritable/);
338
339	/*
340	* Set socket options.
341	*/
342	int fFlag = 1;
343	if (!rtSocketSetOpt(WaitSock, SOL_SOCKET, SO_REUSEADDR, &fFlag, sizeof(fFlag)))
344	{
345
346	/*
347	* Bind a name to a socket and set it listening for connections.
348	*/
349	rc = rtSocketBind(WaitSock, &LocalAddr);
350	if (RT_SUCCESS(rc))
351	rc = rtSocketListen(WaitSock, RTTCP_SERVER_BACKLOG);
352	if (RT_SUCCESS(rc))
353	{
354	/*
355	* Create the server handle.
356	*/
357	PRTTCPSERVER pServer = (PRTTCPSERVER)RTMemPoolAlloc(RTMEMPOOL_DEFAULT, sizeof(*pServer));
358	if (pServer)
359	{
360	pServer->u32Magic = RTTCPSERVER_MAGIC;
361	pServer->enmState = RTTCPSERVERSTATE_CREATED;
362	pServer->Thread = NIL_RTTHREAD;
363	pServer->hServerSocket = WaitSock;
364	pServer->hClientSocket = NIL_RTSOCKET;
365	pServer->pfnServe = NULL;
366	pServer->pvUser = NULL;
367	*ppServer = pServer;
368	return VINF_SUCCESS;
369	}
370
371	/* bail out */
372	rc = VERR_NO_MEMORY;
373	}
374	}
375	else
376	AssertMsgFailed(("rtSocketSetOpt: %Rrc\n", rc));
377	rtTcpClose(WaitSock, "RTServerCreateEx", false /fTryGracefulShutdown/);
378	}
379
380	return rc;
381	}
382
383
384	/**
385	* Listen for incoming connections.
386	*
387	* The function will loop accepting connections and call pfnServe for
388	* each of the incoming connections in turn. The pfnServe function can
389	* return VERR_TCP_SERVER_STOP too terminate this loop. A stopped server
390	* can only be destroyed.
391	*
392	* @returns IPRT status code.
393	* @retval VERR_TCP_SERVER_STOP if stopped by pfnServe.
394	* @retval VERR_TCP_SERVER_SHUTDOWN if shut down by RTTcpServerShutdown.
395	*
396	* @param pServer The server handle as returned from RTTcpServerCreateEx().
397	* @param pfnServe The function which will serve a new client connection.
398	* @param pvUser User argument passed to pfnServe.
399	*/
400	RTR3DECL(int) RTTcpServerListen(PRTTCPSERVER pServer, PFNRTTCPSERVE pfnServe, void *pvUser)
401	{
402	/*
403	* Validate input and retain the instance.
404	*/
405	AssertPtrReturn(pfnServe, VERR_INVALID_POINTER);
406	AssertPtrReturn(pServer, VERR_INVALID_HANDLE);
407	AssertReturn(pServer->u32Magic == RTTCPSERVER_MAGIC, VERR_INVALID_HANDLE);
408	AssertReturn(RTMemPoolRetain(pServer) != UINT32_MAX, VERR_INVALID_HANDLE);
409
410	int rc = VERR_INVALID_STATE;
411	if (rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_ACCEPTING, RTTCPSERVERSTATE_CREATED))
412	{
413	Assert(!pServer->pfnServe);
414	Assert(!pServer->pvUser);
415	Assert(pServer->Thread == NIL_RTTHREAD);
416	Assert(pServer->hClientSocket == NIL_RTSOCKET);
417
418	pServer->pfnServe = pfnServe;
419	pServer->pvUser = pvUser;
420	pServer->Thread = RTThreadSelf();
421	Assert(pServer->Thread != NIL_RTTHREAD);
422	rc = rtTcpServerListen(pServer);
423	}
424	else
425	{
426	AssertMsgFailed(("enmState=%d\n", pServer->enmState));
427	rc = VERR_INVALID_STATE;
428	}
429	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
430	return rc;
431	}
432
433
434	/**
435	* Internal worker common for RTTcpServerListen and the thread created by
436	* RTTcpServerCreate().
437	*
438	* The caller makes sure it has its own memory reference and releases it upon
439	* return.
440	*/
441	static int rtTcpServerListen(PRTTCPSERVER pServer)
442	{
443	/*
444	* Accept connection loop.
445	*/
446	for (;;)
447	{
448	/*
449	* Change state, getting an extra reference to the socket so we can
450	* allow others to close it while we're stuck in rtSocketAccept.
451	*/
452	RTTCPSERVERSTATE enmState = pServer->enmState;
453	RTSOCKET hServerSocket;
454	ASMAtomicXchgHandle(&pServer->hServerSocket, NIL_RTSOCKET, &hServerSocket);
455	if (hServerSocket != NIL_RTSOCKET)
456	{
457	RTSocketRetain(hServerSocket);
458	ASMAtomicWriteHandle(&pServer->hServerSocket, hServerSocket);
459	}
460	if ( enmState != RTTCPSERVERSTATE_ACCEPTING
461	&& enmState != RTTCPSERVERSTATE_SERVING)
462	{
463	RTSocketRelease(hServerSocket);
464	return rtTcpServerListenCleanup(pServer);
465	}
466	if (!rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_ACCEPTING, enmState))
467	{
468	RTSocketRelease(hServerSocket);
469	continue;
470	}
471
472	/*
473	* Accept connection.
474	*/
475	struct sockaddr_in RemoteAddr;
476	size_t cbRemoteAddr = sizeof(RemoteAddr);
477	RTSOCKET hClientSocket;
478	RT_ZERO(RemoteAddr);
479	int rc = rtSocketAccept(hServerSocket, &hClientSocket, (struct sockaddr *)&RemoteAddr, &cbRemoteAddr);
480	RTSocketRelease(hServerSocket);
481	if (RT_FAILURE(rc))
482	{
483	/* These are typical for what can happen during destruction. */
484	if ( rc == VERR_INVALID_HANDLE
485	\|\| rc == VERR_INVALID_PARAMETER
486	\|\| rc == VERR_NET_NOT_SOCKET)
487	return rtTcpServerListenCleanup(pServer);
488	continue;
489	}
490	RTSocketSetInheritance(hClientSocket, false /fInheritable/);
491
492	/*
493	* Run a pfnServe callback.
494	*/
495	if (!rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_SERVING, RTTCPSERVERSTATE_ACCEPTING))
496	{
497	rtTcpClose(hClientSocket, "rtTcpServerListen", true /fTryGracefulShutdown/);
498	return rtTcpServerListenCleanup(pServer);
499	}
500	RTSocketRetain(hClientSocket);
501	rtTcpAtomicXchgSock(&pServer->hClientSocket, hClientSocket);
502	rc = pServer->pfnServe(hClientSocket, pServer->pvUser);
503	rtTcpServerDestroySocket(&pServer->hClientSocket, "Listener: client (secondary)", true /fTryGracefulShutdown/);
504	RTSocketRelease(hClientSocket);
505
506	/*
507	* Stop the server?
508	*/
509	if (rc == VERR_TCP_SERVER_STOP)
510	{
511	if (rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_STOPPING, RTTCPSERVERSTATE_SERVING))
512	{
513	/*
514	* Reset the server socket and change the state to stopped. After that state change
515	* we cannot safely access the handle so we'll have to return here.
516	*/
517	hServerSocket = rtTcpAtomicXchgSock(&pServer->hServerSocket, NIL_RTSOCKET);
518	rtTcpServerSetState(pServer, RTTCPSERVERSTATE_STOPPED, RTTCPSERVERSTATE_STOPPING);
519	rtTcpClose(hServerSocket, "Listener: server stopped", false /fTryGracefulShutdown/);
520	}
521	else
522	rtTcpServerListenCleanup(pServer); /* ignore rc */
523	return rc;
524	}
525	}
526	}
527
528
529	/**
530	* Clean up after listener.
531	*/
532	static int rtTcpServerListenCleanup(PRTTCPSERVER pServer)
533	{
534	/*
535	* Close the server socket, the client one shouldn't be set.
536	*/
537	rtTcpServerDestroySocket(&pServer->hServerSocket, "ListenCleanup", false /fTryGracefulShutdown/);
538	Assert(pServer->hClientSocket == NIL_RTSOCKET);
539
540	/*
541	* Figure the return code and make sure the state is OK.
542	*/
543	RTTCPSERVERSTATE enmState = pServer->enmState;
544	switch (enmState)
545	{
546	case RTTCPSERVERSTATE_STOPPING:
547	case RTTCPSERVERSTATE_STOPPED:
548	return VERR_TCP_SERVER_SHUTDOWN;
549
550	case RTTCPSERVERSTATE_ACCEPTING:
551	rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_STOPPED, enmState);
552	return VERR_TCP_SERVER_DESTROYED;
553
554	case RTTCPSERVERSTATE_DESTROYING:
555	return VERR_TCP_SERVER_DESTROYED;
556
557	case RTTCPSERVERSTATE_STARTING:
558	case RTTCPSERVERSTATE_SERVING:
559	default:
560	AssertMsgFailedReturn(("pServer=%p enmState=%d\n", pServer, enmState), VERR_INTERNAL_ERROR_4);
561	}
562	}
563
564
565	/**
566	* Listen and accept one incoming connection.
567	*
568	* This is an alternative to RTTcpServerListen for the use the callbacks are not
569	* possible.
570	*
571	* @returns IPRT status code.
572	* @retval VERR_TCP_SERVER_SHUTDOWN if shut down by RTTcpServerShutdown.
573	* @retval VERR_INTERRUPTED if the listening was interrupted.
574	*
575	* @param pServer The server handle as returned from RTTcpServerCreateEx().
576	* @param phClientSocket Where to return the socket handle to the client
577	* connection (on success only). This must be closed
578	* by calling RTTcpServerDisconnectClient2().
579	*/
580	RTR3DECL(int) RTTcpServerListen2(PRTTCPSERVER pServer, PRTSOCKET phClientSocket)
581	{
582	/*
583	* Validate input and retain the instance.
584	*/
585	AssertPtrReturn(phClientSocket, VERR_INVALID_HANDLE);
586	*phClientSocket = NIL_RTSOCKET;
587	AssertReturn(pServer->u32Magic == RTTCPSERVER_MAGIC, VERR_INVALID_HANDLE);
588	AssertReturn(RTMemPoolRetain(pServer) != UINT32_MAX, VERR_INVALID_HANDLE);
589
590	int rc = VERR_INVALID_STATE;
591	for (;;)
592	{
593	/*
594	* Change state, getting an extra reference to the socket so we can
595	* allow others to close it while we're stuck in rtSocketAccept.
596	*/
597	RTTCPSERVERSTATE enmState = pServer->enmState;
598	RTSOCKET hServerSocket;
599	ASMAtomicXchgHandle(&pServer->hServerSocket, NIL_RTSOCKET, &hServerSocket);
600	if (hServerSocket != NIL_RTSOCKET)
601	{
602	RTSocketRetain(hServerSocket);
603	ASMAtomicWriteHandle(&pServer->hServerSocket, hServerSocket);
604	}
605	if ( enmState != RTTCPSERVERSTATE_SERVING
606	&& enmState != RTTCPSERVERSTATE_CREATED)
607	{
608	RTSocketRelease(hServerSocket);
609	return rtTcpServerListenCleanup(pServer);
610	}
611	if (!rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_ACCEPTING, enmState))
612	{
613	RTSocketRelease(hServerSocket);
614	continue;
615	}
616	Assert(!pServer->pfnServe);
617	Assert(!pServer->pvUser);
618	Assert(pServer->Thread == NIL_RTTHREAD);
619	Assert(pServer->hClientSocket == NIL_RTSOCKET);
620
621	/*
622	* Accept connection.
623	*/
624	struct sockaddr_in RemoteAddr;
625	size_t cbRemoteAddr = sizeof(RemoteAddr);
626	RTSOCKET hClientSocket;
627	RT_ZERO(RemoteAddr);
628	rc = rtSocketAccept(hServerSocket, &hClientSocket, (struct sockaddr *)&RemoteAddr, &cbRemoteAddr);
629	RTSocketRelease(hServerSocket);
630	if (RT_FAILURE(rc))
631	{
632	if (!rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_CREATED, RTTCPSERVERSTATE_ACCEPTING))
633	rc = rtTcpServerListenCleanup(pServer);
634	if (RT_FAILURE(rc))
635	break;
636	continue;
637	}
638	RTSocketSetInheritance(hClientSocket, false /fInheritable/);
639
640	/*
641	* Chance to the 'serving' state and return the socket.
642	*/
643	if (rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_SERVING, RTTCPSERVERSTATE_ACCEPTING))
644	{
645	*phClientSocket = hClientSocket;
646	rc = VINF_SUCCESS;
647	}
648	else
649	{
650	rtTcpClose(hClientSocket, "RTTcpServerListen2", true /fTryGracefulShutdown/);
651	rc = rtTcpServerListenCleanup(pServer);
652	}
653	break;
654	}
655
656	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
657	return rc;
658	}
659
660
661	/**
662	* Terminate the open connection to the server.
663	*
664	* @returns iprt status code.
665	* @param pServer Handle to the server.
666	*/
667	RTR3DECL(int) RTTcpServerDisconnectClient(PRTTCPSERVER pServer)
668	{
669	/*
670	* Validate input and retain the instance.
671	*/
672	AssertPtrReturn(pServer, VERR_INVALID_HANDLE);
673	AssertReturn(pServer->u32Magic == RTTCPSERVER_MAGIC, VERR_INVALID_HANDLE);
674	AssertReturn(RTMemPoolRetain(pServer) != UINT32_MAX, VERR_INVALID_HANDLE);
675
676	int rc = rtTcpServerDestroySocket(&pServer->hClientSocket, "DisconnectClient: client", true /fTryGracefulShutdown/);
677
678	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
679	return rc;
680	}
681
682
683	/**
684	* Terminates an open client connect when using RTTcpListen2
685	*
686	* @returns IPRT status code.
687	* @param hClientSocket The client socket handle. This will be invalid upon
688	* return, whether successful or not. NIL is quietly
689	* ignored (VINF_SUCCESS).
690	*/
691	RTR3DECL(int) RTTcpServerDisconnectClient2(RTSOCKET hClientSocket)
692	{
693	return rtTcpClose(hClientSocket, "RTTcpServerDisconnectClient2", true /fTryGracefulShutdown/);
694	}
695
696
697	/**
698	* Shuts down the server, leaving client connections open.
699	*
700	* @returns IPRT status code.
701	* @param pServer Handle to the server.
702	*/
703	RTR3DECL(int) RTTcpServerShutdown(PRTTCPSERVER pServer)
704	{
705	/*
706	* Validate input and retain the instance.
707	*/
708	AssertPtrReturn(pServer, VERR_INVALID_HANDLE);
709	AssertReturn(pServer->u32Magic == RTTCPSERVER_MAGIC, VERR_INVALID_HANDLE);
710	AssertReturn(RTMemPoolRetain(pServer) != UINT32_MAX, VERR_INVALID_HANDLE);
711
712	/*
713	* Try change the state to stopping, then replace and destroy the server socket.
714	*/
715	for (;;)
716	{
717	RTTCPSERVERSTATE enmState = pServer->enmState;
718	if ( enmState != RTTCPSERVERSTATE_ACCEPTING
719	&& enmState != RTTCPSERVERSTATE_SERVING)
720	{
721	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
722	switch (enmState)
723	{
724	case RTTCPSERVERSTATE_CREATED:
725	case RTTCPSERVERSTATE_STARTING:
726	default:
727	AssertMsgFailed(("%d\n", enmState));
728	return VERR_INVALID_STATE;
729
730	case RTTCPSERVERSTATE_STOPPING:
731	case RTTCPSERVERSTATE_STOPPED:
732	return VINF_SUCCESS;
733
734	case RTTCPSERVERSTATE_DESTROYING:
735	return VERR_TCP_SERVER_DESTROYED;
736	}
737	}
738	if (rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_STOPPING, enmState))
739	{
740	rtTcpServerDestroySocket(&pServer->hServerSocket, "RTTcpServerShutdown", false /fTryGracefulShutdown/);
741	rtTcpServerSetState(pServer, RTTCPSERVERSTATE_STOPPED, RTTCPSERVERSTATE_STOPPING);
742
743	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
744	return VINF_SUCCESS;
745	}
746	}
747	}
748
749
750	/**
751	* Closes down and frees a TCP Server.
752	* This will also terminate any open connections to the server.
753	*
754	* @returns iprt status code.
755	* @param pServer Handle to the server.
756	*/
757	RTR3DECL(int) RTTcpServerDestroy(PRTTCPSERVER pServer)
758	{
759	/*
760	* Validate input and retain the instance.
761	*/
762	AssertPtrReturn(pServer, VERR_INVALID_HANDLE);
763	AssertReturn(pServer->u32Magic == RTTCPSERVER_MAGIC, VERR_INVALID_HANDLE);
764	AssertReturn(RTMemPoolRetain(pServer) != UINT32_MAX, VERR_INVALID_HANDLE); /* paranoia */
765
766	/*
767	* Move the state along so the listener can figure out what's going on.
768	*/
769	for (;;)
770	{
771	bool fDestroyable;
772	RTTCPSERVERSTATE enmState = pServer->enmState;
773	switch (enmState)
774	{
775	case RTTCPSERVERSTATE_STARTING:
776	case RTTCPSERVERSTATE_ACCEPTING:
777	case RTTCPSERVERSTATE_SERVING:
778	case RTTCPSERVERSTATE_CREATED:
779	case RTTCPSERVERSTATE_STOPPED:
780	fDestroyable = rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_DESTROYING, enmState);
781	break;
782
783	/* destroyable states */
784	case RTTCPSERVERSTATE_STOPPING:
785	fDestroyable = true;
786	break;
787
788	/*
789	* Everything else means user or internal misbehavior.
790	*/
791	default:
792	AssertMsgFailed(("pServer=%p enmState=%d\n", pServer, enmState));
793	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
794	return VERR_INTERNAL_ERROR;
795	}
796	if (fDestroyable)
797	break;
798	}
799
800	/*
801	* Destroy it.
802	*/
803	ASMAtomicWriteU32(&pServer->u32Magic, ~RTTCPSERVER_MAGIC);
804	rtTcpServerDestroySocket(&pServer->hServerSocket, "Destroyer: server", false /fTryGracefulShutdown/);
805	rtTcpServerDestroySocket(&pServer->hClientSocket, "Destroyer: client", true /fTryGracefulShutdown/);
806
807	/*
808	* Release it.
809	*/
810	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
811	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
812	return VINF_SUCCESS;
813	}
814
815
816	RTR3DECL(int) RTTcpClientConnect(const char *pszAddress, uint32_t uPort, PRTSOCKET pSock)
817	{
818	return RTTcpClientConnectEx(pszAddress, uPort, pSock, RT_SOCKETCONNECT_DEFAULT_WAIT, NULL);
819	}
820
821
822	RTR3DECL(int) RTTcpClientConnectEx(const char *pszAddress, uint32_t uPort, PRTSOCKET pSock,
823	RTMSINTERVAL cMillies, PRTTCPCLIENTCONNECTCANCEL volatile *ppCancelCookie)
824	{
825	/*
826	* Validate input.
827	*/
828	AssertReturn(uPort > 0, VERR_INVALID_PARAMETER);
829	AssertPtrReturn(pszAddress, VERR_INVALID_POINTER);
830	AssertPtrNullReturn(ppCancelCookie, VERR_INVALID_POINTER);
831
832	/*
833	* Resolve the address.
834	*/
835	RTNETADDR Addr;
836	int rc = RTSocketParseInetAddress(pszAddress, uPort, &Addr);
837	if (RT_FAILURE(rc))
838	return rc;
839
840	/*
841	* Create the socket and connect.
842	*/
843	RTSOCKET Sock;
844	rc = rtSocketCreate(&Sock, PF_INET, SOCK_STREAM, 0);
845	if (RT_SUCCESS(rc))
846	{
847	RTSocketSetInheritance(Sock, false /fInheritable/);
848
849	if (!ppCancelCookie)
850	rc = rtSocketConnect(Sock, &Addr, cMillies);
851	else
852	{
853	RTSocketRetain(Sock);
854	if (ASMAtomicCmpXchgPtr(ppCancelCookie, (PRTTCPCLIENTCONNECTCANCEL)Sock, NULL))
855	{
856	rc = rtSocketConnect(Sock, &Addr, cMillies);
857	if (ASMAtomicCmpXchgPtr(ppCancelCookie, NULL, (PRTTCPCLIENTCONNECTCANCEL)Sock))
858	RTSocketRelease(Sock);
859	else
860	rc = VERR_CANCELLED;
861	}
862	else
863	{
864	RTSocketRelease(Sock);
865	rc = VERR_CANCELLED;
866	}
867	}
868	if (RT_SUCCESS(rc))
869	{
870	*pSock = Sock;
871	return VINF_SUCCESS;
872	}
873
874	rtTcpClose(Sock, "RTTcpClientConnect", false /fTryGracefulShutdown/);
875	}
876	if (ppCancelCookie)
877	*ppCancelCookie = NULL;
878	return rc;
879	}
880
881
882	RTR3DECL(int) RTTcpClientCancelConnect(PRTTCPCLIENTCONNECTCANCEL volatile *ppCancelCookie)
883	{
884	AssertPtrReturn(ppCancelCookie, VERR_INVALID_POINTER);
885
886	RTSOCKET const hSockCancelled = (RTSOCKET)(uintptr_t)0xdead9999;
887
888	AssertCompile(NIL_RTSOCKET == NULL);
889	RTSOCKET hSock = (RTSOCKET)ASMAtomicXchgPtr((void * volatile *)ppCancelCookie, hSockCancelled);
890	if (hSock != NIL_RTSOCKET && hSock != hSockCancelled)
891	{
892	int rc = rtTcpClose(hSock, "RTTcpClientCancelConnect", false /fTryGracefulShutdown/);
893	AssertRCReturn(rc, rc);
894	}
895
896	return VINF_SUCCESS;
897	}
898
899
900	RTR3DECL(int) RTTcpClientClose(RTSOCKET Sock)
901	{
902	return rtTcpClose(Sock, "RTTcpClientClose", true /fTryGracefulShutdown/);
903	}
904
905
906	RTR3DECL(int) RTTcpClientCloseEx(RTSOCKET Sock, bool fGracefulShutdown)
907	{
908	return rtTcpClose(Sock, "RTTcpClientCloseEx", fGracefulShutdown);
909	}
910
911
912	#ifdef FIX_FOR_3_2
913	/**
914	* Changes the blocking mode of the socket.
915	*
916	* @returns 0 on success, -1 on failure.
917	* @param hSocket The socket to work on.
918	* @param fBlocking The desired mode of operation.
919	*/
920	static int rtTcpSetBlockingMode(RTHCUINTPTR hSocket, bool fBlocking)
921	{
922	int rc = VINF_SUCCESS;
923	#ifdef RT_OS_WINDOWS
924	u_long uBlocking = fBlocking ? 0 : 1;
925	if (ioctlsocket(hSocket, FIONBIO, &uBlocking))
926	return -1;
927
928	#else
929	int fFlags = fcntl(hSocket, F_GETFL, 0);
930	if (fFlags == -1)
931	return -1;
932
933	if (fBlocking)
934	fFlags &= ~O_NONBLOCK;
935	else
936	fFlags \|= O_NONBLOCK;
937	if (fcntl(hSocket, F_SETFL, fFlags) == -1)
938	return -1;
939	#endif
940
941	return 0;
942	}
943	#endif
944
945
946	/**
947	* Internal close function which does all the proper bitching.
948	*/
949	static int rtTcpClose(RTSOCKET Sock, const char *pszMsg, bool fTryGracefulShutdown)
950	{
951	NOREF(pszMsg); /** @todo drop this parameter? */
952
953	/* ignore nil handles. */
954	if (Sock == NIL_RTSOCKET)
955	return VINF_SUCCESS;
956
957	/*
958	* Try to gracefully shut it down.
959	*/
960	int rc;
961	if (fTryGracefulShutdown)
962	{
963	rc = RTSocketShutdown(Sock, false /fRead/, true /fWrite/);
964	#ifdef FIX_FOR_3_2
965	RTHCUINTPTR hNative = RTSocketToNative(Sock);
966	if (RT_SUCCESS(rc) && rtTcpSetBlockingMode(hNative, false /fBlocking/) == 0)
967	#else
968	if (RT_SUCCESS(rc))
969	#endif
970	{
971
972	size_t cbReceived = 0;
973	uint64_t u64Start = RTTimeMilliTS();
974	while ( cbReceived < _1G
975	&& RTTimeMilliTS() - u64Start < 30000)
976	{
977	#ifdef FIX_FOR_3_2
978	fd_set FdSetR;
979	FD_ZERO(&FdSetR);
980	FD_SET(hNative, &FdSetR);
981
982	fd_set FdSetE;
983	FD_ZERO(&FdSetE);
984	FD_SET(hNative, &FdSetE);
985
986	struct timeval TvTimeout;
987	TvTimeout.tv_sec = 1;
988	TvTimeout.tv_usec = 0;
989	rc = select(hNative + 1, &FdSetR, NULL, &FdSetE, &TvTimeout);
990	if (rc == 0)
991	continue;
992	if (rc < 0)
993	break;
994	if (FD_ISSET(hNative, &FdSetE))
995	break;
996	#else
997	uint32_t fEvents;
998	rc = RTSocketSelectOneEx(Sock, RTSOCKET_EVT_READ \| RTSOCKET_EVT_ERROR, &fEvents, 1000);
999	if (rc == VERR_TIMEOUT)
1000	continue;
1001	if (RT_FAILURE(rc))
1002	break;
1003	if (fEvents & RTSOCKET_EVT_ERROR)
1004	break;
1005	#endif
1006
1007	char abBitBucket[16*_1K];
1008	#ifdef FIX_FOR_3_2
1009	ssize_t cbRead = recv(hNative, &abBitBucket[0], sizeof(abBitBucket), MSG_NOSIGNAL);
1010	if (cbRead == 0)
1011	break; /* orderly shutdown in progress */
1012	if (cbRead < 0 && errno != EAGAIN)
1013	break; /* some kind of error, never mind which... */
1014	#else
1015	size_t cbRead;
1016	rc = RTSocketReadNB(Sock, &abBitBucket[0], sizeof(abBitBucket), &cbRead);
1017	if (RT_FAILURE(rc))
1018	break; /* some kind of error, never mind which... */
1019	if (rc != VINF_TRY_AGAIN && !cbRead)
1020	break; /* orderly shutdown in progress */
1021	#endif
1022
1023	cbReceived += cbRead;
1024	}
1025	}
1026	}
1027
1028	/*
1029	* Close the socket handle (drops our reference to it).
1030	*/
1031	return RTSocketClose(Sock);
1032	}
1033
1034
1035	/**
1036	* Creates connected pair of TCP sockets.
1037	*
1038	* @returns IPRT status code.
1039	* @param phServer Where to return the "server" side of the pair.
1040	* @param phClient Where to return the "client" side of the pair.
1041	*
1042	* @note There is no server or client side, but we gotta call it something.
1043	*/
1044	RTR3DECL(int) RTTcpCreatePair(PRTSOCKET phServer, PRTSOCKET phClient, uint32_t fFlags)
1045	{
1046	/*
1047	* Validate input.
1048	*/
1049	AssertPtrReturn(phServer, VERR_INVALID_PARAMETER);
1050	AssertPtrReturn(phClient, VERR_INVALID_PARAMETER);
1051	AssertReturn(!fFlags, VERR_INVALID_PARAMETER);
1052
1053	/*
1054	* Do the job.
1055	*/
1056	return rtSocketCreateTcpPair(phServer, phClient);
1057	}
1058
1059
1060	RTR3DECL(int) RTTcpRead(RTSOCKET Sock, void pvBuffer, size_t cbBuffer, size_t pcbRead)
1061	{
1062	return RTSocketRead(Sock, pvBuffer, cbBuffer, pcbRead);
1063	}
1064
1065
1066	RTR3DECL(int) RTTcpWrite(RTSOCKET Sock, const void *pvBuffer, size_t cbBuffer)
1067	{
1068	return RTSocketWrite(Sock, pvBuffer, cbBuffer);
1069	}
1070
1071
1072	RTR3DECL(int) RTTcpFlush(RTSOCKET Sock)
1073	{
1074	int fFlag = 1;
1075	int rc = rtSocketSetOpt(Sock, IPPROTO_TCP, TCP_NODELAY, &fFlag, sizeof(fFlag));
1076	if (RT_SUCCESS(rc))
1077	{
1078	fFlag = 0;
1079	rc = rtSocketSetOpt(Sock, IPPROTO_TCP, TCP_NODELAY, &fFlag, sizeof(fFlag));
1080	}
1081	return rc;
1082	}
1083
1084
1085	RTR3DECL(int) RTTcpSetSendCoalescing(RTSOCKET Sock, bool fEnable)
1086	{
1087	int fFlag = fEnable ? 0 : 1;
1088	return rtSocketSetOpt(Sock, IPPROTO_TCP, TCP_NODELAY, &fFlag, sizeof(fFlag));
1089	}
1090
1091
1092	RTR3DECL(int) RTTcpSetBufferSize(RTSOCKET hSocket, uint32_t cbSize)
1093	{
1094	int cbIntSize = (int)cbSize;
1095	AssertReturn(cbIntSize >= 0, VERR_OUT_OF_RANGE);
1096	int rc = rtSocketSetOpt(hSocket, SOL_SOCKET, SO_SNDBUF, &cbIntSize, sizeof(cbIntSize));
1097	if (RT_SUCCESS(rc))
1098	rc = rtSocketSetOpt(hSocket, SOL_SOCKET, SO_RCVBUF, &cbIntSize, sizeof(cbIntSize));
1099	return rc;
1100	}
1101
1102
1103	RTR3DECL(int) RTTcpSelectOne(RTSOCKET Sock, RTMSINTERVAL cMillies)
1104	{
1105	return RTSocketSelectOne(Sock, cMillies);
1106	}
1107
1108
1109	RTR3DECL(int) RTTcpSelectOneEx(RTSOCKET Sock, uint32_t fEvents, uint32_t *pfEvents,
1110	RTMSINTERVAL cMillies)
1111	{
1112	return RTSocketSelectOneEx(Sock, fEvents, pfEvents, cMillies);
1113	}
1114
1115
1116	RTR3DECL(int) RTTcpGetLocalAddress(RTSOCKET Sock, PRTNETADDR pAddr)
1117	{
1118	return RTSocketGetLocalAddress(Sock, pAddr);
1119	}
1120
1121
1122	RTR3DECL(int) RTTcpGetPeerAddress(RTSOCKET Sock, PRTNETADDR pAddr)
1123	{
1124	return RTSocketGetPeerAddress(Sock, pAddr);
1125	}
1126
1127
1128	RTR3DECL(int) RTTcpSgWrite(RTSOCKET Sock, PCRTSGBUF pSgBuf)
1129	{
1130	return RTSocketSgWrite(Sock, pSgBuf);
1131	}
1132
1133
1134	RTR3DECL(int) RTTcpSgWriteL(RTSOCKET hSocket, size_t cSegs, ...)
1135	{
1136	va_list va;
1137	va_start(va, cSegs);
1138	int rc = RTSocketSgWriteLV(hSocket, cSegs, va);
1139	va_end(va);
1140	return rc;
1141	}
1142
1143
1144	RTR3DECL(int) RTTcpSgWriteLV(RTSOCKET hSocket, size_t cSegs, va_list va)
1145	{
1146	return RTSocketSgWriteLV(hSocket, cSegs, va);
1147	}
1148
1149
1150	RTR3DECL(int) RTTcpReadNB(RTSOCKET Sock, void pvBuffer, size_t cbBuffer, size_t pcbRead)
1151	{
1152	return RTSocketReadNB(Sock, pvBuffer, cbBuffer, pcbRead);
1153	}
1154
1155
1156	RTR3DECL(int) RTTcpWriteNB(RTSOCKET Sock, const void pvBuffer, size_t cbBuffer, size_t pcbWritten)
1157	{
1158	return RTSocketWriteNB(Sock, pvBuffer, cbBuffer, pcbWritten);
1159	}
1160
1161
1162	RTR3DECL(int) RTTcpSgWriteNB(RTSOCKET Sock, PCRTSGBUF pSgBuf, size_t *pcbWritten)
1163	{
1164	return RTSocketSgWriteNB(Sock, pSgBuf, pcbWritten);
1165	}
1166
1167
1168	RTR3DECL(int) RTTcpSgWriteLNB(RTSOCKET hSocket, size_t cSegs, size_t *pcbWritten, ...)
1169	{
1170	va_list va;
1171	va_start(va, pcbWritten);
1172	int rc = RTSocketSgWriteLVNB(hSocket, cSegs, pcbWritten, va);
1173	va_end(va);
1174	return rc;
1175	}
1176
1177
1178	RTR3DECL(int) RTTcpSgWriteLVNB(RTSOCKET hSocket, size_t cSegs, size_t *pcbWritten, va_list va)
1179	{
1180	return RTSocketSgWriteLVNB(hSocket, cSegs, pcbWritten, va);
1181	}
1182

注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

source: vbox/trunk/src/VBox/Runtime/r3/tcp.cpp@ 96407

以其他格式下載: