[mirror_ubuntu-zesty-kernel.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>
#include <linux/bug.h>

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

	return __fsnotify_parent(path, dentry, mask);
}

/* simple call site for access decisions */
static inline int fsnotify_perm(struct file *file, int mask)
{
	const struct path *path = &file->f_path;
	/*
	 * Do not use file_inode() here or anywhere in this file to get the
	 * inode.  That would break *notity on overlayfs.
	 */
	struct inode *inode = path->dentry->d_inode;
	__u32 fsnotify_mask = 0;
	int ret;

	if (file->f_mode & FMODE_NONOTIFY)
		return 0;
	if (!(mask & (MAY_READ | MAY_OPEN)))
		return 0;
	if (mask & MAY_OPEN)
		fsnotify_mask = FS_OPEN_PERM;
	else if (mask & MAY_READ)
		fsnotify_mask = FS_ACCESS_PERM;
	else
		BUG();

	ret = fsnotify_parent(path, NULL, fsnotify_mask);
	if (ret)
		return ret;

	return fsnotify(inode, fsnotify_mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
}

/*
 * 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 unsigned 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 unsigned char *new_name = moved->d_name.name;

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

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

	fsnotify(old_dir, old_dir_mask, source, FSNOTIFY_EVENT_INODE, old_name,
		 fs_cookie);
	fsnotify(new_dir, new_dir_mask, source, 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(new_dir, moved, AUDIT_TYPE_CHILD_CREATE);
}

/*
 * 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_vfsmount_delete - a vfsmount is being destroyed, clean up is needed
 */
static inline void fsnotify_vfsmount_delete(struct vfsmount *mnt)
{
	__fsnotify_vfsmount_delete(mnt);
}

/*
 * 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_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(inode, dentry, AUDIT_TYPE_CHILD_CREATE);

	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(dir, new_dentry, AUDIT_TYPE_CHILD_CREATE);

	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_ISDIR);
	struct inode *d_inode = dentry->d_inode;

	audit_inode_child(inode, dentry, AUDIT_TYPE_CHILD_CREATE);

	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)
{
	const 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_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)
{
	const 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_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)
{
	const 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_ISDIR;

	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)
{
	const struct path *path = &file->f_path;
	struct inode *inode = 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_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_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_ISDIR;

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

#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>
187f1882	17	#include <linux/bug.h>
0eeca283	18
c28f7e56	19	/* Notify this dentry's parent about a child's events. */
12c7f9dc	20	static inline int fsnotify_parent(const struct path path, struct dentry dentry, __u32 mask)
c28f7e56	21	{
72acc854	22	if (!dentry)
2069601b	23	dentry = path->dentry;
28c60e37	24
52420392	25	return __fsnotify_parent(path, dentry, mask);
c28f7e56 EP	26	}
c28f7e56 EP	27
c4ec54b4 EP	28	/* simple call site for access decisions */
	29	static inline int fsnotify_perm(struct file *file, int mask)
	30	{
40212d53	31	const struct path *path = &file->f_path;
f3fbbb07 AZ	32	/*
	33	* Do not use file_inode() here or anywhere in this file to get the
	34	* inode. That would break *notity on overlayfs.
	35	*/
	36	struct inode *inode = path->dentry->d_inode;
fb1cfb88	37	__u32 fsnotify_mask = 0;
52420392	38	int ret;
c4ec54b4 EP	39
	40	if (file->f_mode & FMODE_NONOTIFY)
	41	return 0;
	42	if (!(mask & (MAY_READ \| MAY_OPEN)))
	43	return 0;
c4ec54b4 EP	44	if (mask & MAY_OPEN)
c4ec54b4 EP	45	fsnotify_mask = FS_OPEN_PERM;
fb1cfb88 EP	46	else if (mask & MAY_READ)
	47	fsnotify_mask = FS_ACCESS_PERM;
	48	else
	49	BUG();
c4ec54b4	50
52420392 EP	51	ret = fsnotify_parent(path, NULL, fsnotify_mask);
	52	if (ret)
	53	return ret;
	54
2069601b	55	return fsnotify(inode, fsnotify_mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
c4ec54b4 EP	56	}
c4ec54b4 EP	57
90586523 EP	58	/*
	59	* fsnotify_link_count - inode's link count changed
	60	*/
	61	static inline void fsnotify_link_count(struct inode *inode)
	62	{
47882c6f	63	fsnotify(inode, FS_ATTRIB, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
90586523 EP	64	}
90586523 EP	65
0eeca283 RL	66	/*
	67	* fsnotify_move - file old_name at old_dir was moved to new_name at new_dir
	68	*/
	69	static inline void fsnotify_move(struct inode old_dir, struct inode new_dir,
59b0df21	70	const unsigned char *old_name,
5a190ae6	71	int isdir, struct inode target, struct dentry moved)
0eeca283	72	{
5a190ae6	73	struct inode *source = moved->d_inode;
47882c6f	74	u32 fs_cookie = fsnotify_get_cookie();
ff52cc21 EP	75	__u32 old_dir_mask = (FS_EVENT_ON_CHILD \| FS_MOVED_FROM);
ff52cc21 EP	76	__u32 new_dir_mask = (FS_EVENT_ON_CHILD \| FS_MOVED_TO);
59b0df21	77	const unsigned char *new_name = moved->d_name.name;
0eeca283	78
ff52cc21 EP	79	if (old_dir == new_dir)
ff52cc21 EP	80	old_dir_mask \|= FS_DN_RENAME;
0eeca283	81
90586523	82	if (isdir) {
b29866aa EP	83	old_dir_mask \|= FS_ISDIR;
b29866aa EP	84	new_dir_mask \|= FS_ISDIR;
90586523 EP	85	}
90586523 EP	86
6ee8e25f JK	87	fsnotify(old_dir, old_dir_mask, source, FSNOTIFY_EVENT_INODE, old_name,
	88	fs_cookie);
	89	fsnotify(new_dir, new_dir_mask, source, FSNOTIFY_EVENT_INODE, new_name,
	90	fs_cookie);
90586523	91
2dfc1cae	92	if (target)
90586523	93	fsnotify_link_count(target);
89204c40	94
2dfc1cae	95	if (source)
47882c6f	96	fsnotify(source, FS_MOVE_SELF, moved->d_inode, FSNOTIFY_EVENT_INODE, NULL, 0);
4fa6b5ec	97	audit_inode_child(new_dir, moved, AUDIT_TYPE_CHILD_CREATE);
0eeca283 RL	98	}
0eeca283 RL	99
3be25f49 EP	100	/*
	101	* fsnotify_inode_delete - and inode is being evicted from cache, clean up is needed
	102	*/
	103	static inline void fsnotify_inode_delete(struct inode *inode)
	104	{
	105	__fsnotify_inode_delete(inode);
	106	}
	107
ca9c726e AG	108	/*
	109	* fsnotify_vfsmount_delete - a vfsmount is being destroyed, clean up is needed
	110	*/
	111	static inline void fsnotify_vfsmount_delete(struct vfsmount *mnt)
	112	{
	113	__fsnotify_vfsmount_delete(mnt);
	114	}
	115
7a91bf7f JM	116	/*
	117	* fsnotify_nameremove - a filename was removed from a directory
	118	*/
	119	static inline void fsnotify_nameremove(struct dentry *dentry, int isdir)
	120	{
90586523 EP	121	__u32 mask = FS_DELETE;
90586523 EP	122
7a91bf7f	123	if (isdir)
b29866aa	124	mask \|= FS_ISDIR;
c28f7e56	125
28c60e37	126	fsnotify_parent(NULL, dentry, mask);
7a91bf7f JM	127	}
	128
	129	/*
	130	* fsnotify_inoderemove - an inode is going away
	131	*/
	132	static inline void fsnotify_inoderemove(struct inode *inode)
	133	{
47882c6f	134	fsnotify(inode, FS_DELETE_SELF, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
3be25f49	135	__fsnotify_inode_delete(inode);
ece95912 JK	136	}
ece95912 JK	137
0eeca283 RL	138	/*
	139	* fsnotify_create - 'name' was linked in
	140	*/
f38aa942	141	static inline void fsnotify_create(struct inode inode, struct dentry dentry)
0eeca283	142	{
4fa6b5ec	143	audit_inode_child(inode, dentry, AUDIT_TYPE_CHILD_CREATE);
90586523	144
47882c6f	145	fsnotify(inode, FS_CREATE, dentry->d_inode, FSNOTIFY_EVENT_INODE, dentry->d_name.name, 0);
0eeca283 RL	146	}
0eeca283 RL	147
ece95912 JK	148	/*
	149	* fsnotify_link - new hardlink in 'inode' directory
	150	* Note: We have to pass also the linked inode ptr as some filesystems leave
	151	* new_dentry->d_inode NULL and instantiate inode pointer later
	152	*/
	153	static inline void fsnotify_link(struct inode dir, struct inode inode, struct dentry *new_dentry)
	154	{
ece95912	155	fsnotify_link_count(inode);
4fa6b5ec	156	audit_inode_child(dir, new_dentry, AUDIT_TYPE_CHILD_CREATE);
90586523	157
47882c6f	158	fsnotify(dir, FS_CREATE, inode, FSNOTIFY_EVENT_INODE, new_dentry->d_name.name, 0);
ece95912 JK	159	}
ece95912 JK	160
0eeca283 RL	161	/*
	162	* fsnotify_mkdir - directory 'name' was created
	163	*/
f38aa942	164	static inline void fsnotify_mkdir(struct inode inode, struct dentry dentry)
0eeca283	165	{
b29866aa	166	__u32 mask = (FS_CREATE \| FS_ISDIR);
90586523 EP	167	struct inode *d_inode = dentry->d_inode;
90586523 EP	168
4fa6b5ec	169	audit_inode_child(inode, dentry, AUDIT_TYPE_CHILD_CREATE);
90586523	170
47882c6f	171	fsnotify(inode, mask, d_inode, FSNOTIFY_EVENT_INODE, dentry->d_name.name, 0);
0eeca283 RL	172	}
	173
	174	/*
	175	* fsnotify_access - file was read
	176	*/
2a12a9d7	177	static inline void fsnotify_access(struct file *file)
0eeca283	178	{
40212d53	179	const struct path *path = &file->f_path;
f3fbbb07	180	struct inode *inode = path->dentry->d_inode;
90586523	181	__u32 mask = FS_ACCESS;
0eeca283 RL	182
0eeca283 RL	183	if (S_ISDIR(inode->i_mode))
b29866aa	184	mask \|= FS_ISDIR;
0eeca283	185
ecf081d1	186	if (!(file->f_mode & FMODE_NONOTIFY)) {
2069601b LT	187	fsnotify_parent(path, NULL, mask);
2069601b LT	188	fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
ecf081d1	189	}
0eeca283 RL	190	}
	191
	192	/*
	193	* fsnotify_modify - file was modified
	194	*/
2a12a9d7	195	static inline void fsnotify_modify(struct file *file)
0eeca283	196	{
40212d53	197	const struct path *path = &file->f_path;
f3fbbb07	198	struct inode *inode = path->dentry->d_inode;
90586523	199	__u32 mask = FS_MODIFY;
0eeca283 RL	200
0eeca283 RL	201	if (S_ISDIR(inode->i_mode))
b29866aa	202	mask \|= FS_ISDIR;
0eeca283	203
ecf081d1	204	if (!(file->f_mode & FMODE_NONOTIFY)) {
2069601b LT	205	fsnotify_parent(path, NULL, mask);
2069601b LT	206	fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
ecf081d1	207	}
0eeca283 RL	208	}
	209
	210	/*
	211	* fsnotify_open - file was opened
	212	*/
2a12a9d7	213	static inline void fsnotify_open(struct file *file)
0eeca283	214	{
40212d53	215	const struct path *path = &file->f_path;
f3fbbb07	216	struct inode *inode = path->dentry->d_inode;
90586523	217	__u32 mask = FS_OPEN;
0eeca283 RL	218
0eeca283 RL	219	if (S_ISDIR(inode->i_mode))
b29866aa	220	mask \|= FS_ISDIR;
0eeca283	221
6bff7ecc LS	222	fsnotify_parent(path, NULL, mask);
6bff7ecc LS	223	fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
0eeca283 RL	224	}
	225
	226	/*
	227	* fsnotify_close - file was closed
	228	*/
	229	static inline void fsnotify_close(struct file *file)
	230	{
40212d53	231	const struct path *path = &file->f_path;
f3fbbb07	232	struct inode *inode = path->dentry->d_inode;
aeb5d727	233	fmode_t mode = file->f_mode;
90586523	234	__u32 mask = (mode & FMODE_WRITE) ? FS_CLOSE_WRITE : FS_CLOSE_NOWRITE;
0eeca283 RL	235
0eeca283 RL	236	if (S_ISDIR(inode->i_mode))
b29866aa	237	mask \|= FS_ISDIR;
0eeca283	238
ecf081d1	239	if (!(file->f_mode & FMODE_NONOTIFY)) {
2069601b LT	240	fsnotify_parent(path, NULL, mask);
2069601b LT	241	fsnotify(inode, mask, path, FSNOTIFY_EVENT_PATH, NULL, 0);
ecf081d1	242	}
0eeca283 RL	243	}
	244
	245	/*
	246	* fsnotify_xattr - extended attributes were changed
	247	*/
	248	static inline void fsnotify_xattr(struct dentry *dentry)
	249	{
	250	struct inode *inode = dentry->d_inode;
90586523	251	__u32 mask = FS_ATTRIB;
0eeca283 RL	252
0eeca283 RL	253	if (S_ISDIR(inode->i_mode))
b29866aa	254	mask \|= FS_ISDIR;
0eeca283	255
28c60e37	256	fsnotify_parent(NULL, dentry, mask);
47882c6f	257	fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
0eeca283 RL	258	}
	259
	260	/*
	261	* fsnotify_change - notify_change event. file was modified and/or metadata
	262	* was changed.
	263	*/
	264	static inline void fsnotify_change(struct dentry *dentry, unsigned int ia_valid)
	265	{
	266	struct inode *inode = dentry->d_inode;
3c5119c0 EP	267	__u32 mask = 0;
	268
	269	if (ia_valid & ATTR_UID)
	270	mask \|= FS_ATTRIB;
	271	if (ia_valid & ATTR_GID)
	272	mask \|= FS_ATTRIB;
	273	if (ia_valid & ATTR_SIZE)
	274	mask \|= FS_MODIFY;
0eeca283	275
0eeca283 RL	276	/* both times implies a utime(s) call */
0eeca283 RL	277	if ((ia_valid & (ATTR_ATIME \| ATTR_MTIME)) == (ATTR_ATIME \| ATTR_MTIME))
3c5119c0 EP	278	mask \|= FS_ATTRIB;
	279	else if (ia_valid & ATTR_ATIME)
	280	mask \|= FS_ACCESS;
	281	else if (ia_valid & ATTR_MTIME)
	282	mask \|= FS_MODIFY;
	283
	284	if (ia_valid & ATTR_MODE)
	285	mask \|= FS_ATTRIB;
0eeca283	286
3c5119c0	287	if (mask) {
0eeca283	288	if (S_ISDIR(inode->i_mode))
b29866aa	289	mask \|= FS_ISDIR;
28c60e37 EP	290
28c60e37 EP	291	fsnotify_parent(NULL, dentry, mask);
47882c6f	292	fsnotify(inode, mask, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
0eeca283 RL	293	}
	294	}
	295
0eeca283	296	#endif /* _LINUX_FS_NOTIFY_H */