def get_field_offet_by_str(self, field_des):
"""
return field_des (offset,size) layer:cnt.field
- for example
+ for example
802|1Q.vlan get 802.1Q->valn replace | with .
IP.src
IP:0.src (first IP.src like IP.src)
op : string
could be "inc", "dec", "random"
- For example::
+ .. code-block:: python
+ :caption: Example1
+
# input
STLVmFlowVar(min_value=0, max_value=3, size=1,op="inc")
**IPv4 header** offset from packet start. It is **not** the offset of the checksum field itself.
in could be string in case of scapy packet. format IP[:[id]]
- For example::
+ .. code-block:: python
+ :caption: Example2
pkt = Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)
is_big : bool
how to write the variable to the the packet. is it big-edian or little edian
- For example::
+ .. code-block:: python
+ :caption: Example3
pkt = Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)
class STLVmWrMaskFlowVar(CTRexVmDescBase):
def __init__(self, fv_name, pkt_offset, pkt_cast_size=1, mask=0xff, shift=0, add_value=0, offset_fixup=0, is_big=True):
+
+ """
+ Write a stream variable into a packet field with some operations.
+ Using this instruction the variable size and the field could be with different size.
+
+ Pseudocode of this code::
+
+ uint32_t val=(cast_to_size)rd_from_variable("name") # read flow-var
+ val+=m_add_value # add value
+
+ if (m_shift>0) { # shift
+ val=val<<m_shift
+ }else{
+ if (m_shift<0) {
+ val=val>>(-m_shift)
+ }
+ }
+
+ pkt_val=rd_from_pkt(pkt_offset) # RMW to the packet
+ pkt_val = (pkt_val & ~m_mask) | (val & m_mask)
+ wr_to_pkt(pkt_offset,pkt_val)
+
+
+ :parameters:
+ fv_name : string
+ The stream variable name to write to a packet field
+
+ pkt_cast_size : uint8_t
+ The size in bytes of the packet field
+
+
+ mask : uint32_t
+ The mask of the field. 1 means to write. 0 don't care
+
+ shift : uint8_t
+ How many bits to shift
+
+ pkt_offset : string or in
+ the name of the field or offset in byte from packet start.
+
+ offset_fixup : int
+ how many bytes to go forward. In case of a negative value go backward
+
+ add_val : int
+ value to add to stream variable before writing it to packet field. can be used as a constant offset
+
+ is_big : bool
+ how to write the variable to the the packet. is it big-edian or little edian
+
+ Example 1- casting from uint16_t (var) to uint8_t (pkt)::
+
+
+ base_pkt = Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)
+
+ vm = STLScVmRaw( [ STLVmFlowVar(name="mac_src",
+ min_value=1,
+ max_value=30,
+ size=2,
+ op="dec",step=1),
+ STLVmWrMaskFlowVar(fv_name="mac_src",
+ pkt_offset= 11,
+ pkt_cast_size=1,
+ mask=0xff) # mask command ->write it as one byte
+ ]
+ )
+
+ pkt = Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)
+
+ Example 2- change MSB of uint16_t variable::
+
+
+ vm = STLScVmRaw( [ STLVmFlowVar(name="mac_src",
+ min_value=1,
+ max_value=30,
+ size=2, op="dec",step=1),
+ STLVmWrMaskFlowVar(fv_name="mac_src",
+ pkt_offset= 10,
+ pkt_cast_size=2,
+ mask=0xff00,
+ shift=8) # take the var shift it 8 (x256) write only to LSB
+ ]
+ )
+
+
+
+ Example 3- Every 2 packet change the MAC (shift right)::
+
+ vm = STLScVmRaw( [ STLVmFlowVar(name="mac_src",
+ min_value=1,
+ max_value=30,
+ size=2, op="dec",step=1),
+ STLVmWrMaskFlowVar(fv_name="mac_src",
+ pkt_offset= 10,
+ pkt_cast_size=1,
+ mask=0x1,
+ shift=-1) # take var mac_src>>1 and write the LSB every two packet there should be a change
+ ]
+ )
+
+
+ """
+
super(STLVmWrMaskFlowVar, self).__init__()
self.name =fv_name
assert type(fv_name)==str, 'type of fv_name is not str'
the stream variable name. the value from this variable would be the new total packet size.
-
- For example::
+ For Example::
def create_stream (self):
# pkt
="0.0.0.10", port_min=1025, port_max=65535, limit_flows=100000, flags=0
-
- For example::
+ .. code-block:: python
+ :caption: Example5
def create_stream (self):
# pkt
pkt could be Scapy pkt or pcap file name
When path_relative_to_profile is a True load pcap file from a path relative to the profile
- Instantiate a CTRexPktBuilder object
+
+ .. code-block:: python
+ :caption: Example6
+
+
+ # packet is scapy
+ STLPktBuilder( pkt = Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)/(10*'x') )
+
+
+ # packet is taken from pcap file relative to python
+ STLPktBuilder( pkt ="stl/yaml/udp_64B_no_crc.pcap")
+
+ # packet is taken from pcap file relative to profile file
+ STLPktBuilder( pkt ="stl/yaml/udp_64B_no_crc.pcap",
+ path_relative_to_profile = True )
+
+
+ vm = STLScVmRaw( [ STLVmTupleGen ( ip_min="16.0.0.1", ip_max="16.0.0.2",
+ port_min=1025, port_max=65535,
+ name="tuple"), # define tuple gen
+
+ STLVmWrFlowVar (fv_name="tuple.ip", pkt_offset= "IP.src" ), # write ip to packet IP.src
+ STLVmFixIpv4(offset = "IP"), # fix checksum
+ STLVmWrFlowVar (fv_name="tuple.port", pkt_offset= "UDP.sport" ) #write udp.port
+ ]
+ )
+
+ base_pkt = Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)
+ pad = max(0, size - len(base_pkt)) * 'x'
+
+ STLPktBuilder(pkt = base_pkt/pad, vm= vm)
+
:parameters:
pkt_buffer : string
a packet as buffer
- vm : list
+ vm : list or base on :class:`trex_stl_lib.trex_stl_packet_builder_scapy.STLScVmRaw`
a list of instructions to manipolate packet fields
path_relative_to_profile : bool
remove_fcs : bool
in case of buffer do we want to remove fcs
- for Example::
-
- # packet is scapy
- STLPktBuilder( pkt = Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)/(10*'x')
-
- # packet is taken from pcap file relative to python
- STLPktBuilder(pkt ="stl/yaml/udp_64B_no_crc.pcap")
-
- # packet is taken from pcap file relative to profile file
- STLPktBuilder(pkt ="stl/yaml/udp_64B_no_crc.pcap",
- path_relative_to_profile = True)
-
-
- vm = STLScVmRaw( [ STLVmTupleGen ( ip_min="16.0.0.1", ip_max="16.0.0.2",
- port_min=1025, port_max=65535,
- name="tuple"), # define tuple gen
-
- STLVmWrFlowVar (fv_name="tuple.ip", pkt_offset= "IP.src" ), # write ip to packet IP.src
- STLVmFixIpv4(offset = "IP"), # fix checksum
- STLVmWrFlowVar (fv_name="tuple.port", pkt_offset= "UDP.sport" ) #write udp.port
- ]
- );
-
- base_pkt = Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)
- pad = max(0, size - len(base_pkt)) * 'x'
-
- STLPktBuilder(pkt = base_pkt/pad,
- vm= vm)
"""
def set_packet (self, pkt):
"""
- Scapy packet Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)/IP()/"A"*10
+ Scapy packet
+
+ For Example::
+
+ pkt =Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)/IP()/('x'*10)
+
"""
if isinstance(pkt, Packet):
self.pkt = pkt;
percentage : float
link interface precent 0-100 e.g. 10 is 10%% of the port link setup
- For example::
+ .. code-block:: python
+ :caption: STLTXMode Example
+
mode = STLTXCont(pps = 10)
+
mode = STLTXCont(bps_L1 = 10000000) #10mbps L1
+
mode = STLTXCont(bps_L2 = 10000000) #10mbps L2
+
mode = STLTXCont(percentage = 10) #10%
"""
see :class:`trex_stl_lib.trex_stl_streams.STLTXMode` for rate
- For example::
+ .. code-block:: python
+ :caption: STLTXCont Example
+
mode = STLTXCont(pps = 10)
"""
see :class:`trex_stl_lib.trex_stl_streams.STLTXMode` for rate
- For example::
+ .. code-block:: python
+ :caption: STLTXSingleBurst Example
+
mode = STLTXSingleBurst( pps = 10, total_pkts = 1)
"""
see :class:`trex_stl_lib.trex_stl_streams.STLTXMode` for rate
- For example::
+ .. code-block:: python
+ :caption: STLTXMultiBurst Example
+
mode = STLTXMultiBurst(pps = 10, pkts_per_burst = 1,count 10, ibg=10.0)
"""
class STLFlowStats(object):
""" Define per stream stats
- For example::
+ .. code-block:: python
+ :caption: STLFlowStats Example
flow_stats = STLFlowStats(pg_id = 7)
class STLStream(object):
""" One stream object, include mode, Field Engine mode packet template and Rx stats
- For example::
+ .. code-block:: python
+ :caption: STLStream Example
+
base_pkt = Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)
pad = max(0, size - len(base_pkt)) * 'x'
name : string
The name of the stream. Needed if this stream is dependent on another stream and another stream need to refer to this stream by its name.
- packet : STLPktBuilder
+ packet : STLPktBuilder see :class:`trex_stl_lib.trex_stl_packet_builder_scapy.STLPktBuilder`
The template packet and field engine program e.g. packet = STLPktBuilder(pkt = base_pkt/pad)
mode : :class:`trex_stl_lib.trex_stl_streams.STLTXCont` or :class:`trex_stl_lib.trex_stl_streams.STLTXSingleBurst` or :class:`trex_stl_lib.trex_stl_streams.STLTXMultiBurst`
class STLProfile(object):
""" Describe a list of streams
- For example::
+ .. code-block:: python
+ :caption: STLProfile Example
profile = STLProfile( [ STLStream( isg = 10.0, # star in delay
name ='S0',
Code Review / trex.git / commitdiff