2 * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2003 Internet Software Consortium.
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: dispatch.c,v 1.101.2.11 2004/07/21 00:49:02 marka Exp $ */
24 #include <isc/entropy.h>
27 #include <isc/mutex.h>
28 #include <isc/print.h>
29 #include <isc/string.h>
34 #include <dns/dispatch.h>
35 #include <dns/events.h>
37 #include <dns/message.h>
38 #include <dns/tcpmsg.h>
39 #include <dns/types.h>
41 typedef ISC_LIST(dns_dispentry_t) dns_displist_t;
43 typedef struct dns_qid {
45 unsigned int qid_nbuckets; /* hash table size */
46 unsigned int qid_increment; /* id increment on collision */
48 isc_lfsr_t qid_lfsr1; /* state generator info */
49 isc_lfsr_t qid_lfsr2; /* state generator info */
50 dns_displist_t *qid_table; /* the table itself */
53 struct dns_dispatchmgr {
59 /* Locked by "lock". */
62 ISC_LIST(dns_dispatch_t) list;
64 /* locked by buffer lock */
66 isc_mutex_t buffer_lock;
67 unsigned int buffers; /* allocated buffers */
68 unsigned int buffersize; /* size of each buffer */
69 unsigned int maxbuffers; /* max buffers */
71 /* Locked internally. */
72 isc_mutex_t pool_lock;
73 isc_mempool_t *epool; /* memory pool for events */
74 isc_mempool_t *rpool; /* memory pool for replies */
75 isc_mempool_t *dpool; /* dispatch allocations */
76 isc_mempool_t *bpool; /* memory pool for buffers */
78 isc_entropy_t *entropy; /* entropy source */
81 #define MGR_SHUTTINGDOWN 0x00000001U
82 #define MGR_IS_SHUTTINGDOWN(l) (((l)->state & MGR_SHUTTINGDOWN) != 0)
84 #define IS_PRIVATE(d) (((d)->attributes & DNS_DISPATCHATTR_PRIVATE) != 0)
86 struct dns_dispentry {
93 isc_taskaction_t action;
95 isc_boolean_t item_out;
96 ISC_LIST(dns_dispatchevent_t) items;
97 ISC_LINK(dns_dispentry_t) link;
100 #define INVALID_BUCKET (0xffffdead)
102 struct dns_dispatch {
104 unsigned int magic; /* magic */
105 dns_dispatchmgr_t *mgr; /* dispatch manager */
106 isc_task_t *task; /* internal task */
107 isc_socket_t *socket; /* isc socket attached to */
108 isc_sockaddr_t local; /* local address */
109 unsigned int maxrequests; /* max requests */
110 isc_event_t *ctlevent;
112 /* Locked by mgr->lock. */
113 ISC_LINK(dns_dispatch_t) link;
115 /* Locked by "lock". */
116 isc_mutex_t lock; /* locks all below */
117 isc_sockettype_t socktype;
118 unsigned int attributes;
119 unsigned int refcount; /* number of users */
120 dns_dispatchevent_t *failsafe_ev; /* failsafe cancel event */
121 unsigned int shutting_down : 1,
125 recv_pending : 1; /* is a recv() pending? */
126 isc_result_t shutdown_why;
127 unsigned int requests; /* how many requests we have */
128 unsigned int tcpbuffers; /* allocated buffers */
129 dns_tcpmsg_t tcpmsg; /* for tcp streams */
133 #define QID_MAGIC ISC_MAGIC('Q', 'i', 'd', ' ')
134 #define VALID_QID(e) ISC_MAGIC_VALID((e), QID_MAGIC)
136 #define RESPONSE_MAGIC ISC_MAGIC('D', 'r', 's', 'p')
137 #define VALID_RESPONSE(e) ISC_MAGIC_VALID((e), RESPONSE_MAGIC)
139 #define DISPATCH_MAGIC ISC_MAGIC('D', 'i', 's', 'p')
140 #define VALID_DISPATCH(e) ISC_MAGIC_VALID((e), DISPATCH_MAGIC)
142 #define DNS_DISPATCHMGR_MAGIC ISC_MAGIC('D', 'M', 'g', 'r')
143 #define VALID_DISPATCHMGR(e) ISC_MAGIC_VALID((e), DNS_DISPATCHMGR_MAGIC)
145 #define DNS_QID(disp) ((disp)->socktype == isc_sockettype_tcp) ? \
146 (disp)->qid : (disp)->mgr->qid
150 static dns_dispentry_t *bucket_search(dns_qid_t *, isc_sockaddr_t *,
151 dns_messageid_t, unsigned int);
152 static isc_boolean_t destroy_disp_ok(dns_dispatch_t *);
153 static void destroy_disp(isc_task_t *task, isc_event_t *event);
154 static void udp_recv(isc_task_t *, isc_event_t *);
155 static void tcp_recv(isc_task_t *, isc_event_t *);
156 static inline void startrecv(dns_dispatch_t *);
157 static dns_messageid_t dns_randomid(dns_qid_t *);
158 static isc_uint32_t dns_hash(dns_qid_t *, isc_sockaddr_t *, dns_messageid_t);
159 static void free_buffer(dns_dispatch_t *disp, void *buf, unsigned int len);
160 static void *allocate_udp_buffer(dns_dispatch_t *disp);
161 static inline void free_event(dns_dispatch_t *disp, dns_dispatchevent_t *ev);
162 static inline dns_dispatchevent_t *allocate_event(dns_dispatch_t *disp);
163 static void do_cancel(dns_dispatch_t *disp);
164 static dns_dispentry_t *linear_first(dns_qid_t *disp);
165 static dns_dispentry_t *linear_next(dns_qid_t *disp,
166 dns_dispentry_t *resp);
167 static void dispatch_free(dns_dispatch_t **dispp);
168 static isc_result_t dispatch_createudp(dns_dispatchmgr_t *mgr,
169 isc_socketmgr_t *sockmgr,
170 isc_taskmgr_t *taskmgr,
171 isc_sockaddr_t *localaddr,
172 unsigned int maxrequests,
173 unsigned int attributes,
174 dns_dispatch_t **dispp);
175 static isc_boolean_t destroy_mgr_ok(dns_dispatchmgr_t *mgr);
176 static void destroy_mgr(dns_dispatchmgr_t **mgrp);
177 static isc_result_t qid_allocate(dns_dispatchmgr_t *mgr, unsigned int buckets,
178 unsigned int increment, dns_qid_t **qidp);
179 static void qid_destroy(isc_mem_t *mctx, dns_qid_t **qidp);
181 #define LVL(x) ISC_LOG_DEBUG(x)
184 mgr_log(dns_dispatchmgr_t *mgr, int level, const char *fmt, ...)
185 ISC_FORMAT_PRINTF(3, 4);
188 mgr_log(dns_dispatchmgr_t *mgr, int level, const char *fmt, ...) {
192 if (! isc_log_wouldlog(dns_lctx, level))
196 vsnprintf(msgbuf, sizeof(msgbuf), fmt, ap);
199 isc_log_write(dns_lctx,
200 DNS_LOGCATEGORY_DISPATCH, DNS_LOGMODULE_DISPATCH,
201 level, "dispatchmgr %p: %s", mgr, msgbuf);
205 dispatch_log(dns_dispatch_t *disp, int level, const char *fmt, ...)
206 ISC_FORMAT_PRINTF(3, 4);
209 dispatch_log(dns_dispatch_t *disp, int level, const char *fmt, ...) {
213 if (! isc_log_wouldlog(dns_lctx, level))
217 vsnprintf(msgbuf, sizeof(msgbuf), fmt, ap);
220 isc_log_write(dns_lctx,
221 DNS_LOGCATEGORY_DISPATCH, DNS_LOGMODULE_DISPATCH,
222 level, "dispatch %p: %s", disp, msgbuf);
226 request_log(dns_dispatch_t *disp, dns_dispentry_t *resp,
227 int level, const char *fmt, ...)
228 ISC_FORMAT_PRINTF(4, 5);
231 request_log(dns_dispatch_t *disp, dns_dispentry_t *resp,
232 int level, const char *fmt, ...)
238 if (! isc_log_wouldlog(dns_lctx, level))
242 vsnprintf(msgbuf, sizeof(msgbuf), fmt, ap);
245 if (VALID_RESPONSE(resp)) {
246 isc_sockaddr_format(&resp->host, peerbuf, sizeof peerbuf);
247 isc_log_write(dns_lctx, DNS_LOGCATEGORY_DISPATCH,
248 DNS_LOGMODULE_DISPATCH, level,
249 "dispatch %p response %p %s: %s", disp, resp,
252 isc_log_write(dns_lctx, DNS_LOGCATEGORY_DISPATCH,
253 DNS_LOGMODULE_DISPATCH, level,
254 "dispatch %p req/resp %p: %s", disp, resp,
260 reseed_lfsr(isc_lfsr_t *lfsr, void *arg)
262 dns_dispatchmgr_t *mgr = arg;
266 REQUIRE(VALID_DISPATCHMGR(mgr));
268 if (mgr->entropy != NULL) {
269 result = isc_entropy_getdata(mgr->entropy, &val, sizeof val,
271 INSIST(result == ISC_R_SUCCESS);
272 lfsr->count = (val & 0x1f) + 32;
277 lfsr->count = (random() & 0x1f) + 32; /* From 32 to 63 states */
278 lfsr->state = random();
282 * Return an unpredictable message ID.
284 static dns_messageid_t
285 dns_randomid(dns_qid_t *qid) {
288 id = isc_lfsr_generate32(&qid->qid_lfsr1, &qid->qid_lfsr2);
290 return (dns_messageid_t)(id & 0xFFFF);
294 * Return a hash of the destination and message id.
297 dns_hash(dns_qid_t *qid, isc_sockaddr_t *dest, dns_messageid_t id) {
300 ret = isc_sockaddr_hash(dest, ISC_TRUE);
302 ret %= qid->qid_nbuckets;
304 INSIST(ret < qid->qid_nbuckets);
310 * Find the first entry in 'qid'. Returns NULL if there are no entries.
312 static dns_dispentry_t *
313 linear_first(dns_qid_t *qid) {
314 dns_dispentry_t *ret;
319 while (bucket < qid->qid_nbuckets) {
320 ret = ISC_LIST_HEAD(qid->qid_table[bucket]);
330 * Find the next entry after 'resp' in 'qid'. Return NULL if there are
333 static dns_dispentry_t *
334 linear_next(dns_qid_t *qid, dns_dispentry_t *resp) {
335 dns_dispentry_t *ret;
338 ret = ISC_LIST_NEXT(resp, link);
342 bucket = resp->bucket;
344 while (bucket < qid->qid_nbuckets) {
345 ret = ISC_LIST_HEAD(qid->qid_table[bucket]);
355 * The dispatch must be locked.
358 destroy_disp_ok(dns_dispatch_t *disp)
360 if (disp->refcount != 0)
363 if (disp->recv_pending != 0)
366 if (disp->shutting_down == 0)
374 * Called when refcount reaches 0 (and safe to destroy).
376 * The dispatcher must not be locked.
377 * The manager must be locked.
380 destroy_disp(isc_task_t *task, isc_event_t *event) {
381 dns_dispatch_t *disp;
382 dns_dispatchmgr_t *mgr;
383 isc_boolean_t killmgr;
385 INSIST(event->ev_type == DNS_EVENT_DISPATCHCONTROL);
389 disp = event->ev_arg;
393 ISC_LIST_UNLINK(mgr->list, disp, link);
395 dispatch_log(disp, LVL(90),
396 "shutting down; detaching from sock %p, task %p",
397 disp->socket, disp->task);
399 isc_socket_detach(&disp->socket);
400 isc_task_detach(&disp->task);
401 isc_event_free(&event);
403 dispatch_free(&disp);
405 killmgr = destroy_mgr_ok(mgr);
413 * Find an entry for query ID 'id' and socket address 'dest' in 'qid'.
414 * Return NULL if no such entry exists.
416 static dns_dispentry_t *
417 bucket_search(dns_qid_t *qid, isc_sockaddr_t *dest, dns_messageid_t id,
420 dns_dispentry_t *res;
422 REQUIRE(bucket < qid->qid_nbuckets);
424 res = ISC_LIST_HEAD(qid->qid_table[bucket]);
426 while (res != NULL) {
427 if ((res->id == id) && isc_sockaddr_equal(dest, &res->host))
429 res = ISC_LIST_NEXT(res, link);
436 free_buffer(dns_dispatch_t *disp, void *buf, unsigned int len) {
437 INSIST(buf != NULL && len != 0);
440 switch (disp->socktype) {
441 case isc_sockettype_tcp:
442 INSIST(disp->tcpbuffers > 0);
444 isc_mem_put(disp->mgr->mctx, buf, len);
446 case isc_sockettype_udp:
447 LOCK(&disp->mgr->buffer_lock);
448 INSIST(disp->mgr->buffers > 0);
449 INSIST(len == disp->mgr->buffersize);
450 disp->mgr->buffers--;
451 isc_mempool_put(disp->mgr->bpool, buf);
452 UNLOCK(&disp->mgr->buffer_lock);
461 allocate_udp_buffer(dns_dispatch_t *disp) {
464 LOCK(&disp->mgr->buffer_lock);
465 temp = isc_mempool_get(disp->mgr->bpool);
468 disp->mgr->buffers++;
469 UNLOCK(&disp->mgr->buffer_lock);
475 free_event(dns_dispatch_t *disp, dns_dispatchevent_t *ev) {
476 if (disp->failsafe_ev == ev) {
477 INSIST(disp->shutdown_out == 1);
478 disp->shutdown_out = 0;
483 isc_mempool_put(disp->mgr->epool, ev);
486 static inline dns_dispatchevent_t *
487 allocate_event(dns_dispatch_t *disp) {
488 dns_dispatchevent_t *ev;
490 ev = isc_mempool_get(disp->mgr->epool);
493 ISC_EVENT_INIT(ev, sizeof(*ev), 0, NULL, 0,
494 NULL, NULL, NULL, NULL, NULL);
502 * If I/O result == CANCELED or error, free the buffer.
504 * If query, free the buffer, restart.
507 * Allocate event, fill in details.
508 * If cannot allocate, free buffer, restart.
509 * find target. If not found, free buffer, restart.
510 * if event queue is not empty, queue. else, send.
514 udp_recv(isc_task_t *task, isc_event_t *ev_in) {
515 isc_socketevent_t *ev = (isc_socketevent_t *)ev_in;
516 dns_dispatch_t *disp = ev_in->ev_arg;
521 dns_dispentry_t *resp;
522 dns_dispatchevent_t *rev;
524 isc_boolean_t killit;
525 isc_boolean_t queue_response;
526 dns_dispatchmgr_t *mgr;
528 isc_netaddr_t netaddr;
538 dispatch_log(disp, LVL(90),
539 "got packet: requests %d, buffers %d, recvs %d",
540 disp->requests, disp->mgr->buffers, disp->recv_pending);
542 if (ev->ev_type == ISC_SOCKEVENT_RECVDONE) {
544 * Unless the receive event was imported from a listening
545 * interface, in which case the event type is
546 * DNS_EVENT_IMPORTRECVDONE, receive operation must be pending.
548 INSIST(disp->recv_pending != 0);
549 disp->recv_pending = 0;
552 if (disp->shutting_down) {
554 * This dispatcher is shutting down.
556 free_buffer(disp, ev->region.base, ev->region.length);
558 isc_event_free(&ev_in);
561 killit = destroy_disp_ok(disp);
564 isc_task_send(disp->task, &disp->ctlevent);
569 if (ev->result != ISC_R_SUCCESS) {
570 free_buffer(disp, ev->region.base, ev->region.length);
572 if (ev->result != ISC_R_CANCELED)
573 dispatch_log(disp, ISC_LOG_ERROR,
574 "odd socket result in udp_recv(): %s",
575 isc_result_totext(ev->result));
578 isc_event_free(&ev_in);
583 * If this is from a blackholed address, drop it.
585 isc_netaddr_fromsockaddr(&netaddr, &ev->address);
586 if (disp->mgr->blackhole != NULL &&
587 dns_acl_match(&netaddr, NULL, disp->mgr->blackhole,
588 NULL, &match, NULL) == ISC_R_SUCCESS &&
591 if (isc_log_wouldlog(dns_lctx, LVL(10))) {
592 char netaddrstr[ISC_NETADDR_FORMATSIZE];
593 isc_netaddr_format(&netaddr, netaddrstr,
595 dispatch_log(disp, LVL(10),
596 "blackholed packet from %s",
599 free_buffer(disp, ev->region.base, ev->region.length);
604 * Peek into the buffer to see what we can see.
606 isc_buffer_init(&source, ev->region.base, ev->region.length);
607 isc_buffer_add(&source, ev->n);
608 dres = dns_message_peekheader(&source, &id, &flags);
609 if (dres != ISC_R_SUCCESS) {
610 free_buffer(disp, ev->region.base, ev->region.length);
611 dispatch_log(disp, LVL(10), "got garbage packet");
615 dispatch_log(disp, LVL(92),
616 "got valid DNS message header, /QR %c, id %u",
617 ((flags & DNS_MESSAGEFLAG_QR) ? '1' : '0'), id);
620 * Look at flags. If query, drop it. If response,
621 * look to see where it goes.
623 queue_response = ISC_FALSE;
624 if ((flags & DNS_MESSAGEFLAG_QR) == 0) {
626 free_buffer(disp, ev->region.base, ev->region.length);
631 bucket = dns_hash(qid, &ev->address, id);
633 resp = bucket_search(qid, &ev->address, id, bucket);
634 dispatch_log(disp, LVL(90),
635 "search for response in bucket %d: %s",
636 bucket, (resp == NULL ? "not found" : "found"));
639 free_buffer(disp, ev->region.base, ev->region.length);
642 queue_response = resp->item_out;
643 rev = allocate_event(resp->disp);
645 free_buffer(disp, ev->region.base, ev->region.length);
650 * At this point, rev contains the event we want to fill in, and
651 * resp contains the information on the place to send it to.
652 * Send the event off.
654 isc_buffer_init(&rev->buffer, ev->region.base, ev->region.length);
655 isc_buffer_add(&rev->buffer, ev->n);
656 rev->result = ISC_R_SUCCESS;
658 rev->addr = ev->address;
659 rev->pktinfo = ev->pktinfo;
660 rev->attributes = ev->attributes;
661 if (queue_response) {
662 ISC_LIST_APPEND(resp->items, rev, ev_link);
664 ISC_EVENT_INIT(rev, sizeof(*rev), 0, NULL,
666 resp->action, resp->arg, resp, NULL, NULL);
667 request_log(disp, resp, LVL(90),
668 "[a] Sent event %p buffer %p len %d to task %p",
669 rev, rev->buffer.base, rev->buffer.length,
671 resp->item_out = ISC_TRUE;
672 isc_task_send(resp->task, ISC_EVENT_PTR(&rev));
678 * Restart recv() to get the next packet.
685 isc_event_free(&ev_in);
691 * If I/O result == CANCELED, EOF, or error, notify everyone as the
692 * various queues drain.
697 * Allocate event, fill in details.
698 * If cannot allocate, restart.
699 * find target. If not found, restart.
700 * if event queue is not empty, queue. else, send.
704 tcp_recv(isc_task_t *task, isc_event_t *ev_in) {
705 dns_dispatch_t *disp = ev_in->ev_arg;
706 dns_tcpmsg_t *tcpmsg = &disp->tcpmsg;
710 dns_dispentry_t *resp;
711 dns_dispatchevent_t *rev;
713 isc_boolean_t killit;
714 isc_boolean_t queue_response;
719 REQUIRE(VALID_DISPATCH(disp));
723 dispatch_log(disp, LVL(90),
724 "got TCP packet: requests %d, buffers %d, recvs %d",
725 disp->requests, disp->tcpbuffers, disp->recv_pending);
729 INSIST(disp->recv_pending != 0);
730 disp->recv_pending = 0;
732 if (disp->refcount == 0) {
734 * This dispatcher is shutting down. Force cancelation.
736 tcpmsg->result = ISC_R_CANCELED;
739 if (tcpmsg->result != ISC_R_SUCCESS) {
740 switch (tcpmsg->result) {
745 dispatch_log(disp, LVL(90), "shutting down on EOF");
750 dispatch_log(disp, ISC_LOG_ERROR,
751 "shutting down due to TCP "
753 isc_result_totext(tcpmsg->result));
759 * The event is statically allocated in the tcpmsg
760 * structure, and destroy_disp() frees the tcpmsg, so we must
761 * free the event *before* calling destroy_disp().
763 isc_event_free(&ev_in);
765 disp->shutting_down = 1;
766 disp->shutdown_why = tcpmsg->result;
769 * If the recv() was canceled pass the word on.
771 killit = destroy_disp_ok(disp);
774 isc_task_send(disp->task, &disp->ctlevent);
778 dispatch_log(disp, LVL(90), "result %d, length == %d, addr = %p",
780 tcpmsg->buffer.length, tcpmsg->buffer.base);
783 * Peek into the buffer to see what we can see.
785 dres = dns_message_peekheader(&tcpmsg->buffer, &id, &flags);
786 if (dres != ISC_R_SUCCESS) {
787 dispatch_log(disp, LVL(10), "got garbage packet");
791 dispatch_log(disp, LVL(92),
792 "got valid DNS message header, /QR %c, id %u",
793 ((flags & DNS_MESSAGEFLAG_QR) ? '1' : '0'), id);
796 * Allocate an event to send to the query or response client, and
797 * allocate a new buffer for our use.
801 * Look at flags. If query, drop it. If response,
802 * look to see where it goes.
804 queue_response = ISC_FALSE;
805 if ((flags & DNS_MESSAGEFLAG_QR) == 0) {
815 bucket = dns_hash(qid, &tcpmsg->address, id);
817 resp = bucket_search(qid, &tcpmsg->address, id, bucket);
818 dispatch_log(disp, LVL(90),
819 "search for response in bucket %d: %s",
820 bucket, (resp == NULL ? "not found" : "found"));
824 queue_response = resp->item_out;
825 rev = allocate_event(disp);
830 * At this point, rev contains the event we want to fill in, and
831 * resp contains the information on the place to send it to.
832 * Send the event off.
834 dns_tcpmsg_keepbuffer(tcpmsg, &rev->buffer);
836 rev->result = ISC_R_SUCCESS;
838 rev->addr = tcpmsg->address;
839 if (queue_response) {
840 ISC_LIST_APPEND(resp->items, rev, ev_link);
842 ISC_EVENT_INIT(rev, sizeof(*rev), 0, NULL, DNS_EVENT_DISPATCH,
843 resp->action, resp->arg, resp, NULL, NULL);
844 request_log(disp, resp, LVL(90),
845 "[b] Sent event %p buffer %p len %d to task %p",
846 rev, rev->buffer.base, rev->buffer.length,
848 resp->item_out = ISC_TRUE;
849 isc_task_send(resp->task, ISC_EVENT_PTR(&rev));
855 * Restart recv() to get the next packet.
862 isc_event_free(&ev_in);
866 * disp must be locked.
869 startrecv(dns_dispatch_t *disp) {
873 if (disp->shutting_down == 1)
876 if ((disp->attributes & DNS_DISPATCHATTR_NOLISTEN) != 0)
879 if (disp->recv_pending != 0)
882 if (disp->mgr->buffers >= disp->mgr->maxbuffers)
885 switch (disp->socktype) {
887 * UDP reads are always maximal.
889 case isc_sockettype_udp:
890 region.length = disp->mgr->buffersize;
891 region.base = allocate_udp_buffer(disp);
892 if (region.base == NULL)
894 res = isc_socket_recv(disp->socket, ®ion, 1,
895 disp->task, udp_recv, disp);
896 if (res != ISC_R_SUCCESS) {
897 free_buffer(disp, region.base, region.length);
898 disp->shutdown_why = res;
899 disp->shutting_down = 1;
903 disp->recv_pending = 1;
906 case isc_sockettype_tcp:
907 res = dns_tcpmsg_readmessage(&disp->tcpmsg, disp->task,
909 if (res != ISC_R_SUCCESS) {
910 disp->shutdown_why = res;
911 disp->shutting_down = 1;
915 disp->recv_pending = 1;
921 * Mgr must be locked when calling this function.
924 destroy_mgr_ok(dns_dispatchmgr_t *mgr) {
925 mgr_log(mgr, LVL(90),
926 "destroy_mgr_ok: shuttingdown=%d, listnonempty=%d, "
927 "epool=%d, rpool=%d, dpool=%d",
928 MGR_IS_SHUTTINGDOWN(mgr), !ISC_LIST_EMPTY(mgr->list),
929 isc_mempool_getallocated(mgr->epool),
930 isc_mempool_getallocated(mgr->rpool),
931 isc_mempool_getallocated(mgr->dpool));
932 if (!MGR_IS_SHUTTINGDOWN(mgr))
934 if (!ISC_LIST_EMPTY(mgr->list))
936 if (isc_mempool_getallocated(mgr->epool) != 0)
938 if (isc_mempool_getallocated(mgr->rpool) != 0)
940 if (isc_mempool_getallocated(mgr->dpool) != 0)
947 * Mgr must be unlocked when calling this function.
950 destroy_mgr(dns_dispatchmgr_t **mgrp) {
952 dns_dispatchmgr_t *mgr;
961 DESTROYLOCK(&mgr->lock);
964 isc_mempool_destroy(&mgr->epool);
965 isc_mempool_destroy(&mgr->rpool);
966 isc_mempool_destroy(&mgr->dpool);
967 isc_mempool_destroy(&mgr->bpool);
969 DESTROYLOCK(&mgr->pool_lock);
971 if (mgr->entropy != NULL)
972 isc_entropy_detach(&mgr->entropy);
973 if (mgr->qid != NULL)
974 qid_destroy(mctx, &mgr->qid);
976 DESTROYLOCK(&mgr->buffer_lock);
978 if (mgr->blackhole != NULL)
979 dns_acl_detach(&mgr->blackhole);
981 isc_mem_put(mctx, mgr, sizeof(dns_dispatchmgr_t));
982 isc_mem_detach(&mctx);
986 create_socket(isc_socketmgr_t *mgr, isc_sockaddr_t *local,
987 isc_socket_t **sockp)
993 result = isc_socket_create(mgr, isc_sockaddr_pf(local),
994 isc_sockettype_udp, &sock);
995 if (result != ISC_R_SUCCESS)
998 result = isc_socket_bind(sock, local);
999 if (result != ISC_R_SUCCESS) {
1000 isc_socket_detach(&sock);
1005 return (ISC_R_SUCCESS);
1013 dns_dispatchmgr_create(isc_mem_t *mctx, isc_entropy_t *entropy,
1014 dns_dispatchmgr_t **mgrp)
1016 dns_dispatchmgr_t *mgr;
1017 isc_result_t result;
1019 REQUIRE(mctx != NULL);
1020 REQUIRE(mgrp != NULL && *mgrp == NULL);
1022 mgr = isc_mem_get(mctx, sizeof(dns_dispatchmgr_t));
1024 return (ISC_R_NOMEMORY);
1027 isc_mem_attach(mctx, &mgr->mctx);
1029 mgr->blackhole = NULL;
1031 result = isc_mutex_init(&mgr->lock);
1032 if (result != ISC_R_SUCCESS)
1035 result = isc_mutex_init(&mgr->buffer_lock);
1036 if (result != ISC_R_SUCCESS)
1039 result = isc_mutex_init(&mgr->pool_lock);
1040 if (result != ISC_R_SUCCESS)
1041 goto kill_buffer_lock;
1044 if (isc_mempool_create(mgr->mctx, sizeof(dns_dispatchevent_t),
1045 &mgr->epool) != ISC_R_SUCCESS) {
1046 result = ISC_R_NOMEMORY;
1047 goto kill_pool_lock;
1051 if (isc_mempool_create(mgr->mctx, sizeof(dns_dispentry_t),
1052 &mgr->rpool) != ISC_R_SUCCESS) {
1053 result = ISC_R_NOMEMORY;
1058 if (isc_mempool_create(mgr->mctx, sizeof(dns_dispatch_t),
1059 &mgr->dpool) != ISC_R_SUCCESS) {
1060 result = ISC_R_NOMEMORY;
1064 isc_mempool_setname(mgr->epool, "dispmgr_epool");
1065 isc_mempool_setfreemax(mgr->epool, 1024);
1066 isc_mempool_associatelock(mgr->epool, &mgr->pool_lock);
1068 isc_mempool_setname(mgr->rpool, "dispmgr_rpool");
1069 isc_mempool_setfreemax(mgr->rpool, 1024);
1070 isc_mempool_associatelock(mgr->rpool, &mgr->pool_lock);
1072 isc_mempool_setname(mgr->dpool, "dispmgr_dpool");
1073 isc_mempool_setfreemax(mgr->dpool, 1024);
1074 isc_mempool_associatelock(mgr->dpool, &mgr->pool_lock);
1077 mgr->buffersize = 0;
1078 mgr->maxbuffers = 0;
1080 mgr->entropy = NULL;
1083 ISC_LIST_INIT(mgr->list);
1084 mgr->magic = DNS_DISPATCHMGR_MAGIC;
1086 if (entropy != NULL)
1087 isc_entropy_attach(entropy, &mgr->entropy);
1090 return (ISC_R_SUCCESS);
1093 isc_mempool_destroy(&mgr->rpool);
1095 isc_mempool_destroy(&mgr->epool);
1097 DESTROYLOCK(&mgr->pool_lock);
1099 DESTROYLOCK(&mgr->buffer_lock);
1101 DESTROYLOCK(&mgr->lock);
1103 isc_mem_put(mctx, mgr, sizeof(dns_dispatchmgr_t));
1104 isc_mem_detach(&mctx);
1110 dns_dispatchmgr_setblackhole(dns_dispatchmgr_t *mgr, dns_acl_t *blackhole) {
1111 REQUIRE(VALID_DISPATCHMGR(mgr));
1112 if (mgr->blackhole != NULL)
1113 dns_acl_detach(&mgr->blackhole);
1114 dns_acl_attach(blackhole, &mgr->blackhole);
1118 dns_dispatchmgr_getblackhole(dns_dispatchmgr_t *mgr) {
1119 REQUIRE(VALID_DISPATCHMGR(mgr));
1120 return (mgr->blackhole);
1124 dns_dispatchmgr_setudp(dns_dispatchmgr_t *mgr,
1125 unsigned int buffersize, unsigned int maxbuffers,
1126 unsigned int buckets, unsigned int increment)
1128 isc_result_t result;
1130 REQUIRE(VALID_DISPATCHMGR(mgr));
1131 REQUIRE(buffersize >= 512 && buffersize < (64 * 1024));
1132 REQUIRE(maxbuffers > 0);
1133 REQUIRE(buckets < 2097169); /* next prime > 65536 * 32 */
1134 REQUIRE(increment > buckets);
1137 * Keep some number of items around. This should be a config
1138 * option. For now, keep 8, but later keep at least two even
1139 * if the caller wants less. This allows us to ensure certain
1140 * things, like an event can be "freed" and the next allocation
1141 * will always succeed.
1143 * Note that if limits are placed on anything here, we use one
1144 * event internally, so the actual limit should be "wanted + 1."
1152 LOCK(&mgr->buffer_lock);
1153 if (mgr->bpool != NULL) {
1154 isc_mempool_setmaxalloc(mgr->bpool, maxbuffers);
1155 mgr->maxbuffers = maxbuffers;
1156 UNLOCK(&mgr->buffer_lock);
1157 return (ISC_R_SUCCESS);
1160 if (isc_mempool_create(mgr->mctx, buffersize,
1161 &mgr->bpool) != ISC_R_SUCCESS) {
1162 return (ISC_R_NOMEMORY);
1165 isc_mempool_setname(mgr->bpool, "dispmgr_bpool");
1166 isc_mempool_setmaxalloc(mgr->bpool, maxbuffers);
1167 isc_mempool_associatelock(mgr->bpool, &mgr->pool_lock);
1169 result = qid_allocate(mgr, buckets, increment, &mgr->qid);
1170 if (result != ISC_R_SUCCESS)
1173 mgr->buffersize = buffersize;
1174 mgr->maxbuffers = maxbuffers;
1175 UNLOCK(&mgr->buffer_lock);
1176 return (ISC_R_SUCCESS);
1179 isc_mempool_destroy(&mgr->bpool);
1180 UNLOCK(&mgr->buffer_lock);
1181 return (ISC_R_NOMEMORY);
1185 dns_dispatchmgr_destroy(dns_dispatchmgr_t **mgrp) {
1186 dns_dispatchmgr_t *mgr;
1187 isc_boolean_t killit;
1189 REQUIRE(mgrp != NULL);
1190 REQUIRE(VALID_DISPATCHMGR(*mgrp));
1196 mgr->state |= MGR_SHUTTINGDOWN;
1198 killit = destroy_mgr_ok(mgr);
1201 mgr_log(mgr, LVL(90), "destroy: killit=%d", killit);
1208 #define ATTRMATCH(_a1, _a2, _mask) (((_a1) & (_mask)) == ((_a2) & (_mask)))
1210 static isc_boolean_t
1211 local_addr_match(dns_dispatch_t *disp, isc_sockaddr_t *addr) {
1216 return (isc_sockaddr_equal(&disp->local, addr));
1220 * Requires mgr be locked.
1222 * No dispatcher can be locked by this thread when calling this function.
1226 * If a matching dispatcher is found, it is locked after this function
1227 * returns, and must be unlocked by the caller.
1230 dispatch_find(dns_dispatchmgr_t *mgr, isc_sockaddr_t *local,
1231 unsigned int attributes, unsigned int mask,
1232 dns_dispatch_t **dispp)
1234 dns_dispatch_t *disp;
1235 isc_result_t result;
1238 * Make certain that we will not match a private dispatch.
1240 attributes &= ~DNS_DISPATCHATTR_PRIVATE;
1241 mask |= DNS_DISPATCHATTR_PRIVATE;
1243 disp = ISC_LIST_HEAD(mgr->list);
1244 while (disp != NULL) {
1246 if ((disp->shutting_down == 0)
1247 && ATTRMATCH(disp->attributes, attributes, mask)
1248 && local_addr_match(disp, local))
1250 UNLOCK(&disp->lock);
1251 disp = ISC_LIST_NEXT(disp, link);
1255 result = ISC_R_NOTFOUND;
1260 result = ISC_R_SUCCESS;
1267 qid_allocate(dns_dispatchmgr_t *mgr, unsigned int buckets,
1268 unsigned int increment, dns_qid_t **qidp)
1273 REQUIRE(VALID_DISPATCHMGR(mgr));
1274 REQUIRE(buckets < 2097169); /* next prime > 65536 * 32 */
1275 REQUIRE(increment > buckets);
1276 REQUIRE(qidp != NULL && *qidp == NULL);
1278 qid = isc_mem_get(mgr->mctx, sizeof(*qid));
1280 return (ISC_R_NOMEMORY);
1282 qid->qid_table = isc_mem_get(mgr->mctx,
1283 buckets * sizeof(dns_displist_t));
1284 if (qid->qid_table == NULL) {
1285 isc_mem_put(mgr->mctx, qid, sizeof(*qid));
1286 return (ISC_R_NOMEMORY);
1289 if (isc_mutex_init(&qid->lock) != ISC_R_SUCCESS) {
1290 UNEXPECTED_ERROR(__FILE__, __LINE__, "isc_mutex_init failed");
1291 isc_mem_put(mgr->mctx, qid->qid_table,
1292 buckets * sizeof(dns_displist_t));
1293 isc_mem_put(mgr->mctx, qid, sizeof(*qid));
1294 return (ISC_R_UNEXPECTED);
1297 for (i = 0 ; i < buckets ; i++)
1298 ISC_LIST_INIT(qid->qid_table[i]);
1300 qid->qid_nbuckets = buckets;
1301 qid->qid_increment = increment;
1302 qid->magic = QID_MAGIC;
1305 * Initialize to a 32-bit LFSR. Both of these are from Applied
1309 * x^32 + x^7 + x^5 + x^3 + x^2 + x + 1
1312 * x^32 + x^7 + x^6 + x^2 + 1
1314 isc_lfsr_init(&qid->qid_lfsr1, 0, 32, 0x80000057U,
1315 0, reseed_lfsr, mgr);
1316 isc_lfsr_init(&qid->qid_lfsr2, 0, 32, 0x80000062U,
1317 0, reseed_lfsr, mgr);
1319 return (ISC_R_SUCCESS);
1323 qid_destroy(isc_mem_t *mctx, dns_qid_t **qidp) {
1326 REQUIRE(qidp != NULL);
1329 REQUIRE(VALID_QID(qid));
1333 isc_mem_put(mctx, qid->qid_table,
1334 qid->qid_nbuckets * sizeof(dns_displist_t));
1335 DESTROYLOCK(&qid->lock);
1336 isc_mem_put(mctx, qid, sizeof(*qid));
1340 * Allocate and set important limits.
1343 dispatch_allocate(dns_dispatchmgr_t *mgr, unsigned int maxrequests,
1344 dns_dispatch_t **dispp)
1346 dns_dispatch_t *disp;
1349 REQUIRE(VALID_DISPATCHMGR(mgr));
1350 REQUIRE(dispp != NULL && *dispp == NULL);
1353 * Set up the dispatcher, mostly. Don't bother setting some of
1354 * the options that are controlled by tcp vs. udp, etc.
1357 disp = isc_mempool_get(mgr->dpool);
1359 return (ISC_R_NOMEMORY);
1363 disp->maxrequests = maxrequests;
1364 disp->attributes = 0;
1365 ISC_LINK_INIT(disp, link);
1367 disp->recv_pending = 0;
1368 memset(&disp->local, 0, sizeof disp->local);
1369 disp->shutting_down = 0;
1370 disp->shutdown_out = 0;
1371 disp->connected = 0;
1372 disp->tcpmsg_valid = 0;
1373 disp->shutdown_why = ISC_R_UNEXPECTED;
1375 disp->tcpbuffers = 0;
1378 if (isc_mutex_init(&disp->lock) != ISC_R_SUCCESS) {
1379 res = ISC_R_UNEXPECTED;
1380 UNEXPECTED_ERROR(__FILE__, __LINE__, "isc_mutex_init failed");
1384 disp->failsafe_ev = allocate_event(disp);
1385 if (disp->failsafe_ev == NULL) {
1386 res = ISC_R_NOMEMORY;
1390 disp->magic = DISPATCH_MAGIC;
1393 return (ISC_R_SUCCESS);
1399 DESTROYLOCK(&disp->lock);
1401 isc_mempool_put(mgr->dpool, disp);
1408 * MUST be unlocked, and not used by anthing.
1411 dispatch_free(dns_dispatch_t **dispp)
1413 dns_dispatch_t *disp;
1414 dns_dispatchmgr_t *mgr;
1416 REQUIRE(VALID_DISPATCH(*dispp));
1421 REQUIRE(VALID_DISPATCHMGR(mgr));
1423 if (disp->tcpmsg_valid) {
1424 dns_tcpmsg_invalidate(&disp->tcpmsg);
1425 disp->tcpmsg_valid = 0;
1428 INSIST(disp->tcpbuffers == 0);
1429 INSIST(disp->requests == 0);
1430 INSIST(disp->recv_pending == 0);
1432 isc_mempool_put(mgr->epool, disp->failsafe_ev);
1433 disp->failsafe_ev = NULL;
1435 if (disp->qid != NULL)
1436 qid_destroy(mgr->mctx, &disp->qid);
1438 DESTROYLOCK(&disp->lock);
1440 isc_mempool_put(mgr->dpool, disp);
1444 dns_dispatch_createtcp(dns_dispatchmgr_t *mgr, isc_socket_t *sock,
1445 isc_taskmgr_t *taskmgr, unsigned int buffersize,
1446 unsigned int maxbuffers, unsigned int maxrequests,
1447 unsigned int buckets, unsigned int increment,
1448 unsigned int attributes, dns_dispatch_t **dispp)
1450 isc_result_t result;
1451 dns_dispatch_t *disp;
1456 REQUIRE(VALID_DISPATCHMGR(mgr));
1457 REQUIRE(isc_socket_gettype(sock) == isc_sockettype_tcp);
1458 REQUIRE((attributes & DNS_DISPATCHATTR_TCP) != 0);
1459 REQUIRE((attributes & DNS_DISPATCHATTR_UDP) == 0);
1461 attributes |= DNS_DISPATCHATTR_PRIVATE; /* XXXMLG */
1466 * dispatch_allocate() checks mgr for us.
1467 * qid_allocate() checks buckets and increment for us.
1470 result = dispatch_allocate(mgr, maxrequests, &disp);
1471 if (result != ISC_R_SUCCESS) {
1476 result = qid_allocate(mgr, buckets, increment, &disp->qid);
1477 if (result != ISC_R_SUCCESS)
1478 goto deallocate_dispatch;
1480 disp->socktype = isc_sockettype_tcp;
1481 disp->socket = NULL;
1482 isc_socket_attach(sock, &disp->socket);
1485 result = isc_task_create(taskmgr, 0, &disp->task);
1486 if (result != ISC_R_SUCCESS)
1489 disp->ctlevent = isc_event_allocate(mgr->mctx, disp,
1490 DNS_EVENT_DISPATCHCONTROL,
1492 sizeof(isc_event_t));
1493 if (disp->ctlevent == NULL)
1496 isc_task_setname(disp->task, "tcpdispatch", disp);
1498 dns_tcpmsg_init(mgr->mctx, disp->socket, &disp->tcpmsg);
1499 disp->tcpmsg_valid = 1;
1501 disp->attributes = attributes;
1504 * Append it to the dispatcher list.
1506 ISC_LIST_APPEND(mgr->list, disp, link);
1509 mgr_log(mgr, LVL(90), "created TCP dispatcher %p", disp);
1510 dispatch_log(disp, LVL(90), "created task %p", disp->task);
1514 return (ISC_R_SUCCESS);
1520 isc_task_detach(&disp->task);
1522 isc_socket_detach(&disp->socket);
1523 deallocate_dispatch:
1524 dispatch_free(&disp);
1532 dns_dispatch_getudp(dns_dispatchmgr_t *mgr, isc_socketmgr_t *sockmgr,
1533 isc_taskmgr_t *taskmgr, isc_sockaddr_t *localaddr,
1534 unsigned int buffersize,
1535 unsigned int maxbuffers, unsigned int maxrequests,
1536 unsigned int buckets, unsigned int increment,
1537 unsigned int attributes, unsigned int mask,
1538 dns_dispatch_t **dispp)
1540 isc_result_t result;
1541 dns_dispatch_t *disp;
1543 REQUIRE(VALID_DISPATCHMGR(mgr));
1544 REQUIRE(sockmgr != NULL);
1545 REQUIRE(localaddr != NULL);
1546 REQUIRE(taskmgr != NULL);
1547 REQUIRE(buffersize >= 512 && buffersize < (64 * 1024));
1548 REQUIRE(maxbuffers > 0);
1549 REQUIRE(buckets < 2097169); /* next prime > 65536 * 32 */
1550 REQUIRE(increment > buckets);
1551 REQUIRE(dispp != NULL && *dispp == NULL);
1552 REQUIRE((attributes & DNS_DISPATCHATTR_TCP) == 0);
1554 result = dns_dispatchmgr_setudp(mgr, buffersize, maxbuffers,
1555 buckets, increment);
1556 if (result != ISC_R_SUCCESS)
1562 * First, see if we have a dispatcher that matches.
1565 result = dispatch_find(mgr, localaddr, attributes, mask, &disp);
1566 if (result == ISC_R_SUCCESS) {
1569 if (disp->maxrequests < maxrequests)
1570 disp->maxrequests = maxrequests;
1572 if ((disp->attributes & DNS_DISPATCHATTR_NOLISTEN) == 0 &&
1573 (attributes & DNS_DISPATCHATTR_NOLISTEN) != 0)
1575 disp->attributes |= DNS_DISPATCHATTR_NOLISTEN;
1576 if (disp->recv_pending != 0)
1577 isc_socket_cancel(disp->socket, disp->task,
1578 ISC_SOCKCANCEL_RECV);
1581 UNLOCK(&disp->lock);
1586 return (ISC_R_SUCCESS);
1592 result = dispatch_createudp(mgr, sockmgr, taskmgr, localaddr,
1593 maxrequests, attributes, &disp);
1594 if (result != ISC_R_SUCCESS) {
1601 return (ISC_R_SUCCESS);
1605 * mgr should be locked.
1608 dispatch_createudp(dns_dispatchmgr_t *mgr, isc_socketmgr_t *sockmgr,
1609 isc_taskmgr_t *taskmgr,
1610 isc_sockaddr_t *localaddr,
1611 unsigned int maxrequests,
1612 unsigned int attributes,
1613 dns_dispatch_t **dispp)
1615 isc_result_t result;
1616 dns_dispatch_t *disp;
1620 * dispatch_allocate() checks mgr for us.
1623 result = dispatch_allocate(mgr, maxrequests, &disp);
1624 if (result != ISC_R_SUCCESS)
1627 result = create_socket(sockmgr, localaddr, &sock);
1628 if (result != ISC_R_SUCCESS)
1629 goto deallocate_dispatch;
1631 disp->socktype = isc_sockettype_udp;
1632 disp->socket = sock;
1633 disp->local = *localaddr;
1636 result = isc_task_create(taskmgr, 0, &disp->task);
1637 if (result != ISC_R_SUCCESS)
1640 disp->ctlevent = isc_event_allocate(mgr->mctx, disp,
1641 DNS_EVENT_DISPATCHCONTROL,
1643 sizeof(isc_event_t));
1644 if (disp->ctlevent == NULL)
1647 isc_task_setname(disp->task, "udpdispatch", disp);
1649 attributes &= ~DNS_DISPATCHATTR_TCP;
1650 attributes |= DNS_DISPATCHATTR_UDP;
1651 disp->attributes = attributes;
1654 * Append it to the dispatcher list.
1656 ISC_LIST_APPEND(mgr->list, disp, link);
1658 mgr_log(mgr, LVL(90), "created UDP dispatcher %p", disp);
1659 dispatch_log(disp, LVL(90), "created task %p", disp->task);
1660 dispatch_log(disp, LVL(90), "created socket %p", disp->socket);
1664 return (ISC_R_SUCCESS);
1670 isc_task_detach(&disp->task);
1672 isc_socket_detach(&disp->socket);
1673 deallocate_dispatch:
1674 dispatch_free(&disp);
1680 dns_dispatch_attach(dns_dispatch_t *disp, dns_dispatch_t **dispp) {
1681 REQUIRE(VALID_DISPATCH(disp));
1682 REQUIRE(dispp != NULL && *dispp == NULL);
1686 UNLOCK(&disp->lock);
1692 * It is important to lock the manager while we are deleting the dispatch,
1693 * since dns_dispatch_getudp will call dispatch_find, which returns to
1694 * the caller a dispatch but does not attach to it until later. _getudp
1695 * locks the manager, however, so locking it here will keep us from attaching
1696 * to a dispatcher that is in the process of going away.
1699 dns_dispatch_detach(dns_dispatch_t **dispp) {
1700 dns_dispatch_t *disp;
1701 isc_boolean_t killit;
1703 REQUIRE(dispp != NULL && VALID_DISPATCH(*dispp));
1710 INSIST(disp->refcount > 0);
1713 if (disp->refcount == 0) {
1714 if (disp->recv_pending > 0)
1715 isc_socket_cancel(disp->socket, disp->task,
1716 ISC_SOCKCANCEL_RECV);
1717 disp->shutting_down = 1;
1720 dispatch_log(disp, LVL(90), "detach: refcount %d", disp->refcount);
1722 killit = destroy_disp_ok(disp);
1723 UNLOCK(&disp->lock);
1725 isc_task_send(disp->task, &disp->ctlevent);
1729 dns_dispatch_addresponse(dns_dispatch_t *disp, isc_sockaddr_t *dest,
1730 isc_task_t *task, isc_taskaction_t action, void *arg,
1731 dns_messageid_t *idp, dns_dispentry_t **resp)
1733 dns_dispentry_t *res;
1734 unsigned int bucket;
1740 REQUIRE(VALID_DISPATCH(disp));
1741 REQUIRE(task != NULL);
1742 REQUIRE(dest != NULL);
1743 REQUIRE(resp != NULL && *resp == NULL);
1744 REQUIRE(idp != NULL);
1748 if (disp->shutting_down == 1) {
1749 UNLOCK(&disp->lock);
1750 return (ISC_R_SHUTTINGDOWN);
1753 if (disp->requests >= disp->maxrequests) {
1754 UNLOCK(&disp->lock);
1755 return (ISC_R_QUOTA);
1759 * Try somewhat hard to find an unique ID.
1761 qid = DNS_QID(disp);
1763 id = dns_randomid(qid);
1764 bucket = dns_hash(qid, dest, id);
1766 for (i = 0 ; i < 64 ; i++) {
1767 if (bucket_search(qid, dest, id, bucket) == NULL) {
1771 id += qid->qid_increment;
1773 bucket = dns_hash(qid, dest, id);
1778 UNLOCK(&disp->lock);
1779 return (ISC_R_NOMORE);
1782 res = isc_mempool_get(disp->mgr->rpool);
1785 UNLOCK(&disp->lock);
1786 return (ISC_R_NOMEMORY);
1792 isc_task_attach(task, &res->task);
1795 res->bucket = bucket;
1797 res->action = action;
1799 res->item_out = ISC_FALSE;
1800 ISC_LIST_INIT(res->items);
1801 ISC_LINK_INIT(res, link);
1802 res->magic = RESPONSE_MAGIC;
1803 ISC_LIST_APPEND(qid->qid_table[bucket], res, link);
1806 request_log(disp, res, LVL(90),
1807 "attached to task %p", res->task);
1809 if (((disp->attributes & DNS_DISPATCHATTR_UDP) != 0) ||
1810 ((disp->attributes & DNS_DISPATCHATTR_CONNECTED) != 0))
1813 UNLOCK(&disp->lock);
1818 return (ISC_R_SUCCESS);
1822 dns_dispatch_starttcp(dns_dispatch_t *disp) {
1824 REQUIRE(VALID_DISPATCH(disp));
1826 dispatch_log(disp, LVL(90), "starttcp %p", disp->task);
1829 disp->attributes |= DNS_DISPATCHATTR_CONNECTED;
1831 UNLOCK(&disp->lock);
1835 dns_dispatch_removeresponse(dns_dispentry_t **resp,
1836 dns_dispatchevent_t **sockevent)
1838 dns_dispatchmgr_t *mgr;
1839 dns_dispatch_t *disp;
1840 dns_dispentry_t *res;
1841 dns_dispatchevent_t *ev;
1842 unsigned int bucket;
1843 isc_boolean_t killit;
1845 isc_eventlist_t events;
1848 REQUIRE(resp != NULL);
1849 REQUIRE(VALID_RESPONSE(*resp));
1855 REQUIRE(VALID_DISPATCH(disp));
1857 REQUIRE(VALID_DISPATCHMGR(mgr));
1859 qid = DNS_QID(disp);
1861 if (sockevent != NULL) {
1862 REQUIRE(*sockevent != NULL);
1871 INSIST(disp->requests > 0);
1873 INSIST(disp->refcount > 0);
1876 if (disp->refcount == 0) {
1877 if (disp->recv_pending > 0)
1878 isc_socket_cancel(disp->socket, disp->task,
1879 ISC_SOCKCANCEL_RECV);
1880 disp->shutting_down = 1;
1883 bucket = res->bucket;
1886 ISC_LIST_UNLINK(qid->qid_table[bucket], res, link);
1889 if (ev == NULL && res->item_out) {
1891 * We've posted our event, but the caller hasn't gotten it
1892 * yet. Take it back.
1894 ISC_LIST_INIT(events);
1895 n = isc_task_unsend(res->task, res, DNS_EVENT_DISPATCH,
1898 * We had better have gotten it back.
1901 ev = (dns_dispatchevent_t *)ISC_LIST_HEAD(events);
1905 REQUIRE(res->item_out == ISC_TRUE);
1906 res->item_out = ISC_FALSE;
1907 if (ev->buffer.base != NULL)
1908 free_buffer(disp, ev->buffer.base, ev->buffer.length);
1909 free_event(disp, ev);
1912 request_log(disp, res, LVL(90), "detaching from task %p", res->task);
1913 isc_task_detach(&res->task);
1916 * Free any buffered requests as well
1918 ev = ISC_LIST_HEAD(res->items);
1919 while (ev != NULL) {
1920 ISC_LIST_UNLINK(res->items, ev, ev_link);
1921 if (ev->buffer.base != NULL)
1922 free_buffer(disp, ev->buffer.base, ev->buffer.length);
1923 free_event(disp, ev);
1924 ev = ISC_LIST_HEAD(res->items);
1927 isc_mempool_put(disp->mgr->rpool, res);
1928 if (disp->shutting_down == 1)
1933 killit = destroy_disp_ok(disp);
1934 UNLOCK(&disp->lock);
1936 isc_task_send(disp->task, &disp->ctlevent);
1940 do_cancel(dns_dispatch_t *disp) {
1941 dns_dispatchevent_t *ev;
1942 dns_dispentry_t *resp;
1945 if (disp->shutdown_out == 1)
1948 qid = DNS_QID(disp);
1951 * Search for the first response handler without packets outstanding.
1954 for (resp = linear_first(qid);
1955 resp != NULL && resp->item_out != ISC_FALSE;
1957 resp = linear_next(qid, resp);
1959 * No one to send the cancel event to, so nothing to do.
1965 * Send the shutdown failsafe event to this resp.
1967 ev = disp->failsafe_ev;
1968 ISC_EVENT_INIT(ev, sizeof (*ev), 0, NULL, DNS_EVENT_DISPATCH,
1969 resp->action, resp->arg, resp, NULL, NULL);
1970 ev->result = disp->shutdown_why;
1971 ev->buffer.base = NULL;
1972 ev->buffer.length = 0;
1973 disp->shutdown_out = 1;
1974 request_log(disp, resp, LVL(10),
1975 "cancel: failsafe event %p -> task %p",
1977 resp->item_out = ISC_TRUE;
1978 isc_task_send(resp->task, ISC_EVENT_PTR(&ev));
1984 dns_dispatch_getsocket(dns_dispatch_t *disp) {
1985 REQUIRE(VALID_DISPATCH(disp));
1987 return (disp->socket);
1991 dns_dispatch_getlocaladdress(dns_dispatch_t *disp, isc_sockaddr_t *addrp) {
1993 REQUIRE(VALID_DISPATCH(disp));
1994 REQUIRE(addrp != NULL);
1996 if (disp->socktype == isc_sockettype_udp) {
1997 *addrp = disp->local;
1998 return (ISC_R_SUCCESS);
2000 return (ISC_R_NOTIMPLEMENTED);
2004 dns_dispatch_cancel(dns_dispatch_t *disp) {
2005 REQUIRE(VALID_DISPATCH(disp));
2009 if (disp->shutting_down == 1) {
2010 UNLOCK(&disp->lock);
2014 disp->shutdown_why = ISC_R_CANCELED;
2015 disp->shutting_down = 1;
2018 UNLOCK(&disp->lock);
2024 dns_dispatch_changeattributes(dns_dispatch_t *disp,
2025 unsigned int attributes, unsigned int mask)
2027 REQUIRE(VALID_DISPATCH(disp));
2030 * Should check for valid attributes here!
2035 if ((mask & DNS_DISPATCHATTR_NOLISTEN) != 0) {
2036 if ((disp->attributes & DNS_DISPATCHATTR_NOLISTEN) != 0 &&
2037 (attributes & DNS_DISPATCHATTR_NOLISTEN) == 0) {
2038 disp->attributes &= ~DNS_DISPATCHATTR_NOLISTEN;
2040 } else if ((disp->attributes & DNS_DISPATCHATTR_NOLISTEN)
2042 (attributes & DNS_DISPATCHATTR_NOLISTEN) != 0) {
2043 disp->attributes |= DNS_DISPATCHATTR_NOLISTEN;
2044 if (disp->recv_pending != 0)
2045 isc_socket_cancel(disp->socket, disp->task,
2046 ISC_SOCKCANCEL_RECV);
2050 disp->attributes &= ~mask;
2051 disp->attributes |= (attributes & mask);
2052 UNLOCK(&disp->lock);
2056 dns_dispatch_importrecv(dns_dispatch_t *disp, isc_event_t *event) {
2058 isc_socketevent_t *sevent, *newsevent;
2060 REQUIRE(VALID_DISPATCH(disp));
2061 REQUIRE((disp->attributes & DNS_DISPATCHATTR_NOLISTEN) != 0);
2062 REQUIRE(event != NULL);
2064 sevent = (isc_socketevent_t *)event;
2066 INSIST(sevent->n <= disp->mgr->buffersize);
2067 newsevent = (isc_socketevent_t *)
2068 isc_event_allocate(disp->mgr->mctx, NULL,
2069 DNS_EVENT_IMPORTRECVDONE, udp_recv,
2070 disp, sizeof(isc_socketevent_t));
2071 if (newsevent == NULL)
2074 buf = allocate_udp_buffer(disp);
2076 isc_event_free(ISC_EVENT_PTR(&newsevent));
2079 memcpy(buf, sevent->region.base, sevent->n);
2080 newsevent->region.base = buf;
2081 newsevent->region.length = disp->mgr->buffersize;
2082 newsevent->n = sevent->n;
2083 newsevent->result = sevent->result;
2084 newsevent->address = sevent->address;
2085 newsevent->timestamp = sevent->timestamp;
2086 newsevent->pktinfo = sevent->pktinfo;
2087 newsevent->attributes = sevent->attributes;
2089 isc_task_send(disp->task, ISC_EVENT_PTR(&newsevent));
2094 dns_dispatchmgr_dump(dns_dispatchmgr_t *mgr) {
2095 dns_dispatch_t *disp;
2098 disp = ISC_LIST_HEAD(mgr->list);
2099 while (disp != NULL) {
2100 isc_sockaddr_format(&disp->local, foo, sizeof foo);
2101 printf("\tdispatch %p, addr %s\n", disp, foo);
2102 disp = ISC_LIST_NEXT(disp, link);