OpenFlow Switch Specification

OpenFlow Switch Specification
OpenFlow Switch Specification
Version 1.4.0 (Wire Protocol 0x05)
October 14, 2013
ONF TS-012
OpenFlow Switch Specification
Version 1.4.0
Disclaimer
THIS SPECIFICATION IS PROVIDED ”AS IS” WITH NO WARRANTIES WHATSOEVER,
INCLUDING ANY WARRANTY OF MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR ANY PARTICULAR PURPOSE, OR ANY WARRANTY OTHERWISE ARISING
OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE. Without limitation, ONF disclaims all liability, including liability for infringement of any proprietary rights, relating to use
of information in this specification and to the implementation of this specification, and ONF
disclaims all liability for cost of procurement of substitute goods or services, lost profits, loss of
use, loss of data or any incidental, consequential, direct, indirect, or special damages, whether
under contract, tort, warranty or otherwise, arising in any way out of use or reliance upon this
specification or any information herein.
No license, express or implied, by estoppel or otherwise, to any Open Networking Foundation or
Open Networking Foundation member intellectual property rights is granted herein.
Except that a license is hereby granted by ONF to copy and reproduce this specification for
internal use only.
Contact the Open Networking Foundation at http://www.opennetworking.org for information
on specification licensing through membership agreements.
Any marks and brands contained herein are the property of their respective owners.
Contents
1 Introduction
9
2 Switch Components
9
3 Glossary
10
4 OpenFlow Ports
4.1 OpenFlow Ports
4.2 Standard Ports .
4.3 Physical Ports . .
4.4 Logical Ports . .
4.5 Reserved Ports .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
11
11
12
12
12
12
5 OpenFlow Tables
5.1 Pipeline Processing .
5.2 Flow Table . . . . .
5.3 Matching . . . . . .
5.4 Table-miss . . . . . .
5.5 Flow Removal . . . .
5.6 Group Table . . . .
5.6.1 Group Types
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
13
14
15
16
17
17
18
18
.
.
.
.
.
2
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
5.7
Meter Table . . . . . . . . . . . . . . . .
5.7.1 Meter Bands . . . . . . . . . . .
5.8 Counters . . . . . . . . . . . . . . . . . .
5.9 Instructions . . . . . . . . . . . . . . . .
5.10 Action Set . . . . . . . . . . . . . . . . .
5.11 Action List . . . . . . . . . . . . . . . .
5.12 Actions . . . . . . . . . . . . . . . . . .
5.12.1 Default values for fields on push
6 OpenFlow Channel
6.1 OpenFlow Protocol Overview . . . .
6.1.1 Controller-to-Switch . . . . .
6.1.2 Asynchronous . . . . . . . . .
6.1.3 Symmetric . . . . . . . . . .
6.2 Message Handling . . . . . . . . . .
6.3 OpenFlow Channel Connections . .
6.3.1 Connection Setup . . . . . .
6.3.2 Connection Interruption . . .
6.3.3 Encryption . . . . . . . . . .
6.3.4 Multiple Controllers . . . . .
6.3.5 Auxiliary Connections . . . .
6.4 Flow Table Modification Messages .
6.5 Flow Table Synchronisation . . . . .
6.6 Group Table Modification Messages
6.7 Meter Modification Messages . . . .
6.8 Bundle Messages . . . . . . . . . . .
6.8.1 Bundle overview . . . . . . .
6.8.2 Bundle example usage . . . .
6.8.3 Bundle error processing . . .
6.8.4 Bundle atomic modifications
6.8.5 Bundle parallelism . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
19
20
20
22
22
23
24
26
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
26
26
27
27
28
28
29
30
31
31
31
34
35
38
39
41
42
42
42
43
43
44
7 The OpenFlow Protocol
7.1 OpenFlow Header . . . . . . . . . . . . . . . .
7.1.1 Padding . . . . . . . . . . . . . . . . . .
7.2 Common Structures . . . . . . . . . . . . . . .
7.2.1 Port Structures . . . . . . . . . . . . . .
7.2.1.1 Port Description Structures . .
7.2.1.2 Port Description Properties . .
7.2.2 Flow Match Structures . . . . . . . . . .
7.2.2.1 Flow Match Header . . . . . .
7.2.2.2 Flow Match Field Structures .
7.2.2.3 OXM classes . . . . . . . . . .
7.2.2.4 Flow Matching . . . . . . . . .
7.2.2.5 Flow Match Field Masking . .
7.2.2.6 Flow Match Field Prerequisite
7.2.2.7 Flow Match Fields . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
44
44
46
46
46
46
48
51
51
52
53
53
54
54
55
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
3
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
7.3
Version 1.4.0
7.2.2.8 Experimenter Flow Match Fields
7.2.3 Flow Instruction Structures . . . . . . . .
7.2.4 Action Structures . . . . . . . . . . . . . .
7.2.5 Experimenter Structure . . . . . . . . . .
Controller-to-Switch Messages . . . . . . . . . . .
7.3.1 Handshake . . . . . . . . . . . . . . . . .
7.3.2 Switch Configuration . . . . . . . . . . . .
7.3.3 Flow Table Configuration . . . . . . . . .
7.3.4 Modify State Messages . . . . . . . . . . .
7.3.4.1 Modify Flow Table Message . .
7.3.4.2 Modify Flow Entry Message . .
7.3.4.3 Modify Group Entry Message . .
7.3.4.4 Port Modification Message . . .
7.3.4.5 Meter Modification Message . .
7.3.5 Multipart Messages . . . . . . . . . . . .
7.3.5.1 Description . . . . . . . . . . . .
7.3.5.2 Individual Flow Statistics . . . .
7.3.5.3 Aggregate Flow Statistics . . . .
7.3.5.4 Table Statistics . . . . . . . . . .
7.3.5.5 Table Description . . . . . . . .
7.3.5.6 Table Features . . . . . . . . . .
7.3.5.7 Port Statistics . . . . . . . . . .
7.3.5.8 Port Description . . . . . . . . .
7.3.5.9 Queue Statistics . . . . . . . . .
7.3.5.10 Queue Descriptions . . . . . . .
7.3.5.11 Group Statistics . . . . . . . . .
7.3.5.12 Group Description . . . . . . . .
7.3.5.13 Group Features . . . . . . . . .
7.3.5.14 Meter Statistics . . . . . . . . .
7.3.5.15 Meter Configuration Statistics .
7.3.5.16 Meter Features Statistics . . . .
7.3.5.17 Flow monitoring . . . . . . . . .
7.3.5.18 Experimenter Multipart . . . . .
7.3.6 Packet-Out Message . . . . . . . . . . . .
7.3.7 Barrier Message . . . . . . . . . . . . . .
7.3.8 Role Request Message . . . . . . . . . . .
7.3.9 Bundle messages . . . . . . . . . . . . . .
7.3.9.1 Bundle control messages . . . .
7.3.9.2 Bundle Add message . . . . . .
7.3.9.3 Bundle flags . . . . . . . . . . .
7.3.9.4 Bundle properties . . . . . . . .
7.3.9.5 Creating and opening a bundle .
7.3.9.6 Adding messages to a bundle . .
7.3.9.7 Closing a bundle . . . . . . . . .
7.3.9.8 Committing Bundles . . . . . . .
7.3.9.9 Discarding Bundles . . . . . . .
7.3.9.10 Other bundle error conditions .
4
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
60
60
62
68
69
69
70
71
71
71
74
77
79
81
84
87
88
89
90
90
91
96
99
100
102
104
105
105
106
107
107
107
113
113
114
114
115
115
116
117
117
118
118
119
120
121
121
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
7.4
7.5
Version 1.4.0
7.3.10 Set Asynchronous Configuration Message
Asynchronous Messages . . . . . . . . . . . . . .
7.4.1 Packet-In Message . . . . . . . . . . . . .
7.4.2 Flow Removed Message . . . . . . . . . .
7.4.3 Port Status Message . . . . . . . . . . . .
7.4.4 Controller Role Status Message . . . . . .
7.4.5 Table Status Message . . . . . . . . . . .
7.4.6 Request Forward Message . . . . . . . . .
Symmetric Messages . . . . . . . . . . . . . . . .
7.5.1 Hello . . . . . . . . . . . . . . . . . . . . .
7.5.2 Echo Request . . . . . . . . . . . . . . . .
7.5.3 Echo Reply . . . . . . . . . . . . . . . . .
7.5.4 Error Message . . . . . . . . . . . . . . .
7.5.5 Experimenter Message . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
A Header file openflow.h
121
124
124
126
127
128
129
130
130
130
131
132
132
139
140
B Release Notes
B.1 OpenFlow version 0.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.2 OpenFlow version 0.2.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.3 OpenFlow version 0.8.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.4 OpenFlow version 0.8.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.5 OpenFlow version 0.8.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.6 OpenFlow version 0.8.9 . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.6.1 IP Netmasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.6.2 New Physical Port Stats . . . . . . . . . . . . . . . . . . . . . . . .
B.6.3 IN PORT Virtual Port . . . . . . . . . . . . . . . . . . . . . . . . .
B.6.4 Port and Link Status and Configuration . . . . . . . . . . . . . . .
B.6.5 Echo Request/Reply Messages . . . . . . . . . . . . . . . . . . . .
B.6.6 Vendor Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.6.7 Explicit Handling of IP Fragments . . . . . . . . . . . . . . . . . .
B.6.8 802.1D Spanning Tree . . . . . . . . . . . . . . . . . . . . . . . . .
B.6.9 Modify Actions in Existing Flow Entries . . . . . . . . . . . . . . .
B.6.10 More Flexible Description of Tables . . . . . . . . . . . . . . . . .
B.6.11 Lookup Count in Tables . . . . . . . . . . . . . . . . . . . . . . . .
B.6.12 Modifying Flags in Port-Mod More Explicit . . . . . . . . . . . . .
B.6.13 New Packet-Out Message Format . . . . . . . . . . . . . . . . . . .
B.6.14 Hard Timeout for Flow Entries . . . . . . . . . . . . . . . . . . . .
B.6.15 Reworked initial handshake to support backwards compatibility . .
B.6.16 Description of Switch Stat . . . . . . . . . . . . . . . . . . . . . . .
B.6.17 Variable Length and Vendor Actions . . . . . . . . . . . . . . . . .
B.6.18 VLAN Action Changes . . . . . . . . . . . . . . . . . . . . . . . .
B.6.19 Max Supported Ports Set to 65280 . . . . . . . . . . . . . . . . . .
B.6.20 Send Error Message When Flow Not Added Due To Full Tables . .
B.6.21 Behavior Defined When Controller Connection Lost . . . . . . . .
B.6.22 ICMP Type and Code Fields Now Matchable . . . . . . . . . . . .
B.6.23 Output Port Filtering for Delete*, Flow Stats and Aggregate Stats
5
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
174
175
175
175
175
176
176
176
177
177
177
178
178
179
179
180
180
180
181
181
181
182
183
183
184
185
185
185
186
186
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
B.7 OpenFlow version 0.9 . . . . . . . . . . . . . . . . . . . . . . . . .
B.7.1 Failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.7.2 Emergency Flow Cache . . . . . . . . . . . . . . . . . . . .
B.7.3 Barrier Command . . . . . . . . . . . . . . . . . . . . . . .
B.7.4 Match on VLAN Priority Bits . . . . . . . . . . . . . . . . .
B.7.5 Selective Flow Expirations . . . . . . . . . . . . . . . . . . .
B.7.6 Flow Mod Behavior . . . . . . . . . . . . . . . . . . . . . .
B.7.7 Flow Expiration Duration . . . . . . . . . . . . . . . . . . .
B.7.8 Notification for Flow Deletes . . . . . . . . . . . . . . . . .
B.7.9 Rewrite DSCP in IP ToS header . . . . . . . . . . . . . . .
B.7.10 Port Enumeration now starts at 1 . . . . . . . . . . . . . .
B.7.11 Other changes to the Specification . . . . . . . . . . . . . .
B.8 OpenFlow version 1.0 . . . . . . . . . . . . . . . . . . . . . . . . .
B.8.1 Slicing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.8.2 Flow cookies . . . . . . . . . . . . . . . . . . . . . . . . . .
B.8.3 User-specifiable datapath description . . . . . . . . . . . . .
B.8.4 Match on IP fields in ARP packets . . . . . . . . . . . . . .
B.8.5 Match on IP ToS/DSCP bits . . . . . . . . . . . . . . . . .
B.8.6 Querying port stats for individual ports . . . . . . . . . . .
B.8.7 Improved flow duration resolution in stats/expiry messages
B.8.8 Other changes to the Specification . . . . . . . . . . . . . .
B.9 OpenFlow version 1.1 . . . . . . . . . . . . . . . . . . . . . . . . .
B.9.1 Multiple Tables . . . . . . . . . . . . . . . . . . . . . . . . .
B.9.2 Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
B.9.3 Tags : MPLS & VLAN . . . . . . . . . . . . . . . . . . . .
B.9.4 Virtual ports . . . . . . . . . . . . . . . . . . . . . . . . . .
B.9.5 Controller connection failure . . . . . . . . . . . . . . . . .
B.9.6 Other changes . . . . . . . . . . . . . . . . . . . . . . . . .
B.10 OpenFlow version 1.2 . . . . . . . . . . . . . . . . . . . . . . . . .
B.10.1 Extensible match support . . . . . . . . . . . . . . . . . . .
B.10.2 Extensible ’set field’ packet rewriting support . . . . . . . .
B.10.3 Extensible context expression in ’packet-in’ . . . . . . . . .
B.10.4 Extensible Error messages via experimenter error type . . .
B.10.5 IPv6 support added . . . . . . . . . . . . . . . . . . . . . .
B.10.6 Simplified behaviour of flow-mod request . . . . . . . . . .
B.10.7 Removed packet parsing specification . . . . . . . . . . . .
B.10.8 Controller role change mechanism . . . . . . . . . . . . . .
B.10.9 Other changes . . . . . . . . . . . . . . . . . . . . . . . . .
B.11 OpenFlow version 1.3 . . . . . . . . . . . . . . . . . . . . . . . . .
B.11.1 Refactor capabilities negotiation . . . . . . . . . . . . . . .
B.11.2 More flexible table miss support . . . . . . . . . . . . . . .
B.11.3 IPv6 Extension Header handling support . . . . . . . . . .
B.11.4 Per flow meters . . . . . . . . . . . . . . . . . . . . . . . . .
B.11.5 Per connection event filtering . . . . . . . . . . . . . . . . .
B.11.6 Auxiliary connections . . . . . . . . . . . . . . . . . . . . .
B.11.7 MPLS BoS matching . . . . . . . . . . . . . . . . . . . . . .
B.11.8 Provider Backbone Bridging tagging . . . . . . . . . . . . .
6
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
186
186
187
187
187
187
187
187
188
188
188
188
188
188
189
189
189
189
189
189
189
190
190
191
191
191
192
192
192
192
193
193
193
193
194
194
194
194
195
195
195
196
196
196
197
197
197
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
B.11.9 Rework tag order . . . . . . . . . . . .
B.11.10Tunnel-ID metadata . . . . . . . . . .
B.11.11Cookies in packet-in . . . . . . . . . .
B.11.12Duration for stats . . . . . . . . . . .
B.11.13On demand flow counters . . . . . . .
B.11.14Other changes . . . . . . . . . . . . .
B.12 OpenFlow version 1.3.1 . . . . . . . . . . . .
B.12.1 Improved version negotiation . . . . .
B.12.2 Other changes . . . . . . . . . . . . .
B.13 OpenFlow version 1.3.2 . . . . . . . . . . . .
B.13.1 Changes . . . . . . . . . . . . . . . . .
B.13.2 Clarifications . . . . . . . . . . . . . .
B.14 OpenFlow version 1.4.0 . . . . . . . . . . . .
B.14.1 More extensible wire protocol . . . . .
B.14.2 More descriptive reasons for packet-in
B.14.3 Optical port properties . . . . . . . .
B.14.4 Flow-removed reason for meter delete
B.14.5 Flow monitoring . . . . . . . . . . . .
B.14.6 Role status events . . . . . . . . . . .
B.14.7 Eviction . . . . . . . . . . . . . . . . .
B.14.8 Vacancy events . . . . . . . . . . . . .
B.14.9 Bundles . . . . . . . . . . . . . . . . .
B.14.10Synchronised tables . . . . . . . . . .
B.14.11Group and Meter change notifications
B.14.12Error code for bad priority . . . . . .
B.14.13Error code for Set-async-config . . . .
B.14.14PBB UCA header field . . . . . . . . .
B.14.15Error code for duplicate instruction .
B.14.16Error code for multipart timeout . . .
B.14.17Change default TCP port to 6653 . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
C Credits
197
198
198
198
198
198
198
199
199
200
200
200
200
200
201
201
202
202
202
203
203
203
203
204
204
204
204
204
205
205
205
List of Tables
1
2
3
4
5
6
7
8
9
10
11
Main components of a flow entry in a flow table. . . . . . . . . . .
Main components of a group entry in the group table. . . . . . . .
Main components of a meter entry in the meter table. . . . . . . .
Main components of a meter band in a meter entry. . . . . . . . .
List of counters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Push/pop tag actions. . . . . . . . . . . . . . . . . . . . . . . . . .
Change-TTL actions. . . . . . . . . . . . . . . . . . . . . . . . . . .
Existing fields that may be copied into new fields on a push action.
OXM TLV header fields. . . . . . . . . . . . . . . . . . . . . . . . .
OXM mask and value. . . . . . . . . . . . . . . . . . . . . . . . . .
Required match fields. . . . . . . . . . . . . . . . . . . . . . . . . .
7
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
15
18
19
20
21
25
25
26
52
54
57
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
12
13
Version 1.4.0
Match fields details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match combinations for VLAN tags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
58
59
List of Figures
1
2
3
4
Main components of an OpenFlow switch. . . . . . . . . . . .
Packet flow through the processing pipeline. . . . . . . . . . .
Flowchart detailing packet flow through an OpenFlow switch.
OXM TLV header layout. . . . . . . . . . . . . . . . . . . . .
8
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
9
14
16
52
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
1 Introduction
This document describes the requirements of an OpenFlow Switch. We recommend that you read the
latest version of the OpenFlow whitepaper before reading this specification. The whitepaper is available on the Open Networking Foundation website (https://www.opennetworking.org/standards/
intro-to-openflow). This specification covers the components and the basic functions of the switch,
and the OpenFlow protocol to manage an OpenFlow switch from a remote controller.
Controller
OpenFlow Protocol
OpenFlow
Channel
Flow
Table
Group
Table
...
Flow
Table
Pipeline
OpenFlow Switch
Figure 1: Main components of an OpenFlow switch.
2 Switch Components
An OpenFlow Switch consists of one or more flow tables and a group table, which perform packet
lookups and forwarding, and an OpenFlow channel to an external controller (Figure 1). The switch
communicates with the controller and the controller manages the switch via the OpenFlow protocol.
Using the OpenFlow protocol, the controller can add, update, and delete flow entries in flow tables,
both reactively (in response to packets) and proactively. Each flow table in the switch contains a set
of flow entries; each flow entry consists of match fields, counters, and a set of instructions to apply to
matching packets (see 5.2).
Matching starts at the first flow table and may continue to additional flow tables (see 5.1). Flow entries
match packets in priority order, with the first matching entry in each table being used (see 5.3). If
a matching entry is found, the instructions associated with the specific flow entry are executed. If no
match is found in a flow table, the outcome depends on configuration of the table-miss flow entry: for
example, the packet may be forwarded to the controller over the OpenFlow channel, dropped, or may
continue to the next flow table (see 5.4).
Instructions associated with each flow entry either contain actions or modify pipeline processing (see
5.9). Actions included in instructions describe packet forwarding, packet modification and group table
9
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
processing. Pipeline processing instructions allow packets to be sent to subsequent tables for further
processing and allow information, in the form of metadata, to be communicated between tables. Table
pipeline processing stops when the instruction set associated with a matching flow entry does not specify
a next table; at this point the packet is usually modified and forwarded (see 5.10).
Flow entries may forward to a port. This is usually a physical port, but it may also be a logical port
defined by the switch or a reserved port defined by this specification (see 4.1). Reserved ports may
specify generic forwarding actions such as sending to the controller, flooding, or forwarding using nonOpenFlow methods, such as “normal” switch processing (see 4.5), while switch-defined logical ports
may specify link aggregation groups, tunnels or loopback interfaces (see 4.4).
Actions associated with flow entries may also direct packets to a group, which specifies additional
processing (see 5.6). Groups represent sets of actions for flooding, as well as more complex forwarding
semantics (e.g. multipath, fast reroute, and link aggregation). As a general layer of indirection, groups
also enable multiple flow entries to forward to a single identifier (e.g. IP forwarding to a common next
hop). This abstraction allows common output actions across flow entries to be changed efficiently.
The group table contains group entries; each group entry contains a list of action buckets with specific
semantics dependent on group type (see 5.6.1). The actions in one or more action buckets are applied
to packets sent to the group.
Switch designers are free to implement the internals in any way convenient, provided that correct match
and instruction semantics are preserved. For example, while a flow entry may use an all group to
forward to multiple ports, a switch designer may choose to implement this as a single bitmask within
the hardware forwarding table. Another example is matching; the pipeline exposed by an OpenFlow
switch may be physically implemented with a different number of hardware tables.
3 Glossary
This section describes key OpenFlow specification terms:
ˆ Byte: an 8-bit octet.
ˆ Packet: an Ethernet frame, including header and payload.
ˆ Port: where packets enter and exit the OpenFlow pipeline (see 4.1). May be a physical port, a
logical port defined by the switch, or a reserved port defined by the OpenFlow protocol.
ˆ Pipeline: the set of linked flow tables that provide matching, forwarding, and packet modification
in an OpenFlow switch.
ˆ Flow Table: a stage of the pipeline. It contains flow entries.
ˆ Flow Entry: an element in a flow table used to match and process packets. It contains a set of
match fields for matching packets, a priority for matching precedence, a set of counters to track
packets, and a set of instructions to apply.
ˆ Match Field: a field against which a packet is matched, including packet headers, the ingress
port, and the metadata value. A match field may be wildcarded (match any value) and in some
cases bitmasked.
10
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
ˆ Metadata: a maskable register value that is used to carry information from one table to the next.
ˆ Instruction: instructions are attached to a flow entry and describe the OpenFlow processing that
happens when a packet matches the flow entry. An instruction either modifies pipeline processing,
such as directing the packet to another flow table, or contains a set of actions to add to the action
set, or contains a list of actions to apply immediately to the packet.
ˆ Action: an operation that forwards the packet to a port or modifies the packet, such as decrementing the TTL field. Actions may be specified as part of the instruction set associated with a
flow entry or in an action bucket associated with a group entry. Actions may be accumulated in
the Action Set of the packet or applied immediately to the packet.
ˆ Action Set: a set of actions associated with the packet that are accumulated while the packet
is processed by each table and that are executed when the instruction set instructs the packet to
exit the processing pipeline.
ˆ Group: a list of action buckets and some means of choosing one or more of those buckets to apply
on a per-packet basis.
ˆ Action Bucket: a set of actions and associated parameters, defined for groups.
ˆ Tag: a header that can be inserted or removed from a packet via push and pop actions.
ˆ Outermost Tag: the tag that appears closest to the beginning of a packet.
ˆ Controller: an entity interacting with the OpenFlow switch using the OpenFlow protocol.
ˆ Meter: a switch element that can measure and control the rate of packets. The meter triggers
a meter band if the packet rate or byte rate passing through the meter exceeds a predefined
threshold. If the meter band drops the packet, it is called a Rate Limiter.
4 OpenFlow Ports
This section describes the OpenFlow port abstraction and the various types of OpenFlow ports supported by OpenFlow.
4.1 OpenFlow Ports
OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the
rest of the network. OpenFlow switches connect logically to each other via their OpenFlow ports.
An OpenFlow switch makes a number of OpenFlow ports available for OpenFlow processing. The set of
OpenFlow ports may not be identical to the set of network interfaces provided by the switch hardware,
some network interfaces may be disabled for OpenFlow, and the OpenFlow switch may define additional
OpenFlow ports.
OpenFlow packets are received on an ingress port and processed by the OpenFlow pipeline (see 5.1)
which may forward them to an output port. The packet ingress port is a property of the packet
throughout the OpenFlow pipeline and represents the OpenFlow port on which the packet was received
11
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
into the OpenFlow switch. The ingress port can be used when matching packets (see 5.3). The OpenFlow pipeline can decide to send the packet on an output port using the output action (see 5.12), which
defines how the packet goes back to the network.
An OpenFlow switch must support three types of OpenFlow ports: physical ports, logical ports and
reserved ports.
4.2 Standard Ports
The OpenFlow standard ports are defined as physical ports, logical ports, and the LOCAL reserved
port if supported (excluding other reserved ports).
Standard ports can be used as ingress and output ports, they can be used in groups (see 5.6), and they
have port counters (see 5.8).
4.3 Physical Ports
The OpenFlow physical ports are switch defined ports that correspond to a hardware interface of the
switch. For example, on an Ethernet switch, physical ports map one-to-one to the Ethernet interfaces.
In some deployments, the OpenFlow switch may be virtualised over the switch hardware. In those cases,
an OpenFlow physical port may represent a virtual slice of the corresponding hardware interface of the
switch.
4.4 Logical Ports
The OpenFlow logical ports are switch defined ports that don’t correspond directly to a hardware
interface of the switch. Logical ports are higher level abstractions that may be defined in the switch
using non-OpenFlow methods (e.g. link aggregation groups, tunnels, loopback interfaces).
Logical ports may include packet encapsulation and may map to various physical ports. The processing
done by the logical port must be transparent to OpenFlow processing and those ports must interact
with OpenFlow processing like OpenFlow physical ports.
The only differences between physical ports and logical ports is that a packet associated with a logical
port may have an extra metadata field called Tunnel-ID associated with it (see 7.2.2.7) and when a
packet received on a logical port is sent to the controller, both its logical port and its underlying physical
port are reported to the controller (see 7.4.1).
4.5 Reserved Ports
The OpenFlow reserved ports are defined by this specification. They specify generic forwarding
actions such as sending to the controller, flooding, or forwarding using non-OpenFlow methods, such
as “normal” switch processing.
A switch is not required to support all reserved ports, just those marked “Required” below.
12
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
ˆ Required: ALL: Represents all ports the switch can use for forwarding a specific packet. Can
be used only as an output port. In that case a copy of the packet is sent to all standard ports,
excluding the packet ingress port and ports that are configured OFPPC_NO_FWD.
ˆ Required: CONTROLLER: Represents the control channel with the OpenFlow controller. Can
be used as an ingress port or as an output port. When used as an output port, encapsulate the
packet in a packet-in message and send it using the OpenFlow protocol (see 7.4.1). When used as
an ingress port, this identifies a packet originating from the controller.
ˆ Required: TABLE: Represents the start of the OpenFlow pipeline (see 5.1). This port is only
valid in an output action in the action list of a packet-out message (see 7.3.6), and submits the
packet to the first flow table so that the packet can be processed through the regular OpenFlow
pipeline.
ˆ Required: IN PORT: Represents the packet ingress port. Can be used only as an output port,
send the packet out through its ingress port.
ˆ Required: ANY: Special value used in some OpenFlow commands when no port is specified (i.e.
port is wildcarded). Can neither be used as an ingress port nor as an output port.
ˆ Optional: LOCAL: Represents the switch’s local networking stack and its management stack.
Can be used as an ingress port or as an output port. The local port enables remote entities to
interact with the switch and its network services via the OpenFlow network, rather than via a
separate control network. With a suitable set of default flow entries it can be used to implement
an in-band controller connection.
ˆ Optional: NORMAL: Represents the traditional non-OpenFlow pipeline of the switch (see 5.1).
Can be used only as an output port and processes the packet using the normal pipeline. If the
switch cannot forward packets from the OpenFlow pipeline to the normal pipeline, it must indicate
that it does not support this action.
ˆ Optional: FLOOD: Represents flooding using the normal pipeline of the switch (see 5.1). Can
be used only as an output port, in general will send the packet out all standard ports, but not to
the ingress port, nor ports that are in OFPPS_BLOCKED state. The switch may also use the packet
VLAN ID to select which ports to flood.
OpenFlow-only switches do not support the NORMAL port and FLOOD port, while OpenFlow-hybrid
switches may support them (see 5.1). Forwarding packets to the FLOOD port depends on the switch
implementation and configuration, while forwarding using a group of type all enables the controller to
more flexibly implement flooding (see 5.6.1).
5 OpenFlow Tables
This section describes the components of flow tables and group tables, along with the mechanics of
matching and action handling.
13
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
OpenFlow Switch
Packet
In
Ingress
port
Action
Set = {}
Table
0
Packet +
ingress port +
metadata
Action
Set
...
Table
1
Table Packet
n
Action
Set
Execute
Action
Set
Packet
Out
(a) Packets are matched against multiple tables in the pipeline
➁ Match fields:
Match fields:
Ingress port +
metadata +
pkt hdrs
Action set
➀ Find highest-priority matching flow entry
➁ Apply instructions:
Ingress port +
metadata +
pkt hdrs
Flow
Table
Action set
➀
i. Modify packet & update match fields
(apply actions instruction)
ii. Update action set (clear actions and/or
write actions instructions)
iii. Update metadata
➂
➂ Send match data and action set to
next table
(b) Per-table packet processing
Figure 2: Packet flow through the processing pipeline.
5.1 Pipeline Processing
OpenFlow-compliant switches come in two types: OpenFlow-only, and OpenFlow-hybrid. OpenFlowonly switches support only OpenFlow operation, in those switches all packets are processed by the
OpenFlow pipeline, and can not be processed otherwise.
OpenFlow-hybrid switches support both OpenFlow operation and normal Ethernet switching operation, i.e. traditional L2 Ethernet switching, VLAN isolation, L3 routing (IPv4 routing, IPv6 routing...),
ACL and QoS processing. Those switches must provide a classification mechanism outside of OpenFlow
that routes traffic to either the OpenFlow pipeline or the normal pipeline. For example, a switch may
use the VLAN tag or input port of the packet to decide whether to process the packet using one pipeline
or the other, or it may direct all packets to the OpenFlow pipeline. This classification mechanism is
outside the scope of this specification. An OpenFlow-hybrid switch may also allow a packet to go from
the OpenFlow pipeline to the normal pipeline through the NORMAL and FLOOD reserved ports (see
4.5).
The OpenFlow pipeline of every OpenFlow switch contains multiple flow tables, each flow table
containing multiple flow entries. The OpenFlow pipeline processing defines how packets interact with
those flow tables (see Figure 2). An OpenFlow switch is required to have at least one flow table, and
can optionally have more flow tables. An OpenFlow switch with only a single flow table is valid, in this
case pipeline processing is greatly simplified.
14
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The flow tables of an OpenFlow switch are sequentially numbered, starting at 0. Pipeline processing
always starts at the first flow table: the packet is first matched against flow entries of flow table 0.
Other flow tables may be used depending on the outcome of the match in the first table.
When processed by a flow table, the packet is matched against the flow entries of the flow table to
select a flow entry (see 5.3). If a flow entry is found, the instruction set included in that flow entry
is executed. These instructions may explicitly direct the packet to another flow table (using the Goto
Instruction, see 5.9), where the same process is repeated again. A flow entry can only direct a packet to
a flow table number which is greater than its own flow table number, in other words pipeline processing
can only go forward and not backward. Obviously, the flow entries of the last table of the pipeline can
not include the Goto instruction. If the matching flow entry does not direct packets to another flow
table, pipeline processing stops at this table. When pipeline processing stops, the packet is processed
with its associated action set and usually forwarded (see 5.10).
If a packet does not match a flow entry in a flow table, this is a table miss. The behavior on a table
miss depends on the table configuration (see 5.4). A table-miss flow entry in the flow table can specify
how to process unmatched packets: options include dropping them, passing them to another table or
sending them to the controller over the control channel via packet-in messages (see 6.1.2).
The OpenFlow pipeline and various OpenFlow operations process packets of a specific type in conformance with the specifications defined for that packet type, unless the present specification or the
OpenFlow configuration specify otherwise. For example, the Ethernet header definition used by OpenFlow must conform to IEEE specifications, and the TCP/IP header definition used by OpenFlow must
conform to RFC specifications. Additionally, packet reordering in an OpenFlow switch must conform
to the requirements of IEEE specifications, provided that the packets are processed by the same flow
entries, group bucket and meter band.
5.2 Flow Table
A flow table consists of flow entries.
Match Fields
Priority
Counters
Instructions
Timeouts
Cookie
Table 1: Main components of a flow entry in a flow table.
Each flow table entry (see Table 1) contains:
ˆ match fields: to match against packets. These consist of the ingress port and packet headers,
and optionally metadata specified by a previous table.
ˆ priority: matching precedence of the flow entry.
ˆ counters: updated when packets are matched.
ˆ instructions: to modify the action set or pipeline processing.
ˆ timeouts: maximum amount of time or idle time before flow is expired by the switch.
ˆ cookie: opaque data value chosen by the controller. May be used by the controller to filter flow
statistics, flow modification and flow deletion. Not used when processing packets.
15
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
A flow table entry is identified by its match fields and priority: the match fields and priority taken
together identify a unique flow entry in the flow table. The flow entry that wildcards all fields (all fields
omitted) and has priority equal to 0 is called the table-miss flow entry (see 5.4).
5.3 Matching
Packet In
Start at table 0
Yes
Match in
table n?
Yes
Update counters
Execute instructions:
• update action set
• update packet/match set fields
• update metadata
No
Tablemiss flow
entry
exists?
GotoTable n?
No
Execute action
set
Yes
No
Drop packet
Figure 3: Flowchart detailing packet flow through an OpenFlow switch.
On receipt of a packet, an OpenFlow Switch performs the functions shown in Figure 3. The switch starts
by performing a table lookup in the first flow table, and based on pipeline processing, may perform
table lookups in other flow tables (see 5.1).
Packet match fields are extracted from the packet. Packet match fields used for table lookups depend
on the packet type, and typically include various packet header fields, such as Ethernet source address
or IPv4 destination address (see 7.2.2). In addition to packet headers, matches can also be performed
against the ingress port and metadata fields. Metadata may be used to pass information between tables
in a switch. The packet match fields represent the packet in its current state, if actions applied in a
previous table using the Apply-Actions changed the packet headers, those changes are reflected in the
packet match fields.
A packet matches a flow table entry if the values in the packet match fields used for the lookup match
those defined in the flow table entry. If a flow table entry field has a value of ANY (field omitted), it
matches all possible values in the header. If the switch supports arbitrary bitmasks on specific match
fields, these masks can more precisely specify matches.
The packet is matched against the table and only the highest priority flow entry that matches the
packet must be selected. The counters associated with the selected flow entry must be updated and the
instruction set included in the selected flow entry must be applied. If there are multiple matching flow
16
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
entries with the same highest priority, the selected flow entry is explicitly undefined. This case can only
arise when a controller writer never sets the OFPFF_CHECK_OVERLAP bit on flow mod messages and adds
overlapping entries.
IP fragments must be reassembled before pipeline processing if the switch configuration contains the
OFPC_FRAG_REASM flag (see 7.3.2).
This version of the specification does not define the expected behavior when a switch receives a malformed or corrupted packet.
5.4 Table-miss
Every flow table must support a table-miss flow entry to process table misses. The table-miss flow entry
specifies how to process packets unmatched by other flow entries in the flow table (see 5.1), and may,
for example, send packets to the controller, drop packets or direct packets to a subsequent table.
The table-miss flow entry is identified by its match and its priority (see 5.2), it wildcards all match
fields (all fields omitted) and has the lowest priority (0). The match of the table-miss flow entry
may fall outside the normal range of matches supported by a flow table, for example an exact match
table would not support wildcards for other flow entries but must support the table-miss flow entry
wildcarding all fields. The table-miss flow entry may not have the same capability as regular flow entry
(see 7.3.5.6). The table-miss flow entry must support at least sending packets to the controller using the
CONTROLLER reserved port (see 4.5) and dropping packets using the Clear-Actions instruction (see
5.9). Implementations are encouraged to support directing packets to a subsequent table when possible
for compatibility with earlier versions of this specification.
The table-miss flow entry behaves in most ways like any other flow entry: it does not exist by default in
a flow table, the controller may add it or remove it at any time (see 6.4), and it may expire (see 5.5). The
table-miss flow entry matches packets in the table as expected from its set of match fields and priority
(see 5.3): it matches packets unmatched by other flow entries in the flow table. The table-miss flow
entry instructions are applied to packets matching the table-miss flow entry (see 5.9). If the table-miss
flow entry directly sends packets to the controller using the CONTROLLER reserved port (see 4.5), the
packet-in reason must identify a table-miss (see 7.4.1).
If the table-miss flow entry does not exist, by default packets unmatched by flow entries are dropped
(discarded). A switch configuration, for example using the OpenFlow Configuration Protocol, may
override this default and specify another behaviour.
5.5 Flow Removal
Flow entries are removed from flow tables in three ways, either at the request of the controller, via the
switch flow expiry mechanism, or via the optional switch eviction mechanism.
The switch flow expiry mechanism is run by the switch independently of the controller and is based on
the state and configuration of flow entries. Each flow entry has an idle_timeout and a hard_timeout
associated with it. If the hard_timeout field is non-zero, the switch must note the flow entry’s arrival
time, as it may need to evict the entry later. A non-zero hard_timeout field causes the flow entry to
be removed after the given number of seconds, regardless of how many packets it has matched. If the
17
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
idle_timeout field is non-zero, the switch must note the arrival time of the last packet associated with
the flow, as it may need to evict the entry later. A non-zero idle_timeout field causes the flow entry to
be removed when it has matched no packets in the given number of seconds. The switch must implement
flow expiry and remove flow entries from the flow table when one of their timeouts is exceeded.
The controller may actively remove flow entries from flow tables by sending delete flow table modification messages (OFPFC_DELETE or OFPFC_DELETE_STRICT - see 6.4). Flow entries may also be removed
as the result of removal of a group (see 6.6) or a meter (see 6.7) by the controller.
Flow entries may be evicted from flow tables when the switch needs to reclaim resources. Flow entry
eviction occurs only on flow tables where it is explicitly enabled (see 7.3.3). Flow entry eviction is
an optional feature, and the mechanism used to select which flow entries to evict is switch defined
and may depend on flow entry parameters, resource mappings in the switch and other internal switch
constraints.
When a flow entry is removed, either by the controller, the flow expiry mechanism, or the optional
switch eviction mechanism, the switch must check the flow entry’s OFPFF_SEND_FLOW_REM flag. If this
flag is set, the switch must send a flow removed message to the controller. Each flow removed message
contains a complete description of the flow entry, the reason for removal (expiry, delete or eviction), the
flow entry duration at the time of removal, and the flow statistics at the time of removal.
5.6 Group Table
A group table consists of group entries. The ability for a flow entry to point to a group enables OpenFlow
to represent additional methods of forwarding (e.g. select and all).
Group Identifier
Group Type
Counters
Action Buckets
Table 2: Main components of a group entry in the group table.
Each group entry (see Table 2) is identified by its group identifier and contains:
ˆ group identifier: a 32 bit unsigned integer uniquely identifying the group
ˆ group type: to determine group semantics (see Section 5.6.1)
ˆ counters: updated when packets are processed by a group
ˆ action buckets: an ordered list of action buckets, where each action bucket contains a set of
actions to execute and associated parameters
5.6.1 Group Types
A switch is not required to support all group types, just those marked “Required” below. The controller
can also query the switch about which of the “Optional” group types it supports.
18
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
ˆ Required: all: Execute all buckets in the group. This group is used for multicast or broadcast
forwarding. The packet is effectively cloned for each bucket; one packet is processed for each
bucket of the group. If a bucket directs a packet explicitly out the ingress port, this packet clone
is dropped. If the controller writer wants to forward out the ingress port, the group must include
an extra bucket which includes an output action to the OFPP_IN_PORT reserved port.
ˆ Optional: select: Execute one bucket in the group. Packets are processed by a single bucket in
the group, based on a switch-computed selection algorithm (e.g. hash on some user-configured
tuple or simple round robin). All configuration and state for the selection algorithm is external
to OpenFlow. The selection algorithm should implement equal load sharing and can optionally
be based on bucket weights. When a port specified in a bucket in a select group goes down, the
switch may restrict bucket selection to the remaining set (those with forwarding actions to live
ports) instead of dropping packets destined to that port. This behavior may reduce the disruption
of a downed link or switch.
ˆ Required: indirect: Execute the one defined bucket in this group. This group supports only
a single bucket. Allows multiple flow entries or groups to point to a common group identifier,
supporting faster, more efficient convergence (e.g. next hops for IP forwarding). This group type
is effectively identical to an all group with one bucket.
ˆ Optional: fast failover: Execute the first live bucket. Each action bucket is associated with
a specific port and/or group that controls its liveness. The buckets are evaluated in the order
defined by the group, and the first bucket which is associated with a live port/group is selected.
This group type enables the switch to change forwarding without requiring a round trip to the
controller. If no buckets are live, packets are dropped. This group type must implement a liveness
mechanism (see 6.6).
5.7 Meter Table
A meter table consists of meter entries, defining per-flow meters. Per-flow meters enable OpenFlow to
implement various simple QoS operations, such as rate-limiting, and can be combined with per-port
queues (see 5.12) to implement complex QoS frameworks, such as DiffServ.
A meter measures the rate of packets assigned to it and enables controlling the rate of those packets.
Meters are attached directly to flow entries (as opposed to queues which are attached to ports). Any
flow entry can specify a meter in its instruction set (see 5.9): the meter measures and controls the rate
of the aggregate of all flow entries to which it is attached. Multiple meters can be used in the same
table, but in an exclusive way (disjoint set of flow entries). Multiple meters can be used on the same
set of packets by using them in successive flow tables.
Meter Identifier
Meter Bands
Counters
Table 3: Main components of a meter entry in the meter table.
Each meter entry (see Table 3) is identified by its meter identifier and contains:
ˆ meter identifier: a 32 bit unsigned integer uniquely identifying the meter
19
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
ˆ meter bands: an unordered list of meter bands, where each meter band specifies the rate of the
band and the way to process the packet
ˆ counters: updated when packets are processed by a meter
5.7.1 Meter Bands
Each meter may have one or more meter bands. Each band specifies the rate at which the band applies
and the way packets should be processed. Packets are processed by a single meter band based on the
current measured meter rate. The meter applies the meter band with the highest configured rate that
is lower than the current measured rate. If the current rate is lower than any specified meter band rate,
no meter band is applied.
Band Type
Rate
Counters
Type specific arguments
Table 4: Main components of a meter band in a meter entry.
Each meter band (see Table 4) is identified by its rate and contains:
ˆ band type: defines how packet are processed
ˆ rate: used by the meter to select the meter band, defines the lowest rate at which the band can
apply
ˆ counters: updated when packets are processed by a meter band
ˆ type specific arguments: some band types have optional arguments
There is no band type “Required” by this specification. The controller can query the switch about which
of the “Optional” meter band types it supports.
ˆ Optional: drop: drop (discard) the packet. Can be used to define a rate limiter band.
ˆ Optional: dscp remark: increase the drop precedence of the DSCP field in the IP header of the
packet. Can be used to define a simple DiffServ policer.
5.8 Counters
Counters are maintained for each flow table, flow entry, port, queue, group, group bucket, meter and
meter band. OpenFlow-compliant counters may be implemented in software and maintained by polling
hardware counters with more limited ranges. Table 5 contains the set of counters defined by the
OpenFlow specification. A switch is not required to support all counters, just those marked “Required”
in Table 5.
Duration refers to the amount of time the flow entry, a port, a group, a queue or a meter has been
installed in the switch, and must be tracked with second precision. The Receive Errors field is the total
of all receive and collision errors defined in Table 5, as well as any others not called out in the table.
Counters are unsigned and wrap around with no overflow indicator. If a specific numeric counter is not
available in the switch, its value must be set to the maximum field value (the unsigned equivalent of
-1).
20
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
Counter
Bits
Per Flow Table
Reference Count (active entries)
Packet Lookups
Packet Matches
Per Flow Entry
Received Packets
Received Bytes
Duration (seconds)
Duration (nanoseconds)
Per Port
Received Packets
Transmitted Packets
Received Bytes
Transmitted Bytes
Receive Drops
Transmit Drops
Receive Errors
Transmit Errors
Receive Frame Alignment Errors
Receive Overrun Errors
Receive CRC Errors
Collisions
Duration (seconds)
Duration (nanoseconds)
Per Queue
Transmit Packets
Transmit Bytes
Transmit Overrun Errors
Duration (seconds)
Duration (nanoseconds)
Per Group
Reference Count (flow entries)
Packet Count
Byte Count
Duration (seconds)
Duration (nanoseconds)
Per Group Bucket
Packet Count
Byte Count
Per Meter
Flow Count
Input Packet Count
Input Byte Count
Duration (seconds)
Duration (nanoseconds)
Per Meter Band
In Band Packet Count
In Band Byte Count
32
64
64
Required
Optional
Optional
64
64
32
32
Optional
Optional
Required
Optional
64
64
64
64
64
64
64
64
64
64
64
64
32
32
Required
Required
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Required
Optional
64
64
64
32
32
Required
Optional
Optional
Required
Optional
32
64
64
32
32
Optional
Optional
Optional
Required
Optional
64
64
Optional
Optional
32
64
64
32
32
Optional
Optional
Optional
Required
Optional
64
64
Optional
Optional
Table 5: List of counters.
21
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
5.9 Instructions
Each flow entry contains a set of instructions that are executed when a packet matches the entry. These
instructions result in changes to the packet, action set and/or pipeline processing.
A switch is not required to support all instruction types, just those marked “Required Instruction”
below. The controller can also query the switch about which of the “Optional Instruction” types it
supports.
ˆ Optional Instruction: Meter meter id : Direct packet to the specified meter. As the result of
the metering, the packet may be dropped (depending on meter configuration and state).
ˆ Optional Instruction: Apply-Actions action(s): Applies the specific action(s) immediately,
without any change to the Action Set. This instruction may be used to modify the packet between
two tables or to execute multiple actions of the same type. The actions are specified as an action
list (see 5.11).
ˆ Optional Instruction: Clear-Actions: Clears all the actions in the action set immediately.
ˆ Required Instruction: Write-Actions action(s): Merges the specified action(s) into the current
action set (see 5.10). If an action of the given type exists in the current set, overwrite it, otherwise
add it.
ˆ Optional Instruction: Write-Metadata metadata / mask : Writes the masked metadata value
into the metadata field. The mask specifies which bits of the metadata register should be modified
(i.e. new metadata = old metadata & ˜mask | value & mask).
ˆ Required Instruction: Goto-Table next-table-id : Indicates the next table in the processing
pipeline. The table-id must be greater than the current table-id. The flow entries of the last table
of the pipeline can not include this instruction (see 5.1). OpenFlow switches with only a single
flow table are not required to implement this instruction.
The instruction set associated with a flow entry contains a maximum of one instruction of each type. The
instructions of the set execute in the order specified by this above list. In practice, the only constraints
are that the Meter instruction is executed before the Apply-Actions instruction, that the Clear-Actions
instruction is executed before the Write-Actions instruction, and that Goto-Table is executed last.
A switch must reject a flow entry if it is unable to execute the instructions associated with the flow
entry. In this case, the switch must return an unsupported flow error (see 6.4). Flow tables may not
support every match, every instruction or every action.
5.10 Action Set
An action set is associated with each packet. This set is empty by default. A flow entry can modify the
action set using a Write-Action instruction or a Clear-Action instruction associated with a particular
match. The action set is carried between flow tables. When the instruction set of a flow entry does
not contain a Goto-Table instruction, pipeline processing stops and the actions in the action set of the
packet are executed.
22
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
An action set contains a maximum of one action of each type. The set-field actions are identified by
their field types, therefore the action set contains a maximum of one set-field action for each field type
(i.e. multiple fields can be set). When multiple actions of the same type are required, e.g. pushing
multiple MPLS labels or popping multiple MPLS labels, the Apply-Actions instruction should be used
(see 5.11).
The actions in an action set are applied in the order specified below, regardless of the order that they
were added to the set. If an action set contains a group action, the actions in the appropriate action
bucket of the group are also applied in the order specified below. The switch may support arbitrary
action execution order through the action list of the Apply-Actions instruction.
1. copy TTL inwards: apply copy TTL inward actions to the packet
2. pop: apply all tag pop actions to the packet
3. push-MPLS: apply MPLS tag push action to the packet
4. push-PBB: apply PBB tag push action to the packet
5. push-VLAN: apply VLAN tag push action to the packet
6. copy TTL outwards: apply copy TTL outwards action to the packet
7. decrement TTL: apply decrement TTL action to the packet
8. set: apply all set-field actions to the packet
9. qos: apply all QoS actions, such as set queue to the packet
10. group: if a group action is specified, apply the actions of the relevant group bucket(s) in the
order specified by this list
11. output: if no group action is specified, forward the packet on the port specified by the output
action
The output action in the action set is executed last. If both an output action and a group action are
specified in an action set, the output action is ignored and the group action takes precedence. If no
output action and no group action were specified in an action set, the packet is dropped. The execution
of groups is recursive if the switch supports it; a group bucket may specify another group, in which case
the execution of actions traverses all the groups specified by the group configuration.
5.11 Action List
The Apply-Actions instruction and the Packet-out message include an action list. The semantics of the
action list is identical to the OpenFlow 1.0 specification. The actions of an action list are executed in
the order specified by the list, and are applied immediately to the packet.
The execution of an action list starts with the first action in the list and each action is executed on the
packet in sequence. The effect of those actions is cumulative, if the action list contains two Push VLAN
actions, two VLAN headers are added to the packet. If the action list contains an output action, a copy
of the packet is forwarded in its current state to the desired port. If the list contains group actions, a
copy of the packet in its current state is processed by the relevant group buckets.
23
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
After the execution of the action list in an Apply-Actions instruction, pipeline execution continues on
the modified packet (see 5.1). The action set of the packet is unchanged by the execution of the action
list.
5.12 Actions
A switch is not required to support all action types, just those marked “Required Action” below. The
controller can also query the switch about which of the “Optional Action” it supports.
Required Action: Output. The Output action forwards a packet to a specified OpenFlow port (see
4.1). OpenFlow switches must support forwarding to physical ports, switch-defined logical ports and
the required reserved ports (see 4.5).
Optional Action: Set-Queue. The set-queue action sets the queue id for a packet. When the packet is
forwarded to a port using the output action, the queue id determines which queue attached to this port
is used for scheduling and forwarding the packet. Forwarding behavior is dictated by the configuration
of the queue and is used to provide basic Quality-of-Service (QoS) support (see section 7.3.5.10).
Required Action: Drop. There is no explicit action to represent drops. Instead, packets whose action
sets have no output actions should be dropped. This result could come from empty instruction sets or
empty action buckets in the processing pipeline, or after executing a Clear-Actions instruction.
Required Action: Group. Process the packet through the specified group. The exact interpretation
depends on group type.
Optional Action: Push-Tag/Pop-Tag. Switches may support the ability to push/pop tags as shown
in Table 6. To aid integration with existing networks, we suggest that the ability to push/pop VLAN
tags be supported.
Newly pushed tags should always be inserted as the outermost tag in the outermost valid location for
that tag. When a new VLAN tag is pushed, it should be the outermost tag inserted, immediately after
the Ethernet header and before other tags. Likewise, when a new MPLS tag is pushed, it should be the
outermost tag inserted, immediately after the Ethernet header and before other tags.
When multiple push actions are added to the action set of the packet, they apply to the packet in the
order defined by the action set rules, first MPLS, then PBB, than VLAN (se 5.10). When multiple push
actions are included in an action list, they apply to the packet in the list order (see 5.11).
Note: Refer to section 5.12.1 for information on default field values.
Action
Push VLAN header
Associated Data
Ethertype
Description
Push a new VLAN header onto the packet.
The Ethertype is used as the Ethertype for the tag. Only
Ethertype 0x8100 and 0x88a8 should be used.
Pop the outer-most VLAN header from the packet.
Push a new MPLS shim header onto the packet.
The Ethertype is used as the Ethertype for the tag. Only
Ethertype 0x8847 and 0x8848 should be used.
Table 6 – Continued on next page
Pop VLAN header
Push MPLS header
Ethertype
24
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Action
Pop MPLS header
Push PBB header
Pop PBB header
Version 1.4.0
Table 6 – concluded from previous page
Associated Data
Description
Ethertype
Pop the outer-most MPLS tag or shim header from the packet.
The Ethertype is used as the Ethertype for the resulting packet
(Ethertype for the MPLS payload).
Ethertype
Push a new PBB service instance header (I-TAG TCI) onto
the packet (see 7.2.4).
The Ethertype is used as the Ethertype for the tag. Only
Ethertype 0x88E7 should be used.
Pop the outer-most PBB service instance header (I-TAG TCI)
from the packet (see 7.2.4).
Table 6: Push/pop tag actions.
Optional Action: Set-Field. The various Set-Field actions are identified by their field type and modify the values of respective header fields in the packet. While not strictly required, the support of
rewriting various header fields using Set-Field actions greatly increase the usefulness of an OpenFlow
implementation. To aid integration with existing networks, we suggest that VLAN modification actions
be supported. Set-Field actions should always be applied to the outermost-possible header (e.g. a
“Set VLAN ID” action always sets the ID of the outermost VLAN tag), unless the field type specifies
otherwise.
Optional Action: Change-TTL. The various Change-TTL actions modify the values of the IPv4 TTL,
IPv6 Hop Limit or MPLS TTL in the packet. While not strictly required, the actions shown in Table
7 greatly increase the usefulness of an OpenFlow implementation for implementing routing functions.
Change-TTL actions should always be applied to the outermost-possible header.
Action
Set MPLS TTL
Associated Data
8 bits: New MPLS TTL
Decrement MPLS TTL
-
Set IP TTL
8 bits: New IP TTL
Decrement IP TTL
-
Copy TTL outwards
-
Copy TTL inwards
-
Description
Replace the existing MPLS TTL. Only applies to packets
with an existing MPLS shim header.
Decrement the MPLS TTL. Only applies to packets with
an existing MPLS shim header.
Replace the existing IPv4 TTL or IPv6 Hop Limit and
update the IP checksum. Only applies to IPv4 and IPv6
packets.
Decrement the IPv4 TTL or IPv6 Hop Limit field and
update the IP checksum. Only applies to IPv4 and IPv6
packets.
Copy the TTL from next-to-outermost to outermost
header with TTL.
Copy can be IP-to-IP, MPLS-to-MPLS, or IP-to-MPLS.
Copy the TTL from outermost to next-to-outermost
header with TTL.
Copy can be IP-to-IP, MPLS-to-MPLS, or MPLS-to-IP.
Table 7: Change-TTL actions.
The OpenFlow switch checks for packets with invalid IP TTL or MPLS TTL and rejects them. Checking
for invalid TTL does not need to be done for every packet, but it must be done at a minimum every
time a decrement TTL action is applied to a packet. The asynchronous configuration of the switch may
25
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
be changed (see 6.1.1) to send packets with invalid TTL to the controller over the control channel via
a packet-in message (see 6.1.2).
5.12.1 Default values for fields on push
Field values for all fields specified in Table 8 should be copied from existing outer headers to new outer
headers when executing a push action. New fields listed in Table 8 without corresponding existing
fields should be set to zero. Fields that cannot be modified via OpenFlow set-field actions should be
initialized to appropriate protocol values.
New Fields
VLAN ID
VLAN priority
MPLS label
MPLS traffic class
←
←
←
←
MPLS TTL
←
PBB
PBB
PBB
PBB
←
←
←
←
I-SID
I-PCP
C-DA
C-SA
Existing Field(s)
VLAN ID
VLAN priority
MPLS label
MPLS
traffic class
(
MPLS TTL
IP TTL
PBB I-SID
VLAN PCP
ETH DST
ETH SRC
Table 8: Existing fields that may be copied into new fields on a push action.
Fields in new headers may be overridden by specifying a “set” action for the appropriate field(s) after
the push operation.
6 OpenFlow Channel
The OpenFlow channel is the interface that connects each OpenFlow switch to a controller. Through
this interface, the controller configures and manages the switch, receives events from the switch, and
sends packets out the switch.
Between the datapath and the OpenFlow channel, the interface is implementation-specific, however all
OpenFlow channel messages must be formatted according to the OpenFlow protocol. The OpenFlow
channel is usually encrypted using TLS, but may be run directly over TCP.
6.1 OpenFlow Protocol Overview
The OpenFlow protocol supports three message types, controller-to-switch, asynchronous, and symmetric, each with multiple sub-types. Controller-to-switch messages are initiated by the controller and
used to directly manage or inspect the state of the switch. Asynchronous messages are initiated by the
switch and used to update the controller of network events and changes to the switch state. Symmetric
messages are initiated by either the switch or the controller and sent without solicitation. The message
types used by OpenFlow are described below.
26
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
6.1.1 Controller-to-Switch
Controller/switch messages are initiated by the controller and may or may not require a response from
the switch.
Features: The controller may request the identity and the basic capabilities of a switch by sending
a features request; the switch must respond with a features reply that specifies the identity and basic
capabilities of the switch. This is commonly performed upon establishment of the OpenFlow channel.
Configuration: The controller is able to set and query configuration parameters in the switch. The
switch only responds to a query from the controller.
Modify-State: Modify-State messages are sent by the controller to manage state on the switches.
Their primary purpose is to add, delete and modify flow/group entries in the OpenFlow tables and to
set switch port properties.
Read-State: Read-State messages are used by the controller to collect various information from the
switch, such as current configuration, statistics and capabilities.
Packet-out: These are used by the controller to send packets out of a specified port on the switch, and
to forward packets received via Packet-in messages. Packet-out messages must contain a full packet or
a buffer ID referencing a packet stored in the switch. The message must also contain a list of actions
to be applied in the order they are specified; an empty action list drops the packet.
Barrier: Barrier request/reply messages are used by the controller to ensure message dependencies
have been met or to receive notifications for completed operations.
Role-Request: Role-Request messages are used by the controller to set the role of its OpenFlow
channel, or query that role. This is mostly useful when the switch connects to multiple controllers (see
6.3.4).
Asynchronous-Configuration: The Asynchronous-Configuration message are used by the controller
to set an additional filter on the asynchronous messages that it wants to receive on its OpenFlow
channel, or to query that filter. This is mostly useful when the switch connects to multiple controllers
(see 6.3.4) and commonly performed upon establishment of the OpenFlow channel.
6.1.2 Asynchronous
Asynchronous messages are sent without a controller soliciting them from a switch. Switches send
asynchronous messages to controllers to denote a packet arrival or switch state change. The three main
asynchronous message types are described below.
Packet-in: Transfer the control of a packet to the controller. For all packets forwarded to the CONTROLLER reserved port using a flow entry or the table-miss flow entry, a packet-in event is always
sent to controllers (see 5.12). Other processing, such as TTL checking, may also generate packet-in
events to send packets to the controller.
Packet-in events can be configured to buffer packets. For packet-in generated by an output action in
a flow entries or group bucket, it can be specified individually in the output action itself (see 7.2.4),
for other packet-in it can be configured in the switch configuration (see 7.3.2). If the packet-in event is
configured to buffer packets and the switch has sufficient memory to buffer them, the packet-in events
27
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
contain only some fraction of the packet header and a buffer ID to be used by a controller when it
is ready for the switch to forward the packet. Switches that do not support internal buffering, are
configured to not buffer packets for the packet-in event, or have run out of internal buffering, must
send the full packet to controllers as part of the event. Buffered packets will usually be processed via a
Packet-out message from a controller, or automatically expired after some time.
If the packet is buffered, the number of bytes of the original packet to include in the packet-in can be
configured. By default, it is 128 bytes. For packet-in generated by an output action in a flow entries or
group bucket, it can be specified individually in the output action itself (see 7.2.4), for other packet-in
it can be configured in the switch configuration (see 7.3.2).
Flow-Removed: Inform the controller about the removal of a flow entry from a flow table. FlowRemoved messages are only sent for flow entries with the OFPFF_SEND_FLOW_REM flag set. They are
generated as the result of a controller flow delete requests or the switch flow expiry process when one
of the flow timeout is exceeded (see 5.5).
Port-status: Inform the controller of a change on a port. The switch is expected to send port-status
messages to controllers as port configuration or port state changes. These events include change in
port configuration events, for example if it was brought down directly by a user, and port state change
events, for example if the link went down.
6.1.3 Symmetric
Symmetric messages are sent without solicitation, in either direction.
Hello: Hello messages are exchanged between the switch and controller upon connection startup.
Echo: Echo request/reply messages can be sent from either the switch or the controller, and must
return an echo reply. They are mainly used to verify the liveness of a controller-switch connection, and
may as well be used to measure its latency or bandwidth.
Error: Error messages are used by the switch or the controller to notify the other side of the connection
of problems. They are mostly used by the switch to indicate a failure of a request initiated by the
controller.
Experimenter: Experimenter messages provide a standard way for OpenFlow switches to offer additional functionality within the OpenFlow message type space. This is a staging area for features meant
for future OpenFlow revisions.
6.2 Message Handling
The OpenFlow protocol provides reliable message delivery and processing, but does not automatically
provide acknowledgements or ensure ordered message processing. The OpenFlow message handling
behaviour described in this section is provided on the main connection and auxiliary connections using
reliable transport, however it is not supported on auxiliary connections using unreliable transport (see
6.3.5).
28
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
Message Delivery: Messages are guaranteed delivery, unless the OpenFlow channel fails entirely, in
which case the controller should not assume anything about the switch state (e.g., the switch may have
gone into “fail standalone mode”).
Message Processing: Switches must process every message received from a controller in full, possibly
generating a reply. If a switch cannot completely process a message received from a controller, it must
send back an error message. For packet-out messages, fully processing the message does not guarantee
that the included packet actually exits the switch. The included packet may be silently dropped after
OpenFlow processing due to congestion at the switch, QoS policy, or if sent to a blocked or invalid
port.
In addition, switches must send to the controller all asynchronous messages generated by OpenFlow
state changes, such as flow-removed, port-status or packet-in messages, so that the controller view
of the switch is consistent with its actual state. Those messages may get filtered out based on the
Asynchronous Configuration (see 6.1.1). Moreover, conditions that would trigger an OpenFlow state
change may get filtered prior to causing such change. For example, packets received on data ports that
should be forwarded to the controller may get dropped due to congestion or QoS policy within the
switch and generate no packet-in messages. These drops may occur for packets with an explicit output
action to the controller. These drops may also occur when a packet fails to match any entries in a
table and that table’s default action is to send to the controller. The policing of packets destined to
the controller using QoS actions or rate limiting is advised, to prevent denial of service of the controller
connection, and is outside the scope of the present specification.
Controllers are free to ignore messages they receive, but must respond to echo messages to prevent the
switch from terminating the connection.
Message Ordering: Ordering can be ensured through the use of barrier messages. In the absence of
barrier messages, switches may arbitrarily reorder messages to maximize performance; hence, controllers
should not depend on a specific processing order. In particular, flow entries may be inserted in tables
in an order different than that of flow mod messages received by the switch. Messages must not be
reordered across a barrier message and the barrier message must be processed only when all prior
messages have been processed. More precisely:
1. messages before a barrier must be fully processed before the barrier, including sending any resulting
replies or errors
2. the barrier must then be processed and a barrier reply sent
3. messages after the barrier may then begin processing
If two messages from the controller depend on each other, they must be separated by a barrier message.
Examples of such message dependancies include a group mod add with a flow mod add referencing
the group, a port mod with a packet-out forwarding to the port, or a flow mod add with a following
packet-out to OFPP_TABLE.
6.3 OpenFlow Channel Connections
The OpenFlow channel is used to exchange OpenFlow message between an OpenFlow switch and an
OpenFlow controller. A typical OpenFlow controller manages multiple OpenFlow channels, each one
29
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
to a different OpenFlow switch. An OpenFlow switch may have one OpenFlow channel to a single
controller, or multiple channels for reliability, each to a different controller (see 6.3.4).
An OpenFlow controller typically manages an OpenFlow switch remotely over one or more networks.
The specification of the networks used for the OpenFlow channels is outside the scope of the present
specification. It may be a separate dedicated network, or the OpenFlow channel may use the network
managed by the OpenFlow switch (in-band controller connection). The only requirement is that it
should provide TCP/IP connectivity.
The OpenFlow channel is usually instantiated as a single network connection between the switch and the
controller, using TLS or plain TCP (see 6.3.3). Alternatively, the OpenFlow channel may be composed
of multiple network connections to exploit parallelism (see 6.3.5). The OpenFlow switch must be able
to create an OpenFlow channel by initiating a connection to an OpenFlow controller (see 6.3.1). Some
switch implementations may optionally allow an OpenFlow controller to connect to the OpenFlow
switch, in this case the switch usually should restrict itself to secured connections (see 6.3.3) to prevent
unauthorised connections.
6.3.1 Connection Setup
The switch must be able to establish communication with a controller at a user-configurable (but
otherwise fixed) IP address, using either a user-specified transport port or the default transport port
(see 6.3.3). If the switch is configured with the IP address of the controller to connect to, the switch
initiates a standard TLS or TCP connection to the controller. Traffic to and from the OpenFlow channel
is not run through the OpenFlow pipeline. Therefore, the switch must identify incoming traffic as local
before checking it against the flow tables.
When an OpenFlow connection is first established, each side of the connection must immediately send
an OFPT_HELLO message with the version field set to the highest OpenFlow protocol version supported
by the sender (see 7.1). This Hello message may optionally include some OpenFlow elements to help
connection setup (see 7.5.1). Upon receipt of this message, the recipient must calculate the OpenFlow
protocol version to be used. If both the Hello message sent and the Hello message received contained a
OFPHET_VERSIONBITMAP hello element, and if those bitmaps have some common bits set, the negotiated
version must be the highest version set in both bitmaps. Otherwise, the negotiated version must be the
smaller of the version number that was sent and the one that was received in the version fields.
If the negotiated version is supported by the recipient, then the connection proceeds. Otherwise, the
recipient must reply with an OFPT_ERROR message with a type field of OFPET_HELLO_FAILED, a code
field of OFPHFC_INCOMPATIBLE, and optionally an ASCII string explaining the situation in data, and
then terminate the connection.
After the switch and the controller have exchanged OFPT_HELLO messages and successfully negotiated
a common version number, the connection setup is done and standard OpenFlow messages can be
exchanged over the connection. One of the first thing that the controller should do is to send a
OFPT_FEATURES_REQUEST message to get the Datapath ID of the switch (see 7.3.1).
30
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
6.3.2 Connection Interruption
In the case that a switch loses contact with all controllers, as a result of echo request timeouts, TLS
session timeouts, or other disconnections, the switch must immediately enter either “fail secure mode”
or “fail standalone mode”, depending upon the switch implementation and configuration. In “fail secure
mode”, the only change to switch behavior is that packets and messages destined to the controllers are
dropped. Flow entries should continue to expire according to their timeouts in “fail secure mode”. In
“fail standalone mode”, the switch processes all packets using the OFPP_NORMAL reserved port; in other
words, the switch acts as a legacy Ethernet switch or router. The “fail standalone mode” is usually
only available on Hybrid switches (see 5.1).
Upon connecting to a controller again, the existing flow entries remain. The controller then has the
option of deleting all flow entries, if desired.
The first time a switch starts up, it will operate in either “fail secure mode” or “fail standalone mode”
mode, until it successfully connects to a controller. Configuration of the default set of flow entries to
be used at startup is outside the scope of the OpenFlow protocol.
6.3.3 Encryption
The switch and controller may communicate through a TLS connection. The TLS connection is initiated
by the switch on startup to the controller, which is located by default on TCP port 6653 . The switch
and controller mutually authenticate by exchanging certificates signed by a site-specific private key.
Each switch must be user-configurable with one certificate for authenticating the controller (controller
certificate) and the other for authenticating to the controller (switch certificate).
The switch and controller may optionally communicate using plain TCP. The TCP connection is initiated by the switch on startup to the controller, which is located by default on TCP port 6653 . When
using plain TCP, it is recommended to use alternative security measures to prevent eavesdropping,
controller impersonation or other attacks on the OpenFlow channel.
6.3.4 Multiple Controllers
The switch may establish communication with a single controller, or may establish communication
with multiple controllers. Having multiple controllers improves reliability, as the switch can continue
to operate in OpenFlow mode if one controller or controller connection fails. The hand-over between
controllers is entirely managed by the controllers themselves, which enables fast recovery from failure
and also controller load balancing. The controllers coordinate the management of the switch amongst
themselves via mechanisms outside the scope of the present specification, and the goal of the multiple
controller functionality is only to help synchronise controller handoffs performed by the controllers.
The multiple controller functionality only addresses controller fail-over and load balancing, and doesn’t
address virtualisation which can be done outside the OpenFlow protocol.
When OpenFlow operation is initiated, the switch must connect to all controllers it is configured with,
and try to maintain connectivity with all of them concurrently. Many controllers may send controllerto-switch commands to the switch, the reply or error messages related to those commands must only be
sent on the controller connection associated with that command. Asynchronous messages may need to
31
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
be sent to multiple controllers, the message is duplicated for each eligible OpenFlow channel and each
message sent when the respective controller connection allows it.
The default role of a controller is OFPCR_ROLE_EQUAL. In this role, the controller has full access to the
switch and is equal to other controllers in the same role. By default, the controller receives all the switch
asynchronous messages (such as packet-in, flow-removed). The controller can send controller-to-switch
commands to modify the state of the switch. The switch does not do any arbitration or resource sharing
between controllers.
A controller can request its role to be changed to OFPCR_ROLE_SLAVE. In this role, the controller
has read-only access to the switch. By default, the controller does not receive switch asynchronous
messages, apart from Port-status messages. The controller is denied the ability to execute all
controller-to-switch commands that send packets or modify the state of the switch. For example,
OFPT_PACKET_OUT, OFPT_FLOW_MOD, OFPT_GROUP_MOD, OFPT_PORT_MOD, OFPT_TABLE_MOD requests, and
OFPMP_TABLE_FEATURES multiparts requests with a non-empty body must be rejected. If the controller
sends one of those commands, the switch must reply with an OFPT_ERROR message with a type field
of OFPET_BAD_REQUEST, a code field of OFPBRC_IS_SLAVE. Other controller-to-switch messages, such as
OFPT_ROLE_REQUEST, OFPT_SET_ASYNC and OFPT_MULTIPART_REQUEST that only query data, should be
processed normally.
A controller can request its role to be changed to OFPCR_ROLE_MASTER. This role is similar to
OFPCR_ROLE_EQUAL and has full access to the switch, the difference is that the switch ensures it is
the only controller in this role. When a controller changes its role to OFPCR_ROLE_MASTER, the switch
changes all other controllers with the role OFPCR_ROLE_MASTER to have the role OFPCR_ROLE_SLAVE, but
does not affect controllers with role OFPCR_ROLE_EQUAL. When the switch performs such role changes, if
a controller role is changed from OFPCR_ROLE_MASTER to OFPCR_ROLE_SLAVE, the switch must generate a
controller role status event for this controller informing it of its new state (in many cases that controller
is no longer reachable, and switch may not be able to transmit that event).
Each controller may send a OFPT_ROLE_REQUEST message to communicate its role to the switch (see
7.3.8), and the switch must remember the role of each controller connection. A controller may change
role at any time, provided the generation_id in the message is current (see below).
The role request message offers a lightweight mechanism to help the controller master election process,
the controllers configure their role and usually still need to coordinate among themselve. The switch
can not change the state of a controller on its own, controller state is always changed as a result of a
request from one of the controllers. Any Slave controller or Equal controller can elect itself Master. A
switch may be simultaneously connected to multiple controllers in Equal state, multiple controllers in
Slave state, and at most one controller in Master state. The controller in Master state (if any) and
all the controllers in Equal state can fully change the switch state, there is no mechanism to enforce
partitioning of the switch between those controllers. If the controller in Master role need to be the only
controller able to make changes on the switch, then no controllers should be in Equal state and all other
controllers should be in Slave state.
A controller can also control which types of switch asynchronous messages are sent over its OpenFlow
channel, and change the defaults described above. This is done via a Asynchronous Configuration
message (see 6.1.1), listing all reasons for each message type that need to be enabled or filtered out (see
7.3.10) for the specific OpenFlow channel. Using this feature, different controllers can receive different
notifications, a controller in master mode can selectively disable notifications it does not care about,
and a controller in slave mode can enable notifications it wants to monitor.
32
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
To detect out-of-order messages during a master/slave transition, the OFPT_ROLE_REQUEST message
contains a 64-bit sequence number field, generation_id, that identifies a given mastership view. As
a part of the master election mechanism, controllers (or a third party on their behalf) coordinate the
assignment of generation_id. generation_id is a monotonically increasing counter: a new (larger)
generation_id is assigned each time the mastership view changes, e.g. when a new master is designated.
generation_id can wrap around.
On receiving a OFPT_ROLE_REQUEST with role equal to OFPCR_ROLE_MASTER or OFPCR_ROLE_SLAVE the
switch must compare the generation_id in the message against the largest generation id seen so far.
A message with a generation_id smaller than a previously seen generation id must be considered
stale and discarded. The switch must respond to stale messages with an error message with type
OFPET_ROLE_REQUEST_FAILED and code OFPRRFC_STALE.
The following pseudo-code describes the behavior of the switch in dealing with generation_id.
On switch startup:
generation_is_defined = false;
On receiving OFPT_ROLE_REQUEST with role equal to OFPCR_ROLE_MASTER or OFPCR_ROLE_SLAVE and
with a given generation_id, say GEN_ID_X:
if (generation_is_defined AND
distance(GEN_ID_X, cached_generation_id) < 0) {
<discard OFPT_ROLE_REQUEST message>;
<send an error message with code OFPRRFC_STALE>;
} else {
cached_generation_id = GEN_ID_X;
generation_is_defined = true;
<process the message normally>;
}
where distance() is the Wrapping Sequence Number Distance operator defined as following:
distance(a, b) := (int64_t)(a - b)
I.e. distance() is the unsigned difference between the sequence numbers, interpreted as a two’s complement signed value. This results in a positive distance if a is greater than b (in a circular sense) but
less than “half the sequence number space” away from it. It results in a negative distance otherwise
(a < b).
The switch must ignore generation_id if the role in the OFPT_ROLE_REQUEST is OFPCR_ROLE_EQUAL,
as generation_id is specifically intended for the disambiguation of race condition in master/slave
transition.
33
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
6.3.5 Auxiliary Connections
By default, the OpenFlow channel between an OpenFlow switch and an OpenFlow controller is a
single network connection. The OpenFlow channel may also be composed of a main connection
and multiple auxiliary connections. Auxiliary connections are created by the OpenFlow switch and
are helpful to improve the switch processing performance and exploit the parallelism of most switch
implementations.
Each connection from the switch to the controller is identified by the switch Datapath ID and a Auxiliary
ID (see 7.3.1). The main connection must have its Auxiliary ID set to zero, whereas auxiliary connection
must have a non-zero Auxiliary ID and the same Datapath ID. Auxiliary connections must use the same
source IP address as the main connection, but can use a different transport, for example TLS, TCP,
DTLS or UDP, depending on the switch configuration. The auxiliary connection should have the same
destination IP address and same transport destination port as the main connection, unless the switch
configuration specifies otherwise. The controller must recognise incoming connections with non-zero
Auxiliary ID as auxiliary connections and bind them to the main connection with the same Datapath
ID.
The switch must not initiate auxiliary connection before having completed the connection setup over
the main connection (see 6.3.1), it must setup and maintain auxiliary connections with the controller
only while the corresponding main connection is alive. The connection setup for auxiliary connections
is the same as for the main connection (see 6.3.1). If the switch detects that the main connection to a
controller is broken, it must immediately close all its auxiliary connections to that controller, to enable
the controller to properly resolve Datapath ID conflicts.
Both the OpenFlow switch and the OpenFlow controller must accept any OpenFlow message types and
sub-types on all connections : the main connection or an auxiliary connection can not be restricted to
a specific message type or sub-type. However, the processing performance of different message types or
sub-types on different connections may be different. The switch may service auxiliary connections with
different priorities, for example one auxiliary connection may be dedicated to high priority requests
and always processed by the switch before other auxiliary connections. A switch configuration, for
example using the OpenFlow Configuration Protocol, may optionally configure the priority of auxiliary
connections.
A reply to an OpenFlow request must be made on the same connection it came in. There is no
synchronisation between connections, and messages sent on different connections may be processed in
any order. A barrier message applies only to the connection where it is used (see 6.2). Auxiliary
connections using DTLS or UDP may lose or reorder messages, OpenFlow does not provide ordering
or delivery guarantees on those connections (see 6.2). If messages must be processed in sequence, they
must be sent over the same connection, use a connection that does not reorder packets, and use barrier
messages.
The controller is free to use the various switch connections for sending OpenFlow messages at its entire
discretion, however to maximise performance on most switches the following guidelines are suggested:
ˆ All OpenFlow controller messages which are not Packet-out (flow-mod, statistic request...) should
be sent over the main connection.
ˆ All Packet-Out messages containing a packet from a Packet-In message should be sent on the
connection where the Packet-In came from.
34
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
ˆ All other Packet-Out messages should be spread across the various auxiliary connections using a
mechanism keeping the packets of a same flow mapped to the same connection.
ˆ If the desired auxiliary connection is not available, the controller should use the main connection.
The switch is free to use the various controller connections for sending OpenFlow messages as it wishes,
however the following guidelines are suggested :
ˆ All OpenFlow messages which are not Packet-in should be sent over the main connection.
ˆ All Packet-In messages spread across the various auxiliary connection using a mechanism keeping
the packets of a same flow mapped to the same connection.
Auxiliary connection on unreliable transports (UDP, DTLS) have additional restrictions
and rules that don’t apply to auxiliary connection on other transport (TCP, TLS). The only
message types supported on unreliable auxiliary connections are OFPT_HELLO, OFPT_ERROR,
OFPT_ECHO_REQUEST,
OFPT_ECHO_REPLY,
OFPT_FEATURES_REQUEST,
OFPT_FEATURES_REPLY,
OFPT_PACKET_IN, OFPT_PACKET_OUT and OFPT_EXPERIMENTER, other messages types are not supported by the specification.
On unreliable auxiliary connection, Hello messages are sent at connection initiation to setup the connection (see 6.3.1). If an OpenFlow device receives another message on an unreliable auxiliary connection prior to receiving a Hello message, the device must either assume the connection is setup
properly and use the version number from that message, or it must return an Error message with
OFPET_BAD_REQUEST type and OFPBRC_BAD_VERSION code. If a OpenFlow device receives a error message with OFPET_BAD_REQUEST type and OFPBRC_BAD_VERSION code on unreliable auxiliary connection,
it must either send a new Hello message or terminate the unreliable auxiliary connection (the connection
may be retried at a later time). If no message was ever received on an auxiliary connection after some
implementation chosen amount of time lower than 5 seconds, the device must either send a new Hello
message or terminate the unreliable auxiliary connection. If after sending a Feature Request message,
the controller does not receives a Feature Reply message after some implementation chosen amount of
time lower than 5 seconds, the device must either send a new Feature Request message or terminate
the unreliable auxiliary connection. If after receiving a message, a device does not receives any other
message after some implementation chosen amount of time lower than 30 seconds, the device must
terminate the unreliable auxiliary connection. If a device receives a message for a unreliable auxiliary
connection already terminated, it must assume it is a new connection.
OpenFlow devices using unreliable auxiliary connection should follow recommendations in RFC 5405
when possible.
6.4 Flow Table Modification Messages
Flow table modification messages can have the following types:
enum ofp_flow_mod_command
OFPFC_ADD
=
OFPFC_MODIFY
=
OFPFC_MODIFY_STRICT =
{
0, /* New flow. */
1, /* Modify all matching flows. */
2, /* Modify entry strictly matching wildcards and
priority. */
OFPFC_DELETE
= 3, /* Delete all matching flows. */
OFPFC_DELETE_STRICT = 4, /* Delete entry strictly matching wildcards and
35
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
priority. */
};
For add requests (OFPFC_ADD) with the OFPFF_CHECK_OVERLAP flag set, the switch must first check for
any overlapping flow entries in the requested table. Two flow entries overlap if a single packet may match
both, and both entries have the same priority. If an overlap conflict exists between an existing flow
entry and the add request, the switch must refuse the addition and respond with an ofp_error_msg
with OFPET_FLOW_MOD_FAILED type and OFPFMFC_OVERLAP code.
For non-overlapping add requests, or those with no overlap checking, the switch must insert the flow
entry in the requested table. If a flow entry with identical match fields and priority already resides in
the requested table, then that entry, including its duration, must be cleared from the table, and the
new flow entry added. If the OFPFF_RESET_COUNTS flag is set, the flow entry counters must be cleared,
otherwise they should be copied from the replaced flow entry. No flow-removed message is generated
for the flow entry eliminated as part of an add request; if the controller wants a flow-removed message
it should explicitly send a delete request for the old flow entry prior to adding the new one.
For modify requests (OFPFC_MODIFY or OFPFC_MODIFY_STRICT), if a matching entry exists in the table, the instructions field of this entry is updated with the value from the request, whereas its
cookie, idle_timeout, hard_timeout, flags, counters and duration fields are left unchanged. If the
OFPFF_RESET_COUNTS flag is set, the flow entry counters must be cleared. For modify requests, if no
flow entry currently residing in the requested table matches the request, no error is recorded, and no
flow table modification occurs.
For delete requests (OFPFC_DELETE or OFPFC_DELETE_STRICT), if a matching entry exists in the table,
it must be deleted, and if the entry has the OFPFF_SEND_FLOW_REM flag set, it should generate a flow
removed message. For delete requests, if no flow entry currently residing in the requested table matches
the request, no error is recorded, and no flow table modification occurs.
Modify and delete flow mod commands have non-strict versions (OFPFC_MODIFY and OFPFC_DELETE)
and strict versions (OFPFC_MODIFY_STRICT or OFPFC_DELETE_STRICT). In the strict versions, the set of
match fields, all match fields, including their masks, and the priority, are strictly matched against the
entry, and only an identical flow entry is modified or removed. For example, if a message to remove
entries is sent that has no match fields included, the OFPFC_DELETE command would delete all flow
entries from the tables, while the OFPFC_DELETE_STRICT command would only delete a flow entry that
applies to all packets at the specified priority.
For non-strict modify and delete commands, all flow entries that match the flow mod description are
modified or removed. In the non-strict versions, a match will occur when a flow entry exactly matches
or is more specific than the description in the flow mod command; in the flow mod the missing match
fields are wildcarded, field masks are active, and other flow mod fields such as priority are ignored. For
example, if a OFPFC_DELETE command says to delete all flow entries with a destination port of 80, then a
flow entry that wildcards all match fields will not be deleted. However, a OFPFC_DELETE command that
wildcards all match fields will delete an entry that matches all port 80 traffic. This same interpretation
of mixed wildcard and exact match fields also applies to individual and aggregate flows stats requests.
Delete commands can be optionally filtered by destination group or output port. If the out_port
field contains a value other than OFPP_ANY, it introduces a constraint when matching. This constraint
is that each matching flow entry must contain an output action directed at the specified port in the
actions associated with that flow entry. This constraint is limited to only the actions directly associated
36
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
with the flow entry. In other words, the switch must not recurse through the action sets of pointed-to
groups, which may have matching output actions. The out_group, if different from OFPG_ANY, introduce
a similar constraint on the group action. These fields are ignored by OFPFC_ADD, OFPFC_MODIFY and
OFPFC_MODIFY_STRICT messages.
Modify and delete commands can also be filtered by cookie value, if the cookie_mask field contains a value other than 0. This constraint is that the bits specified by the cookie_mask in both
the cookie field of the flow mod and a flow entry’s cookie value must be equal. In other words,
(f low entry.cookie & f low mod.cookie mask) == (f low mod.cookie & f low mod.cookie mask).
Delete commands can use the OFPTT_ALL value for table-id to indicate that matching flow entries are
to be deleted from all flow tables.
If the flow modification message specifies an invalid table-id, the switch must send an ofp_error_msg
with OFPET_FLOW_MOD_FAILED type and OFPFMFC_BAD_TABLE_ID code. If the flow modification message
specifies OFPTT_ALL for table-id in a add or modify request, the switch must send the same error
message.
If a switch cannot find any space in the requested table in which to add the incoming flow entry, the
switch must send an ofp_error_msg with OFPET_FLOW_MOD_FAILED type and OFPFMFC_TABLE_FULL
code.
If the instructions requested in a flow mod message are unknown the switch must return an
ofp_error_msg with OFPET_BAD_INSTRUCTION type and OFPBIC_UNKNOWN_INST code. If the instructions requested in a flow mod message are unsupported the switch must return an ofp_error_msg with
OFPET_BAD_INSTRUCTION type and OFPBIC_UNSUP_INST code.
If the instructions requested contain a Goto-Table and the next-table-id refers to an invalid table the
switch must return an ofp_error_msg with OFPET_BAD_INSTRUCTION type and OFPBIC_BAD_TABLE_ID
code.
If the instructions requested contain a Write-Metadata and the metadata value or metadata mask value
is unsupported then the switch must return an ofp_error_msg with OFPET_BAD_INSTRUCTION type and
OFPBIC_UNSUP_METADATA or OFPBIC_UNSUP_METADATA_MASK code.
If the match in a flow mod message specifies a field that is unsupported in the table, the switch must
return an ofp_error_msg with OFPET_BAD_MATCH type and OFPBMC_BAD_FIELD code. If the match in
a flow mod message specifies a field more than once, the switch must return an ofp_error_msg with
OFPET_BAD_MATCH type and OFPBMC_DUP_FIELD code. If the match in a flow mod message specifies
a field but fail to specify its associated prerequisites, for example specifies an IPv4 address without
matching the EtherType to 0x800, the switch must return an ofp_error_msg with OFPET_BAD_MATCH
type and OFPBMC_BAD_PREREQ code.
If the match in a flow mod specifies an arbitrary bitmask for either the datalink or network addresses
which the switch cannot support, the switch must return an ofp_error_msg with OFPET_BAD_MATCH
type and either OFPBMC_BAD_DL_ADDR_MASK or OFPBMC_BAD_NW_ADDR_MASK. If the bitmasks specified in
both the datalink and network addresses are not supported then OFPBMC_BAD_DL_ADDR_MASK should be
used. If the match in a flow mod specifies an arbitrary bitmask for another field which the switch cannot
support, the switch must return an ofp_error_msg with OFPET_BAD_MATCH type and OFPBMC_BAD_MASK
code.
37
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
If the match in a flow mod specifies values that cannot be matched, for example, a VLAN ID greater
than 4095 and not one of the reserved values, or a DSCP value with one of the two higher bits set, the
switch must return an ofp_error_msg with OFPET_BAD_MATCH type and OFPBMC_BAD_VALUE code.
If any action references a port that will never be valid on a switch, the switch must return an
ofp_error_msg with OFPET_BAD_ACTION type and OFPBAC_BAD_OUT_PORT code. If the referenced port
may be valid in the future, e.g. when a linecard is added to a chassis switch, or a port is dynamically
added to a software switch, the switch must either silently drop packets sent to the referenced port, or
immediately return an OFPBAC_BAD_OUT_PORT error and refuse the flow mod.
If an action in a flow mod message references a group that is not currently defined on the switch, or is a
reserved group, such as OFPG_ALL, the switch must return an ofp_error_msg with OFPET_BAD_ACTION
type and OFPBAC_BAD_OUT_GROUP code.
If an action in a flow mod message has a value that is invalid, for example a Set VLAN ID action
with value greater than 4095, or a Push action with an invalid Ethertype, the switch must return an
ofp_error_msg with OFPET_BAD_ACTION type and OFPBAC_BAD_ARGUMENT code.
If an action in a flow mod message performs an operation which is inconsistent with the match, for
example, a pop VLAN action with a match specifying no VLAN, or a set IPv4 address action with
a match wildcarding the Ethertype, the switch may optionally reject the flow mod and immediately
return an ofp_error_msg with OFPET_BAD_ACTION type and OFPBAC_MATCH_INCONSISTENT code. The
effect of any inconsistent actions on matched packets is undefined. Controllers are strongly encouraged
to avoid generating combinations of table entries that may yield inconsistent actions.
If an action list contain a sequence of actions that the switch can not support in the specified order, the
switch must return an ofp_error_msg with OFPET_BAD_ACTION type and OFPBAC_UNSUPPORTED_ORDER
code.
If any other errors occur during the processing of the flow mod message, the switch may return an
ofp_error_msg with OFPET_FLOW_MOD_FAILED type and OFPFMC_UNKNOWN code.
6.5 Flow Table Synchronisation
A flow table may be synchronised with another flow table. When a flow table is synchronised, its content
is automatically updated by the switch to reflect changes in the flow table it is synchronised with. This
mechanism enables to perform multiple matches on different views of the same data at different points
of the OpenFlow pipeline.
Flows tables can be synchronised bidirectionally or unidirectionally, for any synchronised table a table
property describes the source flow table it synchronise from (see 7.3.5.6). When a flow table is synchronised, when a flow entry is added, modified or removed in the source flow table, a corresponding flow
entry must be automatically added, modified or removed in the synchronised flow table by the switch.
If a flow entry is added in the source flow table, and the corresponding flow entry has identical match
and priority to a older flow entry already residing in the synchronised flow table, the old and new flow
entries must be merged by the switch. If a flow entry is modified or removed in the source flow table,
and if the corresponding flow entry no longer exist in the synchronised flow table, no flow entry should
be modified or created in the synchronised flow table.
38
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The flow entry created in the synchronised table may not be identical to the corresponding flow entry
in the source flow table, as they are often different views on the same data. The translation between
those synchronised flow entries is not specified by the OpenFlow protocol and depends on the switch
implementation and configuration. For example, synchronised flow entries may have a different instruction set and actions, and the match fields may be transposed (source and destination inverted). The
counters of a flow entry must be kept independantly of counters in the source flow table, those counters
are not synchronised. In general, synchronised flow entries are created as permanent flow entries (both
expiry timers set to zero) so that their lifetime is properly synchronised with the flow entries in the
source flow table.
The switch may allow the controller to modify or delete those flow entries automatically added in the
synchronised table, and may also allow the controller to create new entries in the synchronised table.
This enables the controller to customise those synchronised flow entries beyond the switch automatic
translation. Some of these changes may be lost if the source flow entry is modified. If flow table
synchronisation is bidirectional (both flow table synchronised on each other), changes done by the
controller on the synchronised flow entry need to be reflected on the source flow entry.
A common example of synchronised tables is the mapping of a Ethernet learning/forwarding hardware
table as a set of two synchronised flow tables. In this example, a first flow table expresses the learning
lookup and matches on Ethernet source address and source port (and optionally other fields such as
VLAN ID). A second flow table expresses the forwarding lookup and matches on Ethernet destination
address and sets the output port. The two tables synchronise from each other, with the Ethernet
addresses transposed in the match. Flow entries in the first table are set to expire based on the learning
ageing timer, flow entries in the second table as permanent. The controller can add a flow entry in
either of those two flow tables, and then modify the instructions of the flow entry automatically added
in the other flow table, alternatively the controller can add a flow entry in each flow table concurently.
Another example of synchronised tables is mapping RPF checks for multicast packets as a flow table.
6.6 Group Table Modification Messages
Group table modification messages can have the following types:
/* Group commands */
enum ofp_group_mod_command {
OFPGC_ADD
= 0,
/* New group. */
OFPGC_MODIFY = 1,
/* Modify all matching groups. */
OFPGC_DELETE = 2,
/* Delete all matching groups. */
};
Groups may consist of zero or more buckets. A group with no buckets will not alter the action set
associated with a packet. A group may also include buckets which themselves forward to other groups
if the switch supports it.
The action set for each bucket must be validated using the same rules as those for flow mods (Section
6.4), with additional group-specific checks. If an action in one of the buckets is invalid or unsupported,
the switch should return an ofp_error_msg with OFPET_BAD_ACTION type and code corresponding to
the error (see 6.4).
39
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
For add requests (OFPGC_ADD), if a group entry with the specified group identifier already resides in
the group table, then the switch must refuse to add the group entry and must send an ofp_error_msg
with OFPET_GROUP_MOD_FAILED type and OFPGMFC_GROUP_EXISTS code.
For modify requests (OFPGC_MODIFY), if a group entry with the specified group identifier already resides
in the group table, then that entry, including its type and action buckets, must be removed, and the new
group entry added. If a group entry with the specified group identifier does not already exist then the
switch must refuse the group mod and send an ofp_error_msg with OFPET_GROUP_MOD_FAILED type
and OFPGMFC_UNKNOWN_GROUP code.
If a specified group type is invalid (ie: includes fields such as weight that are undefined for the specified
group type) then the switch must refuse to add the group entry and must send an ofp_error_msg with
OFPET_GROUP_MOD_FAILED type and OFPGMFC_INVALID_GROUP code.
If a switch does not support unequal load sharing with select groups (buckets with weight different than 1), it must refuse to add the group entry and must send an ofp_error_msg with
OFPET_GROUP_MOD_FAILED type and OFPGMFC_WEIGHT_UNSUPPORTED code.
If a switch cannot add the incoming group entry due to lack of space, the switch must send an
ofp_error_msg with OFPET_GROUP_MOD_FAILED type and OFPGMFC_OUT_OF_GROUPS code.
If a switch cannot add the incoming group entry due to restrictions (hardware or otherwise) limiting
the number of group buckets, it must refuse to add the group entry and must send an ofp_error_msg
with OFPET_GROUP_MOD_FAILED type and OFPGMFC_OUT_OF_BUCKETS code.
If a switch cannot add the incoming group because it does not support the proposed liveliness
configuration, the switch must send an ofp_error_msg with OFPET_GROUP_MOD_FAILED type and
OFPGMFC_WATCH_UNSUPPORTED code. This includes specifying watch_port or watch_group for a group
that does not support liveness, or specifying a port that does not support liveness in watch_port, or
specifying a group that does not support liveness in watch_group.
For delete requests (OFPGC_DELETE), if no group entry with the specified group identifier currently
exists in the group table, no error is recorded, and no group table modification occurs. Otherwise, the
group is removed, and all flow entries containing this group in a Group action are also removed. The
group type need not be specified for the delete request. Delete also differs from an add or modify
with no buckets specified in that future attempts to add the group identifier will not result in a group
exists error. If one wishes to effectively delete a group yet leave in flow entries using it, that group can
be cleared by sending a modify with no buckets specified.
To delete all groups with a single message, specify OFPG_ALL as the group value.
Groups may be chained if the switch supports it, when at least one group forward to another group, or
in more complex configuration. For example, a fast reroute group may have two buckets, where each
points to a select group. If a switch does not support groups of groups, it must send an ofp_error_msg
with OFPET_GROUP_MOD_FAILED type and OFPGMFC_CHAINING_UNSUPPORTED code.
A switch may support checking that no loop is created while chaining groups : if a group mod is sent
such that a forwarding loop would be created, the switch must reject the group mod and must send an
ofp_error_msg with OFPET_GROUP_MOD_FAILED type and OFPGMFC_LOOP code. If the switch does not
support such checking, the forwarding behavior is undefined.
40
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
A switch may support checking that groups forwarded to by other groups are not removed : If a switch
cannot delete a group because it is referenced by another group, it must refuse to delete the group entry
and must send an ofp_error_msg with OFPET_GROUP_MOD_FAILED type and OFPGMFC_CHAINED_GROUP
code. If the switch does not support such checking, the forwarding behavior is undefined.
Fast failover group support requires liveness monitoring, to determine the specific bucket to execute.
Other group types are not required to implement liveness monitoring, but may optionally implement
it. If a switch cannot implement liveness checking for any bucket in a group, it must refuse the group
mod and return an error. The rules for determining liveness include:
ˆ A port is considered live if it has the OFPPS_LIVE flag set in its port state. Port liveness may be
managed by code outside of the OpenFlow portion of a switch, defined outside of the OpenFlow
specification, such as Spanning Tree or a KeepAlive mechanism. The port must not be considered
live (and the OFPPS_LIVE flag must be unset) if one of the port liveness mechanisms enabled on
the switch consider the port not live, or if the port config bit OFPPC_PORT_DOWN indicates the port
is down, or if the port state bit OFPPS_LINK_DOWN indicates the link is down.
ˆ A bucket is considered live if either watch_port is not OFPP_ANY and the port watched is live, or
if watch_group is not OFPG_ANY and the group watched is live.
ˆ A group is considered live if a least one of its buckets is live.
The controller can infer the liveness state of the group by monitoring the states of the various ports.
6.7 Meter Modification Messages
Meter modification messages can have the following types:
/* Meter commands */
enum ofp_meter_mod_command {
OFPMC_ADD,
/* New meter. */
OFPMC_MODIFY,
/* Modify specified meter. */
OFPMC_DELETE,
/* Delete specified meter. */
};
For add requests (OFPMC_ADD), if a meter entry with the specified meter identifier already exist, then the switch must refuse to add the meter entry and must send an ofp_error_msg with
OFPET_METER_MOD_FAILED type and OFPMMFC_METER_EXISTS code.
For modify requests (OFPMC_MODIFY), if a meter entry with the specified meter identifier already exists,
then that entry, including its bands, must be removed, and the new meter entry added. If a meter entry
with the specified meter identifier does not already exists then the switch must refuse the meter mod and
send an ofp_error_msg with OFPET_METER_MOD_FAILED type and OFPMMFC_UNKNOWN_METER code.
If a switch cannot add the incoming meter entry due to lack of space, the switch must send an
ofp_error_msg with OFPET_METER_MOD_FAILED type and OFPMMFC_OUT_OF_METERS code.
If a switch cannot add the incoming meter entry due to restrictions (hardware or otherwise) limiting
the number of bands, it must refuse to add the meter entry and must send an ofp_error_msg with
OFPET_METER_MOD_FAILED type and OFPMMFC_OUT_OF_BANDS code.
41
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
For delete requests (OFPMC_DELETE), if no meter entry with the specified meter identifier currently
exists, no error is recorded, and no meter modification occurs. Otherwise, the meter is removed, and all
flows that include the meter in their instruction set are also removed. Only the meter identifier need to
be specified for the delete request, other fields such as bands can be omitted.
To delete all meters with a single message, specify OFPM_ALL as the meter value. Virtual meters can
never be deleted and are not removed when deleting all meters.
6.8 Bundle Messages
6.8.1 Bundle overview
A bundle is a sequence of OpenFlow modification requests from the controller that is applied as a single
OpenFlow operation. If all modifications in the bundle succeed, all of the modifications are retained,
but if any errors arise, none of the modifications are retained.
The first goal of bundles is to group related state changes on a switch so that all changes are applied
together or that none of them is applied. The second goal is to better synchronise changes across a set
of OpenFlow switches, bundles can be prepared and pre-validated on each switch and applied at the
same time.
A bundle is specified as all controllers messages encoded with the same bundle_id on a specific controller
connection. Messages part of the bundle are encapsulated in a Bundle Add message (see 7.3.9.6), the
payload of the Bundle Add message is formatted like a regular OpenFlow messages and has the same
semantic. The messages part of a bundle are pre-validated as they are stored in the bundle, minimising
the risk of errors when the bundle is applied. The applications of the message included in the Bundle
Add message is postponed to when the bundle is committed (see 7.3.9.8).
A switch is not required to accept arbitrary messages in a bundle, a switch may not accept some message
types in bundles, and a switch may not allow all combinations of message types to be bundled together
(see 7.3.9.6). For example, a switch should not allow to embed a bundle message within a Bundle
Add message. At a minimum, a switch must be able to support a bundle of multiple flow-mods and
port-mods in any order.
6.8.2 Bundle example usage
The controller can issue the following sequence of messages to apply a sequence of modifications together.
1. OFPBCT_OPEN_REQUEST bundle_id
2. OFPT_BUNDLE_ADD_MESSAGE bundle_id modification 1
3. OFPT_BUNDLE_ADD_MESSAGE bundle_id ...
4. OFPT_BUNDLE_ADD_MESSAGE bundle_id modification n
5. OFPBCT_CLOSE_REQUEST bundle_id
6. OFPBCT_COMMIT_REQUEST bundle_id
42
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The switch is expected to behave as follows. When a bundle is opened, modifications are saved into a
temporary staging area without taking effect. When the bundle is committed, the changes in the staging
area are applied to the state (e.g. tables) used by the switch. If an error occurs in one modification, no
change is applied to the state.
6.8.3 Bundle error processing
The OpenFlow messages part of a bundle must be pre-validated before they are stored in the bundle (see
7.3.9.6). For each message sent by the controller, the switch must verify that the syntax of the message
is valid and that all features in the message are supported features, and immediately return an error
message is this message can not be validated. The switch may optionally verify resource availability
and may commit resource at this time and generate errors. Messages generating errors when added to
the bundle are not stored in the bundle and the bundle is unmodified.
When the bundle is committed, most errors will have been already detected and reported. One of
the message part of the bundle may still fail during commit, for example due to resource availability.
In this case, no message part of the bundle is applied and the switch must generate the error message
corresponding to the failure (see 7.3.9.8). Messages of a bundle should have unique xid to help matching
errors to messages. If none of the messages part of the bundle generate an error message, the switch
inform the controller of the successful application of the bundle.
6.8.4 Bundle atomic modifications
Committing the bundle must be controller atomic, i.e. a controller querying the switch must never
see the intermediate state, it must see either the state of the switch with none or with all of the
modifications contained in the bundle having been applied. In particular, is a bundle fails, controllers
should not receive any notification resulting from the partial application of the bundle.
If the flag OFPBF_ORDERED is specified (see 7.3.9.3), the messages part of the bundle must be applied
strictly in order, as if separated by OFPT_BARRIER_REQUEST messages (however no OFPT_BARRIER_REPLY
is generated). If this flag is not specified, messages don’t need to be applied in order.
If the flag OFPBF_ATOMIC is specified (see 7.3.9.3), committing the bundle must also be packet atomic,
i.e. a given packet from an input port or packet-out request should either be processed with none or
with all of the modifications having been applied. Whether this flag is supported would depend on the
switch hardware and software architecture. Packets and messages can temporarily be enqueued while
changes are applied. As the resulting increase in forwarding / processing latency may be unacceptable,
double buffering techniques are often employed.
If the flag OFPBF_ATOMIC is not specified, committing the bundle does not need to be packet atomic.
Packet may be processed by intermediate state resulting from partial application of the bundle, even
if the bundle commit ultimately fails. The various OpenFlow counters would also reflect the partial
application of the bundle in this case.
43
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
6.8.5 Bundle parallelism
The switch must support exchanging echo request and echo reply messages during the creation and
population of the bundle, the switch must reply to an echo request without waiting for the end of the
bundle. Echo request and echo reply messages can not be included in a bundle. Similarly, asynchronous
messages generated by the switch are not impacted by the bundle, the switch must send status events
without waiting for the end of the bundle.
If the switch supports multiple controller channels or auxiliary connections, the switch must maintains
a separate bundle staging area for each controller-switch connection. This permits multiple bundles to
be incrementally populated in parallel on a given switch. The bundle_id namespace is specific to each
controller connection, so that controllers don’t need to coordinate.
A switch may also optionally support populating multiple bundle in parallel on the same controller
connection, by multiplexing bundle messages with different bundle_id. The controller may create and
send multiple bundles, each identified by a unique bundle_id, and then can apply any of them in
any order by specifying its bundle_id in a commit message. Inversely, a switch may not allow to
create another bundle or accept any regular OpenFlow messages between opening a bundle and either
committing it or discarding it.
In some implementations, when a switch start storing a bundle, it may lock some of the objects referenced
by the bundle. If a message on the same or another controller connection try to modify an object locked
by a bundle, the switch must reject that message and return an error. A switch is not required to lock
objects referenced by a bundle. If a switch does not lock objects referenced by a bundle, the application
of the bundle may fail if those objects have been modified via other controller connections.
7 The OpenFlow Protocol
The heart of the OpenFlow switch specification is the set of structures used for OpenFlow Protocol
messages.
The structures, defines, and enumerations described below are derived from the file openflow.h which
is included in this document (see A). All OpenFlow messages are sent in big-endian format.
7.1 OpenFlow Header
Each OpenFlow message begins with the OpenFlow header:
/* Header on all OpenFlow packets. */
struct ofp_header {
uint8_t version;
/* OFP_VERSION. */
uint8_t type;
/* One of the OFPT_ constants. */
uint16_t length;
/* Length including this ofp_header. */
uint32_t xid;
/* Transaction id associated with this packet.
Replies use the same id as was in the request
to facilitate pairing. */
};
OFP_ASSERT(sizeof(struct ofp_header) == 8);
44
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The version specifies the OpenFlow protocol version being used. During the earlier draft phase of the
OpenFlow Protocol, the most significant bit was set to indicate an experimental version. The lower
bits indicate the revision number of the protocol. The version of the protocol described by the current
specification is 1.4.0, and its ofp version is 0x05 .
The length field indicates the total length of the message, so no additional framing is used to distinguish
one frame from the next. The type can have the following values:
enum ofp_type {
/* Immutable messages. */
OFPT_HELLO
= 0,
OFPT_ERROR
= 1,
OFPT_ECHO_REQUEST
= 2,
OFPT_ECHO_REPLY
= 3,
OFPT_EXPERIMENTER
= 4,
/* Switch configuration
OFPT_FEATURES_REQUEST
OFPT_FEATURES_REPLY
OFPT_GET_CONFIG_REQUEST
OFPT_GET_CONFIG_REPLY
OFPT_SET_CONFIG
/*
/*
/*
/*
/*
Symmetric
Symmetric
Symmetric
Symmetric
Symmetric
message
message
message
message
message
messages. */
= 5, /* Controller/switch
= 6, /* Controller/switch
= 7, /* Controller/switch
= 8, /* Controller/switch
= 9, /* Controller/switch
/* Asynchronous messages.
OFPT_PACKET_IN
=
OFPT_FLOW_REMOVED
=
OFPT_PORT_STATUS
=
message
message
message
message
message
*/
*/
*/
*/
*/
message
message
message
message
message
*/
*/
*/
*/
*/
*/
10, /* Async message */
11, /* Async message */
12, /* Async message */
/* Controller command messages. */
OFPT_PACKET_OUT
= 13, /* Controller/switch
OFPT_FLOW_MOD
= 14, /* Controller/switch
OFPT_GROUP_MOD
= 15, /* Controller/switch
OFPT_PORT_MOD
= 16, /* Controller/switch
OFPT_TABLE_MOD
= 17, /* Controller/switch
/* Multipart messages. */
OFPT_MULTIPART_REQUEST
OFPT_MULTIPART_REPLY
*/
*/
*/
*/
*/
= 18, /* Controller/switch message */
= 19, /* Controller/switch message */
/* Barrier messages. */
OFPT_BARRIER_REQUEST
= 20, /* Controller/switch message */
OFPT_BARRIER_REPLY
= 21, /* Controller/switch message */
/* Controller role change request messages. */
OFPT_ROLE_REQUEST
= 24, /* Controller/switch message */
OFPT_ROLE_REPLY
= 25, /* Controller/switch message */
/* Asynchronous message
OFPT_GET_ASYNC_REQUEST
OFPT_GET_ASYNC_REPLY
OFPT_SET_ASYNC
configuration. */
= 26, /* Controller/switch message */
= 27, /* Controller/switch message */
= 28, /* Controller/switch message */
/* Meters and rate limiters configuration messages. */
OFPT_METER_MOD
= 29, /* Controller/switch message */
/* Controller role change event messages. */
45
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPT_ROLE_STATUS
Version 1.4.0
= 30, /* Async message */
/* Asynchronous messages. */
OFPT_TABLE_STATUS
= 31, /* Async message */
/* Request forwarding by the switch. */
OFPT_REQUESTFORWARD
= 32, /* Async message */
/* Bundle operations (multiple messages as a single operation). */
OFPT_BUNDLE_CONTROL
= 33,
OFPT_BUNDLE_ADD_MESSAGE = 34,
};
7.1.1 Padding
Most OpenFlow messages contain padding fields. Those are included in the various message types and
in various common structures. Most of those padding fields can be identified by the fact that their
name start with pad. The goal of padding fields is to align multi-byte entities on natural processor
boundaries.
All common structures included in messages are aligned on 64 bit boundaries. Various other types are
aligned as needed, for example 32 bits integer are aligned on 32 bit boundaries. An exception to the
padding rules are OXM match fields which are never padded (7.2.2.2). In general, the end of OpenFlow
messages is not padded, unless explicitly specified. On the other hand, common structures are almost
always padded at the end.
The padding fields should be set to zero. An OpenFlow implementation must accept any values set in
padding fields, and must just ignore the content of padding fields.
7.2 Common Structures
This section describes structures used by multiple message types.
7.2.1 Port Structures
The OpenFlow pipeline receives and sends packets on ports. The switch may define physical and logical
ports, and the OpenFlow specification defines some reserved ports (see 4.1).
7.2.1.1 Port Description Structures
The physical ports, switch-defined logical ports, and the OFPP_LOCAL reserved port are described with
the following structure:
/* Description of a port */
struct ofp_port {
uint32_t port_no;
uint16_t length;
uint8_t pad[2];
46
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
uint8_t hw_addr[OFP_ETH_ALEN];
uint8_t pad2[2];
/* Align to 64 bits. */
char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
uint32_t config;
uint32_t state;
/* Bitmap of OFPPC_* flags. */
/* Bitmap of OFPPS_* flags. */
/* Port description property list - 0 or more properties */
struct ofp_port_desc_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_port) == 40);
The port_no field uniquely identifies a port within a switch. The hw_addr field typically is the MAC
address for the port; OFP_ETH_ALEN is 6. The name field is a null-terminated string containing a
human-readable name for the interface. The value of OFP_MAX_PORT_NAME_LEN is 16.
The port numbers use the following conventions:
/* Port numbering. Ports are numbered starting from 1. */
enum ofp_port_no {
/* Maximum number of physical and logical switch ports. */
OFPP_MAX
= 0xffffff00,
/* Reserved OpenFlow Port (fake output "ports"). */
OFPP_IN_PORT
= 0xfffffff8, /* Send the packet out the input port. This
reserved port must be explicitly used
in order to send back out of the input
port. */
OFPP_TABLE
= 0xfffffff9, /* Submit the packet to the first flow table
NB: This destination port can only be
used in packet-out messages. */
OFPP_NORMAL
= 0xfffffffa, /* Process with normal L2/L3 switching. */
OFPP_FLOOD
= 0xfffffffb, /* All physical ports in VLAN, except input
port and those blocked or link down. */
OFPP_ALL
= 0xfffffffc, /* All physical ports except input port. */
OFPP_CONTROLLER = 0xfffffffd, /* Send to controller. */
OFPP_LOCAL
= 0xfffffffe, /* Local openflow "port". */
OFPP_ANY
= 0xffffffff
/* Wildcard port used only for flow mod
(delete) and flow stats requests. Selects
all flows regardless of output port
(including flows with no output port). */
};
The config field describes port administrative settings, and has the following structure:
/* Flags to indicate behavior of the physical port. These flags are
* used in ofp_port to describe the current configuration. They are
* used in the ofp_port_mod message to configure the port’s behavior.
*/
enum ofp_port_config {
OFPPC_PORT_DOWN
= 1 << 0, /* Port is administratively down. */
OFPPC_NO_RECV
OFPPC_NO_FWD
= 1 << 2,
= 1 << 5,
/* Drop all packets received by port. */
/* Drop packets forwarded to port. */
47
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPPC_NO_PACKET_IN = 1 << 6
Version 1.4.0
/* Do not send packet-in msgs for port. */
};
The OFPPC_PORT_DOWN bit indicates that the port has been administratively brought down and should
not be used by OpenFlow. The OFPPC_NO_RECV bit indicates that packets received on that port should
be ignored. The OFPPC_NO_FWD bit indicates that OpenFlow should not send packets to that port. The
OFPPFL_NO_PACKET_IN bit indicates that packets on that port that generate a table miss should never
trigger a packet-in message to the controller.
In general, the port config bits are set by the controller and not changed by the switch. Those bits
may be useful for the controller to implement protocols such as STP or BFD. If the port config bits are
changed by the switch through another administrative interface, the switch sends an OFPT_PORT_STATUS
message to notify the controller of the change.
The state field describes the port internal state, and has the following structure:
/* Current state of the physical port. These are not configurable from
* the controller.
*/
enum ofp_port_state {
OFPPS_LINK_DOWN
= 1 << 0, /* No physical link present. */
OFPPS_BLOCKED
= 1 << 1, /* Port is blocked */
OFPPS_LIVE
= 1 << 2, /* Live for Fast Failover Group. */
};
The port state bits represent the state of the physical link or switch protocols outside of OpenFlow. The
OFPPS_LINK_DOWN bit indicates the the physical link is not present. The OFPPS_BLOCKED bit indicates
that a switch protocol outside of OpenFlow, such as 802.1D Spanning Tree, is preventing the use of
that port with OFPP_FLOOD.
All port state bits are read-only and cannot be changed by the controller. When the port flags are
changed, the switch sends an OFPT_PORT_STATUS message to notify the controller of the change.
The properties field is a list of port description properties, describing various configuration and state
of the port.
7.2.1.2 Port Description Properties
The list of port description property types that are currently defined are:
/* Port description property types.
*/
enum ofp_port_desc_prop_type {
OFPPDPT_ETHERNET
= 0,
/* Ethernet property. */
OFPPDPT_OPTICAL
= 1,
/* Optical property. */
OFPPDPT_EXPERIMENTER
= 0xFFFF, /* Experimenter property. */
};
A property definition contains the property type, length, and any associated data:
48
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Common header for all port description properties. */
struct ofp_port_desc_prop_header {
uint16_t
type;
/* One of OFPPDPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_port_desc_prop_header) == 4);
The OFPPDPT_ETHERNET property uses the following structure and fields:
/* Ethernet port description property. */
struct ofp_port_desc_prop_ethernet {
uint16_t
type;
/* OFPPDPT_ETHERNET. */
uint16_t
length; /* Length in bytes of this property. */
uint8_t
pad[4]; /* Align to 64 bits. */
/* Bitmaps of OFPPF_* that describe features. All bits zeroed if
* unsupported or unavailable. */
uint32_t curr;
/* Current features. */
uint32_t advertised;
/* Features being advertised by the port. */
uint32_t supported;
/* Features supported by the port. */
uint32_t peer;
/* Features advertised by peer. */
uint32_t curr_speed;
uint32_t max_speed;
/* Current port bitrate in kbps. */
/* Max port bitrate in kbps */
};
OFP_ASSERT(sizeof(struct ofp_port_desc_prop_ethernet) == 32);
The curr, advertised, supported, and peer fields indicate link modes (speed and duplexity), link
type (copper/fiber) and link features (autonegotiation and pause). Port features are represented by the
following structure:
/* Features of ports available in a datapath. */
enum ofp_port_features {
OFPPF_10MB_HD
= 1 << 0, /* 10 Mb half-duplex rate support. */
OFPPF_10MB_FD
= 1 << 1, /* 10 Mb full-duplex rate support. */
OFPPF_100MB_HD
= 1 << 2, /* 100 Mb half-duplex rate support. */
OFPPF_100MB_FD
= 1 << 3, /* 100 Mb full-duplex rate support. */
OFPPF_1GB_HD
= 1 << 4, /* 1 Gb half-duplex rate support. */
OFPPF_1GB_FD
= 1 << 5, /* 1 Gb full-duplex rate support. */
OFPPF_10GB_FD
= 1 << 6, /* 10 Gb full-duplex rate support. */
OFPPF_40GB_FD
= 1 << 7, /* 40 Gb full-duplex rate support. */
OFPPF_100GB_FD
= 1 << 8, /* 100 Gb full-duplex rate support. */
OFPPF_1TB_FD
= 1 << 9, /* 1 Tb full-duplex rate support. */
OFPPF_OTHER
= 1 << 10, /* Other rate, not in the list. */
OFPPF_COPPER
OFPPF_FIBER
OFPPF_AUTONEG
OFPPF_PAUSE
OFPPF_PAUSE_ASYM
=
=
=
=
=
1
1
1
1
1
<<
<<
<<
<<
<<
11,
12,
13,
14,
15
/*
/*
/*
/*
/*
Copper medium. */
Fiber medium. */
Auto-negotiation. */
Pause. */
Asymmetric pause. */
};
Multiple of these flags may be set simultaneously. If none of the port speed flags are set, the max_speed
or curr_speed are used.
49
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The curr_speed and max_speed fields indicate the current and maximum bit rate (raw transmission
speed) of the link in kbps. The number should be rounded to match common usage. For example,
an optical 10 Gb Ethernet port should have this field set to 10000000 (instead of 10312500), and an
OC-192 port should have this field set to 10000000 (instead of 9953280).
The max_speed fields indicate the maximum configured capacity of the link, whereas the curr_speed
indicates the current capacity. If the port is a LAG with 3 links of 1Gb/s capacity, with one of the ports
of the LAG being down, one port auto-negotiated at 1Gb/s and 1 port auto-negotiated at 100Mb/s,
the max_speed is 3 Gb/s and the curr_speed is 1.1 Gb/s.
The OFPPDPT_OPTICAL property uses the following structure and fields:
/* Optical port description property. */
struct ofp_port_desc_prop_optical {
uint16_t
type;
/* OFPPDPT_3OPTICAL. */
uint16_t
length; /* Length in bytes of this property. */
uint8_t
pad[4]; /* Align to 64 bits. */
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint16_t
uint16_t
supported;
/* Features supported by the port. */
tx_min_freq_lmda;
/* Minimum TX Frequency/Wavelength */
tx_max_freq_lmda;
/* Maximum TX Frequency/Wavelength */
tx_grid_freq_lmda; /* TX Grid Spacing Frequency/Wavelength */
rx_min_freq_lmda;
/* Minimum RX Frequency/Wavelength */
rx_max_freq_lmda;
/* Maximum RX Frequency/Wavelength */
rx_grid_freq_lmda; /* RX Grid Spacing Frequency/Wavelength */
tx_pwr_min;
/* Minimum TX power */
tx_pwr_max;
/* Maximum TX power */
};
OFP_ASSERT(sizeof(struct ofp_port_desc_prop_optical) == 40);
The minimum, maximum, and grid spacing are specified for both transmit and receive optical ports
as either a frequency in MHz or wavelength (lambda) as nm * 100. For ports that are not tunable,
the minimum and maximum values will be identical and specify the fixed value. The tx_pwr_min and
tx_pwr_max are dBm * 10. The optical port features are specified as follows:
/* Features of optical ports available in switch. */
enum ofp_optical_port_features {
OFPOPF_RX_TUNE
= 1 << 0, /* Receiver is tunable */
OFPOPF_TX_TUNE
= 1 << 1, /* Transmit is tunable */
OFPOPF_TX_PWR
= 1 << 2, /* Power is configurable */
OFPOPF_USE_FREQ = 1 << 3, /* Use Frequency, not wavelength */
};
The OFPOPF_RX_TUNE indicates the port receive function is able to tune, the OFPOPF_TX_TUNE indicates
the port transmit function is able to tune. The OFPOPF_TX_PWR indicates the transmit power can be set.
The OFPOPF_USE_FREQ indicates frequency must be used instead of wavelength for description of the
port tuning. It is highly important that the same tuning domain (frequency or wavelength) is used as
indicated, since conversion between wavelength and frequency is often prone to error due to the range
of the values.
The OFPPDPT_EXPERIMENTER property uses the following structure and fields:
50
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Experimenter port description property. */
struct ofp_port_desc_prop_experimenter {
uint16_t
type;
/* OFPPDPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_port_desc_prop_experimenter) == 12);
The experimenter field is the Experimenter ID, which takes the same form as in the typical experimenter structure (see 7.2.5).
7.2.2 Flow Match Structures
An OpenFlow match is composed of a flow match header and a sequence of zero or more flow match
fields.
7.2.2.1 Flow Match Header
The flow match header is described by the ofp_match structure:
/* Fields to match against flows */
struct ofp_match {
uint16_t type;
/* One of OFPMT_* */
uint16_t length;
/* Length of ofp_match (excluding padding) */
/* Followed by:
*
- Exactly (length - 4) (possibly 0) bytes containing OXM TLVs, then
*
- Exactly ((length + 7)/8*8 - length) (between 0 and 7) bytes of
*
all-zero bytes
* In summary, ofp_match is padded as needed, to make its overall size
* a multiple of 8, to preserve alignement in structures using it.
*/
uint8_t oxm_fields[0];
/* 0 or more OXM match fields */
uint8_t pad[4];
/* Zero bytes - see above for sizing */
};
OFP_ASSERT(sizeof(struct ofp_match) == 8);
The type field is set to OFPMT_OXM and length field is set to the actual length of ofp_match structure
including all match fields. The payload of the OpenFlow match is a set of OXM Flow match fields.
51
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* The match type indicates the match structure (set of fields that compose the
* match) in use. The match type is placed in the type field at the beginning
* of all match structures. The "OpenFlow Extensible Match" type corresponds
* to OXM TLV format described below and must be supported by all OpenFlow
* switches. Extensions that define other match types may be published on the
* ONF wiki. Support for extensions is optional.
*/
enum ofp_match_type {
OFPMT_STANDARD = 0,
/* Deprecated. */
OFPMT_OXM
= 1,
/* OpenFlow Extensible Match */
};
The only valid match type in this specification is OFPMT_OXM, the OpenFlow 1.1 match type
OFPMT_STANDARD is deprecated. If an alternate match type is used, the match fields and payload may
be set differently, but this is outside the scope of this specification.
7.2.2.2 Flow Match Field Structures
The flow match fields are described using the OpenFlow Extensible Match (OXM) format, which is a
compact type-length-value (TLV) format. Each OXM TLV is 5 to 259 (inclusive) bytes long. OXM
TLVs are not aligned on or padded to any multibyte boundary. The first 4 bytes of an OXM TLV are
its header, followed by the entry’s body.
An OXM TLV’s header is interpreted as a 32-bit word in network byte order (see figure 4).
16 15
oxm class
9 8 7
oxm field
HM
31
0
oxm length
Figure 4: OXM TLV header layout.
The OXM TLV’s header fields are defined in Table 9
Name
oxm_class
oxm type
oxm_field
oxm_hasmask
oxm_length
Width
16
7
1
8
Usage
Match class: member class or reserved class
Match field within the class
Set if OXM include a bitmask in payload
Length of OXM payload
Table 9: OXM TLV header fields.
The oxm_class is a OXM match class that contains related match types, and is described in section
7.2.2.3. oxm_field is an class-specific value, identifying one of the match types within the match
class. The combination of oxm_class and oxm_field (the most-significant 23 bits of the header) are
collectively oxm_type. The oxm_type normally designates a protocol header field, such as the Ethernet
type, but it can also refer to packet metadata, such as the switch port on which a packet arrived.
oxm_hasmask defines if the OXM TLV contains a bitmask, more details is explained in section 7.2.2.5.
oxm_length is a positive integer describing the length of the OXM TLV payload in bytes. The length
of the OXM TLV, including the header, is exactly 4 + oxm_length bytes.
52
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
For a given oxm_class, oxm_field, and oxm_hasmask value, oxm_length is a constant. It is included only to allow software to minimally parse OXM TLVs of unknown types. (Similarly, for a
given oxm_class, oxm_field, and oxm_length, oxm_hasmask is a constant.)
7.2.2.3 OXM classes
The match types are structured using OXM match classes. The OpenFlow specification distinguishes
two types of OXM match classes, ONF member classes and ONF reserved classes, differentiated by their
high order bit. Classes with the high order bit set to 1 are ONF reserved classes, they are used for the
OpenFlow specification itself. Classes with the high order bit set to zero are ONF member classes, they
are allocated by the ONF on an as needed basis, they uniquely identify an ONF member and can be
used arbitrarily by that member. Support for ONF member classes is optional.
The following OXM classes are defined:
/* OXM Class IDs.
* The high order bit differentiate reserved classes from member classes.
* Classes 0x0000 to 0x7FFF are member classes, allocated by ONF.
* Classes 0x8000 to 0xFFFE are reserved classes, reserved for standardisation.
*/
enum ofp_oxm_class {
OFPXMC_NXM_0
= 0x0000,
/* Backward compatibility with NXM */
OFPXMC_NXM_1
= 0x0001,
/* Backward compatibility with NXM */
OFPXMC_OPENFLOW_BASIC = 0x8000,
/* Basic class for OpenFlow */
OFPXMC_EXPERIMENTER
= 0xFFFF,
/* Experimenter class */
};
The class OFPXMC_OPENFLOW_BASIC contains the basic set of OpenFlow match fields (see 7.2.2.7). The
optional class OFPXMC_EXPERIMENTER is used for experimenter matches (see 7.2.2.8). Other ONF reserved classes are reserved for future uses such as modularisation of the specification. The first two
ONF member classes OFPXMC_NXM_0 and OFPXMC_NXM_1 are reserved for backward compatibility with
the Nicira Extensible Match (NXM) specification.
7.2.2.4 Flow Matching
A zero-length OpenFlow match (one with no OXM TLVs) matches every packet. Match fields that
should be wildcarded are omitted from the OpenFlow match.
An OXM TLV places a constraint on the packets matched by the OpenFlow match:
ˆ If oxm_hasmask is 0, the OXM TLV’s body contains a value for the field, called oxm_value. The
OXM TLV match matches only packets in which the corresponding field equals oxm_value.
ˆ If oxm_hasmask is 1, then the oxm_entry’s body contains a value for the field (oxm_value), followed
by a bitmask of the same length as the value, called oxm_mask. Each 1-bit in oxm_mask constrains
the OXM TLV to match only packets in which the corresponding bit of the field equals the the
corresponding bit in oxm_value. Each 0-bit in oxm_mask places no constraint on the corresponding
bit in the field.
53
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
When using masking, it is an error for a 0-bit in oxm_mask to have a corresponding 1-bit in oxm_value.
The switch must report an error message of type OFPET_BAD_MATCH and code OFPBMC_BAD_WILDCARDS
in such a case.
The following table summarizes the constraint that a pair of corresponding oxm_mask and oxm_value
bits place upon the corresponding field bit when using masking. Omitting oxm_mask is equivalent to
supplying an oxm_mask that is all 1-bits.
oxm_mask
0
1
oxm value
0
1
no constraint
error
must be 0
must be 1
Table 10: OXM mask and value.
When there are multiple OXM TLVs, all of the constraints must be met: the packet fields must match
all OXM TLVs part of the OpenFlow match. The fields for which OXM TLVs that are not present are
wildcarded to ANY, omitted OXM TLVs are effectively fully masked to zero.
7.2.2.5 Flow Match Field Masking
When oxm_hasmask is 1, the OXM TLV contains a bitmask and its length is effectively doubled, so
oxm_length is always even. The bitmask follows the field value and is encoded in the same way. The
masks are defined such that a 0 in a given bit position indicates a “don’t care” match for the same bit
in the corresponding field, whereas a 1 means match the bit exactly.
An all-zero-bits oxm_mask is equivalent to omitting the OXM TLV entirely. An all-one-bits oxm_mask
is equivalent to specifying 0 for oxm_hasmask and omitting oxm_mask.
Some oxm_types may not support masked wildcards, that is, oxm_hasmask must always be 0 when
these fields are specified. For example, the field that identifies the ingress port on which a packet was
received may not be masked.
Some oxm_types that do support masked wildcards may only support certain oxm_mask patterns. For
example, some fields that have IPv4 address values may be restricted to CIDR masks (subnet masks).
These restrictions are detailed in specifications for individual fields. A switch may accept an
oxm_hasmask or oxm_mask value that the specification disallows, but only if the switch correctly implements support for that oxm_hasmask or oxm_mask value. A switch must reject an attempt to set up a
flow entry that contains a oxm_hasmask or oxm_mask value that it does not support (see 6.4).
7.2.2.6 Flow Match Field Prerequisite
The presence of an OXM TLV with a given oxm_type may be restricted based on the presence or values
of other OXM TLVs. In general, matching header fields of a protocol can only be done if the OpenFlow
match explitly matches the corresponding protocol.
For example:
54
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
ˆ An OXM TLV for oxm_type=OXM OF IPV4 SRC is allowed only if it is preceded by another entry with oxm_type=OXM_OF_ETH_TYPE, oxm_hasmask=0, and oxm_value=0x0800. That is, matching on the IPv4 source address is allowed only if the Ethernet type is explicitly set to IPv4.
ˆ An OXM TLV for oxm_type=OXM OF TCP SRC is allowed only if it is preceded by an entry with
oxm_type=OXM OF ETH TYPE, oxm_hasmask=0, oxm_value=0x0800 or 0x86dd, and another
with oxm_type=OXM OF IP PROTO, oxm_hasmask=0, oxm_value=6, in that order. That is,
matching on the TCP source port is allowed only if the Ethernet type is IP and the IP protocol
is TCP.
ˆ An OXM TLV for oxm_type=OXM OF MPLS LABEL is allowed only if it is preceded by an
entry with oxm_type=OXM OF ETH TYPE, oxm_hasmask=0, oxm_value=0x8847 or 0x8848.
ˆ An OXM TLV for oxm_type=OXM OF VLAN PCP is allowed only if it is preceded by an entry
with oxm_type=OXM OF VLAN VID, oxm_value!=OFPVID NONE.
These restrictions are noted in specifications for individual fields (see 7.2.2.7). A switch may implement
relaxed versions of these restrictions. For example, a switch may accept no prerequisite at all. A switch
must reject an attempt to set up a flow entry that violates its restrictions (see 6.4), and must deal with
inconsistent matches created by the lack of prerequisite (for example matching both a TCP source port
and a UDP destination port).
New match fields defined by members (in member classes or as experimenter fields) may provide alternate
prerequisites to already specified match fields. For example, this could be used to reuse existing IP
match fields over an alternate link technology (such as PPP) by substituting the ETH_TYPE prerequisite
as needed (for PPP, that could be an hypothetical PPP_PROTOCOL field).
An OXM TLV that has prerequisite restrictions must appear after the OXM TLVs for its prerequisites.
Ordering of OXM TLVs within an OpenFlow match is not otherwise constrained.
Any given oxm_type may appear in an OpenFlow match at most once, otherwise the switch must
generate an error (see 6.4). A switch may implement a relaxed version of this rule and may allow
in some cases a oxm_type to appear multiple time in an OpenFlow match, however the behaviour of
matching is then implementation-defined.
If a flow table implements a specific OXM TLV, this flow table must accept valid matches containing
the prerequisites of this OXM TLV, even if the flow table does not support matching all possible values
for the match fields specified by those prerequisites. For example, if a flow table matches the IPv4
source address, this flow table must accept matching the Ethertype exactly to IPv4, however this flow
table does not need to support matching Ethertype to any other value.
7.2.2.7 Flow Match Fields
The specification defines a default set of match fields with oxm_class=OFPXMC_OPENFLOW_BASIC which
can have the following values:
/* OXM Flow match field types
enum oxm_ofb_match_fields {
OFPXMT_OFB_IN_PORT
OFPXMT_OFB_IN_PHY_PORT
OFPXMT_OFB_METADATA
for OpenFlow basic class. */
= 0,
= 1,
= 2,
/* Switch input port. */
/* Switch physical input port. */
/* Metadata passed between tables. */
55
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPXMT_OFB_ETH_DST
OFPXMT_OFB_ETH_SRC
OFPXMT_OFB_ETH_TYPE
OFPXMT_OFB_VLAN_VID
OFPXMT_OFB_VLAN_PCP
OFPXMT_OFB_IP_DSCP
OFPXMT_OFB_IP_ECN
OFPXMT_OFB_IP_PROTO
OFPXMT_OFB_IPV4_SRC
OFPXMT_OFB_IPV4_DST
OFPXMT_OFB_TCP_SRC
OFPXMT_OFB_TCP_DST
OFPXMT_OFB_UDP_SRC
OFPXMT_OFB_UDP_DST
OFPXMT_OFB_SCTP_SRC
OFPXMT_OFB_SCTP_DST
OFPXMT_OFB_ICMPV4_TYPE
OFPXMT_OFB_ICMPV4_CODE
OFPXMT_OFB_ARP_OP
OFPXMT_OFB_ARP_SPA
OFPXMT_OFB_ARP_TPA
OFPXMT_OFB_ARP_SHA
OFPXMT_OFB_ARP_THA
OFPXMT_OFB_IPV6_SRC
OFPXMT_OFB_IPV6_DST
OFPXMT_OFB_IPV6_FLABEL
OFPXMT_OFB_ICMPV6_TYPE
OFPXMT_OFB_ICMPV6_CODE
OFPXMT_OFB_IPV6_ND_TARGET
OFPXMT_OFB_IPV6_ND_SLL
OFPXMT_OFB_IPV6_ND_TLL
OFPXMT_OFB_MPLS_LABEL
OFPXMT_OFB_MPLS_TC
OFPXMT_OFP_MPLS_BOS
OFPXMT_OFB_PBB_ISID
OFPXMT_OFB_TUNNEL_ID
OFPXMT_OFB_IPV6_EXTHDR
OFPXMT_OFB_PBB_UCA
Version 1.4.0
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
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,
41,
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
Ethernet destination address. */
Ethernet source address. */
Ethernet frame type. */
VLAN id. */
VLAN priority. */
IP DSCP (6 bits in ToS field). */
IP ECN (2 bits in ToS field). */
IP protocol. */
IPv4 source address. */
IPv4 destination address. */
TCP source port. */
TCP destination port. */
UDP source port. */
UDP destination port. */
SCTP source port. */
SCTP destination port. */
ICMP type. */
ICMP code. */
ARP opcode. */
ARP source IPv4 address. */
ARP target IPv4 address. */
ARP source hardware address. */
ARP target hardware address. */
IPv6 source address. */
IPv6 destination address. */
IPv6 Flow Label */
ICMPv6 type. */
ICMPv6 code. */
Target address for ND. */
Source link-layer for ND. */
Target link-layer for ND. */
MPLS label. */
MPLS TC. */
MPLS BoS bit. */
PBB I-SID. */
Logical Port Metadata. */
IPv6 Extension Header pseudo-field */
PBB UCA header field. */
};
A switch must support the required match fields listed in Table 11 in its pipeline. Each required match
field must be supported in at least one flow table of the switch : that flow table must enable matching
that field and the match field prerequisites must be met in that table (see 7.2.2.6). The required fields
don’t need to be implemented in all flow tables, and don’t need to be implemented in the same flow
table. Flow tables can support non-required and experimenter match fields. The controller can query
the switch about which match fields are supported in each flow table (see 7.3.5.6).
56
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Field
OXM_OF_IN_PORT
OXM_OF_ETH_DST
OXM_OF_ETH_SRC
OXM_OF_ETH_TYPE
OXM_OF_IP_PROTO
OXM_OF_IPV4_SRC
OXM_OF_IPV4_DST
OXM_OF_IPV6_SRC
OXM_OF_IPV6_DST
OXM_OF_TCP_SRC
OXM_OF_TCP_DST
OXM_OF_UDP_SRC
OXM_OF_UDP_DST
Version 1.4.0
Required
Required
Required
Required
Required
Required
Required
Required
Required
Required
Required
Required
Required
Description
Ingress port. This may be a physical or switch-defined logical port.
Ethernet destination address. Can use arbitrary bitmask
Ethernet source address. Can use arbitrary bitmask
Ethernet type of the OpenFlow packet payload, after VLAN tags.
IPv4 or IPv6 protocol number
IPv4 source address. Can use subnet mask or arbitrary bitmask
IPv4 destination address. Can use subnet mask or arbitrary bitmask
IPv6 source address. Can use subnet mask or arbitrary bitmask
IPv6 destination address. Can use subnet mask or arbitrary bitmask
TCP source port
TCP destination port
UDP source port
UDP destination port
Table 11: Required match fields.
All match fields have different size, prerequisites and masking capability, as specified in Table 12. If
not explictely specified in the field description, each field type refer the the outermost occurrence of the
field in the packet headers.
Field
OXM_OF_IN_PORT
Bits
32
Mask
No
Pre-requisite
None
OXM_OF_IN_PHY_PORT
32
No
IN PORT present
OXM_OF_METADATA
64
Yes
None
OXM_OF_ETH_DST
OXM_OF_ETH_SRC
OXM_OF_ETH_TYPE
48
48
16
Yes
Yes
No
None
None
None
OXM_OF_VLAN_VID
12+1
Yes
None
OXM_OF_VLAN_PCP
OXM_OF_IP_DSCP
3
6
No
No
OXM_OF_IP_ECN
2
No
OXM_OF_IP_PROTO
8
No
OXM_OF_IPV4_SRC
32
Yes
VLAN VID!=NONE
ETH TYPE=0x0800 or
ETH TYPE=0x86dd
ETH TYPE=0x0800 or
ETH TYPE=0x86dd
ETH TYPE=0x0800 or
ETH TYPE=0x86dd
ETH TYPE=0x0800
OXM_OF_IPV4_DST
32
Yes
Description
Ingress port. Numerical representation of incoming port, starting at 1. This may be a physical or switch-defined logical port.
Physical port. In ofp_packet_in messages, underlying physical port when packet received on
a logical port.
Table metadata. Used to pass information between tables.
Ethernet destination MAC address.
Ethernet source MAC address.
Ethernet type of the OpenFlow packet payload,
after VLAN tags.
VLAN-ID from 802.1Q header. The CFI bit indicate the presence of a valid VLAN-ID, see below.
VLAN-PCP from 802.1Q header.
Diff Serv Code Point (DSCP). Part of the IPv4
ToS field or the IPv6 Traffic Class field.
ECN bits of the IP header. Part of the IPv4
ToS field or the IPv6 Traffic Class field.
IPv4 or IPv6 protocol number.
IPv4 source address. Can use subnet mask or
arbitrary bitmask
ETH TYPE=0x0800
IPv4 destination address. Can use subnet mask
or arbitrary bitmask
Table 12 – Continued on next page
57
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Field
OXM_OF_TCP_SRC
OXM_OF_TCP_DST
OXM_OF_UDP_SRC
OXM_OF_UDP_DST
OXM_OF_SCTP_SRC
OXM_OF_SCTP_DST
OXM_OF_ICMPV4_TYPE
OXM_OF_ICMPV4_CODE
OXM_OF_ARP_OP
OXM_OF_ARP_SPA
Bits
16
16
16
16
16
16
8
8
16
32
OXM_OF_ARP_TPA
32
OXM_OF_ARP_SHA
OXM_OF_ARP_THA
OXM_OF_IPV6_SRC
48
48
128
OXM_OF_IPV6_DST
128
OXM_OF_IPV6_FLABEL
OXM_OF_ICMPV6_TYPE
OXM_OF_ICMPV6_CODE
OXM_OF_IPV6_ND_TARGET
20
8
8
128
OXM_OF_IPV6_ND_SLL
48
OXM_OF_IPV6_ND_TLL
48
OXM_OF_MPLS_LABEL
20
OXM_OF_MPLS_TC
3
OXM_OF_MPLS_BOS
1
OXM_OF_PBB_ISID
OXM_OF_TUNNEL_ID
OXM_OF_IPV6_EXTHDR
OXM_OF_PBB_UCA
24
64
9
1
Version 1.4.0
Table 12 – concluded from previous page
Mask Pre-requisite
Description
No
IP PROTO=6
TCP source port
No
IP PROTO=6
TCP destination port
No
IP PROTO=17
UDP source port
No
IP PROTO=17
UDP destination port
No
IP PROTO=132
SCTP source port
No
IP PROTO=132
SCTP destination port
No
IP PROTO=1
ICMP type
No
IP PROTO=1
ICMP code
No
ETH TYPE=0x0806
ARP opcode
Yes
ETH TYPE=0x0806
Source IPv4 address in the ARP payload. Can
use subnet mask or arbitrary bitmask
Yes
ETH TYPE=0x0806
Target IPv4 address in the ARP payload. Can
use subnet mask or arbitrary bitmask
Yes
ETH TYPE=0x0806
Source Ethernet address in the ARP payload.
Yes
ETH TYPE=0x0806
Target Ethernet address in the ARP payload.
Yes
ETH TYPE=0x86dd
IPv6 source address. Can use subnet mask or
arbitrary bitmask
Yes
ETH TYPE=0x86dd
IPv6 destination address. Can use subnet mask
or arbitrary bitmask
Yes
ETH TYPE=0x86dd
IPv6 flow label.
No
IP PROTO=58
ICMPv6 type
No
IP PROTO=58
ICMPv6 code
No
ICMPV6 TYPE=135 or The target address in an IPv6 Neighbor DiscovICMPV6 TYPE=136
ery message.
No
ICMPV6 TYPE=135
The source link-layer address option in an IPv6
Neighbor Discovery message.
No
ICMPV6 TYPE=136
The target link-layer address option in an IPv6
Neighbor Discovery message.
No
ETH TYPE=0x8847 or The LABEL in the first MPLS shim header.
ETH TYPE=0x8848
No
ETH TYPE=0x8847 or The TC in the first MPLS shim header.
ETH TYPE=0x8848
No
ETH TYPE=0x8847 or The BoS bit (Bottom of Stack bit) in the first
ETH TYPE=0x8848
MPLS shim header.
Yes
ETH TYPE=0x88E7
The I-SID in the first PBB service instance tag.
Yes
None
Metadata associated with a logical port.
Yes
ETH TYPE=0x86dd
IPv6 Extension Header pseudo-field.
No
ETH TYPE=0x88E7
The UCA field in the first PBB service instance
tag.
Table 12: Match fields details.
The ingress port OXM_OF_IN_PORT is a valid standard OpenFlow port, either a physical, a logical port, the OFPP_LOCAL reserved port or the OFPP_CONTROLLER reserved port. The physical port
OXM_OF_IN_PHY_PORT is used in Packet-in messages to identify a physical port underneath a logical
port (see 7.4.1).
The metadata field OXM_OF_METADATA is used to pass information between lookups across multiple
tables. This value can be arbitrarily masked.
The Tunnel ID field OXM_OF_TUNNEL_ID carries optional metadata associated with a logical port. The
mapping of this metadata is defined by the logical port implementation. If the logical port does not
58
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
provide such data or if the packet was received on a physical port, its value is zero. For example, for
a packet received via GRE tunnel including a (32-bit) key, the key is stored in the low 32-bits and the
high bits are zeroed. For a MPLS logical port, the low 20 bits represent the MPLS Label. For a VxLAN
logical port, the low 24 bits represent the VNI.
Omitting the OFPXMT_OFB_VLAN_VID field specifies that a flow entry should match packets regardless
of whether they contain the corresponding tag. Special values are defined below for the VLAN tag
to allow matching of packets with any tag, independent of the tag’s value, and to supports matching
packets without a VLAN tag. The special values defined for OFPXMT_OFB_VLAN_VID are:
/* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
* special conditions.
*/
enum ofp_vlan_id {
OFPVID_PRESENT = 0x1000, /* Bit that indicate that a VLAN id is set */
OFPVID_NONE
= 0x0000, /* No VLAN id was set. */
};
The OFPXMT_OFB_VLAN_PCP field must be rejected when the OFPXMT_OFB_VLAN_VID field is wildcarded
(not present) or when the value of OFPXMT_OFB_VLAN_VID is set to OFPVID_NONE. Table 13 summarizes
the combinations of wildcard bits and field values for particular VLAN tag matches.
OXM field
absent
present
present
oxm value
OFPVID_NONE
OFPVID_PRESENT
oxm mask
absent
OFPVID_PRESENT
present
value | OFPVID_PRESENT
absent
Matching packets
Packets with and without a VLAN tag
Only packets without a VLAN tag
Only packets with a VLAN tag regardless of its
value
Only packets with VLAN tag and VID equal
value
Table 13: Match combinations for VLAN tags.
The field OXM_OF_IPV6_EXTHDR is a pseudo field that indicates the presence of various IPv6 extension
headers in the packet header. The IPv6 extension header bits are combined together in the fields
OXM_OF_IPV6_EXTHDR, and those bits can have the following values:
/* Bit definitions for IPv6 Extension Header pseudo-field. */
enum ofp_ipv6exthdr_flags {
OFPIEH_NONEXT = 1 << 0,
/* "No next header" encountered. */
OFPIEH_ESP
= 1 << 1,
/* Encrypted Sec Payload header present. */
OFPIEH_AUTH
= 1 << 2,
/* Authentication header present. */
OFPIEH_DEST
= 1 << 3,
/* 1 or 2 dest headers present. */
OFPIEH_FRAG
= 1 << 4,
/* Fragment header present. */
OFPIEH_ROUTER = 1 << 5,
/* Router header present. */
OFPIEH_HOP
= 1 << 6,
/* Hop-by-hop header present. */
OFPIEH_UNREP = 1 << 7,
/* Unexpected repeats encountered. */
OFPIEH_UNSEQ = 1 << 8,
/* Unexpected sequencing encountered. */
};
ˆ OFPIEH_HOP is set to 1 if a hop-by-hop IPv6 extension header is present as the first extension
header in the packet.
59
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
ˆ OFPIEH_ROUTER is set to 1 if a router IPv6 extension header is present.
ˆ OFPIEH_FRAG is set to 1 if a fragmentation IPv6 extension header is present.
ˆ OFPIEH_DEST is set to 1 if one or more Destination options IPv6 extension headers are present. It
is normal to have either one or two of these in one IPv6 packet (see RFC 2460).
ˆ OFPIEH_AUTH is set to 1 if an Authentication IPv6 extension header is present.
ˆ OFPIEH_ESP is set to 1 if an Encrypted Security Payload IPv6 extension header is present.
ˆ OFPIEH_NONEXT is set to 1 if a No Next Header IPv6 extension header is present.
ˆ OFPIEH_UNSEQ is set to 1 if IPv6 extension headers were not in the order preferred (but not
required) by RFC 2460.
ˆ OFPIEH_UNREP is set to 1 if more than one of a given IPv6 extension header is unexpectedly
encountered. (Two destination options headers may be expected and would not cause this bit to
be set.)
7.2.2.8 Experimenter Flow Match Fields
Support for experimenter-specific flow match fields is optional. Experimenter-specific flow match fields
may be defined using the oxm_class=OFPXMC_EXPERIMENTER. The first four bytes of the OXM TLV’s
body contains the experimenter identifier, which takes the same form as in the typical experimenter
structure (see 7.2.5). Both oxm_field and the rest of the OXM TLV is experimenter-defined and does
not need to be padded or aligned.
/* Header for OXM experimenter match fields. */
struct ofp_oxm_experimenter_header {
uint32_t oxm_header;
/* oxm_class = OFPXMC_EXPERIMENTER */
uint32_t experimenter;
/* Experimenter ID. */
};
OFP_ASSERT(sizeof(struct ofp_oxm_experimenter_header) == 8);
7.2.3 Flow Instruction Structures
Flow instructions associated with a flow table entry are executed when a flow matches the entry. The
list of instructions that are currently defined are:
enum ofp_instruction_type {
OFPIT_GOTO_TABLE = 1,
OFPIT_WRITE_METADATA = 2,
OFPIT_WRITE_ACTIONS = 3,
OFPIT_APPLY_ACTIONS = 4,
OFPIT_CLEAR_ACTIONS = 5,
OFPIT_METER = 6,
/* Setup the next table in the lookup
pipeline */
/* Setup the metadata field for use later in
pipeline */
/* Write the action(s) onto the datapath action
set */
/* Applies the action(s) immediately */
/* Clears all actions from the datapath
action set */
/* Apply meter (rate limiter) */
60
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPIT_EXPERIMENTER = 0xFFFF
Version 1.4.0
/* Experimenter instruction */
};
The instruction set is described in section 5.9. Flow tables may support a subset of instruction types.
An instruction definition contains the instruction type, length, and any associated data:
/* Instruction header that is common to all instructions. The length includes
* the header and any padding used to make the instruction 64-bit aligned.
* NB: The length of an instruction *must* always be a multiple of eight. */
struct ofp_instruction_header {
uint16_t type;
/* One of OFPIT_*. */
uint16_t len;
/* Length of this struct in bytes. */
};
OFP_ASSERT(sizeof(struct ofp_instruction_header) == 4);
The OFPIT_GOTO_TABLE instruction uses the following structure and fields:
/* Instruction structure for OFPIT_GOTO_TABLE */
struct ofp_instruction_goto_table {
uint16_t type;
/* OFPIT_GOTO_TABLE */
uint16_t len;
/* Length is 8. */
uint8_t table_id;
/* Set next table in the lookup pipeline */
uint8_t pad[3];
/* Pad to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_instruction_goto_table) == 8);
table_id indicates the next table in the packet processing pipeline.
The OFPIT_WRITE_METADATA instruction uses the following structure and fields:
/* Instruction structure for OFPIT_WRITE_METADATA */
struct ofp_instruction_write_metadata {
uint16_t type;
/* OFPIT_WRITE_METADATA */
uint16_t len;
/* Length is 24. */
uint8_t pad[4];
/* Align to 64-bits */
uint64_t metadata;
/* Metadata value to write */
uint64_t metadata_mask;
/* Metadata write bitmask */
};
OFP_ASSERT(sizeof(struct ofp_instruction_write_metadata) == 24);
Metadata for the next table lookup can be written using the metadata and the metadata_mask in
order to set specific bits on the match field. If this instruction is not specified, the metadata is passed,
unchanged.
The OFPIT_WRITE_ACTIONS, OFPIT_APPLY_ACTIONS, and OFPIT_CLEAR_ACTIONS instructions use the
following structure and fields:
61
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Instruction structure for OFPIT_WRITE/APPLY/CLEAR_ACTIONS */
struct ofp_instruction_actions {
uint16_t type;
/* One of OFPIT_*_ACTIONS */
uint16_t len;
/* Length is padded to 64 bits. */
uint8_t pad[4];
/* Align to 64-bits */
struct ofp_action_header actions[0]; /* 0 or more actions associated with
OFPIT_WRITE_ACTIONS and
OFPIT_APPLY_ACTIONS */
};
OFP_ASSERT(sizeof(struct ofp_instruction_actions) == 8);
For the Apply-Actions instruction, the actions field is treated as a list and the actions are applied to
the packet in-order. For the Write-Actions instruction, the actions field is treated as a set and the
actions are merged into the current action set.
For the Clear-Actions instruction, the structure does not contain any actions.
The OFPIT_METER instruction uses the following structure and fields:
/* Instruction structure for OFPIT_METER */
struct ofp_instruction_meter {
uint16_t type;
/* OFPIT_METER */
uint16_t len;
/* Length is 8. */
uint32_t meter_id;
/* Meter instance. */
};
OFP_ASSERT(sizeof(struct ofp_instruction_meter) == 8);
meter_id indicates which meter to apply on the packet.
An OFPIT_EXPERIMENTER instruction uses the following structure and fields:
/* Instruction structure for experimental instructions */
struct ofp_instruction_experimenter_header {
uint16_t type;
/* OFPIT_EXPERIMENTER. */
uint16_t len;
/* Length is padded to 64 bits. */
uint32_t experimenter;
/* Experimenter ID. */
/* Experimenter-defined arbitrary additional data. */
};
OFP_ASSERT(sizeof(struct ofp_instruction_experimenter_header) == 8);
The experimenter field is the Experimenter ID, which takes the same form as in the typical experimenter structure (see 7.2.5). The rest of the instruction body is experimenter defined, the whole
instruction need to be padded to 64 bits.
7.2.4 Action Structures
A number of actions may be associated with flow entries, groups or packets. The currently defined
action types are:
62
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
enum ofp_action_type {
OFPAT_OUTPUT
= 0, /* Output to switch port. */
OFPAT_COPY_TTL_OUT = 11, /* Copy TTL "outwards" -- from next-to-outermost
to outermost */
OFPAT_COPY_TTL_IN = 12, /* Copy TTL "inwards" -- from outermost to
next-to-outermost */
OFPAT_SET_MPLS_TTL = 15, /* MPLS TTL */
OFPAT_DEC_MPLS_TTL = 16, /* Decrement MPLS TTL */
OFPAT_PUSH_VLAN
OFPAT_POP_VLAN
OFPAT_PUSH_MPLS
OFPAT_POP_MPLS
OFPAT_SET_QUEUE
OFPAT_GROUP
OFPAT_SET_NW_TTL
OFPAT_DEC_NW_TTL
OFPAT_SET_FIELD
OFPAT_PUSH_PBB
OFPAT_POP_PBB
OFPAT_EXPERIMENTER
=
=
=
=
=
=
=
=
=
=
=
=
17, /*
18, /*
19, /*
20, /*
21, /*
22, /*
23, /*
24, /*
25, /*
26, /*
27, /*
0xffff
Push a new VLAN tag */
Pop the outer VLAN tag */
Push a new MPLS tag */
Pop the outer MPLS tag */
Set queue id when outputting to a port */
Apply group. */
IP TTL. */
Decrement IP TTL. */
Set a header field using OXM TLV format. */
Push a new PBB service tag (I-TAG) */
Pop the outer PBB service tag (I-TAG) */
};
Output, group, and set-queue actions are described in Section 5.12, tag push/pop actions are described
in Table 6, and Set-Field actions are described from their OXM types in Table 12. An action definition
contains the action type, length, and any associated data:
/* Action header that is common to all actions. The length includes the
* header and any padding used to make the action 64-bit aligned.
* NB: The length of an action *must* always be a multiple of eight. */
struct ofp_action_header {
uint16_t type;
/* One of OFPAT_*. */
uint16_t len;
/* Length of action, including this
header. This is the length of action,
including any padding to make it
64-bit aligned. */
};
OFP_ASSERT(sizeof(struct ofp_action_header) == 4);
An Output action uses the following structure and fields:
/* Action structure for OFPAT_OUTPUT, which sends packets out ’port’.
* When the ’port’ is the OFPP_CONTROLLER, ’max_len’ indicates the max
* number of bytes to send. A ’max_len’ of zero means no bytes of the
* packet should be sent. A ’max_len’ of OFPCML_NO_BUFFER means that
* the packet is not buffered and the complete packet is to be sent to
* the controller. */
struct ofp_action_output {
uint16_t type;
/* OFPAT_OUTPUT. */
uint16_t len;
/* Length is 16. */
uint32_t port;
/* Output port. */
uint16_t max_len;
/* Max length to send to controller. */
uint8_t pad[6];
/* Pad to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_action_output) == 16);
63
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The port specifies the port through which the packet should be sent. The max_len indicates the
maximum amount of data from a packet that should be sent when the port is OFPP_CONTROLLER. If
max_len is zero, the switch must send zero bytes of the packet. A max_len of OFPCML_NO_BUFFER
means that the complete packet should be sent, and it should not be buffered.
enum ofp_controller_max_len {
OFPCML_MAX
= 0xffe5, /* maximum max_len value which can be
to request a specific byte length.
OFPCML_NO_BUFFER = 0xffff /* indicates that no buffering should
applied and the whole packet is to
sent to the controller. */
};
used
*/
be
be
A Group action uses the following structure and fields:
/* Action structure for OFPAT_GROUP. */
struct ofp_action_group {
uint16_t type;
/* OFPAT_GROUP. */
uint16_t len;
/* Length is 8. */
uint32_t group_id;
/* Group identifier. */
};
OFP_ASSERT(sizeof(struct ofp_action_group) == 8);
The group_id indicates the group used to process this packet. The set of buckets to apply depends on
the group type.
The Set-Queue action sets the queue id that will be used to map a flow entry to an already-configured
queue on a port, regardless of the ToS and VLAN PCP bits. The packet should not change as a result
of a Set-Queue action. If the switch needs to set the ToS/PCP bits for internal handling, the original
values should be restored before sending the packet out.
A switch may support only queues that are tied to specific PCP/ToS bits. In that case, we cannot
map an arbitrary flow entry to a specific queue, therefore the Set-Queue action is not supported. The
user can still use these queues and map flow entries to them by setting the relevant fields (ToS, VLAN
PCP).
A Set Queue action uses the following structure and fields:
/* Action structure for OFPAT_SET_QUEUE. */
struct ofp_action_set_queue {
uint16_t type;
/* OFPAT_SET_QUEUE. */
uint16_t len;
/* Len is 8. */
uint32_t queue_id;
/* Queue id for the packets. */
};
OFP_ASSERT(sizeof(struct ofp_action_set_queue) == 8);
A Set MPLS TTL action uses the following structure and fields:
64
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Action structure for OFPAT_SET_MPLS_TTL. */
struct ofp_action_mpls_ttl {
uint16_t type;
/* OFPAT_SET_MPLS_TTL. */
uint16_t len;
/* Length is 8. */
uint8_t mpls_ttl;
/* MPLS TTL */
uint8_t pad[3];
};
OFP_ASSERT(sizeof(struct ofp_action_mpls_ttl) == 8);
The mpls_ttl field is the MPLS TTL to set.
A Decrement MPLS TTL action takes no arguments and consists only of a generic ofp_action_generic.
The action decrements the MPLS TTL.
/* Action structure for OFPAT_COPY_TTL_OUT, OFPAT_COPY_TTL_IN,
* OFPAT_DEC_MPLS_TTL, OFPAT_DEC_NW_TTL, OFPAT_POP_VLAN and OFPAT_POP_PBB. */
struct ofp_action_generic {
uint16_t type;
/* One of OFPAT_*. */
uint16_t len;
/* Length is 8. */
uint8_t pad[4];
/* Pad to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_action_generic) == 8);
A Set IPv4 TTL action uses the following structure and fields:
/* Action structure for OFPAT_SET_NW_TTL. */
struct ofp_action_nw_ttl {
uint16_t type;
/* OFPAT_SET_NW_TTL. */
uint16_t len;
/* Length is 8. */
uint8_t nw_ttl;
/* IP TTL */
uint8_t pad[3];
};
OFP_ASSERT(sizeof(struct ofp_action_nw_ttl) == 8);
The nw_ttl field is the TTL address to set in the IP header.
An Decrement IPv4 TTL action takes no arguments and consists only of a generic ofp_action_generic.
This action decrement the TTL in the IP header if one is present.
A Copy TTL outwards action takes no arguments and consists only of a generic ofp_action_generic.
The action copies the TTL from the next-to-outermost header with TTL to the outermost header with
TTL.
A Copy TTL inwards action takes no arguments and consists only of a generic ofp_action_generic.
The action copies the TTL from the outermost header with TTL to the next-to-outermost header with
TTL.
A Push VLAN header action, Push MPLS header and Push PBB header action use the following
structure and fields:
65
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Action structure for OFPAT_PUSH_VLAN/MPLS/PBB. */
struct ofp_action_push {
uint16_t type;
/* OFPAT_PUSH_VLAN/MPLS/PBB. */
uint16_t len;
/* Length is 8. */
uint16_t ethertype;
/* Ethertype */
uint8_t pad[2];
};
OFP_ASSERT(sizeof(struct ofp_action_push) == 8);
The ethertype indicates the Ethertype of the new tag. It is used when pushing a new VLAN tag, new
MPLS header or PBB service header.
The Push PBB header action logically pushes a new PBB service instance header onto the packet (ITAG TCI), and copy the original Ethernet addresses of the packet into the customer addresses (C-DA
and C-SA) of the tag. The customer addresses of the I-TAG are in the location of the original Ethernet
addresses of the encapsulated packet, therefore this operations can be seen as adding both the backbone
MAC-in-MAC header and the I-SID field to the front of the packet. The Push PBB header action does
not add a backbone VLAN header (B-TAG) to the packet, it can be added via the Push VLAN header
action after the push PBB header operation. After this operation, regular set-field actions can be used
to modify the outer Ethernet addresses (B-DA and B-SA).
A Pop VLAN header action takes no arguments and consists only of a generic ofp_action_generic.
The action pops the outermost VLAN tag from the packet.
A Pop PBB header action takes no arguments and consists only of a generic ofp_action_generic. The
action logically pops the outer-most PBB service instance header from the packet (I-TAG TCI) and
copy the customer addresses (C-DA and C-SA) in the Ethernet addresses of the packet. This operation
can be seen as removing the backbone MAC-in-MAC header and the I-SID field from the front of the
packet. The Pop PBB header action does not remove the backbone VLAN header (B-TAG) from the
packet, it should be removed prior to this operation via the Pop VLAN header action.
A Pop MPLS header action uses the following structure and fields:
/* Action structure for OFPAT_POP_MPLS. */
struct ofp_action_pop_mpls {
uint16_t type;
/* OFPAT_POP_MPLS. */
uint16_t len;
/* Length is 8. */
uint16_t ethertype;
/* Ethertype */
uint8_t pad[2];
};
OFP_ASSERT(sizeof(struct ofp_action_pop_mpls) == 8);
The ethertype indicates the Ethertype of the MPLS payload. The ethertype is used as the Ethertype
for the resulting packet regardless of whether the “bottom of stack (BoS)” bit was set in the removed
MPLS shim. It is recommended that flow entries using this action match both the MPLS label and the
MPLS BoS fields to avoid applying the wrong Ethertype to the MPLS payload.
The MPLS specification does not allow to set arbitrary Ethertype to MPLS payload when BoS is not
equal to 1, and the controller is responsible in complying with this requirement and only set 0x8847
or 0x8848 as the Ethertype for those MPLS payloads. The switch can optionally enforce this MPLS
requirement: in this case the switch should reject any flow entry matching a wildcard BoS and any
66
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
flow entry matching BoS to 0 with the wrong ethertype in the Pop MPLS header action, and in both
cases should return an ofp_error_msg with OFPET_BAD_ACTION type and OFPBAC_MATCH_INCONSISTENT
code.
Set Field actions uses the following structure and fields:
/* Action structure for OFPAT_SET_FIELD. */
struct ofp_action_set_field {
uint16_t type;
/* OFPAT_SET_FIELD. */
uint16_t len;
/* Length is padded to 64 bits. */
/* Followed by:
*
- Exactly oxm_len bytes containing a single OXM TLV, then
*
- Exactly ((oxm_len + 4) + 7)/8*8 - (oxm_len + 4) (between 0 and 7)
*
bytes of all-zero bytes
*/
uint8_t field[4];
/* OXM TLV - Make compiler happy */
};
OFP_ASSERT(sizeof(struct ofp_action_set_field) == 8);
The field contains a header field described using a single OXM TLV structure (see 7.2.2). Set-Field
actions are defined by oxm_type, the type of the OXM TLV, and modify the corresponding header field in
the packet with the value of oxm_value, the payload of the OXM TLV. The value of oxm_hasmask must
be zero and no oxm_mask is included. The match of the flow entry must contain the OXM prerequisite
curresponding to the field to be set (see 7.2.2.6), otherwise an error must be generated (see 6.4).
The type of a set-field action can be any valid OXM header type, the list of possible OXM types
are described in Section 7.2.2.7 and Table 12. Set-Field actions for OXM types OFPXMT_OFB_IN_PORT,
OXM_OF_IN_PHY_PORT and OFPXMT_OFB_METADATA are not supported, because those are not header fields.
The Set-Field action overwrite the header field specified by the OXM type, and perform the necessary
CRC recalculation based on the header field. The OXM fields refers to the outermost-possible occurence
in the header, unless the field type explictely specifies otherwise, and therefore in general the set-field
actions applies to the outermost-possible header (e.g. a “Set VLAN ID” set-field action always sets the
ID of the outermost VLAN tag).
An Experimenter action uses the following structure and fields:
/* Action header for OFPAT_EXPERIMENTER.
* The rest of the body is experimenter-defined. */
struct ofp_action_experimenter_header {
uint16_t type;
/* OFPAT_EXPERIMENTER. */
uint16_t len;
/* Length is a multiple of 8. */
uint32_t experimenter;
/* Experimenter ID. */
};
OFP_ASSERT(sizeof(struct ofp_action_experimenter_header) == 8);
The experimenter field is the Experimenter ID, which takes the same form as in the typical experimenter structure (see 7.2.5). The rest of the instruction body is experimenter defined, the whole action
need to be padded to 64 bits.
67
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.2.5 Experimenter Structure
Experimenter extensions provide a standard way for OpenFlow switches to offer additional functionality
within the OpenFlow message type space. This is a staging area for features meant for future OpenFlow
revisions. Many OpenFlow object types offer Experimenter extensions, such as basic messages (see
7.5.5), OXM matches (see 7.2.2.2), instructions (see 7.2.3), actions (see 7.2.4), queues (see 7.3.5.10),
meters (see 7.3.4.5) and error (see 7.5.4).
A typical experimenter structure looks like this :
/* Typical Experimenter structure. */
struct ofp_experimenter_structure {
uint32_t experimenter;
/* Experimenter ID:
* - MSB 0: low-order bytes are IEEE OUI.
* - MSB != 0: defined by ONF. */
uint32_t exp_type;
/* Experimenter defined. */
uint8_t experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_experimenter_structure) == 8);
The actual Experimenter extension included in some object may not match exactly this structure due
to various constraints.
The experimenter field is a 32-bit value that uniquely identifies the experimenter, the entity defining the
experimenter extension. If the most significant byte is zero, the next three bytes are the experimenter’s
IEEE OUI. If the most significant byte is not zero, it is a value allocated by the Open Networking
Foundation. If experimenter does not have (or wish to use) their OUI, they should contact the Open
Networking Foundation to obtain a unique experimenter ID.
The exp_type field is a 32-bit value present in some Experimenter extensions, it defines the experimenter
type. This experimenter type is managed by the experimenter and can have any value and function the
experimenter wishes.
The experimenter_data field represent the rest of the body of the Experimenter extension, it is uninterpreted by standard OpenFlow processing and is arbitrarily defined by the corresponding experimenter.
The length of that body must fit within the OpenFlow object and the OpenFlow object length must
be properly set to accomodate this data. Some OpenFlow objects require the whole Experimenter
extension to be padded to 64 bits.
The actual Experimenter extensions are outside the scope of this specification, they are always optional,
and a switch is not required to support any Experimenter extension. If a switch does not understand
an experimenter extension, it must reject the entire message and send an appropriate error message.
The error message to use depend on the OpenFlow object (see 7.5.4). If a switch reject a specific
Experimenter extension, the controller should no longer use that specific Experimenter extension in
subsequent messages.
68
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.3 Controller-to-Switch Messages
7.3.1 Handshake
The OFPT_FEATURES_REQUEST message is used by the controller to identify the switch and read
its basic capabilities.
Upon session establishment (see 6.3.1), the controller should send an
OFPT_FEATURES_REQUEST message. This message does not contain a body beyond the OpenFlow header.
The switch must respond with an OFPT_FEATURES_REPLY message:
/* Switch features. */
struct ofp_switch_features {
struct ofp_header header;
uint64_t datapath_id;
/* Datapath unique ID. The lower 48-bits are for
a MAC address, while the upper 16-bits are
implementer-defined. */
uint32_t n_buffers;
/* Max packets buffered at once. */
uint8_t n_tables;
uint8_t auxiliary_id;
uint8_t pad[2];
/* Number of tables supported by datapath. */
/* Identify auxiliary connections */
/* Align to 64-bits. */
/* Features. */
uint32_t capabilities;
uint32_t reserved;
/* Bitmap of support "ofp_capabilities". */
};
OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
The datapath_id field uniquely identifies a datapath. The lower 48 bits are intended for the switch
MAC address, while the top 16 bits are up to the implementer. An example use of the top 16 bits would
be a VLAN ID to distinguish multiple virtual switch instances on a single physical switch. This field
should be treated as an opaque bit string by controllers.
The n_buffers field specifies the maximum number of packets the switch can buffer when sending
packets to the controller using packet-in messages (see 6.1.2).
The n_tables field describes the number of tables supported by the switch, each of which can have a
different set of supported match fields, actions and number of entries. When the controller and switch
first communicate, the controller will find out how many tables the switch supports from the Features
Reply. If it wishes to understand the size, types, and order in which tables are consulted, the controller
sends a OFPMP_TABLE_FEATURES multipart request (see 7.3.5.6). A switch must return these tables in
the order the packets traverse the tables.
The auxiliary_id field identify the type of connection from the switch to the controller, the main
connection has this field set to zero, an auxiliary connection has this field set to a non-zero value (see
6.3.5).
The capabilities field uses a combination of the following flags:
69
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
/* Capabilities supported
enum ofp_capabilities {
OFPC_FLOW_STATS
=
OFPC_TABLE_STATS
=
OFPC_PORT_STATS
=
OFPC_GROUP_STATS
=
OFPC_IP_REASM
=
OFPC_QUEUE_STATS
=
OFPC_PORT_BLOCKED
=
};
Version 1.4.0
by the datapath. */
1
1
1
1
1
1
1
<<
<<
<<
<<
<<
<<
<<
0,
1,
2,
3,
5,
6,
8
/*
/*
/*
/*
/*
/*
/*
Flow statistics. */
Table statistics. */
Port statistics. */
Group statistics. */
Can reassemble IP fragments. */
Queue statistics. */
Switch will block looping ports. */
The OFPC_PORT_BLOCKED bit indicates that a switch protocol outside of OpenFlow, such as 802.1D
Spanning Tree, will detect topology loops and block ports to prevent packet loops. If this bit is not set,
in most cases the controller should implement a mechanism to prevent packet loops.
7.3.2 Switch Configuration
The controller is able to set and query configuration parameters in the switch with the OFPT_SET_CONFIG
and OFPT_GET_CONFIG_REQUEST messages, respectively. The switch responds to a configuration request
with an OFPT_GET_CONFIG_REPLY message; it does not reply to a request to set the configuration.
There is no body for OFPT_GET_CONFIG_REQUEST beyond the OpenFlow header. The OFPT_SET_CONFIG
and OFPT_GET_CONFIG_REPLY use the following:
/* Switch configuration. */
struct ofp_switch_config {
struct ofp_header header;
uint16_t flags;
uint16_t miss_send_len;
/* Bitmap of OFPC_* flags. */
/* Max bytes of packet that datapath
should send to the controller. See
ofp_controller_max_len for valid values.
*/
};
OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
The configuration flags include the following:
enum ofp_config_flags {
/* Handling of IP fragments. */
OFPC_FRAG_NORMAL
= 0,
/* No special handling for fragments. */
OFPC_FRAG_DROP
= 1 << 0, /* Drop fragments. */
OFPC_FRAG_REASM
= 1 << 1, /* Reassemble (only if OFPC_IP_REASM set). */
OFPC_FRAG_MASK
= 3,
};
The OFPC_FRAG_* flags indicate whether IP fragments should be treated normally, dropped, or reassembled. “Normal” handling of fragments means that an attempt should be made to pass the fragments
through the OpenFlow tables. If any field is not present (e.g., the TCP/UDP ports didn’t fit), then the
packet should not match any entry that has that field set.
70
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The miss_send_len field defines the number of bytes of each packet sent to the controller by the
OpenFlow pipeline when not using an output action to the OFPP_CONTROLLER logical port, for example
sending packets with invalid TTL if this message reason is enabled. If this field equals 0, the switch must
send zero bytes of the packet in the ofp_packet_in message. If the value is set to OFPCML_NO_BUFFER
the complete packet must be included in the message, and should not be buffered.
7.3.3 Flow Table Configuration
Flow tables are numbered from 0 and can take any number until OFPTT_MAX. OFPTT_ALL is a reserved
value.
/* Table numbering. Tables can use any number up to OFPT_MAX. */
enum ofp_table {
/* Last usable table number. */
OFPTT_MAX
= 0xfe,
/* Fake tables. */
OFPTT_ALL
= 0xff
/* Wildcard table used for table config,
flow stats and flow deletes. */
};
Flow entries are modified in the flow table using the OFP_FLOW_MOD request (see 7.3.4.2). Table statistics
can be queried using the OFPMP_TABLE multipart requests (see 7.3.5.4). The controller can configure
the dynamic state in a flow table with the OFP_TABLE_MOD request (see 7.3.4.2). The flow table static
features can be modified using the OFPMP_TABLE_FEATURES multipart request (see 7.3.5.6).
7.3.4 Modify State Messages
7.3.4.1 Modify Flow Table Message
The controller can configure the dynamic state in a flow table with the OFP_TABLE_MOD request. The
OFP_TABLE_MOD use the following structure and fields:
/* Configure/Modify behavior of a flow table */
struct ofp_table_mod {
struct ofp_header header;
uint8_t table_id;
/* ID of the table, OFPTT_ALL indicates all tables */
uint8_t pad[3];
/* Pad to 32 bits */
uint32_t config;
/* Bitmap of OFPTC_* flags */
/* Table Mod Property list */
struct ofp_table_mod_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_table_mod) == 16);
71
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The table_id chooses the table to which the configuration change should be applied. If the table_id
is OFPTT_ALL, the configuration is applied to all tables in the switch.
The config field is a bitmap that configures the behaviour of the table. The following values are defined
for that field :
/* Flags to configure the table. */
enum ofp_table_config {
OFPTC_DEPRECATED_MASK
= 3,
OFPTC_EVICTION
= 1 << 2,
OFPTC_VACANCY_EVENTS
= 1 << 3,
};
/* Deprecated bits */
/* Authorise table to evict flows. */
/* Enable vacancy events. */
The flag OFPTC_EVICTION control flow entry eviction in that flow table (see 5.5). If this flag is set, the
switch can evict flow entries from that flow table. If this flag is unset, the switch cannot evict flow
entries from that table. Flow entry eviction is optional and as a consequence a switch may not support
setting this flag.
The flag OFPTC_VACANCY_EVENTS control vacancy events in that table (see 7.4.5). If this flag is set, the
switch must generate vacancy events for that table. If this flag is unset, the switch must not generate
those events. Parameters for vacancy events may be specified using the OFPTMPT_VACANCY property.
The properties field is a list of table mod properties, describing dynamic parameters of table configuration.
The table mod property types currently defined are:
/* Table Mod property types.
*/
enum ofp_table_mod_prop_type {
OFPTMPT_EVICTION
OFPTMPT_VACANCY
OFPTMPT_EXPERIMENTER
};
= 0x2,
/* Eviction property. */
= 0x3,
/* Vacancy property. */
= 0xFFFF, /* Experimenter property. */
A property definition contains the property type, length, and any associated data:
/* Common header for all Table Mod Properties */
struct ofp_table_mod_prop_header {
uint16_t
type;
/* One of OFPTMPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_table_mod_prop_header) == 4);
The OFPTMPT_EVICTION property usually cannot be modified using a OFP_TABLE_MOD request, because
the eviction mechanism is switch defined, and this property is usually only used in a OFPMP_TABLE_DESC
multipart reply to inform the controller about the eviction mechanism used. It uses the following
structure and fields:
72
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Eviction table mod Property. Mostly used in OFPMP_TABLE_DESC replies. */
struct ofp_table_mod_prop_eviction {
uint16_t
type;
/* OFPTMPT_EVICTION. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
flags;
/* Bitmap of OFPTMPEF_* flags */
};
OFP_ASSERT(sizeof(struct ofp_table_mod_prop_eviction) == 8);
The flags field is a bitmap that defines the type of eviction the switch is implementing. The following
flags:
/* Eviction flags. */
enum ofp_table_mod_prop_eviction_flag {
OFPTMPEF_OTHER
= 1 << 0,
OFPTMPEF_IMPORTANCE
= 1 << 1,
OFPTMPEF_LIFETIME
= 1 << 2,
};
/* Using other factors. */
/* Using flow entry importance. */
/* Using flow entry lifetime. */
If the flag OFPTMPEF_IMPORTANCE is set, the eviction process will use the flow entry importance field
(see 7.3.4.2) to perform eviction. If the flag OFPTMPEF_IMPORTANCE is the only flag set, eviction will
be performed strictly in order of importance, that is flow entry with lower importance will always be
evicted before flow entry with higher importance. The eviction mechanism is switch defined, therefore
it is not possible to predict in which order flow entries of same importance will get evicted.
If the flag OFPTMPEF_LIFETIME is set, the eviction process will use the flow entry remaining lifetime, the
shortest time to expiration (see 5.5), to perform eviction. If the flag OFPTMPEF_LIFETIME is the only
flag set, eviction will be performed stricly in order of remaining lifetime, and permanent flow entries
are never removed.
If the flag OFPTMPEF_OTHER is set, the eviction process will use other factors, such as internal constraints,
to perform eviction. When this flag is set, the controller cannot predict in which order flow entries will
get evicted. This flag may be combined with other flags to signify that, for example, eviction is mostly
done by the switch according to importance or lifetime but not strictly.
The OFPTMPT_VACANCY property uses the following structure and fields:
/* Vacancy table mod property */
struct ofp_table_mod_prop_vacancy {
uint16_t
type;
/* OFPTMPT_VACANCY. */
uint16_t
length; /* Length in bytes of this property. */
uint8_t vacancy_down;
/* Vacancy threshold when space decreases (%). */
uint8_t vacancy_up;
/* Vacancy threshold when space increases (%). */
uint8_t vacancy;
/* Current vacancy (%) - only in ofp_table_desc. */
uint8_t pad[1];
/* Align to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_table_mod_prop_vacancy) == 8);
The fields vacancy_down and vacancy_up are the threshold for generating vacancy events that should
be configured on this flow table, expressed as a percent.
When the remaining space in the flow table decreases to less than vacancy_down, and if vacancy
down events are enabled, a vacancy down event must be generated to the controller using the
73
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
OFPT_TABLE_STATUS message type with reason OFPTR_VACANCY_DOWN (see 7.4.5). Further vacancy down
events are disabled until a vacancy up event is generated.
When the remaining space in the flow table increases to more than vacancy_up, and if vacancy up events
are enabled, a vacancy up event must be generated to the controller using the OFPT_TABLE_STATUS
message type with reason OFPTR_VACANCY_UP. Further vacancy up events are disabled until a vacancy
down event is generated.
When vacancy events are enabled on the table using the OFPTC_VACANCY_EVENTS flag, either the vacancy up or vacancy down event is enabled. When enabling events, if the current vacancy is less than
vacancy_up, vacancy up events must be enabled, and vacancy down events must be disabled. When
enabling events, if the current vacancy is greater or equal to vacancy_up, vacancy down events must
be enabled, and vacancy up events must be disabled. When vacancy events are disabled on the table
using the OFPTC_VACANCY_EVENTS flag, both vacancy up and vacancy down events must be disabled.
If in a OFP_TABLE_MOD message the value of vacancy_down is greater than the value of
vacancy_up, the switch should reject the OFP_TABLE_MOD message and send an ofp_error_msg with
OFPET_BAD_PROPERTY type and OFPBPC_BAD_VALUE code.
The vacancy field is only used when this property in included in a OFPMP_TABLE_DESC multipart reply or
a OFPT_TABLE_STATUS message and represent the current vacancy of the table, expressed as a percent.
In OFP_TABLE_MOD requests, this field must be set to 0.
The OFPTMPT_EXPERIMENTER property uses the following structure and fields:
/* Experimenter table mod property */
struct ofp_table_mod_prop_experimenter {
uint16_t
type;
/* OFPTMPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_table_mod_prop_experimenter) == 12);
The experimenter field is the Experimenter ID, which takes the same form as in the typical experimenter structure (see 7.2.5).
7.3.4.2 Modify Flow Entry Message
Modifications to a flow table from the controller are done with the OFPT_FLOW_MOD message:
74
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Flow setup and teardown (controller -> datapath). */
struct ofp_flow_mod {
struct ofp_header header;
uint64_t cookie;
/* Opaque controller-issued identifier. */
uint64_t cookie_mask;
/* Mask used to restrict the cookie bits
that must match when the command is
OFPFC_MODIFY* or OFPFC_DELETE*. A value
of 0 indicates no restriction. */
/* Flow actions. */
uint8_t table_id;
/* ID of the table to put the flow in.
For OFPFC_DELETE_* commands, OFPTT_ALL
can also be used to delete matching
flows from all tables. */
uint8_t command;
/* One of OFPFC_*. */
uint16_t idle_timeout;
/* Idle time before discarding (seconds). */
uint16_t hard_timeout;
/* Max time before discarding (seconds). */
uint16_t priority;
/* Priority level of flow entry. */
uint32_t buffer_id;
/* Buffered packet to apply to, or
OFP_NO_BUFFER.
Not meaningful for OFPFC_DELETE*. */
uint32_t out_port;
/* For OFPFC_DELETE* commands, require
matching entries to include this as an
output port. A value of OFPP_ANY
indicates no restriction. */
uint32_t out_group;
/* For OFPFC_DELETE* commands, require
matching entries to include this as an
output group. A value of OFPG_ANY
indicates no restriction. */
uint16_t flags;
/* Bitmap of OFPFF_* flags. */
uint16_t importance;
/* Eviction precedence (optional). */
struct ofp_match match;
/* Fields to match. Variable size. */
/* The variable size and padded match is always followed by instructions. */
//struct ofp_instruction_header instructions[0];
/* Instruction set - 0 or more. The length
of the instruction set is inferred from
the length field in the header. */
};
OFP_ASSERT(sizeof(struct ofp_flow_mod) == 56);
The cookie field is an opaque data value chosen by the controller. This value appears in flow removed
messages and flow statistics, and can also be used to filter flow statistics, flow modification and flow
deletion (see 6.4). It is not used by the packet processing pipeline, and thus does not need to reside in
hardware. The value -1 (0xffffffffffffffff) is reserved and must not be used. When a flow entry is inserted
in a table through an OFPFC_ADD message, its cookie field is set to the provided value. When a flow
entry is modified (OFPFC_MODIFY or OFPFC_MODIFY_STRICT messages), its cookie field is unchanged.
If the cookie_mask field is non-zero, it is used with the cookie field to restrict flow matching while
modifying or deleting flow entries. This field is ignored by OFPFC_ADD messages. The cookie_mask
field’s behavior is explained in Section 6.4.
The table_id field specifies the table into which the flow entry should be inserted, modified or deleted.
Table 0 signifies the first table in the pipeline. The use of OFPTT_ALL is only valid for delete requests.
The command field must be one of the following:
75
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
enum ofp_flow_mod_command
OFPFC_ADD
=
OFPFC_MODIFY
=
OFPFC_MODIFY_STRICT =
{
0, /* New flow. */
1, /* Modify all matching flows. */
2, /* Modify entry strictly matching wildcards and
priority. */
OFPFC_DELETE
= 3, /* Delete all matching flows. */
OFPFC_DELETE_STRICT = 4, /* Delete entry strictly matching wildcards and
priority. */
};
The differences between OFPFC_MODIFY and OFPFC_MODIFY_STRICT are explained in Section 6.4 and
differences between OFPFC_DELETE and OFPFC_DELETE_STRICT are explained in Section 6.4.
The idle_timeout and hard_timeout fields control how quickly flow entries expire (see 5.5). When
a flow entry is inserted in a table, its idle_timeout and hard_timeout fields are set with the values
from the message. When a flow entry is modified (OFPFC_MODIFY or OFPFC_MODIFY_STRICT messages),
the idle_timeout and hard_timeout fields are ignored.
If the idle_timeout is set and the hard_timeout is zero, the entry must expire after idle_timeout
seconds with no received traffic. If the idle_timeout is zero and the hard_timeout is set, the entry
must expire in hard_timeout seconds regardless of whether or not packets are hitting the entry. If both
idle_timeout and hard_timeout are set, the flow entry will timeout after idle_timeout seconds with
no traffic, or hard_timeout seconds, whichever comes first. If both idle_timeout and hard_timeout
are zero, the entry is considered permanent and will never time out. It can still be removed with a
flow_mod message of type OFPFC_DELETE.
The priority indicates priority within the specified flow table table. Higher numbers indicate higher
priorities. This field is used only for OFPFC_ADD messages when matching and adding flow entries, and
for OFPFC_MODIFY_STRICT or OFPFC_DELETE_STRICT messages when matching flow entries.
The buffer_id refers to a packet buffered at the switch and sent to the controller by a packet-in
message. If no buffered packet is associated with the flow mod, it must be set to OFP_NO_BUFFER.
A flow mod that includes a valid buffer_id removes the corresponding packet from the buffer and
processes it through the entire OpenFlow pipeline after the flow is inserted, starting at the first flow
table. This is effectively equivalent to sending a two-message sequence of a flow mod and a packet-out
forwarding to the OFPP_TABLE logical port (see 7.3.6), with the requirement that the switch must fully
process the flow mod before the packet out. These semantics apply regardless of the table to which the
flow mod refers, or the instructions contained in the flow mod. This field is ignored by OFPFC_DELETE
and OFPFC_DELETE_STRICT flow mod messages.
The out_port and out_group fields optionally filter the scope of OFPFC_DELETE and
OFPFC_DELETE_STRICT messages by output port and group. If either out_port or out_group contains a value other than OFPP_ANY or OFPG_ANY respectively, it introduces a constraint when matching. This constraint is that the flow entry must contain an output action directed at that port or
group. Other constraints such as ofp_match structs and priorities are still used; this is purely an
additional constraint. Note that to disable output filtering, both out_port and out_group must be
set to OFPP_ANY and OFPG_ANY respectively. These fields are ignored by OFPFC_ADD, OFPFC_MODIFY or
OFPFC_MODIFY_STRICT messages.
The flags field may include a combination of the following flags:
76
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
enum ofp_flow_mod_flags {
OFPFF_SEND_FLOW_REM = 1 << 0,
OFPFF_CHECK_OVERLAP
OFPFF_RESET_COUNTS
OFPFF_NO_PKT_COUNTS
OFPFF_NO_BYT_COUNTS
=
=
=
=
1
1
1
1
<<
<<
<<
<<
1,
2,
3,
4,
/*
*
/*
/*
/*
/*
Send flow removed message when flow
expires or is deleted. */
Check for overlapping entries first. */
Reset flow packet and byte counts. */
Don’t keep track of packet count. */
Don’t keep track of byte count. */
};
When the OFPFF_SEND_FLOW_REM flag is set, the switch must send a flow removed message when the
flow entry expires or is deleted.
When the OFPFF_CHECK_OVERLAP flag is set, the switch must check that there are no conflicting entries
with the same priority prior to inserting it in the flow table. If there is one, the flow mod fails and an
error message is returned (see 6.4).
When the OFPFF_NO_PKT_COUNTS flag is set, the switch does not need to keep track of the flow packet
count. When the OFPFF_NO_BYT_COUNTS flag is set, the switch does not need to keep track of the flow
byte count. Setting those flags may decrease the processing load on some OpenFlow switches, however
those counters may not be available in flow statistics and flow removed messages for this flow entry. A
switch is not required to honor those flags and may keep track of a flow count and return it despite the
corresponding flag being set. If a switch does not keep track of a flow count, the corresponding counter
is not available and must be set to the maximum field value (see 5.8).
When a flow entry is inserted in a table, its flags field is set with the values from the message. When
a flow entry is matched and modified (OFPFC_MODIFY or OFPFC_MODIFY_STRICT messages), the flags
field is ignored.
The importance field is the importance of the flow entry. This field may be optionally used by the flow
entry eviction mechanism (see 5.5).
The instructions field contains the instruction set for the flow entry when adding or modifying entries.
If the instruction set is not valid or supported, the switch must generate an error (see 6.4).
7.3.4.3 Modify Group Entry Message
Modifications to the group table from the controller are done with the OFPT_GROUP_MOD message:
/* Group setup and teardown (controller -> datapath). */
struct ofp_group_mod {
struct ofp_header header;
uint16_t command;
/* One of OFPGC_*. */
uint8_t type;
/* One of OFPGT_*. */
uint8_t pad;
/* Pad to 64 bits. */
uint32_t group_id;
/* Group identifier. */
struct ofp_bucket buckets[0]; /* The length of the bucket array is inferred
from the length field in the header. */
};
OFP_ASSERT(sizeof(struct ofp_group_mod) == 16);
77
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The semantics of the type and group fields are explained in Section 6.6.
The command field must be one of the following:
/* Group commands */
enum ofp_group_mod_command {
OFPGC_ADD
= 0,
/* New group. */
OFPGC_MODIFY = 1,
/* Modify all matching groups. */
OFPGC_DELETE = 2,
/* Delete all matching groups. */
};
The type field must be one of the following:
/* Group types. Values
* use. */
enum ofp_group_type {
OFPGT_ALL
= 0,
OFPGT_SELECT
= 1,
OFPGT_INDIRECT = 2,
OFPGT_FF
= 3,
};
in the range [128, 255] are reserved for experimental
/*
/*
/*
/*
All (multicast/broadcast) group.
Select group. */
Indirect group. */
Fast failover group. */
*/
The group_id field uniquely identifies a group within a switch. The following special group identifiers
are defined:
/* Group numbering. Groups can use any number up to OFPG_MAX. */
enum ofp_group {
/* Last usable group number. */
OFPG_MAX
= 0xffffff00,
/* Fake groups. */
OFPG_ALL
= 0xfffffffc,
OFPG_ANY
= 0xffffffff
/* Represents all groups for group delete
commands. */
/* Wildcard group used only for flow stats
requests. Selects all flows regardless of
group (including flows with no group).
*/
};
The buckets field is an array of buckets. For Indirect group, the arrays must contain exactly one
bucket (see 5.6.1), other group types may have multiple buckets in the array. For Fast Failover group,
the bucket order does define the bucket priorities (see 5.6.1), and the bucket order can be changed by
modifying the group (for example using a OFPT_GROUP_MOD message with command OFPGC_MODIFY).
Buckets in the array use the following struct:
/* Bucket for use in groups. */
struct ofp_bucket {
uint16_t len;
uint16_t weight;
/* Length the bucket in bytes, including
this header and any padding to make it
64-bit aligned. */
/* Relative weight of bucket. Only
78
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
uint32_t watch_port;
uint32_t watch_group;
Version 1.4.0
defined for select groups. */
/* Port whose state affects whether this
bucket is live. Only required for fast
failover groups. */
/* Group whose state affects whether this
bucket is live. Only required for fast
failover groups. */
uint8_t pad[4];
struct ofp_action_header actions[0]; /* 0 or more actions associated with
the bucket - The action list length
is inferred from the length
of the bucket. */
};
OFP_ASSERT(sizeof(struct ofp_bucket) == 16);
The weight field is only defined for select groups, and its support is optional. The bucket’s share of the
traffic processed by the group is defined by the individual bucket’s weight divided by the sum of the
bucket weights in the group. When a port goes down, the change in traffic distribution is undefined.
The precision by which a switch’s packet distribution should match bucket weights is undefined.
The watch_port and watch_group fields are only required for fast failover groups, and may be optionally
implemented for other group types. These fields indicate the port and/or group whose liveness controls
whether this bucket is a candidate for forwarding. For fast failover groups, the first bucket defined is
the highest-priority bucket, and only the highest-priority live bucket is used (see 5.6.1).
The actions field is the action set associated with the bucket. When the bucket is selected for a packet,
its action set is applied to the packet (see 5.10).
7.3.4.4 Port Modification Message
The controller uses the OFPT_PORT_MOD message to modify the behavior of the port:
/* Modify behavior of the physical port */
struct ofp_port_mod {
struct ofp_header header;
uint32_t port_no;
uint8_t pad[4];
uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
configurable. This is used to
sanity-check the request, so it must
be the same as returned in an
ofp_port struct. */
uint8_t pad2[2];
/* Pad to 64 bits. */
uint32_t config;
/* Bitmap of OFPPC_* flags. */
uint32_t mask;
/* Bitmap of OFPPC_* flags to be changed. */
/* Port mod property list - 0 or more properties */
struct ofp_port_mod_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_port_mod) == 32);
79
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The config field describes port administrative settings (see 7.2.1).
The mask field is used to select bits in the config field to change.
The properties field is a list of port description properties, enabling to configure additional properties
of the port. All port properties do not need to be included in the OFPT_PORT_MOD message, properties
that are omitted are unchanged.
The list of port description property types that are currently defined are:
/* Port mod property types.
*/
enum ofp_port_mod_prop_type {
OFPPMPT_ETHERNET
= 0,
/* Ethernet property. */
OFPPMPT_OPTICAL
= 1,
/* Optical property. */
OFPPMPT_EXPERIMENTER
= 0xFFFF, /* Experimenter property. */
};
A property definition contains the property type, length, and any associated data:
/* Common header for all port mod properties. */
struct ofp_port_mod_prop_header {
uint16_t
type;
/* One of OFPPMPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_port_mod_prop_header) == 4);
The OFPPMPT_ETHERNET property uses the following structure and fields:
/* Ethernet port mod property. */
struct ofp_port_mod_prop_ethernet {
uint16_t
type;
/* OFPPMPT_ETHERNET. */
uint16_t
length;
/* Length in bytes of this property. */
uint32_t
advertise; /* Bitmap of OFPPF_*. Zero all bits to prevent
any action taking place. */
};
OFP_ASSERT(sizeof(struct ofp_port_mod_prop_ethernet) == 8);
The advertise field describe Ethernet features advertised on the link (7.2.1). It has no mask; all port
features change together.
The OFPPMPT_OPTICAL property uses the following structure and fields:
struct ofp_port_mod_prop_optical {
uint16_t
type;
/* OFPPMPT_OPTICAL. */
uint16_t
length;
/* Length in bytes of this property. */
uint32_t
configure; /* Bitmap of OFPOPF_*. */
uint32_t
freq_lmda; /* The "center" frequency */
int32_t
fl_offset; /* signed frequency offset */
uint32_t
grid_span; /* The size of the grid for this port */
uint32_t
tx_pwr;
/* tx power setting */
};
OFP_ASSERT(sizeof(struct ofp_port_mod_prop_optical) == 24);
80
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The configure field describes optical features to change for this port. Any of OFPOPF_* may be set.
Frequency is specified in MHz, wavelength (lambda) as nm * 100. The OFPOPF_USE_FREQ must match
the advertised port feture. The tx_pwr is dBm * 10.
The tuned frequency is the sum of freq_lmda and fl_offset. This is for convenience of the software,
since some tuning options, including Flex Grid, may be based upon a center frequency and an offset.
The ”center” frequency is often used for passive filters, again making this convenient for the software.
The grid_span is the amount of bandwidth consumed by this port, useful for Flex Grid as well as other
tuning information.
The OFPPMPT_EXPERIMENTER property uses the following structure and fields:
/* Experimenter port mod property. */
struct ofp_port_mod_prop_experimenter {
uint16_t
type;
/* OFPPMPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_port_mod_prop_experimenter) == 12);
The experimenter field is the Experimenter ID, which takes the same form as in the typical experimenter structure (see 7.2.5).
7.3.4.5 Meter Modification Message
Modifications to a meter from the controller are done with the OFPT_METER_MOD message:
/* Meter configuration. OFPT_METER_MOD. */
struct ofp_meter_mod {
struct ofp_header header;
uint16_t
command;
/*
uint16_t
flags;
/*
uint32_t
meter_id;
/*
struct ofp_meter_band_header bands[0];
One of OFPMC_*. */
Bitmap of OFPMF_* flags. */
Meter instance. */
/* The band list length is
inferred from the length field
in the header. */
};
OFP_ASSERT(sizeof(struct ofp_meter_mod) == 16);
The meter_id field uniquely identifies a meter within a switch. Meter are defined starting with
meter_id=1 up to the maximum number of meters that the switch can support. The OpenFlow
protocol also defines some additional virtual meters that can not be associated with flows:
81
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Meter numbering. Flow meters can use any number up to OFPM_MAX. */
enum ofp_meter {
/* Last usable meter. */
OFPM_MAX
= 0xffff0000,
/* Virtual meters. */
OFPM_SLOWPATH
= 0xfffffffd,
OFPM_CONTROLLER = 0xfffffffe,
OFPM_ALL
= 0xffffffff,
/* Meter for slow datapath. */
/* Meter for controller connection. */
/* Represents all meters for stat requests
commands. */
};
Virtual meters are provided to support existing implementations of OpenFlow. New implementations
are encouraged to use regular per-flow meters or priority queues instead.
ˆ OFPM_CONTROLLER: Virtual meter controlling all packets sent to the controller via Packet-in messages, either using the CONTROLLER reserved port or in other processing (see 6.1.2). Can be
used to limit the amount of traffic sent to the controller.
ˆ OFPM_SLOWPATH: Virtual meter controlling all packets processed by the slow datapath of the switch.
Many switch implementations have a fast and slow datapath, for example a hardware switch may
have a slow software datapath, or a software switch may have a slow userspace datapath.
The command field must be one of the following:
/* Meter commands */
enum ofp_meter_mod_command {
OFPMC_ADD,
/* New meter. */
OFPMC_MODIFY,
/* Modify specified meter. */
OFPMC_DELETE,
/* Delete specified meter. */
};
The flags field may include a combination of following flags:
/* Meter configuration flags */
enum ofp_meter_flags {
OFPMF_KBPS
= 1 << 0,
/* Rate value in kb/s (kilo-bit per second). */
OFPMF_PKTPS
= 1 << 1,
/* Rate value in packet/sec. */
OFPMF_BURST
= 1 << 2,
/* Do burst size. */
OFPMF_STATS
= 1 << 3,
/* Collect statistics. */
};
The bands field is a list of rate bands. It can contain any number of bands, and each band type can be
repeated when it make sense. Only a single band is used at a time, if the current rate of packets exceed
the rate of multiple bands, the band with the highest configured rate is used.
All the rate bands are defined using the same common header:
82
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Common header for all meter bands */
struct ofp_meter_band_header {
uint16_t
type;
/* One of OFPMBT_*. */
uint16_t
len;
/* Length in bytes of this band. */
uint32_t
rate;
/* Rate for this band. */
uint32_t
burst_size; /* Size of bursts. */
};
OFP_ASSERT(sizeof(struct ofp_meter_band_header) == 12);
The rate field indicates the rate value above which the corresponding band may apply to packets (see
5.7.1). The rate value is in kilobit per seconds, unless the flags field includes OFPMF_PKTPS, in which
case the rate is in packets per seconds.
The burst_size field is used only if the flags field includes OFPMF_BURST. It defines the granularity
of the meter, for all packet or byte burst which length is greater than burst value, the meter rate will
always be strictly enforced. The burst value is in kilobits, unless the flags field includes OFPMF_PKTPS,
in which case the burst value is in packets.
The type field must be one of the following:
/* Meter band types */
enum ofp_meter_band_type {
OFPMBT_DROP
= 1,
OFPMBT_DSCP_REMARK
= 2,
OFPMBT_EXPERIMENTER
= 0xFFFF
};
/* Drop packet. */
/* Remark DSCP in the IP header. */
/* Experimenter meter band. */
An OpenFlow switch may not support all band types, and may not allow to use all its supported bands
on all meters, i.e. some meters may be specialised.
The band OFPMBT_DROP defines a simple rate limiter that drop packets that exceed the band rate value,
and uses the following structure:
/* OFPMBT_DROP band - drop packets */
struct ofp_meter_band_drop {
uint16_t
type;
/* OFPMBT_DROP. */
uint16_t
len;
/* Length is 16. */
uint32_t
rate;
/* Rate for dropping packets. */
uint32_t
burst_size; /* Size of bursts. */
uint8_t
pad[4];
};
OFP_ASSERT(sizeof(struct ofp_meter_band_drop) == 16);
The band OFPMBT_DSCP_REMARK defines a simple DiffServ policer that remark the drop precedence of
the DSCP field in the IP header of the packets that exceed the band rate value, and uses the following
structure:
/* OFPMBT_DSCP_REMARK band - Remark DSCP in the IP header */
struct ofp_meter_band_dscp_remark {
uint16_t
type;
/* OFPMBT_DSCP_REMARK. */
uint16_t
len;
/* Length is 16. */
83
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
uint32_t
uint32_t
uint8_t
uint8_t
Version 1.4.0
rate;
/* Rate for remarking packets. */
burst_size; /* Size of bursts. */
prec_level; /* Number of drop precedence level to add. */
pad[3];
};
OFP_ASSERT(sizeof(struct ofp_meter_band_dscp_remark) == 16);
The prec_level field indicates by which amount the drop precedence of the packet should be increased
if the band is exceeded.
The band OFPMBT_EXPERIMENTER is experimenter defined and uses the following structure:
/* OFPMBT_EXPERIMENTER band - Write actions in action set */
struct ofp_meter_band_experimenter {
uint16_t
type;
/* One of OFPMBT_*. */
uint16_t
len;
/* Length in bytes of this band. */
uint32_t
rate;
/* Rate for this band. */
uint32_t
burst_size;
/* Size of bursts. */
uint32_t
experimenter; /* Experimenter ID. */
};
OFP_ASSERT(sizeof(struct ofp_meter_band_experimenter) == 16);
The experimenter field is the Experimenter ID, which takes the same form as in the typical experimenter structure (see 7.2.5). The rest of the band body is experimenter defined.
7.3.5 Multipart Messages
Multipart messages are used to encode requests or replies that potentially carry a large amount of data
and would not always fit in a single OpenFlow message, which is limited to 64KB. The request or reply
is encoded as a sequence of multipart messages with a specific multipart type, and re-assembled by
the receiver. Multipart messages are primarily used to request statistics or state information from the
switch.
The request is carried in one or more OFPT_MULTIPART_REQUEST messages:
struct ofp_multipart_request {
struct ofp_header header;
uint16_t type;
/* One of the OFPMP_* constants. */
uint16_t flags;
/* OFPMPF_REQ_* flags. */
uint8_t pad[4];
uint8_t body[0];
/* Body of the request. 0 or more bytes. */
};
OFP_ASSERT(sizeof(struct ofp_multipart_request) == 16);
enum ofp_multipart_request_flags {
OFPMPF_REQ_MORE = 1 << 0 /* More requests to follow. */
};
The switch responds with one or more OFPT_MULTIPART_REPLY messages:
84
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
struct ofp_multipart_reply {
struct ofp_header header;
uint16_t type;
/* One of the OFPMP_* constants. */
uint16_t flags;
/* OFPMPF_REPLY_* flags. */
uint8_t pad[4];
uint8_t body[0];
/* Body of the reply. 0 or more bytes. */
};
OFP_ASSERT(sizeof(struct ofp_multipart_reply) == 16);
enum ofp_multipart_reply_flags {
OFPMPF_REPLY_MORE = 1 << 0 /* More replies to follow. */
};
The only value defined for flags in a request and reply is whether more requests/replies will follow
this one - this has the value 0x0001. To ease implementation, the controller is allowed to send requests
and the switch is allowed to send replies with no additional entries (i.e. an empty body). However,
another message must always follow a message with the more flag set. A request or reply that spans
multiple messages (has one or more messages with the more flag set), must use the same multipart type
and transaction id (xid) for all messages in the message sequence. Messages from a multipart request
or reply may be interleaved with other OpenFlow message types, including other multipart requests
or replies, but must have distinct transaction ids if multiple unanswered multipart requests or replies
are in flight simultaneously. Transaction ids of replies must always match the request that prompted
them.
In both the request and response, the type field specifies the kind of information being passed and
determines how the body field is interpreted:
enum ofp_multipart_type {
/* Description of this OpenFlow switch.
* The request body is empty.
* The reply body is struct ofp_desc. */
OFPMP_DESC = 0,
/* Individual flow statistics.
* The request body is struct ofp_flow_stats_request.
* The reply body is an array of struct ofp_flow_stats. */
OFPMP_FLOW = 1,
/* Aggregate flow statistics.
* The request body is struct ofp_aggregate_stats_request.
* The reply body is struct ofp_aggregate_stats_reply. */
OFPMP_AGGREGATE = 2,
/* Flow table statistics.
* The request body is empty.
* The reply body is an array of struct ofp_table_stats. */
OFPMP_TABLE = 3,
/* Port statistics.
* The request body is struct ofp_port_stats_request.
* The reply body is an array of struct ofp_port_stats. */
OFPMP_PORT_STATS = 4,
85
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Queue statistics for a port
* The request body is struct ofp_queue_stats_request.
* The reply body is an array of struct ofp_queue_stats */
OFPMP_QUEUE_STATS = 5,
/* Group counter statistics.
* The request body is struct ofp_group_stats_request.
* The reply is an array of struct ofp_group_stats. */
OFPMP_GROUP = 6,
/* Group description.
* The request body is empty.
* The reply body is an array of struct ofp_group_desc. */
OFPMP_GROUP_DESC = 7,
/* Group features.
* The request body is empty.
* The reply body is struct ofp_group_features. */
OFPMP_GROUP_FEATURES = 8,
/* Meter statistics.
* The request body is struct ofp_meter_multipart_requests.
* The reply body is an array of struct ofp_meter_stats. */
OFPMP_METER = 9,
/* Meter configuration.
* The request body is struct ofp_meter_multipart_requests.
* The reply body is an array of struct ofp_meter_config. */
OFPMP_METER_CONFIG = 10,
/* Meter features.
* The request body is empty.
* The reply body is struct ofp_meter_features. */
OFPMP_METER_FEATURES = 11,
/* Table features.
* The request body is either empty or contains an array of
* struct ofp_table_features containing the controller’s
* desired view of the switch. If the switch is unable to
* set the specified view an error is returned.
* The reply body is an array of struct ofp_table_features. */
OFPMP_TABLE_FEATURES = 12,
/* Port description.
* The request body is empty.
* The reply body is an array of struct ofp_port. */
OFPMP_PORT_DESC = 13,
/* Table description.
* The request body is empty.
* The reply body is an array of struct ofp_table_desc. */
OFPMP_TABLE_DESC = 14,
/* Queue description.
* The request body is struct ofp_queue_desc_request.
* The reply body is an array of struct ofp_queue_desc. */
OFPMP_QUEUE_DESC = 15,
86
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Flow monitors.
* The request body is struct ofp_flow_monitor_request.
* The reply body is an array of struct ofp_flow_update_header. */
OFPMP_FLOW_MONITOR = 16,
/* Experimenter extension.
* The request and reply bodies begin with
* struct ofp_experimenter_multipart_header.
* The request and reply bodies are otherwise experimenter-defined. */
OFPMP_EXPERIMENTER = 0xffff
};
If a multipart request spans multiple messages and grows to
buffer, the switch must respond with an error messsage of
OFPBRC_MULTIPART_BUFFER_OVERFLOW. If a multipart request
ported, the switch must respond with an error messsage of
OFPBRC_BAD_MULTIPART.
a size that the switch is
type OFPET_BAD_REQUEST
contains a type that is
type OFPET_BAD_REQUEST
unable to
and code
not supand code
If a switch receives a multipart request message sequence that does not include a message with
OFPMPF_REQ_MORE flag set to zero, after a switch defined amount of time greater than 100 milliseconds
from the last message, the switch must discard the incomplete multipart request, and may generate an
error messsage of type OFPET_BAD_REQUEST and code OFPBRC_MULTIPART_REQUEST_TIMEOUT to the controller. If a controller receives a multipart reply message sequence that does not include a message with
OFPMPF_REPLY_MORE flag set to zero, after a controller defined amount of time greater than 1 second
from the last message, the controller must discard the incomplete multipart reply, and may generate an
error messsage of type OFPET_BAD_REQUEST and code OFPBRC_MULTIPART_REPLY_TIMEOUT to the switch.
The controller may retry the failed switch operation as needed as a new multipart request.
In all types of multipart reply containing statistics, if a specific numeric counter is not available in the
switch, its value must be set to the maximum field value (the unsigned equivalent of -1). Counters are
unsigned and wrap around with no overflow indicator.
7.3.5.1 Description
Information about the switch manufacturer, hardware revision, software revision, serial number, and a
description field is available from the OFPMP_DESC multipart request type:
/* Body of reply to OFPMP_DESC request. Each entry is a NULL-terminated
* ASCII string. */
struct ofp_desc {
char mfr_desc[DESC_STR_LEN];
/* Manufacturer description. */
char hw_desc[DESC_STR_LEN];
/* Hardware description. */
char sw_desc[DESC_STR_LEN];
/* Software description. */
char serial_num[SERIAL_NUM_LEN];
/* Serial number. */
char dp_desc[DESC_STR_LEN];
/* Human readable description of datapath. */
};
OFP_ASSERT(sizeof(struct ofp_desc) == 1056);
87
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
Each entry is ASCII formatted and padded on the right with null bytes (\0). DESC_STR_LEN is 256 and
SERIAL_NUM_LEN is 32. The dp_desc field is a free-form string to describe the datapath for debugging
purposes, e.g., “switch3 in room 3120”. As such, it is not guaranteed to be unique and should not be
used as the primary identifier for the datapath—use the datapath_id field from the switch features
instead (see 7.3.1).
7.3.5.2 Individual Flow Statistics
Information about individual flow entries is requested with the OFPMP_FLOW multipart request type:
/* Body for ofp_multipart_request of type OFPMP_FLOW. */
struct ofp_flow_stats_request {
uint8_t table_id;
/* ID of table to read (from ofp_table_stats),
OFPTT_ALL for all tables. */
uint8_t pad[3];
/* Align to 32 bits. */
uint32_t out_port;
/* Require matching entries to include this
as an output port. A value of OFPP_ANY
indicates no restriction. */
uint32_t out_group;
/* Require matching entries to include this
as an output group. A value of OFPG_ANY
indicates no restriction. */
uint8_t pad2[4];
/* Align to 64 bits. */
uint64_t cookie;
/* Require matching entries to contain this
cookie value */
uint64_t cookie_mask;
/* Mask used to restrict the cookie bits that
must match. A value of 0 indicates
no restriction. */
struct ofp_match match;
/* Fields to match. Variable size. */
};
OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
The match field contains a description of the flow entries that should be matched and may contain
wildcarded and masked fields. This field’s matching behavior is described in Section 6.4.
The table_id field indicates the index of a single table to read, or OFPTT_ALL for all tables.
The out_port and out_group fields optionally filter by output port and group. If either out_port or
out_group contain a value other than OFPP_ANY and OFPG_ANY respectively, it introduces a constraint
when matching. This constraint is that the flow entry must contain an output action directed at that
port or group. Other constraints such as ofp_match structs are still used; this is purely an additional
constraint. Note that to disable output filtering, both out_port and out_group must be set to OFPP_ANY
and OFPG_ANY respectively.
The usage of the cookie and cookie_mask fields is defined in Section 6.4.
The body of the reply to a OFPMP_FLOW multipart request consists of an array of the following:
/* Body of reply to OFPMP_FLOW request. */
struct ofp_flow_stats {
uint16_t length;
/* Length of this entry. */
uint8_t table_id;
/* ID of table flow came from. */
uint8_t pad;
88
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
uint32_t duration_sec;
uint32_t duration_nsec;
/* Time flow has been alive in seconds. */
/* Time flow has been alive in nanoseconds beyond
duration_sec. */
uint16_t priority;
/* Priority of the entry. */
uint16_t idle_timeout;
/* Number of seconds idle before expiration. */
uint16_t hard_timeout;
/* Number of seconds before expiration. */
uint16_t flags;
/* Bitmap of OFPFF_* flags. */
uint16_t importance;
/* Eviction precedence. */
uint8_t pad2[2];
/* Align to 64-bits. */
uint64_t cookie;
/* Opaque controller-issued identifier. */
uint64_t packet_count;
/* Number of packets in flow. */
uint64_t byte_count;
/* Number of bytes in flow. */
struct ofp_match match;
/* Description of fields. Variable size. */
//struct ofp_instruction_header instructions[0];
/* Instruction set - 0 or more. */
};
OFP_ASSERT(sizeof(struct ofp_flow_stats) == 56);
The fields consist of those provided in the flow_mod that created the flow entry (see 7.3.4.2), plus
the table_id into which the entry was inserted, the packet_count, and the byte_count counting all
packets processed by the flow entry.
The duration_sec and duration_nsec fields indicate the elapsed time the flow entry has been installed
in the switch. The total duration in nanoseconds can be computed as duration sec×109 +duration nsec.
Implementations are required to provide second precision; higher precision is encouraged where available.
7.3.5.3 Aggregate Flow Statistics
Aggregate information about multiple flow entries is requested with the OFPMP_AGGREGATE multipart
request type:
/* Body for ofp_multipart_request of type OFPMP_AGGREGATE. */
struct ofp_aggregate_stats_request {
uint8_t table_id;
/* ID of table to read (from ofp_table_stats)
OFPTT_ALL for all tables. */
uint8_t pad[3];
/* Align to 32 bits. */
uint32_t out_port;
/* Require matching entries to include this
as an output port. A value of OFPP_ANY
indicates no restriction. */
uint32_t out_group;
/* Require matching entries to include this
as an output group. A value of OFPG_ANY
indicates no restriction. */
uint8_t pad2[4];
/* Align to 64 bits. */
uint64_t cookie;
/* Require matching entries to contain this
cookie value */
uint64_t cookie_mask;
/* Mask used to restrict the cookie bits that
must match. A value of 0 indicates
no restriction. */
struct ofp_match match;
/* Fields to match. Variable size. */
};
OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40);
89
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The fields in this message have the same meanings as in the individual flow stats request type
(OFPMP_FLOW).
The body of the reply consists of the following:
/* Body of reply to OFPMP_AGGREGATE request. */
struct ofp_aggregate_stats_reply {
uint64_t packet_count;
/* Number of packets in flows. */
uint64_t byte_count;
/* Number of bytes in flows. */
uint32_t flow_count;
/* Number of flows. */
uint8_t pad[4];
/* Align to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
7.3.5.4 Table Statistics
Information about tables is requested with the OFPMP_TABLE multipart request type. The request does
not contain any data in the body.
The body of the reply consists of an array of the following:
/* Body of reply to OFPMP_TABLE request. */
struct ofp_table_stats {
uint8_t table_id;
/* Identifier of table. Lower numbered tables
are consulted first. */
uint8_t pad[3];
/* Align to 32-bits. */
uint32_t active_count;
/* Number of active entries. */
uint64_t lookup_count;
/* Number of packets looked up in table. */
uint64_t matched_count; /* Number of packets that hit table. */
};
OFP_ASSERT(sizeof(struct ofp_table_stats) == 24);
The array has one structure for each table supported by the switch. The entries are returned in the
order that packets traverse the tables.
7.3.5.5 Table Description
The OFPMP_TABLE_DESC multipart request message provides a way to list the current configuration of
the tables on a switch, which is set using the OFPT_TABLE_MOD message. The request body is empty,
while the reply body is an array of the following structure:
/* Body of reply to OFPMP_TABLE_DESC request. */
struct ofp_table_desc {
uint16_t length;
/* Length is padded to 64 bits. */
uint8_t table_id;
/* Identifier of table. Lower numbered tables
are consulted first. */
uint8_t pad[1];
/* Align to 32-bits. */
uint32_t config;
/* Bitmap of OFPTC_* values. */
/* Table Mod Property list - 0 or more. */
90
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
struct ofp_table_mod_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_table_desc) == 8);
Fields for table description are the same as those used with the ofp_table_mod struct (see 7.3.4.1).
7.3.5.6 Table Features
The OFPMP_TABLE_FEATURES multipart type allows a controller to both query for the capabilities of
existing tables, and to optionally ask the switch to reconfigure its tables to match a supplied configuration. In general, the table feature capabilities represents all possible features of a table, however some
features may be mutually exclusive and the current capabilities structures do not allow us to represent
such exclusions.
7.3.5.6.1 Table Features request and reply
If the OFPMP_TABLE_FEATURES request body is empty the switch will return an array of struct
ofp_table_features containing the capabilities of the currently configured flow tables.
If the request body contains an array of one or more ofp_table_features structs, the switch will
attempt to change its flow tables to match the requested flow table configuration. This operation
configures the entire pipeline, and the set of flow tables in the pipeline must match the set in the
request, or an error must be returned. In particular, if the requested configuration does not contain an
ofp_table_features struct for one or more flow tables that the switch supports, these flow tables are
to be removed from the pipeline if the configuration is successfully set. A successful configuration change
will modify the features for all flow tables in the request, that is, either all the flow tables specified in
the request are modified or none, and the new capabilities for each flow table must be either a superset
of, or equal to the requested capabilities. If the flow table configuration is successful, flow entries from
flow tables that have been removed or flow tables that had their capabilities change between the prior
and new configuration are removed from the flow table, however no ofp_flow_removed messages are
sent. The switch then replies with the new configuration. If the switch is unable to set the requested
configuration, an error of type OFPET_TABLE_FEATURES_FAILED is returned with the appropriate error
code.
Requests and replies containing ofp_table_features are expected to meet the following minimum
requirements:
ˆ Each ofp_table_features struct’s table_id field value should be unique amongst all
ofp_table_features structs in the message
ˆ Each ofp_table_features struct’s properties field must contain exactly one of each of the
ofp_table_feature_prop_type properties, with two exceptions. First, properties with the _MISS
suffix may be ommited if it is the same as the corresponding property for regular flow entries.
Second, properties of type OFPTFPT_EXPERIMENTER and OFPTFPT_EXPERIMENTER_MISS may be
ommited or included many times. Ordering is unspecified, but implementers are encouraged to
use the ordering listed in the specification (see 7.3.5.6.2).
91
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
A switch receiving a request that does not meet these requirements should return an error of type
OFPET_TABLE_FEATURES_FAILED with the appropriate error code.
The following structure describes the body of the table features request and reply:
/* Body for ofp_multipart_request of type OFPMP_TABLE_FEATURES./
* Body of reply to OFPMP_TABLE_FEATURES request. */
struct ofp_table_features {
uint16_t length;
/* Length is padded to 64 bits. */
uint8_t table_id;
/* Identifier of table. Lower numbered tables
are consulted first. */
uint8_t pad[5];
/* Align to 64-bits. */
char name[OFP_MAX_TABLE_NAME_LEN];
uint64_t metadata_match; /* Bits of metadata table can match. */
uint64_t metadata_write; /* Bits of metadata table can write. */
uint32_t capabilities;
/* Bitmap of OFPTC_* values. */
uint32_t max_entries;
/* Max number of entries supported. */
/* Table Feature Property list */
struct ofp_table_feature_prop_header properties[0]; /* List of properties */
};
OFP_ASSERT(sizeof(struct ofp_table_features) == 64);
The array has one structure for each flow table supported by the switch. The entries are always returned
in the order that packets traverse the flow tables. OFP_MAX_TABLE_NAME_LEN is 32 .
The metadata_match field indicates the bits of the metadata field that the table can match on, when
using the metadata field of struct ofp_match. A value of 0xFFFFFFFFFFFFFFFF indicates that the
table can match the full metadata field.
The metadata_write field indicates the bits of the metadata field that the table can write using the
OFPIT_WRITE_METADATA instruction. A value of 0xFFFFFFFFFFFFFFFF indicates that the table can write
the full metadata field.
The capabilities field is the set of flags that are supported in a table configuration message (see
7.3.3).
The max_entries field describes the maximum number of flow entries that can be inserted into that
table. Due to limitations imposed by modern hardware, the max_entries value should be considered
advisory and a best effort approximation of the capacity of the table. Despite the high-level abstraction
of a table, in practice the resource consumed by a single flow table entry is not constant. For example,
a flow table entry might consume more than one entry, depending on its match parameters (e.g.,
IPv4 vs. IPv6). Also, tables that appear distinct at an OpenFlow-level might in fact share the same
underlying physical resources. Further, on OpenFlow hybrid switches, those table may be shared with
non-OpenFlow functions. The result is that switch implementers should report an approximation of
the total flow entries supported and controller writers should not treat this value as a fixed, physical
constant.
The properties field is a list of table feature properties, describing various capabilities of the table.
92
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.3.5.6.2 Table Features properties
The list of table feature property types that are currently defined are:
/* Table Feature property types.
* Low order bit cleared indicates a property for a regular Flow Entry.
* Low order bit set indicates a property for the Table-Miss Flow Entry.
*/
enum ofp_table_feature_prop_type {
OFPTFPT_INSTRUCTIONS
= 0, /* Instructions property. */
OFPTFPT_INSTRUCTIONS_MISS
= 1, /* Instructions for table-miss. */
OFPTFPT_NEXT_TABLES
= 2, /* Next Table property. */
OFPTFPT_NEXT_TABLES_MISS
= 3, /* Next Table for table-miss. */
OFPTFPT_WRITE_ACTIONS
= 4, /* Write Actions property. */
OFPTFPT_WRITE_ACTIONS_MISS
= 5, /* Write Actions for table-miss. */
OFPTFPT_APPLY_ACTIONS
= 6, /* Apply Actions property. */
OFPTFPT_APPLY_ACTIONS_MISS
= 7, /* Apply Actions for table-miss. */
OFPTFPT_MATCH
= 8, /* Match property. */
OFPTFPT_WILDCARDS
= 10, /* Wildcards property. */
OFPTFPT_WRITE_SETFIELD
= 12, /* Write Set-Field property. */
OFPTFPT_WRITE_SETFIELD_MISS
= 13, /* Write Set-Field for table-miss. */
OFPTFPT_APPLY_SETFIELD
= 14, /* Apply Set-Field property. */
OFPTFPT_APPLY_SETFIELD_MISS
= 15, /* Apply Set-Field for table-miss. */
OFPTFPT_TABLE_SYNC_FROM
= 16, /* Table synchronisation property. */
OFPTFPT_EXPERIMENTER
= 0xFFFE, /* Experimenter property. */
OFPTFPT_EXPERIMENTER_MISS
= 0xFFFF, /* Experimenter for table-miss. */
};
The properties with the _MISS suffix describe the capabilities for the table-miss flow entry (see 5.4),
whereas other properties describe the capabilities for regular flow entry. If a specific property does not
have any capability (for example no Set-Field support), a property with an empty list must be included
in the property list. When a property of the table-miss flow entry is the same as the corresponding
property for regular flow entries (i.e. both properties have the same list of capabilities), this table-miss
property can be omited from the property list.
A property definition contains the property type, length, and any associated data:
/* Common header for all Table Feature Properties */
struct ofp_table_feature_prop_header {
uint16_t
type;
/* One of OFPTFPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_header) == 4);
The OFPTFPT_INSTRUCTIONS and OFPTFPT_INSTRUCTIONS_MISS properties use the following structure
and fields:
/* Instructions property */
struct ofp_table_feature_prop_instructions {
uint16_t
type;
/* One of OFPTFPT_INSTRUCTIONS,
OFPTFPT_INSTRUCTIONS_MISS. */
uint16_t
length; /* Length in bytes of this property. */
/* Followed by:
93
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
*
*
*
struct
Version 1.4.0
Exactly (length - 4) bytes containing the instruction ids, then
Exactly (length + 7)/8*8 - (length) (between 0 and 7)
bytes of all-zero bytes */
ofp_instruction_id instruction_ids[0];
/* List of instructions */
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_instructions) == 4);
The instruction_ids is the list of instructions supported by this table (see 5.9). The elements of that
list are variable size to enable expressing experimenter instructions, non-experimenter instructions are
4 bytes, and they use the following structure:
/* Instruction ID */
struct ofp_instruction_id {
uint16_t type;
/* One of OFPIT_*. */
uint16_t len;
/* Length is 4 or experimenter defined. */
uint8_t exp_data[0];
/* Optional experimenter id + data. */
};
OFP_ASSERT(sizeof(struct ofp_instruction_id) == 4);
The OFPTFPT_NEXT_TABLES, OFPTFPT_NEXT_TABLES_MISS and OFPTFPT_TABLE_SYNC_FROM properties
use the following structure and fields:
/* Next Tables and Table Synchronise From properties */
struct ofp_table_feature_prop_tables {
uint16_t
type;
/* One of OFPTFPT_NEXT_TABLES,
OFPTFPT_NEXT_TABLES_MISS,
OFPTFPT_TABLE_SYNC_FROM. */
uint16_t
length; /* Length in bytes of this property. */
/* Followed by:
*
- Exactly (length - 4) bytes containing the table_ids, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint8_t
table_ids[0];
/* List of table ids. */
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_tables) == 4);
For OFPTFPT_NEXT_TABLES and OFPTFPT_NEXT_TABLES_MISS, the table_ids is the array of tables that
can be directly reached from the present table using the OFPIT_GOTO_TABLE instruction (see 5.1).
For OFPTFPT_TABLE_SYNC_FROM, the table_ids field is the array of tables the present table is synchronising content from (see 6.5). When a flow entry is added, modified or removed in one of the flow
tables listen in the array, a corresponding flow entry is automatically added, modified or removed in
the present flow table.
The OFPTFPT_WRITE_ACTIONS, OFPTFPT_WRITE_ACTIONS_MISS, OFPTFPT_APPLY_ACTIONS
OFPTFPT_APPLY_ACTIONS_MISS properties use the following structure and fields:
and
/* Actions property */
struct ofp_table_feature_prop_actions {
uint16_t
type;
/* One of OFPTFPT_WRITE_ACTIONS,
OFPTFPT_WRITE_ACTIONS_MISS,
94
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
OFPTFPT_APPLY_ACTIONS,
OFPTFPT_APPLY_ACTIONS_MISS. */
/* Length in bytes of this property. */
uint16_t
length;
/* Followed by:
*
- Exactly (length - 4) bytes containing the action_ids, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
struct ofp_action_id action_ids[0];
/* List of actions */
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_actions) == 4);
The OFPTFPT_WRITE_ACTIONS and OFPTFPT_WRITE_ACTIONS_MISS properties describe actions supported by the table using the OFPIT_WRITE_ACTIONS instruction, whereas the OFPTFPT_APPLY_ACTIONS
and OFPTFPT_APPLY_ACTIONS_MISS properties describe actions supported by the table using the
OFPIT_APPLY_ACTIONS instruction.
The action_ids is the list of actions for the feature (see 5.12). The elements of that list are variable
size to enable expressing experimenter actions, non-experimenter actions are 4 bytes, and they use the
following structure:
/* Action ID */
struct ofp_action_id {
uint16_t type;
/* One of OFPAT_*. */
uint16_t len;
/* Length is 4 or experimenter defined. */
uint8_t exp_data[0];
/* Optional experimenter id + data. */
};
OFP_ASSERT(sizeof(struct ofp_action_id) == 4);
The
OFPTFPT_MATCH,
OFPTFPT_WILDCARDS,
OFPTFPT_WRITE_SETFIELD_MISS, OFPTFPT_APPLY_SETFIELD and
properties use the following structure and fields:
OFPTFPT_WRITE_SETFIELD,
OFPTFPT_APPLY_SETFIELD_MISS
/* Match, Wildcard or Set-Field property */
struct ofp_table_feature_prop_oxm {
uint16_t
type;
/* One of OFPTFPT_MATCH,
OFPTFPT_WILDCARDS,
OFPTFPT_WRITE_SETFIELD,
OFPTFPT_WRITE_SETFIELD_MISS,
OFPTFPT_APPLY_SETFIELD,
OFPTFPT_APPLY_SETFIELD_MISS. */
uint16_t
length; /* Length in bytes of this property. */
/* Followed by:
*
- Exactly (length - 4) bytes containing the oxm_ids, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
oxm_ids[0];
/* Array of OXM headers */
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_oxm) == 4);
The oxm_ids is the list of OXM types for the feature (see 7.2.2.2). The elements of that list are 32-bit
OXM headers or 64-bit OXM headers for experimenter OXM fields.
95
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The OFPTFPT_MATCH property indicates the fields for which that particular table supports matching
on (see 7.2.2.7). For example, if the table can match the ingress port, an OXM header with the type
OXM_OF_IN_PORT should be included in the list. If the HASMASK bit is set on the OXM header then the
switch must support masking for the given type. The OFPTFPT_WILDCARDS property indicates the fields
for which that particular table supports wildcarding (omiting). For example, a direct look-up hash table
would have that list empty, while a TCAM or sequentially searched table would have it set to the same
value as the OFPTFPT_MATCH property.
The OFPTFPT_WRITE_SETFIELD and OFPTFPT_WRITE_SETFIELD_MISS properties describe Set-Field
action types supported by the table using the OFPIT_WRITE_ACTIONS instruction, whereas the
OFPTFPT_APPLY_SETFIELD and OFPTFPT_APPLY_SETFIELD_MISS properties describe Set-Field action
types supported by the table using the OFPIT_APPLY_ACTIONS instruction.
All fields in ofp_table_features may be requested to be changed by the controller with the exception
of the max_entries field, this is read only and returned by the switch.
The OFPTFPT_APPLY_ACTIONS, OFPTFPT_APPLY_ACTIONS_MISS, OFPTFPT_APPLY_SETFIELD, and
OFPTFPT_APPLY_SETFIELD_MISS properties contain actions and fields the table is capable of applying.
For each of these lists, if an element is present it means the table is at least capable of applying the
element in isolation one time. There is currently no way to indicate which elements can be applied
together, in which order, and how many time an element can be applied in a single flow entry.
The OFPTFPT_EXPERIMENTER and OFPTFPT_EXPERIMENTER_MISS properties use the following structure
and fields:
/* Experimenter table feature property */
struct ofp_table_feature_prop_experimenter {
uint16_t
type;
/* One of OFPTFPT_EXPERIMENTER,
OFPTFPT_EXPERIMENTER_MISS. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_experimenter) == 12);
The experimenter field is the Experimenter ID and the exp_type field is the experimenter type, they
takes the same form as in the typical experimenter structure (see 7.2.5). The experimenter_data field
is experimenter defined, the whole property need to be padded to 64 bits.
7.3.5.7 Port Statistics
Information about ports statistics is requested with the OFPMP_PORT_STATS multipart request type:
96
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Body for ofp_multipart_request of type OFPMP_PORT_STATS. */
struct ofp_port_stats_request {
uint32_t port_no;
/* OFPMP_PORT message must request statistics
* either for a single port (specified in
* port_no) or for all ports (if port_no ==
* OFPP_ANY). */
uint8_t pad[4];
};
OFP_ASSERT(sizeof(struct ofp_port_stats_request) == 8);
The port_no field optionally filters the stats request to the given port. To request all port statistics,
port_no must be set to OFPP_ANY.
The body of the reply consists of an array of the following:
/* Body of reply to OFPMP_PORT_STATS request. If a counter is unsupported,
* set the field to all ones. */
struct ofp_port_stats {
uint16_t length;
/* Length of this entry. */
uint8_t pad[2];
/* Align to 64 bits. */
uint32_t port_no;
uint32_t duration_sec;
/* Time port has been alive in seconds. */
uint32_t duration_nsec; /* Time port has been alive in nanoseconds beyond
duration_sec. */
uint64_t rx_packets;
/* Number of received packets. */
uint64_t tx_packets;
/* Number of transmitted packets. */
uint64_t rx_bytes;
/* Number of received bytes. */
uint64_t tx_bytes;
/* Number of transmitted bytes. */
uint64_t rx_dropped;
uint64_t tx_dropped;
uint64_t rx_errors;
uint64_t tx_errors;
/* Number of packets dropped by RX. */
/* Number of packets dropped by TX. */
/* Number of receive errors. This is a super-set
of more specific receive errors and should be
greater than or equal to the sum of all
rx_*_err values in properties. */
/* Number of transmit errors. This is a super-set
of more specific transmit errors and should be
greater than or equal to the sum of all
tx_*_err values (none currently defined.) */
/* Port description property list - 0 or more properties */
struct ofp_port_desc_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_port_stats) == 80);
The duration_sec and duration_nsec fields indicate the elapsed time the port has been configured
into the OpenFlow pipeline. The total duration in nanoseconds can be computed as duration sec ×
109 + duration nsec. Implementations are required to provide second precision; higher precision is
encouraged where available.
The rx_packets, tx_packets, rx_bytes and tx_bytes are basic port counters measuring packets going
through the port.
The properties field is a list of port statistics properties, which include port type specific statistics.
97
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The list of port description property types that are currently defined are:
/* Port stats property types.
*/
enum ofp_port_stats_prop_type
OFPPSPT_ETHERNET
OFPPSPT_OPTICAL
OFPPSPT_EXPERIMENTER
};
{
= 0,
/* Ethernet property. */
= 1,
/* Optical property. */
= 0xFFFF, /* Experimenter property. */
A property definition contains the property type, length, and any associated data:
/* Common header for all port stats properties. */
struct ofp_port_stats_prop_header {
uint16_t
type;
/* One of OFPPSPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_port_stats_prop_header) == 4);
The OFPPSPT_ETHERNET property uses the following structure and fields:
/* Ethernet port stats property. */
struct ofp_port_stats_prop_ethernet {
uint16_t
type;
/* OFPPSPT_ETHERNET. */
uint16_t
length; /* Length in bytes of this property. */
uint8_t
pad[4]; /* Align to 64 bits. */
uint64_t
uint64_t
uint64_t
uint64_t
rx_frame_err;
rx_over_err;
rx_crc_err;
collisions;
/*
/*
/*
/*
Number
Number
Number
Number
of
of
of
of
frame alignment errors. */
packets with RX overrun. */
CRC errors. */
collisions. */
};
OFP_ASSERT(sizeof(struct ofp_port_stats_prop_ethernet) == 40);
The OFPPSPT_OPTICAL property uses the following structure and fields:
/* Optical port stats property. */
struct ofp_port_stats_prop_optical {
uint16_t
type;
/* OFPPSPT_OPTICAL. */
uint16_t
length; /* Length in bytes of this property. */
uint8_t
pad[4]; /* Align to 64 bits. */
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint16_t
uint16_t
uint16_t
uint16_t
flags;
tx_freq_lmda;
tx_offset;
tx_grid_span;
rx_freq_lmda;
rx_offset;
rx_grid_span;
tx_pwr;
rx_pwr;
bias_current;
temperature;
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
Features enabled by the port. */
Current TX Frequency/Wavelength */
TX Offset */
TX Grid Spacing */
Current RX Frequency/Wavelength */
RX Offset */
RX Grid Spacing */
Current TX power */
Current RX power */
TX Bias Current */
TX Laser Temperature */
};
OFP_ASSERT(sizeof(struct ofp_port_stats_prop_optical) == 44);
98
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The flags indicates which of the stats values are valid:
/* Flags is one of OFPOSF_ below */
enum ofp_port_stats_optical_flags {
OFPOSF_RX_TUNE
= 1 << 0, /* Receiver tune info valid */
OFPOSF_TX_TUNE
= 1 << 1, /* Transmit tune info valid */
OFPOSF_TX_PWR
= 1 << 2, /* TX Power is valid */
OFPOSF_RX_PWR
= 1 << 4, /* RX power is valid */
OFPOSF_TX_BIAS
= 1 << 5, /* Transmit bias is valid */
OFPOSF_TX_TEMP
= 1 << 6, /* TX Temp is valid */
};
The port tuning values are represented as described by the Port Description (see 7.2.1). Frequency
values are in MHz, wavelength (lambda) in nm * 100. The tx_pwr and rx_pwr are dBm * 10. The
bias_current is mA * 10 and is useful as a laser efficiency reference. The laser temperature is degress
C * 10.
The OFPPSPT_EXPERIMENTER property uses the following structure and fields:
/* Experimenter port stats property. */
struct ofp_port_stats_prop_experimenter {
uint16_t
type;
/* OFPPSPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_port_stats_prop_experimenter) == 12);
The experimenter field is the Experimenter ID, which takes the same form as in the typical experimenter structure (see 7.2.5).
7.3.5.8 Port Description
The port description request OFPMP_PORT_DESCRIPTION enables the controller to get a description of all
the ports in the system that support OpenFlow. The request body is empty. The reply body consists
of an array of the following:
/* Description of a port */
struct ofp_port {
uint32_t port_no;
uint16_t length;
uint8_t pad[2];
uint8_t hw_addr[OFP_ETH_ALEN];
uint8_t pad2[2];
/* Align to 64 bits. */
99
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
uint32_t config;
uint32_t state;
/* Bitmap of OFPPC_* flags. */
/* Bitmap of OFPPS_* flags. */
/* Port description property list - 0 or more properties */
struct ofp_port_desc_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_port) == 40);
This structure is described in section 7.2.1. All port properties relevant to the port type must be
included in the port description. For example, a physical port of type Ethernet must include a Ethernet
property in its description, whereas a logical port does not need to include it.
7.3.5.9 Queue Statistics
The OFPMP_QUEUE_STATS multipart request message provides queue statistics for one or more ports and
one or more queues. The request body contains a port_no field identifying the OpenFlow port for
which statistics are requested, or OFPP_ANY to refer to all ports. The queue_id field identifies one of
the priority queues, or OFPQ_ALL to refer to all queues configured at the specified port. OFPQ_ALL is
0xffffffff.
/* Body for ofp_multipart_request of type OFPMP_QUEUE_STATS. */
struct ofp_queue_stats_request {
uint32_t port_no;
/* All ports if OFPP_ANY. */
uint32_t queue_id;
/* All queues if OFPQ_ALL. */
};
OFP_ASSERT(sizeof(struct ofp_queue_stats_request) == 8);
The body of the reply consists of an array of the following structure:
/* Body of reply to OFPMP_QUEUE_STATS request. */
struct ofp_queue_stats {
uint16_t length;
/* Length of this entry. */
uint8_t pad[6];
/* Align to 64 bits. */
uint32_t port_no;
/* Port the queue is attached to. */
uint32_t queue_id;
/* Queue i.d */
uint64_t tx_bytes;
/* Number of transmitted bytes. */
uint64_t tx_packets;
/* Number of transmitted packets. */
uint64_t tx_errors;
/* Number of packets dropped due to overrun. */
uint32_t duration_sec;
/* Time queue has been alive in seconds. */
uint32_t duration_nsec; /* Time queue has been alive in nanoseconds beyond
duration_sec. */
struct ofp_queue_stats_prop_header properties[0]; /* List of properties. */
};
OFP_ASSERT(sizeof(struct ofp_queue_stats) == 48);
100
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The duration_sec and duration_nsec fields indicate the elapsed time the queue has been installed in
the switch. The total duration in nanoseconds can be computed as duration sec × 109 + duration nsec.
Implementations are required to provide second precision; higher precision is encouraged where available.
The properties field is a list of table feature properties, describing various capabilities of the table.
The list of table feature property types that are currently defined are:
enum ofp_queue_stats_prop_type {
OFPQSPT_EXPERIMENTER = 0xffff
};
/* Experimenter defined property. */
A property definition contains the property type, length, and any associated data:
/* Common header for all queue properties */
struct ofp_queue_stats_prop_header {
uint16_t
type;
/* One of OFPQSPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_queue_stats_prop_header) == 4);
The OFPQSPT_EXPERIMENTER properties uses the following structure and fields:
/* Experimenter queue property description. */
struct ofp_queue_stats_prop_experimenter {
uint16_t
type;
/* OFPQSPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_queue_stats_prop_experimenter) == 12);
The experimenter field is the Experimenter ID, which takes the same form as in the typical experimenter structure (see 7.2.5).
101
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.3.5.10 Queue Descriptions
An OpenFlow switch provides limited Quality-of-Service support (QoS) through a simple queuing mechanism. One (or more) queues can attach to a port and be used to map flow entries on it. Flow entries
mapped to a specific queue will be treated according to that queue’s configuration (e.g. min rate).
Queue configuration takes place outside the OpenFlow protocol, either through a command line tool or
through an external dedicated configuration protocol. The controller can query the switch for configured
queues on a port using OFPMP_QUEUE_DESC multipart request.
The OFPMP_QUEUE_DESC multipart request message provides queue descriptions for one or more ports
and one or more queues. The request body contains a port_no field identifying the OpenFlow port for
which statistics are requested, or OFPP_ANY to refer to all ports. The queue_id field identifies one of
the priority queues, or OFPQ_ALL to refer to all queues configured at the specified port. OFPQ_ALL is
0xffffffff.
/* Body for ofp_multipart_request of type OFPMP_QUEUE_DESC. */
struct ofp_queue_desc_request {
uint32_t port_no;
/* All ports if OFPP_ANY. */
uint32_t queue_id;
/* All queues if OFPQ_ALL. */
};
OFP_ASSERT(sizeof(struct ofp_queue_desc_request) == 8);
The body of the reply consists of an array of the following structure:
/* Body of reply to OFPMP_QUEUE_DESC request. */
struct ofp_queue_desc {
uint32_t port_no;
/* Port this queue is attached to. */
uint32_t queue_id;
/* id for the specific queue. */
uint16_t len;
/* Length in bytes of this queue desc. */
uint8_t pad[6];
/* 64-bit alignment. */
struct ofp_queue_desc_prop_header properties[0]; /* List of properties. */
};
OFP_ASSERT(sizeof(struct ofp_queue_desc) == 16);
The properties field is a list of table feature properties, describing various capabilities of the table.
The list of table feature property types that are currently defined are:
enum ofp_queue_desc_prop_type {
OFPQDPT_MIN_RATE
= 1,
OFPQDPT_MAX_RATE
= 2,
OFPQDPT_EXPERIMENTER = 0xffff
};
/* Minimum datarate guaranteed. */
/* Maximum datarate. */
/* Experimenter defined property. */
A property definition contains the property type, length, and any associated data:
102
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Common header for all queue properties */
struct ofp_queue_desc_prop_header {
uint16_t
type;
/* One of OFPQDPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_queue_desc_prop_header) == 4);
The OFPQDPT_MIN_RATE properties uses the following structure and fields:
/* Min-Rate queue property description. */
struct ofp_queue_desc_prop_min_rate {
uint16_t
type;
/* OFPQDPT_MIN_RATE. */
uint16_t
length; /* Length is 8. */
uint16_t rate;
/* In 1/10 of a percent; >1000 -> disabled. */
uint8_t pad[2];
/* 64-bit alignment */
};
OFP_ASSERT(sizeof(struct ofp_queue_desc_prop_min_rate) == 8);
If rate is not configured, it is set to OFPQ_MIN_RATE_UNCFG, which is 0xffff.
The OFPQDPT_MAX_RATE properties uses the following structure and fields:
/* Max-Rate queue property description. */
struct ofp_queue_desc_prop_max_rate {
uint16_t
type;
/* OFPQDPT_MAX_RATE. */
uint16_t
length; /* Length is 8. */
uint16_t rate;
/* In 1/10 of a percent; >1000 -> disabled. */
uint8_t pad[2];
/* 64-bit alignment */
};
OFP_ASSERT(sizeof(struct ofp_queue_desc_prop_max_rate) == 8);
If rate is not configured, it is set to OFPQ_MAX_RATE_UNCFG, which is 0xffff.
The OFPQDPT_EXPERIMENTER properties uses the following structure and fields:
/* Experimenter queue property description. */
struct ofp_queue_desc_prop_experimenter {
uint16_t
type;
/* OFPQDPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_queue_desc_prop_experimenter) == 12);
The experimenter field is the Experimenter ID, which takes the same form as in the typical experimenter structure (see 7.2.5).
103
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.3.5.11 Group Statistics
The OFPMP_GROUP multipart request message provides statistics for one or more groups. The request
body consists of a group_id field, which can be set to OFPG_ALL to refer to all groups on the switch.
/* Body of OFPMP_GROUP request. */
struct ofp_group_stats_request {
uint32_t group_id;
/* All groups if OFPG_ALL. */
uint8_t pad[4];
/* Align to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_group_stats_request) == 8);
The body of the reply consists of an array of the following structure:
/* Body of reply to OFPMP_GROUP
struct ofp_group_stats {
uint16_t length;
/*
uint8_t pad[2];
/*
uint32_t group_id;
/*
uint32_t ref_count;
/*
request. */
Length of this entry. */
Align to 64 bits. */
Group identifier. */
Number of flows or groups that directly forward
to this group. */
uint8_t pad2[4];
/* Align to 64 bits. */
uint64_t packet_count;
/* Number of packets processed by group. */
uint64_t byte_count;
/* Number of bytes processed by group. */
uint32_t duration_sec;
/* Time group has been alive in seconds. */
uint32_t duration_nsec; /* Time group has been alive in nanoseconds beyond
duration_sec. */
struct ofp_bucket_counter bucket_stats[0]; /* One counter set per bucket. */
};
OFP_ASSERT(sizeof(struct ofp_group_stats) == 40);
The fields consist of those provided in the group_mod that created the group, plus the ref_count
counting the number of flows referencing directly the group, the packet_count, and the byte_count
counting all packets processed by the group.
The duration_sec and duration_nsec fields indicate the elapsed time the group has been installed in
the switch. The total duration in nanoseconds can be computed as duration sec × 109 + duration nsec.
Implementations are required to provide second precision; higher precision is encouraged where available.
The bucket_stats field consists of an array of ofp_bucket_counter structs:
/* Used in group stats replies. */
struct ofp_bucket_counter {
uint64_t packet_count;
/* Number of packets processed by bucket. */
uint64_t byte_count;
/* Number of bytes processed by bucket. */
};
OFP_ASSERT(sizeof(struct ofp_bucket_counter) == 16);
104
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.3.5.12 Group Description
The OFPMP_GROUP_DESC multipart request message provides a way to list the set of groups on a switch,
along with their corresponding bucket actions. The request body is empty, while the reply body is an
array of the following structure:
/* Body of reply to OFPMP_GROUP_DESC request. */
struct ofp_group_desc {
uint16_t length;
/* Length of this entry. */
uint8_t type;
/* One of OFPGT_*. */
uint8_t pad;
/* Pad to 64 bits. */
uint32_t group_id;
/* Group identifier. */
struct ofp_bucket buckets[0];
/* List of buckets - 0 or more. */
};
OFP_ASSERT(sizeof(struct ofp_group_desc) == 8);
Fields for group description are the same as those used with the ofp_group_mod struct (see 7.3.4.3).
7.3.5.13 Group Features
The OFPMP_GROUP_FEATURES multipart request message provides a way to list the capabilities of groups
on a switch. The request body is empty, while the reply body is the following structure:
/* Body of reply to OFPMP_GROUP_FEATURES request. Group features. */
struct ofp_group_features {
uint32_t types;
/* Bitmap of OFPGT_* values supported. */
uint32_t capabilities;
/* Bitmap of OFPGFC_* capability supported. */
uint32_t max_groups[4];
/* Maximum number of groups for each type. */
uint32_t actions[4];
/* Bitmaps of OFPAT_* that are supported. */
};
OFP_ASSERT(sizeof(struct ofp_group_features) == 40);
The max_groups field is the maximum number of groups for each type of groups. The actions is
the supported actions for each type of groups. The capabilities uses a combination of the following
flags:
/* Group configuration flags */
enum ofp_group_capabilities {
OFPGFC_SELECT_WEIGHT
= 1 <<
OFPGFC_SELECT_LIVENESS = 1 <<
OFPGFC_CHAINING
= 1 <<
OFPGFC_CHAINING_CHECKS = 1 <<
};
0,
1,
2,
3,
/*
/*
/*
/*
Support weight for select groups */
Support liveness for select groups */
Support chaining groups */
Check chaining for loops and delete */
105
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.3.5.14 Meter Statistics
The OFPMT_METER stats request message provides statistics for one or more meters. The request body
consists of a meter_id field, which can be set to OFPM_ALL to refer to all meters on the switch.
/* Body of OFPMP_METER and OFPMP_METER_CONFIG requests. */
struct ofp_meter_multipart_request {
uint32_t meter_id;
/* Meter instance, or OFPM_ALL. */
uint8_t pad[4];
/* Align to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_meter_multipart_request) == 8);
The body of the reply consists of an array of the following structure:
/* Body of reply to OFPMP_METER request. Meter statistics. */
struct ofp_meter_stats {
uint32_t
meter_id;
/* Meter instance. */
uint16_t
len;
/* Length in bytes of this stats. */
uint8_t
pad[6];
uint32_t
flow_count;
/* Number of flows bound to meter. */
uint64_t
packet_in_count; /* Number of packets in input. */
uint64_t
byte_in_count;
/* Number of bytes in input. */
uint32_t
duration_sec; /* Time meter has been alive in seconds. */
uint32_t
duration_nsec; /* Time meter has been alive in nanoseconds beyond
duration_sec. */
struct ofp_meter_band_stats band_stats[0]; /* The band_stats length is
inferred from the length field. */
};
OFP_ASSERT(sizeof(struct ofp_meter_stats) == 40);
The packet_in_count, and the byte_in_count count all packets processed by the meter.
The duration_sec and duration_nsec fields indicate the elapsed time the meter has been installed in
the switch. The total duration in nanoseconds can be computed as duration sec × 109 + duration nsec.
Implementations are required to provide second precision; higher precision is encouraged where available.
The band_stats field consists of an array of ofp_meter_band_stats structs:
/* Statistics for each meter band */
struct ofp_meter_band_stats {
uint64_t
packet_band_count;
/* Number of packets in band. */
uint64_t
byte_band_count;
/* Number of bytes in band. */
};
OFP_ASSERT(sizeof(struct ofp_meter_band_stats) == 16);
The packet_band_count, and the byte_band_count count all packets processed by the band.
The order of the band statistics must be the same as in the OFPMT_METER_CONFIG stats reply.
106
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.3.5.15 Meter Configuration Statistics
The OFPMT_METER_CONFIG stats request message provides configuration for one or more meter. The
request body consists of a meter_id field, which can be set to OFPM_ALL to refer to all meters on the
switch.
/* Body of OFPMP_METER and OFPMP_METER_CONFIG requests. */
struct ofp_meter_multipart_request {
uint32_t meter_id;
/* Meter instance, or OFPM_ALL. */
uint8_t pad[4];
/* Align to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_meter_multipart_request) == 8);
The body of the reply consists of an array of the following structure:
/* Body of reply to OFPMP_METER_CONFIG request. Meter configuration. */
struct ofp_meter_config {
uint16_t
length;
/* Length of this entry. */
uint16_t
flags;
/* All OFPMC_* that apply. */
uint32_t
meter_id;
/* Meter instance. */
struct ofp_meter_band_header bands[0]; /* The bands length is
inferred from the length field. */
};
OFP_ASSERT(sizeof(struct ofp_meter_config) == 8);
The fields are the same fields used for configuring the meter (see 7.3.4.5).
7.3.5.16 Meter Features Statistics
The OFPMT_METER_FEATURES stats request message provides the set of features of the metering subsystem. The request body is empty, and the body of the reply consists of the following structure:
/* Body of reply to OFPMP_METER_FEATURES request. Meter features. */
struct ofp_meter_features {
uint32_t
max_meter;
/* Maximum number of meters. */
uint32_t
band_types;
/* Bitmaps of OFPMBT_* values supported. */
uint32_t
capabilities; /* Bitmaps of "ofp_meter_flags". */
uint8_t
max_bands;
/* Maximum bands per meters */
uint8_t
max_color;
/* Maximum color value */
uint8_t
pad[2];
};
OFP_ASSERT(sizeof(struct ofp_meter_features) == 16);
7.3.5.17 Flow monitoring
The OFPMP_FLOW_MONITOR multipart type allows a controller to manage flow monitors, that keep track
of changes to the flow tables. In a multi-controller deployment, this enables a controller to be aware of
changes made to the flow tables by other controllers. A controller can create a number of flow monitors,
each flow monitor matching a subset of flow entries in some flow tables. Flow monitors will generate
events for any change to the flow tables matching one of the monitor.
107
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.3.5.17.1 Flow monitoring request
Flow monitor configuration is done with a OFPMP_FLOW_MONITOR multipart request.
/* Body for ofp_multipart_request of type OFPMP_FLOW_MONITOR.
*
* The OFPMP_FLOW_MONITOR request’s body consists of an array of zero or more
* instances of this structure. The request arranges to monitor the flows
* that match the specified criteria, which are interpreted in the same way as
* for OFPMP_FLOW.
*
* ’id’ identifies a particular monitor for the purpose of allowing it to be
* canceled later with OFPFMC_DELETE. ’id’ must be unique among
* existing monitors that have not already been canceled.
*/
struct ofp_flow_monitor_request {
uint32_t monitor_id;
/* Controller-assigned ID for this monitor. */
uint32_t out_port;
/* Required output port, if not OFPP_ANY. */
uint32_t out_group;
/* Required output port, if not OFPG_ANY. */
uint16_t flags;
/* OFFMF_*. */
uint8_t table_id;
/* One table’s ID or OFPTT_ALL (all tables). */
uint8_t command;
/* One of OFPFMC_*. */
struct ofp_match match;
/* Fields to match. Variable size. */
};
OFP_ASSERT(sizeof(struct ofp_flow_monitor_request) == 24);
The monitor_id field uniquely identifies a monitor for a specific controller connection within a switch.
The same monitor_id can be reused for different monitors by two different controller connections on
the same switch
The command field must be one of the following:
/* Flow monitor commands */
enum ofp_flow_monitor_command {
OFPFMC_ADD
= 0,
/* New flow monitor. */
OFPFMC_MODIFY = 1,
/* Modify existing flow monitor. */
OFPFMC_DELETE = 2,
/* Delete/cancel existing flow monitor. */
};
The command OFPFMC_ADD creates a new flow monitor and begins to monitor flow entries based on
the request parameters. The command OFPFMC_ADD must return an error if the monitor_id specified
is already in use. The command OFPFMC_DELETE destroys the flow monitor specified by monitor_id
and stops the associated flow monitoring and flow monitor events. The command OFPFMC_MODIFY is
equivalent to deleting and creating a flow monitor.
The table_id field specifies the flow table to monitor. If this field is set to OFPTT_ALL, all tables are
monitored.
The match field contains a description of the flow entries that should be monitored and may contain
wildcarded and masked fields. This field’s matching behavior is described in Section 6.4.
The out_port and out_group fields optionally reduce the scope of the flow monitor by output port.
If either out_port or out_group contains a value other than OFPP_ANY or OFPG_ANY respectively, it
108
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
introduces an additional constraint when matching flow entries to monitors. This constraint is that the
flow entry must contain an output action directed at that port or that group before or after the change
triggering the flow monitor event.
The flags field only applies to flow monitor creation and may include the following flags:
/* ’flags’ bits in struct of_flow_monitor_request. */
enum ofp_flow_monitor_flags {
/* When to send updates. */
OFPFMF_INITIAL = 1 << 0,
/* Initially matching flows. */
OFPFMF_ADD = 1 << 1,
/* New matching flows as they are added. */
OFPFMF_REMOVED = 1 << 2,
/* Old matching flows as they are removed. */
OFPFMF_MODIFY = 1 << 3,
/* Matching flows as they are changed. */
/* What to include in updates. */
OFPFMF_INSTRUCTIONS = 1 << 4,/* If set, instructions are included. */
OFPFMF_NO_ABBREV = 1 << 5,
/* If set, include own changes in full. */
OFPFMF_ONLY_OWN = 1 << 6,
/* If set, don’t include other controllers. */
};
When the OFPFMF_INITIAL flag is set, the switch must include, in the reply to the flow monitor request,
all flow entries matching the new monitor at the time of the request.
When the OFPFMF_ADD flag is set, the flow monitor must match all additions of flow entries, for example
flow mod with OFPFC_ADD command. When the OFPFMF_REMOVED flag is set, the flow monitor must
match all removal of flow entries, for example flow mod with OFPFC_DELETE or OFPFC_DELETE_STICT
commands, flow expiry due to timeout, or group deletion. When the OFPFMF_MODIFY flag is set, the flow
monitor must match all modifications of flow entries, for example flow mod requests with OFPFC_MODIFY
or OFPFC_MODIFY_STICT commands.
Flow updates of type OFPFMF_REMOVED and flow removed messages (see 7.4.2) are independant notification mechanisms. Flow updates do not take into account the value of the OFPFF_SEND_FLOW_REM flag
on the flow entry. A single flow entry may be reported by both notification mechanism.
When the OFPFMF_INSTRUCTIONS flag is set, the switch must include the flow entry instructions in the
flow monitor events. If this flag is unset, the switch must ommit the flow entry instructions in the flow
monitor events.
When the OFPFMF_NO_ABBREV flag is set, the switch must not use abbreviated flow updates in events. If
this flag is unset, the switch must use abbreviated flow updates in events related to flow table changes
done by the controller that created the flow monitor.
When the OFPFMF_ONLY_OWN flag is set, the switch must generate updates only for flow table changes
done by the controller that created the flow monitor. If this flag is unset, the switch must generate
updates for flow table changes done by all controllers.
7.3.5.17.2 Flow monitoring reply
When the switch received a OFPMP_FLOW_MONITOR multipart request, it replies to it using a
OFPMP_FLOW_MONITOR multipart reply, the transaction id (xid) of this reply must be the same as the
request. All flow entries that match one flow monitor of the request with the flag OFPFMF_INITIAL set
must be included in the reply as a flow update (with event type OFPFME_INITIAL).
109
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
At any time, whenever a change to a flow table matches some outstanding flow monitor, the switch
must send a notification to the controller using a OFPMP_FLOW_MONITOR multipart reply, the transaction
id (xid) of this reply must be 0. All flow entries that match one outstanding flow monitor must be
included in the reply. For example, if a flow_mod request modifies multiple flow entries that match
some flow monitors, the notification must include one flow update for each flow entry matching a flow
monitor.
If a modified flow entry matches multiple flow monitor, it must be included only once in the notification.
The flow update must include the aggregate of all information specified by the matched flow monitors.
For example, if any of the matching flow monitors specifies instructions (OFPFMF_INSTRUCTIONS), the
flow update must include instructions, and if any of the matching flow monitors specifies full changes
for the controller’s own changes (OFPFMF_NO_ABBREV), the controller’s own changes will be included in
full.
A flow_mod message that does not change the flow table will not trigger any notification, even an
abbreviated one. For example, a ”modify” or ”delete” flow_mod message that does not match any flow
entries will not trigger a notification. Whether an ”add” or ”modify” flow_mod message, that specifies
all the same parameters that a flow entry already has, triggers a notification is unspecified and subject
to change in future versions of this specification.
A OFPMP_FLOW_MONITOR multipart reply can not cross a barrier handshake (see 7.3.7). The switch must
always send the OFPMP_FLOW_MONITOR multipart reply for a given flow table change before the reply to
a OFPT_BARRIER_REQUEST request that follows the request responsible for the flow table change.
The body of any OFPMP_FLOW_MONITOR multipart reply consists of an array of flow updates. All flow
updates contains the update type and length :
/* OFPMP_FLOW_MONITOR reply header.
*
* The body of an OFPMP_FLOW_MONITOR reply is an array of variable-length
* structures, each of which begins with this header. The ’length’ member may
* be used to traverse the array, and the ’event’ member may be used to
* determine the particular structure.
*
* Every instance is a multiple of 8 bytes long. */
struct ofp_flow_update_header {
uint16_t length;
/* Length of this entry. */
uint16_t event;
/* One of OFPFME_*. */
/* ...other data depending on ’event’... */
};
OFP_ASSERT(sizeof(struct ofp_flow_update_header) == 4);
The event field is the flow update type. The list of flow update types that are currently defined are:
/* ’event’ values in struct ofp_flow_update_header. */
enum ofp_flow_update_event {
/* struct ofp_flow_update_full. */
OFPFME_INITIAL = 0,
/* Flow present when flow monitor created. */
OFPFME_ADDED = 1,
/* Flow was added. */
OFPFME_REMOVED = 2,
/* Flow was removed. */
OFPFME_MODIFIED = 3,
/* Flow instructions were changed. */
110
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* struct ofp_flow_update_abbrev. */
OFPFME_ABBREV = 4,
/* Abbreviated reply. */
/* struct ofp_flow_update_header. */
OFPFME_PAUSED = 5,
/* Monitoring paused (out of buffer space). */
OFPFME_RESUMED = 6,
/* Monitoring resumed. */
};
The OFPFME_ADDED, OFPFME_REMOVED and OFPFME_MODIFIED types denotes flow entries matching a flow
monitor that have been respectively added, removed or modified in the flow tables and matching an
active flow monitor. The OFPFME_INITIAL denotes flow updates part of the initial reply for flow monitors
with the flag OFPFMF_INITIAL set. They use the following structure and fields:
/* OFPMP_FLOW_MONITOR reply for OFPFME_INITIAL, OFPFME_ADDED, OFPFME_REMOVED,
* and OFPFME_MODIFIED. */
struct ofp_flow_update_full {
uint16_t length;
/* Length is 32 + match + instructions. */
uint16_t event;
/* One of OFPFME_*. */
uint8_t table_id;
/* ID of flow’s table. */
uint8_t reason;
/* OFPRR_* for OFPFME_REMOVED, else zero. */
uint16_t idle_timeout;
/* Number of seconds idle before expiration. */
uint16_t hard_timeout;
/* Number of seconds before expiration. */
uint16_t priority;
/* Priority of the entry. */
uint8_t zeros[4];
/* Reserved, currently zeroed. */
uint64_t cookie;
/* Opaque controller-issued identifier. */
struct ofp_match match;
/* Fields to match. Variable size. */
/*
Instruction set.
*
If OFPFMF_INSTRUCTIONS was not specified, or ’event’ is
*
OFPFME_REMOVED, no instructions are included.
*/
//struct ofp_instruction instructions[0];
};
OFP_ASSERT(sizeof(struct ofp_flow_update_full) == 32);
The fields consist of those provided in the flow_mod that created the flow entry (see 7.3.4.2). For
updates of type OFPFME_REMOVED, the reason field is the removal reason (see 7.4.2), for other types this
field must be zero.
The OFPFME_ABBREV type denotes an abreviated flow update. When the controller does not specify
OFPFMF_OWN in a monitor request, any flow tables changes due to the controller’s own requests (on
the same OpenFlow channel) will be abbreviated, when possible. It uses the following structure and
fields:
/* OFPMP_FLOW_MONITOR reply for OFPFME_ABBREV.
*
* When the controller does not specify OFPFMF_OWN in a monitor request, any
* flow tables changes due to the controller’s own requests (on the same
* OpenFlow channel) will be abbreviated, when possible, to this form, which
* simply specifies the ’xid’ of the OpenFlow request (e.g. an OFPT_FLOW_MOD)
* that caused the change.
* Some changes cannot be abbreviated and will be sent in full.
*/
struct ofp_flow_update_abbrev {
111
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
uint16_t length;
uint16_t event;
uint32_t xid;
Version 1.4.0
/* Length is 8. */
/* OFPFME_ABBREV. */
/* Controller-specified xid from flow_mod. */
};
OFP_ASSERT(sizeof(struct ofp_flow_update_abbrev) == 8);
The xid field is the transaction id of the controller request this update relates to.
The OFPFME_PAUSED and OFPFME_RESUMED types denotes monitoring pause and resume due to buffer
management constraints. They use the following structure and fields:
/* OFPMP_FLOW_MONITOR reply for OFPFME_PAUSED and OFPFME_RESUMED.
*/
struct ofp_flow_update_paused {
uint16_t length;
/* Length is 8. */
uint16_t event;
/* One of OFPFME_*. */
uint8_t zeros[4];
/* Reserved, currently zeroed. */
};
OFP_ASSERT(sizeof(struct ofp_flow_update_paused) == 8);
7.3.5.17.3 Flow monitoring pause
OpenFlow messages for flow monitor notifications can overflow the buffer space available to the switch,
either temporarily (e.g. due to network conditions slowing OpenFlow traffic) or more permanently
(e.g. the sustained rate of flow table change exceeds the network bandwidth between switch and
controller). The flow monitoring pause mechanism disable flow updates when the number of queued
flow updates reach a limit, and enable the switch and controller to recover gracefully. The pause
mechanism quarantees that the maximum buffer space requirement for flow updates to be bounded by
the limit plus the maximum number of supported flow entries.
When the switch’s notification buffer space reaches a switch defined limiting threshold, the switch must
reacts as follows:
1. The switch must send a OFPFME_PAUSED flow update to the controller, following all the already
queued flow updates. After it receives this message, the controller knows that its view of the flow
table, as represented by flow monitor notifications, is incomplete.
2. As long as the notification buffer is not empty:
ˆ OFPFMF_ADD and OFPFMF_MODIFY flow updates must not be sent.
ˆ OFPFMF_REMOVED flow updates must still be sent, but only for flow entries that existed before
the switch sent the OFPFME_PAUSED flow update.
ˆ OFPFMF_ABBREV flow updates must follow the same rules, in particular flow updates related
to adding or modifying flow entries must not be sent.
3. When the notification buffer empties, the switch must send OFPFME_ADDED flow updates for flow
entries added since the buffer reached its limit and still present in a flow table, and it must send
OFPFME_MODIFIED flow updates for flow entries that existed before the limit was reached, changed
after the limit was reached and still present in a flow table.
112
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
4. The switch must send a OFPFME_RESUMED flow update to the controller. After it receives this
message, the controller knows that its view of the flow table, as represented by flow monitor
notifications, is again complete.
7.3.5.18 Experimenter Multipart
Experimenter-specific multipart messages are requested with the OFPMP_EXPERIMENTER multipart type.
The first bytes of the request and reply bodies are the following structure:
/* Body for ofp_multipart_request/reply of type OFPMP_EXPERIMENTER. */
struct ofp_experimenter_multipart_header {
uint32_t experimenter;
/* Experimenter ID. */
uint32_t exp_type;
/* Experimenter defined. */
/* Experimenter-defined arbitrary additional data. */
};
OFP_ASSERT(sizeof(struct ofp_experimenter_multipart_header) == 8);
The experimenter field is the Experimenter ID and the exp_type field is the experimenter type, they
takes the same form as in the typical experimenter structure (see 7.2.5).
The rest of the request and reply bodies are experimenter-defined and don’t need to be padded.
7.3.6 Packet-Out Message
When the controller wishes to send a packet out through the datapath, it uses the OFPT_PACKET_OUT
message:
/* Send packet (controller -> datapath). */
struct ofp_packet_out {
struct ofp_header header;
uint32_t buffer_id;
/* ID assigned by datapath (OFP_NO_BUFFER
if none). */
uint32_t in_port;
/* Packet’s input port or OFPP_CONTROLLER. */
uint16_t actions_len;
/* Size of action array in bytes. */
uint8_t pad[6];
struct ofp_action_header actions[0]; /* Action list - 0 or more. */
/* The variable size action list is optionally followed by packet data.
* This data is only present and meaningful if buffer_id == -1. */
/* uint8_t data[0]; */
/* Packet data. The length is inferred
from the length field in the header. */
};
OFP_ASSERT(sizeof(struct ofp_packet_out) == 24);
The buffer_id is the same given in the ofp_packet_in message. If the buffer_id is OFP_NO_BUFFER,
then the packet data is included in the data array, and the packet encapsulated in the message is
processed by the actions of the message. OFP_NO_BUFFER is 0xffffffff. If buffer_id is valid, the corresponding packet is removed from the buffer and processed by the actions of the message.
113
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The in_port field is the ingress port that must be associated with the packet for OpenFlow processing.
It must be set to either a valid standard switch port (see 4.2) or OFPP_CONTROLLER. For example, this
field is used when processing the packet using OFPP_TABLE, OFPP_IN_PORT, OFPP_ALL and groups.
The action field is an action list defining how the packet should be processed by the switch. It may include packet modification, group processing and an output port. The action list of an OFPT_PACKET_OUT
message can also specify the OFPP_TABLE reserved port as an output action to process the packet through
the OpenFlow pipeline, starting at the first flow table (see 4.5). If OFPP_TABLE is specified, the in_port
field is used as the ingress port in the flow table lookup.
In some cases, packets sent to OFPP_TABLE may be forwarded back to the controller as the result of a flow
entry action or table miss. Detecting and taking action for such controller-to-switch loops is outside the
scope of this specification. In general, OpenFlow messages are not guaranteed to be processed in order,
therefore if a OFPT_PACKET_OUT message using OFPP_TABLE depends on a flow that was recently sent to
the switch (with a OFPT_FLOW_MOD message), a OFPT_BARRIER_REQUEST message may be required prior
to the OFPT_PACKET_OUT message to make sure the flow entry was committed to the flow table prior to
execution of OFPP_TABLE.
7.3.7 Barrier Message
When the controller wants to ensure message dependencies have been met or wants to receive notifications for completed operations, it may use an OFPT_BARRIER_REQUEST message. This message has no
body. Upon receipt, the switch must finish processing all previously-received messages, including sending corresponding reply or error messages, before executing any messages beyond the Barrier Request.
When such processing is complete, the switch must send an OFPT_BARRIER_REPLY message with the xid
of the original request.
7.3.8 Role Request Message
When the controller wants to change its role, it uses the OFPT_ROLE_REQUEST message with the following
structure:
/* Role request and reply message. */
struct ofp_role_request {
struct ofp_header header;
/* Type OFPT_ROLE_REQUEST/OFPT_ROLE_REPLY. */
uint32_t role;
/* One of OFPCR_ROLE_*. */
uint8_t pad[4];
/* Align to 64 bits. */
uint64_t generation_id;
/* Master Election Generation Id */
};
OFP_ASSERT(sizeof(struct ofp_role_request) == 24);
The field role is the new role that the controller wants to assume, and can have the following values:
/* Controller roles. */
enum ofp_controller_role {
OFPCR_ROLE_NOCHANGE = 0,
OFPCR_ROLE_EQUAL
= 1,
OFPCR_ROLE_MASTER
= 2,
/* Don’t change current role. */
/* Default role, full access. */
/* Full access, at most one master. */
114
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPCR_ROLE_SLAVE
= 3,
Version 1.4.0
/* Read-only access. */
};
If the role value in the message is OFPCR_ROLE_MASTER or OFPCR_ROLE_SLAVE, the switch must validate generation_id to check for stale messages (see 6.3.4). If the validation fails, the switch must
discard the role request and return an error message with type OFPET_ROLE_REQUEST_FAILED and code
OFPRRFC_STALE.
If the role value is OFPCR_ROLE_MASTER, all other controllers whose role was OFPCR_ROLE_MASTER are
changed to OFPCR_ROLE_SLAVE (see 6.3.4). If the role value is OFPCR_ROLE_NOCHANGE, the current role
of the controller is not changed ; this enables a controller to query its current role without changing
it.
Upon receipt of a OFPT_ROLE_REQUEST message, if there is no error, the switch must return a OFPT_ROLE_REPLY message. The structure of this message is exactly the same as the
OFPT_ROLE_REQUEST message, and the field role is the current role of the controller. The field
generation_id is set to the current generation_id (the generation_id associated with the last successful role request with role OFPCR_ROLE_MASTER or OFPCR_ROLE_SLAVE), if the current generation_id
was never set by a controller, the field generation_id in the reply must be set to the maximum field
value (the unsigned equivalent of -1).
If the switch must change the role of another controller from OFPCR_ROLE_MASTER to OFPCR_ROLE_SLAVE,
it must send that controller a OFPT_ROLE_STATUS message (see 7.4.4).
7.3.9 Bundle messages
7.3.9.1 Bundle control messages
The controller can create, destroy and commit bundles with the OFPT_BUNDLE_CONTROL request. The
OFPT_BUNDLE_CONTROL message uses the following structure:
/* Message structure for OFPT_BUNDLE_CONTROL. */
struct ofp_bundle_ctrl_msg {
struct ofp_header
header;
uint32_t
bundle_id;
/* Identify the bundle. */
uint16_t
type;
/* OFPBCT_*. */
uint16_t
flags;
/* Bitmap of OFPBF_* flags. */
/* Bundle Property list. */
struct ofp_bundle_prop_header properties[0]; /* Zero or more properties. */
};
OFP_ASSERT(sizeof(struct ofp_bundle_ctrl_msg) == 16);
The bundle_id field is the bundle identifier, a 32 bit number chosen by the controller. The bundle
identifier should be unique over the connection during the bundle lifetime.
The type field is the control message type. The control types that are currently defined are:
115
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Bundle control message types */
enum ofp_bundle_ctrl_type {
OFPBCT_OPEN_REQUEST
= 0,
OFPBCT_OPEN_REPLY
= 1,
OFPBCT_CLOSE_REQUEST
= 2,
OFPBCT_CLOSE_REPLY
= 3,
OFPBCT_COMMIT_REQUEST = 4,
OFPBCT_COMMIT_REPLY
= 5,
OFPBCT_DISCARD_REQUEST = 6,
OFPBCT_DISCARD_REPLY
= 7,
};
The flags field is a bitmask of bundle flags (see 7.3.9.3).
The properties field is a list of bundle properties (see 7.3.9.4).
7.3.9.2 Bundle Add message
The controller can add requests to a bundle using the OFPT_BUNDLE_ADD_MESSAGE message.
OFPT_BUNDLE_ADD_MESSAGE message uses the following structure:
The
/* Message structure for OFPT_BUNDLE_ADD_MESSAGE.
* Adding a message in a bundle is done with. */
struct ofp_bundle_add_msg {
struct ofp_header
header;
uint32_t
bundle_id;
/* Identify the bundle. */
uint16_t
pad;
/* Align to 64 bits. */
uint16_t
flags;
/* Bitmap of OFPBF_* flags. */
struct ofp_header
message;
/* Message added to the bundle. */
/* If there is one property or more, ’message’ is followed by:
*
- Exactly (message.length + 7)/8*8 - (message.length) (between 0 and 7)
*
bytes of all-zero bytes */
/* Bundle Property list. */
//struct ofp_bundle_prop_header properties[0]; /* Zero or more properties. */
};
OFP_ASSERT(sizeof(struct ofp_bundle_add_msg) == 24);
The bundle_id field is the bundle identifier, a 32 bit number chosen by the controller. The bundle
identifier should be a bundle that has been previously opened and not yet closed.
The flags field is a bitmask of bundle flags (see 7.3.9.3).
The message is a OpenFlow message to be added to the bundle, it can be any OpenFlow message that
the switch can support in a bundle. The field xid in the message must be identical to the field xid of
the OFPT_BUNDLE_ADD_MESSAGE message.
The properties field is a list of bundle properties (see 7.3.9.4).
116
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.3.9.3 Bundle flags
Bundle flags enable to modify the behaviour of a bundle. The bundle flags must be specified on every
bundle message part of the bundle, and they need to be consistent.
The bundle flags that are currently defined are:
/* Bundle configuration flags. */
enum ofp_bundle_flags {
OFPBF_ATOMIC = 1 << 0, /* Execute atomically. */
OFPBF_ORDERED = 1 << 1, /* Execute in specified order. */
};
ˆ OFPBF_ATOMIC is set to request fully atomic application of the bundle.
ˆ OFPBF_ORDERED is set to request the message of the bundle are applied strictly in order.
7.3.9.4 Bundle properties
The list of bundle property types that are currently defined are:
/* Bundle property types. */
enum ofp_bundle_prop_type {
OFPBPT_EXPERIMENTER
};
= 0xFFFF, /* Experimenter property. */
A property definition contains the property type, length, and any associated data:
/* Common header for all Bundle Properties */
struct ofp_bundle_prop_header {
uint16_t
type;
/* One of OFPBPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_bundle_prop_header) == 4);
The OFPBPT_EXPERIMENTER property uses the following structure and fields:
/* Experimenter bundle property */
struct ofp_bundle_prop_experimenter {
uint16_t
type;
/* OFPBPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_bundle_prop_experimenter) == 12);
117
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The experimenter field is the Experimenter ID, which takes the same form as in struct
ofp_experimenter.
7.3.9.5 Creating and opening a bundle
To create a bundle, the controller sends a OFPT_BUNDLE_CONTROL message with type
OFPBCT_OPEN_REQUEST. The switch must create a new bundle with id bundle_id attached to the current connection, with the options specified in the flags and properties. If the operation is successful,
OFPT_BUNDLE_CONTROL message with type OFPBCT_OPEN_REPLY must be returned by the switch. If an
error arises, an error message is returned.
If the bundle_id already refers to an existing bundle attached to the same connection, the switch
must refuse to open the new bundle and send an ofp_error_msg with OFPET_BUNDLE_FAILED type and
OFPBFC_BAD_ID code. The existing bundle identified by bundle_id must be discarded.
If the switch can not open this bundle because its having too many opened bundles on the switch
or attached to the current connection, the switch must refuse to open the new bundle and send an
ofp_error_msg with OFPET_BUNDLE_FAILED type and OFPBFC_OUT_OF_BUNDLES code. If the switch
can not open the bundle because the connection is using an unreliable transport, the switch must
refuse to open the new bundle and send an ofp_error_msg with OFPET_BUNDLE_FAILED type and
OFPBFC_OUT_OF_BUNDLES code.
If the flags field request some feature that can not be implemented by the switch, the switch must
refuse to open the new bundle and send an ofp_error_msg with OFPET_BUNDLE_FAILED type and
OFPBFC_BAD_FLAGS code.
7.3.9.6 Adding messages to a bundle
The switch adds message to a bundle using the OFPT_BUNDLE_ADD_MESSAGE. After the bundle is opened,
the controller can sends a sequence of OFPT_BUNDLE_ADD_MESSAGE messages to populate the bundle.
Each OFPT_BUNDLE_ADD_MESSAGE includes an OpenFlow message, this OpenFlow message is validated,
and if successful it is stored in the bundle specified by bundle_id on the current connection. If a
message validation error or a bundle error condition arise, an error message is returned.
Message validation includes at minimum syntax checking and that all features are supported, and it
may optionally include checking resource availability (see 6.8.3). If a message fails validation, an error
message must be returned. The error message must use the xid of the offending message, the error data
field corresponding to that message and the error code corresponding to the validation failure.
If the bundle_id refers to a bundle that does not exist on the current connection, the corresponding
bundle is created using arguments from the OFPT_BUNDLE_ADD_MESSAGE message. If an error arise from
creating the bundle, the relevant error message is returned (see 7.3.9.5). No OFPT_BUNDLE_CONTROL
message with type OFPBCT_OPEN_REPLY is returned by the switch in this case.
If the bundle_id refers to a bundle that is already closed, the switch must refuse to add the message
to the bundle, discard the bundle and send an ofp_error_msg with OFPET_BUNDLE_FAILED type and
OFPBFC_BUNDLE_CLOSED code.
118
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
If the flags field is different from the flags that were specified when the bundle was opened, the switch
must refuse to add the message to the bundle, discard the bundle and send an ofp_error_msg with
OFPET_BUNDLE_FAILED type and OFPBFC_BAD_FLAGS code.
If the message in the request is normally supported on the switch but is not supported in a bundle, the switch must refuse to add the message to the bundle and send an ofp_error_msg with
OFPET_BUNDLE_FAILED type and OFPBFC_MSG_UNSUP code. This is the case for hello, echo and bundle messages, messages that are not requests, or if the implementation does not support including a
specific modification message in a bundle.
If the message in the request is incompatible with another message already stored in the bundle, the switch must refuse to add the message to the bundle and send an ofp_error_msg with
OFPET_BUNDLE_FAILED type and OFPBFC_MSG_CONFLICT code.
If the bundle is full and can not fit the message in the request, the switch must refuse to add the message
to the bundle and send an ofp_error_msg with OFPET_BUNDLE_FAILED type and OFPBFC_MSG_TOO_MANY
code.
If the message in the request does not have a valid length field, the switch must refuse to add the message
to the bundle and send an ofp_error_msg with OFPET_BUNDLE_FAILED type and OFPBFC_MSG_BAD_LEN
code.
Message added in a bundle should have a unique xid to help matching errors to messages, and the xid of
the bundle add message must be the same. A switch may optionally verify that the two xid of a message
are consistent or that two messages of the bundle don’t have the same xid, and if this is the case refuse
to add the new message to the bundle and send an ofp_error_msg with OFPET_BUNDLE_FAILED type
and OFPBFC_MSG_BAD_XID code.
7.3.9.7 Closing a bundle
To finish recording a bundle, the controller may sends a OFPT_BUNDLE_CONTROL message with type
OFPBCT_CLOSE_REQUEST. The switch must close the bundle specified by bundle_id on the current connection. After closing the bundle, it can no longer be modified and no messages can be added to it,
it can only be committed or discarded. Closing a bundle is optional. If the operation is successful,
OFPT_BUNDLE_CONTROL message with type OFPBCT_CLOSE_REPLY must be returned by the switch. If an
error arises, an error message is returned.
If the bundle_id refers to a bundle that does not exist, the switch must reject the request and send an
ofp_error_msg with OFPET_BUNDLE_FAILED type and OFPBFC_BAD_ID code.
If the bundle_id refers to a bundle that is already closed, the switch must refuse to close to
the bundle, discard the bundle and send an ofp_error_msg with OFPET_BUNDLE_FAILED type and
OFPBFC_BUNDLE_CLOSED code.
If the flags field is different from the flags that were specified when the bundle was opened, the
switch must refuse to close to the bundle, discard the bundle and send an ofp_error_msg with
OFPET_BUNDLE_FAILED type and OFPBFC_BAD_FLAGS code.
The switch may optionally do additional validation of the messages part of the bundle as the result of
the close request, such as validating resource availability. For each message that fails this additional
119
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
validation, an error message must be generated that refer to the offending message. After sending those
individual error messages, the switch must discard the bundle and send an additional ofp_error_msg
with OFPET_BUNDLE_FAILED type and OFPBFC_MSG_FAILED code.
7.3.9.8 Committing Bundles
To finish and apply the bundle, the controller sends a OFPT_BUNDLE_CONTROL message with type
OFPBCT_COMMIT_REQUEST. The switch must commit the bundle specified by bundle_id on the current connection, it must apply all messages stored in the bundle as a single operation or return an error.
The commit operation and the way the message part of the bundle are applied depend on the bundle
flags (see 7.3.9.3). If the bundle was not closed prior to this request, it is automatically closed (see
7.3.9.7).
The commit is successful only if all messages parts of the bundle can be applied without error. If the
bundle does not contain any message, commit is always successful. If the commit is successful, the switch
must apply all messages of the bundle as a single operation, and a OFPT_BUNDLE_CONTROL message with
type OFPBCT_CLOSE_REPLY must be returned by the switch. The OFPT_BUNDLE_CONTROL message with
type OFPBCT_CLOSE_REPLY must be sent to the controller after the processing of all messages part of
the bundle are guaranteed to no longer fail or produce an error.
If one or more message part of the bundle can not be applied without error, for example due to resource
availability, the commit fails and all messages part of the bundle must be discarded without being
applied. When the commit fails, the switch must generate an error message corresponding to the
message that could not be applied. The error message must use the xid of the offending message,
the error data field corresponding to that message and the error code corresponding to the failure. If
multiple messages are generating errors, the switch may return only the first error found or generate
multiple error messages for the same bundle. After sending those individual error messages, the switch
must send an additional ofp_error_msg with OFPET_BUNDLE_FAILED type and OFPBFC_MSG_FAILED
code.
After a commit operation, the bundle is discarded, whether the commit was successful or not. After
receiving a successful reply or error message for this operation, the controller can reuse the bundle_id.
Modification requests may require replies to be returned to the controller or events to be generated.
Because any message of the bundle may fail, replies and events can only be generated once all modifications in the bundle have been applied. For replies, each of these replies contains the transaction ID
of the corresponding request.
If the bundle_id refers to a bundle that does not exist, the switch must reject the request and send an
ofp_error_msg with OFPET_BUNDLE_FAILED type and OFPBFC_BAD_ID code.
If the flags field is different from the flags that were specified when the bundle was opened, the
switch must refuse to commit the bundle, discard the bundle and send an ofp_error_msg with
OFPET_BUNDLE_FAILED type and OFPBFC_BAD_FLAGS code.
120
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.3.9.9 Discarding Bundles
To finish and discard the bundle, the controller sends a OFPT_BUNDLE_CONTROL message with type
OFPBCT_DISCARD_REQUEST. The switch must discard the bundle specified by bundle_id on the current connection, and all messages part of the bundle are discarded. If the operation is successful, a
OFPT_BUNDLE_CONTROL message with type OFPBCT_DISCARD_REPLY must be returned by the switch.
If an error arises, an error message is returned. After receiving either a successful reply or an error
message, the controller can reuse the bundle_id.
All implementations must be able to process a discard request on a existing bundle on the current connection without triggering errors. If the bundle_id refers to a bundle that does not exist, the switch must
reject the request and send an ofp_error_msg with OFPET_BUNDLE_FAILED type and OFPBFC_BAD_ID
code.
7.3.9.10 Other bundle error conditions
If a OFPT_BUNDLE_CONTROL message contains an invalid type, the switch must reject the request and
send an ofp_error_msg with OFPET_BUNDLE_FAILED type and OFPBFC_BAD_TYPE code.
If a OFPT_BUNDLE_CONTROL or OFPT_BUNDLE_ADD_MESSAGE message specifies flags different for those
already specified on an existing bundle, the switch must reject the request and send an ofp_error_msg
with OFPET_BUNDLE_FAILED type and OFPBFC_BAD_FLAGS code.
If the switch does not receive any OFPT_BUNDLE_CONTROL or OFPT_BUNDLE_ADD_MESSAGE message for
an opened bundle_id for a switch defined time greater than 1s, it may send an ofp_error_msg with
OFPET_BUNDLE_FAILED type and OFPBFC_TIMEOUT code. If the switch does not receive any new message
in a bundle apart from echo request and replies for a switch defined time greater than 1s, it may send
an ofp_error_msg with OFPET_BUNDLE_FAILED type and OFPBFC_TIMEOUT code.
If an OpenFlow message can not be processed because a bundle is locking a resource this message is
using, the switch must reject that message and send an ofp_error_msg with OFPET_BUNDLE_FAILED
type and OFPBFC_BUNDLE_IN_PROGRESS code. If a switch can not process other messages between
opening a bundle and either committing it or discarding it, the switch must reject that message and
send an ofp_error_msg with OFPET_BUNDLE_FAILED type and OFPBFC_BUNDLE_IN_PROGRESS code.
7.3.10 Set Asynchronous Configuration Message
The switch manages a per-controller asynchronous configuration, which defines the asynchronous
messages that it wants to receive (other than error messages) on a given OpenFlow channel. The
controller is able to set and query its asynchronous configuration with the OFPT_SET_ASYNC and
OFPT_GET_ASYNC_REQUEST messages, respectively. The switch responds to a OFPT_GET_ASYNC_REQUEST
message with an OFPT_GET_ASYNC_REPLY message; it does not reply to a request to set the configuration.
The OFPT_SET_ASYNC message sets whether a controller should receive a given asynchronous message
that is generated by the switch. Other OpenFlow features control whether a given message is generated; for example, the OFPFF_SEND_FLOW_REM flag in each flow entry controls whether the switch
121
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
generates a OFPT_FLOW_REMOVED message when a flow entry is removed. The asynchronous configuration acts as an additional per-controller filter; for example it defines if a specific controller receives those
OFPT_FLOW_REMOVED messages.
The configuration set with the OFPT_SET_ASYNC message is specific to a particular OpenFlow channel. It
does not affect any other OpenFlow channels, whether currently established or to be established in the
future. The configuration set with OFPT_SET_ASYNC does not filter or otherwise affect error messages.
A switch configuration, for example using the OpenFlow Configuration Protocol, may set the initial
configuration of asynchronous messages when an OpenFlow connection is established. In the absence
of such switch configuration, the initial configuration shall be:
ˆ In the “master” or “equal” role, enable all OFPT_PACKET_IN messages, except those with reason
OFPR_INVALID_TTL, enable all OFPT_PORT_STATUS and OFPT_FLOW_REMOVED messages, and disable
all OFPT_ROLE_STATUS and OFPT_REQUESTFORWARD messages.
ˆ In the “slave” role, enable all OFPT_PORT_STATUS messages and disable all OFPT_PACKET_IN,
OFPT_FLOW_REMOVED, OFPT_ROLE_STATUS and OFPT_REQUESTFORWARD messages.
There is no body for OFPT_GET_ASYNC_REQUEST beyond the OpenFlow header. The OFPT_SET_ASYNC
and OFPT_GET_ASYNC_REPLY messages have the following format:
/* Asynchronous message configuration. */
struct ofp_async_config {
struct ofp_header header;
/* OFPT_GET_ASYNC_REPLY or OFPT_SET_ASYNC. */
/* Async config Property list - 0 or more */
struct ofp_async_config_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_async_config) == 8);
The properties field is a list of asynchronous configuration properties, describing if various set of
asynchronous messages are enabled or not. In a OFPT_SET_ASYNC, only the properties that shall be
changed need to be included, properties that are omitted from the message are unchanged. In a
OFPT_GET_ASYNC_REPLY message, all properties must be included.
The asynchronous configuration types currently defined are:
/* Async Config property types.
* Low order bit cleared indicates a property for the slave role.
* Low order bit set indicates a property for the master/equal role.
*/
enum ofp_async_config_prop_type {
OFPACPT_PACKET_IN_SLAVE
= 0, /* Packet-in mask for slave. */
OFPACPT_PACKET_IN_MASTER
= 1, /* Packet-in mask for master. */
OFPACPT_PORT_STATUS_SLAVE
= 2, /* Port-status mask for slave. */
OFPACPT_PORT_STATUS_MASTER
= 3, /* Port-status mask for master. */
OFPACPT_FLOW_REMOVED_SLAVE
= 4, /* Flow removed mask for slave. */
OFPACPT_FLOW_REMOVED_MASTER = 5, /* Flow removed mask for master. */
OFPACPT_ROLE_STATUS_SLAVE
= 6, /* Role status mask for slave. */
OFPACPT_ROLE_STATUS_MASTER
= 7, /* Role status mask for master. */
OFPACPT_TABLE_STATUS_SLAVE
= 8, /* Table status mask for slave. */
OFPACPT_TABLE_STATUS_MASTER = 9, /* Table status mask for master. */
122
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPACPT_REQUESTFORWARD_SLAVE = 10, /*
OFPACPT_REQUESTFORWARD_MASTER = 11, /*
OFPTFPT_EXPERIMENTER_SLAVE
= 0xFFFE,
OFPTFPT_EXPERIMENTER_MASTER = 0xFFFF,
Version 1.4.0
RequestForward mask
RequestForward mask
/* Experimenter for
/* Experimenter for
for slave. */
for master. */
slave. */
master. */
};
Each property type control whether the controller receives asynchronous messages with a specific
enum ofp_type. The properties with the _MASTER suffix specifies messages of interest when the controller has a OFPCR_ROLE_EQUAL or OFPCR_ROLE_MASTER role (see ). The properties with the _SLAVE
suffix specifies messages of interest when the controller has a OFPCR_ROLE_SLAVE role.
A property definition contains the property type, length, and any associated data:
/* Common header for all async config Properties */
struct ofp_async_config_prop_header {
uint16_t
type;
/* One of OFPACPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_async_config_prop_header) == 4);
The
OFPACPT_PACKET_IN_SLAVE,
OFPACPT_PACKET_IN_MASTER,
OFPACPT_PORT_STATUS_SLAVE,
OFPACPT_PORT_STATUS_MASTER, OFPACPT_FLOW_REMOVED_SLAVE, OFPACPT_FLOW_REMOVED_MASTER,
OFPACPT_ROLE_STATUS_SLAVE and OFPACPT_ROLE_STATUS_MASTER, OFPACPT_TABLE_STATUS_SLAVE,
OFPACPT_TABLE_STATUS_MASTER,
OFPACPT_REQUESTFORWARD_SLAVE
and
OFPACPT_REQUESTFORWARD_MASTER properties use the following structure and fields:
/* Various reason based properties */
struct ofp_async_config_prop_reasons {
uint16_t
type;
/* One of OFPACPT_PACKET_IN_*,
OFPACPT_PORT_STATUS_*,
OFPACPT_FLOW_REMOVED_*,
OFPACPT_ROLE_STATUS_*,
OFPACPT_TABLE_STATUS_*,
OFPACPT_REQUESTFORWARD_*. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
mask;
/* Bitmasks of reason values. */
};
OFP_ASSERT(sizeof(struct ofp_async_config_prop_reasons) == 8);
The mask field is a bit-mask in which a 0-bit disables receiving a message sent with the reason code
corresponding to the bit index and a 1-bit enables receiving it. For example, if the property type is
OFPACPT_PORT_STATUS_SLAVE, the bit with value 22 = 4 in mask determines whether the controller will
receive OFPT_PORT_STATUS messages with reason OFPPR_MODIFY (value 2) when the controller has role
OFPCR_ROLE_SLAVE.
The OFPTFPT_EXPERIMENTER_SLAVE and OFPTFPT_EXPERIMENTER_MASTER properties uses the following
structure and fields:
123
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Experimenter async config property */
struct ofp_async_config_prop_experimenter {
uint16_t
type;
/* One of OFPTFPT_EXPERIMENTER_SLAVE,
OFPTFPT_EXPERIMENTER_MASTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_async_config_prop_experimenter) == 12);
The experimenter field is the Experimenter ID, which takes the same form as in the typical experimenter structure (see 7.2.5).
7.4 Asynchronous Messages
7.4.1 Packet-In Message
When packets are received by the datapath and sent to the controller, they use the OFPT_PACKET_IN
message:
/* Packet received on port (datapath -> controller). */
struct ofp_packet_in {
struct ofp_header header;
uint32_t buffer_id;
/* ID assigned by datapath. */
uint16_t total_len;
/* Full length of frame. */
uint8_t reason;
/* Reason packet is being sent (one of OFPR_*) */
uint8_t table_id;
/* ID of the table that was looked up */
uint64_t cookie;
/* Cookie of the flow entry that was looked up. */
struct ofp_match match; /* Packet metadata. Variable size. */
/* The variable size and padded match is always followed by:
*
- Exactly 2 all-zero padding bytes, then
*
- An Ethernet frame whose length is inferred from header.length.
* The padding bytes preceding the Ethernet frame ensure that the IP
* header (if any) following the Ethernet header is 32-bit aligned.
*/
//uint8_t pad[2];
/* Align to 64 bit + 16 bit */
//uint8_t data[0];
/* Ethernet frame */
};
OFP_ASSERT(sizeof(struct ofp_packet_in) == 32);
The buffer_id is an opaque value used by the datapath to identify a buffered packet. When a packet
is buffered, some number of bytes from the message will be included in the data portion of the message. If the packet is sent because of a “send to controller” action, then max_len bytes from the
ofp_action_output of the flow setup request are sent. If the packet is sent for other reasons, such
124
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
as an invalid TTL, then at least miss_send_len bytes from the OFPT_SET_CONFIG message are sent.
The default miss_send_len is 128 bytes. If the packet is not buffered - either because of no available
buffers, or because of explicitly requested via OFPCML_NO_BUFFER - the entire packet is included in the
data portion, and the buffer_id is OFP_NO_BUFFER.
Switches that implement buffering are expected to expose, through documentation, both the amount
of available buffering, and the length of time before buffers may be reused. A switch must gracefully
handle the case where a buffered packet_in message yields no response from the controller. A switch
should prevent a buffer from being reused until it has been handled by the controller, or some amount
of time (indicated in documentation) has passed.
The data field contains the packet itself, or a fraction of the packet if the packet is buffered. The packet
header reflect any changes applied to the packet in previous processing.
The reason field indicates which context triggered the packet-in message and can be any of these
values:
/* Why is this packet being sent to the controller? */
enum ofp_packet_in_reason {
OFPR_TABLE_MISS
= 0,
/* No matching flow (table-miss flow entry). */
OFPR_APPLY_ACTION = 1,
/* Output to controller in apply-actions. */
OFPR_INVALID_TTL = 2,
/* Packet has invalid TTL */
OFPR_ACTION_SET
= 3,
/* Output to controller in action set. */
OFPR_GROUP
= 4,
/* Output to controller in group bucket. */
OFPR_PACKET_OUT
= 5,
/* Output to controller in packet-out. */
};
OFPR_INVALID_TTL indicates that a packets with an invalid IP TTL or MPLS TTL was rejected by
the OpenFlow pipeline and passed to the controller. Checking for invalid TTL does not need to
be done for every packet, but it must be done at a minimum every time a OFPAT_DEC_MPLS_TTL or
OFPAT_DEC_NW_TTL action is applied to a packet.
The cookie field contains the cookie of the flow entry that caused the packet to be sent to the controller.
This field must be set to -1 (0xffffffffffffffff) if a cookie cannot be associated with a particular flow. For
example, if the packet-in was generated in a group bucket or from the action set.
The match field reflect the packet’s headers and context when the event that triggers the packet-in message occurred and contains a set of OXM TLVs. This context includes any changes applied to the packet
in previous processing, including actions already executed, if any, but not any changes in the action set.
The OXM TLVs must include context fields, that is, fields whose values cannot be determined from
the packet data. The standard context fields are OFPXMT_OFB_IN_PORT, OFPXMT_OFB_IN_PHY_PORT,
OFPXMT_OFB_METADATA and OFPXMT_OFB_TUNNEL_ID. Fields whose values are all-bits-zero should be
omitted. Optionally, the OXM TLVs may also include packet header fields that were previously extracted from the packet, including any modifications of those in the course of the processing.
When a packet is received directly on a physical port and not processed by a logical port,
OFPXMT_OFB_IN_PORT and OFPXMT_OFB_IN_PHY_PORT have the same value, the OpenFlow port no
of this physical port. OFPXMT_OFB_IN_PHY_PORT should be omitted if it has the same value as
OFPXMT_OFB_IN_PORT.
125
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
When a packet is received on a logical port by way of a physical port, OFPXMT_OFB_IN_PORT is the logical
port’s port no and OFPXMT_OFB_IN_PHY_PORT is the physical port’s port no. For example, consider a
packet received on a tunnel interface defined over a link aggregation group (LAG) with two physical port
members. If the tunnel interface is the logical port bound to OpenFlow, then OFPXMT_OFB_IN_PORT is
the tunnel port no and OFPXMT_OFB_IN_PHY_PORT is the physical port no member of the LAG on which
the tunnel is configured.
The port referenced by the OFPXMT_OFB_IN_PORT TLV must be the port used for matching flow entries
(see 5.3) and must be available to OpenFlow processing (i.e. OpenFlow can forward packet to this port,
depending on port flags). OFPXMT_OFB_IN_PHY_PORT need not be available for matching or OpenFlow
processing.
7.4.2 Flow Removed Message
If the controller has requested to be notified when flow entries time out or are deleted from tables (see
5.5), the datapath does this with the OFPT_FLOW_REMOVED message:
/* Flow removed (datapath -> controller). */
struct ofp_flow_removed {
struct ofp_header header;
uint64_t cookie;
/* Opaque controller-issued identifier. */
uint16_t priority;
uint8_t reason;
uint8_t table_id;
/* Priority level of flow entry. */
/* One of OFPRR_*. */
/* ID of the table */
uint32_t duration_sec;
uint32_t duration_nsec;
/* Time flow was alive in seconds. */
/* Time flow was alive in nanoseconds beyond
duration_sec. */
/* Idle timeout from original flow mod. */
/* Hard timeout from original flow mod. */
uint16_t idle_timeout;
uint16_t hard_timeout;
uint64_t packet_count;
uint64_t byte_count;
struct ofp_match match;
/* Description of fields. Variable size. */
};
OFP_ASSERT(sizeof(struct ofp_flow_removed) == 56);
The match, cookie, and priority fields are the same as those used in the flow mod request.
The reason field is one of the following:
/* Why was this flow removed? */
enum ofp_flow_removed_reason {
OFPRR_IDLE_TIMEOUT = 0,
/*
OFPRR_HARD_TIMEOUT = 1,
/*
OFPRR_DELETE
= 2,
/*
OFPRR_GROUP_DELETE = 3,
/*
OFPRR_METER_DELETE = 4,
/*
OFPRR_EVICTION
= 5,
/*
};
Flow idle time exceeded idle_timeout. */
Time exceeded hard_timeout. */
Evicted by a DELETE flow mod. */
Group was removed. */
Meter was removed. */
Switch eviction to free resources. */
126
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The reason values OFPRR_IDLE_TIMEOUT and OFPRR_HARD_TIMEOUT are used by the expiry process (see
5.5). The reason value OFPRR_DELETE is used when the flow entry is removed by a flow-mod request (see
6.4). The reason value OFPRR_GROUP_DELETE is used when the flow entry is removed by a group-mod
request (see 6.6). The reason value OFPRR_METER_DELETE is used when the flow entry is removed by a
meter-mod request (see 6.7). The reason value OFPRR_EVICTION is used when the flow entry is removed
by the eviction process (see 5.5).
The duration_sec and duration_nsec fields are described in Section 7.3.5.2.
The idle_timeout and hard_timeout fields are directly copied from the flow mod that created this
entry.
With the above three fields, one can find both the amount of time the flow entry was active, as well as
the amount of time the flow entry received traffic.
The packet_count and byte_count indicate the number of packets and bytes that were associated with
this flow entry, respectively. Those counters should behave like other statistics counters (see 7.3.5) ;
they are unsigned and should be set to the maximum field value if not available.
7.4.3 Port Status Message
As ports are added, modified, and removed from the datapath, the controller needs to be informed with
the OFPT_PORT_STATUS message:
/* A physical port has changed in the datapath */
struct ofp_port_status {
struct ofp_header header;
uint8_t reason;
/* One of OFPPR_*. */
uint8_t pad[7];
/* Align to 64-bits. */
struct ofp_port desc;
};
OFP_ASSERT(sizeof(struct ofp_port_status) == 56);
The reason field can be one of the following values:
/* What changed about the physical port */
enum ofp_port_reason {
OFPPR_ADD
= 0,
/* The port was added. */
OFPPR_DELETE = 1,
/* The port was removed. */
OFPPR_MODIFY = 2,
/* Some attribute of the port has changed. */
};
The desc field is a port description (see 7.2.1). In the port description, all properties don’t need to
be included, only those properties that have changed must be included, whereas unchanged properties
may optionally be included.
127
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.4.4 Controller Role Status Message
When a controller has its role changed by the switch, and not directly changed by that controller using a
OFPT_ROLE_REQUEST message, the corresponding controller must be informed with a OFPT_ROLE_STATUS
message. The switch may generate OFPT_ROLE_STATUS messages at other times, for example when
experimenter data change, this is outside the scope of this specification.
The OFPT_ROLE_STATUS message uses the following structure and fields:
/* Role status event message. */
struct ofp_role_status {
struct ofp_header header;
/*
uint32_t role;
/*
uint8_t reason;
/*
uint8_t pad[3];
/*
uint64_t generation_id;
/*
Type OFPT_ROLE_REQUEST/OFPT_ROLE_REPLY. */
One of OFPCR_ROLE_*. */
One of OFPCRR_*. */
Align to 64 bits. */
Master Election Generation Id */
/* Role Property list */
struct ofp_role_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_role_status) == 24);
The reason can be one of the following values:
/* What changed about the controller role */
enum ofp_controller_role_reason {
OFPCRR_MASTER_REQUEST = 0, /* Another controller asked to be master. */
OFPCRR_CONFIG
= 1, /* Configuration changed on the switch. */
OFPCRR_EXPERIMENTER
= 2, /* Experimenter data changed. */
};
The role is the new role of the controller (see 7.3.8). The generation_id is the generation ID that
was included in the role request message that triggered the role change.
The properties field is a list of role properties, describing dynamic parameters of table configuration.
The list of role property types that are currently defined are:
/* Role property types.
*/
enum ofp_role_prop_type {
OFPRPT_EXPERIMENTER
};
= 0xFFFF, /* Experimenter property. */
A property definition contains the property type, length, and any associated data:
/* Common header for all Role Properties */
struct ofp_role_prop_header {
uint16_t
type;
/* One of OFPRPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_role_prop_header) == 4);
128
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The OFPTMPT_EXPERIMENTER property uses the following structure and fields:
/* Experimenter role property */
struct ofp_role_prop_experimenter {
uint16_t
type;
/* One of OFPRPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_role_prop_experimenter) == 12);
The experimenter field is the Experimenter ID, which takes the same form as in the typical experimenter structure (see 7.2.5).
7.4.5 Table Status Message
When the table state changes, the controller needs to be informed with the OFPT_TABLE_STATUS message:
/* A table config has changed in the datapath */
struct ofp_table_status {
struct ofp_header header;
uint8_t reason;
/* One of OFPTR_*. */
uint8_t pad[7];
/* Pad to 64 bits */
struct ofp_table_desc table;
/* New table config. */
};
OFP_ASSERT(sizeof(struct ofp_table_status) == 24);
The reason can be one of the following values:
/* What changed about the table */
enum ofp_table_reason {
OFPTR_VACANCY_DOWN = 3,
OFPTR_VACANCY_UP
= 4,
};
/* Vacancy down threshold event. */
/* Vacancy up threshold event. */
The reason values OFPTR_VACANCY_DOWN and OFPTR_VACANCY_UP identify a vacancy message. The
vacancy events are generated when the remaining space in the flow table changes and crosses one of the
vacancy thereshold (see 7.3.3), whatever causes the change in remaining space. This change in remaining
space can be the result of OpenFlow operations on the table (flow insertion, expiry or removal), or the
result of switch internal processing changing the amount of remaining space in the table.
129
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.4.6 Request Forward Message
When a controller modifies the state a groups and meters, the request that successfully modifies this state
may be forwarded to other controller. Other controller are informed with the OFPT_REQUESTFORWARD
message:
/* Group/Meter request forwarding. */
struct ofp_requestforward_header {
struct ofp_header header;
/* Type OFPT_REQUESTFORWARD. */
struct ofp_header request; /* Request being forwarded. */
};
OFP_ASSERT(sizeof(struct ofp_requestforward_header) == 16);
Request forwarding is enabled on a per controller channel basis using the Set Asynchronous
Configuration Message (see 7.3.10). The following forwarding reasons may be enabled in the
requestforward_mask field:
/* Request forward reason */
enum ofp_requestforward_reason {
OFPRFR_GROUP_MOD = 0,
/* Forward group mod requests. */
OFPRFR_METER_MOD = 1,
/* Forward meter mod requests. */
};
7.5 Symmetric Messages
7.5.1 Hello
The OFPT_HELLO message consists of an OpenFlow header plus a set of variable size hello elements.
/* OFPT_HELLO. This message includes zero or more hello elements having
* variable size. Unknown elements types must be ignored/skipped, to allow
* for future extensions. */
struct ofp_hello {
struct ofp_header header;
/* Hello element list */
struct ofp_hello_elem_header elements[0]; /* List of elements - 0 or more */
};
OFP_ASSERT(sizeof(struct ofp_hello) == 8);
The version field part of the header field (see 7.1) must be set to the highest OpenFlow protocol
version supported by the sender (see 6.3.1).
The elements field is a set of hello elements, containing optional data to inform the initial handshake
of the connection. Implementations must ignore (skip) all elements of a Hello message that they do not
support. The list of hello elements types that are currently defined are:
130
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
/* Hello elements types.
*/
enum ofp_hello_elem_type {
OFPHET_VERSIONBITMAP
};
Version 1.4.0
= 1,
/* Bitmap of version supported. */
An element definition contains the element type, length, and any associated data:
/* Common header for all Hello Elements */
struct ofp_hello_elem_header {
uint16_t
type;
/* One of OFPHET_*. */
uint16_t
length; /* Length in bytes of this element. */
};
OFP_ASSERT(sizeof(struct ofp_hello_elem_header) == 4);
The OFPHET_VERSIONBITMAP element use the following structure and fields:
/* Version bitmap Hello Element */
struct ofp_hello_elem_versionbitmap {
uint16_t
type;
/* OFPHET_VERSIONBITMAP. */
uint16_t
length; /* Length in bytes of this element. */
/* Followed by:
*
- Exactly (length - 4) bytes containing the bitmaps, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
bitmaps[0];
/* List of bitmaps - supported versions */
};
OFP_ASSERT(sizeof(struct ofp_hello_elem_versionbitmap) == 4);
The bitmaps field indicates the set of versions of the OpenFlow switch protocol a device supports,
and may be used during version negotiation (see 6.3.1). The bits of the set of bitmaps are indexed
by the ofp version number of the protocol ; if the bit identified by the number of left bitshift equal
to a ofp version number is set, this OpenFlow version is supported. The number of bitmaps included
in the field depend on the highest version number supported : ofp versions 0 to 31 are encoded in
the first bitmap, ofp versions 32 to 63 are encoded in the second bitmap and so on. For example, if
a switch supports only version 1.0 (ofp version=0x01) and version 1.3 (ofp version=0x04), the first
bitmap would be set to 0x00000012.
7.5.2 Echo Request
An Echo Request message consists of an OpenFlow header plus an arbitrary-length data field. The
data field might be a message timestamp to check latency, various lengths to measure bandwidth, or
zero-size to verify liveness between the switch and controller.
131
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
7.5.3 Echo Reply
An Echo Reply message consists of an OpenFlow header plus the unmodified data field of an echo
request message.
In an OpenFlow protocol implementation divided into multiple layers, the echo request/reply logic
should be implemented in the ”deepest” practical layer. For example, in the OpenFlow reference
implementation that includes a userspace process that relays to a kernel module, echo request/reply is
implemented in the kernel module. Receiving a correctly formatted echo reply then shows a greater
likelihood of correct end-to-end functionality than if the echo request/reply were implemented in the
userspace process, as well as providing more accurate end-to-end latency timing.
7.5.4 Error Message
Error messages are used by the switch or the controller to notify the other side of the connection
of problems. They are mostly used by the switch to indicate a failure of a request initiated by the
controller. The OFPT_ERROR_MSG message use the following structure:
/* OFPT_ERROR: Error message (datapath -> controller). */
struct ofp_error_msg {
struct ofp_header header;
uint16_t type;
uint16_t code;
uint8_t data[0];
/* Variable-length data.
on the type and code.
Interpreted based
No padding. */
};
OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
The type value indicates the high-level type of error. The code value is interpreted based on the type.
The data is variable length and interpreted based on the type and code. Unless specified otherwise,
the data field must contain at least 64 bytes of the failed message that caused the error message to be
generated, if the failed message is shorter than 64 bytes it must contain the full message without any
padding.
If the error message is in response to a specific message from the controller, e.g., OFPET_BAD_REQUEST,
OFPET_BAD_ACTION, OFPET_BAD_INSTRUCTION, OFPET_BAD_MATCH, or OFPET_FLOW_MOD_FAILED, then
the xid field of the header must match that of the offending message. If the error is caused by the
processing of a request, the error message is sent in place of the reply and the normal reply to the
request is not sent.
Error codes ending in _EPERM correspond to a permissions error generated by, for example, an OpenFlow
hypervisor interposing between a controller and switch.
Currently defined error types are:
/* Values for ’type’ in ofp_error_message. These values are immutable: they
* will not change in future versions of the protocol (although new values may
* be added). */
enum ofp_error_type {
132
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
OFPET_HELLO_FAILED
= 0, /* Hello protocol failed. */
OFPET_BAD_REQUEST
= 1, /* Request was not understood. */
OFPET_BAD_ACTION
= 2, /* Error in action description. */
OFPET_BAD_INSTRUCTION
= 3, /* Error in instruction list. */
OFPET_BAD_MATCH
= 4, /* Error in match. */
OFPET_FLOW_MOD_FAILED
= 5, /* Problem modifying flow entry. */
OFPET_GROUP_MOD_FAILED
= 6, /* Problem modifying group entry. */
OFPET_PORT_MOD_FAILED
= 7, /* Port mod request failed. */
OFPET_TABLE_MOD_FAILED
= 8, /* Table mod request failed. */
OFPET_QUEUE_OP_FAILED
= 9, /* Queue operation failed. */
OFPET_SWITCH_CONFIG_FAILED = 10, /* Switch config request failed. */
OFPET_ROLE_REQUEST_FAILED = 11, /* Controller Role request failed. */
OFPET_METER_MOD_FAILED
= 12, /* Error in meter. */
OFPET_TABLE_FEATURES_FAILED = 13, /* Setting table features failed. */
OFPET_BAD_PROPERTY
= 14, /* Some property is invalid. */
OFPET_ASYNC_CONFIG_FAILED = 15, /* Asynchronous config request failed. */
OFPET_FLOW_MONITOR_FAILED = 16, /* Setting flow monitor failed. */
OFPET_BUNDLE_FAILED
= 17, /* Bundle operation failed. */
OFPET_EXPERIMENTER = 0xffff
/* Experimenter error messages. */
};
For the OFPET_HELLO_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for
* ASCII text string that may give
enum ofp_hello_failed_code {
OFPHFC_INCOMPATIBLE = 0,
/*
OFPHFC_EPERM
= 1,
/*
};
OFPET_HELLO_FAILED.
failure details. */
’data’ contains an
No compatible version. */
Permissions error. */
The data field contains an ASCII text string that adds detail on why the error occurred.
For the OFPET_BAD_REQUEST error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_BAD_REQUEST. ’data’ contains at least
* the first 64 bytes of the failed request. */
enum ofp_bad_request_code {
OFPBRC_BAD_VERSION
= 0, /* ofp_header.version not supported. */
OFPBRC_BAD_TYPE
= 1, /* ofp_header.type not supported. */
OFPBRC_BAD_MULTIPART
= 2, /* ofp_multipart_request.type not supported. */
OFPBRC_BAD_EXPERIMENTER = 3, /* Experimenter id not supported
* (in ofp_experimenter_header or
* ofp_multipart_request or
* ofp_multipart_reply). */
OFPBRC_BAD_EXP_TYPE
= 4, /* Experimenter type not supported. */
OFPBRC_EPERM
= 5, /* Permissions error. */
OFPBRC_BAD_LEN
= 6, /* Wrong request length for type. */
OFPBRC_BUFFER_EMPTY
= 7, /* Specified buffer has already been used. */
OFPBRC_BUFFER_UNKNOWN
= 8, /* Specified buffer does not exist. */
OFPBRC_BAD_TABLE_ID
= 9, /* Specified table-id invalid or does not
* exist. */
OFPBRC_IS_SLAVE
= 10, /* Denied because controller is slave. */
OFPBRC_BAD_PORT
= 11, /* Invalid port. */
OFPBRC_BAD_PACKET
= 12, /* Invalid packet in packet-out. */
OFPBRC_MULTIPART_BUFFER_OVERFLOW
= 13, /* ofp_multipart_request
133
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
overflowed the assigned buffer. */
OFPBRC_MULTIPART_REQUEST_TIMEOUT = 14, /* Timeout during multipart request. */
OFPBRC_MULTIPART_REPLY_TIMEOUT = 15, /* Timeout during multipart reply. */
};
Error
message
using
the
codes
OFPBRC_MULTIPART_BUFFER_OVERFLOW,
OFPBRC_MULTIPART_REQUEST_TIMEOUT and OFPBRC_MULTIPART_REPLY_TIMEOUT must include an
empty data field, and the xid field must match that of the offending multipart message sequence.
For the OFPET_BAD_ACTION error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_BAD_ACTION. ’data’ contains at least
* the first 64 bytes of the failed request. */
enum ofp_bad_action_code {
OFPBAC_BAD_TYPE
= 0, /* Unknown action type. */
OFPBAC_BAD_LEN
= 1, /* Length problem in actions. */
OFPBAC_BAD_EXPERIMENTER
= 2, /* Unknown experimenter id specified. */
OFPBAC_BAD_EXP_TYPE
= 3, /* Unknown action for experimenter id. */
OFPBAC_BAD_OUT_PORT
= 4, /* Problem validating output port. */
OFPBAC_BAD_ARGUMENT
= 5, /* Bad action argument. */
OFPBAC_EPERM
= 6, /* Permissions error. */
OFPBAC_TOO_MANY
= 7, /* Can’t handle this many actions. */
OFPBAC_BAD_QUEUE
= 8, /* Problem validating output queue. */
OFPBAC_BAD_OUT_GROUP
= 9, /* Invalid group id in forward action. */
OFPBAC_MATCH_INCONSISTENT = 10, /* Action can’t apply for this match,
or Set-Field missing prerequisite. */
OFPBAC_UNSUPPORTED_ORDER = 11, /* Action order is unsupported for the
action list in an Apply-Actions instruction */
OFPBAC_BAD_TAG
= 12, /* Actions uses an unsupported
tag/encap. */
OFPBAC_BAD_SET_TYPE
= 13, /* Unsupported type in SET_FIELD action. */
OFPBAC_BAD_SET_LEN
= 14, /* Length problem in SET_FIELD action. */
OFPBAC_BAD_SET_ARGUMENT
= 15, /* Bad argument in SET_FIELD action. */
};
For the OFPET_BAD_INSTRUCTION error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_BAD_INSTRUCTION. ’data’ contains at least
* the first 64 bytes of the failed request. */
enum ofp_bad_instruction_code {
OFPBIC_UNKNOWN_INST
= 0, /* Unknown instruction. */
OFPBIC_UNSUP_INST
= 1, /* Switch or table does not support the
instruction. */
OFPBIC_BAD_TABLE_ID
= 2, /* Invalid Table-ID specified. */
OFPBIC_UNSUP_METADATA
= 3, /* Metadata value unsupported by datapath. */
OFPBIC_UNSUP_METADATA_MASK = 4, /* Metadata mask value unsupported by
datapath. */
OFPBIC_BAD_EXPERIMENTER = 5, /* Unknown experimenter id specified. */
OFPBIC_BAD_EXP_TYPE
= 6, /* Unknown instruction for experimenter id. */
OFPBIC_BAD_LEN
= 7, /* Length problem in instructions. */
OFPBIC_EPERM
= 8, /* Permissions error. */
OFPBIC_DUP_INST
= 9, /* Duplicate instruction. */
};
134
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
For the OFPET_BAD_MATCH error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_BAD_MATCH. ’data’ contains at least
* the first 64 bytes of the failed request. */
enum ofp_bad_match_code {
OFPBMC_BAD_TYPE
= 0, /* Unsupported match type specified by the
match */
OFPBMC_BAD_LEN
= 1, /* Length problem in match. */
OFPBMC_BAD_TAG
= 2, /* Match uses an unsupported tag/encap. */
OFPBMC_BAD_DL_ADDR_MASK = 3, /* Unsupported datalink addr mask - switch
does not support arbitrary datalink
address mask. */
OFPBMC_BAD_NW_ADDR_MASK = 4, /* Unsupported network addr mask - switch
does not support arbitrary network
address mask. */
OFPBMC_BAD_WILDCARDS
= 5, /* Unsupported combination of fields masked
or omitted in the match. */
OFPBMC_BAD_FIELD
= 6, /* Unsupported field type in the match. */
OFPBMC_BAD_VALUE
= 7, /* Unsupported value in a match field. */
OFPBMC_BAD_MASK
= 8, /* Unsupported mask specified in the match,
field is not dl-address or nw-address. */
OFPBMC_BAD_PREREQ
= 9, /* A prerequisite was not met. */
OFPBMC_DUP_FIELD
= 10, /* A field type was duplicated. */
OFPBMC_EPERM
= 11, /* Permissions error. */
};
For the OFPET_FLOW_MOD_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_FLOW_MOD_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_flow_mod_failed_code {
OFPFMFC_UNKNOWN
= 0,
/* Unspecified error. */
OFPFMFC_TABLE_FULL
= 1,
/* Flow not added because table was full. */
OFPFMFC_BAD_TABLE_ID = 2,
/* Table does not exist */
OFPFMFC_OVERLAP
= 3,
/* Attempted to add overlapping flow with
CHECK_OVERLAP flag set. */
OFPFMFC_EPERM
= 4,
/* Permissions error. */
OFPFMFC_BAD_TIMEOUT = 5,
/* Flow not added because of unsupported
idle/hard timeout. */
OFPFMFC_BAD_COMMAND = 6,
/* Unsupported or unknown command. */
OFPFMFC_BAD_FLAGS
= 7,
/* Unsupported or unknown flags. */
OFPFMFC_CANT_SYNC
= 8,
/* Problem in table synchronisation. */
OFPFMFC_BAD_PRIORITY = 9,
/* Unsupported priority value. */
};
For the OFPET_GROUP_MOD_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_GROUP_MOD_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_group_mod_failed_code {
OFPGMFC_GROUP_EXISTS
= 0, /* Group not added because a group ADD
attempted to replace an
already-present group. */
OFPGMFC_INVALID_GROUP
= 1, /* Group not added because Group
135
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
OFPGMFC_WEIGHT_UNSUPPORTED
= 2,
OFPGMFC_OUT_OF_GROUPS
OFPGMFC_OUT_OF_BUCKETS
= 3,
= 4,
OFPGMFC_CHAINING_UNSUPPORTED = 5,
OFPGMFC_WATCH_UNSUPPORTED
= 6,
OFPGMFC_LOOP
OFPGMFC_UNKNOWN_GROUP
= 7,
= 8,
OFPGMFC_CHAINED_GROUP
= 9,
OFPGMFC_BAD_TYPE
OFPGMFC_BAD_COMMAND
OFPGMFC_BAD_BUCKET
OFPGMFC_BAD_WATCH
OFPGMFC_EPERM
=
=
=
=
=
10,
11,
12,
13,
14,
specified is invalid. */
/* Switch does not support unequal load
sharing with select groups. */
/* The group table is full. */
/* The maximum number of action buckets
for a group has been exceeded. */
/* Switch does not support groups that
forward to groups. */
/* This group cannot watch the watch_port
or watch_group specified. */
/* Group entry would cause a loop. */
/* Group not modified because a group
MODIFY attempted to modify a
non-existent group. */
/* Group not deleted because another
group is forwarding to it. */
/* Unsupported or unknown group type. */
/* Unsupported or unknown command. */
/* Error in bucket. */
/* Error in watch port/group. */
/* Permissions error. */
};
For the OFPET_PORT_MOD_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_PORT_MOD_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_port_mod_failed_code {
OFPPMFC_BAD_PORT
= 0,
/* Specified port number does not exist. */
OFPPMFC_BAD_HW_ADDR
= 1,
/* Specified hardware address does not
* match the port number. */
OFPPMFC_BAD_CONFIG
= 2,
/* Specified config is invalid. */
OFPPMFC_BAD_ADVERTISE = 3,
/* Specified advertise is invalid. */
OFPPMFC_EPERM
= 4,
/* Permissions error. */
};
For the OFPET_TABLE_MOD_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_TABLE_MOD_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_table_mod_failed_code {
OFPTMFC_BAD_TABLE = 0,
/* Specified table does not exist. */
OFPTMFC_BAD_CONFIG = 1,
/* Specified config is invalid. */
OFPTMFC_EPERM
= 2,
/* Permissions error. */
};
For the OFPET_QUEUE_OP_FAILED error type, the following codes are currently defined:
/* ofp_error msg ’code’ values for OFPET_QUEUE_OP_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request */
enum ofp_queue_op_failed_code {
OFPQOFC_BAD_PORT
= 0,
/* Invalid port (or port does not exist). */
OFPQOFC_BAD_QUEUE = 1,
/* Queue does not exist. */
OFPQOFC_EPERM
= 2,
/* Permissions error. */
};
136
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
For the OFPET_SWITCH_CONFIG_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_SWITCH_CONFIG_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_switch_config_failed_code {
OFPSCFC_BAD_FLAGS = 0,
/* Specified flags is invalid. */
OFPSCFC_BAD_LEN
= 1,
/* Specified len is invalid. */
OFPSCFC_EPERM
= 2,
/* Permissions error. */
};
For the OFPET_ROLE_REQUEST_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_ROLE_REQUEST_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_role_request_failed_code {
OFPRRFC_STALE
= 0,
/* Stale Message: old generation_id. */
OFPRRFC_UNSUP
= 1,
/* Controller role change unsupported. */
OFPRRFC_BAD_ROLE
= 2,
/* Invalid role. */
};
For the OFPET_METER_MOD_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_METER_MOD_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_meter_mod_failed_code {
OFPMMFC_UNKNOWN
= 0, /* Unspecified error. */
OFPMMFC_METER_EXISTS = 1, /* Meter not added because a Meter ADD
* attempted to replace an existing Meter. */
OFPMMFC_INVALID_METER = 2,
/* Meter not added because Meter specified
* is invalid. */
OFPMMFC_UNKNOWN_METER = 3, /* Meter not modified because a Meter
MODIFY attempted to modify a non-existent
Meter. */
OFPMMFC_BAD_COMMAND
= 4, /* Unsupported or unknown command. */
OFPMMFC_BAD_FLAGS
= 5, /* Flag configuration unsupported. */
OFPMMFC_BAD_RATE
= 6, /* Rate unsupported. */
OFPMMFC_BAD_BURST
= 7, /* Burst size unsupported. */
OFPMMFC_BAD_BAND
= 8, /* Band unsupported. */
OFPMMFC_BAD_BAND_VALUE = 9, /* Band value unsupported. */
OFPMMFC_OUT_OF_METERS = 10, /* No more meters available. */
OFPMMFC_OUT_OF_BANDS = 11, /* The maximum number of properties
* for a meter has been exceeded. */
};
For the OFPET_TABLE_FEATURES_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_TABLE_FEATURES_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_table_features_failed_code {
OFPTFFC_BAD_TABLE
= 0,
/* Specified table does not exist. */
OFPTFFC_BAD_METADATA = 1,
/* Invalid metadata mask. */
OFPTFFC_EPERM
= 5,
/* Permissions error. */
};
137
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
For the OFPET_BAD_PROPERTY error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_BAD_PROPERTY. ’data’ contains at least
* the first 64 bytes of the failed request. */
enum ofp_bad_property_code {
OFPBPC_BAD_TYPE
= 0, /* Unknown property type. */
OFPBPC_BAD_LEN
= 1, /* Length problem in property. */
OFPBPC_BAD_VALUE
= 2, /* Unsupported property value. */
OFPBPC_TOO_MANY
= 3, /* Can’t handle this many properties. */
OFPBPC_DUP_TYPE
= 4, /* A property type was duplicated. */
OFPBPC_BAD_EXPERIMENTER
= 5, /* Unknown experimenter id specified. */
OFPBPC_BAD_EXP_TYPE
= 6, /* Unknown exp_type for experimenter id. */
OFPBPC_BAD_EXP_VALUE
= 7, /* Unknown value for experimenter id. */
OFPBPC_EPERM
= 8, /* Permissions error. */
};
For the OFPET_ASYNC_CONFIG_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_ASYNC_CONFIG_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_async_config_failed_code {
OFPACFC_INVALID
= 0,
/* One mask is invalid. */
OFPACFC_UNSUPPORTED = 1,
/* Requested configuration not supported. */
OFPACFC_EPERM
= 2,
/* Permissions error. */
};
For the OFPET_FLOW_MONITOR_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_FLOW_MONITOR_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_flow_monitor_failed_code {
OFPMOFC_UNKNOWN
= 0, /* Unspecified error. */
OFPMOFC_MONITOR_EXISTS = 1, /* Monitor not added because a Monitor ADD
* attempted to replace an existing Monitor. */
OFPMOFC_INVALID_MONITOR = 2, /* Monitor not added because Monitor specified
* is invalid. */
OFPMOFC_UNKNOWN_MONITOR = 3, /* Monitor not modified because a Monitor
MODIFY attempted to modify a non-existent
Monitor. */
OFPMOFC_BAD_COMMAND
= 4, /* Unsupported or unknown command. */
OFPMOFC_BAD_FLAGS
= 5, /* Flag configuration unsupported. */
OFPMOFC_BAD_TABLE_ID = 6, /* Specified table does not exist. */
OFPMOFC_BAD_OUT
= 7, /* Error in output port/group. */
};
For the OFPET_BUNDLE_FAILED error type, the following codes are currently defined:
/* ofp_error_msg ’code’ values for OFPET_BUNDLE_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_bundle_failed_code {
OFPBFC_UNKNOWN
= 0, /* Unspecified error. */
OFPBFC_EPERM
= 1, /* Permissions error. */
138
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPBFC_BAD_ID
= 2,
OFPBFC_BUNDLE_EXIST
= 3,
OFPBFC_BUNDLE_CLOSED = 4,
OFPBFC_OUT_OF_BUNDLES = 5,
OFPBFC_BAD_TYPE
= 6,
OFPBFC_BAD_FLAGS
= 7,
OFPBFC_MSG_BAD_LEN
= 8,
OFPBFC_MSG_BAD_XID
= 9,
OFPBFC_MSG_UNSUP
= 10,
OFPBFC_MSG_CONFLICT
= 11,
OFPBFC_MSG_TOO_MANY
= 12,
OFPBFC_MSG_FAILED
= 13,
OFPBFC_TIMEOUT
= 14,
OFPBFC_BUNDLE_IN_PROGRESS =
Version 1.4.0
/* Bundle ID doesn’t exist. */
/* Bundle ID already exist. */
/* Bundle ID is closed. */
/* Too many bundles IDs. */
/* Unsupported or unknown message control type. */
/* Unsupported, unknown, or inconsistent flags. */
/* Length problem in included message. */
/* Inconsistent or duplicate XID. */
/* Unsupported message in this bundle. */
/* Unsupported message combination in this bundle. */
/* Cant handle this many messages in bundle. */
/* One message in bundle failed. */
/* Bundle is taking too long. */
15, /* Bundle is locking the resource. */
};
For the OFPET_EXPERIMENTER error type, the error message is defined by the following structure and
fields:
/* OFPET_EXPERIMENTER: Error message (datapath -> controller). */
struct ofp_error_experimenter_msg {
struct ofp_header header;
uint16_t type;
uint16_t exp_code;
uint32_t experimenter;
uint8_t data[0];
/*
/*
/*
/*
OFPET_EXPERIMENTER. */
Experimenter defined. */
Experimenter ID. */
Variable-length data. Interpreted based
on the type and experimenter. No padding. */
};
OFP_ASSERT(sizeof(struct ofp_error_experimenter_msg) == 16);
The experimenter field is the Experimenter ID , which takes the same form as in the typical experimenter structure (see 7.2.5). The exp_code field is the experimenter code, a 16 bit field managed by
the experimenter and it can have any value and function the experimenter wishes. The data field is
experimenter defined and does not need to be padded.
7.5.5 Experimenter Message
The Experimenter message is defined as follows:
/* Experimenter extension message. */
struct ofp_experimenter_msg {
struct ofp_header header;
/* Type OFPT_EXPERIMENTER. */
uint32_t experimenter;
/* Experimenter ID:
* - MSB 0: low-order bytes are IEEE OUI.
* - MSB != 0: defined by ONF. */
uint32_t exp_type;
/* Experimenter defined. */
/* Experimenter-defined arbitrary additional data. */
uint8_t experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_experimenter_msg) == 16);
139
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The experimenter field and identifies the experimenter, the exp_type field is the experimenter type,
and experimenter_data is the exprimenter arbitrary data. They take the same form as in the typical
experimenter structure (see 7.2.5). The Experimenter message does not need to be padded.
As opposed to other Experimenter extensions, Experimenter messages are not associated with a specific
OpenFlow object, and therefore can be used to create entirely new APIs and manage entirely new
objects.
If a switch does not understand an experimenter message, it must send an OFPT_ERROR message with a
OFPBRC_BAD_EXPERIMENTER error code and OFPET_BAD_REQUEST error type.
Appendix A
Header file openflow.h
The file openflow.h contains all the structures, defines, and enumerations used by the OpenFlow
protocol. The version of openflow.h defined for the present version of the specification 1.4.0 is both
included below and attached to this document here (not available in all PDF reader).
/* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
* Junior University
* Copyright (c) 2011, 2013 Open Networking Foundation
*
* We are making the OpenFlow specification and associated documentation
* (Software) 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 above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* 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.
*
* The name and trademarks of copyright holder(s) may NOT be used in
* advertising or publicity pertaining to the Software or any
* derivatives without specific, written prior permission.
*/
/* OpenFlow: protocol between controller and datapath. */
#ifndef OPENFLOW_OPENFLOW_H
#define OPENFLOW_OPENFLOW_H 1
#ifdef __KERNEL__
#include <linux/types.h>
#else
#include <stdint.h>
#endif
#ifdef SWIG
#define OFP_ASSERT(EXPR)
/* SWIG can’t handle OFP_ASSERT. */
#elif !defined(__cplusplus)
/* Build-time assertion for use in a declaration context. */
#define OFP_ASSERT(EXPR)
\
extern int (*build_assert(void))[ sizeof(struct {
\
unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
#else /* __cplusplus */
#define OFP_ASSERT(_EXPR) typedef int build_assert_failed[(_EXPR) ? 1 : -1]
#endif /* __cplusplus */
140
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
#ifndef SWIG
#define OFP_PACKED __attribute__((packed))
#else
#define OFP_PACKED
/* SWIG doesn’t understand __attribute. */
#endif
/* Version number:
* Non-experimental versions released: 0x01 = 1.0 ; 0x02 = 1.1 ; 0x03 = 1.2
*
0x04 = 1.3.X ; 0x05 = 1.4.X
* Experimental versions released: 0x81 -- 0x99
*/
/* The most significant bit being set in the version field indicates an
* experimental OpenFlow version.
*/
#define OFP_VERSION
0x05
#define OFP_MAX_TABLE_NAME_LEN 32
#define OFP_MAX_PORT_NAME_LEN 16
#define OFP_TCP_PORT
#define OFP_SSL_PORT
6653
6653
#define OFP_ETH_ALEN 6
/* Bytes in an Ethernet address. */
/* Port numbering. Ports are numbered starting from 1. */
enum ofp_port_no {
/* Maximum number of physical and logical switch ports. */
OFPP_MAX
= 0xffffff00,
/* Reserved OpenFlow Port (fake output "ports"). */
OFPP_IN_PORT
= 0xfffffff8, /* Send the packet out the input port. This
reserved port must be explicitly used
in order to send back out of the input
port. */
OFPP_TABLE
= 0xfffffff9, /* Submit the packet to the first flow table
NB: This destination port can only be
used in packet-out messages. */
OFPP_NORMAL
= 0xfffffffa, /* Process with normal L2/L3 switching. */
OFPP_FLOOD
= 0xfffffffb, /* All physical ports in VLAN, except input
port and those blocked or link down. */
OFPP_ALL
= 0xfffffffc, /* All physical ports except input port. */
OFPP_CONTROLLER = 0xfffffffd, /* Send to controller. */
OFPP_LOCAL
= 0xfffffffe, /* Local openflow "port". */
OFPP_ANY
= 0xffffffff
/* Wildcard port used only for flow mod
(delete) and flow stats requests. Selects
all flows regardless of output port
(including flows with no output port). */
};
enum ofp_type {
/* Immutable messages. */
OFPT_HELLO
= 0,
OFPT_ERROR
= 1,
OFPT_ECHO_REQUEST
= 2,
OFPT_ECHO_REPLY
= 3,
OFPT_EXPERIMENTER
= 4,
/* Switch configuration
OFPT_FEATURES_REQUEST
OFPT_FEATURES_REPLY
OFPT_GET_CONFIG_REQUEST
OFPT_GET_CONFIG_REPLY
OFPT_SET_CONFIG
/*
/*
/*
/*
/*
Symmetric
Symmetric
Symmetric
Symmetric
Symmetric
message
message
message
message
message
messages. */
= 5, /* Controller/switch
= 6, /* Controller/switch
= 7, /* Controller/switch
= 8, /* Controller/switch
= 9, /* Controller/switch
/* Asynchronous messages.
OFPT_PACKET_IN
=
OFPT_FLOW_REMOVED
=
OFPT_PORT_STATUS
=
message
message
message
message
message
*/
*/
*/
*/
*/
message
message
message
message
message
*/
*/
*/
*/
*/
*/
10, /* Async message */
11, /* Async message */
12, /* Async message */
/* Controller command messages. */
OFPT_PACKET_OUT
= 13, /* Controller/switch
OFPT_FLOW_MOD
= 14, /* Controller/switch
OFPT_GROUP_MOD
= 15, /* Controller/switch
OFPT_PORT_MOD
= 16, /* Controller/switch
OFPT_TABLE_MOD
= 17, /* Controller/switch
/* Multipart messages. */
OFPT_MULTIPART_REQUEST
OFPT_MULTIPART_REPLY
*/
*/
*/
*/
*/
= 18, /* Controller/switch message */
= 19, /* Controller/switch message */
/* Barrier messages. */
OFPT_BARRIER_REQUEST
= 20, /* Controller/switch message */
OFPT_BARRIER_REPLY
= 21, /* Controller/switch message */
/* Controller role change request messages. */
OFPT_ROLE_REQUEST
= 24, /* Controller/switch message */
OFPT_ROLE_REPLY
= 25, /* Controller/switch message */
/* Asynchronous message configuration. */
141
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPT_GET_ASYNC_REQUEST
OFPT_GET_ASYNC_REPLY
OFPT_SET_ASYNC
Version 1.4.0
= 26, /* Controller/switch message */
= 27, /* Controller/switch message */
= 28, /* Controller/switch message */
/* Meters and rate limiters configuration messages. */
OFPT_METER_MOD
= 29, /* Controller/switch message */
/* Controller role change event messages. */
OFPT_ROLE_STATUS
= 30, /* Async message */
/* Asynchronous messages. */
OFPT_TABLE_STATUS
= 31, /* Async message */
/* Request forwarding by the switch. */
OFPT_REQUESTFORWARD
= 32, /* Async message */
/* Bundle operations (multiple messages as a single operation). */
OFPT_BUNDLE_CONTROL
= 33,
OFPT_BUNDLE_ADD_MESSAGE = 34,
};
/* Header on all OpenFlow packets. */
struct ofp_header {
uint8_t version;
/* OFP_VERSION. */
uint8_t type;
/* One of the OFPT_ constants. */
uint16_t length;
/* Length including this ofp_header. */
uint32_t xid;
/* Transaction id associated with this packet.
Replies use the same id as was in the request
to facilitate pairing. */
};
OFP_ASSERT(sizeof(struct ofp_header) == 8);
/* Hello elements types.
*/
enum ofp_hello_elem_type {
OFPHET_VERSIONBITMAP
};
= 1,
/* Bitmap of version supported. */
/* Common header for all Hello Elements */
struct ofp_hello_elem_header {
uint16_t
type;
/* One of OFPHET_*. */
uint16_t
length; /* Length in bytes of this element. */
};
OFP_ASSERT(sizeof(struct ofp_hello_elem_header) == 4);
/* Version bitmap Hello Element */
struct ofp_hello_elem_versionbitmap {
uint16_t
type;
/* OFPHET_VERSIONBITMAP. */
uint16_t
length; /* Length in bytes of this element. */
/* Followed by:
*
- Exactly (length - 4) bytes containing the bitmaps, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
bitmaps[0];
/* List of bitmaps - supported versions */
};
OFP_ASSERT(sizeof(struct ofp_hello_elem_versionbitmap) == 4);
/* OFPT_HELLO. This message includes zero or more hello elements having
* variable size. Unknown elements types must be ignored/skipped, to allow
* for future extensions. */
struct ofp_hello {
struct ofp_header header;
/* Hello element list */
struct ofp_hello_elem_header elements[0]; /* List of elements - 0 or more */
};
OFP_ASSERT(sizeof(struct ofp_hello) == 8);
#define OFP_DEFAULT_MISS_SEND_LEN
128
enum ofp_config_flags {
/* Handling of IP fragments. */
OFPC_FRAG_NORMAL
= 0,
/* No special handling for fragments. */
OFPC_FRAG_DROP
= 1 << 0, /* Drop fragments. */
OFPC_FRAG_REASM
= 1 << 1, /* Reassemble (only if OFPC_IP_REASM set). */
OFPC_FRAG_MASK
= 3,
};
/* Switch configuration. */
struct ofp_switch_config {
struct ofp_header header;
uint16_t flags;
uint16_t miss_send_len;
/* Bitmap of OFPC_* flags. */
/* Max bytes of packet that datapath
should send to the controller. See
ofp_controller_max_len for valid values.
*/
};
OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
/* Table numbering. Tables can use any number up to OFPT_MAX. */
142
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
enum ofp_table {
/* Last usable table number. */
OFPTT_MAX
= 0xfe,
/* Fake tables. */
OFPTT_ALL
= 0xff
/* Wildcard table used for table config,
flow stats and flow deletes. */
};
/* Flags to configure the table. */
enum ofp_table_config {
OFPTC_DEPRECATED_MASK
= 3,
OFPTC_EVICTION
= 1 << 2,
OFPTC_VACANCY_EVENTS
= 1 << 3,
};
/* Table Mod property types.
*/
enum ofp_table_mod_prop_type {
OFPTMPT_EVICTION
OFPTMPT_VACANCY
OFPTMPT_EXPERIMENTER
};
/* Deprecated bits */
/* Authorise table to evict flows. */
/* Enable vacancy events. */
= 0x2,
/* Eviction property. */
= 0x3,
/* Vacancy property. */
= 0xFFFF, /* Experimenter property. */
/* Common header for all Table Mod Properties */
struct ofp_table_mod_prop_header {
uint16_t
type;
/* One of OFPTMPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_table_mod_prop_header) == 4);
/* Eviction flags. */
enum ofp_table_mod_prop_eviction_flag {
OFPTMPEF_OTHER
= 1 << 0,
OFPTMPEF_IMPORTANCE
= 1 << 1,
OFPTMPEF_LIFETIME
= 1 << 2,
};
/* Using other factors. */
/* Using flow entry importance. */
/* Using flow entry lifetime. */
/* Eviction table mod Property. Mostly used in OFPMP_TABLE_DESC replies. */
struct ofp_table_mod_prop_eviction {
uint16_t
type;
/* OFPTMPT_EVICTION. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
flags;
/* Bitmap of OFPTMPEF_* flags */
};
OFP_ASSERT(sizeof(struct ofp_table_mod_prop_eviction) == 8);
/* Vacancy table mod property */
struct ofp_table_mod_prop_vacancy {
uint16_t
type;
/* OFPTMPT_VACANCY. */
uint16_t
length; /* Length in bytes of this property. */
uint8_t vacancy_down;
/* Vacancy threshold when space decreases (%). */
uint8_t vacancy_up;
/* Vacancy threshold when space increases (%). */
uint8_t vacancy;
/* Current vacancy (%) - only in ofp_table_desc. */
uint8_t pad[1];
/* Align to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_table_mod_prop_vacancy) == 8);
/* Experimenter table mod property */
struct ofp_table_mod_prop_experimenter {
uint16_t
type;
/* OFPTMPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_table_mod_prop_experimenter) == 12);
/* Configure/Modify behavior of a flow table */
struct ofp_table_mod {
struct ofp_header header;
uint8_t table_id;
/* ID of the table, OFPTT_ALL indicates all tables */
uint8_t pad[3];
/* Pad to 32 bits */
uint32_t config;
/* Bitmap of OFPTC_* flags */
/* Table Mod Property list */
struct ofp_table_mod_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_table_mod) == 16);
/* Capabilities supported
enum ofp_capabilities {
OFPC_FLOW_STATS
=
OFPC_TABLE_STATS
=
OFPC_PORT_STATS
=
by the datapath. */
1 << 0,
1 << 1,
1 << 2,
/* Flow statistics. */
/* Table statistics. */
/* Port statistics. */
143
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPC_GROUP_STATS
OFPC_IP_REASM
OFPC_QUEUE_STATS
OFPC_PORT_BLOCKED
=
=
=
=
1
1
1
1
<<
<<
<<
<<
3,
5,
6,
8
/*
/*
/*
/*
Group statistics.
Can reassemble IP
Queue statistics.
Switch will block
Version 1.4.0
*/
fragments. */
*/
looping ports. */
};
/* Flags to indicate behavior of the physical port. These flags are
* used in ofp_port to describe the current configuration. They are
* used in the ofp_port_mod message to configure the port’s behavior.
*/
enum ofp_port_config {
OFPPC_PORT_DOWN
= 1 << 0, /* Port is administratively down. */
OFPPC_NO_RECV
= 1 << 2,
OFPPC_NO_FWD
= 1 << 5,
OFPPC_NO_PACKET_IN = 1 << 6
/* Drop all packets received by port. */
/* Drop packets forwarded to port. */
/* Do not send packet-in msgs for port. */
};
/* Current state of the physical port. These are not configurable from
* the controller.
*/
enum ofp_port_state {
OFPPS_LINK_DOWN
= 1 << 0, /* No physical link present. */
OFPPS_BLOCKED
= 1 << 1, /* Port is blocked */
OFPPS_LIVE
= 1 << 2, /* Live for Fast Failover Group. */
};
/* Features of ports available in a datapath. */
enum ofp_port_features {
OFPPF_10MB_HD
= 1 << 0, /* 10 Mb half-duplex rate support. */
OFPPF_10MB_FD
= 1 << 1, /* 10 Mb full-duplex rate support. */
OFPPF_100MB_HD
= 1 << 2, /* 100 Mb half-duplex rate support. */
OFPPF_100MB_FD
= 1 << 3, /* 100 Mb full-duplex rate support. */
OFPPF_1GB_HD
= 1 << 4, /* 1 Gb half-duplex rate support. */
OFPPF_1GB_FD
= 1 << 5, /* 1 Gb full-duplex rate support. */
OFPPF_10GB_FD
= 1 << 6, /* 10 Gb full-duplex rate support. */
OFPPF_40GB_FD
= 1 << 7, /* 40 Gb full-duplex rate support. */
OFPPF_100GB_FD
= 1 << 8, /* 100 Gb full-duplex rate support. */
OFPPF_1TB_FD
= 1 << 9, /* 1 Tb full-duplex rate support. */
OFPPF_OTHER
= 1 << 10, /* Other rate, not in the list. */
OFPPF_COPPER
OFPPF_FIBER
OFPPF_AUTONEG
OFPPF_PAUSE
OFPPF_PAUSE_ASYM
=
=
=
=
=
1
1
1
1
1
<<
<<
<<
<<
<<
11,
12,
13,
14,
15
/*
/*
/*
/*
/*
Copper medium. */
Fiber medium. */
Auto-negotiation. */
Pause. */
Asymmetric pause. */
};
/* Port description property types.
*/
enum ofp_port_desc_prop_type {
OFPPDPT_ETHERNET
= 0,
/* Ethernet property. */
OFPPDPT_OPTICAL
= 1,
/* Optical property. */
OFPPDPT_EXPERIMENTER
= 0xFFFF, /* Experimenter property. */
};
/* Common header for all port description properties. */
struct ofp_port_desc_prop_header {
uint16_t
type;
/* One of OFPPDPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_port_desc_prop_header) == 4);
/* Ethernet port description property. */
struct ofp_port_desc_prop_ethernet {
uint16_t
type;
/* OFPPDPT_ETHERNET. */
uint16_t
length; /* Length in bytes of this property. */
uint8_t
pad[4]; /* Align to 64 bits. */
/* Bitmaps of OFPPF_* that describe features. All bits zeroed if
* unsupported or unavailable. */
uint32_t curr;
/* Current features. */
uint32_t advertised;
/* Features being advertised by the port. */
uint32_t supported;
/* Features supported by the port. */
uint32_t peer;
/* Features advertised by peer. */
uint32_t curr_speed;
uint32_t max_speed;
/* Current port bitrate in kbps. */
/* Max port bitrate in kbps */
};
OFP_ASSERT(sizeof(struct ofp_port_desc_prop_ethernet) == 32);
/* Features of optical ports available in switch. */
enum ofp_optical_port_features {
OFPOPF_RX_TUNE
= 1 << 0, /* Receiver is tunable */
OFPOPF_TX_TUNE
= 1 << 1, /* Transmit is tunable */
OFPOPF_TX_PWR
= 1 << 2, /* Power is configurable */
OFPOPF_USE_FREQ = 1 << 3, /* Use Frequency, not wavelength */
};
/* Optical port description property. */
struct ofp_port_desc_prop_optical {
144
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
uint16_t
uint16_t
uint8_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint16_t
uint16_t
type;
length;
pad[4];
Version 1.4.0
/* OFPPDPT_3OPTICAL. */
/* Length in bytes of this property. */
/* Align to 64 bits. */
supported;
/* Features supported by the port. */
tx_min_freq_lmda;
/* Minimum TX Frequency/Wavelength */
tx_max_freq_lmda;
/* Maximum TX Frequency/Wavelength */
tx_grid_freq_lmda; /* TX Grid Spacing Frequency/Wavelength */
rx_min_freq_lmda;
/* Minimum RX Frequency/Wavelength */
rx_max_freq_lmda;
/* Maximum RX Frequency/Wavelength */
rx_grid_freq_lmda; /* RX Grid Spacing Frequency/Wavelength */
tx_pwr_min;
/* Minimum TX power */
tx_pwr_max;
/* Maximum TX power */
};
OFP_ASSERT(sizeof(struct ofp_port_desc_prop_optical) == 40);
/* Experimenter port description property. */
struct ofp_port_desc_prop_experimenter {
uint16_t
type;
/* OFPPDPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_port_desc_prop_experimenter) == 12);
/* Description of a port */
struct ofp_port {
uint32_t port_no;
uint16_t length;
uint8_t pad[2];
uint8_t hw_addr[OFP_ETH_ALEN];
uint8_t pad2[2];
/* Align to 64 bits. */
char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
uint32_t config;
uint32_t state;
/* Bitmap of OFPPC_* flags. */
/* Bitmap of OFPPS_* flags. */
/* Port description property list - 0 or more properties */
struct ofp_port_desc_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_port) == 40);
/* Switch features. */
struct ofp_switch_features {
struct ofp_header header;
uint64_t datapath_id;
/* Datapath unique ID. The lower 48-bits are for
a MAC address, while the upper 16-bits are
implementer-defined. */
uint32_t n_buffers;
/* Max packets buffered at once. */
uint8_t n_tables;
uint8_t auxiliary_id;
uint8_t pad[2];
/* Number of tables supported by datapath. */
/* Identify auxiliary connections */
/* Align to 64-bits. */
/* Features. */
uint32_t capabilities;
uint32_t reserved;
/* Bitmap of support "ofp_capabilities". */
};
OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
/* What changed about the physical port */
enum ofp_port_reason {
OFPPR_ADD
= 0,
/* The port was added. */
OFPPR_DELETE = 1,
/* The port was removed. */
OFPPR_MODIFY = 2,
/* Some attribute of the port has changed. */
};
/* A physical port has changed in the datapath */
struct ofp_port_status {
struct ofp_header header;
uint8_t reason;
/* One of OFPPR_*. */
uint8_t pad[7];
/* Align to 64-bits. */
struct ofp_port desc;
};
OFP_ASSERT(sizeof(struct ofp_port_status) == 56);
/* Port mod property types.
*/
enum ofp_port_mod_prop_type {
OFPPMPT_ETHERNET
= 0,
/* Ethernet property. */
OFPPMPT_OPTICAL
= 1,
/* Optical property. */
OFPPMPT_EXPERIMENTER
= 0xFFFF, /* Experimenter property. */
145
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
};
/* Common header for all port mod properties. */
struct ofp_port_mod_prop_header {
uint16_t
type;
/* One of OFPPMPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_port_mod_prop_header) == 4);
/* Ethernet port mod property. */
struct ofp_port_mod_prop_ethernet {
uint16_t
type;
/* OFPPMPT_ETHERNET. */
uint16_t
length;
/* Length in bytes of this property. */
uint32_t
advertise; /* Bitmap of OFPPF_*. Zero all bits to prevent
any action taking place. */
};
OFP_ASSERT(sizeof(struct ofp_port_mod_prop_ethernet) == 8);
struct ofp_port_mod_prop_optical {
uint16_t
type;
/* OFPPMPT_OPTICAL. */
uint16_t
length;
/* Length in bytes of this property. */
uint32_t
configure; /* Bitmap of OFPOPF_*. */
uint32_t
freq_lmda; /* The "center" frequency */
int32_t
fl_offset; /* signed frequency offset */
uint32_t
grid_span; /* The size of the grid for this port */
uint32_t
tx_pwr;
/* tx power setting */
};
OFP_ASSERT(sizeof(struct ofp_port_mod_prop_optical) == 24);
/* Experimenter port mod property. */
struct ofp_port_mod_prop_experimenter {
uint16_t
type;
/* OFPPMPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_port_mod_prop_experimenter) == 12);
/* Modify behavior of the physical port */
struct ofp_port_mod {
struct ofp_header header;
uint32_t port_no;
uint8_t pad[4];
uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
configurable. This is used to
sanity-check the request, so it must
be the same as returned in an
ofp_port struct. */
uint8_t pad2[2];
/* Pad to 64 bits. */
uint32_t config;
/* Bitmap of OFPPC_* flags. */
uint32_t mask;
/* Bitmap of OFPPC_* flags to be changed. */
/* Port mod property list - 0 or more properties */
struct ofp_port_mod_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_port_mod) == 32);
/* ## -------------------------- ## */
/* ## OpenFlow Extensible Match. ## */
/* ## -------------------------- ## */
/* The match type indicates the match structure (set of fields that compose the
* match) in use. The match type is placed in the type field at the beginning
* of all match structures. The "OpenFlow Extensible Match" type corresponds
* to OXM TLV format described below and must be supported by all OpenFlow
* switches. Extensions that define other match types may be published on the
* ONF wiki. Support for extensions is optional.
*/
enum ofp_match_type {
OFPMT_STANDARD = 0,
/* Deprecated. */
OFPMT_OXM
= 1,
/* OpenFlow Extensible Match */
};
/* Fields to match against flows */
struct ofp_match {
uint16_t type;
/* One of OFPMT_* */
uint16_t length;
/* Length of ofp_match (excluding padding) */
/* Followed by:
*
- Exactly (length - 4) (possibly 0) bytes containing OXM TLVs, then
*
- Exactly ((length + 7)/8*8 - length) (between 0 and 7) bytes of
*
all-zero bytes
* In summary, ofp_match is padded as needed, to make its overall size
* a multiple of 8, to preserve alignement in structures using it.
146
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
*/
uint8_t oxm_fields[0];
uint8_t pad[4];
Version 1.4.0
/* 0 or more OXM match fields */
/* Zero bytes - see above for sizing */
};
OFP_ASSERT(sizeof(struct ofp_match) == 8);
/* Components of a OXM TLV header. */
#define OXM_HEADER__(CLASS, FIELD, HASMASK, LENGTH) \
(((CLASS) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
#define OXM_HEADER(CLASS, FIELD, LENGTH) \
OXM_HEADER__(CLASS, FIELD, 0, LENGTH)
#define OXM_HEADER_W(CLASS, FIELD, LENGTH) \
OXM_HEADER__(CLASS, FIELD, 1, (LENGTH) * 2)
#define OXM_CLASS(HEADER) ((HEADER) >> 16)
#define OXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
#define OXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
#define OXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
#define OXM_LENGTH(HEADER) ((HEADER) & 0xff)
#define OXM_MAKE_WILD_HEADER(HEADER) \
OXM_HEADER_W(OXM_CLASS(HEADER), OXM_FIELD(HEADER), OXM_LENGTH(HEADER))
/* OXM Class IDs.
* The high order bit differentiate reserved classes from member classes.
* Classes 0x0000 to 0x7FFF are member classes, allocated by ONF.
* Classes 0x8000 to 0xFFFE are reserved classes, reserved for standardisation.
*/
enum ofp_oxm_class {
OFPXMC_NXM_0
= 0x0000,
/* Backward compatibility with NXM */
OFPXMC_NXM_1
= 0x0001,
/* Backward compatibility with NXM */
OFPXMC_OPENFLOW_BASIC = 0x8000,
/* Basic class for OpenFlow */
OFPXMC_EXPERIMENTER
= 0xFFFF,
/* Experimenter class */
};
/* OXM Flow match field types
enum oxm_ofb_match_fields {
OFPXMT_OFB_IN_PORT
OFPXMT_OFB_IN_PHY_PORT
OFPXMT_OFB_METADATA
OFPXMT_OFB_ETH_DST
OFPXMT_OFB_ETH_SRC
OFPXMT_OFB_ETH_TYPE
OFPXMT_OFB_VLAN_VID
OFPXMT_OFB_VLAN_PCP
OFPXMT_OFB_IP_DSCP
OFPXMT_OFB_IP_ECN
OFPXMT_OFB_IP_PROTO
OFPXMT_OFB_IPV4_SRC
OFPXMT_OFB_IPV4_DST
OFPXMT_OFB_TCP_SRC
OFPXMT_OFB_TCP_DST
OFPXMT_OFB_UDP_SRC
OFPXMT_OFB_UDP_DST
OFPXMT_OFB_SCTP_SRC
OFPXMT_OFB_SCTP_DST
OFPXMT_OFB_ICMPV4_TYPE
OFPXMT_OFB_ICMPV4_CODE
OFPXMT_OFB_ARP_OP
OFPXMT_OFB_ARP_SPA
OFPXMT_OFB_ARP_TPA
OFPXMT_OFB_ARP_SHA
OFPXMT_OFB_ARP_THA
OFPXMT_OFB_IPV6_SRC
OFPXMT_OFB_IPV6_DST
OFPXMT_OFB_IPV6_FLABEL
OFPXMT_OFB_ICMPV6_TYPE
OFPXMT_OFB_ICMPV6_CODE
OFPXMT_OFB_IPV6_ND_TARGET
OFPXMT_OFB_IPV6_ND_SLL
OFPXMT_OFB_IPV6_ND_TLL
OFPXMT_OFB_MPLS_LABEL
OFPXMT_OFB_MPLS_TC
OFPXMT_OFP_MPLS_BOS
OFPXMT_OFB_PBB_ISID
OFPXMT_OFB_TUNNEL_ID
OFPXMT_OFB_IPV6_EXTHDR
OFPXMT_OFB_PBB_UCA
};
#define OFPXMT_OFB_ALL
for OpenFlow basic class. */
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
0,
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,
41,
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
Switch input port. */
Switch physical input port. */
Metadata passed between tables. */
Ethernet destination address. */
Ethernet source address. */
Ethernet frame type. */
VLAN id. */
VLAN priority. */
IP DSCP (6 bits in ToS field). */
IP ECN (2 bits in ToS field). */
IP protocol. */
IPv4 source address. */
IPv4 destination address. */
TCP source port. */
TCP destination port. */
UDP source port. */
UDP destination port. */
SCTP source port. */
SCTP destination port. */
ICMP type. */
ICMP code. */
ARP opcode. */
ARP source IPv4 address. */
ARP target IPv4 address. */
ARP source hardware address. */
ARP target hardware address. */
IPv6 source address. */
IPv6 destination address. */
IPv6 Flow Label */
ICMPv6 type. */
ICMPv6 code. */
Target address for ND. */
Source link-layer for ND. */
Target link-layer for ND. */
MPLS label. */
MPLS TC. */
MPLS BoS bit. */
PBB I-SID. */
Logical Port Metadata. */
IPv6 Extension Header pseudo-field */
PBB UCA header field. */
((UINT64_C(1) << 42) - 1)
/* OpenFlow port on which the packet was received.
* May be a physical port, a logical port, or the reserved port OFPP_LOCAL
*
* Prereqs: None.
*
* Format: 32-bit integer in network byte order.
*
* Masking: Not maskable. */
#define OXM_OF_IN_PORT
OXM_HEADER (0x8000, OFPXMT_OFB_IN_PORT, 4)
147
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Physical port on which the packet was received.
*
* Consider a packet received on a tunnel interface defined over a link
* aggregation group (LAG) with two physical port members. If the tunnel
* interface is the logical port bound to OpenFlow. In this case,
* OFPXMT_OF_IN_PORT is the tunnel’s port number and OFPXMT_OF_IN_PHY_PORT is
* the physical port number of the LAG on which the tunnel is configured.
*
* When a packet is received directly on a physical port and not processed by a
* logical port, OFPXMT_OF_IN_PORT and OFPXMT_OF_IN_PHY_PORT have the same
* value.
*
* This field is usually not available in a regular match and only available
* in ofp_packet_in messages when it’s different from OXM_OF_IN_PORT.
*
* Prereqs: OXM_OF_IN_PORT must be present.
*
* Format: 32-bit integer in network byte order.
*
* Masking: Not maskable. */
#define OXM_OF_IN_PHY_PORT OXM_HEADER (0x8000, OFPXMT_OFB_IN_PHY_PORT, 4)
/* Table metadata.
*
* Prereqs: None.
*
* Format: 64-bit integer in network byte order.
*
* Masking: Arbitrary masks.
*/
#define OXM_OF_METADATA
OXM_HEADER (0x8000, OFPXMT_OFB_METADATA, 8)
#define OXM_OF_METADATA_W OXM_HEADER_W(0x8000, OFPXMT_OFB_METADATA, 8)
/* Source or destination address in Ethernet header.
*
* Prereqs: None.
*
* Format: 48-bit Ethernet MAC address.
*
* Masking: Arbitrary masks. */
#define OXM_OF_ETH_DST
OXM_HEADER (0x8000, OFPXMT_OFB_ETH_DST,
#define OXM_OF_ETH_DST_W OXM_HEADER_W(0x8000, OFPXMT_OFB_ETH_DST,
#define OXM_OF_ETH_SRC
OXM_HEADER (0x8000, OFPXMT_OFB_ETH_SRC,
#define OXM_OF_ETH_SRC_W OXM_HEADER_W(0x8000, OFPXMT_OFB_ETH_SRC,
6)
6)
6)
6)
/* Packet’s Ethernet type.
*
* Prereqs: None.
*
* Format: 16-bit integer in network byte order.
*
* Masking: Not maskable. */
#define OXM_OF_ETH_TYPE
OXM_HEADER (0x8000, OFPXMT_OFB_ETH_TYPE, 2)
/* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
* special conditions.
*/
enum ofp_vlan_id {
OFPVID_PRESENT = 0x1000, /* Bit that indicate that a VLAN id is set */
OFPVID_NONE
= 0x0000, /* No VLAN id was set. */
};
/* Define for compatibility */
#define OFP_VLAN_NONE
OFPVID_NONE
/*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
802.1Q VID.
For a packet with an 802.1Q header, this is the VLAN-ID (VID) from the
outermost tag, with the CFI bit forced to 1. For a packet with no 802.1Q
header, this has value OFPVID_NONE.
Prereqs: None.
Format: 16-bit integer in network byte order with bit 13 indicating
presence of VLAN header and 3 most-significant bits forced to 0.
Only the lower 13 bits have meaning.
Masking: Arbitrary masks.
This field can be used in various ways:
- If it is not constrained at all, the nx_match matches packets without
an 802.1Q header or with an 802.1Q header that has any VID value.
- Testing for an exact match with 0x0 matches only packets without
an 802.1Q header.
- Testing for an exact match with a VID value with CFI=1 matches packets
that have an 802.1Q header with a specified VID.
148
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
*
- Testing for an exact match with a nonzero VID value with CFI=0 does
*
not make sense. The switch may reject this combination.
*
*
- Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
*
header or with an 802.1Q header with a VID of 0.
*
*
- Testing with nxm_value=0x1000, nxm_mask=0x1000 matches packets with
*
an 802.1Q header that has any VID value.
*/
#define OXM_OF_VLAN_VID
OXM_HEADER (0x8000, OFPXMT_OFB_VLAN_VID, 2)
#define OXM_OF_VLAN_VID_W OXM_HEADER_W(0x8000, OFPXMT_OFB_VLAN_VID, 2)
/* 802.1Q PCP.
*
* For a packet with an 802.1Q header, this is the VLAN-PCP from the
* outermost tag. For a packet with no 802.1Q header, this has value
* 0.
*
* Prereqs: OXM_OF_VLAN_VID must be different from OFPVID_NONE.
*
* Format: 8-bit integer with 5 most-significant bits forced to 0.
* Only the lower 3 bits have meaning.
*
* Masking: Not maskable.
*/
#define OXM_OF_VLAN_PCP
OXM_HEADER (0x8000, OFPXMT_OFB_VLAN_PCP, 1)
/* The Diff Serv Code Point (DSCP) bits of the IP header.
* Part of the IPv4 ToS field or the IPv6 Traffic Class field.
*
* Prereqs: OXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
*
* Format: 8-bit integer with 2 most-significant bits forced to 0.
* Only the lower 6 bits have meaning.
*
* Masking: Not maskable. */
#define OXM_OF_IP_DSCP
OXM_HEADER (0x8000, OFPXMT_OFB_IP_DSCP, 1)
/* The ECN bits of the IP header.
* Part of the IPv4 ToS field or the IPv6 Traffic Class field.
*
* Prereqs: OXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
*
* Format: 8-bit integer with 6 most-significant bits forced to 0.
* Only the lower 2 bits have meaning.
*
* Masking: Not maskable. */
#define OXM_OF_IP_ECN
OXM_HEADER (0x8000, OFPXMT_OFB_IP_ECN, 1)
/* The "protocol" byte in the IP header.
*
* Prereqs: OXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
*
* Format: 8-bit integer.
*
* Masking: Not maskable. */
#define OXM_OF_IP_PROTO
OXM_HEADER (0x8000, OFPXMT_OFB_IP_PROTO, 1)
/* The source or destination address in the IP header.
*
* Prereqs: OXM_OF_ETH_TYPE must match 0x0800 exactly.
*
* Format: 32-bit integer in network byte order.
*
* Masking: Arbitrary masks.
*/
#define OXM_OF_IPV4_SRC
OXM_HEADER (0x8000, OFPXMT_OFB_IPV4_SRC,
#define OXM_OF_IPV4_SRC_W
OXM_HEADER_W(0x8000, OFPXMT_OFB_IPV4_SRC,
#define OXM_OF_IPV4_DST
OXM_HEADER (0x8000, OFPXMT_OFB_IPV4_DST,
#define OXM_OF_IPV4_DST_W
OXM_HEADER_W(0x8000, OFPXMT_OFB_IPV4_DST,
4)
4)
4)
4)
/* The source or destination port in the TCP header.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
*
OXM_OF_IP_PROTO must match 6 exactly.
*
* Format: 16-bit integer in network byte order.
*
* Masking: Not maskable. */
#define OXM_OF_TCP_SRC
OXM_HEADER (0x8000, OFPXMT_OFB_TCP_SRC, 2)
#define OXM_OF_TCP_DST
OXM_HEADER (0x8000, OFPXMT_OFB_TCP_DST, 2)
/* The source or destination port in the UDP header.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
*
OXM_OF_IP_PROTO must match 17 exactly.
*
* Format: 16-bit integer in network byte order.
149
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
*
* Masking: Not maskable. */
#define OXM_OF_UDP_SRC
OXM_HEADER
#define OXM_OF_UDP_DST
OXM_HEADER
Version 1.4.0
(0x8000, OFPXMT_OFB_UDP_SRC, 2)
(0x8000, OFPXMT_OFB_UDP_DST, 2)
/* The source or destination port in the SCTP header.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
*
OXM_OF_IP_PROTO must match 132 exactly.
*
* Format: 16-bit integer in network byte order.
*
* Masking: Not maskable. */
#define OXM_OF_SCTP_SRC
OXM_HEADER (0x8000, OFPXMT_OFB_SCTP_SRC, 2)
#define OXM_OF_SCTP_DST
OXM_HEADER (0x8000, OFPXMT_OFB_SCTP_DST, 2)
/* The type or code in the ICMP header.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match 0x0800 exactly.
*
OXM_OF_IP_PROTO must match 1 exactly.
*
* Format: 8-bit integer.
*
* Masking: Not maskable. */
#define OXM_OF_ICMPV4_TYPE OXM_HEADER (0x8000, OFPXMT_OFB_ICMPV4_TYPE, 1)
#define OXM_OF_ICMPV4_CODE OXM_HEADER (0x8000, OFPXMT_OFB_ICMPV4_CODE, 1)
/* ARP opcode.
*
* For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
* otherwise.
*
* Prereqs: OXM_OF_ETH_TYPE must match 0x0806 exactly.
*
* Format: 16-bit integer in network byte order.
*
* Masking: Not maskable. */
#define OXM_OF_ARP_OP
OXM_HEADER (0x8000, OFPXMT_OFB_ARP_OP, 2)
/* For an Ethernet+IP ARP packet, the source or target protocol address
* in the ARP header. Always 0 otherwise.
*
* Prereqs: OXM_OF_ETH_TYPE must match 0x0806 exactly.
*
* Format: 32-bit integer in network byte order.
*
* Masking: Arbitrary masks.
*/
#define OXM_OF_ARP_SPA
OXM_HEADER (0x8000, OFPXMT_OFB_ARP_SPA, 4)
#define OXM_OF_ARP_SPA_W OXM_HEADER_W(0x8000, OFPXMT_OFB_ARP_SPA, 4)
#define OXM_OF_ARP_TPA
OXM_HEADER (0x8000, OFPXMT_OFB_ARP_TPA, 4)
#define OXM_OF_ARP_TPA_W OXM_HEADER_W(0x8000, OFPXMT_OFB_ARP_TPA, 4)
/* For an Ethernet+IP ARP packet, the source or target hardware address
* in the ARP header. Always 0 otherwise.
*
* Prereqs: OXM_OF_ETH_TYPE must match 0x0806 exactly.
*
* Format: 48-bit Ethernet MAC address.
*
* Masking: Not maskable. */
#define OXM_OF_ARP_SHA
OXM_HEADER (0x8000, OFPXMT_OFB_ARP_SHA, 6)
#define OXM_OF_ARP_THA
OXM_HEADER (0x8000, OFPXMT_OFB_ARP_THA, 6)
/* The source or destination address in the IPv6 header.
*
* Prereqs: OXM_OF_ETH_TYPE must match 0x86dd exactly.
*
* Format: 128-bit IPv6 address.
*
* Masking: Arbitrary masks.
*/
#define OXM_OF_IPV6_SRC
OXM_HEADER (0x8000, OFPXMT_OFB_IPV6_SRC,
#define OXM_OF_IPV6_SRC_W OXM_HEADER_W(0x8000, OFPXMT_OFB_IPV6_SRC,
#define OXM_OF_IPV6_DST
OXM_HEADER (0x8000, OFPXMT_OFB_IPV6_DST,
#define OXM_OF_IPV6_DST_W OXM_HEADER_W(0x8000, OFPXMT_OFB_IPV6_DST,
16)
16)
16)
16)
/* The IPv6 Flow Label
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match 0x86dd exactly
*
* Format: 32-bit integer with 12 most-significant bits forced to 0.
* Only the lower 20 bits have meaning.
*
* Masking: Maskable. */
#define OXM_OF_IPV6_FLABEL
OXM_HEADER (0x8000, OFPXMT_OFB_IPV6_FLABEL, 4)
150
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* The type or code in the ICMPv6 header.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match 0x86dd exactly.
*
OXM_OF_IP_PROTO must match 58 exactly.
*
* Format: 8-bit integer.
*
* Masking: Not maskable. */
#define OXM_OF_ICMPV6_TYPE OXM_HEADER (0x8000, OFPXMT_OFB_ICMPV6_TYPE, 1)
#define OXM_OF_ICMPV6_CODE OXM_HEADER (0x8000, OFPXMT_OFB_ICMPV6_CODE, 1)
/* The target address in an IPv6 Neighbor Discovery message.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match 0x86dd exactly.
*
OXM_OF_IP_PROTO must match 58 exactly.
*
OXM_OF_ICMPV6_TYPE must be either 135 or 136.
*
* Format: 128-bit IPv6 address.
*
* Masking: Not maskable. */
#define OXM_OF_IPV6_ND_TARGET OXM_HEADER (0x8000, OFPXMT_OFB_IPV6_ND_TARGET, 16)
/* The source link-layer address option in an IPv6 Neighbor Discovery
* message.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match 0x86dd exactly.
*
OXM_OF_IP_PROTO must match 58 exactly.
*
OXM_OF_ICMPV6_TYPE must be exactly 135.
*
* Format: 48-bit Ethernet MAC address.
*
* Masking: Not maskable. */
#define OXM_OF_IPV6_ND_SLL OXM_HEADER (0x8000, OFPXMT_OFB_IPV6_ND_SLL, 6)
/* The target link-layer address option in an IPv6 Neighbor Discovery
* message.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match 0x86dd exactly.
*
OXM_OF_IP_PROTO must match 58 exactly.
*
OXM_OF_ICMPV6_TYPE must be exactly 136.
*
* Format: 48-bit Ethernet MAC address.
*
* Masking: Not maskable. */
#define OXM_OF_IPV6_ND_TLL OXM_HEADER (0x8000, OFPXMT_OFB_IPV6_ND_TLL, 6)
/* The LABEL in the first
*
* Prereqs:
*
OXM_OF_ETH_TYPE must
*
* Format: 32-bit integer
* bits forced to 0. Only
*
* Masking: Not maskable.
#define OXM_OF_MPLS_LABEL
MPLS shim header.
match 0x8847 or 0x8848 exactly.
in network byte order with 12 most-significant
the lower 20 bits have meaning.
*/
OXM_HEADER
(0x8000, OFPXMT_OFB_MPLS_LABEL, 4)
/* The TC in the first MPLS shim header.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match 0x8847 or 0x8848 exactly.
*
* Format: 8-bit integer with 5 most-significant bits forced to 0.
* Only the lower 3 bits have meaning.
*
* Masking: Not maskable. */
#define OXM_OF_MPLS_TC
OXM_HEADER (0x8000, OFPXMT_OFB_MPLS_TC, 1)
/* The BoS bit in the first MPLS shim header.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match 0x8847 or 0x8848 exactly.
*
* Format: 8-bit integer with 7 most-significant bits forced to 0.
* Only the lowest bit have a meaning.
*
* Masking: Not maskable. */
#define OXM_OF_MPLS_BOS
OXM_HEADER (0x8000, OFPXMT_OFB_MPLS_BOS, 1)
/*
*
*
*
*
*
*
IEEE 802.1ah I-SID.
For a packet with a PBB header, this is the I-SID from the
outermost service tag.
Prereqs:
OXM_OF_ETH_TYPE must match 0x88E7 exactly.
151
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
*
* Format: 24-bit integer in network byte order.
*
* Masking: Arbitrary masks. */
#define OXM_OF_PBB_ISID
OXM_HEADER (0x8000, OFPXMT_OFB_PBB_ISID, 3)
#define OXM_OF_PBB_ISID_W OXM_HEADER_W(0x8000, OFPXMT_OFB_PBB_ISID, 3)
/* Logical Port Metadata.
*
* Metadata associated with a logical port.
* If the logical port performs encapsulation and decapsulation, this
* is the demultiplexing field from the encapsulation header.
* For example, for a packet received via GRE tunnel including a (32-bit) key,
* the key is stored in the low 32-bits and the high bits are zeroed.
* For a MPLS logical port, the low 20 bits represent the MPLS Label.
* For a VxLAN logical port, the low 24 bits represent the VNI.
* If the packet is not received through a logical port, the value is 0.
*
* Prereqs: None.
*
* Format: 64-bit integer in network byte order.
*
* Masking: Arbitrary masks. */
#define OXM_OF_TUNNEL_ID
OXM_HEADER (0x8000, OFPXMT_OFB_TUNNEL_ID, 8)
#define OXM_OF_TUNNEL_ID_W OXM_HEADER_W(0x8000, OFPXMT_OFB_TUNNEL_ID, 8)
/* The IPv6 Extension Header pseudo-field.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match 0x86dd exactly
*
* Format: 16-bit integer with 7 most-significant bits forced to 0.
* Only the lower 9 bits have meaning.
*
* Masking: Maskable. */
#define OXM_OF_IPV6_EXTHDR
OXM_HEADER (0x8000, OFPXMT_OFB_IPV6_EXTHDR, 2)
#define OXM_OF_IPV6_EXTHDR_W OXM_HEADER_W(0x8000, OFPXMT_OFB_IPV6_EXTHDR, 2)
/* Bit definitions for IPv6 Extension Header pseudo-field. */
enum ofp_ipv6exthdr_flags {
OFPIEH_NONEXT = 1 << 0,
/* "No next header" encountered. */
OFPIEH_ESP
= 1 << 1,
/* Encrypted Sec Payload header present. */
OFPIEH_AUTH
= 1 << 2,
/* Authentication header present. */
OFPIEH_DEST
= 1 << 3,
/* 1 or 2 dest headers present. */
OFPIEH_FRAG
= 1 << 4,
/* Fragment header present. */
OFPIEH_ROUTER = 1 << 5,
/* Router header present. */
OFPIEH_HOP
= 1 << 6,
/* Hop-by-hop header present. */
OFPIEH_UNREP = 1 << 7,
/* Unexpected repeats encountered. */
OFPIEH_UNSEQ = 1 << 8,
/* Unexpected sequencing encountered. */
};
/* IEEE 802.1ah UCA.
*
* For a packet with a PBB header, this is the UCA (Use Customer Address)
* from the outermost service tag.
*
* Prereqs:
*
OXM_OF_ETH_TYPE must match 0x88E7 exactly.
*
* Format: 8-bit integer with 7 most-significant bits forced to 0.
* Only the lower 1 bit has meaning.
*
* Masking: Not maskable. */
#define OXM_OF_PBB_UCA
OXM_HEADER (0x8000, OFPXMT_OFB_PBB_UCA, 1)
/* Header for OXM experimenter match fields. */
struct ofp_oxm_experimenter_header {
uint32_t oxm_header;
/* oxm_class = OFPXMC_EXPERIMENTER */
uint32_t experimenter;
/* Experimenter ID. */
};
OFP_ASSERT(sizeof(struct ofp_oxm_experimenter_header) == 8);
/* ## ----------------- ## */
/* ## OpenFlow Actions. ## */
/* ## ----------------- ## */
enum ofp_action_type {
OFPAT_OUTPUT
= 0, /* Output to switch port. */
OFPAT_COPY_TTL_OUT = 11, /* Copy TTL "outwards" -- from next-to-outermost
to outermost */
OFPAT_COPY_TTL_IN = 12, /* Copy TTL "inwards" -- from outermost to
next-to-outermost */
OFPAT_SET_MPLS_TTL = 15, /* MPLS TTL */
OFPAT_DEC_MPLS_TTL = 16, /* Decrement MPLS TTL */
OFPAT_PUSH_VLAN
OFPAT_POP_VLAN
OFPAT_PUSH_MPLS
OFPAT_POP_MPLS
OFPAT_SET_QUEUE
=
=
=
=
=
17,
18,
19,
20,
21,
/*
/*
/*
/*
/*
Push a new VLAN tag */
Pop the outer VLAN tag */
Push a new MPLS tag */
Pop the outer MPLS tag */
Set queue id when outputting to a port */
152
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPAT_GROUP
OFPAT_SET_NW_TTL
OFPAT_DEC_NW_TTL
OFPAT_SET_FIELD
OFPAT_PUSH_PBB
OFPAT_POP_PBB
OFPAT_EXPERIMENTER
=
=
=
=
=
=
=
22, /*
23, /*
24, /*
25, /*
26, /*
27, /*
0xffff
Version 1.4.0
Apply group. */
IP TTL. */
Decrement IP TTL. */
Set a header field using OXM TLV format. */
Push a new PBB service tag (I-TAG) */
Pop the outer PBB service tag (I-TAG) */
};
/* Action header that is common to all actions. The length includes the
* header and any padding used to make the action 64-bit aligned.
* NB: The length of an action *must* always be a multiple of eight. */
struct ofp_action_header {
uint16_t type;
/* One of OFPAT_*. */
uint16_t len;
/* Length of action, including this
header. This is the length of action,
including any padding to make it
64-bit aligned. */
};
OFP_ASSERT(sizeof(struct ofp_action_header) == 4);
enum ofp_controller_max_len {
OFPCML_MAX
= 0xffe5, /* maximum max_len value which can be
to request a specific byte length.
OFPCML_NO_BUFFER = 0xffff /* indicates that no buffering should
applied and the whole packet is to
sent to the controller. */
};
used
*/
be
be
/* Action structure for OFPAT_OUTPUT, which sends packets out ’port’.
* When the ’port’ is the OFPP_CONTROLLER, ’max_len’ indicates the max
* number of bytes to send. A ’max_len’ of zero means no bytes of the
* packet should be sent. A ’max_len’ of OFPCML_NO_BUFFER means that
* the packet is not buffered and the complete packet is to be sent to
* the controller. */
struct ofp_action_output {
uint16_t type;
/* OFPAT_OUTPUT. */
uint16_t len;
/* Length is 16. */
uint32_t port;
/* Output port. */
uint16_t max_len;
/* Max length to send to controller. */
uint8_t pad[6];
/* Pad to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_action_output) == 16);
/* Action structure for OFPAT_COPY_TTL_OUT, OFPAT_COPY_TTL_IN,
* OFPAT_DEC_MPLS_TTL, OFPAT_DEC_NW_TTL, OFPAT_POP_VLAN and OFPAT_POP_PBB. */
struct ofp_action_generic {
uint16_t type;
/* One of OFPAT_*. */
uint16_t len;
/* Length is 8. */
uint8_t pad[4];
/* Pad to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_action_generic) == 8);
/* Action structure for OFPAT_SET_MPLS_TTL. */
struct ofp_action_mpls_ttl {
uint16_t type;
/* OFPAT_SET_MPLS_TTL. */
uint16_t len;
/* Length is 8. */
uint8_t mpls_ttl;
/* MPLS TTL */
uint8_t pad[3];
};
OFP_ASSERT(sizeof(struct ofp_action_mpls_ttl) == 8);
/* Action structure for OFPAT_PUSH_VLAN/MPLS/PBB. */
struct ofp_action_push {
uint16_t type;
/* OFPAT_PUSH_VLAN/MPLS/PBB. */
uint16_t len;
/* Length is 8. */
uint16_t ethertype;
/* Ethertype */
uint8_t pad[2];
};
OFP_ASSERT(sizeof(struct ofp_action_push) == 8);
/* Action structure for OFPAT_POP_MPLS. */
struct ofp_action_pop_mpls {
uint16_t type;
/* OFPAT_POP_MPLS. */
uint16_t len;
/* Length is 8. */
uint16_t ethertype;
/* Ethertype */
uint8_t pad[2];
};
OFP_ASSERT(sizeof(struct ofp_action_pop_mpls) == 8);
/* Action structure for OFPAT_SET_QUEUE. */
struct ofp_action_set_queue {
uint16_t type;
/* OFPAT_SET_QUEUE. */
uint16_t len;
/* Len is 8. */
uint32_t queue_id;
/* Queue id for the packets. */
};
OFP_ASSERT(sizeof(struct ofp_action_set_queue) == 8);
/* Action structure for OFPAT_GROUP. */
struct ofp_action_group {
153
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
uint16_t type;
uint16_t len;
uint32_t group_id;
Version 1.4.0
/* OFPAT_GROUP. */
/* Length is 8. */
/* Group identifier. */
};
OFP_ASSERT(sizeof(struct ofp_action_group) == 8);
/* Action structure for OFPAT_SET_NW_TTL. */
struct ofp_action_nw_ttl {
uint16_t type;
/* OFPAT_SET_NW_TTL. */
uint16_t len;
/* Length is 8. */
uint8_t nw_ttl;
/* IP TTL */
uint8_t pad[3];
};
OFP_ASSERT(sizeof(struct ofp_action_nw_ttl) == 8);
/* Action structure for OFPAT_SET_FIELD. */
struct ofp_action_set_field {
uint16_t type;
/* OFPAT_SET_FIELD. */
uint16_t len;
/* Length is padded to 64 bits. */
/* Followed by:
*
- Exactly oxm_len bytes containing a single OXM TLV, then
*
- Exactly ((oxm_len + 4) + 7)/8*8 - (oxm_len + 4) (between 0 and 7)
*
bytes of all-zero bytes
*/
uint8_t field[4];
/* OXM TLV - Make compiler happy */
};
OFP_ASSERT(sizeof(struct ofp_action_set_field) == 8);
/* Action header for OFPAT_EXPERIMENTER.
* The rest of the body is experimenter-defined. */
struct ofp_action_experimenter_header {
uint16_t type;
/* OFPAT_EXPERIMENTER. */
uint16_t len;
/* Length is a multiple of 8. */
uint32_t experimenter;
/* Experimenter ID. */
};
OFP_ASSERT(sizeof(struct ofp_action_experimenter_header) == 8);
/* ## ---------------------- ## */
/* ## OpenFlow Instructions. ## */
/* ## ---------------------- ## */
enum ofp_instruction_type {
OFPIT_GOTO_TABLE = 1,
OFPIT_WRITE_METADATA = 2,
OFPIT_WRITE_ACTIONS = 3,
OFPIT_APPLY_ACTIONS = 4,
OFPIT_CLEAR_ACTIONS = 5,
OFPIT_METER = 6,
OFPIT_EXPERIMENTER = 0xFFFF
/* Setup the next table in the lookup
pipeline */
/* Setup the metadata field for use later in
pipeline */
/* Write the action(s) onto the datapath action
set */
/* Applies the action(s) immediately */
/* Clears all actions from the datapath
action set */
/* Apply meter (rate limiter) */
/* Experimenter instruction */
};
/* Instruction header that is common to all instructions. The length includes
* the header and any padding used to make the instruction 64-bit aligned.
* NB: The length of an instruction *must* always be a multiple of eight. */
struct ofp_instruction_header {
uint16_t type;
/* One of OFPIT_*. */
uint16_t len;
/* Length of this struct in bytes. */
};
OFP_ASSERT(sizeof(struct ofp_instruction_header) == 4);
/* Instruction structure for OFPIT_GOTO_TABLE */
struct ofp_instruction_goto_table {
uint16_t type;
/* OFPIT_GOTO_TABLE */
uint16_t len;
/* Length is 8. */
uint8_t table_id;
/* Set next table in the lookup pipeline */
uint8_t pad[3];
/* Pad to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_instruction_goto_table) == 8);
/* Instruction structure for OFPIT_WRITE_METADATA */
struct ofp_instruction_write_metadata {
uint16_t type;
/* OFPIT_WRITE_METADATA */
uint16_t len;
/* Length is 24. */
uint8_t pad[4];
/* Align to 64-bits */
uint64_t metadata;
/* Metadata value to write */
uint64_t metadata_mask;
/* Metadata write bitmask */
};
OFP_ASSERT(sizeof(struct ofp_instruction_write_metadata) == 24);
/* Instruction structure for OFPIT_WRITE/APPLY/CLEAR_ACTIONS */
struct ofp_instruction_actions {
uint16_t type;
/* One of OFPIT_*_ACTIONS */
uint16_t len;
/* Length is padded to 64 bits. */
uint8_t pad[4];
/* Align to 64-bits */
struct ofp_action_header actions[0]; /* 0 or more actions associated with
154
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
OFPIT_WRITE_ACTIONS and
OFPIT_APPLY_ACTIONS */
};
OFP_ASSERT(sizeof(struct ofp_instruction_actions) == 8);
/* Instruction structure for OFPIT_METER */
struct ofp_instruction_meter {
uint16_t type;
/* OFPIT_METER */
uint16_t len;
/* Length is 8. */
uint32_t meter_id;
/* Meter instance. */
};
OFP_ASSERT(sizeof(struct ofp_instruction_meter) == 8);
/* Instruction structure for experimental instructions */
struct ofp_instruction_experimenter_header {
uint16_t type;
/* OFPIT_EXPERIMENTER. */
uint16_t len;
/* Length is padded to 64 bits. */
uint32_t experimenter;
/* Experimenter ID. */
/* Experimenter-defined arbitrary additional data. */
};
OFP_ASSERT(sizeof(struct ofp_instruction_experimenter_header) == 8);
/* ## --------------------------- ## */
/* ## OpenFlow Flow Modification. ## */
/* ## --------------------------- ## */
enum ofp_flow_mod_command
OFPFC_ADD
=
OFPFC_MODIFY
=
OFPFC_MODIFY_STRICT =
{
0, /* New flow. */
1, /* Modify all matching flows. */
2, /* Modify entry strictly matching wildcards and
priority. */
OFPFC_DELETE
= 3, /* Delete all matching flows. */
OFPFC_DELETE_STRICT = 4, /* Delete entry strictly matching wildcards and
priority. */
};
/* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
* is permanent. */
#define OFP_FLOW_PERMANENT 0
/* By default, choose a priority in the middle. */
#define OFP_DEFAULT_PRIORITY 0x8000
enum ofp_flow_mod_flags {
OFPFF_SEND_FLOW_REM = 1 << 0,
OFPFF_CHECK_OVERLAP
OFPFF_RESET_COUNTS
OFPFF_NO_PKT_COUNTS
OFPFF_NO_BYT_COUNTS
=
=
=
=
1
1
1
1
<<
<<
<<
<<
1,
2,
3,
4,
/*
*
/*
/*
/*
/*
Send flow removed message when flow
expires or is deleted. */
Check for overlapping entries first. */
Reset flow packet and byte counts. */
Don’t keep track of packet count. */
Don’t keep track of byte count. */
};
/* Flow setup and teardown (controller -> datapath). */
struct ofp_flow_mod {
struct ofp_header header;
uint64_t cookie;
/* Opaque controller-issued identifier. */
uint64_t cookie_mask;
/* Mask used to restrict the cookie bits
that must match when the command is
OFPFC_MODIFY* or OFPFC_DELETE*. A value
of 0 indicates no restriction. */
/* Flow actions. */
uint8_t table_id;
/* ID of the table to put the flow in.
For OFPFC_DELETE_* commands, OFPTT_ALL
can also be used to delete matching
flows from all tables. */
uint8_t command;
/* One of OFPFC_*. */
uint16_t idle_timeout;
/* Idle time before discarding (seconds). */
uint16_t hard_timeout;
/* Max time before discarding (seconds). */
uint16_t priority;
/* Priority level of flow entry. */
uint32_t buffer_id;
/* Buffered packet to apply to, or
OFP_NO_BUFFER.
Not meaningful for OFPFC_DELETE*. */
uint32_t out_port;
/* For OFPFC_DELETE* commands, require
matching entries to include this as an
output port. A value of OFPP_ANY
indicates no restriction. */
uint32_t out_group;
/* For OFPFC_DELETE* commands, require
matching entries to include this as an
output group. A value of OFPG_ANY
indicates no restriction. */
uint16_t flags;
/* Bitmap of OFPFF_* flags. */
uint16_t importance;
/* Eviction precedence (optional). */
struct ofp_match match;
/* Fields to match. Variable size. */
/* The variable size and padded match is always followed by instructions. */
//struct ofp_instruction_header instructions[0];
/* Instruction set - 0 or more. The length
of the instruction set is inferred from
the length field in the header. */
};
155
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
OFP_ASSERT(sizeof(struct ofp_flow_mod) == 56);
/* Group numbering. Groups can use any number up to OFPG_MAX. */
enum ofp_group {
/* Last usable group number. */
OFPG_MAX
= 0xffffff00,
/* Fake groups. */
OFPG_ALL
= 0xfffffffc,
OFPG_ANY
= 0xffffffff
/* Represents all groups for group delete
commands. */
/* Wildcard group used only for flow stats
requests. Selects all flows regardless of
group (including flows with no group).
*/
};
/* Group commands */
enum ofp_group_mod_command {
OFPGC_ADD
= 0,
/* New group. */
OFPGC_MODIFY = 1,
/* Modify all matching groups. */
OFPGC_DELETE = 2,
/* Delete all matching groups. */
};
/* Bucket for use in groups. */
struct ofp_bucket {
uint16_t len;
uint16_t weight;
uint32_t watch_port;
uint32_t watch_group;
/* Length the bucket in bytes, including
this header and any padding to make it
64-bit aligned. */
/* Relative weight of bucket. Only
defined for select groups. */
/* Port whose state affects whether this
bucket is live. Only required for fast
failover groups. */
/* Group whose state affects whether this
bucket is live. Only required for fast
failover groups. */
uint8_t pad[4];
struct ofp_action_header actions[0]; /* 0 or more actions associated with
the bucket - The action list length
is inferred from the length
of the bucket. */
};
OFP_ASSERT(sizeof(struct ofp_bucket) == 16);
/* Group setup and teardown (controller -> datapath). */
struct ofp_group_mod {
struct ofp_header header;
uint16_t command;
/* One of OFPGC_*. */
uint8_t type;
/* One of OFPGT_*. */
uint8_t pad;
/* Pad to 64 bits. */
uint32_t group_id;
/* Group identifier. */
struct ofp_bucket buckets[0]; /* The length of the bucket array is inferred
from the length field in the header. */
};
OFP_ASSERT(sizeof(struct ofp_group_mod) == 16);
/* Group types. Values
* use. */
enum ofp_group_type {
OFPGT_ALL
= 0,
OFPGT_SELECT
= 1,
OFPGT_INDIRECT = 2,
OFPGT_FF
= 3,
};
in the range [128, 255] are reserved for experimental
/*
/*
/*
/*
All (multicast/broadcast) group.
Select group. */
Indirect group. */
Fast failover group. */
*/
/* Special buffer-id to indicate ’no buffer’ */
#define OFP_NO_BUFFER 0xffffffff
/* Send packet (controller -> datapath). */
struct ofp_packet_out {
struct ofp_header header;
uint32_t buffer_id;
/* ID assigned by datapath (OFP_NO_BUFFER
if none). */
uint32_t in_port;
/* Packet’s input port or OFPP_CONTROLLER. */
uint16_t actions_len;
/* Size of action array in bytes. */
uint8_t pad[6];
struct ofp_action_header actions[0]; /* Action list - 0 or more. */
/* The variable size action list is optionally followed by packet data.
* This data is only present and meaningful if buffer_id == -1. */
/* uint8_t data[0]; */
/* Packet data. The length is inferred
from the length field in the header. */
};
OFP_ASSERT(sizeof(struct ofp_packet_out) == 24);
/* Why is this packet being sent to the controller? */
enum ofp_packet_in_reason {
OFPR_TABLE_MISS
= 0,
/* No matching flow (table-miss flow entry). */
OFPR_APPLY_ACTION = 1,
/* Output to controller in apply-actions. */
OFPR_INVALID_TTL = 2,
/* Packet has invalid TTL */
OFPR_ACTION_SET
= 3,
/* Output to controller in action set. */
156
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPR_GROUP
OFPR_PACKET_OUT
= 4,
= 5,
Version 1.4.0
/* Output to controller in group bucket. */
/* Output to controller in packet-out. */
};
/* Packet received on port (datapath -> controller). */
struct ofp_packet_in {
struct ofp_header header;
uint32_t buffer_id;
/* ID assigned by datapath. */
uint16_t total_len;
/* Full length of frame. */
uint8_t reason;
/* Reason packet is being sent (one of OFPR_*) */
uint8_t table_id;
/* ID of the table that was looked up */
uint64_t cookie;
/* Cookie of the flow entry that was looked up. */
struct ofp_match match; /* Packet metadata. Variable size. */
/* The variable size and padded match is always followed by:
*
- Exactly 2 all-zero padding bytes, then
*
- An Ethernet frame whose length is inferred from header.length.
* The padding bytes preceding the Ethernet frame ensure that the IP
* header (if any) following the Ethernet header is 32-bit aligned.
*/
//uint8_t pad[2];
/* Align to 64 bit + 16 bit */
//uint8_t data[0];
/* Ethernet frame */
};
OFP_ASSERT(sizeof(struct ofp_packet_in) == 32);
/* Why was this flow removed? */
enum ofp_flow_removed_reason {
OFPRR_IDLE_TIMEOUT = 0,
/*
OFPRR_HARD_TIMEOUT = 1,
/*
OFPRR_DELETE
= 2,
/*
OFPRR_GROUP_DELETE = 3,
/*
OFPRR_METER_DELETE = 4,
/*
OFPRR_EVICTION
= 5,
/*
};
Flow idle time exceeded idle_timeout. */
Time exceeded hard_timeout. */
Evicted by a DELETE flow mod. */
Group was removed. */
Meter was removed. */
Switch eviction to free resources. */
/* Flow removed (datapath -> controller). */
struct ofp_flow_removed {
struct ofp_header header;
uint64_t cookie;
/* Opaque controller-issued identifier. */
uint16_t priority;
uint8_t reason;
uint8_t table_id;
/* Priority level of flow entry. */
/* One of OFPRR_*. */
/* ID of the table */
uint32_t duration_sec;
uint32_t duration_nsec;
/* Time flow was alive in seconds. */
/* Time flow was alive in nanoseconds beyond
duration_sec. */
/* Idle timeout from original flow mod. */
/* Hard timeout from original flow mod. */
uint16_t idle_timeout;
uint16_t hard_timeout;
uint64_t packet_count;
uint64_t byte_count;
struct ofp_match match;
/* Description of fields. Variable size. */
};
OFP_ASSERT(sizeof(struct ofp_flow_removed) == 56);
/* Meter numbering. Flow meters can use any number up to OFPM_MAX. */
enum ofp_meter {
/* Last usable meter. */
OFPM_MAX
= 0xffff0000,
/* Virtual meters. */
OFPM_SLOWPATH
= 0xfffffffd,
OFPM_CONTROLLER = 0xfffffffe,
OFPM_ALL
= 0xffffffff,
/* Meter for slow datapath. */
/* Meter for controller connection. */
/* Represents all meters for stat requests
commands. */
};
/* Meter band types */
enum ofp_meter_band_type {
OFPMBT_DROP
= 1,
OFPMBT_DSCP_REMARK
= 2,
OFPMBT_EXPERIMENTER
= 0xFFFF
};
/* Drop packet. */
/* Remark DSCP in the IP header. */
/* Experimenter meter band. */
/* Common header for all meter bands */
struct ofp_meter_band_header {
uint16_t
type;
/* One of OFPMBT_*. */
uint16_t
len;
/* Length in bytes of this band. */
uint32_t
rate;
/* Rate for this band. */
uint32_t
burst_size; /* Size of bursts. */
};
OFP_ASSERT(sizeof(struct ofp_meter_band_header) == 12);
/* OFPMBT_DROP band - drop packets */
struct ofp_meter_band_drop {
uint16_t
type;
/* OFPMBT_DROP. */
uint16_t
len;
/* Length is 16. */
uint32_t
rate;
/* Rate for dropping packets. */
uint32_t
burst_size; /* Size of bursts. */
uint8_t
pad[4];
};
157
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
OFP_ASSERT(sizeof(struct ofp_meter_band_drop) == 16);
/* OFPMBT_DSCP_REMARK band - Remark DSCP in the IP header */
struct ofp_meter_band_dscp_remark {
uint16_t
type;
/* OFPMBT_DSCP_REMARK. */
uint16_t
len;
/* Length is 16. */
uint32_t
rate;
/* Rate for remarking packets. */
uint32_t
burst_size; /* Size of bursts. */
uint8_t
prec_level; /* Number of drop precedence level to add. */
uint8_t
pad[3];
};
OFP_ASSERT(sizeof(struct ofp_meter_band_dscp_remark) == 16);
/* OFPMBT_EXPERIMENTER band - Write actions in action set */
struct ofp_meter_band_experimenter {
uint16_t
type;
/* One of OFPMBT_*. */
uint16_t
len;
/* Length in bytes of this band. */
uint32_t
rate;
/* Rate for this band. */
uint32_t
burst_size;
/* Size of bursts. */
uint32_t
experimenter; /* Experimenter ID. */
};
OFP_ASSERT(sizeof(struct ofp_meter_band_experimenter) == 16);
/* Meter commands */
enum ofp_meter_mod_command {
OFPMC_ADD,
/* New meter. */
OFPMC_MODIFY,
/* Modify specified meter. */
OFPMC_DELETE,
/* Delete specified meter. */
};
/* Meter configuration flags */
enum ofp_meter_flags {
OFPMF_KBPS
= 1 << 0,
/* Rate value in kb/s (kilo-bit per second). */
OFPMF_PKTPS
= 1 << 1,
/* Rate value in packet/sec. */
OFPMF_BURST
= 1 << 2,
/* Do burst size. */
OFPMF_STATS
= 1 << 3,
/* Collect statistics. */
};
/* Meter configuration. OFPT_METER_MOD. */
struct ofp_meter_mod {
struct ofp_header header;
uint16_t
command;
/*
uint16_t
flags;
/*
uint32_t
meter_id;
/*
struct ofp_meter_band_header bands[0];
One of OFPMC_*. */
Bitmap of OFPMF_* flags. */
Meter instance. */
/* The band list length is
inferred from the length field
in the header. */
};
OFP_ASSERT(sizeof(struct ofp_meter_mod) == 16);
/* Values for ’type’ in ofp_error_message. These values are immutable: they
* will not change in future versions of the protocol (although new values may
* be added). */
enum ofp_error_type {
OFPET_HELLO_FAILED
= 0, /* Hello protocol failed. */
OFPET_BAD_REQUEST
= 1, /* Request was not understood. */
OFPET_BAD_ACTION
= 2, /* Error in action description. */
OFPET_BAD_INSTRUCTION
= 3, /* Error in instruction list. */
OFPET_BAD_MATCH
= 4, /* Error in match. */
OFPET_FLOW_MOD_FAILED
= 5, /* Problem modifying flow entry. */
OFPET_GROUP_MOD_FAILED
= 6, /* Problem modifying group entry. */
OFPET_PORT_MOD_FAILED
= 7, /* Port mod request failed. */
OFPET_TABLE_MOD_FAILED
= 8, /* Table mod request failed. */
OFPET_QUEUE_OP_FAILED
= 9, /* Queue operation failed. */
OFPET_SWITCH_CONFIG_FAILED = 10, /* Switch config request failed. */
OFPET_ROLE_REQUEST_FAILED = 11, /* Controller Role request failed. */
OFPET_METER_MOD_FAILED
= 12, /* Error in meter. */
OFPET_TABLE_FEATURES_FAILED = 13, /* Setting table features failed. */
OFPET_BAD_PROPERTY
= 14, /* Some property is invalid. */
OFPET_ASYNC_CONFIG_FAILED = 15, /* Asynchronous config request failed. */
OFPET_FLOW_MONITOR_FAILED = 16, /* Setting flow monitor failed. */
OFPET_BUNDLE_FAILED
= 17, /* Bundle operation failed. */
OFPET_EXPERIMENTER = 0xffff
/* Experimenter error messages. */
};
/* ofp_error_msg ’code’ values for
* ASCII text string that may give
enum ofp_hello_failed_code {
OFPHFC_INCOMPATIBLE = 0,
/*
OFPHFC_EPERM
= 1,
/*
};
OFPET_HELLO_FAILED.
failure details. */
’data’ contains an
No compatible version. */
Permissions error. */
/* ofp_error_msg ’code’ values for OFPET_BAD_REQUEST. ’data’ contains at least
* the first 64 bytes of the failed request. */
enum ofp_bad_request_code {
OFPBRC_BAD_VERSION
= 0, /* ofp_header.version not supported. */
OFPBRC_BAD_TYPE
= 1, /* ofp_header.type not supported. */
OFPBRC_BAD_MULTIPART
= 2, /* ofp_multipart_request.type not supported. */
OFPBRC_BAD_EXPERIMENTER = 3, /* Experimenter id not supported
* (in ofp_experimenter_header or
158
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
*
*
OFPBRC_BAD_EXP_TYPE
= 4, /*
OFPBRC_EPERM
= 5, /*
OFPBRC_BAD_LEN
= 6, /*
OFPBRC_BUFFER_EMPTY
= 7, /*
OFPBRC_BUFFER_UNKNOWN
= 8, /*
OFPBRC_BAD_TABLE_ID
= 9, /*
*
OFPBRC_IS_SLAVE
= 10, /*
OFPBRC_BAD_PORT
= 11, /*
OFPBRC_BAD_PACKET
= 12, /*
OFPBRC_MULTIPART_BUFFER_OVERFLOW
ofp_multipart_request or
ofp_multipart_reply). */
Experimenter type not supported. */
Permissions error. */
Wrong request length for type. */
Specified buffer has already been used. */
Specified buffer does not exist. */
Specified table-id invalid or does not
exist. */
Denied because controller is slave. */
Invalid port. */
Invalid packet in packet-out. */
= 13, /* ofp_multipart_request
overflowed the assigned buffer. */
OFPBRC_MULTIPART_REQUEST_TIMEOUT = 14, /* Timeout during multipart request. */
OFPBRC_MULTIPART_REPLY_TIMEOUT = 15, /* Timeout during multipart reply. */
};
/* ofp_error_msg ’code’ values for OFPET_BAD_ACTION. ’data’ contains at least
* the first 64 bytes of the failed request. */
enum ofp_bad_action_code {
OFPBAC_BAD_TYPE
= 0, /* Unknown action type. */
OFPBAC_BAD_LEN
= 1, /* Length problem in actions. */
OFPBAC_BAD_EXPERIMENTER
= 2, /* Unknown experimenter id specified. */
OFPBAC_BAD_EXP_TYPE
= 3, /* Unknown action for experimenter id. */
OFPBAC_BAD_OUT_PORT
= 4, /* Problem validating output port. */
OFPBAC_BAD_ARGUMENT
= 5, /* Bad action argument. */
OFPBAC_EPERM
= 6, /* Permissions error. */
OFPBAC_TOO_MANY
= 7, /* Can’t handle this many actions. */
OFPBAC_BAD_QUEUE
= 8, /* Problem validating output queue. */
OFPBAC_BAD_OUT_GROUP
= 9, /* Invalid group id in forward action. */
OFPBAC_MATCH_INCONSISTENT = 10, /* Action can’t apply for this match,
or Set-Field missing prerequisite. */
OFPBAC_UNSUPPORTED_ORDER = 11, /* Action order is unsupported for the
action list in an Apply-Actions instruction */
OFPBAC_BAD_TAG
= 12, /* Actions uses an unsupported
tag/encap. */
OFPBAC_BAD_SET_TYPE
= 13, /* Unsupported type in SET_FIELD action. */
OFPBAC_BAD_SET_LEN
= 14, /* Length problem in SET_FIELD action. */
OFPBAC_BAD_SET_ARGUMENT
= 15, /* Bad argument in SET_FIELD action. */
};
/* ofp_error_msg ’code’ values for OFPET_BAD_INSTRUCTION. ’data’ contains at least
* the first 64 bytes of the failed request. */
enum ofp_bad_instruction_code {
OFPBIC_UNKNOWN_INST
= 0, /* Unknown instruction. */
OFPBIC_UNSUP_INST
= 1, /* Switch or table does not support the
instruction. */
OFPBIC_BAD_TABLE_ID
= 2, /* Invalid Table-ID specified. */
OFPBIC_UNSUP_METADATA
= 3, /* Metadata value unsupported by datapath. */
OFPBIC_UNSUP_METADATA_MASK = 4, /* Metadata mask value unsupported by
datapath. */
OFPBIC_BAD_EXPERIMENTER = 5, /* Unknown experimenter id specified. */
OFPBIC_BAD_EXP_TYPE
= 6, /* Unknown instruction for experimenter id. */
OFPBIC_BAD_LEN
= 7, /* Length problem in instructions. */
OFPBIC_EPERM
= 8, /* Permissions error. */
OFPBIC_DUP_INST
= 9, /* Duplicate instruction. */
};
/* ofp_error_msg ’code’ values for OFPET_BAD_MATCH. ’data’ contains at least
* the first 64 bytes of the failed request. */
enum ofp_bad_match_code {
OFPBMC_BAD_TYPE
= 0, /* Unsupported match type specified by the
match */
OFPBMC_BAD_LEN
= 1, /* Length problem in match. */
OFPBMC_BAD_TAG
= 2, /* Match uses an unsupported tag/encap. */
OFPBMC_BAD_DL_ADDR_MASK = 3, /* Unsupported datalink addr mask - switch
does not support arbitrary datalink
address mask. */
OFPBMC_BAD_NW_ADDR_MASK = 4, /* Unsupported network addr mask - switch
does not support arbitrary network
address mask. */
OFPBMC_BAD_WILDCARDS
= 5, /* Unsupported combination of fields masked
or omitted in the match. */
OFPBMC_BAD_FIELD
= 6, /* Unsupported field type in the match. */
OFPBMC_BAD_VALUE
= 7, /* Unsupported value in a match field. */
OFPBMC_BAD_MASK
= 8, /* Unsupported mask specified in the match,
field is not dl-address or nw-address. */
OFPBMC_BAD_PREREQ
= 9, /* A prerequisite was not met. */
OFPBMC_DUP_FIELD
= 10, /* A field type was duplicated. */
OFPBMC_EPERM
= 11, /* Permissions error. */
};
/* ofp_error_msg ’code’ values for OFPET_FLOW_MOD_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_flow_mod_failed_code {
OFPFMFC_UNKNOWN
= 0,
/* Unspecified error. */
OFPFMFC_TABLE_FULL
= 1,
/* Flow not added because table was full. */
OFPFMFC_BAD_TABLE_ID = 2,
/* Table does not exist */
OFPFMFC_OVERLAP
= 3,
/* Attempted to add overlapping flow with
159
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPFMFC_EPERM
OFPFMFC_BAD_TIMEOUT
= 4,
= 5,
OFPFMFC_BAD_COMMAND
OFPFMFC_BAD_FLAGS
OFPFMFC_CANT_SYNC
OFPFMFC_BAD_PRIORITY
=
=
=
=
6,
7,
8,
9,
Version 1.4.0
CHECK_OVERLAP flag set. */
/* Permissions error. */
/* Flow not added because of unsupported
idle/hard timeout. */
/* Unsupported or unknown command. */
/* Unsupported or unknown flags. */
/* Problem in table synchronisation. */
/* Unsupported priority value. */
};
/* ofp_error_msg ’code’ values for OFPET_GROUP_MOD_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_group_mod_failed_code {
OFPGMFC_GROUP_EXISTS
= 0, /* Group not added because a group ADD
attempted to replace an
already-present group. */
OFPGMFC_INVALID_GROUP
= 1, /* Group not added because Group
specified is invalid. */
OFPGMFC_WEIGHT_UNSUPPORTED
= 2, /* Switch does not support unequal load
sharing with select groups. */
OFPGMFC_OUT_OF_GROUPS
= 3, /* The group table is full. */
OFPGMFC_OUT_OF_BUCKETS
= 4, /* The maximum number of action buckets
for a group has been exceeded. */
OFPGMFC_CHAINING_UNSUPPORTED = 5, /* Switch does not support groups that
forward to groups. */
OFPGMFC_WATCH_UNSUPPORTED
= 6, /* This group cannot watch the watch_port
or watch_group specified. */
OFPGMFC_LOOP
= 7, /* Group entry would cause a loop. */
OFPGMFC_UNKNOWN_GROUP
= 8, /* Group not modified because a group
MODIFY attempted to modify a
non-existent group. */
OFPGMFC_CHAINED_GROUP
= 9, /* Group not deleted because another
group is forwarding to it. */
OFPGMFC_BAD_TYPE
= 10, /* Unsupported or unknown group type. */
OFPGMFC_BAD_COMMAND
= 11, /* Unsupported or unknown command. */
OFPGMFC_BAD_BUCKET
= 12, /* Error in bucket. */
OFPGMFC_BAD_WATCH
= 13, /* Error in watch port/group. */
OFPGMFC_EPERM
= 14, /* Permissions error. */
};
/* ofp_error_msg ’code’ values for OFPET_PORT_MOD_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_port_mod_failed_code {
OFPPMFC_BAD_PORT
= 0,
/* Specified port number does not exist. */
OFPPMFC_BAD_HW_ADDR
= 1,
/* Specified hardware address does not
* match the port number. */
OFPPMFC_BAD_CONFIG
= 2,
/* Specified config is invalid. */
OFPPMFC_BAD_ADVERTISE = 3,
/* Specified advertise is invalid. */
OFPPMFC_EPERM
= 4,
/* Permissions error. */
};
/* ofp_error_msg ’code’ values for OFPET_TABLE_MOD_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_table_mod_failed_code {
OFPTMFC_BAD_TABLE = 0,
/* Specified table does not exist. */
OFPTMFC_BAD_CONFIG = 1,
/* Specified config is invalid. */
OFPTMFC_EPERM
= 2,
/* Permissions error. */
};
/* ofp_error msg ’code’ values for OFPET_QUEUE_OP_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request */
enum ofp_queue_op_failed_code {
OFPQOFC_BAD_PORT
= 0,
/* Invalid port (or port does not exist). */
OFPQOFC_BAD_QUEUE = 1,
/* Queue does not exist. */
OFPQOFC_EPERM
= 2,
/* Permissions error. */
};
/* ofp_error_msg ’code’ values for OFPET_SWITCH_CONFIG_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_switch_config_failed_code {
OFPSCFC_BAD_FLAGS = 0,
/* Specified flags is invalid. */
OFPSCFC_BAD_LEN
= 1,
/* Specified len is invalid. */
OFPSCFC_EPERM
= 2,
/* Permissions error. */
};
/* ofp_error_msg ’code’ values for OFPET_ROLE_REQUEST_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_role_request_failed_code {
OFPRRFC_STALE
= 0,
/* Stale Message: old generation_id. */
OFPRRFC_UNSUP
= 1,
/* Controller role change unsupported. */
OFPRRFC_BAD_ROLE
= 2,
/* Invalid role. */
};
/* ofp_error_msg ’code’ values for OFPET_METER_MOD_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_meter_mod_failed_code {
OFPMMFC_UNKNOWN
= 0, /* Unspecified error. */
OFPMMFC_METER_EXISTS = 1, /* Meter not added because a Meter ADD
* attempted to replace an existing Meter. */
OFPMMFC_INVALID_METER = 2,
/* Meter not added because Meter specified
160
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
* is invalid. */
/* Meter not modified because a Meter
MODIFY attempted to modify a non-existent
Meter. */
OFPMMFC_BAD_COMMAND
= 4, /* Unsupported or unknown command. */
OFPMMFC_BAD_FLAGS
= 5, /* Flag configuration unsupported. */
OFPMMFC_BAD_RATE
= 6, /* Rate unsupported. */
OFPMMFC_BAD_BURST
= 7, /* Burst size unsupported. */
OFPMMFC_BAD_BAND
= 8, /* Band unsupported. */
OFPMMFC_BAD_BAND_VALUE = 9, /* Band value unsupported. */
OFPMMFC_OUT_OF_METERS = 10, /* No more meters available. */
OFPMMFC_OUT_OF_BANDS = 11, /* The maximum number of properties
* for a meter has been exceeded. */
OFPMMFC_UNKNOWN_METER = 3,
};
/* ofp_error_msg ’code’ values for OFPET_TABLE_FEATURES_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_table_features_failed_code {
OFPTFFC_BAD_TABLE
= 0,
/* Specified table does not exist. */
OFPTFFC_BAD_METADATA = 1,
/* Invalid metadata mask. */
OFPTFFC_EPERM
= 5,
/* Permissions error. */
};
/* ofp_error_msg ’code’ values for OFPET_BAD_PROPERTY. ’data’ contains at least
* the first 64 bytes of the failed request. */
enum ofp_bad_property_code {
OFPBPC_BAD_TYPE
= 0, /* Unknown property type. */
OFPBPC_BAD_LEN
= 1, /* Length problem in property. */
OFPBPC_BAD_VALUE
= 2, /* Unsupported property value. */
OFPBPC_TOO_MANY
= 3, /* Can’t handle this many properties. */
OFPBPC_DUP_TYPE
= 4, /* A property type was duplicated. */
OFPBPC_BAD_EXPERIMENTER
= 5, /* Unknown experimenter id specified. */
OFPBPC_BAD_EXP_TYPE
= 6, /* Unknown exp_type for experimenter id. */
OFPBPC_BAD_EXP_VALUE
= 7, /* Unknown value for experimenter id. */
OFPBPC_EPERM
= 8, /* Permissions error. */
};
/* ofp_error_msg ’code’ values for OFPET_ASYNC_CONFIG_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_async_config_failed_code {
OFPACFC_INVALID
= 0,
/* One mask is invalid. */
OFPACFC_UNSUPPORTED = 1,
/* Requested configuration not supported. */
OFPACFC_EPERM
= 2,
/* Permissions error. */
};
/* ofp_error_msg ’code’ values for OFPET_FLOW_MONITOR_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_flow_monitor_failed_code {
OFPMOFC_UNKNOWN
= 0, /* Unspecified error. */
OFPMOFC_MONITOR_EXISTS = 1, /* Monitor not added because a Monitor ADD
* attempted to replace an existing Monitor. */
OFPMOFC_INVALID_MONITOR = 2, /* Monitor not added because Monitor specified
* is invalid. */
OFPMOFC_UNKNOWN_MONITOR = 3, /* Monitor not modified because a Monitor
MODIFY attempted to modify a non-existent
Monitor. */
OFPMOFC_BAD_COMMAND
= 4, /* Unsupported or unknown command. */
OFPMOFC_BAD_FLAGS
= 5, /* Flag configuration unsupported. */
OFPMOFC_BAD_TABLE_ID = 6, /* Specified table does not exist. */
OFPMOFC_BAD_OUT
= 7, /* Error in output port/group. */
};
/* ofp_error_msg ’code’ values for OFPET_BUNDLE_FAILED. ’data’ contains
* at least the first 64 bytes of the failed request. */
enum ofp_bundle_failed_code {
OFPBFC_UNKNOWN
= 0, /* Unspecified error. */
OFPBFC_EPERM
= 1, /* Permissions error. */
OFPBFC_BAD_ID
= 2, /* Bundle ID doesn’t exist. */
OFPBFC_BUNDLE_EXIST
= 3, /* Bundle ID already exist. */
OFPBFC_BUNDLE_CLOSED = 4, /* Bundle ID is closed. */
OFPBFC_OUT_OF_BUNDLES = 5, /* Too many bundles IDs. */
OFPBFC_BAD_TYPE
= 6, /* Unsupported or unknown message control type. */
OFPBFC_BAD_FLAGS
= 7, /* Unsupported, unknown, or inconsistent flags. */
OFPBFC_MSG_BAD_LEN
= 8, /* Length problem in included message. */
OFPBFC_MSG_BAD_XID
= 9, /* Inconsistent or duplicate XID. */
OFPBFC_MSG_UNSUP
= 10, /* Unsupported message in this bundle. */
OFPBFC_MSG_CONFLICT
= 11, /* Unsupported message combination in this bundle. */
OFPBFC_MSG_TOO_MANY
= 12, /* Cant handle this many messages in bundle. */
OFPBFC_MSG_FAILED
= 13, /* One message in bundle failed. */
OFPBFC_TIMEOUT
= 14, /* Bundle is taking too long. */
OFPBFC_BUNDLE_IN_PROGRESS = 15, /* Bundle is locking the resource. */
};
/* OFPT_ERROR: Error message (datapath -> controller). */
struct ofp_error_msg {
struct ofp_header header;
uint16_t type;
uint16_t code;
uint8_t data[0];
/* Variable-length data.
Interpreted based
161
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
on the type and code.
};
OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
Version 1.4.0
No padding. */
/* OFPET_EXPERIMENTER: Error message (datapath -> controller). */
struct ofp_error_experimenter_msg {
struct ofp_header header;
uint16_t type;
uint16_t exp_code;
uint32_t experimenter;
uint8_t data[0];
/*
/*
/*
/*
OFPET_EXPERIMENTER. */
Experimenter defined. */
Experimenter ID. */
Variable-length data. Interpreted based
on the type and experimenter. No padding. */
};
OFP_ASSERT(sizeof(struct ofp_error_experimenter_msg) == 16);
enum ofp_multipart_type {
/* Description of this OpenFlow switch.
* The request body is empty.
* The reply body is struct ofp_desc. */
OFPMP_DESC = 0,
/* Individual flow statistics.
* The request body is struct ofp_flow_stats_request.
* The reply body is an array of struct ofp_flow_stats. */
OFPMP_FLOW = 1,
/* Aggregate flow statistics.
* The request body is struct ofp_aggregate_stats_request.
* The reply body is struct ofp_aggregate_stats_reply. */
OFPMP_AGGREGATE = 2,
/* Flow table statistics.
* The request body is empty.
* The reply body is an array of struct ofp_table_stats. */
OFPMP_TABLE = 3,
/* Port statistics.
* The request body is struct ofp_port_stats_request.
* The reply body is an array of struct ofp_port_stats. */
OFPMP_PORT_STATS = 4,
/* Queue statistics for a port
* The request body is struct ofp_queue_stats_request.
* The reply body is an array of struct ofp_queue_stats */
OFPMP_QUEUE_STATS = 5,
/* Group counter statistics.
* The request body is struct ofp_group_stats_request.
* The reply is an array of struct ofp_group_stats. */
OFPMP_GROUP = 6,
/* Group description.
* The request body is empty.
* The reply body is an array of struct ofp_group_desc. */
OFPMP_GROUP_DESC = 7,
/* Group features.
* The request body is empty.
* The reply body is struct ofp_group_features. */
OFPMP_GROUP_FEATURES = 8,
/* Meter statistics.
* The request body is struct ofp_meter_multipart_requests.
* The reply body is an array of struct ofp_meter_stats. */
OFPMP_METER = 9,
/* Meter configuration.
* The request body is struct ofp_meter_multipart_requests.
* The reply body is an array of struct ofp_meter_config. */
OFPMP_METER_CONFIG = 10,
/* Meter features.
* The request body is empty.
* The reply body is struct ofp_meter_features. */
OFPMP_METER_FEATURES = 11,
/* Table features.
* The request body is either empty or contains an array of
* struct ofp_table_features containing the controller’s
* desired view of the switch. If the switch is unable to
* set the specified view an error is returned.
* The reply body is an array of struct ofp_table_features. */
OFPMP_TABLE_FEATURES = 12,
/* Port description.
* The request body is empty.
* The reply body is an array of struct ofp_port. */
OFPMP_PORT_DESC = 13,
162
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Table description.
* The request body is empty.
* The reply body is an array of struct ofp_table_desc. */
OFPMP_TABLE_DESC = 14,
/* Queue description.
* The request body is struct ofp_queue_desc_request.
* The reply body is an array of struct ofp_queue_desc. */
OFPMP_QUEUE_DESC = 15,
/* Flow monitors.
* The request body is struct ofp_flow_monitor_request.
* The reply body is an array of struct ofp_flow_update_header. */
OFPMP_FLOW_MONITOR = 16,
/* Experimenter extension.
* The request and reply bodies begin with
* struct ofp_experimenter_multipart_header.
* The request and reply bodies are otherwise experimenter-defined. */
OFPMP_EXPERIMENTER = 0xffff
};
/* Backward compatibility with 1.3.1 - avoid breaking the API. */
#define ofp_multipart_types ofp_multipart_type
enum ofp_multipart_request_flags {
OFPMPF_REQ_MORE = 1 << 0 /* More requests to follow. */
};
struct ofp_multipart_request {
struct ofp_header header;
uint16_t type;
/* One of the OFPMP_* constants. */
uint16_t flags;
/* OFPMPF_REQ_* flags. */
uint8_t pad[4];
uint8_t body[0];
/* Body of the request. 0 or more bytes. */
};
OFP_ASSERT(sizeof(struct ofp_multipart_request) == 16);
enum ofp_multipart_reply_flags {
OFPMPF_REPLY_MORE = 1 << 0 /* More replies to follow. */
};
struct ofp_multipart_reply {
struct ofp_header header;
uint16_t type;
/* One of the OFPMP_* constants. */
uint16_t flags;
/* OFPMPF_REPLY_* flags. */
uint8_t pad[4];
uint8_t body[0];
/* Body of the reply. 0 or more bytes. */
};
OFP_ASSERT(sizeof(struct ofp_multipart_reply) == 16);
#define DESC_STR_LEN
256
#define SERIAL_NUM_LEN 32
/* Body of reply to OFPMP_DESC request. Each entry is a NULL-terminated
* ASCII string. */
struct ofp_desc {
char mfr_desc[DESC_STR_LEN];
/* Manufacturer description. */
char hw_desc[DESC_STR_LEN];
/* Hardware description. */
char sw_desc[DESC_STR_LEN];
/* Software description. */
char serial_num[SERIAL_NUM_LEN];
/* Serial number. */
char dp_desc[DESC_STR_LEN];
/* Human readable description of datapath. */
};
OFP_ASSERT(sizeof(struct ofp_desc) == 1056);
/* Body for ofp_multipart_request of type OFPMP_FLOW. */
struct ofp_flow_stats_request {
uint8_t table_id;
/* ID of table to read (from ofp_table_stats),
OFPTT_ALL for all tables. */
uint8_t pad[3];
/* Align to 32 bits. */
uint32_t out_port;
/* Require matching entries to include this
as an output port. A value of OFPP_ANY
indicates no restriction. */
uint32_t out_group;
/* Require matching entries to include this
as an output group. A value of OFPG_ANY
indicates no restriction. */
uint8_t pad2[4];
/* Align to 64 bits. */
uint64_t cookie;
/* Require matching entries to contain this
cookie value */
uint64_t cookie_mask;
/* Mask used to restrict the cookie bits that
must match. A value of 0 indicates
no restriction. */
struct ofp_match match;
/* Fields to match. Variable size. */
};
OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
/* Body of reply to OFPMP_FLOW request. */
struct ofp_flow_stats {
uint16_t length;
/* Length of this entry. */
uint8_t table_id;
/* ID of table flow came from. */
uint8_t pad;
163
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
uint32_t duration_sec;
uint32_t duration_nsec;
/* Time flow has been alive in seconds. */
/* Time flow has been alive in nanoseconds beyond
duration_sec. */
uint16_t priority;
/* Priority of the entry. */
uint16_t idle_timeout;
/* Number of seconds idle before expiration. */
uint16_t hard_timeout;
/* Number of seconds before expiration. */
uint16_t flags;
/* Bitmap of OFPFF_* flags. */
uint16_t importance;
/* Eviction precedence. */
uint8_t pad2[2];
/* Align to 64-bits. */
uint64_t cookie;
/* Opaque controller-issued identifier. */
uint64_t packet_count;
/* Number of packets in flow. */
uint64_t byte_count;
/* Number of bytes in flow. */
struct ofp_match match;
/* Description of fields. Variable size. */
//struct ofp_instruction_header instructions[0];
/* Instruction set - 0 or more. */
};
OFP_ASSERT(sizeof(struct ofp_flow_stats) == 56);
/* Body for ofp_multipart_request of type OFPMP_AGGREGATE. */
struct ofp_aggregate_stats_request {
uint8_t table_id;
/* ID of table to read (from ofp_table_stats)
OFPTT_ALL for all tables. */
uint8_t pad[3];
/* Align to 32 bits. */
uint32_t out_port;
/* Require matching entries to include this
as an output port. A value of OFPP_ANY
indicates no restriction. */
uint32_t out_group;
/* Require matching entries to include this
as an output group. A value of OFPG_ANY
indicates no restriction. */
uint8_t pad2[4];
/* Align to 64 bits. */
uint64_t cookie;
/* Require matching entries to contain this
cookie value */
uint64_t cookie_mask;
/* Mask used to restrict the cookie bits that
must match. A value of 0 indicates
no restriction. */
struct ofp_match match;
/* Fields to match. Variable size. */
};
OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40);
/* Body of reply to OFPMP_AGGREGATE request. */
struct ofp_aggregate_stats_reply {
uint64_t packet_count;
/* Number of packets in flows. */
uint64_t byte_count;
/* Number of bytes in flows. */
uint32_t flow_count;
/* Number of flows. */
uint8_t pad[4];
/* Align to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
/* Table Feature property types.
* Low order bit cleared indicates a property for a regular Flow Entry.
* Low order bit set indicates a property for the Table-Miss Flow Entry.
*/
enum ofp_table_feature_prop_type {
OFPTFPT_INSTRUCTIONS
= 0, /* Instructions property. */
OFPTFPT_INSTRUCTIONS_MISS
= 1, /* Instructions for table-miss. */
OFPTFPT_NEXT_TABLES
= 2, /* Next Table property. */
OFPTFPT_NEXT_TABLES_MISS
= 3, /* Next Table for table-miss. */
OFPTFPT_WRITE_ACTIONS
= 4, /* Write Actions property. */
OFPTFPT_WRITE_ACTIONS_MISS
= 5, /* Write Actions for table-miss. */
OFPTFPT_APPLY_ACTIONS
= 6, /* Apply Actions property. */
OFPTFPT_APPLY_ACTIONS_MISS
= 7, /* Apply Actions for table-miss. */
OFPTFPT_MATCH
= 8, /* Match property. */
OFPTFPT_WILDCARDS
= 10, /* Wildcards property. */
OFPTFPT_WRITE_SETFIELD
= 12, /* Write Set-Field property. */
OFPTFPT_WRITE_SETFIELD_MISS
= 13, /* Write Set-Field for table-miss. */
OFPTFPT_APPLY_SETFIELD
= 14, /* Apply Set-Field property. */
OFPTFPT_APPLY_SETFIELD_MISS
= 15, /* Apply Set-Field for table-miss. */
OFPTFPT_TABLE_SYNC_FROM
= 16, /* Table synchronisation property. */
OFPTFPT_EXPERIMENTER
= 0xFFFE, /* Experimenter property. */
OFPTFPT_EXPERIMENTER_MISS
= 0xFFFF, /* Experimenter for table-miss. */
};
/* Common header for all Table Feature Properties */
struct ofp_table_feature_prop_header {
uint16_t
type;
/* One of OFPTFPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_header) == 4);
/* Instruction ID */
struct ofp_instruction_id {
uint16_t type;
/* One of OFPIT_*. */
uint16_t len;
/* Length is 4 or experimenter defined. */
uint8_t exp_data[0];
/* Optional experimenter id + data. */
};
OFP_ASSERT(sizeof(struct ofp_instruction_id) == 4);
/* Instructions property */
struct ofp_table_feature_prop_instructions {
uint16_t
type;
/* One of OFPTFPT_INSTRUCTIONS,
164
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
OFPTFPT_INSTRUCTIONS_MISS. */
uint16_t
length; /* Length in bytes of this property. */
/* Followed by:
*
- Exactly (length - 4) bytes containing the instruction ids, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
struct ofp_instruction_id instruction_ids[0];
/* List of instructions */
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_instructions) == 4);
/* Next Tables and Table Synchronise From properties */
struct ofp_table_feature_prop_tables {
uint16_t
type;
/* One of OFPTFPT_NEXT_TABLES,
OFPTFPT_NEXT_TABLES_MISS,
OFPTFPT_TABLE_SYNC_FROM. */
uint16_t
length; /* Length in bytes of this property. */
/* Followed by:
*
- Exactly (length - 4) bytes containing the table_ids, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint8_t
table_ids[0];
/* List of table ids. */
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_tables) == 4);
/* Action ID */
struct ofp_action_id {
uint16_t type;
/* One of OFPAT_*. */
uint16_t len;
/* Length is 4 or experimenter defined. */
uint8_t exp_data[0];
/* Optional experimenter id + data. */
};
OFP_ASSERT(sizeof(struct ofp_action_id) == 4);
/* Actions property */
struct ofp_table_feature_prop_actions {
uint16_t
type;
/* One of OFPTFPT_WRITE_ACTIONS,
OFPTFPT_WRITE_ACTIONS_MISS,
OFPTFPT_APPLY_ACTIONS,
OFPTFPT_APPLY_ACTIONS_MISS. */
uint16_t
length; /* Length in bytes of this property. */
/* Followed by:
*
- Exactly (length - 4) bytes containing the action_ids, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
struct ofp_action_id action_ids[0];
/* List of actions */
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_actions) == 4);
/* Match, Wildcard or Set-Field property */
struct ofp_table_feature_prop_oxm {
uint16_t
type;
/* One of OFPTFPT_MATCH,
OFPTFPT_WILDCARDS,
OFPTFPT_WRITE_SETFIELD,
OFPTFPT_WRITE_SETFIELD_MISS,
OFPTFPT_APPLY_SETFIELD,
OFPTFPT_APPLY_SETFIELD_MISS. */
uint16_t
length; /* Length in bytes of this property. */
/* Followed by:
*
- Exactly (length - 4) bytes containing the oxm_ids, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
oxm_ids[0];
/* Array of OXM headers */
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_oxm) == 4);
/* Experimenter table feature property */
struct ofp_table_feature_prop_experimenter {
uint16_t
type;
/* One of OFPTFPT_EXPERIMENTER,
OFPTFPT_EXPERIMENTER_MISS. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_table_feature_prop_experimenter) == 12);
/* Body for ofp_multipart_request of type OFPMP_TABLE_FEATURES./
* Body of reply to OFPMP_TABLE_FEATURES request. */
struct ofp_table_features {
uint16_t length;
/* Length is padded to 64 bits. */
uint8_t table_id;
/* Identifier of table. Lower numbered tables
are consulted first. */
uint8_t pad[5];
/* Align to 64-bits. */
char name[OFP_MAX_TABLE_NAME_LEN];
uint64_t metadata_match; /* Bits of metadata table can match. */
165
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
uint64_t metadata_write; /* Bits of metadata table can write. */
uint32_t capabilities;
/* Bitmap of OFPTC_* values. */
uint32_t max_entries;
/* Max number of entries supported. */
/* Table Feature Property list */
struct ofp_table_feature_prop_header properties[0]; /* List of properties */
};
OFP_ASSERT(sizeof(struct ofp_table_features) == 64);
/* Body of reply to OFPMP_TABLE request. */
struct ofp_table_stats {
uint8_t table_id;
/* Identifier of table. Lower numbered tables
are consulted first. */
uint8_t pad[3];
/* Align to 32-bits. */
uint32_t active_count;
/* Number of active entries. */
uint64_t lookup_count;
/* Number of packets looked up in table. */
uint64_t matched_count; /* Number of packets that hit table. */
};
OFP_ASSERT(sizeof(struct ofp_table_stats) == 24);
/* Body of reply to OFPMP_TABLE_DESC request. */
struct ofp_table_desc {
uint16_t length;
/* Length is padded to 64 bits. */
uint8_t table_id;
/* Identifier of table. Lower numbered tables
are consulted first. */
uint8_t pad[1];
/* Align to 32-bits. */
uint32_t config;
/* Bitmap of OFPTC_* values. */
/* Table Mod Property list - 0 or more. */
struct ofp_table_mod_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_table_desc) == 8);
/* Body for ofp_multipart_request of type OFPMP_PORT_STATS. */
struct ofp_port_stats_request {
uint32_t port_no;
/* OFPMP_PORT message must request statistics
* either for a single port (specified in
* port_no) or for all ports (if port_no ==
* OFPP_ANY). */
uint8_t pad[4];
};
OFP_ASSERT(sizeof(struct ofp_port_stats_request) == 8);
/* Port stats property types.
*/
enum ofp_port_stats_prop_type
OFPPSPT_ETHERNET
OFPPSPT_OPTICAL
OFPPSPT_EXPERIMENTER
};
{
= 0,
/* Ethernet property. */
= 1,
/* Optical property. */
= 0xFFFF, /* Experimenter property. */
/* Common header for all port stats properties. */
struct ofp_port_stats_prop_header {
uint16_t
type;
/* One of OFPPSPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_port_stats_prop_header) == 4);
/* Ethernet port stats property. */
struct ofp_port_stats_prop_ethernet {
uint16_t
type;
/* OFPPSPT_ETHERNET. */
uint16_t
length; /* Length in bytes of this property. */
uint8_t
pad[4]; /* Align to 64 bits. */
uint64_t
uint64_t
uint64_t
uint64_t
rx_frame_err;
rx_over_err;
rx_crc_err;
collisions;
/*
/*
/*
/*
Number
Number
Number
Number
of
of
of
of
frame alignment errors. */
packets with RX overrun. */
CRC errors. */
collisions. */
};
OFP_ASSERT(sizeof(struct ofp_port_stats_prop_ethernet) == 40);
/* Optical port stats property. */
struct ofp_port_stats_prop_optical {
uint16_t
type;
/* OFPPSPT_OPTICAL. */
uint16_t
length; /* Length in bytes of this property. */
uint8_t
pad[4]; /* Align to 64 bits. */
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint16_t
uint16_t
uint16_t
uint16_t
flags;
tx_freq_lmda;
tx_offset;
tx_grid_span;
rx_freq_lmda;
rx_offset;
rx_grid_span;
tx_pwr;
rx_pwr;
bias_current;
temperature;
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
Features enabled by the port. */
Current TX Frequency/Wavelength */
TX Offset */
TX Grid Spacing */
Current RX Frequency/Wavelength */
RX Offset */
RX Grid Spacing */
Current TX power */
Current RX power */
TX Bias Current */
TX Laser Temperature */
};
OFP_ASSERT(sizeof(struct ofp_port_stats_prop_optical) == 44);
166
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Flags is one of OFPOSF_ below */
enum ofp_port_stats_optical_flags {
OFPOSF_RX_TUNE
= 1 << 0, /* Receiver tune info valid */
OFPOSF_TX_TUNE
= 1 << 1, /* Transmit tune info valid */
OFPOSF_TX_PWR
= 1 << 2, /* TX Power is valid */
OFPOSF_RX_PWR
= 1 << 4, /* RX power is valid */
OFPOSF_TX_BIAS
= 1 << 5, /* Transmit bias is valid */
OFPOSF_TX_TEMP
= 1 << 6, /* TX Temp is valid */
};
/* Experimenter port stats property. */
struct ofp_port_stats_prop_experimenter {
uint16_t
type;
/* OFPPSPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_port_stats_prop_experimenter) == 12);
/* Body of reply to OFPMP_PORT_STATS request. If a counter is unsupported,
* set the field to all ones. */
struct ofp_port_stats {
uint16_t length;
/* Length of this entry. */
uint8_t pad[2];
/* Align to 64 bits. */
uint32_t port_no;
uint32_t duration_sec;
/* Time port has been alive in seconds. */
uint32_t duration_nsec; /* Time port has been alive in nanoseconds beyond
duration_sec. */
uint64_t rx_packets;
/* Number of received packets. */
uint64_t tx_packets;
/* Number of transmitted packets. */
uint64_t rx_bytes;
/* Number of received bytes. */
uint64_t tx_bytes;
/* Number of transmitted bytes. */
uint64_t rx_dropped;
uint64_t tx_dropped;
uint64_t rx_errors;
uint64_t tx_errors;
/* Number of packets dropped by RX. */
/* Number of packets dropped by TX. */
/* Number of receive errors. This is a super-set
of more specific receive errors and should be
greater than or equal to the sum of all
rx_*_err values in properties. */
/* Number of transmit errors. This is a super-set
of more specific transmit errors and should be
greater than or equal to the sum of all
tx_*_err values (none currently defined.) */
/* Port description property list - 0 or more properties */
struct ofp_port_desc_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_port_stats) == 80);
/* Body of OFPMP_GROUP request. */
struct ofp_group_stats_request {
uint32_t group_id;
/* All groups if OFPG_ALL. */
uint8_t pad[4];
/* Align to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_group_stats_request) == 8);
/* Used in group stats replies. */
struct ofp_bucket_counter {
uint64_t packet_count;
/* Number of packets processed by bucket. */
uint64_t byte_count;
/* Number of bytes processed by bucket. */
};
OFP_ASSERT(sizeof(struct ofp_bucket_counter) == 16);
/* Body of reply to OFPMP_GROUP
struct ofp_group_stats {
uint16_t length;
/*
uint8_t pad[2];
/*
uint32_t group_id;
/*
uint32_t ref_count;
/*
request. */
Length of this entry. */
Align to 64 bits. */
Group identifier. */
Number of flows or groups that directly forward
to this group. */
uint8_t pad2[4];
/* Align to 64 bits. */
uint64_t packet_count;
/* Number of packets processed by group. */
uint64_t byte_count;
/* Number of bytes processed by group. */
uint32_t duration_sec;
/* Time group has been alive in seconds. */
uint32_t duration_nsec; /* Time group has been alive in nanoseconds beyond
duration_sec. */
struct ofp_bucket_counter bucket_stats[0]; /* One counter set per bucket. */
};
OFP_ASSERT(sizeof(struct ofp_group_stats) == 40);
/* Body of reply to OFPMP_GROUP_DESC request. */
struct ofp_group_desc {
167
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
uint16_t length;
uint8_t type;
uint8_t pad;
uint32_t group_id;
struct ofp_bucket buckets[0];
Version 1.4.0
/* Length of this entry. */
/* One of OFPGT_*. */
/* Pad to 64 bits. */
/* Group identifier. */
/* List of buckets - 0 or more. */
};
OFP_ASSERT(sizeof(struct ofp_group_desc) == 8);
/* Backward compatibility with 1.3.1 - avoid breaking the API. */
#define ofp_group_desc_stats ofp_group_desc
/* Group configuration flags */
enum ofp_group_capabilities {
OFPGFC_SELECT_WEIGHT
= 1 <<
OFPGFC_SELECT_LIVENESS = 1 <<
OFPGFC_CHAINING
= 1 <<
OFPGFC_CHAINING_CHECKS = 1 <<
};
0,
1,
2,
3,
/*
/*
/*
/*
Support weight for select groups */
Support liveness for select groups */
Support chaining groups */
Check chaining for loops and delete */
/* Body of reply to OFPMP_GROUP_FEATURES request. Group features. */
struct ofp_group_features {
uint32_t types;
/* Bitmap of OFPGT_* values supported. */
uint32_t capabilities;
/* Bitmap of OFPGFC_* capability supported. */
uint32_t max_groups[4];
/* Maximum number of groups for each type. */
uint32_t actions[4];
/* Bitmaps of OFPAT_* that are supported. */
};
OFP_ASSERT(sizeof(struct ofp_group_features) == 40);
/* Body of OFPMP_METER and OFPMP_METER_CONFIG requests. */
struct ofp_meter_multipart_request {
uint32_t meter_id;
/* Meter instance, or OFPM_ALL. */
uint8_t pad[4];
/* Align to 64 bits. */
};
OFP_ASSERT(sizeof(struct ofp_meter_multipart_request) == 8);
/* Statistics for each meter band */
struct ofp_meter_band_stats {
uint64_t
packet_band_count;
/* Number of packets in band. */
uint64_t
byte_band_count;
/* Number of bytes in band. */
};
OFP_ASSERT(sizeof(struct ofp_meter_band_stats) == 16);
/* Body of reply to OFPMP_METER request. Meter statistics. */
struct ofp_meter_stats {
uint32_t
meter_id;
/* Meter instance. */
uint16_t
len;
/* Length in bytes of this stats. */
uint8_t
pad[6];
uint32_t
flow_count;
/* Number of flows bound to meter. */
uint64_t
packet_in_count; /* Number of packets in input. */
uint64_t
byte_in_count;
/* Number of bytes in input. */
uint32_t
duration_sec; /* Time meter has been alive in seconds. */
uint32_t
duration_nsec; /* Time meter has been alive in nanoseconds beyond
duration_sec. */
struct ofp_meter_band_stats band_stats[0]; /* The band_stats length is
inferred from the length field. */
};
OFP_ASSERT(sizeof(struct ofp_meter_stats) == 40);
/* Body of reply to OFPMP_METER_CONFIG request. Meter configuration. */
struct ofp_meter_config {
uint16_t
length;
/* Length of this entry. */
uint16_t
flags;
/* All OFPMC_* that apply. */
uint32_t
meter_id;
/* Meter instance. */
struct ofp_meter_band_header bands[0]; /* The bands length is
inferred from the length field. */
};
OFP_ASSERT(sizeof(struct ofp_meter_config) == 8);
/* Body of reply to OFPMP_METER_FEATURES request. Meter features. */
struct ofp_meter_features {
uint32_t
max_meter;
/* Maximum number of meters. */
uint32_t
band_types;
/* Bitmaps of OFPMBT_* values supported. */
uint32_t
capabilities; /* Bitmaps of "ofp_meter_flags". */
uint8_t
max_bands;
/* Maximum bands per meters */
uint8_t
max_color;
/* Maximum color value */
uint8_t
pad[2];
};
OFP_ASSERT(sizeof(struct ofp_meter_features) == 16);
/* All ones is used to indicate all queues in a port (for stats retrieval). */
#define OFPQ_ALL
0xffffffff
/* Min rate > 1000 means not configured. */
#define OFPQ_MIN_RATE_UNCFG
0xffff
/* Max rate > 1000 means not configured. */
#define OFPQ_MAX_RATE_UNCFG
0xffff
enum ofp_queue_desc_prop_type {
OFPQDPT_MIN_RATE
= 1,
/* Minimum datarate guaranteed. */
168
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
OFPQDPT_MAX_RATE
OFPQDPT_EXPERIMENTER
= 2,
= 0xffff
Version 1.4.0
/* Maximum datarate. */
/* Experimenter defined property. */
};
/* Common header for all queue properties */
struct ofp_queue_desc_prop_header {
uint16_t
type;
/* One of OFPQDPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_queue_desc_prop_header) == 4);
/* Min-Rate queue property description. */
struct ofp_queue_desc_prop_min_rate {
uint16_t
type;
/* OFPQDPT_MIN_RATE. */
uint16_t
length; /* Length is 8. */
uint16_t rate;
/* In 1/10 of a percent; >1000 -> disabled. */
uint8_t pad[2];
/* 64-bit alignment */
};
OFP_ASSERT(sizeof(struct ofp_queue_desc_prop_min_rate) == 8);
/* Max-Rate queue property description. */
struct ofp_queue_desc_prop_max_rate {
uint16_t
type;
/* OFPQDPT_MAX_RATE. */
uint16_t
length; /* Length is 8. */
uint16_t rate;
/* In 1/10 of a percent; >1000 -> disabled. */
uint8_t pad[2];
/* 64-bit alignment */
};
OFP_ASSERT(sizeof(struct ofp_queue_desc_prop_max_rate) == 8);
/* Experimenter queue property description. */
struct ofp_queue_desc_prop_experimenter {
uint16_t
type;
/* OFPQDPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_queue_desc_prop_experimenter) == 12);
/* Body for ofp_multipart_request of type OFPMP_QUEUE_DESC. */
struct ofp_queue_desc_request {
uint32_t port_no;
/* All ports if OFPP_ANY. */
uint32_t queue_id;
/* All queues if OFPQ_ALL. */
};
OFP_ASSERT(sizeof(struct ofp_queue_desc_request) == 8);
/* Body of reply to OFPMP_QUEUE_DESC request. */
struct ofp_queue_desc {
uint32_t port_no;
/* Port this queue is attached to. */
uint32_t queue_id;
/* id for the specific queue. */
uint16_t len;
/* Length in bytes of this queue desc. */
uint8_t pad[6];
/* 64-bit alignment. */
struct ofp_queue_desc_prop_header properties[0]; /* List of properties. */
};
OFP_ASSERT(sizeof(struct ofp_queue_desc) == 16);
/* Body for ofp_multipart_request of type OFPMP_QUEUE_STATS. */
struct ofp_queue_stats_request {
uint32_t port_no;
/* All ports if OFPP_ANY. */
uint32_t queue_id;
/* All queues if OFPQ_ALL. */
};
OFP_ASSERT(sizeof(struct ofp_queue_stats_request) == 8);
enum ofp_queue_stats_prop_type {
OFPQSPT_EXPERIMENTER = 0xffff
};
/* Experimenter defined property. */
/* Common header for all queue properties */
struct ofp_queue_stats_prop_header {
uint16_t
type;
/* One of OFPQSPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_queue_stats_prop_header) == 4);
/* Experimenter queue property description. */
struct ofp_queue_stats_prop_experimenter {
uint16_t
type;
/* OFPQSPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
169
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_queue_stats_prop_experimenter) == 12);
/* Body of reply to OFPMP_QUEUE_STATS request. */
struct ofp_queue_stats {
uint16_t length;
/* Length of this entry. */
uint8_t pad[6];
/* Align to 64 bits. */
uint32_t port_no;
/* Port the queue is attached to. */
uint32_t queue_id;
/* Queue i.d */
uint64_t tx_bytes;
/* Number of transmitted bytes. */
uint64_t tx_packets;
/* Number of transmitted packets. */
uint64_t tx_errors;
/* Number of packets dropped due to overrun. */
uint32_t duration_sec;
/* Time queue has been alive in seconds. */
uint32_t duration_nsec; /* Time queue has been alive in nanoseconds beyond
duration_sec. */
struct ofp_queue_stats_prop_header properties[0]; /* List of properties. */
};
OFP_ASSERT(sizeof(struct ofp_queue_stats) == 48);
/* Body for ofp_multipart_request of type OFPMP_FLOW_MONITOR.
*
* The OFPMP_FLOW_MONITOR request’s body consists of an array of zero or more
* instances of this structure. The request arranges to monitor the flows
* that match the specified criteria, which are interpreted in the same way as
* for OFPMP_FLOW.
*
* ’id’ identifies a particular monitor for the purpose of allowing it to be
* canceled later with OFPFMC_DELETE. ’id’ must be unique among
* existing monitors that have not already been canceled.
*/
struct ofp_flow_monitor_request {
uint32_t monitor_id;
/* Controller-assigned ID for this monitor. */
uint32_t out_port;
/* Required output port, if not OFPP_ANY. */
uint32_t out_group;
/* Required output port, if not OFPG_ANY. */
uint16_t flags;
/* OFFMF_*. */
uint8_t table_id;
/* One table’s ID or OFPTT_ALL (all tables). */
uint8_t command;
/* One of OFPFMC_*. */
struct ofp_match match;
/* Fields to match. Variable size. */
};
OFP_ASSERT(sizeof(struct ofp_flow_monitor_request) == 24);
/* Flow monitor commands */
enum ofp_flow_monitor_command {
OFPFMC_ADD
= 0,
/* New flow monitor. */
OFPFMC_MODIFY = 1,
/* Modify existing flow monitor. */
OFPFMC_DELETE = 2,
/* Delete/cancel existing flow monitor. */
};
/* ’flags’ bits in struct of_flow_monitor_request. */
enum ofp_flow_monitor_flags {
/* When to send updates. */
OFPFMF_INITIAL = 1 << 0,
/* Initially matching flows. */
OFPFMF_ADD = 1 << 1,
/* New matching flows as they are added. */
OFPFMF_REMOVED = 1 << 2,
/* Old matching flows as they are removed. */
OFPFMF_MODIFY = 1 << 3,
/* Matching flows as they are changed. */
/* What to include in updates. */
OFPFMF_INSTRUCTIONS = 1 << 4,/* If set, instructions are included. */
OFPFMF_NO_ABBREV = 1 << 5,
/* If set, include own changes in full. */
OFPFMF_ONLY_OWN = 1 << 6,
/* If set, don’t include other controllers. */
};
/* OFPMP_FLOW_MONITOR reply header.
*
* The body of an OFPMP_FLOW_MONITOR reply is an array of variable-length
* structures, each of which begins with this header. The ’length’ member may
* be used to traverse the array, and the ’event’ member may be used to
* determine the particular structure.
*
* Every instance is a multiple of 8 bytes long. */
struct ofp_flow_update_header {
uint16_t length;
/* Length of this entry. */
uint16_t event;
/* One of OFPFME_*. */
/* ...other data depending on ’event’... */
};
OFP_ASSERT(sizeof(struct ofp_flow_update_header) == 4);
/* ’event’ values in struct ofp_flow_update_header. */
enum ofp_flow_update_event {
/* struct ofp_flow_update_full. */
OFPFME_INITIAL = 0,
/* Flow present when flow monitor created. */
OFPFME_ADDED = 1,
/* Flow was added. */
OFPFME_REMOVED = 2,
/* Flow was removed. */
OFPFME_MODIFIED = 3,
/* Flow instructions were changed. */
170
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* struct ofp_flow_update_abbrev. */
OFPFME_ABBREV = 4,
/* Abbreviated reply. */
/* struct ofp_flow_update_header. */
OFPFME_PAUSED = 5,
/* Monitoring paused (out of buffer space). */
OFPFME_RESUMED = 6,
/* Monitoring resumed. */
};
/* OFPMP_FLOW_MONITOR reply for OFPFME_INITIAL, OFPFME_ADDED, OFPFME_REMOVED,
* and OFPFME_MODIFIED. */
struct ofp_flow_update_full {
uint16_t length;
/* Length is 32 + match + instructions. */
uint16_t event;
/* One of OFPFME_*. */
uint8_t table_id;
/* ID of flow’s table. */
uint8_t reason;
/* OFPRR_* for OFPFME_REMOVED, else zero. */
uint16_t idle_timeout;
/* Number of seconds idle before expiration. */
uint16_t hard_timeout;
/* Number of seconds before expiration. */
uint16_t priority;
/* Priority of the entry. */
uint8_t zeros[4];
/* Reserved, currently zeroed. */
uint64_t cookie;
/* Opaque controller-issued identifier. */
struct ofp_match match;
/* Fields to match. Variable size. */
/*
Instruction set.
*
If OFPFMF_INSTRUCTIONS was not specified, or ’event’ is
*
OFPFME_REMOVED, no instructions are included.
*/
//struct ofp_instruction instructions[0];
};
OFP_ASSERT(sizeof(struct ofp_flow_update_full) == 32);
/* OFPMP_FLOW_MONITOR reply for OFPFME_ABBREV.
*
* When the controller does not specify OFPFMF_OWN in a monitor request, any
* flow tables changes due to the controller’s own requests (on the same
* OpenFlow channel) will be abbreviated, when possible, to this form, which
* simply specifies the ’xid’ of the OpenFlow request (e.g. an OFPT_FLOW_MOD)
* that caused the change.
* Some changes cannot be abbreviated and will be sent in full.
*/
struct ofp_flow_update_abbrev {
uint16_t length;
/* Length is 8. */
uint16_t event;
/* OFPFME_ABBREV. */
uint32_t xid;
/* Controller-specified xid from flow_mod. */
};
OFP_ASSERT(sizeof(struct ofp_flow_update_abbrev) == 8);
/* OFPMP_FLOW_MONITOR reply for OFPFME_PAUSED and OFPFME_RESUMED.
*/
struct ofp_flow_update_paused {
uint16_t length;
/* Length is 8. */
uint16_t event;
/* One of OFPFME_*. */
uint8_t zeros[4];
/* Reserved, currently zeroed. */
};
OFP_ASSERT(sizeof(struct ofp_flow_update_paused) == 8);
/* Body for ofp_multipart_request/reply of type OFPMP_EXPERIMENTER. */
struct ofp_experimenter_multipart_header {
uint32_t experimenter;
/* Experimenter ID. */
uint32_t exp_type;
/* Experimenter defined. */
/* Experimenter-defined arbitrary additional data. */
};
OFP_ASSERT(sizeof(struct ofp_experimenter_multipart_header) == 8);
/* Typical Experimenter structure. */
struct ofp_experimenter_structure {
uint32_t experimenter;
/* Experimenter ID:
* - MSB 0: low-order bytes are IEEE OUI.
* - MSB != 0: defined by ONF. */
uint32_t exp_type;
/* Experimenter defined. */
uint8_t experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_experimenter_structure) == 8);
/* Experimenter extension message. */
struct ofp_experimenter_msg {
struct ofp_header header;
/* Type OFPT_EXPERIMENTER. */
uint32_t experimenter;
/* Experimenter ID:
* - MSB 0: low-order bytes are IEEE OUI.
* - MSB != 0: defined by ONF. */
uint32_t exp_type;
/* Experimenter defined. */
/* Experimenter-defined arbitrary additional data. */
uint8_t experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_experimenter_msg) == 16);
/* Configures the "role" of the sending controller. The default role is:
*
*
- Equal (OFPCR_ROLE_EQUAL), which allows the controller access to all
*
OpenFlow features. All controllers have equal responsibility.
*
* The other possible roles are a related pair:
171
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
*
*
*
*
*
*
*
*
*
*
*
*
*/
Version 1.4.0
- Master (OFPCR_ROLE_MASTER) is equivalent to Equal, except that there
may be at most one Master controller at a time: when a controller
configures itself as Master, any existing Master is demoted to the
Slave role.
- Slave (OFPCR_ROLE_SLAVE) allows the controller read-only access to
OpenFlow features. In particular attempts to modify the flow table
will be rejected with an OFPBRC_EPERM error.
Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
messages, but they do receive OFPT_PORT_STATUS messages.
/* Controller roles. */
enum ofp_controller_role {
OFPCR_ROLE_NOCHANGE = 0,
OFPCR_ROLE_EQUAL
= 1,
OFPCR_ROLE_MASTER
= 2,
OFPCR_ROLE_SLAVE
= 3,
};
/*
/*
/*
/*
Don’t change current role. */
Default role, full access. */
Full access, at most one master. */
Read-only access. */
/* Role request and reply message. */
struct ofp_role_request {
struct ofp_header header;
/* Type OFPT_ROLE_REQUEST/OFPT_ROLE_REPLY. */
uint32_t role;
/* One of OFPCR_ROLE_*. */
uint8_t pad[4];
/* Align to 64 bits. */
uint64_t generation_id;
/* Master Election Generation Id */
};
OFP_ASSERT(sizeof(struct ofp_role_request) == 24);
/* Role property types.
*/
enum ofp_role_prop_type {
OFPRPT_EXPERIMENTER
};
= 0xFFFF, /* Experimenter property. */
/* Common header for all Role Properties */
struct ofp_role_prop_header {
uint16_t
type;
/* One of OFPRPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_role_prop_header) == 4);
/* Experimenter role property */
struct ofp_role_prop_experimenter {
uint16_t
type;
/* One of OFPRPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_role_prop_experimenter) == 12);
/* What changed about the controller role */
enum ofp_controller_role_reason {
OFPCRR_MASTER_REQUEST = 0, /* Another controller asked to be master. */
OFPCRR_CONFIG
= 1, /* Configuration changed on the switch. */
OFPCRR_EXPERIMENTER
= 2, /* Experimenter data changed. */
};
/* Role status event message. */
struct ofp_role_status {
struct ofp_header header;
/* Type OFPT_ROLE_REQUEST/OFPT_ROLE_REPLY. */
uint32_t role;
/* One of OFPCR_ROLE_*. */
uint8_t reason;
/* One of OFPCRR_*. */
uint8_t pad[3];
/* Align to 64 bits. */
uint64_t generation_id;
/* Master Election Generation Id */
/* Role Property list */
struct ofp_role_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_role_status) == 24);
/* Async Config property types.
* Low order bit cleared indicates a property for the slave role.
* Low order bit set indicates a property for the master/equal role.
*/
enum ofp_async_config_prop_type {
OFPACPT_PACKET_IN_SLAVE
= 0, /* Packet-in mask for slave. */
OFPACPT_PACKET_IN_MASTER
= 1, /* Packet-in mask for master. */
OFPACPT_PORT_STATUS_SLAVE
= 2, /* Port-status mask for slave. */
OFPACPT_PORT_STATUS_MASTER
= 3, /* Port-status mask for master. */
OFPACPT_FLOW_REMOVED_SLAVE
= 4, /* Flow removed mask for slave. */
172
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
OFPACPT_FLOW_REMOVED_MASTER = 5, /* Flow removed mask for master. */
OFPACPT_ROLE_STATUS_SLAVE
= 6, /* Role status mask for slave. */
OFPACPT_ROLE_STATUS_MASTER
= 7, /* Role status mask for master. */
OFPACPT_TABLE_STATUS_SLAVE
= 8, /* Table status mask for slave. */
OFPACPT_TABLE_STATUS_MASTER = 9, /* Table status mask for master. */
OFPACPT_REQUESTFORWARD_SLAVE = 10, /* RequestForward mask for slave. */
OFPACPT_REQUESTFORWARD_MASTER = 11, /* RequestForward mask for master. */
OFPTFPT_EXPERIMENTER_SLAVE
= 0xFFFE, /* Experimenter for slave. */
OFPTFPT_EXPERIMENTER_MASTER = 0xFFFF, /* Experimenter for master. */
};
/* Common header for all async config Properties */
struct ofp_async_config_prop_header {
uint16_t
type;
/* One of OFPACPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_async_config_prop_header) == 4);
/* Various reason based properties */
struct ofp_async_config_prop_reasons {
uint16_t
type;
/* One of OFPACPT_PACKET_IN_*,
OFPACPT_PORT_STATUS_*,
OFPACPT_FLOW_REMOVED_*,
OFPACPT_ROLE_STATUS_*,
OFPACPT_TABLE_STATUS_*,
OFPACPT_REQUESTFORWARD_*. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
mask;
/* Bitmasks of reason values. */
};
OFP_ASSERT(sizeof(struct ofp_async_config_prop_reasons) == 8);
/* Experimenter async config property */
struct ofp_async_config_prop_experimenter {
uint16_t
type;
/* One of OFPTFPT_EXPERIMENTER_SLAVE,
OFPTFPT_EXPERIMENTER_MASTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_async_config_prop_experimenter) == 12);
/* Asynchronous message configuration. */
struct ofp_async_config {
struct ofp_header header;
/* OFPT_GET_ASYNC_REPLY or OFPT_SET_ASYNC. */
/* Async config Property list - 0 or more */
struct ofp_async_config_prop_header properties[0];
};
OFP_ASSERT(sizeof(struct ofp_async_config) == 8);
/* What changed about the table */
enum ofp_table_reason {
OFPTR_VACANCY_DOWN = 3,
OFPTR_VACANCY_UP
= 4,
};
/* Vacancy down threshold event. */
/* Vacancy up threshold event. */
/* A table config has changed in the datapath */
struct ofp_table_status {
struct ofp_header header;
uint8_t reason;
/* One of OFPTR_*. */
uint8_t pad[7];
/* Pad to 64 bits */
struct ofp_table_desc table;
/* New table config. */
};
OFP_ASSERT(sizeof(struct ofp_table_status) == 24);
/* Request forward reason */
enum ofp_requestforward_reason {
OFPRFR_GROUP_MOD = 0,
/* Forward group mod requests. */
OFPRFR_METER_MOD = 1,
/* Forward meter mod requests. */
};
/* Group/Meter request forwarding. */
struct ofp_requestforward_header {
struct ofp_header header;
/* Type OFPT_REQUESTFORWARD. */
struct ofp_header request; /* Request being forwarded. */
};
OFP_ASSERT(sizeof(struct ofp_requestforward_header) == 16);
/* Bundle property types. */
enum ofp_bundle_prop_type {
OFPBPT_EXPERIMENTER
};
= 0xFFFF, /* Experimenter property. */
173
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
/* Common header for all Bundle Properties */
struct ofp_bundle_prop_header {
uint16_t
type;
/* One of OFPBPT_*. */
uint16_t
length; /* Length in bytes of this property. */
};
OFP_ASSERT(sizeof(struct ofp_bundle_prop_header) == 4);
/* Experimenter bundle property */
struct ofp_bundle_prop_experimenter {
uint16_t
type;
/* OFPBPT_EXPERIMENTER. */
uint16_t
length; /* Length in bytes of this property. */
uint32_t
experimenter; /* Experimenter ID which takes the same
form as in struct
ofp_experimenter_header. */
uint32_t
exp_type;
/* Experimenter defined. */
/* Followed by:
*
- Exactly (length - 12) bytes containing the experimenter data, then
*
- Exactly (length + 7)/8*8 - (length) (between 0 and 7)
*
bytes of all-zero bytes */
uint32_t
experimenter_data[0];
};
OFP_ASSERT(sizeof(struct ofp_bundle_prop_experimenter) == 12);
/* Bundle control message types */
enum ofp_bundle_ctrl_type {
OFPBCT_OPEN_REQUEST
= 0,
OFPBCT_OPEN_REPLY
= 1,
OFPBCT_CLOSE_REQUEST
= 2,
OFPBCT_CLOSE_REPLY
= 3,
OFPBCT_COMMIT_REQUEST = 4,
OFPBCT_COMMIT_REPLY
= 5,
OFPBCT_DISCARD_REQUEST = 6,
OFPBCT_DISCARD_REPLY
= 7,
};
/* Bundle configuration flags. */
enum ofp_bundle_flags {
OFPBF_ATOMIC = 1 << 0, /* Execute atomically. */
OFPBF_ORDERED = 1 << 1, /* Execute in specified order. */
};
/* Message structure for OFPT_BUNDLE_CONTROL. */
struct ofp_bundle_ctrl_msg {
struct ofp_header
header;
uint32_t
bundle_id;
/* Identify the bundle. */
uint16_t
type;
/* OFPBCT_*. */
uint16_t
flags;
/* Bitmap of OFPBF_* flags. */
/* Bundle Property list. */
struct ofp_bundle_prop_header properties[0]; /* Zero or more properties. */
};
OFP_ASSERT(sizeof(struct ofp_bundle_ctrl_msg) == 16);
/* Message structure for OFPT_BUNDLE_ADD_MESSAGE.
* Adding a message in a bundle is done with. */
struct ofp_bundle_add_msg {
struct ofp_header
header;
uint32_t
bundle_id;
/* Identify the bundle. */
uint16_t
pad;
/* Align to 64 bits. */
uint16_t
flags;
/* Bitmap of OFPBF_* flags. */
struct ofp_header
message;
/* Message added to the bundle. */
/* If there is one property or more, ’message’ is followed by:
*
- Exactly (message.length + 7)/8*8 - (message.length) (between 0 and 7)
*
bytes of all-zero bytes */
/* Bundle Property list. */
//struct ofp_bundle_prop_header properties[0]; /* Zero or more properties. */
};
OFP_ASSERT(sizeof(struct ofp_bundle_add_msg) == 24);
#endif /* openflow/openflow.h */
Appendix B
Release Notes
This section contains release notes highlighting the main changes between the main versions of the
OpenFlow protocol.
The text of the release notes is informative and historical, and should not be considered normative.
Many items of the release notes refer to features and text that has been removed, replaced or up-
174
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
dated in subsequent versions of this specification, and therefore does not necessarily match the actual
specification.
B.1
OpenFlow version 0.2.0
Release date : March 28,2008
Wire Protocol : 1
B.2
OpenFlow version 0.2.1
Release date : March 28,2008
Wire Protocol : 1
No protocol change.
B.3
OpenFlow version 0.8.0
Release date : May 5, 2008
Wire Protocol : 0x83
ˆ Reorganise OpenFlow message types
ˆ Add OFPP_TABLE virtual port to send packet-out packet to the tables
ˆ Add global flag OFPC_SEND_FLOW_EXP to configure flow expired messages generation
ˆ Add flow priority
ˆ Remove flow Group-ID (experimental QoS support)
ˆ Add Error messages
ˆ Make stat request and stat reply more generic, with a generic header and stat specific body
ˆ Change fragmentation strategy for stats reply, use explicit flag OFPSF_REPLY_MORE instead of
empty packet
ˆ Add table stats and port stats mesages
B.4
OpenFlow version 0.8.1
Release date : May 20, 2008
Wire Protocol : 0x83
No protocol change.
175
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.5
Version 1.4.0
OpenFlow version 0.8.2
Release date : October 17, 2008
Wire Protocol : 0x85
ˆ Add Echo Request and Echo Reply messages
ˆ Make all message 64 bits aligned
B.6
OpenFlow version 0.8.9
Release date : December 2, 2008
Wire Protocol : 0x97
B.6.1
IP Netmasks
It is now possible for flow entries to contain IP subnet masks. This is done by changes to the wildcards
field, which has been expanded to 32-bits:
/* Flow wildcards. */
enum ofp_flow_wildcards {
OFPFW_IN_PORT = 1 << 0,
OFPFW_DL_VLAN = 1 << 1,
OFPFW_DL_SRC
= 1 << 2,
OFPFW_DL_DST
= 1 << 3,
OFPFW_DL_TYPE = 1 << 4,
OFPFW_NW_PROTO = 1 << 5,
OFPFW_TP_SRC
= 1 << 6,
OFPFW_TP_DST
= 1 << 7,
/*
/*
/*
/*
/*
/*
/*
/*
Switch input port. */
VLAN. */
Ethernet source address. */
Ethernet destination address. */
Ethernet frame type. */
IP protocol. */
TCP/UDP source port. */
TCP/UDP destination port. */
/* IP source address wildcard bit count. 0 is exact match, 1 ignores the
* LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
* the entire field. This is the *opposite* of the usual convention where
* e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
OFPFW_NW_SRC_SHIFT = 8,
OFPFW_NW_SRC_BITS = 6,
OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
/* IP destination address wildcard bit count. Same format as source. */
OFPFW_NW_DST_SHIFT = 14,
OFPFW_NW_DST_BITS = 6,
OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
/* Wildcard all fields. */
OFPFW_ALL = ((1 << 20) - 1)
};
176
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The source and destination netmasks are each specified with a 6-bit number in the wildcard description.
It is interpreted similar to the CIDR suffix, but with the opposite meaning, since this is being used to
indicate which bits in the IP address should be treated as ”wild”. For example, a CIDR suffix of ”24”
means to use a netmask of ”255.255.255.0”. However, a wildcard mask value of ”24” means that the
least-significant 24-bits are wild, so it forms a netmask of ”255.0.0.0”.
B.6.2
New Physical Port Stats
The ofp_port_stats message has been expanded to return more information. If a switch does not
support a particular field, it should set the value to have all bits enabled (i.e., a ”-1” if the value were
treated as signed). This is the new format:
/* Body of reply to OFPST_PORT request. If a counter is unsupported, set
* the field to all ones. */
struct ofp_port_stats {
uint16_t port_no;
uint8_t pad[6];
/* Align to 64-bits. */
uint64_t rx_packets;
/* Number of received packets. */
uint64_t tx_packets;
/* Number of transmitted packets. */
uint64_t rx_bytes;
/* Number of received bytes. */
uint64_t tx_bytes;
/* Number of transmitted bytes. */
uint64_t rx_dropped;
/* Number of packets dropped by RX. */
uint64_t tx_dropped;
/* Number of packets dropped by TX. */
uint64_t rx_errors;
/* Number of receive errors. This is a super-set
of receive errors and should be great than or
equal to the sum of al rx_*_err values. */
uint64_t tx_errors;
/* Number of transmit errors. This is a super-set
of transmit errors. */
uint64_t rx_frame_err;
/* Number of frame alignment errors. */
uint64_t rx_over_err;
/* Number of packets with RX overrun. */
uint64_t rx_crc_err;
/* Number of CRC errors. */
uint64_t collisions;
/* Number of collisions. */
};
B.6.3
IN PORT Virtual Port
The behavior of sending out the incoming port was not clearly defined in earlier versions of the specification. It is now forbidden unless the output port is explicitly set to OFPP_IN_PORT virtual port
(0xfff8) is set. The primary place where this is used is for wireless links, where a packet is received over
the wireless interface and needs to be sent to another host through the same interface. For example,
if a packet needed to be sent to all interfaces on the switch, two actions would need to be specified:
”actions=output:ALL,output:IN PORT”.
B.6.4
Port and Link Status and Configuration
The switch should inform the controller of changes to port and link status. This is done with a new
flag in ofp_port_config:
ˆ OFPPC_PORT_DOWN - The port has been configured ”down”.
177
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
... and a new flag in ofp_port_state:
ˆ OFPPS_LINK_DOWN - There is no physical link present.
The switch should support enabling and disabling a physical port by modifying the OFPPFL_PORT_DOWN
flag (and mask bit) in the ofp_port_mod message. Note that this is not the same as adding or removing
the interface from the list of OpenFlow monitored ports; it is equivalent to "ifconfig eth0 down" on
Unix systems.
B.6.5
Echo Request/Reply Messages
The switch and controller can verify proper connectivity through the OpenFlow protocol with the new
echo request (OFPT_ECHO_REQUEST) and reply (OFPT_ECHO_REPLY) messages. The body of the message
is undefined and simply contains uninterpreted data that is to be echoed back to the requester. The
requester matches the reply with the transaction id from the OpenFlow header.
B.6.6
Vendor Extensions
Vendors are now able to add their own extensions, while still being OpenFlow compliant. The primary
way to do this is with the new OFPT_VENDOR message type. The message body is of the form:
/* Vendor extension. */
struct ofp_vendor {
struct ofp_header header;
uint32_t vendor;
/* Type OFPT_VENDOR. */
/* Vendor ID:
* - MSB 0: low-order bytes are IEEE OUI.
* - MSB != 0: defined by OpenFlow
*
consortium. */
/* Vendor-defined arbitrary additional data. */
};
The vendor field is a 32-bit value that uniquely identifies the vendor. If the most significant byte is zero,
the next three bytes are the vendor’s IEEE OUI. If vendor does not have (or wish to use) their OUI,
they should contact the OpenFlow consortium to obtain one. The rest of the body is uninterpreted.
It is also possible to add vendor extensions for stats messages with the OFPST_VENDOR stats type. The
first four bytes of the message are the vendor identifier as described earlier. The rest of the body is
vendor-defined.
To indicate that a switch does not understand a vendor extension, a OFPBRC_BAD_VENDOR error code
has been defined under the OFPET_BAD_REQUEST error type.
Vendor-defined actions are described below in the ”Variable Length and Vendor Actions” section.
178
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.6.7
Version 1.4.0
Explicit Handling of IP Fragments
In previous versions of the specification, handling of IP fragments was not clearly defined. The switch
is now able to tell the controller whether it is able to reassemble fragments. This is done with the
following capabilities flag passed in the ofp_switch features message:
OFPC_IP_REASM
= 1 << 5
/* Can reassemble IP fragments. */
The controller can configure fragment handling in the switch through the setting the following new
ofp_config_flags in the ofp_switch_config message:
/* Handling of IP fragments. */
OFPC_FRAG_NORMAL
= 0 << 1, /* No special handling for fragments. */
OFPC_FRAG_DROP
= 1 << 1, /* Drop fragments. */
OFPC_FRAG_REASM
= 2 << 1, /* Reassemble (only if OFPC_IP_REASM set). */
OFPC_FRAG_MASK
= 3 << 1
”Normal” handling of fragments means that an attempt should be made to pass the fragments through
the OpenFlow tables. If any field is not present (e.g., the TCP/UDP ports didn’t fit), then the packet
should not match any entry that has that field set.
B.6.8
802.1D Spanning Tree
OpenFlow now has a way to configure and view results of on-switch implementations of 802.1D Spanning
Tree Protocol.
A switch that implements STP must set the new OFPC_STP bit in the ’capabilities’ field of its
OFPT_FEATURES_REPLY message. A switch that implements STP at all must make it available on all of
its physical ports, but it need not implement it on virtual ports (e.g. OFPP_LOCAL).
Several port configuration flags are associated with STP. The complete set of port configuration flags
are:
enum ofp_port_config {
OFPPC_PORT_DOWN
=
OFPPC_NO_STP
=
OFPPC_NO_RECV
=
OFPPC_NO_RECV_STP =
OFPPC_NO_FLOOD
=
OFPPC_NO_FWD
=
OFPPC_NO_PACKET_IN =
};
1
1
1
1
1
1
1
<<
<<
<<
<<
<<
<<
<<
0,
1,
2,
3,
4,
5,
6
/*
/*
/*
/*
/*
/*
/*
Port is administratively down. */
Disable 802.1D spanning tree on port. */
Drop most packets received on port. */
Drop received 802.1D STP packets. */
Do not include this port when flooding. */
Drop packets forwarded to port. */
Do not send packet-in msgs for port. */
The controller may set OFPPFL_NO_STP to 0 to enable STP on a port or to 1 to disable STP on a port.
(The latter corresponds to the Disabled STP port state.) The default is switch implementation-defined;
the OpenFlow reference implementation by default sets this bit to 0 (enabling STP).
When OFPPFL_NO_STP is 0, STP controls the OFPPFL_NO_FLOOD and OFPPFL_STP_* bits directly.
OFPPFL_NO_FLOOD is set to 0 when the STP port state is Forwarding, otherwise to 1. The bits in
179
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
OFPPFL_STP_MASK are set to one of the other OFPPFL_STP_* values according to the current STP port
state.
When the port flags are changed by STP, the switch sends an OFPT_PORT_STATUS message to notify the controller of the change. The OFPPFL_NO_RECV, OFPPFL_NO_RECV_STP, OFPPFL_NO_FWD, and
OFPPFL_NO_PACKET_IN bits in the OpenFlow port flags may be useful for the controller to implement
STP, although they interact poorly with in-band control.
B.6.9
Modify Actions in Existing Flow Entries
New ofp_flow_mod commands have been added to support modifying the actions of existing entries:
OFPFC_MODIFY and OFPFC_MODIFY_STRICT. They use the match field to describe the entries that should
be modified with the supplied actions. OFPFC_MODIFY is similar to OFPFC_DELETE, in that wildcards
are ”active”. OFPFC_MODIFY_STRICT is similar to OFPFC_DELETE_STRICT, in that wildcards are not
”active”, so both the wildcards and priority must match an entry. When a matching flow is found, only
its actions are modified–information such as counters and timers are not reset.
If the controller uses the OFPFC_ADD command to add an entry that already exists, then the new entry
replaces the old and all counters and timers are reset.
B.6.10
More Flexible Description of Tables
Previous versions of OpenFlow had very limited abilities to describe the tables supported by the switch.
The n_exact, n_compression, and n_general fields in ofp_switch_features have been replaced with
n_tables, which lists the number of tables in the switch.
The behavior of the OFPST_TABLE stat reply has been modified slightly. The ofp_table_stats body now
contains a wildcards field, which indicates the fields for which that particular table supports wildcarding.
For example, a direct look-up hash table would have that field set to zero, while a sequentially searched
table would have it set to OFPFW_ALL. The ofp_table_stats entries are returned in the order that
packets traverse the tables.
When the controller and switch first communicate, the controller will find out how many tables the
switch supports from the Features Reply. If it wishes to understand the size, types, and order in which
tables are consulted, the controller sends a OFPST_TABLE stats request.
B.6.11
Lookup Count in Tables
Table stats returned ofp_table_stats structures now return the number of packets that have been
looked up in the table–whether they hit or not. This is stored in the lookup_count field.
180
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.6.12
Version 1.4.0
Modifying Flags in Port-Mod More Explicit
The ofp_port_mod is used to modify characteristics of a switch’s ports. A supplied ofp_phy_port
structure describes the behavior of the switch through its flags field. However, it’s possible that the
controller wishes to change a particular flag and may not know the current status of all flags. A mask
field has been added which has a bit set for each flag that should be changed on the switch.
The new ofp_port_mod message looks like the following:
/* Modify behavior of the physical port */
struct ofp_port_mod {
struct ofp_header header;
uint32_t mask;
/* Bitmap of "ofp_port_flags" that should be
changed. */
struct ofp_phy_port desc;
};
B.6.13
New Packet-Out Message Format
The previous version’s packet-out message treated the variable-length array differently depending on
whether the buffer_id was set or not. If set, the array consisted of actions to be executed and the
out_port was ignored. If not, the array consisted of the actual packet that should be placed on the
wire through the out_port interface. This was a bit ugly, and it meant that in order for a non-buffered
packet to have multiple actions executed on it, that a new flow entry be created just to match that
entry.
A new format is now used, which cleans the message up a bit. The packet always contains a list of
actions. An additional variable-length array follows the list of actions with the contents of the packet
if buffer_id is not set. This is the new format:
struct ofp_packet_out {
struct ofp_header header;
uint32_t buffer_id;
uint16_t in_port;
uint16_t n_actions;
struct ofp_action actions[0];
/* uint8_t data[0]; */
/*
/*
/*
/*
/*
ID assigned by datapath (-1 if none). */
Packet’s input port (OFPP_NONE if none). */
Number of actions. */
Actions. */
Packet data. The length is inferred
from the length field in the header.
(Only meaningful if buffer_id == -1.) */
};
B.6.14
Hard Timeout for Flow Entries
A hard timeout value has been added to flow entries. If set, then the entry must be expired in the
specified number of seconds regardless of whether or not packets are hitting the entry. A hard_timeout
field has been added to the flow_mod message to support this. The max_idle field has been renamed
idle_timeout. A value of zero means that a timeout has not been set. If both idle_timeout and
hard_timeout are zero, then the flow is permanent and should not be deleted without an explicit
deletion.
181
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The new ofp_flow_mod format looks like this:
struct ofp_flow_mod {
struct ofp_header header;
struct ofp_match match;
/* Fields to match */
/* Flow actions. */
uint16_t command;
uint16_t idle_timeout;
uint16_t hard_timeout;
uint16_t priority;
uint32_t buffer_id;
/*
/*
/*
/*
/*
One of OFPFC_*. */
Idle time before discarding (seconds). */
Max time before discarding (seconds). */
Priority level of flow entry. */
Buffered packet to apply to (or -1).
Not meaningful for OFPFC_DELETE*. */
uint32_t reserved;
/* Reserved for future use. */
struct ofp_action actions[0]; /* The number of actions is inferred from
the length field in the header. */
};
Since flow entries can now be expired due to idle or hard timeouts, a reason field has been added to the
ofp_flow_expired message. A value of 0 indicates an idle timeout and 1 indicates a hard timeout:
enum ofp_flow_expired_reason {
OFPER_IDLE_TIMEOUT,
OFPER_HARD_TIMEOUT
};
/* Flow idle time exceeded idle_timeout. */
/* Time exceeded hard_timeout. */
The new ofp_flow_expired message looks like the following:
struct ofp_flow_expired {
struct ofp_header header;
struct ofp_match match;
/* Description of fields */
uint16_t priority;
uint8_t reason;
uint8_t pad[1];
/* Priority level of flow entry. */
/* One of OFPER_*. */
/* Align to 32-bits. */
uint32_t duration;
uint8_t pad2[4];
uint64_t packet_count;
uint64_t byte_count;
/* Time flow was alive in seconds. */
/* Align to 64-bits. */
};
B.6.15
Reworked initial handshake to support backwards compatibility
OpenFlow now includes a basic ”version negotiation” capability. When an OpenFlow connection is
established, each side of the connection should immediately send an OFPT_HELLO message as its first
OpenFlow message. The ’version’ field in the hello message should be the highest OpenFlow protocol
version supported by the sender. Upon receipt of this message, the recipient may calculate the OpenFlow
protocol version to be used as the smaller of the version number that it sent and the one that it
received.
182
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
If the negotiated version is supported by the recipient, then the connection proceeds. Otherwise, the
recipient must reply with a message of OFPT_ERROR with a ’type’ value of OFPET_HELLO_FAILED, a
’code’ of OFPHFC_COMPATIBLE, and optionally an ASCII string explaining the situation in ’data’, and
then terminate the connection.
The OFPT_HELLO message has no body; that is, it consists only of an OpenFlow header. Implementations
must be prepared to receive a hello message that includes a body, ignoring its contents, to allow for
later extensions.
B.6.16
Description of Switch Stat
The OFPST_DESC stat has been added to describe the hardware and software running on the switch:
#define DESC_STR_LEN
256
#define SERIAL_NUM_LEN 32
/* Body of reply to OFPST_DESC request. Each entry is a NULL-terminated
* ASCII string. */
struct ofp_desc_stats {
char mfr_desc[DESC_STR_LEN];
/* Manufacturer description. */
char hw_desc[DESC_STR_LEN];
/* Hardware description. */
char sw_desc[DESC_STR_LEN];
/* Software description. */
char serial_num[SERIAL_NUM_LEN];
/* Serial number. */
};
It contains a 256 character ASCII description of the manufacturer, hardware type, and software version.
It also contains a 32 character ASCII serial number. Each entry is padded on the right with 0 bytes.
B.6.17
Variable Length and Vendor Actions
Vendor-defined actions have been added to OpenFlow. To enable more versatility, actions have switched
from fixed-length to variable. All actions have the following header:
struct ofp_action_header {
uint16_t type;
uint16_t len;
/* One of OFPAT_*. */
/* Length of action, including this
header. This is the length of action,
including any padding to make it
64-bit aligned. */
uint8_t pad[4];
};
The length for actions must always be a multiple of eight to aid in 64-bit alignment. The action types
are as follows:
183
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
enum ofp_action_type {
OFPAT_OUTPUT,
OFPAT_SET_VLAN_VID,
OFPAT_SET_VLAN_PCP,
OFPAT_STRIP_VLAN,
OFPAT_SET_DL_SRC,
OFPAT_SET_DL_DST,
OFPAT_SET_NW_SRC,
OFPAT_SET_NW_DST,
OFPAT_SET_TP_SRC,
OFPAT_SET_TP_DST,
OFPAT_VENDOR = 0xffff
};
Version 1.4.0
/*
/*
/*
/*
/*
/*
/*
/*
/*
/*
Output to switch port. */
Set the 802.1q VLAN id. */
Set the 802.1q priority. */
Strip the 802.1q header. */
Ethernet source address. */
Ethernet destination address. */
IP source address. */
IP destination address. */
TCP/UDP source port. */
TCP/UDP destination port. */
The vendor-defined action header looks like the following:
struct ofp_action_vendor_header {
uint16_t type;
uint16_t len;
uint32_t vendor;
/* OFPAT_VENDOR. */
/* Length is 8. */
/* Vendor ID, which takes the same form
as in "struct ofp_vendor". */
};
The vendor field uses the same vendor identifier described earlier in the ”Vendor Extensions” section.
Beyond using the ofp_action_vendor header and the 64-bit alignment requirement, vendors are free
to use whatever body for the message they like.
B.6.18
VLAN Action Changes
It is now possible to set the priority field in VLAN tags and stripping VLAN tags is now a separate
action. The OFPAT_SET_VLAN_VID action behaves like the former OFPAT_SET_DL_VLAN action, but no
longer accepts a special value that causes it to strip the VLAN tag. The OFPAT_SET_VLAN_PCP action
modifies the 3-bit priority field in the VLAN tag. For existing tags, both actions only modify the bits
associated with the field being updated. If a new VLAN tag needs to be added, the value of all other
fields is zero.
The OFPAT_SET_VLAN_VID action looks like the following:
struct ofp_action_vlan_vid {
uint16_t type;
uint16_t len;
uint16_t vlan_vid;
uint8_t pad[2];
};
/* OFPAT_SET_VLAN_VID. */
/* Length is 8. */
/* VLAN id. */
The OFPAT_SET_VLAN_PCP action looks like the following:
184
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
struct ofp_action_vlan_pcp {
uint16_t type;
uint16_t len;
uint8_t vlan_pcp;
uint8_t pad[3];
};
Version 1.4.0
/* OFPAT_SET_VLAN_PCP. */
/* Length is 8. */
/* VLAN priority. */
The OFPAT_STRIP_VLAN action takes no argument and strips the VLAN tag if one is present.
B.6.19
Max Supported Ports Set to 65280
What: Increase maximum number of ports to support large vendor switches; was previously 256, chosen
arbitrarily.
Why: The HP 5412 chassis supports 288 ports of Ethernet, and some Cisco switches go much higher.
The current limit (OFPP_MAX) is 255, set to equal the maximum number of ports in a bridge segment in
the 1998 STP spec. The RSTP spec from 2004 supports up to 4096 (12 bits) of ports.
How: Change OFPP_MAX to 65280. (However, out of the box, the reference switch implementation
supports at most 256 ports.)
B.6.20
Send Error Message When Flow Not Added Due To Full Tables
The switch now sends an error message when a flow is added, but cannot because all the tables are full.
The message has an error type of OFPET_FLOW_MOD_FAILED and code of OFPFMFC_ALL_TABLES_FULL. If
the Flow-Mod command references a buffered packet, then actions are not performed on the packet. If
the controller wishes the packet to be sent regardless of whether or not a flow entry is added, then it
should use a Packet-Out directly.
B.6.21
Behavior Defined When Controller Connection Lost
What: Ensure that all switches have at least one common behavior when the controller connection is
lost.
Why: When the connection to the controller is lost, the switch should behave in a well-defined way.
Reasonable behaviors include ’do nothing - let flows naturally timeout’, ’freeze timeouts’, ’become
learning switch’, and ’attempt connection to other controller’. Switches may implement one or more
of these, and network admins may want to ensure that if the controller goes out, they know what the
network can do.
The first is the simplest: ensure that every switch implements a default of ’do nothing - let flows timeout
naturally’. Changes must be done via vendor-specific command line interface or vendor extension
OpenFlow messages.
The second may help ensure that a single controller can work with switches from multiple vendors. The
different failure behaviors, plus ’other’, could be feature bits set for the switch. A switch would still
only have to support the default.
185
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
The worry here is that we may not be able to enumerate in advance the full range of failure behaviors,
which argues for the first approach.
How: Added text to spec: ”In the case that the switch loses contact with the controller, the default
behavior must be to do nothing - to let flows timeout naturally. Other behaviors can be implemented
via vendor-specific command line interface or vendor extension OpenFlow messages.”
B.6.22
ICMP Type and Code Fields Now Matchable
What: Allow matching ICMP traffic based on type or code.
Why: We can’t distinguish between different types of ICMP traffic (e.g., echo replies vs echo requests
vs redirects).
How: Changed spec to allow matching on these fields.
As for implementation: The type and code are each a single byte, so they easily fit in our existing flow
structure. Overload the tp_src field to ICMP type and tp_dst to ICMP code. Since they are only a
single byte, they will reside in the low-byte of these two byte fields (stored in network-byte order). This
will allow a controller to use the existing wildcard bits to wildcard these ICMP fields.
B.6.23
Output Port Filtering for Delete*, Flow Stats and Aggregate Stats
Add support for listing and deleting entries based on an output port.
To support this, an out_port field has been added to the ofp_flow_mod, ofp_flow_stats_request,
and ofp_aggregate_stats_request messages. If an out_port contains a value other than OFPP_NONE,
it introduces a constraint when matching. This constraint is that the rule must contain an output action
directed at that port. Other constraints such as ofp_match structs and priorities are still used; this is
purely an *additional* constraint. Note that to get previous behavior, though, out_port must be set
to OFPP_NONE, since ”0” is a valid port id. This only applies to the delete and delete_strict flow
mod commands; the field is ignored by add, modify, and modify_strict.
B.7
OpenFlow version 0.9
Release date : July 20, 2009
Wire Protocol : 0x98
B.7.1
Failover
The reference implementation now includes a simple failover mechanism. A switch can be configured
with a list of controllers. If the first controller fails, it will automatically switch over to the second
controller on the list.
186
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.7.2
Version 1.4.0
Emergency Flow Cache
The protocol and reference implementation have been extended to allow insertion and management of
emergency flow entries.
Emergency-specific flow entries are inactive until a switch loses connectivity from the controller. If this
happens, the switch invalidates all normal flow table entries and copies all emergency flows into the
normal flow table.
Upon connecting to a controller again, all entries in the flow cache stay active. The controller then has
the option of resetting the flow cache if needed.
B.7.3
Barrier Command
The Barrier Command is a mechanism to get notified when an OpenFlow message has finished executing
on the switch. When a switch receives a Barrier message it must first complete all commands sent before
the Barrier message before executing any commands after it. When all commands before the Barrier
message have completed, it must send a Barrier Reply message back to the controller.
B.7.4
Match on VLAN Priority Bits
There is an optional new feature that allows matching on priority VLAN fields. Pre 0.9, the VLAN id
is a field used in identifying a flow, but the priority bits in the VLAN tag are not. In this release we
include the priority bits as a separate field to identify flows. Matching is possible as either an exact
match on the 3 priority bits, or as a wildcard for the entire 3 bits.
B.7.5
Selective Flow Expirations
Flow expiration messages can now be requested on a per-flow, rather than per-switch granularity.
B.7.6
Flow Mod Behavior
There now is a CHECK_OVERLAP flag to flow mods which requires the switch to do the (potentially more
costly) check that there doesn’t already exist a conflicting flow with the same priority. If there is one,
the mod fails and an error code is returned. Support for this flag is required in an OpenFlow switch.
B.7.7
Flow Expiration Duration
The meaning of the ”duration” field in the Flow Expiration message has been changed slightly. Previously there were conflicting definitions of this in the spec. In 0.9 the value returned will be the time
that the flow was active and not include the timeout period.
187
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.7.8
Version 1.4.0
Notification for Flow Deletes
If a controller deletes a flow it now receives a notification if the notification bit is set. In previous
releases only flow expirations but not delete actions would trigger notifications.
B.7.9
Rewrite DSCP in IP ToS header
There is now an added Flow action to rewrite the DiffServ CodePoint bits part of the IP ToS field in
the IP header. This enables basic support for basic QoS with OpenFlow in some switches. A more
complete QoS framework is planned for a future OpenFlow release.
B.7.10
Port Enumeration now starts at 1
Previous releases of OpenFlow had port numbers start at 0, release 0.9 changes them to start at 1.
B.7.11
Other changes to the Specification
ˆ 6633/TCP is now the recommended default OpenFlow Port. Long term the goal is to get a IANA
approved port for OpenFlow.
ˆ The use of ”Type 1” and ”Type 0” has been depreciated and references to it have been removed.
ˆ Clarified Matching Behavior for Flow Modification and Stats
ˆ Made explicit that packets received on ports that are disabled by spanning tree must follow the
normal flow table processing path.
ˆ Clarified that transaction ID in header should match offending message for OFPET_BAD_REQUEST,
OFPET_BAD_ACTION, OFPET_FLOW_MOD_FAILED.
ˆ Clarified the format for the Strip VLAN Action
ˆ Clarify behavior for packets that are buffered on the switch while switch is waiting for a reply
from controller
ˆ Added the new EPERM Error Type
ˆ Fixed Flow Table Matching Diagram
ˆ Clarified datapath ID 64 bits, up from 48 bits
ˆ Clarified miss-send-len and max-len of output action
B.8
OpenFlow version 1.0
Release date : December 31, 2009
Wire Protocol : 0x01
B.8.1
Slicing
OpenFlow now supports multiple queues per output port. Queues support the ability to provide minimum bandwidth guarantees; the bandwidth allocated to each queue is configurable. The name slicing
is derived from the ability to provide a slice of the available network bandwidth to each queue.
188
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.8.2
Version 1.4.0
Flow cookies
Flows have been extended to include an opaque identifier, referred to as a cookie. The cookie is specified
by the controller when the flow is installed; the cookie will be returned as part of each flow stats and
flow expired message.
B.8.3
User-specifiable datapath description
The OFPST DESC (switch description) reply now includes a datapath description field. This is a userspecifiable field that allows a switch to return a string specified by the switch owner to describe the
switch.
B.8.4
Match on IP fields in ARP packets
The reference implementation can now match on IP fields inside ARP packets. The source and destination protocol address are mapped to the nw src and nw dst fields respecitively, and the opcode is
mapped to the nw proto field.
B.8.5
Match on IP ToS/DSCP bits
OpenFlow now supports matching on the IP ToS/DSCP bits.
B.8.6
Querying port stats for individual ports
Port stat request messages include a port_no field to allow stats for individual ports to be queried.
Port stats for all ports can still be requested by specifying OFPP_NONE as the port number.
B.8.7
Improved flow duration resolution in stats/expiry messages
Flow durations in stats and expiry messages are now expressed with nanosecond resolution. Note that
the accuracy of flow durations in the reference implementation is on the order of milliseconds. (The
actual accuracy is in part dependent upon kernel parameters.)
B.8.8
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
Other changes to the Specification
remove multi_phy_tx spec text and capability bit
clarify execution order of actions
replace SSL refs with TLS
resolve overlap ambiguity
clarify flow mod to non-existing port
clarify port definition
update packet flow diagram
update header parsing diagram for ICMP
189
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
B.9
Version 1.4.0
fix English ambiguity for flow-removed messages
fix async message English ambiguity
note that multiple controller support is undefined
clarify that byte equals octet
note counter wrap-around
removed warning not to build a switch from this specification
OpenFlow version 1.1
Release date : February 28, 2011
Wire Protocol : 0x02
B.9.1
Multiple Tables
Prior versions of the OpenFlow specification did expose to the controller the abstraction of a single
table. The OpenFlow pipeline could internally be mapped to multiple tables, such as having a separate
wildcard and exact match table, but those tables would always act logically as a single table.
OpenFlow 1.1 introduces a more flexible pipeline with multiple tables. Exposing multiple tables has
many advantages. The first advantage is that many hardware have multiple tables internally (for
example L2 table, L3 table, multiple TCAM lookups), and the multiple table support of OpenFlow
may enable to expose this hardware with greater efficiency and flexibility. The second advantage is
that many network deployments combine orthogonal processing of packets (for example ACL, QoS and
routing), forcing all those processing in a single table creates huge ruleset due to the cross product of
individual rules, multiple tables may decouple properly those processing.
The new OpenFlow pipeline with multiple table is quite different from the simple pipeline of prior
OpenFlow versions. The new OpenFlow pipeline expose a set of completely generic tables, supporting
the full match and full set of actions. It’s difficult to build a pipeline abstraction that represent accurately
all possible hardware, therefore OpenFlow 1.1 is based on a generic and flexible pipeline that may be
mapped to the hardware. Some limited table capabilities are available to denote what each table is
capable of supporting.
Packets are processed through the pipeline, they are matched and processed in the first table, and may
be matched and processed in other tables. As it goes through the pipeline, a packet is associated with
an action set, accumulating action, and a generic metadata register. The action set is resolved at the
end of the pipeline and applied to the packet. The metadata can be matched and written at each table
and enables to carry state between tables.
OpenFlow introduces a new protocol object called instruction to control pipeline processing. Actions
which were directly attached to flows in previous versions are now encapsulated in instructions, instructions may apply those actions between tables or accumulate them in the packet action set. Instructions
can also change the metadata, or direct packet to another table.
ˆ
ˆ
ˆ
ˆ
The switch now expose a pipeline with multiple tables
Flow entry have instructions to control pipeline processing
Controller can choose packet traversal of tables via goto instruction
Metadata field (64 bits) can be set and match in tables
190
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
ˆ
ˆ
ˆ
ˆ
ˆ
B.9.2
Version 1.4.0
Packet actions can be merged in packet action set
Packet action set is executed at the end of pipeline
Packet actions can be applied between table stages
Table miss can send to controller, continue to next table or drop
Rudimentary table capability and configuration
Groups
The new group abstraction enables OpenFlow to represent a set of ports as a single entity for forwarding
packets. Different types of groups are provided, to represent different abstractions such as multicasting
or multipathing. Each group is composed of a set group buckets, each group bucket contains the set of
actions to be applied before forwarding to the port. Groups buckets can also forward to other groups,
enabling to chain groups together.
ˆ Group indirection to represent a set of ports
ˆ Group table with 4 types of groups :
– All - used for multicast and flooding
– Select - used for multipath
– Indirect - simple indirection
– Fast Failover - use first live port
ˆ Group action to direct a flow to a group
ˆ Group buckets contains actions related to the individual port
B.9.3
Tags : MPLS & VLAN
Prior versions of the OpenFlow specification had limited VLAN support, it only supported a single
level of VLAN tagging with ambiguous semantic. The new tagging support has explicit actions to add,
modify and remove VLAN tags, and can support multiple level of VLAN tagging. It also adds similar
support the MPLS shim headers.
ˆ Support for VLAN and QinQ, adding, modifying and removing VLAN headers
ˆ Support for MPLS, adding, modifying and removing MPLS shim headers
B.9.4
Virtual ports
Prior versions of the OpenFlow specification assumed that all the ports of the OpenFlow switch were
physical ports. This version of the specification add support for virtual ports, which can represent
complex forwarding abstractions such as LAGs or tunnels.
ˆ Make port number 32 bits, enable larger number of ports
ˆ Enable switch to provide virtual ports as OpenFlow ports
ˆ Augment packet-in to report both virtual and physical ports
191
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.9.5
Version 1.4.0
Controller connection failure
Prior versions of the OpenFlow specification introduced the emergency flow cache as a way to deal
with the loss of connectivity with the controller. The emergency flow cache feature was removed in this
version of the specification, due to the lack of adoption, the complexity to implement it and other issues
with the feature semantic.
This version of the specification adds two simpler modes to deal with the loss of connectivity with the
controller. In fail secure mode, the switch continues operating in OpenFlow mode, until it reconnects to a
controller. In fail standalone mode, the switch revert to using normal processing (Ethernet switching).
ˆ Remove Emergency Flow Cache from spec
ˆ Connection interruption triggers fail secure or fail standalone mode
B.9.6
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
Other changes
Remove 802.1d-specific text from the specification
Cookie Enhancements Proposal - cookie mask for filtering
Set queue action (unbundled from output port action)
Maskable DL and NW address match fields
Add TTL decrement, set and copy actions for IPv4 and MPLS
SCTP header matching and rewriting support
Set ECN action
Define message handling : no loss, may reorder if no barrier
Rename VENDOR APIs to EXPERIMENTER APIs
Many other bug fixes, rewording and clarifications
B.10
OpenFlow version 1.2
Release date : December 5, 2011
Wire Protocol : 0x03
Please refers to the bug tracking ID for more details on each change
B.10.1
Extensible match support
Prior versions of the OpenFlow specification used a static fixed length structure to specify ofp_match,
which prevents flexible expression of matches and prevents inclusion of new match fields. The ofp_match
has been changed to a TLV structure, called OpenFlow Extensible Match (OXM), which dramatically
increases flexibility.
The match fields themselves have been reorganised. In the previous static structure, many fields were
overloaded ; for example tcp.src_port, udp.src_port, and icmp.code were using the same field entry.
Now, every logical field has its own unique type.
List of features for OpenFlow Extensible Match :
ˆ Flexible and compact TLV structure called OXM (EXT-1)
192
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
Version 1.4.0
Enable flexible expression of match, and flexible bitmasking (EXT-1)
Pre-requisite system to insure consistency of match (EXT-1)
Give every match field a unique type, remove overloading (EXT-1)
Modify VLAN matching to be more flexible (EXT-26)
Add vendor classes and experimenter matches (EXT-42)
Allow switches to override match requirements (EXT-56, EXT-33)
B.10.2
Extensible ’set field’ packet rewriting support
Prior versions of the OpenFlow specification were using hand-crafted actions to rewrite header fields.
The Extensible set_field action reuses the OXM encoding defined for matches, and enables to rewrite
any header field in a single action (EXT-13). This allows any new match field, including experimenter
fields, to be available for rewrite. This makes the specification cleaner and eases cost of introducing
new fields.
ˆ Deprecate most header rewrite actions
ˆ Introduce generic set-field action (EXT-13)
ˆ Reuse match TLV structure (OXM) in set-field action
B.10.3
Extensible context expression in ’packet-in’
The packet-in message did include some of the packet context (ingress port), but not all (metadata),
preventing the controller from figuring how match did happen in the table and which flow entries would
match or not match. Rather than introduce a hard coded field in the packet-in message, the flexible
OXM encoding is used to carry packet context.
ˆ
ˆ
ˆ
ˆ
Reuse match TLV structure (OXM) to describe metadata in packet-in (EXT-6)
Include the ’metadata’ field in packet-in
Move ingress port and physical port from static field to OXM encoding
Allow to optionally include packet header fields in TLV structure
B.10.4
Extensible Error messages via experimenter error type
An experimenter error code has been added, enabling experimenter functionality to generate custom
error messages (EXT-2). The format is identical to other experimenter APIs.
B.10.5
IPv6 support added
Basic support for IPv6 match and header rewrite has been added, via the Flexible match support.
ˆ Added support for matching on IPv6 source address, destination address, protocol number, traffic
class, ICMPv6 type, ICMPv6 code and IPv6 neighbor discovery header fields (EXT-1)
ˆ Added support for matching on IPv6 flow label (EXT-36)
193
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.10.6
Version 1.4.0
Simplified behaviour of flow-mod request
The behaviour of flow-mod request has been simplified (EXT-30).
ˆ MODIFY and MODIFY STRICT commands never insert new flows in the table
ˆ New flag OFPFF RESET COUNTS to control counter reset
ˆ Remove quirky behaviour for cookie field.
B.10.7
Removed packet parsing specification
The OpenFlow specification no longer attempts to define how to parse packets (EXT-3). The match
fields are only defined logically.
ˆ OpenFlow does not mandate how to parse packets
ˆ Parsing consistency acheived via OXM pre-requisite
B.10.8
Controller role change mechanism
The controller role change mechanism is a simple mechanism to support multiple controllers for failover
(EXT-39). This scheme is entirely driven by the controllers ; the switch only need to remember the role
of each controller to help the controller election mechanism.
ˆ Simple mechanism to support multiple controllers for failover
ˆ Switches may now connect to multiple controllers in parallel
ˆ Enable each controller to change its roles to equal, master or slave
B.10.9
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
Other changes
Per-table metadata bitmask capabilities (EXT-34)
Rudimentary group capabilities (EXT-61)
Add hard timeout info in flow-removed messages (OFP-283)
Add ability for controller to detect STP support(OFP-285)
Turn off packet buffering with OFPCML NO BUFFER (EXT-45)
Added ability to query all queues (EXT-15)
Added experimenter queue property (EXT-16)
Added max-rate queue property (EXT-21)
Enable deleting flow in all tables (EXT-10)
Enable switch to check chaining when deleting groups (EXT-12)
Enable controller to disable buffering (EXT-45)
Virtual ports renamed logical ports (EXT-78)
New error messages (EXT-1, EXT-2, EXT-12, EXT-13, EXT-39, EXT-74 and EXT-82)
Include release notes into the specification document
Many other bug fixes, rewording and clarifications
194
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.11
Version 1.4.0
OpenFlow version 1.3
Release date : April 13, 2012
Wire Protocol : 0x04
Please refers to the bug tracking ID for more details on each change
B.11.1
Refactor capabilities negotiation
Prior versions of the OpenFlow specification included limited expression of the capabilities of an OpenFlow switch. OpenFlow 1.3 include a more flexible framework to express capabilities (EXT-123).
The main change is the improved description of table capabilities. Those capabilities have been moved
out of the table statistics structure in its own request/reply message, and encoded using a flexible TLV
format. This enables the additions of next-table capabilities, table-miss flow entry capabilities and
experimenter capabilities.
Other changes include renaming the ’stats’ framework into the ’multipart’ framework to reflect the fact
that it is now used for both statistics and capabilities, and the move of port descriptions into its own
multipart message to enable support of a greater number of ports.
List of features for Refactor capabilities negotiation :
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
Rename ’stats’ framework into the ’multipart’ framework.
Enable ’multipart’ requests (requests spanning multiple messages).
Move port list description to its own multipart request/reply.
Move table capabilities to its own multipart request/reply.
Create flexible property structure to express table capabilities.
Enable to express experimenter capabilities.
Add capabilities for table-miss flow entries.
Add next-table (i.e. goto) capabilities
B.11.2
More flexible table miss support
Prior versions of the OpenFlow specification included table configuration flags to select one of three 3
behaviour for handling table-misses (packet not matching any flows in the table). OpenFlow 1.3 replace
those limited flags with the table-miss flow entry, a special flow entry describing the behaviour on table
miss (EXT-108).
The table-miss flow entry uses standard OpenFlow instructions and actions to process table-miss packets,
this enables to use the full flexibility of OpenFlow in processing those packets. All previous behaviour
expressed by the table-miss config flags can be expressed using the table-miss flow entry. Many new
way of handling table-miss, such as processing table-miss with normal, can now trivially be described
by the OpenFlow protocol.
ˆ Remove table-miss config flags (EXT-108).
ˆ Define table-miss flow entry as the all wildcard, lowest priority flow entry (EXT-108).
ˆ Mandate support of the table-miss flow entry in every table to process table-miss packets (EXT108).
195
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
ˆ Add capabilities to describe the table-miss flow entry (EXT-123).
ˆ Change table-miss default to drop packets (EXT-119).
B.11.3
IPv6 Extension Header handling support
Add the ability of match the presence of common IPv6 extension headers, and some anomalous conditions in IPv6 extension headers (EXT-38). A new OXM pseudo header field OXM_OF_IPV6_EXTHDR
enables to match the following conditions :
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
Hop-by-hop IPv6 extension header is present.
Router IPv6 extension header is present.
Fragmentation IPv6 extension header is present.
Destination options IPv6 extension headers is present.
Authentication IPv6 extension header is present.
Encrypted Security Payload IPv6 extension header is present.
No Next Header IPv6 extension header is present.
IPv6 extension headers out of preferred order.
Unexpected IPv6 extension header encountered.
B.11.4
Per flow meters
Add support for per-flow meters (EXT-14). Per-flow meters can be attached to flow entries and can
measure and control the rate of packets. One of the main applications of per-flow meters is to rate limit
packets sent to the controller.
The per-flow meter feature is based on a new flexible meter framework, which includes the ability to
describe complex meters through the use of multiple metering bands, metering statistics and capabilities.
Currently, only simple rate-limiter meters are defined over this framework. Support for color-aware
meters, which support Diff-Serv style operation and are tightly integrated in the pipeline, was postponed
to a later release.
ˆ
ˆ
ˆ
ˆ
Flexible meter framework based on per-flow meters and meter bands.
Meter statistics, including per band statistics.
Enable to attach meters flexibly to flow entries.
Simple rate-limiter support (drop packets).
B.11.5
Per connection event filtering
Previous version of the specification introduced the ability for a switch to connect to multiple controllers
for fault tolerance and load balancing. Per connection event filtering improves the multi-controller
support by enabling each controller to filter events from the switch it does not want (EXT-120).
A new set of OpenFlow messages enables a controller to configure an event filter on its own connection
to the switch. Asynchronous messages can be filtered by type and reason. This event filter comes in
addition to other existing mechanisms that enable or disable asynchronous messages, for example the
generation of flow-removed events can be configured per flow. Each controller can have a separate filter
for the slave role and the master/equal role.
196
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
ˆ
ˆ
ˆ
ˆ
Version 1.4.0
Add asynchronous message filter for each controller connection.
Controller message to set/get the asynchronous message filter.
Set default filter value to match OpenFlow 1.2 behaviour.
Remove OFPC_INVALID_TTL_TO_CONTROLLER config flag.
B.11.6
Auxiliary connections
In previous version of the specification, the channel between the switch and the controller is exclusively
made of a single TCP connection, which does not allow to exploit the parallelism available in most
switch implementations. OpenFlow 1.3 enables a switch to create auxiliary connections to supplement
the main connection between the switch and the controller (EXT-114). Auxiliary connections are mostly
useful to carry packet-in and packet-out messages.
ˆ
ˆ
ˆ
ˆ
Enable switch to create auxiliary connections to the controller.
Mandate that auxiliary connection can not exist when main connection is not alive.
Add auxiliary-id to the protocol to disambiguate the type of connection.
Enable auxiliary connection over UDP and DTLS.
B.11.7
MPLS BoS matching
A new OXM field OXM_OF_MPLS_BOS has been added to match the Bottom of Stack bit (BoS) from the
MPLS header (EXT-85). The BoS bit indicates if other MPLS shim header are in the payload of the
present MPLS packet, and matching this bit can help to disambiguate case where the MPLS label is
reused across levels of MPLS encapsulation.
B.11.8
Provider Backbone Bridging tagging
Add support for tagging packet using Provider Backbone Bridging (PBB) encapsulation (EXT-105).
This support enables OpenFlow to support various network deployment based on PBB, such as regular
PBB and PBB-TE.
ˆ Push and Pop operation to add PBB header as a tag.
ˆ New OXM field to match I-SID for the PBB header.
B.11.9
Rework tag order
In previous version of the specification, the final order of tags in a packet was statically specified. For
example, a MPLS shim header was always inserted after all VLAN tags in the packet. OpenFlow
1.3 removes this restriction, the final order of tags in a packet is dictated by the order of the tagging
operations, each tagging operation adds its tag in the outermost position (EXT-121).
ˆ
ˆ
ˆ
ˆ
Remove defined order of tags in packet from the specification.
Tags are now always added in the outermost possible position.
Action-list can add tags in arbitrary order.
Tag order is predefined for tagging in the action-set.
197
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.11.10
Version 1.4.0
Tunnel-ID metadata
The logical port abstraction enables OpenFlow to support a wide variety of encapsulations. The tunnelid metadata OXM_OF_TUNNEL_ID is a new OXM field that expose to the OpenFlow pipeline metadata
associated with the logical port, most commonly the demultiplexing field from the encapsulation header
(EXT-107).
For example, if the logical port perform GRE encapsulation, the tunnel-id field would map to the GRE
key field from the GRE header. After decapsulation, OpenFlow would be able to match the GRE key
in the tunnel-id match field. Similarly, by setting the tunnel-id, OpenFlow would be able to set the
GRE key in an encapsulated packet.
B.11.11
Cookies in packet-in
A cookie field was added to the packet-in message (EXT-7). This field takes its value from the flow the
sends the packet to the controller. If the packet was not sent by a flow, this field is set to 0xffffffffffffffff.
Having the cookie in the packet-in enables the controller to more efficiently classify packet-in, rather
than having to match the packet against the full flow table.
B.11.12
Duration for stats
A duration field was added to most statistics, including port statistics, group statistics, queue statistics
and meter statistics (EXT-102). The duration field enables to more accurately calculate packet and
byte rate from the counters included in those statistics.
B.11.13
On demand flow counters
New flow-mod flags have been added to disable packet and byte counters on a per-flow basis. Disabling
such counters may improve flow handling performance in the switch.
B.11.14
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
B.12
Other changes
Fix a bug describing VLAN matching (EXT-145).
Flow entry description now mention priority (EXT-115).
Flow entry description now mention timeout and cookies (EXT-147).
Unavailable counters must now be set to all 1 (EXT-130).
Correctly refer to flow entry instead of rule (EXT-132).
Many other bug fixes, rewording and clarifications.
OpenFlow version 1.3.1
Release date : September 06, 2012
Wire Protocol : 0x04
Please refers to the bug tracking ID for more details on each change
198
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.12.1
Version 1.4.0
Improved version negotiation
Prior versions of the OpenFlow specification included a simple scheme for version negotiation, picking
the lowest of the highest version supported by each side. Unfortunately this scheme does not work
properly in all cases, if both implementations don’t implement all versions up to their highest version,
the scheme can fail to negotiate a version they have in common (EXT-157).
The main change is adding a bitmap of version numbers in the Hello messages using during negotiation.
By having the full list of version numbers, negotiation can always negotiate the appropriate version if
one is available. This version bitmap is encoded in a flexible TLV format to retain future extensibility
of the Hello message.
List of features for Improved version negotiation :
ˆ Hello Elements, new flexible TLV format for Hello message
ˆ Optional version bitmap in Hello messages.
ˆ Improve version negotiation using optional version bitmaps.
B.12.2
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
Other changes
Mandate that table-miss flow entry support drop and controller (EXT-158).
Clarify the mapping of encapsulation data in OXM_OF_TUNNEL_ID (EXT-161).
Rules and restrictions for UDP connections (EXT-162).
Clarify virtual meters (EXT-165).
Remove reference to switch fragmentation - confusing (EXT-172).
Fix meter constant names to always be multipart (OFPST_ => OFPMT_) (EXT-184).
Add OFPG_* definitions to spec (EXT-198).
Add ofp_instruction and ofp_table_feature_prop_header in spec text (EXT-200).
Bad error code in connection setup, must be OFPHFC_INCOMPATIBLE (EXT-201).
Instructions must be a multiple of 8 bytes in length (EXT-203).
Port status includes a reason, not a status (EXT-204).
Clarify usage of table config field (EXT-205).
Clarify that required match fields don’t need to be supported in every flow table (EXT-206).
Clarify that prerequisite does not require full match field support (EXT-206).
Include in the spec missing definitions from openflow.h (EXT-207).
Fix invalid error code OFPQCFC_EPERM -> OFPSCFC_EPERM (EXT-208).
Clarify PBB language about B-VLAN (EXT-215)
Fix inversion between source and destination ethernet addresses (EXT-215)
Clarify how to reorder group buckets, and associated group bucket clarifications (EXT-217).
Add disclaimer that release notes may not match specification (EXT-218)
Figure 1 still says ”Secure Channel” (EXT-222).
OpenFlow version must be calculated (EXT-223).
Meter band drop precedence should be increased, not reduced (EXT-225)
Fix ambiguous uses of may/can/should/must (EXT-227)
Fix typos (EXT-228)
Many typos (EXT-231)
199
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.13
Version 1.4.0
OpenFlow version 1.3.2
Release date : April 25, 2013
Wire Protocol : 0x04
Please refers to the bug tracking ID for more details on each change
B.13.1
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
Mandate in OXM that 0-bits in mask must be 0-bits in value (EXT-238).
Allow connection initiated from one of the controllers (EXT-252).
Add clause on frame misordering to spec (EXT-259).
Set table features doesn’t generate flow removed messages (EXT-266).
Fix description of set table features error response (EXT-267).
Define use of generation_id in role reply messages (EXT-272).
Switch with only one flow table are not mandated to implement goto (EXT-280).
B.13.2
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
Changes
Clarifications
Clarify that MPLS Pop action uses Ethertype regardless of BOS bit (EXT-194).
Controller message priorities using auxiliary connections (EXT-240).
Clarify padding rules and variable size arrays (EXT-251).
Better description buffer-id in flow mod (EXT-257).
Semantic of OFPPS_LIVE (EXT-258).
Improve multipart introduction (EXT-263).
Clarify set table features description (EXT-266).
Clarify meter flags and burst fields (EXT-270).
Clarify slave access rights (EXT-271).
Clarify that a switch can’t change a controller role (EXT-276).
Clarify roles of coexisting master and equal controllers (EXT-277).
Various typos and rewording (EXT-282, EXT-288, EXT-290)
B.14
OpenFlow version 1.4.0
Release date : August, 2013
Wire Protocol : 0x05
Please refers to the bug tracking ID for more details on each change
B.14.1
More extensible wire protocol
The OpenFlow protocol was initially designed with many static fixed structures and limited extensibility. The introduction of the OpenFlow Extensible Match (OXM) in version 1.2 added much needed
extensibility in the OpenFlow classifier. In version 1.4, many other parts of the protocol have been
retrofitted with TLV structures for improved extensibility (EXT-262).
200
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
This TLV work affected many areas of the protocol. New TLVs have been added in previously fixed
structures in the form of properties at the end of the structure. In some areas, the existing TLVs have
been changed to use the common property TLV format. TLVs rules have been clarified. This additional
extensibility of the protocol will allow a much easier way to add new features to the protocol in the
future, and also greatly extend the Experimenter Extension API.
ˆ Port structures: add port description properties, add port mod properties and add port stats
properties.
ˆ Table structures: add table mod properties, add table descriptions multipart, add table status
asynchronous message.
ˆ Queue structures: migrate queue description to multipart, convert queue description properties
to standardised TLVs, add queue stats properties.
ˆ Set-async structures: convert set-async-config to TLVs, add set-async experimenter property.
ˆ Instruction structures: clarify instruction TLVs.
ˆ Actions structures: clarify actions TLVs.
ˆ Experimented structures: clarify experimenter TLVs.
ˆ Properties errors: add a set of unified error codes for all properties.
B.14.2
More descriptive reasons for packet-in
The OpenFlow pipeline saw extensive changes since 1.0, however, the reason values in the
ofp_packet_in messages did not change. As a result, many distinct parts of the pipeline are using
the same reason value. Version 1.4 introduces more descriptive reasons, so that the controller can
properly distinguish which part of the pipeline redirected the packet to the controller (EXT-136).
The main change is that the the ”output action” reason OFPR_ACTION is effectively split into four reasons,
”apply-action”, ”action-set”, ”group bucket” and ”packet-out”, representing the four distinct context
where this action is used. The ”no match” reason OFPR_NO_MATCH is renamed to properly reflect the
fact that it is generated by the table miss flow entry.
The new set of reason values for ofp_packet_in message is :
ˆ
ˆ
ˆ
ˆ
ˆ
ˆ
OFPR_TABLE_MISS: No matching flow (table-miss flow entry).
OFPR_APPLY_ACTION: Output to controller in apply-actions.
OFPR_INVALID_TTL: Packet has invalid TTL.
OFPR_ACTION_SET: Output to controller in action set.
OFPR_GROUP: Output to controller in group bucket.
OFPR_PACKET_OUT: Output to controller in packet-out.
B.14.3
Optical port properties
A new set of port properties add support for Optical ports, they include fields to configure and monitor
the transmit and receive frequency of a laser, as well as its power (EXT-154). Those new properties can
be used to configure and monitor either Ethernet optical port or optical ports on circuit switches.
ˆ Optical port mod property ofp_port_mod_prop_optical to configure optical ports.
ˆ Optical port stats property ofp_port_stats_prop_optical to monitor optical ports.
201
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
ˆ Optical port description property ofp_port_desc_prop_optical to describe optical port capabilities.
B.14.4
Flow-removed reason for meter delete
Add a new reason value OFPRR_METER_DELETE for the ofp_flow_removed message to denote that the
flow entry was removed as a result of a meter deletion (EXT-261).
When a meter is deleted on the switch, all the flow entries that use that meter are removed. This
is similar to how group operates. The flow that are removed may generate a flow-removed message
(depending on config). In version 1.3, we did not have a reason for this condition, version 1.4 fixes that
bug.
B.14.5
Flow monitoring
The OpenFlow protocol defines a multi-controller scheme where multiple controller can manage a switch.
Flow monitoring allows a controller to monitor in real time the changes to any subsets of the flow table
done by other controllers (EXT-187).
The flow monitoring framework allows a controller to define a number of monitors, each selecting a
subset of the flow tables. Each monitor includes a table id and a match pattern that defines the subset
monitored. When any flow entry is added, modified or removed in one of the subset defined by a flow
monitor, an event is sent to the controller to inform it of the change.
ˆ Multipart request ofp_flow_monitor_request to set flow monitors on the switch.
ˆ Flow monitor update events sent to controller, with full details using ofp_flow_update_full or
abbreviated using ofp_flow_update_abbrev.
ˆ Monitor flags to define the format of the updates.
ˆ Flow control mechanism to avoid backlog of monitor updates.
B.14.6
Role status events
Version 1.2 of the specification added the ability for a controller to set its role in a multi-controller
environment. When a controller elected itself to “master” role, the previous master controller is demoted
to “slave” role, however that controller was not informed about it. In version 1.4, the Role Status
message enable the switch to inform a controller about change to its role (EXT-191).
ˆ Role status event OFPT_ROLE_STATUS to inform controller to change to role.
ˆ Role status properties for experimenter data, ofp_role_prop_experimenter.
202
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
B.14.7
Version 1.4.0
Eviction
Most flow tables have finite capacity. In previous versions of the specification, when a flow table is full,
new flow entries are not inserted in the flow table and an error is returned to the controller. However,
reaching that point is pretty problematic, as the controller need time to operate on the flow table and
this may cause a disruption of service. Eviction adds a mechanism enabling the switch to automatically
eliminate entries of lower importance to make space for newer entries (EXT-192). This enables to
smoother degradation of behaviour when the table is full.
ˆ Table-mod flag OFPTC_EVICTION to enable or disable eviction on a table.
ˆ Flow-mod importance to optionally denote the importance of a flow entry for eviction.
ˆ Table-desc eviction property ofp_table_mod_prop_eviction to describe the type of eviction
performed by the switch.
B.14.8
Vacancy events
Most flow tables have finite capacity. In previous versions of the specification, when a flow table is full,
new flow entries are not inserted in the flow table and an error is returned to the controller. However,
reaching that point is pretty problematic, as the controller need time to operate on the flow table and
this may cause a disruption of service. Vacancy events adds a mechanism enabling the controller to get
an early warning based on a capacity threshold chosen by the controller (EXT-192). This allows the
controller to react in advance and avoid getting the table full.
ˆ Table status event OFPT_TABLE_STATUS with reasons OFPTR_VACANCY_DOWN and
OFPTR_VACANCY_UP to inform controller of vacancy change.
ˆ Hysteresis mechanism to avoid spurious events using two threshold, vacancy_down and
vacancy_up.
ˆ Table-mod vacancy property to set vacancy thresholds, ofp_table_mod_prop_vacancy.
B.14.9
Bundles
Add the bundle mechanism, enabling to apply a group of OpenFlow message as a single operation
(EXT-230). This enables the quasi-atomic application of related changes, and to better synchronise
changes across a series of switches.
ˆ Bundle control message OFPT_BUNDLE_CONTROL to create, destroy and commit bundles.
ˆ Bundle add message OFPT_BUNDLE_ADD_MESSAGE to add an OpenFlow message into a bundle.
ˆ Bundle error type OFPET_BUNDLE_FAILED to report bundle operation errors.
B.14.10
Synchronised tables
Many switches can perform multiple lookups on the same lookup data. For example, a standard Ethernet
learning table performs a learning lookup and a forwarding lookup on the same set of MAC addresses.
Another example is RPF checks which reuses the IP forwarding data. The synchronised table feature
enables to represent those constructs as a set of two tables which data is synchronised (EXT-232).
203
© 2013; The Open Networking Foundation
OpenFlow Switch Specification
Version 1.4.0
Synchronised table is expressed using a new property in the table feature, OFPTFPT_TABLE_SYNC_FROM.
It defines the synchronisation abstraction between the two flow tables, however it does not define and
express the flow entry transformation between the flow tables.
B.14.11
Group and Meter change notifications
The OpenFlow protocol defines a multi-controller scheme where multiple controller can manage a switch.
Group and Meter change notifications allow a controller to monitor in real time the changes to the group
table or meter table done by other controllers (EXT-235).
The “group-mod” and “meter-mod” requests are simple encapsulated in a OFPT_REQUESTFORWARD asynchronous message sent to other controllers. Those notifications are enabled and disabled via the “setasync-config” message.
B.14.12
Error code for bad priority
Some switches may have restrictions on the priorities that can be used in a table. For example a switch
may be enforcing some “longest prefix match” rule in a table, requiring the priority to be related to the
mask. A new error code, OFPFMFC_BAD_PRIORITY, enables the switch to properly inform the controller
when this happens (EXT-236).
B.14.13
Error code for Set-async-config
The OFPT_GET_ASYNC_REQUEST feature was introduced in version 1.3.0. There was no error messages defined for that features, however it is possible for this request to fail. A new error type,
OFPET_ASYNC_CONFIG_FAILED, which appropriate code, enables the switch to properly inform the controller when this happens (EXT-237).
The set of error codes defined for OFPET_ASYNC_CONFIG_FAILED are :
ˆ OFPACFC_INVALID: One mask is invalid.
ˆ OFPACFC_UNSUPPORTED: Requested configuration not supported.
ˆ OFPACFC_EPERM: Permissions error.
B.14.14
PBB UCA header field
A new OXM field OFPXMT_OFB_PBB_UCA has been added to match the “use customer address” header
field from the PBB header (EXT-256).
B.14.15
Error code for duplicate instruction
The OpenFlow specification defines the instructions included in a flow entry as a set, and that an
instruction can not be duplicated in that set. A new error code, OFPBIC_DUP_INST, enables the switch
to properly inform the controller when flow entries contain duplicate instructions (EXT-237).
204
© 2013; The Open Networking Foundation
B.14.16
Error code for multipart timeout
Multipart request and replies are encoded as a sequence of messages. This version of the specification
defines how to deal with unterminated sequence, some minimum timeout are defined as well as error
codes (EXT-264).
ˆ Define minimum timeout (100 ms) and error code (OFPBRC_MULTIPART_REQUEST_TIMEOUT) for
unterminated multipart request sequences.
ˆ Define minimum timeout (1 s) and error code (OFPBRC_MULTIPART_REPLY_TIMEOUT) for unterminated multipart reply sequences.
B.14.17
Change default TCP port to 6653
IANA allocated to ONF the TCP port number 6653 to be used by the OpenFlow switch protocol.
All uses of the previous port numbers, 6633 and 976, should be discontinued. OpenFlow switches and
OpenFlow controllers must use 6653 by default (when not using a user specified port number).
Appendix C
Credits
Spec contributions, in alphabetical order:
Anders Nygren, Ben Pfaff, Bob Lantz, Brandon Heller, Casey Barker, Curt Beckmann, Dan
Cohn, Dan Malek, Dan Talayco, David Erickson, David McDysan, David Ward, Edward Crabbe,
Fabian Schneider, Glen Gibb, Guido Appenzeller, Jean Tourrilhes, Johann Tonsing, Justin Pettit,
KK Yap, Leon Poutievski, Linda Dunbar, Lorenzo Vicisano, Martin Casado, Masahiko Takahashi,
Masayoshi Kobayashi, Navindra Yadav, Nick McKeown, Nico dHeureuse, Peter Balland, Rajiv
Ramanathan, Reid Price, Rob Sherwood, Saurav Das, Shashidhar Gandham, Tatsuya Yabe, Wanfu
Ding, Yiannis Yiakoumis, Zoltán Lajos Kis.
205
OpenFlow Specification
Version 1.4.0
Disclaimer
WITHOUT LIMITING THE DISCLAIMER ABOVE, THIS SPECIFICATION OF THE
OPEN NETWORKING FOUNDATION (“ONF”) IS SUBJECT TO THE ROYALTY FREE,
REASONABLE AND NONDISCRIMINATORY (“RANDZ”) LICENSING COMMITMENTS
OF THE MEMBERS OF ONF PURSUANT TO THE ONF INTELLECTUAL PROPERTY
RIGHTS POLICY. ONF DOES NOT WARRANT THAT ALL NECESSARY CLAIMS
OF PATENT WHICH MAY BE IMPLICATED BY THE IMPLEMENTATION OF THIS
SPECIFICATION ARE OWNED OR LICENSABLE BY ONF'S MEMBERS AND
THEREFORE SUBJECT TO THE RANDZ COMMITMENT OF THE MEMBERS.
© Open Networking Foundation
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement