[source,c] ---- ...some great code deserving a callout // <1> ---- <1> This is an example of a callout
v188.8.131.52 is a minor service release of the Monarch LTS (Long Term Support) release of ODP. It incorporates several bug fixes and is otherwise unchanged from the base Monarch LTS release
Test case for classification enable field in odp_pktin_queue_config parameter.
Doxygen warning for ODP_BIG_ENDIAN_BITFIELD
Builds TAR have no .scmversion
Compilation fails using clang 4.0.0
doxygen errors and travis does not catch them
Compilation failures using GCC 7 series
Socket pktio recv fails on large number of packet
git_hash: handle git worktree
Use PRIu32 to print uint32_t values
configure: remove dependency on autoconf-archive
Fix compilation with OpenSSL 1.1.y
ODP v1.11.0 is the base tag and branch for the Monarch LTS (Long Term Support) release of ODP.
As part of the final Monarch LTS API set, a minor change to the
odp_tm_egress_t struct was made to better reflect the capabilities of SoC platforms targeting Monarch support. This change adds the boolean
egress_fcn_supported that indicates whether TM systems support an egress function. In addition, each TM system is now associated with a PktIO rather than a PktOUT queue. This struct is input to the
odp_tm_create() API and output from the
Building on the modular scheduler framework introduced in v184.108.40.206, An alternate Strict Priority (SP) scheduler is now available. The SP scheduler is selected when ODP is configured with the
The SP scheduler is designed to favor low-latency processing of high priority work at the expense of throughput. This is considered experimental code at this point and should be treated as such by those wishing to use it.
The scheduler now properly cleans up PktIOs operating in SCHEDULE mode following
odp_pktio_close() calls. This resolves Bug 2301.
The odph_chksum() helper routine is now C++ conformant. This resolves Bug 2302.
odp_packet_copy() API now copies the packet user area as part of its processing and the packet validation test has been enhanced to verify that this is done properly. This resolves Bug 2310.
The internal definition of
ODP_TIMEOUT_INVALID was changed in
odp-linux to enable the use of Pool 0 as a timeout pool. This resolves Bug 2316.
To facilitate API tracking,
libodphelper.so has been split out from
To avoid circular dependencies that cause issues when packaging ODP as a shared library, the
odp-linux implementation no longer makes and use of the ODP helper library.
Performance enhancements in the
odp-linux reference implementation have been made in PktIO routines and the packet classifier.
General cleanup throughout has resulted in adding proper termination calls to ODP examples as well as miscellaneous Doxygen corrections. Additionally, the
odp-linux code base has been cleaned up by removing "To Dos" as well as extraneous
#includes for extra C headers and dependencies on linux headers for improved portability.
The Queue validation test now properly exercises the
odp_queue_capability() API and attempts to create the maximum reported number of supported queues.
The platform-specific tests have been moved from
test/platform/linux-generc so that all tests are now found under a single
examples directory has been cleaned up and numerous corrections to existing examples have been made to add proper termination paths, etc. In addition, a new "hello world" example (
odp_hello.c) has been added that illustrates the basic startup and shutdown steps needed for all ODP applications. As a simple stand-alone application is is also a good initial build tests for new ODP implementations.
The Doxygen API guide has been split so that both a "pure" version that is platform-independent and retains unresolved ODP abstract types as well as an implementation-specific version (for
odp-linux) that shows platform-specific
The ODP Implementer’s Guide has been enhanced with a section on implementation considerations, including issues surrounding the definition of Application Binary Interfaces (ABIs).
The timer validation tests have seen occasional failures when run on systems containing a larger number of CPUs (typically 24 or more).
ODP cannot be compiled using the -m32 option to generate 32-bit code on a 64-bit platform when using GCC 4.9 (the default GCC found in Ubuntu 15.04). This is due to a known bug in GCC 4.9 and is closed as a permanent restriction.
Doxygen generates a warning for
ODP_BIG_ENDIAN_BITFIELD when compiling on little endian systems. A similar warning for
ODP_LITTLE_ENDIAN_BITFIELD is issued when compiling on big endian systems.
The traffic manager cannot be used with two PktIOs simultaneously. That is,
odp-linux does not properly support applications that create more than one TM system. This is a bug in the
odp-linux implementation that will be corrected. It is not a limit of the architecture or other ODP implementations.
ODP v220.127.116.11 is a maintenance release and as such introduces no new APIs or other changes that might result in application source incompatibility with v18.104.22.168.
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.
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.
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_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.
As part of the new "agnostic" threading support, two additional helper APIs (
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.
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:
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.
odp_timer_t abstract type is now strongly typed for consistency with other ODP types, and the
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.
The default scheduler has been improved to avoid starvation and increase fairness when running with a limited number of threads or CPUs.
-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.
In systems that support multiple hugepage sizes, the default hugepage size is now reported properly by the
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.
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 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.
l2fwd_simple example has been added that does simple Layer 2 forwarding.
To get better formatting capabilities and future extensibility the ODP user documentation system has been switched from AsciiDoc to 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
...some great code deserving a callout (1)
This is an example of a callout
Note that this change only affects user documentation. Code documentation still uses Doxygen.
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.
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.
The ODP Helper library now has its own document that describes these additional functions of use to ODP applications and validation tests.
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.
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.
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.
Provides a way to get the available cipher and authentication algorithms.
Adds the ODP_STATIC_ASSERT() API to permit compile-time assertions.
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.
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.
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.
Add the ability to query information about a defined scheduler group
Add a capability inquiry API to obtain implementation shared memory limits.
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
More complete and correct checksum implementation
A focus has been made on improving the packaging support of ODP for distributions such as Debian.
Improved creation of source tar ball and packaging scenarios moved to https://git.linaro.org/lng/odp-packaging.git
Renamed libodp to libodp-linux
Removed all internal functions from leaking through the libodp-linux
Time and Traffic Manager validation tests sometimes fail on heavy loaded systems. This behaviour depends on time accuracy measurements, which depends on system load.