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