Merge ODP v1.47.0.0

Merge ODP linux-generic v1.47.0.0 into linux-dpdk.

Author: MatiasElo

CHANGELOG

@@ -1,3 +1,138 @@
+== OpenDataPlane (1.47.0.0)
+
+=== Backward incompatible API changes
+
+==== System
+* Allow implementations to return zero in `odp_system_meminfo_t.total_overhead`
+field if tracking memory usage overhead is not supported.
+
+=== Backward compatible API changes
+
+==== General
+* Add a paragraph in the API principles section in `include/README` to describe
+parameter lifetimes of ODP API functions: Structures passed by reference
+(and structures referred by them) do not need to outlive the API call,
+unless otherwise noted in the API.
+
+==== Classifier
+* Clarify the presumed intent of back pressure API by specifying how exactly the
+back pressure threshold for any given pktio + pool/queue + pfc_level -tuple is
+derived from the configuration.
+* Add CoS parameter `odp_cls_cos_param_t.aggr_enq_profile` for selecting
+aggregator enqueuing profile (`odp_aggr_enq_profile_t`), which can generate
+hints to an event aggregator. Support is advertised through
+`odp_cls_capability_t.aggr` capability. The hints can affect e.g. the boundaries
+of vector events generated by an event aggregator.
+
+==== CPU
+* Add `odp_cpu_cycles_strict()` function for reading current CPU cycle count
+value more strictly in the program order.
+
+==== DMA
+* Add necessary fields to `odp_dma_transfer_param_t` for freeing DMA source
+segments of data format `ODP_DMA_FORMAT_PACKET`. Support is advertised through
+`odp_dma_capability_t.src_seg_free` capability.
+* Add necessary fields to `odp_dma_seg_t`, `odp_dma_transfer_param_t`, and
+`odp_dma_result_t` for allocating DMA destination segments of data format
+`ODP_DMA_FORMAT_PACKET`. Support is advertised through
+`odp_dma_capability_t.dst_seg_alloc` capability.
+
+==== Event
+* Add `ODP_EVENT_VECTOR` event type.
+* Add special `ODP_EVENT_ANY` event type, which does not match to any particular
+event type and can only be used when explicitly documented by the API.
+* Change `odp_event_free()` specification to state that in case of vector
+events (`ODP_EVENT_VECTOR` or `ODP_EVENT_PACKET_VECTOR`) it frees the vector and
+all events or packets stored inside it.
+
+==== Event Vector
+* Add new generic event vector APIs. Event vectors can contain events of any
+type, as opposed to the existing packet vectors, which can contain only packets.
+
+==== ML
+* Add quantization parameters to input (`odp_ml_input_info_t.quant_info`) and
+output (`odp_ml_output_info_t.quant_info`) info. Implementation may optionally
+provide these parameters, if they are available for a given model.
+
+==== Pool
+* Add `ODP_POOL_EVENT_VECTOR` pool type for allocating event vectors.
+
+==== Queue
+* Clarify that `odp_queue_sched_type()`, `odp_queue_sched_prio()`,
+`odp_queue_sched_group()`, and `odp_queue_lock_count()` functions can be used
+only with queues of `ODP_QUEUE_TYPE_SCHED` type.
+* Add event aggregators that are associated with queues and have the same life
+time. Event aggregators are queues which try to aggregate multiple events into
+event vectors, which are then enqueued to the underlying queue. Event
+aggregators are configured through queue parameters
+(`odp_queue_param_t.num_aggr` and `odp_queue_param_t.aggr`) and the related
+capabilities are advertised using `odp_event_aggr_capability_t` struct. Event
+aggregators cannot be used simultaneously with the existing packet vector config
+in the same ODP application.
+* Add `ODP_QUEUE_TYPE_AGGR` queue type.
+* Add `odp_queue_aggr()` function for getting a queue handle of an event
+aggregator associated with a queue.
+* Add `odp_aggr_enq_param_init()` function for initializing event aggregator
+enqueuing parameters.
+* Add `odp_queue_enq_aggr()` function that can be used for passing hints to an
+event aggregator.
+
+==== Scheduler
+* Add `odp_schedule_group_param_init()` function for initializing schedule group
+parameters.
+* Add `odp_schedule_group_create_2()` function, which is otherwise like
+`odp_schedule_group_create()`, but additionally accepts a set of parameters
+(`odp_schedule_group_param_t`). Parameters for predefined scheduling groups can
+be configured in `odp_schedule_config()`.
+* Add possibility to configure cache stashing
+(`odp_schedule_group_param_t.cache_stash_hints`) at schedule group and/or
+priority levels. Stashing data of to-be-scheduled events and queues may improve
+performance in some workloads.
+
+==== Timer
+* Add new timer pool parameter `odp_timer_pool_param_t.priority` and related
+capabilities. Timers allocated from pools with a higher priority value are
+served with higher priority than timers allocated from pools with a lower
+priority value.
+
+==== Traffic Manager
+* Add `odp_tm_node_stats()` function for reading TM node specific statistics
+counters. The supported counters are advertised in
+`odp_tm_level_capabilities_t.node_stats` capability.
+
+=== ABI changes
+* Increase `ODP_SHM_NAME_LEN` default value to 64.
+
+=== Helper (1.7.1)
+
+==== Backward compatible changes
+* Add `ODPH_DIV_ROUNDUP()` macro for dividing two numbers and rounding up the
+result to the closest integer.
+* Add `ODPH_ROUNDUP_MULTIPLE()` macro for rounding up a value to a multiple of
+another value.
+
+=== Implementation
+* Disable basic scheduler implementation's ordered queue reorder stash config
+file option (`sched_basic:order_stash_size`) by default.
+* Simplify `odp_version_impl_str()` output and include commit hash (if
+available) in it.
+* Optimize `odp_packet_free_sp()` and `odp_event_free_sp()` implementations.
+
+=== Performance Tests
+==== stress
+* Add new `-t` option for selecting timer mode (shared/private).
+
+==== timer_accuracy
+* Add a new "concurrency" mode (`-m 4`) that performs timer starts and cancels
+across multiple threads. This mode aims to uncover concurrency issues in the
+timer implementation, particularly with a short period, where timer expirations,
+starts, and cancels frequently occur close to each other.
+
+==== timer_stress
+* Add new tool for benchmarking timer handling performance in different
+scenarios. Tester currently supports modes for single-shot (with and without
+cancelling) and periodic timers.
+
 == OpenDataPlane (1.46.0.0)
 
 === Backward incompatible API changes

