Licensing: Add copyright for Mark Wooding
[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,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.)
14 *
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)
18 * any later version.
19 *
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.
24 *
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.
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 *dgram, int labstart, int lablen)
115 {
116 int i, c;
117 const char *label = dgram+labstart;
118
119 if (flags & adns_qf_quoteok_query) return adns_s_ok;
120 for (i=0; i<lablen; i++) {
121 c= label[i];
122 if (c == '-') {
123 if (!i) return adns_s_querydomaininvalid;
124 } else if (!ctype_alpha(c) && !ctype_digit(c)) {
125 return adns_s_querydomaininvalid;
126 }
127 }
128 return adns_s_ok;
129 }
130
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)
134 {
135 findlabel_state fls;
136 adns_status st;
137 int labnum= 0, labstart, lablen;
138 union checklabel_state cls;
139
140 adns__findlabel_start(&fls,ads, -1,0, dgram,dglen,dglen, DNS_HDRSIZE,0);
141 do {
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);
146 if (st) return st;
147 } while (lablen);
148 return adns_s_ok;
149 }
150
151 adns_status adns__internal_submit(adns_state ads, adns_query *query_r,
152 adns_query parent,
153 const typeinfo *typei, adns_rrtype type,
154 vbuf *qumsg_vb, int id,
155 adns_queryflags flags, struct timeval now,
156 qcontext *ctx) {
157 adns_query qu;
158 adns_status st;
159
160 st= check_domain_name(ads, flags,ctx,typei, qumsg_vb->buf,qumsg_vb->used);
161 if (st) goto x_err;
162 qu= query_alloc(ads,typei,type,flags,now);
163 if (!qu) { st = adns_s_nomemory; goto x_err; }
164 *query_r= qu;
165
166 qu->parent= parent;
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);
170
171 return adns_s_ok;
172
173 x_err:
174 adns__vbuf_free(qumsg_vb);
175 return st;
176 }
177
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) {
182 vbuf vb_new;
183 int id;
184 adns_status st;
185
186 st= adns__mkquery(ads,&qu->vb,&id, owner,ol,
187 typei,qu->answer->type, flags);
188 if (st) {
189 if (st == adns_s_querydomaintoolong && (flags & adns_qf_search)) {
190 adns__search_next(ads,qu,now);
191 return;
192 } else {
193 adns__query_fail(qu,st);
194 return;
195 }
196 }
197
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; }
200
201 vb_new= qu->vb;
202 adns__vbuf_init(&qu->vb);
203 query_submit(ads,qu, typei,&vb_new,id, flags,now);
204 }
205
206 void adns__search_next(adns_state ads, adns_query qu, struct timeval now) {
207 const char *nextentry;
208 adns_status st;
209
210 if (qu->search_doneabs<0) {
211 nextentry= 0;
212 qu->search_doneabs= 1;
213 } else {
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;
218 } else {
219 nextentry= 0;
220 qu->search_doneabs= 1;
221 }
222 } else {
223 nextentry= ads->searchlist[qu->search_pos++];
224 }
225 }
226
227 qu->search_vb.used= qu->search_origlen;
228 if (nextentry) {
229 if (!adns__vbuf_append(&qu->search_vb,".",1) ||
230 !adns__vbuf_appendstr(&qu->search_vb,nextentry))
231 goto x_nomemory;
232 }
233
234 free(qu->query_dgram);
235 qu->query_dgram= 0; qu->query_dglen= 0;
236
237 query_simple(ads,qu, qu->search_vb.buf, qu->search_vb.used,
238 qu->typei, qu->flags, now);
239 return;
240
241 x_nomemory:
242 st= adns_s_nomemory;
243 x_fail:
244 adns__query_fail(qu,st);
245 }
246
247 static int save_owner(adns_query qu, const char *owner, int ol) {
248 /* Returns 1 if OK, otherwise there was no memory. */
249 adns_answer *ans;
250
251 if (!(qu->flags & adns_qf_owner)) return 1;
252
253 ans= qu->answer;
254 assert(!ans->owner);
255
256 ans->owner= adns__alloc_preserved(qu,ol+1); if (!ans->owner) return 0;
257
258 memcpy(ans->owner,owner,ol);
259 ans->owner[ol]= 0;
260 return 1;
261 }
262
263 int adns_submit(adns_state ads,
264 const char *owner,
265 adns_rrtype type,
266 adns_queryflags flags,
267 void *context,
268 adns_query *query_r) {
269 int r, ol, ndots;
270 adns_status st;
271 const typeinfo *typei;
272 struct timeval now;
273 adns_query qu;
274 const char *p;
275
276 adns__consistency(ads,0,cc_entex);
277
278 typei= adns__findtype(type);
279 if (!typei) return ENOSYS;
280
281 r= gettimeofday(&now,0); if (r) goto x_errno;
282 qu= query_alloc(ads,typei,type,flags,now); if (!qu) goto x_errno;
283
284 qu->ctx.ext= context;
285 qu->ctx.callback= 0;
286 memset(&qu->ctx.pinfo,0,sizeof(qu->ctx.pinfo));
287 memset(&qu->ctx.tinfo,0,sizeof(qu->ctx.tinfo));
288
289 *query_r= qu;
290
291 ol= strlen(owner);
292 if (!ol) { st= adns_s_querydomaininvalid; goto x_adnsfail; }
293 if (ol>DNS_MAXDOMAIN+1) { st= adns_s_querydomaintoolong; goto x_adnsfail; }
294
295 if (ol>=1 && owner[ol-1]=='.' && (ol<2 || owner[ol-2]!='\\')) {
296 flags &= ~adns_qf_search;
297 qu->flags= flags;
298 ol--;
299 }
300
301 if (flags & adns_qf_search) {
302 r= adns__vbuf_append(&qu->search_vb,owner,ol);
303 if (!r) { st= adns_s_nomemory; goto x_adnsfail; }
304
305 for (ndots=0, p=owner; (p= strchr(p,'.')); p++, ndots++);
306 qu->search_doneabs= (ndots >= ads->searchndots) ? -1 : 0;
307 qu->search_origlen= ol;
308 adns__search_next(ads,qu,now);
309 } else {
310 if (flags & adns_qf_owner) {
311 if (!save_owner(qu,owner,ol)) { st= adns_s_nomemory; goto x_adnsfail; }
312 }
313 query_simple(ads,qu, owner,ol, typei,flags, now);
314 }
315 adns__autosys(ads,now);
316 adns__returning(ads,qu);
317 return 0;
318
319 x_adnsfail:
320 adns__query_fail(qu,st);
321 adns__returning(ads,qu);
322 return 0;
323
324 x_errno:
325 r= errno;
326 assert(r);
327 adns__returning(ads,0);
328 return r;
329 }
330
331 int adns_submit_reverse_any(adns_state ads,
332 const struct sockaddr *addr,
333 const char *zone,
334 adns_rrtype type,
335 adns_queryflags flags,
336 void *context,
337 adns_query *query_r) {
338 char *buf, *buf_free = 0;
339 char shortbuf[100];
340 int r;
341
342 flags &= ~adns_qf_search;
343
344 buf = shortbuf;
345 r= adns__make_reverse_domain(addr,zone, &buf,sizeof(shortbuf),&buf_free);
346 if (r) return r;
347 r= adns_submit(ads,buf,type,flags,context,query_r);
348 free(buf_free);
349 return r;
350 }
351
352 int adns_submit_reverse(adns_state ads,
353 const struct sockaddr *addr,
354 adns_rrtype type,
355 adns_queryflags flags,
356 void *context,
357 adns_query *query_r) {
358 if (((type^adns_r_ptr) & adns_rrt_reprmask) &&
359 ((type^adns_r_ptr_raw) & adns_rrt_reprmask))
360 return EINVAL;
361 return adns_submit_reverse_any(ads,addr,0,type,flags,context,query_r);
362 }
363
364 int adns_synchronous(adns_state ads,
365 const char *owner,
366 adns_rrtype type,
367 adns_queryflags flags,
368 adns_answer **answer_r) {
369 adns_query qu;
370 int r;
371
372 r= adns_submit(ads,owner,type,flags,0,&qu);
373 if (r) return r;
374
375 r= adns_wait(ads,&qu,answer_r,0);
376 if (r) adns_cancel(qu);
377
378 return r;
379 }
380
381 static void *alloc_common(adns_query qu, size_t sz) {
382 allocnode *an;
383
384 if (!sz) return qu; /* Any old pointer will do */
385 assert(!qu->final_allocspace);
386 an= malloc(MEM_ROUND(MEM_ROUND(sizeof(*an)) + sz));
387 if (!an) return 0;
388 LIST_LINK_TAIL(qu->allocations,an);
389 an->sz= sz;
390 return (byte*)an + MEM_ROUND(sizeof(*an));
391 }
392
393 void *adns__alloc_interim(adns_query qu, size_t sz) {
394 void *rv;
395
396 sz= MEM_ROUND(sz);
397 rv= alloc_common(qu,sz);
398 if (!rv) return 0;
399 qu->interim_allocd += sz;
400 return rv;
401 }
402
403 void *adns__alloc_preserved(adns_query qu, size_t sz) {
404 void *rv;
405
406 sz= MEM_ROUND(sz);
407 rv= adns__alloc_interim(qu,sz);
408 if (!rv) return 0;
409 qu->preserved_allocd += sz;
410 return rv;
411 }
412
413 static allocnode *alloc__info(adns_query qu, void *p, size_t *sz_r) {
414 allocnode *an;
415
416 if (!p || p == qu) { *sz_r= 0; return 0; }
417 an= (allocnode *)((byte *)p - MEM_ROUND(sizeof(allocnode)));
418 *sz_r= MEM_ROUND(an->sz);
419 return an;
420 }
421
422 void adns__free_interim(adns_query qu, void *p) {
423 size_t sz;
424 allocnode *an= alloc__info(qu, p, &sz);
425
426 if (!an) return;
427 assert(!qu->final_allocspace);
428 LIST_UNLINK(qu->allocations, an);
429 free(an);
430 qu->interim_allocd -= sz;
431 assert(!qu->interim_allocd >= 0);
432 }
433
434 void *adns__alloc_mine(adns_query qu, size_t sz) {
435 return alloc_common(qu,MEM_ROUND(sz));
436 }
437
438 void adns__transfer_interim(adns_query from, adns_query to, void *block) {
439 size_t sz;
440 allocnode *an= alloc__info(from, block, &sz);
441
442 if (!an) return;
443
444 assert(!to->final_allocspace);
445 assert(!from->final_allocspace);
446
447 LIST_UNLINK(from->allocations,an);
448 LIST_LINK_TAIL(to->allocations,an);
449
450 from->interim_allocd -= sz;
451 to->interim_allocd += sz;
452
453 if (to->expires > from->expires) to->expires= from->expires;
454 }
455
456 void *adns__alloc_final(adns_query qu, size_t sz) {
457 /* When we're in the _final stage, we _subtract_ from interim_alloc'd
458 * each allocation, and use final_allocspace to point to the next free
459 * bit.
460 */
461 void *rp;
462
463 sz= MEM_ROUND(sz);
464 rp= qu->final_allocspace;
465 assert(rp);
466 qu->interim_allocd -= sz;
467 assert(qu->interim_allocd>=0);
468 qu->final_allocspace= (byte*)rp + sz;
469 return rp;
470 }
471
472 void adns__cancel_children(adns_query qu) {
473 adns_query cqu, ncqu;
474
475 for (cqu= qu->children.head; cqu; cqu= ncqu) {
476 ncqu= cqu->siblings.next;
477 adns__cancel(cqu);
478 }
479 }
480
481 void adns__reset_preserved(adns_query qu) {
482 assert(!qu->final_allocspace);
483 adns__cancel_children(qu);
484 qu->answer->nrrs= 0;
485 qu->answer->rrs.untyped= 0;
486 qu->interim_allocd= qu->preserved_allocd;
487 }
488
489 static void free_query_allocs(adns_query qu) {
490 allocnode *an, *ann;
491
492 adns__cancel_children(qu);
493 for (an= qu->allocations.head; an; an= ann) { ann= an->next; free(an); }
494 LIST_INIT(qu->allocations);
495 adns__vbuf_free(&qu->vb);
496 adns__vbuf_free(&qu->search_vb);
497 free(qu->query_dgram);
498 qu->query_dgram= 0;
499 }
500
501 void adns__returning(adns_state ads, adns_query qu_for_caller) {
502 while (ads->intdone.head) {
503 adns_query iq= ads->intdone.head;
504 adns_query parent= iq->parent;
505 LIST_UNLINK_PART(parent->children,iq,siblings.);
506 LIST_UNLINK(iq->ads->childw,parent);
507 LIST_UNLINK(ads->intdone,iq);
508 iq->ctx.callback(parent,iq);
509 free_query_allocs(iq);
510 free(iq->answer);
511 free(iq);
512 }
513 adns__consistency(ads,qu_for_caller,cc_entex);
514 }
515
516 void adns__cancel(adns_query qu) {
517 adns_state ads;
518
519 ads= qu->ads;
520 adns__consistency(ads,qu,cc_freq);
521 if (qu->parent) LIST_UNLINK_PART(qu->parent->children,qu,siblings.);
522 switch (qu->state) {
523 case query_tosend:
524 LIST_UNLINK(ads->udpw,qu);
525 break;
526 case query_tcpw:
527 LIST_UNLINK(ads->tcpw,qu);
528 break;
529 case query_childw:
530 LIST_UNLINK(ads->childw,qu);
531 break;
532 case query_done:
533 if (qu->parent)
534 LIST_UNLINK(ads->intdone,qu);
535 else
536 LIST_UNLINK(ads->output,qu);
537 break;
538 default:
539 abort();
540 }
541 free_query_allocs(qu);
542 free(qu->answer);
543 free(qu);
544 }
545
546 void adns_cancel(adns_query qu) {
547 adns_state ads;
548
549 assert(!qu->parent);
550 ads= qu->ads;
551 adns__consistency(ads,qu,cc_entex);
552 adns__cancel(qu);
553 adns__returning(ads,0);
554 }
555
556 void adns__update_expires(adns_query qu, unsigned long ttl,
557 struct timeval now) {
558 time_t max;
559
560 assert(ttl <= MAXTTLBELIEVE);
561 max= now.tv_sec + ttl;
562 if (qu->expires < max) return;
563 qu->expires= max;
564 }
565
566 static void makefinal_query(adns_query qu) {
567 adns_answer *ans;
568 int rrn;
569
570 ans= qu->answer;
571
572 if (qu->interim_allocd) {
573 ans= realloc(qu->answer,
574 MEM_ROUND(MEM_ROUND(sizeof(*ans)) + qu->interim_allocd));
575 if (!ans) goto x_nomem;
576 qu->answer= ans;
577 }
578
579 qu->final_allocspace= (byte*)ans + MEM_ROUND(sizeof(*ans));
580 adns__makefinal_str(qu,&ans->cname);
581 adns__makefinal_str(qu,&ans->owner);
582
583 if (ans->nrrs) {
584 adns__makefinal_block(qu, &ans->rrs.untyped, ans->nrrs*ans->rrsz);
585
586 for (rrn=0; rrn<ans->nrrs; rrn++)
587 qu->typei->makefinal(qu, ans->rrs.bytes + rrn*ans->rrsz);
588 }
589
590 free_query_allocs(qu);
591 return;
592
593 x_nomem:
594 qu->preserved_allocd= 0;
595 qu->answer->cname= 0;
596 qu->answer->owner= 0;
597 adns__reset_preserved(qu); /* (but we just threw away the preserved stuff) */
598
599 qu->answer->status= adns_s_nomemory;
600 free_query_allocs(qu);
601 }
602
603 void adns__query_done(adns_query qu) {
604 adns_state ads=qu->ads;
605 adns_answer *ans;
606
607 adns__cancel_children(qu);
608
609 qu->id= -1;
610 ans= qu->answer;
611
612 if (qu->flags & adns_qf_search && ans->status != adns_s_nomemory) {
613 if (!save_owner(qu, qu->search_vb.buf, qu->search_vb.used)) {
614 adns__query_fail(qu,adns_s_nomemory);
615 return;
616 }
617 }
618
619 if (ans->nrrs && qu->typei->diff_needswap) {
620 if (!adns__vbuf_ensure(&qu->vb,qu->answer->rrsz)) {
621 adns__query_fail(qu,adns_s_nomemory);
622 return;
623 }
624 adns__isort(ans->rrs.bytes, ans->nrrs, ans->rrsz,
625 qu->vb.buf,
626 (int(*)(void*, const void*, const void*))
627 qu->typei->diff_needswap,
628 qu->ads);
629 }
630 if (ans->nrrs && qu->typei->postsort) {
631 qu->typei->postsort(qu->ads, ans->rrs.bytes,
632 ans->nrrs,ans->rrsz, qu->typei);
633 }
634
635 ans->expires= qu->expires;
636 qu->state= query_done;
637 if (qu->parent) {
638 LIST_LINK_TAIL(ads->intdone,qu);
639 } else {
640 makefinal_query(qu);
641 LIST_LINK_TAIL(qu->ads->output,qu);
642 }
643 }
644
645 void adns__query_fail(adns_query qu, adns_status st) {
646 adns__reset_preserved(qu);
647 qu->answer->status= st;
648 adns__query_done(qu);
649 }
650
651 void adns__makefinal_str(adns_query qu, char **strp) {
652 int l;
653 char *before, *after;
654
655 before= *strp;
656 if (!before) return;
657 l= strlen(before)+1;
658 after= adns__alloc_final(qu,l);
659 memcpy(after,before,l);
660 *strp= after;
661 }
662
663 void adns__makefinal_block(adns_query qu, void **blpp, size_t sz) {
664 void *before, *after;
665
666 before= *blpp;
667 if (!before) return;
668 after= adns__alloc_final(qu,sz);
669 memcpy(after,before,sz);
670 *blpp= after;
671 }