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 Copyright (C) 1997, 1998 Ian Jackson
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2, or (at your option)
  13  *  any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with this program; if not, write to the Free Software Foundation,
  22  *  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  */
  24
  25 #ifndef ADNS_INTERNAL_H_INCLUDED
  26 #define ADNS_INTERNAL_H_INCLUDED
  27
  28 #define PRINTFFORMAT(a,b) __attribute__((format(printf,a,b)))
  29 typedef unsigned char byte;
  30
  31 #include <stdarg.h>
  32 #include <assert.h>
  33 #include <unistd.h>
  34
  35 #include <sys/time.h>
  36
  37 #include "adns.h"
  38
  39 /* Configuration and constants */
  40
  41 #define MAXSERVERS 5
  42 #define UDPMAXRETRIES /*15*/5
  43 #define UDPRETRYMS 2000
  44 #define TCPMS 30000
  45 #define LOCALRESOURCEMS 20
  46
  47 #define DNS_PORT 53
  48 #define DNS_MAXUDP 512
  49 #define DNS_MAXDOMAIN 255
  50 #define DNS_HDRSIZE 12
  51 #define DNS_CLASS_IN 1
  52
  53 #define DNS_INADDR_ARPA "in-addr", "arpa"
  54
  55 typedef enum {
  56   rcode_noerror,
  57   rcode_formaterror,
  58   rcode_servfail,
  59   rcode_nxdomain,
  60   rcode_notimp,
  61   rcode_refused
  62 } dns_rcode;
  63
  64 /* Shared data structures */
  65
  66 typedef union {
  67   adns_status status;
  68   char *cp;
  69   adns_rrtype type;
  70   int i;
  71   struct in_addr ia;
  72   unsigned long ul;
  73 } rr_align;
  74
  75 typedef struct {
  76   int used, avail;
  77   byte *buf;
  78 } vbuf;
  79
  80 typedef struct {
  81   adns_state ads;
  82   adns_query qu;
  83   int serv;
  84   const byte *dgram;
  85   int dglen, nsstart, nscount, arcount;
  86   struct timeval now;
  87 } parseinfo;
  88
  89 typedef struct {
  90   adns_rrtype type;
  91   const char *rrtname;
  92   const char *fmtname;
  93   int rrsz;
  94
  95   void (*makefinal)(adns_query qu, void *data);
  96   /* Change memory management of *data.
  97    * Previously, used alloc_interim, now use alloc_final.
  98    */
  99
 100   adns_status (*convstring)(vbuf *vb, const void *data);
 101   /* Converts the RR data to a string representation in vbuf.
 102    * vbuf will be appended to (it must have been initialised),
 103    * and will not be null-terminated by convstring.
 104    */
 105
 106   adns_status (*parse)(const parseinfo *pai, int cbyte, int max, void *store_r);
 107   /* Parse one RR, in dgram of length dglen, starting at cbyte and
 108    * extending until at most max.
 109    *
 110    * The RR should be stored at *store_r, of length qu->typei->rrsz.
 111    *
 112    * If there is an overrun which might indicate truncation, it should set
 113    * *rdstart to -1; otherwise it may set it to anything else positive.
 114    *
 115    * nsstart is the offset of the authority section.
 116    */
 117
 118   int (*diff_needswap)(const void *datap_a, const void *datap_b);
 119   /* Returns !0 if RR a should be strictly after RR b in the sort order,
 120    * 0 otherwise.  Must not fail.
 121    */
 122 } typeinfo;
 123
 124 typedef struct allocnode {
 125   struct allocnode *next, *back;
 126 } allocnode;
 127
 128 union maxalign {
 129   byte d[1];
 130   struct in_addr ia;
 131   long l;
 132   void *p;
 133   void (*fp)(void);
 134   union maxalign *up;
 135 } data;
 136
 137 typedef struct {
 138   void *ext;
 139   void (*callback)(adns_query parent, adns_query child);
 140   union {
 141     adns_rr_addr ptr_parent_addr;
 142     adns_rr_hostaddr *hostaddr;
 143   } info;
 144 } qcontext;
 145
 146 struct adns__query {
 147   adns_state ads;
 148   enum { query_udp, query_tcpwait, query_tcpsent, query_child, query_done } state;
 149   adns_query back, next, parent;
 150   struct { adns_query head, tail; } children;
 151   struct { adns_query back, next; } siblings;
 152   struct { allocnode *head, *tail; } allocations;
 153   int interim_allocd;
 154   void *final_allocspace;
 155
 156   const typeinfo *typei;
 157   byte *query_dgram;
 158   int query_dglen;
 159
 160   vbuf vb;
 161   /* General-purpose messing-about buffer.
 162    * Wherever a `big' interface is crossed, this may be corrupted/changed
 163    * unless otherwise specified.
 164    */
 165
 166   adns_answer *answer;
 167   /* This is allocated when a query is submitted, to avoid being unable
 168    * to relate errors to queries if we run out of memory.  During
 169    * query processing status, rrs is 0.  cname is set if
 170    * we found a cname (this corresponds to cname_dgram in the query
 171    * structure).  type is set from the word go.  nrrs and rrs
 172    * are set together, when we find how many rrs there are.
 173    */
 174
 175   byte *cname_dgram;
 176   int cname_dglen, cname_begin;
 177   /* If non-0, has been allocated using . */
 178
 179   int id, flags, udpretries;
 180   int udpnextserver;
 181   unsigned long udpsent, tcpfailed; /* bitmap indexed by server */
 182   struct timeval timeout;
 183
 184   qcontext ctx;
 185
 186   /* Possible states:
 187    *
 188    *  state   Queue   child  id   nextudpserver  sentudp     failedtcp
 189    *
 190    *  udp     NONE    null   >=0  0              zero        zero
 191    *  udp     timew   null   >=0  any            nonzero     zero
 192    *  udp     NONE    null   >=0  any            nonzero     zero
 193    *
 194    *  tcpwait timew   null   >=0  irrelevant     zero        any
 195    *  tcpsent timew   null   >=0  irrelevant     zero        any
 196    *
 197    *  child   childw  set    >=0  irrelevant     irrelevant  irrelevant
 198    *  done    output  null   -1   irrelevant     irrelevant  irrelevant
 199    *
 200    *                          +------------------------+
 201    *             START -----> |      udp/NONE          |
 202    *                          +------------------------+
 203    *                         /                       |\  \
 204    *        too big for UDP /             UDP timeout  \  \ send via UDP
 205    *        do this ASAP!  /              more retries  \  \   do this ASAP!
 206    *                     |_                  desired     \  _|
 207    *              +---------------+                     +-----------+
 208    *              | tcpwait/timew | ____                | udp/timew |
 209    *              +---------------+     \               +-----------+
 210    *                    |  ^             |                 | |
 211    *     TCP conn'd;    |  | TCP died    |                 | |
 212    *     send via TCP   |  | more        |     UDP timeout | |
 213    *     do this ASAP!  |  | servers     |      no more    | |
 214    *                    v  | to try      |      retries    | |
 215    *              +---------------+      |      desired    | |
 216    *              | tcpsent/timew | ____ |                 | |
 217    *              +---------------+     \|                 | |
 218    *                  \   \ TCP died     | TCP             | |
 219    *                   \   \ no more     | timeout         / |
 220    *                    \   \ servers    |                /  |
 221    *                     \   \ to try    |               /   |
 222    *                  got \   \          v             |_    / got
 223    *                 reply \   _| +------------------+      / reply
 224    *                        \     | done/output FAIL |     /
 225    *                         \    +------------------+    /
 226    *                          \                          /
 227    *                           _|                      |_
 228    *                             (..... got reply ....)
 229    *                              /                   \
 230    *        need child query/ies /                     \ no child query
 231    *                            /                       \
 232    *                          |_                         _|
 233    *                +--------------+                   +----------------+
 234    *                | child/childw | ----------------> | done/output OK |
 235    *                +--------------+  children done    +----------------+
 236    */
 237 };
 238
 239 struct adns__state {
 240   adns_initflags iflags;
 241   FILE *diagfile;
 242   struct { adns_query head, tail; } timew, childw, output;
 243   int nextid, udpsocket, tcpsocket;
 244   vbuf tcpsend, tcprecv;
 245   int nservers, tcpserver;
 246   enum adns__tcpstate { server_disconnected, server_connecting, server_ok } tcpstate;
 247   struct timeval tcptimeout;
 248   struct server {
 249     struct in_addr addr;
 250   } servers[MAXSERVERS];
 251 };
 252
 253 /* From setup.c: */
 254
 255 int adns__setnonblock(adns_state ads, int fd); /* => errno value */
 256
 257 /* From general.c: */
 258
 259 void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent,
 260                  int serv, adns_query qu, const char *fmt, va_list al);
 261
 262 void adns__debug(adns_state ads, int serv, adns_query qu,
 263                  const char *fmt, ...) PRINTFFORMAT(4,5);
 264 void adns__warn(adns_state ads, int serv, adns_query qu,
 265                 const char *fmt, ...) PRINTFFORMAT(4,5);
 266 void adns__diag(adns_state ads, int serv, adns_query qu,
 267                 const char *fmt, ...) PRINTFFORMAT(4,5);
 268
 269 int adns__vbuf_ensure(vbuf *vb, int want);
 270 int adns__vbuf_appendstr(vbuf *vb, const char *data); /* does not include nul */
 271 int adns__vbuf_append(vbuf *vb, const byte *data, int len);
 272 /* 1=>success, 0=>realloc failed */
 273 void adns__vbuf_appendq(vbuf *vb, const byte *data, int len);
 274 void adns__vbuf_init(vbuf *vb);
 275 void adns__vbuf_free(vbuf *vb);
 276
 277 const char *adns__diag_domain(adns_state ads, int serv, adns_query qu,
 278                               vbuf *vb, const byte *dgram, int dglen, int cbyte);
 279 /* Unpicks a domain in a datagram and returns a string suitable for
 280  * printing it as.  Never fails - if an error occurs, it will
 281  * return some kind of string describing the error.
 282  *
 283  * serv may be -1 and qu may be 0.  vb must have been initialised,
 284  * and will be left in an arbitrary consistent state.
 285  *
 286  * Returns either vb->buf, or a pointer to a string literal.  Do not modify
 287  * vb before using the return value.
 288  */
 289
 290 void adns__isort(void *array, int nobjs, int sz, void *tempbuf,
 291                  int (*needswap)(const void *a, const void *b));
 292 /* Does an insertion sort of array which must contain nobjs objects
 293  * each sz bytes long.  tempbuf must point to a buffer at least
 294  * sz bytes long.  needswap should return !0 if a>b (strictly, ie
 295  * wrong order) 0 if a<=b (ie, order is fine).
 296  */
 297
 298 /* From transmit.c: */
 299
 300 adns_status adns__mkquery(adns_state ads, vbuf *vb, int *id_r,
 301                           const char *owner, int ol,
 302                           const typeinfo *typei, adns_queryflags flags);
 303 /* Assembles a query packet in vb, and returns id at *id_r. */
 304
 305 adns_status adns__mkquery_frdgram(adns_state ads, vbuf *vb, int *id_r,
 306                                   const byte *qd_dgram, int qd_dglen, int qd_begin,
 307                                   adns_rrtype type, adns_queryflags flags);
 308 /* Same as adns__mkquery, but takes the owner domain from an existing datagram.
 309  * That domain must be correct and untruncated.
 310  */
 311
 312 void adns__query_tcp(adns_query qu, struct timeval now);
 313 /* Query must be in state tcpwait/timew; it will be moved to a new state
 314  * if possible and no further processing can be done on it for now.
 315  * (Resulting state is one of tcpwait/timew (if server not connected),
 316  *  tcpsent/timew, child/childw or done/output.)
 317  *
 318  * adns__tcp_tryconnect should already have been called - _tcp
 319  * will only use an existing connection (if there is one), which it
 320  * may break.  If the conn list lost then the caller is responsible for any
 321  * reestablishment and retry.
 322  */
 323
 324 void adns__query_udp(adns_query qu, struct timeval now);
 325 /* Query must be in state udp/NONE; it will be moved to a new state,
 326  * and no further processing can be done on it for now.
 327  * (Resulting state is one of udp/timew, tcpwait/timew (if server not connected),
 328  *  tcpsent/timew, child/childw or done/output.)
 329  */
 330
 331 /* From query.c: */
 332
 333 int adns__internal_submit(adns_state ads, adns_query *query_r,
 334                           const typeinfo *typei, vbuf *qumsg_vb, int id,
 335                           adns_queryflags flags, struct timeval now,
 336                           adns_status failstat, const qcontext *ctx);
 337 /* Submits a query (for internal use, called during external submits).
 338  *
 339  * The new query is returned in *query_r, or we return adns_s_nomemory.
 340  *
 341  * The query datagram should already have been assembled in qumsg_vb;
 342  * the memory for it is _taken over_ by this routine whether it
 343  * succeeds or fails (if it succeeds, the vbuf is reused for qu->vb).
 344  *
 345  * If failstat is nonzero then if we are successful in creating the query
 346  * it is immediately failed with code failstat (but _submit still succeds).
 347  *
 348  * *ctx is copied byte-for-byte into the query.
 349  */
 350
 351 void *adns__alloc_interim(adns_query qu, size_t sz);
 352 /* Allocates some memory, and records which query it came from
 353  * and how much there was.
 354  *
 355  * If an error occurs in the query, all its memory is simply freed.
 356  *
 357  * If the query succeeds, one large buffer will be made which is
 358  * big enough for all these allocations, and then adns__alloc_final
 359  * will get memory from this buffer.
 360  *
 361  * _alloc_interim can fail (and return 0).
 362  * The caller must ensure that the query is failed.
 363  *
 364  * adns__alloc_interim_{only,fail}(qu,0) will not return 0,
 365  * but it will not necessarily return a distinct pointer each time.
 366  */
 367
 368 void adns__transfer_interim(adns_query from, adns_query to, void *block, size_t sz);
 369 /* Transfers an interim allocation from one query to another, so that
 370  * the `to' query will have room for the data when we get to makefinal
 371  * and so that the free will happen when the `to' query is freed
 372  * rather than the `from' query.
 373  *
 374  * It is legal to call adns__transfer_interim with a null pointer; this
 375  * has no effect.
 376  */
 377
 378 void *adns__alloc_mine(adns_query qu, size_t sz);
 379 /* Like _interim, but does not record the length for later
 380  * copying into the answer.  This just ensures that the memory
 381  * will be freed when we're done with the query.
 382  */
 383
 384 void *adns__alloc_final(adns_query qu, size_t sz);
 385 /* Cannot fail, and cannot return 0.
 386  */
 387
 388 void adns__makefinal_block(adns_query qu, void **blpp, size_t sz);
 389 void adns__makefinal_str(adns_query qu, char **strp);
 390
 391 void adns__reset_cnameonly(adns_query qu);
 392 /* Resets all of the memory management stuff etc. to
 393  * take account of only the CNAME.  Used when we find an error somewhere
 394  * and want to just report the error (with perhaps CNAME info), and also
 395  * when we're halfway through RRs in a datagram and discover that we
 396  * need to retry the query.
 397  */
 398
 399 void adns__query_done(adns_query qu);
 400 void adns__query_fail(adns_query qu, adns_status stat);
 401
 402 /* From reply.c: */
 403
 404 void adns__procdgram(adns_state ads, const byte *dgram, int len,
 405                      int serv, struct timeval now);
 406
 407 /* From types.c: */
 408
 409 const typeinfo *adns__findtype(adns_rrtype type);
 410
 411 /* From parse.c: */
 412
 413 typedef struct {
 414   adns_state ads;
 415   adns_query qu;
 416   int serv;
 417   const byte *dgram;
 418   int dglen, max, cbyte, namelen;
 419   int *dmend_r;
 420 } findlabel_state;
 421
 422 void adns__findlabel_start(findlabel_state *fls, adns_state ads,
 423                            int serv, adns_query qu,
 424                            const byte *dgram, int dglen, int max,
 425                            int dmbegin, int *dmend_rlater);
 426 /* Finds labels in a domain in a datagram.
 427  *
 428  * Call this routine first.
 429  * dmend_rlater may be null.  ads (and of course fls) may not be.
 430  * serv may be -1, qu may be null - they are for error reporting.
 431  */
 432
 433 adns_status adns__findlabel_next(findlabel_state *fls, int *lablen_r, int *labstart_r);
 434 /* Then, call this one repeatedly.
 435  *
 436  * It will return adns_s_ok if all is well, and tell you the length
 437  * and start of successive labels.  labstart_r may be null, but
 438  * lablen_r must not be.
 439  *
 440  * After the last label, it will return with *lablen_r zero.
 441  * Do not then call it again; instead, just throw away the findlabel_state.
 442  *
 443  * *dmend_rlater will have been set to point to the next part of
 444  * the datagram after the label (or after the uncompressed part,
 445  * if compression was used).  *namelen_rlater will have been set
 446  * to the length of the domain name (total length of labels plus
 447  * 1 for each intervening dot).
 448  *
 449  * If the datagram appears to be truncated, *lablen_r will be -1.
 450  * *dmend_rlater, *labstart_r and *namelen_r may contain garbage.
 451  * Do not call _next again.
 452  *
 453  * There may also be errors, in which case *dmend_rlater,
 454  * *namelen_rlater, *lablen_r and *labstart_r may contain garbage.
 455  * Do not then call findlabel_next again.
 456  */
 457
 458 typedef enum {
 459   pdf_quoteok= 0x001
 460 } parsedomain_flags;
 461
 462 adns_status adns__parse_domain(adns_state ads, int serv, adns_query qu,
 463                                vbuf *vb, parsedomain_flags flags,
 464                                const byte *dgram, int dglen, int *cbyte_io, int max);
 465 /* vb must already have been initialised; it will be reset if necessary.
 466  * If there is truncation, vb->used will be set to 0; otherwise
 467  * (if there is no error) vb will be null-terminated.
 468  * If there is an error vb and *cbyte_io may be left indeterminate.
 469  *
 470  * serv may be -1 and qu may be 0 - they are used for error reporting only.
 471  */
 472
 473 adns_status adns__findrr(adns_query qu, int serv,
 474                          const byte *dgram, int dglen, int *cbyte_io,
 475                          int *type_r, int *class_r, int *rdlen_r, int *rdstart_r,
 476                          int *ownermatchedquery_r);
 477 /* Finds the extent and some of the contents of an RR in a datagram
 478  * and does some checks.  The datagram is *dgram, length dglen, and
 479  * the RR starts at *cbyte_io (which is updated afterwards to point
 480  * to the end of the RR).
 481  *
 482  * The type, class and RRdata length and start are returned iff
 483  * the corresponding pointer variables are not null.  type_r and
 484  * class_r may not be null.
 485  *
 486  * If ownermatchedquery_r != 0 then the owner domain of this
 487  * RR will be compared with that in the query (or, if the query
 488  * has gone to a CNAME lookup, with the canonical name).
 489  * In this case, *ownermatchedquery_r will be set to 0 or 1.
 490  * The query datagram (or CNAME datagram) MUST be valid and not truncated.
 491  *
 492  * If there is truncation then *type_r will be set to -1 and
 493  * *cbyte_io, *class_r, *rdlen_r, *rdstart_r and *eo_matched_r will be
 494  * undefined.
 495  *
 496  * qu must obviously be non-null.
 497  *
 498  * If an error is returned then *type_r will be undefined too.
 499  */
 500
 501 adns_status adns__findrr_anychk(adns_query qu, int serv,
 502                                 const byte *dgram, int dglen, int *cbyte_io,
 503                                 int *type_r, int *class_r, int *rdlen_r, int *rdstart_r,
 504                                 const byte *eo_dgram, int eo_dglen, int eo_cbyte,
 505                                 int *eo_matched_r);
 506 /* Like adns__findrr_checked, except that the datagram and
 507  * owner to compare with can be specified explicitly.
 508  *
 509  * If the caller thinks they know what the owner of the RR ought to
 510  * be they can pass in details in eo_*: this is another (or perhaps
 511  * the same datagram), and a pointer to where the putative owner
 512  * starts in that datagram.  In this case *eo_matched_r will be set
 513  * to 1 if the datagram matched or 0 if it did not.  Either
 514  * both eo_dgram and eo_matched_r must both be non-null, or they
 515  * must both be null (in which case eo_dglen and eo_cbyte will be ignored).
 516  * The eo datagram and contained owner domain MUST be valid and
 517  * untruncated.
 518  */
 519
 520 int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len);
 521
 522 /* From event.c: */
 523
 524 void adns__tcp_broken(adns_state ads, const char *what, const char *why);
 525 void adns__tcp_tryconnect(adns_state ads, struct timeval now);
 526
 527 void adns__autosys(adns_state ads, struct timeval now);
 528 /* Make all the system calls we want to if the application wants us to. */
 529
 530 /* Useful static inline functions: */
 531
 532 static inline void timevaladd(struct timeval *tv_io, long ms) {
 533   struct timeval tmp;
 534   assert(ms>=0);
 535   tmp= *tv_io;
 536   tmp.tv_usec += (ms%1000)*1000000;
 537   tmp.tv_sec += ms/1000;
 538   if (tmp.tv_usec >= 1000000) { tmp.tv_sec++; tmp.tv_usec -= 1000; }
 539   *tv_io= tmp;
 540 }
 541
 542 static inline int ctype_whitespace(int c) { return c==' ' || c=='\n' || c=='\t'; }
 543 static inline int ctype_digit(int c) { return c>='0' && c<='9'; }
 544 static inline int ctype_alpha(int c) {
 545   return (c >= 'a' && c <= 'z') || (c >= 'A' || c <= 'Z');
 546 }
 547
 548 /* Useful macros */
 549
 550 #define MEM_ROUND(sz) \
 551   (( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) ) \
 552    * sizeof(union maxalign) )
 553
 554 #define LIST_INIT(list) ((list).head= (list).tail= 0)
 555
 556 #define LIST_UNLINK_PART(list,node,part) \
 557   do { \
 558     if ((node)->part back) (node)->part back->part next= (node)->part next; \
 559       else                                  (list).head= (node)->part next; \
 560     if ((node)->part next) (node)->part next->part back= (node)->part back; \
 561       else                                  (list).tail= (node)->part back; \
 562   } while(0)
 563
 564 #define LIST_LINK_TAIL_PART(list,node,part) \
 565   do { \
 566     (node)->part next= 0; \
 567     (node)->part back= (list).tail; \
 568     if ((list).tail) (list).tail->part next= (node); else (list).head= (node); \
 569     (list).tail= (node); \
 570   } while(0)
 571
 572 #define LIST_UNLINK(list,node) LIST_UNLINK_PART(list,node,)
 573 #define LIST_LINK_TAIL(list,node) LIST_LINK_TAIL_PART(list,node,)
 574
 575 #define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff)
 576 #define GET_B(cb,tv) ((tv)= GETIL_B((cb)))
 577 #define GET_W(cb,tv) ((tv)=0, (tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv))
 578
 579 #endif