1 OpenFlow 1.1+ support in Open vSwitch
2 =====================================
4 Open vSwitch support for OpenFlow 1.1, 1.2, and 1.3 is a work in
5 progress. This file describes the work still to be done.
10 OpenFlow version support is not a build-time option. A single build
11 of Open vSwitch must be able to handle all supported versions of
12 OpenFlow. Ideally, even at runtime it should be able to support all
13 protocol versions at the same time on different OpenFlow bridges (and
14 perhaps even on the same bridge).
16 At the same time, it would be a shame to litter the core of the OVS
17 code with lots of ugly code concerned with the details of various
18 OpenFlow protocol versions.
20 The primary approach to compatibility is to abstract most of the
21 details of the differences from the core code, by adding a protocol
22 layer that translates between OF1.x and a slightly higher-level
23 abstract representation. The core of this approach is the many struct
24 ofputil_* structures in lib/ofp-util.h.
26 As a consequence of this approach, OVS cannot use OpenFlow protocol
27 definitions that closely resemble those in the OpenFlow specification,
28 because openflow.h in different versions of the OpenFlow specification
29 defines the same identifier with different values. Instead,
30 openflow-common.h contains definitions that are common to all the
31 specifications and separate protocol version-specific headers contain
32 protocol-specific definitions renamed so as not to conflict,
33 e.g. OFPAT10_ENQUEUE and OFPAT11_ENQUEUE for the OpenFlow 1.0 and 1.1
34 values for OFPAT_ENQUEUE. Generally, in cases of conflict, the
35 protocol layer will define a more abstract OFPUTIL_* or struct
38 Here are the current approaches in a few tricky areas:
40 * Port numbering. OpenFlow 1.0 has 16-bit port numbers and later
41 OpenFlow versions have 32-bit port numbers. For now, OVS
42 support for later protocol versions requires all port numbers to
43 fall into the 16-bit range, translating the reserved OFPP_* port
46 * Actions. OpenFlow 1.0 and later versions have very different
47 ideas of actions. OVS reconciles by translating all the
48 versions' actions (and instructions) to and from a common
49 internal representation.
54 The list of remaining work items for OpenFlow 1.1 is below. It is
57 * Implement Write-Actions instruction.
60 * The new in_phy_port field in OFPT_PACKET_IN needs some kind of
61 implementation. It has a sensible interpretation for tunnels
62 but in general the physical port is not in the datapath for OVS
63 so the value is not necessarily meaningful. We might have to
64 just fix it as the same as in_port.
65 [required for OF1.1; optional for OF1.2+]
67 * OFPT_TABLE_MOD message. This is new in OF1.1, so we need to
68 implement it. It should be implemented so that the default OVS
69 behavior does not change.
70 [required for OF1.1 and OF1.2]
72 * MPLS. Simon Horman maintains a patch series that adds this
73 feature. This is partially merged.
76 * Match and set double-tagged VLANs (QinQ). This requires kernel
77 work for reasonable performance.
80 * VLANs tagged with 88a8 Ethertype. This requires kernel work for
81 reasonable performance.
104 OpenFlow 1.2 support requires OpenFlow 1.1 as a prerequisite. All the
105 additional work specific to Openflow 1.2 are complete. (This is based
106 on the change log at the end of the OF1.2 spec. I didn't compare the
107 specs carefully yet.)
112 OpenFlow 1.3 support requires OpenFlow 1.2 as a prerequisite, plus the
113 following additional work. (This is based on the change log at the
114 end of the OF1.3 spec, reusing most of the section titles directly. I
115 didn't compare the specs carefully yet.)
117 * Send errors for unsupported multipart requests.
118 [required for OF1.3+]
120 * Add support for multipart requests.
121 [optional for OF1.3+]
123 * Add OFPMP_TABLE_FEATURES statistics.
124 [optional for OF1.3+]
126 * More flexible table miss support.
127 [required for OF1.3+]
129 * IPv6 extension header handling support. Fully implementing this
130 requires kernel support. This likely will take some careful and
131 probably time-consuming design work. The actual coding, once
132 that is all done, is probably 2 or 3 days work.
133 [optional for OF1.3+]
135 * Per-flow meters. Similar to IPv6 extension headers in kernel
136 and design requirements. Might be politically difficult to add
137 directly to the kernel module, since its functionality overlaps
138 with tc. Ideally, therefore, we could implement these somehow
139 with tc, but I haven't investigated whether that makes sense.
140 [optional for OF1.3+]
142 * Per-connection event filtering. OF1.3 adopted Open vSwitch's
143 existing design for this feature so implementation should be
145 [required for OF1.3+]
147 * Auxiliary connections. An implementation in generic code might
148 be a week's worth of work. The value of an implementation in
149 generic code is questionable, though, since much of the benefit
150 of axuiliary connections is supposed to be to take advantage of
151 hardware support. (We could make the kernel module somehow
152 send packets across the auxiliary connections directly, for
153 some kind of "hardware" support, if we judged it useful enough.)
154 [optional for OF1.3+]
156 * MPLS BoS matching. (Included in Simon's MPLS series?)
157 [optional for OF1.3+]
159 * Provider Backbone Bridge tagging. I don't plan to implement
160 this (but we'd accept an implementation).
161 [optional for OF1.3+]
163 * Rework tag order. I'm not sure whether we need to do anything
164 for this. Part of MPLS patchset by Simon Horman.
167 * On-demand flow counters. I think this might be a real
168 optimization in some cases for the software switch.
169 [optional for OF1.3+]
171 ONF OpenFlow Exensions for 1.3.X Pack1
172 --------------------------------------
174 OpenFlow 1.3 has a bunch of ONF extentions.
175 Many of them are necessary for OpenFlow 1.4 as well.
177 * Flow entry notifications
178 This seems to be modelled after OVS's NXST_FLOW_MONITOR.
180 [required for OF1.4+]
184 [required for OF1.4+]
186 * Flow entry eviction
187 OVS has flow eviction functionality.
188 table_mod OFPTC_EVICTION, flow_mod 'importance', and
189 table_desc ofp_table_mod_prop_eviction need to be implemented.
191 [optional for OF1.4+]
195 [optional for OF1.4+]
198 Transactional modification. OpenFlow 1.4 requires to support
199 flow_mods and port_mods in a bundle.
200 (Not related to OVS's 'ofbundle' stuff.)
202 [required for OF1.4+]
204 * Table synchronisation
206 [optional for OF1.4+]
208 * Group notifications
210 [optional for OF1.4+]
212 * Bad flow entry priority error
213 Probably not so useful to the software switch.
215 [optional for OF1.4+]
217 * Set async config error
219 [optional for OF1.4+]
221 * PBB UCA header field
223 [optional for OF1.4+]
225 * Duplicate instruction error
226 We already have ONFBIC_DUP_INSTRUCTION.
228 [required for OF1.4+]
230 * Multipart timeout error
232 [required for OF1.4+]
237 * More extensible wire protocol
238 Many on-wire structures got TLVs.
240 [required for OF1.4+]
242 * More descriptive reasons for packet-in
243 Distinguish OFPR_APPLY_ACTION, OFPR_ACTION_SET, OFPR_GROUP,
244 OFPR_PACKET_OUT. NO_MATCH was renamed to OFPR_TABLE_MISS.
246 [required for OF1.4+]
248 * Optical port properties
250 [optional for OF1.4+]
252 * Flow-removed reason for meter delete
253 Report flow removal due to meter deletion with OFPRR_METER_DELETE.
255 [optional for OF1.4+]
257 * Meter notifications
259 [optional for OF1.4+]
264 If you plan to contribute code for a feature, please let everyone know
265 on ovs-dev before you start work. This will help avoid duplicating
268 Please consider the following:
270 * Testing. Please test your code.
272 * Unit tests. Please consider writing some. The tests directory
273 has many examples that you can use as a starting point.
275 * ovs-ofctl. If you add a feature that is useful for some
276 ovs-ofctl command then you should add support for it there.
278 * Documentation. If you add a user-visible feature, then you
279 should document it in the appropriate manpage and mention it in
282 * Coding style (see the CodingStyle file at the top of the source
285 * The patch submission guidelines (see SubmittingPatches). I
286 recommend using "git send-email", which automatically follows a
287 lot of those guidelines.
292 Please report problems to bugs@openvswitch.org.