1b7579f77SDag-Erling Smørgrav /* 2b7579f77SDag-Erling Smørgrav * util/netevent.h - event notification 3b7579f77SDag-Erling Smørgrav * 4b7579f77SDag-Erling Smørgrav * Copyright (c) 2007, NLnet Labs. All rights reserved. 5b7579f77SDag-Erling Smørgrav * 6b7579f77SDag-Erling Smørgrav * This software is open source. 7b7579f77SDag-Erling Smørgrav * 8b7579f77SDag-Erling Smørgrav * Redistribution and use in source and binary forms, with or without 9b7579f77SDag-Erling Smørgrav * modification, are permitted provided that the following conditions 10b7579f77SDag-Erling Smørgrav * are met: 11b7579f77SDag-Erling Smørgrav * 12b7579f77SDag-Erling Smørgrav * Redistributions of source code must retain the above copyright notice, 13b7579f77SDag-Erling Smørgrav * this list of conditions and the following disclaimer. 14b7579f77SDag-Erling Smørgrav * 15b7579f77SDag-Erling Smørgrav * Redistributions in binary form must reproduce the above copyright notice, 16b7579f77SDag-Erling Smørgrav * this list of conditions and the following disclaimer in the documentation 17b7579f77SDag-Erling Smørgrav * and/or other materials provided with the distribution. 18b7579f77SDag-Erling Smørgrav * 19b7579f77SDag-Erling Smørgrav * Neither the name of the NLNET LABS nor the names of its contributors may 20b7579f77SDag-Erling Smørgrav * be used to endorse or promote products derived from this software without 21b7579f77SDag-Erling Smørgrav * specific prior written permission. 22b7579f77SDag-Erling Smørgrav * 23b7579f77SDag-Erling Smørgrav * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2417d15b25SDag-Erling Smørgrav * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2517d15b25SDag-Erling Smørgrav * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2617d15b25SDag-Erling Smørgrav * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2717d15b25SDag-Erling Smørgrav * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2817d15b25SDag-Erling Smørgrav * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 2917d15b25SDag-Erling Smørgrav * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 3017d15b25SDag-Erling Smørgrav * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 3117d15b25SDag-Erling Smørgrav * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 3217d15b25SDag-Erling Smørgrav * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3317d15b25SDag-Erling Smørgrav * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34b7579f77SDag-Erling Smørgrav */ 35b7579f77SDag-Erling Smørgrav 36b7579f77SDag-Erling Smørgrav /** 37b7579f77SDag-Erling Smørgrav * \file 38b7579f77SDag-Erling Smørgrav * 39b7579f77SDag-Erling Smørgrav * This file contains event notification functions. 40b7579f77SDag-Erling Smørgrav * 41b7579f77SDag-Erling Smørgrav * There are three types of communication points 42b7579f77SDag-Erling Smørgrav * o UDP socket - perthread buffer. 43b7579f77SDag-Erling Smørgrav * o TCP-accept socket - array of TCP-sockets, socketcount. 44b7579f77SDag-Erling Smørgrav * o TCP socket - own buffer, parent-TCPaccept, read/write state, 45b7579f77SDag-Erling Smørgrav * number of bytes read/written, timeout. 46b7579f77SDag-Erling Smørgrav * 47b7579f77SDag-Erling Smørgrav * There are sockets aimed towards our clients and towards the internet. 48b7579f77SDag-Erling Smørgrav * o frontside - aimed towards our clients, queries come in, answers back. 49b7579f77SDag-Erling Smørgrav * o behind - aimed towards internet, to the authoritative DNS servers. 50b7579f77SDag-Erling Smørgrav * 51b7579f77SDag-Erling Smørgrav * Several event types are available: 52b7579f77SDag-Erling Smørgrav * o comm_base - for thread safety of the comm points, one per thread. 53b7579f77SDag-Erling Smørgrav * o comm_point - udp and tcp networking, with callbacks. 54b7579f77SDag-Erling Smørgrav * o comm_timer - a timeout with callback. 55b7579f77SDag-Erling Smørgrav * o comm_signal - callbacks when signal is caught. 56b7579f77SDag-Erling Smørgrav * o comm_reply - holds reply info during networking callback. 57b7579f77SDag-Erling Smørgrav * 58b7579f77SDag-Erling Smørgrav */ 59b7579f77SDag-Erling Smørgrav 60b7579f77SDag-Erling Smørgrav #ifndef NET_EVENT_H 61b7579f77SDag-Erling Smørgrav #define NET_EVENT_H 62b7579f77SDag-Erling Smørgrav 6365b390aaSDag-Erling Smørgrav #include "dnscrypt/dnscrypt.h" 6465b390aaSDag-Erling Smørgrav 6517d15b25SDag-Erling Smørgrav struct sldns_buffer; 66b7579f77SDag-Erling Smørgrav struct comm_point; 67b7579f77SDag-Erling Smørgrav struct comm_reply; 68e2d15004SDag-Erling Smørgrav struct ub_event_base; 69b7579f77SDag-Erling Smørgrav 70b7579f77SDag-Erling Smørgrav /* internal event notification data storage structure. */ 71b7579f77SDag-Erling Smørgrav struct internal_event; 72b7579f77SDag-Erling Smørgrav struct internal_base; 73e2d15004SDag-Erling Smørgrav struct internal_timer; /* A sub struct of the comm_timer super struct */ 74b7579f77SDag-Erling Smørgrav 75b7579f77SDag-Erling Smørgrav /** callback from communication point function type */ 763005e0a3SDag-Erling Smørgrav typedef int comm_point_callback_type(struct comm_point*, void*, int, 77b7579f77SDag-Erling Smørgrav struct comm_reply*); 78b7579f77SDag-Erling Smørgrav 79b7579f77SDag-Erling Smørgrav /** to pass no_error to callback function */ 80b7579f77SDag-Erling Smørgrav #define NETEVENT_NOERROR 0 81b7579f77SDag-Erling Smørgrav /** to pass closed connection to callback function */ 82b7579f77SDag-Erling Smørgrav #define NETEVENT_CLOSED -1 83b7579f77SDag-Erling Smørgrav /** to pass timeout happened to callback function */ 84b7579f77SDag-Erling Smørgrav #define NETEVENT_TIMEOUT -2 85b7579f77SDag-Erling Smørgrav /** to pass fallback from capsforID to callback function; 0x20 failed */ 86b7579f77SDag-Erling Smørgrav #define NETEVENT_CAPSFAIL -3 87b7579f77SDag-Erling Smørgrav 88b7579f77SDag-Erling Smørgrav /** timeout to slow accept calls when not possible, in msec. */ 89b7579f77SDag-Erling Smørgrav #define NETEVENT_SLOW_ACCEPT_TIME 2000 90b7579f77SDag-Erling Smørgrav 91b7579f77SDag-Erling Smørgrav /** 92b7579f77SDag-Erling Smørgrav * A communication point dispatcher. Thread specific. 93b7579f77SDag-Erling Smørgrav */ 94b7579f77SDag-Erling Smørgrav struct comm_base { 95b7579f77SDag-Erling Smørgrav /** behind the scenes structure. with say libevent info. alloced */ 96b7579f77SDag-Erling Smørgrav struct internal_base* eb; 97b7579f77SDag-Erling Smørgrav /** callback to stop listening on accept sockets, 98b7579f77SDag-Erling Smørgrav * performed when accept() will not function properly */ 99b7579f77SDag-Erling Smørgrav void (*stop_accept)(void*); 100b7579f77SDag-Erling Smørgrav /** callback to start listening on accept sockets, performed 101b7579f77SDag-Erling Smørgrav * after stop_accept() then a timeout has passed. */ 102b7579f77SDag-Erling Smørgrav void (*start_accept)(void*); 103b7579f77SDag-Erling Smørgrav /** user argument for stop_accept and start_accept functions */ 104b7579f77SDag-Erling Smørgrav void* cb_arg; 105b7579f77SDag-Erling Smørgrav }; 106b7579f77SDag-Erling Smørgrav 107b7579f77SDag-Erling Smørgrav /** 108b7579f77SDag-Erling Smørgrav * Reply information for a communication point. 109b7579f77SDag-Erling Smørgrav */ 110b7579f77SDag-Erling Smørgrav struct comm_reply { 111b7579f77SDag-Erling Smørgrav /** the comm_point with fd to send reply on to. */ 112b7579f77SDag-Erling Smørgrav struct comm_point* c; 113b7579f77SDag-Erling Smørgrav /** the address (for UDP based communication) */ 114b7579f77SDag-Erling Smørgrav struct sockaddr_storage addr; 115b7579f77SDag-Erling Smørgrav /** length of address */ 116b7579f77SDag-Erling Smørgrav socklen_t addrlen; 117b7579f77SDag-Erling Smørgrav /** return type 0 (none), 4(IP4), 6(IP6) */ 118b7579f77SDag-Erling Smørgrav int srctype; 11965b390aaSDag-Erling Smørgrav /* DnsCrypt context */ 12065b390aaSDag-Erling Smørgrav #ifdef USE_DNSCRYPT 12165b390aaSDag-Erling Smørgrav uint8_t client_nonce[crypto_box_HALF_NONCEBYTES]; 12265b390aaSDag-Erling Smørgrav uint8_t nmkey[crypto_box_BEFORENMBYTES]; 123*c7f4d7adSDag-Erling Smørgrav const dnsccert *dnsc_cert; 12465b390aaSDag-Erling Smørgrav int is_dnscrypted; 12565b390aaSDag-Erling Smørgrav #endif 126b7579f77SDag-Erling Smørgrav /** the return source interface data */ 127b7579f77SDag-Erling Smørgrav union { 128b7579f77SDag-Erling Smørgrav #ifdef IPV6_PKTINFO 129b7579f77SDag-Erling Smørgrav struct in6_pktinfo v6info; 130b7579f77SDag-Erling Smørgrav #endif 131b7579f77SDag-Erling Smørgrav #ifdef IP_PKTINFO 132b7579f77SDag-Erling Smørgrav struct in_pktinfo v4info; 133b7579f77SDag-Erling Smørgrav #elif defined(IP_RECVDSTADDR) 134b7579f77SDag-Erling Smørgrav struct in_addr v4addr; 135b7579f77SDag-Erling Smørgrav #endif 136b7579f77SDag-Erling Smørgrav } 137b7579f77SDag-Erling Smørgrav /** variable with return source data */ 138b7579f77SDag-Erling Smørgrav pktinfo; 13965b390aaSDag-Erling Smørgrav /** max udp size for udp packets */ 14065b390aaSDag-Erling Smørgrav size_t max_udp_size; 141b7579f77SDag-Erling Smørgrav }; 142b7579f77SDag-Erling Smørgrav 143b7579f77SDag-Erling Smørgrav /** 144b7579f77SDag-Erling Smørgrav * Communication point to the network 145b7579f77SDag-Erling Smørgrav * These behaviours can be accomplished by setting the flags 146b7579f77SDag-Erling Smørgrav * and passing return values from the callback. 147b7579f77SDag-Erling Smørgrav * udp frontside: called after readdone. sendafter. 148b7579f77SDag-Erling Smørgrav * tcp frontside: called readdone, sendafter. close. 149b7579f77SDag-Erling Smørgrav * udp behind: called after readdone. No send after. 150b7579f77SDag-Erling Smørgrav * tcp behind: write done, read done, then called. No send after. 151b7579f77SDag-Erling Smørgrav */ 152b7579f77SDag-Erling Smørgrav struct comm_point { 153b7579f77SDag-Erling Smørgrav /** behind the scenes structure, with say libevent info. alloced. */ 154b7579f77SDag-Erling Smørgrav struct internal_event* ev; 155b7579f77SDag-Erling Smørgrav 156b7579f77SDag-Erling Smørgrav /** file descriptor for communication point */ 157b7579f77SDag-Erling Smørgrav int fd; 158b7579f77SDag-Erling Smørgrav 159b7579f77SDag-Erling Smørgrav /** timeout (NULL if it does not). Malloced. */ 160b7579f77SDag-Erling Smørgrav struct timeval* timeout; 161b7579f77SDag-Erling Smørgrav 162b7579f77SDag-Erling Smørgrav /** buffer pointer. Either to perthread, or own buffer or NULL */ 16317d15b25SDag-Erling Smørgrav struct sldns_buffer* buffer; 164b7579f77SDag-Erling Smørgrav 165b7579f77SDag-Erling Smørgrav /* -------- TCP Handler -------- */ 166b7579f77SDag-Erling Smørgrav /** Read/Write state for TCP */ 167b7579f77SDag-Erling Smørgrav int tcp_is_reading; 168b7579f77SDag-Erling Smørgrav /** The current read/write count for TCP */ 169b7579f77SDag-Erling Smørgrav size_t tcp_byte_count; 170b7579f77SDag-Erling Smørgrav /** parent communication point (for TCP sockets) */ 171b7579f77SDag-Erling Smørgrav struct comm_point* tcp_parent; 172b7579f77SDag-Erling Smørgrav /** sockaddr from peer, for TCP handlers */ 173b7579f77SDag-Erling Smørgrav struct comm_reply repinfo; 174b7579f77SDag-Erling Smørgrav 175b7579f77SDag-Erling Smørgrav /* -------- TCP Accept -------- */ 176b7579f77SDag-Erling Smørgrav /** the number of TCP handlers for this tcp-accept socket */ 177b7579f77SDag-Erling Smørgrav int max_tcp_count; 17809a3aaf3SDag-Erling Smørgrav /** current number of tcp handler in-use for this accept socket */ 17909a3aaf3SDag-Erling Smørgrav int cur_tcp_count; 180b7579f77SDag-Erling Smørgrav /** malloced array of tcp handlers for a tcp-accept, 181b7579f77SDag-Erling Smørgrav of size max_tcp_count. */ 182b7579f77SDag-Erling Smørgrav struct comm_point** tcp_handlers; 183b7579f77SDag-Erling Smørgrav /** linked list of free tcp_handlers to use for new queries. 184b7579f77SDag-Erling Smørgrav For tcp_accept the first entry, for tcp_handlers the next one. */ 185b7579f77SDag-Erling Smørgrav struct comm_point* tcp_free; 186b7579f77SDag-Erling Smørgrav 187b7579f77SDag-Erling Smørgrav /* -------- SSL TCP DNS ------- */ 188b7579f77SDag-Erling Smørgrav /** the SSL object with rw bio (owned) or for commaccept ctx ref */ 189b7579f77SDag-Erling Smørgrav void* ssl; 190b7579f77SDag-Erling Smørgrav /** handshake state for init and renegotiate */ 191b7579f77SDag-Erling Smørgrav enum { 192b7579f77SDag-Erling Smørgrav /** no handshake, it has been done */ 193b7579f77SDag-Erling Smørgrav comm_ssl_shake_none = 0, 194b7579f77SDag-Erling Smørgrav /** ssl initial handshake wants to read */ 195b7579f77SDag-Erling Smørgrav comm_ssl_shake_read, 196b7579f77SDag-Erling Smørgrav /** ssl initial handshake wants to write */ 197b7579f77SDag-Erling Smørgrav comm_ssl_shake_write, 198b7579f77SDag-Erling Smørgrav /** ssl_write wants to read */ 199b7579f77SDag-Erling Smørgrav comm_ssl_shake_hs_read, 200b7579f77SDag-Erling Smørgrav /** ssl_read wants to write */ 201b7579f77SDag-Erling Smørgrav comm_ssl_shake_hs_write 202b7579f77SDag-Erling Smørgrav } ssl_shake_state; 203b7579f77SDag-Erling Smørgrav 204ff825849SDag-Erling Smørgrav /* -------- dnstap ------- */ 205ff825849SDag-Erling Smørgrav /** the dnstap environment */ 206ff825849SDag-Erling Smørgrav struct dt_env* dtenv; 207ff825849SDag-Erling Smørgrav 208b7579f77SDag-Erling Smørgrav /** is this a UDP, TCP-accept or TCP socket. */ 209b7579f77SDag-Erling Smørgrav enum comm_point_type { 210b7579f77SDag-Erling Smørgrav /** UDP socket - handle datagrams. */ 211b7579f77SDag-Erling Smørgrav comm_udp, 212b7579f77SDag-Erling Smørgrav /** TCP accept socket - only creates handlers if readable. */ 213b7579f77SDag-Erling Smørgrav comm_tcp_accept, 214b7579f77SDag-Erling Smørgrav /** TCP handler socket - handle byteperbyte readwrite. */ 215b7579f77SDag-Erling Smørgrav comm_tcp, 216b7579f77SDag-Erling Smørgrav /** AF_UNIX socket - for internal commands. */ 217b7579f77SDag-Erling Smørgrav comm_local, 218b7579f77SDag-Erling Smørgrav /** raw - not DNS format - for pipe readers and writers */ 219b7579f77SDag-Erling Smørgrav comm_raw 220b7579f77SDag-Erling Smørgrav } 221b7579f77SDag-Erling Smørgrav /** variable with type of socket, UDP,TCP-accept,TCP,pipe */ 222b7579f77SDag-Erling Smørgrav type; 223b7579f77SDag-Erling Smørgrav 224b7579f77SDag-Erling Smørgrav /* ---------- Behaviour ----------- */ 225b7579f77SDag-Erling Smørgrav /** if set the connection is NOT closed on delete. */ 226b7579f77SDag-Erling Smørgrav int do_not_close; 227b7579f77SDag-Erling Smørgrav 228b7579f77SDag-Erling Smørgrav /** if set, the connection is closed on error, on timeout, 229b7579f77SDag-Erling Smørgrav and after read/write completes. No callback is done. */ 230b7579f77SDag-Erling Smørgrav int tcp_do_close; 231b7579f77SDag-Erling Smørgrav 232b7579f77SDag-Erling Smørgrav /** if set, read/write completes: 233b7579f77SDag-Erling Smørgrav read/write state of tcp is toggled. 234b7579f77SDag-Erling Smørgrav buffer reset/bytecount reset. 235b7579f77SDag-Erling Smørgrav this flag cleared. 236b7579f77SDag-Erling Smørgrav So that when that is done the callback is called. */ 237b7579f77SDag-Erling Smørgrav int tcp_do_toggle_rw; 238b7579f77SDag-Erling Smørgrav 239b5663de9SDag-Erling Smørgrav /** timeout in msec for TCP wait times for this connection */ 240b5663de9SDag-Erling Smørgrav int tcp_timeout_msec; 241b5663de9SDag-Erling Smørgrav 242b7579f77SDag-Erling Smørgrav /** if set, checks for pending error from nonblocking connect() call.*/ 243b7579f77SDag-Erling Smørgrav int tcp_check_nb_connect; 244b7579f77SDag-Erling Smørgrav 245b5663de9SDag-Erling Smørgrav #ifdef USE_MSG_FASTOPEN 246b5663de9SDag-Erling Smørgrav /** used to track if the sendto() call should be done when using TFO. */ 247b5663de9SDag-Erling Smørgrav int tcp_do_fastopen; 248b5663de9SDag-Erling Smørgrav #endif 249b5663de9SDag-Erling Smørgrav 25065b390aaSDag-Erling Smørgrav #ifdef USE_DNSCRYPT 25165b390aaSDag-Erling Smørgrav /** Is this a dnscrypt channel */ 25265b390aaSDag-Erling Smørgrav int dnscrypt; 25365b390aaSDag-Erling Smørgrav /** encrypted buffer pointer. Either to perthread, or own buffer or NULL */ 25465b390aaSDag-Erling Smørgrav struct sldns_buffer* dnscrypt_buffer; 25565b390aaSDag-Erling Smørgrav #endif 256b7579f77SDag-Erling Smørgrav /** number of queries outstanding on this socket, used by 257b7579f77SDag-Erling Smørgrav * outside network for udp ports */ 258b7579f77SDag-Erling Smørgrav int inuse; 259b7579f77SDag-Erling Smørgrav 260b7579f77SDag-Erling Smørgrav /** callback when done. 261b7579f77SDag-Erling Smørgrav tcp_accept does not get called back, is NULL then. 262b7579f77SDag-Erling Smørgrav If a timeout happens, callback with timeout=1 is called. 263b7579f77SDag-Erling Smørgrav If an error happens, callback is called with error set 264b7579f77SDag-Erling Smørgrav nonzero. If not NETEVENT_NOERROR, it is an errno value. 265b7579f77SDag-Erling Smørgrav If the connection is closed (by remote end) then the 266b7579f77SDag-Erling Smørgrav callback is called with error set to NETEVENT_CLOSED=-1. 267b7579f77SDag-Erling Smørgrav If a timeout happens on the connection, the error is set to 268b7579f77SDag-Erling Smørgrav NETEVENT_TIMEOUT=-2. 269b7579f77SDag-Erling Smørgrav The reply_info can be copied if the reply needs to happen at a 270b7579f77SDag-Erling Smørgrav later time. It consists of a struct with commpoint and address. 271b7579f77SDag-Erling Smørgrav It can be passed to a msg send routine some time later. 272b7579f77SDag-Erling Smørgrav Note the reply information is temporary and must be copied. 273b7579f77SDag-Erling Smørgrav NULL is passed for_reply info, in cases where error happened. 274b7579f77SDag-Erling Smørgrav 275b7579f77SDag-Erling Smørgrav declare as: 276b7579f77SDag-Erling Smørgrav int my_callback(struct comm_point* c, void* my_arg, int error, 277b7579f77SDag-Erling Smørgrav struct comm_reply *reply_info); 278b7579f77SDag-Erling Smørgrav 279b7579f77SDag-Erling Smørgrav if the routine returns 0, nothing is done. 280b7579f77SDag-Erling Smørgrav Notzero, the buffer will be sent back to client. 281b7579f77SDag-Erling Smørgrav For UDP this is done without changing the commpoint. 282b7579f77SDag-Erling Smørgrav In TCP it sets write state. 283b7579f77SDag-Erling Smørgrav */ 2843005e0a3SDag-Erling Smørgrav comm_point_callback_type* callback; 285b7579f77SDag-Erling Smørgrav /** argument to pass to callback. */ 286b7579f77SDag-Erling Smørgrav void *cb_arg; 287b7579f77SDag-Erling Smørgrav }; 288b7579f77SDag-Erling Smørgrav 289b7579f77SDag-Erling Smørgrav /** 290b7579f77SDag-Erling Smørgrav * Structure only for making timeout events. 291b7579f77SDag-Erling Smørgrav */ 292b7579f77SDag-Erling Smørgrav struct comm_timer { 293e2d15004SDag-Erling Smørgrav /** the internal event stuff (derived) */ 294b7579f77SDag-Erling Smørgrav struct internal_timer* ev_timer; 295b7579f77SDag-Erling Smørgrav 296b7579f77SDag-Erling Smørgrav /** callback function, takes user arg only */ 297b7579f77SDag-Erling Smørgrav void (*callback)(void*); 298b7579f77SDag-Erling Smørgrav 299b7579f77SDag-Erling Smørgrav /** callback user argument */ 300b7579f77SDag-Erling Smørgrav void* cb_arg; 301b7579f77SDag-Erling Smørgrav }; 302b7579f77SDag-Erling Smørgrav 303b7579f77SDag-Erling Smørgrav /** 304b7579f77SDag-Erling Smørgrav * Structure only for signal events. 305b7579f77SDag-Erling Smørgrav */ 306b7579f77SDag-Erling Smørgrav struct comm_signal { 307b7579f77SDag-Erling Smørgrav /** the communication base */ 308b7579f77SDag-Erling Smørgrav struct comm_base* base; 309b7579f77SDag-Erling Smørgrav 310b7579f77SDag-Erling Smørgrav /** the internal event stuff */ 311b7579f77SDag-Erling Smørgrav struct internal_signal* ev_signal; 312b7579f77SDag-Erling Smørgrav 313b7579f77SDag-Erling Smørgrav /** callback function, takes signal number and user arg */ 314b7579f77SDag-Erling Smørgrav void (*callback)(int, void*); 315b7579f77SDag-Erling Smørgrav 316b7579f77SDag-Erling Smørgrav /** callback user argument */ 317b7579f77SDag-Erling Smørgrav void* cb_arg; 318b7579f77SDag-Erling Smørgrav }; 319b7579f77SDag-Erling Smørgrav 320b7579f77SDag-Erling Smørgrav /** 321b7579f77SDag-Erling Smørgrav * Create a new comm base. 322b7579f77SDag-Erling Smørgrav * @param sigs: if true it attempts to create a default loop for 323b7579f77SDag-Erling Smørgrav * signal handling. 324b7579f77SDag-Erling Smørgrav * @return: the new comm base. NULL on error. 325b7579f77SDag-Erling Smørgrav */ 326b7579f77SDag-Erling Smørgrav struct comm_base* comm_base_create(int sigs); 327b7579f77SDag-Erling Smørgrav 328b7579f77SDag-Erling Smørgrav /** 329e2d15004SDag-Erling Smørgrav * Create comm base that uses the given ub_event_base (underlying pluggable 330e2d15004SDag-Erling Smørgrav * event mechanism pointer). 331e2d15004SDag-Erling Smørgrav * @param base: underlying pluggable event base. 33217d15b25SDag-Erling Smørgrav * @return: the new comm base. NULL on error. 33317d15b25SDag-Erling Smørgrav */ 334e2d15004SDag-Erling Smørgrav struct comm_base* comm_base_create_event(struct ub_event_base* base); 33517d15b25SDag-Erling Smørgrav 33617d15b25SDag-Erling Smørgrav /** 33717d15b25SDag-Erling Smørgrav * Delete comm base structure but not the underlying lib event base. 33817d15b25SDag-Erling Smørgrav * All comm points must have been deleted. 33917d15b25SDag-Erling Smørgrav * @param b: the base to delete. 34017d15b25SDag-Erling Smørgrav */ 34117d15b25SDag-Erling Smørgrav void comm_base_delete_no_base(struct comm_base* b); 34217d15b25SDag-Erling Smørgrav 34317d15b25SDag-Erling Smørgrav /** 344b7579f77SDag-Erling Smørgrav * Destroy a comm base. 345b7579f77SDag-Erling Smørgrav * All comm points must have been deleted. 346b7579f77SDag-Erling Smørgrav * @param b: the base to delete. 347b7579f77SDag-Erling Smørgrav */ 348b7579f77SDag-Erling Smørgrav void comm_base_delete(struct comm_base* b); 349b7579f77SDag-Erling Smørgrav 350b7579f77SDag-Erling Smørgrav /** 351b7579f77SDag-Erling Smørgrav * Obtain two pointers. The pointers never change (until base_delete()). 352b7579f77SDag-Erling Smørgrav * The pointers point to time values that are updated regularly. 353b7579f77SDag-Erling Smørgrav * @param b: the communication base that will update the time values. 354b7579f77SDag-Erling Smørgrav * @param tt: pointer to time in seconds is returned. 355b7579f77SDag-Erling Smørgrav * @param tv: pointer to time in microseconds is returned. 356b7579f77SDag-Erling Smørgrav */ 35717d15b25SDag-Erling Smørgrav void comm_base_timept(struct comm_base* b, time_t** tt, struct timeval** tv); 358b7579f77SDag-Erling Smørgrav 359b7579f77SDag-Erling Smørgrav /** 360b7579f77SDag-Erling Smørgrav * Dispatch the comm base events. 361b7579f77SDag-Erling Smørgrav * @param b: the communication to perform. 362b7579f77SDag-Erling Smørgrav */ 363b7579f77SDag-Erling Smørgrav void comm_base_dispatch(struct comm_base* b); 364b7579f77SDag-Erling Smørgrav 365b7579f77SDag-Erling Smørgrav /** 366b7579f77SDag-Erling Smørgrav * Exit from dispatch loop. 367b7579f77SDag-Erling Smørgrav * @param b: the communication base that is in dispatch(). 368b7579f77SDag-Erling Smørgrav */ 369b7579f77SDag-Erling Smørgrav void comm_base_exit(struct comm_base* b); 370b7579f77SDag-Erling Smørgrav 371b7579f77SDag-Erling Smørgrav /** 372b7579f77SDag-Erling Smørgrav * Set the slow_accept mode handlers. You can not provide these if you do 373b7579f77SDag-Erling Smørgrav * not perform accept() calls. 374b7579f77SDag-Erling Smørgrav * @param b: comm base 375b7579f77SDag-Erling Smørgrav * @param stop_accept: function that stops listening to accept fds. 376b7579f77SDag-Erling Smørgrav * @param start_accept: function that resumes listening to accept fds. 377b7579f77SDag-Erling Smørgrav * @param arg: callback arg to pass to the functions. 378b7579f77SDag-Erling Smørgrav */ 379b7579f77SDag-Erling Smørgrav void comm_base_set_slow_accept_handlers(struct comm_base* b, 380b7579f77SDag-Erling Smørgrav void (*stop_accept)(void*), void (*start_accept)(void*), void* arg); 381b7579f77SDag-Erling Smørgrav 382b7579f77SDag-Erling Smørgrav /** 383b7579f77SDag-Erling Smørgrav * Access internal data structure (for util/tube.c on windows) 384b7579f77SDag-Erling Smørgrav * @param b: comm base 385e2d15004SDag-Erling Smørgrav * @return ub_event_base. 386b7579f77SDag-Erling Smørgrav */ 387e2d15004SDag-Erling Smørgrav struct ub_event_base* comm_base_internal(struct comm_base* b); 388b7579f77SDag-Erling Smørgrav 389b7579f77SDag-Erling Smørgrav /** 390b7579f77SDag-Erling Smørgrav * Create an UDP comm point. Calls malloc. 391b7579f77SDag-Erling Smørgrav * setups the structure with the parameters you provide. 392b7579f77SDag-Erling Smørgrav * @param base: in which base to alloc the commpoint. 393b7579f77SDag-Erling Smørgrav * @param fd : file descriptor of open UDP socket. 394b7579f77SDag-Erling Smørgrav * @param buffer: shared buffer by UDP sockets from this thread. 395b7579f77SDag-Erling Smørgrav * @param callback: callback function pointer. 396b7579f77SDag-Erling Smørgrav * @param callback_arg: will be passed to your callback function. 397b7579f77SDag-Erling Smørgrav * @return: returns the allocated communication point. NULL on error. 398b7579f77SDag-Erling Smørgrav * Sets timeout to NULL. Turns off TCP options. 399b7579f77SDag-Erling Smørgrav */ 400b7579f77SDag-Erling Smørgrav struct comm_point* comm_point_create_udp(struct comm_base* base, 40117d15b25SDag-Erling Smørgrav int fd, struct sldns_buffer* buffer, 4023005e0a3SDag-Erling Smørgrav comm_point_callback_type* callback, void* callback_arg); 403b7579f77SDag-Erling Smørgrav 404b7579f77SDag-Erling Smørgrav /** 405b7579f77SDag-Erling Smørgrav * Create an UDP with ancillary data comm point. Calls malloc. 406b7579f77SDag-Erling Smørgrav * Uses recvmsg instead of recv to get udp message. 407b7579f77SDag-Erling Smørgrav * setups the structure with the parameters you provide. 408b7579f77SDag-Erling Smørgrav * @param base: in which base to alloc the commpoint. 409b7579f77SDag-Erling Smørgrav * @param fd : file descriptor of open UDP socket. 410b7579f77SDag-Erling Smørgrav * @param buffer: shared buffer by UDP sockets from this thread. 411b7579f77SDag-Erling Smørgrav * @param callback: callback function pointer. 412b7579f77SDag-Erling Smørgrav * @param callback_arg: will be passed to your callback function. 413b7579f77SDag-Erling Smørgrav * @return: returns the allocated communication point. NULL on error. 414b7579f77SDag-Erling Smørgrav * Sets timeout to NULL. Turns off TCP options. 415b7579f77SDag-Erling Smørgrav */ 416b7579f77SDag-Erling Smørgrav struct comm_point* comm_point_create_udp_ancil(struct comm_base* base, 41717d15b25SDag-Erling Smørgrav int fd, struct sldns_buffer* buffer, 4183005e0a3SDag-Erling Smørgrav comm_point_callback_type* callback, void* callback_arg); 419b7579f77SDag-Erling Smørgrav 420b7579f77SDag-Erling Smørgrav /** 421b7579f77SDag-Erling Smørgrav * Create a TCP listener comm point. Calls malloc. 422b7579f77SDag-Erling Smørgrav * Setups the structure with the parameters you provide. 423b7579f77SDag-Erling Smørgrav * Also Creates TCP Handlers, pre allocated for you. 424b7579f77SDag-Erling Smørgrav * Uses the parameters you provide. 425b7579f77SDag-Erling Smørgrav * @param base: in which base to alloc the commpoint. 426b7579f77SDag-Erling Smørgrav * @param fd: file descriptor of open TCP socket set to listen nonblocking. 427b7579f77SDag-Erling Smørgrav * @param num: becomes max_tcp_count, the routine allocates that 428b7579f77SDag-Erling Smørgrav * many tcp handler commpoints. 429b7579f77SDag-Erling Smørgrav * @param bufsize: size of buffer to create for handlers. 430b7579f77SDag-Erling Smørgrav * @param callback: callback function pointer for TCP handlers. 431b7579f77SDag-Erling Smørgrav * @param callback_arg: will be passed to your callback function. 432b7579f77SDag-Erling Smørgrav * @return: returns the TCP listener commpoint. You can find the 433b7579f77SDag-Erling Smørgrav * TCP handlers in the array inside the listener commpoint. 434b7579f77SDag-Erling Smørgrav * returns NULL on error. 435b7579f77SDag-Erling Smørgrav * Inits timeout to NULL. All handlers are on the free list. 436b7579f77SDag-Erling Smørgrav */ 437b7579f77SDag-Erling Smørgrav struct comm_point* comm_point_create_tcp(struct comm_base* base, 438b7579f77SDag-Erling Smørgrav int fd, int num, size_t bufsize, 4393005e0a3SDag-Erling Smørgrav comm_point_callback_type* callback, void* callback_arg); 440b7579f77SDag-Erling Smørgrav 441b7579f77SDag-Erling Smørgrav /** 442b7579f77SDag-Erling Smørgrav * Create an outgoing TCP commpoint. No file descriptor is opened, left at -1. 443b7579f77SDag-Erling Smørgrav * @param base: in which base to alloc the commpoint. 444b7579f77SDag-Erling Smørgrav * @param bufsize: size of buffer to create for handlers. 445b7579f77SDag-Erling Smørgrav * @param callback: callback function pointer for the handler. 446b7579f77SDag-Erling Smørgrav * @param callback_arg: will be passed to your callback function. 447b7579f77SDag-Erling Smørgrav * @return: the commpoint or NULL on error. 448b7579f77SDag-Erling Smørgrav */ 449b7579f77SDag-Erling Smørgrav struct comm_point* comm_point_create_tcp_out(struct comm_base* base, 4503005e0a3SDag-Erling Smørgrav size_t bufsize, comm_point_callback_type* callback, void* callback_arg); 451b7579f77SDag-Erling Smørgrav 452b7579f77SDag-Erling Smørgrav /** 453b7579f77SDag-Erling Smørgrav * Create commpoint to listen to a local domain file descriptor. 454b7579f77SDag-Erling Smørgrav * @param base: in which base to alloc the commpoint. 455b7579f77SDag-Erling Smørgrav * @param fd: file descriptor of open AF_UNIX socket set to listen nonblocking. 456b7579f77SDag-Erling Smørgrav * @param bufsize: size of buffer to create for handlers. 457b7579f77SDag-Erling Smørgrav * @param callback: callback function pointer for the handler. 458b7579f77SDag-Erling Smørgrav * @param callback_arg: will be passed to your callback function. 459b7579f77SDag-Erling Smørgrav * @return: the commpoint or NULL on error. 460b7579f77SDag-Erling Smørgrav */ 461b7579f77SDag-Erling Smørgrav struct comm_point* comm_point_create_local(struct comm_base* base, 462b7579f77SDag-Erling Smørgrav int fd, size_t bufsize, 4633005e0a3SDag-Erling Smørgrav comm_point_callback_type* callback, void* callback_arg); 464b7579f77SDag-Erling Smørgrav 465b7579f77SDag-Erling Smørgrav /** 466b7579f77SDag-Erling Smørgrav * Create commpoint to listen to a local domain pipe descriptor. 467b7579f77SDag-Erling Smørgrav * @param base: in which base to alloc the commpoint. 468b7579f77SDag-Erling Smørgrav * @param fd: file descriptor. 469b7579f77SDag-Erling Smørgrav * @param writing: true if you want to listen to writes, false for reads. 470b7579f77SDag-Erling Smørgrav * @param callback: callback function pointer for the handler. 471b7579f77SDag-Erling Smørgrav * @param callback_arg: will be passed to your callback function. 472b7579f77SDag-Erling Smørgrav * @return: the commpoint or NULL on error. 473b7579f77SDag-Erling Smørgrav */ 474b7579f77SDag-Erling Smørgrav struct comm_point* comm_point_create_raw(struct comm_base* base, 475b7579f77SDag-Erling Smørgrav int fd, int writing, 4763005e0a3SDag-Erling Smørgrav comm_point_callback_type* callback, void* callback_arg); 477b7579f77SDag-Erling Smørgrav 478b7579f77SDag-Erling Smørgrav /** 479b7579f77SDag-Erling Smørgrav * Close a comm point fd. 480b7579f77SDag-Erling Smørgrav * @param c: comm point to close. 481b7579f77SDag-Erling Smørgrav */ 482b7579f77SDag-Erling Smørgrav void comm_point_close(struct comm_point* c); 483b7579f77SDag-Erling Smørgrav 484b7579f77SDag-Erling Smørgrav /** 485b7579f77SDag-Erling Smørgrav * Close and deallocate (free) the comm point. If the comm point is 486b7579f77SDag-Erling Smørgrav * a tcp-accept point, also its tcp-handler points are deleted. 487b7579f77SDag-Erling Smørgrav * @param c: comm point to delete. 488b7579f77SDag-Erling Smørgrav */ 489b7579f77SDag-Erling Smørgrav void comm_point_delete(struct comm_point* c); 490b7579f77SDag-Erling Smørgrav 491b7579f77SDag-Erling Smørgrav /** 492b7579f77SDag-Erling Smørgrav * Send reply. Put message into commpoint buffer. 493b7579f77SDag-Erling Smørgrav * @param repinfo: The reply info copied from a commpoint callback call. 494b7579f77SDag-Erling Smørgrav */ 495b7579f77SDag-Erling Smørgrav void comm_point_send_reply(struct comm_reply* repinfo); 496b7579f77SDag-Erling Smørgrav 497b7579f77SDag-Erling Smørgrav /** 498b7579f77SDag-Erling Smørgrav * Drop reply. Cleans up. 499b7579f77SDag-Erling Smørgrav * @param repinfo: The reply info copied from a commpoint callback call. 500b7579f77SDag-Erling Smørgrav */ 501b7579f77SDag-Erling Smørgrav void comm_point_drop_reply(struct comm_reply* repinfo); 502b7579f77SDag-Erling Smørgrav 503b7579f77SDag-Erling Smørgrav /** 504b7579f77SDag-Erling Smørgrav * Send an udp message over a commpoint. 505b7579f77SDag-Erling Smørgrav * @param c: commpoint to send it from. 506b7579f77SDag-Erling Smørgrav * @param packet: what to send. 507b7579f77SDag-Erling Smørgrav * @param addr: where to send it to. 508b7579f77SDag-Erling Smørgrav * @param addrlen: length of addr. 509b7579f77SDag-Erling Smørgrav * @return: false on a failure. 510b7579f77SDag-Erling Smørgrav */ 51117d15b25SDag-Erling Smørgrav int comm_point_send_udp_msg(struct comm_point* c, struct sldns_buffer* packet, 512b7579f77SDag-Erling Smørgrav struct sockaddr* addr, socklen_t addrlen); 513b7579f77SDag-Erling Smørgrav 514b7579f77SDag-Erling Smørgrav /** 515b7579f77SDag-Erling Smørgrav * Stop listening for input on the commpoint. No callbacks will happen. 516b7579f77SDag-Erling Smørgrav * @param c: commpoint to disable. The fd is not closed. 517b7579f77SDag-Erling Smørgrav */ 518b7579f77SDag-Erling Smørgrav void comm_point_stop_listening(struct comm_point* c); 519b7579f77SDag-Erling Smørgrav 520b7579f77SDag-Erling Smørgrav /** 521b7579f77SDag-Erling Smørgrav * Start listening again for input on the comm point. 522b7579f77SDag-Erling Smørgrav * @param c: commpoint to enable again. 523b7579f77SDag-Erling Smørgrav * @param newfd: new fd, or -1 to leave fd be. 524b5663de9SDag-Erling Smørgrav * @param msec: timeout in milliseconds, or -1 for no (change to the) timeout. 525b5663de9SDag-Erling Smørgrav * So seconds*1000. 526b7579f77SDag-Erling Smørgrav */ 527b5663de9SDag-Erling Smørgrav void comm_point_start_listening(struct comm_point* c, int newfd, int msec); 528b7579f77SDag-Erling Smørgrav 529b7579f77SDag-Erling Smørgrav /** 530b7579f77SDag-Erling Smørgrav * Stop listening and start listening again for reading or writing. 531b7579f77SDag-Erling Smørgrav * @param c: commpoint 532b7579f77SDag-Erling Smørgrav * @param rd: if true, listens for reading. 533b7579f77SDag-Erling Smørgrav * @param wr: if true, listens for writing. 534b7579f77SDag-Erling Smørgrav */ 535b7579f77SDag-Erling Smørgrav void comm_point_listen_for_rw(struct comm_point* c, int rd, int wr); 536b7579f77SDag-Erling Smørgrav 537b7579f77SDag-Erling Smørgrav /** 538b7579f77SDag-Erling Smørgrav * Get size of memory used by comm point. 539b7579f77SDag-Erling Smørgrav * For TCP handlers this includes subhandlers. 540b7579f77SDag-Erling Smørgrav * For UDP handlers, this does not include the (shared) UDP buffer. 541b7579f77SDag-Erling Smørgrav * @param c: commpoint. 542b7579f77SDag-Erling Smørgrav * @return size in bytes. 543b7579f77SDag-Erling Smørgrav */ 544b7579f77SDag-Erling Smørgrav size_t comm_point_get_mem(struct comm_point* c); 545b7579f77SDag-Erling Smørgrav 546b7579f77SDag-Erling Smørgrav /** 547b7579f77SDag-Erling Smørgrav * create timer. Not active upon creation. 548b7579f77SDag-Erling Smørgrav * @param base: event handling base. 549b7579f77SDag-Erling Smørgrav * @param cb: callback function: void myfunc(void* myarg); 550b7579f77SDag-Erling Smørgrav * @param cb_arg: user callback argument. 551b7579f77SDag-Erling Smørgrav * @return: the new timer or NULL on error. 552b7579f77SDag-Erling Smørgrav */ 553b7579f77SDag-Erling Smørgrav struct comm_timer* comm_timer_create(struct comm_base* base, 554b7579f77SDag-Erling Smørgrav void (*cb)(void*), void* cb_arg); 555b7579f77SDag-Erling Smørgrav 556b7579f77SDag-Erling Smørgrav /** 557b7579f77SDag-Erling Smørgrav * disable timer. Stops callbacks from happening. 558b7579f77SDag-Erling Smørgrav * @param timer: to disable. 559b7579f77SDag-Erling Smørgrav */ 560b7579f77SDag-Erling Smørgrav void comm_timer_disable(struct comm_timer* timer); 561b7579f77SDag-Erling Smørgrav 562b7579f77SDag-Erling Smørgrav /** 563b7579f77SDag-Erling Smørgrav * reset timevalue for timer. 564b7579f77SDag-Erling Smørgrav * @param timer: timer to (re)set. 565b7579f77SDag-Erling Smørgrav * @param tv: when the timer should activate. if NULL timer is disabled. 566b7579f77SDag-Erling Smørgrav */ 567b7579f77SDag-Erling Smørgrav void comm_timer_set(struct comm_timer* timer, struct timeval* tv); 568b7579f77SDag-Erling Smørgrav 569b7579f77SDag-Erling Smørgrav /** 570b7579f77SDag-Erling Smørgrav * delete timer. 571b7579f77SDag-Erling Smørgrav * @param timer: to delete. 572b7579f77SDag-Erling Smørgrav */ 573b7579f77SDag-Erling Smørgrav void comm_timer_delete(struct comm_timer* timer); 574b7579f77SDag-Erling Smørgrav 575b7579f77SDag-Erling Smørgrav /** 576b7579f77SDag-Erling Smørgrav * see if timeout has been set to a value. 577b7579f77SDag-Erling Smørgrav * @param timer: the timer to examine. 578b7579f77SDag-Erling Smørgrav * @return: false if disabled or not set. 579b7579f77SDag-Erling Smørgrav */ 580b7579f77SDag-Erling Smørgrav int comm_timer_is_set(struct comm_timer* timer); 581b7579f77SDag-Erling Smørgrav 582b7579f77SDag-Erling Smørgrav /** 583b7579f77SDag-Erling Smørgrav * Get size of memory used by comm timer. 584b7579f77SDag-Erling Smørgrav * @param timer: the timer to examine. 585b7579f77SDag-Erling Smørgrav * @return size in bytes. 586b7579f77SDag-Erling Smørgrav */ 587b7579f77SDag-Erling Smørgrav size_t comm_timer_get_mem(struct comm_timer* timer); 588b7579f77SDag-Erling Smørgrav 589b7579f77SDag-Erling Smørgrav /** 590b7579f77SDag-Erling Smørgrav * Create a signal handler. Call signal_bind() later to bind to a signal. 591b7579f77SDag-Erling Smørgrav * @param base: communication base to use. 592b7579f77SDag-Erling Smørgrav * @param callback: called when signal is caught. 593b7579f77SDag-Erling Smørgrav * @param cb_arg: user argument to callback 594b7579f77SDag-Erling Smørgrav * @return: the signal struct or NULL on error. 595b7579f77SDag-Erling Smørgrav */ 596b7579f77SDag-Erling Smørgrav struct comm_signal* comm_signal_create(struct comm_base* base, 597b7579f77SDag-Erling Smørgrav void (*callback)(int, void*), void* cb_arg); 598b7579f77SDag-Erling Smørgrav 599b7579f77SDag-Erling Smørgrav /** 600b7579f77SDag-Erling Smørgrav * Bind signal struct to catch a signal. A signle comm_signal can be bound 601b7579f77SDag-Erling Smørgrav * to multiple signals, calling comm_signal_bind multiple times. 602b7579f77SDag-Erling Smørgrav * @param comsig: the communication point, with callback information. 603b7579f77SDag-Erling Smørgrav * @param sig: signal number. 604b7579f77SDag-Erling Smørgrav * @return: true on success. false on error. 605b7579f77SDag-Erling Smørgrav */ 606b7579f77SDag-Erling Smørgrav int comm_signal_bind(struct comm_signal* comsig, int sig); 607b7579f77SDag-Erling Smørgrav 608b7579f77SDag-Erling Smørgrav /** 609b7579f77SDag-Erling Smørgrav * Delete the signal communication point. 610b7579f77SDag-Erling Smørgrav * @param comsig: to delete. 611b7579f77SDag-Erling Smørgrav */ 612b7579f77SDag-Erling Smørgrav void comm_signal_delete(struct comm_signal* comsig); 613b7579f77SDag-Erling Smørgrav 614b7579f77SDag-Erling Smørgrav /** 615b7579f77SDag-Erling Smørgrav * perform accept(2) with error checking. 616b7579f77SDag-Erling Smørgrav * @param c: commpoint with accept fd. 617b7579f77SDag-Erling Smørgrav * @param addr: remote end returned here. 618b7579f77SDag-Erling Smørgrav * @param addrlen: length of remote end returned here. 619b7579f77SDag-Erling Smørgrav * @return new fd, or -1 on error. 620b7579f77SDag-Erling Smørgrav * if -1, error message has been printed if necessary, simply drop 621b7579f77SDag-Erling Smørgrav * out of the reading handler. 622b7579f77SDag-Erling Smørgrav */ 623b7579f77SDag-Erling Smørgrav int comm_point_perform_accept(struct comm_point* c, 624b7579f77SDag-Erling Smørgrav struct sockaddr_storage* addr, socklen_t* addrlen); 625b7579f77SDag-Erling Smørgrav 626b7579f77SDag-Erling Smørgrav /**** internal routines ****/ 627b7579f77SDag-Erling Smørgrav 628b7579f77SDag-Erling Smørgrav /** 629b7579f77SDag-Erling Smørgrav * This routine is published for checks and tests, and is only used internally. 630b7579f77SDag-Erling Smørgrav * handle libevent callback for udp comm point. 631b7579f77SDag-Erling Smørgrav * @param fd: file descriptor. 632b7579f77SDag-Erling Smørgrav * @param event: event bits from libevent: 633b7579f77SDag-Erling Smørgrav * EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT. 634b7579f77SDag-Erling Smørgrav * @param arg: the comm_point structure. 635b7579f77SDag-Erling Smørgrav */ 636b7579f77SDag-Erling Smørgrav void comm_point_udp_callback(int fd, short event, void* arg); 637b7579f77SDag-Erling Smørgrav 638b7579f77SDag-Erling Smørgrav /** 639b7579f77SDag-Erling Smørgrav * This routine is published for checks and tests, and is only used internally. 640b7579f77SDag-Erling Smørgrav * handle libevent callback for udp ancillary data comm point. 641b7579f77SDag-Erling Smørgrav * @param fd: file descriptor. 642b7579f77SDag-Erling Smørgrav * @param event: event bits from libevent: 643b7579f77SDag-Erling Smørgrav * EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT. 644b7579f77SDag-Erling Smørgrav * @param arg: the comm_point structure. 645b7579f77SDag-Erling Smørgrav */ 646b7579f77SDag-Erling Smørgrav void comm_point_udp_ancil_callback(int fd, short event, void* arg); 647b7579f77SDag-Erling Smørgrav 648b7579f77SDag-Erling Smørgrav /** 649b7579f77SDag-Erling Smørgrav * This routine is published for checks and tests, and is only used internally. 650b7579f77SDag-Erling Smørgrav * handle libevent callback for tcp accept comm point 651b7579f77SDag-Erling Smørgrav * @param fd: file descriptor. 652b7579f77SDag-Erling Smørgrav * @param event: event bits from libevent: 653b7579f77SDag-Erling Smørgrav * EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT. 654b7579f77SDag-Erling Smørgrav * @param arg: the comm_point structure. 655b7579f77SDag-Erling Smørgrav */ 656b7579f77SDag-Erling Smørgrav void comm_point_tcp_accept_callback(int fd, short event, void* arg); 657b7579f77SDag-Erling Smørgrav 658b7579f77SDag-Erling Smørgrav /** 659b7579f77SDag-Erling Smørgrav * This routine is published for checks and tests, and is only used internally. 660b7579f77SDag-Erling Smørgrav * handle libevent callback for tcp data comm point 661b7579f77SDag-Erling Smørgrav * @param fd: file descriptor. 662b7579f77SDag-Erling Smørgrav * @param event: event bits from libevent: 663b7579f77SDag-Erling Smørgrav * EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT. 664b7579f77SDag-Erling Smørgrav * @param arg: the comm_point structure. 665b7579f77SDag-Erling Smørgrav */ 666b7579f77SDag-Erling Smørgrav void comm_point_tcp_handle_callback(int fd, short event, void* arg); 667b7579f77SDag-Erling Smørgrav 668b7579f77SDag-Erling Smørgrav /** 669b7579f77SDag-Erling Smørgrav * This routine is published for checks and tests, and is only used internally. 670b7579f77SDag-Erling Smørgrav * handle libevent callback for timer comm. 671b7579f77SDag-Erling Smørgrav * @param fd: file descriptor (always -1). 672b7579f77SDag-Erling Smørgrav * @param event: event bits from libevent: 673b7579f77SDag-Erling Smørgrav * EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT. 674b7579f77SDag-Erling Smørgrav * @param arg: the comm_timer structure. 675b7579f77SDag-Erling Smørgrav */ 676b7579f77SDag-Erling Smørgrav void comm_timer_callback(int fd, short event, void* arg); 677b7579f77SDag-Erling Smørgrav 678b7579f77SDag-Erling Smørgrav /** 679b7579f77SDag-Erling Smørgrav * This routine is published for checks and tests, and is only used internally. 680b7579f77SDag-Erling Smørgrav * handle libevent callback for signal comm. 681b7579f77SDag-Erling Smørgrav * @param fd: file descriptor (used for the signal number). 682b7579f77SDag-Erling Smørgrav * @param event: event bits from libevent: 683b7579f77SDag-Erling Smørgrav * EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT. 684b7579f77SDag-Erling Smørgrav * @param arg: the internal commsignal structure. 685b7579f77SDag-Erling Smørgrav */ 686b7579f77SDag-Erling Smørgrav void comm_signal_callback(int fd, short event, void* arg); 687b7579f77SDag-Erling Smørgrav 688b7579f77SDag-Erling Smørgrav /** 689b7579f77SDag-Erling Smørgrav * This routine is published for checks and tests, and is only used internally. 690b7579f77SDag-Erling Smørgrav * libevent callback for AF_UNIX fds 691b7579f77SDag-Erling Smørgrav * @param fd: file descriptor. 692b7579f77SDag-Erling Smørgrav * @param event: event bits from libevent: 693b7579f77SDag-Erling Smørgrav * EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT. 694b7579f77SDag-Erling Smørgrav * @param arg: the comm_point structure. 695b7579f77SDag-Erling Smørgrav */ 696b7579f77SDag-Erling Smørgrav void comm_point_local_handle_callback(int fd, short event, void* arg); 697b7579f77SDag-Erling Smørgrav 698b7579f77SDag-Erling Smørgrav /** 699b7579f77SDag-Erling Smørgrav * This routine is published for checks and tests, and is only used internally. 700b7579f77SDag-Erling Smørgrav * libevent callback for raw fd access. 701b7579f77SDag-Erling Smørgrav * @param fd: file descriptor. 702b7579f77SDag-Erling Smørgrav * @param event: event bits from libevent: 703b7579f77SDag-Erling Smørgrav * EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT. 704b7579f77SDag-Erling Smørgrav * @param arg: the comm_point structure. 705b7579f77SDag-Erling Smørgrav */ 706b7579f77SDag-Erling Smørgrav void comm_point_raw_handle_callback(int fd, short event, void* arg); 707b7579f77SDag-Erling Smørgrav 708b7579f77SDag-Erling Smørgrav /** 709b7579f77SDag-Erling Smørgrav * This routine is published for checks and tests, and is only used internally. 710b7579f77SDag-Erling Smørgrav * libevent callback for timeout on slow accept. 711b7579f77SDag-Erling Smørgrav * @param fd: file descriptor. 712b7579f77SDag-Erling Smørgrav * @param event: event bits from libevent: 713b7579f77SDag-Erling Smørgrav * EV_READ, EV_WRITE, EV_SIGNAL, EV_TIMEOUT. 714b7579f77SDag-Erling Smørgrav * @param arg: the comm_point structure. 715b7579f77SDag-Erling Smørgrav */ 716b7579f77SDag-Erling Smørgrav void comm_base_handle_slow_accept(int fd, short event, void* arg); 717b7579f77SDag-Erling Smørgrav 718b7579f77SDag-Erling Smørgrav #ifdef USE_WINSOCK 719b7579f77SDag-Erling Smørgrav /** 720b7579f77SDag-Erling Smørgrav * Callback for openssl BIO to on windows detect WSAEWOULDBLOCK and notify 721b7579f77SDag-Erling Smørgrav * the winsock_event of this for proper TCP nonblocking implementation. 722b7579f77SDag-Erling Smørgrav * @param c: comm_point, fd must be set its struct event is registered. 723b7579f77SDag-Erling Smørgrav * @param ssl: openssl SSL, fd must be set so it has a bio. 724b7579f77SDag-Erling Smørgrav */ 725b7579f77SDag-Erling Smørgrav void comm_point_tcp_win_bio_cb(struct comm_point* c, void* ssl); 726b7579f77SDag-Erling Smørgrav #endif 727b7579f77SDag-Erling Smørgrav 728b7579f77SDag-Erling Smørgrav /** see if errno for tcp connect has to be logged or not. This uses errno */ 729b7579f77SDag-Erling Smørgrav int tcp_connect_errno_needs_log(struct sockaddr* addr, socklen_t addrlen); 730b7579f77SDag-Erling Smørgrav 731b7579f77SDag-Erling Smørgrav #endif /* NET_EVENT_H */ 732