== opendataplane (1.15.0.0)

=== new features
odp v1.15.0.0 continues the preview of tiger moth, introducing new apis and
extensions, as well as numerous bug fixes and functional improvements.

==== deprecation framework
to permit smoother evolution of the odp api specification, a deprecation
framework is introduced to permit controlled deprecation.

when an odp api or defined struct parameter is deprecated, odp validation
tests will be updated to no longer use that api and instead use the
replacement api. by default, attempts to compile with the older api/feature
will fail and applications wishing to move to the new odp release should be
updated to use the replacement api. to permit evaluation of new odp
releases in advance of such updating, however, odp supports the `configure`
option `--enable-deprecated`, which makes the obsolete apis visible again.

this feature will be used on a case-by-case basis and documented in the
release notes for each release that introduces replacement api(s). in general
the deprecated forms will not be maintained for more than a single release
cycle. after that they will no longer be present in the api specification and
the replacement forms must be used to compile with that level of the api
specification.

==== apis
a number of new and refined apis are introduced in crypto, packet parsing,
and queue configuration:

===== crypto enhancements
the odp crypto apis receive several enhancements in this release:

====== new authentication algorithms
additional enumerations added for hmac-sha-1 and hmac-sha-512 authentication.

====== deprecated cipher/authentication algorithms
the following cipher/authentication algorithms have been deprecated in favor
of newer replacement algorithms:

