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

/*
 * Filesystem access notification for Linux
 *
 *  Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
 */

#ifndef __LINUX_FSNOTIFY_BACKEND_H
#define __LINUX_FSNOTIFY_BACKEND_H

#ifdef __KERNEL__

#include <linux/idr.h> /* inotify uses this */
#include <linux/fs.h> /* struct inode */
#include <linux/list.h>
#include <linux/path.h> /* struct path */
#include <linux/spinlock.h>
#include <linux/types.h>
#include <linux/atomic.h>
#include <linux/user_namespace.h>

/*
 * IN_* from inotfy.h lines up EXACTLY with FS_*, this is so we can easily
 * convert between them.  dnotify only needs conversion at watch creation
 * so no perf loss there.  fanotify isn't defined yet, so it can use the
 * wholes if it needs more events.
 */
#define FS_ACCESS		0x00000001	/* File was accessed */
#define FS_MODIFY		0x00000002	/* File was modified */
#define FS_ATTRIB		0x00000004	/* Metadata changed */
#define FS_CLOSE_WRITE		0x00000008	/* Writtable file was closed */
#define FS_CLOSE_NOWRITE	0x00000010	/* Unwrittable file closed */
#define FS_OPEN			0x00000020	/* File was opened */
#define FS_MOVED_FROM		0x00000040	/* File was moved from X */
#define FS_MOVED_TO		0x00000080	/* File was moved to Y */
#define FS_CREATE		0x00000100	/* Subfile was created */
#define FS_DELETE		0x00000200	/* Subfile was deleted */
#define FS_DELETE_SELF		0x00000400	/* Self was deleted */
#define FS_MOVE_SELF		0x00000800	/* Self was moved */

#define FS_UNMOUNT		0x00002000	/* inode on umount fs */
#define FS_Q_OVERFLOW		0x00004000	/* Event queued overflowed */
#define FS_IN_IGNORED		0x00008000	/* last inotify event here */

#define FS_OPEN_PERM		0x00010000	/* open event in an permission hook */
#define FS_ACCESS_PERM		0x00020000	/* access event in a permissions hook */

#define FS_EXCL_UNLINK		0x04000000	/* do not send events if object is unlinked */
#define FS_ISDIR		0x40000000	/* event occurred against dir */
#define FS_IN_ONESHOT		0x80000000	/* only send event once */

#define FS_DN_RENAME		0x10000000	/* file renamed */
#define FS_DN_MULTISHOT		0x20000000	/* dnotify multishot */

/* This inode cares about things that happen to its children.  Always set for
 * dnotify and inotify. */
#define FS_EVENT_ON_CHILD	0x08000000

/* This is a list of all events that may get sent to a parernt based on fs event
 * happening to inodes inside that directory */
#define FS_EVENTS_POSS_ON_CHILD   (FS_ACCESS | FS_MODIFY | FS_ATTRIB |\
				   FS_CLOSE_WRITE | FS_CLOSE_NOWRITE | FS_OPEN |\
				   FS_MOVED_FROM | FS_MOVED_TO | FS_CREATE |\
				   FS_DELETE | FS_OPEN_PERM | FS_ACCESS_PERM)

#define FS_MOVE			(FS_MOVED_FROM | FS_MOVED_TO)

#define ALL_FSNOTIFY_PERM_EVENTS (FS_OPEN_PERM | FS_ACCESS_PERM)

#define ALL_FSNOTIFY_EVENTS (FS_ACCESS | FS_MODIFY | FS_ATTRIB | \
			     FS_CLOSE_WRITE | FS_CLOSE_NOWRITE | FS_OPEN | \
			     FS_MOVED_FROM | FS_MOVED_TO | FS_CREATE | \
			     FS_DELETE | FS_DELETE_SELF | FS_MOVE_SELF | \
			     FS_UNMOUNT | FS_Q_OVERFLOW | FS_IN_IGNORED | \
			     FS_OPEN_PERM | FS_ACCESS_PERM | FS_EXCL_UNLINK | \
			     FS_ISDIR | FS_IN_ONESHOT | FS_DN_RENAME | \
			     FS_DN_MULTISHOT | FS_EVENT_ON_CHILD)

struct fsnotify_group;
struct fsnotify_event;
struct fsnotify_mark;
struct fsnotify_event_private_data;
struct fsnotify_fname;

/*
 * Each group much define these ops.  The fsnotify infrastructure will call
 * these operations for each relevant group.
 *
 * handle_event - main call for a group to handle an fs event
 * free_group_priv - called when a group refcnt hits 0 to clean up the private union
 * freeing_mark - called when a mark is being destroyed for some reason.  The group
 * 		MUST be holding a reference on each mark and that reference must be
 * 		dropped in this function.  inotify uses this function to send
 * 		userspace messages that marks have been removed.
 */
struct fsnotify_ops {
	int (*handle_event)(struct fsnotify_group *group,
			    struct inode *inode,
			    struct fsnotify_mark *inode_mark,
			    struct fsnotify_mark *vfsmount_mark,
			    u32 mask, const void *data, int data_type,
			    const unsigned char *file_name, u32 cookie);
	void (*free_group_priv)(struct fsnotify_group *group);
	void (*freeing_mark)(struct fsnotify_mark *mark, struct fsnotify_group *group);
	void (*free_event)(struct fsnotify_event *event);
};

