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