Zephyr Project API 4.1.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
dns_resolve.h
Go to the documentation of this file.
1
7/*
8 * Copyright (c) 2017 Intel Corporation
9 *
10 * SPDX-License-Identifier: Apache-2.0
11 */
12
13#ifndef ZEPHYR_INCLUDE_NET_DNS_RESOLVE_H_
14#define ZEPHYR_INCLUDE_NET_DNS_RESOLVE_H_
15
16#include <zephyr/kernel.h>
17#include <zephyr/net/net_ip.h>
18#include <zephyr/net/net_if.h>
20#include <zephyr/net/net_core.h>
21
22#ifdef __cplusplus
23extern "C" {
24#endif
25
46
48#if defined(CONFIG_DNS_RESOLVER_MAX_NAME_LEN)
49#define DNS_MAX_NAME_SIZE CONFIG_DNS_RESOLVER_MAX_NAME_LEN
50#else
51#define DNS_MAX_NAME_SIZE 20
52#endif /* CONFIG_DNS_RESOLVER_MAX_NAME_LEN */
53
56#define DNS_BUF_TIMEOUT K_MSEC(500) /* ms */
57
58/* This value is recommended by RFC 1035 */
59#if defined(CONFIG_DNS_RESOLVER_MAX_ANSWER_SIZE)
60#define DNS_RESOLVER_MAX_BUF_SIZE CONFIG_DNS_RESOLVER_MAX_ANSWER_SIZE
61#else
62#define DNS_RESOLVER_MAX_BUF_SIZE 512
63#endif /* CONFIG_DNS_RESOLVER_MAX_ANSWER_SIZE */
64
65/* Make sure that we can compile things even if CONFIG_DNS_RESOLVER
66 * is not enabled.
67 */
68#if defined(CONFIG_DNS_RESOLVER_MAX_SERVERS)
69#define DNS_RESOLVER_MAX_SERVERS CONFIG_DNS_RESOLVER_MAX_SERVERS
70#else
71#define DNS_RESOLVER_MAX_SERVERS 0
72#endif
73
74#if defined(CONFIG_DNS_NUM_CONCUR_QUERIES)
75#define DNS_NUM_CONCUR_QUERIES CONFIG_DNS_NUM_CONCUR_QUERIES
76#else
77#define DNS_NUM_CONCUR_QUERIES 1
78#endif
79
80#if defined(CONFIG_NET_IF_MAX_IPV6_COUNT)
81#define MAX_IPV6_IFACE_COUNT CONFIG_NET_IF_MAX_IPV6_COUNT
82#else
83#define MAX_IPV6_IFACE_COUNT 1
84#endif
85
86#if defined(CONFIG_NET_IF_MAX_IPV4_COUNT)
87#define MAX_IPV4_IFACE_COUNT CONFIG_NET_IF_MAX_IPV4_COUNT
88#else
89#define MAX_IPV4_IFACE_COUNT 1
90#endif
91
92/* If mDNS is enabled, then add some extra well known multicast servers to the
93 * server list.
94 */
95#if defined(CONFIG_MDNS_RESOLVER)
96#if defined(CONFIG_NET_IPV6) && defined(CONFIG_NET_IPV4)
97#define MDNS_SERVER_COUNT 2
98#else
99#define MDNS_SERVER_COUNT 1
100#endif /* CONFIG_NET_IPV6 && CONFIG_NET_IPV4 */
101#else
102#define MDNS_SERVER_COUNT 0
103#endif /* CONFIG_MDNS_RESOLVER */
104
105/* If LLMNR is enabled, then add some extra well known multicast servers to the
106 * server list.
107 */
108#if defined(CONFIG_LLMNR_RESOLVER)
109#if defined(CONFIG_NET_IPV6) && defined(CONFIG_NET_IPV4)
110#define LLMNR_SERVER_COUNT 2
111#else
112#define LLMNR_SERVER_COUNT 1
113#endif /* CONFIG_NET_IPV6 && CONFIG_NET_IPV4 */
114#else
115#define LLMNR_SERVER_COUNT 0
116#endif /* CONFIG_MDNS_RESOLVER */
117
118#define DNS_MAX_MCAST_SERVERS (MDNS_SERVER_COUNT + LLMNR_SERVER_COUNT)
119
120#if defined(CONFIG_MDNS_RESPONDER)
121#if defined(CONFIG_NET_IPV6)
122#define MDNS_MAX_IPV6_IFACE_COUNT CONFIG_NET_IF_MAX_IPV6_COUNT
123#else
124#define MDNS_MAX_IPV6_IFACE_COUNT 0
125#endif /* CONFIG_NET_IPV6 */
126
127#if defined(CONFIG_NET_IPV4)
128#define MDNS_MAX_IPV4_IFACE_COUNT CONFIG_NET_IF_MAX_IPV4_COUNT
129#else
130#define MDNS_MAX_IPV4_IFACE_COUNT 0
131#endif /* CONFIG_NET_IPV4 */
132
133#define MDNS_MAX_POLL (MDNS_MAX_IPV4_IFACE_COUNT + MDNS_MAX_IPV6_IFACE_COUNT)
134#else
135#define MDNS_MAX_POLL 0
136#endif /* CONFIG_MDNS_RESPONDER */
137
138#if defined(CONFIG_LLMNR_RESPONDER)
139#if defined(CONFIG_NET_IPV6) && defined(CONFIG_NET_IPV4)
140#define LLMNR_MAX_POLL 2
141#else
142#define LLMNR_MAX_POLL 1
143#endif
144#else
145#define LLMNR_MAX_POLL 0
146#endif /* CONFIG_LLMNR_RESPONDER */
147
148#define DNS_RESOLVER_MAX_POLL (DNS_RESOLVER_MAX_SERVERS + DNS_MAX_MCAST_SERVERS)
149
151#define DNS_DISPATCHER_MAX_POLL (DNS_RESOLVER_MAX_POLL + MDNS_MAX_POLL + LLMNR_MAX_POLL)
152
153#if defined(CONFIG_ZVFS_POLL_MAX)
154BUILD_ASSERT(CONFIG_ZVFS_POLL_MAX >= DNS_DISPATCHER_MAX_POLL,
155 "CONFIG_ZVFS_POLL_MAX must be larger than " STRINGIFY(DNS_DISPATCHER_MAX_POLL));
156#endif
157
161enum dns_socket_type {
162 DNS_SOCKET_RESOLVER = 1,
163 DNS_SOCKET_RESPONDER = 2
164};
165
167struct mdns_responder_context;
168struct dns_socket_dispatcher;
169
184typedef int (*dns_socket_dispatcher_cb)(struct dns_socket_dispatcher *ctx, int sock,
185 struct sockaddr *addr, size_t addrlen,
186 struct net_buf *buf, size_t data_len);
187
189struct dns_socket_dispatcher {
191 sys_snode_t node;
193 const struct net_socket_service_desc *svc;
197 union {
198 void *ctx;
199 struct dns_resolve_context *resolve_ctx;
200 struct mdns_responder_context *mdns_ctx;
201 };
202
204 enum dns_socket_type type;
206 struct sockaddr local_addr;
208 dns_socket_dispatcher_cb cb;
210 struct zsock_pollfd *fds;
212 int fds_len;
214 int sock;
216 int ifindex;
220 struct dns_socket_dispatcher *pair;
222 struct k_mutex lock;
224 k_timeout_t buf_timeout;
225};
226
236int dns_dispatcher_register(struct dns_socket_dispatcher *ctx);
237
247int dns_dispatcher_unregister(struct dns_socket_dispatcher *ctx);
248
264
304
324typedef void (*dns_resolve_cb_t)(enum dns_resolve_status status,
325 struct dns_addrinfo *info,
326 void *user_data);
327
330enum dns_resolve_context_state {
331 DNS_RESOLVE_CONTEXT_UNINITIALIZED = 0,
332 DNS_RESOLVE_CONTEXT_ACTIVE,
333 DNS_RESOLVE_CONTEXT_DEACTIVATING,
334 DNS_RESOLVE_CONTEXT_INACTIVE,
335};
336
344 struct dns_server {
347
349 int sock;
350
355
358
361
364 struct dns_socket_dispatcher dispatcher;
366 } servers[DNS_RESOLVER_MAX_POLL];
367
370 struct zsock_pollfd fds[DNS_RESOLVER_MAX_POLL];
374 struct k_mutex lock;
375
380
433
435 enum dns_resolve_context_state state;
436};
437
440struct mdns_probe_user_data {
441 struct mdns_responder_context *ctx;
442 char query[DNS_MAX_NAME_SIZE + 1];
443 uint16_t dns_id;
444};
445
446struct mdns_responder_context {
447 struct sockaddr server_addr;
448 struct dns_socket_dispatcher dispatcher;
449 struct zsock_pollfd fds[1];
450 int sock;
451 struct net_if *iface;
452#if defined(CONFIG_MDNS_RESPONDER_PROBE)
453 struct k_work_delayable probe_timer;
454 struct dns_resolve_context probe_ctx;
455 struct mdns_probe_user_data probe_data;
456#endif
457};
458
489 const char *dns_servers_str[],
490 const struct sockaddr *dns_servers_sa[]);
491
500
512
533 const char *servers_str[],
534 const struct sockaddr *servers_sa[]);
535
558 const char *servers_str[],
559 const struct sockaddr *servers_sa[],
560 int interfaces[]);
561
570int dns_resolve_remove(struct dns_resolve_context *ctx, int if_index);
571
583 uint16_t dns_id);
584
598 uint16_t dns_id,
599 const char *query_name,
600 enum dns_query_type query_type);
601
630 const char *query,
631 enum dns_query_type type,
632 uint16_t *dns_id,
634 void *user_data,
635 int32_t timeout);
636
664static inline int dns_resolve_service(struct dns_resolve_context *ctx,
665 const char *query,
666 uint16_t *dns_id,
668 void *user_data,
669 int32_t timeout)
670{
671 return dns_resolve_name(ctx, query, DNS_QUERY_TYPE_PTR,
672 dns_id, cb, user_data, timeout);
673}
674
686
714static inline int dns_get_addr_info(const char *query,
715 enum dns_query_type type,
716 uint16_t *dns_id,
718 void *user_data,
719 int32_t timeout)
720{
722 query,
723 type,
724 dns_id,
725 cb,
726 user_data,
727 timeout);
728}
729
739static inline int dns_cancel_addr_info(uint16_t dns_id)
740{
742}
743
753#if defined(CONFIG_DNS_RESOLVER_AUTO_INIT)
754void dns_init_resolver(void);
755
756#else
757#define dns_init_resolver(...)
758#endif /* CONFIG_DNS_RESOLVER_AUTO_INIT */
759
762#ifdef __cplusplus
763}
764#endif
765
766#endif /* ZEPHYR_INCLUDE_NET_DNS_RESOLVE_H_ */
int dns_resolve_name(struct dns_resolve_context *ctx, const char *query, enum dns_query_type type, uint16_t *dns_id, dns_resolve_cb_t cb, void *user_data, int32_t timeout)
Resolve DNS name.
static int dns_cancel_addr_info(uint16_t dns_id)
Cancel a pending DNS query.
Definition dns_resolve.h:739
int dns_resolve_remove(struct dns_resolve_context *ctx, int if_index)
Remove servers from the DNS resolving context.
dns_resolve_status
Status values for the callback.
Definition dns_resolve.h:268
dns_query_type
DNS query type enum.
Definition dns_resolve.h:38
int dns_resolve_init_default(struct dns_resolve_context *ctx)
Init DNS resolving context with default Kconfig options.
int dns_resolve_init(struct dns_resolve_context *ctx, const char *dns_servers_str[], const struct sockaddr *dns_servers_sa[])
Init DNS resolving context.
int dns_resolve_cancel(struct dns_resolve_context *ctx, uint16_t dns_id)
Cancel a pending DNS query.
void(* dns_resolve_cb_t)(enum dns_resolve_status status, struct dns_addrinfo *info, void *user_data)
DNS resolve callback.
Definition dns_resolve.h:324
int dns_resolve_reconfigure(struct dns_resolve_context *ctx, const char *servers_str[], const struct sockaddr *servers_sa[])
Reconfigure DNS resolving context.
int dns_resolve_close(struct dns_resolve_context *ctx)
Close DNS resolving context.
int dns_resolve_reconfigure_with_interfaces(struct dns_resolve_context *ctx, const char *servers_str[], const struct sockaddr *servers_sa[], int interfaces[])
Reconfigure DNS resolving context with new server list and allowing servers to be specified to a spec...
#define DNS_MAX_NAME_SIZE
Max size of the resolved name.
Definition dns_resolve.h:51
struct dns_resolve_context * dns_resolve_get_default(void)
Get default DNS context.
int dns_resolve_cancel_with_name(struct dns_resolve_context *ctx, uint16_t dns_id, const char *query_name, enum dns_query_type query_type)
Cancel a pending DNS query using id, name and type.
static int dns_resolve_service(struct dns_resolve_context *ctx, const char *query, uint16_t *dns_id, dns_resolve_cb_t cb, void *user_data, int32_t timeout)
Resolve DNS service.
Definition dns_resolve.h:664
static int dns_get_addr_info(const char *query, enum dns_query_type type, uint16_t *dns_id, dns_resolve_cb_t cb, void *user_data, int32_t timeout)
Get IP address info from DNS.
Definition dns_resolve.h:714
@ DNS_EAI_MEMORY
Memory allocation failure.
Definition dns_resolve.h:288
@ DNS_EAI_NOTCANCELED
Request not canceled.
Definition dns_resolve.h:298
@ DNS_EAI_IDN_ENCODE
IDN encoding failed.
Definition dns_resolve.h:302
@ DNS_EAI_ADDRFAMILY
Address family for NAME not supported.
Definition dns_resolve.h:286
@ DNS_EAI_INPROGRESS
Processing request in progress.
Definition dns_resolve.h:294
@ DNS_EAI_FAIL
Non-recoverable failure in name res.
Definition dns_resolve.h:276
@ DNS_EAI_AGAIN
Temporary failure in name resolution.
Definition dns_resolve.h:274
@ DNS_EAI_NODATA
No address associated with NAME.
Definition dns_resolve.h:278
@ DNS_EAI_NONAME
NAME or SERVICE is unknown.
Definition dns_resolve.h:272
@ DNS_EAI_FAMILY
‘ai_family’ not supported
Definition dns_resolve.h:280
@ DNS_EAI_OVERFLOW
Argument buffer overflow.
Definition dns_resolve.h:292
@ DNS_EAI_CANCELED
Request canceled.
Definition dns_resolve.h:296
@ DNS_EAI_BADFLAGS
Invalid value for ‘ai_flags’ field.
Definition dns_resolve.h:270
@ DNS_EAI_SOCKTYPE
‘ai_socktype’ not supported
Definition dns_resolve.h:282
@ DNS_EAI_ALLDONE
All requests done.
Definition dns_resolve.h:300
@ DNS_EAI_SYSTEM
System error returned in ‘errno’.
Definition dns_resolve.h:290
@ DNS_EAI_SERVICE
SRV not supported for ‘ai_socktype’.
Definition dns_resolve.h:284
@ DNS_QUERY_TYPE_PTR
PTR query.
Definition dns_resolve.h:42
@ DNS_QUERY_TYPE_A
IPv4 query.
Definition dns_resolve.h:40
@ DNS_QUERY_TYPE_AAAA
IPv6 query.
Definition dns_resolve.h:44
size_t socklen_t
Length of a socket address.
Definition net_ip.h:172
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
#define STRINGIFY(s)
Definition common.h:165
Public kernel APIs.
Network core definitions.
Public API for network interface.
IPv6 and IPv4 definitions.
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Address info struct is passed to callback that gets all the results.
Definition dns_resolve.h:254
char ai_canonname[20+1]
Canonical name of the address.
Definition dns_resolve.h:262
struct sockaddr ai_addr
IP address information.
Definition dns_resolve.h:256
socklen_t ai_addrlen
Length of the ai_addr field.
Definition dns_resolve.h:258
uint8_t ai_family
Address family of the address information.
Definition dns_resolve.h:260
Result callbacks.
Definition dns_resolve.h:387
const char * query
String containing the thing to resolve like www.example.com.
Definition dns_resolve.h:417
uint16_t query_hash
Hash of the DNS name + query type we are querying.
Definition dns_resolve.h:431
struct dns_resolve_context * ctx
Back pointer to ctx, needed in timeout handler.
Definition dns_resolve.h:392
void * user_data
User data.
Definition dns_resolve.h:401
struct k_work_delayable timer
Timeout timer.
Definition dns_resolve.h:389
uint16_t id
DNS id of this query.
Definition dns_resolve.h:423
k_timeout_t timeout
TX timeout.
Definition dns_resolve.h:404
dns_resolve_cb_t cb
Result callback.
Definition dns_resolve.h:398
enum dns_query_type query_type
Query type.
Definition dns_resolve.h:420
List of configured DNS servers.
Definition dns_resolve.h:344
int if_index
Network interface index if the DNS resolving should be done via this interface.
Definition dns_resolve.h:354
int sock
Connection to the DNS server.
Definition dns_resolve.h:349
uint8_t is_mdns
Is this server mDNS one.
Definition dns_resolve.h:357
uint8_t is_llmnr
Is this server LLMNR one.
Definition dns_resolve.h:360
DNS resolve context structure.
Definition dns_resolve.h:342
k_timeout_t buf_timeout
This timeout is also used when a buffer is required from the buffer pools.
Definition dns_resolve.h:379
struct dns_resolve_context::dns_pending_query queries[DNS_NUM_CONCUR_QUERIES]
struct dns_resolve_context::dns_server servers[DNS_RESOLVER_MAX_POLL]
enum dns_resolve_context_state state
Is this context in use.
Definition dns_resolve.h:435
struct k_mutex lock
Prevent concurrent access.
Definition dns_resolve.h:374
Mutex Structure.
Definition kernel.h:3070
Kernel timeout type.
Definition sys_clock.h:65
A structure used to submit work after a delay.
Definition kernel.h:4101
Network buffer representation.
Definition net_buf.h:1006
Network Interface structure.
Definition net_if.h:726
Main structure holding socket service configuration information.
Definition socket_service.h:70
Generic sockaddr struct.
Definition net_ip.h:408
Definition of the monitored socket/file descriptor.
Definition socket_poll.h:31