[linux-2.6-block.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 */

/* 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_ON_VFSMOUNT	0x00000010

#define FAN_ALL_MARK_FLAGS	(FAN_MARK_ADD |\
				 FAN_MARK_REMOVE |\
				 FAN_MARK_DONT_FOLLOW |\
				 FAN_MARK_ONLYDIR |\
				 FAN_MARK_ON_VFSMOUNT)

/*
 * 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 legal FAN bits userspace can request (although possibly not all
 * at the same time.
 */
#define FAN_ALL_INCOMING_EVENTS	(FAN_ALL_EVENTS |\
				 FAN_EVENT_ON_CHILD)

#define FAN_ALL_OUTGOING_EVENTS	(FAN_ALL_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));

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

#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
	18	/* helper events */
	19	#define FAN_CLOSE (FAN_CLOSE_WRITE \| FAN_CLOSE_NOWRITE) /* close */
	20
2a3edf86	21	/* flags used for fanotify_init() */
52c923dd EP	22	#define FAN_CLOEXEC 0x00000001
	23	#define FAN_NONBLOCK 0x00000002
	24
	25	#define FAN_ALL_INIT_FLAGS (FAN_CLOEXEC \| FAN_NONBLOCK)
2a3edf86 EP	26
	27	/* flags used for fanotify_modify_mark() */
	28	#define FAN_MARK_ADD 0x00000001
	29	#define FAN_MARK_REMOVE 0x00000002
	30	#define FAN_MARK_DONT_FOLLOW 0x00000004
	31	#define FAN_MARK_ONLYDIR 0x00000008
0ff21db9	32	#define FAN_MARK_ON_VFSMOUNT 0x00000010
2a3edf86 EP	33
	34	#define FAN_ALL_MARK_FLAGS (FAN_MARK_ADD \|\
	35	FAN_MARK_REMOVE \|\
	36	FAN_MARK_DONT_FOLLOW \|\
0ff21db9 EP	37	FAN_MARK_ONLYDIR \|\
0ff21db9 EP	38	FAN_MARK_ON_VFSMOUNT)
2a3edf86	39
ff0b16a9 EP	40	/*
	41	* All of the events - we build the list by hand so that we can add flags in
	42	* the future and not break backward compatibility. Apps will get only the
	43	* events that they originally wanted. Be sure to add new events here!
	44	*/
	45	#define FAN_ALL_EVENTS (FAN_ACCESS \|\
	46	FAN_MODIFY \|\
	47	FAN_CLOSE \|\
	48	FAN_OPEN)
	49
	50	/*
	51	* All legal FAN bits userspace can request (although possibly not all
	52	* at the same time.
	53	*/
	54	#define FAN_ALL_INCOMING_EVENTS (FAN_ALL_EVENTS \|\
	55	FAN_EVENT_ON_CHILD)
a1014f10 EP	56
	57	#define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS \|\
	58	FAN_Q_OVERFLOW)
	59
	60	#define FANOTIFY_METADATA_VERSION 1
	61
	62	struct fanotify_event_metadata {
	63	__u32 event_len;
	64	__u32 vers;
	65	__s32 fd;
	66	__u64 mask;
32c32632	67	__s64 pid;
a1014f10 EP	68	} __attribute__ ((packed));
	69
	70	/* Helper functions to deal with fanotify_event_metadata buffers */
	71	#define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))
	72
	73	#define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
	74	(struct fanotify_event_metadata)(((char )(meta)) + \
	75	(meta)->event_len))
	76
	77	#define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
	78	(long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
	79	(long)(meta)->event_len <= (long)(len))
	80
ff0b16a9 EP	81	#ifdef __KERNEL__
	82
	83	#endif /* __KERNEL__ */
	84	#endif /* _LINUX_FANOTIFY_H */