Series comparison

-[PATCH v4 0/4] Panthor BO tagging and GEMS debug display
+[PATCH v5 0/4] Panthor BO tagging and GEMS debug display
 ...
 To visualise it, cat sudo cat /sys/kernel/debug/dri/*.gpu/gems.
 To test this functionality from UM, please refer to this Mesa patch series:
 https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/34224
 Discussion of previous revision of this patch series can be found at:
-https://lore.kernel.org/dri-devel/20250327140845.105962-1-adrian.larumbe@collabora.com/
+https://lore.kernel.org/dri-devel/20250402115432.1469703-1-adrian.larumbe@collabora.com/
 Changelog:
+v5:
+ - Kept case and naming of kernel BO's consistent
+ - Increased the driver minor after new ioctl
+ - Now adds BO to debugfs GEMs list at GEM object creation time
+ - No longer try to hide BO creator's name when it's a workqueue or modprobe
+ - Reworked the procedure for printing GEM state and kernel BO flags
+ - Turned kernel BO flags and GEM state flags into bit enums
+ - Wait until BO state is marked as initialied for debugfs display
 v4:
  - Labelled all kernel BO's, not just heap chunks.
  - Refactored DebugGFs GEMs list handling functions
  - Added debugfs GEMS node mask to tell different kinds of BO's
 ...
   drm/panthor: Label all kernel BO's
   drm/panthor: show device-wide list of DRM GEM objects over DebugFS
  drivers/gpu/drm/panthor/panthor_device.c |   5 +
  drivers/gpu/drm/panthor/panthor_device.h |  11 ++
- drivers/gpu/drm/panthor/panthor_drv.c    |  66 ++++++++
+ drivers/gpu/drm/panthor/panthor_drv.c    |  68 +++++++-
  drivers/gpu/drm/panthor/panthor_fw.c     |   8 +-
- drivers/gpu/drm/panthor/panthor_gem.c    | 190 ++++++++++++++++++++++-
+ drivers/gpu/drm/panthor/panthor_gem.c    | 210 ++++++++++++++++++++++-
- drivers/gpu/drm/panthor/panthor_gem.h    |  56 ++++++-
+ drivers/gpu/drm/panthor/panthor_gem.h    |  86 +++++++++-
  drivers/gpu/drm/panthor/panthor_heap.c   |   6 +-
  drivers/gpu/drm/panthor/panthor_sched.c  |   9 +-
- include/uapi/drm/panthor_drm.h           |  19 +++
+ include/uapi/drm/panthor_drm.h           |  19 ++
-files changed, 360 insertions(+), 10 deletions(-)
+files changed, 411 insertions(+), 11 deletions(-)
 --
 .48.1

-[PATCH v4 1/4] drm/panthor: Introduce BO labeling
+[PATCH v5 1/4] drm/panthor: Introduce BO labeling
 Add a new character string Panthor BO field, and a function that allows
 setting it from within the driver.
 Driver takes care of freeing the string when it's replaced or no longer
 needed at object destruction time, but allocating it is the responsibility
 of callers.
 Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
 ---
  drivers/gpu/drm/panthor/panthor_gem.c | 38 +++++++++++++++++++++++++++
  drivers/gpu/drm/panthor/panthor_gem.h | 17 ++++++++++++
 files changed, 55 insertions(+)
 diff --git a/drivers/gpu/drm/panthor/panthor_gem.c b/drivers/gpu/drm/panthor/panthor_gem.c
 index XXXXXXX..XXXXXXX 100644
 --- a/drivers/gpu/drm/panthor/panthor_gem.c
 +++ b/drivers/gpu/drm/panthor/panthor_gem.c
 @@ -XXX,XX +XXX,XX @@ static void panthor_gem_free_object(struct drm_gem_object *obj)
      struct panthor_gem_object *bo = to_panthor_bo(obj);
      struct drm_gem_object *vm_root_gem = bo->exclusive_vm_root_gem;
 +    /*
 +     * Label might have been allocated with kstrdup_const(),
 +     * we need to take that into account when freeing the memory
 +     */
 +    kfree_const(bo->label.str);
 +
 +    mutex_destroy(&bo->label.lock);
 +
      drm_gem_free_mmap_offset(&bo->base.base);
      mutex_destroy(&bo->gpuva_list_lock);
      drm_gem_shmem_free(&bo->base);
 @@ -XXX,XX +XXX,XX @@ struct drm_gem_object *panthor_gem_create_object(struct drm_device *ddev, size_t
      obj->base.map_wc = !ptdev->coherent;
      mutex_init(&obj->gpuva_list_lock);
      drm_gem_gpuva_set_lock(&obj->base.base, &obj->gpuva_list_lock);
 +    mutex_init(&obj->label.lock);
      return &obj->base.base;
  }
 @@ -XXX,XX +XXX,XX @@ panthor_gem_create_with_handle(struct drm_file *file,
      return ret;
  }
 +
 +void
 +panthor_gem_bo_set_label(struct drm_gem_object *obj, const char *label)
 +{
 +    struct panthor_gem_object *bo = to_panthor_bo(obj);
 +    const char *old_label;
 +
 +    mutex_lock(&bo->label.lock);
 +    old_label = bo->label.str;
 +    bo->label.str = label;
 +    mutex_unlock(&bo->label.lock);
 +
 +    kfree(old_label);
 +}
 +
 +void
 +panthor_gem_kernel_bo_set_label(struct panthor_kernel_bo *bo, const char *label)
 +{
 +    const char *str;
 +
 +    str = kstrdup_const(label, GFP_KERNEL);
 +    if (!str) {
 +        /* Failing to allocate memory for a label isn't a fatal condition */
 +        drm_warn(bo->obj->dev, "Not enough memory to allocate BO label");
 +        return;
 +    }
 +
 +    panthor_gem_bo_set_label(bo->obj, kstrdup_const(str, GFP_KERNEL));
 +}
 diff --git a/drivers/gpu/drm/panthor/panthor_gem.h b/drivers/gpu/drm/panthor/panthor_gem.h
 index XXXXXXX..XXXXXXX 100644
 --- a/drivers/gpu/drm/panthor/panthor_gem.h
 +++ b/drivers/gpu/drm/panthor/panthor_gem.h
 @@ -XXX,XX +XXX,XX @@ struct panthor_gem_object {
      /** @flags: Combination of drm_panthor_bo_flags flags. */
      u32 flags;
 +
 +    /**
 +     * @label: BO tagging fields. The label can be assigned within the
 +     * driver itself or through a specific IOCTL.
 +     */
 +    struct {
 +        /**
 +         * @label.str: Pointer to NULL-terminated string,
 +         */
 +        const char *str;
 +
 +        /** @lock.str: Protects access to the @label.str field. */
 +        struct mutex lock;
 +    } label;
  };
  /**
 @@ -XXX,XX +XXX,XX @@ panthor_gem_create_with_handle(struct drm_file *file,
                     struct panthor_vm *exclusive_vm,
                     u64 *size, u32 flags, uint32_t *handle);
 +void panthor_gem_bo_set_label(struct drm_gem_object *obj, const char *label);
 +void panthor_gem_kernel_bo_set_label(struct panthor_kernel_bo *bo, const char *label);
 +
  static inline u64
  panthor_kernel_bo_gpuva(struct panthor_kernel_bo *bo)
  {
 --
 .48.1

-[PATCH v4 2/4] drm/panthor: Add driver IOCTL for setting BO labels
+[PATCH v5 2/4] drm/panthor: Add driver IOCTL for setting BO labels
 Allow UM to label a BO for which it possesses a DRM handle.
 Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
+Reviewed-by: Liviu Dudau <liviu.dudau@arm.com>
 ---
- drivers/gpu/drm/panthor/panthor_drv.c | 40 +++++++++++++++++++++++++++
+ drivers/gpu/drm/panthor/panthor_drv.c | 42 ++++++++++++++++++++++++++-
  drivers/gpu/drm/panthor/panthor_gem.h |  2 ++
- include/uapi/drm/panthor_drm.h        | 19 +++++++++++++
+ include/uapi/drm/panthor_drm.h        | 19 ++++++++++++
-files changed, 61 insertions(+)
+files changed, 62 insertions(+), 1 deletion(-)
 diff --git a/drivers/gpu/drm/panthor/panthor_drv.c b/drivers/gpu/drm/panthor/panthor_drv.c
 index XXXXXXX..XXXXXXX 100644
 --- a/drivers/gpu/drm/panthor/panthor_drv.c
 +++ b/drivers/gpu/drm/panthor/panthor_drv.c
 ...
   * - 1.3 - adds DRM_PANTHOR_GROUP_STATE_INNOCENT flag
 + * - 1.4 - adds DRM_IOCTL_PANTHOR_BO_SET_LABEL ioctl
   */
  static const struct drm_driver panthor_drm_driver = {
      .driver_features = DRIVER_RENDER | DRIVER_GEM | DRIVER_SYNCOBJ |
+@@ -XXX,XX +XXX,XX @@ static const struct drm_driver panthor_drm_driver = {
+     .name = "panthor",
+     .desc = "Panthor DRM driver",
+     .major = 1,
+-    .minor = 3,
++    .minor = 4,
+     .gem_create_object = panthor_gem_create_object,
+     .gem_prime_import_sg_table = drm_gem_shmem_prime_import_sg_table,
 diff --git a/drivers/gpu/drm/panthor/panthor_gem.h b/drivers/gpu/drm/panthor/panthor_gem.h
 index XXXXXXX..XXXXXXX 100644
 --- a/drivers/gpu/drm/panthor/panthor_gem.h
 +++ b/drivers/gpu/drm/panthor/panthor_gem.h
 @@ -XXX,XX +XXX,XX @@
 ...

-[PATCH v4 3/4] drm/panthor: Label all kernel BO's
+[PATCH v5 3/4] drm/panthor: Label all kernel BO's
 ...
 future, this would have to change.
 Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
 ---
  drivers/gpu/drm/panthor/panthor_fw.c    | 8 +++++---
- drivers/gpu/drm/panthor/panthor_gem.c   | 3 ++-
+ drivers/gpu/drm/panthor/panthor_gem.c   | 4 +++-
  drivers/gpu/drm/panthor/panthor_gem.h   | 2 +-
  drivers/gpu/drm/panthor/panthor_heap.c  | 6 ++++--
  drivers/gpu/drm/panthor/panthor_sched.c | 9 ++++++---
-files changed, 18 insertions(+), 10 deletions(-)
+files changed, 19 insertions(+), 10 deletions(-)
 diff --git a/drivers/gpu/drm/panthor/panthor_fw.c b/drivers/gpu/drm/panthor/panthor_fw.c
 index XXXXXXX..XXXXXXX 100644
 --- a/drivers/gpu/drm/panthor/panthor_fw.c
 +++ b/drivers/gpu/drm/panthor/panthor_fw.c
 ...
 @@ -XXX,XX +XXX,XX @@ static int panthor_fw_load_section_entry(struct panthor_device *ptdev,
          section->mem = panthor_kernel_bo_create(ptdev, panthor_fw_vm(ptdev),
                              section_size,
                              DRM_PANTHOR_BO_NO_MMAP,
 -                            vm_map_flags, va);
-+                            vm_map_flags, va, "FW Section");
++                            vm_map_flags, va, "FW section");
          if (IS_ERR(section->mem))
              return PTR_ERR(section->mem);
 diff --git a/drivers/gpu/drm/panthor/panthor_gem.c b/drivers/gpu/drm/panthor/panthor_gem.c
 index XXXXXXX..XXXXXXX 100644
 ...
 @@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
      kbo->obj = &obj->base;
      bo->flags = bo_flags;
 +    panthor_gem_kernel_bo_set_label(kbo, name);
++
      /* The system and GPU MMU page size might differ, which becomes a
       * problem for FW sections that need to be mapped at explicit address
       * since our PAGE_SIZE alignment might cover a VA range that's
 diff --git a/drivers/gpu/drm/panthor/panthor_gem.h b/drivers/gpu/drm/panthor/panthor_gem.h
 index XXXXXXX..XXXXXXX 100644
 ...
                       DRM_PANTHOR_BO_NO_MMAP,
                       DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC |
                       DRM_PANTHOR_VM_BIND_OP_MAP_UNCACHED,
 -                     PANTHOR_VM_KERNEL_AUTO_VA);
 +                     PANTHOR_VM_KERNEL_AUTO_VA,
-+                     "fdinfo slots");
++                     "Group job stats");
      if (IS_ERR(queue->profiling.slots)) {
          ret = PTR_ERR(queue->profiling.slots);
 @@ -XXX,XX +XXX,XX @@ int panthor_group_create(struct panthor_file *pfile,
                             DRM_PANTHOR_BO_NO_MMAP,
 ...

-[PATCH v4 4/4] drm/panthor: show device-wide list of DRM GEM objects over DebugFS
+[PATCH v5 4/4] drm/panthor: show device-wide list of DRM GEM objects over DebugFS
 ...
 File format is that of a table, with each entry displaying a variety of
 fields with information about each GEM object.
 Each GEM object entry in the file displays the following information
 fields: Client PID, BO's global name, reference count, BO virtual size,
-BO resize size, VM address in its DRM-managed range, BO label and a flag
+BO resize size, VM address in its DRM-managed range, BO label and a GEM
-bitmask.
+state flags.
-There's also a kflags field for the type of BO. Bit 0 tells us whether
+There's also a kflags field for the type of BO, which tells us whether
-it's a kernel BO, and bit 1 means the BO is mapped onto the FW's address
+it's a kernel BO and/or mapped onto the FW's address space.
 space.
 Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
 ---
  drivers/gpu/drm/panthor/panthor_device.c |   5 +
  drivers/gpu/drm/panthor/panthor_device.h |  11 ++
  drivers/gpu/drm/panthor/panthor_drv.c    |  26 ++++
- drivers/gpu/drm/panthor/panthor_gem.c    | 149 +++++++++++++++++++++++
+ drivers/gpu/drm/panthor/panthor_gem.c    | 168 +++++++++++++++++++++++
- drivers/gpu/drm/panthor/panthor_gem.h    |  35 ++++++
+ drivers/gpu/drm/panthor/panthor_gem.h    |  65 +++++++++
-files changed, 226 insertions(+)
+files changed, 275 insertions(+)
 diff --git a/drivers/gpu/drm/panthor/panthor_device.c b/drivers/gpu/drm/panthor/panthor_device.c
 index XXXXXXX..XXXXXXX 100644
 --- a/drivers/gpu/drm/panthor/panthor_device.c
 +++ b/drivers/gpu/drm/panthor/panthor_device.c
 ...
 +#include "panthor_fw.h"
  #include "panthor_gem.h"
  #include "panthor_mmu.h"
 +#ifdef CONFIG_DEBUG_FS
-+static void panthor_gem_debugfs_bo_init(struct panthor_gem_object *bo, u32 type_mask)
++static void panthor_gem_debugfs_bo_add(struct panthor_device *ptdev,
 +                       struct panthor_gem_object *bo)
 +{
 +    INIT_LIST_HEAD(&bo->debugfs.node);
 +
-+    if (!(type_mask & PANTHOR_BO_FW_MAPPED)) {
++    bo->debugfs.creator.tgid = current->group_leader->pid;
-+        bo->debugfs.creator.tgid = current->group_leader->pid;
++    get_task_comm(bo->debugfs.creator.process_name, current->group_leader);
 +        get_task_comm(bo->debugfs.creator.process_name, current->group_leader);
 +    } else {
 +        bo->debugfs.creator.tgid = 0;
 +        snprintf(bo->debugfs.creator.process_name,
 +             sizeof(bo->debugfs.creator.process_name),
 +             "kernel");
 +    }
 +
 +    bo->debugfs.bo_mask = type_mask;
 +}
 +
 +static void panthor_gem_debugfs_bo_add(struct panthor_gem_object *bo, u32 type_mask)
 +{
 +    struct panthor_device *ptdev =  container_of(bo->base.base.dev,
 +                             struct panthor_device, base);
 +
 +    panthor_gem_debugfs_bo_init(bo, type_mask);
 +
 +    mutex_lock(&ptdev->gems.lock);
 +    list_add_tail(&bo->debugfs.node, &ptdev->gems.node);
 +    mutex_unlock(&ptdev->gems.lock);
 +}
 ...
 +    list_del_init(&bo->debugfs.node);
 +    mutex_unlock(&ptdev->gems.lock);
 +}
 +
 +#else
-+static void panthor_gem_debugfs_bo_add(struct panthor_gem_object *bo, u32 type_mask) {}
++static void panthor_gem_debugfs_bo_add(struct panthor_device *ptdev,
 +                       struct panthor_gem_object *bo)
 +{}
 +static void panthor_gem_debugfs_bo_rm(struct panthor_gem_object *bo) {}
 +#endif
 +
  static void panthor_gem_free_object(struct drm_gem_object *obj)
  {
 ...
       * we need to take that into account when freeing the memory
 @@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
      struct drm_gem_shmem_object *obj;
      struct panthor_kernel_bo *kbo;
      struct panthor_gem_object *bo;
-+    u32 type_mask = PANTHOR_BO_KERNEL;
++    u32 debug_flags = PANTHOR_DEBUGFS_BO_FLAGS_KERNEL;
      int ret;
      if (drm_WARN_ON(&ptdev->base, !vm))
 @@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
      kbo->obj = &obj->base;
      bo->flags = bo_flags;
 +    if (vm == panthor_fw_vm(ptdev))
-+        type_mask |= PANTHOR_BO_FW_MAPPED;
++        debug_flags |= PANTHOR_DEBUGFS_BO_FW_FLAG_MAPPED;
 +
      panthor_gem_kernel_bo_set_label(kbo, name);
-+    panthor_gem_debugfs_bo_add(to_panthor_bo(kbo->obj), type_mask);
++    panthor_gem_debugfs_bo_set_mask(to_panthor_bo(kbo->obj), debug_flags);
-+
      /* The system and GPU MMU page size might differ, which becomes a
       * problem for FW sections that need to be mapped at explicit address
-      * since our PAGE_SIZE alignment might cover a VA range that's
+@@ -XXX,XX +XXX,XX @@ struct drm_gem_object *panthor_gem_create_object(struct drm_device *ddev, size_t
      drm_gem_gpuva_set_lock(&obj->base.base, &obj->gpuva_list_lock);
      mutex_init(&obj->label.lock);
 +    panthor_gem_debugfs_bo_add(ptdev, obj);
 +
      return &obj->base.base;
  }
 @@ -XXX,XX +XXX,XX @@ panthor_gem_create_with_handle(struct drm_file *file,
      /* drop reference from allocate - handle holds it now. */
      drm_gem_object_put(&shmem->base);
-+    panthor_gem_debugfs_bo_add(bo, 0);
++    panthor_gem_debugfs_bo_set_mask(bo, 0);
 +
      return ret;
  }
 @@ -XXX,XX +XXX,XX @@ panthor_gem_kernel_bo_set_label(struct panthor_kernel_bo *bo, const char *label)
      panthor_gem_bo_set_label(bo->obj, kstrdup_const(str, GFP_KERNEL));
  }
 +
 +#ifdef CONFIG_DEBUG_FS
-+static bool panfrost_gem_print_flag(const char *name,
++static void
-+                    bool is_set,
++panthor_gem_debugfs_print_flags(struct seq_file *m,
-+                    bool other_flags_printed,
++                const char *names[],
-+                    struct seq_file *m)
++                u32 name_count,
-+{
++                u32 flags)
-+    if (is_set)
++{
-+        seq_printf(m, "%s%s", other_flags_printed ? "," : "", name);
++    bool first = true;
 +
-+    return is_set | other_flags_printed;
++    seq_puts(m, "(");
 +
 +    if (!flags)
 +        seq_puts(m, "none");
 +
 +    while (flags) {
 +        u32 bit = fls(flags) - 1;
 +
 +        if (!first)
 +            seq_puts(m, ",");
 +
 +        if (bit >= name_count || !names[bit])
 +            seq_printf(m, "unknown-bit%d", bit);
 +        else
 +            seq_printf(m, "%s", names[bit]);
 +
 +        first = false;
 +        flags &= ~BIT(bit);
 +    }
 +
 +    seq_puts(m, ")");
 +}
 +
 +struct gem_size_totals {
 +    size_t size;
 +    size_t resident;
 ...
 +                     struct seq_file *m,
 +                     struct gem_size_totals *totals)
 +{
 +    unsigned int refcount = kref_read(&bo->base.base.refcount);
 +    char creator_info[32] = {};
-+    bool has_flags = false;
++    u32 gem_state_flags = 0;
 +    size_t resident_size;
++
++    static const char *gem_status_flags[] = {
++        "imported", "exported", "purged", "purgeable"
++    };
++
++    static const char *panthor_bo_flags[] = {
++        "kernel", "fw"
++    };
 +
 +    /* Skip BOs being destroyed. */
 +    if (!refcount)
 +        return;
 +
 ...
 +           refcount,
 +           bo->base.base.size,
 +           resident_size,
 +           drm_vma_node_start(&bo->base.base.vma_node));
 +
-+    seq_puts(m, "(");
++
-+    has_flags = panfrost_gem_print_flag("imported", bo->base.base.import_attach != NULL,
++    if (bo->base.base.import_attach != NULL)
-+                        has_flags, m);
++        gem_state_flags |= PANTHOR_DEBUGFS_GEM_IMPORTED;
-+    has_flags = panfrost_gem_print_flag("exported", bo->base.base.dma_buf != NULL,
++    if (bo->base.base.dma_buf != NULL)
-+                        has_flags, m);
++        gem_state_flags |= PANTHOR_DEBUGFS_GEM_EXPORTED;
 +    if (bo->base.madv < 0)
-+        has_flags = panfrost_gem_print_flag("purged", true, has_flags, m);
++        gem_state_flags |= PANTHOR_DEBUGFS_GEM_PURGED;
-+    else if (bo->base.madv > 0)
++    if (bo->base.madv)
-+        has_flags = panfrost_gem_print_flag("purgeable", true, has_flags, m);
++        gem_state_flags |= PANTHOR_DEBUGFS_GEM_PURGEABLE;
-+    if (!has_flags)
++
-+        seq_puts(m, "none");
++    panthor_gem_debugfs_print_flags(m, gem_status_flags,
-+    seq_puts(m, ")");
++                    sizeof(gem_status_flags), gem_state_flags);
-+
++    seq_printf(m, "%-4s", "");
-+    seq_printf(m, "%-6s0x%-2x", "", bo->debugfs.bo_mask);
++    panthor_gem_debugfs_print_flags(m, panthor_bo_flags, sizeof(panthor_bo_flags),
 +                    bo->debugfs.flags & (u32)~PANTHOR_DEBUGFS_BO_FLAG_INITIALISED);
 +
 +    mutex_lock(&bo->label.lock);
 +    seq_printf(m, "%-6s%-60s", "", bo->label.str ? : NULL);
 +    mutex_unlock(&bo->label.lock);
 +    seq_puts(m, "\n");
 ...
 +                   struct seq_file *m)
 +{
 +    struct gem_size_totals totals = {0};
 +    struct panthor_gem_object *bo;
 +
-+    seq_puts(m, "created-by                      global-name     refcount        size            resident-size   file-offset     flags     kflags     label\n");
++    seq_puts(m, "created-by                      global-name     refcount        size            resident-size   file-offset     state     kflags     label\n");
 +    seq_puts(m, "------------------------------------------------------------------------------------------------------------------------------------------------\n");
 +
 +    scoped_guard(mutex, &ptdev->gems.lock) {
-+        list_for_each_entry(bo, &ptdev->gems.node, debugfs.node)
++        list_for_each_entry(bo, &ptdev->gems.node, debugfs.node) {
-+            panthor_gem_debugfs_bo_print(bo, m, &totals);
++            if (bo->debugfs.flags & PANTHOR_DEBUGFS_BO_FLAG_INITIALISED)
 +                panthor_gem_debugfs_bo_print(bo, m, &totals);
 +        }
 +
 +    }
 +
 +    seq_puts(m, "==========================================================================================================================================================\n");
 +    seq_printf(m, "Total size: %zd, Total resident: %zd, Total reclaimable: %zd\n",
 +           totals.size, totals.resident, totals.reclaimable);
 ...
 +++ b/drivers/gpu/drm/panthor/panthor_gem.h
 @@ -XXX,XX +XXX,XX @@ struct panthor_vm;
  #define PANTHOR_BO_LABEL_MAXLEN    PAGE_SIZE
-+#define PANTHOR_BO_KERNEL    BIT(0)
++enum panthor_debugfs_gem_state_flags {
-+#define PANTHOR_BO_FW_MAPPED    BIT(1)
++    /** @PANTHOR_DEBUGFS_GEM_IMPORTED: GEM BO is PRIME imported. */
 +    PANTHOR_DEBUGFS_GEM_IMPORTED = BIT(0),
 +
 +    /** @PANTHOR_DEBUGFS_GEM_EXPORTED: GEM BO is PRIME exported. */
 +    PANTHOR_DEBUGFS_GEM_EXPORTED = BIT(1),
 +
 +    /** @PANTHOR_DEBUGFS_GEM_PURGED: GEM BO was reclaimed by the shrinker. */
 +    PANTHOR_DEBUGFS_GEM_PURGED = BIT(2),
 +
 +    /** @PANTHOR_DEBUGFS_GEM_PURGEABLE: GEM BO can be reclaimed by the shrinker. */
 +    PANTHOR_DEBUGFS_GEM_PURGEABLE = BIT(3),
 +};
 +
 +enum panthor_debugfs_bo_flags {
 +    /** @PANTHOR_DEBUGFS_BO_KERNEL: BO is for kernel use only. */
 +    PANTHOR_DEBUGFS_BO_FLAGS_KERNEL = BIT(0),
 +
 +    /** @PANTHOR_DEBUGFS_BO_FW_MAPPED: BO is mapped on the FW VM. */
 +    PANTHOR_DEBUGFS_BO_FW_FLAG_MAPPED = BIT(1),
 +
 +    /** @PANTHOR_DEBUGFS_BO_INITIALISED: BO is ready for DebugFS display. */
 +    PANTHOR_DEBUGFS_BO_FLAG_INITIALISED = BIT(31),
 +};
 +
 +/**
 + * struct panthor_gem_debugfs - GEM object's DebugFS list information
 + */
 +struct panthor_gem_debugfs {
 ...
 +
 +        /** @creator.tgid: PID of the thread's group leader within its process */
 +        pid_t tgid;
 +    } creator;
 +
-+    /** @bo_mask: Bitmask encoding BO type as {USER, KERNEL} x {GPU, FW} */
++    /** @bo_mask: Combination of panthor_debugfs_bo_flags flags */
-+    u32 bo_mask;
++    u32 flags;
 +};
 +
  /**
   * struct panthor_gem_object - Driver specific GEM object.
   */
 ...
  void panthor_kernel_bo_destroy(struct panthor_kernel_bo *bo);
 +#ifdef CONFIG_DEBUG_FS
 +void panthor_gem_debugfs_print_bos(struct panthor_device *pfdev,
 +                   struct seq_file *m);
