Term "poll" does not describe queue type accurately. Many resources
can be polled. For example, application polls the scheduler to
dequeue from "sched" type queues. Term "plain queues" describe better
what these queues offer, a plain storage of events which application
can directly dequeue (instead of using the scheduler).

Signed-off-by: Petri Savolainen <[email protected]>
---
 example/generator/odp_generator.c                          |  6 +++---
 example/ipsec/odp_ipsec.c                                  |  6 +++---
 example/time/time_global_test.c                            |  2 +-
 include/odp/api/queue.h                                    | 10 ++++++++--
 platform/linux-generic/include/odp/plat/queue_types.h      |  2 +-
 platform/linux-generic/odp_packet_io.c                     |  2 +-
 platform/linux-generic/odp_schedule.c                      |  4 ++--
 platform/linux-generic/pktio/loop.c                        |  2 +-
 test/performance/odp_pktio_perf.c                          |  2 +-
 test/performance/odp_scheduling.c                          |  2 +-
 test/validation/classification/odp_classification_common.c |  2 +-
 .../classification/odp_classification_test_pmr.c           |  8 ++++----
 test/validation/crypto/crypto.c                            |  2 +-
 test/validation/pktio/pktio.c                              | 14 +++++++-------
 test/validation/queue/queue.c                              |  8 ++++----
 test/validation/scheduler/scheduler.c                      |  3 ++-
 test/validation/timer/timer.c                              |  4 ++--
 17 files changed, 43 insertions(+), 36 deletions(-)

diff --git a/example/generator/odp_generator.c 
b/example/generator/odp_generator.c
index 344a227..f597fea 100644
--- a/example/generator/odp_generator.c
+++ b/example/generator/odp_generator.c
@@ -771,7 +771,7 @@ int main(int argc, char *argv[])
                cpu_first = odp_cpumask_first(&cpumask);
                odp_cpumask_set(&cpu_mask, cpu_first);
 
-               tq = odp_queue_create("", ODP_QUEUE_TYPE_POLL, NULL);
+               tq = odp_queue_create("", ODP_QUEUE_TYPE_PLAIN, NULL);
                if (tq == ODP_QUEUE_INVALID)
                        abort();
                args->thread[1].pktio_dev = args->appl.if_names[0];
@@ -789,7 +789,7 @@ int main(int argc, char *argv[])
                                          gen_recv_thread, &args->thread[1],
                                          ODP_THREAD_WORKER);
 
-               tq = odp_queue_create("", ODP_QUEUE_TYPE_POLL, NULL);
+               tq = odp_queue_create("", ODP_QUEUE_TYPE_PLAIN, NULL);
                if (tq == ODP_QUEUE_INVALID)
                        abort();
                args->thread[0].pktio_dev = args->appl.if_names[0];
@@ -821,7 +821,7 @@ int main(int argc, char *argv[])
                        if_idx = i % args->appl.if_count;
 
                        args->thread[i].pktio_dev = args->appl.if_names[if_idx];
-                       tq = odp_queue_create("", ODP_QUEUE_TYPE_POLL, NULL);
+                       tq = odp_queue_create("", ODP_QUEUE_TYPE_PLAIN, NULL);
                        if (tq == ODP_QUEUE_INVALID)
                                abort();
                        args->thread[i].pool = pool;
