slirp_state.h@ 50690

Last change on this file since 50690 was 50156, checked in by vboxsync, 11 years ago
NAT/slirp: comment updates to (r89055). Clarify the difference between NATState::fUseHostResolver and NATState::fUseHostResolverPermanent.
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-2012 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	*/
41	struct arp_cache_entry
42	{
43	uint32_t ip;
44	uint8_t ether[6];
45	LIST_ENTRY(arp_cache_entry) list;
46	};
47	LIST_HEAD(arp_cache_head, arp_cache_entry);
48
49	/** TFTP session entry. */
50	struct dns_domain_entry
51	{
52	char *dd_pszDomain;
53	LIST_ENTRY(dns_domain_entry) dd_list;
54	};
55	LIST_HEAD(dns_domain_list_head, dns_domain_entry);
56
57	#ifdef VBOX_WITH_DNSMAPPING_IN_HOSTRESOLVER
58	typedef struct DNSMAPPINGENTRY
59	{
60	/** host name to map.
61	* @note If pszCName isn't null pszPattern won't be used (see alias_dns.c for
62	* details).
63	*/
64	char *pszCName;
65	/** Pattern (simple) of hostnames to map to the specified IP. */
66	char *pszPattern;
67	/** The IP Address. */
68	uint32_t u32IpAddress;
69	/** List entry. */
70	LIST_ENTRY(DNSMAPPINGENTRY) MapList;
71	} DNSMAPPINGENTRY, *PDNSMAPPINGENTRY;
72	typedef LIST_HEAD(DNSMAPPINGLISTHEAD, DNSMAPPINGENTRY) DNSMAPPINGLISTHEAD;
73	#endif
74
75	struct dns_entry
76	{
77	struct in_addr de_addr;
78	TAILQ_ENTRY(dns_entry) de_list;
79	};
80	TAILQ_HEAD(dns_list_head, dns_entry);
81	TAILQ_HEAD(if_queue, mbuf);
82
83	struct port_forward_rule
84	{
85	uint16_t proto;
86	uint16_t host_port;
87	uint16_t guest_port;
88	struct in_addr guest_addr;
89	struct in_addr bind_ip;
90	uint8_t mac_address[6]; /need ETH_ALEN here /
91	int activated;
92	struct socket *so;
93	LIST_ENTRY(port_forward_rule) list;
94	};
95	LIST_HEAD(port_forward_rule_list, port_forward_rule);
96
97
98
99	/* forward declaration */
100	struct proto_handler;
101
102	/** Main state/configuration structure for slirp NAT. */
103	typedef 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
139	int tcp_rcvspace;
140	int tcp_sndspace;
141	int socket_rcv;
142	int socket_snd;
143	int soMaxConn;
144	#ifdef RT_OS_WINDOWS
145	ULONG (WINAPI * pfGetAdaptersAddresses)(ULONG, ULONG, PVOID, PIP_ADAPTER_ADDRESSES, PULONG);
146	#endif
147	struct dns_list_head pDnsList;
148	struct dns_domain_list_head pDomainList;
149	struct in_addr tftp_server;
150	struct in_addr loopback_addr;
151	uint32_t dnsLastUpdate;
152	uint32_t netmask;
153	#ifndef VBOX_WITH_NAT_SERVICE
154	uint8_t client_ethaddr[6];
155	#endif
156	const uint8_t *slirp_ethaddr;
157	char slirp_hostname[33];
158	bool fPassDomain;
159	struct in_addr bindIP;
160	/* Stuff from tcp_input.c */
161	struct socket tcb;
162
163	struct socket *tcp_last_so;
164	tcp_seq tcp_iss;
165	/* Stuff from tcp_timer.c */
166	struct tcpstat_t tcpstat;
167	uint32_t tcp_now;
168	int tcp_reass_qsize;
169	int tcp_reass_maxqlen;
170	int tcp_reass_maxseg;
171	int tcp_reass_overflows;
172	/* Stuff from tftp.c */
173	void *pvTftpSessions;
174	int cTftpSession;
175	const char *tftp_prefix;
176	/* Stuff from udp.c */
177	struct udpstat_t udpstat;
178	struct socket udb;
179	struct socket *udp_last_so;
180	struct socket icmp_socket;
181	struct icmp_storage icmp_msg_head;
182	# ifndef RT_OS_WINDOWS
183	/* counter of sockets needed for allocation enough room to
184	* process sockets with poll/epoll
185	*
186	* NSOCK_INC/DEC should be injected before every
187	* operation on socket queue (tcb, udb)
188	*/
189	int nsock;
190	# define NSOCK_INC() do {pData->nsock++;} while (0)
191	# define NSOCK_DEC() do {pData->nsock--;} while (0)
192	# define NSOCK_INC_EX(ex) do {ex->pData->nsock++;} while (0)
193	# define NSOCK_DEC_EX(ex) do {ex->pData->nsock--;} while (0)
194	# else
195	# define NSOCK_INC() do {} while (0)
196	# define NSOCK_DEC() do {} while (0)
197	# define NSOCK_INC_EX(ex) do {} while (0)
198	# define NSOCK_DEC_EX(ex) do {} while (0)
199	# endif
200	int cIcmpCacheSize;
201	int iIcmpCacheLimit;
202	# ifdef RT_OS_WINDOWS
203	void *pvIcmpBuffer;
204	uint32_t cbIcmpBuffer;
205	/* According MSDN specification IcmpParseReplies
206	* function should be detected at runtime.
207	*/
208	long (WINAPI * pfIcmpParseReplies)(void *, long);
209	BOOL (WINAPI * pfIcmpCloseHandle)(HANDLE);
210	# endif
211	#if defined(RT_OS_WINDOWS)
212	# define VBOX_SOCKET_EVENT (pData->phEvents[VBOX_SOCKET_EVENT_INDEX])
213	HANDLE phEvents[VBOX_EVENT_COUNT];
214	#endif
215	#ifdef zone_mbuf
216	# undef zone_mbuf
217	#endif
218	uma_zone_t zone_mbuf;
219	#ifdef zone_clust
220	# undef zone_clust
221	#endif
222	uma_zone_t zone_clust;
223	#ifdef zone_pack
224	# undef zone_pack
225	#endif
226	uma_zone_t zone_pack;
227	#ifdef zone_jumbop
228	# undef zone_jumbop
229	#endif
230	uma_zone_t zone_jumbop;
231	#ifdef zone_jumbo9
232	# undef zone_jumbo9
233	#endif
234	uma_zone_t zone_jumbo9;
235	#ifdef zone_jumbo16
236	# undef zone_jumbo16
237	#endif
238	uma_zone_t zone_jumbo16;
239	#ifdef zone_ext_refcnt
240	# undef zone_ext_refcnt
241	int nmbclusters; /* limits number of mbuf clusters */
242	int nmbjumbop; /* limits number of page size jumbo clusters */
243	int nmbjumbo9; /* limits number of 9k jumbo clusters */
244	int nmbjumbo16; /* limits number of 16k jumbo clusters */
245	struct mbstat mbstat;
246	#endif
247	uma_zone_t zone_ext_refcnt;
248	/**
249	* in (r89055) using of this behaviour has been changed and mean that Slirp
250	* can't parse hosts strucutures/files to provide to guest host name-resolving
251	* configuration, instead Slirp provides .{interface-number + 1}.3 as a nameserver
252	* and proxies DNS queiries to Host's Name Resolver API.
253	*/
254	bool fUseHostResolver;
255	/**
256	* Flag whether using the host resolver mode is permanent
257	* because the user configured it that way.
258	*/
259	bool fUseHostResolverPermanent;
260	/* from dnsproxy/dnsproxy.h*/
261	unsigned int authoritative_port;
262	unsigned int authoritative_timeout;
263	unsigned int recursive_port;
264	unsigned int recursive_timeout;
265	unsigned int stats_timeout;
266	unsigned int port;
267
268	unsigned long active_queries;
269	unsigned long all_queries;
270	unsigned long authoritative_queries;
271	unsigned long recursive_queries;
272	unsigned long removed_queries;
273	unsigned long dropped_queries;
274	unsigned long answered_queries;
275	unsigned long dropped_answers;
276	unsigned long late_answers;
277	unsigned long hash_collisions;
278	/dnsproxy/dnsproxy.c/
279	unsigned short queryid;
280	struct sockaddr_in authoritative_addr;
281	struct sockaddr_in recursive_addr;
282	int sock_query;
283	int sock_answer;
284	/* dnsproxy/hash.c */
285	#define HASHSIZE 10
286	#define HASH(id) (id & ((1 << HASHSIZE) - 1))
287	struct request *request_hash[1 << HASHSIZE];
288	/* this field control behaviour of DHCP server */
289	bool fUseDnsProxy;
290
291	LIST_HEAD(RT_NOTHING, libalias) instancehead;
292	int i32AliasMode;
293	struct libalias *proxy_alias;
294	struct libalias *dns_alias;
295	LIST_HEAD(handler_chain, proto_handler) handler_chain;
296	/** Critical R/W section to protect the handler chain list. */
297	RTCRITSECTRW CsRwHandlerChain;
298	struct port_forward_rule_list port_forward_rule_head;
299	int cRedirectionsActive;
300	int cRedirectionsStored;
301	struct arp_cache_head arp_cache;
302	/* libalis modules' handlers*/
303	struct proto_handler *ftp_module;
304	struct proto_handler *nbt_module;
305	struct proto_handler *dns_module;
306	#ifdef VBOX_WITH_NAT_SEND2HOME
307	/* array of home addresses */
308	struct sockaddr_in *pInSockAddrHomeAddress;
309	/* size of pInSockAddrHomeAddress in elements */
310	int cInHomeAddressSize;
311	#endif
312	#ifdef VBOX_WITH_DNSMAPPING_IN_HOSTRESOLVER
313	DNSMAPPINGLISTHEAD DNSMapHead;
314	#endif
315	} NATState;
316
317
318	/** Default IP time to live. */
319	#define ip_defttl IPDEFTTL
320
321	/** Number of permanent buffers in mbuf. */
322	#define mbuf_thresh 30
323
324	/** Use a fixed time before sending keepalive. */
325	#define tcp_keepidle TCPTV_KEEP_IDLE
326
327	/** Use a fixed interval between keepalive. */
328	#define tcp_keepintvl TCPTV_KEEPINTVL
329
330	/** Maximum idle time before timing out a connection. */
331	#define tcp_maxidle (TCPTV_KEEPCNT * tcp_keepintvl)
332
333	/** Default TCP socket options. */
334	#define so_options DO_KEEPALIVE
335
336	/** Default TCP MSS value. */
337	#define tcp_mssdflt TCP_MSS
338
339	/** Default TCP round trip time. */
340	#define tcp_rttdflt (TCPTV_SRTTDFLT / PR_SLOWHZ)
341
342	/** Enable RFC1323 performance enhancements.
343	* @todo check if it really works, it was turned off before. */
344	#define tcp_do_rfc1323 1
345
346	/** TCP receive buffer size. */
347	#define tcp_rcvspace pData->tcp_rcvspace
348
349	/** TCP receive buffer size. */
350	#define tcp_sndspace pData->tcp_sndspace
351
352	/* TCP duplicate ACK retransmit threshold. */
353	#define tcprexmtthresh 3
354
355
356	#define bootp_filename pData->bootp_filename
357
358	#define if_mtu pData->if_mtu
359	#define if_mru pData->if_mru
360	#define if_comp pData->if_comp
361	#define if_maxlinkhdr pData->if_maxlinkhdr
362	#define if_queued pData->if_queued
363	#define if_thresh pData->if_thresh
364
365	#define icmpstat pData->icmpstat
366
367	#define ipstat pData->ipstat
368	#define ipq pData->ipq
369	#define ip_currid pData->ip_currid
370
371	#define mbuf_alloced pData->mbuf_alloced
372	#define mbuf_max pData->mbuf_max
373	#define msize pData->msize
374	#define m_freelist pData->m_freelist
375	#define m_usedlist pData->m_usedlist
376
377	#define curtime pData->curtime
378	#define time_fasttimo pData->time_fasttimo
379	#define last_slowtimo pData->last_slowtimo
380	#define do_slowtimo pData->do_slowtimo
381	#define link_up pData->link_up
382	#define cUsers pData->cUsers
383	#define tt pData->tt
384	#define our_addr pData->our_addr
385	#ifndef VBOX_SLIRP_ALIAS
386	# define alias_addr pData->alias_addr
387	#else
388	# define handler_chain pData->handler_chain
389	#endif
390	#define dns_addr pData->dns_addr
391	#define loopback_addr pData->loopback_addr
392	#define client_ethaddr pData->client_ethaddr
393	#define slirp_hostname pData->slirp_hostname
394
395	#define tcb pData->tcb
396	#define tcp_last_so pData->tcp_last_so
397	#define tcp_iss pData->tcp_iss
398
399	#define tcpstat pData->tcpstat
400	#define tcp_now pData->tcp_now
401
402	#define tftp_prefix pData->tftp_prefix
403
404	#define udpstat pData->udpstat
405	#define udb pData->udb
406	#define udp_last_so pData->udp_last_so
407
408	#define maxfragsperpacket pData->maxfragsperpacket
409	#define maxnipq pData->maxnipq
410	#define nipq pData->nipq
411
412	#define tcp_reass_qsize pData->tcp_reass_qsize
413	#define tcp_reass_maxqlen pData->tcp_reass_maxqlen
414	#define tcp_reass_maxseg pData->tcp_reass_maxseg
415	#define tcp_reass_overflows pData->tcp_reass_overflows
416
417	#define queue_tcp_label tcb
418	#define queue_udp_label udb
419	#define VBOX_X2(x) x
420	#define VBOX_X(x) VBOX_X2(x)
421
422	#if 1
423
424	# define QSOCKET_LOCK(queue) do {} while (0)
425	# define QSOCKET_UNLOCK(queue) do {} while (0)
426	# define QSOCKET_LOCK_CREATE(queue) do {} while (0)
427	# define QSOCKET_LOCK_DESTROY(queue) do {} while (0)
428	# define QSOCKET_FOREACH(so, sonext, label) \
429	for ((so) = VBOX_X2(queue_ ## label ## _label).so_next; \
430	(so) != &(VBOX_X2(queue_ ## label ## _label)); \
431	(so) = (sonext)) \
432	{ \
433	(sonext) = (so)->so_next; \
434	Log2(("%s:%d Processing so:%R[natsock]\n", __FUNCTION__, __LINE__, (so)));
435	# define CONTINUE(label) continue
436	# define CONTINUE_NO_UNLOCK(label) continue
437	# define LOOP_LABEL(label, so, sonext) /* empty*/
438	# define DO_TCP_OUTPUT(data, sotcb) tcp_output((data), (sotcb))
439	# define DO_TCP_INPUT(data, mbuf, size, so) tcp_input((data), (mbuf), (size), (so))
440	# define DO_TCP_CONNECT(data, so) tcp_connect((data), (so))
441	# define DO_SOREAD(ret, data, so, ifclose) \
442	do { \
443	(ret) = soread((data), (so), (ifclose)); \
444	} while(0)
445	# define DO_SOWRITE(ret, data, so) \
446	do { \
447	(ret) = sowrite((data), (so)); \
448	} while(0)
449	# define DO_SORECFROM(data, so) sorecvfrom((data), (so))
450	# define SOLOOKUP(so, label, src, sport, dst, dport) \
451	do { \
452	(so) = solookup(&VBOX_X2(queue_ ## label ## _label), (src), (sport), (dst), (dport)); \
453	} while (0)
454	# define DO_UDP_DETACH(data, so, ignored) udp_detach((data), (so))
455
456	#endif
457
458	#define TCP_OUTPUT(data, sotcb) DO_TCP_OUTPUT((data), (sotcb))
459	#define TCP_INPUT(data, mbuf, size, so) DO_TCP_INPUT((data), (mbuf), (size), (so))
460	#define TCP_CONNECT(data, so) DO_TCP_CONNECT((data), (so))
461	#define SOREAD(ret, data, so, ifclose) DO_SOREAD((ret), (data), (so), (ifclose))
462	#define SOWRITE(ret, data, so) DO_SOWRITE((ret), (data), (so))
463	#define SORECVFROM(data, so) DO_SORECFROM((data), (so))
464	#define UDP_DETACH(data, so, so_next) DO_UDP_DETACH((data), (so), (so_next))
465
466	/* dnsproxy/dnsproxy.c */
467	#define authoritative_port pData->authoritative_port
468	#define authoritative_timeout pData->authoritative_timeout
469	#define recursive_port pData->recursive_port
470	#define recursive_timeout pData->recursive_timeout
471	#define stats_timeout pData->stats_timeout
472	/* dnsproxy/hash.c */
473	#define dns_port pData->port
474	#define request_hash pData->request_hash
475	#define hash_collisions pData->hash_collisions
476	#define active_queries pData->active_queries
477	#define all_queries pData->all_queries
478	#define authoritative_queries pData->authoritative_queries
479	#define recursive_queries pData->recursive_queries
480	#define removed_queries pData->removed_queries
481	#define dropped_queries pData->dropped_queries
482	#define answered_queries pData->answered_queries
483	#define dropped_answers pData->dropped_answers
484	#define late_answers pData->late_answers
485
486	/* dnsproxy/dnsproxy.c */
487	#define queryid pData->queryid
488	#define authoritative_addr pData->authoritative_addr
489	#define recursive_addr pData->recursive_addr
490	#define sock_query pData->sock_query
491	#define sock_answer pData->sock_answer
492
493	#define instancehead pData->instancehead
494
495	#define nmbclusters pData->nmbclusters
496	#define nmbjumbop pData->nmbjumbop
497	#define nmbjumbo9 pData->nmbjumbo9
498	#define nmbjumbo16 pData->nmbjumbo16
499	#define mbstat pData->mbstat
500	#include "ext.h"
501	#undef zone_mbuf
502	#undef zone_clust
503	#undef zone_pack
504	#undef zone_jumbop
505	#undef zone_jumbo9
506	#undef zone_jumbo16
507	#undef zone_ext_refcnt
508	static inline uma_zone_t slirp_zone_pack(PNATState pData)
509	{
510	return pData->zone_pack;
511	}
512	static inline uma_zone_t slirp_zone_jumbop(PNATState pData)
513	{
514	return pData->zone_jumbop;
515	}
516	static inline uma_zone_t slirp_zone_jumbo9(PNATState pData)
517	{
518	return pData->zone_jumbo9;
519	}
520	static inline uma_zone_t slirp_zone_jumbo16(PNATState pData)
521	{
522	return pData->zone_jumbo16;
523	}
524	static inline uma_zone_t slirp_zone_ext_refcnt(PNATState pData)
525	{
526	return pData->zone_ext_refcnt;
527	}
528	static inline uma_zone_t slirp_zone_mbuf(PNATState pData)
529	{
530	return pData->zone_mbuf;
531	}
532	static inline uma_zone_t slirp_zone_clust(PNATState pData)
533	{
534	return pData->zone_clust;
535	}
536	#ifndef VBOX_SLIRP_BSD
537	# define m_adj(m, len) m_adj(pData, (m), (len))
538	#endif
539
540	#endif /* !___slirp_state_h */

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

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

Download in other formats: