OPENFLOW-1.1+

   1                 OpenFlow 1.1+ support in Open vSwitch
   2                 =====================================
   3
   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.
   6
   7 The Plan
   8 --------
   9
  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).
  15
  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.
  19
  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.
  25
  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
  36 ofputil_*.
  37
  38 Here are the current approaches in a few tricky areas:
  39
  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
  44       numbers.
  45
  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.
  50
  51 OpenFlow 1.1
  52 ------------
  53
  54 The list of remaining work items for OpenFlow 1.1 is below.  It is
  55 probably incomplete.
  56
  57     * The new in_phy_port field in OFPT_PACKET_IN needs some kind of
  58       implementation.  It has a sensible interpretation for tunnels
  59       but in general the physical port is not in the datapath for OVS
  60       so the value is not necessarily meaningful.  We might have to
  61       just fix it as the same as in_port.
  62       [required for OF1.1; optional for OF1.2+]
  63
  64     * OFPT_TABLE_MOD message.  This is new in OF1.1, so we need to
  65       implement it.  It should be implemented so that the default OVS
  66       behavior does not change.
  67       [required for OF1.1 and OF1.2]
  68
  69     * MPLS.  Simon Horman maintains a patch series that adds this
  70       feature.  This is partially merged.
  71       [optional for OF1.1+]
  72
  73     * Match and set double-tagged VLANs (QinQ).  This requires kernel
  74       work for reasonable performance.
  75       [optional for OF1.1+]
  76
  77     * VLANs tagged with 88a8 Ethertype.  This requires kernel work for
  78       reasonable performance.
  79       [required for OF1.1+]
  80
  81 OpenFlow 1.2
  82 ------------
  83
  84 OpenFlow 1.2 support requires OpenFlow 1.1 as a prerequisite. All the
  85 additional work specific to Openflow 1.2 are complete.  (This is based
  86 on the change log at the end of the OF1.2 spec.  I didn't compare the
  87 specs carefully yet.)
  88
  89 OpenFlow 1.3
  90 ------------
  91
  92 OpenFlow 1.3 support requires OpenFlow 1.2 as a prerequisite, plus the
  93 following additional work.  (This is based on the change log at the
  94 end of the OF1.3 spec, reusing most of the section titles directly.  I
  95 didn't compare the specs carefully yet.)
  96
  97     * Add support for multipart requests.
  98       Currently we always report OFPBRC_MULTIPART_BUFFER_OVERFLOW.
  99       [optional for OF1.3+]
 100
 101     * Add OFPMP_TABLE_FEATURES statistics.
 102       [optional for OF1.3+]
 103
 104     * More flexible table miss support.
 105       This requires the following.
 106       - Change the default table-miss action (in the absense of table-miss
 107         entry) from packet_in to drop for OF1.3+.  Decide what to do if
 108         a switch is configured to support multiple OF versions.
 109       [required for OF1.3+]
 110
 111     * IPv6 extension header handling support.  Fully implementing this
 112       requires kernel support.  This likely will take some careful and
 113       probably time-consuming design work.  The actual coding, once
 114       that is all done, is probably 2 or 3 days work.
 115       [optional for OF1.3+]
 116
 117     * Per-flow meters.  OpenFlow protocol support is now implemented.
 118       Support for the special OFPM_SLOWPATH and OFPM_CONTROLLER meters
 119       is missing.  Support for the software switch is under review.
 120       [optional for OF1.3+]
 121
 122     * Auxiliary connections.  An implementation in generic code might
 123       be a week's worth of work.  The value of an implementation in
 124       generic code is questionable, though, since much of the benefit
 125       of axuiliary connections is supposed to be to take advantage of
 126       hardware support.  (We could make the kernel module somehow
 127       send packets across the auxiliary connections directly, for
 128       some kind of "hardware" support, if we judged it useful enough.)
 129       [optional for OF1.3+]
 130
 131     * MPLS BoS matching.
 132       Part of MPLS patchset by Simon Horman.
 133       [optional for OF1.3+]
 134
 135     * Provider Backbone Bridge tagging.  I don't plan to implement
 136       this (but we'd accept an implementation).
 137       [optional for OF1.3+]
 138
 139     * Rework tag order.
 140       Part of MPLS patchset by Simon Horman.
 141       [required for v1.3+]
 142
 143     * On-demand flow counters.  I think this might be a real
 144       optimization in some cases for the software switch.
 145       [optional for OF1.3+]
 146
 147 ONF OpenFlow Exensions for 1.3.X Pack1
 148 --------------------------------------
 149
 150 OpenFlow 1.3 has a bunch of ONF extentions.
 151 Many of them are necessary for OpenFlow 1.4 as well.
 152
 153     * Flow entry notifications
 154       This seems to be modelled after OVS's NXST_FLOW_MONITOR.
 155       [EXT-187]
 156       [required for OF1.4+]
 157
 158     * Role Status
 159       [EXT-191]
 160       [required for OF1.4+]
 161
 162     * Flow entry eviction
 163       OVS has flow eviction functionality.
 164       table_mod OFPTC_EVICTION, flow_mod 'importance', and
 165       table_desc ofp_table_mod_prop_eviction need to be implemented.
 166       [EXT-192-e]
 167       [optional for OF1.4+]
 168
 169     * Vacancy events
 170       [EXT-192-v]
 171       [optional for OF1.4+]
 172
 173     * Bundle
 174       Transactional modification.  OpenFlow 1.4 requires to support
 175       flow_mods and port_mods in a bundle.
 176       (Not related to OVS's 'ofbundle' stuff.)
 177       [EXT-230]
 178       [required for OF1.4+]
 179
 180     * Table synchronisation
 181       [EXT-232]
 182       [optional for OF1.4+]
 183
 184     * Group notifications
 185       [EXT-235]
 186       [optional for OF1.4+]
 187
 188     * Bad flow entry priority error
 189       Probably not so useful to the software switch.
 190       [EXT-236]
 191       [optional for OF1.4+]
 192
 193     * Set async config error
 194       [EXT-237]
 195       [optional for OF1.4+]
 196
 197     * PBB UCA header field
 198       [EXT-256]
 199       [optional for OF1.4+]
 200
 201     * Duplicate instruction error
 202       We already have ONFBIC_DUP_INSTRUCTION.
 203       [EXT-260]
 204       [required for OF1.4+]
 205
 206     * Multipart timeout error
 207       [EXT-264]
 208       [required for OF1.4+]
 209
 210 OpenFlow 1.4
 211 ------------
 212
 213     * More extensible wire protocol
 214       Many on-wire structures got TLVs.
 215       [EXT-262]
 216       [required for OF1.4+]
 217
 218     * More descriptive reasons for packet-in
 219       Distinguish OFPR_APPLY_ACTION, OFPR_ACTION_SET, OFPR_GROUP,
 220       OFPR_PACKET_OUT.  NO_MATCH was renamed to OFPR_TABLE_MISS.
 221       [EXT-136]
 222       [required for OF1.4+]
 223
 224     * Optical port properties
 225       [EXT-154]
 226       [optional for OF1.4+]
 227
 228     * Flow-removed reason for meter delete
 229       Report flow removal due to meter deletion with OFPRR_METER_DELETE.
 230       [EXT-261]
 231       [optional for OF1.4+]
 232
 233     * Meter notifications
 234       [EXT-235]
 235       [optional for OF1.4+]
 236
 237 General
 238 -----
 239
 240     * ovs-ofctl(8) often lists as Nicira extensions features that
 241       later OpenFlow versions support in standard ways.
 242
 243 How to contribute
 244 -----------------
 245
 246 If you plan to contribute code for a feature, please let everyone know
 247 on ovs-dev before you start work.  This will help avoid duplicating
 248 work.
 249
 250 Please consider the following:
 251
 252     * Testing.  Please test your code.
 253
 254     * Unit tests.  Please consider writing some.  The tests directory
 255       has many examples that you can use as a starting point.
 256
 257     * ovs-ofctl.  If you add a feature that is useful for some
 258       ovs-ofctl command then you should add support for it there.
 259
 260     * Documentation.  If you add a user-visible feature, then you
 261       should document it in the appropriate manpage and mention it in
 262       NEWS as well.
 263
 264     * Coding style (see the CodingStyle file at the top of the source
 265       tree).
 266
 267     * The patch submission guidelines (see SubmittingPatches).  I
 268       recommend using "git send-email", which automatically follows a
 269       lot of those guidelines.
 270
 271 Bug Reporting
 272 -------------
 273
 274 Please report problems to bugs@openvswitch.org.