OPENFLOW-1.1+.md

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