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