[PATCH] [net] update xdp_statistics in docs

[PATCH] [net] update xdp_statistics in docs

[nick black]

Add the three fields from xdp_statistics that were
missing in the AF_XDP documentation.

Signed-off-by: nick black <dankamongmen@gmail.com>
---
 Documentation/networking/af_xdp.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git Documentation/networking/af_xdp.rst Documentation/networking/af_xdp.rst
index 247c6c4127e9..a968de7e902c 100644
--- Documentation/networking/af_xdp.rst
+++ Documentation/networking/af_xdp.rst
@@ -445,6 +445,9 @@ purposes. The supported statistics are shown below:
        __u64 rx_dropped; /* Dropped for reasons other than invalid desc */
        __u64 rx_invalid_descs; /* Dropped due to invalid descriptor */
        __u64 tx_invalid_descs; /* Dropped due to invalid descriptor */
+       __u64 rx_ring_full; /* Dropped due to rx ring being full */
+       __u64 rx_fill_ring_empty_descs; /* Failed to retrieve item from fill ring */
+       __u64 tx_ring_empty_descs; /* Failed to retrieve item from tx ring */
    };
 
 XDP_OPTIONS getsockopt
-- 
2.40.0

Re: [PATCH] [net] update xdp_statistics in docs

[Magnus Karlsson]

On Tue, 4 Apr 2023 at 06:38, nick black <dankamongmen@gmail.com> wrote:
>
> Add the three fields from xdp_statistics that were
> missing in the AF_XDP documentation.

Thanks Nick.

Acked-by: Magnus Karlsson <magnus.karlsson@intel.com>

> Signed-off-by: nick black <dankamongmen@gmail.com>
> ---
>  Documentation/networking/af_xdp.rst | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git Documentation/networking/af_xdp.rst Documentation/networking/af_xdp.rst
> index 247c6c4127e9..a968de7e902c 100644
> --- Documentation/networking/af_xdp.rst
> +++ Documentation/networking/af_xdp.rst
> @@ -445,6 +445,9 @@ purposes. The supported statistics are shown below:
>         __u64 rx_dropped; /* Dropped for reasons other than invalid desc */
>         __u64 rx_invalid_descs; /* Dropped due to invalid descriptor */
>         __u64 tx_invalid_descs; /* Dropped due to invalid descriptor */
> +       __u64 rx_ring_full; /* Dropped due to rx ring being full */
> +       __u64 rx_fill_ring_empty_descs; /* Failed to retrieve item from fill ring */
> +       __u64 tx_ring_empty_descs; /* Failed to retrieve item from tx ring */
>     };
>
>  XDP_OPTIONS getsockopt
> --
> 2.40.0

Re: [PATCH] [net] update xdp_statistics in docs

[Paolo Abeni]

On Sun, 2023-04-02 at 04:41 -0400, nick black wrote:
> Add the three fields from xdp_statistics that were
> missing in the AF_XDP documentation.
> 
> Signed-off-by: nick black <dankamongmen@gmail.com>

I think this kind of changes are best suited for net-next, please set
the target tree accordingly in next submissions.

> ---
>  Documentation/networking/af_xdp.rst | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git Documentation/networking/af_xdp.rst Documentation/networking/af_xdp.rst
> index 247c6c4127e9..a968de7e902c 100644
> --- Documentation/networking/af_xdp.rst
> +++ Documentation/networking/af_xdp.rst

There is something strange in your setup, the above should be:

--- a/Documentation/networking/af_xdp.rst
+++ b/Documentation/networking/af_xdp.rst

The format you used confuses my scripts. I handled this one manually,
but please update your setup to stick to the standard layout.

Cheers,

Paolo

Re: [PATCH] [net] update xdp_statistics in docs

[Paolo Abeni]

On Tue, 2023-04-04 at 11:35 +0200, Paolo Abeni wrote:
> On Sun, 2023-04-02 at 04:41 -0400, nick black wrote:
> > Add the three fields from xdp_statistics that were
> > missing in the AF_XDP documentation.
> > 
> > Signed-off-by: nick black <dankamongmen@gmail.com>
> 
> I think this kind of changes are best suited for net-next, please set
> the target tree accordingly in next submissions.
> 
> > ---
> >  Documentation/networking/af_xdp.rst | 3 +++
> >  1 file changed, 3 insertions(+)
> > 
> > diff --git Documentation/networking/af_xdp.rst Documentation/networking/af_xdp.rst
> > index 247c6c4127e9..a968de7e902c 100644
> > --- Documentation/networking/af_xdp.rst
> > +++ Documentation/networking/af_xdp.rst
> 
> There is something strange in your setup, the above should be:
> 
> --- a/Documentation/networking/af_xdp.rst
> +++ b/Documentation/networking/af_xdp.rst
> 
> The format you used confuses my scripts. I handled this one manually,
> but please update your setup to stick to the standard layout.

I almost forgot: you should include into the subject a tag identifying
the relevant subsystem/networking area. In this case, a proper subject
could be:

net: doc: update xdp_statistics in docs

Given all the above I think is better if you re-submit addressing my
comments. You can retain Magnus's ack.

Thanks!

Paolo