* [dts] [PATCH V1] doc/dts_gsg/usage_of_create_eal_and_start_testpmd
@ 2019-11-06 2:16 Jianwei Mei
2019-11-22 5:52 ` Tu, Lijuan
0 siblings, 1 reply; 2+ messages in thread
From: Jianwei Mei @ 2019-11-06 2:16 UTC (permalink / raw)
To: dts; +Cc: Jianwei Mei
usage of create eal parameters and start testpmd functions.
Signed-off-by: Jianwei Mei <jianweix.mei@intel.com>
---
.../usage_of_create_eal_and_start_testpmd.rst | 103 +++++++++++++++++++++
1 file changed, 103 insertions(+)
create mode 100644 doc/dts_gsg/usage_of_create_eal_and_start_testpmd.rst
diff --git a/doc/dts_gsg/usage_of_create_eal_and_start_testpmd.rst b/doc/dts_gsg/usage_of_create_eal_and_start_testpmd.rst
new file mode 100644
index 0000000..e1d077d
--- /dev/null
+++ b/doc/dts_gsg/usage_of_create_eal_and_start_testpmd.rst
@@ -0,0 +1,103 @@
+How create_eal_parameters and start_testpmd methods use in DPDK Test Suite
+===========================
+
+create_eal_parameters
+----------------------------
+
+This method used to create EAL parameters character string in DPDK Test Suite.
+for example: -l 1,2 -w 0000:88:00.0 -w 0000:88:00.1 --file-prefix=dpdk_1112_20190809143420.
+
+.. code-block:: console
+
+ define: create_eal_parameters(self, fixed_prefix=False, socket=-1, **config)
+
+ usage and example:
+ no user parameters:
+ param = self.dut.create_eal_parameters()
+ output:
+ param = '-l 1,2 -n 4 -w 0000:1a:00.0 -w 0000:1a:00.1 --file-prefix=dpdk_397938_20191105143309'
+
+ user parameters:
+ 1. usage for port and port options, there are two methods for them.
+ param = self.dut.create_eal_parameters(cores='1S/4C/1T', ports=[0,1], port_options={0: "proto_xtr=vlan"})
+ or
+ param = self.dut.create_eal_parameters(cores='1S/4C/1T', ports=['0000:1a:00.0', '0000:1a:00.1'], port_options={'0000:1a:00.0': "proto_xtr=vlan"})
+ output:
+ param = '-l 1,2,3,4 -n 4 -w 0000:1a:00.0,proto_xtr=vlan -w 0000:1a:00.1 --file-prefix=dpdk_399214_20191105155446'
+
+ 2. usage for b_ports.
+ param = self.dut.create_eal_parameters(cores='1S/4C/1T', b_ports=[0])
+ or
+ param = self.dut.create_eal_parameters(cores='1S/4C/1T', b_ports=['0000:1a:00.0'])
+ output:
+ param = '-l 1,2,3,4 -n 4 -b 0000:1a:00.0 --file-prefix=dpdk_399214_20191105155446'
+
+ 3. usage for no-pci.
+ param = self.dut.create_eal_parameters(cores='1S/4C/1T', no_pci=True)
+ output:
+ param = '-l 1,2,3,4 -n 4 --file-prefix=dpdk_399214_20191105155446 --no-pci'
+
+ 4. usage for prefix, if fixed_prefix = True, the file-prefix will use the value of prefix, or the value is dpdk_pid_timestamp.
+ param = self.dut.create_eal_parameters(cores='1S/4C/1T', ports=[0, 1], port_options={0: "proto_xtr=vlan"}, fixed_prefix=True, prefix='user_defined')
+ output:
+ param = '-l 1,2,3,4 -n 4 -w 0000:1a:00.0,proto_xtr=vlan -w 0000:1a:00.1 --file-prefix=user_defined'
+
+ 5. usege for vdevs.
+ param_vdev = self.dut.create_eal_parameters(cores='1S/4C/1T', no_pci=True, vdevs=[r"net_virtio_user0,mac=%s,path=./vhost-net,queues=1"])
+ output:
+ param = '-l 1,2,3,4 -n 4 --file-prefix=dpdk_399214_20191105155446 --no-pci --vdev net_virtio_user0,mac=%s,path=./vhost-net,queues=1'
+
+
+create_eal_parameters function supports the following parameters:
+
+.. table::
+
+ +---------------------------+---------------------------------------------------+------------------+
+ | parameter | description | Default Value |
+ +---------------------------+---------------------------------------------------+------------------+
+ | fixed_prefix | Indicate use default prefix or user define prefix | False |
+ +---------------------------+---------------------------------------------------+------------------+
+ | socket | socket of system | -1 |
+ +---------------------------+---------------------------------------------------+------------------+
+ | cores | set core list | 1S/2C/1T |
+ +---------------------------+---------------------------------------------------+------------------+
+ | ports | PCI list or PCI ID list | |
+ +---------------------------+---------------------------------------------------+------------------+
+ | port_options | other port options | |
+ +---------------------------+---------------------------------------------------+------------------+
+ | b_ports | PCI device in black list | |
+ +---------------------------+---------------------------------------------------+------------------+
+ | no_pci | Disable PCI bug | |
+ +---------------------------+---------------------------------------------------+------------------+
+ | prefix | Use a different shared data file prefix for a | |
+ | | DPDK process | |
+ +---------------------------+---------------------------------------------------+------------------+
+ | vdevs | Add a virtual device | |
+ +---------------------------+---------------------------------------------------+------------------+
+
+
+start_testpmd
+----------------------------
+
+The method use to start testpmd application.
+
+.. code-block:: console
+
+ define: start_testpmd(self, cores='default', param='', eal_param='', socket=0, fixed_prefix=False, **config)
+
+ usage and example:
+ no user parameters:
+ out = self.pmdout.start_testpmd()
+ user parameters:
+ 1. Those two parameters param and eal_param are used for current test suites.
+ for example:
+ In current test suite TestSuite_runtime_vf_queue_number, the eal parameters are wrote as a line string as below.
+ eal_param = '-w %s,queue-num-per-vf=%d --file-prefix=test1 --socket-mem 1024,1024' % (self.pf_pci, invalid_qn)
+ then you can call start_testpmd like this.
+ out = self.pmdout.start_testpmd(self.pmdout.default_cores, param='', eal_param=eal_param)
+
+ Another usage in current test suite like below:
+ self.pmdout.start_testpmd("Default", "--portmask=%s " %(self.portMask) + " --enable-rx-cksum " + "--port-topology=loop", socket=self.ports_socket)
+
+ 2. If you will write a new test suite and need to call start_testpmd method,
+ The usage of other parameters such as cores, socket, fixed_prefix and **config are the same as create_eal_parameters.
\ No newline at end of file
--
1.8.3.1
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [dts] [PATCH V1] doc/dts_gsg/usage_of_create_eal_and_start_testpmd
2019-11-06 2:16 [dts] [PATCH V1] doc/dts_gsg/usage_of_create_eal_and_start_testpmd Jianwei Mei
@ 2019-11-22 5:52 ` Tu, Lijuan
0 siblings, 0 replies; 2+ messages in thread
From: Tu, Lijuan @ 2019-11-22 5:52 UTC (permalink / raw)
To: Mei, JianweiX, dts; +Cc: Mei, JianweiX
Applied, thanks
> -----Original Message-----
> From: dts [mailto:dts-bounces@dpdk.org] On Behalf Of Jianwei Mei
> Sent: Wednesday, November 6, 2019 10:17 AM
> To: dts@dpdk.org
> Cc: Mei, JianweiX <jianweix.mei@intel.com>
> Subject: [dts] [PATCH V1]
> doc/dts_gsg/usage_of_create_eal_and_start_testpmd
>
> usage of create eal parameters and start testpmd functions.
>
> Signed-off-by: Jianwei Mei <jianweix.mei@intel.com>
> ---
> .../usage_of_create_eal_and_start_testpmd.rst | 103
> +++++++++++++++++++++
> 1 file changed, 103 insertions(+)
> create mode 100644
> doc/dts_gsg/usage_of_create_eal_and_start_testpmd.rst
>
> diff --git a/doc/dts_gsg/usage_of_create_eal_and_start_testpmd.rst
> b/doc/dts_gsg/usage_of_create_eal_and_start_testpmd.rst
> new file mode 100644
> index 0000000..e1d077d
> --- /dev/null
> +++ b/doc/dts_gsg/usage_of_create_eal_and_start_testpmd.rst
> @@ -0,0 +1,103 @@
> +How create_eal_parameters and start_testpmd methods use in DPDK Test
> +Suite ===========================
> +
> +create_eal_parameters
> +----------------------------
> +
> +This method used to create EAL parameters character string in DPDK Test
> Suite.
> +for example: -l 1,2 -w 0000:88:00.0 -w 0000:88:00.1 --file-
> prefix=dpdk_1112_20190809143420.
> +
> +.. code-block:: console
> +
> + define: create_eal_parameters(self, fixed_prefix=False, socket=-1,
> + **config)
> +
> + usage and example:
> + no user parameters:
> + param = self.dut.create_eal_parameters()
> + output:
> + param = '-l 1,2 -n 4 -w 0000:1a:00.0 -w 0000:1a:00.1 --file-
> prefix=dpdk_397938_20191105143309'
> +
> + user parameters:
> + 1. usage for port and port options, there are two methods for them.
> + param = self.dut.create_eal_parameters(cores='1S/4C/1T',
> ports=[0,1], port_options={0: "proto_xtr=vlan"})
> + or
> + param = self.dut.create_eal_parameters(cores='1S/4C/1T',
> ports=['0000:1a:00.0', '0000:1a:00.1'], port_options={'0000:1a:00.0':
> "proto_xtr=vlan"})
> + output:
> + param = '-l 1,2,3,4 -n 4 -w 0000:1a:00.0,proto_xtr=vlan -w
> 0000:1a:00.1 --file-prefix=dpdk_399214_20191105155446'
> +
> + 2. usage for b_ports.
> + param = self.dut.create_eal_parameters(cores='1S/4C/1T',
> b_ports=[0])
> + or
> + param = self.dut.create_eal_parameters(cores='1S/4C/1T',
> b_ports=['0000:1a:00.0'])
> + output:
> + param = '-l 1,2,3,4 -n 4 -b 0000:1a:00.0 --file-
> prefix=dpdk_399214_20191105155446'
> +
> + 3. usage for no-pci.
> + param = self.dut.create_eal_parameters(cores='1S/4C/1T',
> no_pci=True)
> + output:
> + param = '-l 1,2,3,4 -n 4 --file-
> prefix=dpdk_399214_20191105155446 --no-pci'
> +
> + 4. usage for prefix, if fixed_prefix = True, the file-prefix will use the
> value of prefix, or the value is dpdk_pid_timestamp.
> + param = self.dut.create_eal_parameters(cores='1S/4C/1T',
> ports=[0, 1], port_options={0: "proto_xtr=vlan"}, fixed_prefix=True,
> prefix='user_defined')
> + output:
> + param = '-l 1,2,3,4 -n 4 -w 0000:1a:00.0,proto_xtr=vlan -w
> 0000:1a:00.1 --file-prefix=user_defined'
> +
> + 5. usege for vdevs.
> + param_vdev = self.dut.create_eal_parameters(cores='1S/4C/1T',
> no_pci=True, vdevs=[r"net_virtio_user0,mac=%s,path=./vhost-
> net,queues=1"])
> + output:
> + param = '-l 1,2,3,4 -n 4 --file-
> prefix=dpdk_399214_20191105155446 --no-pci --vdev
> net_virtio_user0,mac=%s,path=./vhost-net,queues=1'
> +
> +
> +create_eal_parameters function supports the following parameters:
> +
> +.. table::
> +
> + +---------------------------+---------------------------------------------------+-------------
> -----+
> + | parameter | description | Default Value
> |
> + +---------------------------+---------------------------------------------------+-------------
> -----+
> + | fixed_prefix | Indicate use default prefix or user define prefix |
> False |
> + +---------------------------+---------------------------------------------------+-------------
> -----+
> + | socket | socket of system | -1 |
> + +---------------------------+---------------------------------------------------+-------------
> -----+
> + | cores | set core list | 1S/2C/1T |
> + +---------------------------+---------------------------------------------------+-------------
> -----+
> + | ports | PCI list or PCI ID list | |
> + +---------------------------+---------------------------------------------------+-------------
> -----+
> + | port_options | other port options | |
> + +---------------------------+---------------------------------------------------+-------------
> -----+
> + | b_ports | PCI device in black list | |
> + +---------------------------+---------------------------------------------------+-------------
> -----+
> + | no_pci | Disable PCI bug | |
> + +---------------------------+---------------------------------------------------+-------------
> -----+
> + | prefix | Use a different shared data file prefix for a |
> |
> + | | DPDK process | |
> + +---------------------------+---------------------------------------------------+-------------
> -----+
> + | vdevs | Add a virtual device | |
> +
> + +---------------------------+-----------------------------------------
> + ----------+------------------+
> +
> +
> +start_testpmd
> +----------------------------
> +
> +The method use to start testpmd application.
> +
> +.. code-block:: console
> +
> + define: start_testpmd(self, cores='default', param='', eal_param='',
> + socket=0, fixed_prefix=False, **config)
> +
> + usage and example:
> + no user parameters:
> + out = self.pmdout.start_testpmd()
> + user parameters:
> + 1. Those two parameters param and eal_param are used for current
> test suites.
> + for example:
> + In current test suite TestSuite_runtime_vf_queue_number, the
> eal parameters are wrote as a line string as below.
> + eal_param = '-w %s,queue-num-per-vf=%d --file-prefix=test1 --
> socket-mem 1024,1024' % (self.pf_pci, invalid_qn)
> + then you can call start_testpmd like this.
> + out =
> + self.pmdout.start_testpmd(self.pmdout.default_cores, param='',
> + eal_param=eal_param)
> +
> + Another usage in current test suite like below:
> + self.pmdout.start_testpmd("Default",
> + "--portmask=%s " %(self.portMask) + " --enable-rx-cksum " +
> + "--port-topology=loop", socket=self.ports_socket)
> +
> + 2. If you will write a new test suite and need to call start_testpmd
> method,
> + The usage of other parameters such as cores, socket, fixed_prefix
> and **config are the same as create_eal_parameters.
> \ No newline at end of file
> --
> 1.8.3.1
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2019-11-22 5:53 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-11-06 2:16 [dts] [PATCH V1] doc/dts_gsg/usage_of_create_eal_and_start_testpmd Jianwei Mei
2019-11-22 5:52 ` Tu, Lijuan
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).