[linux-block.git] / include / uapi / linux / fanotify.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
#ifndef _UAPI_LINUX_FANOTIFY_H
#define _UAPI_LINUX_FANOTIFY_H

#include <linux/types.h>

/* the following events that user-space can register for */
#define FAN_ACCESS		0x00000001	/* File was accessed */
#define FAN_MODIFY		0x00000002	/* File was modified */
#define FAN_ATTRIB		0x00000004	/* Metadata changed */
#define FAN_CLOSE_WRITE		0x00000008	/* Writtable file closed */
#define FAN_CLOSE_NOWRITE	0x00000010	/* Unwrittable file closed */
#define FAN_OPEN		0x00000020	/* File was opened */
#define FAN_MOVED_FROM		0x00000040	/* File was moved from X */
#define FAN_MOVED_TO		0x00000080	/* File was moved to Y */
#define FAN_CREATE		0x00000100	/* Subfile was created */
#define FAN_DELETE		0x00000200	/* Subfile was deleted */
#define FAN_DELETE_SELF		0x00000400	/* Self was deleted */
#define FAN_MOVE_SELF		0x00000800	/* Self was moved */
#define FAN_OPEN_EXEC		0x00001000	/* File was opened for exec */

#define FAN_Q_OVERFLOW		0x00004000	/* Event queued overflowed */

#define FAN_OPEN_PERM		0x00010000	/* File open in perm check */
#define FAN_ACCESS_PERM		0x00020000	/* File accessed in perm check */
#define FAN_OPEN_EXEC_PERM	0x00040000	/* File open/exec in perm check */

#define FAN_ONDIR		0x40000000	/* event occurred against dir */

#define FAN_EVENT_ON_CHILD	0x08000000	/* interested in child events */

/* helper events */
#define FAN_CLOSE		(FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE) /* close */
#define FAN_MOVE		(FAN_MOVED_FROM | FAN_MOVED_TO) /* moves */

/* flags used for fanotify_init() */
#define FAN_CLOEXEC		0x00000001
#define FAN_NONBLOCK		0x00000002

/* These are NOT bitwise flags.  Both bits are used together.  */
#define FAN_CLASS_NOTIF		0x00000000
#define FAN_CLASS_CONTENT	0x00000004
#define FAN_CLASS_PRE_CONTENT	0x00000008

/* Deprecated - do not use this in programs and do not add new flags here! */
#define FAN_ALL_CLASS_BITS	(FAN_CLASS_NOTIF | FAN_CLASS_CONTENT | \
				 FAN_CLASS_PRE_CONTENT)

#define FAN_UNLIMITED_QUEUE	0x00000010
#define FAN_UNLIMITED_MARKS	0x00000020
#define FAN_ENABLE_AUDIT	0x00000040

/* Flags to determine fanotify event format */
#define FAN_REPORT_TID		0x00000100	/* event->pid is thread id */
#define FAN_REPORT_FID		0x00000200	/* Report unique file id */

/* Deprecated - do not use this in programs and do not add new flags here! */
#define FAN_ALL_INIT_FLAGS	(FAN_CLOEXEC | FAN_NONBLOCK | \
				 FAN_ALL_CLASS_BITS | FAN_UNLIMITED_QUEUE |\
				 FAN_UNLIMITED_MARKS)

/* flags used for fanotify_modify_mark() */
#define FAN_MARK_ADD		0x00000001
#define FAN_MARK_REMOVE		0x00000002
#define FAN_MARK_DONT_FOLLOW	0x00000004
#define FAN_MARK_ONLYDIR	0x00000008
/* FAN_MARK_MOUNT is		0x00000010 */
#define FAN_MARK_IGNORED_MASK	0x00000020
#define FAN_MARK_IGNORED_SURV_MODIFY	0x00000040
#define FAN_MARK_FLUSH		0x00000080
/* FAN_MARK_FILESYSTEM is	0x00000100 */

