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