libslirp.h revision 1b097ed3dfab440934c002fd83612f6fb216f345
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync/* $Id$ */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync/** @file
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * NAT - slirp interface.
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync/*
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * Copyright (C) 2006-2010 Oracle Corporation
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync *
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * available from http://www.virtualbox.org. This file is free software;
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * you can redistribute it and/or modify it under the terms of the GNU
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * General Public License (GPL) as published by the Free Software
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#ifndef _LIBSLIRP_H
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#define _LIBSLIRP_H
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#ifdef RT_OS_WINDOWS
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# include <winsock2.h>
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# ifdef __cplusplus
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncextern "C" {
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# endif
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncint inet_aton(const char *cp, struct in_addr *ia);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# ifdef __cplusplus
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync}
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# endif
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#else
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# ifdef RT_OS_OS2 /* temporary workaround, see ticket #127 */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# include <sys/time.h>
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# endif
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# include <sys/select.h>
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# include <poll.h>
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# include <arpa/inet.h>
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#endif
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#include <VBox/types.h>
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#include <VBox/vmm/dbgf.h>
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsynctypedef struct NATState *PNATState;
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncstruct mbuf;
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#ifdef __cplusplus
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncextern "C" {
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#endif
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncint slirp_init(PNATState *, uint32_t, uint32_t, bool, bool, int, int, void *);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_register_statistics(PNATState pData, PPDMDRVINS pDrvIns);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_deregister_statistics(PNATState pData, PPDMDRVINS pDrvIns);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_term(PNATState);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_link_up(PNATState);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_link_down(PNATState);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#if defined(RT_OS_WINDOWS)
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_select_fill(PNATState pData, int *pndfs);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_select_poll(PNATState pData, int fTimeout, int fIcmp);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#else /* RT_OS_WINDOWS */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_select_fill(PNATState pData, int *pnfds, struct pollfd *polls);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_select_poll(PNATState pData, struct pollfd *polls, int ndfs);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#endif /* !RT_OS_WINDOWS */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_input(PNATState pData, struct mbuf *m, size_t cbBuf);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_set_ethaddr_and_activate_port_forwarding(PNATState pData, const uint8_t *ethaddr, uint32_t GuestIP);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync/* you must provide the following functions: */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_arm_fast_timer(void *pvUser);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncint slirp_can_output(void * pvUser);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_output(void * pvUser, struct mbuf *m, const uint8_t *pkt, int pkt_len);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_output_pending(void * pvUser);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_urg_output(void *pvUser, struct mbuf *, const uint8_t *pu8Buf, int cb);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_post_sent(PNATState pData, void *pvArg);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncint slirp_add_redirect(PNATState pData, int is_udp, struct in_addr host_addr,
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync int host_port, struct in_addr guest_addr,
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync int guest_port, const uint8_t *);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncint slirp_remove_redirect(PNATState pData, int is_udp, struct in_addr host_addr,
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync int host_port, struct in_addr guest_addr,
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync int guest_port);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncint slirp_add_exec(PNATState pData, int do_pty, const char *args, int addr_low_byte,
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync int guest_port);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_set_dhcp_TFTP_prefix(PNATState pData, const char *tftpPrefix);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_set_dhcp_TFTP_bootfile(PNATState pData, const char *bootFile);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_set_dhcp_next_server(PNATState pData, const char *nextServer);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_set_dhcp_dns_proxy(PNATState pData, bool fDNSProxy);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_set_rcvbuf(PNATState pData, int kilobytes);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_set_sndbuf(PNATState pData, int kilobytes);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_set_tcp_rcvspace(PNATState pData, int kilobytes);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_set_tcp_sndspace(PNATState pData, int kilobytes);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncint slirp_set_binding_address(PNATState, char *addr);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_set_mtu(PNATState, int);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_info(PNATState pData, PCDBGFINFOHLP pHlp, const char *pszArgs);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_set_somaxconn(PNATState pData, int iSoMaxConn);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#if defined(RT_OS_WINDOWS)
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync/*
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * ICMP handle state change
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# define VBOX_ICMP_EVENT_INDEX 0
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync/**
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * This event is for
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * - slirp_input
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * - slirp_link_up
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * - slirp_link_down
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * - wakeup
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# define VBOX_WAKEUP_EVENT_INDEX 1
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync/*
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * UDP/TCP socket state change (socket ready to receive, to send, ...)
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# define VBOX_SOCKET_EVENT_INDEX 2
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync/*
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * The number of events for WSAWaitForMultipleEvents().
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# define VBOX_EVENT_COUNT 3
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncHANDLE *slirp_get_events(PNATState pData);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_register_external_event(PNATState pData, HANDLE hEvent, int index);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#endif /* RT_OS_WINDOWS */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#ifdef VBOX_WITH_SLIRP_MT
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_process_queue(PNATState pData);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid *slirp_get_queue(PNATState pData);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#endif
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncstruct mbuf *slirp_ext_m_get(PNATState pData, size_t cbMin, void **ppvBuf, size_t *pcbBuf);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncvoid slirp_ext_m_free(PNATState pData, struct mbuf *, uint8_t *pu8Buf);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync/*
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * Returns the timeout.
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncunsigned int slirp_get_timeout_ms(PNATState pData);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# ifndef RT_OS_WINDOWS
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync/*
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync * Returns the number of sockets.
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync */
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncint slirp_get_nsock(PNATState pData);
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync# endif
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#ifdef __cplusplus
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync}
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#endif
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync#endif
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsync