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