/*
 * all of the information about the original object we want to now send to
 * a group.  If you want to carry more info from the accessing task to the
 * listener this structure is where you need to be adding fields.
 */
struct fsnotify_event {
	struct list_head list;
	/* inode may ONLY be dereferenced during handle_event(). */
	struct inode *inode;	/* either the inode the event happened to or its parent */
	u32 mask;		/* the type of access, bitwise OR for FS_* event types */
};

/*
 * A group is a "thing" that wants to receive notification about filesystem
 * events.  The mask holds the subset of event types this group cares about.
 * refcnt on a group is up to the implementor and at any moment if it goes 0
 * everything will be cleaned up.
 */
struct fsnotify_group {
	/*
	 * How the refcnt is used is up to each group.  When the refcnt hits 0
	 * fsnotify will clean up all of the resources associated with this group.
	 * As an example, the dnotify group will always have a refcnt=1 and that
	 * will never change.  Inotify, on the other hand, has a group per
	 * inotify_init() and the refcnt will hit 0 only when that fd has been
	 * closed.
	 */
	atomic_t refcnt;		/* things with interest in this group */

	const struct fsnotify_ops *ops;	/* how this group handles things */

	/* needed to send notification to userspace */
	spinlock_t notification_lock;		/* protect the notification_list */
	struct list_head notification_list;	/* list of event_holder this group needs to send to userspace */
	wait_queue_head_t notification_waitq;	/* read() on the notification file blocks on this waitq */
	unsigned int q_len;			/* events on the queue */
	unsigned int max_events;		/* maximum events allowed on the list */
	/*
	 * Valid fsnotify group priorities.  Events are send in order from highest
	 * priority to lowest priority.  We default to the lowest priority.
	 */
	#define FS_PRIO_0	0 /* normal notifiers, no permissions */
	#define FS_PRIO_1	1 /* fanotify content based access control */
	#define FS_PRIO_2	2 /* fanotify pre-content access */
	unsigned int priority;
	bool shutdown;		/* group is being shut down, don't queue more events */

	/* stores all fastpath marks assoc with this group so they can be cleaned on unregister */
	struct mutex mark_mutex;	/* protect marks_list */
	atomic_t num_marks;		/* 1 for each mark and 1 for not being
					 * past the point of no return when freeing
					 * a group */
	struct list_head marks_list;	/* all inode marks for this group */

	struct fasync_struct *fsn_fa;    /* async notification */

	struct fsnotify_event *overflow_event;	/* Event we queue when the
						 * notification list is too
						 * full */

	/* groups can define private fields here or use the void *private */
	union {
		void *private;
#ifdef CONFIG_INOTIFY_USER
		struct inotify_group_private_data {
			spinlock_t	idr_lock;
			struct idr      idr;
			struct ucounts *ucounts;
		} inotify_data;
#endif
#ifdef CONFIG_FANOTIFY
		struct fanotify_group_private_data {
#ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
			/* allows a group to block waiting for a userspace response */
			struct list_head access_list;
			wait_queue_head_t access_waitq;
#endif /* CONFIG_FANOTIFY_ACCESS_PERMISSIONS */
			int f_flags;
			unsigned int max_marks;
			struct user_struct *user;
		} fanotify_data;
#endif /* CONFIG_FANOTIFY */
	};
};

/* when calling fsnotify tell it if the data is a path or inode */
#define FSNOTIFY_EVENT_NONE	0
#define FSNOTIFY_EVENT_PATH	1
#define FSNOTIFY_EVENT_INODE	2

/*
 * Inode / vfsmount point to this structure which tracks all marks attached to
 * the inode / vfsmount. The reference to inode / vfsmount is held by this
 * structure whenever the list is non-empty. The structure is freed only when
 * inode / vfsmount gets freed.
 */
struct fsnotify_mark_connector {
	spinlock_t lock;
#define FSNOTIFY_OBJ_TYPE_INODE		0x01
#define FSNOTIFY_OBJ_TYPE_VFSMOUNT	0x02
	unsigned int flags;	/* Type of object [lock] */
	union {	/* Object pointer [lock] */
		struct inode *inode;
		struct vfsmount *mnt;
	};
	struct hlist_head list;
};

/*
 * A mark is simply an object attached to an in core inode which allows an
 * fsnotify listener to indicate they are either no longer interested in events
 * of a type matching mask or only interested in those events.
 *
 * These are flushed when an inode is evicted from core and may be flushed
 * when the inode is modified (as seen by fsnotify_access).  Some fsnotify
 * users (such as dnotify) will flush these when the open fd is closed and not
 * at inode eviction or modification.
 *
 * Text in brackets is showing the lock(s) protecting modifications of a
 * particular entry. obj_lock means either inode->i_lock or
 * mnt->mnt_root->d_lock depending on the mark type.
 */
