src/internal.h

   1 /*
   2  * internal.h
   3  * - declarations of private objects with external linkage (adns__*)
   4  * - definitons of internal macros
   5  * - comments regarding library data structures
   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 #ifndef ADNS_INTERNAL_H_INCLUDED
  30 #define ADNS_INTERNAL_H_INCLUDED
  31
  32 #include "config.h"
  33 typedef unsigned char byte;
  34
  35 #include <stdarg.h>
  36 #include <assert.h>
  37 #include <unistd.h>
  38 #include <signal.h>
  39 #include <errno.h>
  40 #include <string.h>
  41 #include <stdlib.h>
  42
  43 #include <sys/time.h>
  44
  45 #define ADNS_FEATURE_MANYAF
  46 #include "adns.h"
  47 #include "dlist.h"
  48
  49 #ifdef ADNS_REGRESS_TEST
  50 # include "hredirect.h"
  51 #endif
  52
  53 /* Configuration and constants */
  54
  55 #define MAXSERVERS 5
  56 #define MAXSORTLIST 15
  57 #define UDPMAXRETRIES 15
  58 #define UDPRETRYMS 2000
  59 #define TCPWAITMS 30000
  60 #define TCPCONNMS 14000
  61 #define TCPIDLEMS 30000
  62 #define MAXTTLBELIEVE (7*86400) /* any TTL > 7 days is capped */
  63
  64 #define DNS_PORT 53
  65 #define DNS_MAXUDP 512
  66 #define DNS_MAXLABEL 63
  67 #define DNS_MAXDOMAIN 255
  68 #define DNS_HDRSIZE 12
  69 #define DNS_IDOFFSET 0
  70 #define DNS_CLASS_IN 1
  71
  72 #define DNS_INADDR_ARPA "in-addr", "arpa"
  73 #define DNS_IP6_ARPA "ip6", "arpa"
  74
  75 #define MAX_ADDRSTRLEN 64
  76
  77 #define STRINGIFY(x) REALLY_STRINGIFY(x)
  78 #define REALLY_STRINGIFY(x) #x
  79
  80 #define MAX_POLLFDS  ADNS_POLLFDS_RECOMMENDED
  81
  82 typedef enum {
  83   cc_user,
  84   cc_entex,
  85   cc_freq
  86 } consistency_checks;
  87
  88 typedef enum {
  89   rcode_noerror,
  90   rcode_formaterror,
  91   rcode_servfail,
  92   rcode_nxdomain,
  93   rcode_notimp,
  94   rcode_refused
  95 } dns_rcode;
  96
  97 enum {
  98   adns__qf_addr_answer= 0x01000000,/* addr query received an answer */
  99   adns__qf_addr_cname = 0x02000000 /* addr subquery performed on cname */
 100 };
 101
 102 /* Shared data structures */
 103
 104 typedef union {
 105   adns_status status;
 106   char *cp;
 107   adns_rrtype type;
 108   int i;
 109   struct in_addr ia;
 110   unsigned long ul;
 111 } rr_align;
 112
 113 typedef struct {
 114   int used, avail;
 115   byte *buf;
 116 } vbuf;
 117
 118 typedef struct {
 119   adns_state ads;
 120   adns_query qu;
 121   int serv;
 122   const byte *dgram;
 123   int dglen, nsstart, nscount, arcount;
 124   struct timeval now;
 125 } parseinfo;
 126
 127 union gen_addr {
 128   struct in_addr v4;
 129   struct in6_addr v6;
 130 };
 131
 132 union checklabel_state {
 133   struct {
 134 #define PTR_NDOMAIN 2
 135     unsigned domainmap;                 /* which domains are still live */
 136     byte ipv[PTR_NDOMAIN][32];          /* address components so far */
 137   } ptr;
 138 };
 139
 140 typedef struct {
 141   int af;
 142   int width;
 143   int delim;
 144   int nrevcomp;
 145   int revcompwd;
 146   adns_rrtype rrtype;
 147   const void *(*sockaddr_to_inaddr)(const struct sockaddr *sa);
 148   int (*sockaddr_equalp)(const struct sockaddr *sa,
 149                          const struct sockaddr *sb);
 150   void (*prefix_mask)(int len, union gen_addr *a);
 151   int (*guess_len)(const union gen_addr *a);
 152   int (*matchp)(const union gen_addr *addr,
 153                 const union gen_addr *base, const union gen_addr *mask);
 154   int (*rev_parsecomp)(const char *p, size_t n);
 155   void (*rev_mkaddr)(union gen_addr *addr, const byte *ipv);
 156   char *(*rev_mkname)(const struct sockaddr *sa, char *buf);
 157 } afinfo;
 158
 159 struct afinfo_addr { const afinfo *ai; union gen_addr addr; };
 160
 161 typedef struct {
 162   void *ext;
 163   void (*callback)(adns_query parent, adns_query child);
 164
 165   union {
 166     adns_rr_hostaddr *hostaddr;
 167   } pinfo; /* state for use by parent's callback function */
 168
 169   union {
 170     struct {
 171       struct afinfo_addr addr;
 172     } ptr;
 173     struct {
 174       unsigned want, have;
 175     } addr;
 176   } tinfo; /* type-specific state for the query itself: zero-init if you
 177             * don't know better. */
 178
 179 } qcontext;
 180
 181 typedef struct typeinfo {
 182   adns_rrtype typekey;
 183   const char *rrtname;
 184   const char *fmtname;
 185   int rrsz;
 186
 187   void (*makefinal)(adns_query qu, void *data);
 188   /* Change memory management of *data.
 189    * Previously, used alloc_interim, now use alloc_final.
 190    */
 191
 192   adns_status (*convstring)(vbuf *vb, const void *data);
 193   /* Converts the RR data to a string representation in vbuf.
 194    * vbuf will be appended to (it must have been initialised),
 195    * and will not be null-terminated by convstring.
 196    */
 197
 198   adns_status (*parse)(const parseinfo *pai, int cbyte,
 199                        int max, void *store_r);
 200   /* Parse one RR, in dgram of length dglen, starting at cbyte and
 201    * extending until at most max.
 202    *
 203    * The RR should be stored at *store_r, of length qu->typei->rrsz.
 204    *
 205    * If there is an overrun which might indicate truncation, it should set
 206    * *rdstart to -1; otherwise it may set it to anything else positive.
 207    *
 208    * nsstart is the offset of the authority section.
 209    */
 210
 211   int (*diff_needswap)(adns_state ads,const void *datap_a,const void *datap_b);
 212   /* Returns !0 if RR a should be strictly after RR b in the sort order,
 213    * 0 otherwise.  Must not fail.
 214    */
 215
 216   adns_status (*checklabel)(adns_state ads, adns_queryflags flags,
 217                             union checklabel_state *css, qcontext *ctx,
 218                             int labnum, const char *label, int lablen);
 219   /* Check a label from the query domain string.  The label is not
 220    * necessarily null-terminated.  The query has not yet been constructed,
 221    * and this hook can refuse its submission by returning a nonzero status.
 222    * State can be stored in *css between calls, and useful information can be
 223    * stashed in ctx->tinfo, to be stored with the query (e.g., it will be
 224    * available to the parse hook).  This hook can detect a first call because
 225    * labnum is zero, and a final call because lablen is zero.
 226    */
 227
 228   void (*postsort)(adns_state ads, void *array, int nrrs,
 229                    const struct typeinfo *typei);
 230   /* Called immediately after the RRs have been sorted, and may rearrange
 231    * them.  (This is really for the benefit of SRV's bizarre weighting
 232    * stuff.)  May be 0 to mean nothing needs to be done.
 233    */
 234
 235   int (*getrrsz)(adns_rrtype type);
 236   /* Return the output resource-record element size; if this is null, then
 237    * the rrsz member can be used.
 238    */
 239
 240   void (*query_send)(adns_query qu, struct timeval now);
 241   /* Send the query to nameservers, and hook it into the appropriate queue.
 242    * Normal behaviour is to call adns__query_send, but this can be overridden
 243    * for special effects.
 244    */
 245 } typeinfo;
 246
 247 adns_status adns__ckl_hostname(adns_state ads, adns_queryflags flags,
 248                                union checklabel_state *css,
 249                                qcontext *ctx, int labnum,
 250                                const char *label, int lablen);
 251 /* implemented in query.c, used by types.c as default
 252  * and as part of implementation for some fancier types */
 253
 254 typedef struct allocnode {
 255   struct allocnode *next, *back;
 256   size_t sz;
 257 } allocnode;
 258
 259 union maxalign {
 260   byte d[1];
 261   struct in_addr ia;
 262   long l;
 263   void *p;
 264   void (*fp)(void);
 265   union maxalign *up;
 266 } data;
 267
 268 struct adns__query {
 269   adns_state ads;
 270   enum { query_tosend, query_tcpw, query_childw, query_done } state;
 271   adns_query back, next, parent;
 272   struct { adns_query head, tail; } children;
 273   struct { adns_query back, next; } siblings;
 274   struct { allocnode *head, *tail; } allocations;
 275   int interim_allocd, preserved_allocd;
 276   void *final_allocspace;
 277
 278   const typeinfo *typei;
 279   byte *query_dgram;
 280   int query_dglen;
 281
 282   vbuf vb;
 283   /* General-purpose messing-about buffer.
 284    * Wherever a `big' interface is crossed, this may be corrupted/changed
 285    * unless otherwise specified.
 286    */
 287
 288   adns_answer *answer;
 289   /* This is allocated when a query is submitted, to avoid being unable
 290    * to relate errors to queries if we run out of memory.  During
 291    * query processing status, rrs is 0.  cname is set if
 292    * we found a cname (this corresponds to cname_dgram in the query
 293    * structure).  type is set from the word go.  nrrs and rrs
 294    * are set together, when we find how many rrs there are.
 295    * owner is set during querying unless we're doing searchlist,
 296    * in which case it is set only when we find an answer.
 297    */
 298
 299   byte *cname_dgram;
 300   int cname_dglen, cname_begin;
 301   /* If non-0, has been allocated using . */
 302
 303   vbuf search_vb;
 304   int search_origlen, search_pos, search_doneabs;
 305   /* Used by the searching algorithm.  The query domain in textual form
 306    * is copied into the vbuf, and _origlen set to its length.  Then
 307    * we walk the searchlist, if we want to.  _pos says where we are
 308    * (next entry to try), and _doneabs says whether we've done the
 309    * absolute query yet (0=not yet, 1=done, -1=must do straight away,
 310    * but not done yet).  If flags doesn't have adns_qf_search then
 311    * the vbuf is initialised but empty and everything else is zero.
 312    */
 313
 314   int id, flags, retries;
 315   int udpnextserver;
 316   unsigned long udpsent; /* bitmap indexed by server */
 317   struct timeval timeout;
 318   time_t expires; /* Earliest expiry time of any record we used. */
 319
 320   qcontext ctx;
 321
 322   /* Possible states:
 323    *
 324    *  state   Queue   child  id   nextudpserver  udpsent     tcpfailed
 325    *
 326    *  tosend  NONE    null   >=0  0              zero        zero
 327    *  tosend  udpw    null   >=0  any            nonzero     zero
 328    *  tosend  NONE    null   >=0  any            nonzero     zero
 329    *
 330    *  tcpw    tcpw    null   >=0  irrelevant     any         any
 331    *
 332    *  child   childw  set    >=0  irrelevant     irrelevant  irrelevant
 333    *  child   NONE    null   >=0  irrelevant     irrelevant  irrelevant
 334    *  done    output  null   -1   irrelevant     irrelevant  irrelevant
 335    *
 336    * Queries are only not on a queue when they are actually being processed.
 337    * Queries in state tcpw/tcpw have been sent (or are in the to-send buffer)
 338    * iff the tcp connection is in state server_ok.
 339    *
 340    *                          +------------------------+
 341    *             START -----> |      tosend/NONE       |
 342    *                          +------------------------+
 343    *                         /                       |\  \
 344    *        too big for UDP /             UDP timeout  \  \ send via UDP
 345    *        send via TCP   /              more retries  \  \
 346    *        when conn'd   /                  desired     \  \
 347    *                     |                                |  |
 348    *                     v                                |  v
 349    *              +-----------+                         +-------------+
 350    *              | tcpw/tcpw | ________                | tosend/udpw |
 351    *              +-----------+         \               +-------------+
 352    *                 |    |              |     UDP timeout | |
 353    *                 |    |              |      no more    | |
 354    *                 |    |              |      retries    | |
 355    *                  \   | TCP died     |      desired    | |
 356    *                   \   \ no more     |                 | |
 357    *                    \   \ servers    | TCP            /  |
 358    *                     \   \ to try    | timeout       /   |
 359    *                  got \   \          v             |_    | got
 360    *                 reply \   _| +------------------+      / reply
 361    *                        \     | done/output FAIL |     /
 362    *                         \    +------------------+    /
 363    *                          \                          /
 364    *                           _|                      |_
 365    *                             (..... got reply ....)
 366    *                              /                   \
 367    *        need child query/ies /                     \ no child query
 368    *                            /                       \
 369    *                          |_                         _|
 370    *               +---------------+                   +----------------+
 371    *               | childw/childw | ----------------> | done/output OK |
 372    *               +---------------+  children done    +----------------+
 373    */
 374 };
 375
 376 struct query_queue { adns_query head, tail; };
 377
 378 #define MAXUDP 2
 379
 380 struct adns__state {
 381   adns_initflags iflags;
 382   adns_logcallbackfn *logfn;
 383   void *logfndata;
 384   int configerrno;
 385   struct query_queue udpw, tcpw, childw, output;
 386   adns_query forallnext;
 387   int nextid, tcpsocket;
 388   struct udpsocket { const afinfo *ai; int fd; } udpsocket[MAXUDP];
 389   int nudp;
 390   vbuf tcpsend, tcprecv;
 391   int nservers, nsortlist, nsearchlist, searchndots, tcpserver, tcprecv_skip;
 392   enum adns__tcpstate {
 393     server_disconnected, server_connecting,
 394     server_ok, server_broken
 395   } tcpstate;
 396   struct timeval tcptimeout;
 397   /* This will have tv_sec==0 if it is not valid.  It will always be
 398    * valid if tcpstate _connecting.  When _ok, it will be nonzero if
 399    * we are idle (ie, tcpw queue is empty), in which case it is the
 400    * absolute time when we will close the connection.
 401    */
 402   struct sigaction stdsigpipe;
 403   sigset_t stdsigmask;
 404   struct pollfd pollfds_buf[MAX_POLLFDS];
 405   adns_rr_addr servers[MAXSERVERS];
 406   struct sortlist {
 407     const afinfo *ai;
 408     union gen_addr base, mask;
 409   } sortlist[MAXSORTLIST];
 410   char **searchlist;
 411   unsigned short rand48xsubi[3];
 412 };
 413
 414 /* From addrfam.c: */
 415
 416 extern const afinfo adns__inet_afinfo, adns__inet6_afinfo;
 417
 418 /* From setup.c: */
 419
 420 int adns__setnonblock(adns_state ads, int fd); /* => errno value */
 421
 422 /* From general.c: */
 423
 424 const char *adns__sockaddr_ntoa(struct sockaddr *sa, size_t n, char *buf);
 425 /* Buffer must be at least MAX_ADDRSTRLEN bytes long. */
 426
 427 void adns__vlprintf(adns_state ads, const char *fmt, va_list al);
 428 void adns__lprintf(adns_state ads, const char *fmt,
 429                    ...) PRINTFFORMAT(2,3);
 430
 431 void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent,
 432                  int serv, adns_query qu, const char *fmt, va_list al);
 433
 434 void adns__debug(adns_state ads, int serv, adns_query qu,
 435                  const char *fmt, ...) PRINTFFORMAT(4,5);
 436 void adns__warn(adns_state ads, int serv, adns_query qu,
 437                 const char *fmt, ...) PRINTFFORMAT(4,5);
 438 void adns__diag(adns_state ads, int serv, adns_query qu,
 439                 const char *fmt, ...) PRINTFFORMAT(4,5);
 440
 441 int adns__vbuf_ensure(vbuf *vb, int want);
 442 int adns__vbuf_appendstr(vbuf *vb, const char *data); /* doesn't include nul */
 443 int adns__vbuf_append(vbuf *vb, const byte *data, int len);
 444 /* 1=>success, 0=>realloc failed */
 445 void adns__vbuf_appendq(vbuf *vb, const byte *data, int len);
 446 void adns__vbuf_init(vbuf *vb);
 447 void adns__vbuf_free(vbuf *vb);
 448
 449 const char *adns__diag_domain(adns_state ads, int serv, adns_query qu,
 450                               vbuf *vb,
 451                               const byte *dgram, int dglen, int cbyte);
 452 /* Unpicks a domain in a datagram and returns a string suitable for
 453  * printing it as.  Never fails - if an error occurs, it will
 454  * return some kind of string describing the error.
 455  *
 456  * serv may be -1 and qu may be 0.  vb must have been initialised,
 457  * and will be left in an arbitrary consistent state.
 458  *
 459  * Returns either vb->buf, or a pointer to a string literal.  Do not modify
 460  * vb before using the return value.
 461  */
 462
 463 void adns__isort(void *array, int nobjs, int sz, void *tempbuf,
 464                  int (*needswap)(void *context, const void *a, const void *b),
 465                  void *context);
 466 /* Does an insertion sort of array which must contain nobjs objects
 467  * each sz bytes long.  tempbuf must point to a buffer at least
 468  * sz bytes long.  needswap should return !0 if a>b (strictly, ie
 469  * wrong order) 0 if a<=b (ie, order is fine).
 470  */
 471
 472 void adns__sigpipe_protect(adns_state);
 473 void adns__sigpipe_unprotect(adns_state);
 474 /* If SIGPIPE protection is not disabled, will block all signals except
 475  * SIGPIPE, and set SIGPIPE's disposition to SIG_IGN.  (And then restore.)
 476  * Each call to _protect must be followed by a call to _unprotect before
 477  * any significant amount of code gets to run, since the old signal mask
 478  * is stored in the adns structure.
 479  */
 480
 481 /* From transmit.c: */
 482
 483 adns_status adns__mkquery(adns_state ads, vbuf *vb, int *id_r,
 484                           const char *owner, int ol,
 485                           const typeinfo *typei, adns_rrtype type,
 486                           adns_queryflags flags);
 487 /* Assembles a query packet in vb.  A new id is allocated and returned.
 488  */
 489
 490 adns_status adns__mkquery_frdgram(adns_state ads, vbuf *vb, int *id_r,
 491                                   const byte *qd_dgram, int qd_dglen,
 492                                   int qd_begin,
 493                                   adns_rrtype type, adns_queryflags flags);
 494 /* Same as adns__mkquery, but takes the owner domain from an existing datagram.
 495  * That domain must be correct and untruncated.
 496  */
 497
 498 void adns__querysend_tcp(adns_query qu, struct timeval now);
 499 /* Query must be in state tcpw/tcpw; it will be sent if possible and
 500  * no further processing can be done on it for now.  The connection
 501  * might be broken, but no reconnect will be attempted.
 502  */
 503
 504 void adns__query_send(adns_query qu, struct timeval now);
 505 /* Query must be in state tosend/NONE; it will be moved to a new state,
 506  * and no further processing can be done on it for now.
 507  * (Resulting state is one of udp/timew, tcpwait/timew (if server not
 508  * connected), tcpsent/timew, child/childw or done/output.)
 509  * __query_send may decide to use either UDP or TCP depending whether
 510  * _qf_usevc is set (or has become set) and whether the query is too
 511  * large.
 512  */
 513
 514 /* From query.c: */
 515
 516 adns_status adns__internal_submit(adns_state ads, adns_query *query_r,
 517                                   const typeinfo *typei, adns_rrtype,
 518                                   vbuf *qumsg_vb, int id,
 519                                   adns_queryflags flags, struct timeval now,
 520                                   qcontext *ctx);
 521 /* Submits a query (for internal use, called during external submits).
 522  *
 523  * The new query is returned in *query_r, or we return adns_s_nomemory.
 524  *
 525  * The query datagram should already have been assembled in qumsg_vb;
 526  * the memory for it is _taken over_ by this routine whether it
 527  * succeeds or fails (if it succeeds, the vbuf is reused for qu->vb).
 528  *
 529  * If adns__qf_nosend is set in flags, then the query is not sent: doing
 530  * whatever is necessary to send the query and link it onto the appropriate
 531  * queue is left as the caller's responsibility.
 532  *
 533  * *ctx is copied byte-for-byte into the query.
 534  *
 535  * When the child query is done, ctx->callback will be called.  The
 536  * child will already have been taken off both the global list of
 537  * queries in ads and the list of children in the parent.  The child
 538  * will be freed when the callback returns.  The parent will have been
 539  * taken off the global childw queue.
 540  *
 541  * The callback should either call adns__query_done, if it is
 542  * complete, or adns__query_fail, if an error has occurred, in which
 543  * case the other children (if any) will be cancelled.  If the parent
 544  * has more unfinished children (or has just submitted more) then the
 545  * callback may choose to wait for them - it must then put the parent
 546  * back on the childw queue.
 547  */
 548
 549 void adns__search_next(adns_state ads, adns_query qu, struct timeval now);
 550 /* Walks down the searchlist for a query with adns_qf_search.
 551  * The query should have just had a negative response, or not had
 552  * any queries sent yet, and should not be on any queue.
 553  * The query_dgram if any will be freed and forgotten and a new
 554  * one constructed from the search_* members of the query.
 555  *
 556  * Cannot fail (in case of error, calls adns__query_fail).
 557  */
 558
 559 void *adns__alloc_interim(adns_query qu, size_t sz);
 560 void *adns__alloc_preserved(adns_query qu, size_t sz);
 561 /* Allocates some memory, and records which query it came from
 562  * and how much there was.
 563  *
 564  * If an error occurs in the query, all the memory from _interim is
 565  * simply freed.  If the query succeeds, one large buffer will be made
 566  * which is big enough for all these allocations, and then
 567  * adns__alloc_final will get memory from this buffer.
 568  *
 569  * _alloc_interim can fail (and return 0).
 570  * The caller must ensure that the query is failed.
 571  *
 572  * The memory from _preserved is is kept and transferred into the
 573  * larger buffer - unless we run out of memory, in which case it too
 574  * is freed.  When you use _preserved you have to add code to the
 575  * x_nomem error exit case in adns__makefinal_query to clear out the
 576  * pointers you made to those allocations, because that's when they're
 577  * thrown away; you should also make a note in the declaration of
 578  * those pointer variables, to note that they are _preserved rather
 579  * than _interim.  If they're in the answer, note it here:
 580  *  answer->cname and answer->owner are _preserved.
 581  */
 582
 583 void adns__transfer_interim(adns_query from, adns_query to, void *block);
 584 /* Transfers an interim allocation from one query to another, so that
 585  * the `to' query will have room for the data when we get to makefinal
 586  * and so that the free will happen when the `to' query is freed
 587  * rather than the `from' query.
 588  *
 589  * It is legal to call adns__transfer_interim with a null pointer; this
 590  * has no effect.
 591  *
 592  * _transfer_interim also ensures that the expiry time of the `to' query
 593  * is no later than that of the `from' query, so that child queries'
 594  * TTLs get inherited by their parents.
 595  */
 596
 597 void adns__free_interim(adns_query qu, void *p);
 598 /* Forget about a block allocated by adns__alloc_interim.
 599  */
 600
 601 void *adns__alloc_mine(adns_query qu, size_t sz);
 602 /* Like _interim, but does not record the length for later
 603  * copying into the answer.  This just ensures that the memory
 604  * will be freed when we're done with the query.
 605  */
 606
 607 void *adns__alloc_final(adns_query qu, size_t sz);
 608 /* Cannot fail, and cannot return 0.
 609  */
 610
 611 void adns__makefinal_block(adns_query qu, void **blpp, size_t sz);
 612 void adns__makefinal_str(adns_query qu, char **strp);
 613
 614 void adns__reset_preserved(adns_query qu);
 615 /* Resets all of the memory management stuff etc. to take account of
 616  * only the _preserved stuff from _alloc_preserved.  Used when we find
 617  * an error somewhere and want to just report the error (with perhaps
 618  * CNAME, owner, etc. info), and also when we're halfway through RRs
 619  * in a datagram and discover that we need to retry the query.
 620  */
 621
 622 void adns__query_done(adns_query qu);
 623 void adns__query_fail(adns_query qu, adns_status stat);
 624 void adns__cancel_children(adns_query qu);
 625
 626 /* From reply.c: */
 627
 628 void adns__procdgram(adns_state ads, const byte *dgram, int len,
 629                      int serv, int viatcp, struct timeval now);
 630 /* This function is allowed to cause new datagrams to be constructed
 631  * and sent, or even new queries to be started.  However,
 632  * query-sending functions are not allowed to call any general event
 633  * loop functions in case they accidentally call this.
 634  *
 635  * Ie, receiving functions may call sending functions.
 636  * Sending functions may NOT call receiving functions.
 637  */
 638
 639 /* From types.c: */
 640
 641 const typeinfo *adns__findtype(adns_rrtype type);
 642
 643 /* From parse.c: */
 644
 645 typedef struct {
 646   adns_state ads;
 647   adns_query qu;
 648   int serv;
 649   const byte *dgram;
 650   int dglen, max, cbyte, namelen;
 651   int *dmend_r;
 652 } findlabel_state;
 653
 654 void adns__findlabel_start(findlabel_state *fls, adns_state ads,
 655                            int serv, adns_query qu,
 656                            const byte *dgram, int dglen, int max,
 657                            int dmbegin, int *dmend_rlater);
 658 /* Finds labels in a domain in a datagram.
 659  *
 660  * Call this routine first.
 661  * dmend_rlater may be null.  ads (and of course fls) may not be.
 662  * serv may be -1, qu may be null - they are for error reporting.
 663  */
 664
 665 adns_status adns__findlabel_next(findlabel_state *fls,
 666                                  int *lablen_r, int *labstart_r);
 667 /* Then, call this one repeatedly.
 668  *
 669  * It will return adns_s_ok if all is well, and tell you the length
 670  * and start of successive labels.  labstart_r may be null, but
 671  * lablen_r must not be.
 672  *
 673  * After the last label, it will return with *lablen_r zero.
 674  * Do not then call it again; instead, just throw away the findlabel_state.
 675  *
 676  * *dmend_rlater will have been set to point to the next part of
 677  * the datagram after the label (or after the uncompressed part,
 678  * if compression was used).  *namelen_rlater will have been set
 679  * to the length of the domain name (total length of labels plus
 680  * 1 for each intervening dot).
 681  *
 682  * If the datagram appears to be truncated, *lablen_r will be -1.
 683  * *dmend_rlater, *labstart_r and *namelen_r may contain garbage.
 684  * Do not call _next again.
 685  *
 686  * There may also be errors, in which case *dmend_rlater,
 687  * *namelen_rlater, *lablen_r and *labstart_r may contain garbage.
 688  * Do not then call findlabel_next again.
 689  */
 690
 691 typedef enum {
 692   pdf_quoteok= 0x001
 693 } parsedomain_flags;
 694
 695 adns_status adns__parse_domain(adns_state ads, int serv, adns_query qu,
 696                                vbuf *vb, parsedomain_flags flags,
 697                                const byte *dgram, int dglen, int *cbyte_io,
 698                                int max);
 699 /* vb must already have been initialised; it will be reset if necessary.
 700  * If there is truncation, vb->used will be set to 0; otherwise
 701  * (if there is no error) vb will be null-terminated.
 702  * If there is an error vb and *cbyte_io may be left indeterminate.
 703  *
 704  * serv may be -1 and qu may be 0 - they are used for error reporting only.
 705  */
 706
 707 adns_status adns__parse_domain_more(findlabel_state *fls, adns_state ads,
 708                                     adns_query qu, vbuf *vb,
 709                                     parsedomain_flags flags,
 710                                     const byte *dgram);
 711 /* Like adns__parse_domain, but you pass it a pre-initialised findlabel_state,
 712  * for continuing an existing domain or some such of some kind.  Also, unlike
 713  * _parse_domain, the domain data will be appended to vb, rather than replacing
 714  * the existing contents.
 715  */
 716
 717 adns_status adns__findrr(adns_query qu, int serv,
 718                          const byte *dgram, int dglen, int *cbyte_io,
 719                          int *type_r, int *class_r, unsigned long *ttl_r,
 720                          int *rdlen_r, int *rdstart_r,
 721                          int *ownermatchedquery_r);
 722 /* Finds the extent and some of the contents of an RR in a datagram
 723  * and does some checks.  The datagram is *dgram, length dglen, and
 724  * the RR starts at *cbyte_io (which is updated afterwards to point
 725  * to the end of the RR).
 726  *
 727  * The type, class, TTL and RRdata length and start are returned iff
 728  * the corresponding pointer variables are not null.  type_r, class_r
 729  * and ttl_r may not be null.  The TTL will be capped.
 730  *
 731  * If ownermatchedquery_r != 0 then the owner domain of this
 732  * RR will be compared with that in the query (or, if the query
 733  * has gone to a CNAME lookup, with the canonical name).
 734  * In this case, *ownermatchedquery_r will be set to 0 or 1.
 735  * The query datagram (or CNAME datagram) MUST be valid and not truncated.
 736  *
 737  * If there is truncation then *type_r will be set to -1 and
 738  * *cbyte_io, *class_r, *rdlen_r, *rdstart_r and *eo_matched_r will be
 739  * undefined.
 740  *
 741  * qu must obviously be non-null.
 742  *
 743  * If an error is returned then *type_r will be undefined too.
 744  */
 745
 746 adns_status adns__findrr_anychk(adns_query qu, int serv,
 747                                 const byte *dgram, int dglen, int *cbyte_io,
 748                                 int *type_r, int *class_r,
 749                                 unsigned long *ttl_r,
 750                                 int *rdlen_r, int *rdstart_r,
 751                                 const byte *eo_dgram, int eo_dglen,
 752                                 int eo_cbyte, int *eo_matched_r);
 753 /* Like adns__findrr_checked, except that the datagram and
 754  * owner to compare with can be specified explicitly.
 755  *
 756  * If the caller thinks they know what the owner of the RR ought to
 757  * be they can pass in details in eo_*: this is another (or perhaps
 758  * the same datagram), and a pointer to where the putative owner
 759  * starts in that datagram.  In this case *eo_matched_r will be set
 760  * to 1 if the datagram matched or 0 if it did not.  Either
 761  * both eo_dgram and eo_matched_r must both be non-null, or they
 762  * must both be null (in which case eo_dglen and eo_cbyte will be ignored).
 763  * The eo datagram and contained owner domain MUST be valid and
 764  * untruncated.
 765  */
 766
 767 void adns__update_expires(adns_query qu, unsigned long ttl,
 768                           struct timeval now);
 769 /* Updates the `expires' field in the query, so that it doesn't exceed
 770  * now + ttl.
 771  */
 772
 773 int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len);
 774
 775 /* From event.c: */
 776
 777 void adns__tcp_broken(adns_state ads, const char *what, const char *why);
 778 /* what and why may be both 0, or both non-0. */
 779
 780 void adns__tcp_tryconnect(adns_state ads, struct timeval now);
 781
 782 void adns__autosys(adns_state ads, struct timeval now);
 783 /* Make all the system calls we want to if the application wants us to.
 784  * Must not be called from within adns internal processing functions,
 785  * lest we end up in recursive descent !
 786  */
 787
 788 void adns__must_gettimeofday(adns_state ads, const struct timeval **now_io,
 789                              struct timeval *tv_buf);
 790
 791 int adns__pollfds(adns_state ads, struct pollfd pollfds_buf[MAX_POLLFDS]);
 792 void adns__fdevents(adns_state ads,
 793                     const struct pollfd *pollfds, int npollfds,
 794                     int maxfd, const fd_set *readfds,
 795                     const fd_set *writefds, const fd_set *exceptfds,
 796                     struct timeval now, int *r_r);
 797 int adns__internal_check(adns_state ads,
 798                          adns_query *query_io,
 799                          adns_answer **answer,
 800                          void **context_r);
 801
 802 void adns__timeouts(adns_state ads, int act,
 803                     struct timeval **tv_io, struct timeval *tvbuf,
 804                     struct timeval now);
 805 /* If act is !0, then this will also deal with the TCP connection
 806  * if previous events broke it or require it to be connected.
 807  */
 808
 809 /* From check.c: */
 810
 811 void adns__consistency(adns_state ads, adns_query qu, consistency_checks cc);
 812
 813 /* Useful static inline functions: */
 814
 815 static inline int ctype_whitespace(int c) {
 816   return c==' ' || c=='\n' || c=='\t';
 817 }
 818 static inline int ctype_digit(int c) { return c>='0' && c<='9'; }
 819 static inline int ctype_alpha(int c) {
 820   return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
 821 }
 822 static inline int ctype_822special(int c) {
 823   return strchr("()<>@,;:\\\".[]",c) != 0;
 824 }
 825 static inline int ctype_domainunquoted(int c) {
 826   return ctype_alpha(c) || ctype_digit(c) || (strchr("-_/+",c) != 0);
 827 }
 828
 829 static inline int errno_resources(int e) { return e==ENOMEM || e==ENOBUFS; }
 830
 831 /* Useful macros */
 832
 833 #define MEM_ROUND(sz)                                           \
 834   (( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) ) \
 835    * sizeof(union maxalign) )
 836
 837 #define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff)
 838 #define GET_B(cb,tv) ((tv)= GETIL_B((cb)))
 839 #define GET_W(cb,tv) ((tv)=0,(tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv))
 840 #define GET_L(cb,tv) ( (tv)=0,                          \
 841                        (tv)|=(GETIL_B((cb))<<24),       \
 842                        (tv)|=(GETIL_B((cb))<<16),       \
 843                        (tv)|=(GETIL_B((cb))<<8),        \
 844                        (tv)|=GETIL_B(cb),               \
 845                        (tv) )
 846
 847 #endif