[deliverable/linux.git] / include / linux / fsnotify.h

#ifndef _LINUX_FS_NOTIFY_H
#define _LINUX_FS_NOTIFY_H

/*
 * include/linux/fsnotify.h - generic hooks for filesystem notification, to
 * reduce in-source duplication from both dnotify and inotify.
 *
 * We don't compile any of this away in some complicated menagerie of ifdefs.
 * Instead, we rely on the code inside to optimize away as needed.
 *
 * (C) Copyright 2005 Robert Love
 */

#include <linux/fsnotify_backend.h>
#include <linux/audit.h>
#include <linux/slab.h>

/*
 * fsnotify_d_instantiate - instantiate a dentry for inode
 * Called with dcache_lock held.
 */
static inline void fsnotify_d_instantiate(struct dentry *dentry,
					  struct inode *inode)
{
	__fsnotify_d_instantiate(dentry, inode);
}

/* Notify this dentry's parent about a child's events. */
static inline void fsnotify_parent(struct path *path, struct dentry *dentry, __u32 mask)
{
	if (!dentry)
		dentry = path->dentry;

	__fsnotify_parent(path, dentry, mask);
}

/*
 * fsnotify_d_move - dentry has been moved
 * Called with dcache_lock and dentry->d_lock held.
 */
static inline void fsnotify_d_move(struct dentry *dentry)
{
	/*
	 * On move we need to update dentry->d_flags to indicate if the new parent
	 * cares about events from this dentry.
	 */
	__fsnotify_update_dcache_flags(dentry);
}

/*
 * fsnotify_link_count - inode's link count changed
 */