struct fsnotify_mark {
	/* Mask this mark is for [mark->lock, group->mark_mutex] */
	__u32 mask;
	/* We hold one for presence in g_list. Also one ref for each 'thing'
	 * in kernel that found and may be using this mark. */
	atomic_t refcnt;
	/* Group this mark is for. Set on mark creation, stable until last ref
	 * is dropped */
	struct fsnotify_group *group;
	/* List of marks by group->i_fsnotify_marks. Also reused for queueing
	 * mark into destroy_list when it's waiting for the end of SRCU period
	 * before it can be freed. [group->mark_mutex] */
	struct list_head g_list;
	/* Protects inode / mnt pointers, flags, masks */
	spinlock_t lock;
	/* List of marks for inode / vfsmount [connector->lock] */
	struct hlist_node obj_list;
	/* Head of list of marks for an object [mark->lock, group->mark_mutex] */
	struct fsnotify_mark_connector *connector;
	/* Events types to ignore [mark->lock, group->mark_mutex] */
	__u32 ignored_mask;
#define FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY	0x01
#define FSNOTIFY_MARK_FLAG_ALIVE		0x02
#define FSNOTIFY_MARK_FLAG_ATTACHED		0x04
	unsigned int flags;		/* flags [mark->lock] */
	void (*free_mark)(struct fsnotify_mark *mark); /* called on final put+free */
};

#ifdef CONFIG_FSNOTIFY

/* called from the vfs helpers */

/* main fsnotify call to send events */
extern int fsnotify(struct inode *to_tell, __u32 mask, const void *data, int data_is,
		    const unsigned char *name, u32 cookie);
extern int __fsnotify_parent(const struct path *path, struct dentry *dentry, __u32 mask);
extern void __fsnotify_inode_delete(struct inode *inode);
extern void __fsnotify_vfsmount_delete(struct vfsmount *mnt);
extern u32 fsnotify_get_cookie(void);

static inline int fsnotify_inode_watches_children(struct inode *inode)
{
	/* FS_EVENT_ON_CHILD is set if the inode may care */
	if (!(inode->i_fsnotify_mask & FS_EVENT_ON_CHILD))
		return 0;
	/* this inode might care about child events, does it care about the
	 * specific set of events that can happen on a child? */
	return inode->i_fsnotify_mask & FS_EVENTS_POSS_ON_CHILD;
}

/*
 * Update the dentry with a flag indicating the interest of its parent to receive
 * filesystem events when those events happens to this dentry->d_inode.
 */
static inline void fsnotify_update_flags(struct dentry *dentry)
{
	assert_spin_locked(&dentry->d_lock);

	/*
	 * Serialisation of setting PARENT_WATCHED on the dentries is provided
	 * by d_lock. If inotify_inode_watched changes after we have taken
	 * d_lock, the following __fsnotify_update_child_dentry_flags call will
	 * find our entry, so it will spin until we complete here, and update
	 * us with the new state.
	 */
	if (fsnotify_inode_watches_children(dentry->d_parent->d_inode))
		dentry->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
	else
		dentry->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
}

/* called from fsnotify listeners, such as fanotify or dnotify */

/* create a new group */
extern struct fsnotify_group *fsnotify_alloc_group(const struct fsnotify_ops *ops);
/* get reference to a group */
extern void fsnotify_get_group(struct fsnotify_group *group);
/* drop reference on a group from fsnotify_alloc_group */
extern void fsnotify_put_group(struct fsnotify_group *group);
/* group destruction begins, stop queuing new events */
extern void fsnotify_group_stop_queueing(struct fsnotify_group *group);
/* destroy group */
extern void fsnotify_destroy_group(struct fsnotify_group *group);
/* fasync handler function */
extern int fsnotify_fasync(int fd, struct file *file, int on);
/* Free event from memory */
extern void fsnotify_destroy_event(struct fsnotify_group *group,
				   struct fsnotify_event *event);
/* attach the event to the group notification queue */
extern int fsnotify_add_event(struct fsnotify_group *group,
			      struct fsnotify_event *event,
			      int (*merge)(struct list_head *,
					   struct fsnotify_event *));
/* true if the group notification queue is empty */
extern bool fsnotify_notify_queue_is_empty(struct fsnotify_group *group);
/* return, but do not dequeue the first event on the notification queue */
extern struct fsnotify_event *fsnotify_peek_first_event(struct fsnotify_group *group);
/* return AND dequeue the first event on the notification queue */
extern struct fsnotify_event *fsnotify_remove_first_event(struct fsnotify_group *group);

/* functions used to manipulate the marks attached to inodes */

/* Calculate mask of events for a list of marks */
extern void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn);
/* run all marks associated with a vfsmount and update mnt->mnt_fsnotify_mask */
extern void fsnotify_recalc_vfsmount_mask(struct vfsmount *mnt);
/* run all marks associated with an inode and update inode->i_fsnotify_mask */
extern void fsnotify_recalc_inode_mask(struct inode *inode);
extern void fsnotify_init_mark(struct fsnotify_mark *mark, void (*free_mark)(struct fsnotify_mark *mark));
/* find (and take a reference) to a mark associated with group and inode */
extern struct fsnotify_mark *fsnotify_find_inode_mark(struct fsnotify_group *group, struct inode *inode);
/* find (and take a reference) to a mark associated with group and vfsmount */
extern struct fsnotify_mark *fsnotify_find_vfsmount_mark(struct fsnotify_group *group, struct vfsmount *mnt);
/* set the ignored_mask of a mark */
extern void fsnotify_set_mark_ignored_mask_locked(struct fsnotify_mark *mark, __u32 mask);
/* set the mask of a mark (might pin the object into memory */
extern void fsnotify_set_mark_mask_locked(struct fsnotify_mark *mark, __u32 mask);
/* attach the mark to both the group and the inode */
extern int fsnotify_add_mark(struct fsnotify_mark *mark, struct fsnotify_group *group,
			     struct inode *inode, struct vfsmount *mnt, int allow_dups);
