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