static inline void fsnotify_link_count(struct inode *inode)
{
	fsnotify(inode, FS_ATTRIB, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
}

/*
 * fsnotify_move - file old_name at old_dir was moved to new_name at new_dir
 */
static inline void fsnotify_move(struct inode *old_dir, struct inode *new_dir,
				 const char *old_name,
				 int isdir, struct inode *target, struct dentry *moved)
{
	struct inode *source = moved->d_inode;
	u32 fs_cookie = fsnotify_get_cookie();
	__u32 old_dir_mask = (FS_EVENT_ON_CHILD | FS_MOVED_FROM);
	__u32 new_dir_mask = (FS_EVENT_ON_CHILD | FS_MOVED_TO);
	const char *new_name = moved->d_name.name;

	if (old_dir == new_dir)
		old_dir_mask |= FS_DN_RENAME;

	if (isdir) {
		old_dir_mask |= FS_IN_ISDIR;
		new_dir_mask |= FS_IN_ISDIR;
	}

	fsnotify(old_dir, old_dir_mask, old_dir, FSNOTIFY_EVENT_INODE, old_name, fs_cookie);
	fsnotify(new_dir, new_dir_mask, new_dir, FSNOTIFY_EVENT_INODE, new_name, fs_cookie);

	if (target)
		fsnotify_link_count(target);

	if (source)
		fsnotify(source, FS_MOVE_SELF, moved->d_inode, FSNOTIFY_EVENT_INODE, NULL, 0);
	audit_inode_child(moved, new_dir);
}

/*
 * fsnotify_inode_delete - and inode is being evicted from cache, clean up is needed
 */
static inline void fsnotify_inode_delete(struct inode *inode)
{
	__fsnotify_inode_delete(inode);
}

/*
 * fsnotify_nameremove - a filename was removed from a directory
 */
static inline void fsnotify_nameremove(struct dentry *dentry, int isdir)
{
	__u32 mask = FS_DELETE;

	if (isdir)
		mask |= FS_IN_ISDIR;

	fsnotify_parent(NULL, dentry, mask);
}

/*
 * fsnotify_inoderemove - an inode is going away
 */
static inline void fsnotify_inoderemove(struct inode *inode)
{
	fsnotify(inode, FS_DELETE_SELF, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
	__fsnotify_inode_delete(inode);
}

/*
 * fsnotify_create - 'name' was linked in
 */
static inline void fsnotify_create(struct inode *inode, struct dentry *dentry)
{
	audit_inode_child(dentry, inode);

	fsnotify(inode, FS_CREATE, dentry->d_inode, FSNOTIFY_EVENT_INODE, dentry->d_name.name, 0);
}

/*
 * fsnotify_link - new hardlink in 'inode' directory
 * Note: We have to pass also the linked inode ptr as some filesystems leave
 *   new_dentry->d_inode NULL and instantiate inode pointer later
 */
static inline void fsnotify_link(struct inode *dir, struct inode *inode, struct dentry *new_dentry)
{
	fsnotify_link_count(inode);
	audit_inode_child(new_dentry, dir);

	fsnotify(dir, FS_CREATE, inode, FSNOTIFY_EVENT_INODE, new_dentry->d_name.name, 0);
}

/*
 * fsnotify_mkdir - directory 'name' was created
 */
static inline void fsnotify_mkdir(struct inode *inode, struct dentry *dentry)
{
	__u32 mask = (FS_CREATE | FS_IN_ISDIR);
	struct inode *d_inode = dentry->d_inode;

	audit_inode_child(dentry, inode);

	fsnotify(inode, mask, d_inode, FSNOTIFY_EVENT_INODE, dentry->d_name.name, 0);
}

/*
 * fsnotify_access - file was read
 */
static inline void fsnotify_access(struct file *file)
{
	struct path *path = &file->f_path;
	struct inode *inode = path->dentry->d_inode;
	__u32 mask = FS_ACCESS;

	if (S_ISDIR(inode->i_mode))
		mask |= FS_IN_ISDIR;

	if (!(file->f_mode & FMODE_NONOTIFY)) {
		fsnotify_parent(path, NULL, mask);
		fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
	}
}

/*
 * fsnotify_modify - file was modified
 */
static inline void fsnotify_modify(struct file *file)
{
	struct path *path = &file->f_path;
	struct inode *inode = path->dentry->d_inode;
	__u32 mask = FS_MODIFY;

	if (S_ISDIR(inode->i_mode))
		mask |= FS_IN_ISDIR;

	if (!(file->f_mode & FMODE_NONOTIFY)) {
		fsnotify_parent(path, NULL, mask);
		fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
	}
}

/*
 * fsnotify_open - file was opened
 */
static inline void fsnotify_open(struct file *file)
{
	struct path *path = &file->f_path;
	struct inode *inode = path->dentry->d_inode;
	__u32 mask = FS_OPEN;

	if (S_ISDIR(inode->i_mode))
		mask |= FS_IN_ISDIR;

	if (!(file->f_mode & FMODE_NONOTIFY)) {
		fsnotify_parent(path, NULL, mask);
		fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
	}
}

/*
 * fsnotify_close - file was closed
 */
static inline void fsnotify_close(struct file *file)
{
	struct path *path = &file->f_path;
	struct inode *inode = file->f_path.dentry->d_inode;
	fmode_t mode = file->f_mode;
	__u32 mask = (mode & FMODE_WRITE) ? FS_CLOSE_WRITE : FS_CLOSE_NOWRITE;

	if (S_ISDIR(inode->i_mode))
		mask |= FS_IN_ISDIR;

	if (!(file->f_mode & FMODE_NONOTIFY)) {
		fsnotify_parent(path, NULL, mask);
		fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
	}
}

/*
 * fsnotify_xattr - extended attributes were changed
 */
static inline void fsnotify_xattr(struct dentry *dentry)
{
	struct inode *inode = dentry->d_inode;
	__u32 mask = FS_ATTRIB;

	if (S_ISDIR(inode->i_mode))
		mask |= FS_IN_ISDIR;

	fsnotify_parent(NULL, dentry, mask);
	fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
}

/*
 * fsnotify_change - notify_change event.  file was modified and/or metadata
 * was changed.
 */
static inline void fsnotify_change(struct dentry *dentry, unsigned int ia_valid)
{
	struct inode *inode = dentry->d_inode;
	__u32 mask = 0;

	if (ia_valid & ATTR_UID)
		mask |= FS_ATTRIB;
	if (ia_valid & ATTR_GID)
		mask |= FS_ATTRIB;
	if (ia_valid & ATTR_SIZE)
		mask |= FS_MODIFY;

	/* both times implies a utime(s) call */
	if ((ia_valid & (ATTR_ATIME | ATTR_MTIME)) == (ATTR_ATIME | ATTR_MTIME))
		mask |= FS_ATTRIB;
	else if (ia_valid & ATTR_ATIME)
		mask |= FS_ACCESS;
	else if (ia_valid & ATTR_MTIME)
		mask |= FS_MODIFY;

	if (ia_valid & ATTR_MODE)
		mask |= FS_ATTRIB;

	if (mask) {
		if (S_ISDIR(inode->i_mode))
			mask |= FS_IN_ISDIR;

		fsnotify_parent(NULL, dentry, mask);
		fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
	}
}

#if defined(CONFIG_FSNOTIFY)	/* notify helpers */

/*
 * fsnotify_oldname_init - save off the old filename before we change it
 */
static inline const char *fsnotify_oldname_init(const char *name)
{
	return kstrdup(name, GFP_KERNEL);
}

/*
 * fsnotify_oldname_free - free the name we got from fsnotify_oldname_init
 */
static inline void fsnotify_oldname_free(const char *old_name)
{
	kfree(old_name);
}

#else	/* CONFIG_FSNOTIFY */

static inline const char *fsnotify_oldname_init(const char *name)
{
	return NULL;
}

static inline void fsnotify_oldname_free(const char *old_name)
{
}

#endif	/*  CONFIG_FSNOTIFY */

#endif	/* _LINUX_FS_NOTIFY_H */
Commit	Line	Data
0eeca283 RL	1	#ifndef _LINUX_FS_NOTIFY_H
	2	#define _LINUX_FS_NOTIFY_H
	3
	4	/*
	5	* include/linux/fsnotify.h - generic hooks for filesystem notification, to
	6	* reduce in-source duplication from both dnotify and inotify.
	7	*
	8	* We don't compile any of this away in some complicated menagerie of ifdefs.
	9	* Instead, we rely on the code inside to optimize away as needed.
	10	*
	11	* (C) Copyright 2005 Robert Love
	12	*/
	13
90586523	14	#include <linux/fsnotify_backend.h>
73241ccc	15	#include <linux/audit.h>
5a0e3ad6	16	#include <linux/slab.h>
0eeca283	17
c32ccd87 NP	18	/*
	19	* fsnotify_d_instantiate - instantiate a dentry for inode
	20	* Called with dcache_lock held.
	21	*/
e61ce867 EP	22	static inline void fsnotify_d_instantiate(struct dentry *dentry,
e61ce867 EP	23	struct inode *inode)
c32ccd87	24	{
e61ce867	25	__fsnotify_d_instantiate(dentry, inode);
c32ccd87 NP	26	}
c32ccd87 NP	27
c28f7e56	28	/* Notify this dentry's parent about a child's events. */
72acc854	29	static inline void fsnotify_parent(struct path path, struct dentry dentry, __u32 mask)
c28f7e56	30	{
72acc854 AG	31	if (!dentry)
72acc854 AG	32	dentry = path->dentry;
28c60e37	33
72acc854	34	__fsnotify_parent(path, dentry, mask);
c28f7e56 EP	35	}
c28f7e56 EP	36
c32ccd87	37	/*
e61ce867 EP	38	* fsnotify_d_move - dentry has been moved
e61ce867 EP	39	* Called with dcache_lock and dentry->d_lock held.
c32ccd87	40	*/
e61ce867	41	static inline void fsnotify_d_move(struct dentry *dentry)
c32ccd87	42	{
c28f7e56	43	/*
e61ce867 EP	44	* On move we need to update dentry->d_flags to indicate if the new parent
e61ce867 EP	45	* cares about events from this dentry.
c28f7e56	46	*/
e61ce867	47	__fsnotify_update_dcache_flags(dentry);
c32ccd87 NP	48	}
c32ccd87 NP	49
90586523 EP	50	/*
	51	* fsnotify_link_count - inode's link count changed
	52	*/
	53	static inline void fsnotify_link_count(struct inode *inode)
	54	{
47882c6f	55	fsnotify(inode, FS_ATTRIB, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
90586523 EP	56	}
90586523 EP	57
0eeca283 RL	58	/*
	59	* fsnotify_move - file old_name at old_dir was moved to new_name at new_dir
	60	*/
	61	static inline void fsnotify_move(struct inode old_dir, struct inode new_dir,
123df294	62	const char *old_name,
5a190ae6	63	int isdir, struct inode target, struct dentry moved)
0eeca283	64	{
5a190ae6	65	struct inode *source = moved->d_inode;
47882c6f	66	u32 fs_cookie = fsnotify_get_cookie();
ff52cc21 EP	67	__u32 old_dir_mask = (FS_EVENT_ON_CHILD \| FS_MOVED_FROM);
ff52cc21 EP	68	__u32 new_dir_mask = (FS_EVENT_ON_CHILD \| FS_MOVED_TO);
123df294	69	const char *new_name = moved->d_name.name;
0eeca283	70
ff52cc21 EP	71	if (old_dir == new_dir)
ff52cc21 EP	72	old_dir_mask \|= FS_DN_RENAME;
0eeca283	73
90586523	74	if (isdir) {
90586523 EP	75	old_dir_mask \|= FS_IN_ISDIR;
	76	new_dir_mask \|= FS_IN_ISDIR;
	77	}
	78
47882c6f EP	79	fsnotify(old_dir, old_dir_mask, old_dir, FSNOTIFY_EVENT_INODE, old_name, fs_cookie);
47882c6f EP	80	fsnotify(new_dir, new_dir_mask, new_dir, FSNOTIFY_EVENT_INODE, new_name, fs_cookie);
90586523	81
2dfc1cae	82	if (target)
90586523	83	fsnotify_link_count(target);
89204c40	84
2dfc1cae	85	if (source)
47882c6f	86	fsnotify(source, FS_MOVE_SELF, moved->d_inode, FSNOTIFY_EVENT_INODE, NULL, 0);
cccc6bba	87	audit_inode_child(moved, new_dir);
0eeca283 RL	88	}
0eeca283 RL	89
3be25f49 EP	90	/*
	91	* fsnotify_inode_delete - and inode is being evicted from cache, clean up is needed
	92	*/
	93	static inline void fsnotify_inode_delete(struct inode *inode)
	94	{
	95	__fsnotify_inode_delete(inode);
	96	}
	97
7a91bf7f JM	98	/*
	99	* fsnotify_nameremove - a filename was removed from a directory
	100	*/
	101	static inline void fsnotify_nameremove(struct dentry *dentry, int isdir)
	102	{
90586523 EP	103	__u32 mask = FS_DELETE;
90586523 EP	104
7a91bf7f	105	if (isdir)
90586523	106	mask \|= FS_IN_ISDIR;
c28f7e56	107
28c60e37	108	fsnotify_parent(NULL, dentry, mask);
7a91bf7f JM	109	}
	110
	111	/*
	112	* fsnotify_inoderemove - an inode is going away
	113	*/
	114	static inline void fsnotify_inoderemove(struct inode *inode)
	115	{
47882c6f	116	fsnotify(inode, FS_DELETE_SELF, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
3be25f49	117	__fsnotify_inode_delete(inode);
ece95912 JK	118	}
ece95912 JK	119
0eeca283 RL	120	/*
	121	* fsnotify_create - 'name' was linked in
	122	*/
f38aa942	123	static inline void fsnotify_create(struct inode inode, struct dentry dentry)
0eeca283	124	{
cccc6bba	125	audit_inode_child(dentry, inode);
90586523	126
47882c6f	127	fsnotify(inode, FS_CREATE, dentry->d_inode, FSNOTIFY_EVENT_INODE, dentry->d_name.name, 0);
0eeca283 RL	128	}
0eeca283 RL	129
ece95912 JK	130	/*
	131	* fsnotify_link - new hardlink in 'inode' directory
	132	* Note: We have to pass also the linked inode ptr as some filesystems leave
	133	* new_dentry->d_inode NULL and instantiate inode pointer later
	134	*/
	135	static inline void fsnotify_link(struct inode dir, struct inode inode, struct dentry *new_dentry)
	136	{
ece95912	137	fsnotify_link_count(inode);
cccc6bba	138	audit_inode_child(new_dentry, dir);
90586523	139
47882c6f	140	fsnotify(dir, FS_CREATE, inode, FSNOTIFY_EVENT_INODE, new_dentry->d_name.name, 0);
ece95912 JK	141	}
ece95912 JK	142
0eeca283 RL	143	/*
	144	* fsnotify_mkdir - directory 'name' was created
	145	*/
f38aa942	146	static inline void fsnotify_mkdir(struct inode inode, struct dentry dentry)
0eeca283	147	{
90586523 EP	148	__u32 mask = (FS_CREATE \| FS_IN_ISDIR);
	149	struct inode *d_inode = dentry->d_inode;
	150
cccc6bba	151	audit_inode_child(dentry, inode);
90586523	152
47882c6f	153	fsnotify(inode, mask, d_inode, FSNOTIFY_EVENT_INODE, dentry->d_name.name, 0);
0eeca283 RL	154	}
	155
	156	/*
	157	* fsnotify_access - file was read
	158	*/
2a12a9d7	159	static inline void fsnotify_access(struct file *file)
0eeca283	160	{
72acc854 AG	161	struct path *path = &file->f_path;
72acc854 AG	162	struct inode *inode = path->dentry->d_inode;
90586523	163	__u32 mask = FS_ACCESS;
0eeca283 RL	164
0eeca283 RL	165	if (S_ISDIR(inode->i_mode))
90586523	166	mask \|= FS_IN_ISDIR;
0eeca283	167
ecf081d1 EP	168	if (!(file->f_mode & FMODE_NONOTIFY)) {
	169	fsnotify_parent(path, NULL, mask);
	170	fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
	171	}
0eeca283 RL	172	}
	173
	174	/*
	175	* fsnotify_modify - file was modified
	176	*/
2a12a9d7	177	static inline void fsnotify_modify(struct file *file)
0eeca283	178	{
72acc854 AG	179	struct path *path = &file->f_path;
72acc854 AG	180	struct inode *inode = path->dentry->d_inode;
90586523	181	__u32 mask = FS_MODIFY;
0eeca283 RL	182
0eeca283 RL	183	if (S_ISDIR(inode->i_mode))
90586523	184	mask \|= FS_IN_ISDIR;
0eeca283	185
ecf081d1 EP	186	if (!(file->f_mode & FMODE_NONOTIFY)) {
	187	fsnotify_parent(path, NULL, mask);
	188	fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
	189	}
0eeca283 RL	190	}
	191
	192	/*
	193	* fsnotify_open - file was opened
	194	*/
2a12a9d7	195	static inline void fsnotify_open(struct file *file)
0eeca283	196	{
72acc854 AG	197	struct path *path = &file->f_path;
72acc854 AG	198	struct inode *inode = path->dentry->d_inode;
90586523	199	__u32 mask = FS_OPEN;
0eeca283 RL	200
0eeca283 RL	201	if (S_ISDIR(inode->i_mode))
90586523	202	mask \|= FS_IN_ISDIR;
0eeca283	203
ecf081d1 EP	204	if (!(file->f_mode & FMODE_NONOTIFY)) {
	205	fsnotify_parent(path, NULL, mask);
	206	fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
	207	}
0eeca283 RL	208	}
	209
	210	/*
	211	* fsnotify_close - file was closed
	212	*/
	213	static inline void fsnotify_close(struct file *file)
	214	{
72acc854	215	struct path *path = &file->f_path;
28c60e37	216	struct inode *inode = file->f_path.dentry->d_inode;
aeb5d727	217	fmode_t mode = file->f_mode;
90586523	218	__u32 mask = (mode & FMODE_WRITE) ? FS_CLOSE_WRITE : FS_CLOSE_NOWRITE;
0eeca283 RL	219
0eeca283 RL	220	if (S_ISDIR(inode->i_mode))
90586523	221	mask \|= FS_IN_ISDIR;
0eeca283	222
ecf081d1 EP	223	if (!(file->f_mode & FMODE_NONOTIFY)) {
	224	fsnotify_parent(path, NULL, mask);
	225	fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
	226	}
0eeca283 RL	227	}
	228
	229	/*
	230	* fsnotify_xattr - extended attributes were changed
	231	*/
	232	static inline void fsnotify_xattr(struct dentry *dentry)
	233	{
	234	struct inode *inode = dentry->d_inode;
90586523	235	__u32 mask = FS_ATTRIB;
0eeca283 RL	236
0eeca283 RL	237	if (S_ISDIR(inode->i_mode))
90586523	238	mask \|= FS_IN_ISDIR;
0eeca283	239
28c60e37	240	fsnotify_parent(NULL, dentry, mask);
47882c6f	241	fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
0eeca283 RL	242	}
	243
	244	/*
	245	* fsnotify_change - notify_change event. file was modified and/or metadata
	246	* was changed.
	247	*/
	248	static inline void fsnotify_change(struct dentry *dentry, unsigned int ia_valid)
	249	{
	250	struct inode *inode = dentry->d_inode;
3c5119c0 EP	251	__u32 mask = 0;
	252
	253	if (ia_valid & ATTR_UID)
	254	mask \|= FS_ATTRIB;
	255	if (ia_valid & ATTR_GID)
	256	mask \|= FS_ATTRIB;
	257	if (ia_valid & ATTR_SIZE)
	258	mask \|= FS_MODIFY;
0eeca283	259
0eeca283 RL	260	/* both times implies a utime(s) call */
0eeca283 RL	261	if ((ia_valid & (ATTR_ATIME \| ATTR_MTIME)) == (ATTR_ATIME \| ATTR_MTIME))
3c5119c0 EP	262	mask \|= FS_ATTRIB;
	263	else if (ia_valid & ATTR_ATIME)
	264	mask \|= FS_ACCESS;
	265	else if (ia_valid & ATTR_MTIME)
	266	mask \|= FS_MODIFY;
	267
	268	if (ia_valid & ATTR_MODE)
	269	mask \|= FS_ATTRIB;
0eeca283	270
3c5119c0	271	if (mask) {
0eeca283	272	if (S_ISDIR(inode->i_mode))
3c5119c0	273	mask \|= FS_IN_ISDIR;
28c60e37 EP	274
28c60e37 EP	275	fsnotify_parent(NULL, dentry, mask);
47882c6f	276	fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
0eeca283 RL	277	}
	278	}
	279
2dfc1cae	280	#if defined(CONFIG_FSNOTIFY) /* notify helpers */
0eeca283 RL	281
	282	/*
	283	* fsnotify_oldname_init - save off the old filename before we change it
	284	*/
	285	static inline const char fsnotify_oldname_init(const char name)
	286	{
	287	return kstrdup(name, GFP_KERNEL);
	288	}
	289
	290	/*
	291	* fsnotify_oldname_free - free the name we got from fsnotify_oldname_init
	292	*/
	293	static inline void fsnotify_oldname_free(const char *old_name)
	294	{
	295	kfree(old_name);
	296	}
	297
28c60e37	298	#else /* CONFIG_FSNOTIFY */
0eeca283 RL	299
	300	static inline const char fsnotify_oldname_init(const char name)
	301	{
	302	return NULL;
	303	}
	304
	305	static inline void fsnotify_oldname_free(const char *old_name)
	306	{
	307	}
	308
28c60e37	309	#endif /* CONFIG_FSNOTIFY */
0eeca283	310
0eeca283	311	#endif /* _LINUX_FS_NOTIFY_H */