1 /* 2 * Copyright (C) 2017 THL A29 Limited, a Tencent company. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, this 9 * list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 17 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR 18 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 19 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 20 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 21 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 23 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 24 * 25 */ 26 27 #ifndef _FSTACK_API_H 28 #define _FSTACK_API_H 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 #include <sys/socket.h> 34 #include <sys/select.h> 35 #include <sys/poll.h> 36 #include <netinet/in.h> 37 #include <sys/time.h> 38 39 #include "ff_event.h" 40 #include "ff_errno.h" 41 42 struct linux_sockaddr { 43 short sa_family; 44 char sa_data[126]; 45 }; 46 47 #define AF_INET6_LINUX 10 48 #define PF_INET6_LINUX AF_INET6_LINUX 49 50 typedef int (*loop_func_t)(void *arg); 51 52 int ff_init(int argc, char * const argv[]); 53 54 void ff_run(loop_func_t loop, void *arg); 55 56 /* POSIX-LIKE api begin */ 57 58 int ff_fcntl(int fd, int cmd, ...); 59 60 int ff_sysctl(const int *name, u_int namelen, void *oldp, size_t *oldlenp, 61 const void *newp, size_t newlen); 62 63 int ff_ioctl(int fd, unsigned long request, ...); 64 65 int ff_socket(int domain, int type, int protocol); 66 67 int ff_setsockopt(int s, int level, int optname, const void *optval, 68 socklen_t optlen); 69 70 int ff_getsockopt(int s, int level, int optname, void *optval, 71 socklen_t *optlen); 72 73 int ff_listen(int s, int backlog); 74 int ff_bind(int s, const struct linux_sockaddr *addr, socklen_t addrlen); 75 int ff_accept(int s, struct linux_sockaddr *addr, socklen_t *addrlen); 76 int ff_connect(int s, const struct linux_sockaddr *name, socklen_t namelen); 77 int ff_close(int fd); 78 int ff_shutdown(int s, int how); 79 80 int ff_getpeername(int s, struct linux_sockaddr *name, 81 socklen_t *namelen); 82 int ff_getsockname(int s, struct linux_sockaddr *name, 83 socklen_t *namelen); 84 85 ssize_t ff_read(int d, void *buf, size_t nbytes); 86 ssize_t ff_readv(int fd, const struct iovec *iov, int iovcnt); 87 88 ssize_t ff_write(int fd, const void *buf, size_t nbytes); 89 ssize_t ff_writev(int fd, const struct iovec *iov, int iovcnt); 90 91 ssize_t ff_send(int s, const void *buf, size_t len, int flags); 92 ssize_t ff_sendto(int s, const void *buf, size_t len, int flags, 93 const struct linux_sockaddr *to, socklen_t tolen); 94 ssize_t ff_sendmsg(int s, const struct msghdr *msg, int flags); 95 96 ssize_t ff_recv(int s, void *buf, size_t len, int flags); 97 ssize_t ff_recvfrom(int s, void *buf, size_t len, int flags, 98 struct linux_sockaddr *from, socklen_t *fromlen); 99 ssize_t ff_recvmsg(int s, struct msghdr *msg, int flags); 100 101 int ff_select(int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, 102 struct timeval *timeout); 103 104 int ff_poll(struct pollfd fds[], nfds_t nfds, int timeout); 105 106 int ff_kqueue(void); 107 int ff_kevent(int kq, const struct kevent *changelist, int nchanges, 108 struct kevent *eventlist, int nevents, const struct timespec *timeout); 109 int ff_kevent_do_each(int kq, const struct kevent *changelist, int nchanges, 110 void *eventlist, int nevents, const struct timespec *timeout, 111 void (*do_each)(void **, struct kevent *)); 112 113 int ff_gettimeofday(struct timeval *tv, struct timezone *tz); 114 115 int ff_dup(int oldfd); 116 int ff_dup2(int oldfd, int newfd); 117 118 /* POSIX-LIKE api end */ 119 120 121 /* Tests if fd is used by F-Stack */ 122 extern int ff_fdisused(int fd); 123 124 extern int ff_getmaxfd(void); 125 126 /* route api begin */ 127 enum FF_ROUTE_CTL { 128 FF_ROUTE_ADD, 129 FF_ROUTE_DEL, 130 FF_ROUTE_CHANGE, 131 }; 132 133 enum FF_ROUTE_FLAG { 134 FF_RTF_HOST, 135 FF_RTF_GATEWAY, 136 }; 137 138 /* 139 * On success, 0 is returned. 140 * On error, -1 is returned, and errno is set appropriately. 141 */ 142 int ff_route_ctl(enum FF_ROUTE_CTL req, enum FF_ROUTE_FLAG flag, 143 struct linux_sockaddr *dst, struct linux_sockaddr *gw, 144 struct linux_sockaddr *netmask); 145 146 /* route api end */ 147 148 149 /* dispatch api begin */ 150 #define FF_DISPATCH_ERROR (-1) 151 #define FF_DISPATCH_RESPONSE (-2) 152 153 /* 154 * Packet dispatch callback function. 155 * Implemented by user. 156 * 157 * @param data 158 * The data pointer of this packet. 159 * @param len 160 * The length of this packet. 161 * @param queue_id 162 * Current queue of this packet. 163 * @param nb_queues 164 * Number of queues to be dispatched. 165 * 166 * @return 0 to (nb_queues - 1) 167 * The queue id that the packet will be dispatched to. 168 * @return FF_DISPATCH_ERROR (-1) 169 * Error occurs or packet is handled by user, packet will be freed. 170 * @return FF_DISPATCH_RESPONSE (-2) 171 * Packet is handled by user, packet will be responsed. 172 * 173 */ 174 typedef int (*dispatch_func_t)(void *data, uint16_t *len, 175 uint16_t queue_id, uint16_t nb_queues); 176 177 /* regist a packet dispath function */ 178 void ff_regist_packet_dispatcher(dispatch_func_t func); 179 180 /* dispatch api end */ 181 182 183 /* internal api begin */ 184 185 /* FreeBSD style calls. Used for tools. */ 186 int ff_ioctl_freebsd(int fd, unsigned long request, ...); 187 int ff_setsockopt_freebsd(int s, int level, int optname, 188 const void *optval, socklen_t optlen); 189 int ff_getsockopt_freebsd(int s, int level, int optname, 190 void *optval, socklen_t *optlen); 191 192 /* 193 * Handle rtctl. 194 * The data is a pointer to struct rt_msghdr. 195 */ 196 int ff_rtioctl(int fib, void *data, unsigned *plen, unsigned maxlen); 197 198 /* 199 * Handle ngctl. 200 */ 201 enum FF_NGCTL_CMD { 202 NGCTL_SOCKET, 203 NGCTL_BIND, 204 NGCTL_CONNECT, 205 NGCTL_SEND, 206 NGCTL_RECV, 207 NGCTL_CLOSE, 208 }; 209 210 int ff_ngctl(int cmd, void *data); 211 212 /* internal api end */ 213 214 #ifdef __cplusplus 215 } 216 #endif 217 #endif 218 219