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