chiark / gitweb /
regress: Move case-*.in opening to shlib playback_prepare
[adns.git] / src / internal.h
index 0b39418433c859b464aa2c19606769e5dd728e0c..121c6d8fb36afd9f3e12edd1f388384a2266f007 100644 (file)
@@ -6,14 +6,15 @@
  */
 /*
  *  This file is part of adns, which is
- *    Copyright (C) 1997-2000,2003,2006  Ian Jackson
+ *    Copyright (C) 1997-2000,2003,2006,2014-2016,2020  Ian Jackson
+ *    Copyright (C) 2014  Mark Wooding
  *    Copyright (C) 1999-2000,2003,2006  Tony Finch
  *    Copyright (C) 1991 Massachusetts Institute of Technology
  *  (See the file INSTALL for full details.)
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2, or (at your option)
+ *  the Free Software Foundation; either version 3, or (at your option)
  *  any later version.
  *
  *  This program is distributed in the hope that it will be useful,
@@ -22,8 +23,7 @@
  *  GNU General Public License for more details.
  *
  *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software Foundation,
- *  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *  along with this program; if not, write to the Free Software Foundation.
  */
 
 #ifndef ADNS_INTERNAL_H_INCLUDED
@@ -39,6 +39,7 @@ typedef unsigned char byte;
 #include <errno.h>
 #include <string.h>
 #include <stdlib.h>
+#include <stdbool.h>
 
 #include <sys/time.h>
 
@@ -52,7 +53,7 @@ typedef unsigned char byte;
 
 /* Configuration and constants */
 
-#define MAXSERVERS 5
+#define MAXSERVERS 5 /* do not increase beyond no. of bits in `unsigned'! */
 #define MAXSORTLIST 15
 #define UDPMAXRETRIES 15
 #define UDPRETRYMS 2000
@@ -69,9 +70,6 @@ typedef unsigned char byte;
 #define DNS_IDOFFSET 0
 #define DNS_CLASS_IN 1
 
-#define DNS_INADDR_ARPA "in-addr", "arpa"
-#define DNS_IP6_ARPA "ip6", "arpa"
-
 #define MAX_POLLFDS  ADNS_POLLFDS_RECOMMENDED
 
 /* Some preprocessor hackery */
@@ -97,7 +95,8 @@ typedef unsigned char byte;
 
 typedef enum {
   cc_user,
-  cc_entex,
+  cc_enter,
+  cc_exit,
   cc_freq
 } consistency_checks;
 
@@ -131,10 +130,10 @@ typedef struct {
   struct timeval now;
 } parseinfo;
 
