slirp/src/libslirp.h

   1 #ifndef LIBSLIRP_H
   2 #define LIBSLIRP_H
   3
   4 #include <stdint.h>
   5 #include <stdbool.h>
   6 #include <sys/types.h>
   7
   8 #ifdef _WIN32
   9 #include <winsock2.h>
  10 #include <in6addr.h>
  11 #else
  12 #include <netinet/in.h>
  13 #include <arpa/inet.h>
  14 #endif
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 typedef struct Slirp Slirp;
  21
  22 enum {
  23     SLIRP_POLL_IN  = 1 << 0,
  24     SLIRP_POLL_OUT = 1 << 1,
  25     SLIRP_POLL_PRI = 1 << 2,
  26     SLIRP_POLL_ERR = 1 << 3,
  27     SLIRP_POLL_HUP = 1 << 4,
  28 };
  29
  30 typedef ssize_t (*SlirpReadCb)(void *buf, size_t len, void *opaque);
  31 typedef ssize_t (*SlirpWriteCb)(const void *buf, size_t len, void *opaque);
  32 typedef void (*SlirpTimerCb)(void *opaque);
  33 typedef int (*SlirpAddPollCb)(int fd, int events, void *opaque);
  34 typedef int (*SlirpGetREventsCb)(int idx, void *opaque);
  35
  36 /*
  37  * Callbacks from slirp
  38  */
  39 typedef struct SlirpCb {
  40     /*
  41      * Send an ethernet frame to the guest network. The opaque
  42      * parameter is the one given to slirp_init(). The function
  43      * doesn't need to send all the data and may return <len (no
  44      * buffering is done on libslirp side, so the data will be dropped
  45      * in this case). <0 reports an IO error.
  46      */
  47     SlirpWriteCb send_packet;
  48     /* Print a message for an error due to guest misbehavior.  */
  49     void (*guest_error)(const char *msg, void *opaque);
  50     /* Return the virtual clock value in nanoseconds */
  51     int64_t (*clock_get_ns)(void *opaque);
  52     /* Create a new timer with the given callback and opaque data */
  53     void *(*timer_new)(SlirpTimerCb cb, void *cb_opaque, void *opaque);
  54     /* Remove and free a timer */
  55     void (*timer_free)(void *timer, void *opaque);
  56     /* Modify a timer to expire at @expire_time */
  57     void (*timer_mod)(void *timer, int64_t expire_time, void *opaque);
  58     /* Register a fd for future polling */
  59     void (*register_poll_fd)(int fd, void *opaque);
  60     /* Unregister a fd */
  61     void (*unregister_poll_fd)(int fd, void *opaque);
  62     /* Kick the io-thread, to signal that new events may be processed */
  63     void (*notify)(void *opaque);
  64 } SlirpCb;
  65
  66
  67 Slirp *slirp_init(int restricted, bool in_enabled, struct in_addr vnetwork,
  68                   struct in_addr vnetmask, struct in_addr vhost,
  69                   bool in6_enabled,
  70                   struct in6_addr vprefix_addr6, uint8_t vprefix_len,
  71                   struct in6_addr vhost6, const char *vhostname,
  72                   const char *tftp_server_name,
  73                   const char *tftp_path, const char *bootfile,
  74                   struct in_addr vdhcp_start, struct in_addr vnameserver,
  75                   struct in6_addr vnameserver6, const char **vdnssearch,
  76                   const char *vdomainname,
  77                   const SlirpCb *callbacks,
  78                   void *opaque);
  79 void slirp_cleanup(Slirp *slirp);
  80
  81 void slirp_pollfds_fill(Slirp *slirp, uint32_t *timeout,
  82                         SlirpAddPollCb add_poll, void *opaque);
  83
  84 void slirp_pollfds_poll(Slirp *slirp, int select_error,
  85                         SlirpGetREventsCb get_revents, void *opaque);
  86
  87 void slirp_input(Slirp *slirp, const uint8_t *pkt, int pkt_len);
  88
  89 int slirp_add_hostfwd(Slirp *slirp, int is_udp,
  90                       struct in_addr host_addr, int host_port,
  91                       struct in_addr guest_addr, int guest_port);
  92 int slirp_remove_hostfwd(Slirp *slirp, int is_udp,
  93                          struct in_addr host_addr, int host_port);
  94 int slirp_add_exec(Slirp *slirp, const char *cmdline,
  95                    struct in_addr *guest_addr, int guest_port);
  96 int slirp_add_guestfwd(Slirp *slirp, SlirpWriteCb write_cb, void *opaque,
  97                    struct in_addr *guest_addr, int guest_port);
  98
  99 char *slirp_connection_info(Slirp *slirp);
 100
 101 void slirp_socket_recv(Slirp *slirp, struct in_addr guest_addr,
 102                        int guest_port, const uint8_t *buf, int size);
 103 size_t slirp_socket_can_recv(Slirp *slirp, struct in_addr guest_addr,
 104                              int guest_port);
 105
 106 void slirp_state_save(Slirp *s, SlirpWriteCb write_cb, void *opaque);
 107
 108 int slirp_state_load(Slirp *s, int version_id,
 109                      SlirpReadCb read_cb, void *opaque);
 110
 111 int slirp_state_version(void);
 112
 113 #ifdef __cplusplus
 114 } /* extern "C" */
 115 #endif
 116
 117 #endif /* LIBSLIRP_H */