++static inline void
++panthor_gem_debugfs_bo_set_mask(struct panthor_gem_object *bo, u32 type_mask)
++{
++    bo->debugfs.flags = type_mask | PANTHOR_DEBUGFS_BO_FLAG_INITIALISED;
++}
++
++#else
++void panthor_gem_debugfs_bo_set_mask(struct panthor_gem_object *bo, u32 type_mask) {};
 +#endif
 +
  #endif /* __PANTHOR_GEM_H__ */
 --
 .48.1

This patch series is aimed at providing UM with detailed memory profiling
information in debug builds. It is achieved through a device-wide list of
DRM GEM objects, and also implementing the ability to label BO's from UM
through a new IOCTL.

The new debugfs file shows a list of driver DRM GEM objects in tabular mode.
To visualise it, cat sudo cat /sys/kernel/debug/dri/*.gpu/gems.
To test this functionality from UM, please refer to this Mesa patch series:
https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/34224

Discussion of previous revision of this patch series can be found at:
https://lore.kernel.org/dri-devel/20250327140845.105962-1-adrian.larumbe@collabora.com/

Changelog:

v4:
 - Labelled all kernel BO's, not just heap chunks.
 - Refactored DebugGFs GEMs list handling functions
 - Added debugfs GEMS node mask to tell different kinds of BO's

Adrián Larumbe (4):
  drm/panthor: Introduce BO labeling
  drm/panthor: Add driver IOCTL for setting BO labels
  drm/panthor: Label all kernel BO's
  drm/panthor: show device-wide list of DRM GEM objects over DebugFS

drivers/gpu/drm/panthor/panthor_device.c |   5 +
 drivers/gpu/drm/panthor/panthor_device.h |  11 ++
 drivers/gpu/drm/panthor/panthor_drv.c    |  66 ++++++++
 drivers/gpu/drm/panthor/panthor_fw.c     |   8 +-
 drivers/gpu/drm/panthor/panthor_gem.c    | 190 ++++++++++++++++++++++-
 drivers/gpu/drm/panthor/panthor_gem.h    |  56 ++++++-
 drivers/gpu/drm/panthor/panthor_heap.c   |   6 +-
 drivers/gpu/drm/panthor/panthor_sched.c  |   9 +-
 include/uapi/drm/panthor_drm.h           |  19 +++
 9 files changed, 360 insertions(+), 10 deletions(-)

--
2.48.1

Add a new character string Panthor BO field, and a function that allows
setting it from within the driver.

Driver takes care of freeing the string when it's replaced or no longer
needed at object destruction time, but allocating it is the responsibility
of callers.

Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
---
 drivers/gpu/drm/panthor/panthor_gem.c | 38 +++++++++++++++++++++++++++
 drivers/gpu/drm/panthor/panthor_gem.h | 17 ++++++++++++
 2 files changed, 55 insertions(+)

diff --git a/drivers/gpu/drm/panthor/panthor_gem.c b/drivers/gpu/drm/panthor/panthor_gem.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.c
+++ b/drivers/gpu/drm/panthor/panthor_gem.c
@@ -XXX,XX +XXX,XX @@ static void panthor_gem_free_object(struct drm_gem_object *obj)
 	struct panthor_gem_object *bo = to_panthor_bo(obj);
 	struct drm_gem_object *vm_root_gem = bo->exclusive_vm_root_gem;
 
+	/*
+	 * Label might have been allocated with kstrdup_const(),
+	 * we need to take that into account when freeing the memory
+	 */
+	kfree_const(bo->label.str);
+
+	mutex_destroy(&bo->label.lock);
+
 	drm_gem_free_mmap_offset(&bo->base.base);
 	mutex_destroy(&bo->gpuva_list_lock);
 	drm_gem_shmem_free(&bo->base);
@@ -XXX,XX +XXX,XX @@ struct drm_gem_object *panthor_gem_create_object(struct drm_device *ddev, size_t
 	obj->base.map_wc = !ptdev->coherent;
 	mutex_init(&obj->gpuva_list_lock);
 	drm_gem_gpuva_set_lock(&obj->base.base, &obj->gpuva_list_lock);
+	mutex_init(&obj->label.lock);
 
 	return &obj->base.base;
 }
@@ -XXX,XX +XXX,XX @@ panthor_gem_create_with_handle(struct drm_file *file,
 
 	return ret;
 }
