[PATCH] net: add comment for sock_efree() usage

[PATCH] net: add comment for sock_efree() usage

[Oliver Hartkopp]

Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
---
 net/core/sock.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/net/core/sock.c b/net/core/sock.c
index 93c8b20..78e89eb 100644
--- a/net/core/sock.c
+++ b/net/core/sock.c
@@ -1655,6 +1655,10 @@ void sock_rfree(struct sk_buff *skb)
 }
 EXPORT_SYMBOL(sock_rfree);
 
+/*
+ * Buffer destructor for skbs that are not used directly in read or write
+ * path, e.g. for error handler skbs. Automatically called from kfree_skb.
+ */
 void sock_efree(struct sk_buff *skb)
 {
 	sock_put(skb->sk);
-- 
2.1.4

Re: [PATCH] net: add comment for sock_efree() usage

[Alexander Duyck]

On 03/10/2015 11:03 AM, Oliver Hartkopp wrote:
> Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
> ---
>   net/core/sock.c | 4 ++++
>   1 file changed, 4 insertions(+)
>
> diff --git a/net/core/sock.c b/net/core/sock.c
> index 93c8b20..78e89eb 100644
> --- a/net/core/sock.c
> +++ b/net/core/sock.c
> @@ -1655,6 +1655,10 @@ void sock_rfree(struct sk_buff *skb)
>   }
>   EXPORT_SYMBOL(sock_rfree);
>   
> +/*
> + * Buffer destructor for skbs that are not used directly in read or write
> + * path, e.g. for error handler skbs. Automatically called from kfree_skb.
> + */
>   void sock_efree(struct sk_buff *skb)
>   {
>   	sock_put(skb->sk);

Acked-by: Alexander Duyck <alexander.h.duyck@redhat.com>

Re: [PATCH] net: add comment for sock_efree() usage

[David Miller]

From: Oliver Hartkopp <socketcan@hartkopp.net>
Date: Tue, 10 Mar 2015 19:03:46 +0100

> Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>

Applied, thanks.

[PATCH] net: add comment for sock_efree() usage

[Oliver Hartkopp]

In opposite to sock_rfree() and sock_wfree() the function sock_efree() does
not need to change the sk_[rw]_mem_alloc length. Add the comment to point out
the idea for using sock_efree() in the _e_rror handler or e.g. timestamp path.

Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
---
 net/core/sock.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/net/core/sock.c b/net/core/sock.c
index 93c8b20..7a1eac8 100644
--- a/net/core/sock.c
+++ b/net/core/sock.c
@@ -1655,6 +1655,10 @@ void sock_rfree(struct sk_buff *skb)
 }
 EXPORT_SYMBOL(sock_rfree);
 
