diff options
| -rw-r--r-- | embassy-net/Cargo.toml | 4 | ||||
| -rw-r--r-- | embassy-net/src/dns.rs | 114 | ||||
| -rw-r--r-- | embassy-net/src/lib.rs | 2 | ||||
| -rw-r--r-- | examples/std/Cargo.toml | 2 | ||||
| -rw-r--r-- | examples/std/src/bin/net_dns.rs | 102 |
5 files changed, 221 insertions, 3 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] |
| 15 | default = [] | 15 | default = [] |
| 16 | std = [] | 16 | std = ["smoltcp/alloc", "managed/std"] |
| 17 | 17 | ||
| 18 | defmt = ["dep:defmt", "smoltcp/defmt", "embassy-net-driver/defmt"] | 18 | defmt = ["dep:defmt", "smoltcp/defmt", "embassy-net-driver/defmt"] |
| 19 | 19 | ||
| @@ -22,7 +22,7 @@ unstable-traits = [] | |||
| 22 | 22 | ||
| 23 | udp = ["smoltcp/socket-udp"] | 23 | udp = ["smoltcp/socket-udp"] |
| 24 | tcp = ["smoltcp/socket-tcp"] | 24 | tcp = ["smoltcp/socket-tcp"] |
| 25 | dns = ["smoltcp/socket-dns"] | 25 | dns = ["smoltcp/socket-dns", "smoltcp/proto-dns"] |
| 26 | dhcpv4 = ["medium-ethernet", "smoltcp/socket-dhcpv4"] | 26 | dhcpv4 = ["medium-ethernet", "smoltcp/socket-dhcpv4"] |
| 27 | proto-ipv6 = ["smoltcp/proto-ipv6"] | 27 | proto-ipv6 = ["smoltcp/proto-ipv6"] |
| 28 | medium-ethernet = ["smoltcp/medium-ethernet"] | 28 | medium-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. | ||
| 2 | use core::cell::RefCell; | ||
| 3 | use core::future::poll_fn; | ||
| 4 | use core::mem; | ||
| 5 | use core::task::Poll; | ||
| 6 | |||
| 7 | use embassy_net_driver::Driver; | ||
| 8 | use heapless::Vec; | ||
| 9 | use managed::ManagedSlice; | ||
| 10 | use smoltcp::iface::{Interface, SocketHandle}; | ||
| 11 | pub use smoltcp::socket::dns::DnsQuery; | ||
| 12 | use smoltcp::socket::dns::{self, GetQueryResultError, StartQueryError, MAX_ADDRESS_COUNT}; | ||
| 13 | pub use smoltcp::wire::{DnsQueryType, IpAddress}; | ||
| 14 | |||
| 15 | use crate::{SocketStack, Stack}; | ||
| 16 | |||
| 17 | /// Errors returned by DnsSocket. | ||
| 18 | #[derive(Debug, PartialEq, Eq, Clone, Copy)] | ||
| 19 | #[cfg_attr(feature = "defmt", derive(defmt::Format))] | ||
| 20 | pub 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 | |||
| 31 | impl From<GetQueryResultError> for Error { | ||
| 32 | fn from(_: GetQueryResultError) -> Self { | ||
| 33 | Self::Failed | ||
| 34 | } | ||
| 35 | } | ||
| 36 | |||
| 37 | impl 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. | ||
| 48 | pub struct DnsSocket<'a> { | ||
| 49 | stack: &'a RefCell<SocketStack>, | ||
| 50 | handle: SocketHandle, | ||
| 51 | } | ||
| 52 | |||
| 53 | impl<'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 | |||
| 110 | impl<'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; | |||
| 11 | pub use embassy_net_driver as driver; | 11 | pub use embassy_net_driver as driver; |
| 12 | 12 | ||
| 13 | mod device; | 13 | mod device; |
| 14 | #[cfg(feature = "dns")] | ||
| 15 | pub mod dns; | ||
| 14 | #[cfg(feature = "tcp")] | 16 | #[cfg(feature = "tcp")] |
| 15 | pub mod tcp; | 17 | pub mod tcp; |
| 16 | #[cfg(feature = "udp")] | 18 | #[cfg(feature = "udp")] |
diff --git a/examples/std/Cargo.toml b/examples/std/Cargo.toml index af1481e08..8087df09a 100644 --- a/examples/std/Cargo.toml +++ b/examples/std/Cargo.toml | |||
| @@ -8,7 +8,7 @@ license = "MIT OR Apache-2.0" | |||
| 8 | embassy-sync = { version = "0.1.0", path = "../../embassy-sync", features = ["log"] } | 8 | embassy-sync = { version = "0.1.0", path = "../../embassy-sync", features = ["log"] } |
| 9 | embassy-executor = { version = "0.1.0", path = "../../embassy-executor", features = ["log", "std", "nightly", "integrated-timers"] } | 9 | embassy-executor = { version = "0.1.0", path = "../../embassy-executor", features = ["log", "std", "nightly", "integrated-timers"] } |
| 10 | embassy-time = { version = "0.1.0", path = "../../embassy-time", features = ["log", "std", "nightly"] } | 10 | embassy-time = { version = "0.1.0", path = "../../embassy-time", features = ["log", "std", "nightly"] } |
| 11 | embassy-net = { version = "0.1.0", path = "../../embassy-net", features=[ "std", "nightly", "log", "medium-ethernet", "tcp", "udp", "dhcpv4"] } | 11 | embassy-net = { version = "0.1.0", path = "../../embassy-net", features=[ "std", "nightly", "log", "medium-ethernet", "tcp", "udp", "dns", "dhcpv4", "unstable-traits", "proto-ipv6"] } |
| 12 | embassy-net-driver = { version = "0.1.0", path = "../../embassy-net-driver" } | 12 | embassy-net-driver = { version = "0.1.0", path = "../../embassy-net-driver" } |
| 13 | embedded-io = { version = "0.4.0", features = ["async", "std", "futures"] } | 13 | embedded-io = { version = "0.4.0", features = ["async", "std", "futures"] } |
| 14 | critical-section = { version = "1.1", features = ["std"] } | 14 | critical-section = { version = "1.1", features = ["std"] } |
diff --git a/examples/std/src/bin/net_dns.rs b/examples/std/src/bin/net_dns.rs new file mode 100644 index 000000000..6203f8370 --- /dev/null +++ b/examples/std/src/bin/net_dns.rs | |||
| @@ -0,0 +1,102 @@ | |||
| 1 | #![feature(type_alias_impl_trait)] | ||
| 2 | |||
| 3 | use std::default::Default; | ||
| 4 | |||
| 5 | use clap::Parser; | ||
| 6 | use embassy_executor::{Executor, Spawner}; | ||
| 7 | use embassy_net::dns::{DnsQueryType, DnsSocket}; | ||
| 8 | use embassy_net::{Config, Ipv4Address, Ipv4Cidr, Stack, StackResources}; | ||
| 9 | use heapless::Vec; | ||
| 10 | use log::*; | ||
| 11 | use rand_core::{OsRng, RngCore}; | ||
| 12 | use static_cell::StaticCell; | ||
| 13 | |||
| 14 | #[path = "../tuntap.rs"] | ||
| 15 | mod tuntap; | ||
| 16 | |||
| 17 | use crate::tuntap::TunTapDevice; | ||
| 18 | |||
| 19 | macro_rules! singleton { | ||
| 20 | ($val:expr) => {{ | ||
| 21 | type T = impl Sized; | ||
| 22 | static STATIC_CELL: StaticCell<T> = StaticCell::new(); | ||
| 23 | STATIC_CELL.init_with(move || $val) | ||
| 24 | }}; | ||
| 25 | } | ||
| 26 | |||
| 27 | #[derive(Parser)] | ||
| 28 | #[clap(version = "1.0")] | ||
| 29 | struct Opts { | ||
| 30 | /// TAP device name | ||
| 31 | #[clap(long, default_value = "tap0")] | ||
| 32 | tap: String, | ||
| 33 | /// use a static IP instead of DHCP | ||
| 34 | #[clap(long)] | ||
| 35 | static_ip: bool, | ||
| 36 | } | ||
| 37 | |||
| 38 | #[embassy_executor::task] | ||
| 39 | async fn net_task(stack: &'static Stack<TunTapDevice>) -> ! { | ||
| 40 | stack.run().await | ||
| 41 | } | ||
| 42 | |||
| 43 | #[embassy_executor::task] | ||
| 44 | async fn main_task(spawner: Spawner) { | ||
| 45 | let opts: Opts = Opts::parse(); | ||
| 46 | |||
| 47 | // Init network device | ||
| 48 | let device = TunTapDevice::new(&opts.tap).unwrap(); | ||
| 49 | |||
| 50 | // Choose between dhcp or static ip | ||
| 51 | let config = if opts.static_ip { | ||
| 52 | Config::Static(embassy_net::StaticConfig { | ||
| 53 | address: Ipv4Cidr::new(Ipv4Address::new(192, 168, 69, 1), 24), | ||
| 54 | dns_servers: Vec::from_slice(&[Ipv4Address::new(8, 8, 4, 4).into(), Ipv4Address::new(8, 8, 8, 8).into()]) | ||
| 55 | .unwrap(), | ||
| 56 | gateway: Some(Ipv4Address::new(192, 168, 69, 100)), | ||
| 57 | }) | ||
| 58 | } else { | ||
| 59 | Config::Dhcp(Default::default()) | ||
| 60 | }; | ||
| 61 | |||
| 62 | // Generate random seed | ||
| 63 | let mut seed = [0; 8]; | ||
| 64 | OsRng.fill_bytes(&mut seed); | ||
| 65 | let seed = u64::from_le_bytes(seed); | ||
| 66 | |||
| 67 | // Init network stack | ||
| 68 | let stack = &*singleton!(Stack::new(device, config, singleton!(StackResources::<2>::new()), seed)); | ||
| 69 | |||
| 70 | // Launch network task | ||
| 71 | spawner.spawn(net_task(stack)).unwrap(); | ||
| 72 | |||
| 73 | // Then we can use it! | ||
| 74 | |||
| 75 | let mut socket = DnsSocket::new(stack, vec![]); | ||
| 76 | |||
| 77 | let host = "example.com"; | ||
| 78 | info!("querying host {:?}...", host); | ||
| 79 | match socket.query(host, DnsQueryType::A).await { | ||
| 80 | Ok(r) => { | ||
| 81 | info!("query response: {:?}", r); | ||
| 82 | } | ||
| 83 | Err(e) => { | ||
| 84 | warn!("query error: {:?}", e); | ||
| 85 | } | ||
| 86 | }; | ||
| 87 | } | ||
| 88 | |||
| 89 | static EXECUTOR: StaticCell<Executor> = StaticCell::new(); | ||
| 90 | |||
| 91 | fn main() { | ||
| 92 | env_logger::builder() | ||
| 93 | .filter_level(log::LevelFilter::Debug) | ||
| 94 | .filter_module("async_io", log::LevelFilter::Info) | ||
| 95 | .format_timestamp_nanos() | ||
| 96 | .init(); | ||
| 97 | |||
| 98 | let executor = EXECUTOR.init(Executor::new()); | ||
| 99 | executor.run(|spawner| { | ||
| 100 | spawner.spawn(main_task(spawner)).unwrap(); | ||
| 101 | }); | ||
| 102 | } | ||