+
+void
+panthor_gem_bo_set_label(struct drm_gem_object *obj, const char *label)
+{
+	struct panthor_gem_object *bo = to_panthor_bo(obj);
+	const char *old_label;
+
+	mutex_lock(&bo->label.lock);
+	old_label = bo->label.str;
+	bo->label.str = label;
+	mutex_unlock(&bo->label.lock);
+
+	kfree(old_label);
+}
+
+void
+panthor_gem_kernel_bo_set_label(struct panthor_kernel_bo *bo, const char *label)
+{
+	const char *str;
+
+	str = kstrdup_const(label, GFP_KERNEL);
+	if (!str) {
+		/* Failing to allocate memory for a label isn't a fatal condition */
+		drm_warn(bo->obj->dev, "Not enough memory to allocate BO label");
+		return;
+	}
+
+	panthor_gem_bo_set_label(bo->obj, kstrdup_const(str, GFP_KERNEL));
+}
diff --git a/drivers/gpu/drm/panthor/panthor_gem.h b/drivers/gpu/drm/panthor/panthor_gem.h
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.h
+++ b/drivers/gpu/drm/panthor/panthor_gem.h
@@ -XXX,XX +XXX,XX @@ struct panthor_gem_object {
 
 	/** @flags: Combination of drm_panthor_bo_flags flags. */
 	u32 flags;
+
+	/**
+	 * @label: BO tagging fields. The label can be assigned within the
+	 * driver itself or through a specific IOCTL.
+	 */
+	struct {
+		/**
+		 * @label.str: Pointer to NULL-terminated string,
+		 */
+		const char *str;
+
+		/** @lock.str: Protects access to the @label.str field. */
+		struct mutex lock;
+	} label;
 };
 
 /**
@@ -XXX,XX +XXX,XX @@ panthor_gem_create_with_handle(struct drm_file *file,
 			       struct panthor_vm *exclusive_vm,
 			       u64 *size, u32 flags, uint32_t *handle);
 
+void panthor_gem_bo_set_label(struct drm_gem_object *obj, const char *label);
+void panthor_gem_kernel_bo_set_label(struct panthor_kernel_bo *bo, const char *label);
+
 static inline u64
 panthor_kernel_bo_gpuva(struct panthor_kernel_bo *bo)
 {
-- 
2.48.1

Allow UM to label a BO for which it possesses a DRM handle.

Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
---
 drivers/gpu/drm/panthor/panthor_drv.c | 40 +++++++++++++++++++++++++++
 drivers/gpu/drm/panthor/panthor_gem.h |  2 ++
 include/uapi/drm/panthor_drm.h        | 19 +++++++++++++
 3 files changed, 61 insertions(+)

diff --git a/drivers/gpu/drm/panthor/panthor_drv.c b/drivers/gpu/drm/panthor/panthor_drv.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_drv.c
+++ b/drivers/gpu/drm/panthor/panthor_drv.c
@@ -XXX,XX +XXX,XX @@ static int panthor_ioctl_vm_get_state(struct drm_device *ddev, void *data,
 	return 0;
 }
 
+static int panthor_ioctl_bo_set_label(struct drm_device *ddev, void *data,
+				  struct drm_file *file)
+{
+	struct drm_panthor_bo_set_label *args = data;
+	struct drm_gem_object *obj;
+	const char *label;
+	int ret = 0;
+
+	obj = drm_gem_object_lookup(file, args->handle);
+	if (!obj)
+		return -ENOENT;
+
+	if (args->size && args->label) {
+		if (args->size > PANTHOR_BO_LABEL_MAXLEN) {
+			ret = -E2BIG;
+			goto err_label;
+		}
+
+		label = strndup_user(u64_to_user_ptr(args->label), args->size);
+		if (IS_ERR(label)) {
+			ret = PTR_ERR(label);
+			goto err_label;
+		}
+	} else if (args->size && !args->label) {
+		ret = -EINVAL;
+		goto err_label;
+	} else {
+		label = NULL;
+	}
+
+	panthor_gem_bo_set_label(obj, label);
+
+err_label:
+	drm_gem_object_put(obj);
+
+	return ret;
+}
+
 static int
 panthor_open(struct drm_device *ddev, struct drm_file *file)
 {
@@ -XXX,XX +XXX,XX @@ static const struct drm_ioctl_desc panthor_drm_driver_ioctls[] = {
 	PANTHOR_IOCTL(TILER_HEAP_CREATE, tiler_heap_create, DRM_RENDER_ALLOW),
 	PANTHOR_IOCTL(TILER_HEAP_DESTROY, tiler_heap_destroy, DRM_RENDER_ALLOW),
 	PANTHOR_IOCTL(GROUP_SUBMIT, group_submit, DRM_RENDER_ALLOW),
+	PANTHOR_IOCTL(BO_SET_LABEL, bo_set_label, DRM_RENDER_ALLOW),
 };
 
 static int panthor_mmap(struct file *filp, struct vm_area_struct *vma)
@@ -XXX,XX +XXX,XX @@ static void panthor_debugfs_init(struct drm_minor *minor)
  * - 1.2 - adds DEV_QUERY_GROUP_PRIORITIES_INFO query
  *       - adds PANTHOR_GROUP_PRIORITY_REALTIME priority
  * - 1.3 - adds DRM_PANTHOR_GROUP_STATE_INNOCENT flag
+ * - 1.4 - adds DRM_IOCTL_PANTHOR_BO_SET_LABEL ioctl
  */
 static const struct drm_driver panthor_drm_driver = {
 	.driver_features = DRIVER_RENDER | DRIVER_GEM | DRIVER_SYNCOBJ |
diff --git a/drivers/gpu/drm/panthor/panthor_gem.h b/drivers/gpu/drm/panthor/panthor_gem.h
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.h
+++ b/drivers/gpu/drm/panthor/panthor_gem.h
@@ -XXX,XX +XXX,XX @@
 
 struct panthor_vm;
 
+#define PANTHOR_BO_LABEL_MAXLEN	PAGE_SIZE
+
 /**
  * struct panthor_gem_object - Driver specific GEM object.
  */
diff --git a/include/uapi/drm/panthor_drm.h b/include/uapi/drm/panthor_drm.h
index XXXXXXX..XXXXXXX 100644
--- a/include/uapi/drm/panthor_drm.h
+++ b/include/uapi/drm/panthor_drm.h
@@ -XXX,XX +XXX,XX @@ enum drm_panthor_ioctl_id {
 
 	/** @DRM_PANTHOR_TILER_HEAP_DESTROY: Destroy a tiler heap. */
 	DRM_PANTHOR_TILER_HEAP_DESTROY,
+
+	/** @DRM_PANTHOR_BO_SET_LABEL: Label a BO. */
+	DRM_PANTHOR_BO_SET_LABEL,
 };
 
 /**
@@ -XXX,XX +XXX,XX @@ struct drm_panthor_tiler_heap_destroy {
 	__u32 pad;
 };
 
+/**
+ * struct drm_panthor_bo_set_label - Arguments passed to DRM_IOCTL_PANTHOR_BO_SET_LABEL
+ */
+struct drm_panthor_bo_set_label {
+	/** @handle: Handle of the buffer object to label. */
+	__u32 handle;
+
+	/** @size: Length of the label, including the NULL terminator. */
+	__u32 size;
+
+	/** @label: User pointer to a NULL-terminated string */
+	__u64 label;
+};
+
 /**
  * DRM_IOCTL_PANTHOR() - Build a Panthor IOCTL number
  * @__access: Access type. Must be R, W or RW.
@@ -XXX,XX +XXX,XX @@ enum {
 		DRM_IOCTL_PANTHOR(WR, TILER_HEAP_CREATE, tiler_heap_create),
 	DRM_IOCTL_PANTHOR_TILER_HEAP_DESTROY =
 		DRM_IOCTL_PANTHOR(WR, TILER_HEAP_DESTROY, tiler_heap_destroy),
+	DRM_IOCTL_PANTHOR_BO_SET_LABEL =
+		DRM_IOCTL_PANTHOR(WR, BO_SET_LABEL, bo_set_label),
 };
 
 #if defined(__cplusplus)
-- 
2.48.1

Kernel BO's aren't exposed to UM, so labelling them is the responsibility
of the driver itself. This kind of tagging will prove useful in further
commits when want to expose these objects through DebugFS.

Expand panthor_kernel_bo_create() interface to take a NULL-terminated
string. No bounds checking is done because all label strings are given
as statically-allocated literals, but if a more complex kernel BO naming
scheme with explicit memory allocation and formatting was desired in the
future, this would have to change.

Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
---
 drivers/gpu/drm/panthor/panthor_fw.c    | 8 +++++---
 drivers/gpu/drm/panthor/panthor_gem.c   | 3 ++-
 drivers/gpu/drm/panthor/panthor_gem.h   | 2 +-
 drivers/gpu/drm/panthor/panthor_heap.c  | 6 ++++--
 drivers/gpu/drm/panthor/panthor_sched.c | 9 ++++++---
 5 files changed, 18 insertions(+), 10 deletions(-)

diff --git a/drivers/gpu/drm/panthor/panthor_fw.c b/drivers/gpu/drm/panthor/panthor_fw.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_fw.c
+++ b/drivers/gpu/drm/panthor/panthor_fw.c
@@ -XXX,XX +XXX,XX @@ panthor_fw_alloc_queue_iface_mem(struct panthor_device *ptdev,
 				       DRM_PANTHOR_BO_NO_MMAP,
 				       DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC |
 				       DRM_PANTHOR_VM_BIND_OP_MAP_UNCACHED,
-				       PANTHOR_VM_KERNEL_AUTO_VA);
+				       PANTHOR_VM_KERNEL_AUTO_VA,
+				       "Queue FW interface");
 	if (IS_ERR(mem))
 		return mem;
 
@@ -XXX,XX +XXX,XX @@ panthor_fw_alloc_suspend_buf_mem(struct panthor_device *ptdev, size_t size)
 	return panthor_kernel_bo_create(ptdev, panthor_fw_vm(ptdev), size,
 					DRM_PANTHOR_BO_NO_MMAP,
 					DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC,
-					PANTHOR_VM_KERNEL_AUTO_VA);
+					PANTHOR_VM_KERNEL_AUTO_VA,
+					"FW suspend buffer");
 }
 
 static int panthor_fw_load_section_entry(struct panthor_device *ptdev,
@@ -XXX,XX +XXX,XX @@ static int panthor_fw_load_section_entry(struct panthor_device *ptdev,
 		section->mem = panthor_kernel_bo_create(ptdev, panthor_fw_vm(ptdev),
 							section_size,
 							DRM_PANTHOR_BO_NO_MMAP,
-							vm_map_flags, va);
+							vm_map_flags, va, "FW Section");
 		if (IS_ERR(section->mem))
 			return PTR_ERR(section->mem);
 
diff --git a/drivers/gpu/drm/panthor/panthor_gem.c b/drivers/gpu/drm/panthor/panthor_gem.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.c
+++ b/drivers/gpu/drm/panthor/panthor_gem.c
@@ -XXX,XX +XXX,XX @@ void panthor_kernel_bo_destroy(struct panthor_kernel_bo *bo)
 struct panthor_kernel_bo *
 panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 			 size_t size, u32 bo_flags, u32 vm_map_flags,
-			 u64 gpu_va)
+			 u64 gpu_va, const char *name)
 {
 	struct drm_gem_shmem_object *obj;
 	struct panthor_kernel_bo *kbo;
@@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 	kbo->obj = &obj->base;
 	bo->flags = bo_flags;
 
+	panthor_gem_kernel_bo_set_label(kbo, name);
 	/* The system and GPU MMU page size might differ, which becomes a
 	 * problem for FW sections that need to be mapped at explicit address
 	 * since our PAGE_SIZE alignment might cover a VA range that's
diff --git a/drivers/gpu/drm/panthor/panthor_gem.h b/drivers/gpu/drm/panthor/panthor_gem.h
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.h
+++ b/drivers/gpu/drm/panthor/panthor_gem.h
@@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_vunmap(struct panthor_kernel_bo *bo)
 struct panthor_kernel_bo *
 panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 			 size_t size, u32 bo_flags, u32 vm_map_flags,
-			 u64 gpu_va);
+			 u64 gpu_va, const char *name);
 
 void panthor_kernel_bo_destroy(struct panthor_kernel_bo *bo);
 
diff --git a/drivers/gpu/drm/panthor/panthor_heap.c b/drivers/gpu/drm/panthor/panthor_heap.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_heap.c
+++ b/drivers/gpu/drm/panthor/panthor_heap.c
@@ -XXX,XX +XXX,XX @@ static int panthor_alloc_heap_chunk(struct panthor_device *ptdev,
 	chunk->bo = panthor_kernel_bo_create(ptdev, vm, heap->chunk_size,
 					     DRM_PANTHOR_BO_NO_MMAP,
 					     DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC,
-					     PANTHOR_VM_KERNEL_AUTO_VA);
+					     PANTHOR_VM_KERNEL_AUTO_VA,
+					     "Tiler heap chunk");
 	if (IS_ERR(chunk->bo)) {
 		ret = PTR_ERR(chunk->bo);
 		goto err_free_chunk;
@@ -XXX,XX +XXX,XX @@ panthor_heap_pool_create(struct panthor_device *ptdev, struct panthor_vm *vm)
 	pool->gpu_contexts = panthor_kernel_bo_create(ptdev, vm, bosize,
 						      DRM_PANTHOR_BO_NO_MMAP,
 						      DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC,
-						      PANTHOR_VM_KERNEL_AUTO_VA);
+						      PANTHOR_VM_KERNEL_AUTO_VA,
+						      "Heap pool");
 	if (IS_ERR(pool->gpu_contexts)) {
 		ret = PTR_ERR(pool->gpu_contexts);
 		goto err_destroy_pool;
diff --git a/drivers/gpu/drm/panthor/panthor_sched.c b/drivers/gpu/drm/panthor/panthor_sched.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_sched.c
+++ b/drivers/gpu/drm/panthor/panthor_sched.c
@@ -XXX,XX +XXX,XX @@ group_create_queue(struct panthor_group *group,
 						  DRM_PANTHOR_BO_NO_MMAP,
 						  DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC |
 						  DRM_PANTHOR_VM_BIND_OP_MAP_UNCACHED,
-						  PANTHOR_VM_KERNEL_AUTO_VA);
+						  PANTHOR_VM_KERNEL_AUTO_VA,
+						  "Ring buffer");
 	if (IS_ERR(queue->ringbuf)) {
 		ret = PTR_ERR(queue->ringbuf);
 		goto err_free_queue;
@@ -XXX,XX +XXX,XX @@ group_create_queue(struct panthor_group *group,
 					 DRM_PANTHOR_BO_NO_MMAP,
 					 DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC |
 					 DRM_PANTHOR_VM_BIND_OP_MAP_UNCACHED,
-					 PANTHOR_VM_KERNEL_AUTO_VA);
+					 PANTHOR_VM_KERNEL_AUTO_VA,
+					 "fdinfo slots");
 
 	if (IS_ERR(queue->profiling.slots)) {
 		ret = PTR_ERR(queue->profiling.slots);
@@ -XXX,XX +XXX,XX @@ int panthor_group_create(struct panthor_file *pfile,
 						   DRM_PANTHOR_BO_NO_MMAP,
 						   DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC |
 						   DRM_PANTHOR_VM_BIND_OP_MAP_UNCACHED,
-						   PANTHOR_VM_KERNEL_AUTO_VA);
+						   PANTHOR_VM_KERNEL_AUTO_VA,
+						   "Group sync objects");
 	if (IS_ERR(group->syncobjs)) {
 		ret = PTR_ERR(group->syncobjs);
 		goto err_put_group;
-- 
2.48.1

Add a device DebugFS file that displays a complete list of all the DRM
GEM objects that are exposed to UM through a DRM handle.

Since leaking object identifiers that might belong to a different NS is
inadmissible, this functionality is only made available in debug builds
with DEBUGFS support enabled.

File format is that of a table, with each entry displaying a variety of
fields with information about each GEM object.

Each GEM object entry in the file displays the following information
fields: Client PID, BO's global name, reference count, BO virtual size,
BO resize size, VM address in its DRM-managed range, BO label and a flag
bitmask.

There's also a kflags field for the type of BO. Bit 0 tells us whether
it's a kernel BO, and bit 1 means the BO is mapped onto the FW's address
space.

Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
---
 drivers/gpu/drm/panthor/panthor_device.c |   5 +
 drivers/gpu/drm/panthor/panthor_device.h |  11 ++
 drivers/gpu/drm/panthor/panthor_drv.c    |  26 ++++
 drivers/gpu/drm/panthor/panthor_gem.c    | 149 +++++++++++++++++++++++
 drivers/gpu/drm/panthor/panthor_gem.h    |  35 ++++++
 5 files changed, 226 insertions(+)

diff --git a/drivers/gpu/drm/panthor/panthor_device.c b/drivers/gpu/drm/panthor/panthor_device.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_device.c
+++ b/drivers/gpu/drm/panthor/panthor_device.c
@@ -XXX,XX +XXX,XX @@ int panthor_device_init(struct panthor_device *ptdev)
 	if (ret)
 		return ret;
 
+#ifdef CONFIG_DEBUG_FS
+	drmm_mutex_init(&ptdev->base, &ptdev->gems.lock);
+	INIT_LIST_HEAD(&ptdev->gems.node);
+#endif
+
 	atomic_set(&ptdev->pm.state, PANTHOR_DEVICE_PM_STATE_SUSPENDED);
 	p = alloc_page(GFP_KERNEL | __GFP_ZERO);
 	if (!p)
diff --git a/drivers/gpu/drm/panthor/panthor_device.h b/drivers/gpu/drm/panthor/panthor_device.h
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_device.h
+++ b/drivers/gpu/drm/panthor/panthor_device.h
@@ -XXX,XX +XXX,XX @@ struct panthor_device {
 
 	/** @fast_rate: Maximum device clock frequency. Set by DVFS */
 	unsigned long fast_rate;
+
+#ifdef CONFIG_DEBUG_FS
+	/** @gems: Device-wide list of GEM objects owned by at least one file. */
+	struct {
+		/** @gems.lock: Protects the device-wide list of GEM objects. */
+		struct mutex lock;
+
+		/** @node: Used to keep track of all the device's DRM objects */
+		struct list_head node;
+	} gems;
+#endif
 };
 
 struct panthor_gpu_usage {
diff --git a/drivers/gpu/drm/panthor/panthor_drv.c b/drivers/gpu/drm/panthor/panthor_drv.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_drv.c
+++ b/drivers/gpu/drm/panthor/panthor_drv.c
@@ -XXX,XX +XXX,XX @@ static const struct file_operations panthor_drm_driver_fops = {
 };
 
 #ifdef CONFIG_DEBUG_FS
+static int panthor_gems_show(struct seq_file *m, void *data)
+{
+	struct drm_info_node *node = m->private;
+	struct drm_device *dev = node->minor->dev;
+	struct panthor_device *ptdev = container_of(dev, struct panthor_device, base);
+
+	panthor_gem_debugfs_print_bos(ptdev, m);
+
+	return 0;
+}
+
+
+static struct drm_info_list panthor_debugfs_list[] = {
+	{"gems", panthor_gems_show, 0, NULL},
+};
+
+static int panthor_gems_debugfs_init(struct drm_minor *minor)
+{
+	drm_debugfs_create_files(panthor_debugfs_list,
+				 ARRAY_SIZE(panthor_debugfs_list),
+				 minor->debugfs_root, minor);
+
+	return 0;
+}
+
 static void panthor_debugfs_init(struct drm_minor *minor)
 {
 	panthor_mmu_debugfs_init(minor);
+	panthor_gems_debugfs_init(minor);
 }
 #endif
 
diff --git a/drivers/gpu/drm/panthor/panthor_gem.c b/drivers/gpu/drm/panthor/panthor_gem.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.c
+++ b/drivers/gpu/drm/panthor/panthor_gem.c
@@ -XXX,XX +XXX,XX @@
 /* Copyright 2019 Linaro, Ltd, Rob Herring <robh@kernel.org> */
 /* Copyright 2023 Collabora ltd. */
 
+#include <linux/cleanup.h>
 #include <linux/dma-buf.h>
 #include <linux/dma-mapping.h>
 #include <linux/err.h>
@@ -XXX,XX +XXX,XX @@
 #include <drm/panthor_drm.h>
 
 #include "panthor_device.h"
+#include "panthor_fw.h"
 #include "panthor_gem.h"
 #include "panthor_mmu.h"
 
+#ifdef CONFIG_DEBUG_FS
+static void panthor_gem_debugfs_bo_init(struct panthor_gem_object *bo, u32 type_mask)
+{
+	INIT_LIST_HEAD(&bo->debugfs.node);
+
+	if (!(type_mask & PANTHOR_BO_FW_MAPPED)) {
+		bo->debugfs.creator.tgid = current->group_leader->pid;
+		get_task_comm(bo->debugfs.creator.process_name, current->group_leader);
+	} else {
+		bo->debugfs.creator.tgid = 0;
+		snprintf(bo->debugfs.creator.process_name,
+			 sizeof(bo->debugfs.creator.process_name),
+			 "kernel");
+	}
+
+	bo->debugfs.bo_mask = type_mask;
+}
+
+static void panthor_gem_debugfs_bo_add(struct panthor_gem_object *bo, u32 type_mask)
+{
+	struct panthor_device *ptdev =  container_of(bo->base.base.dev,
+						     struct panthor_device, base);
+
+	panthor_gem_debugfs_bo_init(bo, type_mask);
+
+	mutex_lock(&ptdev->gems.lock);
+	list_add_tail(&bo->debugfs.node, &ptdev->gems.node);
+	mutex_unlock(&ptdev->gems.lock);
+}
+
+static void panthor_gem_debugfs_bo_rm(struct panthor_gem_object *bo)
+{
+	struct panthor_device *ptdev = container_of(bo->base.base.dev,
+						    struct panthor_device, base);
+
+	if (list_empty(&bo->debugfs.node))
+		return;
+
+	mutex_lock(&ptdev->gems.lock);
+	list_del_init(&bo->debugfs.node);
+	mutex_unlock(&ptdev->gems.lock);
+}
+
+#else
+static void panthor_gem_debugfs_bo_add(struct panthor_gem_object *bo, u32 type_mask) {}
+static void panthor_gem_debugfs_bo_rm(struct panthor_gem_object *bo) {}
+#endif
+
 static void panthor_gem_free_object(struct drm_gem_object *obj)
 {
 	struct panthor_gem_object *bo = to_panthor_bo(obj);
 	struct drm_gem_object *vm_root_gem = bo->exclusive_vm_root_gem;
 
+	panthor_gem_debugfs_bo_rm(bo);
+
 	/*
 	 * Label might have been allocated with kstrdup_const(),
 	 * we need to take that into account when freeing the memory
@@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 	struct drm_gem_shmem_object *obj;
 	struct panthor_kernel_bo *kbo;
 	struct panthor_gem_object *bo;
+	u32 type_mask = PANTHOR_BO_KERNEL;
 	int ret;
 
 	if (drm_WARN_ON(&ptdev->base, !vm))
@@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 	kbo->obj = &obj->base;
 	bo->flags = bo_flags;
 
+	if (vm == panthor_fw_vm(ptdev))
+		type_mask |= PANTHOR_BO_FW_MAPPED;
+
 	panthor_gem_kernel_bo_set_label(kbo, name);
+	panthor_gem_debugfs_bo_add(to_panthor_bo(kbo->obj), type_mask);
+
 	/* The system and GPU MMU page size might differ, which becomes a
 	 * problem for FW sections that need to be mapped at explicit address
 	 * since our PAGE_SIZE alignment might cover a VA range that's
@@ -XXX,XX +XXX,XX @@ panthor_gem_create_with_handle(struct drm_file *file,
 	/* drop reference from allocate - handle holds it now. */
 	drm_gem_object_put(&shmem->base);
 
+	panthor_gem_debugfs_bo_add(bo, 0);
+
 	return ret;
 }
 
@@ -XXX,XX +XXX,XX @@ panthor_gem_kernel_bo_set_label(struct panthor_kernel_bo *bo, const char *label)
 
 	panthor_gem_bo_set_label(bo->obj, kstrdup_const(str, GFP_KERNEL));
 }
