VirtualBox

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

Last change on this file was 98103, checked in by vboxsync, 16 months ago

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

© 2023 Oracle
Contact – Privacy policy – Terms of Use