FD.io VPP  v19.01.1-17-ge106252
Vector Packet Processing
dns.h
Go to the documentation of this file.
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 {
36  u8 dst_address[16];
37  u8 *name;
39 
40 typedef enum
41 {
47 
48 typedef struct
49 {
50  /** flags */
51  volatile u8 flags;
52 
53  /** The name in "normal human being" notation, e.g. www.foobar.com */
54  u8 *name;
55 
56  /** For CNAME records, the "next name" to resolve */
58 
59  /** Expiration time */
61 
62  /** Cached dns request, for sending retries */
64 
65  /** Retry parameters */
68  int server_af;
71 
72  /** Cached dns response */
74 
75  /** Clients / peers awaiting responses */
78 
79 #define DNS_CACHE_ENTRY_FLAG_VALID (1<<0) /**< we have Actual Data */
80 #define DNS_CACHE_ENTRY_FLAG_STATIC (1<<1) /**< static entry */
81 #define DNS_CACHE_ENTRY_FLAG_CNAME (1<<2) /**< CNAME (indirect) entry */
82 
83 #define DNS_RETRIES_PER_SERVER 3
84 
85 #define DNS_RESOLVER_EVENT_RESOLVED 1
86 #define DNS_RESOLVER_EVENT_PENDING 2
87 
88 
89 typedef struct
90 {
91  /** Pool of cache entries */
93 
94  /** Pool indices of unresolved entries */
96 
97  /** Find cached record by name */
100 
101  /** enable / disable flag */
103 
104  /** udp port registration complete */
106 
107  /** upstream name servers, e.g. 8.8.8.8 */
110 
111  /** config parameters */
115 
116  /* convenience */
119 } dns_main_t;
120 
121 extern dns_main_t dns_main;
122 
127 
128 #define foreach_dns46_request_error \
129 _(NONE, "No error") \
130 _(UNIMPLEMENTED, "Unimplemented") \
131 _(PROCESSED, "DNS request pkts processed") \
132 _(IP_OPTIONS, "DNS pkts with ip options (dropped)") \
133 _(BAD_REQUEST, "DNS pkts with serious discrepanices (dropped)") \
134 _(TOO_MANY_REQUESTS, "DNS pkts asking too many questions") \
135 _(RESOLUTION_REQUIRED, "DNS pkts pending upstream name resolution")
136 
137 typedef enum
138 {
139 #define _(sym,str) DNS46_REQUEST_ERROR_##sym,
141 #undef _
144 
145 #define foreach_dns46_reply_error \
146 _(DISABLED, "DNS pkts punted (feature disabled)") \
147 _(PROCESSED, "DNS reply pkts processed") \
148 _(NO_ELT, "No DNS pool element") \
149 _(FORMAT_ERROR, "DNS format errors") \
150 _(TEST_DROP, "DNS reply pkt dropped for test purposes")
151 
152 typedef enum
153 {
154 #define _(sym,str) DNS46_REPLY_ERROR_##sym,
156 #undef _
159 
161 int
162 vnet_dns_cname_indirection_nolock (dns_main_t * dm, u32 ep_index, u8 * reply);
163 
165 
166 int
168  dns_cache_entry_t ** retp);
169 
170 void
172  dns_cache_entry_t * ep, ip6_address_t * server);
173 void
175  dns_cache_entry_t * ep, ip4_address_t * server);
176 
178  dns_cache_entry_t * ep, vlib_buffer_t * b0);
179 
181  dns_cache_entry_t * ep, vlib_buffer_t * b0);
182 
183 u8 *vnet_dns_labels_to_name (u8 * label, u8 * full_text,
184  u8 ** parse_from_here);
185 
187 
188 static inline void
190 {
191  if (dm->cache_lock)
192  {
194  ;
195  }
196 }
197 
198 static inline void
200 {
201  if (dm->cache_lock)
202  {
204  *dm->cache_lock = 0;
205  }
206 }
207 
208 #endif /* included_dns_h */
209 
210 /*
211  * fd.io coding-style-patch-verification: ON
212  *
213  * Local Variables:
214  * eval: (c-set-style "gnu")
215  * End:
216  */
Definition: dns.h:48
void vnet_send_dns4_reply(dns_main_t *dm, dns_pending_request_t *t, dns_cache_entry_t *ep, vlib_buffer_t *b0)
Definition: dns.c:2735
ip6_address_t * ip6_name_servers
Definition: dns.h:109
dns_main_t dns_main
Definition: dns.c:42
u8 * vnet_dns_labels_to_name(u8 *label, u8 *full_text, u8 **parse_from_here)
arc-function for the above.
Definition: dns.c:491
vlib_node_registration_t dns46_reply_node
(constructor) VLIB_REGISTER_NODE (dns46_reply_node)
Definition: reply_node.c:42
void vnet_dns_send_dns4_request(dns_main_t *dm, dns_cache_entry_t *ep, ip4_address_t *server)
Definition: dns.c:219
vlib_node_registration_t dns4_request_node
(constructor) VLIB_REGISTER_NODE (dns4_request_node)
Definition: request_node.c:293
u8 * dns_response
Cached dns response.
Definition: dns.h:73
int retry_count
Retry parameters.
Definition: dns.h:66
int vnet_dns_resolve_name(dns_main_t *dm, u8 *name, dns_pending_request_t *t, dns_cache_entry_t **retp)
Definition: dns.c:802
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
u32 client_context
Definition: dns.h:31
void vnet_dns_send_dns6_request(dns_main_t *dm, dns_cache_entry_t *ep, ip6_address_t *server)
Definition: dns.c:335
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
vlib_main_t * vlib_main
Definition: dns.h:117
u8 * dns_request
Cached dns request, for sending retries.
Definition: dns.h:63
f64 retry_timer
Definition: dns.h:70
u32 * unresolved_entries
Pool indices of unresolved entries.
Definition: dns.h:95
unsigned int u32
Definition: types.h:88
dns_pending_request_t * pending_requests
Clients / peers awaiting responses.
Definition: dns.h:76
#define clib_atomic_test_and_set(a)
Definition: atomics.h:40
ip4_address_t * ip4_name_servers
upstream name servers, e.g.
Definition: dns.h:108
u8 * cname
For CNAME records, the "next name" to resolve.
Definition: dns.h:57
u8 * name
The name in "normal human being" notation, e.g.
Definition: dns.h:54
unsigned short u16
Definition: types.h:57
#define foreach_dns46_reply_error
Definition: dns.h:145
u8 name[64]
Definition: memclnt.api:152
dns46_reply_error_t
Definition: dns.h:152
int server_rotor
Definition: dns.h:67
int vnet_dns_cname_indirection_nolock(dns_main_t *dm, u32 ep_index, u8 *reply)
Handle cname indirection.
Definition: dns.c:955
dns_pending_request_type_t
Definition: dns.h:40
static void dns_cache_unlock(dns_main_t *dm)
Definition: dns.h:199
int vnet_dns_delete_entry_by_index_nolock(dns_main_t *dm, u32 index)
Definition: dns.c:656
static void dns_cache_lock(dns_main_t *dm)
Definition: dns.h:189
uword * cache_lock
Definition: dns.h:99
void vnet_send_dns6_reply(dns_main_t *dm, dns_pending_request_t *t, dns_cache_entry_t *ep, vlib_buffer_t *b0)
Definition: dns.c:2727
volatile u8 flags
flags
Definition: dns.h:51
vnet_main_t * vnet_main
Definition: dns.h:118
int udp_ports_registered
udp port registration complete
Definition: dns.h:105
uword * cache_entry_by_name
Find cached record by name.
Definition: dns.h:98
vlib_node_registration_t dns_resolver_node
(constructor) VLIB_REGISTER_NODE (dns_resolver_node)
vlib_node_registration_t dns6_request_node
(constructor) VLIB_REGISTER_NODE (dns6_request_node)
Definition: request_node.c:320
struct _vlib_node_registration vlib_node_registration_t
u32 max_ttl_in_seconds
Definition: dns.h:113
u32 name_cache_size
config parameters
Definition: dns.h:112
u64 uword
Definition: types.h:112
format_function_t format_dns_reply
Definition: dns.h:186
Definition: dns.h:89
int server_fails
Definition: dns.h:69
void vnet_send_dns_request(dns_main_t *dm, dns_cache_entry_t *ep)
Definition: dns.c:533
u32 random_seed
Definition: dns.h:114
int server_af
Definition: dns.h:68
#define CLIB_MEMORY_BARRIER()
Definition: clib.h:115
f64 expiration_time
Expiration time.
Definition: dns.h:60
#define foreach_dns46_request_error
Definition: dns.h:128
dns46_request_error_t
Definition: dns.h:137
int is_enabled
enable / disable flag
Definition: dns.h:102
dns_cache_entry_t * entries
Pool of cache entries.
Definition: dns.h:92