DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: Haiyue Wang <haiyue.wang@intel.com>
Cc: dev@dpdk.org, anatoly.burakov@intel.com, vattunuru@marvell.com,
	jerinj@marvell.com, alex.williamson@redhat.com,
	david.marchand@redhat.com, john.mcnamara@intel.com
Subject: Re: [dpdk-dev] [PATCH v8 2/2] eal: support for VFIO-PCI VF token
Date: Mon, 20 Apr 2020 19:12:26 +0200	[thread overview]
Message-ID: <3366363.CEsMmvUzM0@thomas> (raw)
In-Reply-To: <20200418173035.8000-3-haiyue.wang@intel.com>

Hi,

A general comment, please try to limit line length (80 is a good limit),
and prefer breaking lines after a punctuation sign.
Try shortening sentences as well.

I would love seeing some documentation reviews from english native speakers.

18/04/2020 19:30, Haiyue Wang:
> --- a/doc/guides/linux_gsg/linux_drivers.rst
> +++ b/doc/guides/linux_gsg/linux_drivers.rst
> +The ``vfio-pci`` module since Linux version 5.7 supports the creation of virtual functions, this feature is disabled
> +by default. When enabled, the PF needs a shared VF token (UUID) to setup the trust between SR-IOV PF and VFs. The VF
> +token is any kind of valid UUID value selected by the user. When the PF device is bound to ``vfio-pci`` module, it should
> +not have any VFs created, this is consistent as before for security reason.
> +
> +Some use cases about how to use the VF token:
> +
> + - The user just uses PF only for DPDK, then no VF token is required to start the PF device.

This use case is not using the token, so it should be mentioned out of this list.

> +
> + - The user wants to creat SR-IOV VFs on the PF device which is bound to ``vfio-pci`` module, then the user needs to select

creat -> create

> +   a valid UUID type VF token to start the PF device; after the VFs are created, this VF token is also required to access each
> +   VF device.
> +
> + - If the DPDK application that runs on PF device exits, and the user wants to start it with another different VF token
> +   value, it will be OK if no application (DPDP or KVM) runs on VF, otherwise, it will fail to start with a kernel message

DPDP -> DPDK.

> +   "[19145.688094] vfio-pci 0000:87:00.0: Incorrect VF token provided for device" shown. When all of the VFs are free, the

The timestamp is useless in the log.
Please insert the log after :: as a fixed-size font line.

> +   user can select a new VF token to start the PF device.
> +
> +The VFs created are bound to ``vfio-pci`` module automatically. DPDK will use the keyword ``vf_token`` as the device argument
> +to pass the VF token value to PF and its related VFs, the PMD should not use it, and this argument will be pruned from the
> +device argument list, so the PMD can parse its own valid device arguments successfully without seeing it.
> +
> +.. code-block:: console
> +
> +    1. sudo modprobe vfio-pci enable_sriov=1
> +
> +    2. ./usertools/dpdk-devbind.py -b vfio-pci 0000:87:00.0
> +
> +    3. echo 2 > /sys/bus/pci/devices/0000:87:00.0/sriov_numvfs
> +
> +    4. Start the PF:
> +        ./x86_64-native-linux-gcc/app/testpmd -l 22-25 -n 4 -w 87:00.0,vf_token=2ab74924-c335-45f4-9b16-8569e5b08258 --file-prefix=pf -- -i

How did you generate this token?

> +
> +    5. Start the VF:
> +        ./x86_64-native-linux-gcc/app/testpmd -l 26-29 -n 4 -w 87:02.0,vf_token=2ab74924-c335-45f4-9b16-8569e5b08258 --file-prefix=vf0 -- -i

Please do not make bullets and comments part of code-block.



  reply	other threads:[~2020-04-20 17:12 UTC|newest]

