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