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