aboutsummaryrefslogtreecommitdiff
path: root/test/performance/odp_l2fwd.c
diff options
context:
space:
mode:
authorMatias Elo <matias.elo@nokia.com>2024-02-14 16:40:43 +0200
committerMatias Elo <matias.elo@nokia.com>2024-02-29 15:47:17 +0200
commita8a283772f07d8ae5b04fae55170c800f871d6fb (patch)
treeafb65422c6439e11eec8149d62308e55d14b2c9a /test/performance/odp_l2fwd.c
parentfd270c984773dcda55069ce70836f4ab72c28e7b (diff)
example: l2fwd: remove symbolic link to performance test application
Remove symbolic link to odp_l2fwd performance test application and copy relevant information from old README file to application source file. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com>
Diffstat (limited to 'test/performance/odp_l2fwd.c')
-rw-r--r--test/performance/odp_l2fwd.c8
1 files changed, 7 insertions, 1 deletions
diff --git a/test/performance/odp_l2fwd.c b/test/performance/odp_l2fwd.c
index 7435c5769..249286297 100644
--- a/test/performance/odp_l2fwd.c
+++ b/test/performance/odp_l2fwd.c
@@ -9,7 +9,13 @@
/**
* @example odp_l2fwd.c
*
- * L2 forwarding example application
+ * This L2 forwarding application can be used as example as well as performance
+ * test for different ODP packet I/O modes (direct, queue or scheduled).
+ *
+ * Note that this example is tuned for performance. As a result, when using
+ * scheduled packet input mode with direct or queued output mode and multiple
+ * output queues, packet order is not guaranteed. To maintain packet order,
+ * use a single worker thread or output interfaces with one output queue.
*
* @cond _ODP_HIDE_FROM_DOXYGEN_
*/