Initial set of Fabric switch test cases
Change-Id: I86fd2b67d3b773aa496f5ef61f1e1fdf51fd9925
diff --git a/Fabric/Utilities/src/python/oftest/oft12/__init__.py b/Fabric/Utilities/src/python/oftest/oft12/__init__.py
new file mode 100644
index 0000000..d4e8062
--- /dev/null
+++ b/Fabric/Utilities/src/python/oftest/oft12/__init__.py
@@ -0,0 +1,16 @@
+
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+
diff --git a/Fabric/Utilities/src/python/oftest/oft12/packet.py b/Fabric/Utilities/src/python/oftest/oft12/packet.py
new file mode 100644
index 0000000..55724d6
--- /dev/null
+++ b/Fabric/Utilities/src/python/oftest/oft12/packet.py
@@ -0,0 +1,1315 @@
+
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+
+######################################################################
+#
+# All files associated with the OpenFlow Python Test (oftest) are
+# made available for public use and benefit with the expectation
+# that others will use, modify and enhance the Software and contribute
+# those enhancements back to the community. However, since we would
+# like to make the Software available for broadest use, with as few
+# restrictions as possible permission is hereby granted, free of
+# charge, to any person obtaining a copy of this Software to deal in
+# the Software under the copyrights without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject
+# to the following conditions:
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+######################################################################
+import os
+
+"""
+OpenFlow packet class
+
+This class implements the basic abstraction of an OpenFlow packet. It
+includes parsing functionality and OpenFlow actions related to
+packet modifications.
+"""
+
+import socket
+import struct
+import logging
+import ofp
+import unittest
+import binascii
+import string
+import collections #@UnresolvedImport
+
+ETHERTYPE_IP = 0x0800
+ETHERTYPE_VLAN = 0x8100
+ETHERTYPE_VLAN_QinQ = 0x88a8
+ETHERTYPE_ARP = 0x0806
+ETHERTYPE_MPLS = 0x8847
+ETHERTYPE_MPLS_MCAST = 0x8848
+ETHERTYPES_MPLS = [ETHERTYPE_MPLS, ETHERTYPE_MPLS_MCAST]
+
+DL_MASK_ALL = [0xff, 0xff, 0xff, 0xff, 0xff, 0xff]
+NW_MASK_ALL = 0xffffffff
+
+MPLS_BOTTOM_OF_STACK = 0x00000100
+
+# Sigh.. not python26
+#MplsTag = collections.namedtuple("MplsTag", "label tc ttl")
+
+class MplsTag(object):
+ def __init__(self, label, tc, ttl):
+ self.label = label
+ self.tc = tc
+ self.ttl = ttl
+ def pack(self, bos = 0):
+ packed_tag = ((self.label & 0xfffff) << 12) | \
+ ((self.tc & 0x7) << 9) | \
+ (self.ttl & 0xFF) | \
+ (MPLS_BOTTOM_OF_STACK if bos else 0)
+ return packed_tag
+
+ def unpack(packed_tag):
+ tag = MplsTag(packed_tag >> 12,
+ (packed_tag >> 9) & 0x0007,
+ packed_tag & 0xFF)
+ bos = bool(packed_tag & MPLS_BOTTOM_OF_STACK)
+ return (tag, bos)
+ unpack = staticmethod(unpack)
+
+class Packet(object):
+ """
+ Packet abstraction
+
+ This is meant to support the abstraction of a packet in an
+ OpenFlow 1.1 switch so it includes an action set, ingress port,
+ and metadata. These members may be ignored and the rest of the
+ packet parsing and modification functions used to manipulate
+ a packet.
+ """
+
+ icmp_counter = 1
+
+ def __init__(self, in_port=None, data=""):
+ # Use entries in match when possible.
+ self.in_port = in_port
+ self.data = data
+ self.bytes = len(data)
+ self.match = ofp.ofp_match()
+ self.logger = logging.getLogger("packet")
+ self.instructions = []
+ # parsable tags
+ self.ip_header_offset = None
+ self.tcp_header_offset = None
+ self.mpls_tag_offset = None # pointer to outer mpls tag
+ self.vlan_tag_offset = None # pointer to outer vlan tag
+ self.action_set = {}
+ self.queue_id = 0
+
+ if self.data != "":
+ self.parse()
+
+ def show(self):
+ """ Return a ascii hex representation of the packet's data"""
+ ret = ""
+ c = 0
+ for b in list(self.data):
+ if c != 0:
+ if c % 16 == 0:
+ ret += '\n'
+ elif c % 8 == 0:
+ ret += ' '
+ c += 1
+ ret += "%0.2x " % struct.unpack('B', b)
+ return ret
+
+ def __repr__(self):
+ return self.data
+
+ def __str__(self):
+ return self.__repr__()
+
+ def __len__(self):
+ return len(self.data)
+
+ def simple_tcp_packet(self,
+ pktlen=100,
+ dl_dst='00:01:02:03:04:05',
+ dl_src='00:06:07:08:09:0a',
+ dl_vlan_enable=False,
+ dl_vlan_type=ETHERTYPE_VLAN,
+ dl_vlan=0,
+ dl_vlan_pcp=0,
+ dl_vlan_cfi=0,
+ mpls_type=None,
+ mpls_tags=None,
+ ip_src='192.168.0.1',
+ ip_dst='192.168.0.2',
+ ip_tos=0,
+ ip_ttl=64,
+ tcp_sport=1234,
+ tcp_dport=80):
+ """
+ Return a simple dataplane TCP packet
+
+ Supports a few parameters:
+ @param len Length of packet in bytes w/o CRC
+ @param dl_dst Destinatino MAC
+ @param dl_src Source MAC
+ @param dl_vlan_enable True if the packet is with vlan, False otherwise
+ @param dl_vlan_type Ether type for VLAN
+ @param dl_vlan VLAN ID
+ @param dl_vlan_pcp VLAN priority
+ @param ip_src IP source
+ @param ip_dst IP destination
+ @param ip_tos IP ToS
+ @param tcp_dport TCP destination port
+ @param tcp_sport TCP source port
+
+ Generates a simple TCP request. Users shouldn't assume anything
+ about this packet other than that it is a valid ethernet/IP/TCP frame.
+ """
+ self.data = ""
+ self._make_ip_packet(dl_dst, dl_src, dl_vlan_enable, dl_vlan_type,
+ dl_vlan, dl_vlan_pcp, dl_vlan_cfi,
+ mpls_type, mpls_tags,
+ ip_tos, ip_ttl, ip_src, ip_dst, socket.IPPROTO_TCP)
+
+ # Add TCP header
+ self.data += struct.pack("!HHLLBBHHH",
+ tcp_sport,
+ tcp_dport,
+ 1, # tcp.seq
+ 0, # tcp.ack
+ 0x50, # tcp.doff + tcp.res1
+ 0x12, # tcp.syn + tcp.ack
+ 0, # tcp.wnd
+ 0, # tcp.check
+ 0, # tcp.urgent pointer
+ )
+
+ # Fill out packet
+ self.data += "D" * (pktlen - len(self.data))
+ return self
+
+ def simple_icmp_packet(self,
+ pktlen=100,
+ dl_dst='00:01:02:03:04:05',
+ dl_src='00:06:07:08:09:0a',
+ dl_vlan_enable=False,
+ dl_vlan_type=ETHERTYPE_VLAN,
+ dl_vlan=0,
+ dl_vlan_pcp=0,
+ dl_vlan_cfi=0,
+ mpls_type=None,
+ mpls_tags=None,
+ ip_src='192.168.0.1',
+ ip_dst='192.168.0.2',
+ ip_tos=0,
+ ip_ttl=64,
+ icmp_type=8, # ICMP_ECHO_REQUEST
+ icmp_code=0,
+ ):
+ """
+ Return a simple dataplane ICMP packet
+
+ Supports a few parameters:
+ @param len Length of packet in bytes w/o CRC
+ @param dl_dst Destinatino MAC
+ @param dl_src Source MAC
+ @param dl_vlan_enable True if the packet is with vlan, False otherwise
+ @param dl_vlan_type Ether type for VLAN
+ @param dl_vlan VLAN ID
+ @param dl_vlan_pcp VLAN priority
+ @param ip_src IP source
+ @param ip_dst IP destination
+ @param ip_tos IP ToS
+ @param tcp_dport TCP destination port
+ @param ip_sport TCP source port
+
+ Generates a simple TCP request. Users shouldn't assume anything
+ about this packet other than that it is a valid ethernet/IP/TCP frame.
+ """
+ self.data = ""
+ self._make_ip_packet(dl_dst, dl_src, dl_vlan_enable, dl_vlan_type,
+ dl_vlan, dl_vlan_pcp, dl_vlan_cfi,
+ mpls_type, mpls_tags,
+ ip_tos,
+ ip_ttl, ip_src, ip_dst, socket.IPPROTO_ICMP)
+
+ # Add ICMP header
+ self.data += struct.pack("!BBHHH",
+ icmp_type,
+ icmp_code,
+ 0, # icmp.checksum
+ os.getpid() & 0xffff, # icmp.echo.id
+ Packet.icmp_counter # icmp.echo.seq
+ )
+ Packet.icmp_counter += 1
+
+ # Fill out packet
+ self.data += "D" * (pktlen - len(self.data))
+
+ return self
+
+ def _make_ip_packet(self, dl_dst, dl_src, dl_vlan_enable, dl_vlan_type,
+ dl_vlan, dl_vlan_pcp, dl_vlan_cfi, mpls_type, mpls_tags,
+ ip_tos, ip_ttl, ip_src, ip_dst, ip_proto):
+ self.data = ""
+ addr = dl_dst.split(":")
+ for byte in map(lambda z: int(z, 16), addr):
+ self.data += struct.pack("!B", byte)
+ addr = dl_src.split(":")
+ for byte in map(lambda z: int(z, 16), addr):
+ self.data += struct.pack("!B", byte)
+
+ if (dl_vlan_enable):
+ # Form and add VLAN tag
+ self.data += struct.pack("!H", dl_vlan_type)
+ vtag = (dl_vlan & 0x0fff) | \
+ (dl_vlan_pcp & 0x7) << 13 | \
+ (dl_vlan_cfi & 0x1) << 12
+ self.data += struct.pack("!H", vtag)
+
+ if mpls_tags:
+ # Add type/len field
+ self.data += struct.pack("!H", mpls_type)
+ mpls_tags = list(mpls_tags)
+ while len(mpls_tags):
+ tag = mpls_tags.pop(0)
+ packed_tag = tag.pack(bos = not len(mpls_tags))
+ self.data += struct.pack("!I", packed_tag)
+
+ else:
+ # Add type/len field
+ self.data += struct.pack("!H", ETHERTYPE_IP)
+
+ # Add IP header
+ v_and_hlen = 0x45 # assumes no ip or tcp options
+ ip_len = 120 + 40 # assumes no ip or tcp options
+ self.data += struct.pack("!BBHHHBBH", v_and_hlen, ip_tos, ip_len,
+ 0, # ip.id
+ 0, # ip.frag_off
+ ip_ttl, # ip.ttl
+ ip_proto,
+ 0) # ip.checksum
+ # convert ipsrc/dst to ints
+ self.data += struct.pack("!LL", ascii_ip_to_bin(ip_src),
+ ascii_ip_to_bin(ip_dst))
+
+ def length(self):
+ return len(self.data)
+
+ def clear_actions(self):
+ self.action_set = {}
+
+ def parse(self):
+ """
+ Update the headers in self.match based on self.data
+
+ Parses the relevant header features out of the packet, using
+ the table outlined in the OF1.1 spec, Figure 4
+ """
+ self.bytes = len(self.data)
+ self.match.in_port = self.in_port
+ self.match.type = ofp.OFPMT_STANDARD
+ self.match.length = ofp.OFPMT_STANDARD_LENGTH
+ self.match.wildcards = 0
+ self.match.nw_dst_mask = 0
+ self.match.nw_dst_mask = 0
+ self.match.dl_dst_mask = [ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]
+ self.match.dl_src_mask = [ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]
+ self.mpls_tag_offset = None
+ self.ip_header_offset = None
+
+ idx = 0
+ try:
+ idx = self._parse_l2(idx)
+
+ if self.match.dl_type == ETHERTYPE_IP:
+ self.ip_header_offset = idx
+ idx = self._parse_ip(idx)
+ if self.match.nw_proto in [ socket.IPPROTO_TCP,
+ socket.IPPROTO_UDP,
+ socket.IPPROTO_ICMP]:
+ self.tcp_header_offset = idx
+ if self.match.nw_proto != socket.IPPROTO_ICMP:
+ idx = self._parse_l4(idx)
+ else:
+ idx = self._parse_icmp(idx)
+ elif self.match.dl_type == ETHERTYPE_ARP:
+ self._parse_arp(idx)
+ except (parse_error), e:
+ self.logger.warn("Giving up on parsing packet, got %s" %
+ (str(e)))
+ return None
+ return self.match
+
+ def _parse_arp(self, idx):
+ # @todo Implement
+ pass
+
+ def _parse_l2(self, idx):
+ """
+ Parse Layer2 Headers of packet
+
+ Parse ether src,dst,type (and vlan and QinQ headers if exists) from
+ self.data starting at idx
+ """
+ if self.bytes < 14 :
+ raise parse_error("_parse_l2:: packet too shorter <14 bytes")
+
+ self.match.dl_dst = list(struct.unpack("!6B", self.data[idx:idx+6]))
+ self.match.dl_dst_mask = DL_MASK_ALL
+ idx += 6
+ self.match.dl_src = list(struct.unpack("!6B", self.data[idx:idx+6]))
+ self.match.dl_src_mask = DL_MASK_ALL
+ idx += 6
+ #pdb.set_trace()
+ l2_type = struct.unpack("!H", self.data[idx:idx+2])[0]
+ idx += 2
+ if l2_type in [ETHERTYPE_VLAN, ETHERTYPE_VLAN_QinQ] :
+ self.vlan_tag_offset = 12
+ blob = struct.unpack("!H", self.data[idx:idx+2])[0]
+ idx += 2
+ self.match.dl_vlan_pcp = (blob & 0xe000) >> 13
+ #cfi = blob & 0x1000 #@todo figure out what to do if cfi!=0
+ self.match.dl_vlan = blob & 0x0fff
+ l2_type = struct.unpack("!H", self.data[idx:idx+2])[0]
+ # now skip past any more nest VLAN tags (per the spec)
+ while l2_type in [ETHERTYPE_VLAN, ETHERTYPE_VLAN_QinQ] :
+ idx += 4
+ if self.bytes < idx :
+ raise parse_error("_parse_l2(): Too many vlan tags")
+ l2_type = struct.unpack("!H", self.data[idx:idx+2])[0]
+ idx += 2
+ else:
+ self.vlan_tag_offset = None
+ self.match.dl_vlan = ofp.OFPVID_NONE
+ self.match.dl_vlan_pcp = 0
+
+ if l2_type in ETHERTYPES_MPLS:
+ if self.bytes < (idx + 4):
+ raise parse_error("_parse_l2: Invalid MPLS header")
+ self.mpls_tag_offset = idx
+ tag = struct.unpack("!I", self.data[idx:idx+4])[0]
+ self.match.mpls_label = tag >> 12
+ self.match.mpls_tc = (tag >> 9) & 0x0007
+ idx += 4
+ else:
+ self.match.mpls_label = 0
+ self.match.mpls_tc = 0
+
+ self.match.dl_type = l2_type
+ return idx
+
+ def _parse_ip(self, idx):
+ """
+ Parse IP Headers of a packet starting at self.data[idx]
+ """
+ if self.bytes < (idx + 20) :
+ raise parse_error("_parse_ip: Invalid IP header")
+ # the three blanks are id (2bytes), frag offset (2bytes),
+ # and ttl (1byte)
+ (hlen_and_v, self.match.nw_tos, len, _,_,_, self.match.nw_proto) = \
+ struct.unpack("!BBHHHBB", self.data[idx:idx+10])
+ #@todo add fragmentation parsing
+ hlen = hlen_and_v & 0x0f
+ (self.match.nw_src, self.match.nw_dst) = \
+ struct.unpack("!II", self.data[idx + 12:idx+20])
+ self.match.nw_dst_mask = NW_MASK_ALL
+ self.match.nw_src_mask = NW_MASK_ALL
+ return idx + (hlen *4) # this should correctly skip IP options
+
+ def _parse_l4(self, idx):
+ """
+ Parse the src/dst ports of UDP and TCP packets
+ """
+ if self.bytes < (idx + 8):
+ raise parse_error("_parse_l4: Invalid L4 header")
+ (self.match.tp_src, self.match.tp_dst) = \
+ struct.unpack("!HH", self.data[idx:idx+4])
+
+ def _parse_icmp(self, idx):
+ """
+ Parse the type/code of ICMP Packets
+ """
+ if self.bytes < (idx + 4):
+ raise parse_error("_parse_icmp: Invalid icmp header")
+ # yes, type and code get stored into tp_dst and tp_src...
+ (self.match.tp_src, self.match.tp_dst) = \
+ struct.unpack("!BB", self.data[idx:idx+2])
+
+
+ #
+ # NOTE: See comment string in write_action regarding exactly
+ # when actions are executed (for apply vs write instructions)
+ #
+
+ def write_action(self, action):
+ """
+ Write the action into the packet's action set
+
+ Note that we do nothing to the packet when the write_action
+ instruction is executed. We only record the actions for
+ later processing. Because of this, the output port is not
+ explicitly recorded in the packet; that state is recorded
+ in the action_set[set_output] item.
+ """
+ self.action_set[action.__class__] = action
+
+ def _set_1bytes(self,offset,byte):
+ """ Writes the byte at data[offset]
+
+ This function only exists to match the other _set_Xbytes() and
+ is trivial
+
+ """
+ tmp= "%s%s" % (self.data[0:offset],
+ struct.pack('B',byte & 0xff))
+ if len(self.data) > offset + 1 :
+ tmp += self.data[offset+1:len(self.data)]
+ self.data=tmp
+
+ def _set_2bytes(self,offset,short):
+ """ Writes the 2 byte short in network byte order at data[offset] """
+ tmp= "%s%s" % (self.data[0:offset],
+ struct.pack('!H',short & 0xffff))
+ if len(self.data) > offset + 2 :
+ tmp += self.data[offset+2:len(self.data)]
+ self.data=tmp
+
+ def _set_4bytes(self,offset,word,forceNBO=True):
+ """ Writes the 4 byte word at data[offset]
+
+ Use network byte order if forceNBO is True,
+ else it's assumed that word is already in NBO
+
+ """
+ # @todo Verify byte order
+ #pdb.set_trace()
+ fmt ="L"
+ if forceNBO:
+ fmt = '!' + fmt
+
+ tmp= "%s%s" % (self.data[0:offset],
+ struct.pack(fmt,word & 0xffffffff))
+ if len(self.data) > offset + 4 :
+ tmp += self.data[offset+4:len(self.data)]
+ self.data=tmp
+
+ def _set_6bytes(self,offset,byte_list):
+ """ Writes the 6 byte sequence in the given order to data[offset] """
+ # @todo Do as a slice
+ tmp= self.data[0:offset]
+ tmp += struct.pack("BBBBBB", *byte_list)
+ if len(self.data) > offset + 6 :
+ tmp += self.data[offset+6:len(self.data)]
+ self.data=tmp
+
+ def _update_l4_checksum(self):
+ """ Recalculate the L4 checksum, if there
+
+ Can be safely called on non-tcp/non-udp packets as a NOOP
+ """
+ if (self.ip_header_offset is None or
+ self.tcp_header_offset is None):
+ return
+ if self.match.nw_proto == socket.IPPROTO_TCP:
+ return self._update_tcp_checksum()
+ elif self.match.nw_proto == socket.IPPROTO_UDP:
+ return self._update_udp_checksum()
+
+ def _update_tcp_checksum(self):
+ """ Recalculate the TCP checksum
+
+ @warning: Must only be called on actual TCP Packets
+ """
+ #@todo implemnt tcp checksum update
+ pass
+
+ def _update_udp_checksum(self):
+ """ Recalculate the TCP checksum
+
+ @warning: Must only be called on actual TCP Packets
+ """
+ #@todo implemnt udp checksum update
+ pass
+
+ def set_metadata(self, value, mask):
+ self.match.metadata = (self.match.metadata & ~mask) | \
+ (value & mask)
+
+ #
+ # These are the main action operations that take the
+ # required parameters
+ #
+ # Note that 'group', 'experimenter' and 'set_output' are only
+ # implemented for the action versions.
+
+ def set_queue(self, queue_id):
+ self.queue_id = queue_id
+
+ def set_vlan_vid(self, vid):
+ # @todo Verify proper location of VLAN id
+ if self.vlan_tag_offset is None:
+ self.logger.debug("set_vlan_vid(): Adding new vlan tag to untagged packet")
+ self.push_vlan(ETHERTYPE_VLAN)
+ offset = self.vlan_tag_offset + 2
+ short = struct.unpack('!H', self.data[offset:offset+2])[0]
+ short = (short & 0xf000) | ((vid & 0x0fff) )
+ self.data = self.data[0:offset] + struct.pack('!H',short) + \
+ self.data[offset+2:len(self.data)]
+ self.match.dl_vlan = vid & 0x0fff
+ self.logger.debug("set_vlan_vid(): setting packet vlan_vid to 0x%x " %
+ self.match.dl_vlan)
+
+ def set_vlan_pcp(self, pcp):
+ # @todo Verify proper location of VLAN pcp
+ if self.vlan_tag_offset is None:
+ return
+ offset = self.vlan_tag_offset + 2
+ short = struct.unpack('!H', self.data[offset:offset+2])[0]
+ short = (pcp<<13 & 0xf000) | ((short & 0x0fff) )
+ self.data = self.data[0:offset] + struct.pack('!H',short) + \
+ self.data[offset+2:len(self.data)]
+ self.match.dl_vlan_pcp = pcp & 0xf
+
+ def set_dl_src(self, dl_src):
+ self._set_6bytes(6, dl_src)
+ self.match.dl_src = dl_src
+
+ def set_dl_dst(self, dl_dst):
+ self._set_6bytes(0, dl_dst)
+ self.match.dl_dst = dl_dst
+
+ def set_nw_src(self, nw_src):
+ if self.ip_header_offset is None:
+ return
+ self._set_4bytes(self.ip_header_offset + 12, nw_src)
+ self._update_l4_checksum()
+ self.match.nw_src = nw_src
+
+ def set_nw_dst(self, nw_dst):
+ # @todo Verify byte order
+ if self.ip_header_offset is None:
+ return
+ self._set_4bytes(self.ip_header_offset + 16, nw_dst)
+ self._update_l4_checksum()
+ self.match.nw_dst = nw_dst
+
+ def set_nw_tos(self, tos):
+ if self.ip_header_offset is None:
+ return
+ self._set_1bytes(self.ip_header_offset + 1, tos)
+ self.match.nw_tos = tos
+
+ def set_nw_ecn(self, ecn):
+ #@todo look up ecn implementation details
+ pass
+
+ def set_tp_src(self, tp_src):
+ if self.tcp_header_offset is None:
+ return
+ if (self.match.nw_proto == socket.IPPROTO_TCP or
+ self.match.nw_proto == socket.IPPROTO_UDP):
+ self._set_2bytes(self.tcp_header_offset, tp_src)
+ elif (self.match.nw_proto == socket.IPPROTO_ICMP):
+ self._set_1bytes(self.tcp_header_offset, tp_src)
+ self._update_l4_checksum()
+ self.match.tp_src = tp_src
+
+ def set_tp_dst(self, tp_dst):
+ if self.tcp_header_offset is None:
+ return
+ if (self.match.nw_proto == socket.IPPROTO_TCP or
+ self.match.nw_proto == socket.IPPROTO_UDP):
+ self._set_2bytes(self.tcp_header_offset +2, tp_dst)
+ elif (self.match.nw_proto == socket.IPPROTO_ICMP):
+ self._set_1bytes(self.tcp_header_offset + 1, tp_dst)
+ self._update_l4_checksum()
+ self.match.tp_dst = tp_dst
+
+ IP_OFFSET_TTL = 8
+
+ def copy_ttl_out(self):
+ if self.mpls_tag_offset is None:
+ # No MPLS tag.
+ return
+ outerTag = struct.unpack("!I", self.data[self.mpls_tag_offset:
+ self.mpls_tag_offset+4])[0]
+ if not (outerTag & MPLS_BOTTOM_OF_STACK):
+ # Payload is another MPLS tag:
+ innerTag = struct.unpack("!I", self.data[self.mpls_tag_offset+4:
+ self.mpls_tag_offset+8])[0]
+ outerTag = (outerTag & 0xFFFFFF00) | (innerTag & 0x000000FF)
+ self._set_4bytes(self.mpls_tag_offset, outerTag)
+ else:
+ # This MPLS tag is the bottom of the stack.
+ # See if the payload looks like it might be IPv4.
+ versionLen = struct.unpack("B",
+ self.data[self.mpls_tag_offset+4])[0]
+ if versionLen >> 4 != 4:
+ # This is not IPv4.
+ return;
+ # This looks like IPv4, so copy the TTL.
+ ipTTL = struct.unpack("B", self.data[self.mpls_tag_offset + 4 +
+ Packet.IP_OFFSET_TTL])[0]
+ outerTag = (outerTag & 0xFFFFFF00) | (ipTTL & 0xFF)
+ self._set_4bytes(self.mpls_tag_offset, outerTag)
+ return
+
+ def copy_ttl_in(self):
+ if self.mpls_tag_offset is None:
+ # No MPLS tag.
+ return
+ outerTag = struct.unpack("!I", self.data[self.mpls_tag_offset:
+ self.mpls_tag_offset+4])[0]
+ if not (outerTag & MPLS_BOTTOM_OF_STACK):
+ # Payload is another MPLS tag:
+ innerTag = struct.unpack("!I", self.data[self.mpls_tag_offset+4:
+ self.mpls_tag_offset+8])[0]
+ innerTag = (innerTag & 0xFFFFFF00) | (outerTag & 0x000000FF)
+ self._set_4bytes(self.mpls_tag_offset+4, innerTag)
+ else:
+ # This MPLS tag is the bottom of the stack.
+ # See if the payload looks like it might be IPv4.
+ versionLen = struct.unpack("B", self.data[self.mpls_tag_offset+4])[0]
+ if versionLen >> 4 != 4:
+ # This is not IPv4.
+ return;
+ # This looks like IPv4, so copy the TTL.
+ self._set_1bytes(self.mpls_tag_offset + 4 + Packet.IP_OFFSET_TTL,
+ outerTag & 0x000000FF)
+ #@todo update checksum
+ return
+
+ def set_mpls_label(self, mpls_label):
+ if self.mpls_tag_offset is None:
+ return
+ tag = struct.unpack("!I", self.data[self.mpls_tag_offset:
+ self.mpls_tag_offset+4])[0]
+ tag = ((mpls_label & 0xfffff) << 12) | (tag & 0x00000fff)
+ self.match.mpls_label = mpls_label
+ self._set_4bytes(self.mpls_tag_offset, tag)
+
+ def set_mpls_tc(self, mpls_tc):
+ if self.mpls_tag_offset is None:
+ return
+ tag = struct.unpack("!I", self.data[self.mpls_tag_offset:
+ self.mpls_tag_offset+4])[0]
+ tag = ((mpls_tc & 0x7) << 9) | (tag & 0xfffff1ff)
+ self.match.mpls_tc = mpls_tc
+ self._set_4bytes(self.mpls_tag_offset, tag)
+
+ def set_mpls_ttl(self, ttl):
+ if self.mpls_tag_offset is None:
+ return
+ self._set_1bytes(self.mpls_tag_offset + 3, ttl)
+
+ def dec_mpls_ttl(self):
+ if self.mpls_tag_offset is None:
+ return
+ ttl = struct.unpack("B", self.data[self.mpls_tag_offset + 3])[0]
+ self.set_mpls_ttl(ttl - 1)
+
+ def push_vlan(self, ethertype):
+ if len(self) < 14:
+ self.logger.error("NOT Pushing a new VLAN tag: packet too short!")
+ pass # invalid ethernet frame, can't add vlan tag
+
+ # from 4.8.1 of the spec, default values are zero
+ # on a push operation if no VLAN tag already exists
+ l2_type = struct.unpack("!H", self.data[12:14])[0]
+ if ((l2_type == ETHERTYPE_VLAN) or (l2_type == ETHERTYPE_VLAN_QinQ)):
+ current_tag = struct.unpack("!H", self.data[14:16])[0]
+ else:
+ current_tag = 0
+ new_tag = struct.pack('!HH',
+ # one of 0x8100 or x88a8
+ # could check to enforce this?
+ ethertype & 0xffff,
+ current_tag
+ )
+ self.data = self.data[0:12] + new_tag + self.data[12:len(self.data)]
+ self.parse()
+
+ def pop_vlan(self):
+ if self.vlan_tag_offset is None:
+ pass
+ self.data = self.data[0:12] + self.data[16:len(self.data)]
+ self.parse()
+
+ def push_mpls(self, ethertype):
+ tag = MplsTag(0, 0, 0)
+ bos = False
+
+ if self.mpls_tag_offset:
+ # The new tag defaults to the old one.
+ packed_tag = struct.unpack("!I", self.data[self.mpls_tag_offset:
+ self.mpls_tag_offset+4])[0]
+ (tag, _) = MplsTag.unpack(packed_tag)
+
+ else:
+ # Pushing a new label stack, set the BoS bit and get TTL from IP.
+ bos = True
+ if self.ip_header_offset:
+ ttl = struct.unpack("B", self.data[self.ip_header_offset + \
+ Packet.IP_OFFSET_TTL])[0]
+ tag = MplsTag(0, 0, ttl)
+
+ self.data = self.data[0:14] + \
+ struct.pack("!I", tag.pack(bos)) + \
+ self.data[14:]
+ self._set_2bytes(12, ethertype)
+ # Reparse to update offsets, ethertype, etc.
+ self.parse()
+
+ def pop_mpls(self, ethertype):
+ # Ignore if no existing tags.
+ if self.mpls_tag_offset:
+ self.data = self.data[0:self.mpls_tag_offset] + \
+ self.data[self.mpls_tag_offset + 4:]
+ self._set_2bytes(12, ethertype)
+
+ # Reparse to update offsets, ethertype, etc.
+ self.parse()
+
+ def set_nw_ttl(self, ttl):
+ if self.ip_header_offset is None:
+ return
+ self._set_1bytes(self.ip_header_offset + Packet.IP_OFFSET_TTL, ttl)
+ self._update_l4_checksum()
+ # don't need to update self.match; no ttl in it
+
+ def dec_nw_ttl(self):
+ if self.ip_header_offset is None:
+ return
+ offset = self.ip_header_offset + Packet.IP_OFFSET_TTL
+ old_ttl = struct.unpack("b",self.data[offset:offset + 1])[0]
+ self.set_nw_ttl( old_ttl - 1)
+
+ #
+ # All action functions need to take the action object for params
+ # These take an action object to facilitate the switch implementation
+ #
+
+ def action_output(self, action, switch):
+ if action.port < ofp.OFPP_MAX:
+ switch.dataplane.send(action.port, self.data,
+ queue_id=self.queue_id)
+ elif action.port == ofp.OFPP_ALL:
+ for of_port in switch.ports.iterkeys():
+ if of_port != self.in_port:
+ switch.dataplane.send(of_port, self.data,
+ queue_id=self.queue_id)
+ elif action.port == ofp.OFPP_IN_PORT:
+ switch.dataplane.send(self.in_port, self.data,
+ queue_id=self.queue_id)
+ else:
+ switch.logger.error("NEED to implement action_output" +
+ " for port %d" % action.port)
+
+ def action_set_queue(self, action, switch):
+ self.set_queue(action.queue_id)
+
+ def action_set_vlan_vid(self, action, switch):
+ self.set_vlan_vid(action.vlan_vid)
+
+ def action_set_vlan_pcp(self, action, switch):
+ self.set_vlan_pcp(action.vlan_pcp)
+
+ def action_set_dl_src(self, action, switch):
+ self.set_dl_src(action.dl_addr)
+
+ def action_set_dl_dst(self, action, switch):
+ self.set_dl_dst(action.dl_addr)
+
+ def action_set_nw_src(self, action, switch):
+ self.set_nw_src(action.nw_addr)
+
+ def action_set_nw_dst(self, action, switch):
+ self.set_nw_dst(action.nw_addr)
+
+ def action_set_nw_tos(self, action, switch):
+ self.set_nw_tos(action.nw_tos)
+
+ def action_set_nw_ecn(self, action, switch):
+ self.set_nw_ecn(action.nw_ecn)
+
+ def action_set_tp_src(self, action, switch):
+ self.set_tp_src(action.tp_port)
+
+ def action_set_tp_dst(self, action, switch):
+ self.set_tp_dst(action.tp_port)
+
+ def action_copy_ttl_out(self, action, switch):
+ self.copy_ttl_out()
+
+ def action_copy_ttl_in(self, action, switch):
+ self.copy_ttl_in()
+
+ def action_set_mpls_label(self, action, switch):
+ self.set_mpls_label(action.mpls_label)
+
+ def action_set_mpls_tc(self, action, switch):
+ self.set_mpls_tc(action.mpls_tc)
+
+ def action_set_mpls_ttl(self, action, switch):
+ self.set_mpls_ttl(action.mpls_ttl)
+
+ def action_dec_mpls_ttl(self, action, switch):
+ self.dec_mpls_ttl()
+
+ def action_push_vlan(self, action, switch):
+ self.push_vlan(action.ethertype)
+
+ def action_pop_vlan(self, action, switch):
+ self.pop_vlan()
+
+ def action_push_mpls(self, action, switch):
+ self.push_mpls(action.ethertype)
+
+ def action_pop_mpls(self, action, switch):
+ self.pop_mpls(action.ethertype)
+
+ def action_experimenter(self, action, switch):
+ pass
+
+ def action_set_nw_ttl(self, action, switch):
+ self.set_nw_ttl(action.nw_ttl)
+
+ def action_dec_nw_ttl(self, action, switch):
+ self.dec_nw_ttl()
+
+ def action_group(self, action, switch):
+ pass
+
+ def execute_action_set(self, switch):
+ """
+ Execute the actions in the action set for the packet
+ according to the order given in ordered_action_list.
+
+ This determines the order in which
+ actions in the packet's action set are executed
+
+ @param switch The parent switch object (for sending pkts out)
+
+ @todo Verify the ordering in this list
+ """
+ cls = action.action_copy_ttl_in
+ if cls in self.action_set.keys():
+ self.logger.debug("Action copy_ttl_in")
+ self.action_copy_ttl_in(self.action_set[cls], switch)
+
+ cls = action.action_pop_mpls
+ if cls in self.action_set.keys():
+ self.logger.debug("Action pop_mpls")
+ self.action_pop_mpls(self.action_set[cls], switch)
+ cls = action.action_pop_vlan
+ if cls in self.action_set.keys():
+ self.logger.debug("Action pop_vlan")
+ self.action_pop_vlan(self.action_set[cls], switch)
+ cls = action.action_push_mpls
+ if cls in self.action_set.keys():
+ self.logger.debug("Action push_mpls")
+ self.action_push_mpls(self.action_set[cls], switch)
+ cls = action.action_push_vlan
+ if cls in self.action_set.keys():
+ self.logger.debug("Action push_vlan")
+ self.action_push_vlan(self.action_set[cls], switch)
+
+ cls = action.action_dec_mpls_ttl
+ if cls in self.action_set.keys():
+ self.logger.debug("Action dec_mpls_ttl")
+ self.action_dec_mpls_ttl(self.action_set[cls], switch)
+ cls = action.action_dec_nw_ttl
+ if cls in self.action_set.keys():
+ self.logger.debug("Action dec_nw_ttl")
+ self.action_dec_nw_ttl(self.action_set[cls], switch)
+ cls = action.action_copy_ttl_out
+ if cls in self.action_set.keys():
+ self.logger.debug("Action copy_ttl_out")
+ self.action_copy_ttl_out(self.action_set[cls], switch)
+
+ cls = action.action_set_dl_dst
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_dl_dst")
+ self.action_set_dl_dst(self.action_set[cls], switch)
+ cls = action.action_set_dl_src
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_dl_src")
+ self.action_set_dl_src(self.action_set[cls], switch)
+ cls = action.action_set_mpls_label
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_mpls_label")
+ self.action_set_mpls_label(self.action_set[cls], switch)
+ cls = action.action_set_mpls_tc
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_mpls_tc")
+ self.action_set_mpls_tc(self.action_set[cls], switch)
+ cls = action.action_set_mpls_ttl
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_mpls_ttl")
+ self.action_set_mpls_ttl(self.action_set[cls], switch)
+ cls = action.action_set_nw_dst
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_nw_dst")
+ self.action_set_nw_dst(self.action_set[cls], switch)
+ cls = action.action_set_nw_ecn
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_nw_ecn")
+ self.action_set_nw_ecn(self.action_set[cls], switch)
+ cls = action.action_set_nw_src
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_nw_src")
+ self.action_set_nw_src(self.action_set[cls], switch)
+ cls = action.action_set_nw_tos
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_nw_tos")
+ self.action_set_nw_tos(self.action_set[cls], switch)
+ cls = action.action_set_nw_ttl
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_nw_ttl")
+ self.action_set_nw_ttl(self.action_set[cls], switch)
+ cls = action.action_set_queue
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_queue")
+ self.action_set_queue(self.action_set[cls], switch)
+ cls = action.action_set_tp_dst
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_tp_dst")
+ self.action_set_tp_dst(self.action_set[cls], switch)
+ cls = action.action_set_tp_src
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_tp_src")
+ self.action_set_tp_src(self.action_set[cls], switch)
+ cls = action.action_set_vlan_pcp
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_vlan_pcp")
+ self.action_set_vlan_pcp(self.action_set[cls], switch)
+ cls = action.action_set_vlan_vid
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_vlan_vid")
+ self.action_set_vlan_vid(self.action_set[cls], switch)
+
+ cls = action.action_group
+ if cls in self.action_set.keys():
+ self.logger.debug("Action group")
+ self.action_group(self.action_set[cls], switch)
+ cls = action.action_experimenter
+ if cls in self.action_set.keys():
+ self.logger.debug("Action experimenter")
+ self.action_experimenter(self.action_set[cls], switch)
+ cls = action.action_output
+ if cls in self.action_set.keys():
+ self.logger.debug("Action set_output")
+ self.action_output(self.action_set[cls], switch)
+
+
+def ascii_ip_to_bin(ip):
+ """ Take '192.168.0.1' and return the NBO decimal equivalent 0xc0a80101 """
+ #Lookup the cleaner, one-line way of doing this
+ # or if there isn't just a library (!?)
+ s = ip.split('.')
+ return struct.unpack("!L", struct.pack("BBBB", int(s[0]),
+ int(s[1]),
+ int(s[2]),
+ int(s[3]) ))[0]
+
+
+class parse_error(Exception):
+ """
+ Thrown internally if there is an error in packet parsing
+ """
+
+ def __init__(self, why):
+ self.why = why
+
+ def __str__(self):
+ return "%s:: %s" % (super.__str__(self), self.why)
+
+class packet_test(unittest.TestCase):
+ """
+ Unit tests for packet class
+ """
+
+ def ascii_to_data(self, str):
+ return binascii.unhexlify(str.translate(string.maketrans('',''),
+ string.whitespace))
+
+ def setUp(self):
+ """
+ Simple packet data for parsing tests.
+
+ Ethernet II, Src: Fujitsu_ef:cd:8d (00:17:42:ef:cd:8d),
+ Dst: ZhsZeitm_5d:24:00 (00:d0:05:5d:24:00)
+ Internet Protocol, Src: 172.24.74.96 (172.24.74.96),
+ Dst: 171.64.74.58 (171.64.74.58)
+ Transmission Control Protocol, Src Port: 59581 (59581),
+ Dst Port: ssh (22), Seq: 2694, Ack: 2749, Len: 48
+ """
+ pktdata = self.ascii_to_data(
+ """00 d0 05 5d 24 00 00 17 42 ef cd 8d 08 00 45 10
+ 00 64 65 67 40 00 40 06 e9 29 ac 18 4a 60 ab 40
+ 4a 3a e8 bd 00 16 7c 28 2f 88 f2 bd 7a 03 80 18
+ 00 b5 ec 49 00 00 01 01 08 0a 00 d1 46 8b 32 ed
+ 7c 88 78 4b 8a dc 0a 1f c4 d3 02 a3 ae 1d 3c aa
+ 6f 1a 36 9f 27 11 12 71 5b 5d 88 f2 97 fa e7 f9
+ 99 c1 9f 9c 7f c5 1e 3e 45 c6 a6 ac ec 0b 87 64
+ 98 dd""")
+ self.pkt = Packet(data=pktdata)
+
+ """
+ MPLS packet data for MPLS parsing tests.
+
+ Ethernet II, Src: Fujitsu_ef:cd:8d (00:17:42:ef:cd:8d),
+ Dst: ZhsZeitm_5d:24:00 (00:d0:05:5d:24:00)
+ MPLS, Label: 0xFEFEF, TC: 5, S: 1, TTL: 0xAA
+ Internet Protocol, Src: 172.24.74.96 (172.24.74.96),
+ Dst: 171.64.74.58 (171.64.74.58)
+ Transmission Control Protocol, Src Port: 59581 (59581),
+ Dst Port: ssh (22), Seq: 2694, Ack: 2749, Len: 48
+ """
+ mplspktdata = self.ascii_to_data(
+ """00 d0 05 5d 24 00 00 17 42 ef cd 8d 88 47
+ FE FE FB AA
+ 45 10 00 64 65 67 40 00 40 06 e9 29 ac 18 4a 60
+ ab 40 4a 3a
+ e8 bd 00 16 7c 28 2f 88 f2 bd 7a 03 80 18
+ 00 b5 ec 49 00 00 01 01 08 0a 00 d1 46 8b 32 ed
+ 7c 88 78 4b 8a dc 0a 1f c4 d3 02 a3 ae 1d 3c aa
+ 6f 1a 36 9f 27 11 12 71 5b 5d 88 f2 97 fa e7 f9
+ 99 c1 9f 9c 7f c5 1e 3e 45 c6 a6 ac ec 0b 87 64
+ 98 dd""")
+ self.mplspkt = Packet(data=mplspktdata)
+
+ def runTest(self):
+ self.assertTrue(self.pkt)
+
+class l2_parsing_test(packet_test):
+ def runTest(self):
+ match = self.pkt.match
+ self.assertEqual(match.dl_dst,[0x00,0xd0,0x05,0x5d,0x24,0x00])
+ self.assertEqual(match.dl_src,[0x00,0x17,0x42,0xef,0xcd,0x8d])
+ self.assertEqual(match.dl_type,ETHERTYPE_IP)
+
+class mpls_parsing_test(packet_test):
+ def runTest(self):
+ match = self.mplspkt.match
+ self.assertEqual(match.mpls_label, 0xFEFEF)
+ self.assertEqual(match.mpls_tc, 5)
+
+class ip_parsing_test(packet_test):
+ def runTest(self):
+ match = self.pkt.match
+ # @todo Verify byte ordering of the following
+ self.assertEqual(match.nw_dst,ascii_ip_to_bin('171.64.74.58'))
+ self.assertEqual(match.nw_src,ascii_ip_to_bin('172.24.74.96'))
+ self.assertEqual(match.nw_proto, socket.IPPROTO_TCP)
+
+class mpls_setting_test(packet_test):
+ def runTest(self):
+ orig_len = len(self.mplspkt)
+ label = 0x12345
+ tc = 6
+ ttl = 0x78
+ self.mplspkt.set_mpls_label(label)
+ self.mplspkt.set_mpls_tc(tc)
+ self.mplspkt.set_mpls_ttl(ttl)
+ self.mplspkt.dec_mpls_ttl()
+ self.mplspkt.parse()
+
+ self.assertEqual(len(self.mplspkt), orig_len)
+ self.assertTrue(self.mplspkt.mpls_tag_offset)
+ match = self.mplspkt.match
+
+ self.assertEqual(match.mpls_label, label)
+ self.assertEqual(match.mpls_tc, tc)
+ new_ttl = struct.unpack("B", self.mplspkt.data[self.mplspkt.mpls_tag_offset + 3:
+ self.mplspkt.mpls_tag_offset + 4])[0]
+ self.assertEqual(new_ttl, ttl - 1)
+
+class mpls_pop_test(packet_test):
+ def runTest(self):
+ orig_len = len(self.mplspkt)
+ self.mplspkt.pop_mpls(ETHERTYPE_IP)
+ self.mplspkt.parse()
+
+ self.assertEqual(len(self.mplspkt), orig_len - 4)
+ self.assertFalse(self.mplspkt.mpls_tag_offset)
+ match = self.mplspkt.match
+
+ self.assertEqual(match.dl_type,ETHERTYPE_IP)
+ self.assertEqual(match.nw_dst,ascii_ip_to_bin('171.64.74.58'))
+ self.assertEqual(match.nw_src,ascii_ip_to_bin('172.24.74.96'))
+ self.assertEqual(match.nw_proto, socket.IPPROTO_TCP)
+
+class mpls_push_test(packet_test):
+ def runTest(self):
+ orig_len = len(self.pkt)
+ self.pkt.push_mpls(ETHERTYPE_MPLS)
+ self.pkt.parse()
+
+ self.assertEqual(len(self.pkt), orig_len + 4)
+ self.assertTrue(self.pkt.mpls_tag_offset)
+ match = self.pkt.match
+
+ self.assertEqual(match.dl_type, ETHERTYPE_MPLS)
+ self.assertEqual(match.mpls_label, 0)
+ self.assertEqual(match.mpls_tc, 0)
+
+class ip_setting_test(packet_test):
+ def runTest(self):
+ orig_len = len(self.pkt)
+ ip1 = '11.22.33.44'
+ ip2 = '55.66.77.88'
+ self.pkt.set_nw_src(ascii_ip_to_bin(ip1))
+ self.pkt.set_nw_dst(ascii_ip_to_bin(ip2))
+ self.pkt.parse()
+ self.assertEqual(len(self.pkt), orig_len)
+ match = self.pkt.match
+
+ # @todo Verify byte ordering of the following
+ self.assertEqual(match.nw_src,ascii_ip_to_bin(ip1))
+ self.assertEqual(match.nw_dst,ascii_ip_to_bin(ip2))
+
+
+
+
+class l4_parsing_test(packet_test):
+ def runTest(self):
+ match = self.pkt.match
+ self.assertEqual(match.tp_dst,22)
+ self.assertEqual(match.tp_src,59581)
+
+class l4_setting_test(packet_test):
+ def runTest(self):
+ orig_len = len(self.pkt)
+ self.pkt.set_tp_src(777)
+ self.pkt.set_tp_dst(666)
+ self.pkt.parse()
+ self.assertEqual(len(self.pkt), orig_len)
+ match = self.pkt.match
+ self.assertEqual(match.tp_src,777)
+ self.assertEqual(match.tp_dst,666)
+
+class simple_tcp_test(unittest.TestCase):
+ """ Make sure that simple_tcp_test does what it should
+ pktlen=100,
+ dl_dst='00:01:02:03:04:05',
+ dl_src='00:06:07:08:09:0a',
+ dl_vlan_enable=False,
+ dl_vlan=0,
+ dl_vlan_pcp=0,
+ dl_vlan_cfi=0,
+ ip_src='192.168.0.1',
+ ip_dst='192.168.0.2',
+ ip_tos=0,
+ tcp_sport=1234,
+ tcp_dport=80):
+ """
+ def setUp(self):
+ self.pkt = Packet().simple_tcp_packet()
+ self.pkt.parse()
+ logging.basicConfig(filename="", level=logging.DEBUG)
+ self.logger = logging.getLogger('unittest')
+
+ def runTest(self):
+ match = self.pkt.match
+ self.assertEqual(match.dl_dst, [0x00, 0x01, 0x02, 0x03, 0x04, 0x05])
+ self.assertEqual(match.dl_src, [0x00, 0x06, 0x07, 0x08, 0x09, 0x0a])
+ self.assertEqual(match.dl_type, ETHERTYPE_IP)
+ self.assertEqual(match.nw_src, ascii_ip_to_bin('192.168.0.1'))
+ self.assertEqual(match.nw_dst, ascii_ip_to_bin('192.168.0.2'))
+ self.assertEqual(match.tp_dst, 80)
+ self.assertEqual(match.tp_src, 1234)
+
+class simple_vlan_test(simple_tcp_test):
+ """ Make sure that simple_tcp_test does what it should with vlans
+
+ """
+
+ def runTest(self):
+ self.pkt = Packet().simple_tcp_packet(dl_vlan_enable=True,dl_vlan=0x0abc)
+ self.pkt.parse()
+ match = self.pkt.match
+ #self.logger.debug("Packet=\n%s" % self.pkt.show())
+ self.assertEqual(match.dl_dst, [0x00, 0x01, 0x02, 0x03, 0x04, 0x05])
+ self.assertEqual(match.dl_src, [0x00, 0x06, 0x07, 0x08, 0x09, 0x0a])
+ self.assertEqual(match.dl_type, ETHERTYPE_IP)
+ self.assertEqual(match.nw_src, ascii_ip_to_bin('192.168.0.1'))
+ self.assertEqual(match.nw_dst, ascii_ip_to_bin('192.168.0.2'))
+ self.assertEqual(match.tp_dst, 80)
+ self.assertEqual(match.tp_src, 1234)
+ self.assertEqual(match.dl_vlan, 0xabc)
+
+class vlan_mod(simple_tcp_test):
+ """ Start with a packet with no vlan, add one, change it, remove it"""
+ def runTest(self):
+ old_len = len(self.pkt)
+ match = self.pkt.match
+ self.assertEqual(match.dl_vlan, 0xffff)
+ self.assertEqual(len(self.pkt), old_len)
+ #self.logger.debug("PKT=\n" + self.pkt.show())
+ self.pkt.push_vlan(ETHERTYPE_VLAN) # implicitly pushes vid=0
+ self.assertEqual(len(self.pkt), old_len + 4)
+ self.assertEqual(match.dl_vlan, 0)
+ #self.logger.debug("PKT=\n" + self.pkt.show())
+ self.assertEqual(match.dl_type,ETHERTYPE_IP)
+ self.pkt.set_vlan_vid(0xbabe)
+ self.assertEqual(match.dl_vlan, 0x0abe)
+
+class simple_tcp_with_mpls_test(unittest.TestCase):
+ """ Make sure that simple_tcp_packet does what it should
+ pktlen=100,
+ dl_dst='00:01:02:03:04:05',
+ dl_src='00:06:07:08:09:0a',
+ dl_vlan_enable=False,
+ dl_vlan=0,
+ dl_vlan_pcp=0,
+ dl_vlan_cfi=0,
+ ip_src='192.168.0.1',
+ ip_dst='192.168.0.2',
+ ip_tos=0,
+ tcp_sport=1234,
+ tcp_dport=80):
+ """
+ def setUp(self):
+ tag1 = MplsTag(0xabcde, 0x5, 0xAA)
+ tag2 = MplsTag(0x54321, 0x2, 0xBB)
+ mpls_tags = (tag1, tag2)
+
+ self.pkt = Packet().simple_tcp_packet(mpls_type=ETHERTYPE_MPLS,
+ mpls_tags=mpls_tags)
+ self.pkt.parse()
+
+ def runTest(self):
+ match = self.pkt.match
+ self.assertEqual(match.dl_dst, [0x00, 0x01, 0x02, 0x03, 0x04, 0x05])
+ self.assertEqual(match.dl_src, [0x00, 0x06, 0x07, 0x08, 0x09, 0x0a])
+ self.assertEqual(match.dl_type, ETHERTYPE_MPLS)
+ self.assertEqual(match.mpls_label, 0xabcde)
+ self.assertEqual(match.mpls_tc, 0x5)
+
+if __name__ == '__main__':
+ print("Running packet tests\n")
+ unittest.main()
+
diff --git a/Fabric/Utilities/src/python/oftest/oft12/testutils.py b/Fabric/Utilities/src/python/oftest/oft12/testutils.py
new file mode 100644
index 0000000..3ce2e75
--- /dev/null
+++ b/Fabric/Utilities/src/python/oftest/oft12/testutils.py
@@ -0,0 +1,1518 @@
+
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+
+
+import sys
+import logging
+from cStringIO import StringIO
+#import types
+
+import ofp
+import oftest.parse as parse
+from packet import Packet
+
+try:
+ logging.getLogger("scapy.runtime").setLevel(logging.ERROR)
+ from scapy.all import *
+ from oftest.mpls import *
+except ImportError:
+ sys.exit("Need to install scapy for packet parsing")
+
+global skipped_test_count
+skipped_test_count = 0
+
+# Some useful defines
+IP_ETHERTYPE = 0x800
+IPV6_ETHERTYPE = 0x86dd
+ETHERTYPE_VLAN = 0x8100
+ETHERTYPE_MPLS = 0x8847
+TCP_PROTOCOL = 0x6
+UDP_PROTOCOL = 0x11
+ICMPV6_PROTOCOL = 0x3a
+
+
+
+def clear_switch(parent, port_list, logger):
+ """
+ Clear the switch configuration
+
+ @param parent Object implementing controller and assert equal
+ @param logger Logging object
+ """
+ parent.assertTrue(len(port_list) > 2, "Not enough ports for test")
+ for port in port_list:
+ clear_port_config(parent, port, logger)
+ initialize_table_config(parent.controller, logger)
+ delete_all_flows(parent.controller, logger)
+ delete_all_groups(parent.controller, logger)
+
+ return port_list
+
+def initialize_table_config(ctrl, logger):
+ """
+ Initialize all table configs to default setting ("CONTROLLER")
+ @param ctrl The controller object for the test
+ """
+ logger.info("Initializing all table configs")
+ request = ofp.message.table_mod()
+ request.config = ofp.OFPTC_TABLE_MISS_CONTROLLER
+ rv = 0
+ for table_id in [0, 1, 2, 3, 4, 5, 6, 7]:
+ request.table_id = table_id
+ rv |= ctrl.message_send(request)
+ return rv
+
+def delete_all_flows(ctrl, logger):
+ """
+ Delete all flows on the switch
+ @param ctrl The controller object for the test
+ @param logger Logging object
+ """
+
+ logger.info("Deleting all flows")
+ #DEFAULT_TABLE_COUNT = 4
+ return delete_all_flows_one_table(ctrl, logger, table_id=0xff)
+
+def delete_all_flows_one_table(ctrl, logger, table_id=0):
+ """
+ Delete all flows on a table
+ @param ctrl The controller object for the test
+ @param logger Logging object
+ @param table_id Table ID
+ """
+ logger.info("Deleting all flows on table ID: " + str(table_id))
+ msg = ofp.message.flow_delete()
+ msg.out_port = ofp.OFPP_ANY
+ msg.out_group = ofp.OFPG_ANY
+ msg.buffer_id = 0xffffffff
+ msg.table_id = table_id
+ logger.debug(msg.show())
+
+ return ctrl.message_send(msg)
+
+def delete_all_groups(ctrl, logger):
+ """
+ Delete all groups on the switch
+ @param ctrl The controller object for the test
+ @param logger Logging object
+ """
+
+ logger.info("Deleting all groups")
+ msg = ofp.message.group_mod()
+ msg.group_id = ofp.OFPG_ALL
+ msg.command = ofp.OFPGC_DELETE
+ logger.debug(msg.show())
+ return ctrl.message_send(msg)
+
+def clear_port_config(parent, port, logger):
+ """
+ Clear the port configuration
+
+ @param parent Object implementing controller and assert equal
+ @param logger Logging object
+ """
+ rv = port_config_set(parent.controller, port,
+ 0, 0, logger)
+ parent.assertEqual(rv, 0, "Failed to reset port config")
+
+def simple_tcp_packet(dl_dst='00:01:02:03:04:05',
+ dl_src='00:06:07:08:09:0a',
+ vlan_tags=[], # {type,vid,pcp,cfi} TODO type
+ mpls_tags=[], # {type,label,tc,ttl} TODO type
+ ip_src='192.168.0.1',
+ ip_dst='192.168.0.2',
+ ip_tos=0,
+ ip_ttl=64,
+ tcp_sport=1234,
+ tcp_dport=80,
+ payload_len = 46):
+ pkt = Ether(dst=dl_dst, src=dl_src)
+
+ vlans_num = 0
+ while len(vlan_tags):
+ tag = vlan_tags.pop(0)
+ dot1q = Dot1Q()
+ if 'vid' in tag:
+ dot1q.vlan = tag['vid']
+ if 'pcp' in tag:
+ dot1q.prio = tag['pcp']
+ if 'cfi' in tag:
+ dot1q.id = tag['cfi']
+ pkt = pkt / dot1q
+ if 'type' in tag:
+ if vlans_num == 0:
+ pkt[Ether].setfieldval('type', tag['type'])
+ else:
+ pkt[Dot1Q:vlans_num].setfieldval('type', tag['type'])
+ vlans_num+=1
+
+ mplss_num = 0
+ while len(mpls_tags):
+ tag = mpls_tags.pop(0)
+ mpls = MPLS()
+ if 'label' in tag:
+ mpls.label = tag['label']
+ if 'tc' in tag:
+ mpls.cos = tag['tc']
+ if 'ttl' in tag:
+ mpls.ttl = tag['ttl']
+ pkt = pkt / mpls
+ if 'type' in tag:
+ if mplss_num == 0:
+ if vlans_num == 0:
+ pkt[Ether].setfieldval('type', tag['type'])
+ else:
+ pkt[Dot1Q:vlans_num].setfieldval('type', tag['type'])
+ mplss_num+=1
+
+ pkt = pkt / IP(src=ip_src, dst=ip_dst, tos=ip_tos, ttl=ip_ttl) \
+ / TCP(sport=tcp_sport, dport=tcp_dport)
+
+ pkt = pkt / ("D" * payload_len)
+
+ return pkt
+
+def simple_icmp_packet(dl_dst='00:01:02:03:04:05',
+ dl_src='00:06:07:08:09:0a',
+ vlan_tags=[], # {type,vid,pcp,cfi} TODO type
+ mpls_tags=[], # {type,label,tc,ttl} TODO type
+ ip_src='192.168.0.1',
+ ip_dst='192.168.0.2',
+ ip_tos=0,
+ ip_ttl=64,
+ icmp_type=8, # ICMP_ECHO_REQUEST
+ icmp_code=0,
+ payload_len=0):
+
+ #TODO simple_ip_packet
+ pkt = Ether(dst=dl_dst, src=dl_src)
+
+ vlans_num = 0
+ while len(vlan_tags):
+ tag = vlan_tags.pop(0)
+ dot1q = Dot1Q()
+ if 'vid' in tag:
+ dot1q.vlan = tag['vid']
+ if 'pcp' in tag:
+ dot1q.prio = tag['pcp']
+ if 'cfi' in tag:
+ dot1q.id = tag['cfi']
+ pkt = pkt / dot1q
+ if 'type' in tag:
+ if vlans_num == 0:
+ pkt[Ether].setfieldval('type', tag['type'])
+ else:
+ pkt[Dot1Q:vlans_num].setfieldval('type', tag['type'])
+ vlans_num+=1
+
+ mplss_num = 0
+ while len(mpls_tags):
+ tag = mpls_tags.pop(0)
+ mpls = MPLS()
+ if 'label' in tag:
+ mpls.label = tag['label']
+ if 'tc' in tag:
+ mpls.cos = tag['tc']
+ if 'ttl' in tag:
+ mpls.ttl = tag['ttl']
+ pkt = pkt / mpls
+ if 'type' in tag:
+ if mplss_num == 0:
+ if vlans_num == 0:
+ pkt[Ether].setfieldval('type', tag['type'])
+ else:
+ pkt[Dot1Q:vlans_num].setfieldval('type', tag['type'])
+ mplss_num+=1
+
+ pkt = pkt / IP(src=ip_src, dst=ip_dst, tos=ip_tos, ttl=ip_ttl) \
+ / ICMP(type=icmp_type, code=icmp_code)
+
+ pkt = pkt / ("D" * payload_len)
+
+ return pkt
+
+def simple_ipv6_packet(pktlen=100,
+ dl_dst='00:01:02:03:04:05',
+ dl_src='00:06:07:08:09:0a',
+ dl_vlan_enable=False,
+ dl_vlan=0,
+ dl_vlan_pcp=0,
+ dl_vlan_cfi=0,
+ ip_src='fe80::2420:52ff:fe8f:5189',
+ ip_dst='fe80::2420:52ff:fe8f:5190',
+ ip_tos=0,
+ tcp_sport=0,
+ tcp_dport=0,
+ EH = False,
+ EHpkt = IPv6ExtHdrDestOpt()
+ ):
+
+ """
+ Return a simple IPv6 packet
+
+ Supports a few parameters:
+ @param len Length of packet in bytes w/o CRC
+ @param dl_dst Destinatino MAC
+ @param dl_src Source MAC
+ @param dl_vlan_enable True if the packet is with vlan, False otherwise
+ @param dl_vlan VLAN ID
+ @param dl_vlan_pcp VLAN priority
+ @param ip_src IPv6 source
+ @param ip_dst IPv6 destination
+ @param ip_tos IP ToS
+ @param tcp_dport TCP destination port
+ @param ip_sport TCP source port
+
+ """
+ # Note Dot1Q.id is really CFI
+ if (dl_vlan_enable):
+ pkt = Ether(dst=dl_dst, src=dl_src)/ \
+ Dot1Q(prio=dl_vlan_pcp, id=dl_vlan_cfi, vlan=dl_vlan)/ \
+ IPv6(src=ip_src, dst=ip_dst)
+
+ else:
+ pkt = Ether(dst=dl_dst, src=dl_src)/ \
+ IPv6(src=ip_src, dst=ip_dst)
+
+ # Add IPv6 Extension Headers
+ if EH:
+ pkt = pkt / EHpkt
+
+ if (tcp_sport >0 and tcp_dport >0):
+ pkt = pkt / TCP(sport=tcp_sport, dport=tcp_dport)
+
+ if pktlen > len(pkt) :
+ pkt = pkt/("D" * (pktlen - len(pkt)))
+
+ return pkt
+
+def simple_icmpv6_packet(pktlen=100,
+ dl_dst='00:01:02:03:04:05',
+ dl_src='00:06:07:08:09:0a',
+ dl_vlan_enable=False,
+ dl_vlan=0,
+ dl_vlan_pcp=0,
+ dl_vlan_cfi=0,
+ ip_src='fe80::2420:52ff:fe8f:5189',
+ ip_dst='fe80::2420:52ff:fe8f:5190',
+ ip_tos=0,
+ tcp_sport=0,
+ tcp_dport=0,
+ EH = False,
+ EHpkt = IPv6ExtHdrDestOpt(),
+ route_adv = False,
+ sll_enabled = False
+ ):
+
+ """
+ Return a simple dataplane ICMPv6 packet
+
+ Supports a few parameters:
+ @param len Length of packet in bytes w/o CRC
+ @param dl_dst Destinatino MAC
+ @param dl_src Source MAC
+ @param dl_vlan_enable True if the packet is with vlan, False otherwise
+ @param dl_vlan VLAN ID
+ @param dl_vlan_pcp VLAN priority
+ @param ip_src IPv6 source
+ @param ip_dst IPv6 destination
+ @param ip_tos IP ToS
+ @param tcp_dport TCP destination port
+ @param ip_sport TCP source port
+
+ """
+ if (dl_vlan_enable):
+ pkt = Ether(dst=dl_dst, src=dl_src)/ \
+ Dot1Q(prio=dl_vlan_pcp, id=dl_vlan_cfi, vlan=dl_vlan)/ \
+ IPv6(src=ip_src, dst=ip_dst)
+
+ else:
+ pkt = Ether(dst=dl_dst, src=dl_src)/ \
+ IPv6(src=ip_src, dst=ip_dst)
+
+
+ # Add IPv6 Extension Headers
+ if EH:
+ pkt = pkt / EHpkt
+
+ if route_adv:
+ pkt = pkt/ \
+ ICMPv6ND_RA(chlim=255, H=0L, M=0L, O=1L, routerlifetime=1800, P=0L, retranstimer=0, prf=0L, res=0L)/ \
+ ICMPv6NDOptPrefixInfo(A=1L, res2=0, res1=0L, L=1L, len=4, prefix='fd00:141:64:1::', R=0L, validlifetime=1814400, prefixlen=64, preferredlifetime=604800, type=3)
+ if sll_enabled :
+ pkt = pkt/ \
+ ICMPv6NDOptSrcLLAddr(type=1, len=1, lladdr='66:6f:df:2d:7c:9c')
+ else :
+ pkt = pkt/ \
+ ICMPv6EchoRequest()
+ if (tcp_sport >0 and tcp_dport >0):
+ pkt = pkt / TCP(sport=tcp_sport, dport=tcp_dport)
+
+ if pktlen > len(pkt) :
+ pkt = pkt/("D" * (pktlen - len(pkt)))
+
+ return pkt
+
+
+def do_barrier(ctrl):
+ b = ofp.message.barrier_request()
+ ctrl.transact(b)
+
+
+def port_config_get(controller, port_no, logger):
+ """
+ Get a port's configuration
+
+ Gets the switch feature configuration and grabs one port's
+ configuration
+
+ @returns (hwaddr, config, advert) The hwaddress, configuration and
+ advertised values
+ """
+ request = ofp.message.features_request()
+ reply, _ = controller.transact(request, timeout=2)
+ if reply is None:
+ logger.warn("Get feature request failed")
+ return None, None, None
+ logger.debug(reply.show())
+ for idx in range(len(reply.ports)):
+ if reply.ports[idx].port_no == port_no:
+ return (reply.ports[idx].hw_addr, reply.ports[idx].config,
+ reply.ports[idx].advertised)
+
+ logger.warn("Did not find port number for port config")
+ return None, None, None
+
+def port_config_set(controller, port_no, config, mask, logger):
+ """
+ Set the port configuration according the given parameters
+
+ Gets the switch feature configuration and updates one port's
+ configuration value according to config and mask
+ """
+ logger.info("Setting port " + str(port_no) + " to config " + str(config))
+ request = ofp.message.features_request()
+ reply, _ = controller.transact(request, timeout=2)
+ if reply is None:
+ return -1
+ logger.debug(reply.show())
+ for idx in range(len(reply.ports)):
+ if reply.ports[idx].port_no == port_no:
+ break
+ if idx >= len(reply.ports):
+ return -1
+ mod = ofp.message.port_mod()
+ mod.port_no = port_no
+ mod.hw_addr = reply.ports[idx].hw_addr
+ mod.config = config
+ mod.mask = mask
+ mod.advertise = reply.ports[idx].advertised
+ rv = controller.message_send(mod)
+ return rv
+
+def receive_pkt_check(dataplane, pkt, yes_ports, no_ports, assert_if, logger):
+ """
+ Check for proper receive packets across all ports
+ @param dataplane The dataplane object
+ @param pkt Expected packet; may be None if yes_ports is empty
+ @param yes_ports Set or list of ports that should recieve packet
+ @param no_ports Set or list of ports that should not receive packet
+ @param assert_if Object that implements assertXXX
+ """
+ for ofport in yes_ports:
+ logger.debug("Checking for pkt on port " + str(ofport))
+ (_, rcv_pkt, _) = dataplane.poll(
+ port_number=ofport, timeout=1)
+ assert_if.assertTrue(rcv_pkt is not None,
+ "Did not receive pkt on " + str(ofport))
+ assert_if.assertEqual(str(pkt), str(rcv_pkt),
+ "Response packet does not match send packet " +
+ "on port " + str(ofport))
+
+ for ofport in no_ports:
+ logger.debug("Negative check for pkt on port " + str(ofport))
+ (_, rcv_pkt, _) = dataplane.poll(
+ port_number=ofport, timeout=1)
+ assert_if.assertTrue(rcv_pkt is None,
+ "Unexpected pkt on port " + str(ofport))
+
+
+def pkt_verify(parent, rcv_pkt, exp_pkt):
+ if str(exp_pkt) != str(rcv_pkt):
+ logging.error("ERROR: Packet match failed.")
+ logging.debug("Expected (" + str(len(exp_pkt)) + ")")
+ logging.debug(str(exp_pkt).encode('hex'))
+ sys.stdout = tmpout = StringIO()
+ exp_pkt.show()
+ sys.stdout = sys.__stdout__
+ logging.debug(tmpout.getvalue())
+ logging.debug("Received (" + str(len(rcv_pkt)) + ")")
+ logging.debug(str(rcv_pkt).encode('hex'))
+ sys.stdout = tmpout = StringIO()
+ Ether(rcv_pkt).show()
+ sys.stdout = sys.__stdout__
+ logging.debug(tmpout.getvalue())
+ parent.assertEqual(str(exp_pkt), str(rcv_pkt),
+ "Packet match error")
+
+ return rcv_pkt
+
+def receive_pkt_verify(parent, egr_port, exp_pkt):
+ """
+ Receive a packet and verify it matches an expected value
+
+ parent must implement dataplane, assertTrue and assertEqual
+ """
+ (rcv_port, rcv_pkt, _) = parent.dataplane.poll(port_number=egr_port,
+ timeout=1)
+
+ if exp_pkt is None:
+ if rcv_pkt is None:
+ return None
+ else:
+ logging.error("ERROR: Received unexpected packet from " + str(egr_port));
+ return rcv_pkt
+
+ if rcv_pkt is None:
+ logging.error("ERROR: No packet received from " + str(egr_port))
+
+ parent.assertTrue(rcv_pkt is not None,
+ "Did not receive packet port " + str(egr_port))
+ logging.debug("Packet len " + str(len(rcv_pkt)) + " in on " +
+ str(rcv_port))
+
+ return pkt_verify(parent, rcv_pkt, exp_pkt)
+
+def packetin_verify(parent, exp_pkt):
+ """
+ Receive packet_in and verify it matches an expected value
+ """
+ (response, _) = parent.controller.poll(ofp.OFPT_PACKET_IN, 2)
+
+ parent.assertTrue(response is not None, 'Packet in ofp.message not received')
+ if str(exp_pkt) != response.data:
+ logging.debug("pkt len " + str(len(str(exp_pkt))) + ": "
+ + str(exp_pkt).encode('hex'))
+ logging.debug("resp len " + str(len(str(response.data))) + ": "
+ + str(response.data).encode('hex'))
+ parent.assertEqual(str(exp_pkt), response.data,
+ 'PACKET_IN packet does not match send packet')
+
+def match_verify(parent, req_match, res_match):
+ """
+ Verify flow matches agree; if they disagree, report where
+
+ parent must implement assertEqual
+ Use str() to ensure content is compared and not pointers
+ """
+
+ parent.assertEqual(req_match.wildcards, res_match.wildcards,
+ 'Match failed: wildcards: ' + hex(req_match.wildcards) +
+ " != " + hex(res_match.wildcards))
+ parent.assertEqual(req_match.in_port, res_match.in_port,
+ 'Match failed: in_port: ' + str(req_match.in_port) +
+ " != " + str(res_match.in_port))
+ parent.assertEqual(str(req_match.dl_src), str(res_match.dl_src),
+ 'Match failed: dl_src: ' + str(req_match.dl_src) +
+ " != " + str(res_match.dl_src))
+ parent.assertEqual(str(req_match.dl_dst), str(res_match.dl_dst),
+ 'Match failed: dl_dst: ' + str(req_match.dl_dst) +
+ " != " + str(res_match.dl_dst))
+ parent.assertEqual(req_match.dl_vlan, res_match.dl_vlan,
+ 'Match failed: dl_vlan: ' + str(req_match.dl_vlan) +
+ " != " + str(res_match.dl_vlan))
+ parent.assertEqual(req_match.dl_vlan_pcp, res_match.dl_vlan_pcp,
+ 'Match failed: dl_vlan_pcp: ' +
+ str(req_match.dl_vlan_pcp) + " != " +
+ str(res_match.dl_vlan_pcp))
+ parent.assertEqual(req_match.dl_type, res_match.dl_type,
+ 'Match failed: dl_type: ' + str(req_match.dl_type) +
+ " != " + str(res_match.dl_type))
+
+ if (not(req_match.wildcards & ofp.OFPFW_DL_TYPE)
+ and (req_match.dl_type == IP_ETHERTYPE)):
+ parent.assertEqual(req_match.nw_tos, res_match.nw_tos,
+ 'Match failed: nw_tos: ' + str(req_match.nw_tos) +
+ " != " + str(res_match.nw_tos))
+ parent.assertEqual(req_match.nw_proto, res_match.nw_proto,
+ 'Match failed: nw_proto: ' + str(req_match.nw_proto) +
+ " != " + str(res_match.nw_proto))
+ parent.assertEqual(req_match.nw_src, res_match.nw_src,
+ 'Match failed: nw_src: ' + str(req_match.nw_src) +
+ " != " + str(res_match.nw_src))
+ parent.assertEqual(req_match.nw_dst, res_match.nw_dst,
+ 'Match failed: nw_dst: ' + str(req_match.nw_dst) +
+ " != " + str(res_match.nw_dst))
+
+ if (not(req_match.wildcards & ofp.OFPFW_NW_PROTO)
+ and ((req_match.nw_proto == TCP_PROTOCOL)
+ or (req_match.nw_proto == UDP_PROTOCOL))):
+ parent.assertEqual(req_match.tp_src, res_match.tp_src,
+ 'Match failed: tp_src: ' +
+ str(req_match.tp_src) +
+ " != " + str(res_match.tp_src))
+ parent.assertEqual(req_match.tp_dst, res_match.tp_dst,
+ 'Match failed: tp_dst: ' +
+ str(req_match.tp_dst) +
+ " != " + str(res_match.tp_dst))
+
+def flow_removed_verify(parent, request=None, pkt_count=-1, byte_count=-1):
+ """
+ Receive a flow removed msg and verify it matches expected
+
+ @params parent Must implement controller, assertEqual
+ @param pkt_count If >= 0, verify packet count
+ @param byte_count If >= 0, verify byte count
+ """
+ (response, _) = parent.controller.poll(ofp.OFPT_FLOW_REMOVED, 2)
+ parent.assertTrue(response is not None, 'No flow removed ofp.message received')
+
+ if request is None:
+ return
+
+ parent.assertEqual(request.cookie, response.cookie,
+ "Flow removed cookie error: " +
+ hex(request.cookie) + " != " + hex(response.cookie))
+
+ req_match = request.match
+ res_match = response.match
+ verifyMatchField(req_match, res_match)
+
+ if (req_match.wildcards != 0):
+ parent.assertEqual(request.priority, response.priority,
+ 'Flow remove prio mismatch: ' +
+ str(request.priority) + " != " +
+ str(response.priority))
+ parent.assertEqual(response.reason, ofp.OFPRR_HARD_TIMEOUT,
+ 'Flow remove reason is not HARD TIMEOUT:' +
+ str(response.reason))
+ if pkt_count >= 0:
+ parent.assertEqual(response.packet_count, pkt_count,
+ 'Flow removed failed, packet count: ' +
+ str(response.packet_count) + " != " +
+ str(pkt_count))
+ if byte_count >= 0:
+ parent.assertEqual(response.byte_count, byte_count,
+ 'Flow removed failed, byte count: ' +
+ str(response.byte_count) + " != " +
+ str(byte_count))
+def flow_msg_create(parent, pkt, ing_port=0, match_fields=None, instruction_list=None,
+ action_list=None,wildcards=0, egr_port=None,
+ egr_queue=None, table_id=0, check_expire=False):
+ """
+ Multi-purpose flow_mod creation utility
+
+ Match on packet with given wildcards.
+ See flow_match_test for other parameter descriptoins
+
+ if egr_queue is set
+ append an out_queue ofp.action to egr_queue to the actions_list
+ else if egr_port is set:
+ append an output ofp.action to egr_port to the actions_list
+ if the instruction_list is empty,
+ append an APPLY ofp.instruction to it
+ Add the action_list to the first write or apply ofp.instruction
+
+ @param egr_queue if not None, make the output an enqueue ofp.action
+ @param table_id Table ID for writing a flow_mod
+ """
+
+ if match_fields is None:
+ match_fields = parse.packet_to_flow_match(pkt)
+ parent.assertTrue(match_fields is not None, "Flow match from pkt failed")
+ in_port = ofp.oxm.in_port(ing_port)
+ match_fields.oxm_list.append(in_port)
+ request = ofp.message.flow_add()
+ request.match= match_fields
+ request.buffer_id = 0xffffffff
+ request.table_id = table_id
+
+ if check_expire:
+ request.flags |= ofp.OFPFF_SEND_FLOW_REM
+ request.hard_timeout = 1
+
+ if action_list is None:
+ action_list = []
+ if instruction_list is None:
+ instruction_list = []
+
+ # Set up output/enqueue ofp.action if directed
+ if egr_queue is not None:
+ parent.assertTrue(egr_port is not None, "Egress port not set")
+ act = ofp.action.set_queue()
+ act.port = egr_port
+ act.queue_id = egr_queue
+ action_list.append(act)
+ elif egr_port is not None:
+ act = ofp.action.output()
+ act.port = egr_port
+ action_list.append(act)
+
+ inst = None
+ if len(instruction_list) == 0:
+ inst = ofp.instruction.apply_actions()
+ instruction_list.append(inst)
+ else:
+ for inst in instruction_list:
+ if (inst.type == ofp.OFPIT_WRITE_ACTIONS or
+ inst.type == ofp.OFPIT_APPLY_ACTIONS):
+ break
+
+
+ # add all the actions to the last inst
+ inst.actions += action_list
+
+ # add all the instrutions to the flow_mod
+ request.instructions += instruction_list
+
+ logging.debug(request.show())
+ return request
+
+def flow_msg_install(parent, request, clear_table=True):
+ """
+ Install a flow mod ofp.message in the switch
+
+ @param parent Must implement controller, assertEqual, assertTrue
+ @param request The request, all set to go
+ @param clear_table If true, clear the flow table before installing
+ """
+ if clear_table:
+ logging.debug("Clear flow table")
+ if request.table_id:
+ table_id = request.table_id
+ else:
+ table_id = 0
+ rc = delete_all_flows_one_table(parent.controller,
+ logging,
+ table_id)
+ parent.assertEqual(rc, 0, "Failed to delete all flows on table: "
+ + str(table_id))
+ do_barrier(parent.controller)
+
+ logging.debug("Insert flow::\n%s" % request.show())
+ rv = parent.controller.message_send(request)
+ parent.assertTrue(rv != -1, "Error installing flow mod")
+ do_barrier(parent.controller)
+
+def error_verify(parent, exp_type, exp_code):
+ """
+ Receive an error msg and verify if it is as expected
+
+ @param parent Must implement controller, assertEqual
+ @param exp_type Expected error type
+ @param exp_code Expected error code
+ """
+ (response, raw) = parent.controller.poll(ofp.OFPT_ERROR, 2)
+ parent.assertTrue(response is not None, 'No error ofp.message received')
+
+ if (exp_type is None) or (exp_code is None):
+ logging.debug("Parametrs are not sufficient")
+ return
+
+ parent.assertEqual(exp_type, response.type,
+ 'Error ofp.message type mismatch: ' +
+ str(exp_type) + " != " +
+ str(response.type))
+ parent.assertEqual(exp_code, response.code,
+ 'Error ofp.message code mismatch: ' +
+ str(exp_code) + " != " +
+ str(response.code))
+
+def flow_match_test_port_pair(parent, ing_port, egr_port, match=None,
+ wildcards=0, mask=None,
+ dl_vlan=-1, pkt=None, exp_pkt=None,
+ apply_action_list=None, check_expire=False):
+ """
+ Flow match test on single TCP packet
+
+ Run test with packet through switch from ing_port to egr_port
+ See flow_match_test for parameter descriptions
+ """
+
+ logging.info("Pkt match test: " + str(ing_port) + " to " + str(egr_port))
+ logging.debug(" WC: " + hex(wildcards) + " vlan: " + str(dl_vlan) +
+ " expire: " + str(check_expire))
+ if pkt is None:
+ if dl_vlan >= 0:
+ pkt = simple_tcp_packet(vlan_tags=[{'vid': dl_vlan}])
+ else:
+ pkt = simple_tcp_packet()
+
+ match = parse.packet_to_flow_match(pkt)
+ parent.assertTrue(match is not None, "Flow match from pkt failed")
+
+ if mask is not None:
+ match.dl_src_mask = mask['dl_src']
+ match.dl_dst_mask = mask['dl_dst']
+ match.nw_src_mask = mask['nw_src']
+ match.nw_dst_mask = mask['nw_dst']
+ #Set unmatching values on corresponding match fields
+ for i in range(ofp.OFP_ETH_ALEN):
+ match.dl_src[i] = match.dl_src[i] ^ match.dl_src_mask[i]
+ match.dl_dst[i] = match.dl_dst[i] ^ match.dl_dst_mask[i]
+ match.nw_src = match.nw_src ^ match.nw_src_mask
+ match.nw_dst = match.nw_dst ^ match.nw_dst_mask
+
+ request = flow_msg_create(parent, pkt, ing_port=ing_port,
+ match=match,
+ wildcards=wildcards, egr_port=egr_port,
+ action_list=apply_action_list)
+
+ flow_msg_install(parent, request)
+
+ logging.debug("Send packet: " + str(ing_port) + " to " + str(egr_port))
+ parent.dataplane.send(ing_port, str(pkt))
+
+ if exp_pkt is None:
+ exp_pkt = pkt
+ receive_pkt_verify(parent, egr_port, exp_pkt)
+
+ if check_expire:
+ #@todo Not all HW supports both pkt and byte counters
+ flow_removed_verify(parent, request, pkt_count=1, byte_count=len(pkt))
+def flow_match_test(parent, port_map, match=None, wildcards=0,
+ mask=None, dl_vlan=-1, pkt=None,
+ exp_pkt=None, apply_action_list=None,
+ check_expire=False, max_test=0):
+ """
+ Run flow_match_test_port_pair on all port pairs
+
+ @param max_test If > 0 no more than this number of tests are executed.
+ @param parent Must implement controller, dataplane, assertTrue, assertEqual
+ and logger
+ @param pkt If not None, use this packet for ingress
+ @param match If not None, use this value in flow_mod
+ @param wildcards For flow match entry
+ @param mask DL/NW address bit masks as a dictionary. If set, it is tested
+ against the corresponding match fields with the opposite values
+ @param dl_vlan If not -1, and pkt is None, create a pkt w/ VLAN tag
+ @param exp_pkt If not None, use this as the expected output pkt; els use pkt
+ @param action_list Additional actions to add to flow mod
+ @param check_expire Check for flow expiration ofp.message
+ """
+ of_ports = port_map.keys()
+ of_ports.sort()
+ parent.assertTrue(len(of_ports) > 1, "Not enough ports for test")
+ test_count = 0
+
+ for ing_idx in range(len(of_ports)):
+ ingress_port = of_ports[ing_idx]
+ for egr_idx in range(len(of_ports)):
+ if egr_idx == ing_idx:
+ continue
+ egress_port = of_ports[egr_idx]
+ flow_match_test_port_pair(parent, ingress_port, egress_port,
+ match=match, wildcards=wildcards,
+ dl_vlan=dl_vlan, mask=mask,
+ pkt=pkt, exp_pkt=exp_pkt,
+ apply_action_list=apply_action_list,
+ check_expire=check_expire)
+ test_count += 1
+ if (max_test > 0) and (test_count >= max_test):
+ logging.info("Ran " + str(test_count) + " tests; exiting")
+ return
+
+def flow_match_test_port_pair_vlan(parent, ing_port, egr_port, wildcards=0,
+ dl_vlan=ofp.OFPVID_NONE, dl_vlan_pcp=0,
+ dl_vlan_type=ETHERTYPE_VLAN,
+ dl_vlan_int=-1, dl_vlan_pcp_int=0,
+ vid_match=ofp.OFPVID_NONE, pcp_match=0,
+ exp_vid=-1, exp_pcp=0,
+ exp_vlan_type=ETHERTYPE_VLAN,
+ match_exp=True,
+ add_tag_exp=False,
+ exp_msg=ofp.OFPT_FLOW_REMOVED,
+ exp_msg_type=0, exp_msg_code=0,
+ pkt=None, exp_pkt=None,
+ action_list=None, check_expire=False):
+ """
+ Flow match test for various vlan matching patterns on single TCP packet
+
+ Run test with packet through switch from ing_port to egr_port
+ See flow_match_test_vlan for parameter descriptions
+ """
+ logging.info("Pkt match test: " + str(ing_port) + " to " + str(egr_port))
+ logging.debug(" WC: " + hex(wildcards) + " vlan: " + str(dl_vlan) +
+ " expire: " + str(check_expire))
+ if pkt is None:
+ if dl_vlan >= 0 and dl_vlan != ofp.OFPVID_NONE:
+ if dl_vlan_int >= 0 and dl_vlan_int != ofp.OFPVID_NONE:
+ pkt = simple_tcp_packet(
+ vlan_tags=[{'type': dl_vlan_type, 'vid': dl_vlan, 'pcp': dl_vlan_pcp},
+ {'vid': dl_vlan_int, 'pcp': dl_vlan_pcp_int}])
+ else:
+ pkt = simple_tcp_packet(
+ vlan_tags=[{'type': dl_vlan_type, 'vid': dl_vlan, 'pcp': dl_vlan_pcp}])
+ else:
+ pkt = simple_tcp_packet()
+
+ if exp_pkt is None:
+ if exp_vid >= 0 and exp_vid != ofp.OFPVID_NONE:
+ if add_tag_exp:
+ if dl_vlan >= 0 and dl_vlan != ofp.OFPVID_NONE:
+ if dl_vlan_int >= 0 and dl_vlan_int != ofp.OFPVID_NONE:
+ exp_pkt = simple_tcp_packet(
+ vlan_tags=[{'type': exp_vlan_type, 'vid': exp_vid, 'pcp': exp_pcp},
+ {'type': dl_vlan_type, 'vid': dl_vlan, 'pcp': dl_vlan_pcp},
+ {'vid': dl_vlan_int, 'pcp': dl_vlan_pcp_int}])
+ else:
+ exp_pkt = simple_tcp_packet(
+ vlan_tags=[{'type': exp_vlan_type, 'vid': exp_vid, 'pcp': exp_pcp},
+ {'type': dl_vlan_type, 'vid': dl_vlan, 'pcp': dl_vlan_pcp}])
+ else:
+ exp_pkt = simple_tcp_packet(
+ vlan_tags=[{'type': exp_vlan_type, 'vid': exp_vid, 'pcp': exp_pcp}])
+ else:
+ if dl_vlan_int >= 0:
+ exp_pkt = simple_tcp_packet(
+ vlan_tags=[{'type': exp_vlan_type, 'vid': exp_vid, 'pcp': exp_pcp},
+ {'vid': dl_vlan_int, 'pcp': dl_vlan_pcp_int}])
+
+ else:
+ exp_pkt = simple_tcp_packet(
+ vlan_tags=[{'type': exp_vlan_type, 'vid': exp_vid, 'pcp': exp_pcp}])
+ else:
+ #subtract ofp.action
+ if dl_vlan_int >= 0:
+ exp_pkt = simple_tcp_packet(
+ vlan_tags=[{'vid': dl_vlan_int, 'pcp': dl_vlan_pcp_int}])
+ else:
+ exp_pkt = simple_tcp_packet()
+
+ match = parse.packet_to_flow_match(pkt)
+ parent.assertTrue(match is not None, "Flow match from pkt failed")
+
+ match.dl_vlan = vid_match
+ match.dl_vlan_pcp = pcp_match
+ match.wildcards = wildcards
+
+ request = flow_msg_create(parent, pkt, ing_port=ing_port,
+ wildcards=wildcards,
+ match=match,
+ egr_port=egr_port,
+ action_list=action_list)
+
+ flow_msg_install(parent, request)
+
+ logging.debug("Send packet: " + str(ing_port) + " to " + str(egr_port))
+ logging.debug("Sent:" + str(pkt).encode('hex'))
+ parent.dataplane.send(ing_port, str(pkt))
+
+ if match_exp:
+ receive_pkt_verify(parent, egr_port, exp_pkt)
+ if check_expire:
+ #@todo Not all HW supports both pkt and byte counters
+ flow_removed_verify(parent, request, pkt_count=1, byte_count=len(pkt))
+ else:
+ if exp_msg is ofp.OFPT_FLOW_REMOVED:
+ if check_expire:
+ flow_removed_verify(parent, request, pkt_count=0, byte_count=0)
+ elif exp_msg is ofp.OFPT_ERROR:
+ error_verify(parent, exp_msg_type, exp_msg_code)
+ else:
+ parent.assertTrue(0, "Rcv: Unexpected ofp.message: " + str(exp_msg))
+
+ (_, rcv_pkt, _) = parent.dataplane.poll(timeout=1)
+ parent.assertFalse(rcv_pkt is not None, "Packet on dataplane")
+
+def flow_match_test_vlan(parent, port_map, wildcards=0,
+ dl_vlan=ofp.OFPVID_NONE, dl_vlan_pcp=0, dl_vlan_type=ETHERTYPE_VLAN,
+ dl_vlan_int=-1, dl_vlan_pcp_int=0,
+ vid_match=ofp.OFPVID_NONE, pcp_match=0,
+ exp_vid=-1, exp_pcp=0,
+ exp_vlan_type=ETHERTYPE_VLAN,
+ match_exp=True,
+ add_tag_exp=False,
+ exp_msg=ofp.OFPT_FLOW_REMOVED,
+ exp_msg_type=0, exp_msg_code=0,
+ pkt=None, exp_pkt=None,
+ action_list=None,
+ check_expire=False,
+ max_test=0):
+ """
+ Run flow_match_test_port_pair on all port pairs
+
+ @param max_test If > 0 no more than this number of tests are executed.
+ @param parent Must implement controller, dataplane, assertTrue, assertEqual
+ and logger
+ @param wildcards For flow match entry
+ @param dl_vlan If not -1, and pkt is not None, create a pkt w/ VLAN tag
+ @param dl_vlan_pcp VLAN PCP associated with dl_vlan
+ @param dl_vlan_type VLAN ether type associated with dl_vlan
+ @param dl_vlan_int If not -1, create pkt w/ Inner Vlan tag
+ @param dl_vlan_pcp_int VLAN PCP associated with dl_vlan_2nd
+ @param vid_match Matching value for VLAN VID field
+ @param pcp_match Matching value for VLAN PCP field
+ @param exp_vid Expected VLAN VID value. If -1, no VLAN expected
+ @param exp_vlan_type Expected VLAN ether type
+ @param exp_pcp Expected VLAN PCP value
+ @param match_exp Set whether packet is expected to receive
+ @param add_tag_exp If True, expected_packet has an additional vlan tag,
+ If not, expected_packet's vlan tag is replaced as specified
+ @param exp_msg Expected ofp.message
+ @param exp_msg_type Expected ofp.message type associated with the ofp.message
+ @param exp_msg_code Expected ofp.message code associated with the msg_type
+ @param pkt If not None, use this packet for ingress
+ @param exp_pkt If not None, use this as the expected output pkt
+ @param action_list Additional actions to add to flow mod
+ @param check_expire Check for flow expiration ofp.message
+ """
+ of_ports = port_map.keys()
+ of_ports.sort()
+ parent.assertTrue(len(of_ports) > 1, "Not enough ports for test")
+ test_count = 0
+
+ for ing_idx in range(len(of_ports)):
+ ingress_port = of_ports[ing_idx]
+ for egr_idx in range(len(of_ports)):
+ if egr_idx == ing_idx:
+ continue
+ egress_port = of_ports[egr_idx]
+ flow_match_test_port_pair_vlan(parent, ingress_port, egress_port,
+ wildcards=wildcards,
+ dl_vlan=dl_vlan,
+ dl_vlan_pcp=dl_vlan_pcp,
+ dl_vlan_type=dl_vlan_type,
+ dl_vlan_int=dl_vlan_int,
+ dl_vlan_pcp_int=dl_vlan_pcp_int,
+ vid_match=vid_match,
+ pcp_match=pcp_match,
+ exp_vid=exp_vid,
+ exp_pcp=exp_pcp,
+ exp_vlan_type=exp_vlan_type,
+ exp_msg=exp_msg,
+ exp_msg_type=exp_msg_type,
+ exp_msg_code=exp_msg_code,
+ match_exp=match_exp,
+ add_tag_exp=add_tag_exp,
+ pkt=pkt, exp_pkt=exp_pkt,
+ action_list=action_list,
+ check_expire=check_expire)
+ test_count += 1
+ if (max_test > 0) and (test_count >= max_test):
+ logging.info("Ran " + str(test_count) + " tests; exiting")
+ return
+
+def test_param_get(config, key, default=None):
+ """
+ Return value passed via test-params if present
+
+ @param config The configuration structure for OFTest
+ @param key The lookup key
+ @param default Default value to use if not found
+
+ If the pair 'key=val' appeared in the string passed to --test-params
+ on the command line, return val (as interpreted by exec). Otherwise
+ return default value.
+ """
+ try:
+ exec config["test_params"]
+ except:
+ return default
+
+ s = "val = " + str(key)
+ try:
+ val = None
+ exec s
+ return val
+ except:
+ return default
+
+def action_generate(parent, field_to_mod, mod_field_vals):
+ """
+ Create an ofp.action to modify the field indicated in field_to_mod
+
+ @param parent Must implement, assertTrue
+ @param field_to_mod The field to modify as a string name
+ @param mod_field_vals Hash of values to use for modified values
+ """
+
+ act = None
+
+ if field_to_mod in ['pktlen']:
+ return None
+
+ if field_to_mod == 'dl_dst':
+ act = ofp.action.set_dl_dst()
+ act.dl_addr = parse.parse_mac(mod_field_vals['dl_dst'])
+ elif field_to_mod == 'dl_src':
+ act = ofp.action.set_dl_src()
+ act.dl_addr = parse.parse_mac(mod_field_vals['dl_src'])
+ elif field_to_mod == 'vlan_tags':
+ if len(mod_field_vals['vlan_tags']):
+ act = ofp.action.pop_vlan()
+ else:
+ pass
+# elif field_to_mod == 'dl_vlan_enable':
+# if not mod_field_vals['dl_vlan_enable']: # Strip VLAN tag
+# act = ofp.action.pop_vlan()
+# # Add VLAN tag is handled by dl_vlan field
+# # Will return None in this case
+# elif field_to_mod == 'dl_vlan':
+# act = ofp.action.set_vlan_vid()
+# act.vlan_vid = mod_field_vals['dl_vlan']
+# elif field_to_mod == 'dl_vlan_pcp':
+# act = ofp.action.set_vlan_pcp()
+# act.vlan_pcp = mod_field_vals['dl_vlan_pcp']
+ elif field_to_mod == 'ip_src':
+ act = ofp.action.set_nw_src()
+ act.nw_addr = parse.parse_ip(mod_field_vals['ip_src'])
+ elif field_to_mod == 'ip_dst':
+ act = ofp.action.set_nw_dst()
+ act.nw_addr = parse.parse_ip(mod_field_vals['ip_dst'])
+ elif field_to_mod == 'ip_tos':
+ act = ofp.action.set_nw_tos()
+ act.nw_tos = mod_field_vals['ip_tos']
+ elif field_to_mod == 'tcp_sport':
+ act = ofp.action.set_tp_src()
+ act.tp_port = mod_field_vals['tcp_sport']
+ elif field_to_mod == 'tcp_dport':
+ act = ofp.action.set_tp_dst()
+ act.tp_port = mod_field_vals['tcp_dport']
+ else:
+ parent.assertTrue(0, "Unknown field to modify: " + str(field_to_mod))
+
+ return act
+
+def pkt_action_setup(parent, start_field_vals={}, mod_field_vals={},
+ mod_fields={}, check_test_params=False):
+ """
+ Set up the ingress and expected packet and ofp.action list for a test
+
+ @param parent Must implement, assertTrue, config hash and logger
+ @param start_field_values Field values to use for ingress packet (optional)
+ @param mod_field_values Field values to use for modified packet (optional)
+ @param mod_fields The list of fields to be modified by the switch in the test.
+ @params check_test_params If True, will check the parameters vid, add_vlan
+ and strip_vlan from the command line.
+
+ Returns a triple: pkt-to-send, expected-pkt, ofp.action-list
+ """
+
+ new_actions = []
+
+
+ base_pkt_params = {}
+ base_pkt_params['dl_dst'] = '00:DE:F0:12:34:56'
+ base_pkt_params['dl_src'] = '00:23:45:67:89:AB'
+# base_pkt_params['dl_vlan_enable'] = False
+# base_pkt_params['dl_vlan'] = 2
+# base_pkt_params['dl_vlan_pcp'] = 0
+ base_pkt_params['ip_src'] = '192.168.0.1'
+ base_pkt_params['ip_dst'] = '192.168.0.2'
+ base_pkt_params['ip_tos'] = 0
+ base_pkt_params['tcp_sport'] = 1234
+ base_pkt_params['tcp_dport'] = 80
+ for keyname in start_field_vals.keys():
+ base_pkt_params[keyname] = start_field_vals[keyname]
+
+ mod_pkt_params = {}
+ mod_pkt_params['dl_dst'] = '00:21:0F:ED:CB:A9'
+ mod_pkt_params['dl_src'] = '00:ED:CB:A9:87:65'
+# mod_pkt_params['dl_vlan_enable'] = False
+# mod_pkt_params['dl_vlan'] = 3
+# mod_pkt_params['dl_vlan_pcp'] = 7
+ mod_pkt_params['ip_src'] = '10.20.30.40'
+ mod_pkt_params['ip_dst'] = '50.60.70.80'
+ mod_pkt_params['ip_tos'] = 0xf0
+ mod_pkt_params['tcp_sport'] = 4321
+ mod_pkt_params['tcp_dport'] = 8765
+ for keyname in mod_field_vals.keys():
+ mod_pkt_params[keyname] = mod_field_vals[keyname]
+
+ # Check for test param modifications
+ strip = False
+ if check_test_params:
+ add_vlan = test_param_get(parent.config, 'add_vlan')
+ strip_vlan = test_param_get(parent.config, 'strip_vlan')
+ vid = test_param_get(parent.config, 'vid')
+
+ if add_vlan and strip_vlan:
+ parent.assertTrue(0, "Add and strip VLAN both specified")
+
+ if vid:
+ base_pkt_params['dl_vlan_enable'] = True
+ base_pkt_params['dl_vlan'] = vid
+ if 'dl_vlan' in mod_fields:
+ mod_pkt_params['dl_vlan'] = vid + 1
+
+ if add_vlan:
+ base_pkt_params['dl_vlan_enable'] = False
+ mod_pkt_params['dl_vlan_enable'] = True
+ mod_pkt_params['pktlen'] = base_pkt_params['pktlen'] + 4
+ mod_fields.append('pktlen')
+ mod_fields.append('dl_vlan_enable')
+ if 'dl_vlan' not in mod_fields:
+ mod_fields.append('dl_vlan')
+ elif strip_vlan:
+ base_pkt_params['dl_vlan_enable'] = True
+ mod_pkt_params['dl_vlan_enable'] = False
+ mod_pkt_params['pktlen'] = base_pkt_params['pktlen'] - 4
+ mod_fields.append('dl_vlan_enable')
+ mod_fields.append('pktlen')
+
+ # Build the ingress packet
+ ingress_pkt = simple_tcp_packet(**base_pkt_params)
+
+ # Build the expected packet, modifying the indicated fields
+ for item in mod_fields:
+ base_pkt_params[item] = mod_pkt_params[item]
+ act = action_generate(parent, item, mod_pkt_params)
+ if act:
+ new_actions.append(act)
+
+ expected_pkt = simple_tcp_packet(**base_pkt_params)
+
+ return (ingress_pkt, expected_pkt, new_actions)
+
+def wildcard_all_set(match):
+ match.wildcards = ofp.OFPFW_ALL
+ match.nw_dst_mask = 0xffffffff
+ match.nw_src_mask = 0xffffffff
+ match.dl_dst_mask = [0xff, 0xff, 0xff, 0xff, 0xff, 0xff]
+ match.dl_src_mask = [0xff, 0xff, 0xff, 0xff, 0xff, 0xff]
+ match.metadata_mask = 0xffffffffffffffff
+
+def skip_message_emit(parent, s):
+ """
+ Print out a 'skipped' ofp.message to stderr
+
+ @param s The string to print out to the log file
+ @param parent Must implement config and logger objects
+ """
+ global skipped_test_count
+
+ skipped_test_count += 1
+ logging.info("Skipping: " + s)
+ if parent.config["debug"] < logging.WARNING:
+ sys.stderr.write("(skipped) ")
+ else:
+ sys.stderr.write("(S)")
+
+def do_echo_request_reply_test(test,controller):
+ request = ofp.message.echo_request()
+ response, _ = controller.transact(request)
+ test.assertEqual(response.type, ofp.OFPT_ECHO_REPLY,
+ 'response is not echo_reply')
+ test.assertEqual(request.xid, response.xid,
+ 'response xid != request xid')
+ test.assertEqual(len(response.data), 0, 'response data non-empty')
+
+def match_all_generate():
+ match = ofp.ofp_match()
+ return match
+
+def simple_tcp_packet_w_mpls(
+ dl_dst='00:01:02:03:04:05',
+ dl_src='00:06:07:08:09:0a',
+ mpls_type=0x8847,
+ mpls_label=-1,
+ mpls_tc=0,
+ mpls_ttl=64,
+ mpls_label_int=-1,
+ mpls_tc_int=0,
+ mpls_ttl_int=32,
+ mpls_label_ext=-1,
+ mpls_tc_ext=0,
+ mpls_ttl_ext=128,
+ ip_src='192.168.0.1',
+ ip_dst='192.168.0.2',
+ ip_tos=0,
+ ip_ttl=192,
+ tcp_sport=1234,
+ tcp_dport=80
+ ):
+ """
+ Return a simple dataplane TCP packet w/wo MPLS tags
+
+ Supports a few parameters:
+ @param len Length of packet in bytes w/o CRC
+ @param dl_dst Destinatino MAC
+ @param dl_src Source MAC
+ @param mpls_type MPLS type as ether type
+ @param mpls_label MPLS LABEL if not -1
+ @param mpls_tc MPLS TC
+ @param mpls_ttl MPLS TTL
+ @param mpls_label_int Inner MPLS LABEL if not -1. The shim will be added
+ inside of mpls_label shim.
+ @param mpls_tc_int Inner MPLS TC
+ @param mpls_ttl_int Inner MPLS TTL
+ @param mpls_label_ext External MPLS LABEL if not -1. The shim will be
+ added outside of mpls_label shim
+ @param mpls_tc_ext External MPLS TC
+ @param mpls_ttl_ext External MPLS TTL
+ @param ip_src IP source
+ @param ip_dst IP destination
+ @param ip_tos IP ToS
+ @param tcp_dport TCP destination port
+ @param ip_sport TCP source port
+
+ Generates a simple MPLS/IP/TCP request. Users
+ shouldn't assume anything about this packet other than that
+ it is a valid ethernet/IP/TCP frame.
+ """
+
+ mpls_tags = []
+
+ if mpls_label_ext >= 0:
+ mpls_tags.append({'type': mpls_type, 'label': mpls_label_ext, 'tc': mpls_tc_ext, 'ttl': mpls_ttl_ext})
+
+ if mpls_label >= 0:
+ mpls_tags.append({'type': mpls_type, 'label': mpls_label, 'tc': mpls_tc, 'ttl': mpls_ttl})
+
+ if mpls_label_int >= 0:
+ mpls_tags.append({'type': mpls_type, 'label': mpls_label_int, 'tc': mpls_tc_int, 'ttl': mpls_ttl_int})
+
+ pkt = simple_tcp_packet(dl_dst=dl_dst,
+ dl_src=dl_src,
+ mpls_tags=mpls_tags,
+ ip_src=ip_src,
+ ip_dst=ip_dst,
+ ip_tos=ip_tos,
+ ip_ttl=ip_ttl,
+ tcp_sport=tcp_sport,
+ tcp_dport=tcp_dport)
+ return pkt
+
+def flow_match_test_port_pair_mpls(parent, ing_port, egr_port, wildcards=0,
+ mpls_type=0x8847,
+ mpls_label=-1, mpls_tc=0,mpls_ttl=64,
+ mpls_label_int=-1, mpls_tc_int=0,
+ mpls_ttl_int=32,
+ ip_ttl=192,
+ exp_mpls_type=0x8847,
+ exp_mpls_label=-1, exp_mpls_tc=0,
+ exp_mpls_ttl=64,
+ exp_mpls_ttl_int=32,
+ exp_ip_ttl=192,
+ label_match=0, tc_match=0,
+ dl_type_match=ETHERTYPE_MPLS,
+ match_exp=True,
+ add_tag_exp=False,
+ exp_msg=ofp.OFPT_FLOW_REMOVED,
+ exp_msg_type=0, exp_msg_code=0,
+ pkt=None,
+ exp_pkt=None, action_list=None,
+ check_expire=False):
+ """
+ Flow match test on single packet w/ MPLS tags
+
+ Run test with packet through switch from ing_port to egr_port
+ See flow_match_test for parameter descriptions
+ """
+ logging.info("Pkt match test: " + str(ing_port) + " to " + str(egr_port))
+ logging.debug(" WC: " + hex(wildcards) + " MPLS: " +
+ str(mpls_label) + " expire: " + str(check_expire))
+
+ if pkt is None:
+
+ pkt = simple_tcp_packet_w_mpls(mpls_type=mpls_type,
+ mpls_label=mpls_label,
+ mpls_tc=mpls_tc,
+ mpls_ttl=mpls_ttl,
+ mpls_label_int=mpls_label_int,
+ mpls_tc_int=mpls_tc_int,
+ mpls_ttl_int=mpls_ttl_int,
+ ip_ttl=ip_ttl)
+
+ if exp_pkt is None:
+ if add_tag_exp:
+ exp_pkt = simple_tcp_packet_w_mpls(
+ mpls_type=exp_mpls_type,
+ mpls_label_ext=exp_mpls_label,
+ mpls_tc_ext=exp_mpls_tc,
+ mpls_ttl_ext=exp_mpls_ttl,
+ mpls_label=mpls_label,
+ mpls_tc=mpls_tc,
+ mpls_ttl=mpls_ttl,
+ mpls_label_int=mpls_label_int,
+ mpls_tc_int=mpls_tc_int,
+ mpls_ttl_int=exp_mpls_ttl_int,
+ ip_ttl=exp_ip_ttl)
+ else:
+ if (exp_mpls_label < 0) and (mpls_label_int >= 0):
+ exp_pkt = simple_tcp_packet_w_mpls(
+ mpls_type=mpls_type,
+ mpls_label=mpls_label_int,
+ mpls_tc=mpls_tc_int,
+ mpls_ttl=exp_mpls_ttl_int,
+ ip_ttl=exp_ip_ttl)
+ else:
+ exp_pkt = simple_tcp_packet_w_mpls(
+ mpls_type=exp_mpls_type,
+ mpls_label=exp_mpls_label,
+ mpls_tc=exp_mpls_tc,
+ mpls_ttl=exp_mpls_ttl,
+ mpls_label_int=mpls_label_int,
+ mpls_tc_int=mpls_tc_int,
+ mpls_ttl_int=exp_mpls_ttl_int,
+ ip_ttl=exp_ip_ttl)
+ wildcards = (ofp.OFPFW_ALL & ~(ofp.OFPFW_DL_TYPE | ofp.OFPFW_MPLS_LABEL | ofp.OFPFW_MPLS_TC)) | wildcards
+
+ match = parse.packet_to_flow_match(pkt)
+ parent.assertTrue(match is not None, "Flow match from pkt failed")
+
+ match.mpls_label = label_match
+ match.mpls_tc = tc_match
+ match.wildcards = wildcards
+
+ match.dl_type = dl_type_match
+ match.nw_tos = 0
+ match.nw_proto = 0
+ match.nw_src = 0
+ match.nw_src_mask = 0xFFFFFFFF
+ match.nw_dst = 0
+ match.nw_dst_mask = 0xFFFFFFFF
+ match.tp_src = 0
+ match.tp_dst = 0
+
+ request = flow_msg_create(parent, pkt, ing_port=ing_port,
+ wildcards=wildcards,
+ match=match,
+ egr_port=egr_port,
+ action_list=action_list)
+
+ flow_msg_install(parent, request)
+
+ logging.debug("Send packet: " + str(ing_port) + " to " + str(egr_port))
+ #logging.debug(str(pkt).encode("hex"))
+ parent.dataplane.send(ing_port, str(pkt))
+
+ if match_exp:
+ receive_pkt_verify(parent, egr_port, exp_pkt)
+ if check_expire:
+ #@todo Not all HW supports both pkt and byte counters
+ flow_removed_verify(parent, request, pkt_count=1, byte_count=len(pkt))
+ else:
+ if exp_msg == ofp.OFPT_FLOW_REMOVED:
+ if check_expire:
+ flow_removed_verify(parent, request, pkt_count=0, byte_count=0)
+ elif exp_msg == ofp.OFPT_ERROR:
+ error_verify(parent, exp_msg_type, exp_msg_code)
+ else:
+ parent.assertTrue(0, "Rcv: Unexpected ofp.message: " + str(exp_msg))
+ (_, rcv_pkt, _) = parent.dataplane.poll(timeout=1)
+ parent.assertFalse(rcv_pkt is not None, "Packet on dataplane")
+
+def flow_match_test_mpls(parent, port_map, wildcards=0,
+ mpls_type=0x8847,
+ mpls_label=-1, mpls_tc=0, mpls_ttl=64,
+ mpls_label_int=-1, mpls_tc_int=0, mpls_ttl_int=32,
+ ip_ttl = 192,
+ label_match=0, tc_match=0,
+ dl_type_match=ETHERTYPE_MPLS,
+ exp_mpls_type=0x8847,
+ exp_mpls_label=-1, exp_mpls_tc=0, exp_mpls_ttl=64,
+ exp_mpls_ttl_int=32,
+ exp_ip_ttl=192,
+ match_exp=True,
+ add_tag_exp=False,
+ exp_msg=ofp.OFPT_FLOW_REMOVED,
+ exp_msg_type=0, exp_msg_code=0,
+ pkt=None,
+ exp_pkt=None, action_list=None, check_expire=False,
+ max_test=0):
+ """
+ Run flow_match_test_port_pair on all port pairs
+
+ @param max_test If > 0 no more than this number of tests are executed.
+ @param parent Must implement controller, dataplane, assertTrue, assertEqual
+ and logger
+ @param wildcards For flow match entry
+ @param mpls_type MPLS type
+ @param mpls_label If not -1 create a pkt w/ MPLS tag
+ @param mpls_tc MPLS TC associated with MPLS label
+ @param mpls_ttl MPLS TTL associated with MPLS label
+ @param mpls_label_int If not -1 create a pkt w/ Inner MPLS tag
+ @param mpls_tc_int MPLS TC associated with Inner MPLS label
+ @param mpls_ttl_int MPLS TTL associated with Inner MPLS label
+ @param ip_ttl IP TTL
+ @param label_match Matching value for MPLS LABEL field
+ @param tc_match Matching value for MPLS TC field
+ @param exp_mpls_label Expected MPLS LABEL value. If -1, no MPLS expected
+ @param exp_mpls_tc Expected MPLS TC value
+ @param exp_mpls_ttl Expected MPLS TTL value
+ @param exp_mpls_ttl_int Expected Inner MPLS TTL value
+ @param ip_ttl Expected IP TTL
+ @param match_exp Set whether packet is expected to receive
+ @param add_tag_exp If True, expected_packet has an additional MPLS shim,
+ If not expected_packet's MPLS shim is replaced as specified
+ @param exp_msg Expected ofp.message
+ @param exp_msg_type Expected ofp.message type associated with the ofp.message
+ @param exp_msg_code Expected ofp.message code associated with the msg_type
+ @param pkt If not None, use this packet for ingress
+ @param exp_pkt If not None, use this as the expected output pkt; els use pkt
+ @param action_list Additional actions to add to flow mod
+ @param check_expire Check for flow expiration ofp.message
+ """
+ of_ports = port_map.keys()
+ of_ports.sort()
+ parent.assertTrue(len(of_ports) > 1, "Not enough ports for test")
+ test_count = 0
+
+ for ing_idx in range(len(of_ports)):
+ ingress_port = of_ports[ing_idx]
+ for egr_idx in range(len(of_ports)):
+ if egr_idx == ing_idx:
+ continue
+ egress_port = of_ports[egr_idx]
+ flow_match_test_port_pair_mpls(parent, ingress_port, egress_port,
+ wildcards=wildcards,
+ mpls_type=mpls_type,
+ mpls_label=mpls_label,
+ mpls_tc=mpls_tc,
+ mpls_ttl=mpls_ttl,
+ mpls_label_int=mpls_label_int,
+ mpls_tc_int=mpls_tc_int,
+ mpls_ttl_int=mpls_ttl_int,
+ ip_ttl=ip_ttl,
+ label_match=label_match,
+ tc_match=tc_match,
+ dl_type_match=dl_type_match,
+ exp_mpls_type=exp_mpls_type,
+ exp_mpls_label=exp_mpls_label,
+ exp_mpls_tc=exp_mpls_tc,
+ exp_mpls_ttl=exp_mpls_ttl,
+ exp_mpls_ttl_int=exp_mpls_ttl_int,
+ exp_ip_ttl=exp_ip_ttl,
+ match_exp=match_exp,
+ exp_msg=exp_msg,
+ exp_msg_type=exp_msg_type,
+ exp_msg_code=exp_msg_code,
+ add_tag_exp=add_tag_exp,
+ pkt=pkt, exp_pkt=exp_pkt,
+ action_list=action_list,
+ check_expire=check_expire)
+ test_count += 1
+ if (max_test > 0) and (test_count >= max_test):
+ logging.info("Ran " + str(test_count) + " tests; exiting")
+ return
+
+def flow_stats_get(parent, match_fields = None):
+ """ Get the flow_stats from the switch
+ Test the response to make sure it's really a flow_stats object
+ """
+ request = ofp.message.flow_stats_request()
+ request.out_port = ofp.OFPP_ANY
+ request.out_group = ofp.OFPG_ANY
+ request.table_id = 0xff
+ if match_fields != None:
+ request.match_fields = match_fields
+ response, _ = parent.controller.transact(request, timeout=2)
+ parent.assertTrue(response is not None, "Did not get response")
+ parent.assertTrue(isinstance(response,ofp.message.flow_stats_reply),
+ "Expected a flow_stats_reply, but didn't get it")
+ return response