tcp.cpp@ 23625

Last change on this file since 23625 was 23625, checked in by vboxsync, 16 years ago
IPRT: Added RTTcpServerShutdown and cleaned up the code.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 28.4 KB

Line
1	/* $Id: tcp.cpp 23625 2009-10-08 16:56:22Z vboxsync $ */
2	/** @file
3	* IPRT - TCP/IP.
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 Sun Microsystems, Inc.
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.215389.xyz. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* The contents of this file may alternatively be used under the terms
18	* of the Common Development and Distribution License Version 1.0
19	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20	* VirtualBox OSE distribution, in which case the provisions of the
21	* CDDL are applicable instead of those of the GPL.
22	*
23	* You may elect to license modified versions of this file under the
24	* terms and conditions of either the GPL or the CDDL or both.
25	*
26	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
27	* Clara, CA 95054 USA or visit http://www.sun.com if you need
28	* additional information or have any questions.
29	*/
30
31
32	/*******************************************************************************
33	* Header Files *
34	*******************************************************************************/
35	#ifdef RT_OS_WINDOWS
36	# include <winsock.h>
37	#else /* !RT_OS_WINDOWS */
38	# include <errno.h>
39	# include <sys/stat.h>
40	# include <sys/socket.h>
41	# include <netinet/in.h>
42	# include <netinet/tcp.h>
43	# include <arpa/inet.h>
44	# include <sys/un.h>
45	# include <netdb.h>
46	# include <unistd.h>
47	#endif /* !RT_OS_WINDOWS */
48
49	#include "internal/iprt.h"
50	#include <iprt/tcp.h>
51
52	#include <iprt/asm.h>
53	#include <iprt/assert.h>
54	#include <iprt/err.h>
55	#include <iprt/mempool.h>
56	#include <iprt/string.h>
57	#include <iprt/thread.h>
58
59	#include "internal/magics.h"
60
61
62	/*******************************************************************************
63	* Defined Constants And Macros *
64	*******************************************************************************/
65	/* non-standard linux stuff (it seems). */
66	#ifndef MSG_NOSIGNAL
67	# define MSG_NOSIGNAL 0
68	#endif
69	#ifndef SHUT_RDWR
70	# ifdef SD_BOTH
71	# define SHUT_RDWR SD_BOTH
72	# else
73	# define SHUT_RDWR 2
74	# endif
75	#endif
76
77	/* fixup backlevel OSes. */
78	#if defined(RT_OS_OS2) \|\| defined(RT_OS_WINDOWS)
79	# define socklen_t int
80	#endif
81
82	/** How many pending connection. */
83	#define RTTCP_SERVER_BACKLOG 10
84
85
86	/*******************************************************************************
87	* Structures and Typedefs *
88	*******************************************************************************/
89	/**
90	* TCP Server state.
91	*/
92	typedef enum RTTCPSERVERSTATE
93	{
94	/** Invalid. */
95	RTTCPSERVERSTATE_INVALID = 0,
96	/** Created. */
97	RTTCPSERVERSTATE_CREATED,
98	/** Listener thread is starting up. */
99	RTTCPSERVERSTATE_STARTING,
100	/** Accepting client connections. */
101	RTTCPSERVERSTATE_ACCEPTING,
102	/** Serving a client. */
103	RTTCPSERVERSTATE_SERVING,
104	/** Listener terminating. */
105	RTTCPSERVERSTATE_STOPPING,
106	/** Listener terminated. */
107	RTTCPSERVERSTATE_STOPPED,
108	/** Listener cleans up. */
109	RTTCPSERVERSTATE_DESTROYING
110	} RTTCPSERVERSTATE;
111
112	/*
113	* Internal representation of the TCP Server handle.
114	*/
115	typedef struct RTTCPSERVER
116	{
117	/** The magic value (RTTCPSERVER_MAGIC). */
118	uint32_t volatile u32Magic;
119	/** The server state. */
120	RTTCPSERVERSTATE volatile enmState;
121	/** The server thread. */
122	RTTHREAD Thread;
123	/** The server socket. */
124	RTSOCKET volatile SockServer;
125	/** The socket to the client currently being serviced.
126	* This is NIL_RTSOCKET when no client is serviced. */
127	RTSOCKET volatile SockClient;
128	/** The connection function. */
129	PFNRTTCPSERVE pfnServe;
130	/** Argument to pfnServer. */
131	void *pvUser;
132	} RTTCPSERVER;
133
134
135	/*******************************************************************************
136	* Internal Functions *
137	*******************************************************************************/
138	static DECLCALLBACK(int) rtTcpServerThread(RTTHREAD ThreadSelf, void *pvServer);
139	static int rtTcpServerListen(PRTTCPSERVER pServer);
140	static int rcTcpServerListenCleanup(PRTTCPSERVER pServer);
141	static int rtTcpServerDestroySocket(RTSOCKET volatile pSockClient, const char pszMsg);
142	static int rtTcpClose(RTSOCKET Sock, const char *pszMsg);
143
144
145
146	/**
147	* Get the last error as an iprt status code.
148	*
149	* @returns iprt status code.
150	*/
151	DECLINLINE(int) rtTcpError(void)
152	{
153	#ifdef RT_OS_WINDOWS
154	return RTErrConvertFromWin32(WSAGetLastError());
155	#else
156	return RTErrConvertFromErrno(errno);
157	#endif
158	}
159
160
161	/**
162	* Resets the last error.
163	*/
164	DECLINLINE(void) rtTcpErrorReset(void)
165	{
166	#ifdef RT_OS_WINDOWS
167	WSASetLastError(0);
168	#else
169	errno = 0;
170	#endif
171	}
172
173
174	/**
175	* Get the last resolver error as an iprt status code.
176	*
177	* @returns iprt status code.
178	*/
179	DECLINLINE(int) rtTcpResolverError(void)
180	{
181	#ifdef RT_OS_WINDOWS
182	return RTErrConvertFromWin32(WSAGetLastError());
183	#else
184	switch (h_errno)
185	{
186	case HOST_NOT_FOUND:
187	return VERR_NET_HOST_NOT_FOUND;
188	case NO_DATA:
189	return VERR_NET_ADDRESS_NOT_AVAILABLE;
190	case NO_RECOVERY:
191	return VERR_IO_GEN_FAILURE;
192	case TRY_AGAIN:
193	return VERR_TRY_AGAIN;
194
195	default:
196	return VERR_UNRESOLVED_ERROR;
197	}
198	#endif
199	}
200
201
202	/**
203	* Atomicly updates a socket variable.
204	* @returns The old value.
205	* @param pSock The socket variable to update.
206	* @param Sock The new value.
207	*/
208	DECLINLINE(RTSOCKET) rtTcpAtomicXchgSock(RTSOCKET volatile *pSock, const RTSOCKET Sock)
209	{
210	switch (sizeof(RTSOCKET))
211	{
212	case 4: return (RTSOCKET)ASMAtomicXchgS32((int32_t volatile *)pSock, (int32_t)Sock);
213	default:
214	AssertReleaseFailed();
215	return NIL_RTSOCKET;
216	}
217	}
218
219
220	/**
221	* Tries to change the TCP server state.
222	*/
223	DECLINLINE(bool) rtTcpServerTrySetState(PRTTCPSERVER pServer, RTTCPSERVERSTATE enmStateNew, RTTCPSERVERSTATE enmStateOld)
224	{
225	bool fRc;
226	ASMAtomicCmpXchgSize(&pServer->enmState, enmStateNew, enmStateOld, fRc);
227	return fRc;
228	}
229
230	/**
231	* Changes the TCP server state.
232	*/
233	DECLINLINE(void) rtTcpServerSetState(PRTTCPSERVER pServer, RTTCPSERVERSTATE enmStateNew, RTTCPSERVERSTATE enmStateOld)
234	{
235	bool fRc;
236	ASMAtomicCmpXchgSize(&pServer->enmState, enmStateNew, enmStateOld, fRc);
237	Assert(fRc); NOREF(fRc);
238	}
239
240	/**
241	* Closes the a socket (client or server).
242	*
243	* @returns IPRT status code.
244	*/
245	static int rtTcpServerDestroySocket(RTSOCKET volatile pSock, const char pszMsg)
246	{
247	RTSOCKET Sock = rtTcpAtomicXchgSock(pSock, NIL_RTSOCKET);
248	if (Sock != NIL_RTSOCKET)
249	{
250	shutdown(Sock, SHUT_RDWR);
251	return rtTcpClose(Sock, pszMsg);
252	}
253	return VINF_TCP_SERVER_NO_CLIENT;
254	}
255
256
257	/**
258	* Create single connection at a time TCP Server in a separate thread.
259	*
260	* The thread will loop accepting connections and call pfnServe for
261	* each of the incoming connections in turn. The pfnServe function can
262	* return VERR_TCP_SERVER_STOP too terminate this loop. RTTcpServerDestroy()
263	* should be used to terminate the server.
264	*
265	* @returns iprt status code.
266	* @param pszAddress The address for creating a listening socket.
267	* If NULL or empty string the server is bound to all interfaces.
268	* @param uPort The port for creating a listening socket.
269	* @param enmType The thread type.
270	* @param pszThrdName The name of the worker thread.
271	* @param pfnServe The function which will serve a new client connection.
272	* @param pvUser User argument passed to pfnServe.
273	* @param ppServer Where to store the serverhandle.
274	*/
275	RTR3DECL(int) RTTcpServerCreate(const char pszAddress, unsigned uPort, RTTHREADTYPE enmType, const char pszThrdName,
276	PFNRTTCPSERVE pfnServe, void *pvUser, PPRTTCPSERVER ppServer)
277	{
278	/*
279	* Validate input.
280	*/
281	AssertReturn(uPort > 0, VERR_INVALID_PARAMETER);
282	AssertPtrReturn(pfnServe, VERR_INVALID_POINTER);
283	AssertPtrReturn(pszThrdName, VERR_INVALID_POINTER);
284	AssertPtrReturn(ppServer, VERR_INVALID_POINTER);
285
286	/*
287	* Create the server.
288	*/
289	PRTTCPSERVER pServer;
290	int rc = RTTcpServerCreateEx(pszAddress, uPort, &pServer);
291	if (RT_SUCCESS(rc))
292	{
293	/*
294	* Create the listener thread.
295	*/
296	RTMemPoolRetain(pServer);
297	pServer->enmState = RTTCPSERVERSTATE_STARTING;
298	pServer->pvUser = pvUser;
299	pServer->pfnServe = pfnServe;
300	rc = RTThreadCreate(&pServer->Thread, rtTcpServerThread, pServer, 0, enmType, /RTTHREADFLAGS_WAITABLE/0, pszThrdName);
301	if (RT_SUCCESS(rc))
302	{
303	/* done */
304	if (ppServer)
305	*ppServer = pServer;
306	else
307	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
308	return rc;
309	}
310	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
311
312	/*
313	* Destroy the server.
314	*/
315	rtTcpServerSetState(pServer, RTTCPSERVERSTATE_CREATED, RTTCPSERVERSTATE_STARTING);
316	RTTcpServerDestroy(pServer);
317	}
318
319	return rc;
320	}
321
322
323	/**
324	* Server thread, loops accepting connections until it's terminated.
325	*
326	* @returns iprt status code. (ignored).
327	* @param ThreadSelf Thread handle.
328	* @param pvServer Server handle.
329	*/
330	static DECLCALLBACK(int) rtTcpServerThread(RTTHREAD ThreadSelf, void *pvServer)
331	{
332	PRTTCPSERVER pServer = (PRTTCPSERVER)pvServer;
333	int rc;
334	if (rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_ACCEPTING, RTTCPSERVERSTATE_STARTING))
335	rc = rtTcpServerListen(pServer);
336	else
337	rc = rcTcpServerListenCleanup(pServer);
338	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
339	NOREF(ThreadSelf);
340	return VINF_SUCCESS;
341	}
342
343
344	/**
345	* Create single connection at a time TCP Server.
346	* The caller must call RTTcpServerListen() to actually start the server.
347	*
348	* @returns iprt status code.
349	* @param pszAddress The address for creating a listening socket.
350	* If NULL the server is bound to all interfaces.
351	* @param uPort The port for creating a listening socket.
352	* @param ppServer Where to store the serverhandle.
353	*/
354	RTR3DECL(int) RTTcpServerCreateEx(const char *pszAddress, uint32_t uPort, PPRTTCPSERVER ppServer)
355	{
356	int rc;
357
358	/*
359	* Validate input.
360	*/
361	AssertReturn(uPort > 0, VERR_INVALID_PARAMETER);
362	AssertPtrReturn(ppServer, VERR_INVALID_PARAMETER);
363
364	#ifdef RT_OS_WINDOWS
365	/*
366	* Initialize WinSock and check version.
367	*/
368	WORD wVersionRequested = MAKEWORD(1, 1);
369	WSADATA wsaData;
370	rc = WSAStartup(wVersionRequested, &wsaData);
371	if (wsaData.wVersion != wVersionRequested)
372	{
373	AssertMsgFailed(("Wrong winsock version\n"));
374	return VERR_NOT_SUPPORTED;
375	}
376	#endif
377
378	/*
379	* Get host listening address.
380	*/
381	struct hostent *pHostEnt = NULL;
382	if (pszAddress != NULL && *pszAddress)
383	{
384	pHostEnt = gethostbyname(pszAddress);
385	if (!pHostEnt)
386	{
387	struct in_addr InAddr;
388	InAddr.s_addr = inet_addr(pszAddress);
389	pHostEnt = gethostbyaddr((char *)&InAddr, 4, AF_INET);
390	if (!pHostEnt)
391	{
392	rc = rtTcpResolverError();
393	AssertMsgFailed(("Could not get host address rc=%Rrc\n", rc));
394	return rc;
395	}
396	}
397	}
398
399	/*
400	* Setting up socket.
401	*/
402	RTSOCKET WaitSock = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
403	if (WaitSock != -1)
404	{
405	/*
406	* Set socket options.
407	*/
408	int fFlag = 1;
409	if (!setsockopt(WaitSock, SOL_SOCKET, SO_REUSEADDR, (const char *)&fFlag, sizeof(fFlag)))
410	{
411	/*
412	* Set socket family, address and port.
413	*/
414	struct sockaddr_in LocalAddr = {0};
415	LocalAddr.sin_family = AF_INET;
416	LocalAddr.sin_port = htons(uPort);
417	/* if address not specified, use INADDR_ANY. */
418	if (!pHostEnt)
419	LocalAddr.sin_addr.s_addr = INADDR_ANY;
420	else
421	LocalAddr.sin_addr = ((struct in_addr )pHostEnt->h_addr);
422
423	/*
424	* Bind a name to a socket.
425	*/
426	if (bind(WaitSock, (struct sockaddr *)&LocalAddr, sizeof(LocalAddr)) != -1)
427	{
428	/*
429	* Listen for connections on a socket.
430	*/
431	if (listen(WaitSock, RTTCP_SERVER_BACKLOG) != -1)
432	{
433	/*
434	* Create the server handle.
435	*/
436	PRTTCPSERVER pServer = (PRTTCPSERVER)RTMemPoolAlloc(RTMEMPOOL_DEFAULT, sizeof(*pServer));
437	if (pServer)
438	{
439	pServer->u32Magic = RTTCPSERVER_MAGIC;
440	pServer->SockServer = WaitSock;
441	pServer->SockClient = NIL_RTSOCKET;
442	pServer->Thread = NIL_RTTHREAD;
443	pServer->enmState = RTTCPSERVERSTATE_CREATED;
444	*ppServer = pServer;
445	return VINF_SUCCESS;
446	}
447
448	/* bail out */
449	rc = VERR_NO_MEMORY;
450	}
451	else
452	{
453	rc = rtTcpError();
454	AssertMsgFailed(("listen() %Rrc\n", rc));
455	}
456	}
457	else
458	{
459	rc = rtTcpError();
460	}
461	}
462	else
463	{
464	rc = rtTcpError();
465	AssertMsgFailed(("setsockopt() %Rrc\n", rc));
466	}
467	rtTcpClose(WaitSock, "RTServerCreateEx");
468	}
469	else
470	{
471	rc = rtTcpError();
472	AssertMsgFailed(("socket() %Rrc\n", rc));
473	}
474
475	return rc;
476	}
477
478
479	/**
480	* Listen for incoming connections.
481	*
482	* The function will loop accepting connections and call pfnServe for
483	* each of the incoming connections in turn. The pfnServe function can
484	* return VERR_TCP_SERVER_STOP too terminate this loop. A stopped server
485	* can only be destroyed.
486	*
487	* @returns IPRT status code.
488	* @retval VERR_TCP_SERVER_STOP if stopped by pfnServe.
489	* @retval VERR_TCP_SERVER_SHUTDOWN if shut down by RTTcpServerShutdown.
490	*
491	* @param pServer The server handle as returned from RTTcpServerCreateEx().
492	* @param pfnServe The function which will serve a new client connection.
493	* @param pvUser User argument passed to pfnServe.
494	*/
495	RTR3DECL(int) RTTcpServerListen(PRTTCPSERVER pServer, PFNRTTCPSERVE pfnServe, void *pvUser)
496	{
497	/*
498	* Validate input and retain the instance.
499	*/
500	AssertPtrReturn(pfnServe, VERR_INVALID_POINTER);
501	AssertPtrReturn(pServer, VERR_INVALID_HANDLE);
502	AssertReturn(pServer->u32Magic == RTTCPSERVER_MAGIC, VERR_INVALID_HANDLE);
503	AssertReturn(RTMemPoolRetain(pServer) != UINT32_MAX, VERR_INVALID_HANDLE);
504
505	int rc = VERR_INVALID_STATE;
506	if (rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_ACCEPTING, RTTCPSERVERSTATE_CREATED))
507	{
508	Assert(!pServer->pfnServe);
509	Assert(!pServer->pvUser);
510	Assert(pServer->Thread == NIL_RTTHREAD);
511	Assert(pServer->SockClient == NIL_RTSOCKET);
512
513	pServer->pfnServe = pfnServe;
514	pServer->pvUser = pvUser;
515	pServer->Thread = RTThreadSelf();
516	Assert(pServer->Thread != NIL_RTTHREAD);
517	rc = rtTcpServerListen(pServer);
518	}
519	else
520	{
521	AssertMsgFailed(("enmState=%d\n", pServer->enmState));
522	rc = VERR_INVALID_STATE;
523	}
524	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
525	return rc;
526	}
527
528
529	/**
530	* Internal worker common for RTTcpServerListen and the thread created by
531	* RTTcpServerCreate().
532	*
533	* The caller makes sure it has its own memory reference and releases it upon
534	* return.
535	*/
536	static int rtTcpServerListen(PRTTCPSERVER pServer)
537	{
538	/*
539	* Accept connection loop.
540	*/
541	for (;;)
542	{
543	/*
544	* Change state.
545	*/
546	RTTCPSERVERSTATE enmState = pServer->enmState;
547	RTSOCKET SockServer = pServer->SockServer;
548	if ( enmState != RTTCPSERVERSTATE_ACCEPTING
549	&& enmState != RTTCPSERVERSTATE_SERVING)
550	return rcTcpServerListenCleanup(pServer);
551	if (!rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_ACCEPTING, enmState))
552	continue;
553
554	/*
555	* Accept connection.
556	*/
557	struct sockaddr_in RemoteAddr = {0};
558	socklen_t cbRemoteAddr = sizeof(RemoteAddr);
559	RTSOCKET Socket = accept(SockServer, (struct sockaddr *)&RemoteAddr, &cbRemoteAddr);
560	if (Socket == -1)
561	{
562	#ifndef RT_OS_WINDOWS
563	/* These are typical for what can happen during destruction. */
564	if (errno == EBADF \|\| errno == EINVAL \|\| errno == ENOTSOCK)
565	return rcTcpServerListenCleanup(pServer);
566	#endif
567	continue;
568	}
569
570	/*
571	* Run a pfnServe callback.
572	*/
573	if (!rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_SERVING, RTTCPSERVERSTATE_ACCEPTING))
574	{
575	rtTcpClose(Socket, "rtTcpServerListen");
576	return rcTcpServerListenCleanup(pServer);
577	}
578	rtTcpAtomicXchgSock(&pServer->SockClient, Socket);
579	int rc = pServer->pfnServe(Socket, pServer->pvUser);
580	rtTcpServerDestroySocket(&pServer->SockClient, "Listener: client");
581
582	/*
583	* Stop the server?
584	*/
585	if (rc == VERR_TCP_SERVER_STOP)
586	{
587	if (rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_STOPPING, RTTCPSERVERSTATE_SERVING))
588	{
589	/*
590	* Reset the server socket and change the state to stopped. After that state change
591	* we cannot safely access the handle so we'll have to return here.
592	*/
593	RTSOCKET SockServer = rtTcpAtomicXchgSock(&pServer->SockServer, NIL_RTSOCKET);
594	rtTcpServerSetState(pServer, RTTCPSERVERSTATE_STOPPED, RTTCPSERVERSTATE_STOPPING);
595	rtTcpClose(SockServer, "Listener: server stopped");
596	}
597	else
598	rcTcpServerListenCleanup(pServer); /* ignore rc */
599	return rc;
600	}
601	}
602	}
603
604
605	/**
606	* Clean up after listener.
607	*/
608	static int rcTcpServerListenCleanup(PRTTCPSERVER pServer)
609	{
610	/*
611	* Close the server socket, the client one shouldn't be set.
612	*/
613	rtTcpServerDestroySocket(&pServer->SockServer, "ListenCleanup");
614	Assert(pServer->SockClient == NIL_RTSOCKET);
615
616	/*
617	* Figure the return code and make sure the state is OK.
618	*/
619	RTTCPSERVERSTATE enmState = pServer->enmState;
620	switch (enmState)
621	{
622	case RTTCPSERVERSTATE_STOPPING:
623	case RTTCPSERVERSTATE_STOPPED:
624	return VERR_TCP_SERVER_SHUTDOWN;
625
626	case RTTCPSERVERSTATE_ACCEPTING:
627	rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_STOPPED, enmState);
628	return VERR_TCP_SERVER_DESTROYED;
629
630	case RTTCPSERVERSTATE_DESTROYING:
631	return VERR_TCP_SERVER_DESTROYED;
632
633	case RTTCPSERVERSTATE_STARTING:
634	case RTTCPSERVERSTATE_SERVING:
635	default:
636	AssertMsgFailedReturn(("pServer=%p enmState=%d\n", pServer, enmState), VERR_INTERNAL_ERROR_4);
637	}
638	}
639
640
641	/**
642	* Terminate the open connection to the server.
643	*
644	* @returns iprt status code.
645	* @param pServer Handle to the server.
646	*/
647	RTR3DECL(int) RTTcpServerDisconnectClient(PRTTCPSERVER pServer)
648	{
649	/*
650	* Validate input and retain the instance.
651	*/
652	AssertPtrReturn(pServer, VERR_INVALID_HANDLE);
653	AssertReturn(pServer->u32Magic == RTTCPSERVER_MAGIC, VERR_INVALID_HANDLE);
654	AssertReturn(RTMemPoolRetain(pServer) != UINT32_MAX, VERR_INVALID_HANDLE);
655
656	int rc = rtTcpServerDestroySocket(&pServer->SockClient, "DisconnectClient: client");
657
658	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
659	return rc;
660	}
661
662
663	/**
664	* Shuts down the server, leaving client connections open.
665	*
666	* @returns IPRT status code.
667	* @param pServer Handle to the server.
668	*/
669	RTR3DECL(int) RTTcpServerShutdown(PRTTCPSERVER pServer)
670	{
671	/*
672	* Validate input and retain the instance.
673	*/
674	AssertPtrReturn(pServer, VERR_INVALID_HANDLE);
675	AssertReturn(pServer->u32Magic == RTTCPSERVER_MAGIC, VERR_INVALID_HANDLE);
676	AssertReturn(RTMemPoolRetain(pServer) != UINT32_MAX, VERR_INVALID_HANDLE);
677
678	/*
679	* Try change the state to stopping, then replace and destroy the server socket.
680	*/
681	for (;;)
682	{
683	RTTCPSERVERSTATE enmState = pServer->enmState;
684	if ( enmState != RTTCPSERVERSTATE_ACCEPTING
685	&& enmState != RTTCPSERVERSTATE_SERVING)
686	{
687	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
688	switch (enmState)
689	{
690	case RTTCPSERVERSTATE_CREATED:
691	case RTTCPSERVERSTATE_STARTING:
692	default:
693	AssertMsgFailed(("%d\n", enmState));
694	return VERR_INVALID_STATE;
695
696	case RTTCPSERVERSTATE_STOPPING:
697	case RTTCPSERVERSTATE_STOPPED:
698	return VINF_SUCCESS;
699
700	case RTTCPSERVERSTATE_DESTROYING:
701	return VERR_TCP_SERVER_DESTROYED;
702	}
703	}
704	if (rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_STOPPING, enmState))
705	{
706	rtTcpServerDestroySocket(&pServer->SockServer, "RTTcpServerShutdown");
707	rtTcpServerSetState(pServer, RTTCPSERVERSTATE_STOPPED, RTTCPSERVERSTATE_STOPPING);
708
709	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
710	return VINF_SUCCESS;
711	}
712	}
713	}
714
715
716	/**
717	* Closes down and frees a TCP Server.
718	* This will also terminate any open connections to the server.
719	*
720	* @returns iprt status code.
721	* @param pServer Handle to the server.
722	*/
723	RTR3DECL(int) RTTcpServerDestroy(PRTTCPSERVER pServer)
724	{
725	/*
726	* Validate input and retain the instance.
727	*/
728	AssertPtrReturn(pServer, VERR_INVALID_HANDLE);
729	AssertReturn(pServer->u32Magic == RTTCPSERVER_MAGIC, VERR_INVALID_HANDLE);
730	AssertReturn(RTMemPoolRetain(pServer) != UINT32_MAX, VERR_INVALID_HANDLE); /* paranoia */
731
732	/*
733	* Move the state along so the listener can figure out what's going on.
734	*/
735	for (;;)
736	{
737	bool fDestroyable;
738	RTTCPSERVERSTATE enmState = pServer->enmState;
739	switch (enmState)
740	{
741	case RTTCPSERVERSTATE_STARTING:
742	case RTTCPSERVERSTATE_ACCEPTING:
743	case RTTCPSERVERSTATE_SERVING:
744	case RTTCPSERVERSTATE_CREATED:
745	case RTTCPSERVERSTATE_STOPPED:
746	fDestroyable = rtTcpServerTrySetState(pServer, RTTCPSERVERSTATE_DESTROYING, enmState);
747	break;
748
749	/* destroyable states */
750	case RTTCPSERVERSTATE_STOPPING:
751	fDestroyable = true;
752	break;
753
754	/*
755	* Everything else means user or internal misbehavior.
756	*/
757	default:
758	AssertMsgFailed(("pServer=%p enmState=%d\n", pServer, enmState));
759	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
760	return VERR_INTERNAL_ERROR;
761	}
762	if (fDestroyable)
763	break;
764	}
765
766	/*
767	* Destroy it.
768	*/
769	ASMAtomicWriteU32(&pServer->u32Magic, ~RTTCPSERVER_MAGIC);
770	rtTcpServerDestroySocket(&pServer->SockServer, "Destroyer: server");
771	rtTcpServerDestroySocket(&pServer->SockClient, "Destroyer: client");
772
773	/*
774	* Release it.
775	*/
776	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
777	RTMemPoolRelease(RTMEMPOOL_DEFAULT, pServer);
778	return VINF_SUCCESS;
779	}
780
781
782	RTR3DECL(int) RTTcpRead(RTSOCKET Sock, void pvBuffer, size_t cbBuffer, size_t pcbRead)
783	{
784	/*
785	* Validate input.
786	*/
787	AssertReturn(cbBuffer > 0, VERR_INVALID_PARAMETER);
788	AssertPtr(pvBuffer);
789
790	/*
791	* Read loop.
792	* If pcbRead is NULL we have to fill the entire buffer!
793	*/
794	size_t cbRead = 0;
795	size_t cbToRead = cbBuffer;
796	for (;;)
797	{
798	rtTcpErrorReset();
799	ssize_t cbBytesRead = recv(Sock, (char *)pvBuffer + cbRead, cbToRead, MSG_NOSIGNAL);
800	if (cbBytesRead < 0)
801	return rtTcpError();
802	if (cbBytesRead == 0 && rtTcpError())
803	return rtTcpError();
804	if (pcbRead)
805	{
806	/* return partial data */
807	*pcbRead = cbBytesRead;
808	break;
809	}
810
811	/* read more? */
812	cbRead += cbBytesRead;
813	if (cbRead == cbBuffer)
814	break;
815
816	/* next */
817	cbToRead = cbBuffer - cbRead;
818	}
819
820	return VINF_SUCCESS;
821	}
822
823
824	RTR3DECL(int) RTTcpWrite(RTSOCKET Sock, const void *pvBuffer, size_t cbBuffer)
825	{
826	do
827	{
828	ssize_t cbWritten = send(Sock, (const char *)pvBuffer, cbBuffer, MSG_NOSIGNAL);
829	if (cbWritten < 0)
830	return rtTcpError();
831	AssertMsg(cbBuffer >= (size_t)cbWritten, ("Wrote more than we requested!!! cbWritten=%d cbBuffer=%d rtTcpError()=%d\n",
832	cbWritten, cbBuffer, rtTcpError()));
833	cbBuffer -= cbWritten;
834	pvBuffer = (char *)pvBuffer + cbWritten;
835	} while (cbBuffer);
836
837	return VINF_SUCCESS;
838	}
839
840
841	RTR3DECL(int) RTTcpFlush(RTSOCKET Sock)
842	{
843	int fFlag = 1;
844	setsockopt(Sock, IPPROTO_TCP, TCP_NODELAY, (const char *)&fFlag, sizeof(fFlag));
845	fFlag = 0;
846	setsockopt(Sock, IPPROTO_TCP, TCP_NODELAY, (const char *)&fFlag, sizeof(fFlag));
847
848	return VINF_SUCCESS;
849	}
850
851
852	RTR3DECL(int) RTTcpSelectOne(RTSOCKET Sock, unsigned cMillies)
853	{
854	fd_set fdsetR;
855	FD_ZERO(&fdsetR);
856	FD_SET(Sock, &fdsetR);
857
858	fd_set fdsetE = fdsetR;
859
860	int rc;
861	if (cMillies == RT_INDEFINITE_WAIT)
862	rc = select(Sock + 1, &fdsetR, NULL, &fdsetE, NULL);
863	else
864	{
865	struct timeval timeout;
866	timeout.tv_sec = cMillies / 1000;
867	timeout.tv_usec = (cMillies % 1000) * 1000;
868	rc = select(Sock + 1, &fdsetR, NULL, &fdsetE, &timeout);
869	}
870	if (rc > 0)
871	return VINF_SUCCESS;
872	if (rc == 0)
873	return VERR_TIMEOUT;
874	return rtTcpError();
875	}
876
877
878	RTR3DECL(int) RTTcpClientConnect(const char *pszAddress, uint32_t uPort, PRTSOCKET pSock)
879	{
880	int rc;
881
882	/*
883	* Validate input.
884	*/
885	AssertReturn(uPort > 0, VERR_INVALID_PARAMETER);
886	AssertPtrReturn(pszAddress, VERR_INVALID_POINTER);
887
888	#ifdef RT_OS_WINDOWS
889	/*
890	* Initialize WinSock and check version.
891	*/
892	WORD wVersionRequested = MAKEWORD(1, 1);
893	WSADATA wsaData;
894	rc = WSAStartup(wVersionRequested, &wsaData);
895	if (wsaData.wVersion != wVersionRequested)
896	{
897	AssertMsgFailed(("Wrong winsock version\n"));
898	return VERR_NOT_SUPPORTED;
899	}
900	#endif
901
902	/*
903	* Resolve the address.
904	*/
905	struct hostent *pHostEnt = NULL;
906	pHostEnt = gethostbyname(pszAddress);
907	if (!pHostEnt)
908	{
909	struct in_addr InAddr;
910	InAddr.s_addr = inet_addr(pszAddress);
911	pHostEnt = gethostbyaddr((char *)&InAddr, 4, AF_INET);
912	if (!pHostEnt)
913	{
914	rc = rtTcpError();
915	AssertMsgFailed(("Could not resolve '%s', rc=%Rrc\n", pszAddress, rc));
916	return rc;
917	}
918	}
919
920	/*
921	* Create the socket and connect.
922	*/
923	RTSOCKET Sock = socket(PF_INET, SOCK_STREAM, 0);
924	if (Sock != -1)
925	{
926	struct sockaddr_in InAddr = {0};
927	InAddr.sin_family = AF_INET;
928	InAddr.sin_port = htons(uPort);
929	InAddr.sin_addr = ((struct in_addr )pHostEnt->h_addr);
930	if (!connect(Sock, (struct sockaddr *)&InAddr, sizeof(InAddr)))
931	{
932	*pSock = Sock;
933	return VINF_SUCCESS;
934	}
935	rc = rtTcpError();
936	rtTcpClose(Sock, "RTTcpClientConnect");
937	}
938	else
939	rc = rtTcpError();
940	return rc;
941	}
942
943
944	RTR3DECL(int) RTTcpClientClose(RTSOCKET Sock)
945	{
946	return rtTcpClose(Sock, "RTTcpClientClose");
947	}
948
949
950	/**
951	* Internal close function which does all the proper bitching.
952	*/
953	static int rtTcpClose(RTSOCKET Sock, const char *pszMsg)
954	{
955	/* ignore nil handles. */
956	if (Sock == NIL_RTSOCKET)
957	return VINF_SUCCESS;
958
959	/*
960	* Attempt to close it.
961	*/
962	#ifdef RT_OS_WINDOWS
963	int rc = closesocket(Sock);
964	#else
965	int rc = close(Sock);
966	#endif
967	if (!rc)
968	return VINF_SUCCESS;
969	rc = rtTcpError();
970	AssertMsgFailed(("\"%s\": close(%d) -> %Rrc\n", pszMsg, Sock, rc));
971	return rc;
972	}
973

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: