Robert Love | 0eeca28 | 2005-07-12 17:06:03 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Inode based directory notification for Linux |
| 3 | * |
| 4 | * Copyright (C) 2005 John McCutchan |
| 5 | */ |
| 6 | |
| 7 | #ifndef _LINUX_INOTIFY_H |
| 8 | #define _LINUX_INOTIFY_H |
| 9 | |
| 10 | #include <linux/types.h> |
| 11 | |
| 12 | /* |
| 13 | * struct inotify_event - structure read from the inotify device for each event |
| 14 | * |
| 15 | * When you are watching a directory, you will receive the filename for events |
| 16 | * such as IN_CREATE, IN_DELETE, IN_OPEN, IN_CLOSE, ..., relative to the wd. |
| 17 | */ |
| 18 | struct inotify_event { |
| 19 | __s32 wd; /* watch descriptor */ |
| 20 | __u32 mask; /* watch mask */ |
| 21 | __u32 cookie; /* cookie to synchronize two events */ |
| 22 | __u32 len; /* length (including nulls) of name */ |
| 23 | char name[0]; /* stub for possible name */ |
| 24 | }; |
| 25 | |
| 26 | /* the following are legal, implemented events that user-space can watch for */ |
| 27 | #define IN_ACCESS 0x00000001 /* File was accessed */ |
| 28 | #define IN_MODIFY 0x00000002 /* File was modified */ |
| 29 | #define IN_ATTRIB 0x00000004 /* Metadata changed */ |
| 30 | #define IN_CLOSE_WRITE 0x00000008 /* Writtable file was closed */ |
| 31 | #define IN_CLOSE_NOWRITE 0x00000010 /* Unwrittable file closed */ |
| 32 | #define IN_OPEN 0x00000020 /* File was opened */ |
| 33 | #define IN_MOVED_FROM 0x00000040 /* File was moved from X */ |
| 34 | #define IN_MOVED_TO 0x00000080 /* File was moved to Y */ |
| 35 | #define IN_CREATE 0x00000100 /* Subfile was created */ |
| 36 | #define IN_DELETE 0x00000200 /* Subfile was deleted */ |
| 37 | #define IN_DELETE_SELF 0x00000400 /* Self was deleted */ |
John McCutchan | 89204c4 | 2005-08-15 12:13:28 -0400 | [diff] [blame] | 38 | #define IN_MOVE_SELF 0x00000800 /* Self was moved */ |
Robert Love | 0eeca28 | 2005-07-12 17:06:03 -0400 | [diff] [blame] | 39 | |
| 40 | /* the following are legal events. they are sent as needed to any watch */ |
| 41 | #define IN_UNMOUNT 0x00002000 /* Backing fs was unmounted */ |
| 42 | #define IN_Q_OVERFLOW 0x00004000 /* Event queued overflowed */ |
| 43 | #define IN_IGNORED 0x00008000 /* File was ignored */ |
| 44 | |
| 45 | /* helper events */ |
| 46 | #define IN_CLOSE (IN_CLOSE_WRITE | IN_CLOSE_NOWRITE) /* close */ |
| 47 | #define IN_MOVE (IN_MOVED_FROM | IN_MOVED_TO) /* moves */ |
| 48 | |
| 49 | /* special flags */ |
John McCutchan | 8140a50 | 2005-12-12 00:37:14 -0800 | [diff] [blame] | 50 | #define IN_ONLYDIR 0x01000000 /* only watch the path if it is a directory */ |
| 51 | #define IN_DONT_FOLLOW 0x02000000 /* don't follow a sym link */ |
John McCutchan | 7ea6040 | 2005-09-06 15:18:02 -0700 | [diff] [blame] | 52 | #define IN_MASK_ADD 0x20000000 /* add to the mask of an already existing watch */ |
Robert Love | 0eeca28 | 2005-07-12 17:06:03 -0400 | [diff] [blame] | 53 | #define IN_ISDIR 0x40000000 /* event occurred against dir */ |
| 54 | #define IN_ONESHOT 0x80000000 /* only send event once */ |
| 55 | |
| 56 | /* |
| 57 | * All of the events - we build the list by hand so that we can add flags in |
| 58 | * the future and not break backward compatibility. Apps will get only the |
| 59 | * events that they originally wanted. Be sure to add new events here! |
| 60 | */ |
| 61 | #define IN_ALL_EVENTS (IN_ACCESS | IN_MODIFY | IN_ATTRIB | IN_CLOSE_WRITE | \ |
| 62 | IN_CLOSE_NOWRITE | IN_OPEN | IN_MOVED_FROM | \ |
John McCutchan | 89204c4 | 2005-08-15 12:13:28 -0400 | [diff] [blame] | 63 | IN_MOVED_TO | IN_DELETE | IN_CREATE | IN_DELETE_SELF | \ |
| 64 | IN_MOVE_SELF) |
Robert Love | 0eeca28 | 2005-07-12 17:06:03 -0400 | [diff] [blame] | 65 | |
| 66 | #ifdef __KERNEL__ |
| 67 | |
| 68 | #include <linux/dcache.h> |
| 69 | #include <linux/fs.h> |
| 70 | #include <linux/config.h> |
| 71 | |
| 72 | #ifdef CONFIG_INOTIFY |
| 73 | |
Nick Piggin | c32ccd8 | 2006-03-25 03:07:09 -0800 | [diff] [blame^] | 74 | extern void inotify_d_instantiate(struct dentry *, struct inode *); |
| 75 | extern void inotify_d_move(struct dentry *); |
Robert Love | 0eeca28 | 2005-07-12 17:06:03 -0400 | [diff] [blame] | 76 | extern void inotify_inode_queue_event(struct inode *, __u32, __u32, |
| 77 | const char *); |
| 78 | extern void inotify_dentry_parent_queue_event(struct dentry *, __u32, __u32, |
| 79 | const char *); |
| 80 | extern void inotify_unmount_inodes(struct list_head *); |
| 81 | extern void inotify_inode_is_dead(struct inode *); |
| 82 | extern u32 inotify_get_cookie(void); |
| 83 | |
| 84 | #else |
| 85 | |
Nick Piggin | c32ccd8 | 2006-03-25 03:07:09 -0800 | [diff] [blame^] | 86 | static inline void inotify_d_instantiate(struct dentry *dentry, |
| 87 | struct inode *inode) |
| 88 | { |
| 89 | } |
| 90 | |
| 91 | static inline void inotify_d_move(struct dentry *dentry) |
| 92 | { |
| 93 | } |
| 94 | |
Robert Love | 0eeca28 | 2005-07-12 17:06:03 -0400 | [diff] [blame] | 95 | static inline void inotify_inode_queue_event(struct inode *inode, |
| 96 | __u32 mask, __u32 cookie, |
| 97 | const char *filename) |
| 98 | { |
| 99 | } |
| 100 | |
| 101 | static inline void inotify_dentry_parent_queue_event(struct dentry *dentry, |
| 102 | __u32 mask, __u32 cookie, |
| 103 | const char *filename) |
| 104 | { |
| 105 | } |
| 106 | |
| 107 | static inline void inotify_unmount_inodes(struct list_head *list) |
| 108 | { |
| 109 | } |
| 110 | |
| 111 | static inline void inotify_inode_is_dead(struct inode *inode) |
| 112 | { |
| 113 | } |
| 114 | |
| 115 | static inline u32 inotify_get_cookie(void) |
| 116 | { |
| 117 | return 0; |
| 118 | } |
| 119 | |
| 120 | #endif /* CONFIG_INOTIFY */ |
| 121 | |
| 122 | #endif /* __KERNEL __ */ |
| 123 | |
| 124 | #endif /* _LINUX_INOTIFY_H */ |