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