diff mbox series

[net-next,v8,02/14] net: skb: introduce skb_data_area_size()

Message ID 20220506181310.2183829-3-ricardo.martinez@linux.intel.com (mailing list archive)
State Accepted
Commit a4ff365346c98081311c299955d91d657123e8aa
Delegated to: Netdev Maintainers
Headers show
Series net: wwan: t7xx: PCIe driver for MediaTek M.2 modem | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for net-next, async
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Series has a cover letter
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 5740 this patch: 5740
netdev/cc_maintainers warning 5 maintainers not CCed: linux-arm-kernel@lists.infradead.org linux-mediatek@lists.infradead.org edumazet@google.com imagedong@tencent.com matthias.bgg@gmail.com
netdev/build_clang success Errors and warnings before: 1137 this patch: 1137
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 5884 this patch: 5884
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 11 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Ricardo Martinez May 6, 2022, 6:12 p.m. UTC
Helper to calculate the linear data space in the skb.

Signed-off-by: Ricardo Martinez <ricardo.martinez@linux.intel.com>
Reviewed-by: Sergey Ryazanov <ryazanov.s.a@gmail.com>
---
 include/linux/skbuff.h | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Jakub Kicinski May 9, 2022, 4:49 p.m. UTC | #1
On Fri,  6 May 2022 11:12:58 -0700 Ricardo Martinez wrote:
> Helper to calculate the linear data space in the skb.
> 
> Signed-off-by: Ricardo Martinez <ricardo.martinez@linux.intel.com>
> Reviewed-by: Sergey Ryazanov <ryazanov.s.a@gmail.com>
> ---
>  include/linux/skbuff.h | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h
> index 5c2599e3fe7d..d58669d6cb91 100644
> --- a/include/linux/skbuff.h
> +++ b/include/linux/skbuff.h
> @@ -1665,6 +1665,11 @@ static inline void skb_set_end_offset(struct sk_buff *skb, unsigned int offset)
>  }
>  #endif
>  
> +static inline unsigned int skb_data_area_size(struct sk_buff *skb)
> +{
> +	return skb_end_pointer(skb) - skb->data;
> +}

Not a great name, skb->data_len is the length of paged data.
There is no such thing as "data area", data is just a pointer
somewhere into skb->head.

Why do you need this? Why can't you use the size you passed 
to the dev_alloc_skb() like everyone else?
Sergey Ryazanov May 9, 2022, 6:34 p.m. UTC | #2
Hello Jakub,

On Mon, May 9, 2022 at 7:49 PM Jakub Kicinski <kuba@kernel.org> wrote:
> On Fri,  6 May 2022 11:12:58 -0700 Ricardo Martinez wrote:
>> Helper to calculate the linear data space in the skb.
>>
>> Signed-off-by: Ricardo Martinez <ricardo.martinez@linux.intel.com>
>> Reviewed-by: Sergey Ryazanov <ryazanov.s.a@gmail.com>
>> ---
>>  include/linux/skbuff.h | 5 +++++
>>  1 file changed, 5 insertions(+)
>>
>> diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h
>> index 5c2599e3fe7d..d58669d6cb91 100644
>> --- a/include/linux/skbuff.h
>> +++ b/include/linux/skbuff.h
>> @@ -1665,6 +1665,11 @@ static inline void skb_set_end_offset(struct sk_buff *skb, unsigned int offset)
>>  }
>>  #endif
>>
>> +static inline unsigned int skb_data_area_size(struct sk_buff *skb)
>> +{
>> +     return skb_end_pointer(skb) - skb->data;
>> +}
>
> Not a great name, skb->data_len is the length of paged data.
> There is no such thing as "data area", data is just a pointer
> somewhere into skb->head.

What name would you recommend for this helper?

> Why do you need this? Why can't you use the size you passed
> to the dev_alloc_skb() like everyone else?

It was I who suggested to Ricardo to make this helper a common
function [1]. So let me begin the discussion, perhaps Ricardo will add
to my thoughts as the driver author.

There are many other places where authors do the same but without a
helper function:

$ grep -rn 'skb_end_pointer(.*) [-]' drivers/net/ | sort
drivers/net/ethernet/marvell/mv643xx_eth.c:628: size =
skb_end_pointer(skb) - skb->data;
drivers/net/ethernet/marvell/pxa168_eth.c:322: size =
skb_end_pointer(skb) - skb->data;
drivers/net/ethernet/micrel/ksz884x.c:4764: if (skb_end_pointer(skb) -
skb->data >= 50) {
drivers/net/ethernet/netronome/nfp/ccm_mbox.c:492: undersize =
max_reply_size - (skb_end_pointer(skb) - skb->data);
drivers/net/ethernet/nvidia/forcedeth.c:2073:
(skb_end_pointer(np->rx_skb[i].skb) -
drivers/net/ethernet/nvidia/forcedeth.c:5244: (skb_end_pointer(tx_skb)
- tx_skb->data),
drivers/net/veth.c:775: frame_sz = skb_end_pointer(skb) - skb->head;

There are at least two reasons to evaluate the linear data size from skb:
1) it is difficult to access the same variable that contains a size
during skb allocation (consider skb in a queue);
2) you may not have access to an allocation size because a driver does
not allocate that skb (consider a xmit path).

