VirtualBox

source: vbox/trunk/src/VBox/Devices/Network/slirp/slirp_state.h@ 69496

Last change on this file since 69496 was 69496, checked in by vboxsync, 7 years ago

*: scm --update-copyright-year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 16.0 KB
Line 
1/** @file
2 * NAT - slirp state/configuration.
3 */
4
5/*
6 * Copyright (C) 2006-2017 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 */
16
17#ifndef ___slirp_state_h
18#define ___slirp_state_h
19
20#include <iprt/req.h>
21#include <iprt/critsect.h>
22
23#define COUNTERS_INIT
24#include "counters.h"
25
26#include "ip_icmp.h"
27#include "dnsproxy/dnsproxy.h"
28
29
30/** Where to start DHCP IP number allocation. */
31#define START_ADDR 15
32
33/** DHCP Lease time. */
34#define LEASE_TIME (24 * 3600)
35
36/*
37 * ARP cache this is naive implementaion of ARP
38 * cache of mapping 4 byte IPv4 address to 6 byte
39 * ethernet one.
40 */
41struct arp_cache_entry
42{
43 uint32_t ip;
44 uint8_t ether[6];
45 LIST_ENTRY(arp_cache_entry) list;
46};
47LIST_HEAD(arp_cache_head, arp_cache_entry);
48
49/** TFTP session entry. */
50struct dns_domain_entry
51{
52 char *dd_pszDomain;
53 LIST_ENTRY(dns_domain_entry) dd_list;
54};
55LIST_HEAD(dns_domain_list_head, dns_domain_entry);
56
57#ifdef VBOX_WITH_DNSMAPPING_IN_HOSTRESOLVER
58typedef struct DNSMAPPINGENTRY
59{
60 /** Literal or pattern. */
61 bool fPattern;
62 /** Host name or pattern to map. */
63 char *pszName;
64 /** The IP Address. */
65 uint32_t u32IpAddress;
66 /** List entry. */
67 STAILQ_ENTRY(DNSMAPPINGENTRY) MapList;
68} DNSMAPPINGENTRY, *PDNSMAPPINGENTRY;
69typedef STAILQ_HEAD(DNSMAPPINGHEAD, DNSMAPPINGENTRY) DNSMAPPINGHEAD;
70#endif
71
72struct dns_entry
73{
74 struct in_addr de_addr;
75 TAILQ_ENTRY(dns_entry) de_list;
76};
77TAILQ_HEAD(dns_list_head, dns_entry);
78TAILQ_HEAD(if_queue, mbuf);
79
80struct port_forward_rule
81{
82 uint16_t proto;
83 uint16_t host_port;
84 uint16_t guest_port;
85 struct in_addr guest_addr;
86 struct in_addr bind_ip;
87 int activated;
88 struct socket *so;
89 LIST_ENTRY(port_forward_rule) list;
90};
91LIST_HEAD(port_forward_rule_list, port_forward_rule);
92
93
94#ifdef RT_OS_WINDOWS
95struct pong;
96TAILQ_HEAD(pong_tailq, pong);
97#endif
98
99/* forward declaration */
100struct proto_handler;
101
102/** Main state/configuration structure for slirp NAT. */
103typedef struct NATState
104{
105#define PROFILE_COUNTER(name, dsc) STAMPROFILE Stat ## name
106#define COUNTING_COUNTER(name, dsc) STAMCOUNTER Stat ## name
107#include "counters.h"
108 /* Stuff from boot.c */
109 void *pbootp_clients;
110 const char *bootp_filename;
111 /* Stuff from if.c */
112 int if_mtu, if_mru;
113 int if_comp;
114 int if_maxlinkhdr;
115 int if_queued;
116 int if_thresh;
117 /* Stuff from icmp.c */
118 struct icmpstat_t icmpstat;
119 /* Stuff from ip_input.c */
120 struct ipstat_t ipstat;
121 struct ipqhead ipq[IPREASS_NHASH];
122 int maxnipq; /* Administrative limit on # of reass queues*/
123 int maxfragsperpacket; /* Maximum number of IPv4 fragments allowed per packet */
124 int nipq; /* total number of reass queues */
125 uint16_t ip_currid;
126 /* Stuff from mbuf.c */
127 /* Stuff from slirp.c */
128 void *pvUser;
129 uint32_t curtime;
130 uint32_t time_fasttimo;
131 uint32_t last_slowtimo;
132 bool do_slowtimo;
133 bool link_up;
134 struct timeval tt;
135 struct in_addr our_addr;
136 struct in_addr alias_addr;
137 struct in_addr special_addr;
138 struct in_addr guest_addr_guess;
139
140 int tcp_rcvspace;
141 int tcp_sndspace;
142 int socket_rcv;
143 int socket_snd;
144 int soMaxConn;
145#ifdef RT_OS_WINDOWS
146 ULONG (WINAPI * pfnGetAdaptersAddresses)(ULONG, ULONG, PVOID, PIP_ADAPTER_ADDRESSES, PULONG);
147#endif
148 struct dns_list_head pDnsList;
149 struct dns_domain_list_head pDomainList;
150 uint32_t dnsgen; /* XXX: merge with dnsLastUpdate? */
151 struct in_addr tftp_server;
152 struct in_addr loopback_addr;
153 uint32_t dnsLastUpdate;
154 uint32_t netmask;
155 const uint8_t *slirp_ethaddr;
156 char slirp_hostname[33];
157 bool fPassDomain;
158 struct in_addr bindIP;
159 /* Stuff from tcp_input.c */
160 struct socket tcb;
161
162 struct socket *tcp_last_so;
163 tcp_seq tcp_iss;
164 /* Stuff from tcp_timer.c */
165 struct tcpstat_t tcpstat;
166 uint32_t tcp_now;
167 int tcp_reass_qsize;
168 int tcp_reass_maxqlen;
169 int tcp_reass_maxseg;
170 int tcp_reass_overflows;
171 /* Stuff from tftp.c */
172 void *pvTftpSessions;
173 int cTftpSession;
174 const char *tftp_prefix;
175 /* Stuff from udp.c */
176 struct udpstat_t udpstat;
177 struct socket udb;
178 struct socket *udp_last_so;
179
180# ifndef RT_OS_WINDOWS
181 /* counter of sockets needed for allocation enough room to
182 * process sockets with poll/epoll
183 *
184 * NSOCK_INC/DEC should be injected before every
185 * operation on socket queue (tcb, udb)
186 */
187 int nsock;
188# define NSOCK_INC() do {pData->nsock++;} while (0)
189# define NSOCK_DEC() do {pData->nsock--;} while (0)
190# define NSOCK_INC_EX(ex) do {ex->pData->nsock++;} while (0)
191# define NSOCK_DEC_EX(ex) do {ex->pData->nsock--;} while (0)
192# else
193# define NSOCK_INC() do {} while (0)
194# define NSOCK_DEC() do {} while (0)
195# define NSOCK_INC_EX(ex) do {} while (0)
196# define NSOCK_DEC_EX(ex) do {} while (0)
197# endif
198
199 struct socket icmp_socket;
200# if !defined(RT_OS_WINDOWS)
201 struct icmp_storage icmp_msg_head;
202 int cIcmpCacheSize;
203 int iIcmpCacheLimit;
204# else
205 struct pong_tailq pongs_expected;
206 struct pong_tailq pongs_received;
207 size_t cbIcmpPending;
208# endif
209
210#if defined(RT_OS_WINDOWS)
211# define VBOX_SOCKET_EVENT (pData->phEvents[VBOX_SOCKET_EVENT_INDEX])
212 HANDLE phEvents[VBOX_EVENT_COUNT];
213#endif
214#ifdef zone_mbuf
215# undef zone_mbuf
216#endif
217 uma_zone_t zone_mbuf;
218#ifdef zone_clust
219# undef zone_clust
220#endif
221 uma_zone_t zone_clust;
222#ifdef zone_pack
223# undef zone_pack
224#endif
225 uma_zone_t zone_pack;
226#ifdef zone_jumbop
227# undef zone_jumbop
228#endif
229 uma_zone_t zone_jumbop;
230#ifdef zone_jumbo9
231# undef zone_jumbo9
232#endif
233 uma_zone_t zone_jumbo9;
234#ifdef zone_jumbo16
235# undef zone_jumbo16
236#endif
237 uma_zone_t zone_jumbo16;
238#ifdef zone_ext_refcnt
239# undef zone_ext_refcnt
240 int nmbclusters; /* limits number of mbuf clusters */
241 int nmbjumbop; /* limits number of page size jumbo clusters */
242 int nmbjumbo9; /* limits number of 9k jumbo clusters */
243 int nmbjumbo16; /* limits number of 16k jumbo clusters */
244 struct mbstat mbstat;
245#endif
246 uma_zone_t zone_ext_refcnt;
247 /**
248 * in (r89055) using of this behaviour has been changed and mean that Slirp
249 * can't parse hosts strucutures/files to provide to guest host name-resolving
250 * configuration, instead Slirp provides .{interface-number + 1}.3 as a nameserver
251 * and proxies DNS queiries to Host's Name Resolver API.
252 */
253 bool fUseHostResolver;
254 /**
255 * Flag whether using the host resolver mode is permanent
256 * because the user configured it that way.
257 */
258 bool fUseHostResolverPermanent;
259 /* from dnsproxy/dnsproxy.h*/
260 unsigned int authoritative_port;
261 unsigned int authoritative_timeout;
262 unsigned int recursive_port;
263 unsigned int recursive_timeout;
264 unsigned int stats_timeout;
265 unsigned int port;
266
267 unsigned long active_queries;
268 unsigned long all_queries;
269 unsigned long authoritative_queries;
270 unsigned long recursive_queries;
271 unsigned long removed_queries;
272 unsigned long dropped_queries;
273 unsigned long answered_queries;
274 unsigned long dropped_answers;
275 unsigned long late_answers;
276 unsigned long hash_collisions;
277 /*dnsproxy/dnsproxy.c*/
278 unsigned short queryid;
279 struct sockaddr_in authoritative_addr;
280 struct sockaddr_in recursive_addr;
281 int sock_query;
282 int sock_answer;
283 /* dnsproxy/hash.c */
284#define HASHSIZE 10
285#define HASH(id) (id & ((1 << HASHSIZE) - 1))
286 struct request *request_hash[1 << HASHSIZE];
287 /* this field control behaviour of DHCP server */
288 bool fUseDnsProxy;
289
290 LIST_HEAD(RT_NOTHING, libalias) instancehead;
291 int i32AliasMode;
292 struct libalias *proxy_alias;
293 LIST_HEAD(handler_chain, proto_handler) handler_chain;
294 /** Critical R/W section to protect the handler chain list. */
295 RTCRITSECTRW CsRwHandlerChain;
296 struct port_forward_rule_list port_forward_rule_head;
297 struct arp_cache_head arp_cache;
298 /* libalis modules' handlers*/
299 struct proto_handler *ftp_module;
300 struct proto_handler *nbt_module;
301#ifdef VBOX_WITH_NAT_SEND2HOME
302 /* array of home addresses */
303 struct sockaddr_in *pInSockAddrHomeAddress;
304 /* size of pInSockAddrHomeAddress in elements */
305 int cInHomeAddressSize;
306#endif
307#ifdef VBOX_WITH_DNSMAPPING_IN_HOSTRESOLVER
308 DNSMAPPINGHEAD DNSMapNames;
309 DNSMAPPINGHEAD DNSMapPatterns;
310#endif
311} NATState;
312
313
314/** Default IP time to live. */
315#define ip_defttl IPDEFTTL
316
317/** Number of permanent buffers in mbuf. */
318#define mbuf_thresh 30
319
320/** Use a fixed time before sending keepalive. */
321#define tcp_keepidle TCPTV_KEEP_IDLE
322
323/** Use a fixed interval between keepalive. */
324#define tcp_keepintvl TCPTV_KEEPINTVL
325
326/** Maximum idle time before timing out a connection. */
327#define tcp_maxidle (TCPTV_KEEPCNT * tcp_keepintvl)
328
329/** Default TCP socket options. */
330#define so_options DO_KEEPALIVE
331
332/** Default TCP MSS value. */
333#define tcp_mssdflt TCP_MSS
334
335/** Default TCP round trip time. */
336#define tcp_rttdflt (TCPTV_SRTTDFLT / PR_SLOWHZ)
337
338/** Enable RFC1323 performance enhancements.
339 * @todo check if it really works, it was turned off before. */
340#define tcp_do_rfc1323 1
341
342/** TCP receive buffer size. */
343#define tcp_rcvspace pData->tcp_rcvspace
344
345/** TCP receive buffer size. */
346#define tcp_sndspace pData->tcp_sndspace
347
348/* TCP duplicate ACK retransmit threshold. */
349#define tcprexmtthresh 3
350
351
352#define bootp_filename pData->bootp_filename
353
354#define if_mtu pData->if_mtu
355#define if_mru pData->if_mru
356#define if_comp pData->if_comp
357#define if_maxlinkhdr pData->if_maxlinkhdr
358#define if_queued pData->if_queued
359#define if_thresh pData->if_thresh
360
361#define icmpstat pData->icmpstat
362
363#define ipstat pData->ipstat
364#define ipq pData->ipq
365#define ip_currid pData->ip_currid
366
367#define mbuf_alloced pData->mbuf_alloced
368#define mbuf_max pData->mbuf_max
369#define msize pData->msize
370#define m_freelist pData->m_freelist
371#define m_usedlist pData->m_usedlist
372
373#define curtime pData->curtime
374#define time_fasttimo pData->time_fasttimo
375#define last_slowtimo pData->last_slowtimo
376#define do_slowtimo pData->do_slowtimo
377#define link_up pData->link_up
378#define cUsers pData->cUsers
379#define tt pData->tt
380#define our_addr pData->our_addr
381#ifndef VBOX_SLIRP_ALIAS
382# define alias_addr pData->alias_addr
383#else
384# define handler_chain pData->handler_chain
385#endif
386#define dns_addr pData->dns_addr
387#define loopback_addr pData->loopback_addr
388#define slirp_hostname pData->slirp_hostname
389
390#define tcb pData->tcb
391#define tcp_last_so pData->tcp_last_so
392#define tcp_iss pData->tcp_iss
393
394#define tcpstat pData->tcpstat
395#define tcp_now pData->tcp_now
396
397#define tftp_prefix pData->tftp_prefix
398
399#define udpstat pData->udpstat
400#define udb pData->udb
401#define udp_last_so pData->udp_last_so
402
403#define maxfragsperpacket pData->maxfragsperpacket
404#define maxnipq pData->maxnipq
405#define nipq pData->nipq
406
407#define tcp_reass_qsize pData->tcp_reass_qsize
408#define tcp_reass_maxqlen pData->tcp_reass_maxqlen
409#define tcp_reass_maxseg pData->tcp_reass_maxseg
410#define tcp_reass_overflows pData->tcp_reass_overflows
411
412#define queue_tcp_label tcb
413#define queue_udp_label udb
414#define VBOX_X2(x) x
415#define VBOX_X(x) VBOX_X2(x)
416
417#if 1
418
419# define QSOCKET_LOCK(queue) do {} while (0)
420# define QSOCKET_UNLOCK(queue) do {} while (0)
421# define QSOCKET_LOCK_CREATE(queue) do {} while (0)
422# define QSOCKET_LOCK_DESTROY(queue) do {} while (0)
423# define QSOCKET_FOREACH(so, sonext, label) \
424 for ((so) = VBOX_X2(queue_ ## label ## _label).so_next; \
425 (so) != &(VBOX_X2(queue_ ## label ## _label)); \
426 (so) = (sonext)) \
427 { \
428 (sonext) = (so)->so_next; \
429 Log5(("%s:%d Processing so:%R[natsock]\n", RT_GCC_EXTENSION __FUNCTION__, __LINE__, (so)));
430# define CONTINUE(label) continue
431# define CONTINUE_NO_UNLOCK(label) continue
432# define LOOP_LABEL(label, so, sonext) /* empty*/
433# define DO_TCP_OUTPUT(data, sotcb) tcp_output((data), (sotcb))
434# define DO_TCP_INPUT(data, mbuf, size, so) tcp_input((data), (mbuf), (size), (so))
435# define DO_TCP_CONNECT(data, so) tcp_connect((data), (so))
436# define DO_SOREAD(ret, data, so, ifclose) \
437 do { \
438 (ret) = soread((data), (so), (ifclose)); \
439 } while(0)
440# define DO_SOWRITE(ret, data, so) \
441 do { \
442 (ret) = sowrite((data), (so)); \
443 } while(0)
444# define DO_SORECFROM(data, so) sorecvfrom((data), (so))
445# define SOLOOKUP(so, label, src, sport, dst, dport) \
446 do { \
447 (so) = solookup(&VBOX_X2(queue_ ## label ## _label), (src), (sport), (dst), (dport)); \
448 } while (0)
449# define DO_UDP_DETACH(data, so, ignored) udp_detach((data), (so))
450
451#endif
452
453#define TCP_OUTPUT(data, sotcb) DO_TCP_OUTPUT((data), (sotcb))
454#define TCP_INPUT(data, mbuf, size, so) DO_TCP_INPUT((data), (mbuf), (size), (so))
455#define TCP_CONNECT(data, so) DO_TCP_CONNECT((data), (so))
456#define SOREAD(ret, data, so, ifclose) DO_SOREAD((ret), (data), (so), (ifclose))
457#define SOWRITE(ret, data, so) DO_SOWRITE((ret), (data), (so))
458#define SORECVFROM(data, so) DO_SORECFROM((data), (so))
459#define UDP_DETACH(data, so, so_next) DO_UDP_DETACH((data), (so), (so_next))
460
461/* dnsproxy/dnsproxy.c */
462#define authoritative_port pData->authoritative_port
463#define authoritative_timeout pData->authoritative_timeout
464#define recursive_port pData->recursive_port
465#define recursive_timeout pData->recursive_timeout
466#define stats_timeout pData->stats_timeout
467/* dnsproxy/hash.c */
468#define dns_port pData->port
469#define request_hash pData->request_hash
470#define hash_collisions pData->hash_collisions
471#define active_queries pData->active_queries
472#define all_queries pData->all_queries
473#define authoritative_queries pData->authoritative_queries
474#define recursive_queries pData->recursive_queries
475#define removed_queries pData->removed_queries
476#define dropped_queries pData->dropped_queries
477#define answered_queries pData->answered_queries
478#define dropped_answers pData->dropped_answers
479#define late_answers pData->late_answers
480
481/* dnsproxy/dnsproxy.c */
482#define queryid pData->queryid
483#define authoritative_addr pData->authoritative_addr
484#define recursive_addr pData->recursive_addr
485#define sock_query pData->sock_query
486#define sock_answer pData->sock_answer
487
488#define instancehead pData->instancehead
489
490#define nmbclusters pData->nmbclusters
491#define nmbjumbop pData->nmbjumbop
492#define nmbjumbo9 pData->nmbjumbo9
493#define nmbjumbo16 pData->nmbjumbo16
494#define mbstat pData->mbstat
495#include "ext.h"
496#undef zone_mbuf
497#undef zone_clust
498#undef zone_pack
499#undef zone_jumbop
500#undef zone_jumbo9
501#undef zone_jumbo16
502#undef zone_ext_refcnt
503static inline uma_zone_t slirp_zone_pack(PNATState pData)
504{
505 return pData->zone_pack;
506}
507static inline uma_zone_t slirp_zone_jumbop(PNATState pData)
508{
509 return pData->zone_jumbop;
510}
511static inline uma_zone_t slirp_zone_jumbo9(PNATState pData)
512{
513 return pData->zone_jumbo9;
514}
515static inline uma_zone_t slirp_zone_jumbo16(PNATState pData)
516{
517 return pData->zone_jumbo16;
518}
519static inline uma_zone_t slirp_zone_ext_refcnt(PNATState pData)
520{
521 return pData->zone_ext_refcnt;
522}
523static inline uma_zone_t slirp_zone_mbuf(PNATState pData)
524{
525 return pData->zone_mbuf;
526}
527static inline uma_zone_t slirp_zone_clust(PNATState pData)
528{
529 return pData->zone_clust;
530}
531#ifndef VBOX_SLIRP_BSD
532# define m_adj(m, len) m_adj(pData, (m), (len))
533#endif
534
535#endif /* !___slirp_state_h */
Note: See TracBrowser for help on using the repository browser.

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