commit c638f4537387a7edfd7618e7840289aa0e8470df Author: whitequark Date: Sat Dec 10 09:23:40 2016 +0000 Implement Ethernet II frame support. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a9d37c5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +target +Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..7bd7ab7 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,7 @@ +[package] +name = "smoltcp" +version = "0.1.0" +authors = ["whitequark "] + +[dependencies] +byteorder = { version = "0.5", default-features = false } diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..ecd4fb0 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2016 whitequark + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2c8512f --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +smoltcp +======= + +_smoltcp_ is a standalone, event-driven TCP/IP stack that is designed for bare-metal, +real-time systems. Its design goals are simplicity and robustness. Its design anti-goals +include complicated compile-time computations, such as macro or type tricks, even +at cost of performance degradation. + +Features +-------- + +_smoltcp_ is missing many widely deployed features, whether by design or simply because +no one implemented them yet. To set expectations right, both implemented and omitted +features are listed. + +### Media layer + +The only supported medium is Ethernet. + + * Regular 802.3 frames are supported. + * 802.1Q is not supported. + * Jumbo frames are not supported. + * CRC calculation is not supported. + * ARP packets are not supported. + * ARP probes or announcements are not supported. + +### IP layer + +IP is not supported yet. + +### UDP layer + +UDP is not supported yet. + +### TCP layer + +TCP is not supported yet. + +Installation +------------ + +To use the _smoltcp_ library in your project, add the following to `Cargo.toml`: + +```toml +[dependencies] +smoltcp = "0.1" +``` + +Usage example +------------- + +```rust +TBD +``` + +License +------- + +_smoltcp_ is distributed under the terms of both the MIT license +and the Apache License (Version 2.0). + +See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) +for details. diff --git a/src/ethernet.rs b/src/ethernet.rs new file mode 100644 index 0000000..4651649 --- /dev/null +++ b/src/ethernet.rs @@ -0,0 +1,175 @@ +use core::fmt; +use byteorder::{ByteOrder, NetworkEndian}; + +enum_with_unknown! { + /// Ethernet protocol type. + pub enum ProtocolType(u16) { + Ipv4 = 0x0800, + Arp = 0x0806, + Iv6 = 0x86DD + } +} + +/// A six-octet Ethernet II address. +#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)] +pub struct Address(pub [u8; 6]); + +impl Address { + /// Construct an Ethernet address from a sequence of octets, in big-endian. + /// + /// # Panics + /// The function panics if `data` is not six octets long. + pub fn from_bytes(data: &[u8]) -> Address { + let mut bytes = [0; 6]; + bytes.copy_from_slice(data); + Address(bytes) + } + + /// Return an Ethernet address as a sequence of octets, in big-endian. + pub fn as_bytes(&self) -> &[u8] { + &self.0 + } +} + +impl fmt::Display for Address { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + let bytes = self.0; + write!(f, "{:02x}:{:02x}:{:02x}:{:02x}:{:02x}:{:02x}", + bytes[0], bytes[1], bytes[2], bytes[3], bytes[4], bytes[5]) + } +} + +/// A read/write wrapper around an Ethernet II frame. +#[derive(Debug)] +pub struct Frame>(T); + +mod field { + use ::field::*; + + pub const SOURCE: Field = 0..6; + pub const DESTINATION: Field = 6..12; + pub const LENGTH: Field = 12..14; + pub const PAYLOAD: FieldFrom = 14..; +} + +impl> Frame { + /// Wrap a buffer with an Ethernet frame. Returns an error if the buffer + /// is too small or too large to contain one. + pub fn new(storage: T) -> Result, ()> { + let len = storage.as_ref().len(); + if !(64..1518).contains(len) { + Err(()) // TODO: error type? + } else { + Ok(Frame(storage)) + } + } + + /// Consumes the frame, returning the underlying buffer. + pub fn into_inner(self) -> T { + self.0 + } + + /// Return the source address field. + #[inline(always)] + pub fn source(&self) -> Address { + let bytes = self.0.as_ref(); + Address::from_bytes(&bytes[field::SOURCE]) + } + + /// Return the destination address field. + #[inline(always)] + pub fn destination(&self) -> Address { + let bytes = self.0.as_ref(); + Address::from_bytes(&bytes[field::DESTINATION]) + } + + /// Return the length field, without checking for 802.1Q. + #[inline(always)] + pub fn length(&self) -> u16 { + let bytes = self.0.as_ref(); + NetworkEndian::read_u16(&bytes[field::LENGTH]) + } + + /// Return a pointer to the payload, without checking for 802.1Q. + #[inline(always)] + pub fn payload(&self) -> &[u8] { + let bytes = self.0.as_ref(); + &bytes[field::PAYLOAD] + } +} + +impl + AsMut<[u8]>> Frame { + /// Set the source address field. + #[inline(always)] + pub fn set_source(&mut self, value: Address) { + let bytes = self.0.as_mut(); + bytes[field::SOURCE].copy_from_slice(value.as_bytes()) + } + + /// Set the destination address field. + #[inline(always)] + pub fn set_destination(&mut self, value: Address) { + let bytes = self.0.as_mut(); + bytes[field::DESTINATION].copy_from_slice(value.as_bytes()) + } + + /// Set the length field. + #[inline(always)] + pub fn set_length(&mut self, value: u16) { + let bytes = self.0.as_mut(); + NetworkEndian::write_u16(&mut bytes[field::LENGTH], value) + } + + /// Return a mutable pointer to the payload. + #[inline(always)] + pub fn payload_mut(&mut self) -> &mut [u8] { + let bytes = self.0.as_mut(); + &mut bytes[field::PAYLOAD] + } +} + +#[cfg(test)] +mod test { + use super::*; + + static FRAME_BYTES: [u8; 64] = + [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, + 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, + 0x00, 0x40, + 0xaa, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0xff]; + + static PAYLOAD_BYTES: [u8; 50] = + [0xaa, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0xff]; + + #[test] + fn test_deconstruct() { + let frame = Frame::new(&FRAME_BYTES[..]).unwrap(); + assert_eq!(frame.source(), Address([0x01, 0x02, 0x03, 0x04, 0x05, 0x06])); + assert_eq!(frame.destination(), Address([0x11, 0x12, 0x13, 0x14, 0x15, 0x16])); + assert_eq!(frame.length(), FRAME_BYTES.len() as u16); + assert_eq!(frame.payload(), &PAYLOAD_BYTES[..]); + } + + #[test] + fn test_construct() { + let mut bytes = vec![0; 64]; + let mut frame = Frame::new(&mut bytes).unwrap(); + frame.set_source(Address([0x01, 0x02, 0x03, 0x04, 0x05, 0x06])); + frame.set_destination(Address([0x11, 0x12, 0x13, 0x14, 0x15, 0x16])); + frame.set_length(64); + frame.payload_mut().copy_from_slice(&PAYLOAD_BYTES[..]); + assert_eq!(&frame.into_inner()[..], &FRAME_BYTES[..]); + } +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..897b82a --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,49 @@ +#![feature(range_contains)] +#![no_std] + +#[cfg(test)] +#[macro_use] +extern crate std; + +extern crate byteorder; + +macro_rules! enum_with_unknown { + (#[$( $attr:meta ),*] + pub enum $name:ident($ty:ty) { $( $variant:ident = $value:expr ),+ }) => { + #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)] + #[$( $attr ),*] + pub enum $name { + $( $variant ),*, + Unknown($ty) + } + + impl ::core::convert::From<$ty> for $name { + fn from(value: $ty) -> Self { + match value { + $( $value => $name::$variant ),*, + other => $name::Unknown(other) + } + } + } + + impl ::core::convert::From<$name> for $ty { + fn from(value: $name) -> Self { + match value { + $( $name::$variant => $value ),*, + $name::Unknown(other) => other + } + } + } + } +} + +mod field { + pub type Field = ::core::ops::Range; + pub type FieldFrom = ::core::ops::RangeFrom; +} + +mod ethernet; + +pub use ethernet::ProtocolType as EthernetProtocolType; +pub use ethernet::Address as EthernetAddress; +pub use ethernet::Frame as EthernetFrame;