Re: [PATCH] fanotify: Document FAN_REPORT_FD_ERROR

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

 



On Sun 30-03-25 14:51:46, Amir Goldstein wrote:
> This flag from v6.13 allows reporting detailed errors on failure to
> open a file descriptor for an event.
> 
> This API was backported to LTS kernels v6.12.4 and v6.6.66.
> 
> Cc: Krishna Vivek Vitta <kvitta@xxxxxxxxxxxxx>
> Signed-off-by: Amir Goldstein <amir73il@xxxxxxxxx>

The text looks correct to me. So feel free to add:

Reviewed-by: Jan Kara <jack@xxxxxxx>

Just two typo corrections below.

								Honza

> ---
>  man/man2/fanotify_init.2 | 29 +++++++++++++++++++++++++++++
>  man/man7/fanotify.7      | 12 ++++++++++++
>  2 files changed, 41 insertions(+)
> 
> diff --git a/man/man2/fanotify_init.2 b/man/man2/fanotify_init.2
> index fa4ae9125..23fbe126f 100644
> --- a/man/man2/fanotify_init.2
> +++ b/man/man2/fanotify_init.2
> @@ -364,6 +364,35 @@ so this restriction may eventually be lifted.
>  For more details on information records,
>  see
>  .BR fanotify (7).
> +.TP
> +.BR FAN_REPORT_FD_ERROR " (since Linux 6.13 and 6.12.4 and 6.6.66)"
> +.\" commit 522249f05c5551aec9ec0ba9b6438f1ec19c138d
> +Events for fanotify groups initialized with this flag may contain
> +an error code that explains the reason for failure to open a file descriptor.
> +The
> +.I fd
> +memeber of struct
   ^^^ typo here

> +.I fanotify_event_metadata
> +normally contains
> +an open file descriptor associated with the object of the event
> +or FAN_NOFD in case a file descriptor could not be opened.
> +For a group initialized with this flag, instead of FAN_NOFD,
> +the
> +.I fd
> +memeber of struct
   ^^^ typo here

> +.I fanotify_event_metadata
> +will contain
> +a negative error value.
> +When the group is also initialized with flag
> +.BR FAN_REPORT_PIDFD ,
> +in case a process file descriptor could not be opened,
> +the
> +.I pidfd
> +memeber of struct
> +.I fanotify_event_info_pidfd
> +will also contain a negative error value.
> +For more details, see
> +.BR fanotify (7).
>  .P
>  The
>  .I event_f_flags
> diff --git a/man/man7/fanotify.7 b/man/man7/fanotify.7
> index a5ddf1df0..7844f52f6 100644
> --- a/man/man7/fanotify.7
> +++ b/man/man7/fanotify.7
> @@ -335,6 +335,12 @@ file status flag is set on the open file description.
>  This flag suppresses fanotify event generation.
>  Hence, when the receiver of the fanotify event accesses the notified file or
>  directory using this file descriptor, no additional events will be created.
> +.IP
> +When an fanotify group is initialized using
> +.BR FAN_REPORT_FD_ERROR ,
> +this field will contain a negative error value in case a file descriptor
> +could not be opened and
> +in case of a queue overflow, the value will be -EBADF.
>  .TP
>  .I pid
>  If flag
> @@ -679,6 +685,12 @@ Once the event listener has dealt with an event
>  and the pidfd is no longer required,
>  the pidfd should be closed via
>  .BR close (2).
> +.IP
> +When an fanotify group is initialized using
> +.BR FAN_REPORT_FD_ERROR ,
> +this field will contain a negative error value
> +in case a pidfd creation failure and
> +in case of a terminated process, the value will be -ESRCH.
>  .P
>  The fields of the
>  .I fanotify_event_info_error
> -- 
> 2.34.1
> 
-- 
Jan Kara <jack@xxxxxxxx>
SUSE Labs, CR




[Index of Archives]     [Linux Ext4 Filesystem]     [Union Filesystem]     [Filesystem Testing]     [Ceph Users]     [Ecryptfs]     [NTFS 3]     [AutoFS]     [Kernel Newbies]     [Share Photos]     [Security]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux Cachefs]     [Reiser Filesystem]     [Linux RAID]     [NTFS 3]     [Samba]     [Device Mapper]     [CEPH Development]

  Powered by Linux