src/vnet/dns/dns.h

   1 /*
   2  * Copyright (c) 2017 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef included_dns_h
  17 #define included_dns_h
  18
  19 #include <vppinfra/time.h>
  20 #include <vppinfra/cache.h>
  21 #include <vppinfra/error.h>
  22
  23 #include <vppinfra/hash.h>
  24 #include <vnet/dns/dns_packet.h>
  25 #include <vnet/ip/ip.h>
  26
  27 typedef struct
  28 {
  29   /** flags */
  30   volatile u8 flags;
  31
  32   /** The name in "normal human being" notation, e.g. www.foobar.com */
  33   u8 *name;
  34
  35   /** For CNAME records, the "next name" to resolve */
  36   u8 *cname;
  37
  38   /** Expiration time */
  39   f64 expiration_time;
  40
  41   /** Cached dns request, for sending retries */
  42   u8 *dns_request;
  43
  44   /** Retry parameters */
  45   int retry_count;
  46   int server_rotor;
  47   int server_af;
  48   f64 retry_timer;
  49
  50   /** Cached dns response */
  51   u8 *dns_response;
  52
  53   /** Clients awaiting responses */
  54   u32 *api_clients_to_notify;
  55   u32 *api_client_contexts;
  56   ip4_address_t *ip4_peers_to_notify;
  57   ip6_address_t *ip6_peers_to_notify;
  58 } dns_cache_entry_t;
  59
  60 #define DNS_CACHE_ENTRY_FLAG_VALID      (1<<0) /**< we have Actual Data */
  61 #define DNS_CACHE_ENTRY_FLAG_STATIC     (1<<1) /**< static entry */
  62 #define DNS_CACHE_ENTRY_FLAG_CNAME      (1<<2) /**< CNAME (indirect) entry */
  63
  64 #define DNS_RETRIES_PER_SERVER 3
  65
  66 #define DNS_RESOLVER_EVENT_RESOLVED     1
  67 #define DNS_RESOLVER_EVENT_PENDING      2
  68
  69
  70 typedef struct
  71 {
  72   /** Pool of cache entries */
  73   dns_cache_entry_t *entries;
  74
  75   /** Pool indices of unresolved entries */
  76   u32 *unresolved_entries;
  77
  78   /** Find cached record by name */
  79   uword *cache_entry_by_name;
  80   uword *cache_lock;
  81
  82   /** enable / disable flag */
  83   int is_enabled;
  84
  85   /** upstream name servers, e.g. 8.8.8.8 */
  86   ip4_address_t *ip4_name_servers;
  87   ip6_address_t *ip6_name_servers;
  88
  89   /** config parameters */
  90   u32 name_cache_size;
  91   u32 max_ttl_in_seconds;
  92   u32 random_seed;
  93
  94   /* convenience */
  95   vlib_main_t *vlib_main;
  96   vnet_main_t *vnet_main;
  97 } dns_main_t;
  98
  99 extern dns_main_t dns_main;
 100
 101 extern vlib_node_registration_t dns46_reply_node;
 102 extern vlib_node_registration_t dns_resolver_node;
 103
 104 #define foreach_dns46_reply_error                       \
 105 _(PROCESSED, "DNS reply pkts processed")                \
 106 _(NO_ELT, "No DNS pool element")                        \
 107 _(FORMAT_ERROR, "DNS format errors")                    \
 108 _(TEST_DROP, "DNS reply pkt dropped for test purposes")
 109
 110 typedef enum
 111 {
 112 #define _(sym,str) DNS46_REPLY_ERROR_##sym,
 113   foreach_dns46_reply_error
 114 #undef _
 115     DNS46_REPLY_N_ERROR,
 116 } dns46_reply_error_t;
 117
 118 void vnet_send_dns_request (dns_main_t * dm, dns_cache_entry_t * ep);
 119 int
 120 vnet_dns_cname_indirection_nolock (dns_main_t * dm, u32 ep_index, u8 * reply);
 121
 122 int vnet_dns_delete_entry_by_index_nolock (dns_main_t * dm, u32 index);
 123
 124 format_function_t format_dns_reply;
 125
 126 static inline void
 127 dns_cache_lock (dns_main_t * dm)
 128 {
 129   if (dm->cache_lock)
 130     {
 131       while (__sync_lock_test_and_set (dm->cache_lock, 1))
 132         ;
 133     }
 134 }
 135
 136 static inline void
 137 dns_cache_unlock (dns_main_t * dm)
 138 {
 139   if (dm->cache_lock)
 140     {
 141       CLIB_MEMORY_BARRIER ();
 142       *dm->cache_lock = 0;
 143     }
 144 }
 145
 146 #endif /* included_dns_h */
 147
 148 /*
 149  * fd.io coding-style-patch-verification: ON
 150  *
 151  * Local Variables:
 152  * eval: (c-set-style "gnu")
 153  * End:
 154  */