extern int fsnotify_add_mark_locked(struct fsnotify_mark *mark, struct fsnotify_group *group,
				    struct inode *inode, struct vfsmount *mnt, int allow_dups);
/* given a group and a mark, flag mark to be freed when all references are dropped */
extern void fsnotify_destroy_mark(struct fsnotify_mark *mark,
				  struct fsnotify_group *group);
/* detach mark from inode / mount list, group list, drop inode reference */
extern void fsnotify_detach_mark(struct fsnotify_mark *mark);
/* free mark */
extern void fsnotify_free_mark(struct fsnotify_mark *mark);
/* run all the marks in a group, and clear all of the vfsmount marks */
extern void fsnotify_clear_vfsmount_marks_by_group(struct fsnotify_group *group);
/* run all the marks in a group, and clear all of the inode marks */
extern void fsnotify_clear_inode_marks_by_group(struct fsnotify_group *group);
/* run all the marks in a group, and clear all of the marks attached to given object type */
extern void fsnotify_clear_marks_by_group_flags(struct fsnotify_group *group, unsigned int flags);
extern void fsnotify_connector_free(struct fsnotify_mark_connector **connp);
extern void fsnotify_get_mark(struct fsnotify_mark *mark);
extern void fsnotify_put_mark(struct fsnotify_mark *mark);
extern void fsnotify_unmount_inodes(struct super_block *sb);

/* put here because inotify does some weird stuff when destroying watches */
extern void fsnotify_init_event(struct fsnotify_event *event,
				struct inode *to_tell, u32 mask);

#else

static inline int fsnotify(struct inode *to_tell, __u32 mask, const void *data, int data_is,
			   const unsigned char *name, u32 cookie)
{
	return 0;
}

static inline int __fsnotify_parent(const struct path *path, struct dentry *dentry, __u32 mask)
{
	return 0;
}

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

static inline void __fsnotify_vfsmount_delete(struct vfsmount *mnt)
{}

static inline void fsnotify_update_flags(struct dentry *dentry)
{}

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

static inline void fsnotify_unmount_inodes(struct super_block *sb)
{}

#endif	/* CONFIG_FSNOTIFY */

#endif	/* __KERNEL __ */

#endif	/* __LINUX_FSNOTIFY_BACKEND_H */
Commit	Line	Data
90586523 EP	1	/*
	2	* Filesystem access notification for Linux
	3	*
	4	* Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
	5	*/
	6
	7	#ifndef __LINUX_FSNOTIFY_BACKEND_H
	8	#define __LINUX_FSNOTIFY_BACKEND_H
	9
	10	#ifdef __KERNEL__
	11
63c882a0	12	#include <linux/idr.h> /* inotify uses this */
90586523 EP	13	#include <linux/fs.h> /* struct inode */
	14	#include <linux/list.h>
	15	#include <linux/path.h> /* struct path */
	16	#include <linux/spinlock.h>
	17	#include <linux/types.h>
60063497	18	#include <linux/atomic.h>
1cce1eea	19	#include <linux/user_namespace.h>
90586523 EP	20
	21	/*
	22	* IN_* from inotfy.h lines up EXACTLY with FS_*, this is so we can easily
	23	* convert between them. dnotify only needs conversion at watch creation
	24	* so no perf loss there. fanotify isn't defined yet, so it can use the
	25	* wholes if it needs more events.
	26	*/
	27	#define FS_ACCESS 0x00000001 /* File was accessed */
	28	#define FS_MODIFY 0x00000002 /* File was modified */
	29	#define FS_ATTRIB 0x00000004 /* Metadata changed */
	30	#define FS_CLOSE_WRITE 0x00000008 /* Writtable file was closed */
	31	#define FS_CLOSE_NOWRITE 0x00000010 /* Unwrittable file closed */
	32	#define FS_OPEN 0x00000020 /* File was opened */
	33	#define FS_MOVED_FROM 0x00000040 /* File was moved from X */
	34	#define FS_MOVED_TO 0x00000080 /* File was moved to Y */
	35	#define FS_CREATE 0x00000100 /* Subfile was created */
	36	#define FS_DELETE 0x00000200 /* Subfile was deleted */
	37	#define FS_DELETE_SELF 0x00000400 /* Self was deleted */
	38	#define FS_MOVE_SELF 0x00000800 /* Self was moved */
	39
	40	#define FS_UNMOUNT 0x00002000 /* inode on umount fs */
	41	#define FS_Q_OVERFLOW 0x00004000 /* Event queued overflowed */
	42	#define FS_IN_IGNORED 0x00008000 /* last inotify event here */
	43
c4ec54b4 EP	44	#define FS_OPEN_PERM 0x00010000 /* open event in an permission hook */
	45	#define FS_ACCESS_PERM 0x00020000 /* access event in a permissions hook */
	46
8c1934c8	47	#define FS_EXCL_UNLINK 0x04000000 /* do not send events if object is unlinked */
b29866aa	48	#define FS_ISDIR 0x40000000 /* event occurred against dir */
90586523 EP	49	#define FS_IN_ONESHOT 0x80000000 /* only send event once */
	50
	51	#define FS_DN_RENAME 0x10000000 /* file renamed */
	52	#define FS_DN_MULTISHOT 0x20000000 /* dnotify multishot */
	53
