lkml.org 
[lkml]   [2023]   [Jan]   [5]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v4 01/10] drm/print: Fix and add support for NULL as first argument in drm_* macros
    Date
    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 separating logic to get dev ptr in a new
    function, which will return the dev ptr if arg is not NULL.
    Use it in drm_dbg_*, and also in __DRM_DEFINE_DBG_RATELIMITED,
    where a similar (but correct) NULL check was in place.

    Also, add support for NULL in __drm_printk, so that all the
    drm_* macros will hence support NULL as the first argument.
    This also means that deprecation comments mentioning pr_()*
    can now be changed to the drm equivalents.

    There is a need to support device pointers, as in some cases,
    we may not have drm_device but just the device ptr, such as
    when dealing with struct mipi_dsi_host. Before this change,
    passing just mipi_dsi_host would have worked, since due to
    preprocessing, the resultant would be "host->dev", but now
    due to NULL check that cannot happen.

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

    diff --git a/include/drm/drm_print.h b/include/drm/drm_print.h
    index a44fb7ef257f..df791cd747da 100644
    --- a/include/drm/drm_print.h
    +++ b/include/drm/drm_print.h
    @@ -34,6 +34,7 @@
    #include <linux/dynamic_debug.h>

    #include <drm/drm.h>
    +#include <drm/drm_device.h>

    /* Do *not* use outside of drm_print.[ch]! */
    extern unsigned long __drm_debug;
    @@ -451,9 +452,52 @@ void __drm_dev_dbg(struct _ddebug *desc, const struct device *dev,
    * Prefer drm_device based logging over device or prink based logging.
    */

    -/* Helper for struct drm_device based logging. */
    +/**
    + * ___drm_get_dev_ptr - Helper function to get device pointer.
    + * @ptr: struct drm_device pointer, struct device pointer, or NULL.
    + * @is_drm: True implies @ptr is drm_device pointer, else device pointer.
    + *
    + * RETURNS:
    + * The device pointer (NULL if @ptr is NULL).
    + */
    +static inline struct device *___drm_get_dev_ptr(const void *ptr, bool is_drm)
    +{
    + if (!ptr)
    + return NULL;
    +
    + if (is_drm)
    + return ((struct drm_device *)ptr)->dev;
    +
    + return (struct device *)ptr;
    +}
    +
    +/**
    + * __drm_get_dev_ptr - Helper to get device pointer even if NULL is passed.
    + * Primarily for use in drm_*() print macros, since they
    + * need to handle NULL as the first argument passed.
    + */
    +#define __drm_get_dev_ptr(drm) \
    + _Generic((drm), \
    + struct drm_device * : \
    + __drm_get_dev_ptr((drm), true), \
    + struct device * : \
    + __drm_get_dev_ptr((drm), false), \
    + default : \
    + NULL \
    + )
    +
    +/**
    + * Helper for struct drm_device based logging (prefer this over struct device).
    + * Also supports struct device ptr as an argument for edge cases.
    + */
    #define __drm_printk(drm, level, type, fmt, ...) \
    - dev_##level##type((drm)->dev, "[drm] " fmt, ##__VA_ARGS__)
    +({ \
    + struct device *__dev_ = __drm_get_dev_ptr(drm); \
    + if (__dev_) \
    + dev_##level##type(__dev_, "[drm] " fmt, ##__VA_ARGS__); \
    + else \
    + pr_##level##type("[drm] " fmt, ##__VA_ARGS__); \
    +})


    #define drm_info(drm, fmt, ...) \
    @@ -487,25 +531,25 @@ void __drm_dev_dbg(struct _ddebug *desc, const struct device *dev,


    #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__)
    + drm_dev_dbg(__drm_get_dev_ptr(drm), DRM_UT_CORE, fmt, ##__VA_ARGS__)
    +#define drm_dbg_driver(drm, fmt, ...) \
    + drm_dev_dbg(__drm_get_dev_ptr(drm), 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__)
    + drm_dev_dbg(__drm_get_dev_ptr(drm), 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__)
    + drm_dev_dbg(__drm_get_dev_ptr(drm), 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__)
    + drm_dev_dbg(__drm_get_dev_ptr(drm), 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__)
    + drm_dev_dbg(__drm_get_dev_ptr(drm), 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__)
    + drm_dev_dbg(__drm_get_dev_ptr(drm), 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__)
    + drm_dev_dbg(__drm_get_dev_ptr(drm), 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__)
    + drm_dev_dbg(__drm_get_dev_ptr(drm), 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__)
    + drm_dev_dbg(__drm_get_dev_ptr(drm), DRM_UT_DRMRES, fmt, ##__VA_ARGS__)

    #define drm_dbg(drm, fmt, ...) drm_dbg_driver(drm, fmt, ##__VA_ARGS__)

    @@ -533,31 +577,31 @@ void __drm_err(const char *format, ...);
    #define _DRM_PRINTK(once, level, fmt, ...) \
    printk##once(KERN_##level "[" DRM_NAME "] " fmt, ##__VA_ARGS__)

    -/* NOTE: this is deprecated in favor of pr_info(). */
    +/* NOTE: this is deprecated in favor of drm_info(NULL, ...). */
    #define DRM_INFO(fmt, ...) \
    _DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__)
    -/* NOTE: this is deprecated in favor of pr_notice(). */
    +/* NOTE: this is deprecated in favor of drm_notice(NULL, ...). */
    #define DRM_NOTE(fmt, ...) \
    _DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__)
    -/* NOTE: this is deprecated in favor of pr_warn(). */
    +/* NOTE: this is deprecated in favor of drm_warn(NULL, ...). */
    #define DRM_WARN(fmt, ...) \
    _DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__)

    -/* NOTE: this is deprecated in favor of pr_info_once(). */
    +/* NOTE: this is deprecated in favor of drm_info_once(NULL, ...). */
    #define DRM_INFO_ONCE(fmt, ...) \
    _DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__)
    -/* NOTE: this is deprecated in favor of pr_notice_once(). */
    +/* NOTE: this is deprecated in favor of drm_notice_once(NULL, ...). */
    #define DRM_NOTE_ONCE(fmt, ...) \
    _DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__)
    -/* NOTE: this is deprecated in favor of pr_warn_once(). */
    +/* NOTE: this is deprecated in favor of drm_warn_once(NULL, ...). */
    #define DRM_WARN_ONCE(fmt, ...) \
    _DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__)

    -/* NOTE: this is deprecated in favor of pr_err(). */
    +/* NOTE: this is deprecated in favor of drm_err(NULL, ...). */
    #define DRM_ERROR(fmt, ...) \
    __drm_err(fmt, ##__VA_ARGS__)

    -/* NOTE: this is deprecated in favor of pr_err_ratelimited(). */
    +/* NOTE: this is deprecated in favor of drm_err_ratelimited(NULL, ...). */
    #define DRM_ERROR_RATELIMITED(fmt, ...) \
    DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)

    @@ -593,13 +637,14 @@ void __drm_err(const char *format, ...);
    #define DRM_DEBUG_DP(fmt, ...) \
    __drm_dbg(DRM_UT_DP, fmt, ## __VA_ARGS__)

    -#define __DRM_DEFINE_DBG_RATELIMITED(category, drm, fmt, ...) \
    -({ \
    - static DEFINE_RATELIMIT_STATE(rs_, DEFAULT_RATELIMIT_INTERVAL, DEFAULT_RATELIMIT_BURST);\
    - const struct drm_device *drm_ = (drm); \
    - \
    - if (drm_debug_enabled(DRM_UT_ ## category) && __ratelimit(&rs_)) \
    - drm_dev_printk(drm_ ? drm_->dev : NULL, KERN_DEBUG, fmt, ## __VA_ARGS__); \
    +#define __DRM_DEFINE_DBG_RATELIMITED(category, drm, fmt, ...) \
    +({ \
    + static DEFINE_RATELIMIT_STATE(rs_, DEFAULT_RATELIMIT_INTERVAL, \
    + DEFAULT_RATELIMIT_BURST); \
    + \
    + if (drm_debug_enabled(DRM_UT_ ## category) && __ratelimit(&rs_))\
    + drm_dev_printk(__drm_get_dev_ptr(drm), KERN_DEBUG, \
    + fmt, ## __VA_ARGS__); \
    })

    #define drm_dbg_kms_ratelimited(drm, fmt, ...) \
    --
    2.39.0

    \
     
     \ /
      Last update: 2023-03-26 23:29    [W:4.046 / U:0.196 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site