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     * Implement Write-Actions instruction.
  58
  59     * The new in_phy_port field in OFPT_PACKET_IN needs some kind of
  60       implementation.  It has a sensible interpretation for tunnels
  61       but in general the physical port is not in the datapath for OVS
  62       so the value is not necessarily meaningful.  We might have to
  63       just fix it as the same as in_port.
  64
  65     * OFPT_TABLE_MOD stats.  This is new in OF1.1, so we need to
  66       implement it.  It should be implemented so that the default OVS
  67       behavior does not change.
  68
  69     * MPLS.  Simon Horman maintains a patch series that adds this
  70       feature.  This is partially merged.
  71
  72     * SCTP.  Joe Stringer maintains a patch series that adds this
  73       feature.  It has received review comments that need to be
  74       addressed before it is merged.
  75
  76     * Match and set double-tagged VLANs (QinQ).  This requires kernel
  77       work for reasonable performance.
  78
  79     * VLANs tagged with 88a8 Ethertype.  This requires kernel work for
  80       reasonable performance.
  81
  82     * Groups.
  83
  84 OpenFlow 1.2
  85 ------------
  86
  87 OpenFlow 1.2 support requires OpenFlow 1.1 as a prerequisite, plus the
  88 following additional work.  (This is based on the change log at the
  89 end of the OF1.2 spec.  I didn't compare the specs carefully yet.)
  90
  91     * OFPT_FLOW_MOD:
  92
  93         * New flag OFPFF_RESET_COUNTS.
  94
  95         * Add ability to delete flow in all tables.
  96
  97         * Update DESIGN to describe OF1.2 behavior also.
  98
  99 OpenFlow 1.3
 100 ------------
 101
 102 OpenFlow 1.3 support requires OpenFlow 1.2 as a prerequisite, plus the
 103 following additional work.  (This is based on the change log at the
 104 end of the OF1.3 spec, reusing most of the section titles directly.  I
 105 didn't compare the specs carefully yet.)
 106
 107     * Add support for multipart requests.
 108
 109     * Add OFPMP_TABLE_FEATURES statistics.
 110
 111     * More flexible table miss support.
 112
 113     * IPv6 extension header handling support.  Fully implementing this
 114       requires kernel support.  This likely will take some careful and
 115       probably time-consuming design work.  The actual coding, once
 116       that is all done, is probably 2 or 3 days work.
 117
 118     * Per-flow meters.  Similar to IPv6 extension headers in kernel
 119       and design requirements.  Might be politically difficult to add
 120       directly to the kernel module, since its functionality overlaps
 121       with tc.  Ideally, therefore, we could implement these somehow
 122       with tc, but I haven't investigated whether that makes sense.
 123
 124     * Per-connection event filtering.  OF1.3 adopted Open vSwitch's
 125       existing design for this feature so implementation should be
 126       easy.
 127
 128     * Auxiliary connections.  These are optional, so a minimal
 129       implementation would not need them.  An implementation in
 130       generic code might be a week's worth of work.  The value of an
 131       implementation in generic code is questionable, though, since
 132       much of the benefit of axuiliary connections is supposed to be
 133       to take advantage of hardware support.  (We could make the
 134       kernel module somehow send packets across the auxiliary
 135       connections directly, for some kind of "hardware" support, if we
 136       judged it useful enough.)
 137
 138     * MPLS BoS matching.  (Included in Simon's MPLS series?)
 139
 140     * Provider Backbone Bridge tagging.  I don't plan to implement
 141       this (but we'd accept an implementation).
 142
 143     * Rework tag order.  I'm not sure whether we need to do anything
 144       for this.
 145
 146     * Duration for queue stats.  (Duration for port stats is already
 147       implemented.)
 148
 149     * On-demand flow counters.  I think this might be a real
 150       optimization in some cases for the software switch.
 151
 152 How to contribute
 153 -----------------
 154
 155 If you plan to contribute code for a feature, please let everyone know
 156 on ovs-dev before you start work.  This will help avoid duplicating
 157 work.
 158
 159 Please consider the following:
 160
 161     * Testing.  Please test your code.
 162
 163     * Unit tests.  Please consider writing some.  The tests directory
 164       has many examples that you can use as a starting point.
 165
 166     * ovs-ofctl.  If you add a feature that is useful for some
 167       ovs-ofctl command then you should add support for it there.
 168
 169     * Documentation.  If you add a user-visible feature, then you
 170       should document it in the appropriate manpage and mention it in
 171       NEWS as well.
 172
 173     * Coding style (see the CodingStyle file at the top of the source
 174       tree).
 175
 176     * The patch submission guidelines (see SubmittingPatches).  I
 177       recommend using "git send-email", which automatically follows a
 178       lot of those guidelines.
 179
 180 Bug Reporting
 181 -------------
 182
 183 Please report problems to bugs@openvswitch.org.