From patchwork Tue Oct 15 18:38:22 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ian Rogers X-Patchwork-Id: 13836874 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 gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 4C2E5D1D89A for ; Tue, 15 Oct 2024 18:38:48 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id C515F10E5EB; Tue, 15 Oct 2024 18:38:47 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.b="sMoqDwwt"; dkim-atps=neutral Received: from mail-yb1-f202.google.com (mail-yb1-f202.google.com [209.85.219.202]) by gabe.freedesktop.org (Postfix) with ESMTPS id F40EA10E5EB for ; Tue, 15 Oct 2024 18:38:45 +0000 (UTC) Received: by mail-yb1-f202.google.com with SMTP id 3f1490d57ef6-e28ef71f0d8so9200534276.0 for ; Tue, 15 Oct 2024 11:38:45 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1729017525; x=1729622325; darn=lists.freedesktop.org; h=cc:to:from:subject:mime-version:message-id:date:from:to:cc:subject :date:message-id:reply-to; bh=elVcyqBRot1hWy/7wsiTZrHkBjkpf9b46nIr70Zlz4E=; b=sMoqDwwtnT+uL/w73h0wSEI1/gu+shym9ZuoD/EWpA0dogIfUXIUUY5zqN9FhGZZUQ yGWoCbn00bqU6OCGse3pEHU13yGpfCF44gJLxvWSfitrB2GlHkgHXbk7xGq4Y0HTLpoa jY1sXb2AmlQ2EJldPyjfdGLPueRKH9qof8xBcveNYL5vjPuPiAl6DHHkDIzFCuzc9n3a KcazI3laHqWlAfhIXBmvhS1hwZIA5C1qoPWjSinLorBjH6GyO810BILs4M78aI7n2t8k e/9KdTe83wMFHn0lhMGjWHjBx0UkOMKvL+W0OqWuKj3bpy0mpb7ihuxrOHWeSw2/xO6s N23g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1729017525; x=1729622325; h=cc:to:from:subject:mime-version:message-id:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=elVcyqBRot1hWy/7wsiTZrHkBjkpf9b46nIr70Zlz4E=; b=iB6WBRvt0iTWQ3TJi0lg/32QBKe1LcAq8LZCeefyZ7GfB877nxOBbMlcdaHI0AAGRl uGNSE1qfGll1mltDuu7w9R9jPZFj5140+/wRvyzBMwyy71TqbLgzgeCfQ2jRet0gt+5F J4JkXydwLklPPPiekt//qK3HT9JrZ2gDSYSV/PQpo/QG1YAxQOX/BEyj0oZJhk6QaOsf LiYLCpVZv0aeajcUZiHzFuMl4LzaDAzU6E50Bih+s5jWE0AWAadNOEu4FFQFLtfAvjVs 9Ld2rlH863cyUZjvhkYAG5ojz97UARoooaxucOIoFrTZJ3WvBWhUyzZPIPhWS9tLEq+r TfuA== X-Forwarded-Encrypted: i=1; AJvYcCUeCcm2PMwv0WfNveLCADoFntJ+n+KaCokpRLH8KsDZMW7PVVSYy8G/seofRfYHHp7jbQtHaIcjPWI=@lists.freedesktop.org X-Gm-Message-State: AOJu0YxzQl+Am5mI0642naBZ0H7n/KF7BOYabs/VET8WMugpFKrb6gAi oX2aPzR/kP7RqUvq73FmOJkxEv2fRihexTv2TXdM6krcvDwJhMMcLqSYJ1qAXQqhI7NwmR9vv5L GZSmwZw== X-Google-Smtp-Source: AGHT+IEyK7rc0w1b7082t7PmrW0ZPtserOhvsOb+4IAJFUB6ZgGx9hjsurpK767oQk9+ppFpQnIWnoXlh8wl X-Received: from irogers.svl.corp.google.com ([2620:15c:2c5:11:61a1:4d9d:aca1:ada]) (user=irogers job=sendgmr) by 2002:a25:9702:0:b0:e28:e510:6ab1 with SMTP id 3f1490d57ef6-e297857f673mr582276.8.1729017524932; Tue, 15 Oct 2024 11:38:44 -0700 (PDT) Date: Tue, 15 Oct 2024 11:38:22 -0700 Message-Id: <20241015183824.1014964-1-irogers@google.com> Mime-Version: 1.0 X-Mailer: git-send-email 2.47.0.rc1.288.g06298d1525-goog Subject: [PATCH v1 1/3] proc_pid_fdinfo.5: Reduce indent for most of the page From: Ian Rogers To: Alejandro Colomar Cc: David Airlie , Simona Vetter , Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , Jonathan Corbet , dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-man@vger.kernel.org, Ian Rogers X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" When /proc/pid/fdinfo was part of proc.5 man page the indentation made sense. As a standalone man page the indentation doesn't need to be so far over to the right. Signed-off-by: Ian Rogers --- man/man5/proc_pid_fdinfo.5 | 50 +++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5 index 1e23bbe02..0c4950d5d 100644 --- a/man/man5/proc_pid_fdinfo.5 +++ b/man/man5/proc_pid_fdinfo.5 @@ -8,8 +8,9 @@ .SH NAME /proc/pid/fdinfo/ \- information about file descriptors .SH DESCRIPTION -.TP +.TP 0 .IR /proc/ pid /fdinfo/ " (since Linux 2.6.22)" +.P This is a subdirectory containing one entry for each file which the process has open, named by its file descriptor. The files in this directory are readable only by the owner of the process. @@ -17,9 +18,9 @@ The contents of each file can be read to obtain information about the corresponding file descriptor. The content depends on the type of file referred to by the corresponding file descriptor. -.IP +.P For regular files and directories, we see something like: -.IP +.P .in +4n .EX .RB "$" " cat /proc/12015/fdinfo/4" @@ -28,7 +29,7 @@ flags: 01002002 mnt_id: 21 .EE .in -.IP +.P The fields are as follows: .RS .TP @@ -51,7 +52,6 @@ this field incorrectly displayed the setting of at the time the file was opened, rather than the current setting of the close-on-exec flag. .TP -.I .I mnt_id This field, present since Linux 3.15, .\" commit 49d063cb353265c3af701bab215ac438ca7df36d @@ -59,13 +59,13 @@ is the ID of the mount containing this file. See the description of .IR /proc/ pid /mountinfo . .RE -.IP +.P For eventfd file descriptors (see .BR eventfd (2)), we see (since Linux 3.8) .\" commit cbac5542d48127b546a23d816380a7926eee1c25 the following fields: -.IP +.P .in +4n .EX pos: 0 @@ -74,16 +74,16 @@ mnt_id: 10 eventfd\-count: 40 .EE .in -.IP +.P .I eventfd\-count is the current value of the eventfd counter, in hexadecimal. -.IP +.P For epoll file descriptors (see .BR epoll (7)), we see (since Linux 3.8) .\" commit 138d22b58696c506799f8de759804083ff9effae the following fields: -.IP +.P .in +4n .EX pos: 0 @@ -93,7 +93,7 @@ tfd: 9 events: 19 data: 74253d2500000009 tfd: 7 events: 19 data: 74253d2500000007 .EE .in -.IP +.P Each of the lines beginning .I tfd describes one of the file descriptors being monitored via @@ -110,13 +110,13 @@ descriptor. The .I data field is the data value associated with this file descriptor. -.IP +.P For signalfd file descriptors (see .BR signalfd (2)), we see (since Linux 3.8) .\" commit 138d22b58696c506799f8de759804083ff9effae the following fields: -.IP +.P .in +4n .EX pos: 0 @@ -125,7 +125,7 @@ mnt_id: 10 sigmask: 0000000000000006 .EE .in -.IP +.P .I sigmask is the hexadecimal mask of signals that are accepted via this signalfd file descriptor. @@ -135,12 +135,12 @@ and .BR SIGQUIT ; see .BR signal (7).) -.IP +.P For inotify file descriptors (see .BR inotify (7)), we see (since Linux 3.8) the following fields: -.IP +.P .in +4n .EX pos: 0 @@ -150,7 +150,7 @@ inotify wd:2 ino:7ef82a sdev:800001 mask:800afff ignored_mask:0 fhandle\-bytes:8 inotify wd:1 ino:192627 sdev:800001 mask:800afff ignored_mask:0 fhandle\-bytes:8 fhandle\-type:1 f_handle:27261900802dfd73 .EE .in -.IP +.P Each of the lines beginning with "inotify" displays information about one file or directory that is being monitored. The fields in this line are as follows: @@ -168,19 +168,19 @@ The ID of the device where the target file resides (in hexadecimal). .I mask The mask of events being monitored for the target file (in hexadecimal). .RE -.IP +.P If the kernel was built with exportfs support, the path to the target file is exposed as a file handle, via three hexadecimal fields: .IR fhandle\-bytes , .IR fhandle\-type , and .IR f_handle . -.IP +.P For fanotify file descriptors (see .BR fanotify (7)), we see (since Linux 3.8) the following fields: -.IP +.P .in +4n .EX pos: 0 @@ -190,7 +190,7 @@ fanotify flags:0 event\-flags:88002 fanotify ino:19264f sdev:800001 mflags:0 mask:1 ignored_mask:0 fhandle\-bytes:8 fhandle\-type:1 f_handle:4f261900a82dfd73 .EE .in -.IP +.P The fourth line displays information defined when the fanotify group was created via .BR fanotify_init (2): @@ -210,7 +210,7 @@ argument given to .BR fanotify_init (2) (expressed in hexadecimal). .RE -.IP +.P Each additional line shown in the file contains information about one of the marks in the fanotify group. Most of these fields are as for inotify, except: @@ -228,16 +228,16 @@ The events mask for this mark The mask of events that are ignored for this mark (expressed in hexadecimal). .RE -.IP +.P For details on these fields, see .BR fanotify_mark (2). -.IP +.P For timerfd file descriptors (see .BR timerfd (2)), we see (since Linux 3.17) .\" commit af9c4957cf212ad9cf0bee34c95cb11de5426e85 the following fields: -.IP +.P .in +4n .EX pos: 0 From patchwork Tue Oct 15 18:38:23 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ian Rogers X-Patchwork-Id: 13836875 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 gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id C3611D1D896 for ; Tue, 15 Oct 2024 18:38:50 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id B95A710E5EC; Tue, 15 Oct 2024 18:38:49 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.b="IqbLwDFZ"; dkim-atps=neutral Received: from mail-yb1-f202.google.com (mail-yb1-f202.google.com [209.85.219.202]) by gabe.freedesktop.org (Postfix) with ESMTPS id 2AF3810E5EC for ; Tue, 15 Oct 2024 18:38:48 +0000 (UTC) Received: by mail-yb1-f202.google.com with SMTP id 3f1490d57ef6-e290b8b69f8so9289301276.2 for ; Tue, 15 Oct 2024 11:38:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1729017527; x=1729622327; darn=lists.freedesktop.org; h=cc:to:from:subject:references:mime-version:message-id:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=5Z3Rbrb2Z8GgUdGOPxQ4ICuPuYc4IdHw2IwxB2sqLH4=; b=IqbLwDFZXJgKVuzU9Yzm/hnudwRbMDw/tWCGT4PJ+9u7M69/PcdPQv+AD9To31Hrek BTO4lqDsnaIbYTZBoe+dV0KVQTOZl1av0YphUrq915vOd87p4n29nHwh6LBe3sGPo/mx jI/NZO5zzX3oA9TTjJpm2KtkwtWRXlINvdcXQOZcHbmkh8xeGEuUwQRaE7LE3Fk98B4u APIHZWPhy1HMMR/VuQLMRaL6BP2sHyFAY0Dex09kHn+BnosV0QPmZHilRB6QRpclKAkq tFcCBhWmWkbx2ansznS+fK7CqCpDGy04GLKzcKMgjGe4raFhVY9BU2KTiId3Ltu9ZK2s 0x+w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1729017527; x=1729622327; h=cc:to:from:subject:references:mime-version:message-id:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=5Z3Rbrb2Z8GgUdGOPxQ4ICuPuYc4IdHw2IwxB2sqLH4=; b=UEabfpUbbJMwsmDFF58t/KPXhZrO15Wv8BFn9YoC5dM8qm0T1rbs0RIC0WsurFGVZw bIj5bxQqo9U8TmaXBHiU9wlCgxXoLXuhg7CPN1dSUZvrfR+XIneSoWrqw9y3KylP+dds /pEY9au8tbKwFRGPJEIBzdtchgLPLmEPPwc0UDvIo+auQkihHF+RU/pCv7mZMrMD6pM7 GG6p6zQnHoT8pkUV4RtBDsKFOpYANiaRzuMpC0Z9qImErqIDaWq/CVK8gd8DK6Bt+XPz J4DfJ1AbpgtehE/rELRkANVzvoGITfvnXwT2BO4Sys4VhQqJe1eSM6aOI9mFou7JM6cA hsaQ== X-Forwarded-Encrypted: i=1; AJvYcCWtBGFRLsXawKwclW9LK3J/VC6hmV+ZmjkNz/rMAPCxaiUBDffMvWiqfDOUGLxCxJvnZj9lB8wDqxY=@lists.freedesktop.org X-Gm-Message-State: AOJu0YwwDD/6asdihqZyPgI0QrOkK+poSI3A67/TkVQsjQDcNzC31aRC 3kn7UrHPVEy+B6bO4d5pZSshlIlEVaB3TqJBGEef57y6FvVpTtRAOIpCZpSPtdXFcPHBix1Ry4Z tNr8rDw== X-Google-Smtp-Source: AGHT+IEUCrsutY0kTkkqMWPEqq/3T+BcT4jT1L0k20dzjwNVEGp74umIyv30/nr5D82bDtqQwPBBUTwEa5Ol X-Received: from irogers.svl.corp.google.com ([2620:15c:2c5:11:61a1:4d9d:aca1:ada]) (user=irogers job=sendgmr) by 2002:a05:6902:1c3:b0:e28:ee84:e4d8 with SMTP id 3f1490d57ef6-e29783006b4mr737276.3.1729017527264; Tue, 15 Oct 2024 11:38:47 -0700 (PDT) Date: Tue, 15 Oct 2024 11:38:23 -0700 In-Reply-To: <20241015183824.1014964-1-irogers@google.com> Message-Id: <20241015183824.1014964-2-irogers@google.com> Mime-Version: 1.0 References: <20241015183824.1014964-1-irogers@google.com> X-Mailer: git-send-email 2.47.0.rc1.288.g06298d1525-goog Subject: [PATCH v1 2/3] proc_pid_fdinfo.5: Add subsection headers for different fd types From: Ian Rogers To: Alejandro Colomar Cc: David Airlie , Simona Vetter , Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , Jonathan Corbet , dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-man@vger.kernel.org, Ian Rogers X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" Make the sections about eventfd, epoll, signalfd, inotify, fanotify, timerfd better separated with a clearer subsection header. Signed-off-by: Ian Rogers --- man/man5/proc_pid_fdinfo.5 | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5 index 0c4950d5d..3f90f6bb5 100644 --- a/man/man5/proc_pid_fdinfo.5 +++ b/man/man5/proc_pid_fdinfo.5 @@ -59,6 +59,7 @@ is the ID of the mount containing this file. See the description of .IR /proc/ pid /mountinfo . .RE +.SS eventfd .P For eventfd file descriptors (see .BR eventfd (2)), @@ -77,6 +78,7 @@ eventfd\-count: 40 .P .I eventfd\-count is the current value of the eventfd counter, in hexadecimal. +.SS epoll .P For epoll file descriptors (see .BR epoll (7)), @@ -110,6 +112,7 @@ descriptor. The .I data field is the data value associated with this file descriptor. +.SS signalfd .P For signalfd file descriptors (see .BR signalfd (2)), @@ -135,6 +138,7 @@ and .BR SIGQUIT ; see .BR signal (7).) +.SS inotify .P For inotify file descriptors (see .BR inotify (7)), @@ -175,6 +179,7 @@ file is exposed as a file handle, via three hexadecimal fields: .IR fhandle\-type , and .IR f_handle . +.SS fanotify .P For fanotify file descriptors (see .BR fanotify (7)), @@ -231,6 +236,7 @@ The mask of events that are ignored for this mark .P For details on these fields, see .BR fanotify_mark (2). +.SS timerfd .P For timerfd file descriptors (see .BR timerfd (2)), From patchwork Tue Oct 15 18:38:24 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ian Rogers X-Patchwork-Id: 13836876 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 gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id C6DABD1D89D for ; Tue, 15 Oct 2024 18:38:52 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 34E4110E5ED; Tue, 15 Oct 2024 18:38:52 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.b="fdNnMuRU"; dkim-atps=neutral Received: from mail-yb1-f201.google.com (mail-yb1-f201.google.com [209.85.219.201]) by gabe.freedesktop.org (Postfix) with ESMTPS id 9F24010E5ED for ; Tue, 15 Oct 2024 18:38:50 +0000 (UTC) Received: by mail-yb1-f201.google.com with SMTP id 3f1490d57ef6-e28ef71f0d8so9200598276.0 for ; Tue, 15 Oct 2024 11:38:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1729017530; x=1729622330; darn=lists.freedesktop.org; h=cc:to:from:subject:references:mime-version:message-id:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=gMeke42q77vKZdk9CqMaOeiApW1FFSuUHd/dD3slT+g=; b=fdNnMuRURl3NnLlgYyTakvusBCMn96lLGBJDLirU+/cRphDRxYBpEf0YIxxzrEFX0Z vpzE+Sie8mLhVKHJ1McfmzwNj6+S39XUBpMuX+lxc0BGGXP7854cgsd2GyeGLP57n3tZ dePKGh6I5k2C5C69ZDPo8UowFIrCSDOWFwXErmMk6lqGKhie+zYt5T1ir9WlDTulrnvf 7nx6Z7ettap3BMbWLQbj7oIPTGP2oDuILXQfJruKt7gjct8DhVfVqnpr5y4neXoge+tm g82rlGku4cHXw6Qvj6+EJh8WVorw19MmC7d+lxe51WRuqSAqzjIMIC6Yp74H8bLJlQ0R zgtQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1729017530; x=1729622330; h=cc:to:from:subject:references:mime-version:message-id:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=gMeke42q77vKZdk9CqMaOeiApW1FFSuUHd/dD3slT+g=; b=pS6mL6BkBxSjA1mpopKWIL076c03NDdKIqsc2PpwyfWBf4YCdnrYL8dKdcuBJ4wGSo A9Hi4uw4g5laeNd3JWs7B+vIenxQ+bJ2qNekYNh4iw3q9lmYdWBvLqEdolRdYc+BAyWJ QkCwGdYw6+QENNtAaE8afrf2ywBmaIpGFraQwxiUeMthhGrIWHlbFGwxkj60wjhG5t2T w0KKLkgCTwd3cct9NXZI1VhenOkC1CnK+cyJLSNFDjDVthURJFJY08azDR3pUV93gpmv AKK1M2xvD5gthmUW+iM/RtGyiLEAerawz+twUeA3bAdej5TblokvmAKgdDBFQVZgtPhO ymOg== X-Forwarded-Encrypted: i=1; AJvYcCX1E+ZA2o3ScJQwLT+onr5YfTBQbJPxqWXTWPrKlyHUT7mHkreiHfTuW9cD4/JX70/WJ0pDjT5nKhg=@lists.freedesktop.org X-Gm-Message-State: AOJu0Yy1a1Qvz6/Zy/H+nhtHnE+c84v9COR1SVgeFV2pmP/yTotzhJd/ iYKepomNXyZ9TbDCxKDgJSvtohh90Hr4QcSVmW12cRurmR979kDa7qOXe8u+A1+5dLuAp/O9q6T setE+JQ== X-Google-Smtp-Source: AGHT+IGETkEI/5EAubwwlNl50B+eFDsqD15jqw1peUq+N2xQNvJcU/MhNMYfdP+IJSFOGW9SBOZ45gGLwb1l X-Received: from irogers.svl.corp.google.com ([2620:15c:2c5:11:61a1:4d9d:aca1:ada]) (user=irogers job=sendgmr) by 2002:a25:aa09:0:b0:e29:74e3:616c with SMTP id 3f1490d57ef6-e29782e9e9cmr600276.3.1729017529497; Tue, 15 Oct 2024 11:38:49 -0700 (PDT) Date: Tue, 15 Oct 2024 11:38:24 -0700 In-Reply-To: <20241015183824.1014964-1-irogers@google.com> Message-Id: <20241015183824.1014964-3-irogers@google.com> Mime-Version: 1.0 References: <20241015183824.1014964-1-irogers@google.com> X-Mailer: git-send-email 2.47.0.rc1.288.g06298d1525-goog Subject: [PATCH v1 3/3] proc_pid_fdinfo.5: Add DRM subsection From: Ian Rogers To: Alejandro Colomar Cc: David Airlie , Simona Vetter , Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , Jonathan Corbet , dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-man@vger.kernel.org, Ian Rogers X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" Add description of DRM fdinfo information based on the Linux kernel's `Documentation/gpu/drm-usage-stats.rst`: https://docs.kernel.org/gpu/drm-usage-stats.html Signed-off-by: Ian Rogers --- man/man5/proc_pid_fdinfo.5 | 94 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5 index 3f90f6bb5..76a2562e8 100644 --- a/man/man5/proc_pid_fdinfo.5 +++ b/man/man5/proc_pid_fdinfo.5 @@ -302,5 +302,99 @@ fields contain the values that .BR timerfd_gettime (2) on this file descriptor would return.) .RE +.SS Direct Rendering Manager +.P +DRM drivers can optionally choose to expose usage stats through +/proc/pid/fdinfo/. For example: +.P +.in +4n +.EX +pos: 0 +flags: 02100002 +mnt_id: 26 +ino: 284 +drm-driver: i915 +drm-client-id: 39 +drm-pdev: 0000:00:02.0 +drm-total-system0: 6044 KiB +drm-shared-system0: 0 +drm-active-system0: 0 +drm-resident-system0: 6044 KiB +drm-purgeable-system0: 1688 KiB +drm-total-stolen-system0: 0 +drm-shared-stolen-system0: 0 +drm-active-stolen-system0: 0 +drm-resident-stolen-system0: 0 +drm-purgeable-stolen-system0: 0 +drm-engine-render: 346249 ns +drm-engine-copy: 0 ns +drm-engine-video: 0 ns +drm-engine-capacity-video: 2 +drm-engine-video-enhance: 0 ns +.EE +.TP +.IR drm-driver: " .+ (mandatory)" +The name this driver registered. +.TP +.IR drm-pdev: " " +For PCI devices this should contain the PCI slot address of the device +in question. +.TP +.IR drm-client-id: " [0-9]+" +Unique value relating to the open DRM file descriptor used to +distinguish duplicated and shared file descriptors. +.P +GPUs usually contain multiple execution engines. Each shall be given a +stable and unique name (), with possible values +documented in the driver specific documentation. +.TP +.IR drm-engine-: " [0-9]+ ns" +GPU engine utilization, time spent busy executing workloads for this client. +.TP +.IR drm-engine-capacity-: " [0-9]+" +Capacity of the engine if not 1, cannot be 0. +.TP +.IR drm-cycles-: " [0-9]+" +Contains the number of busy cycles for the given engine. Values are +not required to be constantly monotonic, but are required to catch up +with the previously reported larger value within a reasonable +period. Upon observing a value lower than what was previously read, +userspace is expected to stay with that larger previous value until a +monotonic update is seen. +.TP +.IR drm-total-cycles-: " [0-9]+" +Contains the total number cycles for the given engine. This is a +timestamp in GPU unspecified unit that matches the update rate of +drm-cycles-. For drivers that implement this interface, +the engine utilization can be calculated entirely on the GPU clock +domain, without considering the CPU sleep time between 2 samples. +.P +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 . +The name "memory" is reserved to refer to normal system memory. +.TP +.IR drm-memory-: " [0-9]+ [KiB|MiB]" +The amount of storage currently consumed by the buffer objects belong +to this client, in the respective memory region. +.IP +Default unit shall be bytes with optional unit specifiers of 'KiB' or 'MiB' +indicating kibi- or mebi-bytes. +.TP +.IR drm-shared-: " [0-9]+ [KiB|MiB]" +The total size of buffers that are shared with another file (e.g., have more +than a single handle). +.TP +.IR drm-total-: " [0-9]+ [KiB|MiB]" +The total size of buffers that including shared and private memory. +.TP +.IR drm-resident-: " [0-9]+ [KiB|MiB]" +The total size of buffers that are resident in the specified region. +.TP +.IR drm-purgeable-: " [0-9]+ [KiB|MiB]" +The total size of buffers that are purgeable. +.TP +.IR drm-active-: " [0-9]+ [KiB|MiB]" +The total size of buffers that are active on one or more engines. + .SH SEE ALSO .BR proc (5)