-#define NREVDOMAINS 2                  /* keep in sync with addrfam! */
+#define MAXREVLABELS 34                /* keep in sync with addrfam! */
 struct revparse_state {
-  unsigned map;                                /* which domains are still live */
-  byte ipv[NREVDOMAINS][32];           /* address components so far */
+  uint16_t labstart[MAXREVLABELS];
+  uint8_t lablen[MAXREVLABELS];
 };
 
 union checklabel_state {
@@ -172,7 +171,7 @@ typedef struct typeinfo {
    * Previously, used alloc_interim, now use alloc_final.
    */
 
-  adns_status (*convstring)(vbuf *vb, const void *data);
+  adns_status (*convstring)(vbuf *vb, adns_rrtype, const void *data);
   /* Converts the RR data to a string representation in vbuf.
    * vbuf will be appended to (it must have been initialised),
    * and will not be null-terminated by convstring.
@@ -198,7 +197,8 @@ typedef struct typeinfo {
 
   adns_status (*checklabel)(adns_state ads, adns_queryflags flags,
                            union checklabel_state *cls, qcontext *ctx,
-                           int labnum, const char *label, int lablen);
+                           int labnum, const char *dgram,
+                           int labstart, int lablen);
   /* Check a label from the query domain string.  The label is not
    * necessarily null-terminated.  The hook can refuse the query's submission
    * by returning a nonzero status.  State can be stored in *cls between
@@ -208,7 +208,7 @@ typedef struct typeinfo {
    * because lablen is zero.
    */
 
-  void (*postsort)(adns_state ads, void *array, int nrrs,int rrsz,
+  void (*postsort)(adns_state ads, void *array, int nrrs, int rrsz,
                   const struct typeinfo *typei);
   /* Called immediately after the RRs have been sorted, and may rearrange
    * them.  (This is really for the benefit of SRV's bizarre weighting
@@ -230,7 +230,7 @@ typedef struct typeinfo {
 adns_status adns__ckl_hostname(adns_state ads, adns_queryflags flags,
                               union checklabel_state *cls,
                               qcontext *ctx, int labnum,
-                              const char *label, int lablen);
+                              const char *dgram, int labstart, int lablen);
   /* implemented in query.c, used by types.c as default
    * and as part of implementation for some fancier types
    * doesn't require any state */
@@ -247,7 +247,7 @@ union maxalign {
   void *p;
   void (*fp)(void);
   union maxalign *up;
-} data;
+};
 
 struct adns__query {
   adns_state ads;
@@ -298,7 +298,8 @@ struct adns__query {
   int id, flags, retries;
   int udpnextserver;
   unsigned long udpsent; /* bitmap indexed by server */
-  struct timeval timeout;
+  int timeout_ms;
+  struct timeval timeout_started;
   time_t expires; /* Earliest expiry time of any record we used. */
 
   qcontext ctx;
@@ -372,9 +373,10 @@ struct adns__state {
   int configerrno;
   struct query_queue udpw, tcpw, childw, output, intdone;
   adns_query forallnext;
-  int nextid, tcpsocket;
-  struct udpsocket { int af; int fd; } udpsocket[MAXUDP];
-  int nudp;
+  unsigned nextid;
+  int tcpsocket;
+  struct udpsocket { int af; int fd; } udpsockets[MAXUDP];
+  int nudpsockets;
   vbuf tcpsend, tcprecv;
   int nservers, nsortlist, nsearchlist, searchndots, tcpserver, tcprecv_skip;
   enum adns__tcpstate {
@@ -395,6 +397,7 @@ struct adns__state {
     adns_sockaddr base, mask;
   } sortlist[MAXSORTLIST];
   char **searchlist;
+  unsigned config_report_unknown:1;
   unsigned short rand48xsubi[3];
 };
 
@@ -451,8 +454,9 @@ extern const void *adns__sockaddr_addr(const struct sockaddr *sa);
  */
 
 char *adns__sockaddr_ntoa(const struct sockaddr *sa, char *buf);
-/* Convert sa to a string, and write it to buf, which must be at least
- * ADNS_ADDR2TEXT_BUFLEN bytes long (unchecked).  Return buf; can't fail.
+/* Converts sa to a string, and writes it to buf, which must be at
+ * least ADNS_ADDR2TEXT_BUFLEN bytes long (unchecked).  Returns buf;
+ * can't fail.
  */
 
 extern int adns__make_reverse_domain(const struct sockaddr *sa,
@@ -470,24 +474,26 @@ extern int adns__make_reverse_domain(const struct sockaddr *sa,
  * allocate an output buffer failed.
  */
 
-extern int adns__revparse_label(struct revparse_state *rps, int labnum,
-                               const char *label, int lablen);
+extern bool adns__revparse_label(struct revparse_state *rps, int labnum,
+                                const char *dgram,
+                                int labstart, int lablen);
 /* Parse a label in a reverse-domain name, given its index labnum (starting
  * from zero), a pointer to its contents (which need not be null-terminated),
  * and its length.  The state in *rps is initialized implicitly when labnum
  * is zero.
  *
- * Returns zero if the parse was successful, nonzero if the domain name is
- * definitely invalid and the parse must be abandoned.
+ * Returns 1 if the parse is proceeding successfully, 0 if the domain
+ * name is definitely invalid and the parse must be abandoned.
  */
 
-extern int adns__revparse_done(struct revparse_state *rps, int nlabels,
-                              adns_rrtype *rrtype_r, adns_sockaddr *addr_r);
+extern bool adns__revparse_done(struct revparse_state *rps,
+                               const char *dgram, int nlabels,
+                               adns_rrtype *rrtype_r, adns_sockaddr *addr_r);
 /* Finishes parsing a reverse-domain name, given the total number of
  * labels in the name.  On success, fills in the af and protocol
  * address in *addr_r, and the forward query type in *rrtype_r
- * (because that turns out to be useful).  Returns nonzero if the
- * parse must be abandoned.
+ * (because that turns out to be useful).  Returns 1 if the parse
+ * was successful.
  */
 
 /* From setup.c: */
@@ -705,7 +711,7 @@ void adns__reset_preserved(adns_query qu);
 
 void adns__cancel(adns_query qu);
 void adns__query_done(adns_query qu);
-void adns__query_fail(adns_query qu, adns_status stat);
+void adns__query_fail(adns_query qu, adns_status st);
 void adns__cancel_children(adns_query qu);
 
 void adns__returning(adns_state ads, adns_query qu);
@@ -716,6 +722,8 @@ void adns__returning(adns_state ads, adns_query qu);
  * external-faciing functions which call adns__returning should
  * normally be avoided in internal code. */
 
+void adns__intdone_process(adns_state ads);
+
 /* From reply.c: */
 
 void adns__procdgram(adns_state ads, const byte *dgram, int len,
@@ -863,7 +871,7 @@ void adns__update_expires(adns_query qu, unsigned long ttl,
  * now + ttl.
  */
 
-int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len);
+bool adns__labels_equal(const byte *a, int al, const byte *b, int bl);
 
 /* From event.c: */
 
@@ -878,6 +886,15 @@ void adns__autosys(adns_state ads, struct timeval now);
  * lest we end up in recursive descent !
  */
 
+static inline void
+adns__timeout_set(adns_query qu, struct timeval now, long ms)
+  { qu->timeout_ms= ms; qu->timeout_started= now; }
+
+static inline void
+adns__timeout_clear(adns_query qu)
+  { qu->timeout_ms= 0; timerclear(&qu->timeout_started); }
+
+
 void adns__must_gettimeofday(adns_state ads, const struct timeval **now_io,
                             struct timeval *tv_buf);
 /* Call with care - might reentrantly cause queries to be completed! */
@@ -913,6 +930,9 @@ static inline int ctype_digit(int c) { return c>='0' && c<='9'; }
 static inline int ctype_alpha(int c) {
   return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
 }
+static inline int ctype_toupper(int c) {
+  return ctype_alpha(c) ? (c & ~32) : c;
+}
 static inline int ctype_822special(int c) {
   return strchr("()<>@,;:\\\".[]",c) != 0;
 }
@@ -928,7 +948,7 @@ static inline int errno_resources(int e) { return e==ENOMEM || e==ENOBUFS; }
   (( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) )        \
    * sizeof(union maxalign) )
 
-#define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff)
+#define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ffu)
 #define GET_B(cb,tv) ((tv)= GETIL_B((cb)))
 #define GET_W(cb,tv) ((tv)=0,(tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv))
 #define GET_L(cb,tv) ( (tv)=0,                         \