blob: fefe7707e44c7859da91542a2bc6c3edd66fe0f5 [file] [log] [blame]
Rich Lane4d9f0f62013-05-09 15:50:57 -07001# Copyright 2013, Big Switch Networks, Inc.
2#
3# LoxiGen is licensed under the Eclipse Public License, version 1.0 (EPL), with
4# the following special exception:
5#
6# LOXI Exception
7#
8# As a special exception to the terms of the EPL, you may distribute libraries
9# generated by LoxiGen (LoxiGen Libraries) under the terms of your choice, provided
10# that copyright and licensing notices generated by LoxiGen are not altered or removed
11# from the LoxiGen Libraries and the notice provided below is (i) included in
12# the LoxiGen Libraries, if distributed in source code form and (ii) included in any
13# documentation for the LoxiGen Libraries, if distributed in binary form.
14#
15# Notice: "Copyright 2013, Big Switch Networks, Inc. This library was generated by the LoxiGen Compiler."
16#
17# You may not use this file except in compliance with the EPL or LOXI Exception. You may obtain
18# a copy of the EPL at:
19#
20# http://www.eclipse.org/legal/epl-v10.html
21#
22# Unless required by applicable law or agreed to in writing, software
23# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
25# EPL for the specific language governing permissions and limitations
26# under the EPL.
27
Andreas Wundsamfef7d5f2013-08-01 22:15:44 -070028from generic_utils import find
Rich Lane4d9f0f62013-05-09 15:50:57 -070029from collections import namedtuple
30
31# This module is intended to be imported like this: from loxi_ir import *
32# All public names are prefixed with 'OF'.
33__all__ = [
34 'OFInput',
35 'OFProtocol',
36 'OFClass',
37 'OFDataMember',
38 'OFTypeMember',
Andreas Wundsam780e0c92013-08-02 17:48:27 -070039 'OFDiscriminatorMember',
Rich Lane4d9f0f62013-05-09 15:50:57 -070040 'OFLengthMember',
41 'OFFieldLengthMember',
42 'OFPadMember',
43 'OFEnum',
Andreas Wundsam4ee51462013-07-30 11:00:37 -070044 'OFEnumEntry'
Rich Lane4d9f0f62013-05-09 15:50:57 -070045]
46
47"""
48One input file
49
50@param wire_versions Set of integer wire versions this file applies to
51@param classes List of OFClass objects in the same order as in the file
52@param enums List of Enum objects in the same order as in the file
53"""
54OFInput = namedtuple('OFInput', ['wire_versions', 'classes', 'enums'])
55
56"""
57One version of the OpenFlow protocol
58
59Combination of multiple OFInput objects.
60
61@param wire_version
62@param classes List of OFClass objects
63@param enums List of Enum objects
64"""
65OFProtocol = namedtuple('OFProtocol', ['wire_version', 'classes', 'enums'])
66
67"""
68An OpenFlow class
69
70All compound objects like messages, actions, instructions, etc are
71uniformly represented by this class.
72
73The members are in the same order as on the wire.
74
75@param name
Andreas Wundsam780e0c92013-08-02 17:48:27 -070076@param superclass name of the super class
Rich Lane4d9f0f62013-05-09 15:50:57 -070077@param members List of *Member objects
Andreas Wundsamfef7d5f2013-08-01 22:15:44 -070078@param params optional dictionary of parameters
Rich Lane4d9f0f62013-05-09 15:50:57 -070079"""
Andreas Wundsam780e0c92013-08-02 17:48:27 -070080class OFClass(namedtuple('OFClass', ['name', 'superclass', 'members', 'virtual', 'params'])):
Andreas Wundsamfef7d5f2013-08-01 22:15:44 -070081 def member_by_name(self, name):
82 return find(self.members, lambda m: hasattr(m, "name") and m.name == name)
Rich Lane4d9f0f62013-05-09 15:50:57 -070083
84"""
85Normal field
86
87@param name
88@param oftype C-like type string
89
90Example: packet_in.buffer_id
91"""
92OFDataMember = namedtuple('OFDataMember', ['name', 'oftype'])
93
94"""
Andreas Wundsam780e0c92013-08-02 17:48:27 -070095Field that declares that this is an abstract super-class and
96that the sub classes will be discriminated based on this field.
97E.g., 'type' is the discriminator member of the abstract superclass
98of_action.
99
100@param name
101"""
102OFDiscriminatorMember = namedtuple('OFDiscrminatorMember', ['name', 'oftype'])
103
104"""
Rich Lane4d9f0f62013-05-09 15:50:57 -0700105Field used to determine the type of an OpenFlow object
106
107@param name
108@param oftype C-like type string
109@param value Fixed type value
110
111Example: packet_in.type, flow_add._command
112"""
113OFTypeMember = namedtuple('OFTypeMember', ['name', 'oftype', 'value'])
114
115"""
116Field with the length of the containing object
117
118@param name
119@param oftype C-like type string
120
121Example: packet_in.length, action_output.len
122"""
123OFLengthMember = namedtuple('OFLengthMember', ['name', 'oftype'])
124
125"""
126Field with the length of another field in the containing object
127
128@param name
129@param oftype C-like type string
130@param field_name Peer field whose length this field contains
131
132Example: packet_out.actions_len (only usage)
133"""
134OFFieldLengthMember = namedtuple('OFFieldLengthMember', ['name', 'oftype', 'field_name'])
135
136"""
137Zero-filled padding
138
139@param length Length in bytes
140
141Example: packet_in.pad
142"""
143OFPadMember = namedtuple('OFPadMember', ['length'])
144
145"""
146An OpenFlow enumeration
147
148All values are Python ints.
149
150@param name
Andreas Wundsam4ee51462013-07-30 11:00:37 -0700151@param entries List of OFEnumEntry objects in input order
152@params dict of optional params. Currently defined:
153 - wire_type: the low_level type of the enum values (uint8,...)
Rich Lane4d9f0f62013-05-09 15:50:57 -0700154"""
Andreas Wundsam4ee51462013-07-30 11:00:37 -0700155class OFEnum(namedtuple('OFEnum', ['name', 'entries', 'params'])):
156 @property
157 def values(self):
158 return [(e.name, e.value) for e in self.entries]
159
160OFEnumEntry = namedtuple('OFEnumEntry', ['name', 'value', 'params'])