diff --git a/example/ipsec/odp_ipsec.c b/example/ipsec/odp_ipsec.c
index ea4e46a..938fe7d 100644
--- a/example/ipsec/odp_ipsec.c
+++ b/example/ipsec/odp_ipsec.c
@@ -245,8 +245,8 @@ odp_queue_t polled_odp_queue_create(const char *name,
        odp_queue_type_t my_type = type;
 
        if (ODP_QUEUE_TYPE_SCHED == type) {
-               printf("%s: change %s to POLL\n", __func__, name);
-               my_type = ODP_QUEUE_TYPE_POLL;
+               printf("%s: change %s to PLAIN\n", __func__, name);
+               my_type = ODP_QUEUE_TYPE_PLAIN;
        }
 
        my_queue = odp_queue_create(name, my_type, NULL);
@@ -454,7 +454,7 @@ void initialize_loop(char *intf)
        snprintf(queue_name, sizeof(queue_name), "%i-loop_outq_def", idx);
        queue_name[ODP_QUEUE_NAME_LEN - 1] = '\0';
 
-       outq_def = queue_create(queue_name, ODP_QUEUE_TYPE_POLL, &qparam);
+       outq_def = queue_create(queue_name, ODP_QUEUE_TYPE_PLAIN, &qparam);
        if (ODP_QUEUE_INVALID == outq_def) {
                EXAMPLE_ERR("Error: output queue creation failed for %s\n",
                            intf);
diff --git a/example/time/time_global_test.c b/example/time/time_global_test.c
index 47559ea..717f0bf 100644
--- a/example/time/time_global_test.c
+++ b/example/time/time_global_test.c
@@ -192,7 +192,7 @@ static void *run_thread(void *ptr)
 
        id = odp_atomic_fetch_inc_u32(&gbls->id_counter);
        sprintf(queue_name, QUEUE_NAME_PREFIX "%d", id);
-       queue = odp_queue_create(queue_name, ODP_QUEUE_TYPE_POLL, &qparams);
+       queue = odp_queue_create(queue_name, ODP_QUEUE_TYPE_PLAIN, &qparams);
        if (queue == ODP_QUEUE_INVALID)
                EXAMPLE_ABORT("Cannot create thread queue, thread %d", thr);
 
diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h
index 3ee69fc..87dc4a1 100644
--- a/include/odp/api/queue.h
+++ b/include/odp/api/queue.h
@@ -54,11 +54,17 @@ extern "C" {
 /**
  * @def ODP_QUEUE_TYPE_SCHED
  * Scheduled queue
+ *
+ * Scheduled queues are connected to the scheduler. Application must not
+ * dequeue events directly from these queues but use the scheduler instead.
  */
 
 /**
- * @def ODP_QUEUE_TYPE_POLL
- * Not scheduled queue
+ * @def ODP_QUEUE_TYPE_PLAIN
+ * Plain queue
+ *
+ * Plain queues offer simple FIFO storage of events. Application may dequeue
+ * directly from these queues.
  */
 
 /**
diff --git a/platform/linux-generic/include/odp/plat/queue_types.h 
b/platform/linux-generic/include/odp/plat/queue_types.h
index ace56fa..2551c0c 100644
--- a/platform/linux-generic/include/odp/plat/queue_types.h
+++ b/platform/linux-generic/include/odp/plat/queue_types.h
@@ -37,7 +37,7 @@ typedef ODP_HANDLE_T(odp_queue_group_t);
 typedef int odp_queue_type_t;
 
 #define ODP_QUEUE_TYPE_SCHED  0
-#define ODP_QUEUE_TYPE_POLL   1
+#define ODP_QUEUE_TYPE_PLAIN  1
 #define ODP_QUEUE_TYPE_PKTIN  2
 #define ODP_QUEUE_TYPE_PKTOUT 3
 
diff --git a/platform/linux-generic/odp_packet_io.c 
b/platform/linux-generic/odp_packet_io.c
index b24cb1a..49ee08c 100644
--- a/platform/linux-generic/odp_packet_io.c
+++ b/platform/linux-generic/odp_packet_io.c
@@ -1088,7 +1088,7 @@ int odp_pktio_input_queues_config(odp_pktio_t pktio,
        for (i = 0; i < num_queues; i++) {
                if (mode == ODP_PKTIN_MODE_POLL ||
                    mode == ODP_PKTIN_MODE_SCHED) {
-                       odp_queue_type_t type = ODP_QUEUE_TYPE_POLL;
+                       odp_queue_type_t type = ODP_QUEUE_TYPE_PLAIN;
 
                        if (mode == ODP_PKTIN_MODE_SCHED)
                                type = ODP_QUEUE_TYPE_SCHED;
diff --git a/platform/linux-generic/odp_schedule.c 
b/platform/linux-generic/odp_schedule.c
index 1aa60c2..cd1c9db 100644
--- a/platform/linux-generic/odp_schedule.c
+++ b/platform/linux-generic/odp_schedule.c
@@ -179,7 +179,7 @@ int odp_schedule_init_global(void)
                        name[11] = '0' + j - 10*(j / 10);
 
                        queue = odp_queue_create(name,
-                                                ODP_QUEUE_TYPE_POLL, NULL);
+                                                ODP_QUEUE_TYPE_PLAIN, NULL);
 
                        if (queue == ODP_QUEUE_INVALID) {
                                ODP_ERR("Sched init: Queue create failed.\n");
@@ -199,7 +199,7 @@ int odp_schedule_init_global(void)
                name[13] = '0' + i / 10;
                name[14] = '0' + i - 10 * (i / 10);
 
-               queue = odp_queue_create(name, ODP_QUEUE_TYPE_POLL, NULL);
+               queue = odp_queue_create(name, ODP_QUEUE_TYPE_PLAIN, NULL);
 
                if (queue == ODP_QUEUE_INVALID) {
                        ODP_ERR("Sched init: Queue create failed.\n");
diff --git a/platform/linux-generic/pktio/loop.c 
b/platform/linux-generic/pktio/loop.c
index d96cab4..a9823d9 100644
--- a/platform/linux-generic/pktio/loop.c
+++ b/platform/linux-generic/pktio/loop.c
@@ -33,7 +33,7 @@ static int loopback_open(odp_pktio_t id, pktio_entry_t 
*pktio_entry,
        snprintf(loopq_name, sizeof(loopq_name), "%" PRIu64 "-pktio_loopq",
                 odp_pktio_to_u64(id));
        pktio_entry->s.pkt_loop.loopq =
-               odp_queue_create(loopq_name, ODP_QUEUE_TYPE_POLL, NULL);
+               odp_queue_create(loopq_name, ODP_QUEUE_TYPE_PLAIN, NULL);
 
        if (pktio_entry->s.pkt_loop.loopq == ODP_QUEUE_INVALID)
                return -1;
diff --git a/test/performance/odp_pktio_perf.c 
b/test/performance/odp_pktio_perf.c
index 98a5589..8fb9977 100644
--- a/test/performance/odp_pktio_perf.c
+++ b/test/performance/odp_pktio_perf.c
@@ -809,7 +809,7 @@ static int destroy_inq(odp_pktio_t pktio)
 
        /* flush any pending events */
        while (1) {
-               if (q_type == ODP_QUEUE_TYPE_POLL)
+               if (q_type == ODP_QUEUE_TYPE_PLAIN)
                        ev = odp_queue_deq(inq);
                else
                        ev = odp_schedule(NULL, ODP_SCHED_NO_WAIT);
diff --git a/test/performance/odp_scheduling.c 
b/test/performance/odp_scheduling.c
index 68fca94..7458614 100644
--- a/test/performance/odp_scheduling.c
+++ b/test/performance/odp_scheduling.c
@@ -902,7 +902,7 @@ int main(int argc, char *argv[])
        /*
         * Create a queue for direct poll test
         */
-       queue = odp_queue_create("poll_queue", ODP_QUEUE_TYPE_POLL, NULL);
+       queue = odp_queue_create("poll_queue", ODP_QUEUE_TYPE_PLAIN, NULL);
 
        if (queue == ODP_QUEUE_INVALID) {
                LOG_ERR("Poll queue create failed.\n");
diff --git a/test/validation/classification/odp_classification_common.c 
b/test/validation/classification/odp_classification_common.c
index 58d12fe..86ac4de 100644
--- a/test/validation/classification/odp_classification_common.c
+++ b/test/validation/classification/odp_classification_common.c
@@ -170,7 +170,7 @@ odp_queue_t queue_create(const char *queuename, bool sched)
                                         &qparam);
        } else {
                queue = odp_queue_create(queuename,
-                                        ODP_QUEUE_TYPE_POLL,
+                                        ODP_QUEUE_TYPE_PLAIN,
                                         NULL);
        }
 
diff --git a/test/validation/classification/odp_classification_test_pmr.c 
b/test/validation/classification/odp_classification_test_pmr.c
index 9e6a9e2..2323497 100644
--- a/test/validation/classification/odp_classification_test_pmr.c
+++ b/test/validation/classification/odp_classification_test_pmr.c
@@ -39,7 +39,7 @@ odp_pktio_t create_pktio(odp_queue_type_t q_type)
                return ODP_PKTIO_INVALID;
 
        odp_pktio_param_init(&pktio_param);
-       if (q_type == ODP_QUEUE_TYPE_POLL)
+       if (q_type == ODP_QUEUE_TYPE_PLAIN)
                pktio_param.in_mode = ODP_PKTIN_MODE_POLL;
        else
                pktio_param.in_mode = ODP_PKTIN_MODE_SCHED;
@@ -71,9 +71,9 @@ int create_default_inq(odp_pktio_t pktio, odp_queue_type_t 
qtype)
        inq_def = odp_queue_lookup(inq_name);
        if (inq_def == ODP_QUEUE_INVALID)
                inq_def = odp_queue_create(
-                               inq_name,
-                               ODP_QUEUE_TYPE_PKTIN,
-                               qtype == ODP_QUEUE_TYPE_POLL ? NULL : &qparam);
+                       inq_name,
+                       ODP_QUEUE_TYPE_PKTIN,
+                       qtype == ODP_QUEUE_TYPE_PLAIN ? NULL : &qparam);
 
        CU_ASSERT_FATAL(inq_def != ODP_QUEUE_INVALID);
 
diff --git a/test/validation/crypto/crypto.c b/test/validation/crypto/crypto.c
index 1234f78..c8a84ce 100644
--- a/test/validation/crypto/crypto.c
+++ b/test/validation/crypto/crypto.c
@@ -52,7 +52,7 @@ int crypto_init(void)
                return -1;
        }
        out_queue = odp_queue_create("crypto-out",
-                                    ODP_QUEUE_TYPE_POLL, NULL);
+                                    ODP_QUEUE_TYPE_PLAIN, NULL);
        if (ODP_QUEUE_INVALID == out_queue) {
                fprintf(stderr, "Crypto outq creation failed.\n");
                return -1;
diff --git a/test/validation/pktio/pktio.c b/test/validation/pktio/pktio.c
index e412910..5ad4024 100644
--- a/test/validation/pktio/pktio.c
+++ b/test/validation/pktio/pktio.c
@@ -330,9 +330,9 @@ static int create_inq(odp_pktio_t pktio, odp_queue_type_t 
qtype)
        inq_def = odp_queue_lookup(inq_name);
        if (inq_def == ODP_QUEUE_INVALID)
                inq_def = odp_queue_create(
-                               inq_name,
-                               ODP_QUEUE_TYPE_PKTIN,
-                               qtype == ODP_QUEUE_TYPE_POLL ? NULL : &qparam);
+                       inq_name,
+                       ODP_QUEUE_TYPE_PKTIN,
+                       qtype == ODP_QUEUE_TYPE_PLAIN ? NULL : &qparam);
 
        CU_ASSERT(inq_def != ODP_QUEUE_INVALID);
 
