[PATCH] staging: rtl8723bs: include: use inline functions for dvobj_to_dev

[PATCH] staging: rtl8723bs: include: use inline functions for dvobj_to_dev

[Menna Mahmoud]

Convert `dvobj_to_dev` macro into static inline function,
because it is not great to have macro that use `container_of` macro,
because from looking at the definition one cannot tell what type it applies to.

One can get the same benefit from an efficiency point of view by making an
inline function (concretely, typically a static inline function, because
the definition only needs to be visible in the current file, or in the
case of a header file in the file that includes the header file).

Suggested-by: Julia Lawall <julia.lawall@inria.fr>
Signed-off-by: Menna Mahmoud <eng.mennamahmoud.mm@gmail.com>
---
 drivers/staging/rtl8723bs/include/drv_types.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/drivers/staging/rtl8723bs/include/drv_types.h b/drivers/staging/rtl8723bs/include/drv_types.h
index 82159e1c7f9b..ea6bb44c5e1d 100644
--- a/drivers/staging/rtl8723bs/include/drv_types.h
+++ b/drivers/staging/rtl8723bs/include/drv_types.h
@@ -305,7 +305,11 @@ struct sdio_data intf_data;
 };
 
 #define dvobj_to_pwrctl(dvobj) (&(dvobj->pwrctl_priv))
-#define pwrctl_to_dvobj(pwrctl) container_of(pwrctl, struct dvobj_priv, pwrctl_priv)
+
+static inline struct dvobj_priv *pwrctl_to_dvobj(struct pwrctrl_priv *pwrctl_priv)
+{
+	return container_of(pwrctl_priv, struct dvobj_priv, pwrctl_priv);
+}
 
 static inline struct device *dvobj_to_dev(struct dvobj_priv *dvobj)
 {
-- 
2.34.1

Re: [PATCH] staging: rtl8723bs: include: use inline functions for dvobj_to_dev

[Julia Lawall]

How have you chosen the names at the beginning of the subject line?  The
other patches on this file don't have the word "include:" in the subject.
Please see the section "Following the Driver commit style" of the tutorial
to see what to do.


On Sun, 19 Mar 2023, Menna Mahmoud wrote:

> Convert `dvobj_to_dev` macro into static inline function,

"into a static inline function"

But the message is a bit too verbose.  Please see my suggestion on another
similar patch that was recently proposed.

julia

> because it is not great to have macro that use `container_of` macro,
> because from looking at the definition one cannot tell what type it applies to.
>
> One can get the same benefit from an efficiency point of view by making an
> inline function (concretely, typically a static inline function, because
> the definition only needs to be visible in the current file, or in the
> case of a header file in the file that includes the header file).
>
> Suggested-by: Julia Lawall <julia.lawall@inria.fr>
> Signed-off-by: Menna Mahmoud <eng.mennamahmoud.mm@gmail.com>
> ---
>  drivers/staging/rtl8723bs/include/drv_types.h | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/staging/rtl8723bs/include/drv_types.h b/drivers/staging/rtl8723bs/include/drv_types.h
> index 82159e1c7f9b..ea6bb44c5e1d 100644
> --- a/drivers/staging/rtl8723bs/include/drv_types.h
> +++ b/drivers/staging/rtl8723bs/include/drv_types.h
> @@ -305,7 +305,11 @@ struct sdio_data intf_data;
>  };
>
>  #define dvobj_to_pwrctl(dvobj) (&(dvobj->pwrctl_priv))
> -#define pwrctl_to_dvobj(pwrctl) container_of(pwrctl, struct dvobj_priv, pwrctl_priv)
> +
> +static inline struct dvobj_priv *pwrctl_to_dvobj(struct pwrctrl_priv *pwrctl_priv)
> +{
> +	return container_of(pwrctl_priv, struct dvobj_priv, pwrctl_priv);
> +}
>
>  static inline struct device *dvobj_to_dev(struct dvobj_priv *dvobj)
>  {
> --
> 2.34.1
>
>

Re: [PATCH] staging: rtl8723bs: include: use inline functions for dvobj_to_dev

[Menna Mahmoud]

On ١٩‏/٣‏/٢٠٢٣ ١٦:١٣, Julia Lawall wrote:
> How have you chosen the names at the beginning of the subject line?  The
> other patches on this file don't have the word "include:" in the subject.
> Please see the section "Following the Driver commit style" of the tutorial
> to see what to do.
Okay, I will check it.
>
> On Sun, 19 Mar 2023, Menna Mahmoud wrote:
>
>> Convert `dvobj_to_dev` macro into static inline function,
> "into a static inline function"

I will fix it.

>
> But the message is a bit too verbose.  Please see my suggestion on another
> similar patch that was recently proposed.
>
> julia


I will to rework on it, thanks Julia appreciate your help.


Menna

>> because it is not great to have macro that use `container_of` macro,
>> because from looking at the definition one cannot tell what type it applies to.
>>
>> One can get the same benefit from an efficiency point of view by making an
>> inline function (concretely, typically a static inline function, because
>> the definition only needs to be visible in the current file, or in the
>> case of a header file in the file that includes the header file).
>>
>> Suggested-by: Julia Lawall <julia.lawall@inria.fr>
>> Signed-off-by: Menna Mahmoud <eng.mennamahmoud.mm@gmail.com>
>> ---
>>   drivers/staging/rtl8723bs/include/drv_types.h | 6 +++++-
>>   1 file changed, 5 insertions(+), 1 deletion(-)
>>
>> diff --git a/drivers/staging/rtl8723bs/include/drv_types.h b/drivers/staging/rtl8723bs/include/drv_types.h
>> index 82159e1c7f9b..ea6bb44c5e1d 100644
>> --- a/drivers/staging/rtl8723bs/include/drv_types.h
>> +++ b/drivers/staging/rtl8723bs/include/drv_types.h
>> @@ -305,7 +305,11 @@ struct sdio_data intf_data;
>>   };
>>
>>   #define dvobj_to_pwrctl(dvobj) (&(dvobj->pwrctl_priv))
>> -#define pwrctl_to_dvobj(pwrctl) container_of(pwrctl, struct dvobj_priv, pwrctl_priv)
>> +
>> +static inline struct dvobj_priv *pwrctl_to_dvobj(struct pwrctrl_priv *pwrctl_priv)
>> +{
>> +	return container_of(pwrctl_priv, struct dvobj_priv, pwrctl_priv);
>> +}
>>
>>   static inline struct device *dvobj_to_dev(struct dvobj_priv *dvobj)
>>   {
>> --
>> 2.34.1
>>
>>