c28f7e56 EP	54	/* This inode cares about things that happen to its children. Always set for
	55	* dnotify and inotify. */
	56	#define FS_EVENT_ON_CHILD 0x08000000
	57
	58	/* This is a list of all events that may get sent to a parernt based on fs event
	59	* happening to inodes inside that directory */
	60	#define FS_EVENTS_POSS_ON_CHILD (FS_ACCESS \| FS_MODIFY \| FS_ATTRIB \|\
	61	FS_CLOSE_WRITE \| FS_CLOSE_NOWRITE \| FS_OPEN \|\
	62	FS_MOVED_FROM \| FS_MOVED_TO \| FS_CREATE \|\
a4f9a9a6	63	FS_DELETE \| FS_OPEN_PERM \| FS_ACCESS_PERM)
c28f7e56	64
e9fd702a EP	65	#define FS_MOVE (FS_MOVED_FROM \| FS_MOVED_TO)
e9fd702a EP	66
ff8bcbd0 EP	67	#define ALL_FSNOTIFY_PERM_EVENTS (FS_OPEN_PERM \| FS_ACCESS_PERM)
ff8bcbd0 EP	68
20dee624 EP	69	#define ALL_FSNOTIFY_EVENTS (FS_ACCESS \| FS_MODIFY \| FS_ATTRIB \| \
	70	FS_CLOSE_WRITE \| FS_CLOSE_NOWRITE \| FS_OPEN \| \
	71	FS_MOVED_FROM \| FS_MOVED_TO \| FS_CREATE \| \
	72	FS_DELETE \| FS_DELETE_SELF \| FS_MOVE_SELF \| \
	73	FS_UNMOUNT \| FS_Q_OVERFLOW \| FS_IN_IGNORED \| \
	74	FS_OPEN_PERM \| FS_ACCESS_PERM \| FS_EXCL_UNLINK \| \
b29866aa	75	FS_ISDIR \| FS_IN_ONESHOT \| FS_DN_RENAME \| \
20dee624 EP	76	FS_DN_MULTISHOT \| FS_EVENT_ON_CHILD)
20dee624 EP	77
90586523 EP	78	struct fsnotify_group;
90586523 EP	79	struct fsnotify_event;
e61ce867	80	struct fsnotify_mark;
e4aff117	81	struct fsnotify_event_private_data;
7053aee2	82	struct fsnotify_fname;
90586523 EP	83
	84	/*
	85	* Each group much define these ops. The fsnotify infrastructure will call
	86	* these operations for each relevant group.
	87	*
	88	* handle_event - main call for a group to handle an fs event
	89	* free_group_priv - called when a group refcnt hits 0 to clean up the private union
6960b0d9 LS	90	* freeing_mark - called when a mark is being destroyed for some reason. The group
	91	* MUST be holding a reference on each mark and that reference must be
	92	* dropped in this function. inotify uses this function to send
	93	* userspace messages that marks have been removed.
90586523 EP	94	*/
90586523 EP	95	struct fsnotify_ops {
ce8f76fb	96	int (handle_event)(struct fsnotify_group group,
7053aee2	97	struct inode *inode,
ce8f76fb EP	98	struct fsnotify_mark *inode_mark,
ce8f76fb EP	99	struct fsnotify_mark *vfsmount_mark,
3cd5eca8	100	u32 mask, const void *data, int data_type,
45a22f4c	101	const unsigned char *file_name, u32 cookie);
90586523	102	void (free_group_priv)(struct fsnotify_group group);
841bdc10	103	void (freeing_mark)(struct fsnotify_mark mark, struct fsnotify_group *group);
7053aee2 JK	104	void (free_event)(struct fsnotify_event event);
	105	};
	106
	107	/*
	108	* all of the information about the original object we want to now send to
	109	* a group. If you want to carry more info from the accessing task to the
	110	* listener this structure is where you need to be adding fields.
	111	*/
	112	struct fsnotify_event {
	113	struct list_head list;
	114	/* inode may ONLY be dereferenced during handle_event(). */
	115	struct inode inode; / either the inode the event happened to or its parent */
	116	u32 mask; /* the type of access, bitwise OR for FS_* event types */
90586523 EP	117	};
	118
	119	/*
	120	* A group is a "thing" that wants to receive notification about filesystem
	121	* events. The mask holds the subset of event types this group cares about.
	122	* refcnt on a group is up to the implementor and at any moment if it goes 0
	123	* everything will be cleaned up.
	124	*/
	125	struct fsnotify_group {
90586523 EP	126	/*
	127	* How the refcnt is used is up to each group. When the refcnt hits 0
	128	* fsnotify will clean up all of the resources associated with this group.
	129	* As an example, the dnotify group will always have a refcnt=1 and that
	130	* will never change. Inotify, on the other hand, has a group per
	131	* inotify_init() and the refcnt will hit 0 only when that fd has been
	132	* closed.
	133	*/
	134	atomic_t refcnt; /* things with interest in this group */
90586523 EP	135
	136	const struct fsnotify_ops ops; / how this group handles things */
	137
a2d8bc6c	138	/* needed to send notification to userspace */
c21dbe20	139	spinlock_t notification_lock; /* protect the notification_list */
a2d8bc6c EP	140	struct list_head notification_list; /* list of event_holder this group needs to send to userspace */
	141	wait_queue_head_t notification_waitq; /* read() on the notification file blocks on this waitq */
	142	unsigned int q_len; /* events on the queue */
	143	unsigned int max_events; /* maximum events allowed on the list */
6ad2d4e3 EP	144	/*
	145	* Valid fsnotify group priorities. Events are send in order from highest
	146	* priority to lowest priority. We default to the lowest priority.
	147	*/
	148	#define FS_PRIO_0 0 /* normal notifiers, no permissions */
	149	#define FS_PRIO_1 1 /* fanotify content based access control */
	150	#define FS_PRIO_2 2 /* fanotify pre-content access */
	151	unsigned int priority;
12703dbf	152	bool shutdown; /* group is being shut down, don't queue more events */
a2d8bc6c	153
e61ce867	154	/* stores all fastpath marks assoc with this group so they can be cleaned on unregister */
986ab098	155	struct mutex mark_mutex; /* protect marks_list */
841bdc10	156	atomic_t num_marks; /* 1 for each mark and 1 for not being
3be25f49 EP	157	* past the point of no return when freeing
3be25f49 EP	158	* a group */
e61ce867	159	struct list_head marks_list; /* all inode marks for this group */
3be25f49	160
7053aee2 JK	161	struct fasync_struct fsn_fa; / async notification */
7053aee2 JK	162
ff57cd58	163	struct fsnotify_event overflow_event; / Event we queue when the
7053aee2 JK	164	* notification list is too
7053aee2 JK	165	* full */
0a6b6bd5	166
90586523 EP	167	/* groups can define private fields here or use the void private /
	168	union {
	169	void *private;
63c882a0 EP	170	#ifdef CONFIG_INOTIFY_USER
	171	struct inotify_group_private_data {
	172	spinlock_t idr_lock;
	173	struct idr idr;
1cce1eea	174	struct ucounts *ucounts;
63c882a0	175	} inotify_data;
9e66e423	176	#endif
80af2588	177	#ifdef CONFIG_FANOTIFY
9e66e423	178	struct fanotify_group_private_data {
80af2588	179	#ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
9e66e423	180	/* allows a group to block waiting for a userspace response */
9e66e423 EP	181	struct list_head access_list;
9e66e423 EP	182	wait_queue_head_t access_waitq;
80af2588 EP	183	#endif /* CONFIG_FANOTIFY_ACCESS_PERMISSIONS */
80af2588 EP	184	int f_flags;
e7099d8a	185	unsigned int max_marks;
4afeff85	186	struct user_struct *user;
9e66e423	187	} fanotify_data;
80af2588	188	#endif /* CONFIG_FANOTIFY */
90586523 EP	189	};
	190	};
	191
