make OPTE public (#128)

Author: rzezeski

CONTRIBUTING.adoc

@@ -0,0 +1,51 @@
+== OPTE status and open source
+
+The OPTE repo is public because:
+
+1. It has always been our intention to make this open-source.
+
+2. We figured it's best to err on the side of doing this early instead
+   of late.
+
+However, OPTE is not finished, or even ready.
+
+And so, we thought it was important to explain where we're currently
+at, and manage your expectations.
+
+- We are a small company.
+
+- Our current goal is to get our first generation products finished
+  and in customers' hands.
+
+- We're writing OPTE in support of that goal, not as its own thing.
+  We're all working on the products, and tool development is a side
+  effect. That said, OPTE will be more generally useful if you are
+  looking for a packet transformation engine to implement network
+  functions in an illumos-based environment; it's just the current
+  focus is solely on supporting Oxide and the Oxide Rack.
+
+- OPTE may have dependencies on other Oxide repositories, which
+  themselves may be undergoing similar churn.
+
+- These points together mean that we may not have enough bandwidth to
+  review and integrate outside PRs right now. We hope this will change
+  in the future.
+
+You're welcome to send PRs, but we want to set expectations right: if
+we have time, or if the PRs are very small or fix bugs, we may
+integrate them in the near future. But we might also not get to any PR
+for a while, by which time it might no longer be relevant. Also keep
+in mind that some aspects of the code which have obvious flaws or
+TODOs may already be scheduled for change, but there are other more
+pressing matters to attend to first. If you feel compelled to write a
+PR, it would be best to first reach out before starting any work in
+earnest, as there may already been planned changes that would obsolete
+such work.
+
+We've all dealt with those open source projects that feel open in name
+only, and have big patches and history-free source drops appearing
+from behind the walls of some large organization. We don't like that,
+and we're not going to do that. But it will take some time for us to
+scale up -- please bear with us.
+
+Thanks!

LICENSE

@@ -1,5 +1,10 @@
 = Oxide Packet Transformation Engine
 
+== Contributing
+
+Please see the xref:CONTRIBUTING.adoc[CONTRIBUTING] doc if you are
+interested in contributing to the project.
+
 == Relevant RFDs and Inspiration
 
 * https://rfd.shared.oxide.computer/rfd/0009[RFD 9: Networking Considerations]

README.adoc

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 // This is a "sys" (raw interface) crate for the illumos DDI/DKI
 // interfaces. It contains definitions of C macros, opaque types, 9F
 // prototypes, and 9S structures which are required for proper use of

illumos-ddi-dki/src/lib.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 #![allow(non_camel_case_types)]
 #![no_std]
 

illumos-sys-hdrs/src/lib.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use alloc::string::String;
 use alloc::vec::Vec;
 use core::fmt::Debug;

opte-drv/src/ioctl.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 //! OPTE - Oxide Packet Transformation Engine
 //!
 //! This driver is used as a way to interface the OPTE implementation

opte-drv/src/lib.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use opte::api::{
     CmdOk, MacAddr, NoResp, OpteCmd, OpteCmdIoctl, OpteError,
     SetXdeUnderlayReq, Vni, API_VERSION, XDE_DLD_OPTE_CMD,

opte-ioctl/src/lib.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use super::API_VERSION;
 use illumos_sys_hdrs::{c_int, size_t};
 use serde::{Deserialize, Serialize};

opte/src/api/cmd.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::fmt::{self, Display};
 
 use serde::{Deserialize, Serialize};

opte/src/api/encap.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use super::mac::MacAddr;
 use core::fmt::{self, Debug, Display};
 use core::result;

opte/src/api/ip.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::fmt::{self, Display};
 use serde::{Deserialize, Serialize};
 

opte/src/api/mac.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 pub mod cmd;
 pub mod encap;
 pub mod ip;

opte/src/api/mod.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 /// Port 0 is reserved by the sockets layer. It is used by clients to
 /// indicate they want the operating system to choose a port on their
 /// behalf.

opte/src/api/ulp.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 /// Address Resolution Protocol
 ///
 /// Relevant Docs

opte/src/engine/arp.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 pub struct HeaderChecksum {
     inner: [u8; 2],
 }

opte/src/engine/checksum.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::fmt::{self, Display};
 
 cfg_if! {

opte/src/engine/dhcp.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::convert::TryFrom;
 use core::fmt::{self, Debug, Display};
 use core::mem;

opte/src/engine/ether.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::fmt;
 
 cfg_if! {

opte/src/engine/flow_table.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::convert::TryFrom;
 use core::mem;
 

opte/src/engine/geneve.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::fmt;
 
 cfg_if! {

opte/src/engine/headers.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 //! ICMP headers.
 use core::fmt::{self, Display};
 

opte/src/engine/icmp.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 //! Integration tests.
 //!
 //! The idea behind these tests is to use actual packet captures to

opte/src/engine/int_test.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 //! The ioctl interface.
 use core::fmt::Debug;
 

opte/src/engine/ioctl.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::convert::TryFrom;
 use core::fmt::{self, Debug, Display};
 use core::mem;

opte/src/engine/ip4.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::convert::TryFrom;
 use core::fmt;
 use core::mem::size_of;

opte/src/engine/ip6.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::fmt::{self, Display};
 use core::mem;
 use core::result;

opte/src/engine/layer.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 //! The engine in OPTE.
 //!
 //! All code under this namespace is guarded by the `engine` feature flag.

opte/src/engine/mod.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::fmt;
 use core::ops::Range;
 

opte/src/engine/nat.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 //! Types for creating, reading, and writing network packets.
 //!
 //! TODO

opte/src/engine/packet.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 /// A virtual switch port.
 use core::result;
 

opte/src/engine/port.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::fmt::{self, Display};
 
 cfg_if! {

opte/src/engine/rule.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 //! Safe abstractions for synchronization primitives.
 //!
 //! TODO: This should be in its own crate, wrapping the illumos-ddi-dki

opte/src/engine/sync.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::convert::TryFrom;
 use core::fmt::{self, Display};
 use core::mem;

opte/src/engine/tcp.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 use core::fmt::{self, Display};
 
 cfg_if! {

opte/src/engine/tcp_state.rs

@@ -1,3 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// Copyright 2022 Oxide Computer Company
+
 //! Moments, periodics, etc.
 use core::ops::Add;
 use core::time::Duration;