src/resolve/resolved-dns-answer.h

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