libdns: Avoid using compound literals (2).
[gnupg.git] / dirmngr / dns.h
1 /* ==========================================================================
2  * dns.h - Recursive, Reentrant DNS Resolver.
3  * --------------------------------------------------------------------------
4  * Copyright (c) 2009, 2010, 2012-2015  William Ahern
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the
8  * "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sublicense, and/or sell copies of the Software, and to permit
11  * persons to whom the Software is furnished to do so, subject to the
12  * following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included
15  * in all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
20  * NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
21  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
22  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
23  * USE OR OTHER DEALINGS IN THE SOFTWARE.
24  * ==========================================================================
25  */
26 #ifndef DNS_H
27 #define DNS_H
28
29 #include <stddef.h>             /* size_t offsetof() */
30 #include <stdint.h>             /* uint64_t */
31 #include <stdio.h>              /* FILE */
32 #include <string.h>             /* strlen(3) */
33 #include <time.h>               /* struct timespec time_t */
34
35 #if _WIN32
36 #include <winsock2.h>
37 #include <ws2tcpip.h>
38 #else
39 #include <sys/param.h>          /* BYTE_ORDER BIG_ENDIAN _BIG_ENDIAN */
40 #include <sys/types.h>          /* socklen_t */
41 #include <sys/socket.h>         /* struct socket */
42 #include <poll.h>               /* POLLIN POLLOUT */
43 #include <netinet/in.h>         /* struct in_addr struct in6_addr */
44 #include <netdb.h>              /* struct addrinfo */
45 #endif
46
47
48 /*
49  * V I S I B I L I T Y
50  *
51  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
52
53 #ifndef DNS_PUBLIC
54 #define DNS_PUBLIC
55 #endif
56
57
58 /*
59  * V E R S I O N
60  *
61  * Vendor: Entity for which versions numbers are relevant. (If forking
62  * change DNS_VENDOR to avoid confusion.)
63  *
64  * Three versions:
65  *
66  * REL  Official "release"--bug fixes, new features, etc.
67  * ABI  Changes to existing object sizes or parameter types
68  * API  Changes that might effect application source.
69  *
70  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
71
72 #define DNS_VENDOR "william@25thandClement.com"
73
74 #define DNS_V_REL  0x20160809
75 #define DNS_V_ABI  0x20160608
76 #define DNS_V_API  0x20160809
77
78
79 DNS_PUBLIC const char *dns_vendor(void);
80
81 DNS_PUBLIC int dns_v_rel(void);
82 DNS_PUBLIC int dns_v_abi(void);
83 DNS_PUBLIC int dns_v_api(void);
84
85
86 /*
87  * E R R O R S
88  *
89  * Errors and exceptions are always returned through an int. This should
90  * hopefully make integration easier in the majority of circumstances, and
91  * also cut down on useless compiler warnings.
92  *
93  * System and library errors are returned together. POSIX guarantees that
94  * all system errors are positive integers. Library errors are always
95  * negative integers in the range DNS_EBASE to DNS_ELAST, with the high bits
96  * set to the three magic ASCII characters "dns".
97  *
98  * dns_strerror() returns static English string descriptions of all known
99  * errors, and punts the remainder to strerror(3).
100  *
101  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
102
103 #define DNS_EBASE -(('d' << 24) | ('n' << 16) | ('s' << 8) | 64)
104
105 #define dns_error_t int /* for documentation only */
106
107 enum dns_errno {
108         DNS_ENOBUFS = DNS_EBASE,
109         DNS_EILLEGAL,
110         DNS_EORDER,
111         DNS_ESECTION,
112         DNS_EUNKNOWN,
113         DNS_EADDRESS,
114         DNS_ENOQUERY,
115         DNS_ENOANSWER,
116         DNS_EFETCHED,
117         DNS_ESERVICE, /* EAI_SERVICE */
118         DNS_ENONAME,  /* EAI_NONAME */
119         DNS_EFAIL,    /* EAI_FAIL */
120         DNS_ECONNFIN,
121         DNS_EVERIFY,
122         DNS_ELAST,
123 }; /* dns_errno */
124
125 DNS_PUBLIC const char *dns_strerror(dns_error_t);
126
127 DNS_PUBLIC int *dns_debug_p(void);
128
129 #define dns_debug (*dns_debug_p()) /* was extern int dns_debug before 20160523 API */
130
131
132 /*
133  * C O M P I L E R  A N N O T A T I O N S
134  *
135  * GCC with -Wextra, and clang by default, complain about overrides in
136  * initializer lists. Overriding previous member initializers is well
137  * defined behavior in C. dns.c relies on this behavior to define default,
138  * overrideable member values when instantiating configuration objects.
139  *
140  * dns_quietinit() guards a compound literal expression with pragmas to
141  * silence these shrill warnings. This alleviates the burden of requiring
142  * third-party projects to adjust their compiler flags.
143  *
144  * NOTE: If you take the address of the compound literal, take the address
145  * of the transformed expression, otherwise the compound literal lifetime is
146  * tied to the scope of the GCC statement expression.
147  *
148  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
149
150 #if defined __clang__
151 #define DNS_PRAGMA_PUSH _Pragma("clang diagnostic push")
152 #define DNS_PRAGMA_QUIET _Pragma("clang diagnostic ignored \"-Winitializer-overrides\"")
153 #define DNS_PRAGMA_POP _Pragma("clang diagnostic pop")
154
155 #define dns_quietinit(...) \
156         DNS_PRAGMA_PUSH DNS_PRAGMA_QUIET __VA_ARGS__ DNS_PRAGMA_POP
157 #elif (__GNUC__ == 4 && __GNUC_MINOR__ >= 6) || __GNUC__ > 4
158 #define DNS_PRAGMA_PUSH _Pragma("GCC diagnostic push")
159 #define DNS_PRAGMA_QUIET _Pragma("GCC diagnostic ignored \"-Woverride-init\"")
160 #define DNS_PRAGMA_POP _Pragma("GCC diagnostic pop")
161
162 /* GCC parses the _Pragma operator less elegantly than clang. */
163 #define dns_quietinit(...) \
164         __extension__ ({ DNS_PRAGMA_PUSH DNS_PRAGMA_QUIET __VA_ARGS__; DNS_PRAGMA_POP })
165 #else
166 #define DNS_PRAGMA_PUSH
167 #define DNS_PRAGMA_QUIET
168 #define DNS_PRAGMA_POP
169 #define dns_quietinit(...) __VA_ARGS__
170 #endif
171
172 #if defined __GNUC__
173 #define DNS_PRAGMA_EXTENSION __extension__
174 #else
175 #define DNS_PRAGMA_EXTENSION
176 #endif
177
178
179 /*
180  * E V E N T S  I N T E R F A C E S
181  *
182  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
183
184 #if defined(POLLIN)
185 #define DNS_POLLIN POLLIN
186 #else
187 #define DNS_POLLIN  1
188 #endif
189
190 #if defined(POLLOUT)
191 #define DNS_POLLOUT POLLOUT
192 #else
193 #define DNS_POLLOUT 2
194 #endif
195
196
197 /*
198  * See Application Interface below for configuring libevent bitmasks instead
199  * of poll(2) bitmasks.
200  */
201 #define DNS_EVREAD  2
202 #define DNS_EVWRITE 4
203
204
205 #define DNS_POLL2EV(set) \
206         (((set) & DNS_POLLIN)? DNS_EVREAD : 0) | (((set) & DNS_POLLOUT)? DNS_EVWRITE : 0)
207
208 #define DNS_EV2POLL(set) \
209         (((set) & DNS_EVREAD)? DNS_POLLIN : 0) | (((set) & DNS_EVWRITE)? DNS_POLLOUT : 0)
210
211
212 /*
213  * E N U M E R A T I O N  I N T E R F A C E S
214  *
215  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
216
217 enum dns_section {
218         DNS_S_QD                = 0x01,
219 #define DNS_S_QUESTION          DNS_S_QD
220
221         DNS_S_AN                = 0x02,
222 #define DNS_S_ANSWER            DNS_S_AN
223
224         DNS_S_NS                = 0x04,
225 #define DNS_S_AUTHORITY         DNS_S_NS
226
227         DNS_S_AR                = 0x08,
228 #define DNS_S_ADDITIONAL        DNS_S_AR
229
230         DNS_S_ALL               = 0x0f
231 }; /* enum dns_section */
232
233
234 enum dns_class {
235         DNS_C_IN        = 1,
236
237         DNS_C_ANY       = 255
238 }; /* enum dns_class */
239
240
241 enum dns_type {
242         DNS_T_A         = 1,
243         DNS_T_NS        = 2,
244         DNS_T_CNAME     = 5,
245         DNS_T_SOA       = 6,
246         DNS_T_PTR       = 12,
247         DNS_T_MX        = 15,
248         DNS_T_TXT       = 16,
249         DNS_T_AAAA      = 28,
250         DNS_T_SRV       = 33,
251         DNS_T_OPT       = 41,
252         DNS_T_SSHFP     = 44,
253         DNS_T_SPF       = 99,
254         DNS_T_AXFR      = 252,
255
256         DNS_T_ALL       = 255
257 }; /* enum dns_type */
258
259
260 enum dns_opcode {
261         DNS_OP_QUERY    = 0,
262         DNS_OP_IQUERY   = 1,
263         DNS_OP_STATUS   = 2,
264         DNS_OP_NOTIFY   = 4,
265         DNS_OP_UPDATE   = 5,
266 }; /* dns_opcode */
267
268
269 enum dns_rcode {
270         DNS_RC_NOERROR  = 0,
271         DNS_RC_FORMERR  = 1,
272         DNS_RC_SERVFAIL = 2,
273         DNS_RC_NXDOMAIN = 3,
274         DNS_RC_NOTIMP   = 4,
275         DNS_RC_REFUSED  = 5,
276         DNS_RC_YXDOMAIN = 6,
277         DNS_RC_YXRRSET  = 7,
278         DNS_RC_NXRRSET  = 8,
279         DNS_RC_NOTAUTH  = 9,
280         DNS_RC_NOTZONE  = 10,
281
282         /* EDNS(0) extended RCODEs */
283         DNS_RC_BADVERS = 16,
284 }; /* dns_rcode */
285
286
287 /*
288  * NOTE: These string functions need a small buffer in case the literal
289  * integer value needs to be printed and returned. UNLESS this buffer is
290  * SPECIFIED, the returned string has ONLY BLOCK SCOPE.
291  */
292 #define DNS_STRMAXLEN 47 /* "QUESTION|ANSWER|AUTHORITY|ADDITIONAL" */
293
294 DNS_PUBLIC const char *dns_strsection(enum dns_section);
295
296 DNS_PUBLIC enum dns_section dns_isection(const char *);
297
298 DNS_PUBLIC const char *dns_strclass(enum dns_class);
299
300 DNS_PUBLIC enum dns_class dns_iclass(const char *);
301
302 DNS_PUBLIC const char *dns_strtype(enum dns_type);
303
304 DNS_PUBLIC enum dns_type dns_itype(const char *);
305
306 DNS_PUBLIC const char *dns_stropcode(enum dns_opcode);
307
308 DNS_PUBLIC enum dns_opcode dns_iopcode(const char *);
309
310 DNS_PUBLIC const char *dns_strrcode(enum dns_rcode);
311
312 DNS_PUBLIC enum dns_rcode dns_ircode(const char *);
313
314
315 /*
316  * A T O M I C  I N T E R F A C E S
317  *
318  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
319
320 typedef unsigned long dns_atomic_t;
321
322 typedef unsigned long dns_refcount_t; /* must be same value type as dns_atomic_t */
323
324
325 /*
326  * C R Y P T O  I N T E R F A C E S
327  *
328  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
329
330 typedef unsigned dns_random_f(void);
331
332 DNS_PUBLIC dns_random_f **dns_random_p(void);
333
334 #define dns_random (*dns_random_p()) /* was extern unsigned (*dns_random)(void) before 20160523 API */
335
336
337 /*
338  * P A C K E T  I N T E R F A C E
339  *
340  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
341
342 struct dns_header {
343                 unsigned qid:16;
344
345 #if (defined BYTE_ORDER && BYTE_ORDER == BIG_ENDIAN) || (defined __sun && defined _BIG_ENDIAN)
346                 unsigned qr:1;
347                 unsigned opcode:4;
348                 unsigned aa:1;
349                 unsigned tc:1;
350                 unsigned rd:1;
351
352                 unsigned ra:1;
353                 unsigned unused:3;
354                 unsigned rcode:4;
355 #else
356                 unsigned rd:1;
357                 unsigned tc:1;
358                 unsigned aa:1;
359                 unsigned opcode:4;
360                 unsigned qr:1;
361
362                 unsigned rcode:4;
363                 unsigned unused:3;
364                 unsigned ra:1;
365 #endif
366
367                 unsigned qdcount:16;
368                 unsigned ancount:16;
369                 unsigned nscount:16;
370                 unsigned arcount:16;
371 }; /* struct dns_header */
372
373 #define dns_header(p)   (&(p)->header)
374
375
376 #ifndef DNS_P_QBUFSIZ
377 #define DNS_P_QBUFSIZ   dns_p_calcsize(256 + 4)
378 #endif
379
380 #ifndef DNS_P_DICTSIZE
381 #define DNS_P_DICTSIZE  16
382 #endif
383
384 struct dns_packet {
385         unsigned short dict[DNS_P_DICTSIZE];
386
387         struct dns_p_memo {
388                 struct dns_s_memo {
389                         unsigned short base, end;
390                 } qd, an, ns, ar;
391
392                 struct {
393                         unsigned short p;
394                         unsigned short maxudp;
395                         unsigned ttl;
396                 } opt;
397         } memo;
398
399         struct { struct dns_packet *cqe_next, *cqe_prev; } cqe;
400
401         size_t size, end;
402
403         int:16; /* tcp padding */
404
405         DNS_PRAGMA_EXTENSION union {
406                 struct dns_header header;
407                 unsigned char data[1];
408         };
409 }; /* struct dns_packet */
410
411 #define dns_p_calcsize(n)       (offsetof(struct dns_packet, data) + DNS_PP_MAX(12, (n)))
412
413 #define dns_p_sizeof(P)         dns_p_calcsize((P)->end)
414
415 /** takes size of maximum desired payload */
416 #define dns_p_new(n)            (dns_p_init((struct dns_packet *)&(union { unsigned char b[dns_p_calcsize((n))]; struct dns_packet p; }){ { 0 } }, dns_p_calcsize((n))))
417
418 /** takes size of entire packet structure as allocated */
419 DNS_PUBLIC struct dns_packet *dns_p_init(struct dns_packet *, size_t);
420
421 /** takes size of maximum desired payload */
422 DNS_PUBLIC struct dns_packet *dns_p_make(size_t, int *);
423
424 DNS_PUBLIC int dns_p_grow(struct dns_packet **);
425
426 DNS_PUBLIC struct dns_packet *dns_p_copy(struct dns_packet *, const struct dns_packet *);
427
428 #define dns_p_opcode(P)         (dns_header(P)->opcode)
429
430 DNS_PUBLIC enum dns_rcode dns_p_rcode(struct dns_packet *);
431
432 DNS_PUBLIC unsigned dns_p_count(struct dns_packet *, enum dns_section);
433
434 DNS_PUBLIC int dns_p_push(struct dns_packet *, enum dns_section, const void *, size_t, enum dns_type, enum dns_class, unsigned, const void *);
435
436 DNS_PUBLIC void dns_p_dictadd(struct dns_packet *, unsigned short);
437
438 DNS_PUBLIC struct dns_packet *dns_p_merge(struct dns_packet *, enum dns_section, struct dns_packet *, enum dns_section, int *);
439
440 DNS_PUBLIC void dns_p_dump(struct dns_packet *, FILE *);
441
442 DNS_PUBLIC int dns_p_study(struct dns_packet *);
443
444
445 /*
446  * D O M A I N  N A M E  I N T E R F A C E S
447  *
448  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
449
450 #define DNS_D_MAXLABEL  63      /* + 1 '\0' */
451 #define DNS_D_MAXNAME   255     /* + 1 '\0' */
452
453 #define DNS_D_ANCHOR    1       /* anchor domain w/ root "." */
454 #define DNS_D_CLEAVE    2       /* cleave sub-domain */
455 #define DNS_D_TRIM      4       /* remove superfluous dots */
456
457 #define dns_d_new3(a, b, f)     dns_d_init(&(char[DNS_D_MAXNAME + 1]){ 0 }, DNS_D_MAXNAME + 1, (a), (b), (f))
458 #define dns_d_new2(a, f)        dns_d_new3((a), strlen((a)), (f))
459 #define dns_d_new1(a)           dns_d_new3((a), strlen((a)), DNS_D_ANCHOR)
460 #define dns_d_new(...)          DNS_PP_CALL(DNS_PP_XPASTE(dns_d_new, DNS_PP_NARG(__VA_ARGS__)), __VA_ARGS__)
461
462 DNS_PUBLIC char *dns_d_init(void *, size_t, const void *, size_t, int);
463
464 DNS_PUBLIC size_t dns_d_anchor(void *, size_t, const void *, size_t);
465
466 DNS_PUBLIC size_t dns_d_cleave(void *, size_t, const void *, size_t);
467
468 DNS_PUBLIC size_t dns_d_comp(void *, size_t, const void *, size_t, struct dns_packet *, int *);
469
470 DNS_PUBLIC size_t dns_d_expand(void *, size_t, unsigned short, struct dns_packet *, int *);
471
472 DNS_PUBLIC unsigned short dns_d_skip(unsigned short, struct dns_packet *);
473
474 DNS_PUBLIC int dns_d_push(struct dns_packet *, const void *, size_t);
475
476 DNS_PUBLIC size_t dns_d_cname(void *, size_t, const void *, size_t, struct dns_packet *, int *error);
477
478
479 /*
480  * R E S O U R C E  R E C O R D  I N T E R F A C E S
481  *
482  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
483
484 struct dns_rr {
485         enum dns_section section;
486
487         struct {
488                 unsigned short p;
489                 unsigned short len;
490         } dn;
491
492         enum dns_type type;
493         enum dns_class class;
494         unsigned ttl;
495
496         struct {
497                 unsigned short p;
498                 unsigned short len;
499         } rd;
500 }; /* struct dns_rr */
501
502
503 DNS_PUBLIC int dns_rr_copy(struct dns_packet *, struct dns_rr *, struct dns_packet *);
504
505 DNS_PUBLIC int dns_rr_parse(struct dns_rr *, unsigned short, struct dns_packet *);
506
507 DNS_PUBLIC unsigned short dns_rr_skip(unsigned short, struct dns_packet *);
508
509 DNS_PUBLIC int dns_rr_cmp(struct dns_rr *, struct dns_packet *, struct dns_rr *, struct dns_packet *);
510
511 DNS_PUBLIC size_t dns_rr_print(void *, size_t, struct dns_rr *, struct dns_packet *, int *);
512
513
514 #define dns_rr_i_new(P, ...) \
515         dns_rr_i_init(&dns_quietinit((struct dns_rr_i){ 0, __VA_ARGS__ }), (P))
516
517 struct dns_rr_i {
518         enum dns_section section;
519         const void *name;
520         enum dns_type type;
521         enum dns_class class;
522         const void *data;
523
524         int follow;
525
526         int (*sort)(struct dns_rr *, struct dns_rr *, struct dns_rr_i *, struct dns_packet *);
527         unsigned args[2];
528
529         struct {
530                 unsigned short next;
531                 unsigned short count;
532
533                 unsigned exec;
534                 unsigned regs[2];
535         } state, saved;
536 }; /* struct dns_rr_i */
537
538 DNS_PUBLIC int dns_rr_i_packet(struct dns_rr *, struct dns_rr *, struct dns_rr_i *, struct dns_packet *);
539
540 DNS_PUBLIC int dns_rr_i_order(struct dns_rr *, struct dns_rr *, struct dns_rr_i *, struct dns_packet *);
541
542 DNS_PUBLIC int dns_rr_i_shuffle(struct dns_rr *, struct dns_rr *, struct dns_rr_i *, struct dns_packet *);
543
544 DNS_PUBLIC struct dns_rr_i *dns_rr_i_init(struct dns_rr_i *, struct dns_packet *);
545
546 #define dns_rr_i_save(i)        ((i)->saved = (i)->state)
547 #define dns_rr_i_rewind(i)      ((i)->state = (i)->saved)
548 #define dns_rr_i_count(i)       ((i)->state.count)
549
550 DNS_PUBLIC unsigned dns_rr_grep(struct dns_rr *, unsigned, struct dns_rr_i *, struct dns_packet *, int *);
551
552 #define dns_rr_foreach_(rr, P, ...)     \
553         for (struct dns_rr_i DNS_PP_XPASTE(i, __LINE__) = *dns_rr_i_new((P), __VA_ARGS__); dns_rr_grep((rr), 1, &DNS_PP_XPASTE(i, __LINE__), (P), &(int){ 0 }); )
554
555 #define dns_rr_foreach(...)     dns_rr_foreach_(__VA_ARGS__)
556
557
558 /*
559  * A  R E S O U R C E  R E C O R D
560  */
561
562 struct dns_a {
563         struct in_addr addr;
564 }; /* struct dns_a */
565
566 DNS_PUBLIC int dns_a_parse(struct dns_a *, struct dns_rr *, struct dns_packet *);
567
568 DNS_PUBLIC int dns_a_push(struct dns_packet *, struct dns_a *);
569
570 DNS_PUBLIC int dns_a_cmp(const struct dns_a *, const struct dns_a *);
571
572 DNS_PUBLIC size_t dns_a_print(void *, size_t, struct dns_a *);
573
574 DNS_PUBLIC size_t dns_a_arpa(void *, size_t, const struct dns_a *);
575
576
577 /*
578  * AAAA  R E S O U R C E  R E C O R D
579  */
580
581 struct dns_aaaa {
582         struct in6_addr addr;
583 }; /* struct dns_aaaa */
584
585 DNS_PUBLIC int dns_aaaa_parse(struct dns_aaaa *, struct dns_rr *, struct dns_packet *);
586
587 DNS_PUBLIC int dns_aaaa_push(struct dns_packet *, struct dns_aaaa *);
588
589 DNS_PUBLIC int dns_aaaa_cmp(const struct dns_aaaa *, const struct dns_aaaa *);
590
591 DNS_PUBLIC size_t dns_aaaa_print(void *, size_t, struct dns_aaaa *);
592
593 DNS_PUBLIC size_t dns_aaaa_arpa(void *, size_t, const struct dns_aaaa *);
594
595
596 /*
597  * MX  R E S O U R C E  R E C O R D
598  */
599
600 struct dns_mx {
601         unsigned short preference;
602         char host[DNS_D_MAXNAME + 1];
603 }; /* struct dns_mx */
604
605 DNS_PUBLIC int dns_mx_parse(struct dns_mx *, struct dns_rr *, struct dns_packet *);
606
607 DNS_PUBLIC int dns_mx_push(struct dns_packet *, struct dns_mx *);
608
609 DNS_PUBLIC int dns_mx_cmp(const struct dns_mx *, const struct dns_mx *);
610
611 DNS_PUBLIC size_t dns_mx_print(void *, size_t, struct dns_mx *);
612
613 DNS_PUBLIC size_t dns_mx_cname(void *, size_t, struct dns_mx *);
614
615
616 /*
617  * NS  R E S O U R C E  R E C O R D
618  */
619
620 struct dns_ns {
621         char host[DNS_D_MAXNAME + 1];
622 }; /* struct dns_ns */
623
624 DNS_PUBLIC int dns_ns_parse(struct dns_ns *, struct dns_rr *, struct dns_packet *);
625
626 DNS_PUBLIC int dns_ns_push(struct dns_packet *, struct dns_ns *);
627
628 DNS_PUBLIC int dns_ns_cmp(const struct dns_ns *, const struct dns_ns *);
629
630 DNS_PUBLIC size_t dns_ns_print(void *, size_t, struct dns_ns *);
631
632 DNS_PUBLIC size_t dns_ns_cname(void *, size_t, struct dns_ns *);
633
634
635 /*
636  * CNAME  R E S O U R C E  R E C O R D
637  */
638
639 struct dns_cname {
640         char host[DNS_D_MAXNAME + 1];
641 }; /* struct dns_cname */
642
643 DNS_PUBLIC int dns_cname_parse(struct dns_cname *, struct dns_rr *, struct dns_packet *);
644
645 DNS_PUBLIC int dns_cname_push(struct dns_packet *, struct dns_cname *);
646
647 DNS_PUBLIC int dns_cname_cmp(const struct dns_cname *, const struct dns_cname *);
648
649 DNS_PUBLIC size_t dns_cname_print(void *, size_t, struct dns_cname *);
650
651 DNS_PUBLIC size_t dns_cname_cname(void *, size_t, struct dns_cname *);
652
653
654 /*
655  * SOA  R E S O U R C E  R E C O R D
656  */
657
658 struct dns_soa {
659         char mname[DNS_D_MAXNAME + 1];
660         char rname[DNS_D_MAXNAME + 1];
661         unsigned serial, refresh, retry, expire, minimum;
662 }; /* struct dns_soa */
663
664 DNS_PUBLIC int dns_soa_parse(struct dns_soa *, struct dns_rr *, struct dns_packet *);
665
666 DNS_PUBLIC int dns_soa_push(struct dns_packet *, struct dns_soa *);
667
668 DNS_PUBLIC int dns_soa_cmp(const struct dns_soa *, const struct dns_soa *);
669
670 DNS_PUBLIC size_t dns_soa_print(void *, size_t, struct dns_soa *);
671
672
673 /*
674  * PTR  R E S O U R C E  R E C O R D
675  */
676
677 struct dns_ptr {
678         char host[DNS_D_MAXNAME + 1];
679 }; /* struct dns_ptr */
680
681 DNS_PUBLIC int dns_ptr_parse(struct dns_ptr *, struct dns_rr *, struct dns_packet *);
682
683 DNS_PUBLIC int dns_ptr_push(struct dns_packet *, struct dns_ptr *);
684
685 DNS_PUBLIC int dns_ptr_cmp(const struct dns_ptr *, const struct dns_ptr *);
686
687 DNS_PUBLIC size_t dns_ptr_print(void *, size_t, struct dns_ptr *);
688
689 DNS_PUBLIC size_t dns_ptr_cname(void *, size_t, struct dns_ptr *);
690
691 DNS_PUBLIC size_t dns_ptr_qname(void *, size_t, int, void *);
692
693
694 /*
695  * SRV  R E S O U R C E  R E C O R D
696  */
697
698 struct dns_srv {
699         unsigned short priority;
700         unsigned short weight;
701         unsigned short port;
702         char target[DNS_D_MAXNAME + 1];
703 }; /* struct dns_srv */
704
705 DNS_PUBLIC int dns_srv_parse(struct dns_srv *, struct dns_rr *, struct dns_packet *);
706
707 DNS_PUBLIC int dns_srv_push(struct dns_packet *, struct dns_srv *);
708
709 DNS_PUBLIC int dns_srv_cmp(const struct dns_srv *, const struct dns_srv *);
710
711 DNS_PUBLIC size_t dns_srv_print(void *, size_t, struct dns_srv *);
712
713 DNS_PUBLIC size_t dns_srv_cname(void *, size_t, struct dns_srv *);
714
715
716 /*
717  * OPT  R E S O U R C E  R E C O R D
718  */
719
720 #ifndef DNS_OPT_MINDATA
721 #define DNS_OPT_MINDATA 256
722 #endif
723
724 #define DNS_OPT_DNSSEC  0x8000
725
726 struct dns_opt {
727         enum dns_rcode rcode;
728         unsigned char version;
729         unsigned short flags;
730
731         union {
732                 unsigned short maxsize; /* deprecated as confusing */
733                 unsigned short maxudp; /* maximum UDP payload size */
734         };
735
736         size_t size, len;
737         unsigned char data[DNS_OPT_MINDATA];
738 }; /* struct dns_opt */
739
740 #define DNS_OPT_INIT(opt) { .size = sizeof (*opt) - offsetof(struct dns_opt, data) }
741
742 DNS_PUBLIC struct dns_opt *dns_opt_init(struct dns_opt *, size_t);
743
744 DNS_PUBLIC int dns_opt_parse(struct dns_opt *, struct dns_rr *, struct dns_packet *);
745
746 DNS_PUBLIC int dns_opt_push(struct dns_packet *, struct dns_opt *);
747
748 DNS_PUBLIC int dns_opt_cmp(const struct dns_opt *, const struct dns_opt *);
749
750 DNS_PUBLIC size_t dns_opt_print(void *, size_t, struct dns_opt *);
751
752 DNS_PUBLIC unsigned int dns_opt_ttl(const struct dns_opt *);
753
754 DNS_PUBLIC unsigned short dns_opt_class(const struct dns_opt *);
755
756 DNS_PUBLIC dns_error_t dns_opt_data_push(struct dns_opt *, unsigned char, unsigned short, const void *);
757
758
759 /*
760  * SSHFP  R E S O U R C E  R E C O R D
761  */
762
763 struct dns_sshfp {
764         enum dns_sshfp_key {
765                 DNS_SSHFP_RSA = 1,
766                 DNS_SSHFP_DSA = 2,
767         } algo;
768
769         enum dns_sshfp_digest {
770                 DNS_SSHFP_SHA1 = 1,
771         } type;
772
773         union {
774                 unsigned char sha1[20];
775         } digest;
776 }; /* struct dns_sshfp */
777
778 DNS_PUBLIC int dns_sshfp_parse(struct dns_sshfp *, struct dns_rr *, struct dns_packet *);
779
780 DNS_PUBLIC int dns_sshfp_push(struct dns_packet *, struct dns_sshfp *);
781
782 DNS_PUBLIC int dns_sshfp_cmp(const struct dns_sshfp *, const struct dns_sshfp *);
783
784 DNS_PUBLIC size_t dns_sshfp_print(void *, size_t, struct dns_sshfp *);
785
786
787 /*
788  * TXT  R E S O U R C E  R E C O R D
789  */
790
791 #ifndef DNS_TXT_MINDATA
792 #define DNS_TXT_MINDATA 1024
793 #endif
794
795 struct dns_txt {
796         size_t size, len;
797         unsigned char data[DNS_TXT_MINDATA];
798 }; /* struct dns_txt */
799
800 DNS_PUBLIC struct dns_txt *dns_txt_init(struct dns_txt *, size_t);
801
802 DNS_PUBLIC int dns_txt_parse(struct dns_txt *, struct dns_rr *, struct dns_packet *);
803
804 DNS_PUBLIC int dns_txt_push(struct dns_packet *, struct dns_txt *);
805
806 DNS_PUBLIC int dns_txt_cmp(const struct dns_txt *, const struct dns_txt *);
807
808 DNS_PUBLIC size_t dns_txt_print(void *, size_t, struct dns_txt *);
809
810
811 /*
812  * ANY  R E S O U R C E  R E C O R D
813  */
814
815 union dns_any {
816         struct dns_a a;
817         struct dns_aaaa aaaa;
818         struct dns_mx mx;
819         struct dns_ns ns;
820         struct dns_cname cname;
821         struct dns_soa soa;
822         struct dns_ptr ptr;
823         struct dns_srv srv;
824         struct dns_opt opt;
825         struct dns_sshfp sshfp;
826         struct dns_txt txt, spf, rdata;
827 }; /* union dns_any */
828
829 #define DNS_ANY_INIT(any) { .rdata = { .size = sizeof *(any) - offsetof(struct dns_txt, data) } }
830
831 DNS_PUBLIC union dns_any *dns_any_init(union dns_any *, size_t);
832
833 DNS_PUBLIC int dns_any_parse(union dns_any *, struct dns_rr *, struct dns_packet *);
834
835 DNS_PUBLIC int dns_any_push(struct dns_packet *, union dns_any *, enum dns_type);
836
837 DNS_PUBLIC int dns_any_cmp(const union dns_any *, enum dns_type, const union dns_any *, enum dns_type);
838
839 DNS_PUBLIC size_t dns_any_print(void *, size_t, union dns_any *, enum dns_type);
840
841 DNS_PUBLIC size_t dns_any_cname(void *, size_t, union dns_any *, enum dns_type);
842
843
844 /*
845  * H O S T S  I N T E R F A C E
846  *
847  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
848
849 struct dns_hosts;
850
851 DNS_PUBLIC struct dns_hosts *dns_hosts_open(int *);
852
853 DNS_PUBLIC void dns_hosts_close(struct dns_hosts *);
854
855 DNS_PUBLIC dns_refcount_t dns_hosts_acquire(struct dns_hosts *);
856
857 DNS_PUBLIC dns_refcount_t dns_hosts_release(struct dns_hosts *);
858
859 DNS_PUBLIC struct dns_hosts *dns_hosts_mortal(struct dns_hosts *);
860
861 DNS_PUBLIC struct dns_hosts *dns_hosts_local(int *);
862
863 DNS_PUBLIC int dns_hosts_loadfile(struct dns_hosts *, FILE *);
864
865 DNS_PUBLIC int dns_hosts_loadpath(struct dns_hosts *, const char *);
866
867 DNS_PUBLIC int dns_hosts_dump(struct dns_hosts *, FILE *);
868
869 DNS_PUBLIC int dns_hosts_insert(struct dns_hosts *, int, const void *, const void *, _Bool);
870
871 DNS_PUBLIC struct dns_packet *dns_hosts_query(struct dns_hosts *, struct dns_packet *, int *);
872
873
874 /*
875  * R E S O L V . C O N F  I N T E R F A C E
876  *
877  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
878
879 struct dns_resolv_conf {
880         struct sockaddr_storage nameserver[3];
881
882         char search[4][DNS_D_MAXNAME + 1];
883
884         /* (f)ile, (b)ind, (c)ache */
885         char lookup[4 * (1 + (4 * 2))];
886
887         /* getaddrinfo family by preference order ("inet4", "inet6") */
888         int family[3];
889
890         struct {
891                 _Bool edns0;
892
893                 unsigned ndots;
894
895                 unsigned timeout;
896
897                 unsigned attempts;
898
899                 _Bool rotate;
900
901                 _Bool recurse;
902
903                 _Bool smart;
904
905                 enum {
906                         DNS_RESCONF_TCP_ENABLE,
907                         DNS_RESCONF_TCP_ONLY,
908                         DNS_RESCONF_TCP_SOCKS,
909                         DNS_RESCONF_TCP_DISABLE,
910                 } tcp;
911         } options;
912
913         struct sockaddr_storage iface;
914
915         struct { /* PRIVATE */
916                 dns_atomic_t refcount;
917         } _;
918 }; /* struct dns_resolv_conf */
919
920 DNS_PUBLIC struct dns_resolv_conf *dns_resconf_open(int *);
921
922 DNS_PUBLIC void dns_resconf_close(struct dns_resolv_conf *);
923
924 DNS_PUBLIC dns_refcount_t dns_resconf_acquire(struct dns_resolv_conf *);
925
926 DNS_PUBLIC dns_refcount_t dns_resconf_release(struct dns_resolv_conf *);
927
928 DNS_PUBLIC struct dns_resolv_conf *dns_resconf_mortal(struct dns_resolv_conf *);
929
930 DNS_PUBLIC struct dns_resolv_conf *dns_resconf_local(int *);
931
932 DNS_PUBLIC struct dns_resolv_conf *dns_resconf_root(int *);
933
934 DNS_PUBLIC int dns_resconf_pton(struct sockaddr_storage *, const char *);
935
936 DNS_PUBLIC int dns_resconf_loadfile(struct dns_resolv_conf *, FILE *);
937
938 DNS_PUBLIC int dns_resconf_loadpath(struct dns_resolv_conf *, const char *);
939
940 DNS_PUBLIC int dns_nssconf_loadfile(struct dns_resolv_conf *, FILE *);
941
942 DNS_PUBLIC int dns_nssconf_loadpath(struct dns_resolv_conf *, const char *);
943
944 DNS_PUBLIC int dns_resconf_dump(struct dns_resolv_conf *, FILE *);
945
946 DNS_PUBLIC int dns_nssconf_dump(struct dns_resolv_conf *, FILE *);
947
948 DNS_PUBLIC int dns_resconf_setiface(struct dns_resolv_conf *, const char *, unsigned short);
949
950 typedef unsigned long dns_resconf_i_t;
951
952 DNS_PUBLIC size_t dns_resconf_search(void *, size_t, const void *, size_t, struct dns_resolv_conf *, dns_resconf_i_t *);
953
954
955 /*
956  * H I N T  S E R V E R  I N T E R F A C E
957  *
958  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
959
960 struct dns_hints;
961
962 DNS_PUBLIC struct dns_hints *dns_hints_open(struct dns_resolv_conf *, int *);
963
964 DNS_PUBLIC void dns_hints_close(struct dns_hints *);
965
966 DNS_PUBLIC dns_refcount_t dns_hints_acquire(struct dns_hints *);
967
968 DNS_PUBLIC dns_refcount_t dns_hints_release(struct dns_hints *);
969
970 DNS_PUBLIC struct dns_hints *dns_hints_mortal(struct dns_hints *);
971
972 DNS_PUBLIC int dns_hints_insert(struct dns_hints *, const char *, const struct sockaddr *, unsigned);
973
974 DNS_PUBLIC unsigned dns_hints_insert_resconf(struct dns_hints *, const char *, const struct dns_resolv_conf *, int *);
975
976 DNS_PUBLIC struct dns_hints *dns_hints_local(struct dns_resolv_conf *, int *);
977
978 DNS_PUBLIC struct dns_hints *dns_hints_root(struct dns_resolv_conf *, int *);
979
980 DNS_PUBLIC struct dns_packet *dns_hints_query(struct dns_hints *, struct dns_packet *, int *);
981
982 DNS_PUBLIC int dns_hints_dump(struct dns_hints *, FILE *);
983
984
985 struct dns_hints_i {
986         const char *zone;
987
988         struct {
989                 unsigned next;
990                 unsigned seed;
991         } state;
992 }; /* struct dns_hints_i */
993
994 #define dns_hints_i_new(...)    (&(struct dns_hints_i){ __VA_ARGS__ })
995
996 DNS_PUBLIC unsigned dns_hints_grep(struct sockaddr **, socklen_t *, unsigned, struct dns_hints_i *, struct dns_hints *);
997
998
999 /*
1000  * C A C H E  I N T E R F A C E
1001  *
1002  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1003
1004 struct dns_cache {
1005         void *state;
1006
1007         dns_refcount_t (*acquire)(struct dns_cache *);
1008         dns_refcount_t (*release)(struct dns_cache *);
1009
1010         struct dns_packet *(*query)(struct dns_packet *, struct dns_cache *, int *);
1011
1012         int (*submit)(struct dns_packet *, struct dns_cache *);
1013         int (*check)(struct dns_cache *);
1014         struct dns_packet *(*fetch)(struct dns_cache *, int *);
1015
1016         int (*pollfd)(struct dns_cache *);
1017         short (*events)(struct dns_cache *);
1018         void (*clear)(struct dns_cache *);
1019
1020         union {
1021                 long i;
1022                 void *p;
1023         } arg[3];
1024
1025         struct { /* PRIVATE */
1026                 dns_atomic_t refcount;
1027         } _;
1028 }; /* struct dns_cache */
1029
1030
1031 DNS_PUBLIC struct dns_cache *dns_cache_init(struct dns_cache *);
1032
1033 DNS_PUBLIC void dns_cache_close(struct dns_cache *);
1034
1035
1036 /*
1037  * A P P L I C A T I O N  I N T E R F A C E
1038  *
1039  * Options to change the behavior of the API. Applies across all the
1040  * different components.
1041  *
1042  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1043
1044 #define DNS_OPTS_INITIALIZER_ { 0, 0 }, 0, 0
1045 #define DNS_OPTS_INITIALIZER  { DNS_OPTS_INITIALIZER_ }
1046 #define DNS_OPTS_INIT(...)    { DNS_OPTS_INITIALIZER_, __VA_ARGS__ }
1047
1048 #define dns_opts(...) (&dns_quietinit((struct dns_options)DNS_OPTS_INIT(__VA_ARGS__)))
1049
1050 struct dns_options {
1051         /*
1052          * If the callback closes *fd, it must set it to -1. Otherwise, the
1053          * descriptor is queued and lazily closed at object destruction or
1054          * by an explicit call to _clear(). This allows safe use of
1055          * kqueue(2), epoll(2), et al -style persistent events.
1056          */
1057         struct {
1058                 void *arg;
1059                 int (*cb)(int *fd, void *arg);
1060         } closefd;
1061
1062         /* bitmask for _events() routines */
1063         enum dns_events {
1064                 DNS_SYSPOLL,
1065                 DNS_LIBEVENT,
1066         } events;
1067
1068         /* Use this SOCKS server.  */
1069         const struct sockaddr_storage *socks_host;
1070
1071         /* Credentials for the SOCKS server (optional).  */
1072         const char *socks_user;
1073         const char *socks_password;
1074 }; /* struct dns_options */
1075
1076
1077 /*
1078  * S T A T S  I N T E R F A C E S
1079  *
1080  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1081
1082 struct dns_stat {
1083         size_t queries;
1084
1085         struct {
1086                 struct {
1087                         size_t count, bytes;
1088                 } sent, rcvd;
1089         } udp, tcp;
1090 }; /* struct dns_stat */
1091
1092
1093 /*
1094  * S O C K E T  I N T E R F A C E
1095  *
1096  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1097
1098 struct dns_socket;
1099
1100 DNS_PUBLIC struct dns_socket *dns_so_open(const struct sockaddr *, int, const struct dns_options *, int *error);
1101
1102 DNS_PUBLIC void dns_so_close(struct dns_socket *);
1103
1104 DNS_PUBLIC void dns_so_reset(struct dns_socket *);
1105
1106 DNS_PUBLIC unsigned short dns_so_mkqid(struct dns_socket *so);
1107
1108 DNS_PUBLIC struct dns_packet *dns_so_query(struct dns_socket *, struct dns_packet *, struct sockaddr *, int *);
1109
1110 DNS_PUBLIC int dns_so_submit(struct dns_socket *, struct dns_packet *, struct sockaddr *);
1111
1112 DNS_PUBLIC int dns_so_check(struct dns_socket *);
1113
1114 DNS_PUBLIC struct dns_packet *dns_so_fetch(struct dns_socket *, int *);
1115
1116 DNS_PUBLIC time_t dns_so_elapsed(struct dns_socket *);
1117
1118 DNS_PUBLIC void dns_so_clear(struct dns_socket *);
1119
1120 DNS_PUBLIC int dns_so_events(struct dns_socket *);
1121
1122 DNS_PUBLIC int dns_so_pollfd(struct dns_socket *);
1123
1124 DNS_PUBLIC int dns_so_poll(struct dns_socket *, int);
1125
1126 DNS_PUBLIC const struct dns_stat *dns_so_stat(struct dns_socket *);
1127
1128 DNS_PUBLIC struct dns_trace *dns_so_trace(struct dns_socket *);
1129
1130 DNS_PUBLIC void dns_so_settrace(struct dns_socket *, struct dns_trace *);
1131
1132
1133 /*
1134  * R E S O L V E R  I N T E R F A C E
1135  *
1136  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1137
1138 struct dns_resolver;
1139
1140 DNS_PUBLIC struct dns_resolver *dns_res_open(struct dns_resolv_conf *, struct dns_hosts *hosts, struct dns_hints *, struct dns_cache *, const struct dns_options *, int *);
1141
1142 DNS_PUBLIC struct dns_resolver *dns_res_stub(const struct dns_options *, int *);
1143
1144 DNS_PUBLIC void dns_res_reset(struct dns_resolver *);
1145
1146 DNS_PUBLIC void dns_res_close(struct dns_resolver *);
1147
1148 DNS_PUBLIC dns_refcount_t dns_res_acquire(struct dns_resolver *);
1149
1150 DNS_PUBLIC dns_refcount_t dns_res_release(struct dns_resolver *);
1151
1152 DNS_PUBLIC struct dns_resolver *dns_res_mortal(struct dns_resolver *);
1153
1154 DNS_PUBLIC int dns_res_submit(struct dns_resolver *, const char *, enum dns_type, enum dns_class);
1155
1156 DNS_PUBLIC int dns_res_submit2(struct dns_resolver *, const char *, size_t, enum dns_type, enum dns_class);
1157
1158 DNS_PUBLIC int dns_res_check(struct dns_resolver *);
1159
1160 DNS_PUBLIC struct dns_packet *dns_res_fetch(struct dns_resolver *, int *);
1161
1162 DNS_PUBLIC time_t dns_res_elapsed(struct dns_resolver *);
1163
1164 DNS_PUBLIC void dns_res_clear(struct dns_resolver *);
1165
1166 DNS_PUBLIC int dns_res_events(struct dns_resolver *);
1167
1168 DNS_PUBLIC int dns_res_pollfd(struct dns_resolver *);
1169
1170 DNS_PUBLIC time_t dns_res_timeout(struct dns_resolver *);
1171
1172 DNS_PUBLIC int dns_res_poll(struct dns_resolver *, int);
1173
1174 DNS_PUBLIC struct dns_packet *dns_res_query(struct dns_resolver *, const char *, enum dns_type, enum dns_class, int, int *);
1175
1176 DNS_PUBLIC const struct dns_stat *dns_res_stat(struct dns_resolver *);
1177
1178 DNS_PUBLIC void dns_res_sethints(struct dns_resolver *, struct dns_hints *);
1179
1180 DNS_PUBLIC struct dns_trace *dns_res_trace(struct dns_resolver *);
1181
1182 DNS_PUBLIC void dns_res_settrace(struct dns_resolver *, struct dns_trace *);
1183
1184
1185 /*
1186  * A D D R I N F O  I N T E R F A C E
1187  *
1188  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1189
1190 struct dns_addrinfo;
1191
1192 DNS_PUBLIC struct dns_addrinfo *dns_ai_open(const char *, const char *, enum dns_type, const struct addrinfo *, struct dns_resolver *, int *);
1193
1194 DNS_PUBLIC void dns_ai_close(struct dns_addrinfo *);
1195
1196 DNS_PUBLIC int dns_ai_nextent(struct addrinfo **, struct dns_addrinfo *);
1197
1198 DNS_PUBLIC size_t dns_ai_print(void *, size_t, struct addrinfo *, struct dns_addrinfo *);
1199
1200 DNS_PUBLIC time_t dns_ai_elapsed(struct dns_addrinfo *);
1201
1202 DNS_PUBLIC void dns_ai_clear(struct dns_addrinfo *);
1203
1204 DNS_PUBLIC int dns_ai_events(struct dns_addrinfo *);
1205
1206 DNS_PUBLIC int dns_ai_pollfd(struct dns_addrinfo *);
1207
1208 DNS_PUBLIC time_t dns_ai_timeout(struct dns_addrinfo *);
1209
1210 DNS_PUBLIC int dns_ai_poll(struct dns_addrinfo *, int);
1211
1212 DNS_PUBLIC const struct dns_stat *dns_ai_stat(struct dns_addrinfo *);
1213
1214 DNS_PUBLIC struct dns_trace *dns_ai_trace(struct dns_addrinfo *);
1215
1216 DNS_PUBLIC void dns_ai_settrace(struct dns_addrinfo *, struct dns_trace *);
1217
1218
1219 /*
1220  * Q U E R Y  T R A C I N G  I N T E R F A C E
1221  *
1222  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1223
1224 #define DNS_TRACE_ID_C(n) UINT64_C(n)
1225 typedef uint64_t dns_trace_id_t;
1226
1227 #define DNS_TRACE_ABI 0x20160803
1228
1229 struct dns_trace_event {
1230         enum {
1231                 DNS_TE_RES_SUBMIT = 1,
1232                 DNS_TE_RES_FETCH = 99,
1233
1234                 DNS_TE_SO_SUBMIT = 100,
1235                 DNS_TE_SO_VERIFY,
1236                 DNS_TE_SO_FETCH = 199,
1237
1238                 DNS_TE_SYS_CONNECT = 200,
1239                 DNS_TE_SYS_SEND,
1240                 DNS_TE_SYS_RECV,
1241         } type;
1242
1243         size_t size;
1244         dns_trace_id_t id;
1245         struct timespec ts;
1246         int abi;
1247
1248         union {
1249                 struct {
1250                         char qname[DNS_D_MAXNAME + 1];
1251                         enum dns_type qtype;
1252                         enum dns_class qclass;
1253                         int error;
1254                 } res_submit;
1255
1256                 struct {
1257                         int error;
1258                 } res_fetch;
1259
1260                 struct {
1261                         struct sockaddr_storage haddr;
1262                         char hname[DNS_D_MAXNAME + 1];
1263                         int error;
1264                 } so_submit;
1265
1266                 struct {
1267                         int error;
1268                 } so_verify;
1269
1270                 struct {
1271                         int error;
1272                 } so_fetch;
1273
1274                 struct {
1275                         struct sockaddr_storage src, dst;
1276                         int socktype;
1277                         dns_error_t error;
1278                 } sys_connect, sys_send, sys_recv;
1279         };
1280
1281         unsigned char data[];
1282 };
1283
1284 static inline size_t dns_te_datasize(const struct dns_trace_event *te) {
1285         size_t n = offsetof(struct dns_trace_event, data);
1286         return (n <= te->size)? te->size - n : 0;
1287 }
1288
1289 struct dns_trace;
1290
1291 DNS_PUBLIC int dns_trace_abi(void);
1292
1293 DNS_PUBLIC struct dns_trace *dns_trace_open(FILE *, dns_error_t *);
1294
1295 DNS_PUBLIC void dns_trace_close(struct dns_trace *);
1296
1297 DNS_PUBLIC dns_refcount_t dns_trace_acquire(struct dns_trace *);
1298
1299 DNS_PUBLIC dns_refcount_t dns_trace_release(struct dns_trace *);
1300
1301 DNS_PUBLIC dns_trace_id_t dns_trace_id(struct dns_trace *);
1302
1303 DNS_PUBLIC dns_trace_id_t dns_trace_setid(struct dns_trace *, dns_trace_id_t);
1304
1305 DNS_PUBLIC struct dns_trace_event *dns_trace_get(struct dns_trace *, struct dns_trace_event **, dns_error_t *);
1306
1307 DNS_PUBLIC struct dns_trace_event *dns_trace_tag(struct dns_trace *, struct dns_trace_event *);
1308
1309 DNS_PUBLIC dns_error_t dns_trace_put(struct dns_trace *, const struct dns_trace_event *, const void *, size_t);
1310
1311 DNS_PUBLIC dns_error_t dns_trace_dump(struct dns_trace *, FILE *);
1312
1313 DNS_PUBLIC struct dns_trace_event *dns_trace_fget(struct dns_trace_event **, FILE *, dns_error_t *);
1314
1315 DNS_PUBLIC dns_error_t dns_trace_fput(const struct dns_trace_event *, const void *, size_t, FILE *);
1316
1317
1318 /*
1319  * U T I L I T Y  I N T E R F A C E S
1320  *
1321  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1322
1323 DNS_PUBLIC size_t dns_strlcpy(char *, const char *, size_t);
1324
1325 DNS_PUBLIC size_t dns_strlcat(char *, const char *, size_t);
1326
1327
1328 /*
1329  * M A C R O  M A G I C S
1330  *
1331  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1332
1333 #define DNS_PP_MIN(a, b) (((a) < (b))? (a) : (b))
1334 #define DNS_PP_MAX(a, b) (((a) > (b))? (a) : (b))
1335 #define DNS_PP_NARG_(a, b, c, d, e, f, g, h, i, j, k, N,...) N
1336 #define DNS_PP_NARG(...)        DNS_PP_NARG_(__VA_ARGS__, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0)
1337 #define DNS_PP_CALL(F, ...)     F(__VA_ARGS__)
1338 #define DNS_PP_PASTE(x, y)      x##y
1339 #define DNS_PP_XPASTE(x, y)     DNS_PP_PASTE(x, y)
1340 #define DNS_PP_STRINGIFY_(s)    #s
1341 #define DNS_PP_STRINGIFY(s)     DNS_PP_STRINGIFY_(s)
1342 #define DNS_PP_D1  0
1343 #define DNS_PP_D2  1
1344 #define DNS_PP_D3  2
1345 #define DNS_PP_D4  3
1346 #define DNS_PP_D5  4
1347 #define DNS_PP_D6  5
1348 #define DNS_PP_D7  6
1349 #define DNS_PP_D8  7
1350 #define DNS_PP_D9  8
1351 #define DNS_PP_D10 9
1352 #define DNS_PP_D11 10
1353 #define DNS_PP_DEC(N) DNS_PP_XPASTE(DNS_PP_D, N)
1354
1355 #endif /* DNS_H */