90586523 EP	192	/* when calling fsnotify tell it if the data is a path or inode */
90586523 EP	193	#define FSNOTIFY_EVENT_NONE 0
2069601b	194	#define FSNOTIFY_EVENT_PATH 1
90586523	195	#define FSNOTIFY_EVENT_INODE 2
90586523	196
9dd813c1 JK	197	/*
9dd813c1 JK	198	* Inode / vfsmount point to this structure which tracks all marks attached to
e911d8af JK	199	* the inode / vfsmount. The reference to inode / vfsmount is held by this
	200	* structure whenever the list is non-empty. The structure is freed only when
	201	* inode / vfsmount gets freed.
9dd813c1 JK	202	*/
9dd813c1 JK	203	struct fsnotify_mark_connector {
04662cab	204	spinlock_t lock;
86ffe245 JK	205	#define FSNOTIFY_OBJ_TYPE_INODE 0x01
	206	#define FSNOTIFY_OBJ_TYPE_VFSMOUNT 0x02
	207	unsigned int flags; /* Type of object [lock] */
	208	union { /* Object pointer [lock] */
	209	struct inode *inode;
	210	struct vfsmount *mnt;
	211	};
9dd813c1 JK	212	struct hlist_head list;
	213	};
	214
3be25f49	215	/*
1e39fc01	216	* A mark is simply an object attached to an in core inode which allows an
3be25f49 EP	217	* fsnotify listener to indicate they are either no longer interested in events
	218	* of a type matching mask or only interested in those events.
	219	*
1e39fc01 JK	220	* These are flushed when an inode is evicted from core and may be flushed
	221	* when the inode is modified (as seen by fsnotify_access). Some fsnotify
	222	* users (such as dnotify) will flush these when the open fd is closed and not
	223	* at inode eviction or modification.
	224	*
	225	* Text in brackets is showing the lock(s) protecting modifications of a
	226	* particular entry. obj_lock means either inode->i_lock or
	227	* mnt->mnt_root->d_lock depending on the mark type.
3be25f49	228	*/
e61ce867	229	struct fsnotify_mark {
1e39fc01 JK	230	/* Mask this mark is for [mark->lock, group->mark_mutex] */
	231	__u32 mask;
	232	/* We hold one for presence in g_list. Also one ref for each 'thing'
3be25f49	233	* in kernel that found and may be using this mark. */
1e39fc01 JK	234	atomic_t refcnt;
	235	/* Group this mark is for. Set on mark creation, stable until last ref
	236	* is dropped */
	237	struct fsnotify_group *group;
	238	/* List of marks by group->i_fsnotify_marks. Also reused for queueing
	239	* mark into destroy_list when it's waiting for the end of SRCU period
	240	* before it can be freed. [group->mark_mutex] */
13d34ac6	241	struct list_head g_list;
1e39fc01 JK	242	/* Protects inode / mnt pointers, flags, masks */
1e39fc01 JK	243	spinlock_t lock;
04662cab	244	/* List of marks for inode / vfsmount [connector->lock] */
1e39fc01	245	struct hlist_node obj_list;
86ffe245 JK	246	/* Head of list of marks for an object [mark->lock, group->mark_mutex] */
86ffe245 JK	247	struct fsnotify_mark_connector *connector;
1e39fc01 JK	248	/* Events types to ignore [mark->lock, group->mark_mutex] */
1e39fc01 JK	249	__u32 ignored_mask;
e911d8af JK	250	#define FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY 0x01
	251	#define FSNOTIFY_MARK_FLAG_ALIVE 0x02
	252	#define FSNOTIFY_MARK_FLAG_ATTACHED 0x04
1e39fc01	253	unsigned int flags; /* flags [mark->lock] */
841bdc10	254	void (free_mark)(struct fsnotify_mark mark); /* called on final put+free */
3be25f49 EP	255	};
3be25f49 EP	256
90586523 EP	257	#ifdef CONFIG_FSNOTIFY
	258
	259	/* called from the vfs helpers */
	260
	261	/* main fsnotify call to send events */
