Reentrancy: Avoid reentrant callbacks
[adns] / src / query.c
1 /*
2 * query.c
3 * - overall query management (allocation, completion)
4 * - per-query memory management
5 * - query submission and cancellation (user-visible and internal)
6 */
7 /*
8 * This file is part of adns, which is
9 * Copyright (C) 1997-2000,2003,2006 Ian Jackson
10 * Copyright (C) 1999-2000,2003,2006 Tony Finch
11 * Copyright (C) 1991 Massachusetts Institute of Technology
12 * (See the file INSTALL for full details.)
13 *
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
17 * any later version.
18 *
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 */
28
29 #include "internal.h"
30
31 #include <stdlib.h>
32 #include <unistd.h>
33 #include <errno.h>
34
35 #include <sys/time.h>
36
37 #include "internal.h"
38
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. */
43 adns_query qu;
44
45 qu= malloc(sizeof(*qu)); if (!qu) return 0;
46 qu->answer= malloc(sizeof(*qu->answer));
47 if (!qu->answer) { free(qu); return 0; }
48
49 qu->ads= ads;
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;
58
59 qu->typei= typei;
60 qu->query_dgram= 0;
61 qu->query_dglen= 0;
62 adns__vbuf_init(&qu->vb);
63
64 qu->cname_dgram= 0;
65 qu->cname_dglen= qu->cname_begin= 0;
66
67 adns__vbuf_init(&qu->search_vb);
68 qu->search_origlen= qu->search_pos= qu->search_doneabs= 0;
69
70 qu->id= -2; /* will be overwritten with real id before we leave adns */
71 qu->flags= flags;
72 qu->retries= 0;
73 qu->udpnextserver= 0;
74 qu->udpsent= 0;
75 timerclear(&qu->timeout);
76 qu->expires= now.tv_sec + MAXTTLBELIEVE;
77
78 memset(&qu->ctx,0,sizeof(qu->ctx));
79
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;
84 qu->answer->nrrs= 0;
85 qu->answer->rrs.untyped= 0;
86 qu->answer->rrsz= typei->getrrsz(typei,type);
87
88 return qu;
89 }
90
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.
96 */
97
98 qu->vb= *qumsg_vb;
99 adns__vbuf_init(qumsg_vb);
100
101 qu->query_dgram= malloc(qu->vb.used);
102 if (!qu->query_dgram) { adns__query_fail(qu,adns_s_nomemory); return; }
103
104 qu->id= id;
105 qu->query_dglen= qu->vb.used;
106 memcpy(qu->query_dgram,qu->vb.buf,qu->vb.used);
107
108 typei->query_send(qu,now);
109 }
110
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 *label, int lablen)
115 {
116 int i, c;
117
118 if (flags & adns_qf_quoteok_query) return adns_s_ok;
119 for (i=0; i<lablen; i++) {
120 c= label[i];
121 if (c == '-') {
122 if (!i) return adns_s_querydomaininvalid;
123 } else if (!ctype_alpha(c) && !ctype_digit(c)) {
124 return adns_s_querydomaininvalid;
125 }
126 }
127 return adns_s_ok;
128 }
129
130 static adns_status check_domain_name(adns_state ads, adns_queryflags flags,
131 qcontext *ctx, const typeinfo *typei,
132 const byte *dgram, int dglen)
133 {
134 findlabel_state fls;
135 adns_status err;
136 int labnum= 0, labstart, lablen;
137 union checklabel_state cls;
138
139 adns__findlabel_start(&fls,ads, -1,0, dgram,dglen,dglen, DNS_HDRSIZE,0);
140 do {
141 err= adns__findlabel_next(&fls, &lablen,&labstart);
142 assert(!err); assert(lablen >= 0);
143 err= typei->checklabel(ads,flags, &cls,ctx,
144 labnum++, dgram+labstart,lablen);
145 if (err) return err;
146 } while (lablen);
147 return adns_s_ok;
148 }
149
150 adns_status adns__internal_submit(adns_state ads, adns_query *query_r,
151 adns_query parent,
152 const typeinfo *typei, adns_rrtype type,
153 vbuf *qumsg_vb, int id,
154 adns_queryflags flags, struct timeval now,
155 qcontext *ctx) {
156 adns_query qu;
157 adns_status err;
158
159 err= check_domain_name(ads, flags,ctx,typei, qumsg_vb->buf,qumsg_vb->used);
160 if (err) goto x_err;
161 qu= query_alloc(ads,typei,type,flags,now);
162 if (!qu) { err = adns_s_nomemory; goto x_err; }
163 *query_r= qu;
164
165 qu->parent= parent;
166 LIST_LINK_TAIL_PART(parent->children,qu,siblings.);
167 memcpy(&qu->ctx,ctx,sizeof(qu->ctx));
168 query_submit(ads,qu, typei,qumsg_vb,id,flags,now);
169
170 return adns_s_ok;
171
172 x_err:
173 adns__vbuf_free(qumsg_vb);
174 return err;
175 }
176
177 static void query_simple(adns_state ads, adns_query qu,
178 const char *owner, int ol,
179 const typeinfo *typei, adns_queryflags flags,
180 struct timeval now) {
181 vbuf vb_new;
182 int id;
183 adns_status stat;
184
185 stat= adns__mkquery(ads,&qu->vb,&id, owner,ol,
186 typei,qu->answer->type, flags);
187 if (stat) {
188 if (stat == adns_s_querydomaintoolong && (flags & adns_qf_search)) {
189 adns__search_next(ads,qu,now);
190 return;
191 } else {
192 adns__query_fail(qu,stat);
193 return;
194 }
195 }
196
197 stat= check_domain_name(ads, flags,&qu->ctx,typei, qu->vb.buf,qu->vb.used);
198 if (stat) { adns__query_fail(qu,stat); return; }
199
200 vb_new= qu->vb;
201 adns__vbuf_init(&qu->vb);
202 query_submit(ads,qu, typei,&vb_new,id, flags,now);
203 }
204
205 void adns__search_next(adns_state ads, adns_query qu, struct timeval now) {
206 const char *nextentry;
207 adns_status stat;
208
209 if (qu->search_doneabs<0) {
210 nextentry= 0;
211 qu->search_doneabs= 1;
212 } else {
213 if (qu->search_pos >= ads->nsearchlist) {
214 if (qu->search_doneabs) {
215 qu->search_vb.used= qu->search_origlen;
216 stat= adns_s_nxdomain; goto x_fail;
217 } else {
218 nextentry= 0;
219 qu->search_doneabs= 1;
220 }
221 } else {
222 nextentry= ads->searchlist[qu->search_pos++];
223 }
224 }
225
226 qu->search_vb.used= qu->search_origlen;
227 if (nextentry) {
228 if (!adns__vbuf_append(&qu->search_vb,".",1) ||
229 !adns__vbuf_appendstr(&qu->search_vb,nextentry))
230 goto x_nomemory;
231 }
232
233 free(qu->query_dgram);
234 qu->query_dgram= 0; qu->query_dglen= 0;
235
236 query_simple(ads,qu, qu->search_vb.buf, qu->search_vb.used,
237 qu->typei, qu->flags, now);
238 return;
239
240 x_nomemory:
241 stat= adns_s_nomemory;
242 x_fail:
243 adns__query_fail(qu,stat);
244 }
245
246 static int save_owner(adns_query qu, const char *owner, int ol) {
247 /* Returns 1 if OK, otherwise there was no memory. */
248 adns_answer *ans;
249
250 if (!(qu->flags & adns_qf_owner)) return 1;
251
252 ans= qu->answer;
253 assert(!ans->owner);
254
255 ans->owner= adns__alloc_preserved(qu,ol+1); if (!ans->owner) return 0;
256
257 memcpy(ans->owner,owner,ol);
258 ans->owner[ol]= 0;
259 return 1;
260 }
261
262 int adns_submit(adns_state ads,
263 const char *owner,
264 adns_rrtype type,
265 adns_queryflags flags,
266 void *context,
267 adns_query *query_r) {
268 int r, ol, ndots;
269 adns_status stat;
270 const typeinfo *typei;
271 struct timeval now;
272 adns_query qu;
273 const char *p;
274
275 adns__consistency(ads,0,cc_entex);
276
277 typei= adns__findtype(type);
278 if (!typei) return ENOSYS;
279
280 r= gettimeofday(&now,0); if (r) goto x_errno;
281 qu= query_alloc(ads,typei,type,flags,now); if (!qu) goto x_errno;
282
283 qu->ctx.ext= context;
284 qu->ctx.callback= 0;
285 memset(&qu->ctx.pinfo,0,sizeof(qu->ctx.pinfo));
286 memset(&qu->ctx.tinfo,0,sizeof(qu->ctx.tinfo));
287
288 *query_r= qu;
289
290 ol= strlen(owner);
291 if (!ol) { stat= adns_s_querydomaininvalid; goto x_adnsfail; }
292 if (ol>DNS_MAXDOMAIN+1) { stat= adns_s_querydomaintoolong; goto x_adnsfail; }
293
294 if (ol>=1 && owner[ol-1]=='.' && (ol<2 || owner[ol-2]!='\\')) {
295 flags &= ~adns_qf_search;
296 qu->flags= flags;
297 ol--;
298 }
299
300 if (flags & adns_qf_search) {
301 r= adns__vbuf_append(&qu->search_vb,owner,ol);
302 if (!r) { stat= adns_s_nomemory; goto x_adnsfail; }
303
304 for (ndots=0, p=owner; (p= strchr(p,'.')); p++, ndots++);
305 qu->search_doneabs= (ndots >= ads->searchndots) ? -1 : 0;
306 qu->search_origlen= ol;
307 adns__search_next(ads,qu,now);
308 } else {
309 if (flags & adns_qf_owner) {
310 if (!save_owner(qu,owner,ol)) { stat= adns_s_nomemory; goto x_adnsfail; }
311 }
312 query_simple(ads,qu, owner,ol, typei,flags, now);
313 }
314 adns__autosys(ads,now);
315 adns__returning(ads,qu);
316 return 0;
317
318 x_adnsfail:
319 adns__query_fail(qu,stat);
320 adns__returning(ads,qu);
321 return 0;
322
323 x_errno:
324 r= errno;
325 assert(r);
326 adns__returning(ads,0);
327 return r;
328 }
329
330 int adns_submit_reverse_any(adns_state ads,
331 const struct sockaddr *addr,
332 const char *zone,
333 adns_rrtype type,
334 adns_queryflags flags,
335 void *context,
336 adns_query *query_r) {
337 char *buf, *buf_free = 0;
338 char shortbuf[100];
339 int r;
340
341 flags &= ~adns_qf_search;
342
343 buf = shortbuf;
344 r= adns__make_reverse_domain(addr,zone, &buf,sizeof(shortbuf),&buf_free);
345 if (r) return r;
346 r= adns_submit(ads,buf,type,flags,context,query_r);
347 free(buf_free);
348 return r;
349 }
350
351 int adns_submit_reverse(adns_state ads,
352 const struct sockaddr *addr,
353 adns_rrtype type,
354 adns_queryflags flags,
355 void *context,
356 adns_query *query_r) {
357 if (((type^adns_r_ptr) & adns_rrt_reprmask) &&
358 ((type^adns_r_ptr_raw) & adns_rrt_reprmask))
359 return EINVAL;
360 return adns_submit_reverse_any(ads,addr,0,type,flags,context,query_r);
361 }
362
363 int adns_synchronous(adns_state ads,
364 const char *owner,
365 adns_rrtype type,
366 adns_queryflags flags,
367 adns_answer **answer_r) {
368 adns_query qu;
369 int r;
370
371 r= adns_submit(ads,owner,type,flags,0,&qu);
372 if (r) return r;
373
374 r= adns_wait(ads,&qu,answer_r,0);
375 if (r) adns_cancel(qu);
376
377 return r;
378 }
379
380 static void *alloc_common(adns_query qu, size_t sz) {
381 allocnode *an;
382
383 if (!sz) return qu; /* Any old pointer will do */
384 assert(!qu->final_allocspace);
385 an= malloc(MEM_ROUND(MEM_ROUND(sizeof(*an)) + sz));
386 if (!an) return 0;
387 LIST_LINK_TAIL(qu->allocations,an);
388 an->sz= sz;
389 return (byte*)an + MEM_ROUND(sizeof(*an));
390 }
391
392 void *adns__alloc_interim(adns_query qu, size_t sz) {
393 void *rv;
394
395 sz= MEM_ROUND(sz);
396 rv= alloc_common(qu,sz);
397 if (!rv) return 0;
398 qu->interim_allocd += sz;
399 return rv;
400 }
401
402 void *adns__alloc_preserved(adns_query qu, size_t sz) {
403 void *rv;
404
405 sz= MEM_ROUND(sz);
406 rv= adns__alloc_interim(qu,sz);
407 if (!rv) return 0;
408 qu->preserved_allocd += sz;
409 return rv;
410 }
411
412 static allocnode *alloc_info(adns_query qu, void *p, size_t *sz_r) {
413 allocnode *an;
414
415 if (!p || p == qu) { *sz_r= 0; return 0; }
416 an= (allocnode *)((byte *)p - MEM_ROUND(sizeof(allocnode)));
417 *sz_r= MEM_ROUND(an->sz);
418 return an;
419 }
420
421 void adns__free_interim(adns_query qu, void *p) {
422 size_t sz;
423 allocnode *an= alloc_info(qu, p, &sz);
424
425 if (!an) return;
426 assert(!qu->final_allocspace);
427 LIST_UNLINK(qu->allocations, an);
428 free(an);
429 qu->interim_allocd -= sz;
430 }
431
432 void *adns__alloc_mine(adns_query qu, size_t sz) {
433 return alloc_common(qu,MEM_ROUND(sz));
434 }
435
436 void adns__transfer_interim(adns_query from, adns_query to, void *block) {
437 size_t sz;
438 allocnode *an= alloc_info(from, block, &sz);
439
440 if (!an) return;
441
442 assert(!to->final_allocspace);
443 assert(!from->final_allocspace);
444
445 LIST_UNLINK(from->allocations,an);
446 LIST_LINK_TAIL(to->allocations,an);
447
448 from->interim_allocd -= sz;
449 to->interim_allocd += sz;
450
451 if (to->expires > from->expires) to->expires= from->expires;
452 }
453
454 void *adns__alloc_final(adns_query qu, size_t sz) {
455 /* When we're in the _final stage, we _subtract_ from interim_alloc'd
456 * each allocation, and use final_allocspace to point to the next free
457 * bit.
458 */
459 void *rp;
460
461 sz= MEM_ROUND(sz);
462 rp= qu->final_allocspace;
463 assert(rp);
464 qu->interim_allocd -= sz;
465 assert(qu->interim_allocd>=0);
466 qu->final_allocspace= (byte*)rp + sz;
467 return rp;
468 }
469
470 void adns__cancel_children(adns_query qu) {
471 adns_query cqu, ncqu;
472
473 for (cqu= qu->children.head; cqu; cqu= ncqu) {
474 ncqu= cqu->siblings.next;
475 adns__cancel(cqu);
476 }
477 }
478
479 void adns__reset_preserved(adns_query qu) {
480 assert(!qu->final_allocspace);
481 adns__cancel_children(qu);
482 qu->answer->nrrs= 0;
483 qu->answer->rrs.untyped= 0;
484 qu->interim_allocd= qu->preserved_allocd;
485 }
486
487 static void free_query_allocs(adns_query qu) {
488 allocnode *an, *ann;
489
490 adns__cancel_children(qu);
491 for (an= qu->allocations.head; an; an= ann) { ann= an->next; free(an); }
492 LIST_INIT(qu->allocations);
493 adns__vbuf_free(&qu->vb);
494 adns__vbuf_free(&qu->search_vb);
495 free(qu->query_dgram);
496 qu->query_dgram= 0;
497 }
498
499 void adns__returning(adns_state ads, adns_query qu_for_caller) {
500 while (ads->intdone.head) {
501 adns_query iq= ads->intdone.head;
502 adns_query parent= iq->parent;
503 LIST_UNLINK_PART(parent->children,iq,siblings.);
504 LIST_UNLINK(iq->ads->childw,parent);
505 LIST_UNLINK(ads->intdone,iq);
506 iq->ctx.callback(parent,iq);
507 free_query_allocs(iq);
508 free(iq->answer);
509 free(iq);
510 }
511 adns__consistency(ads,qu_for_caller,cc_entex);
512 }
513
514 void adns__cancel(adns_query qu) {
515 adns_state ads;
516
517 ads= qu->ads;
518 adns__consistency(ads,qu,cc_freq);
519 if (qu->parent) LIST_UNLINK_PART(qu->parent->children,qu,siblings.);
520 switch (qu->state) {
521 case query_tosend:
522 LIST_UNLINK(ads->udpw,qu);
523 break;
524 case query_tcpw:
525 LIST_UNLINK(ads->tcpw,qu);
526 break;
527 case query_childw:
528 LIST_UNLINK(ads->childw,qu);
529 break;
530 case query_done:
531 if (qu->parent)
532 LIST_UNLINK(ads->intdone,qu);
533 else
534 LIST_UNLINK(ads->output,qu);
535 break;
536 default:
537 abort();
538 }
539 free_query_allocs(qu);
540 free(qu->answer);
541 free(qu);
542 }
543
544 void adns_cancel(adns_query qu) {
545 adns_state ads;
546
547 assert(!qu->parent);
548 ads= qu->ads;
549 adns__consistency(ads,qu,cc_entex);
550 adns__cancel(qu);
551 adns__returning(ads,0);
552 }
553
554 void adns__update_expires(adns_query qu, unsigned long ttl,
555 struct timeval now) {
556 time_t max;
557
558 assert(ttl <= MAXTTLBELIEVE);
559 max= now.tv_sec + ttl;
560 if (qu->expires < max) return;
561 qu->expires= max;
562 }
563
564 static void makefinal_query(adns_query qu) {
565 adns_answer *ans;
566 int rrn;
567
568 ans= qu->answer;
569
570 if (qu->interim_allocd) {
571 ans= realloc(qu->answer,
572 MEM_ROUND(MEM_ROUND(sizeof(*ans)) + qu->interim_allocd));
573 if (!ans) goto x_nomem;
574 qu->answer= ans;
575 }
576
577 qu->final_allocspace= (byte*)ans + MEM_ROUND(sizeof(*ans));
578 adns__makefinal_str(qu,&ans->cname);
579 adns__makefinal_str(qu,&ans->owner);
580
581 if (ans->nrrs) {
582 adns__makefinal_block(qu, &ans->rrs.untyped, ans->nrrs*ans->rrsz);
583
584 for (rrn=0; rrn<ans->nrrs; rrn++)
585 qu->typei->makefinal(qu, ans->rrs.bytes + rrn*ans->rrsz);
586 }
587
588 free_query_allocs(qu);
589 return;
590
591 x_nomem:
592 qu->preserved_allocd= 0;
593 qu->answer->cname= 0;
594 qu->answer->owner= 0;
595 adns__reset_preserved(qu); /* (but we just threw away the preserved stuff) */
596
597 qu->answer->status= adns_s_nomemory;
598 free_query_allocs(qu);
599 }
600
601 void adns__query_done(adns_query qu) {
602 adns_state ads=qu->ads;
603 adns_answer *ans;
604
605 adns__cancel_children(qu);
606
607 qu->id= -1;
608 ans= qu->answer;
609
610 if (qu->flags & adns_qf_search && ans->status != adns_s_nomemory) {
611 if (!save_owner(qu, qu->search_vb.buf, qu->search_vb.used)) {
612 adns__query_fail(qu,adns_s_nomemory);
613 return;
614 }
615 }
616
617 if (ans->nrrs && qu->typei->diff_needswap) {
618 if (!adns__vbuf_ensure(&qu->vb,qu->answer->rrsz)) {
619 adns__query_fail(qu,adns_s_nomemory);
620 return;
621 }
622 adns__isort(ans->rrs.bytes, ans->nrrs, ans->rrsz,
623 qu->vb.buf,
624 (int(*)(void*, const void*, const void*))
625 qu->typei->diff_needswap,
626 qu->ads);
627 }
628 if (ans->nrrs && qu->typei->postsort) {
629 qu->typei->postsort(qu->ads, ans->rrs.bytes,
630 ans->nrrs,ans->rrsz, qu->typei);
631 }
632
633 ans->expires= qu->expires;
634 qu->state= query_done;
635 if (qu->parent) {
636 LIST_LINK_TAIL(ads->intdone,qu);
637 } else {
638 makefinal_query(qu);
639 LIST_LINK_TAIL(qu->ads->output,qu);
640 }
641 }
642
643 void adns__query_fail(adns_query qu, adns_status stat) {
644 adns__reset_preserved(qu);
645 qu->answer->status= stat;
646 adns__query_done(qu);
647 }
648
649 void adns__makefinal_str(adns_query qu, char **strp) {
650 int l;
651 char *before, *after;
652
653 before= *strp;
654 if (!before) return;
655 l= strlen(before)+1;
656 after= adns__alloc_final(qu,l);
657 memcpy(after,before,l);
658 *strp= after;
659 }
660
661 void adns__makefinal_block(adns_query qu, void **blpp, size_t sz) {
662 void *before, *after;
663
664 before= *blpp;
665 if (!before) return;
666 after= adns__alloc_final(qu,sz);
667 memcpy(after,before,sz);
668 *blpp= after;
669 }