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[14]; 45 }; 46 47 typedef int (*loop_func_t)(void *arg); 48 49 int ff_init(int argc, char * const argv[]); 50 51 void ff_run(loop_func_t loop, void *arg); 52 53 /* POSIX-LIKE api begin */ 54 55 int ff_fcntl(int fd, int cmd, ...); 56 57 int ff_sysctl(const int *name, u_int namelen, void *oldp, size_t *oldlenp, 58 const void *newp, size_t newlen); 59 60 int ff_ioctl(int fd, unsigned long request, ...); 61 62 int ff_socket(int domain, int type, int protocol); 63 64 int ff_setsockopt(int s, int level, int optname, const void *optval, 65 socklen_t optlen); 66 67 int ff_getsockopt(int s, int level, int optname, void *optval, 68 socklen_t *optlen); 69 70 int ff_socketpair(int domain, int type, int protocol, int *sv); 71 72 int ff_listen(int s, int backlog); 73 int ff_bind(int s, const struct linux_sockaddr *addr, socklen_t addrlen); 74 int ff_accept(int s, struct linux_sockaddr *addr, socklen_t *addrlen); 75 int ff_connect(int s, const struct linux_sockaddr *name, socklen_t namelen); 76 int ff_close(int fd); 77 int ff_shutdown(int s, int how); 78 79 int ff_getpeername(int s, struct linux_sockaddr *name, 80 socklen_t *namelen); 81 int ff_getsockname(int s, struct linux_sockaddr *name, 82 socklen_t *namelen); 83 84 ssize_t ff_read(int d, void *buf, size_t nbytes); 85 ssize_t ff_readv(int fd, const struct iovec *iov, int iovcnt); 86 87 ssize_t ff_write(int fd, const void *buf, size_t nbytes); 88 ssize_t ff_writev(int fd, const struct iovec *iov, int iovcnt); 89 90 ssize_t ff_send(int s, const void *buf, size_t len, int flags); 91 ssize_t ff_sendto(int s, const void *buf, size_t len, int flags, 92 const struct linux_sockaddr *to, socklen_t tolen); 93 ssize_t ff_sendmsg(int s, const struct msghdr *msg, int flags); 94 95 ssize_t ff_recv(int s, void *buf, size_t len, int flags); 96 ssize_t ff_recvfrom(int s, void *buf, size_t len, int flags, 97 struct linux_sockaddr *from, socklen_t *fromlen); 98 ssize_t ff_recvmsg(int s, struct msghdr *msg, int flags); 99 100 int ff_select(int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, 101 struct timeval *timeout); 102 103 int ff_poll(struct pollfd fds[], nfds_t nfds, int timeout); 104 105 int ff_kqueue(void); 106 int ff_kevent(int kq, const struct kevent *changelist, int nchanges, 107 struct kevent *eventlist, int nevents, const struct timespec *timeout); 108 int ff_kevent_do_each(int kq, const struct kevent *changelist, int nchanges, 109 void *eventlist, int nevents, const struct timespec *timeout, 110 void (*do_each)(void **, struct kevent *)); 111 112 int ff_gettimeofday(struct timeval *tv, struct timezone *tz); 113 114 /* POSIX-LIKE api end */ 115 116 117 /* Tests if fd is used by F-Stack */ 118 extern int ff_fdisused(int fd); 119 120 extern int ff_getmaxfd(void); 121 122 /* route api begin */ 123 enum FF_ROUTE_CTL { 124 FF_ROUTE_ADD, 125 FF_ROUTE_DEL, 126 FF_ROUTE_CHANGE, 127 }; 128 129 enum FF_ROUTE_FLAG { 130 FF_RTF_HOST, 131 FF_RTF_GATEWAY, 132 }; 133 134 /* 135 * On success, 0 is returned. 136 * On error, -1 is returned, and errno is set appropriately. 137 */ 138 int ff_route_ctl(enum FF_ROUTE_CTL req, enum FF_ROUTE_FLAG flag, 139 struct linux_sockaddr *dst, struct linux_sockaddr *gw, 140 struct linux_sockaddr *netmask); 141 142 /* route api end */ 143 144 145 /* dispatch api begin */ 146 147 /* 148 * Packet dispatch callback function. 149 * Implemented by user. 150 * 151 * @param data 152 * The data pointer of this packet. 153 * @param len 154 * The length of this packet. 155 * @param queue_id 156 * Current queue of this packet. 157 * @param nb_queues 158 * Number of queues to be dispatched. 159 * 160 * @return 0 to (nb_queues - 1) 161 * The queue id that the packet will be dispatched to. 162 * @return -1 163 * Error occurs or packet is handled by user, packet will be freed. 164 * 165 */ 166 typedef int (*dispatch_func_t)(void *data, uint16_t len, 167 uint16_t queue_id, uint16_t nb_queues); 168 169 /* regist a packet dispath function */ 170 void ff_regist_packet_dispatcher(dispatch_func_t func); 171 172 /* dispatch api end */ 173 174 175 /* internal api begin */ 176 177 /* 178 * Handle rtctl. 179 * The data is a pointer to struct rt_msghdr. 180 */ 181 int ff_rtioctl(int fib, void *data, unsigned *plen, unsigned maxlen); 182 183 /* 184 * Handle ngctl. 185 */ 186 enum FF_NGCTL_CMD { 187 NGCTL_SOCKET, 188 NGCTL_BIND, 189 NGCTL_CONNECT, 190 NGCTL_SEND, 191 NGCTL_RECV, 192 NGCTL_CLOSE, 193 }; 194 195 int ff_ngctl(int cmd, void *data); 196 197 /* internal api end */ 198 199 #ifdef __cplusplus 200 } 201 #endif 202 #endif 203 204