@@ -358,7 +358,7 @@ static int destroy_inq(odp_pktio_t pktio)
 
        /* flush any pending events */
        while (1) {
-               if (q_type == ODP_QUEUE_TYPE_POLL)
+               if (q_type == ODP_QUEUE_TYPE_PLAIN)
                        ev = odp_queue_deq(inq);
                else
                        ev = odp_schedule(NULL, ODP_SCHED_NO_WAIT);
@@ -532,7 +532,7 @@ static void test_txrx(odp_pktio_input_mode_t in_mode, int 
num_pkts,
                io->in_mode = in_mode;
 
                if (in_mode == ODP_PKTIN_MODE_POLL) {
-                       create_inq(io->id, ODP_QUEUE_TYPE_POLL);
+                       create_inq(io->id, ODP_QUEUE_TYPE_PLAIN);
                        io->inq = odp_pktio_inq_getdef(io->id);
                } else if (in_mode == ODP_PKTIN_MODE_SCHED) {
                        create_inq(io->id, ODP_QUEUE_TYPE_SCHED);
@@ -684,7 +684,7 @@ void pktio_test_inq_remdef(void)
        pktio = create_pktio(0, ODP_PKTIN_MODE_SCHED,
                             ODP_PKTOUT_MODE_SEND);
        CU_ASSERT_FATAL(pktio != ODP_PKTIO_INVALID);
-       CU_ASSERT(create_inq(pktio, ODP_QUEUE_TYPE_POLL) == 0);
+       CU_ASSERT(create_inq(pktio, ODP_QUEUE_TYPE_PLAIN) == 0);
        inq = odp_pktio_inq_getdef(pktio);
        CU_ASSERT(inq != ODP_QUEUE_INVALID);
        CU_ASSERT(odp_pktio_inq_remdef(pktio) == 0);
@@ -772,7 +772,7 @@ void pktio_test_inq(void)
                             ODP_PKTOUT_MODE_SEND);
        CU_ASSERT_FATAL(pktio != ODP_PKTIO_INVALID);
 
-       CU_ASSERT(create_inq(pktio, ODP_QUEUE_TYPE_POLL) == 0);
+       CU_ASSERT(create_inq(pktio, ODP_QUEUE_TYPE_PLAIN) == 0);
        CU_ASSERT(destroy_inq(pktio) == 0);
        CU_ASSERT(odp_pktio_close(pktio) == 0);
 }
diff --git a/test/validation/queue/queue.c b/test/validation/queue/queue.c
index d412b3b..9205929 100644
--- a/test/validation/queue/queue.c
+++ b/test/validation/queue/queue.c
@@ -59,10 +59,10 @@ void queue_test_sunnydays(void)
        qparams.sched.group = ODP_SCHED_GROUP_WORKER;
 
        queue_creat_id = odp_queue_create("test_queue",
-                                         ODP_QUEUE_TYPE_POLL, &qparams);
+                                         ODP_QUEUE_TYPE_PLAIN, &qparams);
        CU_ASSERT(ODP_QUEUE_INVALID != queue_creat_id);
 
