1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
"""Defines actions that may be associated with flows packets."""
# System imports
from enum import Enum
# Local source tree imports
from pyof.v0x01.foundation.base import GenericBitMask, GenericStruct
from pyof.v0x01.foundation.basic_types import (PAD, HWAddress, UBInt8, UBInt16,
UBInt32)
# Third-party imports
__all__ = ('ActionType', 'ActionHeader', 'ActionOutput', 'ActionEnqueue',
'ActionVlanVid', 'ActionVlanPCP', 'ActionDLAddr', 'ActionNWAddr',
'ActionNWTos', 'ActionTPPort', 'ActionVendorHeader')
# Enums
class ActionType(GenericBitMask):
"""Actions associated with flows and packets."""
#: Output to switch port.
OFPAT_OUTPUT = 0
#: Set the 802.1q VLAN id.
OFPAT_SET_VLAN_VID = 1
#: Set the 802.1q priority.
OFPAT_SET_VLAN_PCP = 2
#: Strip the 802.1q header.
OFPAT_STRIP_VLAN = 3
#: Ethernet source address.
OFPAT_SET_DL_SRC = 4
#: Ethernet destination address.
OFPAT_SET_DL_DST = 5
#: IP source address.
OFPAT_SET_NW_SRC = 6
#: IP destination address.
OFPAT_SET_NW_DST = 7
#: IP ToS (DSCP field, 6 bits).
OFPAT_SET_NW_TOS = 8
#: TCP/UDP source port.
OFPAT_SET_TP_SRC = 9
#: TCP/UDP destination port.
OFPAT_SET_TP_DST = 10
#: Output to queue.
OFPAT_ENQUEUE = 11
#: Vendor specific.
OFPAT_VENDOR = 0xffff
# Classes
class ActionHeader(GenericStruct):
"""Defines the Header that is common to all actions."""
action_type = UBInt16(enum_ref=ActionType)
length = UBInt16()
#: Pad for 64-bit alignment.
pad = PAD(4)
def __init__(self, action_type=None, length=None):
"""The following constructor parameters are optional.
Args:
action_type (ActionType): The type of the action.
length (int): Length of action, including this header.
"""
super().__init__()
self.action_type = action_type
self.length = length
class ActionOutput(GenericStruct):
"""Defines the actions output.
Action structure for :attr:`ActionType.OFPAT_OUTPUT`, which sends packets
out :attr:`port`. When the :attr:`port` is the
:attr:`.Port.OFPP_CONTROLLER`, :attr:`max_length` indicates the max number
of bytes to send. A :attr:`max_length` of zero means no bytes of the packet
should be sent.
"""
type = UBInt16(ActionType.OFPAT_OUTPUT, enum_ref=ActionType)
length = UBInt16(8)
port = UBInt16()
max_length = UBInt16()
def __init__(self, port=None, max_length=None):
"""The following constructor parameters are optional.
Args:
port (:class:`Port` or :class:`int`): Output port.
max_length (int): Max length to send to controller.
"""
super().__init__()
self.port = port
self.max_length = max_length
class ActionEnqueue(GenericStruct):
"""Send packets to a queue's port.
A switch may support only queues that are tied to specific PCP/TOS bits.
In that case, we cannot map an arbitrary flow to a specific queue,
therefore the action ENQUEUE is not supported. The user can still use
these queues and map flows to them by setting the relevant fields
(TOS, VLAN PCP).
"""
type = UBInt16(ActionType.OFPAT_ENQUEUE, enum_ref=ActionType)
length = UBInt16(16)
port = UBInt16()
#: Pad for 64-bit alignment.
pad = PAD(6)
queue_id = UBInt32()
def __init__(self, port=None, queue_id=None):
"""The following constructor parameters are optional.
Args:
port (physical port or :attr:`.Port.OFPP_IN_PORT`): Queue's port.
queue_id (int): Where to enqueue the packets.
"""
super().__init__()
self.port = port
self.queue_id = queue_id
class ActionVlanVid(GenericStruct):
"""Action structure for :attr:`ActionType.OFPAT_SET_VLAN_VID`.
.. note:: The vlan_vid field is 16 bits long,
when an actual VLAN id is only 12 bits.
The value 0xffff is used to indicate that no VLAN id was set
"""
type = UBInt16(ActionType.OFPAT_SET_VLAN_PCP, enum_ref=ActionType)
length = UBInt16(8)
vlan_id = UBInt16()
#: Pad for bit alignment.
pad2 = PAD(2)
def __init__(self, vlan_id=None):
"""The following constructor parameters are optional.
Args:
vlan_id (int): VLAN priority.
"""
super().__init__()
self.vlan_id = vlan_id
class ActionVlanPCP(GenericStruct):
"""Action structure for :attr:`ActionType.OFPAT_SET_VLAN_PCP`."""
type = UBInt16(ActionType.OFPAT_SET_VLAN_PCP, enum_ref=ActionType)
length = UBInt16(8)
vlan_pcp = UBInt8()
#: Pad for bit alignment.
pad = PAD(3)
def __init__(self, vlan_pcp=None):
"""The following constructor parameters are optional.
Args:
vlan_pcp (int): VLAN Priority.
.. note:: The vlan_pcp field is 8 bits long,
but only the lower 3 bits have meaning.
"""
super().__init__()
self.vlan_pcp = vlan_pcp
class ActionDLAddr(GenericStruct):
"""Action structure for :attr:`ActionType.OFPAT_SET_DL_SRC` or _DST."""
dl_addr_type = UBInt16(enum_ref=ActionType)
length = UBInt16(16)
dl_addr = HWAddress()
#: Pad for bit alignment.
pad = PAD(6)
def __init__(self, dl_addr_type=None, dl_addr=None):
"""The following constructor parameters are optional.
Args:
dl_addr_type (ActionType): :attr:`~ActionType.OFPAT_SET_DL_SRC` or
:attr:`~ActionType.OFPAT_SET_DL_DST`.
dl_addr (:class:`~.HWAddress`): Ethernet address.
Defaults to None.
"""
super().__init__()
self.dl_addr_type = dl_addr_type
self.dl_addr = dl_addr
class ActionNWAddr(GenericStruct):
"""Action structure for :attr:`ActionType.OFPAT_SET_NW_SRC` or _DST."""
nw_addr_type = UBInt16(enum_ref=ActionType)
length = UBInt16(8)
nw_addr = UBInt32()
def __init__(self, nw_addr_type=None, nw_addr=None):
"""The following constructor parameters are optional.
Args:
nw_addr_type (ActionType): :attr:`~ActionType.OFPAT_SET_NW_SRC` or
:attr:`~ActionType.OFPAT_SET_NW_DST`.
nw_addr (int): IP Address.
"""
super().__init__()
self.nw_addr_type = nw_addr_type
self.nw_addr = nw_addr
class ActionNWTos(GenericStruct):
"""Action structure for :attr:`ActionType.OFPAT_SET_NW_TOS`.
.. note:: The nw_tos field is the 6 upper bits of the ToS field to set,
in the original bit positions (shifted to the left by 2).
"""
nw_tos_type = UBInt16(enum_ref=ActionType)
length = UBInt16(8)
nw_tos = UBInt8()
#: Pad for bit alignment.
pad = PAD(3)
def __init__(self, nw_tos_type=None, nw_tos=None):
"""The following constructor parameters are optional.
Args:
nw_tos_type (ActionType): :attr:`~ActionType.OFPAT_SET_NW_SRC` or
:attr:`~ActionType.OFPAT_SET_NW_SRC`.
nw_tos (int): IP ToS (DSCP field, 6 bits).
"""
super().__init__()
self.nw_tos_type = nw_tos_type
self.nw_tos = nw_tos
class ActionTPPort(GenericStruct):
"""Action structure for :attr:`ActionType.OFPAT_SET_TP_SRC` or _DST."""
tp_port_type = UBInt16(enum_ref=ActionType)
length = UBInt16(8)
tp_port = UBInt16()
#: Pad for bit alignment.
pad = PAD(2)
def __init__(self, tp_port_type=None, tp_port=None):
"""The following constructor parameters are optional.
Args:
tp_port_type (ActionType): :attr:`~ActionType.OFPAT_SET_TP_SRC` or
:attr:`~ActionType.OFPAT_SET_TP_DST`.
tp_port (int): TCP/UDP/other port to set.
"""
super().__init__()
self.tp_port_type = tp_port_type
self.tp_port = tp_port
class ActionVendorHeader(GenericStruct):
"""Action header for :attr:`ActionType.OFPAT_VENDOR`.
The rest of the body is vendor-defined.
"""
type = UBInt16(ActionType.OFPAT_VENDOR, enum_ref=ActionType)
length = UBInt16()
vendor = UBInt32()
def __init__(self, length=None, vendor=None):
"""The following constructor parameters are optional.
Args:
length (int): Length is a multiple of 8.
vender (int): Vendor ID with the same form as in VendorHeader.
Defaults to None.
"""
super().__init__()
self.length = length
self.vendor = vendor
|
