]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/resolve/resolved-dns-answer.h
Merge pull request #7388 from keszybz/doc-tweak
[thirdparty/systemd.git] / src / resolve / resolved-dns-answer.h
CommitLineData
faa133f3
LP
1#pragma once
2
3/***
4 This file is part of systemd.
5
6 Copyright 2014 Lennart Poettering
7
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
12
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
17
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
20***/
21
22typedef struct DnsAnswer DnsAnswer;
78c6a153 23typedef struct DnsAnswerItem DnsAnswerItem;
faa133f3 24
92aea95e 25#include "macro.h"
faa133f3
LP
26#include "resolved-dns-rr.h"
27
78c6a153
LP
28/* A simple array of resource records. We keep track of the
29 * originating ifindex for each RR where that makes sense, so that we
30 * can qualify A and AAAA RRs referring to a local link with the
547973de
LP
31 * right ifindex.
32 *
c629ff58 33 * Note that we usually encode the empty DnsAnswer object as a simple NULL. */
105e1512
LP
34
35typedef enum DnsAnswerFlags {
c3ae4188
DR
36 DNS_ANSWER_AUTHENTICATED = 1, /* Item has been authenticated */
37 DNS_ANSWER_CACHEABLE = 2, /* Item is subject to caching */
38 DNS_ANSWER_SHARED_OWNER = 4, /* For mDNS: RRset may be owner by multiple peers */
39 DNS_ANSWER_CACHE_FLUSH = 8, /* For mDNS: sets cache-flush bit in the rrclass of response records */
40 DNS_ANSWER_GOODBYE = 16, /* For mDNS: item is subject to disappear */
105e1512 41} DnsAnswerFlags;
78c6a153
LP
42
43struct DnsAnswerItem {
44 DnsResourceRecord *rr;
45 int ifindex;
105e1512 46 DnsAnswerFlags flags;
78c6a153 47};
faa133f3
LP
48
49struct DnsAnswer {
50 unsigned n_ref;
51 unsigned n_rrs, n_allocated;
78c6a153 52 DnsAnswerItem items[0];
faa133f3
LP
53};
54
55DnsAnswer *dns_answer_new(unsigned n);
56DnsAnswer *dns_answer_ref(DnsAnswer *a);
57DnsAnswer *dns_answer_unref(DnsAnswer *a);
58
105e1512
LP
59int dns_answer_add(DnsAnswer *a, DnsResourceRecord *rr, int ifindex, DnsAnswerFlags flags);
60int dns_answer_add_extend(DnsAnswer **a, DnsResourceRecord *rr, int ifindex, DnsAnswerFlags flags);
97ebebbc 61int dns_answer_add_soa(DnsAnswer *a, const char *name, uint32_t ttl, int ifindex);
faa133f3 62
105e1512
LP
63int dns_answer_match_key(DnsAnswer *a, const DnsResourceKey *key, DnsAnswerFlags *combined_flags);
64int dns_answer_contains_rr(DnsAnswer *a, DnsResourceRecord *rr, DnsAnswerFlags *combined_flags);
65int dns_answer_contains_key(DnsAnswer *a, const DnsResourceKey *key, DnsAnswerFlags *combined_flags);
66int dns_answer_contains_nsec_or_nsec3(DnsAnswer *a);
e926785a 67int dns_answer_contains_zone_nsec3(DnsAnswer *answer, const char *zone);
547973de 68
fd009cd8 69int dns_answer_find_soa(DnsAnswer *a, const DnsResourceKey *key, DnsResourceRecord **ret, DnsAnswerFlags *flags);
105e1512 70int dns_answer_find_cname_or_dname(DnsAnswer *a, const DnsResourceKey *key, DnsResourceRecord **ret, DnsAnswerFlags *flags);
547973de
LP
71
72int dns_answer_merge(DnsAnswer *a, DnsAnswer *b, DnsAnswer **ret);
73int dns_answer_extend(DnsAnswer **a, DnsAnswer *b);
74
af93291c 75void dns_answer_order_by_scope(DnsAnswer *a, bool prefer_link_local);
934e9b10 76
78c6a153 77int dns_answer_reserve(DnsAnswer **a, unsigned n_free);
547973de
LP
78int dns_answer_reserve_or_clone(DnsAnswer **a, unsigned n_free);
79
80int dns_answer_remove_by_key(DnsAnswer **a, const DnsResourceKey *key);
0c857028
LP
81int dns_answer_remove_by_rr(DnsAnswer **a, DnsResourceRecord *rr);
82
105e1512
LP
83int dns_answer_copy_by_key(DnsAnswer **a, DnsAnswer *source, const DnsResourceKey *key, DnsAnswerFlags or_flags);
84int dns_answer_move_by_key(DnsAnswer **to, DnsAnswer **from, const DnsResourceKey *key, DnsAnswerFlags or_flags);
547973de 85
43e6779a
LP
86bool dns_answer_has_dname_for_cname(DnsAnswer *a, DnsResourceRecord *cname);
87
547973de
LP
88static inline unsigned dns_answer_size(DnsAnswer *a) {
89 return a ? a->n_rrs : 0;
90}
78c6a153 91
501e8eb0
LP
92static inline bool dns_answer_isempty(DnsAnswer *a) {
93 return dns_answer_size(a) <= 0;
94}
95
26156910
LP
96void dns_answer_dump(DnsAnswer *answer, FILE *f);
97
faa133f3 98DEFINE_TRIVIAL_CLEANUP_FUNC(DnsAnswer*, dns_answer_unref);
45ec7efb 99
92aea95e
LP
100#define _DNS_ANSWER_FOREACH(q, kk, a) \
101 for (unsigned UNIQ_T(i, q) = ({ \
801ad6a6 102 (kk) = ((a) && (a)->n_rrs > 0) ? (a)->items[0].rr : NULL; \
45ec7efb 103 0; \
92aea95e
LP
104 }); \
105 (a) && (UNIQ_T(i, q) < (a)->n_rrs); \
106 UNIQ_T(i, q)++, (kk) = (UNIQ_T(i, q) < (a)->n_rrs ? (a)->items[UNIQ_T(i, q)].rr : NULL))
45ec7efb 107
92aea95e
LP
108#define DNS_ANSWER_FOREACH(kk, a) _DNS_ANSWER_FOREACH(UNIQ, kk, a)
109
aa44ee27 110#define _DNS_ANSWER_FOREACH_IFINDEX(q, kk, ifi, a) \
92aea95e 111 for (unsigned UNIQ_T(i, q) = ({ \
801ad6a6 112 (kk) = ((a) && (a)->n_rrs > 0) ? (a)->items[0].rr : NULL; \
aa44ee27 113 (ifi) = ((a) && (a)->n_rrs > 0) ? (a)->items[0].ifindex : 0; \
45ec7efb 114 0; \
92aea95e
LP
115 }); \
116 (a) && (UNIQ_T(i, q) < (a)->n_rrs); \
105e1512
LP
117 UNIQ_T(i, q)++, \
118 (kk) = ((UNIQ_T(i, q) < (a)->n_rrs) ? (a)->items[UNIQ_T(i, q)].rr : NULL), \
119 (ifi) = ((UNIQ_T(i, q) < (a)->n_rrs) ? (a)->items[UNIQ_T(i, q)].ifindex : 0))
92aea95e
LP
120
121#define DNS_ANSWER_FOREACH_IFINDEX(kk, ifindex, a) _DNS_ANSWER_FOREACH_IFINDEX(UNIQ, kk, ifindex, a)
105e1512
LP
122
123#define _DNS_ANSWER_FOREACH_FLAGS(q, kk, fl, a) \
124 for (unsigned UNIQ_T(i, q) = ({ \
125 (kk) = ((a) && (a)->n_rrs > 0) ? (a)->items[0].rr : NULL; \
126 (fl) = ((a) && (a)->n_rrs > 0) ? (a)->items[0].flags : 0; \
127 0; \
128 }); \
129 (a) && (UNIQ_T(i, q) < (a)->n_rrs); \
130 UNIQ_T(i, q)++, \
131 (kk) = ((UNIQ_T(i, q) < (a)->n_rrs) ? (a)->items[UNIQ_T(i, q)].rr : NULL), \
132 (fl) = ((UNIQ_T(i, q) < (a)->n_rrs) ? (a)->items[UNIQ_T(i, q)].flags : 0))
133
134#define DNS_ANSWER_FOREACH_FLAGS(kk, flags, a) _DNS_ANSWER_FOREACH_FLAGS(UNIQ, kk, flags, a)
135
136#define _DNS_ANSWER_FOREACH_FULL(q, kk, ifi, fl, a) \
137 for (unsigned UNIQ_T(i, q) = ({ \
138 (kk) = ((a) && (a)->n_rrs > 0) ? (a)->items[0].rr : NULL; \
139 (ifi) = ((a) && (a)->n_rrs > 0) ? (a)->items[0].ifindex : 0; \
140 (fl) = ((a) && (a)->n_rrs > 0) ? (a)->items[0].flags : 0; \
141 0; \
142 }); \
143 (a) && (UNIQ_T(i, q) < (a)->n_rrs); \
144 UNIQ_T(i, q)++, \
145 (kk) = ((UNIQ_T(i, q) < (a)->n_rrs) ? (a)->items[UNIQ_T(i, q)].rr : NULL), \
146 (ifi) = ((UNIQ_T(i, q) < (a)->n_rrs) ? (a)->items[UNIQ_T(i, q)].ifindex : 0), \
147 (fl) = ((UNIQ_T(i, q) < (a)->n_rrs) ? (a)->items[UNIQ_T(i, q)].flags : 0))
148
149#define DNS_ANSWER_FOREACH_FULL(kk, ifindex, flags, a) _DNS_ANSWER_FOREACH_FULL(UNIQ, kk, ifindex, flags, a)