+
+#ifdef CONFIG_DEBUG_FS
+static bool panfrost_gem_print_flag(const char *name,
+				    bool is_set,
+				    bool other_flags_printed,
+				    struct seq_file *m)
+{
+	if (is_set)
+		seq_printf(m, "%s%s", other_flags_printed ? "," : "", name);
+
+	return is_set | other_flags_printed;
+}
+
+struct gem_size_totals {
+	size_t size;
+	size_t resident;
+	size_t reclaimable;
+};
+
+static void panthor_gem_debugfs_bo_print(struct panthor_gem_object *bo,
+					 struct seq_file *m,
+					 struct gem_size_totals *totals)
+{
+	unsigned int refcount = kref_read(&bo->base.base.refcount);
+	char creator_info[32] = {};
+	bool has_flags = false;
+	size_t resident_size;
+
+	/* Skip BOs being destroyed. */
+	if (!refcount)
+		return;
+
+	resident_size = bo->base.pages != NULL ? bo->base.base.size : 0;
+
+	snprintf(creator_info, sizeof(creator_info),
+		 "%s/%d", bo->debugfs.creator.process_name, bo->debugfs.creator.tgid);
+	seq_printf(m, "%-32s%-16d%-16d%-16zd%-16zd%-16lx",
+		   creator_info,
+		   bo->base.base.name,
+		   refcount,
+		   bo->base.base.size,
+		   resident_size,
+		   drm_vma_node_start(&bo->base.base.vma_node));
+
+	seq_puts(m, "(");
+	has_flags = panfrost_gem_print_flag("imported", bo->base.base.import_attach != NULL,
+					    has_flags, m);
+	has_flags = panfrost_gem_print_flag("exported", bo->base.base.dma_buf != NULL,
+					    has_flags, m);
+	if (bo->base.madv < 0)
+		has_flags = panfrost_gem_print_flag("purged", true, has_flags, m);
+	else if (bo->base.madv > 0)
+		has_flags = panfrost_gem_print_flag("purgeable", true, has_flags, m);
+	if (!has_flags)
+		seq_puts(m, "none");
+	seq_puts(m, ")");
+
+	seq_printf(m, "%-6s0x%-2x", "", bo->debugfs.bo_mask);
+
+	mutex_lock(&bo->label.lock);
+	seq_printf(m, "%-6s%-60s", "", bo->label.str ? : NULL);
+	mutex_unlock(&bo->label.lock);
+	seq_puts(m, "\n");
+
+	totals->size += bo->base.base.size;
+	totals->resident += resident_size;
+	if (bo->base.madv > 0)
+		totals->reclaimable += resident_size;
+}
+
+void panthor_gem_debugfs_print_bos(struct panthor_device *ptdev,
+				   struct seq_file *m)
+{
+	struct gem_size_totals totals = {0};
+	struct panthor_gem_object *bo;
+
+	seq_puts(m, "created-by                      global-name     refcount        size            resident-size   file-offset     flags     kflags     label\n");
+	seq_puts(m, "------------------------------------------------------------------------------------------------------------------------------------------------\n");
+
+	scoped_guard(mutex, &ptdev->gems.lock) {
+		list_for_each_entry(bo, &ptdev->gems.node, debugfs.node)
+			panthor_gem_debugfs_bo_print(bo, m, &totals);
+	}
+
+	seq_puts(m, "==========================================================================================================================================================\n");
+	seq_printf(m, "Total size: %zd, Total resident: %zd, Total reclaimable: %zd\n",
+		   totals.size, totals.resident, totals.reclaimable);
+}
+#endif
diff --git a/drivers/gpu/drm/panthor/panthor_gem.h b/drivers/gpu/drm/panthor/panthor_gem.h
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.h
+++ b/drivers/gpu/drm/panthor/panthor_gem.h
@@ -XXX,XX +XXX,XX @@ struct panthor_vm;
 
 #define PANTHOR_BO_LABEL_MAXLEN	PAGE_SIZE
 
