aboutsummaryrefslogtreecommitdiffstats
path: root/test/vpp_udp_encap.py
blob: aad87bd591297ff19ad63e223c67766a8aa38fae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#!/usr/bin/env python3
"""
  UDP encap objects
"""

from vpp_object import VppObject
from socket import inet_pton, inet_ntop, AF_INET, AF_INET6


def find_udp_encap(test, ue):
    encaps = test.vapi.udp_encap_dump()
    for e in encaps:
        if ue.id == e.udp_encap.id \
           and ue.src_ip == str(e.udp_encap.src_ip) \
           and ue.dst_ip == str(e.udp_encap.dst_ip) \
           and e.udp_encap.dst_port == ue.dst_port \
           and e.udp_encap.src_port == ue.src_port:
            return True

    return False


class VppUdpEncap(VppObject):

    def __init__(self,
                 test,
                 src_ip,
                 dst_ip,
                 src_port,
                 dst_port,
                 table_id=0):
        self._test = test
        self.table_id = table_id
        self.src_ip_s = src_ip
        self.dst_ip_s = dst_ip
        self.src_ip = src_ip
        self.dst_ip = dst_ip
        self.src_port = src_port
        self.dst_port = dst_port

    def add_vpp_config(self):
        r = self._test.vapi.udp_encap_add(
            self.src_ip,
            self.dst_ip,
            self.src_port,
            self.dst_port,
            self.table_id)
        self.id = r.id
        self._test.registry.register(self, self._test.logger)

    def remove_vpp_config(self):
        self._test.vapi.udp_encap_del(self.id)

    def query_vpp_config(self):
        return find_udp_encap(self._test, self)

    def object_id(self):
        return ("udp-encap-%d" % self.id)

    def get_stats(self):
        c = self._test.statistics.get_counter("/net/udp-encap")
        return c[0][self.id]
-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
# Copyright (c) 2021 Cisco and/or its affiliates.
#
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
#
# Licensed under the Apache License 2.0 or
# GNU General Public License v2.0 or later;  you may not use this file
# except in compliance with one of these Licenses. You
# may obtain a copy of the Licenses at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#     https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
#
# Note: If this file is linked with Scapy, which is GPLv2+, your use of it
# must be under GPLv2+.  If at any point in the future it is no longer linked
# with Scapy (or other GPLv2+ licensed software), you are free to choose
# Apache 2.
#
# 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.

"""Stream profile for T-rex traffic generator.

Stream profile:
 - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
 - Packet: ETH / IP / UDP
 - Direction 0 --> 1:
   - Source IP address range:      192.168.0.0 - 192.168.255.255
   - Destination IP address range: 20.0.0.0
   - Source UDP port range:        1024 - 1086
   - Destination UDP port range:   1024
 - Direction 1 --> 0:
   - Source IP address range:      20.0.0.0
   - Destination IP address range: 68.142.68.0 - 68.142.68.63
   - Source UDP port range:        1024
   - Destination UDP port range:   1024 - 65535
"""

from trex.stl.api import *
from profile_trex_stateless_base_class import TrafficStreamsBaseClass


class TrafficStreams(TrafficStreamsBaseClass):
    """Stream profile."""

    def __init__(self):
        """Initialization and setting of streams' parameters."""

        super(TrafficStreamsBaseClass, self).__init__()

        # IPs used in packet headers.
        self.p1_src_start_ip = u"192.168.0.0"
        self.p1_src_end_ip = u"192.168.255.255"
        self.p1_dst_start_ip = u"20.0.0.0"
        self.p1_dst_end_ip = u"20.0.0.0"

        self.p2_src_start_ip = u"20.0.0.0"
        self.p2_src_end_ip = u"20.0.0.0"
        self.p2_dst_start_ip = u"68.142.68.0"
        self.p2_dst_end_ip = u"68.142.68.63"

        # UDP ports used in packet headers.
        self.p1_src_start_udp_port = 1024
        self.p1_src_end_udp_port = 1086
        self.p1_dst_start_udp_port = 1024
        self.p1_dst_end_udp_port = 1024

        self.p2_src_start_udp_port = 1024
        self.p2_src_end_udp_port = 1024
        self.p2_dst_start_udp_port = 1024
        self.p2_dst_end_udp_port = 65535

    def define_packets(self):
        """Defines the packets to be sent from the traffic generator.

        Packet definition: | ETH | IP | UDP |

        :returns: Packets to be sent from the traffic generator.
        :rtype: tuple
        """

        # Direction 0 --> 1
        base_pkt_a = (
            Ether() /
            IP(
                src=self.p1_src_start_ip,
                dst=self.p1_dst_start_ip,
                proto=17
            ) /
            UDP(
                sport=self.p1_src_start_udp_port,
                dport=self.p1_dst_start_udp_port
            )
        )
        # Direction 1 --> 0
        base_pkt_b = (
            Ether() /
            IP(
                src=self.p2_src_start_ip,
                dst=self.p2_dst_start_ip,
                proto=17
            ) /
            UDP(
                sport=self.p2_src_start_udp_port,
                dport=self.p2_dst_start_udp_port
            )
        )

        # Direction 0 --> 1
        vm1 = STLVM()
        vm1.var(name="sIP",
                min_value=self.p1_src_start_ip,
                max_value=self.p1_src_end_ip,
                size=4,
                op="inc",
                next_var="sport")
        vm1.var(name="sport",
                min_value=self.p1_src_start_udp_port,
                max_value=self.p1_src_end_udp_port,
                size=2,
                op="inc")
        vm1.var(name="dIP",
                min_value=self.p1_dst_start_ip,
                max_value=self.p1_dst_end_ip,
                size=4,
                op="inc")
        vm1.var(name="dport",
                min_value=self.p1_dst_start_udp_port,
                max_value=self.p1_dst_end_udp_port,
                size=2,
                op="inc")
        vm1.write(fv_name="sIP", pkt_offset="IP.src")
        vm1.write(fv_name="sport", pkt_offset="UDP.sport")
        vm1.write(fv_name="dIP", pkt_offset="IP.dst")
        vm1.write(fv_name="dport", pkt_offset="UDP.dport")
        vm1.fix_chksum(offset='IP')
        # Direction 0 --> 1
        vm2 = STLVM()
        vm2.var(name="sIP",
                min_value=self.p2_src_start_ip,
                max_value=self.p2_src_end_ip,
                size=4,
                op="inc",
                next_var="sport")
        vm2.var(name="sport",
                min_value=self.p2_src_start_udp_port,
                max_value=self.p2_src_end_udp_port,
                size=2,
                op="inc")
        vm2.var(name="dIP",
                min_value=self.p2_dst_start_ip,
                max_value=self.p2_dst_end_ip,
                size=4,
                op="inc",
                next_var="dport")
        vm2.var(name="dport",
                min_value=self.p2_dst_start_udp_port,
                max_value=self.p2_dst_end_udp_port,
                size=2,
                op="inc")
        vm2.write(fv_name="sIP", pkt_offset="IP.src")
        vm2.write(fv_name="sport", pkt_offset="UDP.sport")
        vm2.write(fv_name="dIP", pkt_offset="IP.dst")
        vm2.write(fv_name="dport", pkt_offset="UDP.dport")
        vm2.fix_chksum(offset='IP')

        return base_pkt_a, base_pkt_b, vm1, vm2

def register():
    """Register this traffic profile to T-rex.

    Do not change this function.

    :return: Traffic streams.
    :rtype: Object
    """
    return TrafficStreams()