/* These are NOT bitwise flags.  Both bits can be used togther.  */
#define FAN_MARK_INODE		0x00000000
#define FAN_MARK_MOUNT		0x00000010
#define FAN_MARK_FILESYSTEM	0x00000100

/* Deprecated - do not use this in programs and do not add new flags here! */
#define FAN_ALL_MARK_FLAGS	(FAN_MARK_ADD |\
				 FAN_MARK_REMOVE |\
				 FAN_MARK_DONT_FOLLOW |\
				 FAN_MARK_ONLYDIR |\
				 FAN_MARK_MOUNT |\
				 FAN_MARK_IGNORED_MASK |\
				 FAN_MARK_IGNORED_SURV_MODIFY |\
				 FAN_MARK_FLUSH)

/* Deprecated - do not use this in programs and do not add new flags here! */
#define FAN_ALL_EVENTS (FAN_ACCESS |\
			FAN_MODIFY |\
			FAN_CLOSE |\
			FAN_OPEN)

/*
 * All events which require a permission response from userspace
 */
/* Deprecated - do not use this in programs and do not add new flags here! */
#define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM |\
			     FAN_ACCESS_PERM)

/* Deprecated - do not use this in programs and do not add new flags here! */
#define FAN_ALL_OUTGOING_EVENTS	(FAN_ALL_EVENTS |\
				 FAN_ALL_PERM_EVENTS |\
				 FAN_Q_OVERFLOW)

#define FANOTIFY_METADATA_VERSION	3

struct fanotify_event_metadata {
	__u32 event_len;
	__u8 vers;
	__u8 reserved;
	__u16 metadata_len;
	__aligned_u64 mask;
	__s32 fd;
	__s32 pid;
};

#define FAN_EVENT_INFO_TYPE_FID		1

/* Variable length info record following event metadata */
struct fanotify_event_info_header {
	__u8 info_type;
	__u8 pad;
	__u16 len;
};

/* Unique file identifier info record */
struct fanotify_event_info_fid {
	struct fanotify_event_info_header hdr;
	__kernel_fsid_t fsid;
	/*
	 * Following is an opaque struct file_handle that can be passed as
	 * an argument to open_by_handle_at(2).
	 */
	unsigned char handle[0];
};

struct fanotify_response {
	__s32 fd;
	__u32 response;
};

/* Legit userspace responses to a _PERM event */
#define FAN_ALLOW	0x01
#define FAN_DENY	0x02
#define FAN_AUDIT	0x10	/* Bit mask to create audit record for result */

/* No fd set in event */
#define FAN_NOFD	-1

/* Helper functions to deal with fanotify_event_metadata buffers */
#define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))

#define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
				   (struct fanotify_event_metadata*)(((char *)(meta)) + \
				   (meta)->event_len))

#define FAN_EVENT_OK(meta, len)	((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
				(long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
				(long)(meta)->event_len <= (long)(len))

#endif /* _UAPI_LINUX_FANOTIFY_H */
Commit	Line	Data
6f52b16c	1	/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
607ca46e DH	2	#ifndef _UAPI_LINUX_FANOTIFY_H
	3	#define _UAPI_LINUX_FANOTIFY_H
	4
	5	#include <linux/types.h>
	6
	7	/* the following events that user-space can register for */
	8	#define FAN_ACCESS 0x00000001 /* File was accessed */
	9	#define FAN_MODIFY 0x00000002 /* File was modified */
235328d1	10	#define FAN_ATTRIB 0x00000004 /* Metadata changed */
607ca46e DH	11	#define FAN_CLOSE_WRITE 0x00000008 /* Writtable file closed */
	12	#define FAN_CLOSE_NOWRITE 0x00000010 /* Unwrittable file closed */
	13	#define FAN_OPEN 0x00000020 /* File was opened */
