Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support for the ESP-IDF framework #452

Merged
merged 4 commits into from
Jul 15, 2023
Merged

Support for the ESP-IDF framework #452

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
71fbf6b
Support for the ESP-IDF framework
jasta Jul 14, 2023
d55d2f4
Fix merge error causing multiple definitions of IP_HDRINCL
jasta Jul 14, 2023
10a88c0
cargo fmt and fix a minor merge error added superfluous docs
jasta Jul 14, 2023
a607e6b
espidf: Remove dummy support for is_truncated and is_end_of_record
jasta Jul 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,13 +270,16 @@ impl Type {
pub const DCCP: Type = Type(sys::SOCK_DCCP);

/// Type corresponding to `SOCK_SEQPACKET`.
#[cfg(feature = "all")]
#[cfg_attr(docsrs, doc(cfg(feature = "all")))]
#[cfg(all(feature = "all", not(target_os = "espidf")))]
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", not(target_os = "espidf")))))]
pub const SEQPACKET: Type = Type(sys::SOCK_SEQPACKET);

/// Type corresponding to `SOCK_RAW`.
#[cfg(all(feature = "all", not(target_os = "redox")))]
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", not(target_os = "redox")))))]
#[cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf"))))]
#[cfg_attr(
docsrs,
doc(cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf")))))
)]
pub const RAW: Type = Type(sys::SOCK_RAW);
}

Expand Down Expand Up @@ -428,6 +431,7 @@ pub struct TcpKeepalive {
target_os = "redox",
target_os = "solaris",
target_os = "nto",
target_os = "espidf",
)))]
interval: Option<Duration>,
#[cfg(not(any(
Expand All @@ -436,6 +440,7 @@ pub struct TcpKeepalive {
target_os = "solaris",
target_os = "windows",
target_os = "nto",
target_os = "espidf",
)))]
retries: Option<u32>,
}
Expand All @@ -450,6 +455,7 @@ impl TcpKeepalive {
target_os = "redox",
target_os = "solaris",
target_os = "nto",
target_os = "espidf",
)))]
interval: None,
#[cfg(not(any(
Expand All @@ -458,6 +464,7 @@ impl TcpKeepalive {
target_os = "solaris",
target_os = "windows",
target_os = "nto",
target_os = "espidf",
)))]
retries: None,
}
Expand Down
23 changes: 19 additions & 4 deletions src/socket.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,6 +790,7 @@ fn set_common_flags(socket: Socket) -> io::Result<Socket> {
target_os = "linux",
target_os = "netbsd",
target_os = "openbsd",
target_os = "espidf",
))
))]
socket._set_cloexec(true)?;
Expand Down Expand Up @@ -1108,8 +1109,11 @@ impl Socket {
/// For more information about this option, see [`set_header_included`].
///
/// [`set_header_included`]: Socket::set_header_included
#[cfg(all(feature = "all", not(target_os = "redox")))]
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", not(target_os = "redox")))))]
#[cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf"))))]
#[cfg_attr(
docsrs,
doc(cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf")))))
)]
pub fn header_included(&self) -> io::Result<bool> {
unsafe {
getsockopt::<c_int>(self.as_raw(), sys::IPPROTO_IP, sys::IP_HDRINCL)
Expand All @@ -1132,8 +1136,11 @@ impl Socket {
any(target_os = "fuchsia", target_os = "illumos", target_os = "solaris"),
allow(rustdoc::broken_intra_doc_links)
)]
#[cfg(all(feature = "all", not(target_os = "redox")))]
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", not(target_os = "redox")))))]
#[cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf"))))]
#[cfg_attr(
docsrs,
doc(cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf")))))
)]
pub fn set_header_included(&self, included: bool) -> io::Result<()> {
unsafe {
setsockopt(
Expand Down Expand Up @@ -1237,6 +1244,7 @@ impl Socket {
target_os = "redox",
target_os = "solaris",
target_os = "nto",
target_os = "espidf",
)))]
pub fn join_multicast_v4_n(
&self,
Expand Down Expand Up @@ -1268,6 +1276,7 @@ impl Socket {
target_os = "redox",
target_os = "solaris",
target_os = "nto",
target_os = "espidf",
)))]
pub fn leave_multicast_v4_n(
&self,
Expand Down Expand Up @@ -1300,6 +1309,7 @@ impl Socket {
target_os = "redox",
target_os = "fuchsia",
target_os = "nto",
target_os = "espidf",
)))]
pub fn join_ssm_v4(
&self,
Expand Down Expand Up @@ -1335,6 +1345,7 @@ impl Socket {
target_os = "redox",
target_os = "fuchsia",
target_os = "nto",
target_os = "espidf",
)))]
pub fn leave_ssm_v4(
&self,
Expand Down Expand Up @@ -1512,6 +1523,7 @@ impl Socket {
target_os = "solaris",
target_os = "haiku",
target_os = "nto",
target_os = "espidf",
)))]
pub fn set_recv_tos(&self, recv_tos: bool) -> io::Result<()> {
unsafe {
Expand Down Expand Up @@ -1540,6 +1552,7 @@ impl Socket {
target_os = "solaris",
target_os = "haiku",
target_os = "nto",
target_os = "espidf",
)))]
pub fn recv_tos(&self) -> io::Result<bool> {
unsafe {
Expand Down Expand Up @@ -1755,6 +1768,7 @@ impl Socket {
target_os = "redox",
target_os = "solaris",
target_os = "haiku",
target_os = "espidf",
)))]
pub fn recv_tclass_v6(&self) -> io::Result<bool> {
unsafe {
Expand All @@ -1777,6 +1791,7 @@ impl Socket {
target_os = "redox",
target_os = "solaris",
target_os = "haiku",
target_os = "espidf",
)))]
pub fn set_recv_tclass_v6(&self, recv_tclass: bool) -> io::Result<()> {
unsafe {
Expand Down
30 changes: 24 additions & 6 deletions src/sys/unix.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ pub(crate) use libc::{AF_INET, AF_INET6, AF_UNIX};
// Used in `Type`.
#[cfg(all(feature = "all", target_os = "linux"))]
pub(crate) use libc::SOCK_DCCP;
#[cfg(all(feature = "all", not(target_os = "redox")))]
#[cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf"))))]
pub(crate) use libc::SOCK_RAW;
#[cfg(feature = "all")]
#[cfg(all(feature = "all", not(target_os = "espidf")))]
pub(crate) use libc::SOCK_SEQPACKET;
pub(crate) use libc::{SOCK_DGRAM, SOCK_STREAM};
// Used in `Protocol`.
Expand Down Expand Up @@ -111,8 +111,13 @@ pub(crate) use libc::{
sa_family_t, sockaddr, sockaddr_in, sockaddr_in6, sockaddr_storage, socklen_t,
};
// Used in `RecvFlags`.
#[cfg(not(any(target_os = "redox", target_os = "espidf")))]
pub(crate) use libc::MSG_TRUNC;
#[cfg(not(target_os = "redox"))]
pub(crate) use libc::{MSG_TRUNC, SO_OOBINLINE};
pub(crate) use libc::SO_OOBINLINE;
// TODO: Expose in libc for ESP-IDF/LwIP
#[cfg(target_os = "espidf")]
pub(crate) const MSG_TRUNC: libc::c_int = 4;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to maintain these constants so please add them to libc instead.

// Used in `Socket`.
#[cfg(not(target_os = "nto"))]
pub(crate) use libc::ipv6_mreq as Ipv6Mreq;
Expand All @@ -125,6 +130,7 @@ pub(crate) use libc::ipv6_mreq as Ipv6Mreq;
target_os = "redox",
target_os = "solaris",
target_os = "haiku",
target_os = "espidf",
)))]
pub(crate) use libc::IPV6_RECVTCLASS;
#[cfg(all(feature = "all", not(target_os = "redox")))]
Expand All @@ -140,6 +146,7 @@ pub(crate) use libc::IP_HDRINCL;
target_os = "solaris",
target_os = "haiku",
target_os = "nto",
target_os = "espidf",
)))]
pub(crate) use libc::IP_RECVTOS;
#[cfg(not(any(
Expand Down Expand Up @@ -178,6 +185,7 @@ pub(crate) use libc::{
target_os = "redox",
target_os = "fuchsia",
target_os = "nto",
target_os = "espidf",
)))]
pub(crate) use libc::{
ip_mreq_source as IpMreqSource, IP_ADD_SOURCE_MEMBERSHIP, IP_DROP_SOURCE_MEMBERSHIP,
Expand Down Expand Up @@ -329,6 +337,7 @@ type IovLen = usize;
target_os = "solaris",
target_os = "tvos",
target_os = "watchos",
target_os = "espidf",
))]
type IovLen = c_int;

