50769ac837
Signed-off-by: IWAMOTO Toshihiro <iwamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
407 lines
14 KiB
Python
407 lines
14 KiB
Python
# Copyright (C) 2015 Nippon Telegraph and Telephone Corporation.
|
|
# Copyright (C) 2015 YAMAMOTO Takashi <yamamoto at valinux co jp>
|
|
#
|
|
# 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 struct
|
|
|
|
from ryu import utils
|
|
from ryu.lib import type_desc
|
|
from ryu.ofproto import nicira_ext
|
|
from ryu.ofproto import ofproto_common
|
|
from ryu.lib.pack_utils import msg_pack_into
|
|
from ryu.ofproto.ofproto_parser import StringifyMixin
|
|
|
|
|
|
def generate(ofp_name, ofpp_name):
|
|
import sys
|
|
import string
|
|
import functools
|
|
|
|
ofp = sys.modules[ofp_name]
|
|
ofpp = sys.modules[ofpp_name]
|
|
|
|
class _NXFlowSpec(StringifyMixin):
|
|
_hdr_fmt_str = '!H' # 2 bit 0s, 1 bit src, 2 bit dst, 11 bit n_bits
|
|
_dst_type = None
|
|
_subclasses = {}
|
|
_TYPE = {
|
|
'nx-flow-spec-field': [
|
|
'src',
|
|
'dst',
|
|
]
|
|
}
|
|
|
|
def __init__(self, src, dst, n_bits):
|
|
self.src = src
|
|
self.dst = dst
|
|
self.n_bits = n_bits
|
|
|
|
@classmethod
|
|
def register(cls, subcls):
|
|
assert issubclass(subcls, cls)
|
|
assert subcls._dst_type not in cls._subclasses
|
|
cls._subclasses[subcls._dst_type] = subcls
|
|
|
|
@classmethod
|
|
def parse(cls, buf):
|
|
(hdr,) = struct.unpack_from(cls._hdr_fmt_str, buf, 0)
|
|
rest = buf[struct.calcsize(cls._hdr_fmt_str):]
|
|
if hdr == 0:
|
|
return None, rest # all-0 header is no-op for padding
|
|
src_type = (hdr >> 13) & 0x1
|
|
dst_type = (hdr >> 11) & 0x3
|
|
n_bits = hdr & 0x3ff
|
|
subcls = cls._subclasses[dst_type]
|
|
if src_type == 0: # subfield
|
|
src = cls._parse_subfield(rest)
|
|
rest = rest[6:]
|
|
elif src_type == 1: # immediate
|
|
src_len = (n_bits + 15) // 16 * 2
|
|
src_bin = rest[:src_len]
|
|
src = type_desc.IntDescr(size=src_len).to_user(src_bin)
|
|
rest = rest[src_len:]
|
|
if dst_type == 0: # match
|
|
dst = cls._parse_subfield(rest)
|
|
rest = rest[6:]
|
|
elif dst_type == 1: # load
|
|
dst = cls._parse_subfield(rest)
|
|
rest = rest[6:]
|
|
elif dst_type == 2: # output
|
|
dst = '' # empty
|
|
return subcls(src=src, dst=dst, n_bits=n_bits), rest
|
|
|
|
def serialize(self):
|
|
buf = bytearray()
|
|
if isinstance(self.src, tuple):
|
|
src_type = 0 # subfield
|
|
else:
|
|
src_type = 1 # immediate
|
|
# header
|
|
val = (src_type << 13) | (self._dst_type << 11) | self.n_bits
|
|
msg_pack_into(self._hdr_fmt_str, buf, 0, val)
|
|
# src
|
|
if src_type == 0: # subfield
|
|
buf += self._serialize_subfield(self.src)
|
|
elif src_type == 1: # immediate
|
|
src_len = (self.n_bits + 15) // 16 * 2
|
|
buf += type_desc.IntDescr(size=src_len).from_user(self.src)
|
|
# dst
|
|
if self._dst_type == 0: # match
|
|
buf += self._serialize_subfield(self.dst)
|
|
elif self._dst_type == 1: # load
|
|
buf += self._serialize_subfield(self.dst)
|
|
elif self._dst_type == 2: # output
|
|
pass # empty
|
|
return buf
|
|
|
|
@staticmethod
|
|
def _parse_subfield(buf):
|
|
(n, len) = ofp.oxm_parse_header(buf, 0)
|
|
assert len == 4 # only 4-bytes NXM/OXM are defined
|
|
field = ofp.oxm_to_user_header(n)
|
|
rest = buf[len:]
|
|
(ofs,) = struct.unpack_from('!H', rest, 0)
|
|
return (field, ofs)
|
|
|
|
@staticmethod
|
|
def _serialize_subfield(subfield):
|
|
(field, ofs) = subfield
|
|
buf = bytearray()
|
|
n = ofp.oxm_from_user_header(field)
|
|
ofp.oxm_serialize_header(n, buf, 0)
|
|
assert len(buf) == 4 # only 4-bytes NXM/OXM are defined
|
|
msg_pack_into('!H', buf, 4, ofs)
|
|
return buf
|
|
|
|
class NXFlowSpecMatch(_NXFlowSpec):
|
|
# Add a match criteria
|
|
# an example of the corresponding ovs-ofctl syntax:
|
|
# NXM_OF_VLAN_TCI[0..11]
|
|
_dst_type = 0
|
|
|
|
class NXFlowSpecLoad(_NXFlowSpec):
|
|
# Add NXAST_REG_LOAD actions
|
|
# an example of the corresponding ovs-ofctl syntax:
|
|
# NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[]
|
|
_dst_type = 1
|
|
|
|
class NXFlowSpecOutput(_NXFlowSpec):
|
|
# Add an OFPAT_OUTPUT action
|
|
# an example of the corresponding ovs-ofctl syntax:
|
|
# output:NXM_OF_IN_PORT[]
|
|
_dst_type = 2
|
|
|
|
def __init__(self, src, n_bits, dst=''):
|
|
assert dst == ''
|
|
super(NXFlowSpecOutput, self).__init__(src=src, dst=dst,
|
|
n_bits=n_bits)
|
|
|
|
class NXAction(ofpp.OFPActionExperimenter):
|
|
_fmt_str = '!H' # subtype
|
|
_subtypes = {}
|
|
_experimenter = ofproto_common.NX_EXPERIMENTER_ID
|
|
|
|
def __init__(self):
|
|
super(NXAction, self).__init__(experimenter=self._experimenter)
|
|
self.subtype = self._subtype
|
|
|
|
@classmethod
|
|
def parse(cls, buf):
|
|
fmt_str = NXAction._fmt_str
|
|
(subtype,) = struct.unpack_from(fmt_str, buf, 0)
|
|
subtype_cls = cls._subtypes.get(subtype)
|
|
rest = buf[struct.calcsize(fmt_str):]
|
|
if subtype_cls is None:
|
|
return NXActionUnknown(subtype, rest)
|
|
return subtype_cls.parse(rest)
|
|
|
|
def serialize(self, buf, offset):
|
|
super(NXAction, self).serialize(buf, offset)
|
|
msg_pack_into(NXAction._fmt_str,
|
|
buf,
|
|
offset + ofp.OFP_ACTION_EXPERIMENTER_HEADER_SIZE,
|
|
self.subtype)
|
|
|
|
@classmethod
|
|
def register(cls, subtype_cls):
|
|
assert subtype_cls._subtype is not cls._subtypes
|
|
cls._subtypes[subtype_cls._subtype] = subtype_cls
|
|
|
|
class NXActionUnknown(NXAction):
|
|
def __init__(self, subtype, data=None,
|
|
type_=None, len_=None, experimenter=None):
|
|
super(NXActionUnknown, self).__init__()
|
|
self.data = data
|
|
|
|
@classmethod
|
|
def parse(cls, subtype, buf):
|
|
return cls(data=buf)
|
|
|
|
def serialize(self, buf, offset):
|
|
# fixup
|
|
data = self.data
|
|
if data is None:
|
|
data = bytearray()
|
|
payload_offset = (
|
|
ofp.OFP_ACTION_EXPERIMENTER_HEADER_SIZE +
|
|
struct.calcsize(NXAction._fmt_str)
|
|
)
|
|
self.len = utils.round_up(payload_offset + len(data), 8)
|
|
super(NXActionUnknown, self).serialize(buf, offset)
|
|
buf += data
|
|
|
|
class NXActionRegMove(NXAction):
|
|
_subtype = nicira_ext.NXAST_REG_MOVE
|
|
_fmt_str = '!HHH' # n_bits, src_ofs, dst_ofs
|
|
# Followed by OXM fields (src, dst) and padding to 8 bytes boundary
|
|
_TYPE = {
|
|
'ascii': [
|
|
'src_field',
|
|
'dst_field',
|
|
]
|
|
}
|
|
|
|
def __init__(self, src_field, dst_field, n_bits, src_ofs=0, dst_ofs=0,
|
|
type_=None, len_=None, experimenter=None, subtype=None):
|
|
super(NXActionRegMove, self).__init__()
|
|
self.n_bits = n_bits
|
|
self.src_ofs = src_ofs
|
|
self.dst_ofs = dst_ofs
|
|
self.src_field = src_field
|
|
self.dst_field = dst_field
|
|
|
|
@classmethod
|
|
def parse(cls, buf):
|
|
(n_bits, src_ofs, dst_ofs,) = struct.unpack_from(
|
|
NXActionRegMove._fmt_str, buf, 0)
|
|
rest = buf[struct.calcsize(NXActionRegMove._fmt_str):]
|
|
# src field
|
|
(n, len) = ofp.oxm_parse_header(rest, 0)
|
|
src_field = ofp.oxm_to_user_header(n)
|
|
rest = rest[len:]
|
|
# dst field
|
|
(n, len) = ofp.oxm_parse_header(rest, 0)
|
|
dst_field = ofp.oxm_to_user_header(n)
|
|
rest = rest[len:]
|
|
# ignore padding
|
|
return cls(src_field, dst_field=dst_field, n_bits=n_bits,
|
|
src_ofs=src_ofs, dst_ofs=dst_ofs)
|
|
|
|
def serialize(self, buf, offset):
|
|
# fixup
|
|
data = bytearray()
|
|
msg_pack_into(NXActionRegMove._fmt_str, data, 0,
|
|
self.n_bits, self.src_ofs, self.dst_ofs)
|
|
# src field
|
|
n = ofp.oxm_from_user_header(self.src_field)
|
|
ofp.oxm_serialize_header(n, data, len(data))
|
|
# dst field
|
|
n = ofp.oxm_from_user_header(self.dst_field)
|
|
ofp.oxm_serialize_header(n, data, len(data))
|
|
payload_offset = (
|
|
ofp.OFP_ACTION_EXPERIMENTER_HEADER_SIZE +
|
|
struct.calcsize(NXAction._fmt_str)
|
|
)
|
|
self.len = utils.round_up(payload_offset + len(data), 8)
|
|
super(NXActionRegMove, self).serialize(buf, offset)
|
|
msg_pack_into('!%ds' % len(data), buf, offset + payload_offset,
|
|
bytes(data))
|
|
|
|
class NXActionLearn(NXAction):
|
|
_subtype = nicira_ext.NXAST_LEARN
|
|
|
|
# idle_timeout, hard_timeout, priority, cookie, flags,
|
|
# table_id, pad, fin_idle_timeout, fin_hard_timeout
|
|
_fmt_str = '!HHHQHBxHH'
|
|
# Followed by flow_mod_specs
|
|
|
|
def __init__(self,
|
|
table_id,
|
|
specs,
|
|
idle_timeout=0,
|
|
hard_timeout=0,
|
|
priority=ofp.OFP_DEFAULT_PRIORITY,
|
|
cookie=0,
|
|
flags=0,
|
|
fin_idle_timeout=0,
|
|
fin_hard_timeout=0,
|
|
type_=None, len_=None, experimenter=None, subtype=None):
|
|
super(NXActionLearn, self).__init__()
|
|
self.idle_timeout = idle_timeout
|
|
self.hard_timeout = hard_timeout
|
|
self.priority = priority
|
|
self.cookie = cookie
|
|
self.flags = flags
|
|
self.table_id = table_id
|
|
self.fin_idle_timeout = fin_idle_timeout
|
|
self.fin_hard_timeout = fin_hard_timeout
|
|
self.specs = specs
|
|
|
|
@classmethod
|
|
def parse(cls, buf):
|
|
(idle_timeout,
|
|
hard_timeout,
|
|
priority,
|
|
cookie,
|
|
flags,
|
|
table_id,
|
|
fin_idle_timeout,
|
|
fin_hard_timeout,) = struct.unpack_from(
|
|
NXActionLearn._fmt_str, buf, 0)
|
|
rest = buf[struct.calcsize(NXActionLearn._fmt_str):]
|
|
# specs
|
|
specs = []
|
|
while len(rest) > 0:
|
|
spec, rest = _NXFlowSpec.parse(rest)
|
|
if spec is None:
|
|
continue
|
|
specs.append(spec)
|
|
return cls(idle_timeout=idle_timeout,
|
|
hard_timeout=hard_timeout,
|
|
priority=priority,
|
|
cookie=cookie,
|
|
flags=flags,
|
|
table_id=table_id,
|
|
fin_idle_timeout=fin_idle_timeout,
|
|
fin_hard_timeout=fin_hard_timeout,
|
|
specs=specs)
|
|
|
|
def serialize(self, buf, offset):
|
|
# fixup
|
|
data = bytearray()
|
|
msg_pack_into(NXActionLearn._fmt_str, data, 0,
|
|
self.idle_timeout,
|
|
self.hard_timeout,
|
|
self.priority,
|
|
self.cookie,
|
|
self.flags,
|
|
self.table_id,
|
|
self.fin_idle_timeout,
|
|
self.fin_hard_timeout)
|
|
for spec in self.specs:
|
|
data += spec.serialize()
|
|
payload_offset = (
|
|
ofp.OFP_ACTION_EXPERIMENTER_HEADER_SIZE +
|
|
struct.calcsize(NXAction._fmt_str)
|
|
)
|
|
self.len = utils.round_up(payload_offset + len(data), 8)
|
|
super(NXActionLearn, self).serialize(buf, offset)
|
|
msg_pack_into('!%ds' % len(data), buf, offset + payload_offset,
|
|
bytes(data))
|
|
|
|
class NXActionConjunction(NXAction):
|
|
_subtype = nicira_ext.NXAST_CONJUNCTION
|
|
|
|
# clause, n_clauses, id
|
|
_fmt_str = '!BBI'
|
|
|
|
def __init__(self,
|
|
clause,
|
|
n_clauses,
|
|
id_,
|
|
type_=None, len_=None, experimenter=None, subtype=None):
|
|
super(NXActionConjunction, self).__init__()
|
|
self.clause = clause
|
|
self.n_clauses = n_clauses
|
|
self.id = id_
|
|
|
|
@classmethod
|
|
def parse(cls, buf):
|
|
(clause,
|
|
n_clauses,
|
|
id_,) = struct.unpack_from(
|
|
NXActionConjunction._fmt_str, buf, 0)
|
|
return cls(clause, n_clauses, id_)
|
|
|
|
def serialize(self, buf, offset):
|
|
data = bytearray()
|
|
msg_pack_into(NXActionConjunction._fmt_str, data, 0,
|
|
self.clause,
|
|
self.n_clauses,
|
|
self.id)
|
|
payload_offset = (
|
|
ofp.OFP_ACTION_EXPERIMENTER_HEADER_SIZE +
|
|
struct.calcsize(NXAction._fmt_str)
|
|
)
|
|
self.len = utils.round_up(payload_offset + len(data), 8)
|
|
super(NXActionConjunction, self).serialize(buf, offset)
|
|
msg_pack_into('!%ds' % len(data), buf, offset + payload_offset,
|
|
bytes(data))
|
|
|
|
def add_attr(k, v):
|
|
v.__module__ = ofpp.__name__ # Necessary for stringify stuff
|
|
setattr(ofpp, k, v)
|
|
|
|
add_attr('NXAction', NXAction)
|
|
add_attr('NXActionUnknown', NXActionUnknown)
|
|
|
|
classes = [
|
|
'NXActionRegMove',
|
|
'NXActionLearn',
|
|
'NXActionConjunction',
|
|
'_NXFlowSpec', # exported for testing
|
|
'NXFlowSpecMatch',
|
|
'NXFlowSpecLoad',
|
|
'NXFlowSpecOutput',
|
|
]
|
|
vars = locals()
|
|
for name in classes:
|
|
cls = vars[name]
|
|
add_attr(name, cls)
|
|
if issubclass(cls, NXAction):
|
|
NXAction.register(cls)
|
|
if issubclass(cls, _NXFlowSpec):
|
|
_NXFlowSpec.register(cls)
|