235328d1 AG	14	#define FAN_MOVED_FROM 0x00000040 /* File was moved from X */
	15	#define FAN_MOVED_TO 0x00000080 /* File was moved to Y */
	16	#define FAN_CREATE 0x00000100 /* Subfile was created */
	17	#define FAN_DELETE 0x00000200 /* Subfile was deleted */
	18	#define FAN_DELETE_SELF 0x00000400 /* Self was deleted */
	19	#define FAN_MOVE_SELF 0x00000800 /* Self was moved */
9b076f1c	20	#define FAN_OPEN_EXEC 0x00001000 /* File was opened for exec */
607ca46e DH	21
	22	#define FAN_Q_OVERFLOW 0x00004000 /* Event queued overflowed */
	23
	24	#define FAN_OPEN_PERM 0x00010000 /* File open in perm check */
	25	#define FAN_ACCESS_PERM 0x00020000 /* File accessed in perm check */
66917a31	26	#define FAN_OPEN_EXEC_PERM 0x00040000 /* File open/exec in perm check */
607ca46e DH	27
	28	#define FAN_ONDIR 0x40000000 /* event occurred against dir */
	29
	30	#define FAN_EVENT_ON_CHILD 0x08000000 /* interested in child events */
	31
	32	/* helper events */
	33	#define FAN_CLOSE (FAN_CLOSE_WRITE \| FAN_CLOSE_NOWRITE) /* close */
235328d1	34	#define FAN_MOVE (FAN_MOVED_FROM \| FAN_MOVED_TO) /* moves */
607ca46e DH	35
	36	/* flags used for fanotify_init() */
	37	#define FAN_CLOEXEC 0x00000001
	38	#define FAN_NONBLOCK 0x00000002
	39
d54f4fba	40	/* These are NOT bitwise flags. Both bits are used together. */
607ca46e DH	41	#define FAN_CLASS_NOTIF 0x00000000
	42	#define FAN_CLASS_CONTENT 0x00000004
	43	#define FAN_CLASS_PRE_CONTENT 0x00000008
23c9deeb AG	44
23c9deeb AG	45	/* Deprecated - do not use this in programs and do not add new flags here! */
607ca46e DH	46	#define FAN_ALL_CLASS_BITS (FAN_CLASS_NOTIF \| FAN_CLASS_CONTENT \| \
	47	FAN_CLASS_PRE_CONTENT)
	48
	49	#define FAN_UNLIMITED_QUEUE 0x00000010
	50	#define FAN_UNLIMITED_MARKS 0x00000020
de8cd83e	51	#define FAN_ENABLE_AUDIT 0x00000040
607ca46e	52
d0a6a87e AG	53	/* Flags to determine fanotify event format */
d0a6a87e AG	54	#define FAN_REPORT_TID 0x00000100 /* event->pid is thread id */
e9e0c890	55	#define FAN_REPORT_FID 0x00000200 /* Report unique file id */
d0a6a87e	56
23c9deeb	57	/* Deprecated - do not use this in programs and do not add new flags here! */
607ca46e DH	58	#define FAN_ALL_INIT_FLAGS (FAN_CLOEXEC \| FAN_NONBLOCK \| \
	59	FAN_ALL_CLASS_BITS \| FAN_UNLIMITED_QUEUE \|\
	60	FAN_UNLIMITED_MARKS)
	61
	62	/* flags used for fanotify_modify_mark() */
	63	#define FAN_MARK_ADD 0x00000001
	64	#define FAN_MARK_REMOVE 0x00000002
	65	#define FAN_MARK_DONT_FOLLOW 0x00000004
	66	#define FAN_MARK_ONLYDIR 0x00000008
d54f4fba	67	/* FAN_MARK_MOUNT is 0x00000010 */
607ca46e DH	68	#define FAN_MARK_IGNORED_MASK 0x00000020
	69	#define FAN_MARK_IGNORED_SURV_MODIFY 0x00000040
	70	#define FAN_MARK_FLUSH 0x00000080
d54f4fba AG	71	/* FAN_MARK_FILESYSTEM is 0x00000100 */
	72
	73	/* These are NOT bitwise flags. Both bits can be used togther. */
	74	#define FAN_MARK_INODE 0x00000000
	75	#define FAN_MARK_MOUNT 0x00000010
	76	#define FAN_MARK_FILESYSTEM 0x00000100
607ca46e	77
23c9deeb	78	/* Deprecated - do not use this in programs and do not add new flags here! */
607ca46e DH	79	#define FAN_ALL_MARK_FLAGS (FAN_MARK_ADD \|\
	80	FAN_MARK_REMOVE \|\
	81	FAN_MARK_DONT_FOLLOW \|\
	82	FAN_MARK_ONLYDIR \|\
23c9deeb	83	FAN_MARK_MOUNT \|\
607ca46e DH	84	FAN_MARK_IGNORED_MASK \|\
607ca46e DH	85	FAN_MARK_IGNORED_SURV_MODIFY \|\
23c9deeb	86	FAN_MARK_FLUSH)
607ca46e	87
23c9deeb	88	/* Deprecated - do not use this in programs and do not add new flags here! */
607ca46e DH	89	#define FAN_ALL_EVENTS (FAN_ACCESS \|\
	90	FAN_MODIFY \|\
	91	FAN_CLOSE \|\
	92	FAN_OPEN)
	93
	94	/*
	95	* All events which require a permission response from userspace
	96	*/
23c9deeb	97	/* Deprecated - do not use this in programs and do not add new flags here! */
607ca46e DH	98	#define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM \|\
	99	FAN_ACCESS_PERM)
	100
23c9deeb	101	/* Deprecated - do not use this in programs and do not add new flags here! */
607ca46e DH	102	#define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS \|\
	103	FAN_ALL_PERM_EVENTS \|\
	104	FAN_Q_OVERFLOW)
	105
	106	#define FANOTIFY_METADATA_VERSION 3
	107
	108	struct fanotify_event_metadata {
	109	__u32 event_len;
	110	__u8 vers;
	111	__u8 reserved;
	112	__u16 metadata_len;
	113	__aligned_u64 mask;
	114	__s32 fd;
	115	__s32 pid;
	116	};
	117
5e469c83 AG	118	#define FAN_EVENT_INFO_TYPE_FID 1
	119
	120	/* Variable length info record following event metadata */
	121	struct fanotify_event_info_header {
	122	__u8 info_type;
	123	__u8 pad;
	124	__u16 len;
	125	};
	126
	127	/* Unique file identifier info record */
	128	struct fanotify_event_info_fid {
	129	struct fanotify_event_info_header hdr;
	130	__kernel_fsid_t fsid;
	131	/*
	132	* Following is an opaque struct file_handle that can be passed as
	133	* an argument to open_by_handle_at(2).
	134	*/
	135	unsigned char handle[0];
	136	};
	137
607ca46e DH	138	struct fanotify_response {
	139	__s32 fd;
	140	__u32 response;
	141	};
	142
	143	/* Legit userspace responses to a _PERM event */
	144	#define FAN_ALLOW 0x01
	145	#define FAN_DENY 0x02
de8cd83e SG	146	#define FAN_AUDIT 0x10 /* Bit mask to create audit record for result */
de8cd83e SG	147
607ca46e DH	148	/* No fd set in event */
	149	#define FAN_NOFD -1
	150
	151	/* Helper functions to deal with fanotify_event_metadata buffers */
	152	#define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))
	153
	154	#define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
	155	(struct fanotify_event_metadata)(((char )(meta)) + \
	156	(meta)->event_len))
	157
	158	#define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
	159	(long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
	160	(long)(meta)->event_len <= (long)(len))
	161
	162	#endif /* _UAPI_LINUX_FANOTIFY_H */