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     * Groups.
  82
  83         * Type all
  84           [required for OF1.1+]
  85
  86         * Type select
  87           [optional for OF1.1+]
  88
  89         * Type indirect
  90           [required for OF1.1+]
  91
  92         * Type fast failover
  93           [optional for OF1.1+]
  94
  95         * Statistics
  96           [optional for OF1.1+]
  97
  98 OpenFlow 1.2
  99 ------------
 100
 101 OpenFlow 1.2 support requires OpenFlow 1.1 as a prerequisite. All the
 102 additional work specific to Openflow 1.2 are complete.  (This is based
 103 on the change log at the end of the OF1.2 spec.  I didn't compare the
 104 specs carefully yet.)
 105
 106     * Action translation needs some work to transform OpenFlow 1.1
 107       field modification actions into OpenFlow 1.2+ "set-field"
 108       actions, because OpenFlow 1.2 dropped support for the OF1.1
 109       actions.
 110
 111 OpenFlow 1.3
 112 ------------
 113
 114 OpenFlow 1.3 support requires OpenFlow 1.2 as a prerequisite, plus the
 115 following additional work.  (This is based on the change log at the
 116 end of the OF1.3 spec, reusing most of the section titles directly.  I
 117 didn't compare the specs carefully yet.)
 118
 119     * Add support for multipart requests.
 120       [optional for OF1.3+]
 121
 122     * Add OFPMP_TABLE_FEATURES statistics.
 123       [optional for OF1.3+]
 124
 125     * More flexible table miss support.
 126       This requires the following.
 127       - Change the default table-miss action (in the absense of table-miss
 128         entry) from packet_in to drop for OF1.3+.  Decide what to do if
 129         a switch is configured to support multiple OF versions.
 130       [required for OF1.3+]
 131
 132     * IPv6 extension header handling support.  Fully implementing this
 133       requires kernel support.  This likely will take some careful and
 134       probably time-consuming design work.  The actual coding, once
 135       that is all done, is probably 2 or 3 days work.
 136       [optional for OF1.3+]
 137
 138     * Per-flow meters.  Similar to IPv6 extension headers in kernel
 139       and design requirements.  Might be politically difficult to add
 140       directly to the kernel module, since its functionality overlaps
 141       with tc.  Ideally, therefore, we could implement these somehow
 142       with tc, but I haven't investigated whether that makes sense.
 143       [optional for OF1.3+]
 144
 145     * Per-connection event filtering.  OF1.3 adopted Open vSwitch's
 146       existing design for this feature so implementation should be
 147       easy.
 148       [required for OF1.3+]
 149
 150     * Auxiliary connections.  An implementation in generic code might
 151       be a week's worth of work.  The value of an implementation in
 152       generic code is questionable, though, since much of the benefit
 153       of axuiliary connections is supposed to be to take advantage of
 154       hardware support.  (We could make the kernel module somehow
 155       send packets across the auxiliary connections directly, for
 156       some kind of "hardware" support, if we judged it useful enough.)
 157       [optional for OF1.3+]
 158
 159     * MPLS BoS matching.  (Included in Simon's MPLS series?)
 160       [optional for OF1.3+]
 161
 162     * Provider Backbone Bridge tagging.  I don't plan to implement
 163       this (but we'd accept an implementation).
 164       [optional for OF1.3+]
 165
 166     * Rework tag order.  I'm not sure whether we need to do anything
 167       for this. Part of MPLS patchset by Simon Horman.
 168       [required for v1.3+]
 169
 170     * On-demand flow counters.  I think this might be a real
 171       optimization in some cases for the software switch.
 172       [optional for OF1.3+]
 173
 174 ONF OpenFlow Exensions for 1.3.X Pack1
 175 --------------------------------------
 176
 177 OpenFlow 1.3 has a bunch of ONF extentions.
 178 Many of them are necessary for OpenFlow 1.4 as well.
 179
 180     * Flow entry notifications
 181       This seems to be modelled after OVS's NXST_FLOW_MONITOR.
 182       [EXT-187]
 183       [required for OF1.4+]
 184
 185     * Role Status
 186       [EXT-191]
 187       [required for OF1.4+]
 188
 189     * Flow entry eviction
 190       OVS has flow eviction functionality.
 191       table_mod OFPTC_EVICTION, flow_mod 'importance', and
 192       table_desc ofp_table_mod_prop_eviction need to be implemented.
 193       [EXT-192-e]
 194       [optional for OF1.4+]
 195
 196     * Vacancy events
 197       [EXT-192-v]
 198       [optional for OF1.4+]
 199
 200     * Bundle
 201       Transactional modification.  OpenFlow 1.4 requires to support
 202       flow_mods and port_mods in a bundle.
 203       (Not related to OVS's 'ofbundle' stuff.)
 204       [EXT-230]
 205       [required for OF1.4+]
 206
 207     * Table synchronisation
 208       [EXT-232]
 209       [optional for OF1.4+]
 210
 211     * Group notifications
 212       [EXT-235]
 213       [optional for OF1.4+]
 214
 215     * Bad flow entry priority error
 216       Probably not so useful to the software switch.
 217       [EXT-236]
 218       [optional for OF1.4+]
 219
 220     * Set async config error
 221       [EXT-237]
 222       [optional for OF1.4+]
 223
 224     * PBB UCA header field
 225       [EXT-256]
 226       [optional for OF1.4+]
 227
 228     * Duplicate instruction error
 229       We already have ONFBIC_DUP_INSTRUCTION.
 230       [EXT-260]
 231       [required for OF1.4+]
 232
 233     * Multipart timeout error
 234       [EXT-264]
 235       [required for OF1.4+]
 236
 237 OpenFlow 1.4
 238 ------------
 239
 240     * More extensible wire protocol
 241       Many on-wire structures got TLVs.
 242       [EXT-262]
 243       [required for OF1.4+]
 244
 245     * More descriptive reasons for packet-in
 246       Distinguish OFPR_APPLY_ACTION, OFPR_ACTION_SET, OFPR_GROUP,
 247       OFPR_PACKET_OUT.  NO_MATCH was renamed to OFPR_TABLE_MISS.
 248       [EXT-136]
 249       [required for OF1.4+]
 250
 251     * Optical port properties
 252       [EXT-154]
 253       [optional for OF1.4+]
 254
 255     * Flow-removed reason for meter delete
 256       Report flow removal due to meter deletion with OFPRR_METER_DELETE.
 257       [EXT-261]
 258       [optional for OF1.4+]
 259
 260     * Meter notifications
 261       [EXT-235]
 262       [optional for OF1.4+]
 263
 264 How to contribute
 265 -----------------
 266
 267 If you plan to contribute code for a feature, please let everyone know
 268 on ovs-dev before you start work.  This will help avoid duplicating
 269 work.
 270
 271 Please consider the following:
 272
 273     * Testing.  Please test your code.
 274
 275     * Unit tests.  Please consider writing some.  The tests directory
 276       has many examples that you can use as a starting point.
 277
 278     * ovs-ofctl.  If you add a feature that is useful for some
 279       ovs-ofctl command then you should add support for it there.
 280
 281     * Documentation.  If you add a user-visible feature, then you
 282       should document it in the appropriate manpage and mention it in
 283       NEWS as well.
 284
 285     * Coding style (see the CodingStyle file at the top of the source
 286       tree).
 287
 288     * The patch submission guidelines (see SubmittingPatches).  I
 289       recommend using "git send-email", which automatically follows a
 290       lot of those guidelines.
 291
 292 Bug Reporting
 293 -------------
 294
 295 Please report problems to bugs@openvswitch.org.