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