Eventually you found themself in a position where you need to carry
additional info along with skb. But, on the other hand, you can simply
calculate this value from the skb pointers themselves.

1. https://lore.kernel.org/netdev/CAHNKnsTr3aq1sgHnZQFL7-0uHMp3Wt4PMhVgTMSAiiXT=8p35A@mail.gmail.com/

--
Sergey
Jakub Kicinski May 9, 2022, 7:50 p.m. UTC | #3
On Mon, 9 May 2022 21:34:58 +0300 Sergey Ryazanov wrote:
> >> +static inline unsigned int skb_data_area_size(struct sk_buff *skb)
> >> +{
> >> +     return skb_end_pointer(skb) - skb->data;
> >> +}  
> >
> > Not a great name, skb->data_len is the length of paged data.
> > There is no such thing as "data area", data is just a pointer
> > somewhere into skb->head.  
> 
> What name would you recommend for this helper?

We are assuming that skb->data is where we want to start to write
to so we own the skb. If it's a fresh skb skb->data == skb->tail. 
If it's not fresh but recycled - skb->data is presumably reset
correctly, and then skb_reset_tail_pointer() has to be called. Either
way we give HW empty skbs, tailroom is an existing concept we can use.

> > Why do you need this? Why can't you use the size you passed
> > to the dev_alloc_skb() like everyone else?  
> 
> It was I who suggested to Ricardo to make this helper a common
> function [1]. So let me begin the discussion, perhaps Ricardo will add
> to my thoughts as the driver author.
> 
> There are many other places where authors do the same but without a
> helper function:
> 
> [...]
>
> There are at least two reasons to evaluate the linear data size from skb:
> 1) it is difficult to access the same variable that contains a size
> during skb allocation (consider skb in a queue);

Usually all the Rx skbs on the queue are equally sized so no need to
save the length per buffer, but perhaps that's not universally true.

> 2) you may not have access to an allocation size because a driver does
> not allocate that skb (consider a xmit path).

On Tx you should only map the data that's actually populated, for that
we have skb_headlen().

> Eventually you found themself in a position where you need to carry
> additional info along with skb. But, on the other hand, you can simply
> calculate this value from the skb pointers themselves.
> 
> 1. https://lore.kernel.org/netdev/CAHNKnsTr3aq1sgHnZQFL7-0uHMp3Wt4PMhVgTMSAiiXT=8p35A@mail.gmail.com/

Fair enough, I didn't know more drivers are doing this.

We have two cases:
 - for Tx - drivers should use skb_headlen();
 - for Rx - I presume we are either dealing with fresh or correctly
   reset skbs, so we can use skb_tailroom().
Ricardo Martinez May 9, 2022, 9:37 p.m. UTC | #4
On 5/9/2022 12:50 PM, Jakub Kicinski wrote:
> On Mon, 9 May 2022 21:34:58 +0300 Sergey Ryazanov wrote:
>>>> +static inline unsigned int skb_data_area_size(struct sk_buff *skb)
>>>> +{
>>>> +     return skb_end_pointer(skb) - skb->data;
>>>> +}
>>> Not a great name, skb->data_len is the length of paged data.
>>> There is no such thing as "data area", data is just a pointer
>>> somewhere into skb->head.
>> What name would you recommend for this helper?
> We are assuming that skb->data is where we want to start to write
> to so we own the skb. If it's a fresh skb skb->data == skb->tail.
> If it's not fresh but recycled - skb->data is presumably reset
> correctly, and then skb_reset_tail_pointer() has to be called. Either
> way we give HW empty skbs, tailroom is an existing concept we can use.
>
>>> Why do you need this? Why can't you use the size you passed
>>> to the dev_alloc_skb() like everyone else?
>> It was I who suggested to Ricardo to make this helper a common
>> function [1]. So let me begin the discussion, perhaps Ricardo will add
>> to my thoughts as the driver author.
>>
>> There are many other places where authors do the same but without a
>> helper function:
>>
>> [...]
>>
>> There are at least two reasons to evaluate the linear data size from skb:
>> 1) it is difficult to access the same variable that contains a size
>> during skb allocation (consider skb in a queue);
> Usually all the Rx skbs on the queue are equally sized so no need to
> save the length per buffer, but perhaps that's not universally true.
>
>> 2) you may not have access to an allocation size because a driver does
>> not allocate that skb (consider a xmit path).
> On Tx you should only map the data that's actually populated, for that
> we have skb_headlen().
>
>> Eventually you found themself in a position where you need to carry
>> additional info along with skb. But, on the other hand, you can simply
>> calculate this value from the skb pointers themselves.
>>
>> 1. https://lore.kernel.org/netdev/CAHNKnsTr3aq1sgHnZQFL7-0uHMp3Wt4PMhVgTMSAiiXT=8p35A@mail.gmail.com/
> Fair enough, I didn't know more drivers are doing this.
>
> We have two cases:
>   - for Tx - drivers should use skb_headlen();
>   - for Rx - I presume we are either dealing with fresh or correctly
>     reset skbs, so we can use skb_tailroom().
Thanks for the information, looks like indeed we can avoid the helper in 
t7xx driver by following those guidelines.
Andy Shevchenko May 10, 2022, 10:01 a.m. UTC | #5
On Mon, May 09, 2022 at 02:37:26PM -0700, Martinez, Ricardo wrote:
> On 5/9/2022 12:50 PM, Jakub Kicinski wrote:
> > On Mon, 9 May 2022 21:34:58 +0300 Sergey Ryazanov wrote:

