chiark / gitweb /
More rearrangements and code.
[adns.git] / src / adns.h
index 69425aef7074d099e02b10aaf36255ea62a316cb..23c71efc49ab0a0f410fb2dd56c9a9a10e50e891 100644 (file)
@@ -10,10 +10,11 @@ typedef struct adns__state *adns_state;
 typedef struct adns__query *adns_query;
 
 typedef enum {
-  adns_if_noenv=      0x0001, /* do not look at environment */
-  adns_if_noerrprint= 0x0002, /* never print output to stderr */
-  adns_if_debug=      0x0004, /* print debugging output to stderr */
-  adns_if_noautosys=  0x0008, /* do not do full flow-of-control whenever we can */
+  adns_if_noenv=        0x0001, /* do not look at environment */
+  adns_if_noerrprint=   0x0002, /* never print output to stderr (_debug overrides) */
+  adns_if_noserverwarn= 0x0004, /* do not warn to stderr about duff nameservers etc */
+  adns_if_debug=        0x0008, /* enable all output to stderr plus debug msgs*/
+  adns_if_noautosys=    0x0010, /* do not make syscalls at every opportunity */
 } adns_initflags;
 
 typedef enum {
@@ -23,25 +24,25 @@ typedef enum {
 } adns_queryflags;
 
 typedef enum {
-  adns__rrttype_mask=  0x0fff,
-  adns__qtf_deref=     0x1000, /* dereference domains and produce extra data */
-  adns__qtf_mailconv=  0x2000, /* put @ between first and second labels */
-  adns_r_none=              0,
-  adns_r_a=                 1,
-  adns_r_ns_raw=            2,
-  adns_r_ns=                   adns_r_ns_raw|adns__qtf_deref,
-  adns_r_cname=             5,
-  adns_r_soa_raw=           6,
-  adns_r_soa=                  adns_r_soa_raw|adns__qtf_mailconv,
-  adns_r_null=             10,
-  adns_r_ptr_raw=          12,
-  adns_r_ptr=                  adns_r_ptr_raw|adns__qtf_deref,
-  adns_r_hinfo=            13,  
-  adns_r_mx_raw=           15,
-  adns_r_mx=                   adns_r_mx_raw|adns__qtf_deref,
-  adns_r_txt=              16,
-  adns_r_rp_raw=           17,
-  adns_r_rp=                   adns_r_rp_raw|adns__qtf_mailconv
+  adns__rrt_typemask=  0x0ffff,
+  adns__qtf_deref=     0x10000, /* dereference domains and produce extra data */
+  adns__qtf_mailconv=  0x20000, /* put @ between first and second labels */
+  adns_r_none=               0,
+  adns_r_a=                  1,
+  adns_r_ns_raw=             2,
+  adns_r_ns=                    adns_r_ns_raw|adns__qtf_deref,
+  adns_r_cname=              5,
+  adns_r_soa_raw=            6,
+  adns_r_soa=                   adns_r_soa_raw|adns__qtf_mailconv,
+  adns_r_null=              10,
+  adns_r_ptr_raw=           12,
+  adns_r_ptr=                   adns_r_ptr_raw|adns__qtf_deref,
+  adns_r_hinfo=             13,  
+  adns_r_mx_raw=            15,
+  adns_r_mx=                    adns_r_mx_raw|adns__qtf_deref,
+  adns_r_txt=               16,
+  adns_r_rp_raw=            17,
+  adns_r_rp=                    adns_r_rp_raw|adns__qtf_mailconv
 } adns_rrtype;
 
 /* In queries without qtf_anyquote, all domains must have standard
@@ -60,21 +61,24 @@ typedef enum {
 
 typedef enum {
   adns_s_ok,
-  adns_s_notresponding,
-  adns_s_serverfailure,
+  adns_s_timeout,
   adns_s_unknownqtype,
-  adns_s_remoteerror,
+  adns_s_nolocalmem,
   adns_s_max_tempfail= 99,
+  adns_s_inconsistent, /* PTR gives domain whose A does not match */
+  adns_s_badcname, /* CNAME found where actual record expected */
+  adns_s_max_misconfig= 199;
   adns_s_nxdomain,
   adns_s_norecord,
   adns_s_invaliddomain
 } adns_status;
 
-/* In dereferenced answers, multiple addresses show up as multiple
- * answers with all the dm pointers being the same.  If no
- * address is available (permanent failure) then INADDR_NONE is
- * used.
- */
+typedef struct {
+  char *dm;
+  adns_status astatus;
+  int naddrs; /* temp fail => -1, perm fail => 0, s_ok => >0 */
+  struct in_addr *addrs;
+} adns_dmaddr;
 
 typedef struct {
   adns_status status;
@@ -82,16 +86,16 @@ typedef struct {
   adns_rrtype type;
   int nrrs;
   union {
-    struct in_addr inaddr[1];                                          /* a */
-    char (*str)[1];                     /* ns_raw, cname, ptr, ptr_raw, txt */
-    struct { char *dm; struct in_addr addr; } dmaddr;                 /* ns */
-    struct { char *a, *b; } strpair[1];                /* hinfo, rp, rp_raw */
-    struct { int pref; char *dm; struct in_addr addr; } intdmaddr[1]; /* mx */
-    struct { int pref; char *str; } intstr[1]; /* mx_raw */
+    struct in_addr inaddr[1];                                                    /* a */
+    char (*str)[1];                               /* ns_raw, cname, ptr, ptr_raw, txt */
+    adns_dmaddr dmaddr[1];                                                      /* ns */
+    struct { char *a, *b; } strpair[1];                          /* hinfo, rp, rp_raw */
+    struct { int pref; adns_dmaddrs dmaddr; } intdmaddr[1];                     /* mx */
+    struct { int pref; char *str; } intstr[1];                              /* mx_raw */
     struct {
       char *ns0, *rp;
       unsigned long serial, refresh, retry, expire, minimum;
-    } soa[1]; /* soa, soa_raw */
+    } soa[1];                                                         /* soa, soa_raw */
     /* NULL is empty */
   } rrs;
 } adns_answer;
@@ -118,13 +122,14 @@ typedef struct {
  *  ands_check and _wait set *answer to 0.
  */
 
-int adns_init(adns_state *newstate_r, adns_initflags flags);
+int adns_init(adns_state *newstate_r, adns_initflags flags, FILE *diagfile/*0=>stderr*/);
 
 int adns_synchronous(adns_state ads,
                     const char *owner,
                     adns_rrtype type,
-                    int flags,
-                    adns_answer *answer);
+                    adns_queryflags flags,
+                    adns_answer **answer_r);
+/* Will not return EINTR. */
 
 /* NB: if you set adns_if_noautosys then _submit and _check do not
  * make any system calls; you must use adns_callback (possibly after
@@ -134,19 +139,20 @@ int adns_synchronous(adns_state ads,
 int adns_submit(adns_state ads,
                const char *owner,
                adns_rrtype type,
-               int flags,
+               adns_queryflags flags,
                void *context,
                adns_query *query_r);
 
 int adns_check(adns_state ads,
               adns_query *query_io,
-              adns_answer *answer,
-              void *context_r);
+              adns_answer **answer_r,
+              void **context_r);
 
 int adns_wait(adns_state ads,
              adns_query *query_io,
-             adns_answer *answer,
-             void *context_r);
+             adns_answer **answer_r,
+             void **context_r);
+/* Might return EINTR - if so, try again */
 
 void adns_cancel(adns_state ads, adns_query query);