+#define PANTHOR_BO_KERNEL	BIT(0)
+#define PANTHOR_BO_FW_MAPPED	BIT(1)
+
+/**
+ * struct panthor_gem_debugfs - GEM object's DebugFS list information
+ */
+struct panthor_gem_debugfs {
+	/**
+	 * @node: Node used to insert the object in the device-wide list of
+	 * GEM objects, to display information about it through a DebugFS file.
+	 */
+	struct list_head node;
+
+	/** @creator: Information about the UM process which created the GEM. */
+	struct {
+		/** @creator.process_name: Group leader name in owning thread's process */
+		char process_name[TASK_COMM_LEN];
+
+		/** @creator.tgid: PID of the thread's group leader within its process */
+		pid_t tgid;
+	} creator;
+
+	/** @bo_mask: Bitmask encoding BO type as {USER, KERNEL} x {GPU, FW} */
+	u32 bo_mask;
+};
+
 /**
  * struct panthor_gem_object - Driver specific GEM object.
  */
@@ -XXX,XX +XXX,XX @@ struct panthor_gem_object {
 		/** @lock.str: Protects access to the @label.str field. */
 		struct mutex lock;
 	} label;
+
+#ifdef CONFIG_DEBUG_FS
+	struct panthor_gem_debugfs debugfs;
+#endif
 };
 
 /**
@@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 
 void panthor_kernel_bo_destroy(struct panthor_kernel_bo *bo);
 
+#ifdef CONFIG_DEBUG_FS
+void panthor_gem_debugfs_print_bos(struct panthor_device *pfdev,
+				   struct seq_file *m);
+#endif
+
 #endif /* __PANTHOR_GEM_H__ */
-- 
2.48.1

Discussion of previous revision of this patch series can be found at:
https://lore.kernel.org/dri-devel/20250402115432.1469703-1-adrian.larumbe@collabora.com/

Changelog:
v5:
 - Kept case and naming of kernel BO's consistent
 - Increased the driver minor after new ioctl
 - Now adds BO to debugfs GEMs list at GEM object creation time
 - No longer try to hide BO creator's name when it's a workqueue or modprobe
 - Reworked the procedure for printing GEM state and kernel BO flags
 - Turned kernel BO flags and GEM state flags into bit enums
 - Wait until BO state is marked as initialied for debugfs display

v4:
 - Labelled all kernel BO's, not just heap chunks.
 - Refactored DebugGFs GEMs list handling functions
 - Added debugfs GEMS node mask to tell different kinds of BO's

drivers/gpu/drm/panthor/panthor_device.c |   5 +
 drivers/gpu/drm/panthor/panthor_device.h |  11 ++
 drivers/gpu/drm/panthor/panthor_drv.c    |  68 +++++++-
 drivers/gpu/drm/panthor/panthor_fw.c     |   8 +-
 drivers/gpu/drm/panthor/panthor_gem.c    | 210 ++++++++++++++++++++++-
 drivers/gpu/drm/panthor/panthor_gem.h    |  86 +++++++++-
 drivers/gpu/drm/panthor/panthor_heap.c   |   6 +-
 drivers/gpu/drm/panthor/panthor_sched.c  |   9 +-
 include/uapi/drm/panthor_drm.h           |  19 ++
 9 files changed, 411 insertions(+), 11 deletions(-)

--
2.48.1

Add a new character string Panthor BO field, and a function that allows
setting it from within the driver.

Driver takes care of freeing the string when it's replaced or no longer
needed at object destruction time, but allocating it is the responsibility
of callers.

Allow UM to label a BO for which it possesses a DRM handle.

Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
Reviewed-by: Liviu Dudau <liviu.dudau@arm.com>
---
 drivers/gpu/drm/panthor/panthor_drv.c | 42 ++++++++++++++++++++++++++-
 drivers/gpu/drm/panthor/panthor_gem.h |  2 ++
 include/uapi/drm/panthor_drm.h        | 19 ++++++++++++
 3 files changed, 62 insertions(+), 1 deletion(-)

diff --git a/drivers/gpu/drm/panthor/panthor_drv.c b/drivers/gpu/drm/panthor/panthor_drv.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_drv.c
+++ b/drivers/gpu/drm/panthor/panthor_drv.c
@@ -XXX,XX +XXX,XX @@ static int panthor_ioctl_vm_get_state(struct drm_device *ddev, void *data,
 	return 0;
 }
 
