blob: 0f0121467fc4b8cf261cbb06a9ff6347b3596474 [file] [log] [blame]
Eric Parisff0b16a2009-12-17 21:24:25 -05001#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 */
Stefan Hajnoczi50e4a982010-10-28 17:21:59 -04009#define FAN_CLOSE_WRITE 0x00000008 /* Writtable file closed */
10#define FAN_CLOSE_NOWRITE 0x00000010 /* Unwrittable file closed */
Eric Parisff0b16a2009-12-17 21:24:25 -050011#define FAN_OPEN 0x00000020 /* File was opened */
12
Eric Parisff0b16a2009-12-17 21:24:25 -050013#define FAN_Q_OVERFLOW 0x00004000 /* Event queued overflowed */
14
Eric Paris9e66e422009-12-17 21:24:34 -050015#define FAN_OPEN_PERM 0x00010000 /* File open in perm check */
16#define FAN_ACCESS_PERM 0x00020000 /* File accessed in perm check */
17
Eric Paris8fcd6522010-10-28 17:21:59 -040018#define FAN_ONDIR 0x40000000 /* event occurred against dir */
19
20#define FAN_EVENT_ON_CHILD 0x08000000 /* interested in child events */
21
Eric Parisff0b16a2009-12-17 21:24:25 -050022/* helper events */
23#define FAN_CLOSE (FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE) /* close */
24
Eric Paris2a3edf82009-12-17 21:24:26 -050025/* flags used for fanotify_init() */
Eric Paris52c923d2009-12-17 21:24:26 -050026#define FAN_CLOEXEC 0x00000001
27#define FAN_NONBLOCK 0x00000002
28
Eric Paris4231a232010-10-28 17:21:56 -040029/* These are NOT bitwise flags. Both bits are used togther. */
30#define FAN_CLASS_NOTIF 0x00000000
31#define FAN_CLASS_CONTENT 0x00000004
32#define FAN_CLASS_PRE_CONTENT 0x00000008
Eric Paris4231a232010-10-28 17:21:56 -040033#define FAN_ALL_CLASS_BITS (FAN_CLASS_NOTIF | FAN_CLASS_CONTENT | \
34 FAN_CLASS_PRE_CONTENT)
35
Eric Paris5dd03f52010-10-28 17:21:57 -040036#define FAN_UNLIMITED_QUEUE 0x00000010
Eric Parisac7e22d2010-10-28 17:21:58 -040037#define FAN_UNLIMITED_MARKS 0x00000020
Eric Paris5dd03f52010-10-28 17:21:57 -040038
Eric Paris4231a232010-10-28 17:21:56 -040039#define FAN_ALL_INIT_FLAGS (FAN_CLOEXEC | FAN_NONBLOCK | \
Eric Parisac7e22d2010-10-28 17:21:58 -040040 FAN_ALL_CLASS_BITS | FAN_UNLIMITED_QUEUE |\
41 FAN_UNLIMITED_MARKS)
Eric Paris2a3edf82009-12-17 21:24:26 -050042
43/* flags used for fanotify_modify_mark() */
44#define FAN_MARK_ADD 0x00000001
45#define FAN_MARK_REMOVE 0x00000002
46#define FAN_MARK_DONT_FOLLOW 0x00000004
47#define FAN_MARK_ONLYDIR 0x00000008
Andreas Gruenbachereac8e9e2009-12-17 21:24:29 -050048#define FAN_MARK_MOUNT 0x00000010
Eric Parisb9e4e3b2009-12-17 21:24:33 -050049#define FAN_MARK_IGNORED_MASK 0x00000020
Eric Parisc9778a92009-12-17 21:24:33 -050050#define FAN_MARK_IGNORED_SURV_MODIFY 0x00000040
Eric Paris4d926042009-12-17 21:24:34 -050051#define FAN_MARK_FLUSH 0x00000080
Eric Paris8fcd6522010-10-28 17:21:59 -040052#ifdef __KERNEL__
53/* not valid from userspace, only kernel internal */
54#define FAN_MARK_ONDIR 0x00000100
55#endif
Eric Paris2a3edf82009-12-17 21:24:26 -050056
57#define FAN_ALL_MARK_FLAGS (FAN_MARK_ADD |\
58 FAN_MARK_REMOVE |\
59 FAN_MARK_DONT_FOLLOW |\
Eric Paris0ff21db2009-12-17 21:24:29 -050060 FAN_MARK_ONLYDIR |\
Eric Parisb9e4e3b2009-12-17 21:24:33 -050061 FAN_MARK_MOUNT |\
Eric Parisc9778a92009-12-17 21:24:33 -050062 FAN_MARK_IGNORED_MASK |\
Eric Parisbbf2aba2010-10-28 17:21:57 -040063 FAN_MARK_IGNORED_SURV_MODIFY |\
64 FAN_MARK_FLUSH)
Eric Paris2a3edf82009-12-17 21:24:26 -050065
Eric Parisff0b16a2009-12-17 21:24:25 -050066/*
67 * All of the events - we build the list by hand so that we can add flags in
68 * the future and not break backward compatibility. Apps will get only the
69 * events that they originally wanted. Be sure to add new events here!
70 */
71#define FAN_ALL_EVENTS (FAN_ACCESS |\
72 FAN_MODIFY |\
73 FAN_CLOSE |\
74 FAN_OPEN)
75
Eric Paris9e66e422009-12-17 21:24:34 -050076/*
77 * All events which require a permission response from userspace
78 */
79#define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM |\
80 FAN_ACCESS_PERM)
81
Eric Parisa1014f12009-12-17 21:24:26 -050082#define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS |\
Eric Paris9e66e422009-12-17 21:24:34 -050083 FAN_ALL_PERM_EVENTS |\
Eric Parisa1014f12009-12-17 21:24:26 -050084 FAN_Q_OVERFLOW)
85
Tvrtko Ursulin0fb85622010-08-20 10:02:15 +010086#define FANOTIFY_METADATA_VERSION 2
Eric Parisa1014f12009-12-17 21:24:26 -050087
88struct fanotify_event_metadata {
89 __u32 event_len;
90 __u32 vers;
Eric Paris28682012010-10-28 17:21:56 -040091 __aligned_u64 mask;
Tvrtko Ursulin0fb85622010-08-20 10:02:15 +010092 __s32 fd;
93 __s32 pid;
Eric Paris28682012010-10-28 17:21:56 -040094};
Eric Parisa1014f12009-12-17 21:24:26 -050095
Eric Parisb2d87902009-12-17 21:24:34 -050096struct fanotify_response {
97 __s32 fd;
98 __u32 response;
99} __attribute__ ((packed));
100
Eric Paris9e66e422009-12-17 21:24:34 -0500101/* Legit userspace responses to a _PERM event */
102#define FAN_ALLOW 0x01
103#define FAN_DENY 0x02
104
Eric Parisa1014f12009-12-17 21:24:26 -0500105/* Helper functions to deal with fanotify_event_metadata buffers */
106#define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))
107
108#define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
109 (struct fanotify_event_metadata*)(((char *)(meta)) + \
110 (meta)->event_len))
111
112#define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
113 (long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
114 (long)(meta)->event_len <= (long)(len))
115
Eric Parisff0b16a2009-12-17 21:24:25 -0500116#endif /* _LINUX_FANOTIFY_H */