blob: 8a621c1a0991458e4b41ca61cd0e3e974334777b [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 */
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
Eric Paris9e66e422009-12-17 21:24:34 -050018#define FAN_OPEN_PERM 0x00010000 /* File open in perm check */
19#define FAN_ACCESS_PERM 0x00020000 /* File accessed in perm check */
20
Eric Parisff0b16a2009-12-17 21:24:25 -050021/* helper events */
22#define FAN_CLOSE (FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE) /* close */
23
Eric Paris2a3edf82009-12-17 21:24:26 -050024/* flags used for fanotify_init() */
Eric Paris52c923d2009-12-17 21:24:26 -050025#define FAN_CLOEXEC 0x00000001
26#define FAN_NONBLOCK 0x00000002
27
Eric Paris4231a232010-10-28 17:21:56 -040028/* These are NOT bitwise flags. Both bits are used togther. */
29#define FAN_CLASS_NOTIF 0x00000000
30#define FAN_CLASS_CONTENT 0x00000004
31#define FAN_CLASS_PRE_CONTENT 0x00000008
32
33#define FAN_ALL_CLASS_BITS (FAN_CLASS_NOTIF | FAN_CLASS_CONTENT | \
34 FAN_CLASS_PRE_CONTENT)
35
36#define FAN_ALL_INIT_FLAGS (FAN_CLOEXEC | FAN_NONBLOCK | \
37 FAN_ALL_CLASS_BITS)
Eric Paris2a3edf82009-12-17 21:24:26 -050038
39/* flags used for fanotify_modify_mark() */
40#define FAN_MARK_ADD 0x00000001
41#define FAN_MARK_REMOVE 0x00000002
42#define FAN_MARK_DONT_FOLLOW 0x00000004
43#define FAN_MARK_ONLYDIR 0x00000008
Andreas Gruenbachereac8e9e2009-12-17 21:24:29 -050044#define FAN_MARK_MOUNT 0x00000010
Eric Parisb9e4e3b2009-12-17 21:24:33 -050045#define FAN_MARK_IGNORED_MASK 0x00000020
Eric Parisc9778a92009-12-17 21:24:33 -050046#define FAN_MARK_IGNORED_SURV_MODIFY 0x00000040
Eric Paris4d926042009-12-17 21:24:34 -050047#define FAN_MARK_FLUSH 0x00000080
Eric Paris2a3edf82009-12-17 21:24:26 -050048
49#define FAN_ALL_MARK_FLAGS (FAN_MARK_ADD |\
50 FAN_MARK_REMOVE |\
51 FAN_MARK_DONT_FOLLOW |\
Eric Paris0ff21db2009-12-17 21:24:29 -050052 FAN_MARK_ONLYDIR |\
Eric Parisb9e4e3b2009-12-17 21:24:33 -050053 FAN_MARK_MOUNT |\
Eric Parisc9778a92009-12-17 21:24:33 -050054 FAN_MARK_IGNORED_MASK |\
55 FAN_MARK_IGNORED_SURV_MODIFY)
Eric Paris2a3edf82009-12-17 21:24:26 -050056
Eric Parisff0b16a2009-12-17 21:24:25 -050057/*
58 * All of the events - we build the list by hand so that we can add flags in
59 * the future and not break backward compatibility. Apps will get only the
60 * events that they originally wanted. Be sure to add new events here!
61 */
62#define FAN_ALL_EVENTS (FAN_ACCESS |\
63 FAN_MODIFY |\
64 FAN_CLOSE |\
65 FAN_OPEN)
66
Eric Paris9e66e422009-12-17 21:24:34 -050067/*
68 * All events which require a permission response from userspace
69 */
70#define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM |\
71 FAN_ACCESS_PERM)
72
Eric Parisa1014f12009-12-17 21:24:26 -050073#define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS |\
Eric Paris9e66e422009-12-17 21:24:34 -050074 FAN_ALL_PERM_EVENTS |\
Eric Parisa1014f12009-12-17 21:24:26 -050075 FAN_Q_OVERFLOW)
76
Tvrtko Ursulin0fb85622010-08-20 10:02:15 +010077#define FANOTIFY_METADATA_VERSION 2
Eric Parisa1014f12009-12-17 21:24:26 -050078
79struct fanotify_event_metadata {
80 __u32 event_len;
81 __u32 vers;
Eric Paris28682012010-10-28 17:21:56 -040082 __aligned_u64 mask;
Tvrtko Ursulin0fb85622010-08-20 10:02:15 +010083 __s32 fd;
84 __s32 pid;
Eric Paris28682012010-10-28 17:21:56 -040085};
Eric Parisa1014f12009-12-17 21:24:26 -050086
Eric Parisb2d87902009-12-17 21:24:34 -050087struct fanotify_response {
88 __s32 fd;
89 __u32 response;
90} __attribute__ ((packed));
91
Eric Paris9e66e422009-12-17 21:24:34 -050092/* Legit userspace responses to a _PERM event */
93#define FAN_ALLOW 0x01
94#define FAN_DENY 0x02
95
Eric Parisa1014f12009-12-17 21:24:26 -050096/* Helper functions to deal with fanotify_event_metadata buffers */
97#define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))
98
99#define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
100 (struct fanotify_event_metadata*)(((char *)(meta)) + \
101 (meta)->event_len))
102
103#define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
104 (long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
105 (long)(meta)->event_len <= (long)(len))
106
Eric Parisff0b16a2009-12-17 21:24:25 -0500107#endif /* _LINUX_FANOTIFY_H */