From patchwork Fri Nov 1 19:11:53 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ian Rogers X-Patchwork-Id: 13859701 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 29E88E6F083 for ; Fri, 1 Nov 2024 19:12:03 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 6F49310E059; Fri, 1 Nov 2024 19:12:02 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.b="stnmpdw0"; dkim-atps=neutral Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.201]) by gabe.freedesktop.org (Postfix) with ESMTPS id 5ECDF10E059 for ; Fri, 1 Nov 2024 19:12:01 +0000 (UTC) Received: by mail-yw1-f201.google.com with SMTP id 00721157ae682-6e1fbe2a6b1so44587617b3.2 for ; Fri, 01 Nov 2024 12:12:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730488320; x=1731093120; darn=lists.freedesktop.org; h=cc:to:from:subject:mime-version:message-id:date:from:to:cc:subject :date:message-id:reply-to; bh=qGyHLoLCO60zyzVrXBcmBsuhk/6ChoSuiiRvD06R0Ao=; b=stnmpdw0YWfZDE/NtGn0iDRGwulwH6//hZ+O3KKO6cQofI0mquUPKUhIE4Wgto6zXw x/X/fHMJpU9Bw3xa8U38J+AQceeSu/BrS/BCr038dfGWawSKxdLsKu+qQQdDkUHEj4xO 8+E2whxHruTL3+ZLNkztGjdDMVmAur00LPTdnnU5E2fHEmZg1/1j8Do0UQLWxVrBCpBI q4bpLUB2WRWTZl+rlaprsr6C8wfYXh1f6Rp5cbQcXdYFerffo/VmorKhVm3PXOwdpN7e kYwCrI41DhCcA2B5dzL1xWkgvbCO7FyLNcUpyJ62IaKd2FKTmYxE1W1nW26m9oagV4iu WYuQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730488320; x=1731093120; h=cc:to:from:subject:mime-version:message-id:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=qGyHLoLCO60zyzVrXBcmBsuhk/6ChoSuiiRvD06R0Ao=; b=B8EbKrv1kJyPtRk1yPpG0HiQ3hNWxs1tf6DWDRxsORixOgBsBek4e/9/BMBMvdO3EI /yjyrnqXN8clsnbQPD3S0OaF+9R4sreyFyLqy11WOgcs1W/jmw5mfAk+maTDipHQZ1Jl 9RaVScrrDoWH9es7sKNuH0WCSXk9Y1KZQt6DRsA1/cO4jS1lfLzi8VpQ/xsO0zy69Pu+ AS6B46sfZA8sMGcHRJ4r0qnikOgnCLfevatst0ArUYqlZYtdwDhrsD6ywN5iZ5N7euks OxM5FjG6pN72h2s8mzxhmoRFxE0mB9dH3KT037VYnIyi51CWo3ZL1/JfPs4syBFRPYzu vb4g== X-Forwarded-Encrypted: i=1; AJvYcCWlWGQoPorvjWfDoTbs+4yWegJHKSLyAykRl/UxaiG045wNihhe/7BQzi4Q2qjIoDQroHxHQWTN/Mo=@lists.freedesktop.org X-Gm-Message-State: AOJu0YzWX0KBL7v5eS4TRQ0pHyNMP0L2m5GzuiAYL/LcJ8g9xwO/HAW9 0KZrL2e0dB1tnTjP4WEkqa3uxEpwqhHMPbzFfVdijjWg0pptmkVqVu1AGWAWvRPJFZfqgMpbotr XxE3jww== X-Google-Smtp-Source: AGHT+IExfO3GhTUorPhn74vvA2Ew+xUdeuR6Buzz+Y5G9C5vnSgo3TGMxhFt4h9DTJYT75pyQsEjAcCgqPg3 X-Received: from irogers.svl.corp.google.com ([2620:15c:2c5:11:f2e6:5ab5:a95f:35cb]) (user=irogers job=sendgmr) by 2002:a05:690c:6913:b0:6e3:1627:e866 with SMTP id 00721157ae682-6e9d8b8da3fmr8768857b3.3.1730488320283; Fri, 01 Nov 2024 12:12:00 -0700 (PDT) Date: Fri, 1 Nov 2024 12:11:53 -0700 Message-Id: <20241101191156.1272730-1-irogers@google.com> Mime-Version: 1.0 X-Mailer: git-send-email 2.47.0.199.ga7371fff76-goog Subject: [PATCH v3 1/4] proc_pid_fdinfo.5: Reduce indent for most of the page From: Ian Rogers To: Alejandro Colomar , "G . Branden Robinson" 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. Remove the initial tagged pragraph. Suggested-by: G. Branden Robinson Signed-off-by: Ian Rogers --- man/man5/proc_pid_fdinfo.5 | 52 ++++++++++++++++++-------------------- 1 file changed, 25 insertions(+), 27 deletions(-) diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5 index 1e23bbe02..87e6dbe56 100644 --- a/man/man5/proc_pid_fdinfo.5 +++ b/man/man5/proc_pid_fdinfo.5 @@ -8,18 +8,17 @@ .SH NAME /proc/pid/fdinfo/ \- information about file descriptors .SH DESCRIPTION -.TP -.IR /proc/ pid /fdinfo/ " (since Linux 2.6.22)" -This is a subdirectory containing one entry for each file which the +Since Linux 2.6.22, +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. 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 +27,7 @@ flags: 01002002 mnt_id: 21 .EE .in -.IP +.P The fields are as follows: .RS .TP @@ -51,7 +50,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 +57,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 +72,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 +91,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 +108,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 +123,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 +133,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 +148,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 +166,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 +188,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 +208,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 +226,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 Fri Nov 1 19:11:54 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ian Rogers X-Patchwork-Id: 13859702 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 0D5E6E6F083 for ; Fri, 1 Nov 2024 19:12:06 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 20BE510E9F6; Fri, 1 Nov 2024 19:12:04 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.b="LEsK36u9"; dkim-atps=neutral Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.201]) by gabe.freedesktop.org (Postfix) with ESMTPS id 1DD0F10E9F6 for ; Fri, 1 Nov 2024 19:12:03 +0000 (UTC) Received: by mail-yw1-f201.google.com with SMTP id 00721157ae682-6e3d660a1afso48184857b3.0 for ; Fri, 01 Nov 2024 12:12:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730488322; x=1731093122; 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=GTmM4lMLfU7fGWgK3OZ9YV6wKdDzMuf6g9cMhIBqTuY=; b=LEsK36u9si6gEsEQTKC+qyYbcAPIwHqVQiBrNybSQAkrROJoKBHg2cpcNE6gaORzvt 2orkTKHgB3ULkLUqt6O39F4V1uoA1N+DKsQ7ouhA3T9mk3r3K9EaD+xVmipWYhokNgzK NCxv9YkBbfktHyoV2xF7gu3x5AkmkJiSwH5gHDcOb5gjNsOrq9vK5fGiKx54CYjV3i0+ TC1XCyrl1OJXvZeW1dJ5jXzrXPsLp3RVKHe9/mSKUYAObMFdvH49e1X57R6abCgTG5e2 DNPo+2VYy3c8Wz7Yx7wVNhxmRg4h0MLYgWQVyD4JItTt1CYyNSS2S2o35TCcKDMIUmlK 7NUw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730488322; x=1731093122; 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=GTmM4lMLfU7fGWgK3OZ9YV6wKdDzMuf6g9cMhIBqTuY=; b=EwoQbk4BGp14i1P/W3Upv3QzqSb346H/s7ZgiEv9GzbJywgzsAjiT8vOl7EOxvelQj thCuMk03McfzAfEOjePHso34smnk0AQUyO2nLYj3Q/twIVuRN2w02gvpxUddkx9sjHed gPdHo9D5tbG8qA56aiItj+gqhr+mU2s+MtZi+nCISIZlWHgMM9XyzuoBxpEbtnS6r6C7 phhG957MdlyTyNvBSh9DmyzSne6iWBar7XBHq+gqkp7j7vf9d/U/M5kqsb40Zn1ShrV9 aOlcqNwuASpA9DQlZlS8V+q11IiI0K8s0kp7LGc5RFigxeTIT1cfJcMJlAi35mgeg3cP J6zQ== X-Forwarded-Encrypted: i=1; AJvYcCWlDBTl/sTUhB+pJ0u10/tI77GbF099wGlilO4uDVq5X4ZdnOYlkz1sPd7t/Z3C+g/jJA2Esq4fhXE=@lists.freedesktop.org X-Gm-Message-State: AOJu0Yy/U63tLPfCqEI13GQWFvuf2yahMfUjXlwX1T0P2hhQHyKn0uHR ZHp74eNOTFkDRWNzXJdPq9kzDSQzJwPGAraU7kGYJL4iQnu0ZKhi4+szl5b0SSQnjh20gftCUmF 4Zebk9g== X-Google-Smtp-Source: AGHT+IEFgEJ9V+dh83TejHj9KUuGhQ2RdYn3JAxq+LxsKxbpt4nL0i5Wq1qyj0+MuSpB5JhnuJSnp05GuRfa X-Received: from irogers.svl.corp.google.com ([2620:15c:2c5:11:f2e6:5ab5:a95f:35cb]) (user=irogers job=sendgmr) by 2002:a05:690c:6c8c:b0:6e3:1702:b3e6 with SMTP id 00721157ae682-6ea64b8c450mr305747b3.4.1730488322219; Fri, 01 Nov 2024 12:12:02 -0700 (PDT) Date: Fri, 1 Nov 2024 12:11:54 -0700 In-Reply-To: <20241101191156.1272730-1-irogers@google.com> Message-Id: <20241101191156.1272730-2-irogers@google.com> Mime-Version: 1.0 References: <20241101191156.1272730-1-irogers@google.com> X-Mailer: git-send-email 2.47.0.199.ga7371fff76-goog Subject: [PATCH v3 2/4] proc_pid_fdinfo.5: Make pid clearer in the name and 1st paragraph From: Ian Rogers To: Alejandro Colomar , "G . Branden Robinson" 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" Previously the pid was highlighted through being a tagged paragraph but not mentioned in the description. Add italics to the path emphasizing pid and then change the first sentence to include pid in the definition. Suggested-by: G. Branden Robinson Signed-off-by: Ian Rogers --- man/man5/proc_pid_fdinfo.5 | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5 index 87e6dbe56..935b54b4c 100644 --- a/man/man5/proc_pid_fdinfo.5 +++ b/man/man5/proc_pid_fdinfo.5 @@ -6,11 +6,12 @@ .\" .TH proc_pid_fdinfo 5 (date) "Linux man-pages (unreleased)" .SH NAME -/proc/pid/fdinfo/ \- information about file descriptors +.IR /proc/ pid /fdinfo " \- information about file descriptors" .SH DESCRIPTION Since Linux 2.6.22, -this is a subdirectory containing one entry for each file which the -process has open, named by its file descriptor. +this subdirectory contains one entry for each file that process +.IR pid +has open, named by its file descriptor. The files in this directory are readable only by the owner of the process. The contents of each file can be read to obtain information about the corresponding file descriptor. From patchwork Fri Nov 1 19:11:55 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ian Rogers X-Patchwork-Id: 13859703 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 B60E3E6F084 for ; Fri, 1 Nov 2024 19:12:07 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 8A80310E9F9; Fri, 1 Nov 2024 19:12:06 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.b="wrlVYoi8"; dkim-atps=neutral Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.201]) by gabe.freedesktop.org (Postfix) with ESMTPS id 318F510E9F9 for ; Fri, 1 Nov 2024 19:12:05 +0000 (UTC) Received: by mail-yw1-f201.google.com with SMTP id 00721157ae682-6e35199eb2bso45436347b3.3 for ; Fri, 01 Nov 2024 12:12:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730488324; x=1731093124; 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=Gkz28xMAWt/2KXNBG3XjAFk4KTwZpcO3i3iJdGxkSFg=; b=wrlVYoi8ymwVla7JU03jZM974N9//GkDirs/8pgs+8rUGwvU+vXxf762BuOmK33VZc 7k6wCU1cZ2cr7di1cqFsEPHGDWqlhMtpiCpt2Qit4IHdmt83wQs9qxspTWRXnhMFKZCu pKpLpjMoGR0VV52eH7QPHU7iElmecKQ4iqId476orsjT8Ew10rgmAXNcpUothpof0uL/ kj07geTNIQseqc1La+Rpwt3jRSZIHxVfrCvOYrXXy6QjVDeVj0h7ZHdnRhLb83KIGOkp OlOfpdfSmMC9Euu+OljMctyORBqidfdtxXIlSXBxy8LoIRDpxt0l/w4ATYyAL/0OfKcU 80uw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730488324; x=1731093124; 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=Gkz28xMAWt/2KXNBG3XjAFk4KTwZpcO3i3iJdGxkSFg=; b=OqhDlRASGkmGtroWcJ5pYkSCQwJACicRdTCXDMPj+x9rlyO7UOdxwohBfEs15NToRN SlrEUNl4sWBStv6fQk2CsirstcbGgWLukUdkj+Swm3KMuh+OAHMeyr/3A0irS78uf59p Rq5mqFEn91gGDCDH6dZfbWL2bphtkQaTZPSolwdqByrVo7/PFM/kAiPJErkQWkqSY46F M6iYORA5dBwvCa0EhaIU8pc3bRWpxQ79+kxx5tQ+cVjN7c7ZR44Js//+DfeE5fWRawZP 6HNDmV0p/fev/dBN9cPIsXChr9gNp0xyCYZ9QIxlfFp+dKqNU/7232lzqkb+1B1j4GEu zQQw== X-Forwarded-Encrypted: i=1; AJvYcCWjVXG8Dh9+XQsqrwqO5e91dKOLidVk0L/zOQFUQAWeQqdc6SaHaPacHBo62JT5k2HRikCKuEvAPBw=@lists.freedesktop.org X-Gm-Message-State: AOJu0YzNUdZVuPVbAhDrV0scogMwjVT+eXdJk6O9l+Qgifc8T6YRor97 FiB7adM2ic9J/kIBqlr6moDUppCq5szJAwtaWQOyLvrWJgTH8QYCIqOr++2u77Gt8aiKIHBKiln JIFUFrA== X-Google-Smtp-Source: AGHT+IFNeLRXXudDwC0gCZ6v3ZzzirUae1o9p+zQDA9iH2FxOAlGCG5xI1JIXPP3rrEcjJqvieuCor38xzmk X-Received: from irogers.svl.corp.google.com ([2620:15c:2c5:11:f2e6:5ab5:a95f:35cb]) (user=irogers job=sendgmr) by 2002:a05:690c:6482:b0:6c1:298e:5a7 with SMTP id 00721157ae682-6ea64bed332mr945727b3.5.1730488324379; Fri, 01 Nov 2024 12:12:04 -0700 (PDT) Date: Fri, 1 Nov 2024 12:11:55 -0700 In-Reply-To: <20241101191156.1272730-1-irogers@google.com> Message-Id: <20241101191156.1272730-3-irogers@google.com> Mime-Version: 1.0 References: <20241101191156.1272730-1-irogers@google.com> X-Mailer: git-send-email 2.47.0.199.ga7371fff76-goog Subject: [PATCH v3 3/4] proc_pid_fdinfo.5: Add subsection headers for different fd types From: Ian Rogers To: Alejandro Colomar , "G . Branden Robinson" 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 935b54b4c..290cae6a6 100644 --- a/man/man5/proc_pid_fdinfo.5 +++ b/man/man5/proc_pid_fdinfo.5 @@ -58,6 +58,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)), @@ -76,6 +77,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)), @@ -109,6 +111,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)), @@ -134,6 +137,7 @@ and .BR SIGQUIT ; see .BR signal (7).) +.SS inotify .P For inotify file descriptors (see .BR inotify (7)), @@ -174,6 +178,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)), @@ -230,6 +235,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 Fri Nov 1 19:11:56 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ian Rogers X-Patchwork-Id: 13859704 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 7281BE6F07D for ; Fri, 1 Nov 2024 19:12:09 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id D741A10E9FA; Fri, 1 Nov 2024 19:12:08 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.b="URjFiz8l"; dkim-atps=neutral Received: from mail-yw1-f202.google.com (mail-yw1-f202.google.com [209.85.128.202]) by gabe.freedesktop.org (Postfix) with ESMTPS id 5660B10E9FA for ; Fri, 1 Nov 2024 19:12:07 +0000 (UTC) Received: by mail-yw1-f202.google.com with SMTP id 00721157ae682-6e3231725c9so46494007b3.1 for ; Fri, 01 Nov 2024 12:12:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730488326; x=1731093126; 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=ohnZM44rwMZlspoSV7nexQOFx9fd9I0RoLZU+lRn4Jw=; b=URjFiz8lpyeVBaFsoqdqipqP4n8VYjDNYWzMhChBmWnH+gfZBVd3KH/mH7JV5g/u5Z LK9AYMGWNDTvtYhM6u67XKX+RN60xP7qVL4KilZjsvqVoEoTgdy527qmSO3z6TQPa/yc pN0U2MctIcsiDu2cgUH7atS/fZhGRkJIH/2lpAZnWisSqI3D44BXEUxjy490+F4PW0qo /7CJnjcYZcrTMSvwXIfRtPfnZeym6BbgkC/j7ekvKypeFN+4TMI6XrwTGRTWAMc21N2k Ae8QWF041VOQ3qz1iifa8ZBS8/0utQVo+Adc1AMcadnNsTSh+stTMRtKFyUyevsbyzLH WR6w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730488326; x=1731093126; 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=ohnZM44rwMZlspoSV7nexQOFx9fd9I0RoLZU+lRn4Jw=; b=nyrR0Bb2fVTDMJcu3zpoJJYVw11OTweZSrHUlti2p+F9ZCC5/t3VGa4Chv4bnfxcP4 5caRjj7YwcZsSpZ9VTvSbKUQxLPIHhUvcspVKnLKmlbRBfYPHCSFzadKPYkJhCxPeo4y eutMv4W/Dogux4A8JVQqEKMxbjR+HwqKJLWeDwtz7vVTHfwRSaGrGdBPNezWkITjAE3j l8+80iPTqgxHoQYJinlHGsEtRLuZ3xMBvEjyjT022Pxbe3FoS16r/QZmx+zyRVYwi7iI 4bsBS2JRFWA+hSyp/14MGItjbHrrps6xNiXufhizxQu009EX34VKeNQgZQRgaoppVxr3 TGww== X-Forwarded-Encrypted: i=1; AJvYcCWagKyWTc8aIQSUqYzWRZJCsVoz+R5aydzwJvgF36TvEkUgOhhpZhsoHi191eMIGXUKi8ZVf/tamPw=@lists.freedesktop.org X-Gm-Message-State: AOJu0YwVU8KdZUosYrMcJFcYaxCLd7wU4JYXU1/fEYWxSH+YvvENLJFE jR7xTw5zOdUn0IHT1l+SuKa0/aT9D2ND5uMrGRhbesHaI3HaPnGFA9u0PQvqh+9/yQW0s9hQHJS GRRJ7uA== X-Google-Smtp-Source: AGHT+IEuIJAQ2wb2B6bc2za+FDb03I7t2GB4uUnxnQv8Bdi+HQoDpYmPSz/8C2693i9quEq0xJ1kmlxHgSAn X-Received: from irogers.svl.corp.google.com ([2620:15c:2c5:11:f2e6:5ab5:a95f:35cb]) (user=irogers job=sendgmr) by 2002:a05:690c:6407:b0:6e3:8562:ffa with SMTP id 00721157ae682-6e9d8b5f046mr14987157b3.5.1730488326506; Fri, 01 Nov 2024 12:12:06 -0700 (PDT) Date: Fri, 1 Nov 2024 12:11:56 -0700 In-Reply-To: <20241101191156.1272730-1-irogers@google.com> Message-Id: <20241101191156.1272730-4-irogers@google.com> Mime-Version: 1.0 References: <20241101191156.1272730-1-irogers@google.com> X-Mailer: git-send-email 2.47.0.199.ga7371fff76-goog Subject: [PATCH v3 4/4] proc_pid_fdinfo.5: Add DRM subsection From: Ian Rogers To: Alejandro Colomar , "G . Branden Robinson" 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 290cae6a6..98ac12f16 100644 --- a/man/man5/proc_pid_fdinfo.5 +++ b/man/man5/proc_pid_fdinfo.5 @@ -301,5 +301,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)