+ * bug_if_query_done feature for debugging (SHOULD BE TAKEN OUT FOR RELEASE)
[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
9 * Copyright (C) 1997-1999 Ian Jackson <ian@davenant.greenend.org.uk>
10 *
11 * It is part of adns, which is
12 * Copyright (C) 1997-1999 Ian Jackson <ian@davenant.greenend.org.uk>
13 * Copyright (C) 1999 Tony Finch <dot@dotat.at>
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 2, 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 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 */
29
30 #include "internal.h"
31
32 #include <stdlib.h>
33 #include <unistd.h>
34 #include <errno.h>
35
36 #include <sys/time.h>
37
38 #include "internal.h"
39
40 static adns_query query_alloc(adns_state ads, const typeinfo *typei,
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)); if (!qu->answer) { free(qu); return 0; }
47
48 qu->ads= ads;
49 qu->state= query_tosend;
50 qu->back= qu->next= qu->parent= 0;
51 LIST_INIT(qu->children);
52 LINK_INIT(qu->siblings);
53 LIST_INIT(qu->allocations);
54 qu->interim_allocd= 0;
55 qu->preserved_allocd= 0;
56 qu->final_allocspace= 0;
57
58 qu->typei= typei;
59 qu->query_dgram= 0;
60 qu->query_dglen= 0;
61 adns__vbuf_init(&qu->vb);
62
63 qu->cname_dgram= 0;
64 qu->cname_dglen= qu->cname_begin= 0;
65
66 adns__vbuf_init(&qu->search_vb);
67 qu->search_origlen= qu->search_pos= qu->search_doneabs= 0;
68
69 qu->id= -2; /* will be overwritten with real id before we leave adns */
70 qu->flags= flags;
71 qu->retries= 0;
72 qu->udpnextserver= 0;
73 qu->udpsent= 0;
74 timerclear(&qu->timeout);
75 qu->expires= now.tv_sec + MAXTTLBELIEVE;
76
77 memset(&qu->ctx,0,sizeof(qu->ctx));
78
79 qu->answer->status= adns_s_ok;
80 qu->answer->cname= qu->answer->owner= 0;
81 qu->answer->type= typei->type;
82 qu->answer->expires= -1;
83 qu->answer->nrrs= 0;
84 qu->answer->rrs.untyped= 0;
85 qu->answer->rrsz= typei->rrsz;
86
87 return qu;
88 }
89
90 static void query_submit(adns_state ads, adns_query qu,
91 const typeinfo *typei, vbuf *qumsg_vb, int id,
92 adns_queryflags flags, struct timeval now) {
93 /* Fills in the query message in for a previously-allocated query,
94 * and submits it. Cannot fail. Takes over the memory for qumsg_vb.
95 */
96
97 qu->vb= *qumsg_vb;
98 adns__vbuf_init(qumsg_vb);
99
100 qu->query_dgram= malloc(qu->vb.used);
101 if (!qu->query_dgram) { adns__query_fail(qu,adns_s_nomemory); return; }
102
103 qu->id= id;
104 qu->query_dglen= qu->vb.used;
105 memcpy(qu->query_dgram,qu->vb.buf,qu->vb.used);
106
107 adns__query_send(qu,now);
108 }
109
110 adns_status adns__internal_submit(adns_state ads, adns_query *query_r,
111 const typeinfo *typei, vbuf *qumsg_vb, int id,
112 adns_queryflags flags, struct timeval now,
113 const qcontext *ctx) {
114 adns_query qu;
115
116 qu= query_alloc(ads,typei,flags,now);
117 if (!qu) { adns__vbuf_free(qumsg_vb); return adns_s_nomemory; }
118 *query_r= qu;
119
120 memcpy(&qu->ctx,ctx,sizeof(qu->ctx));
121 query_submit(ads,qu, typei,qumsg_vb,id,flags,now);
122
123 return adns_s_ok;
124 }
125
126 static void query_simple(adns_state ads, adns_query qu,
127 const char *owner, int ol,
128 const typeinfo *typei, adns_queryflags flags,
129 struct timeval now) {
130 vbuf vb_new;
131 int id;
132 adns_status stat;
133
134 stat= adns__mkquery(ads,&qu->vb,&id, owner,ol, typei,flags);
135 if (stat) {
136 if (stat == adns_s_querydomaintoolong && (flags & adns_qf_search)) {
137 adns__search_next(ads,qu,now);
138 return;
139 } else {
140 adns__query_fail(qu,stat);
141 return;
142 }
143 }
144
145 vb_new= qu->vb;
146 adns__vbuf_init(&qu->vb);
147 query_submit(ads,qu, typei,&vb_new,id, flags,now);
148 }
149
150 void adns__search_next(adns_state ads, adns_query qu, struct timeval now) {
151 const char *nextentry;
152 adns_status stat;
153
154 if (qu->search_doneabs<0) {
155 nextentry= 0;
156 qu->search_doneabs= 1;
157 } else {
158 if (qu->search_pos >= ads->nsearchlist) {
159 if (qu->search_doneabs) {
160 stat= adns_s_nxdomain; goto x_fail;
161 return;
162 } else {
163 nextentry= 0;
164 qu->search_doneabs= 1;
165 }
166 } else {
167 nextentry= ads->searchlist[qu->search_pos++];
168 }
169 }
170
171 qu->search_vb.used= qu->search_origlen;
172 if (nextentry) {
173 if (!adns__vbuf_append(&qu->search_vb,".",1) ||
174 !adns__vbuf_appendstr(&qu->search_vb,nextentry)) {
175 stat= adns_s_nomemory; goto x_fail;
176 }
177 }
178
179 free(qu->query_dgram);
180 qu->query_dgram= 0; qu->query_dglen= 0;
181
182 query_simple(ads,qu, qu->search_vb.buf, qu->search_vb.used, qu->typei, qu->flags, now);
183 return;
184
185 x_fail:
186 adns__query_fail(qu,stat);
187 }
188
189 static int save_owner(adns_query qu, const char *owner, int ol) {
190 /* Returns 1 if OK, otherwise there was no memory. */
191 adns_answer *ans;
192
193 ans= qu->answer;
194 assert(!ans->owner);
195
196 ans->owner= adns__alloc_preserved(qu,ol+1); if (!ans->owner) return 0;
197
198 memcpy(ans->owner,owner,ol);
199 ans->owner[ol]= 0;
200 return 1;
201 }
202
203 int adns_submit(adns_state ads,
204 const char *owner,
205 adns_rrtype type,
206 adns_queryflags flags,
207 void *context,
208 adns_query *query_r) {
209 int r, ol, ndots;
210 adns_status stat;
211 const typeinfo *typei;
212 struct timeval now;
213 adns_query qu;
214 const char *p;
215
216 adns__consistency(ads,0,cc_entex);
217
218 typei= adns__findtype(type);
219 if (!typei) return ENOSYS;
220
221 r= gettimeofday(&now,0); if (r) goto x_errno;
222 qu= query_alloc(ads,typei,flags,now); if (!qu) goto x_errno;
223
224 qu->ctx.ext= context;
225 qu->ctx.callback= 0;
226 memset(&qu->ctx.info,0,sizeof(qu->ctx.info));
227
228 *query_r= qu;
229
230 ol= strlen(owner);
231 if (!ol) { stat= adns_s_querydomaininvalid; goto x_adnsfail; }
232 if (ol>DNS_MAXDOMAIN+1) { stat= adns_s_querydomaintoolong; goto x_adnsfail; }
233
234 if (ol>=1 && owner[ol-1]=='.' && (ol<2 || owner[ol-2]!='\\')) {
235 flags &= ~adns_qf_search;
236 qu->flags= flags;
237 ol--;
238 }
239
240 if (flags & adns_qf_search) {
241 r= adns__vbuf_append(&qu->search_vb,owner,ol);
242 if (!r) { stat= adns_s_nomemory; goto x_adnsfail; }
243
244 for (ndots=0, p=owner; (p= strchr(p,'.')); p++, ndots++);
245 qu->search_doneabs= (ndots >= ads->searchndots) ? -1 : 0;
246 qu->search_origlen= ol;
247 adns__search_next(ads,qu,now);
248 } else {
249 if (flags & adns_qf_owner) {
250 if (!save_owner(qu,owner,ol)) { stat= adns_s_nomemory; goto x_adnsfail; }
251 }
252 query_simple(ads,qu, owner,ol, typei,flags, now);
253 }
254 adns__autosys(ads,now);
255 adns__consistency(ads,qu,cc_entex);
256 return 0;
257
258 x_adnsfail:
259 adns__query_fail(qu,stat);
260 adns__consistency(ads,qu,cc_entex);
261 return 0;
262
263 x_errno:
264 r= errno;
265 assert(r);
266 adns__consistency(ads,0,cc_entex);
267 return r;
268 }
269
270 int adns_submit_reverse_any(adns_state ads,
271 const struct sockaddr *addr,
272 const char *zone,
273 adns_rrtype type,
274 adns_queryflags flags,
275 void *context,
276 adns_query *query_r) {
277 const unsigned char *iaddr;
278 char *buf, *buf_free;
279 char shortbuf[100];
280 int r, lreq;
281
282 flags &= ~adns_qf_search;
283
284 if (addr->sa_family != AF_INET) return ENOSYS;
285 iaddr= (const unsigned char*) &(((const struct sockaddr_in*)addr) -> sin_addr);
286
287 lreq= strlen(zone) + 4*4 + 1;
288 if (lreq > sizeof(shortbuf)) {
289 buf= malloc(strlen(zone) + 4*4 + 1);
290 if (!buf) return errno;
291 buf_free= buf;
292 } else {
293 buf= shortbuf;
294 buf_free= 0;
295 }
296 sprintf(buf, "%d.%d.%d.%d.%s", iaddr[3], iaddr[2], iaddr[1], iaddr[0], zone);
297
298 r= adns_submit(ads,buf,type,flags,context,query_r);
299 free(buf_free);
300 return r;
301 }
302
303 int adns_submit_reverse(adns_state ads,
304 const struct sockaddr *addr,
305 adns_rrtype type,
306 adns_queryflags flags,
307 void *context,
308 adns_query *query_r) {
309 if (type != adns_r_ptr && type != adns_r_ptr_raw) return EINVAL;
310 return adns_submit_reverse_any(ads,addr,"in-addr.arpa",type,flags,context,query_r);
311 }
312
313 int adns_synchronous(adns_state ads,
314 const char *owner,
315 adns_rrtype type,
316 adns_queryflags flags,
317 adns_answer **answer_r) {
318 adns_query qu;
319 int r;
320
321 r= adns_submit(ads,owner,type,flags,0,&qu);
322 if (r) return r;
323
324 r= adns_wait(ads,&qu,answer_r,0);
325 if (r) adns_cancel(qu);
326
327 return r;
328 }
329
330 static void *alloc_common(adns_query qu, size_t sz) {
331 allocnode *an;
332
333 if (!sz) return qu; /* Any old pointer will do */
334 assert(!qu->final_allocspace);
335 an= malloc(MEM_ROUND(MEM_ROUND(sizeof(*an)) + sz));
336 if (!an) return 0;
337 LIST_LINK_TAIL(qu->allocations,an);
338 return (byte*)an + MEM_ROUND(sizeof(*an));
339 }
340
341 void *adns__alloc_interim(adns_query qu, size_t sz) {
342 void *rv;
343
344 sz= MEM_ROUND(sz);
345 rv= alloc_common(qu,sz);
346 if (!rv) return 0;
347 qu->interim_allocd += sz;
348 return rv;
349 }
350
351 void *adns__alloc_preserved(adns_query qu, size_t sz) {
352 void *rv;
353
354 sz= MEM_ROUND(sz);
355 rv= adns__alloc_interim(qu,sz);
356 if (!rv) return 0;
357 qu->preserved_allocd += sz;
358 return rv;
359 }
360
361 void *adns__alloc_mine(adns_query qu, size_t sz) {
362 return alloc_common(qu,MEM_ROUND(sz));
363 }
364
365 void adns__transfer_interim(adns_query from, adns_query to, void *block, size_t sz) {
366 allocnode *an;
367
368 if (!block) return;
369 an= (void*)((byte*)block - MEM_ROUND(sizeof(*an)));
370
371 assert(!to->final_allocspace);
372 assert(!from->final_allocspace);
373
374 LIST_UNLINK(from->allocations,an);
375 LIST_LINK_TAIL(to->allocations,an);
376
377 from->interim_allocd -= sz;
378 to->interim_allocd += sz;
379
380 if (to->expires > from->expires) to->expires= from->expires;
381 }
382
383 void *adns__alloc_final(adns_query qu, size_t sz) {
384 /* When we're in the _final stage, we _subtract_ from interim_alloc'd
385 * each allocation, and use final_allocspace to point to the next free
386 * bit.
387 */
388 void *rp;
389
390 sz= MEM_ROUND(sz);
391 rp= qu->final_allocspace;
392 assert(rp);
393 qu->interim_allocd -= sz;
394 assert(qu->interim_allocd>=0);
395 qu->final_allocspace= (byte*)rp + sz;
396 return rp;
397 }
398
399 static void cancel_children(adns_query qu) {
400 adns_query cqu, ncqu;
401
402 for (cqu= qu->children.head; cqu; cqu= ncqu) {
403 ncqu= cqu->siblings.next;
404 adns_cancel(cqu);
405 }
406 }
407
408 void adns__reset_preserved(adns_query qu) {
409 assert(!qu->final_allocspace);
410 cancel_children(qu);
411 qu->answer->nrrs= 0;
412 qu->answer->rrs.untyped= 0;
413 qu->interim_allocd= qu->preserved_allocd;
414 }
415
416 static void free_query_allocs(adns_query qu) {
417 allocnode *an, *ann;
418
419 cancel_children(qu);
420 for (an= qu->allocations.head; an; an= ann) { ann= an->next; free(an); }
421 LIST_INIT(qu->allocations);
422 adns__vbuf_free(&qu->vb);
423 adns__vbuf_free(&qu->search_vb);
424 free(qu->query_dgram);
425 }
426
427 void adns_cancel(adns_query qu) {
428 adns_state ads;
429
430 ads= qu->ads;
431 adns__consistency(ads,qu,cc_entex);
432 if (qu->parent) LIST_UNLINK_PART(qu->parent->children,qu,siblings.);
433 switch (qu->state) {
434 case query_tosend:
435 LIST_UNLINK(ads->udpw,qu);
436 break;
437 case query_tcpw:
438 LIST_UNLINK(ads->tcpw,qu);
439 break;
440 case query_childw:
441 LIST_UNLINK(ads->childw,qu);
442 break;
443 case query_done:
444 LIST_UNLINK(ads->output,qu);
445 break;
446 default:
447 abort();
448 }
449 free_query_allocs(qu);
450 free(qu->answer);
451 free(qu);
452 adns__consistency(ads,0,cc_entex);
453 }
454
455 void adns__update_expires(adns_query qu, unsigned long ttl, struct timeval now) {
456 time_t max;
457
458 assert(ttl <= MAXTTLBELIEVE);
459 max= now.tv_sec + ttl;
460 if (qu->expires < max) return;
461 qu->expires= max;
462 }
463
464 static void makefinal_query(adns_query qu) {
465 adns_answer *ans;
466 int rrn;
467
468 ans= qu->answer;
469
470 if (qu->interim_allocd) {
471 ans= realloc(qu->answer, MEM_ROUND(MEM_ROUND(sizeof(*ans)) + qu->interim_allocd));
472 if (!ans) goto x_nomem;
473 qu->answer= ans;
474 }
475
476 qu->final_allocspace= (byte*)ans + MEM_ROUND(sizeof(*ans));
477 adns__makefinal_str(qu,&ans->cname);
478 adns__makefinal_str(qu,&ans->owner);
479
480 if (ans->nrrs) {
481 adns__makefinal_block(qu, &ans->rrs.untyped, ans->nrrs*ans->rrsz);
482
483 for (rrn=0; rrn<ans->nrrs; rrn++)
484 qu->typei->makefinal(qu, ans->rrs.bytes + rrn*ans->rrsz);
485 }
486
487 free_query_allocs(qu);
488 return;
489
490 x_nomem:
491 qu->preserved_allocd= 0;
492 qu->answer->cname= 0;
493 qu->answer->owner= 0;
494 adns__reset_preserved(qu); /* (but we just threw away the preserved stuff) */
495
496 qu->answer->status= adns_s_nomemory;
497 free_query_allocs(qu);
498 }
499
500 void adns__query_done(adns_query qu) {
501 adns_answer *ans;
502 adns_query parent;
503
504 assert(!qu->ads->bug_if_query_done_now);
505 cancel_children(qu);
506
507 qu->id= -1;
508 ans= qu->answer;
509
510 if (qu->flags & adns_qf_owner && qu->flags & adns_qf_search &&
511 ans->status != adns_s_nomemory) {
512 if (!save_owner(qu, qu->search_vb.buf, qu->search_vb.used)) {
513 adns__query_fail(qu,adns_s_nomemory);
514 return;
515 }
516 }
517
518 if (ans->nrrs && qu->typei->diff_needswap) {
519 if (!adns__vbuf_ensure(&qu->vb,qu->typei->rrsz)) {
520 adns__query_fail(qu,adns_s_nomemory);
521 return;
522 }
523 adns__isort(ans->rrs.bytes, ans->nrrs, ans->rrsz,
524 qu->vb.buf,
525 (int(*)(void*, const void*, const void*))qu->typei->diff_needswap,
526 qu->ads);
527 }
528
529 ans->expires= qu->expires;
530 parent= qu->parent;
531 if (parent) {
532 LIST_UNLINK_PART(parent->children,qu,siblings.);
533 LIST_UNLINK(qu->ads->childw,parent);
534 qu->ctx.callback(parent,qu);
535 free_query_allocs(qu);
536 free(qu->answer);
537 free(qu);
538 } else {
539 makefinal_query(qu);
540 LIST_LINK_TAIL(qu->ads->output,qu);
541 qu->state= query_done;
542 }
543 }
544
545 void adns__query_fail(adns_query qu, adns_status stat) {
546 assert(!qu->ads->bug_if_query_done_now);
547 adns__reset_preserved(qu);
548 qu->answer->status= stat;
549 adns__query_done(qu);
550 }
551
552 void adns__makefinal_str(adns_query qu, char **strp) {
553 int l;
554 char *before, *after;
555
556 before= *strp;
557 if (!before) return;
558 l= strlen(before)+1;
559 after= adns__alloc_final(qu,l);
560 memcpy(after,before,l);
561 *strp= after;
562 }
563
564 void adns__makefinal_block(adns_query qu, void **blpp, size_t sz) {
565 void *before, *after;
566
567 before= *blpp;
568 if (!before) return;
569 after= adns__alloc_final(qu,sz);
570 memcpy(after,before,sz);
571 *blpp= after;
572 }