+static int panthor_ioctl_bo_set_label(struct drm_device *ddev, void *data,
+				  struct drm_file *file)
+{
+	struct drm_panthor_bo_set_label *args = data;
+	struct drm_gem_object *obj;
+	const char *label;
+	int ret = 0;
+
+	obj = drm_gem_object_lookup(file, args->handle);
+	if (!obj)
+		return -ENOENT;
+
+	if (args->size && args->label) {
+		if (args->size > PANTHOR_BO_LABEL_MAXLEN) {
+			ret = -E2BIG;
+			goto err_label;
+		}
+
+		label = strndup_user(u64_to_user_ptr(args->label), args->size);
+		if (IS_ERR(label)) {
+			ret = PTR_ERR(label);
+			goto err_label;
+		}
+	} else if (args->size && !args->label) {
+		ret = -EINVAL;
+		goto err_label;
+	} else {
+		label = NULL;
+	}
+
+	panthor_gem_bo_set_label(obj, label);
+
+err_label:
+	drm_gem_object_put(obj);
+
+	return ret;
+}
+
 static int
 panthor_open(struct drm_device *ddev, struct drm_file *file)
 {
@@ -XXX,XX +XXX,XX @@ static const struct drm_ioctl_desc panthor_drm_driver_ioctls[] = {
 	PANTHOR_IOCTL(TILER_HEAP_CREATE, tiler_heap_create, DRM_RENDER_ALLOW),
 	PANTHOR_IOCTL(TILER_HEAP_DESTROY, tiler_heap_destroy, DRM_RENDER_ALLOW),
 	PANTHOR_IOCTL(GROUP_SUBMIT, group_submit, DRM_RENDER_ALLOW),
+	PANTHOR_IOCTL(BO_SET_LABEL, bo_set_label, DRM_RENDER_ALLOW),
 };
 
 static int panthor_mmap(struct file *filp, struct vm_area_struct *vma)
@@ -XXX,XX +XXX,XX @@ static void panthor_debugfs_init(struct drm_minor *minor)
  * - 1.2 - adds DEV_QUERY_GROUP_PRIORITIES_INFO query
  *       - adds PANTHOR_GROUP_PRIORITY_REALTIME priority
  * - 1.3 - adds DRM_PANTHOR_GROUP_STATE_INNOCENT flag
+ * - 1.4 - adds DRM_IOCTL_PANTHOR_BO_SET_LABEL ioctl
  */
 static const struct drm_driver panthor_drm_driver = {
 	.driver_features = DRIVER_RENDER | DRIVER_GEM | DRIVER_SYNCOBJ |
@@ -XXX,XX +XXX,XX @@ static const struct drm_driver panthor_drm_driver = {
 	.name = "panthor",
 	.desc = "Panthor DRM driver",
 	.major = 1,
-	.minor = 3,
+	.minor = 4,
 
 	.gem_create_object = panthor_gem_create_object,
 	.gem_prime_import_sg_table = drm_gem_shmem_prime_import_sg_table,
diff --git a/drivers/gpu/drm/panthor/panthor_gem.h b/drivers/gpu/drm/panthor/panthor_gem.h
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.h
+++ b/drivers/gpu/drm/panthor/panthor_gem.h
@@ -XXX,XX +XXX,XX @@
 
 struct panthor_vm;
 
+#define PANTHOR_BO_LABEL_MAXLEN	PAGE_SIZE
+
 /**
  * struct panthor_gem_object - Driver specific GEM object.
  */
diff --git a/include/uapi/drm/panthor_drm.h b/include/uapi/drm/panthor_drm.h
index XXXXXXX..XXXXXXX 100644
--- a/include/uapi/drm/panthor_drm.h
+++ b/include/uapi/drm/panthor_drm.h
@@ -XXX,XX +XXX,XX @@ enum drm_panthor_ioctl_id {
 
 	/** @DRM_PANTHOR_TILER_HEAP_DESTROY: Destroy a tiler heap. */
 	DRM_PANTHOR_TILER_HEAP_DESTROY,
+
+	/** @DRM_PANTHOR_BO_SET_LABEL: Label a BO. */
+	DRM_PANTHOR_BO_SET_LABEL,
 };
 
 /**
@@ -XXX,XX +XXX,XX @@ struct drm_panthor_tiler_heap_destroy {
 	__u32 pad;
 };
 
+/**
+ * struct drm_panthor_bo_set_label - Arguments passed to DRM_IOCTL_PANTHOR_BO_SET_LABEL
+ */
+struct drm_panthor_bo_set_label {
+	/** @handle: Handle of the buffer object to label. */
+	__u32 handle;
+
+	/** @size: Length of the label, including the NULL terminator. */
+	__u32 size;
+
+	/** @label: User pointer to a NULL-terminated string */
+	__u64 label;
+};
+
 /**
  * DRM_IOCTL_PANTHOR() - Build a Panthor IOCTL number
  * @__access: Access type. Must be R, W or RW.
@@ -XXX,XX +XXX,XX @@ enum {
 		DRM_IOCTL_PANTHOR(WR, TILER_HEAP_CREATE, tiler_heap_create),
 	DRM_IOCTL_PANTHOR_TILER_HEAP_DESTROY =
 		DRM_IOCTL_PANTHOR(WR, TILER_HEAP_DESTROY, tiler_heap_destroy),
+	DRM_IOCTL_PANTHOR_BO_SET_LABEL =
+		DRM_IOCTL_PANTHOR(WR, BO_SET_LABEL, bo_set_label),
 };
 
 #if defined(__cplusplus)
-- 
2.48.1

Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
---
 drivers/gpu/drm/panthor/panthor_fw.c    | 8 +++++---
 drivers/gpu/drm/panthor/panthor_gem.c   | 4 +++-
 drivers/gpu/drm/panthor/panthor_gem.h   | 2 +-
 drivers/gpu/drm/panthor/panthor_heap.c  | 6 ++++--
 drivers/gpu/drm/panthor/panthor_sched.c | 9 ++++++---
 5 files changed, 19 insertions(+), 10 deletions(-)

diff --git a/drivers/gpu/drm/panthor/panthor_fw.c b/drivers/gpu/drm/panthor/panthor_fw.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_fw.c
+++ b/drivers/gpu/drm/panthor/panthor_fw.c
@@ -XXX,XX +XXX,XX @@ panthor_fw_alloc_queue_iface_mem(struct panthor_device *ptdev,
 				       DRM_PANTHOR_BO_NO_MMAP,
 				       DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC |
 				       DRM_PANTHOR_VM_BIND_OP_MAP_UNCACHED,
-				       PANTHOR_VM_KERNEL_AUTO_VA);
+				       PANTHOR_VM_KERNEL_AUTO_VA,
+				       "Queue FW interface");
 	if (IS_ERR(mem))
 		return mem;
 
@@ -XXX,XX +XXX,XX @@ panthor_fw_alloc_suspend_buf_mem(struct panthor_device *ptdev, size_t size)
 	return panthor_kernel_bo_create(ptdev, panthor_fw_vm(ptdev), size,
 					DRM_PANTHOR_BO_NO_MMAP,
 					DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC,
-					PANTHOR_VM_KERNEL_AUTO_VA);
+					PANTHOR_VM_KERNEL_AUTO_VA,
+					"FW suspend buffer");
 }
 
 static int panthor_fw_load_section_entry(struct panthor_device *ptdev,
@@ -XXX,XX +XXX,XX @@ static int panthor_fw_load_section_entry(struct panthor_device *ptdev,
 		section->mem = panthor_kernel_bo_create(ptdev, panthor_fw_vm(ptdev),
 							section_size,
 							DRM_PANTHOR_BO_NO_MMAP,
-							vm_map_flags, va);
+							vm_map_flags, va, "FW section");
 		if (IS_ERR(section->mem))
 			return PTR_ERR(section->mem);
 
diff --git a/drivers/gpu/drm/panthor/panthor_gem.c b/drivers/gpu/drm/panthor/panthor_gem.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.c
+++ b/drivers/gpu/drm/panthor/panthor_gem.c
@@ -XXX,XX +XXX,XX @@ void panthor_kernel_bo_destroy(struct panthor_kernel_bo *bo)
 struct panthor_kernel_bo *
 panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 			 size_t size, u32 bo_flags, u32 vm_map_flags,
-			 u64 gpu_va)
+			 u64 gpu_va, const char *name)
 {
 	struct drm_gem_shmem_object *obj;
 	struct panthor_kernel_bo *kbo;
@@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 	kbo->obj = &obj->base;
 	bo->flags = bo_flags;
 
+	panthor_gem_kernel_bo_set_label(kbo, name);
+
 	/* The system and GPU MMU page size might differ, which becomes a
 	 * problem for FW sections that need to be mapped at explicit address
 	 * since our PAGE_SIZE alignment might cover a VA range that's
diff --git a/drivers/gpu/drm/panthor/panthor_gem.h b/drivers/gpu/drm/panthor/panthor_gem.h
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.h
+++ b/drivers/gpu/drm/panthor/panthor_gem.h
@@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_vunmap(struct panthor_kernel_bo *bo)
 struct panthor_kernel_bo *
 panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 			 size_t size, u32 bo_flags, u32 vm_map_flags,
-			 u64 gpu_va);
+			 u64 gpu_va, const char *name);
 
 void panthor_kernel_bo_destroy(struct panthor_kernel_bo *bo);
 
diff --git a/drivers/gpu/drm/panthor/panthor_heap.c b/drivers/gpu/drm/panthor/panthor_heap.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_heap.c
+++ b/drivers/gpu/drm/panthor/panthor_heap.c
@@ -XXX,XX +XXX,XX @@ static int panthor_alloc_heap_chunk(struct panthor_device *ptdev,
 	chunk->bo = panthor_kernel_bo_create(ptdev, vm, heap->chunk_size,
 					     DRM_PANTHOR_BO_NO_MMAP,
 					     DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC,
-					     PANTHOR_VM_KERNEL_AUTO_VA);
+					     PANTHOR_VM_KERNEL_AUTO_VA,
+					     "Tiler heap chunk");
 	if (IS_ERR(chunk->bo)) {
 		ret = PTR_ERR(chunk->bo);
 		goto err_free_chunk;
@@ -XXX,XX +XXX,XX @@ panthor_heap_pool_create(struct panthor_device *ptdev, struct panthor_vm *vm)
 	pool->gpu_contexts = panthor_kernel_bo_create(ptdev, vm, bosize,
 						      DRM_PANTHOR_BO_NO_MMAP,
 						      DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC,
-						      PANTHOR_VM_KERNEL_AUTO_VA);
+						      PANTHOR_VM_KERNEL_AUTO_VA,
+						      "Heap pool");
 	if (IS_ERR(pool->gpu_contexts)) {
 		ret = PTR_ERR(pool->gpu_contexts);
 		goto err_destroy_pool;
diff --git a/drivers/gpu/drm/panthor/panthor_sched.c b/drivers/gpu/drm/panthor/panthor_sched.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_sched.c
+++ b/drivers/gpu/drm/panthor/panthor_sched.c
@@ -XXX,XX +XXX,XX @@ group_create_queue(struct panthor_group *group,
 						  DRM_PANTHOR_BO_NO_MMAP,
 						  DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC |
 						  DRM_PANTHOR_VM_BIND_OP_MAP_UNCACHED,
-						  PANTHOR_VM_KERNEL_AUTO_VA);
+						  PANTHOR_VM_KERNEL_AUTO_VA,
+						  "Ring buffer");
 	if (IS_ERR(queue->ringbuf)) {
 		ret = PTR_ERR(queue->ringbuf);
 		goto err_free_queue;
@@ -XXX,XX +XXX,XX @@ group_create_queue(struct panthor_group *group,
 					 DRM_PANTHOR_BO_NO_MMAP,
 					 DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC |
 					 DRM_PANTHOR_VM_BIND_OP_MAP_UNCACHED,
-					 PANTHOR_VM_KERNEL_AUTO_VA);
+					 PANTHOR_VM_KERNEL_AUTO_VA,
+					 "Group job stats");
 
 	if (IS_ERR(queue->profiling.slots)) {
 		ret = PTR_ERR(queue->profiling.slots);
@@ -XXX,XX +XXX,XX @@ int panthor_group_create(struct panthor_file *pfile,
 						   DRM_PANTHOR_BO_NO_MMAP,
 						   DRM_PANTHOR_VM_BIND_OP_MAP_NOEXEC |
 						   DRM_PANTHOR_VM_BIND_OP_MAP_UNCACHED,
-						   PANTHOR_VM_KERNEL_AUTO_VA);
+						   PANTHOR_VM_KERNEL_AUTO_VA,
+						   "Group sync objects");
 	if (IS_ERR(group->syncobjs)) {
 		ret = PTR_ERR(group->syncobjs);
 		goto err_put_group;
-- 
2.48.1

Add a device DebugFS file that displays a complete list of all the DRM
GEM objects that are exposed to UM through a DRM handle.

Since leaking object identifiers that might belong to a different NS is
inadmissible, this functionality is only made available in debug builds
with DEBUGFS support enabled.

File format is that of a table, with each entry displaying a variety of
fields with information about each GEM object.

There's also a kflags field for the type of BO, which tells us whether
it's a kernel BO and/or mapped onto the FW's address space.

Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
---
 drivers/gpu/drm/panthor/panthor_device.c |   5 +
 drivers/gpu/drm/panthor/panthor_device.h |  11 ++
 drivers/gpu/drm/panthor/panthor_drv.c    |  26 ++++
 drivers/gpu/drm/panthor/panthor_gem.c    | 168 +++++++++++++++++++++++
 drivers/gpu/drm/panthor/panthor_gem.h    |  65 +++++++++
 5 files changed, 275 insertions(+)

diff --git a/drivers/gpu/drm/panthor/panthor_device.c b/drivers/gpu/drm/panthor/panthor_device.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_device.c
+++ b/drivers/gpu/drm/panthor/panthor_device.c
@@ -XXX,XX +XXX,XX @@ int panthor_device_init(struct panthor_device *ptdev)
 	if (ret)
 		return ret;
 
+#ifdef CONFIG_DEBUG_FS
+	drmm_mutex_init(&ptdev->base, &ptdev->gems.lock);
+	INIT_LIST_HEAD(&ptdev->gems.node);
+#endif
+
 	atomic_set(&ptdev->pm.state, PANTHOR_DEVICE_PM_STATE_SUSPENDED);
 	p = alloc_page(GFP_KERNEL | __GFP_ZERO);
 	if (!p)
diff --git a/drivers/gpu/drm/panthor/panthor_device.h b/drivers/gpu/drm/panthor/panthor_device.h
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_device.h
+++ b/drivers/gpu/drm/panthor/panthor_device.h
@@ -XXX,XX +XXX,XX @@ struct panthor_device {
 
 	/** @fast_rate: Maximum device clock frequency. Set by DVFS */
 	unsigned long fast_rate;
+
+#ifdef CONFIG_DEBUG_FS
+	/** @gems: Device-wide list of GEM objects owned by at least one file. */
+	struct {
+		/** @gems.lock: Protects the device-wide list of GEM objects. */
+		struct mutex lock;
+
+		/** @node: Used to keep track of all the device's DRM objects */
+		struct list_head node;
+	} gems;
+#endif
 };
 
 struct panthor_gpu_usage {
diff --git a/drivers/gpu/drm/panthor/panthor_drv.c b/drivers/gpu/drm/panthor/panthor_drv.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_drv.c
+++ b/drivers/gpu/drm/panthor/panthor_drv.c
@@ -XXX,XX +XXX,XX @@ static const struct file_operations panthor_drm_driver_fops = {
 };
 
 #ifdef CONFIG_DEBUG_FS
+static int panthor_gems_show(struct seq_file *m, void *data)
+{
+	struct drm_info_node *node = m->private;
+	struct drm_device *dev = node->minor->dev;
+	struct panthor_device *ptdev = container_of(dev, struct panthor_device, base);
+
+	panthor_gem_debugfs_print_bos(ptdev, m);
+
+	return 0;
+}
+
+
+static struct drm_info_list panthor_debugfs_list[] = {
+	{"gems", panthor_gems_show, 0, NULL},
+};
+
+static int panthor_gems_debugfs_init(struct drm_minor *minor)
+{
+	drm_debugfs_create_files(panthor_debugfs_list,
+				 ARRAY_SIZE(panthor_debugfs_list),
+				 minor->debugfs_root, minor);
+
+	return 0;
+}
+
 static void panthor_debugfs_init(struct drm_minor *minor)
 {
 	panthor_mmu_debugfs_init(minor);
+	panthor_gems_debugfs_init(minor);
 }
 #endif
 
diff --git a/drivers/gpu/drm/panthor/panthor_gem.c b/drivers/gpu/drm/panthor/panthor_gem.c
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.c
+++ b/drivers/gpu/drm/panthor/panthor_gem.c
@@ -XXX,XX +XXX,XX @@
 /* Copyright 2019 Linaro, Ltd, Rob Herring <robh@kernel.org> */
 /* Copyright 2023 Collabora ltd. */
 
+#include <linux/cleanup.h>
 #include <linux/dma-buf.h>
 #include <linux/dma-mapping.h>
 #include <linux/err.h>
@@ -XXX,XX +XXX,XX @@
 #include <drm/panthor_drm.h>
 
 #include "panthor_device.h"
+#include "panthor_fw.h"
 #include "panthor_gem.h"
 #include "panthor_mmu.h"
 
+#ifdef CONFIG_DEBUG_FS
+static void panthor_gem_debugfs_bo_add(struct panthor_device *ptdev,
+				       struct panthor_gem_object *bo)
+{
+	INIT_LIST_HEAD(&bo->debugfs.node);
+
+	bo->debugfs.creator.tgid = current->group_leader->pid;
+	get_task_comm(bo->debugfs.creator.process_name, current->group_leader);
+
+	mutex_lock(&ptdev->gems.lock);
+	list_add_tail(&bo->debugfs.node, &ptdev->gems.node);
+	mutex_unlock(&ptdev->gems.lock);
+}
+
+static void panthor_gem_debugfs_bo_rm(struct panthor_gem_object *bo)
+{
+	struct panthor_device *ptdev = container_of(bo->base.base.dev,
+						    struct panthor_device, base);
+
+	if (list_empty(&bo->debugfs.node))
+		return;
+
+	mutex_lock(&ptdev->gems.lock);
+	list_del_init(&bo->debugfs.node);
+	mutex_unlock(&ptdev->gems.lock);
+}
+
+#else
+static void panthor_gem_debugfs_bo_add(struct panthor_device *ptdev,
+				       struct panthor_gem_object *bo)
+{}
+static void panthor_gem_debugfs_bo_rm(struct panthor_gem_object *bo) {}
+#endif
+
 static void panthor_gem_free_object(struct drm_gem_object *obj)
 {
 	struct panthor_gem_object *bo = to_panthor_bo(obj);
 	struct drm_gem_object *vm_root_gem = bo->exclusive_vm_root_gem;
 
+	panthor_gem_debugfs_bo_rm(bo);
+
 	/*
 	 * Label might have been allocated with kstrdup_const(),
 	 * we need to take that into account when freeing the memory
@@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 	struct drm_gem_shmem_object *obj;
 	struct panthor_kernel_bo *kbo;
 	struct panthor_gem_object *bo;
+	u32 debug_flags = PANTHOR_DEBUGFS_BO_FLAGS_KERNEL;
 	int ret;
 
 	if (drm_WARN_ON(&ptdev->base, !vm))
@@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 	kbo->obj = &obj->base;
 	bo->flags = bo_flags;
 
+	if (vm == panthor_fw_vm(ptdev))
+		debug_flags |= PANTHOR_DEBUGFS_BO_FW_FLAG_MAPPED;
+
 	panthor_gem_kernel_bo_set_label(kbo, name);
+	panthor_gem_debugfs_bo_set_mask(to_panthor_bo(kbo->obj), debug_flags);
 
 	/* The system and GPU MMU page size might differ, which becomes a
 	 * problem for FW sections that need to be mapped at explicit address
@@ -XXX,XX +XXX,XX @@ struct drm_gem_object *panthor_gem_create_object(struct drm_device *ddev, size_t
 	drm_gem_gpuva_set_lock(&obj->base.base, &obj->gpuva_list_lock);
 	mutex_init(&obj->label.lock);
 
+	panthor_gem_debugfs_bo_add(ptdev, obj);
+
 	return &obj->base.base;
 }
 
@@ -XXX,XX +XXX,XX @@ panthor_gem_create_with_handle(struct drm_file *file,
 	/* drop reference from allocate - handle holds it now. */
 	drm_gem_object_put(&shmem->base);
 
+	panthor_gem_debugfs_bo_set_mask(bo, 0);
+
 	return ret;
 }
 
@@ -XXX,XX +XXX,XX @@ panthor_gem_kernel_bo_set_label(struct panthor_kernel_bo *bo, const char *label)
 
 	panthor_gem_bo_set_label(bo->obj, kstrdup_const(str, GFP_KERNEL));
 }
+
+#ifdef CONFIG_DEBUG_FS
+static void
+panthor_gem_debugfs_print_flags(struct seq_file *m,
+				const char *names[],
+				u32 name_count,
+				u32 flags)
+{
+	bool first = true;
+
+	seq_puts(m, "(");
+
+	if (!flags)
+		seq_puts(m, "none");
+
+	while (flags) {
+		u32 bit = fls(flags) - 1;
+
+		if (!first)
+			seq_puts(m, ",");
+
+		if (bit >= name_count || !names[bit])
+			seq_printf(m, "unknown-bit%d", bit);
+		else
+			seq_printf(m, "%s", names[bit]);
+
+		first = false;
+		flags &= ~BIT(bit);
+	}
+
+	seq_puts(m, ")");
+}
+
+struct gem_size_totals {
+	size_t size;
+	size_t resident;
+	size_t reclaimable;
+};
+
+static void panthor_gem_debugfs_bo_print(struct panthor_gem_object *bo,
+					 struct seq_file *m,
+					 struct gem_size_totals *totals)
+{
+	unsigned int refcount = kref_read(&bo->base.base.refcount);
+	char creator_info[32] = {};
+	u32 gem_state_flags = 0;
+	size_t resident_size;
+
+	static const char *gem_status_flags[] = {
+		"imported", "exported", "purged", "purgeable"
+	};
+
+	static const char *panthor_bo_flags[] = {
+		"kernel", "fw"
+	};
+
+	/* Skip BOs being destroyed. */
+	if (!refcount)
+		return;
+
+	resident_size = bo->base.pages != NULL ? bo->base.base.size : 0;
+
+	snprintf(creator_info, sizeof(creator_info),
+		 "%s/%d", bo->debugfs.creator.process_name, bo->debugfs.creator.tgid);
+	seq_printf(m, "%-32s%-16d%-16d%-16zd%-16zd%-16lx",
+		   creator_info,
+		   bo->base.base.name,
+		   refcount,
+		   bo->base.base.size,
+		   resident_size,
+		   drm_vma_node_start(&bo->base.base.vma_node));
+
+
+	if (bo->base.base.import_attach != NULL)
+		gem_state_flags |= PANTHOR_DEBUGFS_GEM_IMPORTED;
+	if (bo->base.base.dma_buf != NULL)
+		gem_state_flags |= PANTHOR_DEBUGFS_GEM_EXPORTED;
+	if (bo->base.madv < 0)
+		gem_state_flags |= PANTHOR_DEBUGFS_GEM_PURGED;
+	if (bo->base.madv)
+		gem_state_flags |= PANTHOR_DEBUGFS_GEM_PURGEABLE;
+
+	panthor_gem_debugfs_print_flags(m, gem_status_flags,
+					sizeof(gem_status_flags), gem_state_flags);
+	seq_printf(m, "%-4s", "");
+	panthor_gem_debugfs_print_flags(m, panthor_bo_flags, sizeof(panthor_bo_flags),
+					bo->debugfs.flags & (u32)~PANTHOR_DEBUGFS_BO_FLAG_INITIALISED);
+
+	mutex_lock(&bo->label.lock);
+	seq_printf(m, "%-6s%-60s", "", bo->label.str ? : NULL);
+	mutex_unlock(&bo->label.lock);
+	seq_puts(m, "\n");
+
+	totals->size += bo->base.base.size;
+	totals->resident += resident_size;
+	if (bo->base.madv > 0)
+		totals->reclaimable += resident_size;
+}
+
+void panthor_gem_debugfs_print_bos(struct panthor_device *ptdev,
+				   struct seq_file *m)
+{
+	struct gem_size_totals totals = {0};
+	struct panthor_gem_object *bo;
+
+	seq_puts(m, "created-by                      global-name     refcount        size            resident-size   file-offset     state     kflags     label\n");
+	seq_puts(m, "------------------------------------------------------------------------------------------------------------------------------------------------\n");
+
+	scoped_guard(mutex, &ptdev->gems.lock) {
+		list_for_each_entry(bo, &ptdev->gems.node, debugfs.node) {
+			if (bo->debugfs.flags & PANTHOR_DEBUGFS_BO_FLAG_INITIALISED)
+				panthor_gem_debugfs_bo_print(bo, m, &totals);
+		}
+
+	}
+
+	seq_puts(m, "==========================================================================================================================================================\n");
+	seq_printf(m, "Total size: %zd, Total resident: %zd, Total reclaimable: %zd\n",
+		   totals.size, totals.resident, totals.reclaimable);
+}
+#endif
diff --git a/drivers/gpu/drm/panthor/panthor_gem.h b/drivers/gpu/drm/panthor/panthor_gem.h
index XXXXXXX..XXXXXXX 100644
--- a/drivers/gpu/drm/panthor/panthor_gem.h
+++ b/drivers/gpu/drm/panthor/panthor_gem.h
@@ -XXX,XX +XXX,XX @@ struct panthor_vm;
 
 #define PANTHOR_BO_LABEL_MAXLEN	PAGE_SIZE
 
+enum panthor_debugfs_gem_state_flags {
+	/** @PANTHOR_DEBUGFS_GEM_IMPORTED: GEM BO is PRIME imported. */
+	PANTHOR_DEBUGFS_GEM_IMPORTED = BIT(0),
+
+	/** @PANTHOR_DEBUGFS_GEM_EXPORTED: GEM BO is PRIME exported. */
+	PANTHOR_DEBUGFS_GEM_EXPORTED = BIT(1),
+
+	/** @PANTHOR_DEBUGFS_GEM_PURGED: GEM BO was reclaimed by the shrinker. */
+	PANTHOR_DEBUGFS_GEM_PURGED = BIT(2),
+
+	/** @PANTHOR_DEBUGFS_GEM_PURGEABLE: GEM BO can be reclaimed by the shrinker. */
+	PANTHOR_DEBUGFS_GEM_PURGEABLE = BIT(3),
+};
+
+enum panthor_debugfs_bo_flags {
+	/** @PANTHOR_DEBUGFS_BO_KERNEL: BO is for kernel use only. */
+	PANTHOR_DEBUGFS_BO_FLAGS_KERNEL = BIT(0),
+
+	/** @PANTHOR_DEBUGFS_BO_FW_MAPPED: BO is mapped on the FW VM. */
+	PANTHOR_DEBUGFS_BO_FW_FLAG_MAPPED = BIT(1),
+
+	/** @PANTHOR_DEBUGFS_BO_INITIALISED: BO is ready for DebugFS display. */
+	PANTHOR_DEBUGFS_BO_FLAG_INITIALISED = BIT(31),
+};
+
+/**
+ * struct panthor_gem_debugfs - GEM object's DebugFS list information
+ */
+struct panthor_gem_debugfs {
+	/**
+	 * @node: Node used to insert the object in the device-wide list of
+	 * GEM objects, to display information about it through a DebugFS file.
+	 */
+	struct list_head node;
+
+	/** @creator: Information about the UM process which created the GEM. */
+	struct {
+		/** @creator.process_name: Group leader name in owning thread's process */
+		char process_name[TASK_COMM_LEN];
+
+		/** @creator.tgid: PID of the thread's group leader within its process */
+		pid_t tgid;
+	} creator;
+
+	/** @bo_mask: Combination of panthor_debugfs_bo_flags flags */
+	u32 flags;
+};
+
 /**
  * struct panthor_gem_object - Driver specific GEM object.
  */
@@ -XXX,XX +XXX,XX @@ struct panthor_gem_object {
 		/** @lock.str: Protects access to the @label.str field. */
 		struct mutex lock;
 	} label;
+
+#ifdef CONFIG_DEBUG_FS
+	struct panthor_gem_debugfs debugfs;
+#endif
 };
 
 /**
@@ -XXX,XX +XXX,XX @@ panthor_kernel_bo_create(struct panthor_device *ptdev, struct panthor_vm *vm,
 
 void panthor_kernel_bo_destroy(struct panthor_kernel_bo *bo);
 
+#ifdef CONFIG_DEBUG_FS
+void panthor_gem_debugfs_print_bos(struct panthor_device *pfdev,
+				   struct seq_file *m);
+static inline void
+panthor_gem_debugfs_bo_set_mask(struct panthor_gem_object *bo, u32 type_mask)
+{
+	bo->debugfs.flags = type_mask | PANTHOR_DEBUGFS_BO_FLAG_INITIALISED;
+}
+
+#else
+void panthor_gem_debugfs_bo_set_mask(struct panthor_gem_object *bo, u32 type_mask) {};
+#endif
+
 #endif /* __PANTHOR_GEM_H__ */
-- 
2.48.1