ipng/lcpng
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add README.md and LICENSE

Browse Source
This commit is contained in:
Pim van Pelt
2021-08-22 15:46:19 +02:00
parent fee9776e87
commit caba21ba99
2 changed files with 288 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

202
LICENSE Normal file
View File

@ -0,0 +1,202 @@
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.

216
README.md
View File

@ -1,145 +1,101 @@
This code was taken from VPP's src/plugins/linux-cp/ directory, originally by: # Introduction
Signed-off-by: Neale Ranns <nranns@cisco.com>
Signed-off-by: Matthew Smith <mgsmith@netgate.com> This plugin is a *temporary!* copy of VPP's src/plugins/linux-cp/ plugin,
Signed-off-by: Jon Loeliger <jdl@netgate.com> originally by the following authors:
Signed-off-by: Pim van Pelt <pim@ipng.nl> * Signed-off-by: Neale Ranns <nranns@cisco.com>
Signed-off-by: Neale Ranns <neale@graphiant.com> * Signed-off-by: Matthew Smith <mgsmith@netgate.com>
* Signed-off-by: Jon Loeliger <jdl@netgate.com>
* Signed-off-by: Pim van Pelt <pim@ipng.nl>
* Signed-off-by: Neale Ranns <neale@graphiant.com>
See previous work: See previous work:
https://gerrit.fd.io/r/c/vpp/+/30759 (interface mirroring) * [interface mirroring](https://gerrit.fd.io/r/c/vpp/+/30759)
https://gerrit.fd.io/r/c/vpp/+/31122 (netlink listener) * [netlink listener](https://gerrit.fd.io/r/c/vpp/+/31122)
It's intended to be re-submitted for review as a cleanup/rewrite of the existing My work is intended to be re-submitted for review as a cleanup/rewrite of the
Linux CP interface mirror and netlink syncer. existing Linux CP interface mirror and netlink syncer.
# FAQ Follow along on [my blog](https://ipng.ch/s/articles/) for my findings while
I work towards a completed plugin that can copy VPP configuration into Linux
interfaces, and copy Linux configuration changes into VPP (ie. a fully
bidirectional pipe between Linux and VPP).
***Why doesn't the plugin listen to new linux interfaces?*** When the code is complete, this plugin should be able to work seemlessly with
a higher level controlplane like [FRR](https://frrouting.org/) or
[Bird](https://bird.network.cz/), for example as a BGP/OSPF speaking ISP router.
Consider the following two commands: ## WARNING!!
The only reason that this code is here, is so that I can make some progress
iterating on the Linux CP plugin, and share my findings with some interested
folks. The goal is NOT to use this plugin anywhere other than a bench. I
intend to contribute the plugin back upstream as soon as it's peer reviewed!
***Pull Requests and Issues will be immediately closed without warning***
VPP's code lives at [fd.io](https://gerrit.fd.io/r/c/vpp), and this copy is
shared only for convenience purposes.
## Building
First, ensure that you can build and run 'vanilla' VPP by using the
[instructions](https://wiki.fd.io/view/VPP/Pulling,_Building,_Running,_Hacking_and_Pushing_VPP_Code).
Then check out this plugin out-of-tree and symlink it in.
``` ```
ip link add link e0 name foo type vlan id 10 protocol 802.1ad mkdir ~/src
ip link add link foo name bar type vlan id 20 cd ~/src
``` git clone https://github.com/pimvanpelt/lcpng.git
The two effectively create a dot1ad with an outer tag of 10 and an inner tag of ln -s ~/src/vpp/src/plugins/lcpng ~src/lcpng
20 (you could also read this as e0.10.20). The `foo` interface is the untagged
VLAN 10 on e0 with ethernet type 0x8aa8, and the `bar` interface carries any
tagged traffic on `foo`, thus is ethernet type 0x8100 within the e0's ethernet
type 0x8aa8 outer frame.
It's easy to listen to netlink messages like these, but their name will in
no way be easy to map to a VPP subinterface concept. In VPP, all subinterfaces
are numbered on their phy, such as TenGigabitEthernet0/0/0.1000. It is not
clear how to map the linux host interface name `foo` and `bar` to this
numbering scheme in a way that doesn't create collissions.
A second consideration is that these QinQ interfaces can be 802.1ad or 802.1q
tagged on the outer. So what happens if after the above, a new `foo2` interface
is created with protocol 802.1q ? VPP only allows sub interfaces to carry one
(1) number.
Rather than applying heuristics and adding bugs, it is not possible to create
VPP interfaces via Linux, only the other way around. Create any L3 capable
interface or subinterface in VPP, and it'll be created in Linux as well.
### Notes
We'll be able to see if VPP changes the interfaces with a bunch of callback
functions:
```
pim@hippo:~/src/vpp$ grep -r VNET.*_FUNCTION src/vnet/interface.h
#define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
#define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
#define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f) \
#define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
#define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
``` ```
Super useful for MTU changes, admin up/dn and link up/dn changes (to copy ## Running
these into the TAP and the host interface).
Notably missing here is some form of SW_INTERFACE_L2_L3_CHANGE_FUNCTION(f) Ensure this plugin is enabled and the original `linux-cp` plugin is disabled,
which would be useful to remove an LCP if the iface goes into L2 mode, and that logging goes to stderr (in the debug variant of VPP), and that the features
(re)create an LCP if the iface goes into L3 mode. are dis/enabled, by providing the following `startup.conf`:
```
plugins {
path ~/src/vpp/build-root/install-vpp_debug-native/vpp/lib/vpp_plugins
plugin lcpng_if_plugin.so { enable }
plugin linux_cp_plugin.so { disable }
}
It will also be very useful to create an IP_ADDRESS_ADD_DEL_FUNCTION(f) logging {
of sorts so that we know when VPP sets an IPv4/IPv6 address (so that we default-log-level info
can copy this into the host interface). default-syslog-log-level crit
## Set per-class configuration
class linux-cp/if { rate-limit 10000 level debug syslog-level debug }
}
#### LCP names lcpng {
default netns dataplane
lcp-sync
lcp-auto-subint
}
```
The maximum length of an interface name in Linux is 15 characters. I'd love Then, simply `make build` and `make run` VPP which will load the plugin.
to be able to make interfaces like you might find in DANOS: ```
dp0p6s0f1 but this is already 9 characters, and the slot and PCI bus can be im@hippo:~/src/vpp$ make run
double digits. The Linux idiom is to make a link as a child of another link, snort [debug ]: initialized
like: snort [debug ]: snort listener /run/vpp/snort.sock
ip link add link eth0 name eth0.1234 type vlan id 1234 proto dot1q linux-cp/if [debug ]: interface_add: [1] sw TenGigabitEthernet3/0/0 is_sub 0 lcp-auto-subint 1
linux-cp/if [debug ]: mtu_change: sw TenGigabitEthernet3/0/0 0
linux-cp/if [debug ]: interface_add: [2] sw TenGigabitEthernet3/0/1 is_sub 0 lcp-auto-subint 1
linux-cp/if [debug ]: mtu_change: sw TenGigabitEthernet3/0/1 0
linux-cp/if [debug ]: interface_add: [3] sw TenGigabitEthernet3/0/2 is_sub 0 lcp-auto-subint 1
linux-cp/if [debug ]: mtu_change: sw TenGigabitEthernet3/0/2 0
linux-cp/if [debug ]: interface_add: [4] sw TenGigabitEthernet3/0/3 is_sub 0 lcp-auto-subint 1
linux-cp/if [debug ]: mtu_change: sw TenGigabitEthernet3/0/3 0
linux-cp/if [debug ]: interface_add: [5] sw TwentyFiveGigabitEthernete/0/0 is_sub 0 lcp-auto-subint 1
linux-cp/if [debug ]: mtu_change: sw TwentyFiveGigabitEthernete/0/0 0
linux-cp/if [debug ]: interface_add: [6] sw TwentyFiveGigabitEthernete/0/1 is_sub 0 lcp-auto-subint 1
linux-cp/if [debug ]: mtu_change: sw TwentyFiveGigabitEthernete/0/1 0
_______ _ _ _____ ___
__/ __/ _ \ (_)__ | | / / _ \/ _ \
_/ _// // / / / _ \ | |/ / ___/ ___/
/_/ /____(_)_/\___/ |___/_/ /_/
You can also make QinQ interfaces in the same way: DBGvpp#
ip link add link eth0.1234 name eth0.1234.1000 type vlan id 1234 ```
This last interface will have 5 characters .1000 for the inner, 5 characters
.1234 for the outer, leaving 5 characters for the full interface name.
I can see two ways out of this:
1. Make main interfaces very short
For example `et0` for DPDK interfaces, `be1` for BondEthernet, `lo4` for
Loopback interfaces, and possibly `bvi5` for BridgeVirtualInterface (these
are the L3 interfaces in an L2 bridge-group). In such a world, we can create
any number of subinterfaces in a Linux _idiomatic way_, like et192.1234.1000
but BVIs will be limited to 100 interfaces and ethernet's to 1000. This seems
okay, but does paint us in the corner possibly in the future.
1. Strictly follow VPP's naming
VPP will always have exactly one (integer) numbered subinterface, like
`TenGigabitEthernet3/0/2.1234567890` and the function of such a subint can take
multiple forms (dot1q, dot1ad, double-tagged, etc). In this world, we can create
interface names in Linux that map very cleanly to VPP's subinterfaces, and we
can also auto-create subinterfaces by reading a netlink link message, provided
the chosen name follows an <iface>.<number> pattern, and <iface> maps to a known
LCP.
Here's how I can see the latter approach working:
Creation of VPP sub-interface directly creates the corresponding LCP device
name `e0.1234`. Creating a more complex dot1q/dot1q or dot1ad or dot1ad/dot1q
sub-interface will again create a mirror LCP with device name `e0.1235`,
reusing the sub-int number from VPP directly. That's good.
Reading a netlink new link message is a bit trickier, but here's what I
propose:
* On a physical interface `e0`, one can create a dot1q or dot1ad link with a
linux name of `e0.1234`; in such a case, a corresponding sub-int will be
made by the plugin in VPP.
* On a linux interface `e0.1234`, only a dot1q interface can be made, but
its name is required to follow the <iface>.<number> pattern, and if so,
the plugin will make a VPP interface corresponding to that number, but
considering we already know if the parent is either a .1q interface or a
.1ad interface, the correct type of VPP interface can be selected.
* If an interface name is not valid, the plugin will destroy the link and
log an error.
* Because we'll want to use one TAP interface per LCP (see rationale
above), the plugin will have to destroy the link and recreate it as a
new interface with the same name, but not as a child of the originally
requested parent interface.
With this, we can:
1. Create a dot1q subinterface on `e0`:
`ip link add link e0 name e0.1234 type vlan id 1234`
1. Create a dot1q outer, dot1q inner subinterface on `e0`:
`ip link add link e0.1234 name e0.1235 type vlan id 1000`
1. Create a dot1ad subinterface on `e0`:
`ip link add link e0 name e0.1236 type vlan id 2345 proto 802.1ad`
1. Create a dot1ad outer, dot1q inner subinterface on `e0`:
`ip link add link e0.1236 name e0.1237 type vlan id 2345 proto 802.1q`
1. Fail to create an interface which has an invalid name:
`ip link add link e0.1234 name e0.1234.2345 type vlan id 2345 proto 802.1q`
(this interface will be destroyed by the plugin and an error logged)
For each of these interface creations, the user is asking them to be created as
a child of an existing interface (either `e0` or `e0.1234`), but the plugin
will destroy that interface again, and recreate it as a top-level interface
int the namespace, with an accompanying tap interface. So in this plugin, every
LCP has exactly one TAP, and that TAP interface is never a sub-int.