diff mbox series

[04/10] drm/print: Fix support for NULL as first argument of drm_dbg_*

Message ID 3ebf0d61ad5e82875a4493108602e62429306b14.1671566741.git.code@siddh.me
State New
Headers
Series drm: Remove usage of deprecated DRM_* macros |

Commit Message

Siddh Raman Pant Dec. 20, 2022, 8:16 p.m. UTC 
  Comments say macros DRM_DEBUG_* are deprecated in favor of
drm_dbg_*(NULL, ...), but they have broken support for it,
as the macro will result in `(NULL) ? (NULL)->dev : NULL`.

Thus, fix them by casting input drm to a temporary struct ptr,
with the same convention as in __DRM_DEFINE_DBG_RATELIMITED.

Signed-off-by: Siddh Raman Pant <code@siddh.me>
---
 include/drm/drm_print.h | 89 ++++++++++++++++++++++++++++++++---------
 1 file changed, 69 insertions(+), 20 deletions(-)

Comments

Thomas Zimmermann Dec. 21, 2022, 9:08 a.m. UTC | #1 
Hi

Am 20.12.22 um 21:16 schrieb Siddh Raman Pant:
> Comments say macros DRM_DEBUG_* are deprecated in favor of
> drm_dbg_*(NULL, ...), but they have broken support for it,
> as the macro will result in `(NULL) ? (NULL)->dev : NULL`.
> 
> Thus, fix them by casting input drm to a temporary struct ptr,
> with the same convention as in __DRM_DEFINE_DBG_RATELIMITED.
> 
> Signed-off-by: Siddh Raman Pant <code@siddh.me>
> ---
>   include/drm/drm_print.h | 89 ++++++++++++++++++++++++++++++++---------
>   1 file changed, 69 insertions(+), 20 deletions(-)
> 
> diff --git a/include/drm/drm_print.h b/include/drm/drm_print.h
> index a44fb7ef257f..53702d830291 100644
> --- a/include/drm/drm_print.h
> +++ b/include/drm/drm_print.h
> @@ -486,26 +486,75 @@ void __drm_dev_dbg(struct _ddebug *desc, const struct device *dev,
>   	__drm_printk((drm), err, _ratelimited, "*ERROR* " fmt, ##__VA_ARGS__)
>   
>   
> -#define drm_dbg_core(drm, fmt, ...)					\
> -	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_CORE, fmt, ##__VA_ARGS__)
...
> +#define drm_dbg_core(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_CORE,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})

Instead of doing this for each drm_dbg_ macro, rather add an internal 
helper that returns the device or NULL like this:

static inline struct device *__drm_print_dev(struct drm_device *drm)
{
	if (drm)
		return drm->dev;
	return NULL;
}

and change the macros to

drm_dbg_core(drm, fmt, ...)
	drm_dev_dbg(__drm_print_dev(drm), DRM_UT_CORE, )

and so on.

Best regards
Thomas

> +
> +#define drm_dbg_driver(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_DRIVER,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_kms(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_KMS,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_prime(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_PRIME,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_atomic(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_ATOMIC,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_vbl(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_VBL,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_state(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_STATE,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_lease(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_LEASE,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_dp(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_DP,		\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_drmres(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_DRMRES,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
>   
>   #define drm_dbg(drm, fmt, ...)	drm_dbg_driver(drm, fmt, ##__VA_ARGS__)
>   

-- 
Thomas Zimmermann
Graphics Driver Developer
SUSE Software Solutions Germany GmbH
Maxfeldstr. 5, 90409 Nürnberg, Germany
(HRB 36809, AG Nürnberg)
Geschäftsführer: Ivo Totev
Jani Nikula Dec. 21, 2022, 9:41 a.m. UTC | #2 
On Wed, 21 Dec 2022, Siddh Raman Pant <code@siddh.me> wrote:
> Comments say macros DRM_DEBUG_* are deprecated in favor of
> drm_dbg_*(NULL, ...), but they have broken support for it,
> as the macro will result in `(NULL) ? (NULL)->dev : NULL`.

What's wrong with that?

>
> Thus, fix them by casting input drm to a temporary struct ptr,
> with the same convention as in __DRM_DEFINE_DBG_RATELIMITED.
>
> Signed-off-by: Siddh Raman Pant <code@siddh.me>
> ---
>  include/drm/drm_print.h | 89 ++++++++++++++++++++++++++++++++---------
>  1 file changed, 69 insertions(+), 20 deletions(-)
>
> diff --git a/include/drm/drm_print.h b/include/drm/drm_print.h
> index a44fb7ef257f..53702d830291 100644
> --- a/include/drm/drm_print.h
> +++ b/include/drm/drm_print.h
> @@ -486,26 +486,75 @@ void __drm_dev_dbg(struct _ddebug *desc, const struct device *dev,
>  	__drm_printk((drm), err, _ratelimited, "*ERROR* " fmt, ##__VA_ARGS__)
>  
>  
> -#define drm_dbg_core(drm, fmt, ...)					\
> -	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_CORE, fmt, ##__VA_ARGS__)
> -#define drm_dbg_driver(drm, fmt, ...)						\
> -	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
> -#define drm_dbg_kms(drm, fmt, ...)					\
> -	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_KMS, fmt, ##__VA_ARGS__)
> -#define drm_dbg_prime(drm, fmt, ...)					\
> -	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_PRIME, fmt, ##__VA_ARGS__)
> -#define drm_dbg_atomic(drm, fmt, ...)					\
> -	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
> -#define drm_dbg_vbl(drm, fmt, ...)					\
> -	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_VBL, fmt, ##__VA_ARGS__)
> -#define drm_dbg_state(drm, fmt, ...)					\
> -	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_STATE, fmt, ##__VA_ARGS__)
> -#define drm_dbg_lease(drm, fmt, ...)					\
> -	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_LEASE, fmt, ##__VA_ARGS__)
> -#define drm_dbg_dp(drm, fmt, ...)					\
> -	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DP, fmt, ##__VA_ARGS__)
> -#define drm_dbg_drmres(drm, fmt, ...)					\
> -	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRMRES, fmt, ##__VA_ARGS__)
> +#define drm_dbg_core(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_CORE,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_driver(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_DRIVER,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_kms(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_KMS,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_prime(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_PRIME,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_atomic(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_ATOMIC,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_vbl(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_VBL,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_state(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_STATE,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_lease(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_LEASE,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_dp(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_DP,		\
> +		    fmt, ##__VA_ARGS__);			\
> +})
> +
> +#define drm_dbg_drmres(drm, fmt, ...)				\
> +({								\
> +	const struct drm_device *drm_ = (drm);			\
> +	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_DRMRES,	\
> +		    fmt, ##__VA_ARGS__);			\
> +})
>  
>  #define drm_dbg(drm, fmt, ...)	drm_dbg_driver(drm, fmt, ##__VA_ARGS__)
Siddh Raman Pant Dec. 21, 2022, 3:35 p.m. UTC | #3 
On Wed, Dec 21 2022 at 15:11:07 +0530, Jani Nikula wrote:
> On Wed, 21 Dec 2022, Siddh Raman Pant <code@siddh.me> wrote:
>> Comments say macros DRM_DEBUG_* are deprecated in favor of
>> drm_dbg_*(NULL, ...), but they have broken support for it,
>> as the macro will result in `(NULL) ? (NULL)->dev : NULL`.
> 
> What's wrong with that?

NULL is not a struct, so the syntax is incorrect.

Note that this isn't about a dev pointer whose value is
NULL, the first argument is NULL directly. So "NULL" is
directly substituted as is. If it was a dev pointer, then
the definition of struct allowed for no error, but here
gcc will generate the following error:

error: request for member ‘dev’ in something not a structure or union 

Hence, there is a need to fix them.

Thanks,
Siddh
Siddh Raman Pant Dec. 21, 2022, 3:38 p.m. UTC | #4 
On Wed, Dec 21 2022 at 14:38:08 +0530, Thomas Zimmermann wrote:
> Hi
> 
> Am 20.12.22 um 21:16 schrieb Siddh Raman Pant:
>> Comments say macros DRM_DEBUG_* are deprecated in favor of
>> drm_dbg_*(NULL, ...), but they have broken support for it,
>> as the macro will result in `(NULL) ? (NULL)->dev : NULL`.
>>
>> Thus, fix them by casting input drm to a temporary struct ptr,
>> with the same convention as in __DRM_DEFINE_DBG_RATELIMITED.
>>
>> Signed-off-by: Siddh Raman Pant <code@siddh.me>
>> ---
>>   include/drm/drm_print.h | 89 ++++++++++++++++++++++++++++++++---------
>>   1 file changed, 69 insertions(+), 20 deletions(-)
>>
>> diff --git a/include/drm/drm_print.h b/include/drm/drm_print.h
>> index a44fb7ef257f..53702d830291 100644
>> --- a/include/drm/drm_print.h
>> +++ b/include/drm/drm_print.h
>> @@ -486,26 +486,75 @@ void __drm_dev_dbg(struct _ddebug *desc, const struct device *dev,
>>       __drm_printk((drm), err, _ratelimited, "*ERROR* " fmt, ##__VA_ARGS__)
>>     -#define drm_dbg_core(drm, fmt, ...)                    \
>> -    drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_CORE, fmt, ##__VA_ARGS__)
> ...
>> +#define drm_dbg_core(drm, fmt, ...)                \
>> +({                                \
>> +    const struct drm_device *drm_ = (drm);            \
>> +    drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_CORE,    \
>> +            fmt, ##__VA_ARGS__);            \
>> +})
> 
> Instead of doing this for each drm_dbg_ macro, rather add an internal helper that returns the device or NULL like this:
> 
> static inline struct device *__drm_print_dev(struct drm_device *drm)
> {
>     if (drm)
>         return drm->dev;
>     return NULL;
> }
> 
> and change the macros to
> 
> drm_dbg_core(drm, fmt, ...)
>     drm_dev_dbg(__drm_print_dev(drm), DRM_UT_CORE, )
> 
> and so on.
> 
> Best regards
> Thomas

Sure, I'll send a v2.

Thanks,
Siddh
diff mbox series

Patch

diff --git a/include/drm/drm_print.h b/include/drm/drm_print.h
index a44fb7ef257f..53702d830291 100644
--- a/include/drm/drm_print.h
+++ b/include/drm/drm_print.h
@@ -486,26 +486,75 @@  void __drm_dev_dbg(struct _ddebug *desc, const struct device *dev,
 	__drm_printk((drm), err, _ratelimited, "*ERROR* " fmt, ##__VA_ARGS__)
 
 
-#define drm_dbg_core(drm, fmt, ...)					\
-	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_CORE, fmt, ##__VA_ARGS__)
-#define drm_dbg_driver(drm, fmt, ...)						\
-	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
-#define drm_dbg_kms(drm, fmt, ...)					\
-	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_KMS, fmt, ##__VA_ARGS__)
-#define drm_dbg_prime(drm, fmt, ...)					\
-	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_PRIME, fmt, ##__VA_ARGS__)
-#define drm_dbg_atomic(drm, fmt, ...)					\
-	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
-#define drm_dbg_vbl(drm, fmt, ...)					\
-	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_VBL, fmt, ##__VA_ARGS__)
-#define drm_dbg_state(drm, fmt, ...)					\
-	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_STATE, fmt, ##__VA_ARGS__)
-#define drm_dbg_lease(drm, fmt, ...)					\
-	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_LEASE, fmt, ##__VA_ARGS__)
-#define drm_dbg_dp(drm, fmt, ...)					\
-	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DP, fmt, ##__VA_ARGS__)
-#define drm_dbg_drmres(drm, fmt, ...)					\
-	drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRMRES, fmt, ##__VA_ARGS__)
+#define drm_dbg_core(drm, fmt, ...)				\
+({								\
+	const struct drm_device *drm_ = (drm);			\
+	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_CORE,	\
+		    fmt, ##__VA_ARGS__);			\
+})
+
+#define drm_dbg_driver(drm, fmt, ...)				\
+({								\
+	const struct drm_device *drm_ = (drm);			\
+	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_DRIVER,	\
+		    fmt, ##__VA_ARGS__);			\
+})
+
+#define drm_dbg_kms(drm, fmt, ...)				\
+({								\
+	const struct drm_device *drm_ = (drm);			\
+	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_KMS,	\
+		    fmt, ##__VA_ARGS__);			\
+})
+
+#define drm_dbg_prime(drm, fmt, ...)				\
+({								\
+	const struct drm_device *drm_ = (drm);			\
+	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_PRIME,	\
+		    fmt, ##__VA_ARGS__);			\
+})
+
+#define drm_dbg_atomic(drm, fmt, ...)				\
+({								\
+	const struct drm_device *drm_ = (drm);			\
+	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_ATOMIC,	\
+		    fmt, ##__VA_ARGS__);			\
+})
+
+#define drm_dbg_vbl(drm, fmt, ...)				\
+({								\
+	const struct drm_device *drm_ = (drm);			\
+	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_VBL,	\
+		    fmt, ##__VA_ARGS__);			\
+})
+
+#define drm_dbg_state(drm, fmt, ...)				\
+({								\
+	const struct drm_device *drm_ = (drm);			\
+	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_STATE,	\
+		    fmt, ##__VA_ARGS__);			\
+})
+
+#define drm_dbg_lease(drm, fmt, ...)				\
+({								\
+	const struct drm_device *drm_ = (drm);			\
+	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_LEASE,	\
+		    fmt, ##__VA_ARGS__);			\
+})
+
+#define drm_dbg_dp(drm, fmt, ...)				\
+({								\
+	const struct drm_device *drm_ = (drm);			\
+	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_DP,		\
+		    fmt, ##__VA_ARGS__);			\
+})
+
+#define drm_dbg_drmres(drm, fmt, ...)				\
+({								\
+	const struct drm_device *drm_ = (drm);			\
+	drm_dev_dbg(drm_ ? drm_->dev : NULL, DRM_UT_DRMRES,	\
+		    fmt, ##__VA_ARGS__);			\
+})
 
 #define drm_dbg(drm, fmt, ...)	drm_dbg_driver(drm, fmt, ##__VA_ARGS__)