[mirror_ubuntu-bionic-kernel.git] / include / linux / fanotify.h

#ifndef _LINUX_FANOTIFY_H
#define _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_CLOSE_WRITE		0x00000008	/* Unwrittable file closed */
#define FAN_CLOSE_NOWRITE	0x00000010	/* Writtable file closed */
#define FAN_OPEN		0x00000020	/* File was opened */

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

#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 */

/* helper events */
#define FAN_CLOSE		(FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE) /* close */

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

/* These are NOT bitwise flags.  Both bits are used togther.  */
#define FAN_CLASS_NOTIF		0x00000000
#define FAN_CLASS_CONTENT	0x00000004
#define FAN_CLASS_PRE_CONTENT	0x00000008
#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_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
#define FAN_MARK_MOUNT		0x00000010
#define FAN_MARK_IGNORED_MASK	0x00000020
#define FAN_MARK_IGNORED_SURV_MODIFY	0x00000040
#define FAN_MARK_FLUSH		0x00000080

#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)

/*
 * All of the events - we build the list by hand so that we can add flags in
 * the future and not break backward compatibility.  Apps will get only the
 * events that they originally wanted.  Be sure to add new events here!
 */
#define FAN_ALL_EVENTS (FAN_ACCESS |\
			FAN_MODIFY |\
			FAN_CLOSE |\
			FAN_OPEN)

/*
 * All events which require a permission response from userspace
 */
#define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM |\
			     FAN_ACCESS_PERM)

#define FAN_ALL_OUTGOING_EVENTS	(FAN_ALL_EVENTS |\
				 FAN_ALL_PERM_EVENTS |\
				 FAN_Q_OVERFLOW)

#define FANOTIFY_METADATA_VERSION	2

struct fanotify_event_metadata {
	__u32 event_len;
	__u32 vers;
	__aligned_u64 mask;
	__s32 fd;
	__s32 pid;
};

struct fanotify_response {
	__s32 fd;
	__u32 response;
} __attribute__ ((packed));

/* Legit userspace responses to a _PERM event */
#define FAN_ALLOW	0x01
#define FAN_DENY	0x02

/* 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 /* _LINUX_FANOTIFY_H */
Commit	Line	Data
ff0b16a9 EP	1	#ifndef _LINUX_FANOTIFY_H
	2	#define _LINUX_FANOTIFY_H
	3
	4	#include <linux/types.h>
	5
	6	/* the following events that user-space can register for */
	7	#define FAN_ACCESS 0x00000001 /* File was accessed */
	8	#define FAN_MODIFY 0x00000002 /* File was modified */
	9	#define FAN_CLOSE_WRITE 0x00000008 /* Unwrittable file closed */
	10	#define FAN_CLOSE_NOWRITE 0x00000010 /* Writtable file closed */
	11	#define FAN_OPEN 0x00000020 /* File was opened */
	12
	13	#define FAN_EVENT_ON_CHILD 0x08000000 /* interested in child events */
	14
ff0b16a9 EP	15	#define FAN_Q_OVERFLOW 0x00004000 /* Event queued overflowed */
ff0b16a9 EP	16
9e66e423 EP	17	#define FAN_OPEN_PERM 0x00010000 /* File open in perm check */
	18	#define FAN_ACCESS_PERM 0x00020000 /* File accessed in perm check */
	19
ff0b16a9 EP	20	/* helper events */
	21	#define FAN_CLOSE (FAN_CLOSE_WRITE \| FAN_CLOSE_NOWRITE) /* close */
	22
2a3edf86	23	/* flags used for fanotify_init() */
52c923dd EP	24	#define FAN_CLOEXEC 0x00000001
	25	#define FAN_NONBLOCK 0x00000002
	26
4231a235 EP	27	/* These are NOT bitwise flags. Both bits are used togther. */
	28	#define FAN_CLASS_NOTIF 0x00000000
	29	#define FAN_CLASS_CONTENT 0x00000004
	30	#define FAN_CLASS_PRE_CONTENT 0x00000008
4231a235 EP	31	#define FAN_ALL_CLASS_BITS (FAN_CLASS_NOTIF \| FAN_CLASS_CONTENT \| \
	32	FAN_CLASS_PRE_CONTENT)
	33
5dd03f55	34	#define FAN_UNLIMITED_QUEUE 0x00000010
ac7e22dc	35	#define FAN_UNLIMITED_MARKS 0x00000020
5dd03f55	36
4231a235	37	#define FAN_ALL_INIT_FLAGS (FAN_CLOEXEC \| FAN_NONBLOCK \| \
ac7e22dc EP	38	FAN_ALL_CLASS_BITS \| FAN_UNLIMITED_QUEUE \|\
ac7e22dc EP	39	FAN_UNLIMITED_MARKS)
2a3edf86 EP	40
	41	/* flags used for fanotify_modify_mark() */
	42	#define FAN_MARK_ADD 0x00000001
	43	#define FAN_MARK_REMOVE 0x00000002
	44	#define FAN_MARK_DONT_FOLLOW 0x00000004
	45	#define FAN_MARK_ONLYDIR 0x00000008
eac8e9e8	46	#define FAN_MARK_MOUNT 0x00000010
b9e4e3bd	47	#define FAN_MARK_IGNORED_MASK 0x00000020
c9778a98	48	#define FAN_MARK_IGNORED_SURV_MODIFY 0x00000040
4d92604c	49	#define FAN_MARK_FLUSH 0x00000080
2a3edf86 EP	50
	51	#define FAN_ALL_MARK_FLAGS (FAN_MARK_ADD \|\
	52	FAN_MARK_REMOVE \|\
	53	FAN_MARK_DONT_FOLLOW \|\
0ff21db9	54	FAN_MARK_ONLYDIR \|\
b9e4e3bd	55	FAN_MARK_MOUNT \|\
c9778a98	56	FAN_MARK_IGNORED_MASK \|\
bbf2aba5 EP	57	FAN_MARK_IGNORED_SURV_MODIFY \|\
bbf2aba5 EP	58	FAN_MARK_FLUSH)
2a3edf86	59
ff0b16a9 EP	60	/*
	61	* All of the events - we build the list by hand so that we can add flags in
	62	* the future and not break backward compatibility. Apps will get only the
	63	* events that they originally wanted. Be sure to add new events here!
	64	*/
	65	#define FAN_ALL_EVENTS (FAN_ACCESS \|\
	66	FAN_MODIFY \|\
	67	FAN_CLOSE \|\
	68	FAN_OPEN)
	69
9e66e423 EP	70	/*
	71	* All events which require a permission response from userspace
	72	*/
	73	#define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM \|\
	74	FAN_ACCESS_PERM)
	75
a1014f10	76	#define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS \|\
9e66e423	77	FAN_ALL_PERM_EVENTS \|\
a1014f10 EP	78	FAN_Q_OVERFLOW)
a1014f10 EP	79
0fb85621	80	#define FANOTIFY_METADATA_VERSION 2
a1014f10 EP	81
	82	struct fanotify_event_metadata {
	83	__u32 event_len;
	84	__u32 vers;
28682019	85	__aligned_u64 mask;
0fb85621 TU	86	__s32 fd;
0fb85621 TU	87	__s32 pid;
28682019	88	};
a1014f10	89
b2d87909 EP	90	struct fanotify_response {
	91	__s32 fd;
	92	__u32 response;
	93	} __attribute__ ((packed));
	94
9e66e423 EP	95	/* Legit userspace responses to a _PERM event */
	96	#define FAN_ALLOW 0x01
	97	#define FAN_DENY 0x02
	98
a1014f10 EP	99	/* Helper functions to deal with fanotify_event_metadata buffers */
	100	#define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))
	101
	102	#define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
	103	(struct fanotify_event_metadata)(((char )(meta)) + \
	104	(meta)->event_len))
	105
	106	#define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
	107	(long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
	108	(long)(meta)->event_len <= (long)(len))
	109
ff0b16a9	110	#endif /* _LINUX_FANOTIFY_H */