-       CU_ASSERT_EQUAL(ODP_QUEUE_TYPE_POLL,
+       CU_ASSERT_EQUAL(ODP_QUEUE_TYPE_PLAIN,
                        odp_queue_type(queue_creat_id));
 
        queue_id = odp_queue_lookup("test_queue");
@@ -140,7 +140,7 @@ void queue_test_info(void)
        int ret;
 
        /* Create a polled queue and set context */
-       q_poll = odp_queue_create(nq_poll, ODP_QUEUE_TYPE_POLL, NULL);
+       q_poll = odp_queue_create(nq_poll, ODP_QUEUE_TYPE_PLAIN, NULL);
        CU_ASSERT(ODP_QUEUE_INVALID != q_poll);
        CU_ASSERT(odp_queue_context_set(q_poll, q_poll_ctx) == 0);
 
@@ -157,7 +157,7 @@ void queue_test_info(void)
        /* Check info for the polled queue */
        CU_ASSERT(odp_queue_info(q_poll, &info) == 0);
        CU_ASSERT(strcmp(nq_poll, info.name) == 0);
-       CU_ASSERT(info.type == ODP_QUEUE_TYPE_POLL);
+       CU_ASSERT(info.type == ODP_QUEUE_TYPE_PLAIN);
        CU_ASSERT(info.type == odp_queue_type(q_poll));
        ctx = info.param.context; /* 'char' context ptr */
        CU_ASSERT(ctx == q_poll_ctx);
diff --git a/test/validation/scheduler/scheduler.c 
b/test/validation/scheduler/scheduler.c
index c3a9db1..cc19696 100644
--- a/test/validation/scheduler/scheduler.c
+++ b/test/validation/scheduler/scheduler.c
@@ -1344,7 +1344,8 @@ static int create_queues(void)
                        }
 
                        snprintf(name, sizeof(name), "poll_%d_%d_o", i, j);
