diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guides/contributing/patches.rst | 2 | ||||
| -rw-r--r-- | doc/guides/prog_guide/env_abstraction_layer.rst | 2 | ||||
| -rw-r--r-- | doc/guides/prog_guide/pdump_lib.rst | 12 | ||||
| -rw-r--r-- | doc/guides/prog_guide/ring_lib.rst | 30 | ||||
| -rw-r--r-- | doc/guides/rel_notes/release_16_07.rst | 1 | ||||
| -rw-r--r-- | doc/guides/sample_app_ug/pdump.rst | 40 |
6 files changed, 55 insertions, 32 deletions
diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 06af91d6..16a21a52 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -22,7 +22,7 @@ The DPDK development process has the following features: * Patches are reviewed publicly on the mailing list. * Successfully reviewed patches are merged to the master branch of the repository. -The mailing list for DPDK development is `dev@dpkg.org <http://dpdk.org/ml/archives/dev/>`_. +The mailing list for DPDK development is `dev@dpdk.org <http://dpdk.org/ml/archives/dev/>`_. Contributors will need to `register for the mailing list <http://dpdk.org/ml/listinfo/dev>`_ in order to submit patches. It is also worth registering for the DPDK `Patchwork <http://dpdk.org/dev/patchwxispork/project/dpdk/list/>`_ diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst index 4b9895e4..10a10a88 100644 --- a/doc/guides/prog_guide/env_abstraction_layer.rst +++ b/doc/guides/prog_guide/env_abstraction_layer.rst @@ -341,7 +341,7 @@ Known Issues be preempted by another pthread doing a multi-consumer dequeue on the same ring. - Bypassing this constraint it may cause the 2nd pthread to spin until the 1st one is scheduled again. + Bypassing this constraint may cause the 2nd pthread to spin until the 1st one is scheduled again. Moreover, if the 1st pthread is preempted by a context that has an higher priority, it may even cause a dead lock. This does not mean it cannot be used, simply, there is a need to narrow down the situation when it is used by multi-pthread on the same core. diff --git a/doc/guides/prog_guide/pdump_lib.rst b/doc/guides/prog_guide/pdump_lib.rst index 580ffcbd..0136781a 100644 --- a/doc/guides/prog_guide/pdump_lib.rst +++ b/doc/guides/prog_guide/pdump_lib.rst @@ -75,13 +75,13 @@ the packet capture. The packet capture framework, as part of its initialization, creates the pthread and the server socket in the pthread. The application that calls the framework initialization will have the server socket created, -either under the path that the application has passed or under the default path i.e. either ``/var/run`` for -root user or ``$HOME`` for non root user. +either under the path that the application has passed or under the default path i.e. either ``/var/run/.dpdk`` for +root user or ``~/.dpdk`` for non root user. Applications that request enabling or disabling of the packet capture will have the client socket created either under -the path that the application has passed or under the default path i.e. either ``/var/run/`` for root user or ``$HOME`` -for not root user to send the requests to the server. -The server socket will listen for client requests for enabling or disabling the packet capture. +the path that the application has passed or under the default path i.e. either ``/var/run/.dpdk`` for root user or +``~/.dpdk`` for not root user to send the requests to the server. The server socket will listen for client requests for +enabling or disabling the packet capture. Implementation Details @@ -111,7 +111,7 @@ server socket. The library API ``rte_pdump_set_socket_dir()``, sets the given path as either server socket path or client socket path based on the ``type`` argument of the API. -If the given path is ``NULL``, default path will be selected, i.e. either ``/var/run/`` for root user or ``$HOME`` +If the given path is ``NULL``, default path will be selected, i.e. either ``/var/run/.dpdk`` for root user or ``~/.dpdk`` for non root user. Clients also need to call this API to set their server socket path if the server socket path is different from default path. diff --git a/doc/guides/prog_guide/ring_lib.rst b/doc/guides/prog_guide/ring_lib.rst index 3b92a8f0..9f697538 100644 --- a/doc/guides/prog_guide/ring_lib.rst +++ b/doc/guides/prog_guide/ring_lib.rst @@ -252,8 +252,8 @@ In this example, only the producer head and tail (prod_head and prod_tail) are m The initial state is to have a prod_head and prod_tail pointing at the same location. -Multiple Consumer Enqueue First Step -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Multiple Producers Enqueue First Step +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ On both cores, *ring->prod_head* and ring->cons_tail are copied in local variables. The prod_next local variable points to the next element of the table, @@ -266,11 +266,11 @@ If there is not enough room in the ring (this is detected by checking cons_tail) .. figure:: img/ring-mp-enqueue1.* - Multiple consumer enqueue first step + Multiple producer enqueue first step -Multiple Consumer Enqueue Second Step -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Multiple Producers Enqueue Second Step +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The second step is to modify ring->prod_head in the ring structure to point to the same location as prod_next. This operation is done using a Compare And Swap (CAS) instruction, which does the following operations atomically: @@ -288,11 +288,11 @@ In the figure, the operation succeeded on core 1, and step one restarted on core .. figure:: img/ring-mp-enqueue2.* - Multiple consumer enqueue second step + Multiple producer enqueue second step -Multiple Consumer Enqueue Third Step -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Multiple Producers Enqueue Third Step +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The CAS operation is retried on core 2 with success. @@ -303,11 +303,11 @@ The core 1 updates one element of the ring(obj4), and the core 2 updates another .. figure:: img/ring-mp-enqueue3.* - Multiple consumer enqueue third step + Multiple producer enqueue third step -Multiple Consumer Enqueue Fourth Step -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Multiple Producers Enqueue Fourth Step +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Each core now wants to update ring->prod_tail. A core can only update it if ring->prod_tail is equal to the prod_head local variable. @@ -318,11 +318,11 @@ This is only true on core 1. The operation is finished on core 1. .. figure:: img/ring-mp-enqueue4.* - Multiple consumer enqueue fourth step + Multiple producer enqueue fourth step -Multiple Consumer Enqueue Last Step -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Multiple Producers Enqueue Last Step +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Once ring->prod_tail is updated by core 1, core 2 is allowed to update it too. The operation is also finished on core 2. @@ -332,7 +332,7 @@ The operation is also finished on core 2. .. figure:: img/ring-mp-enqueue5.* - Multiple consumer enqueue last step + Multiple producer enqueue last step Modulo 32-bit Indexes diff --git a/doc/guides/rel_notes/release_16_07.rst b/doc/guides/rel_notes/release_16_07.rst index e2af1474..d3a144fb 100644 --- a/doc/guides/rel_notes/release_16_07.rst +++ b/doc/guides/rel_notes/release_16_07.rst @@ -333,6 +333,7 @@ The libraries prepended with a plus sign were incremented in this version. librte_mbuf.so.2 + librte_mempool.so.2 librte_meter.so.1 + librte_pdump.so.1 librte_pipeline.so.3 librte_pmd_bond.so.1 librte_pmd_ring.so.2 diff --git a/doc/guides/sample_app_ug/pdump.rst b/doc/guides/sample_app_ug/pdump.rst index 96c8709e..ceb038ec 100644 --- a/doc/guides/sample_app_ug/pdump.rst +++ b/doc/guides/sample_app_ug/pdump.rst @@ -33,14 +33,23 @@ dpdk_pdump Application ====================== -The ``dpdk_pdump`` application is a Data Plane Development Kit (DPDK) application that runs as a DPDK secondary process and -is capable of enabling packet capture on dpdk ports. +The ``dpdk_pdump`` tool is a Data Plane Development Kit (DPDK) tool that runs as +a DPDK secondary process and is capable of enabling packet capture on dpdk ports. + + .. Note:: + + * The ``dpdk_pdump`` tool depends on libpcap based PMD which is disabled + by default in the build configuration files, + owing to an external dependency on the libpcap development files + which must be installed on the board. + Once the libpcap development files are installed, the libpcap based PMD + can be enabled by setting CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK. Running the Application ----------------------- -The application has a ``--pdump`` command line option with various sub arguments: +The tool has a number of command line options: .. code-block:: console @@ -52,18 +61,31 @@ The application has a ``--pdump`` command line option with various sub arguments [ring-size=<ring size>], [mbuf-size=<mbuf data size>], [total-num-mbufs=<number of mbufs>]' + [--server-socket-path=<server socket dir>] + [--client-socket-path=<client socket dir>] + +The ``--pdump`` command line option is mandatory and it takes various sub arguments which are described in +below section. + + .. Note:: + + * Parameters inside the parentheses represents mandatory parameters. -Note: + * Parameters inside the square brackets represents optional parameters. -* Parameters inside the parentheses represents mandatory parameters. + * Multiple instances of ``--pdump`` can be passed to capture packets on different port and queue combinations. -* Parameters inside the square brackets represents optional parameters. +The ``--server-socket-path`` command line option is optional. This represents the server socket directory. +If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/`` +for non root users. -Multiple instances of ``--pdump`` can be passed to capture packets on different port and queue combinations. +The ``--client-socket-path`` command line option is optional. This represents the client socket directory. +If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/`` +for non root users. -Parameters -~~~~~~~~~~ +The ``--pdump`` parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~ ``port``: Port id of the eth device on which packets should be captured. |