Eric Paris | ff0b16a | 2009-12-17 21:24:25 -0500 | [diff] [blame] | 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 | |
Eric Paris | ff0b16a | 2009-12-17 21:24:25 -0500 | [diff] [blame] | 15 | #define FAN_Q_OVERFLOW 0x00004000 /* Event queued overflowed */ |
| 16 | |
Eric Paris | 9e66e42 | 2009-12-17 21:24:34 -0500 | [diff] [blame] | 17 | #define FAN_OPEN_PERM 0x00010000 /* File open in perm check */ |
| 18 | #define FAN_ACCESS_PERM 0x00020000 /* File accessed in perm check */ |
| 19 | |
Eric Paris | ff0b16a | 2009-12-17 21:24:25 -0500 | [diff] [blame] | 20 | /* helper events */ |
| 21 | #define FAN_CLOSE (FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE) /* close */ |
| 22 | |
Eric Paris | 2a3edf8 | 2009-12-17 21:24:26 -0500 | [diff] [blame] | 23 | /* flags used for fanotify_init() */ |
Eric Paris | 52c923d | 2009-12-17 21:24:26 -0500 | [diff] [blame] | 24 | #define FAN_CLOEXEC 0x00000001 |
| 25 | #define FAN_NONBLOCK 0x00000002 |
| 26 | |
Eric Paris | 4231a23 | 2010-10-28 17:21:56 -0400 | [diff] [blame] | 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 |
Eric Paris | 4231a23 | 2010-10-28 17:21:56 -0400 | [diff] [blame] | 31 | #define FAN_ALL_CLASS_BITS (FAN_CLASS_NOTIF | FAN_CLASS_CONTENT | \ |
| 32 | FAN_CLASS_PRE_CONTENT) |
| 33 | |
Eric Paris | 5dd03f5 | 2010-10-28 17:21:57 -0400 | [diff] [blame] | 34 | #define FAN_UNLIMITED_QUEUE 0x00000010 |
Eric Paris | ac7e22d | 2010-10-28 17:21:58 -0400 | [diff] [blame^] | 35 | #define FAN_UNLIMITED_MARKS 0x00000020 |
Eric Paris | 5dd03f5 | 2010-10-28 17:21:57 -0400 | [diff] [blame] | 36 | |
Eric Paris | 4231a23 | 2010-10-28 17:21:56 -0400 | [diff] [blame] | 37 | #define FAN_ALL_INIT_FLAGS (FAN_CLOEXEC | FAN_NONBLOCK | \ |
Eric Paris | ac7e22d | 2010-10-28 17:21:58 -0400 | [diff] [blame^] | 38 | FAN_ALL_CLASS_BITS | FAN_UNLIMITED_QUEUE |\ |
| 39 | FAN_UNLIMITED_MARKS) |
Eric Paris | 2a3edf8 | 2009-12-17 21:24:26 -0500 | [diff] [blame] | 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 |
Andreas Gruenbacher | eac8e9e | 2009-12-17 21:24:29 -0500 | [diff] [blame] | 46 | #define FAN_MARK_MOUNT 0x00000010 |
Eric Paris | b9e4e3b | 2009-12-17 21:24:33 -0500 | [diff] [blame] | 47 | #define FAN_MARK_IGNORED_MASK 0x00000020 |
Eric Paris | c9778a9 | 2009-12-17 21:24:33 -0500 | [diff] [blame] | 48 | #define FAN_MARK_IGNORED_SURV_MODIFY 0x00000040 |
Eric Paris | 4d92604 | 2009-12-17 21:24:34 -0500 | [diff] [blame] | 49 | #define FAN_MARK_FLUSH 0x00000080 |
Eric Paris | 2a3edf8 | 2009-12-17 21:24:26 -0500 | [diff] [blame] | 50 | |
| 51 | #define FAN_ALL_MARK_FLAGS (FAN_MARK_ADD |\ |
| 52 | FAN_MARK_REMOVE |\ |
| 53 | FAN_MARK_DONT_FOLLOW |\ |
Eric Paris | 0ff21db | 2009-12-17 21:24:29 -0500 | [diff] [blame] | 54 | FAN_MARK_ONLYDIR |\ |
Eric Paris | b9e4e3b | 2009-12-17 21:24:33 -0500 | [diff] [blame] | 55 | FAN_MARK_MOUNT |\ |
Eric Paris | c9778a9 | 2009-12-17 21:24:33 -0500 | [diff] [blame] | 56 | FAN_MARK_IGNORED_MASK |\ |
Eric Paris | bbf2aba | 2010-10-28 17:21:57 -0400 | [diff] [blame] | 57 | FAN_MARK_IGNORED_SURV_MODIFY |\ |
| 58 | FAN_MARK_FLUSH) |
Eric Paris | 2a3edf8 | 2009-12-17 21:24:26 -0500 | [diff] [blame] | 59 | |
Eric Paris | ff0b16a | 2009-12-17 21:24:25 -0500 | [diff] [blame] | 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 | |
Eric Paris | 9e66e42 | 2009-12-17 21:24:34 -0500 | [diff] [blame] | 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 | |
Eric Paris | a1014f1 | 2009-12-17 21:24:26 -0500 | [diff] [blame] | 76 | #define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS |\ |
Eric Paris | 9e66e42 | 2009-12-17 21:24:34 -0500 | [diff] [blame] | 77 | FAN_ALL_PERM_EVENTS |\ |
Eric Paris | a1014f1 | 2009-12-17 21:24:26 -0500 | [diff] [blame] | 78 | FAN_Q_OVERFLOW) |
| 79 | |
Tvrtko Ursulin | 0fb8562 | 2010-08-20 10:02:15 +0100 | [diff] [blame] | 80 | #define FANOTIFY_METADATA_VERSION 2 |
Eric Paris | a1014f1 | 2009-12-17 21:24:26 -0500 | [diff] [blame] | 81 | |
| 82 | struct fanotify_event_metadata { |
| 83 | __u32 event_len; |
| 84 | __u32 vers; |
Eric Paris | 2868201 | 2010-10-28 17:21:56 -0400 | [diff] [blame] | 85 | __aligned_u64 mask; |
Tvrtko Ursulin | 0fb8562 | 2010-08-20 10:02:15 +0100 | [diff] [blame] | 86 | __s32 fd; |
| 87 | __s32 pid; |
Eric Paris | 2868201 | 2010-10-28 17:21:56 -0400 | [diff] [blame] | 88 | }; |
Eric Paris | a1014f1 | 2009-12-17 21:24:26 -0500 | [diff] [blame] | 89 | |
Eric Paris | b2d8790 | 2009-12-17 21:24:34 -0500 | [diff] [blame] | 90 | struct fanotify_response { |
| 91 | __s32 fd; |
| 92 | __u32 response; |
| 93 | } __attribute__ ((packed)); |
| 94 | |
Eric Paris | 9e66e42 | 2009-12-17 21:24:34 -0500 | [diff] [blame] | 95 | /* Legit userspace responses to a _PERM event */ |
| 96 | #define FAN_ALLOW 0x01 |
| 97 | #define FAN_DENY 0x02 |
| 98 | |
Eric Paris | a1014f1 | 2009-12-17 21:24:26 -0500 | [diff] [blame] | 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 | |
Eric Paris | ff0b16a | 2009-12-17 21:24:25 -0500 | [diff] [blame] | 110 | #endif /* _LINUX_FANOTIFY_H */ |