+/*
+ * Buffer destructor for skbs that don't have sk_[rw]_mem_alloc accounting.
+ * E.g. error handler / timestamp path. Automatically called from kfree_skb.
+ */
 void sock_efree(struct sk_buff *skb)
 {
 	sock_put(skb->sk);
-- 
2.1.4

Re: [PATCH] net: add comment for sock_efree() usage

[Alexander Duyck]

On 03/10/2015 10:19 AM, Oliver Hartkopp wrote:
> In opposite to sock_rfree() and sock_wfree() the function sock_efree() does
> not need to change the sk_[rw]_mem_alloc length. Add the comment to point out
> the idea for using sock_efree() in the _e_rror handler or e.g. timestamp path.
>
> Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
> ---
>   net/core/sock.c | 4 ++++
>   1 file changed, 4 insertions(+)
>
> diff --git a/net/core/sock.c b/net/core/sock.c
> index 93c8b20..7a1eac8 100644
> --- a/net/core/sock.c
> +++ b/net/core/sock.c
> @@ -1655,6 +1655,10 @@ void sock_rfree(struct sk_buff *skb)
>   }
>   EXPORT_SYMBOL(sock_rfree);
>   
> +/*
> + * Buffer destructor for skbs that don't have sk_[rw]_mem_alloc accounting.
> + * E.g. error handler / timestamp path. Automatically called from kfree_skb.
> + */
>   void sock_efree(struct sk_buff *skb)
>   {
>   	sock_put(skb->sk);

This should probably be pushed out to the netdev list since this effects 
all sockets.

Technically speaking there is a 1 byte sk_wmem_alloc that this is 
accounting for to keep the socket from being closed.  It is shared 
between all instances that are using sock_efree as their destructor, and 
will drop that 1 byte when sk_refcnt has reached 0.

- Alex

Re: [PATCH] net: add comment for sock_efree() usage

[Oliver Hartkopp]

On 03/10/2015 06:29 PM, Alexander Duyck wrote:
> On 03/10/2015 10:19 AM, Oliver Hartkopp wrote:
>> In opposite to sock_rfree() and sock_wfree() the function sock_efree() does
>> not need to change the sk_[rw]_mem_alloc length. Add the comment to point out
>> the idea for using sock_efree() in the _e_rror handler or e.g. timestamp path.
>>
>> Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
>> ---
>>   net/core/sock.c | 4 ++++
>>   1 file changed, 4 insertions(+)
>>
>> diff --git a/net/core/sock.c b/net/core/sock.c
>> index 93c8b20..7a1eac8 100644
>> --- a/net/core/sock.c
>> +++ b/net/core/sock.c
>> @@ -1655,6 +1655,10 @@ void sock_rfree(struct sk_buff *skb)
>>   }
>>   EXPORT_SYMBOL(sock_rfree);
>>   +/*
>> + * Buffer destructor for skbs that don't have sk_[rw]_mem_alloc accounting.
>> + * E.g. error handler / timestamp path. Automatically called from kfree_skb.
>> + */
>>   void sock_efree(struct sk_buff *skb)
>>   {
>>       sock_put(skb->sk);
> 
> This should probably be pushed out to the netdev list since this effects all
> sockets.

Yes. That was my default. Will put netdev in --to next time.

> Technically speaking there is a 1 byte sk_wmem_alloc that this is accounting
> for to keep the socket from being closed.  It is shared between all instances
> that are using sock_efree as their destructor, and will drop that 1 byte when
> sk_refcnt has reached 0.

Ok. What would be your suggestion then?

'destructor that doesn't fiddle with sk_[rw]_mem_alloc length' ??? :-)))

Best regards,
Oliver

Re: [PATCH] net: add comment for sock_efree() usage

[Alexander Duyck]

On 03/10/2015 10:39 AM, Oliver Hartkopp wrote:
> On 03/10/2015 06:29 PM, Alexander Duyck wrote:
>> On 03/10/2015 10:19 AM, Oliver Hartkopp wrote:
>>> In opposite to sock_rfree() and sock_wfree() the function sock_efree() does
>>> not need to change the sk_[rw]_mem_alloc length. Add the comment to point out
>>> the idea for using sock_efree() in the _e_rror handler or e.g. timestamp path.
>>>
>>> Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
>>> ---
>>>    net/core/sock.c | 4 ++++
>>>    1 file changed, 4 insertions(+)
>>>
>>> diff --git a/net/core/sock.c b/net/core/sock.c
>>> index 93c8b20..7a1eac8 100644
>>> --- a/net/core/sock.c
>>> +++ b/net/core/sock.c
>>> @@ -1655,6 +1655,10 @@ void sock_rfree(struct sk_buff *skb)
>>>    }
>>>    EXPORT_SYMBOL(sock_rfree);
>>>    +/*
>>> + * Buffer destructor for skbs that don't have sk_[rw]_mem_alloc accounting.
>>> + * E.g. error handler / timestamp path. Automatically called from kfree_skb.
>>> + */
>>>    void sock_efree(struct sk_buff *skb)
>>>    {
>>>        sock_put(skb->sk);
>> This should probably be pushed out to the netdev list since this effects all
>> sockets.
> Yes. That was my default. Will put netdev in --to next time.
>
>> Technically speaking there is a 1 byte sk_wmem_alloc that this is accounting
>> for to keep the socket from being closed.  It is shared between all instances
>> that are using sock_efree as their destructor, and will drop that 1 byte when
>> sk_refcnt has reached 0.
> Ok. What would be your suggestion then?
>
> 'destructor that doesn't fiddle with sk_[rw]_mem_alloc length' ??? :-)))
>
> Best regards,
> Oliver

I'd suggest keeping it simple.  You are trying to define it as something 
it isn't.  It still does accounting, your description makes it sound 
like it doesn't.

For example sock_rfree doesn't tell you where it is supposed to be used 
and what it is accounting for.  It just is described as a read buffer 
descructor called from kfree_skb.  I'd suggest something similar, maybe 
just describe it as a desctructor used to free buffers that are not used 
directly in read or write.

- Alex

Re: [PATCH] net: add comment for sock_efree() usage

[Marc Kleine-Budde]

[-- Attachment #1: Type: text/plain, Size: 1262 bytes --]

On 03/10/2015 06:19 PM, Oliver Hartkopp wrote:
> In opposite to sock_rfree() and sock_wfree() the function sock_efree() does
> not need to change the sk_[rw]_mem_alloc length. Add the comment to point out
> the idea for using sock_efree() in the _e_rror handler or e.g. timestamp path.
> 
> Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
> ---
>  net/core/sock.c | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/net/core/sock.c b/net/core/sock.c
> index 93c8b20..7a1eac8 100644
> --- a/net/core/sock.c
> +++ b/net/core/sock.c
> @@ -1655,6 +1655,10 @@ void sock_rfree(struct sk_buff *skb)
>  }
>  EXPORT_SYMBOL(sock_rfree);
>  
> +/*
> + * Buffer destructor for skbs that don't have sk_[rw]_mem_alloc accounting.
> + * E.g. error handler / timestamp path. Automatically called from kfree_skb.
> + */

/* multiline comments in net
 * work this
 * way
 */

>  void sock_efree(struct sk_buff *skb)
>  {
>  	sock_put(skb->sk);
> 

Marc
-- 
Pengutronix e.K.                  | Marc Kleine-Budde           |
Industrial Linux Solutions        | Phone: +49-231-2826-924     |
Vertretung West/Dortmund          | Fax:   +49-5121-206917-5555 |
Amtsgericht Hildesheim, HRA 2686  | http://www.pengutronix.de   |


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]