VirtualBox

source: vbox/trunk/src/VBox/Devices/Network/slirp/socket.h@ 59202

Last change on this file since 59202 was 56292, checked in by vboxsync, 9 years ago

Devices: Updated (C) year.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.5 KB
Line 
1/* $Id: socket.h 56292 2015-06-09 14:20:46Z vboxsync $ */
2/** @file
3 * NAT - socket handling (declarations/defines).
4 */
5
6/*
7 * Copyright (C) 2006-2015 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. 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
18/*
19 * This code is based on:
20 *
21 * Copyright (c) 1995 Danny Gasparovski.
22 *
23 * Please read the file COPYRIGHT for the
24 * terms and conditions of the copyright.
25 */
26
27/* MINE */
28
29#ifndef _SLIRP_SOCKET_H_
30#define _SLIRP_SOCKET_H_
31
32#define SO_EXPIRE 240000
33#define SO_EXPIREFAST 10000
34
35/*
36 * Our socket structure
37 */
38
39struct socket
40{
41 struct socket *so_next;
42 struct socket *so_prev; /* For a linked list of sockets */
43
44#if !defined(RT_OS_WINDOWS)
45 int s; /* The actual socket */
46#else
47 union {
48 int s;
49 HANDLE sh;
50 };
51 uint64_t so_icmp_id; /* XXX: hack */
52 uint64_t so_icmp_seq; /* XXX: hack */
53#endif
54
55 /* XXX union these with not-yet-used sbuf params */
56 struct mbuf *so_m; /* Pointer to the original SYN packet,
57 * for non-blocking connect()'s, and
58 * PING reply's */
59 struct tcpiphdr *so_ti; /* Pointer to the original ti within
60 * so_mconn, for non-blocking connections */
61 uint8_t *so_ohdr; /* unmolested IP header of the datagram in so_m */
62 int so_urgc;
63 struct in_addr so_faddr; /* foreign host table entry */
64 struct in_addr so_laddr; /* local host table entry */
65 u_int16_t so_fport; /* foreign port */
66 u_int16_t so_lport; /* local port */
67 u_int16_t so_hlport; /* host local port */
68 struct in_addr so_hladdr; /* local host addr */
69
70 u_int8_t so_iptos; /* Type of service */
71
72 uint8_t so_sottl; /* cached socket's IP_TTL option */
73 uint8_t so_sotos; /* cached socket's IP_TOS option */
74 int8_t so_sodf; /* cached socket's DF option */
75
76 u_char so_type; /* Type of socket, UDP or TCP */
77 int so_state; /* internal state flags SS_*, below */
78
79 struct tcpcb *so_tcpcb; /* pointer to TCP protocol control block */
80 u_int so_expire; /* When the socket will expire */
81
82 int so_queued; /* Number of packets queued from this socket */
83 int so_nqueued; /* Number of packets queued in a row
84 * Used to determine when to "downgrade" a session
85 * from fastq to batchq */
86
87 struct sbuf so_rcv; /* Receive buffer */
88 struct sbuf so_snd; /* Send buffer */
89#ifndef RT_OS_WINDOWS
90 int so_poll_index;
91#endif /* !RT_OS_WINDOWS */
92 /*
93 * FD_CLOSE/POLLHUP event has been occurred on socket
94 */
95 int so_close;
96
97 void (* so_timeout)(PNATState pData, struct socket *so, void *arg);
98 void *so_timeout_arg;
99
100#ifdef VBOX_WITH_NAT_UDP_SOCKET_CLONE
101 struct socket *so_cloneOf; /* pointer to master instance */
102 int so_cCloneCounter; /* number of clones */
103#endif
104 /** These flags (''fUnderPolling'' and ''fShouldBeRemoved'') introduced to
105 * to let polling routine gain control over freeing socket whatever level of
106 * TCP/IP initiated socket releasing.
107 * So polling routine when start processing socket alter it's state to
108 * ''fUnderPolling'' to 1, and clean (set to 0) when it finish.
109 * When polling routine calls functions it should be ensure on return,
110 * whether ''fShouldBeRemoved'' set or not, and depending on state call
111 * ''sofree'' or continue socket processing.
112 * On ''fShouldBeRemoved'' equal to 1, polling routine should call ''sofree'',
113 * clearing ''fUnderPolling'' to do real freeng of the socket and removing from
114 * the queue.
115 * @todo: perhaps, to simplefy the things we need some helper function.
116 * @note: it's used like a bool, I use 'int' to avoid compiler warnings
117 * appearing if [-Wc++-compat] used.
118 */
119 int fUnderPolling;
120 /** This flag used by ''sofree'' function in following manner
121 *
122 * fUnderPolling = 1, then we don't remove socket from the queue, just
123 * alter value ''fShouldBeRemoved'' to 1, else we do removal.
124 */
125 int fShouldBeRemoved;
126};
127
128# define SOCKET_LOCK(so) do {} while (0)
129# define SOCKET_UNLOCK(so) do {} while (0)
130# define SOCKET_LOCK_CREATE(so) do {} while (0)
131# define SOCKET_LOCK_DESTROY(so) do {} while (0)
132
133/*
134 * Socket state bits. (peer means the host on the Internet,
135 * local host means the host on the other end of the modem)
136 */
137#define SS_NOFDREF 0x001 /* No fd reference */
138
139#define SS_ISFCONNECTING 0x002 /* Socket is connecting to peer (non-blocking connect()'s) */
140#define SS_ISFCONNECTED 0x004 /* Socket is connected to peer */
141#define SS_FCANTRCVMORE 0x008 /* Socket can't receive more from peer (for half-closes) */
142#define SS_FCANTSENDMORE 0x010 /* Socket can't send more to peer (for half-closes) */
143/* #define SS_ISFDISCONNECTED 0x020*/ /* Socket has disconnected from peer, in 2MSL state */
144#define SS_FWDRAIN 0x040 /* We received a FIN, drain data and set SS_FCANTSENDMORE */
145
146/* #define SS_CTL 0x080 */
147#define SS_FACCEPTCONN 0x100 /* Socket is accepting connections from a host on the internet */
148#define SS_FACCEPTONCE 0x200 /* If set, the SS_FACCEPTCONN socket will die after one accept */
149
150extern struct socket tcb;
151
152#if defined(DECLARE_IOVEC) && !defined(HAVE_READV)
153# if !defined(RT_OS_WINDOWS)
154struct iovec
155{
156 char *iov_base;
157 size_t iov_len;
158};
159# else
160/* make it congruent with WSABUF */
161struct iovec
162{
163 ULONG iov_len;
164 char *iov_base;
165};
166# endif
167#endif
168
169void so_init (void);
170struct socket * solookup (struct socket *, struct in_addr, u_int, struct in_addr, u_int);
171struct socket * socreate (void);
172void sofree (PNATState, struct socket *);
173int soread (PNATState, struct socket *);
174void sorecvoob (PNATState, struct socket *);
175int sosendoob (struct socket *);
176int sowrite (PNATState, struct socket *);
177void sorecvfrom (PNATState, struct socket *);
178int sosendto (PNATState, struct socket *, struct mbuf *);
179struct socket * solisten (PNATState, u_int32_t, u_int, u_int32_t, u_int, int);
180void sorwakeup (struct socket *);
181void sowwakeup (struct socket *);
182void soisfconnecting (register struct socket *);
183void soisfconnected (register struct socket *);
184void sofcantrcvmore (struct socket *);
185void sofcantsendmore (struct socket *);
186void soisfdisconnected (struct socket *);
187void sofwdrain (struct socket *);
188
189/**
190 * Creates copy of UDP socket with specified addr
191 * fBindSocket - in case we want bind a real socket.
192 * @return copy of the socket with f_addr equal to u32ForeignAddr
193 */
194#ifdef VBOX_WITH_NAT_UDP_SOCKET_CLONE
195struct socket * soCloneUDPSocketWithForegnAddr(PNATState pData, bool fBindSocket, struct socket *pSo, uint32_t u32ForeignAddr);
196struct socket *soLookUpClonedUDPSocket(PNATState pData, const struct socket *pcSo, uint32_t u32ForeignAddress);
197#endif
198
199static inline int soIgnorableErrorCode(int iErrorCode)
200{
201 return ( iErrorCode == EINPROGRESS
202 || iErrorCode == EAGAIN
203 || iErrorCode == EWOULDBLOCK);
204}
205
206#endif /* _SOCKET_H_ */
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use