slirp/src/libslirp.h

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