/* * ZeroTier SDK - Network Virtualization Everywhere * Copyright (C) 2011-2018 ZeroTier, Inc. https://www.zerotier.com/ * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * * -- * * You can be released from the requirements of the license by purchasing * a commercial license. Buying such a license is mandatory as soon as you * develop commercial closed-source software that incorporates or links * directly against ZeroTier software without disclosing the source code * of your own application. */ #ifndef ZT_PICOTCP_HPP #define ZT_PICOTCP_HPP /* #include "pico_eth.h" #include "pico_stack.h" #include "pico_ipv4.h" #include "pico_icmp4.h" #include "pico_dev_tap.h" #include "pico_protocol.h" #include "pico_socket.h" #include "pico_device.h" #include "pico_ipv6.h" */ struct pico_socket; class VirtualSocket; class VirtualTap; #include "VirtualTap.h" /****************************************************************************/ /* PicoTCP API Signatures (See libzt.h for the application-facing API) */ /****************************************************************************/ #define PICO_IPV4_TO_STRING_SIG char *ipbuf, const uint32_t ip #define PICO_TAP_CREATE_SIG char *name #define PICO_IPV4_LINK_ADD_SIG struct pico_device *dev, struct pico_ip4 address, struct pico_ip4 netmask #define PICO_DEVICE_INIT_SIG struct pico_device *dev, const char *name, uint8_t *mac #define PICO_STACK_RECV_SIG struct pico_device *dev, uint8_t *buffer, uint32_t len #define PICO_ICMP4_PING_SIG char *dst, int count, int interval, int timeout, int size, void (*cb)(struct pico_icmp4_stats *) #define PICO_TIMER_ADD_SIG pico_time expire, void (*timer)(pico_time, void *), void *arg #define PICO_STRING_TO_IPV4_SIG const char *ipstr, uint32_t *ip #define PICO_STRING_TO_IPV6_SIG const char *ipstr, uint8_t *ip #define PICO_SOCKET_SETOPTION_SIG struct pico_socket *s, int option, void *value #define PICO_SOCKET_SEND_SIG struct pico_socket *s, const void *buf, int len #define PICO_SOCKET_SENDTO_SIG struct pico_socket *s, const void *buf, int len, void *dst, uint16_t remote_port #define PICO_SOCKET_RECV_SIG struct pico_socket *s, void *buf, int len #define PICO_SOCKET_RECVFROM_SIG struct pico_socket *s, void *buf, int len, void *orig, uint16_t *remote_port #define PICO_SOCKET_OPEN_SIG uint16_t net, uint16_t proto, void (*wakeup)(uint16_t ev, struct pico_socket *s) #define PICO_SOCKET_BIND_SIG struct pico_socket *s, void *local_addr, uint16_t *port #define PICO_SOCKET_CONNECT_SIG struct pico_socket *s, const void *srv_addr, uint16_t remote_port #define PICO_SOCKET_LISTEN_SIG struct pico_socket *s, const int backlog #define PICO_SOCKET_READ_SIG struct pico_socket *s, void *buf, int len #define PICO_SOCKET_WRITE_SIG struct pico_socket *s, const void *buf, int len #define PICO_SOCKET_CLOSE_SIG struct pico_socket *s #define PICO_SOCKET_SHUTDOWN_SIG struct pico_socket *s, int mode #define PICO_SOCKET_ACCEPT_SIG struct pico_socket *s, void *orig, uint16_t *port #define PICO_IPV6_LINK_ADD_SIG struct pico_device *dev, struct pico_ip6 address, struct pico_ip6 netmask #define PICO_IPV4_ROUTE_ADD_SIG struct pico_ip4 address, struct pico_ip4 netmask, struct pico_ip4 gateway, int metric, struct pico_ipv4_link *link #define PICO_IPV4_ROUTE_DEL_SIG struct pico_ip4 address, struct pico_ip4 netmask, int metric #define PICO_IPV6_ROUTE_ADD_SIG struct pico_ip6 address, struct pico_ip6 netmask, struct pico_ip6 gateway, int metric, struct pico_ipv6_link *link #define PICO_IPV6_ROUTE_DEL_SIG struct pico_ip6 address, struct pico_ip6 netmask, struct pico_ip6 gateway, int metric, struct pico_ipv6_link *link #define PICO_DNS_CLIENT_NAMESERVER_SIG pico_ip4*, unsigned char /** * Send raw frames from the stack to the ZeroTier virtual wire */ int rd_pico_eth_tx(struct pico_device *dev, void *buf, int len); /** * Read raw frames from RX frame buffer into the stack */ int rd_pico_eth_poll(struct pico_device *dev, int loop_score); /** * Set up an interface in the network stack for the VirtualTap */ bool pico_init_interface(VirtualTap *tap); /** * Register an address with the stack */ bool pico_register_address(VirtualTap *tap, const InetAddress &ip); /** * Adds a route to the picoTCP device */ bool rd_pico_route_add(VirtualTap *tap, const InetAddress &addr, const InetAddress &nm, const InetAddress &gw, int metric); /** * Deletes a route from the picoTCP device */ bool rd_pico_route_del(VirtualTap *tap, const InetAddress &addr, const InetAddress &nm, int metric); /** * Registers a DNS nameserver with the network stack */ int rd_pico_add_dns_nameserver(struct sockaddr *addr); /** * Un-registers a DNS nameserver from the network stack */ int rd_pico_del_dns_nameserver(struct sockaddr *addr); /** * Main stack loop */ void rd_pico_loop(VirtualTap *tap); /** * Read bytes from the stack to the RX buffer (prepare to be read by app) */ void rd_pico_cb_tcp_read(VirtualTap *tap, struct pico_socket *s); /** * Read bytes from the stack to the RX buffer (prepare to be read by app) */ void rd_pico_cb_udp_read(VirtualTap *tap, struct pico_socket *s); /** * Write bytes from TX buffer to stack (prepare to be sent to ZT virtual wire) */ void rd_pico_cb_tcp_write(VirtualTap *tap, struct pico_socket *s); /** * Write bytes from TX buffer to stack (prepare to be sent to ZT virtual wire) */ void rd_pico_cb_socket_ev(uint16_t ev, struct pico_socket *s); /** * Packets from the ZeroTier virtual wire enter the stack here */ void rd_pico_eth_rx(VirtualTap *tap, const ZeroTier::MAC &from, const ZeroTier::MAC &to, unsigned int etherType, const void *data, unsigned int len); /** * Creates a stack-specific "socket" or "VirtualSocket object" */ int rd_pico_socket(struct pico_socket **p, int socket_family, int socket_type, int protocol); /** * Connect to remote host via userspace network stack interface - Called from VirtualTap */ int rd_pico_connect(VirtualSocket *vs, const struct sockaddr *addr, socklen_t addrlen); /** * Bind to a userspace network stack interface - Called from VirtualTap */ int rd_pico_bind(VirtualSocket *vs, const struct sockaddr *addr, socklen_t addrlen); /** * Listen for incoming VirtualSockets - Called from VirtualTap */ int rd_pico_listen(VirtualSocket *vs, int backlog); /** * Accept an incoming VirtualSocket - Called from VirtualTap */ VirtualSocket* rd_pico_accept(VirtualSocket *vs); /** * Read from RX buffer to application - Called from VirtualTap */ int rd_pico_read(VirtualTap *tap, ZeroTier::PhySocket *sock, VirtualSocket *vs, bool stack_invoked); /** * Write to userspace network stack - Called from VirtualTap */ int rd_pico_write(VirtualSocket *vs, void *data, ssize_t len); /** * Close a VirtualSocket - Called from VirtualTap */ int rd_pico_close(VirtualSocket *vs); /** * Shuts down some aspect of a VirtualSocket - Called from VirtualTap */ int rd_pico_shutdown(VirtualSocket *vs, int how); /** * Sets a property of a socket */ int rd_pico_setsockopt(VirtualSocket *vs, int level, int optname, const void *optval, socklen_t optlen); /** * Gets a property of a socket */ int rd_pico_getsockopt(VirtualSocket *vs, int level, int optname, void *optval, socklen_t *optlen); /** * Converts a pico_err to its most closely-related errno, and sets errno */ int map_pico_err_to_errno(int err); /** * Converts picoTCP error codes to pretty string */ char *beautify_pico_error(int err); /** * Converts picoTCP socket states into pretty string */ char *beautify_pico_state(int state); #endif // _H