1 /* 2 * libunbound/worker.h - prototypes for worker methods. 3 * 4 * Copyright (c) 2007, NLnet Labs. All rights reserved. 5 * 6 * This software is open source. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * Redistributions of source code must retain the above copyright notice, 13 * this list of conditions and the following disclaimer. 14 * 15 * Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 19 * Neither the name of the NLNET LABS nor the names of its contributors may 20 * be used to endorse or promote products derived from this software without 21 * specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 26 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE 27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 33 * POSSIBILITY OF SUCH DAMAGE. 34 */ 35 36 /** 37 * \file 38 * 39 * This file declares the methods any worker has to implement. 40 */ 41 42 #ifndef LIBUNBOUND_WORKER_H 43 #define LIBUNBOUND_WORKER_H 44 45 #include "sldns/sbuffer.h" 46 #include "util/data/packed_rrset.h" /* for enum sec_status */ 47 struct comm_reply; 48 struct comm_point; 49 struct module_qstate; 50 struct tube; 51 struct edns_option; 52 struct query_info; 53 54 /** 55 * Worker service routine to send serviced queries to authoritative servers. 56 * @param qinfo: query info. 57 * @param flags: host order flags word, with opcode and CD bit. 58 * @param dnssec: if set, EDNS record will have DO bit set. 59 * @param want_dnssec: signatures needed. 60 * @param nocaps: ignore capsforid(if in config), do not perturb qname. 61 * @param check_ratelimit: if set, will check ratelimit before sending out. 62 * @param addr: where to. 63 * @param addrlen: length of addr. 64 * @param zone: delegation point name. 65 * @param zonelen: length of zone name wireformat dname. 66 * @param tcp_upstream: use TCP for upstream queries. 67 * @param ssl_upstream: use SSL for upstream queries. 68 * @param tls_auth_name: if ssl_upstream, use this name with TLS 69 * authentication. 70 * @param q: which query state to reactivate upon return. 71 * @param was_ratelimited: it will signal back if the query failed to pass the 72 * ratelimit check. 73 * @return: false on failure (memory or socket related). no query was 74 * sent. 75 */ 76 struct outbound_entry* libworker_send_query(struct query_info* qinfo, 77 uint16_t flags, int dnssec, int want_dnssec, int nocaps, 78 int check_ratelimit, 79 struct sockaddr_storage* addr, socklen_t addrlen, uint8_t* zone, 80 size_t zonelen, int tcp_upstream, int ssl_upstream, char* tls_auth_name, 81 struct module_qstate* q, int* was_ratelimited); 82 83 /** process incoming serviced query replies from the network */ 84 int libworker_handle_service_reply(struct comm_point* c, void* arg, int error, 85 struct comm_reply* reply_info); 86 87 /** handle control command coming into server */ 88 void libworker_handle_control_cmd(struct tube* tube, uint8_t* msg, size_t len, 89 int err, void* arg); 90 91 /** mesh callback with fg results */ 92 void libworker_fg_done_cb(void* arg, int rcode, sldns_buffer* buf, 93 enum sec_status s, char* why_bogus, int was_ratelimited); 94 95 /** mesh callback with bg results */ 96 void libworker_bg_done_cb(void* arg, int rcode, sldns_buffer* buf, 97 enum sec_status s, char* why_bogus, int was_ratelimited); 98 99 /** mesh callback with event results */ 100 void libworker_event_done_cb(void* arg, int rcode, struct sldns_buffer* buf, 101 enum sec_status s, char* why_bogus, int was_ratelimited); 102 103 /** 104 * Worker signal handler function. User argument is the worker itself. 105 * @param sig: signal number. 106 * @param arg: the worker (main worker) that handles signals. 107 */ 108 void worker_sighandler(int sig, void* arg); 109 110 /** 111 * Worker service routine to send serviced queries to authoritative servers. 112 * @param qinfo: query info. 113 * @param flags: host order flags word, with opcode and CD bit. 114 * @param dnssec: if set, EDNS record will have DO bit set. 115 * @param want_dnssec: signatures needed. 116 * @param nocaps: ignore capsforid(if in config), do not perturb qname. 117 * @param check_ratelimit: if set, will check ratelimit before sending out. 118 * @param addr: where to. 119 * @param addrlen: length of addr. 120 * @param zone: wireformat dname of the zone. 121 * @param zonelen: length of zone name. 122 * @param tcp_upstream: use TCP for upstream queries. 123 * @param ssl_upstream: use SSL for upstream queries. 124 * @param tls_auth_name: if ssl_upstream, use this name with TLS 125 * authentication. 126 * @param q: which query state to reactivate upon return. 127 * @param was_ratelimited: it will signal back if the query failed to pass the 128 * ratelimit check. 129 * @return: false on failure (memory or socket related). no query was 130 * sent. 131 */ 132 struct outbound_entry* worker_send_query(struct query_info* qinfo, 133 uint16_t flags, int dnssec, int want_dnssec, int nocaps, 134 int check_ratelimit, 135 struct sockaddr_storage* addr, socklen_t addrlen, uint8_t* zone, 136 size_t zonelen, int tcp_upstream, int ssl_upstream, char* tls_auth_name, 137 struct module_qstate* q, int* was_ratelimited); 138 139 /** 140 * process control messages from the main thread. Frees the control 141 * command message. 142 * @param tube: tube control message came on. 143 * @param msg: message contents. Is freed. 144 * @param len: length of message. 145 * @param error: if error (NETEVENT_*) happened. 146 * @param arg: user argument 147 */ 148 void worker_handle_control_cmd(struct tube* tube, uint8_t* msg, size_t len, 149 int error, void* arg); 150 151 /** handles callbacks from listening event interface */ 152 int worker_handle_request(struct comm_point* c, void* arg, int error, 153 struct comm_reply* repinfo); 154 155 /** process incoming serviced query replies from the network */ 156 int worker_handle_service_reply(struct comm_point* c, void* arg, int error, 157 struct comm_reply* reply_info); 158 159 /** cleanup the cache to remove all rrset IDs from it, arg is worker */ 160 void worker_alloc_cleanup(void* arg); 161 162 /** statistics timer callback handler */ 163 void worker_stat_timer_cb(void* arg); 164 165 /** probe timer callback handler */ 166 void worker_probe_timer_cb(void* arg); 167 168 /** start accept callback handler */ 169 void worker_start_accept(void* arg); 170 171 /** stop accept callback handler */ 172 void worker_stop_accept(void* arg); 173 174 /** handle remote control accept callbacks */ 175 int remote_accept_callback(struct comm_point*, void*, int, struct comm_reply*); 176 177 /** handle remote control data callbacks */ 178 int remote_control_callback(struct comm_point*, void*, int, struct comm_reply*); 179 180 /** routine to printout option values over SSL */ 181 void remote_get_opt_ssl(char* line, void* arg); 182 183 #endif /* LIBUNBOUND_WORKER_H */ 184