Expand Down Expand Up @@ -471,10 +480,11 @@ impl_debug!(
libc::SOCK_DGRAM,
#[cfg(all(feature = "all", target_os = "linux"))]
libc::SOCK_DCCP,
#[cfg(not(target_os = "redox"))]
#[cfg(not(any(target_os = "redox", target_os = "espidf")))]
libc::SOCK_RAW,
#[cfg(not(any(target_os = "redox", target_os = "haiku")))]
#[cfg(not(any(target_os = "redox", target_os = "haiku", target_os = "espidf")))]
libc::SOCK_RDM,
#[cfg(not(target_os = "espidf"))]
libc::SOCK_SEQPACKET,
/* TODO: add these optional bit OR-ed flags:
#[cfg(any(
Expand Down Expand Up @@ -539,7 +549,14 @@ impl RecvFlags {
///
/// [`SEQPACKET`]: Type::SEQPACKET
pub const fn is_end_of_record(self) -> bool {
self.0 & libc::MSG_EOR != 0
// TODO: Expose this constant in libc for the ESP-IDF/LwIP framework
#[cfg(target_os = "espidf")]
const MSG_EOR: libc::c_int = 8;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to maintain these constants so please add them to libc instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we might have alternatives here, let me do a little digging and get back to you with options.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops yeah we can follow redox's example here and just conditionally remove the feature. I'll work on that soon and update. Thanks for the review!


#[cfg(not(target_os = "espidf"))]
use libc::MSG_EOR;

self.0 & MSG_EOR != 0
}

/// Check if the message contains out-of-band data.
Expand Down Expand Up @@ -1264,6 +1281,7 @@ pub(crate) fn from_in6_addr(addr: in6_addr) -> Ipv6Addr {
target_os = "redox",
target_os = "solaris",
target_os = "nto",
target_os = "espidf",
)))]
pub(crate) const fn to_mreqn(
multiaddr: &Ipv4Addr,
Expand Down