VirtualBox

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

Last change on this file since 27770 was 27770, checked in by vboxsync, 15 years ago

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

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette