[PATCH] proc.5: document fdinfo format for timerfd

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Extended information for timerfd file descriptors in /proc/[pid]/fdinfo
was added in commit af9c4957cf21 ("timerfd: Implement show_fdinfo
method", 2014-07-16), to support checkpoint/restore for such file
descriptors (see also the TFD_IOC_SET_TICKS ioctl which is documented in
timerfd_create.2).

Signed-off-by: Lucas Werkmeister <mail@xxxxxxxxxxxxxxxxxxx>
---
 man5/proc.5 | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/man5/proc.5 b/man5/proc.5
index 55f3232a9..ae805d8eb 100644
--- a/man5/proc.5
+++ b/man5/proc.5
@@ -932,6 +932,51 @@ The mask of events that are ignored for this mark
 .IP
 For details on these fields, see
 .BR fanotify_mark (2).
+.IP
+For timerfd file descriptors (see
+.BR timerfd (2)),
+we see (since Linux 3.17)
+the following fields:
+.IP
+.in +4n
+.EX
+pos:    0
+flags:  02004002
+mnt_id: 13
+clockid: 0
+ticks: 0
+settime flags: 03
+it_value: (7695568592, 640020877)
+it_interval: (0, 0)
+.EE
+.in
+.IP
+.I clockid
+is the numeric value of the clock constant used to mark the progress of the timer
+(in this example, 0 is
+.BR CLOCK_REALTIME ).
+.I ticks
+is the number of timer expirations that have occurred,
+i.e. the value that
+.BR read (2)
+on it would return.
+.I settime flags
+lists the flags with which the timerfd was last armed (see
+.BR timerfd_settime (2)),
+in octal
+(in this example, both
+.B TFD_TIMER_ABSTIME
+and
+.B TFD_TIMER_CANCEL_ON_SET
+are set).
+.I it_value
+contains the amount of time until the timer will next expire, and
+.I it_interval
+contains the interval of the timer,
+both in seconds and nanoseconds,
+i.e. the values that
+.BR timerfd_gettime (2)
+on this file descriptor would return.
 .TP
 .IR /proc/[pid]/gid_map " (since Linux 3.5)"
 See
-- 
2.17.1

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux