doc: announce behavior change for device NUMA node field

Message ID 20220713155043.11490-1-olivier.matz@6wind.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: announce behavior change for device NUMA node field |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/intel-Testing success Testing PASS

Commit Message

Olivier Matz July 13, 2022, 3:50 p.m. UTC
  The dev->device.numa_node field is set by the bus driver for each device
it manages to indicate on which NUMA node this device lies.

When this information is unknown, the assigned value is not consistent
across the bus drivers. In v22.11, the value will be set to -1 in
this case.

Link: https://patches.dpdk.org/project/dpdk/patch/20211026090610.10823-1-houssem.bouhlel@6wind.com/

Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)
  

Comments

Bruce Richardson July 14, 2022, 10:10 a.m. UTC | #1
On Wed, Jul 13, 2022 at 05:50:43PM +0200, Olivier Matz wrote:
> The dev->device.numa_node field is set by the bus driver for each device
> it manages to indicate on which NUMA node this device lies.
> 
> When this information is unknown, the assigned value is not consistent
> across the bus drivers. In v22.11, the value will be set to -1 in
> this case.
> 
> Link: https://patches.dpdk.org/project/dpdk/patch/20211026090610.10823-1-houssem.bouhlel@6wind.com/
> 
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 4e5b23c53d..5f269bf527 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -125,3 +125,9 @@ Deprecation Notices
>    applications should be updated to use the ``dmadev`` library instead,
>    with the underlying HW-functionality being provided by the ``ioat`` or
>    ``idxd`` dma drivers
> +
> +* bus: The ``dev->device.numa_node`` field is set by the bus driver for
> +  each device it manages to indicate on which NUMA node this device
> +  lies. When this information is unknown, the assigned value is not
> +  consistent across the bus drivers. In v22.11, the value will be set
> +  to -1 in this case.

Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Couple of minor rewording suggestions:
* "the bus driver" seems wrong in the first line as we haven't referred to
  one in particular. How about "...set by each bus driver for every device..."

* "the assigned value is not consistent across the bus drivers" - this
  reads a little strange to me and I find it unclear. Not sure how to
  reword it, maybe something like: "each bus driver selects its own value to
  set. To resolve this inconsistency, in v22.11, the device numa_node value
  will be set to -1 by all bus drivers when the actual NUMA information is
  unavailable."


> -- 
> 2.30.2
>
  
Jerin Jacob July 14, 2022, 10:36 a.m. UTC | #2
On Thu, Jul 14, 2022 at 3:40 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> On Wed, Jul 13, 2022 at 05:50:43PM +0200, Olivier Matz wrote:
> > The dev->device.numa_node field is set by the bus driver for each device
> > it manages to indicate on which NUMA node this device lies.
> >
> > When this information is unknown, the assigned value is not consistent
> > across the bus drivers. In v22.11, the value will be set to -1 in
> > this case.
> >
> > Link: https://patches.dpdk.org/project/dpdk/patch/20211026090610.10823-1-houssem.bouhlel@6wind.com/
> >
> > Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 6 ++++++
> >  1 file changed, 6 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index 4e5b23c53d..5f269bf527 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -125,3 +125,9 @@ Deprecation Notices
> >    applications should be updated to use the ``dmadev`` library instead,
> >    with the underlying HW-functionality being provided by the ``ioat`` or
> >    ``idxd`` dma drivers
> > +
> > +* bus: The ``dev->device.numa_node`` field is set by the bus driver for
> > +  each device it manages to indicate on which NUMA node this device
> > +  lies. When this information is unknown, the assigned value is not
> > +  consistent across the bus drivers. In v22.11, the value will be set
> > +  to -1 in this case.
>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Jerin Jacob <jerinj@marvell.com>


>
> Couple of minor rewording suggestions:
> * "the bus driver" seems wrong in the first line as we haven't referred to
>   one in particular. How about "...set by each bus driver for every device..."
>
> * "the assigned value is not consistent across the bus drivers" - this
>   reads a little strange to me and I find it unclear. Not sure how to
>   reword it, maybe something like: "each bus driver selects its own value to
>   set. To resolve this inconsistency, in v22.11, the device numa_node value
>   will be set to -1 by all bus drivers when the actual NUMA information is
>   unavailable."
>
>
> > --
> > 2.30.2
> >
  
David Marchand July 14, 2022, 11:55 a.m. UTC | #3
On Wed, Jul 13, 2022 at 5:51 PM Olivier Matz <olivier.matz@6wind.com> wrote:
>
> The dev->device.numa_node field is set by the bus driver for each device
> it manages to indicate on which NUMA node this device lies.
>
> When this information is unknown, the assigned value is not consistent
> across the bus drivers. In v22.11, the value will be set to -1 in
> this case.
>
> Link: https://patches.dpdk.org/project/dpdk/patch/20211026090610.10823-1-houssem.bouhlel@6wind.com/
>
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: David Marchand <david.marchand@redhat.com>

Thanks Olivier.
  
Anatoly Burakov July 14, 2022, 12:03 p.m. UTC | #4
On 13-Jul-22 4:50 PM, Olivier Matz wrote:
> The dev->device.numa_node field is set by the bus driver for each device
> it manages to indicate on which NUMA node this device lies.
> 
> When this information is unknown, the assigned value is not consistent
> across the bus drivers. In v22.11, the value will be set to -1 in
> this case.
> 
> Link: https://patches.dpdk.org/project/dpdk/patch/20211026090610.10823-1-houssem.bouhlel@6wind.com/
> 
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
> ---

Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
  
Thomas Monjalon July 15, 2022, 4:07 p.m. UTC | #5
13/07/2022 17:50, Olivier Matz:
> The dev->device.numa_node field is set by the bus driver for each device
> it manages to indicate on which NUMA node this device lies.
> 
> When this information is unknown, the assigned value is not consistent
> across the bus drivers. In v22.11, the value will be set to -1 in
> this case.
> 
> Link: https://patches.dpdk.org/project/dpdk/patch/20211026090610.10823-1-houssem.bouhlel@6wind.com/
> 
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>

    Acked-by: Bruce Richardson <bruce.richardson@intel.com>
    Acked-by: Jerin Jacob <jerinj@marvell.com>
    Acked-by: David Marchand <david.marchand@redhat.com>
    Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>

Applied with a bit of rewording as suggested by Bruce.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 4e5b23c53d..5f269bf527 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -125,3 +125,9 @@  Deprecation Notices
   applications should be updated to use the ``dmadev`` library instead,
   with the underlying HW-functionality being provided by the ``ioat`` or
   ``idxd`` dma drivers
+
+* bus: The ``dev->device.numa_node`` field is set by the bus driver for
+  each device it manages to indicate on which NUMA node this device
+  lies. When this information is unknown, the assigned value is not
+  consistent across the bus drivers. In v22.11, the value will be set
+  to -1 in this case.