-                       pq = odp_queue_create(name, ODP_QUEUE_TYPE_POLL, NULL);
+                       pq = odp_queue_create(name,
+                                             ODP_QUEUE_TYPE_PLAIN, NULL);
                        if (pq == ODP_QUEUE_INVALID) {
                                printf("Poll queue create failed.\n");
                                return -1;
diff --git a/test/validation/timer/timer.c b/test/validation/timer/timer.c
index 0bd67fb..c587368 100644
--- a/test/validation/timer/timer.c
+++ b/test/validation/timer/timer.c
@@ -161,7 +161,7 @@ void timer_test_odp_timer_cancel(void)
        /* Start all created timer pools */
        odp_timer_pool_start();
 
-       queue = odp_queue_create("timer_queue", ODP_QUEUE_TYPE_POLL, NULL);
+       queue = odp_queue_create("timer_queue", ODP_QUEUE_TYPE_PLAIN, NULL);
        if (queue == ODP_QUEUE_INVALID)
                CU_FAIL_FATAL("Queue create failed");
 
@@ -279,7 +279,7 @@ static void *worker_entrypoint(void *arg TEST_UNUSED)
        int rc;
 
        odp_queue_t queue = odp_queue_create("timer_queue",
-                                            ODP_QUEUE_TYPE_POLL,
+                                            ODP_QUEUE_TYPE_PLAIN,
                                             NULL);
        if (queue == ODP_QUEUE_INVALID)
                CU_FAIL_FATAL("Queue create failed");
-- 
2.6.3

_______________________________________________
lng-odp mailing list
[email protected]
https://lists.linaro.org/mailman/listinfo/lng-odp

Reply via email to