[net-next-2.6.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 */

/* FIXME currently Q's have no limit.... */
#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

#define FAN_ALL_INIT_FLAGS	(FAN_CLOEXEC | FAN_NONBLOCK)

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

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

struct fanotify_event_metadata {
	__u32 event_len;
	__u32 vers;
	__s32 fd;
	__u64 mask;
	__s64 pid;
} __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))

#ifdef __KERNEL__

struct fanotify_wait {
	struct fsnotify_event *event;
	__s32 fd;
};
#endif /* __KERNEL__ */
#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
	15	/* FIXME currently Q's have no limit.... */
	16	#define FAN_Q_OVERFLOW 0x00004000 /* Event queued overflowed */
	17
9e66e423 EP	18	#define FAN_OPEN_PERM 0x00010000 /* File open in perm check */
	19	#define FAN_ACCESS_PERM 0x00020000 /* File accessed in perm check */
	20
ff0b16a9 EP	21	/* helper events */
	22	#define FAN_CLOSE (FAN_CLOSE_WRITE \| FAN_CLOSE_NOWRITE) /* close */
	23
2a3edf86	24	/* flags used for fanotify_init() */
52c923dd EP	25	#define FAN_CLOEXEC 0x00000001
	26	#define FAN_NONBLOCK 0x00000002
	27
	28	#define FAN_ALL_INIT_FLAGS (FAN_CLOEXEC \| FAN_NONBLOCK)
2a3edf86 EP	29
	30	/* flags used for fanotify_modify_mark() */
	31	#define FAN_MARK_ADD 0x00000001
	32	#define FAN_MARK_REMOVE 0x00000002
	33	#define FAN_MARK_DONT_FOLLOW 0x00000004
	34	#define FAN_MARK_ONLYDIR 0x00000008
eac8e9e8	35	#define FAN_MARK_MOUNT 0x00000010
b9e4e3bd	36	#define FAN_MARK_IGNORED_MASK 0x00000020
c9778a98	37	#define FAN_MARK_IGNORED_SURV_MODIFY 0x00000040
4d92604c	38	#define FAN_MARK_FLUSH 0x00000080
2a3edf86 EP	39
	40	#define FAN_ALL_MARK_FLAGS (FAN_MARK_ADD \|\
	41	FAN_MARK_REMOVE \|\
	42	FAN_MARK_DONT_FOLLOW \|\
0ff21db9	43	FAN_MARK_ONLYDIR \|\
b9e4e3bd	44	FAN_MARK_MOUNT \|\
c9778a98 EP	45	FAN_MARK_IGNORED_MASK \|\
c9778a98 EP	46	FAN_MARK_IGNORED_SURV_MODIFY)
2a3edf86	47
ff0b16a9 EP	48	/*
	49	* All of the events - we build the list by hand so that we can add flags in
	50	* the future and not break backward compatibility. Apps will get only the
	51	* events that they originally wanted. Be sure to add new events here!
	52	*/
	53	#define FAN_ALL_EVENTS (FAN_ACCESS \|\
	54	FAN_MODIFY \|\
	55	FAN_CLOSE \|\
	56	FAN_OPEN)
	57
9e66e423 EP	58	/*
	59	* All events which require a permission response from userspace
	60	*/
	61	#define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM \|\
	62	FAN_ACCESS_PERM)
	63
a1014f10	64	#define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS \|\
9e66e423	65	FAN_ALL_PERM_EVENTS \|\
a1014f10 EP	66	FAN_Q_OVERFLOW)
	67
	68	#define FANOTIFY_METADATA_VERSION 1
	69
	70	struct fanotify_event_metadata {
	71	__u32 event_len;
	72	__u32 vers;
	73	__s32 fd;
	74	__u64 mask;
32c32632	75	__s64 pid;
a1014f10 EP	76	} __attribute__ ((packed));
a1014f10 EP	77
9e66e423 EP	78	/* Legit userspace responses to a _PERM event */
	79	#define FAN_ALLOW 0x01
	80	#define FAN_DENY 0x02
	81
a1014f10 EP	82	/* Helper functions to deal with fanotify_event_metadata buffers */
	83	#define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))
	84
	85	#define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
	86	(struct fanotify_event_metadata)(((char )(meta)) + \
	87	(meta)->event_len))
	88
	89	#define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
	90	(long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
	91	(long)(meta)->event_len <= (long)(len))
	92
ff0b16a9 EP	93	#ifdef __KERNEL__
ff0b16a9 EP	94
9e66e423 EP	95	struct fanotify_wait {
	96	struct fsnotify_event *event;
	97	__s32 fd;
	98	};
ff0b16a9 EP	99	#endif /* __KERNEL__ */
ff0b16a9 EP	100	#endif /* _LINUX_FANOTIFY_H */