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 "util/data/packed_rrset.h" /* for enum sec_status */ 46 struct comm_reply; 47 struct comm_point; 48 struct module_qstate; 49 struct tube; 50 51 /** 52 * Worker service routine to send serviced queries to authoritative servers. 53 * @param qname: query name. (host order) 54 * @param qnamelen: length in bytes of qname, including trailing 0. 55 * @param qtype: query type. (host order) 56 * @param qclass: query class. (host order) 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 addr: where to. 61 * @param addrlen: length of addr. 62 * @param zone: delegation point name. 63 * @param zonelen: length of zone name wireformat dname. 64 * @param q: wich query state to reactivate upon return. 65 * @return: false on failure (memory or socket related). no query was 66 * sent. 67 */ 68 struct outbound_entry* libworker_send_query(uint8_t* qname, size_t qnamelen, 69 uint16_t qtype, uint16_t qclass, uint16_t flags, int dnssec, 70 int want_dnssec, struct sockaddr_storage* addr, socklen_t addrlen, 71 uint8_t* zone, size_t zonelen, struct module_qstate* q); 72 73 /** process incoming replies from the network */ 74 int libworker_handle_reply(struct comm_point* c, void* arg, int error, 75 struct comm_reply* reply_info); 76 77 /** process incoming serviced query replies from the network */ 78 int libworker_handle_service_reply(struct comm_point* c, void* arg, int error, 79 struct comm_reply* reply_info); 80 81 /** handle control command coming into server */ 82 void libworker_handle_control_cmd(struct tube* tube, uint8_t* msg, size_t len, 83 int err, void* arg); 84 85 /** mesh callback with fg results */ 86 void libworker_fg_done_cb(void* arg, int rcode, ldns_buffer* buf, 87 enum sec_status s, char* why_bogus); 88 89 /** mesh callback with bg results */ 90 void libworker_bg_done_cb(void* arg, int rcode, ldns_buffer* buf, 91 enum sec_status s, char* why_bogus); 92 93 /** 94 * Worker signal handler function. User argument is the worker itself. 95 * @param sig: signal number. 96 * @param arg: the worker (main worker) that handles signals. 97 */ 98 void worker_sighandler(int sig, void* arg); 99 100 /** 101 * Worker service routine to send serviced queries to authoritative servers. 102 * @param qname: query name. (host order) 103 * @param qnamelen: length in bytes of qname, including trailing 0. 104 * @param qtype: query type. (host order) 105 * @param qclass: query class. (host order) 106 * @param flags: host order flags word, with opcode and CD bit. 107 * @param dnssec: if set, EDNS record will have DO bit set. 108 * @param want_dnssec: signatures needed. 109 * @param addr: where to. 110 * @param addrlen: length of addr. 111 * @param zone: wireformat dname of the zone. 112 * @param zonelen: length of zone name. 113 * @param q: wich query state to reactivate upon return. 114 * @return: false on failure (memory or socket related). no query was 115 * sent. 116 */ 117 struct outbound_entry* worker_send_query(uint8_t* qname, size_t qnamelen, 118 uint16_t qtype, uint16_t qclass, uint16_t flags, int dnssec, 119 int want_dnssec, struct sockaddr_storage* addr, socklen_t addrlen, 120 uint8_t* zone, size_t zonelen, struct module_qstate* q); 121 122 /** 123 * process control messages from the main thread. Frees the control 124 * command message. 125 * @param tube: tube control message came on. 126 * @param msg: message contents. Is freed. 127 * @param len: length of message. 128 * @param error: if error (NETEVENT_*) happened. 129 * @param arg: user argument 130 */ 131 void worker_handle_control_cmd(struct tube* tube, uint8_t* msg, size_t len, 132 int error, void* arg); 133 134 /** handles callbacks from listening event interface */ 135 int worker_handle_request(struct comm_point* c, void* arg, int error, 136 struct comm_reply* repinfo); 137 138 /** process incoming replies from the network */ 139 int worker_handle_reply(struct comm_point* c, void* arg, int error, 140 struct comm_reply* reply_info); 141 142 /** process incoming serviced query replies from the network */ 143 int worker_handle_service_reply(struct comm_point* c, void* arg, int error, 144 struct comm_reply* reply_info); 145 146 /** cleanup the cache to remove all rrset IDs from it, arg is worker */ 147 void worker_alloc_cleanup(void* arg); 148 149 /** statistics timer callback handler */ 150 void worker_stat_timer_cb(void* arg); 151 152 /** probe timer callback handler */ 153 void worker_probe_timer_cb(void* arg); 154 155 /** start accept callback handler */ 156 void worker_start_accept(void* arg); 157 158 /** stop accept callback handler */ 159 void worker_stop_accept(void* arg); 160 161 /** handle remote control accept callbacks */ 162 int remote_accept_callback(struct comm_point*, void*, int, struct comm_reply*); 163 164 /** handle remote control data callbacks */ 165 int remote_control_callback(struct comm_point*, void*, int, struct comm_reply*); 166 167 /** routine to printout option values over SSL */ 168 void remote_get_opt_ssl(char* line, void* arg); 169 170 #endif /* LIBUNBOUND_WORKER_H */ 171