3 * - overall query management (allocation, completion)
4 * - per-query memory management
5 * - query submission and cancellation (user-visible and internal)
8 * This file is part of adns, which is
9 * Copyright (C) 1997-2000,2003,2006,2014 Ian Jackson
10 * Copyright (C) 2014 Mark Wooding
11 * Copyright (C) 1999-2000,2003,2006 Tony Finch
12 * Copyright (C) 1991 Massachusetts Institute of Technology
13 * (See the file INSTALL for full details.)
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 3, or (at your option)
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software Foundation.
39 static adns_query
query_alloc(adns_state ads
,
40 const typeinfo
*typei
, adns_rrtype type
,
41 adns_queryflags flags
, struct timeval now
) {
42 /* Allocate a virgin query and return it. */
45 qu
= malloc(sizeof(*qu
)); if (!qu
) return 0;
46 qu
->answer
= malloc(sizeof(*qu
->answer
));
47 if (!qu
->answer
) { free(qu
); return 0; }
50 qu
->state
= query_tosend
;
51 qu
->back
= qu
->next
= qu
->parent
= 0;
52 LIST_INIT(qu
->children
);
53 LINK_INIT(qu
->siblings
);
54 LIST_INIT(qu
->allocations
);
55 qu
->interim_allocd
= 0;
56 qu
->preserved_allocd
= 0;
57 qu
->final_allocspace
= 0;
62 adns__vbuf_init(&qu
->vb
);
65 qu
->cname_dglen
= qu
->cname_begin
= 0;
67 adns__vbuf_init(&qu
->search_vb
);
68 qu
->search_origlen
= qu
->search_pos
= qu
->search_doneabs
= 0;
70 qu
->id
= -2; /* will be overwritten with real id before we leave adns */
75 timerclear(&qu
->timeout
);
76 qu
->expires
= now
.tv_sec
+ MAXTTLBELIEVE
;
78 memset(&qu
->ctx
,0,sizeof(qu
->ctx
));
80 qu
->answer
->status
= adns_s_ok
;
81 qu
->answer
->cname
= qu
->answer
->owner
= 0;
82 qu
->answer
->type
= type
;
83 qu
->answer
->expires
= -1;
85 qu
->answer
->rrs
.untyped
= 0;
86 qu
->answer
->rrsz
= typei
->getrrsz(typei
,type
);
91 static void query_submit(adns_state ads
, adns_query qu
,
92 const typeinfo
*typei
, vbuf
*qumsg_vb
, int id
,
93 adns_queryflags flags
, struct timeval now
) {
94 /* Fills in the query message in for a previously-allocated query,
95 * and submits it. Cannot fail. Takes over the memory for qumsg_vb.
99 adns__vbuf_init(qumsg_vb
);
101 qu
->query_dgram
= malloc(qu
->vb
.used
);
102 if (!qu
->query_dgram
) { adns__query_fail(qu
,adns_s_nomemory
); return; }
105 qu
->query_dglen
= qu
->vb
.used
;
106 memcpy(qu
->query_dgram
,qu
->vb
.buf
,qu
->vb
.used
);
108 typei
->query_send(qu
,now
);
111 adns_status
adns__ckl_hostname(adns_state ads
, adns_queryflags flags
,
112 union checklabel_state
*cls
,
113 qcontext
*ctx
, int labnum
,
114 const char *dgram
, int labstart
, int lablen
)
117 const char *label
= dgram
+labstart
;
119 if (flags
& adns_qf_quoteok_query
) return adns_s_ok
;
120 for (i
=0; i
<lablen
; i
++) {
123 if (!i
) return adns_s_querydomaininvalid
;
124 } else if (!ctype_alpha(c
) && !ctype_digit(c
)) {
125 return adns_s_querydomaininvalid
;
131 static adns_status
check_domain_name(adns_state ads
, adns_queryflags flags
,
132 qcontext
*ctx
, const typeinfo
*typei
,
133 const byte
*dgram
, int dglen
)
137 int labnum
= 0, labstart
, lablen
;
138 union checklabel_state cls
;
140 adns__findlabel_start(&fls
,ads
, -1,0, dgram
,dglen
,dglen
, DNS_HDRSIZE
,0);
142 st
= adns__findlabel_next(&fls
, &lablen
,&labstart
);
143 assert(!st
); assert(lablen
>= 0);
144 st
= typei
->checklabel(ads
,flags
, &cls
,ctx
,
145 labnum
++, dgram
,labstart
,lablen
);
151 adns_status
adns__internal_submit(adns_state ads
, adns_query
*query_r
,
153 const typeinfo
*typei
, adns_rrtype type
,
154 vbuf
*qumsg_vb
, int id
,
155 adns_queryflags flags
, struct timeval now
,
160 st
= check_domain_name(ads
, flags
,ctx
,typei
, qumsg_vb
->buf
,qumsg_vb
->used
);
162 qu
= query_alloc(ads
,typei
,type
,flags
,now
);
163 if (!qu
) { st
= adns_s_nomemory
; goto x_err
; }
167 LIST_LINK_TAIL_PART(parent
->children
,qu
,siblings
.);
168 memcpy(&qu
->ctx
,ctx
,sizeof(qu
->ctx
));
169 query_submit(ads
,qu
, typei
,qumsg_vb
,id
,flags
,now
);
174 adns__vbuf_free(qumsg_vb
);
178 static void query_simple(adns_state ads
, adns_query qu
,
179 const char *owner
, int ol
,
180 const typeinfo
*typei
, adns_queryflags flags
,
181 struct timeval now
) {
186 st
= adns__mkquery(ads
,&qu
->vb
,&id
, owner
,ol
,
187 typei
,qu
->answer
->type
, flags
);
189 if (st
== adns_s_querydomaintoolong
&& (flags
& adns_qf_search
)) {
190 adns__search_next(ads
,qu
,now
);
193 adns__query_fail(qu
,st
);
198 st
= check_domain_name(ads
, flags
,&qu
->ctx
,typei
, qu
->vb
.buf
,qu
->vb
.used
);
199 if (st
) { adns__query_fail(qu
,st
); return; }
202 adns__vbuf_init(&qu
->vb
);
203 query_submit(ads
,qu
, typei
,&vb_new
,id
, flags
,now
);
206 void adns__search_next(adns_state ads
, adns_query qu
, struct timeval now
) {
207 const char *nextentry
;
210 if (qu
->search_doneabs
<0) {
212 qu
->search_doneabs
= 1;
214 if (qu
->search_pos
>= ads
->nsearchlist
) {
215 if (qu
->search_doneabs
) {
216 qu
->search_vb
.used
= qu
->search_origlen
;
217 st
= adns_s_nxdomain
; goto x_fail
;
220 qu
->search_doneabs
= 1;
223 nextentry
= ads
->searchlist
[qu
->search_pos
++];
227 qu
->search_vb
.used
= qu
->search_origlen
;
229 if (!adns__vbuf_append(&qu
->search_vb
,".",1) ||
230 !adns__vbuf_appendstr(&qu
->search_vb
,nextentry
))
234 free(qu
->query_dgram
);
235 qu
->query_dgram
= 0; qu
->query_dglen
= 0;
237 query_simple(ads
,qu
, qu
->search_vb
.buf
, qu
->search_vb
.used
,
238 qu
->typei
, qu
->flags
, now
);
244 adns__query_fail(qu
,st
);
247 static int save_owner(adns_query qu
, const char *owner
, int ol
) {
248 /* Returns 1 if OK, otherwise there was no memory. */
251 if (!(qu
->flags
& adns_qf_owner
)) return 1;
256 ans
->owner
= adns__alloc_preserved(qu
,ol
+1); if (!ans
->owner
) return 0;
258 memcpy(ans
->owner
,owner
,ol
);
263 int adns_submit(adns_state ads
,
266 adns_queryflags flags
,
268 adns_query
*query_r
) {
271 const typeinfo
*typei
;
276 adns__consistency(ads
,0,cc_entex
);
278 if (flags
& ~(adns_queryflags
)0x4009ffff)
279 /* 0x40080000 are reserved for `harmless' future expansion
280 * 0x00000020 used to be adns_qf_quoteok_cname, now the default;
281 * see also addrfam.c:textaddr_check_qf */
284 typei
= adns__findtype(type
);
285 if (!typei
) return ENOSYS
;
287 r
= gettimeofday(&now
,0); if (r
) goto x_errno
;
288 qu
= query_alloc(ads
,typei
,type
,flags
,now
); if (!qu
) goto x_errno
;
290 qu
->ctx
.ext
= context
;
292 memset(&qu
->ctx
.pinfo
,0,sizeof(qu
->ctx
.pinfo
));
293 memset(&qu
->ctx
.tinfo
,0,sizeof(qu
->ctx
.tinfo
));
298 if (!ol
) { st
= adns_s_querydomaininvalid
; goto x_adnsfail
; }
299 if (ol
>DNS_MAXDOMAIN
+1) { st
= adns_s_querydomaintoolong
; goto x_adnsfail
; }
301 if (ol
>=1 && owner
[ol
-1]=='.' && (ol
<2 || owner
[ol
-2]!='\\')) {
302 flags
&= ~adns_qf_search
;
307 if (flags
& adns_qf_search
) {
308 r
= adns__vbuf_append(&qu
->search_vb
,owner
,ol
);
309 if (!r
) { st
= adns_s_nomemory
; goto x_adnsfail
; }
311 for (ndots
=0, p
=owner
; (p
= strchr(p
,'.')); p
++, ndots
++);
312 qu
->search_doneabs
= (ndots
>= ads
->searchndots
) ?
-1 : 0;
313 qu
->search_origlen
= ol
;
314 adns__search_next(ads
,qu
,now
);
316 if (flags
& adns_qf_owner
) {
317 if (!save_owner(qu
,owner
,ol
)) { st
= adns_s_nomemory
; goto x_adnsfail
; }
319 query_simple(ads
,qu
, owner
,ol
, typei
,flags
, now
);
321 adns__autosys(ads
,now
);
322 adns__returning(ads
,qu
);
326 adns__query_fail(qu
,st
);
327 adns__returning(ads
,qu
);
333 adns__returning(ads
,0);
337 int adns_submit_reverse_any(adns_state ads
,
338 const struct sockaddr
*addr
,
341 adns_queryflags flags
,
343 adns_query
*query_r
) {
344 char *buf
, *buf_free
= 0;
348 flags
&= ~adns_qf_search
;
351 r
= adns__make_reverse_domain(addr
,zone
, &buf
,sizeof(shortbuf
),&buf_free
);
353 r
= adns_submit(ads
,buf
,type
,flags
,context
,query_r
);
358 int adns_submit_reverse(adns_state ads
,
359 const struct sockaddr
*addr
,
361 adns_queryflags flags
,
363 adns_query
*query_r
) {
364 if (((type
^adns_r_ptr
) & adns_rrt_reprmask
) &&
365 ((type
^adns_r_ptr_raw
) & adns_rrt_reprmask
))
367 return adns_submit_reverse_any(ads
,addr
,0,type
,flags
,context
,query_r
);
370 int adns_synchronous(adns_state ads
,
373 adns_queryflags flags
,
374 adns_answer
**answer_r
) {
378 r
= adns_submit(ads
,owner
,type
,flags
,0,&qu
);
381 r
= adns_wait(ads
,&qu
,answer_r
,0);
382 if (r
) adns_cancel(qu
);
387 static void *alloc_common(adns_query qu
, size_t sz
) {
390 if (!sz
) return qu
; /* Any old pointer will do */
391 assert(!qu
->final_allocspace
);
392 an
= malloc(MEM_ROUND(MEM_ROUND(sizeof(*an
)) + sz
));
394 LIST_LINK_TAIL(qu
->allocations
,an
);
396 return (byte
*)an
+ MEM_ROUND(sizeof(*an
));
399 void *adns__alloc_interim(adns_query qu
, size_t sz
) {
403 rv
= alloc_common(qu
,sz
);
405 qu
->interim_allocd
+= sz
;
409 void *adns__alloc_preserved(adns_query qu
, size_t sz
) {
413 rv
= adns__alloc_interim(qu
,sz
);
415 qu
->preserved_allocd
+= sz
;
419 static allocnode
*alloc__info(adns_query qu
, void *p
, size_t *sz_r
) {
422 if (!p
|| p
== qu
) { *sz_r
= 0; return 0; }
423 an
= (allocnode
*)((byte
*)p
- MEM_ROUND(sizeof(allocnode
)));
424 *sz_r
= MEM_ROUND(an
->sz
);
428 void adns__free_interim(adns_query qu
, void *p
) {
430 allocnode
*an
= alloc__info(qu
, p
, &sz
);
433 assert(!qu
->final_allocspace
);
434 LIST_UNLINK(qu
->allocations
, an
);
436 qu
->interim_allocd
-= sz
;
437 assert(!qu
->interim_allocd
>= 0);
440 void *adns__alloc_mine(adns_query qu
, size_t sz
) {
441 return alloc_common(qu
,MEM_ROUND(sz
));
444 void adns__transfer_interim(adns_query from
, adns_query to
, void *block
) {
446 allocnode
*an
= alloc__info(from
, block
, &sz
);
450 assert(!to
->final_allocspace
);
451 assert(!from
->final_allocspace
);
453 LIST_UNLINK(from
->allocations
,an
);
454 LIST_LINK_TAIL(to
->allocations
,an
);
456 from
->interim_allocd
-= sz
;
457 to
->interim_allocd
+= sz
;
459 if (to
->expires
> from
->expires
) to
->expires
= from
->expires
;
462 void *adns__alloc_final(adns_query qu
, size_t sz
) {
463 /* When we're in the _final stage, we _subtract_ from interim_alloc'd
464 * each allocation, and use final_allocspace to point to the next free
470 rp
= qu
->final_allocspace
;
472 qu
->interim_allocd
-= sz
;
473 assert(qu
->interim_allocd
>=0);
474 qu
->final_allocspace
= (byte
*)rp
+ sz
;
478 void adns__cancel_children(adns_query qu
) {
479 adns_query cqu
, ncqu
;
481 for (cqu
= qu
->children
.head
; cqu
; cqu
= ncqu
) {
482 ncqu
= cqu
->siblings
.next
;
487 void adns__reset_preserved(adns_query qu
) {
488 assert(!qu
->final_allocspace
);
489 adns__cancel_children(qu
);
491 qu
->answer
->rrs
.untyped
= 0;
492 qu
->interim_allocd
= qu
->preserved_allocd
;
495 static void free_query_allocs(adns_query qu
) {
498 adns__cancel_children(qu
);
499 for (an
= qu
->allocations
.head
; an
; an
= ann
) { ann
= an
->next
; free(an
); }
500 LIST_INIT(qu
->allocations
);
501 adns__vbuf_free(&qu
->vb
);
502 adns__vbuf_free(&qu
->search_vb
);
503 free(qu
->query_dgram
);
507 void adns__returning(adns_state ads
, adns_query qu_for_caller
) {
508 while (ads
->intdone
.head
) {
509 adns_query iq
= ads
->intdone
.head
;
510 adns_query parent
= iq
->parent
;
511 LIST_UNLINK_PART(parent
->children
,iq
,siblings
.);
512 LIST_UNLINK(iq
->ads
->childw
,parent
);
513 LIST_UNLINK(ads
->intdone
,iq
);
514 iq
->ctx
.callback(parent
,iq
);
515 free_query_allocs(iq
);
519 adns__consistency(ads
,qu_for_caller
,cc_entex
);
522 void adns__cancel(adns_query qu
) {
526 adns__consistency(ads
,qu
,cc_freq
);
527 if (qu
->parent
) LIST_UNLINK_PART(qu
->parent
->children
,qu
,siblings
.);
530 LIST_UNLINK(ads
->udpw
,qu
);
533 LIST_UNLINK(ads
->tcpw
,qu
);
536 LIST_UNLINK(ads
->childw
,qu
);
540 LIST_UNLINK(ads
->intdone
,qu
);
542 LIST_UNLINK(ads
->output
,qu
);
547 free_query_allocs(qu
);
552 void adns_cancel(adns_query qu
) {
557 adns__consistency(ads
,qu
,cc_entex
);
559 adns__returning(ads
,0);
562 void adns__update_expires(adns_query qu
, unsigned long ttl
,
563 struct timeval now
) {
566 assert(ttl
<= MAXTTLBELIEVE
);
567 max
= now
.tv_sec
+ ttl
;
568 if (qu
->expires
< max
) return;
572 static void makefinal_query(adns_query qu
) {
578 if (qu
->interim_allocd
) {
579 ans
= realloc(qu
->answer
,
580 MEM_ROUND(MEM_ROUND(sizeof(*ans
)) + qu
->interim_allocd
));
581 if (!ans
) goto x_nomem
;
585 qu
->final_allocspace
= (byte
*)ans
+ MEM_ROUND(sizeof(*ans
));
586 adns__makefinal_str(qu
,&ans
->cname
);
587 adns__makefinal_str(qu
,&ans
->owner
);
590 adns__makefinal_block(qu
, &ans
->rrs
.untyped
, ans
->nrrs
*ans
->rrsz
);
592 for (rrn
=0; rrn
<ans
->nrrs
; rrn
++)
593 qu
->typei
->makefinal(qu
, ans
->rrs
.bytes
+ rrn
*ans
->rrsz
);
596 free_query_allocs(qu
);
600 qu
->preserved_allocd
= 0;
601 qu
->answer
->cname
= 0;
602 qu
->answer
->owner
= 0;
603 adns__reset_preserved(qu
); /* (but we just threw away the preserved stuff) */
605 qu
->answer
->status
= adns_s_nomemory
;
606 free_query_allocs(qu
);
609 void adns__query_done(adns_query qu
) {
610 adns_state ads
=qu
->ads
;
613 adns__cancel_children(qu
);
618 if (qu
->flags
& adns_qf_search
&& ans
->status
!= adns_s_nomemory
) {
619 if (!save_owner(qu
, qu
->search_vb
.buf
, qu
->search_vb
.used
)) {
620 adns__query_fail(qu
,adns_s_nomemory
);
625 if (ans
->nrrs
&& qu
->typei
->diff_needswap
) {
626 if (!adns__vbuf_ensure(&qu
->vb
,qu
->answer
->rrsz
)) {
627 adns__query_fail(qu
,adns_s_nomemory
);
630 adns__isort(ans
->rrs
.bytes
, ans
->nrrs
, ans
->rrsz
,
632 (int(*)(void*, const void*, const void*))
633 qu
->typei
->diff_needswap
,
636 if (ans
->nrrs
&& qu
->typei
->postsort
) {
637 qu
->typei
->postsort(qu
->ads
, ans
->rrs
.bytes
,
638 ans
->nrrs
,ans
->rrsz
, qu
->typei
);
641 ans
->expires
= qu
->expires
;
642 qu
->state
= query_done
;
644 LIST_LINK_TAIL(ads
->intdone
,qu
);
647 LIST_LINK_TAIL(qu
->ads
->output
,qu
);
651 void adns__query_fail(adns_query qu
, adns_status st
) {
652 adns__reset_preserved(qu
);
653 qu
->answer
->status
= st
;
654 adns__query_done(qu
);
657 void adns__makefinal_str(adns_query qu
, char **strp
) {
659 char *before
, *after
;
664 after
= adns__alloc_final(qu
,l
);
665 memcpy(after
,before
,l
);
669 void adns__makefinal_block(adns_query qu
, void **blpp
, size_t sz
) {
670 void *before
, *after
;
674 after
= adns__alloc_final(qu
,sz
);
675 memcpy(after
,before
,sz
);