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