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