...

> > We have two cases:
> >   - for Tx - drivers should use skb_headlen();
> >   - for Rx - I presume we are either dealing with fresh or correctly
> >     reset skbs, so we can use skb_tailroom().
> Thanks for the information, looks like indeed we can avoid the helper in
> t7xx driver by following those guidelines.

I think this can be done as a follow up patch.
Sergey Ryazanov May 10, 2022, 1:37 p.m. UTC | #6
On Mon, May 9, 2022 at 10:50 PM Jakub Kicinski <kuba@kernel.org> wrote:
> On Mon, 9 May 2022 21:34:58 +0300 Sergey Ryazanov wrote:
>>>> +static inline unsigned int skb_data_area_size(struct sk_buff *skb)
>>>> +{
>>>> +     return skb_end_pointer(skb) - skb->data;
>>>> +}
>>>
>>> Not a great name, skb->data_len is the length of paged data.
>>> There is no such thing as "data area", data is just a pointer
>>> somewhere into skb->head.
>>
> > What name would you recommend for this helper?
>
> We are assuming that skb->data is where we want to start to write
> to so we own the skb. If it's a fresh skb skb->data == skb->tail.
> If it's not fresh but recycled - skb->data is presumably reset
> correctly, and then skb_reset_tail_pointer() has to be called. Either
> way we give HW empty skbs, tailroom is an existing concept we can use.
>
>>> Why do you need this? Why can't you use the size you passed
>>> to the dev_alloc_skb() like everyone else?
>>
>> It was I who suggested to Ricardo to make this helper a common
>> function [1]. So let me begin the discussion, perhaps Ricardo will add
>> to my thoughts as the driver author.
>>
>> There are many other places where authors do the same but without a
>> helper function:
>>
>> [...]
>>
>> There are at least two reasons to evaluate the linear data size from skb:
>> 1) it is difficult to access the same variable that contains a size
>> during skb allocation (consider skb in a queue);
>
> Usually all the Rx skbs on the queue are equally sized so no need to
> save the length per buffer, but perhaps that's not universally true.
>
>> 2) you may not have access to an allocation size because a driver does
>> not allocate that skb (consider a xmit path).
>
> On Tx you should only map the data that's actually populated, for that
> we have skb_headlen().
>
>> Eventually you found themself in a position where you need to carry
>> additional info along with skb. But, on the other hand, you can simply
>> calculate this value from the skb pointers themselves.
>>
>> 1. https://lore.kernel.org/netdev/CAHNKnsTr3aq1sgHnZQFL7-0uHMp3Wt4PMhVgTMSAiiXT=8p35A@mail.gmail.com/
>
> Fair enough, I didn't know more drivers are doing this.
>
> We have two cases:
>  - for Tx - drivers should use skb_headlen();
>  - for Rx - I presume we are either dealing with fresh or correctly
>    reset skbs, so we can use skb_tailroom().

Make sense! Especially your remark that on Tx we should only map
populated data. This short API usage guide even answers my wonder why
the kernel still does not have something like skb_data_area_size().
Thank you for this short and clear clarification.
diff mbox series

Patch

diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h
index 5c2599e3fe7d..d58669d6cb91 100644
--- a/include/linux/skbuff.h
+++ b/include/linux/skbuff.h
@@ -1665,6 +1665,11 @@  static inline void skb_set_end_offset(struct sk_buff *skb, unsigned int offset)
 }
 #endif
 
+static inline unsigned int skb_data_area_size(struct sk_buff *skb)
+{
+	return skb_end_pointer(skb) - skb->data;
+}
+
 struct ubuf_info *msg_zerocopy_realloc(struct sock *sk, size_t size,
 				       struct ubuf_info *uarg);