diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/LICENSE @@ -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/README.md b/README.md index ef833b9b..570b9a7d 100644 --- a/README.md +++ b/README.md @@ -114,3 +114,8 @@ just cargo test --profile=release > `just` is computing the correct `RUSTFLAGS` for us depending on the profile. > After that it simply calls `cargo build`. > Normally we would include those kinds of setting in `Cargo.toml` but `cargo` can not currently express all the `RUSTFLAGS` we are using (thus the `just` wrapper). + +## License + +The Dataplane of the Hedgehog Open Fabric Network is licensed under the +[Apache License, Version 2.0](LICENSE). diff --git a/dpdk-sys/build.rs b/dpdk-sys/build.rs index 56a3ed82..1b4ac6b1 100644 --- a/dpdk-sys/build.rs +++ b/dpdk-sys/build.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + use std::env; use bindgen::callbacks::ParseCallbacks; diff --git a/dpdk-sys/src/lib.rs b/dpdk-sys/src/lib.rs index 89f554b9..28a119c3 100644 --- a/dpdk-sys/src/lib.rs +++ b/dpdk-sys/src/lib.rs @@ -1,5 +1,8 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! Raw DPDK bindings for Rust. - + // We don't need to throw down over differences in name style between C and Rust in the bindings. #![allow( clippy::all, @@ -11,5 +14,3 @@ )] include!(concat!(env!("OUT_DIR"), "/generated.rs")); - - diff --git a/dpdk-sysroot-helper/src/lib.rs b/dpdk-sysroot-helper/src/lib.rs index 236c0475..4313f59a 100644 --- a/dpdk-sysroot-helper/src/lib.rs +++ b/dpdk-sysroot-helper/src/lib.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + use std::env; use std::path::Path; diff --git a/dpdk/build.rs b/dpdk/build.rs index a4430d29..52f5b019 100644 --- a/dpdk/build.rs +++ b/dpdk/build.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + fn main() { let sysroot = dpdk_sysroot_helper::get_sysroot(); println!("cargo:rustc-link-search=all={sysroot}/lib"); diff --git a/dpdk/src/dev.rs b/dpdk/src/dev.rs index 901cf335..8463de54 100644 --- a/dpdk/src/dev.rs +++ b/dpdk/src/dev.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! Ethernet device management. use alloc::format; @@ -853,4 +856,4 @@ pub enum SocketIdLookupError { DevDoesNotExist(DevIndex), #[error("Unknown error code set")] UnknownErrno(errno::ErrorCode), -} \ No newline at end of file +} diff --git a/dpdk/src/eal.rs b/dpdk/src/eal.rs index 9dcaeadd..cc9898c5 100644 --- a/dpdk/src/eal.rs +++ b/dpdk/src/eal.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! DPDK Environment Abstraction Layer (EAL) use alloc::format; use alloc::string::{String, ToString}; diff --git a/dpdk/src/flow/mod.rs b/dpdk/src/flow/mod.rs index 4d3c6277..35295433 100644 --- a/dpdk/src/flow/mod.rs +++ b/dpdk/src/flow/mod.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! Flow rules for DPDK //! //! Basically everything that starts with `rte_flow_` in DPDK. diff --git a/dpdk/src/lib.rs b/dpdk/src/lib.rs index c2c7d8c7..b5556543 100644 --- a/dpdk/src/lib.rs +++ b/dpdk/src/lib.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! Safe DPDK bindings for Rust. //! //! This crate provides safe bindings to the DPDK library. diff --git a/dpdk/src/mem.rs b/dpdk/src/mem.rs index d065f1dd..ea76f930 100644 --- a/dpdk/src/mem.rs +++ b/dpdk/src/mem.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! DPDK memory management wrappers. use alloc::format; diff --git a/dpdk/src/queue/hairpin.rs b/dpdk/src/queue/hairpin.rs index 89b51cbd..96c62f09 100644 --- a/dpdk/src/queue/hairpin.rs +++ b/dpdk/src/queue/hairpin.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! Hairpin queue configuration and management. use super::{rx, tx}; use crate::dev::{Dev, DevInfo}; diff --git a/dpdk/src/queue/mod.rs b/dpdk/src/queue/mod.rs index 9eb685ba..10a4513d 100644 --- a/dpdk/src/queue/mod.rs +++ b/dpdk/src/queue/mod.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! DPDK queue abstractions. pub mod rx; pub mod tx; diff --git a/dpdk/src/queue/rx.rs b/dpdk/src/queue/rx.rs index 7e9e0a5a..cc2f3b91 100644 --- a/dpdk/src/queue/rx.rs +++ b/dpdk/src/queue/rx.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! Receive queue configuration and management. use crate::dev::DevIndex; diff --git a/dpdk/src/queue/tx.rs b/dpdk/src/queue/tx.rs index 3c600c24..f9fa5ec5 100644 --- a/dpdk/src/queue/tx.rs +++ b/dpdk/src/queue/tx.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! Transmit queue configuration and management. use crate::dev::DevIndex; diff --git a/dpdk/src/socket.rs b/dpdk/src/socket.rs index 927a6d98..ebe4de2e 100644 --- a/dpdk/src/socket.rs +++ b/dpdk/src/socket.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! DPDK socket functions. //! //! # Note diff --git a/errno/src/lib.rs b/errno/src/lib.rs index a10323fb..67295c80 100644 --- a/errno/src/lib.rs +++ b/errno/src/lib.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! Standard errno values, meanings, and lookups //! //! This code is tedious but quite safe. diff --git a/justfile b/justfile index 4938587d..2c9be0c9 100644 --- a/justfile +++ b/justfile @@ -1,3 +1,6 @@ +# SPDX-License-Identifier: Apache-2.0 +# Copyright Open Network Fabric Authors + set unstable := true run_id := uuid() diff --git a/net/benches/parse.rs b/net/benches/parse.rs index 13cf2bd3..8cab9d6a 100644 --- a/net/benches/parse.rs +++ b/net/benches/parse.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + use std::hint::black_box; use criterion::{criterion_group, criterion_main, Criterion}; diff --git a/net/src/lib.rs b/net/src/lib.rs index 8519a5c1..1722f62e 100644 --- a/net/src/lib.rs +++ b/net/src/lib.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + #![cfg_attr(not(test), no_std)] // This library should always compile without std (even if we never ship that way) #![forbid(unsafe_code)] // Validation logic should always be strictly safe #![deny(missing_docs, clippy::all, clippy::pedantic)] // yeah, I'm that guy. I'm not sorry. diff --git a/net/src/vlan.rs b/net/src/vlan.rs index a6fab445..0974282d 100644 --- a/net/src/vlan.rs +++ b/net/src/vlan.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! VLAN validation and manipulation. use core::num::NonZero; diff --git a/net/src/vxlan.rs b/net/src/vxlan.rs index b807bcee..a9478e96 100644 --- a/net/src/vxlan.rs +++ b/net/src/vxlan.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + //! VXLAN validation and manipulation. use core::num::NonZero; diff --git a/scratch/build.rs b/scratch/build.rs index c18a3acb..194b2c16 100644 --- a/scratch/build.rs +++ b/scratch/build.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + fn main() { let sysroot = dpdk_sysroot_helper::get_sysroot(); let project_root = dpdk_sysroot_helper::get_project_root(); diff --git a/scratch/src/main.rs b/scratch/src/main.rs index c94c4d16..fc477fd0 100644 --- a/scratch/src/main.rs +++ b/scratch/src/main.rs @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Open Network Fabric Authors + use dpdk::dev::TxOffloadConfig; use dpdk::{dev, eal, mem, queue, socket}; use dpdk_sys::*; diff --git a/scripts/bump.sh b/scripts/bump.sh index 48913072..81f162aa 100755 --- a/scripts/bump.sh +++ b/scripts/bump.sh @@ -1,4 +1,6 @@ #!/usr/bin/env bash +# SPDX-License-Identifier: Apache-2.0 +# Copyright Open Network Fabric Authors set -euxo pipefail