Skip to content

Commit

Permalink
api: increment ODP API version to 1.42.1
Browse files Browse the repository at this point in the history
Increment API version number to reflect the following changes:

Backward compatible:
- cls: add odp_cls_pmr_create_multi() function
- cls: add odp_cls_pmr_destroy_multi() function
- cls: add odp_cls_cos_create_multi() function
- cls: add odp_cos_destroy_multi() function
- crypto: clarify packet ordering of async crypto ops
- crypto: add null_crypto crypto op flag for skipping crypto
- crypto: allow both basic and out-of-place ops in one session
- pktio: add ODP_PKTIO_MAX_INDEX define
- queue: add odp_queue_create_multi() function
- queue: add odp_queue_destroy_multi() function
- queue: clarify odp_queue_param_t default value specification
- system: add new ARMv8 and v9 enumerations
- timer: clean up odp_timer_pool_param_t.num_timers description
- timer: add odp_timeout_alloc_multi() function
- timer: add odp_timeout_free_multi() function

Helper library (1.4.0):

Backward incompatible:
- protocols: rename ODP_GTP_HLEN define to ODPH_GTP_HLEN
- protocols: rename ODP_IGMP_HLEN define to ODPH_IGMP_HLEN
- protocols: remove unused ICMP defines and add missing ODPH_ prefix to the
  remaining defines

Backward compatible:
- macros: add ODPH_MIN() and ODPH_MAX() helper macros
- macros: add ODPH_ARRAY_SIZE() helper macro
- macros: add ODPH_ABS() helper macro

Signed-off-by: Matias Elo <matias.elo@nokia.com>
Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
  • Loading branch information
MatiasElo committed Oct 19, 2023
1 parent 3fc1ee2 commit 8fad493
Show file tree
Hide file tree
Showing 2 changed files with 104 additions and 2 deletions.
102 changes: 102 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,105 @@
== OpenDataPlane (1.42.1.0)

=== Backward compatible API changes
==== Classifier
* Add new `odp_cls_pmr_create_multi()` function for creating multiple packet
matching rules with a single call.
* Add new `odp_cls_pmr_destroy_multi()` function for destroying multiple PMRs
with a single call.
* Add new `odp_cls_cos_create_multi()` function for creating multiple class-of-
services with a single call.
* Add new `odp_cos_destroy_multi()` function for destroying multiple CoSes with
a single call.

==== Crypto
* Clarify packet ordering of async crypto ops (`odp_crypto_op_enq()`).
* Add `odp_crypto_packet_op_param_t.null_crypto` parameter that tells that a
packet should be processed as if the configured algorithms were null cipher and
null auth algorithm.
* Add `ODP_CRYPTO_OP_TYPE_BASIC_AND_OOP` crypto operation type that allows both
basic and out-of-place operations in the same session.

==== Packet IO
* Add new API define `ODP_PKTIO_MAX_INDEX` for maximum packet IO interface
index.

==== Queue
* Add new `odp_queue_create_multi()` function for creating multiple queues with
a single call.
* Add new `odp_queue_destroy_multi()` function for destroying multiple queues
with a single call.
* Clarify `odp_queue_param_t` default value specification.

==== System
* Add enumerations for ARM ISA versions ARMv8.8-A, ARMv8.9-A, and ARMv9.3-A.

==== Timer
* Change `odp_timer_pool_param_t.num_timers` description to allow applications
to attempt to allocate more timers than there are in a timer pool.
* Add new `odp_timeout_alloc_multi()` function for allocating multiple timeouts
with a single call.
* Add new `odp_timeout_free_multi()` function for freeing multiple timeouts with
a single call.

=== Helper (1.4.0)
==== Backward incompatible changes
===== Protocols
* Rename `ODP_GTP_HLEN` define to `ODPH_GTP_HLEN`.
* Rename `ODP_IGMP_HLEN` define to `ODPH_IGMP_HLEN`.
* Remove unused ICMP defines and add missing `ODPH_` prefix to the remaining
ones.

==== Backward compatible changes
===== Macros
* Add new `ODPH_MIN()` and `ODPH_MAX()` helper macros for comparison operations.
* Add new `ODPH_ARRAY_SIZE()` helper macro for calculating array size.
* Add new `ODPH_ABS()` helper macro for calculating the absolute value of a
signed variable.

=== Implementation
==== CPU
* Optimize `odp_cpu_cycles()` performance on aarch64 by implementing the
function using `cntvct_el0` virtual counter register.

==== Packet IO
* Transmitting packet vectors is not supported by the current API, so remove
the code from the implementation. This may improve performance when transmitting
packets through event queues.
* Add support for packet transmit completion check through polling
(`ODP_PACKET_TX_COMPL_POLL`).

=== Example Applications
==== sysinfo
* Add prints for various missing capabilities (e.g. pool, packet IO, timer).

==== timer_accuracy
* Add new (`-c, --count`) option to set the CPU count.
* Add new (`-t, --queue_type`) option to set the queue sync type.
* Add new (`-q, --num_queue`) option to set the number of queues.
* Add new (`-G, --sched_groups`) option to use a dedicated schedule group for
each queue.

=== Performance Tests
==== bench_pktio_sp
* Add new `odp_bench_pktio_sp` application for measuring delays of ODP packet IO
slow path functions.

==== dmafwd
* Add new `odp_dmafwd` application for comparing packet forwarding throughput
when received packets are first copied either with software memory copy
or with DMA offload and then echoed back to sender(s).

==== packet_gen
* Add new (`-m, --tx_mode`) option for selecting how packets are transmitted.

==== stash_perf
* Add new `odp_stash_perf` application for measuring ODP stash fast path API
performance.

==== timer_perf
* Add new mode (`-m 2`) for measuring `odp_schedule()` overhead while
continuously restarting expiring timers.

== OpenDataPlane (1.42.0.0)

=== Backward incompatible API changes
Expand Down
4 changes: 2 additions & 2 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ AC_PREREQ([2.5])
##########################################################################
m4_define([odp_version_generation], [1])
m4_define([odp_version_major], [42])
m4_define([odp_version_minor], [0])
m4_define([odp_version_minor], [1])
m4_define([odp_version_patch], [0])

m4_define([odp_version_api],
Expand All @@ -27,7 +27,7 @@ AC_SUBST(ODP_VERSION_API)
# Helper library version
##########################################################################
m4_define([odph_version_generation], [1])
m4_define([odph_version_major], [3])
m4_define([odph_version_major], [4])
m4_define([odph_version_minor], [0])

m4_define([odph_version],
Expand Down

0 comments on commit 8fad493

Please sign in to comment.