e637835e	262	extern int fsnotify(struct inode to_tell, __u32 mask, const void data, int data_is,
c4ec54b4	263	const unsigned char *name, u32 cookie);
12c7f9dc	264	extern int __fsnotify_parent(const struct path path, struct dentry dentry, __u32 mask);
3be25f49	265	extern void __fsnotify_inode_delete(struct inode *inode);
ca9c726e	266	extern void __fsnotify_vfsmount_delete(struct vfsmount *mnt);
47882c6f	267	extern u32 fsnotify_get_cookie(void);
90586523	268
c28f7e56 EP	269	static inline int fsnotify_inode_watches_children(struct inode *inode)
	270	{
	271	/* FS_EVENT_ON_CHILD is set if the inode may care */
	272	if (!(inode->i_fsnotify_mask & FS_EVENT_ON_CHILD))
	273	return 0;
	274	/* this inode might care about child events, does it care about the
	275	* specific set of events that can happen on a child? */
	276	return inode->i_fsnotify_mask & FS_EVENTS_POSS_ON_CHILD;
	277	}
	278
	279	/*
	280	* Update the dentry with a flag indicating the interest of its parent to receive
	281	* filesystem events when those events happens to this dentry->d_inode.
	282	*/
affda484	283	static inline void fsnotify_update_flags(struct dentry *dentry)
c28f7e56	284	{
c28f7e56 EP	285	assert_spin_locked(&dentry->d_lock);
c28f7e56 EP	286
b5c84bf6 NP	287	/*
	288	* Serialisation of setting PARENT_WATCHED on the dentries is provided
	289	* by d_lock. If inotify_inode_watched changes after we have taken
	290	* d_lock, the following __fsnotify_update_child_dentry_flags call will
	291	* find our entry, so it will spin until we complete here, and update
	292	* us with the new state.
	293	*/
affda484	294	if (fsnotify_inode_watches_children(dentry->d_parent->d_inode))
c28f7e56 EP	295	dentry->d_flags \|= DCACHE_FSNOTIFY_PARENT_WATCHED;
	296	else
	297	dentry->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
	298	}
	299
90586523 EP	300	/* called from fsnotify listeners, such as fanotify or dnotify */
90586523 EP	301
98612952	302	/* create a new group */
0d2e2a1d	303	extern struct fsnotify_group fsnotify_alloc_group(const struct fsnotify_ops ops);
98612952 LS	304	/* get reference to a group */
98612952 LS	305	extern void fsnotify_get_group(struct fsnotify_group *group);
ffab8340	306	/* drop reference on a group from fsnotify_alloc_group */
90586523	307	extern void fsnotify_put_group(struct fsnotify_group *group);
12703dbf JK	308	/* group destruction begins, stop queuing new events */
12703dbf JK	309	extern void fsnotify_group_stop_queueing(struct fsnotify_group *group);
d8153d4d LS	310	/* destroy group */
d8153d4d LS	311	extern void fsnotify_destroy_group(struct fsnotify_group *group);
0a6b6bd5 EP	312	/* fasync handler function */
0a6b6bd5 EP	313	extern int fsnotify_fasync(int fd, struct file *file, int on);
7053aee2 JK	314	/* Free event from memory */
	315	extern void fsnotify_destroy_event(struct fsnotify_group *group,
	316	struct fsnotify_event *event);
a2d8bc6c	317	/* attach the event to the group notification queue */
8ba8fa91 JK	318	extern int fsnotify_add_event(struct fsnotify_group *group,
	319	struct fsnotify_event *event,
	320	int (merge)(struct list_head ,
	321	struct fsnotify_event *));
a2d8bc6c EP	322	/* true if the group notification queue is empty */
	323	extern bool fsnotify_notify_queue_is_empty(struct fsnotify_group *group);
	324	/* return, but do not dequeue the first event on the notification queue */