Thread overview: 92+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-05  4:33 [dpdk-dev] [RFC v1 1/1] vfio: set vf token and gain vf device access vattunuru
2020-04-01  3:14 ` Varghese, Vipin
2020-04-10  7:10   ` Vamsi Krishna Attunuru
2020-04-02 12:43 ` Wang, Haiyue
2020-04-10  7:28   ` Vamsi Krishna Attunuru
2020-04-10  7:43     ` Wang, Haiyue
2020-04-10  7:32 ` [dpdk-dev] [RFC v2] eal: add VFIO-PCI SR-IOV support Haiyue Wang
2020-04-10 13:02   ` [dpdk-dev] [EXT] " Vamsi Krishna Attunuru
2020-04-13  2:31 ` [dpdk-dev] [PATCH v1] " Haiyue Wang
2020-04-13  4:45 ` [dpdk-dev] [PATCH v2] " Haiyue Wang
2020-04-13  6:42 ` [dpdk-dev] [PATCH v3] " Haiyue Wang
2020-04-13  8:29 ` [dpdk-dev] [PATCH v4] " Haiyue Wang
2020-04-13 12:18   ` Thomas Monjalon
2020-04-13 17:01     ` Wang, Haiyue
2020-04-13 15:37   ` Andrew Rybchenko
2020-04-13 16:45     ` Wang, Haiyue
2020-04-14  3:06 ` [dpdk-dev] [PATCH v5 0/2] support for VFIO-PCI VF token interface Haiyue Wang
2020-04-14  3:06   ` [dpdk-dev] [PATCH v5 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-04-14  3:06   ` [dpdk-dev] [PATCH v5 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-04-14  3:21 ` [dpdk-dev] [PATCH v6 0/2] support for VFIO-PCI VF token interface Haiyue Wang
2020-04-14  3:21   ` [dpdk-dev] [PATCH v6 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-04-14  3:21   ` [dpdk-dev] [PATCH v6 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-04-14 13:18   ` [dpdk-dev] [EXT] [PATCH v6 0/2] support for VFIO-PCI VF token interface Vamsi Krishna Attunuru
2020-04-18  9:22   ` [dpdk-dev] " David Marchand
2020-04-18  9:38     ` Wang, Haiyue
2020-04-18  9:50       ` Thomas Monjalon
2020-04-18  9:58         ` Wang, Haiyue
2020-04-18 11:16 ` [dpdk-dev] [PATCH v7 " Haiyue Wang
2020-04-18 11:16   ` [dpdk-dev] [PATCH v7 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-04-18 11:16   ` [dpdk-dev] [PATCH v7 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-04-18 13:26     ` Thomas Monjalon
2020-04-18 17:37       ` Wang, Haiyue
2020-04-18 17:30 ` [dpdk-dev] [PATCH v8 0/2] support for VFIO-PCI VF token interface Haiyue Wang
2020-04-18 17:30   ` [dpdk-dev] [PATCH v8 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-04-18 17:30   ` [dpdk-dev] [PATCH v8 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-04-20 17:12     ` Thomas Monjalon [this message]
2020-04-20 16:53   ` [dpdk-dev] [PATCH v8 0/2] support for VFIO-PCI VF token interface David Marchand
2020-04-20 17:02     ` Wang, Haiyue
2020-04-20 17:13       ` Thomas Monjalon
2020-04-20 17:37         ` Wang, Haiyue
2020-04-20 17:42           ` Thomas Monjalon
2020-04-21  1:38             ` Wang, Haiyue
2020-04-21  2:12               ` Thomas Monjalon
2020-04-21  2:52                 ` Wang, Haiyue
2020-04-21  8:47                   ` Thomas Monjalon
2020-04-21 17:35                     ` Wang, Haiyue
2020-04-22  5:08 ` [dpdk-dev] [PATCH v9 " Haiyue Wang
2020-04-22  5:08   ` [dpdk-dev] [PATCH v9 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-04-22  5:08   ` [dpdk-dev] [PATCH v9 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-04-22  8:23     ` Thomas Monjalon
2020-04-22 14:02       ` Wang, Haiyue
2020-04-26  1:55 ` [dpdk-dev] [PATCH v10 0/2] support for VFIO-PCI VF token interface Haiyue Wang
2020-04-26  1:55   ` [dpdk-dev] [PATCH v10 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-04-26  1:55   ` [dpdk-dev] [PATCH v10 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-04-27 11:18     ` Burakov, Anatoly
2020-05-06 16:40     ` Andrew Rybchenko
2020-05-05  7:46 ` [dpdk-dev] [PATCH v11 0/2] support for VFIO-PCI VF token interface Haiyue Wang
2020-05-05  7:46   ` [dpdk-dev] [PATCH v11 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-05-05  7:46   ` [dpdk-dev] [PATCH v11 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-05-05 10:34 ` [dpdk-dev] [PATCH v12 0/2] support for VFIO-PCI VF token interface Haiyue Wang
2020-05-05 10:34   ` [dpdk-dev] [PATCH v12 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-05-05 10:34   ` [dpdk-dev] [PATCH v12 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-05-06 10:27     ` Burakov, Anatoly
2020-05-06 11:35       ` Wang, Haiyue
2020-05-06 11:39         ` Burakov, Anatoly
2020-05-06 11:44           ` Wang, Haiyue
2020-05-06 11:35 ` [dpdk-dev] [PATCH v13 0/2] support for VFIO-PCI VF token interface Haiyue Wang
2020-05-06 11:35   ` [dpdk-dev] [PATCH v13 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-05-06 11:35   ` [dpdk-dev] [PATCH v13 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-05-06 16:51     ` Andrew Rybchenko
2020-05-06 16:56       ` Wang, Haiyue
2020-05-06 16:58         ` Andrew Rybchenko
2020-05-06 17:06           ` Wang, Haiyue
2020-05-28  1:22 ` [dpdk-dev] [PATCH v14 0/2] support for VFIO-PCI VF token interface Haiyue Wang
2020-05-28  1:22   ` [dpdk-dev] [PATCH v14 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-05-28  1:22   ` [dpdk-dev] [PATCH v14 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-05-29  1:26     ` Ye Xiaolong
2020-05-29  1:38       ` Wang, Haiyue
2020-05-29  1:37 ` [dpdk-dev] [PATCH v15 0/2] support for VFIO-PCI VF token interface Haiyue Wang
2020-05-29  1:37   ` [dpdk-dev] [PATCH v15 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-05-29  1:37   ` [dpdk-dev] [PATCH v15 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-06-17  6:33 ` [dpdk-dev] [PATCH v16 0/2] support for VFIO-PCI VF token interface Haiyue Wang
2020-06-17  6:33   ` [dpdk-dev] [PATCH v16 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-06-17  6:33   ` [dpdk-dev] [PATCH v16 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-06-22 20:39     ` Harman Kalra
2020-06-25  7:33       ` David Marchand
2020-06-25 10:49         ` Wang, Haiyue
2020-07-03 14:57 ` [dpdk-dev] [PATCH v17 0/2] support for VFIO-PCI VF token interface Haiyue Wang
2020-07-03 14:57   ` [dpdk-dev] [PATCH v17 1/2] eal: add uuid dependent header files explicitly Haiyue Wang
2020-07-06 14:32     ` David Marchand
2020-07-03 14:57   ` [dpdk-dev] [PATCH v17 2/2] eal: support for VFIO-PCI VF token Haiyue Wang
2020-07-07 12:05     ` David Marchand

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=3366363.CEsMmvUzM0@thomas \
    --to=thomas@monjalon.net \
    --cc=alex.williamson@redhat.com \
    --cc=anatoly.burakov@intel.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=haiyue.wang@intel.com \
    --cc=jerinj@marvell.com \
    --cc=john.mcnamara@intel.com \
    --cc=vattunuru@marvell.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).