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