config/odp-linux-dpdk.conf

@@ -203,7 +203,7 @@ sched_basic: {
 	# performance if threads process events in bursts. If 'order_stash_size'
 	# > 0, events may be dropped by the implementation if the target queue
 	# is full. To prevent this set 'order_stash_size' to 0.
-	order_stash_size = 512
+	order_stash_size = 0
 
 	# Power saving options for schedule with wait
 	#

config/odp-linux-generic.conf

@@ -233,7 +233,7 @@ sched_basic: {
 	# performance if threads process events in bursts. If 'order_stash_size'
 	# > 0, events may be dropped by the implementation if the target queue
 	# is full. To prevent this set 'order_stash_size' to 0.
-	order_stash_size = 512
+	order_stash_size = 0
 
 	# Power saving options for schedule with wait
 	#

configure.ac

@@ -3,7 +3,7 @@ AC_PREREQ([2.5])
 # ODP API version
 ##########################################################################
 m4_define([odp_version_generation], [1])
-m4_define([odp_version_major],     [46])
+m4_define([odp_version_major],     [47])
 m4_define([odp_version_minor],      [0])
 m4_define([odp_version_patch],      [0])
 
@@ -23,12 +23,21 @@ AC_SUBST(ODP_VERSION_API_MINOR)
 ODP_VERSION_API=odp_version_api
 AC_SUBST(ODP_VERSION_API)
 
+##########################################################################
+# ODP Git Revision
+##########################################################################
+m4_define([odp_git_revision],
+	[m4_esyscmd_s([sh -c 'hash=$(git rev-parse --short=8 HEAD 2>/dev/null) && echo "-$hash" || echo ""'])])
+
+ODP_GIT_REVISION=odp_git_revision
+AC_DEFINE_UNQUOTED([_ODP_GIT_REVISION], ["$ODP_GIT_REVISION"], "ODP Git Revision")
+
 ##########################################################################
 # Helper library version
 ##########################################################################
 m4_define([odph_version_generation], [1])
 m4_define([odph_version_major], [7])
-m4_define([odph_version_minor], [0])
+m4_define([odph_version_minor], [1])
 
 m4_define([odph_version],
     [odph_version_generation.odph_version_major.odph_version_minor])

example/classifier/odp_classifier.c

@@ -1161,7 +1161,6 @@ static int parse_policy_ci_pass_count(appl_args_t *appl_args, char *optarg)
 static int parse_args(int argc, char *argv[], appl_args_t *appl_args)
 {
 	int opt;
-	int long_index;
 	size_t len;
 	int i;
 	int interface = 0;
@@ -1198,7 +1197,7 @@ static int parse_args(int argc, char *argv[], appl_args_t *appl_args)
 
 	while (ret == 0) {
 		opt = getopt_long(argc, argv, shortopts,
-				  longopts, &long_index);
+				  longopts, NULL);
 
 		if (opt == -1)
 			break;	/* No more options */

example/debug/odp_debug.c

@@ -58,7 +58,7 @@ static void print_usage(void)
 
 static int parse_options(int argc, char *argv[], test_global_t *global)
 {
-	int opt, long_index;
+	int opt;
 	char *str;
 	uint32_t str_len = 0;
 
@@ -78,7 +78,7 @@ static int parse_options(int argc, char *argv[], test_global_t *global)
 	int ret = 0;
 
 	while (1) {
-		opt = getopt_long(argc, argv, shortopts, longopts, &long_index);
+		opt = getopt_long(argc, argv, shortopts, longopts, NULL);
 
 		if (opt == -1)
 			break;	/* No more options */

example/ipsec_api/odp_ipsec.c

@@ -1188,7 +1188,6 @@ main(int argc, char *argv[])
 static void parse_args(int argc, char *argv[], appl_args_t *appl_args)
 {
 	int opt;
-	int long_index;
 	char *token;
 	size_t len;
 	int rc = 0;
@@ -1216,7 +1215,7 @@ static void parse_args(int argc, char *argv[], appl_args_t *appl_args)
 	printf("\nParsing command line options\n");
 
 	while (!rc) {
-		opt = getopt_long(argc, argv, shortopts, longopts, &long_index);
+		opt = getopt_long(argc, argv, shortopts, longopts, NULL);
 
 		if (-1 == opt)
 			break;	/* No more options */

example/ipsec_crypto/odp_ipsec.c

@@ -1471,7 +1471,6 @@ main(int argc, char *argv[])
 static void parse_args(int argc, char *argv[], appl_args_t *appl_args)
 {
 	int opt;
-	int long_index;
 	char *token;
 	size_t len;
 	int rc = 0;
@@ -1499,7 +1498,7 @@ static void parse_args(int argc, char *argv[], appl_args_t *appl_args)
 	appl_args->mode = 0;  /* turn off async crypto API by default */
 
 	while (!rc) {
-		opt = getopt_long(argc, argv, shortopts, longopts, &long_index);
+		opt = getopt_long(argc, argv, shortopts, longopts, NULL);
 
 		if (-1 == opt)
 			break;	/* No more options */

example/l3fwd/odp_l3fwd.c

@@ -516,7 +516,6 @@ static void print_usage(char *progname)
 static void parse_cmdline_args(int argc, char *argv[], app_args_t *args)
 {
 	int opt;
-	int long_index;
 	char *token, *local;
 	size_t len, route_index = 0;
 	int mem_failure = 0;
@@ -538,7 +537,7 @@ static void parse_cmdline_args(int argc, char *argv[], app_args_t *args)
 
 	while (1) {
 		opt = getopt_long(argc, argv, "+s:t:d:i:r:q:e:h",
-				  longopts, &long_index);
+				  longopts, NULL);
 
 		if (opt == -1)
 			break;	/* No more options */

example/packet/odp_packet_dump.c

@@ -109,7 +109,7 @@ static int parse_int_list(char *str, int integer[], int max_num)
 
 static int parse_options(int argc, char *argv[], test_global_t *global)
 {
-	int i, opt, long_index;
+	int i, opt;
 	char *name, *str;
 	int len, str_len, num;
 
@@ -128,7 +128,7 @@ static int parse_options(int argc, char *argv[], test_global_t *global)
 	int ret = 0;
 
 	while (1) {
-		opt = getopt_long(argc, argv, shortopts, longopts, &long_index);
+		opt = getopt_long(argc, argv, shortopts, longopts, NULL);
 
 		if (opt == -1)
 			break;	/* No more options */