* `odp_cipher_alg_aes128_cbc` is replaced by `odp_cipher_alg_aes_cbc`
* `odp_cipher_alg_aes128_gcm` is replaced by `odp_cipher_alg_aes_gcm`
* `odp_auth_alg_md5_96` is replaced by `odp_auth_alg_md5_hmac`
* `odp_auth_alg_sha256_128` is replaced by `odp_auth_alg_sha256_hmac`
* `odp_auth_alg_aes128_gcm1 is replaced by `odp_auth_alg_aes_gcm`

====== deprecated name for crypto parameter struct
`odp_crypto_op_params_t` is deprecated in favor of `odp_crypto_op_param_t`
for consistency with other odp `param` structs.

====== digest length session parameter
`odp_crypto_session_param_t` adds the field `auth_digest_len` to permit
specification of the authentication digest length to be used for this
session. the `odp_crypto_auth_capability()` api returns the list of
supported digest lengths.

====== additional authentication data (aad)
the `odp_crypto_op_param_t` struct adds an optional pointer and length for
aad information. this allows applications to specify aad information from
the list of supported lengths provided by `odp_crypto_auth_capability()`.

===== packet range data
the former `odp_crypto_data_range_t` type is deprecated and renamed to
`odp_packet_data_range_t` since it can be used to specify ranges for other
than crypto purposes.

===== parser configuration
applications may now specify the maximum packet layer of interest. for
example, a router may not care about anything beyond iso layer 3 in packets.
this can be used by odp implementations to control the depth of packet
parsing needed by the application and may allow greater efficiency,
especially in software implementations.

this is controlled by a new `odp_pktio_parser_layer_t` enum that is
part of the new `odp_pktio_parser_config_t` struct that is added to the
`odp_pktio_config_t` struct used by the `odp_pktio_config()` api. the
supported parser layers are also returned in this struct as part of the
`odp_pktio_capability_t` struct returned by the `odp_pktio_capability()` api.

===== queue size parameter
the `odp_queue_capability_t` struct returned by the `odp_queue_capability()`
api is enhanced as follows:
* the `max_queues` field is now defined to return the maximum number of event
queues of any type.
* new sub-structs (`plain` and `sched`) are added that detail the `max_num` of
queues of that type supported as well as the new field `max_size` that
specifies the maximum number of elements that each queue of this type can
store. a value of zero for `max_num` indicates no fixed limit.

in addition, the `odp_queue_param_t` passed to `odp_queue_create()` now adds
a `size` field to allow applications to specify the minimum number of events
that this queue should be able to store. a value of zero specified requests that
the implementation default limits be used.

the odp examples have been updated to show this configuration, for example,
the `l2fwd_simple` example does layer 2 forwarding and hence doesn't need
packets to be parsed beyond layer 2. so prior to opening an interface via
`odp_pktio_open()` the configuration processing now includes code of the form:
[source,c]
-----
odp_pktio_config_init(&config);
config.parser.layer = odp_pktio_parser_layer_l2;
odp_pktio_config(pktio, &config);
-----
this serves as a hint to the odp implementation that parsing beyond layer 2
is not required on this interface.

===== removal of `odp_time_to_u64()` api
the `odp_time_to_u64()` api is removed without deprecation in this release.
this is redundant since the `odp_time_to_ns()` api already returns a `uint64_t`
value for `odp_time_t` and can be used for the same purpose.

===== new `odp_sys_info_print()` api
for debugging / diagnostic use, the `odp_sys_info_print()` api is added.
this prints implementation defined information about the system and odp
environment and may contain information about cpus, memory, and other
hardware configuration.

=== helpers
==== linux helpers
odp helper functions fall into two categories: system-independent, and those
that rely on linux. for backwards compatibility, these have been
reorganized into a new `helper/linux` directory that is installed only when
the `--enable-helper-linux` `configure` option is specified.

=== `odp-linux` performance
==== scheduler improvements
the default scheduler is streamlined by using precomputed weight tables and
separated priority queues for different scheduling groups. this improves
both latency and scalability.

also included in this change, the default number of scheduling groups is
lowered from 256 to 32, which experience has shown is sufficient for most
applications.

the scheduler fairness checks are also enhanced to avoid low priority event
starvation if `config_burst_size` is set to 1.

=== `odp_linux` crypto improvements
* errors in implicit packet copy operations performed during crypto operation
are now handled properly.
* if `odp_crypto_session_create()` fails, proper cleanup is now performed to
avoid memory leaks.
* the auth digest len is now used when calculating hmacs, and full-length
digests are now added to supported sha capabilities.
* numerous crypto functions have been rewritten to use the openssl `evp_`
functions for improved efficiency and accuracy.

=== `odp-linux` packet improvements
* the packet parser now recognizes icmpv6 packets in addition to icmpv4.

=== `odp-linux` pktio improvements
* the `ethtool` and `socket` drivers add additional initializations to avoid
valgrind warnings.
* the `dpdk` driver is upgraded to dpdk 17.02 and is now also built with the
`--whole-archive` option, which means that pmds no longer need to be linked
individually but are automatically included in builds that make use of dpdk
pktio support.

=== `odp-linux` time improvements
* the odp time apis are now more efficiently handled by replacing the previous
linux timespec with simple nanoseconds (ns) and using native hardware time
counters in x86 and arm environments, when available.

=== `odp-linux` traffic manager improvements
* weighting is now handled properly when weight=1 is specified. previously
this caused an overflow that distorted packet priorities.

=== miscellaneous fixes and improvements
==== native clang build on armv8
armv8 compilation now works properly when using the clang compiler.

==== test improvements
* the `odp_scheduling` performance test now handles dequeueing from
potentially concurrent queues properly.
* the traffic manager and time tests are now invoked via scripts to better
account for load-sensitivity when running regressions in ci environments.
* the l2fwd test now supports an additional parameter to specify the number
of scheduling groups to use in the test.
* the `odp_sched_latency` performance test now handles queue draining in
a robust manner.
* the crypto validation tests now properly check and validate message digests,
and include negative tests to verify that incorrect digests are properly
flagged. note that this may expose omissions in other odp implementations that
had previously passed this validation test.
* the crypto validation test now adds an explicit test for the null cipher,
as well as hmac-sha-1 and hmac-sha-512.
* the pktio_ipc test now properly cleans up only its own temp files.

==== examples improvements
* the `odp_generator` example now properly honors stop criteria based on
number of packets sent.
* the `odp_generator` example now properly flushes output messages
* the `odp_generator` example now supports port configuration.

=== bug fixes
==== https://bugs.linaro.org/show_bug.cgi?id=2416[bug 2416]
example/generator/odp_generator.c contains todo items

==== https://bugs.linaro.org/show_bug.cgi?id=2779[bug 2779]
error handling issues (checked_return)

==== https://bugs.linaro.org/show_bug.cgi?id=2826[bug 2826]
unchecked return in pool.c

==== https://bugs.linaro.org/show_bug.cgi?id=2831[bug 2831]
unchecked return in mmap_unmap_sock()

==== https://bugs.linaro.org/show_bug.cgi?id=2852[bug 2852]
odp_static_assert() fails when used by c++

==== https://bugs.linaro.org/show_bug.cgi?id=2872[bug 2872]
odp_pktio_ordered_run.sh: line 34: integer expression expected

==== https://bugs.linaro.org/show_bug.cgi?id=2881[bug 2881]
load sensitive tests fail on ci

==== https://bugs.linaro.org/show_bug.cgi?id=2895[bug 2895]
the `odp_crypto_operation()` routine does not work with multi-segment packets.

==== https://bugs.linaro.org/show_bug.cgi?id=2908[bug 2908]
packet validation test fails if implementation does not limit packet length

==== https://bugs.linaro.org/show_bug.cgi?id=2910[bug 2910]
odph_iplookup_table_put_value() uses overlapping pointer addresses

==== https://bugs.linaro.org/show_bug.cgi?id=2933[bug 2933]
miss to call unlock if there are some errors happen in loopback_send() function

==== https://bugs.linaro.org/show_bug.cgi?id=2940[bug 2940]
`odp_packet_seg_t` fails abi compatibility between odp-linux and odp-dpdk

==== https://bugs.linaro.org/show_bug.cgi?id=2942[bug 2942]
compilation fails using clang 4.0.0

==== https://bugs.linaro.org/show_bug.cgi?id=2952[bug 2952]
doxygen errors and travis does not catch them

==== https://bugs.linaro.org/show_bug.cgi?id=2969[bug 2969]
tm validation test does find traffic_mngr_main

==== https://bugs.linaro.org/show_bug.cgi?id=2974[bug 2974]
`odp_rwlock_read_trylock()` fails if lock is already held for read access

==== https://bugs.linaro.org/show_bug.cgi?id=3002[bug 3002]
packet order lost when enqueuing to pktout queue

==== https://bugs.linaro.org/show_bug.cgi?id=3003[bug 3003]
aes-gcm returns 'valid' tag when checking invalid tag

==== https://bugs.linaro.org/show_bug.cgi?id=3013[bug 3013]
various failures if config_packet_max_segs is set to 1

==== https://bugs.linaro.org/show_bug.cgi?id=3017[bug 3017]
travis: time main test out of boundaries

==== https://bugs.linaro.org/show_bug.cgi?id=3027[bug 3027]
compilation failures using gcc 7 series

==== https://bugs.linaro.org/show_bug.cgi?id=3039[bug 3039]
socket pktio recv fails on large number of packet

=== known issues
==== https://bugs.linaro.org/show_bug.cgi?id=3024[bug 3024]
odp_traffic_mngr example is broken

==== https://bugs.linaro.org/show_bug.cgi?id=3026[bug 3026]
pktio_ips_run test can fail due to segfault

== OpenDataPlane (1.14.0.0)

=== New Features
==== APIs
ODP v1.14.0.0 represents another preview of the Tiger Moth release series and
introduces new APIs and extensions.

===== Packet References
Packet references are a lightweight mechanism to allow applications to create
and manipulate different "views" of packets. These views consist of shared
bytes common to all references created on the same `odp_packet_t`, possibly
prefixed with unique headers that are private to each reference. Five new APIs
are introduced to enable this feature:

`odp_packet_ref_static()`::
Static references allow a single packet to have multiple "aliases", all of
which must be treated as read only. This is useful, for example, to retain
a reference to a packet being transmitted to support retransmit processing,
since the actual storage represented by a packet is not released until all
references to it have been freed via `odp_packet_free()` calls.

`odp_packet_ref()`::
Dynamic references differ from static references is that they permit the
individual `odp_packet_t` handles to have unique prefixes created via
`odp_packet_push_head()` or `odp_packet_extend_head()` calls. This can be
used, for example, to support multicasting packets to different destinations
by creating packets that consist of unique headers followed by a common shared
payload.

`odp_packet_ref_pkt()`::
Similar to `odp_packet_ref()`, but creates a dynamic reference by prepending a
preexisting header onto another packet.

`odp_packet_has_ref()`::
Returns a boolean indicator of whether a given `odp_packet_t` has other
references that share bytes with this packet.

`odp_packet_unshared_len()`::
Returns the number of unshared bytes accessible through a given `odp_packet_t`
handle. These are the only bytes that should be changed. All other bytes
in the packet should be treated as read only as they are shared with other
`odp_packet_t` handles.

Note that while the packet reference APIs and associated validation tests are
present in this release, the `odp-linux` reference implementation currently
implements references via packet copying. A zero-copy implementation of packet
references is planned to be part of the ODP v1.15.0.0 release.

==== ABI Specification
ODP has supported an Application Binary Interface (ABI) that permits
applications to be generated that are binary portable between select ODP
implementations. This is now formalized with the addition of structures that
permit ABI specifications to be defined that are shared between ODP
implementations. ODP provides a default ABI specification that is the same as
was provided before. This change means that additional ABIs may be defined
that are optimized to collections of platforms that share an Instruction Set
Architecture (ISA) and subscribe to them.

ABI specifications live in the `include/odp/arch/...` directory.

==== Instance Query (iQuery) Scheduler
Adding to the range of scheduler implementations supported by `odp-linux`, a
new scheduler, the instance query scheduler, is available by specifying
`--enable-schedule-iquery` at `configure` time.

This scheduler uses sparse bitmaps and offers scalability advantages when
dealing with large numbers of schedule queues. It otherwise offers performance
comparable to the default ODP scheduler implementation.

=== Helpers
Helpers have been reorganized to provide better independence from odp-linux
and to make them more useful with other ODP implementations. These
reorganizations are functionally transparent to ODP users but should
simplifying packaging and porting to other ODP implementations. This includes
adding the "umbrella" include file `odph_api.h` which can be used to include
all helper API definitions in an application.

=== Classifier Improvements
The `odp-linux` reference implementation now supports Pattern Matching Rules
(PMRs) for IPv6 addresses, inner and outer VLAN IDs, and inner and outer
Ethernet types.

=== Performance

==== Improved inlining for embedded applications
The `odp-linux` reference implementation now offers improved inlining support
for ODP APIs for applications compiled against ODP configured with the
`--enable-abi-compat=no` option, meaning they wish to forego binary
compatibility in exchange for improved performance. These applications remain
source portable to other ODP implementations.

==== Native `odp_cpu_pause()` for ARM processors
A native implementation of the `odp_cpu_pause()` API has been added for ARMv7
and ARMv8 processors.

==== New Microbenchmark
The `odp_packet_bench` microbenchmark application has been added to the
test performance directory to allow implementations to measure and calibrate
the performance of individual ODP packet APIs.

==== Ordered PktIO Test
The `odp_pktio_ordered` application has been added to the test performance
directory to provide stress-testing of packet ordering features of ODP.

=== Documentation
In addition to expanded documentation related to the new packet reference APIs,
a section on applicatin portability has been added that discusses the types
of portability offered by ODP and the tradeoffs that application writers should
consider when using ODP.

=== Bug Fixes

==== https://bugs.linaro.org/show_bug.cgi?id=2806[Bug 2806]
The `hello.c` application can now run properly if Core 0 is not
available (any available core will be used).

==== https://bugs.linaro.org/show_bug.cgi?id=2827[Bug 2827]
Provide proper return code checking within _ishm.c

==== https://bugs.linaro.org/show_bug.cgi?id=2829[Bug 2829]
Remove unused variables in iplookuptable helper routine.

==== https://bugs.linaro.org/show_bug.cgi?id=2830[Bug 2830]
Avoid memory leaks on error paths in the cuckoo table helper functions.

==== https://bugs.linaro.org/show_bug.cgi?id=2834[Bug 2834]
Fixes a race condition in shared memory allocation.

==== https://bugs.linaro.org/show_bug.cgi?id=2842[Bug 2842]
Provide proper fallback for shared memory when hugepages are not available.

==== https://bugs.linaro.org/show_bug.cgi?id=2862[Bug 2862]
Avoid null pointer dereference in the iplookuptable helper routine.

==== https://bugs.linaro.org/show_bug.cgi?id=2865[Bug 2865]
Missing doxygen documentation for helper table functions are added.

=== Known Issues

==== https://bugs.linaro.org/show_bug.cgi?id=2852[Bug 2852]
C++ programs fail to compile if they attempt to include the ODP helper APIs.

==== https://bugs.linaro.org/show_bug.cgi?id=2895[Bug 2895]
The `odp_crypto_operation()` routine does not work with multi-segment packets.

== OpenDataPlane (1.13.0.0)

=== New Features

==== APIs
ODP v1.13.0.0 represents the initial preview of the Tiger Moth release series
and as such introduces new APIs and extensions that will be built on as this
release matures.

===== Crypto Parameter Normalization
Many ODP APIs take parameter structs of type `odp_xxx_param_t`. The crypto APIs,
for historical reasons, failed to follow this convention, using instead structs
of type `odp_crypto_params_t`, etc. These pluralized names are now deprecated
and their singular forms are introduced as the preferred names for these
structs. The old names are retained (for now) to ease migration, however
applications should convert to the new forms at their convenience as these
deprecated forms will be removed in the final Tiger Moth release.

The changes introduced for this include:

* `odp_crypto_op_params_t` => `odp_crypto_op_param_t`
* `odp_crypto_session_params_t` => `odp_crypto_session_param_t`

===== Crypto Decouple Key Length from Algorithm Specification
To provide a more flexible programming for handling all possible
key/digest/iv length combinations, the enums used for crypto specification
are split to decouple lengths from algorithm names. The only exception
is the SHA-2 family of hash routines, which have well-established naming
conventions that incorporate digest lengths (SHA-224, SHA-256, etc.)

Changes included with this restructure include:

* The `odp_crypto_capability_t` structure returned by the
`odp_crypto_capability()` API contains streamlined `odp_crypto_cipher_algos_t`
and `odp_crypto_auth_algos_t` substructures.
* A new `odp_crypto_cipher_capability()` API is added to return detailed
information about available cipher capabilities.
* A new `odp_crypto_auth_capability()` API is added to return detailed
information about available authentication capabilities.

===== `odp_crypto_session_param_init()` API
For completeness the `odp_crypto_session_param_init()` API is provided to
enable platform-independent initialization of the `odp_crypto_session_param_t`
structure used as input to `odp_crypto_session_create()`.

===== Bitfield and Byteorder Cleanup
The `ODP_BITFIELD_ORDER` define is added to the ODP specification to parallel
the existing `ODP_BYTEFIELD_ORDER` define. This will be set to the value
`ODP_BIG_ENDIAN_BITFIELD` or `ODP_LITTLE_ENDIAN_BITFIELD`. This also addresses
https://bugs.linaro.org/show_bug.cgi?id=2402[Bug 2402], however since fixing
this required a small API change this was deferred until an API release
boundary.

===== Improved Name Argument Definitions in `odp_xxx_create()` Functions
The use of name arguments to the various resource creation APIs has
been standardized and documentation improved to clarify that unique
names are not required and that these may be specified as NULL for
anonymous resource creation. When non-unique resource names are used, it is
unspecified which of these are returned by a corresponding lookup API.

===== Pool Parameters for Packet Pools
The `odp_pool_param_t` structure adds the new field `max_len` to be used in
packet pools to advise the implementation of the maximum sized packet that
the application will allocate with a single `odp_packet_alloc()` call. This
may enable storage pool optimization.

===== Packet Clarifications
API documentation for `odp_packet_concat()` and `odp_packet_copy_from_pkt()`
is clarified to specify that the source and destination packets supplied to
these APIs should not refer to the same packet.

===== Packet Allocation Length Clarification
API documentation for `odp_packet_alloc()` is clarified to specify that
the supplied length for requested packet allocation should be greater
than zero.

===== Random API Changes
The APIs provided for working with random data have been revised. The third
parameter to `odp_random_data()` is now of type `odp_random_kind_t`, which is
an `enum` that is used to specify the quality of random data required. The
kinds of random data defined are:

`ODP_RANDOM_BASIC`::
No specific quality guarantees. This is assumed to be pseudo-random data
generated by software where speed of generation is more important than the
quality of the results.This is the lowest kind of random.

`ODP_RANDOM_CRYPTO`::
Random data suitable for use in cryptographic operations.

`ODP_RANDOM_TRUE`::
True random data generated from a hardware entropy source. This is the
highest kind of random.

The `odp_random_max_kind()` API is provided that returns the highest kind of
data available on this implementation. Requests for higher kinds than can be
supplied will fail.

For testing purposes it is often desirable to generate "random" sequences that
are repeatable. To support this use case, the `odp_random_test_data()` API is
introduced. This always returns BASIC random data but uses a user-supplied
64-byte seed parameter that is update for each call and can be used to
repeat the same sequence as needed.

===== Shared Memory Improvements
The `odp_shm_reserve()` API adds two new additional flags to support external
memory.

* `ODP_SHM_SINGLE_VA` guarantees that all ODP threads sharing this memory
will see the block at the same virtual address regardless of whether threads
are implemented as pthreads or processes and when `fork()` calls are made to
create them.

* `ODP_SHM_EXPORT` allows the memory block to be visible to other ODP
instances. Other ODP instances can retrieve this block via the new
`odp_shm_import()` API.

===== Classification Clarifications
The relationship between classification and queue configuration in the
`odp_pktin_queue_param_t` structure is clarified to emphasize that
classification subsumes queue-based I/O processing. This is an API
documentation change only.

=== Helpers
New helper APIs are introduced for IP table lookup support for longest prefix
matching as well as cuckoo hash tables. These are designed to provide analogs
to functions available in DPDK to assist applications being ported to ODP.

=== Performance Improvements
The odp-linux reference implementation includes a number of improvements to
make it more suitable for production use on platforms that rely on software
implementations of key ODP APIs.

==== Ring-based Pool Implementation
Storage pools used for buffers and packets are now implemented via lockless
ring structures that support burst mode read/writes to local caches for
significantly improved multi-core scalability

==== Buffer/Packet Header Optimizations
The layout of the structs used to support buffers and packets has been
optimized to reduce cache footprint and minimize path lengths in packet
manipulation.

==== Ordered Queue Improvements
The implementation of ordered queues has been streamlined and made more
scaleable in multi-core systems.

==== Packet Segmentation Improvements
The more advance segmentation capabilities present in the new ODP packet
implementation are used to streamline the implementation of APIs like
`odp_packet_concat()` and the head/tail extend/trunc APIs.

=== Bug Fixes

==== https://bugs.linaro.org/show_bug.cgi?id=2405[Bug 2405]
A number of "todos" were removed from the packet validation test suite.

==== https://bugs.linaro.org/show_bug.cgi?id=2472[Bug 2472]
The CPU affinity is now correctly read from the cpuset.

==== https://bugs.linaro.org/show_bug.cgi?id=2496[Bug 2496]
The PktIO validation test no longer uses invalid MAC addresses.

==== https://bugs.linaro.org/show_bug.cgi?id=2512[Bug 2512]
The TCP checksum is now properly calculated for generated packets.

==== https://bugs.linaro.org/show_bug.cgi?id=2798[Bug 2798]
The odp-linux reference implementation makes use of the OpenSSL library to
support the `odp_random_xxx()` APIs and some crypto operations. To support
OpenSSL versions prior to 1.1.0, which are not thread safe, support is added
for OpenSSL locking callbacks that use ODP ticketlocks to provide OpenSSL thread
safety.

=== Known Issues

==== https://bugs.linaro.org/show_bug.cgi?id=2812[Bug 2812]
Make check fails on a single core VM in the process mode helper test.

== OpenDataPlane (1.12.0.0)

=== New Features

==== APIs
ODP v1.12.0.0 has no API changes from previous v1.11.0 Monarch LTS. Version
is increased in current development release to make room for Monarch updates
numbers.

==== Application Binary Interface (ABI) Support
Support is added to enable ODP applications to be binary compatible across
different implementations of ODP sharing the same Instruction Set Architecture
(ISA). This support introduces a new `configure` option:

`no abi disable option`::
This is the default and specifies that the ODP library is to be built to
support ABI compatibility mode. In this mode ODP APIs are never inlined. ABI
compatibility ensures maximum application portability in cloud environments.

`--disable-abi-compat`::
Specify this option to enable the inlining of ODP APIs. This may result in
improved performance at the cost of ABI compatibility and is suitable for
applications running in embedded environments.

Note that ODP applications retain source code portability between ODP
implementations regardless of the ABI mode chosen. To move to a different ODP
application running on a different ISA, code need simply be recompiled against
that target ODP implementation.

==== SCTP Parsing Support
The ODP classifier adds support for recognizing Stream Control Transmission
Protocol (SCTP) packets. The APIs for this were previously not implemented.

=== Packaging and Implementation Refinements

==== Remove dependency on Linux headers
ODP no longer has a dependency on Linux headers. This will help make the
odp-linux reference implementation more easily portable to non-Linux
environments.

==== Remove dependency on helpers
The odp-linux implementation has been made independent of the helper library
to avoid circular dependency issues with packaging. Helper functions may use
ODP APIs, however ODP implementations should not use helper functions.

==== Reorganization of `test` directory
The `test` directory has been reorganized to better support a unified approach
to ODP component testing. API tests now live in
`test/common_plat/validation/api` instead of the former
`test/validation`. With this change performance and validation tests, as well
as common and platform-specific tests can all be part of a unified test
hierarchy.

The resulting test tree now looks like:

.New `test` directory hierarchy
-----
test
├── common_plat
│   ├── common
│   ├── m4
│   ├── miscellaneous
│   ├── performance
│   └── validation
│       └── api
│           ├── atomic
│           ├── barrier
│           ├── buffer
│           ├── classification
│           ├── cpumask
│           ├── crypto
│           ├── errno
│           ├── hash
│           ├── init
│           ├── lock
│           ├── packet
│           ├── pktio
│           ├── pool
│           ├── queue
│           ├── random
│           ├── scheduler
│           ├── shmem
│           ├── std_clib
│           ├── system
│           ├── thread
│           ├── time
│           ├── timer
│           └── traffic_mngr
├── linux-generic
│   ├── m4
│   ├── mmap_vlan_ins
│   ├── performance
│   ├── pktio_ipc
│   ├── ring
│   └── validation
│       └── api
│           ├── pktio
│           └── shmem
└── m4
-----

==== Pools
The maximum number of pools that may be created in the odp-linux reference
implementation has been raised from 16 to 64.

==== Upgrade to DPDK 16.07
The DPDK pktio support in odp-linux has been upgraded to work with DPDK 16.07.
A number of miscellaneous fixes and performance improvements in this support
are also present.

==== PktIO TAP Interface Classifier Support
Packet I/O interfaces operating in TAP mode now can feed packets to the ODP
classifier the same as other pktio modes can do.

=== Performance Improvements

==== Burst-mode buffer allocation
The scheduler and pktio components have been reworked to use burst-mode
buffer allocation/deallocation, yielding a measurable performance gain in
almost all cases.

==== Burst-mode queue operations
ODP queues internally now attempt to use burst-mode enq/deq operations to
accelerate performance where applicable.

==== Ring-based Scheduler Priority Queues
The ODP scheduler has been enhanced to use ring-based priority queues, resulting
in significantly better scalability in many core environments.

==== GitHub Automation Support
ODP now supports the Travis framework needed to trigger CI automation in
conjunction with GitHub. This support is considered experimental for now.

=== Examples

==== New `l3fwd` Example
A new example application is provided that illustrates use
of ODP for simple Layer 3 forwarding across multiple interfaces.

=== Documentation

==== Pure API Documentation
ODP now generates "pure" (implementation independent) doxygen documentation in
addition to the specific documentation for the odp-linux implementation. The
pure version is applicable to any ODP implementation as it simply describes
the ODP API specification. Implementation-specific versions of this
documentation describe both the APIs as well as specifics concerning typedefs,
enums, etc. This should help clarify what aspects of ODP are platform
independent.

==== Clarify ODP Thread Definition
The definition of an ODP thread in odp-linux has been clarified to specify that
for this implementation ODP threads are Linux pthreads or Linux processes.
Currently threads as processes is considered experimental in odp-linux.

=== Bug Fixes
Numerous refinements have been incorporated to make
validation tests more robust in API coverage as well as correcting corner
cases in the implementation of many ODP APIs. Notable fixes include:

==== https://bugs.linaro.org/show_bug.cgi?id=2316[Bug 2316]
`ODP_TIMEOUT_INVALID` is now defined consistently with other pool elements so
the restriction on using Pool 0 as a timer pool is removed.

==== https://bugs.linaro.org/show_bug.cgi?id=2310[Bug 2310]
The `odp_packet_copy()` API now correctly handles user areas between pools that
are configured with different sized per-packet user area definitions.

==== https://bugs.linaro.org/show_bug.cgi?id=2571[Bug 2571]
Corrects the implementation of AES GCM decryption in the ODP crypto API.

=== Known Issues

==== https://bugs.linaro.org/show_bug.cgi?id=2309[Bug 2309]
The Timer validation test fails sporadically in environments with high core
counts.

Monarch Long Term Stable v1.11.0.0

Signed-off-by: Maxim Uvarov <[email protected]>

== OpenDataPlane (1.10.1.0)

=== New Features

==== APIs
ODP v1.10.1.0 is a maintenance release and as such introduces no new APIs or
other changes that might result in application source incompatibility with
v1.10.0.0.

==== Modular Scheduler
The ODP scheduler included as part of the `odp-linux` reference implementation
has been modularized to support a "pluggable" architecture that will permit
the easy introduction of alternate scheduler implementations that permit
both easy experimentation as well as alternate scheduling models that are
tuned to specific application workloads (_i.e.,_ a strict priority scheduler
for latency-sensitive workloads). Included in this release is the just the
foundation and alternate schedulers are expected to be added in future ODP
releases.

=== Packaging

==== Rename of `linux-generic` to `odp-linux`
While the platform name within the ODP git repository remains
`linux-generic`, the package name of this reference implementation has been
changed to `odp-linux` to better reflect that this is an implementation of
ODP that is dependent only on the Linux kernel and is intended to be runnable
on any Linux distribution. All ODP documentation has been changed to reflect
this name change.

=== Helpers

==== Introduction of "agnostic" threading support
The current helper APIs for linux pthreads (`odph_linux_pthread_create()`, etc.)
and processes (`odph_linux_process_fork()`, etc.) have been augmented with a
new "agnostic" set of helper routines for general ODP thread management.

`odph_odpthreads_create()` and `odph_odpthreads_join()` are now the preferred
helpers to use for creating and joining threads that may be implemented as
_either_ pthreads or Linux processes. Although currently ODP threads in
Monarch are assumed to share the same (single) address space, this change is
to permit evolution towards multi-address space (_i.e.,_ process oriented)
threading models without requiring application and/or validation test changes.

The various ODP examples and validation tests that make use of threading have
all been changed to new these new helper APIs.

==== Thread affinity APIs
As part of the new "agnostic" threading support, two additional helper APIs
(`odph_odpthread_getaffinity()` and `odph_odpthread_setaffinity()`) have been
added to permit easy management of thread affinity.

The CUnit framework used by the ODP validation suite has been changed to set
the affinity of the initial thread to the first available control CPU. This
avoids inconsistencies in a number of timing tests.

=== Bug Fixes
As a maintenance release, numerous bugs have been fixed in the `odp-linux`
reference implementation in areas such as platform support (particularly on
32-bit systems), compiler support (clang), C++ compatibility, and other
cleanup items. Highlights include:

==== 32-bit platform support
The `configure` utility now correctly identifies and sets variables needed for
proper compilation on 32-bit x86 systems. In addition the Traffic Manager
now executes properly on 32-bit systems.

==== Timer improvements
The `odp_timer_t` abstract type is now strongly typed for consistency with
other ODP types, and the `odp_timer_to_u64()` and `odp_timer_pool_to_u64()`
APIs are now properly implemented. In addition, an issue with compiling the
timer routines on 32-bit systems using clang was resolved.

==== Scheduler fairness
The default scheduler has been improved to avoid starvation and increase
fairness when running with a limited number of threads or CPUs.

==== 128-bit atomics
The `-mcx16` compiler option is now properly identified and used to support
128-bit atomics on systems that support these operations. This leads to
increased efficiency in the implementation of both timers as well as other
atomic operations.

==== Use of hugepages
In systems that support multiple hugepage sizes, the default hugepage size is
now reported properly by the `odp_sys_huge_page_size()` API.

==== Coverity and Valgrind issue cleanup
Numerous issues identified by the Coverity scan tool have been cleaned up
and resolved, leading to improved robustness in the `odp-linux` reference
implementation. In addition, several memory leaks identified by the valgrind
tool have been fixed.

==== Validation test resource checks
The Traffic Manager validation test has certain sub-tests that require a
minimum of 2 CPUs to operate properly. These tests are now skipped with a
warning when run on uniprocessor systems.

=== Performance
Performance enhancements in the `odp-linux` reference implementation have been
made in packet processing, classification, and pktio, leading to increased
observed throughput and packet handling rates.

=== Examples
A new `l2fwd_simple` example has been added that does simple Layer 2 forwarding.

=== Documentation
==== Switch from AsciiDoc to AsciiDoctor
To get better formatting capabilities and future extensibility the ODP user
documentation system has been switched from http://asciidoc.org[AsciiDoc] to
http://asciidoctor.org[AsciiDoctor]. There are a handful of notable changes as
a result of this. Those submitting documentation patches should be aware of
the following:

* `monospace font` is now indicated by demarking the text with backticks (`)
rather than plus signs (+).

* Callouts are now indicated by C++-style double slash comments (// <1>)
instead of C-style comments (/* <1> */). So, for example writing
-----------------------------------------------
[source,c]
----
...some great code deserving a callout // \<1>
----
<1> This is an example of a callout
-----------------------------------------------
yields:
----
...some great code deserving a callout // <1>
----
<1> This is an example of a callout

Note that this change only affects user documentation. Code documentation
still uses http://doxygen.org[Doxygen].

==== Image Cleanup
The images in the user guide have been trimmed to fit the page better. In
addition, many new images have been added to better illustrate ODP API usage.

==== Additional User Documentation for Monarch APIs
The *ODP User's Guide* has been updated to include new sections documenting
the use of the full Monarch packet APIs as well as the Timer APIs. In
addition, the crypto, classification, and traffic manager API documentation
has been improved to cover all of the latest Monarch features, and an
introductory section on overall ODP packet flow architecture has been added.

==== Helper Documentation
The ODP Helper library now has its own document that describes these additional
functions of use to ODP applications and validation tests.

==== Other documentation
The Process Guide, FAQ, CONTRIBUTING, and CHANGELOG files have been reworked
for the new AsciiDoctor structure, leading to a more uniform method of
presenting ODP support documentation. In addition, an option for generating
both a "pure" ODP API document that defines the APIs in their
implementation-independent forms as well as their implementation-dependent
forms for the `odp-linux` reference implementation is now available.

=== Known Issues
==== https://bugs.linaro.org/show_bug.cgi?id=2301[Bug 2301]
The scheduler does not remove PKTIN queues following `odp_pktio_close()`

==== https://bugs.linaro.org/show_bug.cgi?id=2309[Bug 2309]
The timer validation tests have seen occasional failures when run on systems
containing a larger number of CPUs (typically 24 or more).

== OpenDataPlane (1.10.0.0)

=== New Features
==== General
* Move to capabilite structures: The classification, crypto, pktio, pool,
  queue, shared memory, and traffic manager areas all add new APIs to query
  implementation-specific capability limits for enhanced program portability.

==== Classification
* Addtion of a structure that defines system level classification capability
* Addition of range PMRs to complement the existing value PMRs to permit
  application to specifiy classification rules over a range of values.

==== Cryptography
* Provides a way to get the available cipher and authentication algorithms.

==== Debug
* Adds the  ODP_STATIC_ASSERT() API to permit compile-time assertions.

==== Packet
* Rename and add new packet copy and move functionality.
* Add packet prefetch API for performance optimization.
* New APIs to permit packet headroom and tailroom to be extended to additional
  segments or truncated as needed.
* Align an area of packet data (e.g. IP/UDP headers) so that it is contiguous in
  memory and starts in a specified minimum alignment.
* Add packet time stamp metadata support.
* Add packet input index metadata support to allow application context to
  be anchored from the associated interface that received the packet.
* Deprecation and removal of segment-level buffer APIs that are now
  superseded by additional packet-level manipulation APIs discussed above.

==== Packet io
* Replaced config definition for maximum pktio entries with maximum packet IO
  index call
* Added the classify_enable bit to the odp_pktin_queue_param_t that allows
  applications to explicity control which pktin queues are subject to full
  classifier support.
* Addition of pktin configuration options to control packet timestamping
  and checksum validation processing.
* Addition of pktout configuration options to control packet checksum
  offload processing.
* Add the ability to query (via capabilties) whether a pktio interface
  supports operating in loopback mode and if so to enable/disable this
  mode of operation.
* Round out the polling APIs be adding the ability to receive packets in
  poll mode from one or more pktin queues with timeout.
* Add the ability to set the pktio interface index for ease of setting up
  application context areas associated with each pktio.
* Add the ability to inqure the timestamp resolution associated with
  pktio interfaces that support packet timestamping.

==== Queue
* Add a queue capability API to query system-wide queue capabilities and limits.
* Extend queue context with an explicit data length parameter that serves
  as a performance hint for the amount of context to prefetch when the
  scheduler selects an event from a scheduled queue.

==== Scheduler
* Add the ability to query information about a defined scheduler group

==== Shared Memory
* Add a capability inquiry API to obtain implementation shared memory limits.

==== Traffic Manager
* Add a capability inquiry API to obtain implementation traffic mngr limits.
* Split TOS marking into two separate calls.
* Add new APIs to support VLAN, ECN, and drop precedence marking.
* Add destroy APIs for shapers, scheduler profiles, threshholds, WRED profiles,
  TM queues, and TM nodes for symmetry and completeness to allow applictions
  to terminate gracefully without resource leakage.
* Add the ability to disconnect TM queues from their fanouts.
* Add TM node contexts to permit applications to anchor user context areas
  to TM nodes.
* Add the ability to query info about TM node fanins and TM queues.
* Deprecate and remove the odp_tm_periodic_update() API

==== Utilities/Helpers
* More complete and correct checksum implementation

=== Known Issues

Current point release. Full release notes will be

maintained here:
https://git.linaro.org/lng/odp-release-notes.git
and uploaded on opendataplane.org web site.

Signed-off-by: Maxim Uvarov <[email protected]>

Monarch rc1

* API:

    - api headers moved to include/odp/api/spec/ and apps should use include/odp_api.h
      now instead of odp.h
    - api/linux-generic/example: classification: add pmr create api
    - api: move include/odp.h to include/odp_api.h
    - api: odp.h to ease transition period
    - api: packet: add bcast/mcast parse documentation
    - api: packet: add detailed packet error flags
    - api: packet: added multicast flags
    - api: pktio: add pktout event queue
    - api: pktio: added pktio info structure
    - api: pktio: added supported set operations bit mask to pktio capability
    - api: pktio: changed odp_pktio_mtu() return value to uint32_t
    - api: pktio: define default pktio modes
    - api: pktio: define default queue configuration
    - api: pktio: remove old single queue API
    - api: pktio: rename pktio_recv_queue to pktin_recv
    - api: pktio: rename pktio_send_queue to pktout_send
    - api: pktio: specify when queue config is called
    - api: queue: remove queue type pktin and pktout
    - api: sched: define default sched param values
    - api: time: fix typo for cmp function
    - api: tm: add tm API definitions
    - api: tm: replace pktio with pktout_queue in odp_tm_egress_struct
    - doc: users: migrate TM from API to users doc
    - drv: creation of the driver interface (drv)
* ODP docs:
    - doc: depend the docs on the images
    - doc: descr of structure for new interfaces
    - doc: drop using output dir for guides
    - doc: glossary: defining ODP thread more precisely
    - doc: images: add traffic manager svg
    - doc: implementers-guide: adding drv interface
    - doc: removing invalid characters
    - doc: update to latest ax_prog_doxygen.m4
    - doc: use imagedir attribute for path
    - doc: user-guide documentation for classification
    - doc: user-guide: fixing other typos
    - doc: user-guide: shmem
    - doc: users: add TM example
    - doc: users: migrate TM from API to users doc
    - documentation: userguide: add images for packet processing
    - documentation: userguide: add packet processing description
* Validation
    - linux-generic: version: added implementation name string
    - performance: crypto: add odp_crypto to .gitignore file
    - test: l2fwd: add event queue packet output
    - test: l2fwd: add option to give destination MAC
    - test: l2fwd: fix test getting stuck in DIRECT_RECV/POLL_QUEUE mode
    - test: l2fwd: utilize pktio param defaults
    - test: performance: crypto: measure crypto operation performance
    - test: pktio_perf: finalize port to use new pktio api
    - test: pktio_perf: port to use new pktio api
    - validataion: packet: add tests for broadcast and multicast flags
    - validation: classification: add test case for odp_cos_drop() function
    - validation: classifier: port to use new pktio api
    - validation: packet: test if user area is properly set
    - validation: pktio: add output event queue tests
    - validation: pktio: assign MAC address if one loop pktio is used
    - validation: pktio: check if configuring promisc mode is supported before testing
    - validation: pktio: fix pktio_test_recv_queue() crash
    - validation: pktio: fix type on defining pktiout mode
    - validation: pktio: port to use new pktio api
    - validation: pktio: replace pktio_test_jumbo() with pktio_test_recv_mtu()
    - validation: pktio: set packet mac addresses and checksum in statistics test
    - validation: scheduler: increase delay tolerance
    - validation: tm: add cunit test for traffic mngr
    - validation: tm: fix arm compilation
    - validation: tm: miscellaneous cleanup and fixes for tm cunit tests
* General:
    - linux-generic: Makefile: fix broken include path
    - linux-generic: pktio: initial dpdk pktio implementation
    - linux-generic: dpdk: add dpdk_setup_port()
    - linux-generic: dpdk: add functions for fetching packet input/output queues
    - linux-generic: dpdk: add get/set functions for mtu, promisc mode, and capability
    - linux-generic: dpdk: add odp_pktio_input_queues_config()
    - linux-generic: dpdk: add odp_pktio_link_status()
    - linux-generic: dpdk: add odp_pktio_output_queues_config()
    - linux-generic: dpdk: add rx/tx locking
    - linux-generic: dpdk: close resources in odp_pktio_close()
    - linux-generic: dpdk: handle ixgbe_pmd minimum burst size
    - linux-generic: drv: creation of the driver interface (drv)
    - linux-generic: fix usage of function strncpy
    - linux-generic: loop: avoid packet table overflow
    - linux-generic: move CPU info dummy data to generic default file
    - linux-generic: netmap: add support for VALE and pipe virtual ports
    - linux-generic: netmap: bump up link wait timeout to 10 secs
    - linux-generic: netmap: improve single RX queue performance
    - linux-generic: netmap: increase maximum descriptor count
    - linux-generic: netmap: support 'netmap:' interface name prefix
    - linux-generic: packet: implement broadcast and multicast metadata flags
    - linux-generic: packet: implement parser extensions for broadcast and multicast
    - linux-generic: pktio: add dpdk pktio build support
    - linux-generic: pktio: add link_status handler for loop interfaces
    - linux-generic: pktio: add separate functions for global and local init
    - linux-generic: pktio: allow num queues request on disabled pktio
    - linux-generic: pktio: allow recv on stopped interface
    - linux-generic: pktio: pktout event queues
    - linux-generic: pktio: set pktio capability supported set operations flags
    - linux-generic: pktio: simplify callback interface
    - linux-generic: pktio: use unique names for pktin event queues
    - linux-generic: pool: implement user area init support
    - linux-generic: queue: simplify NULL param handling
    - linux-generic: return error for unsupported pktio calls
    - linux-generic: separate MIPS ODP_CACHE_LINE_SIZE to its arch file
    - linux-generic: separate PowerPC ODP_CACHE_LINE_SIZE to its arch file
    - linux-generic: separate x86 ODP_CACHE_LINE_SIZE to its arch file
    - linux-generic: sysinfo clean up for ARM
    - linux-generic: systemcpu(): use input parameter instead of global data
    - linux-generic: test: add tm unit test to list of tests to run
    - linux-generic: tm: Add missing name table initialization call.
    - linux-generic: tm: fix numerous bugs in timer wheel and main tm implementation
    - linux-generic: tm: implement traffic manager
    - linux-generic: tm: remove not used includes of odp_api.h
    - linux-generic: tm: use intermediate casts to avoid strict warnings
    - linux-generic: tm: use odp_hash_crc32c() api to avoid arch issues
    - linux-generic: use one uniform call systemcpu()
    - linux-generic: validation: add netmap test
    - linux-generic: version: added implementation name string
* Helper:
    - helper: eth: added mac address parse
    - helper: ip: added ipv4 address parse
    - helper: linux: correct cpumask usage
    - helper: linux: remove unnecessary cpumask copy
    - helper: remove odp_ definitions
    - helper: remove ring code
    - helpers: remove odp_ prefix for tests source files
       - tests: use parse mac and ip address helpers