aboutsummaryrefslogtreecommitdiff
path: root/embassy-net
diff options
context:
space:
mode:
authorUlf Lilleengen <[email protected]>2023-01-31 22:06:41 +0100
committerUlf Lilleengen <[email protected]>2023-02-10 17:45:03 +0100
commit9cfea693edec5af17ba698f64b3f0a168ad92944 (patch)
treec5c4508bba1583fcea082143e331dca2f498e32d /embassy-net
parent023b0d5b2270f31aa69e54aa3d43416e16c33966 (diff)
Add DNS socket to embassy-net
Diffstat (limited to 'embassy-net')
-rw-r--r--embassy-net/Cargo.toml4
-rw-r--r--embassy-net/src/dns.rs114
-rw-r--r--embassy-net/src/lib.rs2
3 files changed, 118 insertions, 2 deletions
diff --git a/embassy-net/Cargo.toml b/embassy-net/Cargo.toml
index 4ec340b7a..6b3468283 100644
--- a/embassy-net/Cargo.toml
+++ b/embassy-net/Cargo.toml
@@ -13,7 +13,7 @@ target = "thumbv7em-none-eabi"
13 13
14[features] 14[features]
15default = [] 15default = []
16std = [] 16std = ["smoltcp/alloc", "managed/std"]
17 17
18defmt = ["dep:defmt", "smoltcp/defmt", "embassy-net-driver/defmt"] 18defmt = ["dep:defmt", "smoltcp/defmt", "embassy-net-driver/defmt"]
19 19
@@ -22,7 +22,7 @@ unstable-traits = []
22 22
23udp = ["smoltcp/socket-udp"] 23udp = ["smoltcp/socket-udp"]
24tcp = ["smoltcp/socket-tcp"] 24tcp = ["smoltcp/socket-tcp"]
25dns = ["smoltcp/socket-dns"] 25dns = ["smoltcp/socket-dns", "smoltcp/proto-dns"]
26dhcpv4 = ["medium-ethernet", "smoltcp/socket-dhcpv4"] 26dhcpv4 = ["medium-ethernet", "smoltcp/socket-dhcpv4"]
27proto-ipv6 = ["smoltcp/proto-ipv6"] 27proto-ipv6 = ["smoltcp/proto-ipv6"]
28medium-ethernet = ["smoltcp/medium-ethernet"] 28medium-ethernet = ["smoltcp/medium-ethernet"]
diff --git a/embassy-net/src/dns.rs b/embassy-net/src/dns.rs
new file mode 100644
index 000000000..f18750cc3
--- /dev/null
+++ b/embassy-net/src/dns.rs
@@ -0,0 +1,114 @@
1//! DNS socket with async support.
2use core::cell::RefCell;
3use core::future::poll_fn;
4use core::mem;
5use core::task::Poll;
6
7use embassy_net_driver::Driver;
8use heapless::Vec;
9use managed::ManagedSlice;
10use smoltcp::iface::{Interface, SocketHandle};
11pub use smoltcp::socket::dns::DnsQuery;
12use smoltcp::socket::dns::{self, GetQueryResultError, StartQueryError, MAX_ADDRESS_COUNT};
13pub use smoltcp::wire::{DnsQueryType, IpAddress};
14
15use crate::{SocketStack, Stack};
16
17/// Errors returned by DnsSocket.
18#[derive(Debug, PartialEq, Eq, Clone, Copy)]
19#[cfg_attr(feature = "defmt", derive(defmt::Format))]
20pub enum Error {
21 /// No available query slot
22 NoFreeSlot,
23 /// Invalid name
24 InvalidName,
25 /// Name too long
26 NameTooLong,
27 /// Name lookup failed
28 Failed,
29}
30
31impl From<GetQueryResultError> for Error {
32 fn from(_: GetQueryResultError) -> Self {
33 Self::Failed
34 }
35}
36
37impl From<StartQueryError> for Error {
38 fn from(e: StartQueryError) -> Self {
39 match e {
40 StartQueryError::NoFreeSlot => Self::NoFreeSlot,
41 StartQueryError::InvalidName => Self::InvalidName,
42 StartQueryError::NameTooLong => Self::NameTooLong,
43 }
44 }
45}
46
47/// Async socket for making DNS queries.
48pub struct DnsSocket<'a> {
49 stack: &'a RefCell<SocketStack>,
50 handle: SocketHandle,
51}
52
53impl<'a> DnsSocket<'a> {
54 /// Create a new DNS socket using the provided stack and query storage.
55 ///
56 /// DNS servers are derived from the stack configuration.
57 ///
58 /// NOTE: If using DHCP, make sure it has reconfigured the stack to ensure the DNS servers are updated.
59 pub fn new<D, Q>(stack: &'a Stack<D>, queries: Q) -> Self
60 where
61 D: Driver + 'static,
62 Q: Into<ManagedSlice<'a, Option<DnsQuery>>>,
63 {
64 let servers = stack
65 .config()
66 .map(|c| {
67 let v: Vec<IpAddress, 3> = c.dns_servers.iter().map(|c| IpAddress::Ipv4(*c)).collect();
68 v
69 })
70 .unwrap_or(Vec::new());
71 let s = &mut *stack.socket.borrow_mut();
72 let queries: ManagedSlice<'static, Option<DnsQuery>> = unsafe { mem::transmute(queries.into()) };
73
74 let handle = s.sockets.add(dns::Socket::new(&servers[..], queries));
75 Self {
76 stack: &stack.socket,
77 handle,
78 }
79 }
80
81 fn with_mut<R>(&mut self, f: impl FnOnce(&mut dns::Socket, &mut Interface) -> R) -> R {
82 let s = &mut *self.stack.borrow_mut();
83 let socket = s.sockets.get_mut::<dns::Socket>(self.handle);
84 let res = f(socket, &mut s.iface);
85 s.waker.wake();
86 res
87 }
88
89 /// Make a query for a given name and return the corresponding IP addresses.
90 pub async fn query(&mut self, name: &str, qtype: DnsQueryType) -> Result<Vec<IpAddress, MAX_ADDRESS_COUNT>, Error> {
91 let query = match { self.with_mut(|s, i| s.start_query(i.context(), name, qtype)) } {
92 Ok(handle) => handle,
93 Err(e) => return Err(e.into()),
94 };
95
96 poll_fn(|cx| {
97 self.with_mut(|s, _| match s.get_query_result(query) {
98 Ok(addrs) => Poll::Ready(Ok(addrs)),
99 Err(GetQueryResultError::Pending) => {
100 s.register_query_waker(query, cx.waker());
101 Poll::Pending
102 }
103 Err(e) => Poll::Ready(Err(e.into())),
104 })
105 })
106 .await
107 }
108}
109
110impl<'a> Drop for DnsSocket<'a> {
111 fn drop(&mut self) {
112 self.stack.borrow_mut().sockets.remove(self.handle);
113 }
114}
diff --git a/embassy-net/src/lib.rs b/embassy-net/src/lib.rs
index 0f694ee70..ae447d063 100644
--- a/embassy-net/src/lib.rs
+++ b/embassy-net/src/lib.rs
@@ -11,6 +11,8 @@ pub(crate) mod fmt;
11pub use embassy_net_driver as driver; 11pub use embassy_net_driver as driver;
12 12
13mod device; 13mod device;
14#[cfg(feature = "dns")]
15pub mod dns;
14#[cfg(feature = "tcp")] 16#[cfg(feature = "tcp")]
15pub mod tcp; 17pub mod tcp;
16#[cfg(feature = "udp")] 18#[cfg(feature = "udp")]