8ba8fa91	325	extern struct fsnotify_event fsnotify_peek_first_event(struct fsnotify_group group);
e4aff117	326	/* return AND dequeue the first event on the notification queue */
8ba8fa91	327	extern struct fsnotify_event fsnotify_remove_first_event(struct fsnotify_group group);
a2d8bc6c	328
3be25f49 EP	329	/* functions used to manipulate the marks attached to inodes */
3be25f49 EP	330
a242677b JK	331	/* Calculate mask of events for a list of marks */
a242677b JK	332	extern void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn);
0d48b7f0 EP	333	/* run all marks associated with a vfsmount and update mnt->mnt_fsnotify_mask */
0d48b7f0 EP	334	extern void fsnotify_recalc_vfsmount_mask(struct vfsmount *mnt);
3be25f49 EP	335	/* run all marks associated with an inode and update inode->i_fsnotify_mask */
3be25f49 EP	336	extern void fsnotify_recalc_inode_mask(struct inode *inode);
841bdc10	337	extern void fsnotify_init_mark(struct fsnotify_mark mark, void (free_mark)(struct fsnotify_mark *mark));
3be25f49	338	/* find (and take a reference) to a mark associated with group and inode */
5444e298	339	extern struct fsnotify_mark fsnotify_find_inode_mark(struct fsnotify_group group, struct inode *inode);
1c529063 EP	340	/* find (and take a reference) to a mark associated with group and vfsmount */
1c529063 EP	341	extern struct fsnotify_mark fsnotify_find_vfsmount_mark(struct fsnotify_group group, struct vfsmount *mnt);
33af5e32 EP	342	/* set the ignored_mask of a mark */
33af5e32 EP	343	extern void fsnotify_set_mark_ignored_mask_locked(struct fsnotify_mark *mark, __u32 mask);
90b1e7a5 EP	344	/* set the mask of a mark (might pin the object into memory */
90b1e7a5 EP	345	extern void fsnotify_set_mark_mask_locked(struct fsnotify_mark *mark, __u32 mask);
3be25f49	346	/* attach the mark to both the group and the inode */
5444e298 EP	347	extern int fsnotify_add_mark(struct fsnotify_mark mark, struct fsnotify_group group,
5444e298 EP	348	struct inode inode, struct vfsmount mnt, int allow_dups);
d5a335b8 LS	349	extern int fsnotify_add_mark_locked(struct fsnotify_mark mark, struct fsnotify_group group,
d5a335b8 LS	350	struct inode inode, struct vfsmount mnt, int allow_dups);
e2a29943 LS	351	/* given a group and a mark, flag mark to be freed when all references are dropped */
	352	extern void fsnotify_destroy_mark(struct fsnotify_mark *mark,
	353	struct fsnotify_group *group);
4712e722 JK	354	/* detach mark from inode / mount list, group list, drop inode reference */
	355	extern void fsnotify_detach_mark(struct fsnotify_mark *mark);
	356	/* free mark */
	357	extern void fsnotify_free_mark(struct fsnotify_mark *mark);
4d92604c EP	358	/* run all the marks in a group, and clear all of the vfsmount marks */
	359	extern void fsnotify_clear_vfsmount_marks_by_group(struct fsnotify_group *group);
	360	/* run all the marks in a group, and clear all of the inode marks */
	361	extern void fsnotify_clear_inode_marks_by_group(struct fsnotify_group *group);
86ffe245	362	/* run all the marks in a group, and clear all of the marks attached to given object type */
4d92604c	363	extern void fsnotify_clear_marks_by_group_flags(struct fsnotify_group *group, unsigned int flags);
9dd813c1	364	extern void fsnotify_connector_free(struct fsnotify_mark_connector **connp);
841bdc10 EP	365	extern void fsnotify_get_mark(struct fsnotify_mark *mark);
841bdc10 EP	366	extern void fsnotify_put_mark(struct fsnotify_mark *mark);
74278da9	367	extern void fsnotify_unmount_inodes(struct super_block *sb);
3be25f49	368
90586523	369	/* put here because inotify does some weird stuff when destroying watches */
7053aee2 JK	370	extern void fsnotify_init_event(struct fsnotify_event *event,
7053aee2 JK	371	struct inode *to_tell, u32 mask);
b4e4e140	372
90586523 EP	373	#else
90586523 EP	374
e637835e	375	static inline int fsnotify(struct inode to_tell, __u32 mask, const void data, int data_is,
c4ec54b4 EP	376	const unsigned char *name, u32 cookie)
	377	{
	378	return 0;
	379	}
3be25f49	380
12c7f9dc	381	static inline int __fsnotify_parent(const struct path path, struct dentry dentry, __u32 mask)
52420392 EP	382	{
	383	return 0;
	384	}
c28f7e56	385
3be25f49 EP	386	static inline void __fsnotify_inode_delete(struct inode *inode)
	387	{}
	388
ca9c726e AG	389	static inline void __fsnotify_vfsmount_delete(struct vfsmount *mnt)
	390	{}
	391
affda484	392	static inline void fsnotify_update_flags(struct dentry *dentry)
c28f7e56 EP	393	{}
c28f7e56 EP	394
47882c6f EP	395	static inline u32 fsnotify_get_cookie(void)
	396	{
	397	return 0;
	398	}
	399
74278da9	400	static inline void fsnotify_unmount_inodes(struct super_block *sb)
164bc619 EP	401	{}
164bc619 EP	402
90586523 EP	403	#endif /* CONFIG_FSNOTIFY */
	404
	405	#endif /* __KERNEL __ */
	406
	407	#endif /* __LINUX_FSNOTIFY_BACKEND_H */