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