ofproto-dpif: Store relevant fields for wildcarding in facet.
[sliver-openvswitch.git] / NEWS
1 post-v1.11.0
2 ---------------------
3     - OpenFlow:
4       * New support for matching outer source and destination IP address
5         of tunneled packets, for tunnel ports configured with the newly
6         added "remote_ip=flow" and "local_ip=flow" options.
7     - New "check-oftest" Makefile target for running OFTest against Open
8       vSwitch.  See README-OFTest for details.
9     - The flow eviction threshold has been moved to the Open_vSwitch table.
10
11
12 v1.11.0 - xx xxx xxxx
13 ---------------------
14     - The "tutorial" directory contains a new tutorial for some advanced
15       Open vSwitch features.
16     - Stable bond mode has been removed.
17     - The autopath action has been removed.
18     - New support for the data encapsulation format of the LISP tunnel
19       protocol (RFC 6830).  An external control plane or manual flow
20       setup is required for EID-to-RLOC mapping.
21     - OpenFlow:
22       * The "dec_mpls_ttl" and "set_mpls_ttl" actions from OpenFlow
23         1.1 and later are now implemented.
24       * New "stack" extension for use in actions, to push and pop from
25         NXM fields.
26       * The "load" and "set_field" actions can now modify the "in_port".  (This
27         allows one to enable output to a flow's input port by setting the
28         in_port to some unused value, such as OFPP_NONE.)
29     - ovs-dpctl:
30       * New debugging commands "add-flow", "mod-flow", "del-flow".
31     - In dpif-based bridges, cache action translations, which can improve
32       flow set up performance by 80% with a complicated flow table.
33     - New syslog format, prefixed with "ovs|", to be easier to filter.
34     - RHEL: Removes the default firewall rule that allowed GRE traffic to
35       pass through. Any users that relied on this automatic firewall hole
36       will have to manually configure it. The ovs-ctl(8) manpage documents
37       the "enable-protocol" command that can be used as an alternative.
38     - New CFM demand mode which uses data traffic to indicate interface
39       liveness.
40
41 v1.10.0 - 01 May 2013
42 ---------------------
43     - Bridge compatibility support has been removed.  Any uses that
44       rely on ovs-brcompatd will have to stick with Open vSwitch 1.9.x
45       or adapt to native Open vSwitch support (e.g. use ovs-vsctl instead
46       of brctl).
47     - The maximum size of the MAC learning table is now configurable.
48     - With the Linux datapath, packets for new flows are now queued
49       separately on a per-port basis, so it should no longer be
50       possible for a large number of new flows arriving on one port to
51       prevent new flows from being processed on other ports.
52     - ovs-vsctl:
53       * Previously ovs-vsctl would retry connecting to the database forever,
54         causing it to hang if ovsdb-server was not running.  Now, ovs-vsctl
55         only tries once by default (use --retry to try forever).  This change
56         means that you may want to remove uses of --timeout to avoid hangs
57         in ovs-vsctl calls.
58       * Many "ovs-vsctl" database commands now accept an --if-exists option.
59         Please refer to the ovs-vsctl manpage for details.
60     - OpenFlow:
61       - Experimental support for newer versions of OpenFlow.  See
62         the "What versions of OpenFlow does Open vSwitch support?"
63         question in the FAQ for more details.
64       - The OpenFlow "dp_desc" may now be configured by setting the
65         value of other-config:dp-desc in the Bridge table.
66       - It is possible to request the OpenFlow port number with the
67         "ofport_request" column in the Interface table.
68       - The NXM flow_removed message now reports the OpenFlow table ID
69         from which the flow was removed.
70     - Tunneling:
71       - New support for the VXLAN tunnel protocol (see the IETF draft here:
72         http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03).
73       - Tunneling requires the version of the kernel module paired with
74         Open vSwitch 1.9.0 or later.
75       - Inheritance of the Don't Fragment bit in IP tunnels (df_inherit)
76         is no longer supported.
77       - Path MTU discovery is no longer supported.
78       - CAPWAP tunneling support removed.
79       - Tunnels with multicast destination ports are no longer supported.
80     - ovs-dpctl:
81       - The "dump-flows" and "del-flows" no longer require an argument
82         if only one datapath exists.
83     - ovs-appctl:
84       - New "vlog/disable-rate-limit" and "vlog/enable-rate-limit"
85         commands available allow control over logging rate limits.
86       - New "dpif/dump-dps", "dpif/show", and "dpif/dump-flows" command
87         that mimic the equivalent ovs-dpctl commands.
88     - The ofproto library is now responsible for assigning OpenFlow port
89       numbers.  An ofproto implementation should assign them when
90       port_construct() is called.
91     - All dpif-based bridges of a particular type share a common
92       datapath called "ovs-<type>", e.g. "ovs-system".  The ovs-dpctl
93       commands will now return information on that shared datapath.  To
94       get the equivalent bridge-specific information, use the new
95       "ovs-appctl dpif/*" commands.
96     - Backward-incompatible changes:
97       - Earlier Open vSwitch versions treated ANY as a wildcard in flow
98         syntax.  OpenFlow 1.1 adds a port named ANY, which introduces a
99         conflict.  ANY was rarely used in flow syntax, so we chose to
100         retire that meaning of ANY in favor of the OpenFlow 1.1 meaning.
101     - Patch ports no longer require kernel support, so they now work
102       with FreeBSD and the kernel module built into Linux 3.3 and later.
103     - New "sample" action.
104
105
106 v1.9.0 - 26 Feb 2013
107 ------------------------
108     - Datapath:
109       - Support for ipv6 set action.
110       - SKB mark matching and setting.
111       - support for Linux kernels up to 3.8
112     - FreeBSD is now a supported platform, thanks to code contributions from
113       Gaetano Catalli, Ed Maste, and Giuseppe Lettieri.
114     - ovs-bugtool: New --ovs option to report only OVS related information.
115     - New %t and %T log escapes to identify the subprogram within a
116       cooperating group of processes or threads that emitted a log message.
117       The default log patterns now include this information.
118     - OpenFlow:
119       - Allow bitwise masking for SHA and THA fields in ARP, SLL and TLL
120         fields in IPv6 neighbor discovery messages, and IPv6 flow label.
121       - Adds support for writing to the metadata field for a flow.
122     - Tunneling:
123       - The tunneling code no longer assumes input and output keys are
124         symmetric.  If they are not, PMTUD needs to be disabled for
125         tunneling to work. Note this only applies to flow-based keys.
126       - New support for a nonstandard form of GRE that supports a 64-bit key.
127       - Tunnel Path MTU Discovery default value was set to 'disabled'.
128         This feature is deprecated and will be removed soon.
129       - Tunnel header caching removed.
130     - ovs-ofctl:
131       - Commands and actions that accept port numbers now also accept keywords
132         that represent those ports (such as LOCAL, NONE, and ALL).  This is
133         also the recommended way to specify these ports, for compatibility
134         with OpenFlow 1.1 and later (which use the OpenFlow 1.0 numbers
135         for these ports for different purposes).
136     - ovs-dpctl:
137       - Support requesting the port number with the "port_no" option in
138         the "add-if" command.
139     - ovs-pki: The "online PKI" features have been removed, along with
140       the ovs-pki-cgi program that facilitated it, because of some
141       alarmist insecurity claims.  We do not believe that these claims
142       are true, but because we do not know of any users for this
143       feature it seems better on balance to remove it.  (The ovs-pki-cgi
144       program was not included in distribution packaging.)
145     - ovsdb-server now enforces the immutability of immutable columns.  This
146       was not enforced in earlier versions due to an oversight.
147     - The following features are now deprecated.  They will be removed no
148       earlier than February 2013.  Please email dev@openvswitch.org with
149       concerns.
150         - Bridge compatibility.
151         - Stable bond mode.
152         - The autopath action.
153         - Interface type "null".
154         - Numeric values for reserved ports (see "ovs-ofctl" note above).
155         - Tunnel Path MTU Discovery.
156         - CAPWAP tunnel support.
157     - The data in the RARP packets can now be matched in the same way as the
158       data in ARP packets.
159
160
161 v1.8.0 - 26 Feb 2013
162 ------------------------
163     *** Internal only release ***
164     - New FAQ.  Please send updates and additions!
165     - Authors of controllers, please read the new section titled "Action
166       Reproduction" in DESIGN, which describes an Open vSwitch change in
167       behavior in corner cases that may affect some controllers.
168     - ovs-l3ping:
169         - A new test utility that can create L3 tunnel between two Open
170           vSwitches and detect connectivity issues.
171     - ovs-ofctl:
172         - New --sort and --rsort options for "dump-flows" command.
173         - "mod-port" command can now control all OpenFlow config flags.
174     - OpenFlow:
175       - Allow general bitwise masking for IPv4 and IPv6 addresses in
176         IPv4, IPv6, and ARP packets.  (Previously, only CIDR masks
177         were allowed.)
178       - Allow support for arbitrary Ethernet masks.  (Previously, only
179         the multicast bit in the destination address could be individually
180         masked.)
181       - New field OXM_OF_METADATA, to align with OpenFlow 1.1.
182       - The OFPST_QUEUE request now reports an error if a specified port or
183         queue does not exist, or for requests for a specific queue on all
184         ports, if the specified queue does not exist on any port.  (Previous
185         versions generally reported an empty set of results.)
186       - New "flow monitor" feature to allow controllers to be notified of
187         flow table changes as they happen.
188     - Additional protocols are not mirrored and dropped when forward-bpdu is
189       false.  For a full list, see the ovs-vswitchd.conf.db man page.
190     - Open vSwitch now sends RARP packets in situations where it previously
191       sent a custom protocol, making it consistent with behavior of QEMU and
192       VMware.
193     - All Open vSwitch programs and log files now show timestamps in UTC,
194       instead the local timezone, by default.
195
196
197 v1.7.0 - 30 Jul 2012
198 ------------------------
199     - kernel modules are renamed. openvswitch_mod.ko is now
200       openvswitch.ko and brcompat_mod.ko is now brcompat.ko.
201     - Increased the number of NXM registers to 8.
202     - Added ability to configure DSCP setting for manager and controller
203       connections.  By default, these connections have a DSCP value of
204       Internetwork Control (0xc0).
205     - Added the granular link health statistics, 'cfm_health', to an
206       interface.
207     - OpenFlow:
208         - Added support to mask nd_target for ICMPv6 neighbor discovery flows.
209         - Added support for OpenFlow 1.3 port description (OFPMP_PORT_DESC)
210           multipart messages.
211     - ovs-ofctl:
212         - Added the "dump-ports-desc" command to retrieve port
213           information using the new port description multipart messages.
214     - ovs-test:
215         - Added support for spawning ovs-test server from the client.
216         - Now ovs-test is able to automatically create test bridges and ports.
217     - "ovs-dpctl dump-flows" now prints observed TCP flags in TCP flows.
218     - Tripled flow setup performance.
219     - The "coverage/log" command previously available through ovs-appctl
220       has been replaced by "coverage/show".  The new command replies with
221       coverage counter values, instead of logging them.
222
223
224 v1.6.1 - 25 Jun 2012
225 ------------------------
226     - Allow OFPP_CONTROLLER as the in_port for packet-out messages.
227
228
229 v1.6.0 - 24 Feb 2012
230 ------------------------
231     *** Internal only release ***
232     - bonding
233         - LACP bonds no longer fall back to balance-slb when negotiations fail.
234           Instead they drop traffic.
235         - The default bond_mode changed from SLB to active-backup, to protect
236           unsuspecting users from the significant risks of SLB bonds (which are
237           documented in vswitchd/INTERNALS).
238         - Load balancing can be disabled by setting the bond-rebalance-interval
239           to zero.
240     - OpenFlow:
241         - Added support for bitwise matching on TCP and UDP ports.
242           See ovs-ofctl(8) for more information.
243         - NXM flow dumps now include times elapsed toward idle and hard
244           timeouts.
245         - Added an OpenFlow extension NXT_SET_ASYNC_CONFIG that allows
246           controllers more precise control over which OpenFlow messages they
247           receive asynchronously.
248         - New "fin_timeout" action.
249         - Added "fin_timeout" support to "learn" action.
250         - New Nicira action NXAST_CONTROLLER that offers additional features
251           over output to OFPP_CONTROLLER.
252     - When QoS settings for an interface do not configure a default queue
253       (queue 0), Open vSwitch now uses a default configuration for that
254       queue, instead of dropping all packets as in previous versions.
255     - Logging:
256         - Logging to console and file will have UTC timestamp as a default for
257           all the daemons. An example of the default format is
258           2012-01-27T16:35:17Z.  ovs-appctl can be used to change the default
259           format as before.
260         - The syntax of commands and options to set log levels was simplified,
261           to make it easier to remember.
262     - New support for limiting the number of flows in an OpenFlow flow
263       table, with configurable policy for evicting flows upon
264       overflow.  See the Flow_Table table in ovs-vswitch.conf.db(5)
265       for more information.
266     - New "enable-async-messages" column in the Controller table.  If set to
267       false, OpenFlow connections to the controller will initially have all
268       asynchronous messages disabled, overriding normal OpenFlow behavior.
269     - ofproto-provider interface:
270         - "struct rule" has a new member "used" that ofproto implementations
271           should maintain by updating with ofproto_rule_update_used().
272     - ovsdb-client:
273         - The new option --timestamp causes the "monitor" command to print
274           a timestamp with every update.
275     - CFM module CCM broadcasts can now be tagged with an 802.1p priority.
276
277
278 v1.5.0 - 01 Jun 2012
279 ------------------------
280     - OpenFlow:
281         - Added support for querying, modifying, and deleting flows
282           based on flow cookie when using NXM.
283         - Added new NXM_PACKET_IN format.
284         - Added new NXAST_DEC_TTL action.
285     - ovs-ofctl:
286         - Added daemonization support to the monitor and snoop commands.
287     - ovs-vsctl:
288         - The "find" command supports new set relational operators
289           {=}, {!=}, {<}, {>}, {<=}, and {>=}.
290     - ovsdb-tool now uses the typical database and schema installation
291       directories as defaults.
292     - The default MAC learning timeout has been increased from 60 seconds
293       to 300 seconds.  The MAC learning timeout is now configurable.
294
295
296 v1.4.0 - 30 Jan 2012
297 ------------------------
298     - Compatible with Open vSwitch kernel module included in Linux 3.3.
299     - New "VLAN splinters" feature to work around buggy device drivers
300       in old Linux versions.  (This feature is deprecated.  When
301       broken device drivers are no longer in widespread use, we will
302       delete this feature.)  See ovs-vswitchd.conf.db(5) for more
303       information.
304     - OpenFlow:
305        - Added ability to match on IPv6 flow label through NXM.
306        - Added ability to match on ECN bits in IPv4 and IPv6 through NXM.
307        - Added ability to match on TTL in IPv4 and IPv6 through NXM.
308        - Added ability to modify ECN bits in IPv4.
309        - Added ability to modify TTL in IPv4.
310     - ovs-vswitchd:
311        - Don't require the "normal" action to use mirrors.  Traffic will
312          now be properly mirrored for any flows, regardless of their
313          actions.
314        - Track packet and byte statistics sent on mirrors.
315        - The sFlow implementation can now usually infer the correct agent
316          device instead of having to be told explicitly.
317     - ovs-appctl:
318       - New "fdb/flush" command to flush bridge's MAC learning table.
319     - ovs-test:
320       - A new distributed testing tool that allows one to diagnose performance
321         and connectivity issues. This tool currently is not included in RH or
322         Xen packages.
323     - RHEL packaging now supports integration with Red Hat network scripts.
324     - bonding:
325       - Post 1.4.*, OVS will be changing the default bond mode from balance-slb
326         to active-backup.  SLB bonds carry significant risks with them
327         (documented vswitchd/INTERNALS) which we want to prevent unsuspecting
328         users from running into.  Users are advised to update any scripts or
329         configuration which may be negatively impacted by explicitly setting
330         the bond mode which they want to use.
331
332
333 v1.3.0 - 09 Dec 2011
334 ------------------------
335     - OpenFlow:
336       - Added an OpenFlow extension which allows the "output" action to accept
337         NXM fields.
338       - Added an OpenFlow extension for flexible learning.
339       - Bumped number of NXM registers from four to five.
340     - ovs-appctl:
341       - New "version" command to determine version of running daemon.
342       - If no argument is provided for "cfm/show", displays detailed
343         information about all interfaces with CFM enabled.
344       - If no argument is provided for "lacp/show", displays detailed
345         information about all ports with LACP enabled.
346     - ovs-dpctl:
347       - New "set-if" command to modify a datapath port's configuration.
348     - ovs-vswitchd:
349       - The software switch now supports 255 OpenFlow tables, instead
350         of just one.  By default, only table 0 is consulted, but the
351         new NXAST_RESUBMIT_TABLE action can look up in additional
352         tables.  Tables 128 and above are reserved for use by the
353         switch itself; please use only tables 0 through 127.
354       - Add support for 802.1D spanning tree (STP).
355     - Fragment handling extensions:
356       - New OFPC_FRAG_NX_MATCH fragment handling mode, in which L4
357         fields are made available for matching in fragments with
358         offset 0.
359       - New NXM_NX_IP_FRAG match field for matching IP fragments (usable
360         via "ip_frag" in ovs-ofctl).
361       - New ovs-ofctl "get-frags" and "set-frags" commands to get and set
362         fragment handling policy.
363     - CAPWAP tunneling now supports an extension to transport a 64-bit key.
364       By default it remains compatible with the old version and other
365       standards-based implementations.
366     - Flow setups are now processed in a round-robin manner across ports
367       to prevent any single client from monopolizing the CPU and conducting
368       a denial of service attack.
369     - Added support for native VLAN tagging.  A new "vlan_mode"
370       parameter can be set for "port". Possible values: "access",
371       "trunk", "native-tagged" and "native-untagged".
372     - test-openflowd has been removed.  Please use ovs-vswitchd instead.
373
374 v1.2.0 - 03 Aug 2011
375 ------------------------
376     - New "ofproto" abstraction layer to ease porting to hardware
377       switching ASICs.
378     - Packaging for Red Hat Enterprise Linux 5.6 and 6.0.
379     - Datapath support for Linux kernels up to 3.0.
380     - OpenFlow:
381       - New "bundle" and "bundle_load" action extensions.
382     - Database:
383       - Implement table unique constraints.
384       - Support cooperative locking between callers.
385     - ovs-dpctl:
386       - New "-s" option for "show" command prints packet and byte
387         counters for each port.
388     - ovs-ofctl:
389       - New "--readd" option for "replace-flows".
390     - ovs-vsctl:
391       - New "show" command to print an overview of configuration.
392       - New "comment" command to add remark that explains intentions.
393     - ovs-brcompatd has been rewritten to fix long-standing bugs.
394     - ovs-openflowd has been renamed test-openflowd and moved into the
395       tests directory.  Its presence confused too many users.  Please
396       use ovs-vswitchd instead.
397     - New ovs-benchmark utility to test flow setup performance.
398     - A new log level "off" has been added.  Configuring a log facility
399       "off" prevents any messages from being logged to it.  Previously,
400       "emer" was effectively "off" because no messages were ever logged at
401       level "emer".  Now, errors that cause a process to exit are logged
402       at "emer" level.
403     - "configure" option --with-l26 has been renamed --with-linux, and
404       --with-l26-source has been renamed --with-linux-source.  The old
405       names will be removed after the next release, so please update
406       your scripts.
407     - The "-2.6" suffix has been dropped from the datapath/linux-2.6 and
408       datapath/linux-2.6/compat-2.6 directories.
409     - Feature removals:
410       - Dropped support for "tun_id_from_cookie" OpenFlow extension.
411            Please use the extensible match extensions instead.
412       - Removed the Maintenance_Point and Monitor tables in an effort
413         to simplify 802.1ag configuration.
414     - Performance and scalability improvements
415     - Bug fixes
416
417 v1.1.0 - 05 Apr 2011
418 ------------------------
419     - Ability to define policies over IPv6
420     - LACP
421     - 802.1ag CCM
422     - Support for extensible match extensions to OpenFlow
423     - QoS:
424       - Support for HFSC qdisc.
425       - Queue used by in-band control can now be configured.
426     - Kernel:
427       - Kernel<->userspace interface has been reworked and should be
428         close to a stable ABI now.
429       - "Port group" concept has been dropped.
430     - GRE over IPSEC tunnels
431     - Bonding:
432       - New active backup bonding mode.
433       - New L4 hashing support when LACP is enabled.
434       - Source MAC hash now includes VLAN field also.
435       - miimon support.
436     - Greatly improved handling of large flow tables
437     - ovs-dpctl:
438       - "show" command now prints full vport configuration.
439       - "dump-groups" command removed since kernel support for
440         port groups was dropped.
441     - ovs-vsctl:
442       - New commands for working with the new Managers table.
443       - "list" command enhanced with new formatting options and --columns
444         option.
445       - "get" command now accepts new --id option.
446       - New "find" command.
447     - ovs-ofctl:
448       - New "queue-stats" command for printing queue stats.
449       - New commands "replace-flows" and "diff-flows".
450       - Commands to add and remove flows can now read from files.
451       - New --flow-format option to enable or disable NXM.
452       - New --more option to increase OpenFlow message verbosity.
453       - Removed "tun-cookie" command, which is no longer useful.
454     - ovs-controller enhancements for testing various features.
455     - New ovs-vlan-test command for testing for Linux kernel driver VLAN
456       bugs.  New ovs-vlan-bug-workaround command for enabling and
457       disabling a workaround for these driver bugs.
458     - OpenFlow support:
459       - "Resubmit" actions now update flow statistics.
460       - New "register" extension for use in matching and actions, via NXM.
461       - New "multipath" experimental action extension.
462       - New support for matching multicast Ethernet frames, via NXM.
463       - New extension for OpenFlow vendor error codes.
464       - New extension to set the QoS output queue without actually
465         sending to an output port.
466       - Open vSwitch now reports a single flow table, instead of
467         separate hash and wildcard tables.  This better models the
468         current implementation.
469       - New experimental "note" action.
470       - New "ofproto/trace" ovs-appctl command and associated utilities
471         to ease debugging complex flow tables.
472     - Database:
473       - Schema documentation now includes an entity-relationship diagram.
474       - The database is now garbage collected.  In most tables,
475         unreferenced rows will be deleted automatically.
476       - Many tables now include statistics updated periodically by
477         ovs-vswitchd or ovsdb-server.
478       - Every table now has an "external-ids" column for use by OVS
479         integrators.
480       - There is no default controller anymore.  Each bridge must have its
481         controller individually specified.
482       - The "fail-mode" is now a property of a Bridge instead of a Controller.
483       - New versioning and checksum features.
484       - New Managers table and manager_options column in Open_vSwitch table
485         for specifying managers.  The old "managers" column in the
486         Open_vSwitch table has been removed.
487       - Many "name" columns are now immutable.
488     - Feature removals:
489       - Dropped support for XenServer pre-5.6.100.
490       - Dropped support for Linux pre-2.6.18.
491       - Dropped controller discovery support.
492       - Dropped "ovs-ofctl status" and the OpenFlow extension that it used.
493         Statistics reporting in the database is a rough equivalent.
494       - Dropped the "corekeeper" package (now separate, at
495         http://openvswitch.org/cgi-bin/gitweb.cgi?p=corekeeper).
496     - Performance and scalability improvements
497     - Bug fixes
498
499 v1.1.0pre2 - 13 Sep 2010
500 ------------------------
501     - Bug fixes
502
503 v1.1.0pre1 - 31 Aug 2010
504 ------------------------
505     - OpenFlow 1.0 slicing (QoS) functionality
506     - Python bindings for configuration database (no write support)
507     - Performance and scalability improvements
508     - Bug fixes
509
510 v1.0.1 - 31 May 2010
511 --------------------
512     - New "patch" interface type
513     - Bug fixes
514
515 v1.0.0 - 15 May 2010
516 --------------------
517     - Configuration database with remote management
518     - OpenFlow 1.0
519     - GRE tunneling
520     - Support for XenServer 5.5 and 5.6
521     - Performance and scalability improvements
522     - Bug fixes
523
524 v0.99.2 - 18 Feb 2010
525 ---------------------
526     - Bug fixes
527
528 v0.99.1 - 25 Jan 2010
529 ---------------------
530     - Add support for sFlow(R)
531     - Make headers compatible with C++
532     - Bug fixes
533
534 v0.99.0 - 14 Jan 2010
535 ---------------------
536     - User-space forwarding engine
537     - Bug fixes
538
539 v0.90.7 - 29 Nov 2009
540 ---------------------
541     - Add support for NetFlow active timeouts
542     - Bug fixes
543
544 v0.90.6 - 6 Oct 2009
545 --------------------
546     - Bug fixes
547
548 v0.90.5 - 21 Sep 2009
549 ---------------------
550     - Generalize in-band control to more diverse network setups
551     - Bug fixes