From nobody Thu Dec 18 21:20:16 2025 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id ABFEBC7EE26 for ; Mon, 1 May 2023 18:45:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231816AbjEASpi (ORCPT ); Mon, 1 May 2023 14:45:38 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58790 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232641AbjEASp2 (ORCPT ); Mon, 1 May 2023 14:45:28 -0400 Received: from mail-pf1-x42f.google.com (mail-pf1-x42f.google.com [IPv6:2607:f8b0:4864:20::42f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7927E2688; Mon, 1 May 2023 11:45:20 -0700 (PDT) Received: by mail-pf1-x42f.google.com with SMTP id d2e1a72fcca58-64115e652eeso28734558b3a.0; Mon, 01 May 2023 11:45:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1682966720; x=1685558720; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=KQp9gfJGG+Y0BWztBSmHSY/g3i1wrswRgdK7Ptk4ajw=; b=FP6GBCvERuFY2QFLk/vIqLKI9YJo8uJVwdL5P0YYFhSqyU2xwr1+AGZ8G0cU1HtYBP UIw8uFkQ/3jHNgZp5OhNjz2+FCWh/WzH7239GzAloVRSIr02/PTnpJO8DXY9Et2eZRck Cke2ivICuEg3hsdv7ZcbaqZfy97rdEcYWZ7fgsv0amE05QpuIapGDv3V8fUhmkO2eQ4h CFRFxjT7VKaSya1oM2q4vXKWd7gfOrTnwqeWPh9rGw3XStcsM4zzLAr8jHVV0WHASRZT xjFxH1Dw3BnmTCngRq+lF+aUhEKNnumk8n9rbdp/OrzFj+QTohMmhZGGKK2EAuaR8m3j rCRQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682966720; x=1685558720; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=KQp9gfJGG+Y0BWztBSmHSY/g3i1wrswRgdK7Ptk4ajw=; b=RtSfUx55tpTFI1m+v87tN+Me7xQDAJWkrm/765VAI2kelGrYqvMabEIZ3EXHkZrBFg 8owB1u/yoYEkXVV8UWDNjOuqivkGjlKbtZiCZXUSCNVTYlimaQVOP6A0D6VvfcMGVAV6 9w8u3S/r76GbFLkD2NRPPdVOe6b/IaLBgIZv96rNyI1J9rLXoEkXNtmjTfhtqLVf9B0M RJMquBkpHj1dv+8ezVhDTWwn7pJcdTLUQKslob7J1FXO7+DYYKbsJz5BKHIStILD7xLp n63qbMEhSwhzxbDM1J913gaQv/JWAlu3CjGkLAbLFN7SeCTO8cq68GQfkNQmT6GQjM2g Pbdg== X-Gm-Message-State: AC+VfDyQk1YIhb7PO1qbmlyBfljxhwTfMMgvUMSfnkqzGLY06TFvR6XT 0J9cvz8DfUMVubiInMe7KUc= X-Google-Smtp-Source: ACHHUZ7u+VuFSbDRFoeugmom6ZLBj75QfayFTw/3tPOB6o1QVmKKagB/TrcSwWuCSK3GHmBUlKMQig== X-Received: by 2002:a17:90a:3189:b0:24d:f0e9:907f with SMTP id j9-20020a17090a318900b0024df0e9907fmr6472197pjb.6.1682966719804; Mon, 01 May 2023 11:45:19 -0700 (PDT) Received: from localhost ([2a00:79e1:abd:4a00:61b:48ed:72ab:435b]) by smtp.gmail.com with ESMTPSA id b13-20020a17090a8c8d00b0024deb445265sm3169189pjo.47.2023.05.01.11.45.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 01 May 2023 11:45:19 -0700 (PDT) From: Rob Clark To: dri-devel@lists.freedesktop.org Cc: freedreno@lists.freedesktop.org, Daniel Vetter , Tvrtko Ursulin , Boris Brezillon , Christopher Healy , Emil Velikov , =?UTF-8?q?Christian=20K=C3=B6nig?= , Rob Clark , Daniel Vetter , David Airlie , Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , Jonathan Corbet , linux-doc@vger.kernel.org (open list:DOCUMENTATION), linux-kernel@vger.kernel.org (open list) Subject: [PATCH v3 5/9] drm: Add fdinfo memory stats Date: Mon, 1 May 2023 11:44:51 -0700 Message-Id: <20230501184502.1620335-6-robdclark@gmail.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230501184502.1620335-1-robdclark@gmail.com> References: <20230501184502.1620335-1-robdclark@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Rob Clark Add support to dump GEM stats to fdinfo. v2: Fix typos, change size units to match docs, use div_u64 v3: Do it in core v4: more kerneldoc v5: doc fixes Signed-off-by: Rob Clark Reviewed-by: Emil Velikov Reviewed-by: Daniel Vetter --- Documentation/gpu/drm-usage-stats.rst | 54 +++++++++++---- drivers/gpu/drm/drm_file.c | 99 ++++++++++++++++++++++++++- include/drm/drm_file.h | 28 ++++++++ include/drm/drm_gem.h | 30 ++++++++ 4 files changed, 198 insertions(+), 13 deletions(-) diff --git a/Documentation/gpu/drm-usage-stats.rst b/Documentation/gpu/drm-= usage-stats.rst index 552195fb1ea3..d012eb56885e 100644 --- a/Documentation/gpu/drm-usage-stats.rst +++ b/Documentation/gpu/drm-usage-stats.rst @@ -45,37 +45,43 @@ Mandatory fully standardised keys --------------------------------- =20 - drm-driver: =20 String shall contain the name this driver registered as via the respective `struct drm_driver` data structure. =20 Optional fully standardised keys -------------------------------- =20 +Identification +^^^^^^^^^^^^^^ + - drm-pdev: =20 For PCI devices this should contain the PCI slot address of the device in question. =20 - drm-client-id: =20 Unique value relating to the open DRM file descriptor used to distinguish duplicated and shared file descriptors. Conceptually the value should map = 1:1 to the in kernel representation of `struct drm_file` instances. =20 Uniqueness of the value shall be either globally unique, or unique within = the scope of each device, in which case `drm-pdev` shall be present as well. =20 Userspace should make sure to not double account any usage statistics by u= sing the above described criteria in order to associate data to individual clie= nts. =20 +Utilization +^^^^^^^^^^^ + - drm-engine-: ns =20 GPUs usually contain multiple execution engines. Each shall be given a sta= ble and unique name (str), with possible values documented in the driver speci= fic documentation. =20 Value shall be in specified time units which the respective GPU engine spe= nt busy executing workloads belonging to this client. =20 Values are not required to be constantly monotonic if it makes the driver @@ -86,32 +92,20 @@ value until a monotonic update is seen. =20 - drm-engine-capacity-: =20 Engine identifier string must be the same as the one specified in the drm-engine- tag and shall contain a greater than zero number in case = the exported engine corresponds to a group of identical hardware engines. =20 In the absence of this tag parser shall assume capacity of one. Zero capac= ity is not allowed. =20 -- drm-memory-: [KiB|MiB] - -Each possible memory type which can be used to store buffer objects by the -GPU in question shall be given a stable and unique name to be returned as = the -string here. - -Value shall reflect the amount of storage currently consumed by the buffer -object belong to this client, in the respective memory region. - -Default unit shall be bytes with optional unit specifiers of 'KiB' or 'MiB' -indicating kibi- or mebi-bytes. - - drm-cycles-: =20 Engine identifier string must be the same as the one specified in the drm-engine- tag and shall contain the number of busy cycles for the g= iven engine. =20 Values are not required to be constantly monotonic if it makes the driver implementation easier, but are required to catch up with the previously re= ported larger value within a reasonable period. Upon observing a value lower than= what was previously read, userspace is expected to stay with that larger previo= us @@ -119,20 +113,56 @@ value until a monotonic update is seen. =20 - drm-maxfreq-: [Hz|MHz|KHz] =20 Engine identifier string must be the same as the one specified in the drm-engine- tag and shall contain the maximum frequency for the given engine. Taken together with drm-cycles-, this can be used to calcula= te percentage utilization of the engine, whereas drm-engine- only reflec= ts time active without considering what frequency the engine is operating as a percentage of it's maximum frequency. =20 +Memory +^^^^^^ + +- drm-memory-: [KiB|MiB] + +Each possible memory type which can be used to store buffer objects by the +GPU in question shall be given a stable and unique name to be returned as = the +string here. The name "memory" is reserved to refer to normal system memo= ry. + +Value shall reflect the amount of storage currently consumed by the buffer +objects belong to this client, in the respective memory region. + +Default unit shall be bytes with optional unit specifiers of 'KiB' or 'MiB' +indicating kibi- or mebi-bytes. + +- drm-shared-: [KiB|MiB] + +The total size of buffers that are shared with another file (ie. have more +than a single handle). + +- drm-total-: [KiB|MiB] + +The total size of buffers that including shared and private memory. + +- drm-resident-: [KiB|MiB] + +The total size of buffers that are resident in the specified region. + +- drm-purgeable-: [KiB|MiB] + +The total size of buffers that are purgeable. + +- drm-active-: [KiB|MiB] + +The total size of buffers that are active on one or more engines. + Implementation Details =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 Drivers should use drm_show_fdinfo() in their `struct file_operations`, and implement &drm_driver.show_fdinfo if they wish to provide any stats which are not provided by drm_show_fdinfo(). But even driver specific stats sho= uld be documented above and where possible, aligned with other drivers. =20 Driver specific implementations ------------------------------- diff --git a/drivers/gpu/drm/drm_file.c b/drivers/gpu/drm/drm_file.c index 6d5bdd684ae2..9321eb0bf020 100644 --- a/drivers/gpu/drm/drm_file.c +++ b/drivers/gpu/drm/drm_file.c @@ -35,20 +35,21 @@ #include #include #include #include #include #include =20 #include #include #include +#include #include =20 #include "drm_crtc_internal.h" #include "drm_internal.h" #include "drm_legacy.h" =20 /* from BKL pushdown */ DEFINE_MUTEX(drm_global_mutex); =20 bool drm_dev_needs_global_mutex(struct drm_device *dev) @@ -864,23 +865,119 @@ EXPORT_SYMBOL(drm_send_event_locked); void drm_send_event(struct drm_device *dev, struct drm_pending_event *e) { unsigned long irqflags; =20 spin_lock_irqsave(&dev->event_lock, irqflags); drm_send_event_helper(dev, e, 0); spin_unlock_irqrestore(&dev->event_lock, irqflags); } EXPORT_SYMBOL(drm_send_event); =20 +static void print_size(struct drm_printer *p, const char *stat, + const char *region, size_t sz) +{ + const char *units[] =3D {"", " KiB", " MiB"}; + unsigned u; + + for (u =3D 0; u < ARRAY_SIZE(units) - 1; u++) { + if (sz < SZ_1K) + break; + sz =3D div_u64(sz, SZ_1K); + } + + drm_printf(p, "drm-%s-%s:\t%zu%s\n", stat, region, sz, units[u]); +} + +/** + * drm_print_memory_stats - A helper to print memory stats + * @p: The printer to print output to + * @stats: The collected memory stats + * @supported_status: Bitmask of optional stats which are available + * @region: The memory region + * + */ +void drm_print_memory_stats(struct drm_printer *p, + const struct drm_memory_stats *stats, + enum drm_gem_object_status supported_status, + const char *region) +{ + print_size(p, "total", region, stats->private + stats->shared); + print_size(p, "shared", region, stats->shared); + print_size(p, "active", region, stats->active); + + if (supported_status & DRM_GEM_OBJECT_RESIDENT) + print_size(p, "resident", region, stats->resident); + + if (supported_status & DRM_GEM_OBJECT_PURGEABLE) + print_size(p, "purgeable", region, stats->purgeable); +} +EXPORT_SYMBOL(drm_print_memory_stats); + +/** + * drm_show_memory_stats - Helper to collect and show standard fdinfo memo= ry stats + * @p: the printer to print output to + * @file: the DRM file + * + * Helper to iterate over GEM objects with a handle allocated in the speci= fied + * file. + */ +void drm_show_memory_stats(struct drm_printer *p, struct drm_file *file) +{ + struct drm_gem_object *obj; + struct drm_memory_stats status =3D {}; + enum drm_gem_object_status supported_status; + int id; + + spin_lock(&file->table_lock); + idr_for_each_entry (&file->object_idr, obj, id) { + enum drm_gem_object_status s =3D 0; + + if (obj->funcs && obj->funcs->status) { + s =3D obj->funcs->status(obj); + supported_status =3D DRM_GEM_OBJECT_RESIDENT | + DRM_GEM_OBJECT_PURGEABLE; + } + + if (obj->handle_count > 1) { + status.shared +=3D obj->size; + } else { + status.private +=3D obj->size; + } + + if (s & DRM_GEM_OBJECT_RESIDENT) { + status.resident +=3D obj->size; + } else { + /* If already purged or not yet backed by pages, don't + * count it as purgeable: + */ + s &=3D ~DRM_GEM_OBJECT_PURGEABLE; + } + + if (!dma_resv_test_signaled(obj->resv, dma_resv_usage_rw(true))) { + status.active +=3D obj->size; + + /* If still active, don't count as purgeable: */ + s &=3D ~DRM_GEM_OBJECT_PURGEABLE; + } + + if (s & DRM_GEM_OBJECT_PURGEABLE) + status.purgeable +=3D obj->size; + } + spin_unlock(&file->table_lock); + + drm_print_memory_stats(p, &status, supported_status, "memory"); +} +EXPORT_SYMBOL(drm_show_memory_stats); + /** * drm_show_fdinfo - helper for drm file fops - * @seq_file: output stream + * @m: output stream * @f: the device file instance * * Helper to implement fdinfo, for userspace to query usage stats, etc, of= a * process using the GPU. See also &drm_driver.show_fdinfo. * * For text output format description please see Documentation/gpu/drm-usa= ge-stats.rst */ void drm_show_fdinfo(struct seq_file *m, struct file *f) { struct drm_file *file =3D f->private_data; diff --git a/include/drm/drm_file.h b/include/drm/drm_file.h index 6de6d0e9c634..f77540b97cd0 100644 --- a/include/drm/drm_file.h +++ b/include/drm/drm_file.h @@ -34,20 +34,21 @@ #include #include =20 #include =20 #include =20 struct dma_fence; struct drm_file; struct drm_device; +struct drm_printer; struct device; struct file; =20 /* * FIXME: Not sure we want to have drm_minor here in the end, but to avoid * header include loops we need it here for now. */ =20 /* Note that the order of this enum is ABI (it determines * /dev/dri/renderD* numbers). @@ -433,15 +434,42 @@ int drm_event_reserve_init(struct drm_device *dev, struct drm_file *file_priv, struct drm_pending_event *p, struct drm_event *e); void drm_event_cancel_free(struct drm_device *dev, struct drm_pending_event *p); void drm_send_event_locked(struct drm_device *dev, struct drm_pending_even= t *e); void drm_send_event(struct drm_device *dev, struct drm_pending_event *e); void drm_send_event_timestamp_locked(struct drm_device *dev, struct drm_pending_event *e, ktime_t timestamp); + +/** + * struct drm_memory_stats - GEM object stats associated + * @shared: Total size of GEM objects shared between processes + * @private: Total size of GEM objects + * @resident: Total size of GEM objects backing pages + * @purgeable: Total size of GEM objects that can be purged (resident and = not active) + * @active: Total size of GEM objects active on one or more engines + * + * Used by drm_print_memory_stats() + */ +struct drm_memory_stats { + u32 shared; + u32 private; + u32 resident; + u32 purgeable; + u32 active; +}; + +enum drm_gem_object_status; + +void drm_print_memory_stats(struct drm_printer *p, + const struct drm_memory_stats *stats, + enum drm_gem_object_status supported_status, + const char *region); + +void drm_show_memory_stats(struct drm_printer *p, struct drm_file *file); void drm_show_fdinfo(struct seq_file *m, struct file *f); =20 struct file *mock_drm_getfile(struct drm_minor *minor, unsigned int flags); =20 #endif /* _DRM_FILE_H_ */ diff --git a/include/drm/drm_gem.h b/include/drm/drm_gem.h index 189fd618ca65..9ebd2820ad1f 100644 --- a/include/drm/drm_gem.h +++ b/include/drm/drm_gem.h @@ -35,20 +35,39 @@ */ =20 #include #include =20 #include =20 struct iosys_map; struct drm_gem_object; =20 +/** + * enum drm_gem_object_status - bitmask of object state for fdinfo reporti= ng + * @DRM_GEM_OBJECT_RESIDENT: object is resident in memory (ie. not unpinne= d) + * @DRM_GEM_OBJECT_PURGEABLE: object marked as purgeable by userspace + * + * Bitmask of status used for fdinfo memory stats, see &drm_gem_object_fun= cs.status + * and drm_show_fdinfo(). Note that an object can DRM_GEM_OBJECT_PURGEABL= E if + * it still active or not resident, in which case drm_show_fdinfo() will n= ot + * account for it as purgeable. So drivers do not need to check if the bu= ffer + * is idle and resident to return this bit. (Ie. userspace can mark a buf= fer + * as purgeable even while it is still busy on the GPU.. it does not _actu= ally_ + * become puregeable until it becomes idle. The status gem object func do= es + * not need to consider this.) + */ +enum drm_gem_object_status { + DRM_GEM_OBJECT_RESIDENT =3D BIT(0), + DRM_GEM_OBJECT_PURGEABLE =3D BIT(1), +}; + /** * struct drm_gem_object_funcs - GEM object functions */ struct drm_gem_object_funcs { /** * @free: * * Deconstructor for drm_gem_objects. * * This callback is mandatory. @@ -167,20 +186,31 @@ struct drm_gem_object_funcs { /** * @evict: * * Evicts gem object out from memory. Used by the drm_gem_object_evict() * helper. Returns 0 on success, -errno otherwise. * * This callback is optional. */ int (*evict)(struct drm_gem_object *obj); =20 + /** + * @status: + * + * The optional status callback can return additional object state + * which determines which stats the object is counted against. The + * callback is called under table_lock. Racing against object status + * change is "harmless", and the callback can expect to not race + * against object destruction. + */ + enum drm_gem_object_status (*status)(struct drm_gem_object *obj); + /** * @vm_ops: * * Virtual memory operations used with mmap. * * This is optional but necessary for mmap support. */ const struct vm_operations_struct *vm_ops; }; =20 --=20 2.39.2