Home | History | Annotate | Download | only in linux
      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 */
     38 #define IN_MOVE_SELF		0x00000800	/* Self was moved */
     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 */
     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 */
     52 #define IN_MASK_ADD		0x20000000	/* add to the mask of an already existing watch */
     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 | \
     63 			 IN_MOVED_TO | IN_DELETE | IN_CREATE | IN_DELETE_SELF | \
     64 			 IN_MOVE_SELF)
     65 
     66 
     67 #endif	/* _LINUX_INOTIFY_H */
     68