[mirror_ubuntu-bionic-kernel.git] / include / linux / inotify.h

/*
 * Inode based directory notification for Linux
 *
 * Copyright (C) 2005 John McCutchan
 */

#ifndef _LINUX_INOTIFY_H
#define _LINUX_INOTIFY_H

#include <linux/types.h>

/*
 * struct inotify_event - structure read from the inotify device for each event
 *
 * When you are watching a directory, you will receive the filename for events
 * such as IN_CREATE, IN_DELETE, IN_OPEN, IN_CLOSE, ..., relative to the wd.
 */
struct inotify_event {
	__s32		wd;		/* watch descriptor */
	__u32		mask;		/* watch mask */
	__u32		cookie;		/* cookie to synchronize two events */
	__u32		len;		/* length (including nulls) of name */
	char		name[0];	/* stub for possible name */
};

/* the following are legal, implemented events that user-space can watch for */
#define IN_ACCESS		0x00000001	/* File was accessed */
#define IN_MODIFY		0x00000002	/* File was modified */
#define IN_ATTRIB		0x00000004	/* Metadata changed */
#define IN_CLOSE_WRITE		0x00000008	/* Writtable file was closed */
#define IN_CLOSE_NOWRITE	0x00000010	/* Unwrittable file closed */
#define IN_OPEN			0x00000020	/* File was opened */
#define IN_MOVED_FROM		0x00000040	/* File was moved from X */
#define IN_MOVED_TO		0x00000080	/* File was moved to Y */
#define IN_CREATE		0x00000100	/* Subfile was created */
#define IN_DELETE		0x00000200	/* Subfile was deleted */
#define IN_DELETE_SELF		0x00000400	/* Self was deleted */
#define IN_MOVE_SELF		0x00000800	/* Self was moved */

/* the following are legal events.  they are sent as needed to any watch */
#define IN_UNMOUNT		0x00002000	/* Backing fs was unmounted */
#define IN_Q_OVERFLOW		0x00004000	/* Event queued overflowed */
#define IN_IGNORED		0x00008000	/* File was ignored */

/* helper events */
#define IN_CLOSE		(IN_CLOSE_WRITE | IN_CLOSE_NOWRITE) /* close */
#define IN_MOVE			(IN_MOVED_FROM | IN_MOVED_TO) /* moves */

/* special flags */
#define IN_ONLYDIR		0x01000000	/* only watch the path if it is a directory */
#define IN_DONT_FOLLOW		0x02000000	/* don't follow a sym link */
#define IN_MASK_ADD		0x20000000	/* add to the mask of an already existing watch */
#define IN_ISDIR		0x40000000	/* event occurred against dir */
#define IN_ONESHOT		0x80000000	/* only send event once */

/*
 * All of the events - we build the list by hand so that we can add flags in
 * the future and not break backward compatibility.  Apps will get only the
 * events that they originally wanted.  Be sure to add new events here!
 */
#define IN_ALL_EVENTS	(IN_ACCESS | IN_MODIFY | IN_ATTRIB | IN_CLOSE_WRITE | \
			 IN_CLOSE_NOWRITE | IN_OPEN | IN_MOVED_FROM | \
			 IN_MOVED_TO | IN_DELETE | IN_CREATE | IN_DELETE_SELF | \
			 IN_MOVE_SELF)

#ifdef __KERNEL__

#include <linux/dcache.h>
#include <linux/fs.h>
#include <linux/config.h>

#ifdef CONFIG_INOTIFY

extern void inotify_inode_queue_event(struct inode *, __u32, __u32,
				      const char *);
extern void inotify_dentry_parent_queue_event(struct dentry *, __u32, __u32,
					      const char *);
extern void inotify_unmount_inodes(struct list_head *);
extern void inotify_inode_is_dead(struct inode *);
extern u32 inotify_get_cookie(void);

#else

static inline void inotify_inode_queue_event(struct inode *inode,
					     __u32 mask, __u32 cookie,
					     const char *filename)
{
}

static inline void inotify_dentry_parent_queue_event(struct dentry *dentry,
						     __u32 mask, __u32 cookie,
						     const char *filename)
{
}

static inline void inotify_unmount_inodes(struct list_head *list)
{
}

static inline void inotify_inode_is_dead(struct inode *inode)
{
}

static inline u32 inotify_get_cookie(void)
{
	return 0;
}

#endif	/* CONFIG_INOTIFY */

#endif	/* __KERNEL __ */

#endif	/* _LINUX_INOTIFY_H */
Commit	Line	Data
0eeca283 RL	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 */
89204c40	38	#define IN_MOVE_SELF 0x00000800 /* Self was moved */
0eeca283 RL	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 */
8140a500 JM	50	#define IN_ONLYDIR 0x01000000 /* only watch the path if it is a directory */
8140a500 JM	51	#define IN_DONT_FOLLOW 0x02000000 /* don't follow a sym link */
7ea6040b	52	#define IN_MASK_ADD 0x20000000 /* add to the mask of an already existing watch */
0eeca283 RL	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 \| \
89204c40 JM	63	IN_MOVED_TO \| IN_DELETE \| IN_CREATE \| IN_DELETE_SELF \| \
89204c40 JM	64	IN_MOVE_SELF)
0eeca283 RL	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
	74	extern void inotify_inode_queue_event(struct inode *, __u32, __u32,
	75	const char *);
	76	extern void inotify_dentry_parent_queue_event(struct dentry *, __u32, __u32,
	77	const char *);
	78	extern void inotify_unmount_inodes(struct list_head *);
	79	extern void inotify_inode_is_dead(struct inode *);
	80	extern u32 inotify_get_cookie(void);
	81
	82	#else
	83
	84	static inline void inotify_inode_queue_event(struct inode *inode,
	85	__u32 mask, __u32 cookie,
	86	const char *filename)
	87	{
	88	}
	89
	90	static inline void inotify_dentry_parent_queue_event(struct dentry *dentry,
	91	__u32 mask, __u32 cookie,
	92	const char *filename)
	93	{
	94	}
	95
	96	static inline void inotify_unmount_inodes(struct list_head *list)
	97	{
	98	}
	99
	100	static inline void inotify_inode_is_dead(struct inode *inode)
	101	{
	102	}
	103
	104	static inline u32 inotify_get_cookie(void)
	105	{
	106	return 0;
	107	}
	108
	109	#endif /* CONFIG_INOTIFY */
	110
	111	#endif /* __KERNEL __ */
	112
	113	#endif /* _LINUX_INOTIFY_H */