error: Improve documentation
[qemu/kevin.git] / slirp / slirp.h
blobec0a4c24154fcdf703b76a946444203936b445f5
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"
138 #include "net/eth.h"
140 #include "libslirp.h"
141 #include "ip.h"
142 #include "tcp.h"
143 #include "tcp_timer.h"
144 #include "tcp_var.h"
145 #include "tcpip.h"
146 #include "udp.h"
147 #include "ip_icmp.h"
148 #include "mbuf.h"
149 #include "sbuf.h"
150 #include "socket.h"
151 #include "if.h"
152 #include "main.h"
153 #include "misc.h"
154 #ifdef USE_PPP
155 #include "ppp/pppd.h"
156 #include "ppp/ppp.h"
157 #endif
159 #include "bootp.h"
160 #include "tftp.h"
162 #define ARPOP_REQUEST 1 /* ARP request */
163 #define ARPOP_REPLY 2 /* ARP reply */
165 struct ethhdr {
166 unsigned char h_dest[ETH_ALEN]; /* destination eth addr */
167 unsigned char h_source[ETH_ALEN]; /* source ether addr */
168 unsigned short h_proto; /* packet type ID field */
171 struct arphdr {
172 unsigned short ar_hrd; /* format of hardware address */
173 unsigned short ar_pro; /* format of protocol address */
174 unsigned char ar_hln; /* length of hardware address */
175 unsigned char ar_pln; /* length of protocol address */
176 unsigned short ar_op; /* ARP opcode (command) */
179 * Ethernet looks like this : This bit is variable sized however...
181 unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
182 uint32_t ar_sip; /* sender IP address */
183 unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
184 uint32_t ar_tip; /* target IP address */
185 } QEMU_PACKED;
187 #define ARP_TABLE_SIZE 16
189 typedef struct ArpTable {
190 struct arphdr table[ARP_TABLE_SIZE];
191 int next_victim;
192 } ArpTable;
194 void arp_table_add(Slirp *slirp, uint32_t ip_addr, uint8_t ethaddr[ETH_ALEN]);
196 bool arp_table_search(Slirp *slirp, uint32_t ip_addr,
197 uint8_t out_ethaddr[ETH_ALEN]);
199 struct Slirp {
200 QTAILQ_ENTRY(Slirp) entry;
201 u_int time_fasttimo;
202 u_int last_slowtimo;
203 bool do_slowtimo;
205 /* virtual network configuration */
206 struct in_addr vnetwork_addr;
207 struct in_addr vnetwork_mask;
208 struct in_addr vhost_addr;
209 struct in_addr vdhcp_startaddr;
210 struct in_addr vnameserver_addr;
212 struct in_addr client_ipaddr;
213 char client_hostname[33];
215 int restricted;
216 struct ex_list *exec_list;
218 /* mbuf states */
219 struct mbuf m_freelist, m_usedlist;
220 int mbuf_alloced;
222 /* if states */
223 struct mbuf if_fastq; /* fast queue (for interactive data) */
224 struct mbuf if_batchq; /* queue for non-interactive data */
225 struct mbuf *next_m; /* pointer to next mbuf to output */
226 bool if_start_busy; /* avoid if_start recursion */
228 /* ip states */
229 struct ipq ipq; /* ip reass. queue */
230 uint16_t ip_id; /* ip packet ctr, for ids */
232 /* bootp/dhcp states */
233 BOOTPClient bootp_clients[NB_BOOTP_CLIENTS];
234 char *bootp_filename;
235 size_t vdnssearch_len;
236 uint8_t *vdnssearch;
238 /* tcp states */
239 struct socket tcb;
240 struct socket *tcp_last_so;
241 tcp_seq tcp_iss; /* tcp initial send seq # */
242 uint32_t tcp_now; /* for RFC 1323 timestamps */
244 /* udp states */
245 struct socket udb;
246 struct socket *udp_last_so;
248 /* icmp states */
249 struct socket icmp;
250 struct socket *icmp_last_so;
252 /* tftp states */
253 char *tftp_prefix;
254 struct tftp_session tftp_sessions[TFTP_SESSIONS_MAX];
256 ArpTable arp_table;
258 void *opaque;
261 extern Slirp *slirp_instance;
263 #ifndef NULL
264 #define NULL (void *)0
265 #endif
267 #ifndef FULL_BOLT
268 void if_start(Slirp *);
269 #else
270 void if_start(struct ttys *);
271 #endif
273 #ifndef HAVE_STRERROR
274 char *strerror(int error);
275 #endif
277 #ifndef HAVE_INDEX
278 char *index(const char *, int);
279 #endif
281 #ifndef HAVE_GETHOSTID
282 long gethostid(void);
283 #endif
285 #ifndef _WIN32
286 #include <netdb.h>
287 #endif
289 #define DEFAULT_BAUD 115200
291 #define SO_OPTIONS DO_KEEPALIVE
292 #define TCP_MAXIDLE (TCPTV_KEEPCNT * TCPTV_KEEPINTVL)
294 /* dnssearch.c */
295 int translate_dnssearch(Slirp *s, const char ** names);
297 /* cksum.c */
298 int cksum(struct mbuf *m, int len);
300 /* if.c */
301 void if_init(Slirp *);
302 void if_output(struct socket *, struct mbuf *);
304 /* ip_input.c */
305 void ip_init(Slirp *);
306 void ip_cleanup(Slirp *);
307 void ip_input(struct mbuf *);
308 void ip_slowtimo(Slirp *);
309 void ip_stripoptions(register struct mbuf *, struct mbuf *);
311 /* ip_output.c */
312 int ip_output(struct socket *, struct mbuf *);
314 /* tcp_input.c */
315 void tcp_input(register struct mbuf *, int, struct socket *);
316 int tcp_mss(register struct tcpcb *, u_int);
318 /* tcp_output.c */
319 int tcp_output(register struct tcpcb *);
320 void tcp_setpersist(register struct tcpcb *);
322 /* tcp_subr.c */
323 void tcp_init(Slirp *);
324 void tcp_cleanup(Slirp *);
325 void tcp_template(struct tcpcb *);
326 void tcp_respond(struct tcpcb *, register struct tcpiphdr *, register struct mbuf *, tcp_seq, tcp_seq, int);
327 struct tcpcb * tcp_newtcpcb(struct socket *);
328 struct tcpcb * tcp_close(register struct tcpcb *);
329 void tcp_sockclosed(struct tcpcb *);
330 int tcp_fconnect(struct socket *);
331 void tcp_connect(struct socket *);
332 int tcp_attach(struct socket *);
333 uint8_t tcp_tos(struct socket *);
334 int tcp_emu(struct socket *, struct mbuf *);
335 int tcp_ctl(struct socket *);
336 struct tcpcb *tcp_drop(struct tcpcb *tp, int err);
338 #ifdef USE_PPP
339 #define MIN_MRU MINMRU
340 #define MAX_MRU MAXMRU
341 #else
342 #define MIN_MRU 128
343 #define MAX_MRU 16384
344 #endif
346 #ifndef _WIN32
347 #define min(x,y) ((x) < (y) ? (x) : (y))
348 #define max(x,y) ((x) > (y) ? (x) : (y))
349 #endif
351 #ifdef _WIN32
352 #undef errno
353 #define errno (WSAGetLastError())
354 #endif
356 #endif