3 * - declarations of private objects with external linkage (adns__*)
4 * - definitons of internal macros
5 * - comments regarding library data structures
8 * This file is part of adns, which is Copyright (C) 1997-1999 Ian Jackson
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)
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.
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.
25 #ifndef ADNS_INTERNAL_H_INCLUDED
26 #define ADNS_INTERNAL_H_INCLUDED
29 typedef unsigned char byte;
39 /* Configuration and constants */
42 #define MAXSORTLIST 15
43 #define UDPMAXRETRIES 15
44 #define UDPRETRYMS 2000
46 #define LOCALRESOURCEMS 20
47 #define MAXTTLBELIEVE (7*86400) /* any TTL > 7 days is capped */
50 #define DNS_MAXUDP 512
51 #define DNS_MAXDOMAIN 255
52 #define DNS_HDRSIZE 12
53 #define DNS_CLASS_IN 1
55 #define DNS_INADDR_ARPA "in-addr", "arpa"
66 /* Shared data structures */
87 int dglen, nsstart, nscount, arcount;
97 void (*makefinal)(adns_query qu, void *data);
98 /* Change memory management of *data.
99 * Previously, used alloc_interim, now use alloc_final.
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.
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.
112 * The RR should be stored at *store_r, of length qu->typei->rrsz.
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.
117 * nsstart is the offset of the authority section.
120 int (*diff_needswap)(adns_state ads, 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.
126 typedef struct allocnode {
127 struct allocnode *next, *back;
141 void (*callback)(adns_query parent, adns_query child);
143 adns_rr_addr ptr_parent_addr;
144 adns_rr_hostaddr *hostaddr;
150 enum { query_udp, query_tcpwait, query_tcpsent, query_child, query_done } state;
151 adns_query back, next, parent;
152 struct { adns_query head, tail; } children;
153 struct { adns_query back, next; } siblings;
154 struct { allocnode *head, *tail; } allocations;
156 void *final_allocspace;
158 const typeinfo *typei;
163 /* General-purpose messing-about buffer.
164 * Wherever a `big' interface is crossed, this may be corrupted/changed
165 * unless otherwise specified.
169 /* This is allocated when a query is submitted, to avoid being unable
170 * to relate errors to queries if we run out of memory. During
171 * query processing status, rrs is 0. cname is set if
172 * we found a cname (this corresponds to cname_dgram in the query
173 * structure). type is set from the word go. nrrs and rrs
174 * are set together, when we find how many rrs there are.
178 int cname_dglen, cname_begin;
179 /* If non-0, has been allocated using . */
181 int id, flags, udpretries;
183 unsigned long udpsent, tcpfailed; /* bitmap indexed by server */
184 struct timeval timeout;
185 time_t expires; /* Earliest expiry time of any record we used. */
191 * state Queue child id nextudpserver sentudp failedtcp
193 * udp NONE null >=0 0 zero zero
194 * udp timew null >=0 any nonzero zero
195 * udp NONE null >=0 any nonzero zero
197 * tcpwait timew null >=0 irrelevant zero any
198 * tcpsent timew null >=0 irrelevant zero any
200 * child childw set >=0 irrelevant irrelevant irrelevant
201 * done output null -1 irrelevant irrelevant irrelevant
203 * +------------------------+
204 * START -----> | udp/NONE |
205 * +------------------------+
207 * too big for UDP / UDP timeout \ \ send via UDP
208 * do this ASAP! / more retries \ \ do this ASAP!
210 * +---------------+ +-----------+
211 * | tcpwait/timew | ____ | udp/timew |
212 * +---------------+ \ +-----------+
214 * TCP conn'd; | | TCP died | | |
215 * send via TCP | | more | UDP timeout | |
216 * do this ASAP! | | servers | no more | |
217 * v | to try | retries | |
218 * +---------------+ | desired | |
219 * | tcpsent/timew | ____ | | |
220 * +---------------+ \| | |
221 * \ \ TCP died | TCP | |
222 * \ \ no more | timeout / |
226 * reply \ _| +------------------+ / reply
227 * \ | done/output FAIL | /
228 * \ +------------------+ /
231 * (..... got reply ....)
233 * need child query/ies / \ no child query
236 * +--------------+ +----------------+
237 * | child/childw | ----------------> | done/output OK |
238 * +--------------+ children done +----------------+
243 adns_initflags iflags;
246 struct { adns_query head, tail; } timew, childw, output;
247 int nextid, udpsocket, tcpsocket;
248 vbuf tcpsend, tcprecv;
249 int nservers, nsortlist, tcpserver;
250 enum adns__tcpstate { server_disconnected, server_connecting, server_ok } tcpstate;
251 struct timeval tcptimeout;
252 struct pollfd *pollfdsbuf; /* fixme: init and cleanup */
255 } servers[MAXSERVERS];
257 struct in_addr base, mask;
258 } sortlist[MAXSORTLIST];
263 int adns__setnonblock(adns_state ads, int fd); /* => errno value */
265 /* From general.c: */
267 void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent,
268 int serv, adns_query qu, const char *fmt, va_list al);
270 void adns__debug(adns_state ads, int serv, adns_query qu,
271 const char *fmt, ...) PRINTFFORMAT(4,5);
272 void adns__warn(adns_state ads, int serv, adns_query qu,
273 const char *fmt, ...) PRINTFFORMAT(4,5);
274 void adns__diag(adns_state ads, int serv, adns_query qu,
275 const char *fmt, ...) PRINTFFORMAT(4,5);
277 int adns__vbuf_ensure(vbuf *vb, int want);
278 int adns__vbuf_appendstr(vbuf *vb, const char *data); /* does not include nul */
279 int adns__vbuf_append(vbuf *vb, const byte *data, int len);
280 /* 1=>success, 0=>realloc failed */
281 void adns__vbuf_appendq(vbuf *vb, const byte *data, int len);
282 void adns__vbuf_init(vbuf *vb);
283 void adns__vbuf_free(vbuf *vb);
285 const char *adns__diag_domain(adns_state ads, int serv, adns_query qu,
286 vbuf *vb, const byte *dgram, int dglen, int cbyte);
287 /* Unpicks a domain in a datagram and returns a string suitable for
288 * printing it as. Never fails - if an error occurs, it will
289 * return some kind of string describing the error.
291 * serv may be -1 and qu may be 0. vb must have been initialised,
292 * and will be left in an arbitrary consistent state.
294 * Returns either vb->buf, or a pointer to a string literal. Do not modify
295 * vb before using the return value.
298 void adns__isort(void *array, int nobjs, int sz, void *tempbuf,
299 int (*needswap)(void *context, const void *a, const void *b),
301 /* Does an insertion sort of array which must contain nobjs objects
302 * each sz bytes long. tempbuf must point to a buffer at least
303 * sz bytes long. needswap should return !0 if a>b (strictly, ie
304 * wrong order) 0 if a<=b (ie, order is fine).
307 /* From transmit.c: */
309 adns_status adns__mkquery(adns_state ads, vbuf *vb, int *id_r,
310 const char *owner, int ol,
311 const typeinfo *typei, adns_queryflags flags);
312 /* Assembles a query packet in vb, and returns id at *id_r. */
314 adns_status adns__mkquery_frdgram(adns_state ads, vbuf *vb, int *id_r,
315 const byte *qd_dgram, int qd_dglen, int qd_begin,
316 adns_rrtype type, adns_queryflags flags);
317 /* Same as adns__mkquery, but takes the owner domain from an existing datagram.
318 * That domain must be correct and untruncated.
321 void adns__query_tcp(adns_query qu, struct timeval now);
322 /* Query must be in state tcpwait/timew; it will be moved to a new state
323 * if possible and no further processing can be done on it for now.
324 * (Resulting state is one of tcpwait/timew (if server not connected),
325 * tcpsent/timew, child/childw or done/output.)
327 * adns__tcp_tryconnect should already have been called - _tcp
328 * will only use an existing connection (if there is one), which it
329 * may break. If the conn list lost then the caller is responsible for any
330 * reestablishment and retry.
333 void adns__query_udp(adns_query qu, struct timeval now);
334 /* Query must be in state udp/NONE; it will be moved to a new state,
335 * and no further processing can be done on it for now.
336 * (Resulting state is one of udp/timew, tcpwait/timew (if server not connected),
337 * tcpsent/timew, child/childw or done/output.)
342 int adns__internal_submit(adns_state ads, adns_query *query_r,
343 const typeinfo *typei, vbuf *qumsg_vb, int id,
344 adns_queryflags flags, struct timeval now,
345 adns_status failstat, const qcontext *ctx);
346 /* Submits a query (for internal use, called during external submits).
348 * The new query is returned in *query_r, or we return adns_s_nomemory.
350 * The query datagram should already have been assembled in qumsg_vb;
351 * the memory for it is _taken over_ by this routine whether it
352 * succeeds or fails (if it succeeds, the vbuf is reused for qu->vb).
354 * If failstat is nonzero then if we are successful in creating the query
355 * it is immediately failed with code failstat (but _submit still succeds).
357 * *ctx is copied byte-for-byte into the query.
360 void *adns__alloc_interim(adns_query qu, size_t sz);
361 /* Allocates some memory, and records which query it came from
362 * and how much there was.
364 * If an error occurs in the query, all its memory is simply freed.
366 * If the query succeeds, one large buffer will be made which is
367 * big enough for all these allocations, and then adns__alloc_final
368 * will get memory from this buffer.
370 * _alloc_interim can fail (and return 0).
371 * The caller must ensure that the query is failed.
373 * adns__alloc_interim_{only,fail}(qu,0) will not return 0,
374 * but it will not necessarily return a distinct pointer each time.
377 void adns__transfer_interim(adns_query from, adns_query to, void *block, size_t sz);
378 /* Transfers an interim allocation from one query to another, so that
379 * the `to' query will have room for the data when we get to makefinal
380 * and so that the free will happen when the `to' query is freed
381 * rather than the `from' query.
383 * It is legal to call adns__transfer_interim with a null pointer; this
386 * _transfer_interim also ensures that the expiry time of the `to' query
387 * is no later than that of the `from' query, so that child queries'
388 * TTLs get inherited by their parents.
391 void *adns__alloc_mine(adns_query qu, size_t sz);
392 /* Like _interim, but does not record the length for later
393 * copying into the answer. This just ensures that the memory
394 * will be freed when we're done with the query.
397 void *adns__alloc_final(adns_query qu, size_t sz);
398 /* Cannot fail, and cannot return 0.
401 void adns__makefinal_block(adns_query qu, void **blpp, size_t sz);
402 void adns__makefinal_str(adns_query qu, char **strp);
404 void adns__reset_cnameonly(adns_query qu);
405 /* Resets all of the memory management stuff etc. to
406 * take account of only the CNAME. Used when we find an error somewhere
407 * and want to just report the error (with perhaps CNAME info), and also
408 * when we're halfway through RRs in a datagram and discover that we
409 * need to retry the query.
412 void adns__query_done(adns_query qu);
413 void adns__query_fail(adns_query qu, adns_status stat);
417 void adns__procdgram(adns_state ads, const byte *dgram, int len,
418 int serv, struct timeval now);
422 const typeinfo *adns__findtype(adns_rrtype type);
431 int dglen, max, cbyte, namelen;
435 void adns__findlabel_start(findlabel_state *fls, adns_state ads,
436 int serv, adns_query qu,
437 const byte *dgram, int dglen, int max,
438 int dmbegin, int *dmend_rlater);
439 /* Finds labels in a domain in a datagram.
441 * Call this routine first.
442 * dmend_rlater may be null. ads (and of course fls) may not be.
443 * serv may be -1, qu may be null - they are for error reporting.
446 adns_status adns__findlabel_next(findlabel_state *fls, int *lablen_r, int *labstart_r);
447 /* Then, call this one repeatedly.
449 * It will return adns_s_ok if all is well, and tell you the length
450 * and start of successive labels. labstart_r may be null, but
451 * lablen_r must not be.
453 * After the last label, it will return with *lablen_r zero.
454 * Do not then call it again; instead, just throw away the findlabel_state.
456 * *dmend_rlater will have been set to point to the next part of
457 * the datagram after the label (or after the uncompressed part,
458 * if compression was used). *namelen_rlater will have been set
459 * to the length of the domain name (total length of labels plus
460 * 1 for each intervening dot).
462 * If the datagram appears to be truncated, *lablen_r will be -1.
463 * *dmend_rlater, *labstart_r and *namelen_r may contain garbage.
464 * Do not call _next again.
466 * There may also be errors, in which case *dmend_rlater,
467 * *namelen_rlater, *lablen_r and *labstart_r may contain garbage.
468 * Do not then call findlabel_next again.
475 adns_status adns__parse_domain(adns_state ads, int serv, adns_query qu,
476 vbuf *vb, parsedomain_flags flags,
477 const byte *dgram, int dglen, int *cbyte_io, int max);
478 /* vb must already have been initialised; it will be reset if necessary.
479 * If there is truncation, vb->used will be set to 0; otherwise
480 * (if there is no error) vb will be null-terminated.
481 * If there is an error vb and *cbyte_io may be left indeterminate.
483 * serv may be -1 and qu may be 0 - they are used for error reporting only.
486 adns_status adns__findrr(adns_query qu, int serv,
487 const byte *dgram, int dglen, int *cbyte_io,
488 int *type_r, int *class_r, unsigned long *ttl_r,
489 int *rdlen_r, int *rdstart_r,
490 int *ownermatchedquery_r);
491 /* Finds the extent and some of the contents of an RR in a datagram
492 * and does some checks. The datagram is *dgram, length dglen, and
493 * the RR starts at *cbyte_io (which is updated afterwards to point
494 * to the end of the RR).
496 * The type, class, TTL and RRdata length and start are returned iff
497 * the corresponding pointer variables are not null. type_r, class_r
498 * and ttl_r may not be null. The TTL will be capped.
500 * If ownermatchedquery_r != 0 then the owner domain of this
501 * RR will be compared with that in the query (or, if the query
502 * has gone to a CNAME lookup, with the canonical name).
503 * In this case, *ownermatchedquery_r will be set to 0 or 1.
504 * The query datagram (or CNAME datagram) MUST be valid and not truncated.
506 * If there is truncation then *type_r will be set to -1 and
507 * *cbyte_io, *class_r, *rdlen_r, *rdstart_r and *eo_matched_r will be
510 * qu must obviously be non-null.
512 * If an error is returned then *type_r will be undefined too.
515 adns_status adns__findrr_anychk(adns_query qu, int serv,
516 const byte *dgram, int dglen, int *cbyte_io,
517 int *type_r, int *class_r, unsigned long *ttl_r,
518 int *rdlen_r, int *rdstart_r,
519 const byte *eo_dgram, int eo_dglen, int eo_cbyte,
521 /* Like adns__findrr_checked, except that the datagram and
522 * owner to compare with can be specified explicitly.
524 * If the caller thinks they know what the owner of the RR ought to
525 * be they can pass in details in eo_*: this is another (or perhaps
526 * the same datagram), and a pointer to where the putative owner
527 * starts in that datagram. In this case *eo_matched_r will be set
528 * to 1 if the datagram matched or 0 if it did not. Either
529 * both eo_dgram and eo_matched_r must both be non-null, or they
530 * must both be null (in which case eo_dglen and eo_cbyte will be ignored).
531 * The eo datagram and contained owner domain MUST be valid and
535 void adns__update_expires(adns_query qu, unsigned long ttl, struct timeval now);
536 /* Updates the `expires' field in the query, so that it doesn't exceed
540 int vbuf__append_quoted1035(vbuf *vb, const byte *buf, int len);
544 void adns__tcp_broken(adns_state ads, const char *what, const char *why);
545 void adns__tcp_tryconnect(adns_state ads, struct timeval now);
547 void adns__autosys(adns_state ads, struct timeval now);
548 /* Make all the system calls we want to if the application wants us to. */
550 /* Useful static inline functions: */
552 static inline void timevaladd(struct timeval *tv_io, long ms) {
556 tmp.tv_usec += (ms%1000)*1000000;
557 tmp.tv_sec += ms/1000;
558 if (tmp.tv_usec >= 1000000) { tmp.tv_sec++; tmp.tv_usec -= 1000; }
562 static inline int ctype_whitespace(int c) { return c==' ' || c=='\n' || c=='\t'; }
563 static inline int ctype_digit(int c) { return c>='0' && c<='9'; }
564 static inline int ctype_alpha(int c) {
565 return (c >= 'a' && c <= 'z') || (c >= 'A' || c <= 'Z');
570 #define MEM_ROUND(sz) \
571 (( ((sz)+sizeof(union maxalign)-1) / sizeof(union maxalign) ) \
572 * sizeof(union maxalign) )
574 #define LIST_INIT(list) ((list).head= (list).tail= 0)
576 #define LIST_UNLINK_PART(list,node,part) \
578 if ((node)->part back) (node)->part back->part next= (node)->part next; \
579 else (list).head= (node)->part next; \
580 if ((node)->part next) (node)->part next->part back= (node)->part back; \
581 else (list).tail= (node)->part back; \
584 #define LIST_LINK_TAIL_PART(list,node,part) \
586 (node)->part next= 0; \
587 (node)->part back= (list).tail; \
588 if ((list).tail) (list).tail->part next= (node); else (list).head= (node); \
589 (list).tail= (node); \
592 #define LIST_UNLINK(list,node) LIST_UNLINK_PART(list,node,)
593 #define LIST_LINK_TAIL(list,node) LIST_LINK_TAIL_PART(list,node,)
595 #define GETIL_B(cb) (((dgram)[(cb)++]) & 0x0ff)
596 #define GET_B(cb,tv) ((tv)= GETIL_B((cb)))
597 #define GET_W(cb,tv) ((tv)=0, (tv)|=(GETIL_B((cb))<<8), (tv)|=GETIL_B(cb), (tv))
598 #define GET_L(cb,tv) ( (tv)=0, \
599 (tv)|=(GETIL_B((cb))<<24), \
600 (tv)|=(GETIL_B((cb))<<16), \
601 (tv)|=(GETIL_B((cb))<<8), \