help: Fix markup of heading "USB options" so it appears in -help
[qemu/pbrook.git] / slirp / slirp.h
blobfe0e65d0eee0bd1442caf2a8df3a67a8d6fd28b3
1 #ifndef __COMMON_H__
2 #define __COMMON_H__
4 #include "config-host.h"
5 #include "slirp_config.h"
7 #ifdef _WIN32
8 # include <inttypes.h>
10 typedef char *caddr_t;
12 # include <windows.h>
13 # include <winsock2.h>
14 # include <ws2tcpip.h>
15 # include <sys/timeb.h>
16 # include <iphlpapi.h>
18 #else
19 # define ioctlsocket ioctl
20 # define closesocket(s) close(s)
21 # if !defined(__HAIKU__)
22 # define O_BINARY 0
23 # endif
24 #endif
26 #include <sys/types.h>
27 #ifdef HAVE_SYS_BITYPES_H
28 # include <sys/bitypes.h>
29 #endif
31 #include <sys/time.h>
33 #ifdef HAVE_UNISTD_H
34 # include <unistd.h>
35 #endif
37 #ifdef HAVE_STDLIB_H
38 # include <stdlib.h>
39 #endif
41 #include <stdio.h>
42 #include <errno.h>
44 #ifndef HAVE_MEMMOVE
45 #define memmove(x, y, z) bcopy(y, x, z)
46 #endif
48 #if TIME_WITH_SYS_TIME
49 # include <sys/time.h>
50 # include <time.h>
51 #else
52 # ifdef HAVE_SYS_TIME_H
53 # include <sys/time.h>
54 # else
55 # include <time.h>
56 # endif
57 #endif
59 #ifdef HAVE_STRING_H
60 # include <string.h>
61 #else
62 # include <strings.h>
63 #endif
65 #ifndef _WIN32
66 #include <sys/uio.h>
67 #endif
69 #ifndef _WIN32
70 #include <netinet/in.h>
71 #include <arpa/inet.h>
72 #endif
74 /* Systems lacking strdup() definition in <string.h>. */
75 #if defined(ultrix)
76 char *strdup(const char *);
77 #endif
79 /* Systems lacking malloc() definition in <stdlib.h>. */
80 #if defined(ultrix) || defined(hcx)
81 void *malloc(size_t arg);
82 void free(void *ptr);
83 #endif
85 #include <fcntl.h>
86 #ifndef NO_UNIX_SOCKETS
87 #include <sys/un.h>
88 #endif
89 #include <signal.h>
90 #ifdef HAVE_SYS_SIGNAL_H
91 # include <sys/signal.h>
92 #endif
93 #ifndef _WIN32
94 #include <sys/socket.h>
95 #endif
97 #if defined(HAVE_SYS_IOCTL_H)
98 # include <sys/ioctl.h>
99 #endif
101 #ifdef HAVE_SYS_SELECT_H
102 # include <sys/select.h>
103 #endif
105 #ifdef HAVE_SYS_WAIT_H
106 # include <sys/wait.h>
107 #endif
109 #ifdef HAVE_SYS_FILIO_H
110 # include <sys/filio.h>
111 #endif
113 #ifdef USE_PPP
114 #include <ppp/slirppp.h>
115 #endif
117 #ifdef __STDC__
118 #include <stdarg.h>
119 #else
120 #include <varargs.h>
121 #endif
123 #include <sys/stat.h>
125 /* Avoid conflicting with the libc insque() and remque(), which
126 have different prototypes. */
127 #define insque slirp_insque
128 #define remque slirp_remque
130 #ifdef HAVE_SYS_STROPTS_H
131 #include <sys/stropts.h>
132 #endif
134 #include "debug.h"
136 #include "qemu/queue.h"
137 #include "qemu/sockets.h"
139 #include "libslirp.h"
140 #include "ip.h"
141 #include "tcp.h"
142 #include "tcp_timer.h"
143 #include "tcp_var.h"
144 #include "tcpip.h"
145 #include "udp.h"
146 #include "ip_icmp.h"
147 #include "mbuf.h"
148 #include "sbuf.h"
149 #include "socket.h"
150 #include "if.h"
151 #include "main.h"
152 #include "misc.h"
153 #ifdef USE_PPP
154 #include "ppp/pppd.h"
155 #include "ppp/ppp.h"
156 #endif
158 #include "bootp.h"
159 #include "tftp.h"
161 #define ETH_ALEN 6
162 #define ETH_HLEN 14
164 #define ETH_P_IP 0x0800 /* Internet Protocol packet */
165 #define ETH_P_ARP 0x0806 /* Address Resolution packet */
167 #define ARPOP_REQUEST 1 /* ARP request */
168 #define ARPOP_REPLY 2 /* ARP reply */
170 struct ethhdr {
171 unsigned char h_dest[ETH_ALEN]; /* destination eth addr */
172 unsigned char h_source[ETH_ALEN]; /* source ether addr */
173 unsigned short h_proto; /* packet type ID field */
176 struct arphdr {
177 unsigned short ar_hrd; /* format of hardware address */
178 unsigned short ar_pro; /* format of protocol address */
179 unsigned char ar_hln; /* length of hardware address */
180 unsigned char ar_pln; /* length of protocol address */
181 unsigned short ar_op; /* ARP opcode (command) */
184 * Ethernet looks like this : This bit is variable sized however...
186 unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
187 uint32_t ar_sip; /* sender IP address */
188 unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
189 uint32_t ar_tip; /* target IP address */
190 } QEMU_PACKED;
192 #define ARP_TABLE_SIZE 16
194 typedef struct ArpTable {
195 struct arphdr table[ARP_TABLE_SIZE];
196 int next_victim;
197 } ArpTable;
199 void arp_table_add(Slirp *slirp, uint32_t ip_addr, uint8_t ethaddr[ETH_ALEN]);
201 bool arp_table_search(Slirp *slirp, uint32_t ip_addr,
202 uint8_t out_ethaddr[ETH_ALEN]);
204 struct Slirp {
205 QTAILQ_ENTRY(Slirp) entry;
207 /* virtual network configuration */
208 struct in_addr vnetwork_addr;
209 struct in_addr vnetwork_mask;
210 struct in_addr vhost_addr;
211 struct in_addr vdhcp_startaddr;
212 struct in_addr vnameserver_addr;
214 struct in_addr client_ipaddr;
215 char client_hostname[33];
217 int restricted;
218 struct ex_list *exec_list;
220 /* mbuf states */
221 struct mbuf m_freelist, m_usedlist;
222 int mbuf_alloced;
224 /* if states */
225 struct mbuf if_fastq; /* fast queue (for interactive data) */
226 struct mbuf if_batchq; /* queue for non-interactive data */
227 struct mbuf *next_m; /* pointer to next mbuf to output */
228 bool if_start_busy; /* avoid if_start recursion */
230 /* ip states */
231 struct ipq ipq; /* ip reass. queue */
232 uint16_t ip_id; /* ip packet ctr, for ids */
234 /* bootp/dhcp states */
235 BOOTPClient bootp_clients[NB_BOOTP_CLIENTS];
236 char *bootp_filename;
237 size_t vdnssearch_len;
238 uint8_t *vdnssearch;
240 /* tcp states */
241 struct socket tcb;
242 struct socket *tcp_last_so;
243 tcp_seq tcp_iss; /* tcp initial send seq # */
244 uint32_t tcp_now; /* for RFC 1323 timestamps */
246 /* udp states */
247 struct socket udb;
248 struct socket *udp_last_so;
250 /* icmp states */
251 struct socket icmp;
252 struct socket *icmp_last_so;
254 /* tftp states */
255 char *tftp_prefix;
256 struct tftp_session tftp_sessions[TFTP_SESSIONS_MAX];
258 ArpTable arp_table;
260 void *opaque;
263 extern Slirp *slirp_instance;
265 #ifndef NULL
266 #define NULL (void *)0
267 #endif
269 #ifndef FULL_BOLT
270 void if_start(Slirp *);
271 #else
272 void if_start(struct ttys *);
273 #endif
275 #ifndef HAVE_STRERROR
276 char *strerror(int error);
277 #endif
279 #ifndef HAVE_INDEX
280 char *index(const char *, int);
281 #endif
283 #ifndef HAVE_GETHOSTID
284 long gethostid(void);
285 #endif
287 void lprint(const char *, ...) GCC_FMT_ATTR(1, 2);
289 #ifndef _WIN32
290 #include <netdb.h>
291 #endif
293 #define DEFAULT_BAUD 115200
295 #define SO_OPTIONS DO_KEEPALIVE
296 #define TCP_MAXIDLE (TCPTV_KEEPCNT * TCPTV_KEEPINTVL)
298 /* dnssearch.c */
299 int translate_dnssearch(Slirp *s, const char ** names);
301 /* cksum.c */
302 int cksum(struct mbuf *m, int len);
304 /* if.c */
305 void if_init(Slirp *);
306 void if_output(struct socket *, struct mbuf *);
308 /* ip_input.c */
309 void ip_init(Slirp *);
310 void ip_cleanup(Slirp *);
311 void ip_input(struct mbuf *);
312 void ip_slowtimo(Slirp *);
313 void ip_stripoptions(register struct mbuf *, struct mbuf *);
315 /* ip_output.c */
316 int ip_output(struct socket *, struct mbuf *);
318 /* tcp_input.c */
319 void tcp_input(register struct mbuf *, int, struct socket *);
320 int tcp_mss(register struct tcpcb *, u_int);
322 /* tcp_output.c */
323 int tcp_output(register struct tcpcb *);
324 void tcp_setpersist(register struct tcpcb *);
326 /* tcp_subr.c */
327 void tcp_init(Slirp *);
328 void tcp_cleanup(Slirp *);
329 void tcp_template(struct tcpcb *);
330 void tcp_respond(struct tcpcb *, register struct tcpiphdr *, register struct mbuf *, tcp_seq, tcp_seq, int);
331 struct tcpcb * tcp_newtcpcb(struct socket *);
332 struct tcpcb * tcp_close(register struct tcpcb *);
333 void tcp_sockclosed(struct tcpcb *);
334 int tcp_fconnect(struct socket *);
335 void tcp_connect(struct socket *);
336 int tcp_attach(struct socket *);
337 uint8_t tcp_tos(struct socket *);
338 int tcp_emu(struct socket *, struct mbuf *);
339 int tcp_ctl(struct socket *);
340 struct tcpcb *tcp_drop(struct tcpcb *tp, int err);
342 #ifdef USE_PPP
343 #define MIN_MRU MINMRU
344 #define MAX_MRU MAXMRU
345 #else
346 #define MIN_MRU 128
347 #define MAX_MRU 16384
348 #endif
350 #ifndef _WIN32
351 #define min(x,y) ((x) < (y) ? (x) : (y))
352 #define max(x,y) ((x) > (y) ? (x) : (y))
353 #endif
355 #ifdef _WIN32
356 #undef errno
357 #define errno (WSAGetLastError())
358 #endif
360 #endif