net: UDP tunnel encapsulation module for tunnelling different protocols like MPLS...
[platform/kernel/linux-starfive.git] / Documentation / networking / bareudp.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 ========================================
4 Bare UDP Tunnelling Module Documentation
5 ========================================
6
7 There are various L3 encapsulation standards using UDP being discussed to
8 leverage the UDP based load balancing capability of different networks.
9 MPLSoUDP (__ https://tools.ietf.org/html/rfc7510) is one among them.
10
11 The Bareudp tunnel module provides a generic L3 encapsulation tunnelling
12 support for tunnelling different L3 protocols like MPLS, IP, NSH etc. inside
13 a UDP tunnel.
14
15 Usage
16 ------
17
18 1) Device creation & deletion
19
20     a) ip link add dev bareudp0 type bareudp dstport 6635 ethertype 0x8847.
21
22        This creates a bareudp tunnel device which tunnels L3 traffic with ethertype
23        0x8847 (MPLS traffic). The destination port of the UDP header will be set to
24        6635.The device will listen on UDP port 6635 to receive traffic.
25
26     b) ip link delete bareudp0
27
28 2) Device Usage
29
30 The bareudp device could be used along with OVS or flower filter in TC.
31 The OVS or TC flower layer must set the tunnel information in SKB dst field before
32 sending packet buffer to the bareudp device for transmission. On reception the
33 bareudp device extracts and stores the tunnel information in SKB dst field before
34 passing the packet buffer to the network stack.