xref: /openbmc/linux/fs/fuse/fuse_i.h (revision ec99f6d31f2590a4c0ff2dae8fb1fa27f0647a42)
1d8a5ba45SMiklos Szeredi /*
2d8a5ba45SMiklos Szeredi   FUSE: Filesystem in Userspace
31729a16cSMiklos Szeredi   Copyright (C) 2001-2008  Miklos Szeredi <miklos@szeredi.hu>
4d8a5ba45SMiklos Szeredi 
5d8a5ba45SMiklos Szeredi   This program can be distributed under the terms of the GNU GPL.
6d8a5ba45SMiklos Szeredi   See the file COPYING.
7d8a5ba45SMiklos Szeredi */
8d8a5ba45SMiklos Szeredi 
929d434b3STejun Heo #ifndef _FS_FUSE_I_H
1029d434b3STejun Heo #define _FS_FUSE_I_H
1129d434b3STejun Heo 
12d8a5ba45SMiklos Szeredi #include <linux/fuse.h>
13d8a5ba45SMiklos Szeredi #include <linux/fs.h>
1451eb01e7SMiklos Szeredi #include <linux/mount.h>
15d8a5ba45SMiklos Szeredi #include <linux/wait.h>
16d8a5ba45SMiklos Szeredi #include <linux/list.h>
17d8a5ba45SMiklos Szeredi #include <linux/spinlock.h>
18d8a5ba45SMiklos Szeredi #include <linux/mm.h>
19d8a5ba45SMiklos Szeredi #include <linux/backing-dev.h>
20bafa9654SMiklos Szeredi #include <linux/mutex.h>
213be5a52bSMiklos Szeredi #include <linux/rwsem.h>
2295668a69STejun Heo #include <linux/rbtree.h>
2395668a69STejun Heo #include <linux/poll.h>
245a18ec17SMiklos Szeredi #include <linux/workqueue.h>
25744742d6SSeth Forshee #include <linux/kref.h>
2660bcc88aSSeth Forshee #include <linux/xattr.h>
274e8c2eb5SElena Reshetova #include <linux/refcount.h>
28d8a5ba45SMiklos Szeredi 
29334f485dSMiklos Szeredi /** Max number of pages that can be used in a single read request */
30334f485dSMiklos Szeredi #define FUSE_MAX_PAGES_PER_REQ 32
31334f485dSMiklos Szeredi 
323be5a52bSMiklos Szeredi /** Bias for fi->writectr, meaning new writepages must not be sent */
333be5a52bSMiklos Szeredi #define FUSE_NOWRITE INT_MIN
343be5a52bSMiklos Szeredi 
351d3d752bSMiklos Szeredi /** It could be as large as PATH_MAX, but would that have any uses? */
361d3d752bSMiklos Szeredi #define FUSE_NAME_MAX 1024
371d3d752bSMiklos Szeredi 
38bafa9654SMiklos Szeredi /** Number of dentries for each connection in the control filesystem */
3979a9d994SCsaba Henk #define FUSE_CTL_NUM_DENTRIES 5
40bafa9654SMiklos Szeredi 
414250c066SMaxim Patlasov /** Number of page pointers embedded in fuse_req */
424250c066SMaxim Patlasov #define FUSE_REQ_INLINE_PAGES 1
434250c066SMaxim Patlasov 
44bafa9654SMiklos Szeredi /** List of active connections */
45bafa9654SMiklos Szeredi extern struct list_head fuse_conn_list;
46bafa9654SMiklos Szeredi 
47bafa9654SMiklos Szeredi /** Global mutex protecting fuse_conn_list and the control filesystem */
48bafa9654SMiklos Szeredi extern struct mutex fuse_mutex;
49413ef8cbSMiklos Szeredi 
5079a9d994SCsaba Henk /** Module parameters */
5179a9d994SCsaba Henk extern unsigned max_user_bgreq;
5279a9d994SCsaba Henk extern unsigned max_user_congthresh;
5379a9d994SCsaba Henk 
5407e77dcaSMiklos Szeredi /* One forget request */
5507e77dcaSMiklos Szeredi struct fuse_forget_link {
5602c048b9SMiklos Szeredi 	struct fuse_forget_one forget_one;
5707e77dcaSMiklos Szeredi 	struct fuse_forget_link *next;
5807e77dcaSMiklos Szeredi };
5907e77dcaSMiklos Szeredi 
60d8a5ba45SMiklos Szeredi /** FUSE inode */
61d8a5ba45SMiklos Szeredi struct fuse_inode {
62d8a5ba45SMiklos Szeredi 	/** Inode data */
63d8a5ba45SMiklos Szeredi 	struct inode inode;
64d8a5ba45SMiklos Szeredi 
65d8a5ba45SMiklos Szeredi 	/** Unique ID, which identifies the inode between userspace
66d8a5ba45SMiklos Szeredi 	 * and kernel */
67d8a5ba45SMiklos Szeredi 	u64 nodeid;
68d8a5ba45SMiklos Szeredi 
699e6268dbSMiklos Szeredi 	/** Number of lookups on this inode */
709e6268dbSMiklos Szeredi 	u64 nlookup;
719e6268dbSMiklos Szeredi 
72e5e5558eSMiklos Szeredi 	/** The request used for sending the FORGET message */
7307e77dcaSMiklos Szeredi 	struct fuse_forget_link *forget;
74e5e5558eSMiklos Szeredi 
75d8a5ba45SMiklos Szeredi 	/** Time in jiffies until the file attributes are valid */
760a0898cfSMiklos Szeredi 	u64 i_time;
77ebc14c4dSMiklos Szeredi 
78ebc14c4dSMiklos Szeredi 	/** The sticky bit in inode->i_mode may have been removed, so
79ebc14c4dSMiklos Szeredi 	    preserve the original mode */
80541af6a0SAl Viro 	umode_t orig_i_mode;
811fb69e78SMiklos Szeredi 
8245c72cd7SPavel Shilovsky 	/** 64 bit inode number */
8345c72cd7SPavel Shilovsky 	u64 orig_ino;
8445c72cd7SPavel Shilovsky 
851fb69e78SMiklos Szeredi 	/** Version of last attribute change */
861fb69e78SMiklos Szeredi 	u64 attr_version;
8793a8c3cdSMiklos Szeredi 
8893a8c3cdSMiklos Szeredi 	/** Files usable in writepage.  Protected by fc->lock */
8993a8c3cdSMiklos Szeredi 	struct list_head write_files;
903be5a52bSMiklos Szeredi 
913be5a52bSMiklos Szeredi 	/** Writepages pending on truncate or fsync */
923be5a52bSMiklos Szeredi 	struct list_head queued_writes;
933be5a52bSMiklos Szeredi 
943be5a52bSMiklos Szeredi 	/** Number of sent writes, a negative bias (FUSE_NOWRITE)
953be5a52bSMiklos Szeredi 	 * means more writes are blocked */
963be5a52bSMiklos Szeredi 	int writectr;
973be5a52bSMiklos Szeredi 
983be5a52bSMiklos Szeredi 	/** Waitq for writepage completion */
993be5a52bSMiklos Szeredi 	wait_queue_head_t page_waitq;
1003be5a52bSMiklos Szeredi 
1013be5a52bSMiklos Szeredi 	/** List of writepage requestst (pending or sent) */
1023be5a52bSMiklos Szeredi 	struct list_head writepages;
1034582a4abSFeng Shuo 
1044582a4abSFeng Shuo 	/** Miscellaneous bits describing inode state */
1054582a4abSFeng Shuo 	unsigned long state;
1065c672ab3SMiklos Szeredi 
1075c672ab3SMiklos Szeredi 	/** Lock for serializing lookup and readdir for back compatibility*/
1085c672ab3SMiklos Szeredi 	struct mutex mutex;
1094582a4abSFeng Shuo };
1104582a4abSFeng Shuo 
1114582a4abSFeng Shuo /** FUSE inode state bits */
1124582a4abSFeng Shuo enum {
1134582a4abSFeng Shuo 	/** Advise readdirplus  */
1144582a4abSFeng Shuo 	FUSE_I_ADVISE_RDPLUS,
1156314efeeSMiklos Szeredi 	/** Initialized with readdirplus */
1166314efeeSMiklos Szeredi 	FUSE_I_INIT_RDPLUS,
11706a7c3c2SMaxim Patlasov 	/** An operation changing file size is in progress  */
11806a7c3c2SMaxim Patlasov 	FUSE_I_SIZE_UNSTABLE,
119d8a5ba45SMiklos Szeredi };
120d8a5ba45SMiklos Szeredi 
121da5e4714SMiklos Szeredi struct fuse_conn;
122da5e4714SMiklos Szeredi 
123b6aeadedSMiklos Szeredi /** FUSE specific file data */
124b6aeadedSMiklos Szeredi struct fuse_file {
125da5e4714SMiklos Szeredi 	/** Fuse connection for this file */
126da5e4714SMiklos Szeredi 	struct fuse_conn *fc;
127da5e4714SMiklos Szeredi 
128b6aeadedSMiklos Szeredi 	/** Request reserved for flush and release */
12933649c91SMiklos Szeredi 	struct fuse_req *reserved_req;
130b6aeadedSMiklos Szeredi 
131acf99433STejun Heo 	/** Kernel file handle guaranteed to be unique */
132acf99433STejun Heo 	u64 kh;
133acf99433STejun Heo 
134b6aeadedSMiklos Szeredi 	/** File handle used by userspace */
135b6aeadedSMiklos Szeredi 	u64 fh;
136c756e0a4SMiklos Szeredi 
137da5e4714SMiklos Szeredi 	/** Node id of this file */
138da5e4714SMiklos Szeredi 	u64 nodeid;
139da5e4714SMiklos Szeredi 
140c756e0a4SMiklos Szeredi 	/** Refcount */
1414e8c2eb5SElena Reshetova 	refcount_t count;
14293a8c3cdSMiklos Szeredi 
143c7b7143cSMiklos Szeredi 	/** FOPEN_* flags returned by open */
144c7b7143cSMiklos Szeredi 	u32 open_flags;
145c7b7143cSMiklos Szeredi 
14693a8c3cdSMiklos Szeredi 	/** Entry on inode's write_files list */
14793a8c3cdSMiklos Szeredi 	struct list_head write_entry;
14895668a69STejun Heo 
14995668a69STejun Heo 	/** RB node to be linked on fuse_conn->polled_files */
15095668a69STejun Heo 	struct rb_node polled_node;
15195668a69STejun Heo 
15295668a69STejun Heo 	/** Wait queue head for poll */
15395668a69STejun Heo 	wait_queue_head_t poll_wait;
15437fb3a30SMiklos Szeredi 
15537fb3a30SMiklos Szeredi 	/** Has flock been performed on this file? */
15637fb3a30SMiklos Szeredi 	bool flock:1;
157b6aeadedSMiklos Szeredi };
158b6aeadedSMiklos Szeredi 
159334f485dSMiklos Szeredi /** One input argument of a request */
160334f485dSMiklos Szeredi struct fuse_in_arg {
161334f485dSMiklos Szeredi 	unsigned size;
162334f485dSMiklos Szeredi 	const void *value;
163334f485dSMiklos Szeredi };
164334f485dSMiklos Szeredi 
165334f485dSMiklos Szeredi /** The request input */
166334f485dSMiklos Szeredi struct fuse_in {
167334f485dSMiklos Szeredi 	/** The request header */
168334f485dSMiklos Szeredi 	struct fuse_in_header h;
169334f485dSMiklos Szeredi 
170334f485dSMiklos Szeredi 	/** True if the data for the last argument is in req->pages */
171334f485dSMiklos Szeredi 	unsigned argpages:1;
172334f485dSMiklos Szeredi 
173334f485dSMiklos Szeredi 	/** Number of arguments */
174334f485dSMiklos Szeredi 	unsigned numargs;
175334f485dSMiklos Szeredi 
176334f485dSMiklos Szeredi 	/** Array of arguments */
177334f485dSMiklos Szeredi 	struct fuse_in_arg args[3];
178334f485dSMiklos Szeredi };
179334f485dSMiklos Szeredi 
180334f485dSMiklos Szeredi /** One output argument of a request */
181334f485dSMiklos Szeredi struct fuse_arg {
182334f485dSMiklos Szeredi 	unsigned size;
183334f485dSMiklos Szeredi 	void *value;
184334f485dSMiklos Szeredi };
185334f485dSMiklos Szeredi 
186334f485dSMiklos Szeredi /** The request output */
187334f485dSMiklos Szeredi struct fuse_out {
188334f485dSMiklos Szeredi 	/** Header returned from userspace */
189334f485dSMiklos Szeredi 	struct fuse_out_header h;
190334f485dSMiklos Szeredi 
191095da6cbSMiklos Szeredi 	/*
192095da6cbSMiklos Szeredi 	 * The following bitfields are not changed during the request
193095da6cbSMiklos Szeredi 	 * processing
194095da6cbSMiklos Szeredi 	 */
195095da6cbSMiklos Szeredi 
196334f485dSMiklos Szeredi 	/** Last argument is variable length (can be shorter than
197334f485dSMiklos Szeredi 	    arg->size) */
198334f485dSMiklos Szeredi 	unsigned argvar:1;
199334f485dSMiklos Szeredi 
200334f485dSMiklos Szeredi 	/** Last argument is a list of pages to copy data to */
201334f485dSMiklos Szeredi 	unsigned argpages:1;
202334f485dSMiklos Szeredi 
203334f485dSMiklos Szeredi 	/** Zero partially or not copied pages */
204334f485dSMiklos Szeredi 	unsigned page_zeroing:1;
205334f485dSMiklos Szeredi 
206ce534fb0SMiklos Szeredi 	/** Pages may be replaced with new ones */
207ce534fb0SMiklos Szeredi 	unsigned page_replace:1;
208ce534fb0SMiklos Szeredi 
209334f485dSMiklos Szeredi 	/** Number or arguments */
210334f485dSMiklos Szeredi 	unsigned numargs;
211334f485dSMiklos Szeredi 
212334f485dSMiklos Szeredi 	/** Array of arguments */
213f704dcb5SMiklos Szeredi 	struct fuse_arg args[2];
214334f485dSMiklos Szeredi };
215334f485dSMiklos Szeredi 
216b2430d75SMaxim Patlasov /** FUSE page descriptor */
217b2430d75SMaxim Patlasov struct fuse_page_desc {
218b2430d75SMaxim Patlasov 	unsigned int length;
219b2430d75SMaxim Patlasov 	unsigned int offset;
220b2430d75SMaxim Patlasov };
221b2430d75SMaxim Patlasov 
2227078187aSMiklos Szeredi struct fuse_args {
2237078187aSMiklos Szeredi 	struct {
2247078187aSMiklos Szeredi 		struct {
2257078187aSMiklos Szeredi 			uint32_t opcode;
2267078187aSMiklos Szeredi 			uint64_t nodeid;
2277078187aSMiklos Szeredi 		} h;
2287078187aSMiklos Szeredi 		unsigned numargs;
2297078187aSMiklos Szeredi 		struct fuse_in_arg args[3];
2307078187aSMiklos Szeredi 
2317078187aSMiklos Szeredi 	} in;
2327078187aSMiklos Szeredi 	struct {
2337078187aSMiklos Szeredi 		unsigned argvar:1;
2347078187aSMiklos Szeredi 		unsigned numargs;
2357078187aSMiklos Szeredi 		struct fuse_arg args[2];
2367078187aSMiklos Szeredi 	} out;
2377078187aSMiklos Szeredi };
2387078187aSMiklos Szeredi 
2397078187aSMiklos Szeredi #define FUSE_ARGS(args) struct fuse_args args = {}
2407078187aSMiklos Szeredi 
24101e9d11aSMaxim Patlasov /** The request IO state (for asynchronous processing) */
24201e9d11aSMaxim Patlasov struct fuse_io_priv {
243744742d6SSeth Forshee 	struct kref refcnt;
24401e9d11aSMaxim Patlasov 	int async;
24501e9d11aSMaxim Patlasov 	spinlock_t lock;
24601e9d11aSMaxim Patlasov 	unsigned reqs;
24701e9d11aSMaxim Patlasov 	ssize_t bytes;
24801e9d11aSMaxim Patlasov 	size_t size;
24901e9d11aSMaxim Patlasov 	__u64 offset;
25001e9d11aSMaxim Patlasov 	bool write;
25101e9d11aSMaxim Patlasov 	int err;
25201e9d11aSMaxim Patlasov 	struct kiocb *iocb;
25301e9d11aSMaxim Patlasov 	struct file *file;
2549d5722b7SChristoph Hellwig 	struct completion *done;
2557879c4e5SAshish Sangwan 	bool blocking;
25601e9d11aSMaxim Patlasov };
25701e9d11aSMaxim Patlasov 
258744742d6SSeth Forshee #define FUSE_IO_PRIV_SYNC(f) \
259744742d6SSeth Forshee {					\
2601e24edcaSPeter Zijlstra 	.refcnt = KREF_INIT(1),		\
261744742d6SSeth Forshee 	.async = 0,			\
262744742d6SSeth Forshee 	.file = f,			\
263744742d6SSeth Forshee }
264744742d6SSeth Forshee 
265334f485dSMiklos Szeredi /**
266825d6d33SMiklos Szeredi  * Request flags
267825d6d33SMiklos Szeredi  *
268825d6d33SMiklos Szeredi  * FR_ISREPLY:		set if the request has reply
269825d6d33SMiklos Szeredi  * FR_FORCE:		force sending of the request even if interrupted
270825d6d33SMiklos Szeredi  * FR_BACKGROUND:	request is sent in the background
271825d6d33SMiklos Szeredi  * FR_WAITING:		request is counted as "waiting"
272825d6d33SMiklos Szeredi  * FR_ABORTED:		the request was aborted
273825d6d33SMiklos Szeredi  * FR_INTERRUPTED:	the request has been interrupted
274825d6d33SMiklos Szeredi  * FR_LOCKED:		data is being copied to/from the request
27533e14b4dSMiklos Szeredi  * FR_PENDING:		request is not yet in userspace
27633e14b4dSMiklos Szeredi  * FR_SENT:		request is in userspace, waiting for an answer
27733e14b4dSMiklos Szeredi  * FR_FINISHED:		request is finished
27877cd9d48SMiklos Szeredi  * FR_PRIVATE:		request is on private list
279825d6d33SMiklos Szeredi  */
280825d6d33SMiklos Szeredi enum fuse_req_flag {
281825d6d33SMiklos Szeredi 	FR_ISREPLY,
282825d6d33SMiklos Szeredi 	FR_FORCE,
283825d6d33SMiklos Szeredi 	FR_BACKGROUND,
284825d6d33SMiklos Szeredi 	FR_WAITING,
285825d6d33SMiklos Szeredi 	FR_ABORTED,
286825d6d33SMiklos Szeredi 	FR_INTERRUPTED,
287825d6d33SMiklos Szeredi 	FR_LOCKED,
28833e14b4dSMiklos Szeredi 	FR_PENDING,
28933e14b4dSMiklos Szeredi 	FR_SENT,
29033e14b4dSMiklos Szeredi 	FR_FINISHED,
29177cd9d48SMiklos Szeredi 	FR_PRIVATE,
292825d6d33SMiklos Szeredi };
293825d6d33SMiklos Szeredi 
294825d6d33SMiklos Szeredi /**
295334f485dSMiklos Szeredi  * A request to the client
296dc00809aSMiklos Szeredi  *
297dc00809aSMiklos Szeredi  * .waitq.lock protects the following fields:
298dc00809aSMiklos Szeredi  *   - FR_ABORTED
299dc00809aSMiklos Szeredi  *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
300334f485dSMiklos Szeredi  */
301334f485dSMiklos Szeredi struct fuse_req {
302ce1d5a49SMiklos Szeredi 	/** This can be on either pending processing or io lists in
303ce1d5a49SMiklos Szeredi 	    fuse_conn */
304334f485dSMiklos Szeredi 	struct list_head list;
305334f485dSMiklos Szeredi 
306a4d27e75SMiklos Szeredi 	/** Entry on the interrupts list  */
307a4d27e75SMiklos Szeredi 	struct list_head intr_entry;
308a4d27e75SMiklos Szeredi 
309334f485dSMiklos Szeredi 	/** refcount */
310*ec99f6d3SElena Reshetova 	refcount_t count;
311334f485dSMiklos Szeredi 
312a4d27e75SMiklos Szeredi 	/** Unique ID for the interrupt request */
313a4d27e75SMiklos Szeredi 	u64 intr_unique;
314a4d27e75SMiklos Szeredi 
315825d6d33SMiklos Szeredi 	/* Request flags, updated with test/set/clear_bit() */
316825d6d33SMiklos Szeredi 	unsigned long flags;
3179bc5dddaSMiklos Szeredi 
318334f485dSMiklos Szeredi 	/** The request input */
319334f485dSMiklos Szeredi 	struct fuse_in in;
320334f485dSMiklos Szeredi 
321334f485dSMiklos Szeredi 	/** The request output */
322334f485dSMiklos Szeredi 	struct fuse_out out;
323334f485dSMiklos Szeredi 
324334f485dSMiklos Szeredi 	/** Used to wake up the task waiting for completion of request*/
325334f485dSMiklos Szeredi 	wait_queue_head_t waitq;
326334f485dSMiklos Szeredi 
327334f485dSMiklos Szeredi 	/** Data for asynchronous requests */
328334f485dSMiklos Szeredi 	union {
329b57d4264SMiklos Szeredi 		struct {
330b57d4264SMiklos Szeredi 			struct fuse_release_in in;
331baebccbeSMiklos Szeredi 			struct inode *inode;
332b57d4264SMiklos Szeredi 		} release;
3333ec870d5SMiklos Szeredi 		struct fuse_init_in init_in;
3343ec870d5SMiklos Szeredi 		struct fuse_init_out init_out;
33508cbf542STejun Heo 		struct cuse_init_in cuse_init_in;
3365c5c5e51SMiklos Szeredi 		struct {
3375c5c5e51SMiklos Szeredi 			struct fuse_read_in in;
3385c5c5e51SMiklos Szeredi 			u64 attr_ver;
3395c5c5e51SMiklos Szeredi 		} read;
340b25e82e5SMiklos Szeredi 		struct {
341b25e82e5SMiklos Szeredi 			struct fuse_write_in in;
342b25e82e5SMiklos Szeredi 			struct fuse_write_out out;
3438b284dc4SMiklos Szeredi 			struct fuse_req *next;
344b25e82e5SMiklos Szeredi 		} write;
3452d45ba38SMiklos Szeredi 		struct fuse_notify_retrieve_in retrieve_in;
346334f485dSMiklos Szeredi 	} misc;
347334f485dSMiklos Szeredi 
348334f485dSMiklos Szeredi 	/** page vector */
3494250c066SMaxim Patlasov 	struct page **pages;
3504250c066SMaxim Patlasov 
351b2430d75SMaxim Patlasov 	/** page-descriptor vector */
352b2430d75SMaxim Patlasov 	struct fuse_page_desc *page_descs;
353b2430d75SMaxim Patlasov 
3544250c066SMaxim Patlasov 	/** size of the 'pages' array */
3554250c066SMaxim Patlasov 	unsigned max_pages;
3564250c066SMaxim Patlasov 
3574250c066SMaxim Patlasov 	/** inline page vector */
3584250c066SMaxim Patlasov 	struct page *inline_pages[FUSE_REQ_INLINE_PAGES];
359334f485dSMiklos Szeredi 
360b2430d75SMaxim Patlasov 	/** inline page-descriptor vector */
361b2430d75SMaxim Patlasov 	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];
362b2430d75SMaxim Patlasov 
363334f485dSMiklos Szeredi 	/** number of pages in vector */
364334f485dSMiklos Szeredi 	unsigned num_pages;
365334f485dSMiklos Szeredi 
366334f485dSMiklos Szeredi 	/** File used in the request (or NULL) */
367c756e0a4SMiklos Szeredi 	struct fuse_file *ff;
36864c6d8edSMiklos Szeredi 
3693be5a52bSMiklos Szeredi 	/** Inode used in the request or NULL */
3703be5a52bSMiklos Szeredi 	struct inode *inode;
3713be5a52bSMiklos Szeredi 
37201e9d11aSMaxim Patlasov 	/** AIO control block */
37301e9d11aSMaxim Patlasov 	struct fuse_io_priv *io;
37401e9d11aSMaxim Patlasov 
3753be5a52bSMiklos Szeredi 	/** Link on fi->writepages */
3763be5a52bSMiklos Szeredi 	struct list_head writepages_entry;
3773be5a52bSMiklos Szeredi 
37864c6d8edSMiklos Szeredi 	/** Request completion callback */
37964c6d8edSMiklos Szeredi 	void (*end)(struct fuse_conn *, struct fuse_req *);
38033649c91SMiklos Szeredi 
38133649c91SMiklos Szeredi 	/** Request is stolen from fuse_file->reserved_req */
38233649c91SMiklos Szeredi 	struct file *stolen_file;
383334f485dSMiklos Szeredi };
384334f485dSMiklos Szeredi 
385f88996a9SMiklos Szeredi struct fuse_iqueue {
386e16714d8SMiklos Szeredi 	/** Connection established */
387e16714d8SMiklos Szeredi 	unsigned connected;
388e16714d8SMiklos Szeredi 
389f88996a9SMiklos Szeredi 	/** Readers of the connection are waiting on this */
390f88996a9SMiklos Szeredi 	wait_queue_head_t waitq;
391f88996a9SMiklos Szeredi 
392f88996a9SMiklos Szeredi 	/** The next unique request id */
393f88996a9SMiklos Szeredi 	u64 reqctr;
394f88996a9SMiklos Szeredi 
395f88996a9SMiklos Szeredi 	/** The list of pending requests */
396f88996a9SMiklos Szeredi 	struct list_head pending;
397f88996a9SMiklos Szeredi 
398f88996a9SMiklos Szeredi 	/** Pending interrupts */
399f88996a9SMiklos Szeredi 	struct list_head interrupts;
400f88996a9SMiklos Szeredi 
401f88996a9SMiklos Szeredi 	/** Queue of pending forgets */
402f88996a9SMiklos Szeredi 	struct fuse_forget_link forget_list_head;
403f88996a9SMiklos Szeredi 	struct fuse_forget_link *forget_list_tail;
404f88996a9SMiklos Szeredi 
405f88996a9SMiklos Szeredi 	/** Batching of FORGET requests (positive indicates FORGET batch) */
406f88996a9SMiklos Szeredi 	int forget_batch;
407f88996a9SMiklos Szeredi 
408f88996a9SMiklos Szeredi 	/** O_ASYNC requests */
409f88996a9SMiklos Szeredi 	struct fasync_struct *fasync;
410f88996a9SMiklos Szeredi };
411f88996a9SMiklos Szeredi 
4123a2b5b9cSMiklos Szeredi struct fuse_pqueue {
413e96edd94SMiklos Szeredi 	/** Connection established */
414e96edd94SMiklos Szeredi 	unsigned connected;
415e96edd94SMiklos Szeredi 
41645a91cb1SMiklos Szeredi 	/** Lock protecting accessess to  members of this structure */
41745a91cb1SMiklos Szeredi 	spinlock_t lock;
41845a91cb1SMiklos Szeredi 
4193a2b5b9cSMiklos Szeredi 	/** The list of requests being processed */
4203a2b5b9cSMiklos Szeredi 	struct list_head processing;
4213a2b5b9cSMiklos Szeredi 
4223a2b5b9cSMiklos Szeredi 	/** The list of requests under I/O */
4233a2b5b9cSMiklos Szeredi 	struct list_head io;
4243a2b5b9cSMiklos Szeredi };
4253a2b5b9cSMiklos Szeredi 
426d8a5ba45SMiklos Szeredi /**
427cc080e9eSMiklos Szeredi  * Fuse device instance
428cc080e9eSMiklos Szeredi  */
429cc080e9eSMiklos Szeredi struct fuse_dev {
430cc080e9eSMiklos Szeredi 	/** Fuse connection for this device */
431cc080e9eSMiklos Szeredi 	struct fuse_conn *fc;
432cc080e9eSMiklos Szeredi 
433c3696046SMiklos Szeredi 	/** Processing queue */
434c3696046SMiklos Szeredi 	struct fuse_pqueue pq;
435c3696046SMiklos Szeredi 
436cc080e9eSMiklos Szeredi 	/** list entry on fc->devices */
437cc080e9eSMiklos Szeredi 	struct list_head entry;
438cc080e9eSMiklos Szeredi };
439cc080e9eSMiklos Szeredi 
440cc080e9eSMiklos Szeredi /**
441d8a5ba45SMiklos Szeredi  * A Fuse connection.
442d8a5ba45SMiklos Szeredi  *
443d8a5ba45SMiklos Szeredi  * This structure is created, when the filesystem is mounted, and is
444d8a5ba45SMiklos Szeredi  * destroyed, when the client device is closed and the filesystem is
445d8a5ba45SMiklos Szeredi  * unmounted.
446d8a5ba45SMiklos Szeredi  */
447d8a5ba45SMiklos Szeredi struct fuse_conn {
448d7133114SMiklos Szeredi 	/** Lock protecting accessess to  members of this structure */
449d7133114SMiklos Szeredi 	spinlock_t lock;
450d7133114SMiklos Szeredi 
451bafa9654SMiklos Szeredi 	/** Refcount */
452bafa9654SMiklos Szeredi 	atomic_t count;
453bafa9654SMiklos Szeredi 
454c3696046SMiklos Szeredi 	/** Number of fuse_dev's */
455c3696046SMiklos Szeredi 	atomic_t dev_count;
456c3696046SMiklos Szeredi 
457dd3e2c55SAl Viro 	struct rcu_head rcu;
458dd3e2c55SAl Viro 
459d8a5ba45SMiklos Szeredi 	/** The user id for this mount */
460499dcf20SEric W. Biederman 	kuid_t user_id;
461d8a5ba45SMiklos Szeredi 
46287729a55SMiklos Szeredi 	/** The group id for this mount */
463499dcf20SEric W. Biederman 	kgid_t group_id;
46487729a55SMiklos Szeredi 
465db50b96cSMiklos Szeredi 	/** Maximum read size */
466db50b96cSMiklos Szeredi 	unsigned max_read;
467db50b96cSMiklos Szeredi 
468413ef8cbSMiklos Szeredi 	/** Maximum write size */
469413ef8cbSMiklos Szeredi 	unsigned max_write;
470413ef8cbSMiklos Szeredi 
471f88996a9SMiklos Szeredi 	/** Input queue */
472f88996a9SMiklos Szeredi 	struct fuse_iqueue iq;
473334f485dSMiklos Szeredi 
474acf99433STejun Heo 	/** The next unique kernel file handle */
475acf99433STejun Heo 	u64 khctr;
476acf99433STejun Heo 
47795668a69STejun Heo 	/** rbtree of fuse_files waiting for poll events indexed by ph */
47895668a69STejun Heo 	struct rb_root polled_files;
47995668a69STejun Heo 
4807a6d3c8bSCsaba Henk 	/** Maximum number of outstanding background requests */
4817a6d3c8bSCsaba Henk 	unsigned max_background;
4827a6d3c8bSCsaba Henk 
4837a6d3c8bSCsaba Henk 	/** Number of background requests at which congestion starts */
4847a6d3c8bSCsaba Henk 	unsigned congestion_threshold;
4857a6d3c8bSCsaba Henk 
48608a53cdcSMiklos Szeredi 	/** Number of requests currently in the background */
48708a53cdcSMiklos Szeredi 	unsigned num_background;
48808a53cdcSMiklos Szeredi 
489d12def1bSMiklos Szeredi 	/** Number of background requests currently queued for userspace */
490d12def1bSMiklos Szeredi 	unsigned active_background;
491d12def1bSMiklos Szeredi 
492d12def1bSMiklos Szeredi 	/** The list of background requests set aside for later queuing */
493d12def1bSMiklos Szeredi 	struct list_head bg_queue;
494d12def1bSMiklos Szeredi 
495796523fbSMaxim Patlasov 	/** Flag indicating that INIT reply has been received. Allocating
496796523fbSMaxim Patlasov 	 * any fuse request will be suspended until the flag is set */
497796523fbSMaxim Patlasov 	int initialized;
498796523fbSMaxim Patlasov 
49908a53cdcSMiklos Szeredi 	/** Flag indicating if connection is blocked.  This will be
50008a53cdcSMiklos Szeredi 	    the case before the INIT reply is received, and if there
50108a53cdcSMiklos Szeredi 	    are too many outstading backgrounds requests */
50208a53cdcSMiklos Szeredi 	int blocked;
50308a53cdcSMiklos Szeredi 
50408a53cdcSMiklos Szeredi 	/** waitq for blocked connection */
50508a53cdcSMiklos Szeredi 	wait_queue_head_t blocked_waitq;
50608a53cdcSMiklos Szeredi 
507de5e3decSMiklos Szeredi 	/** waitq for reserved requests */
508de5e3decSMiklos Szeredi 	wait_queue_head_t reserved_req_waitq;
509de5e3decSMiklos Szeredi 
51069a53bf2SMiklos Szeredi 	/** Connection established, cleared on umount, connection
51169a53bf2SMiklos Szeredi 	    abort and device release */
512095da6cbSMiklos Szeredi 	unsigned connected;
5131e9a4ed9SMiklos Szeredi 
514095da6cbSMiklos Szeredi 	/** Connection failed (version mismatch).  Cannot race with
515095da6cbSMiklos Szeredi 	    setting other bitfields since it is only set once in INIT
516095da6cbSMiklos Szeredi 	    reply, before any other request, and never cleared */
517334f485dSMiklos Szeredi 	unsigned conn_error:1;
518334f485dSMiklos Szeredi 
5190ec7ca41SMiklos Szeredi 	/** Connection successful.  Only set in INIT */
5200ec7ca41SMiklos Szeredi 	unsigned conn_init:1;
5210ec7ca41SMiklos Szeredi 
5229cd68455SMiklos Szeredi 	/** Do readpages asynchronously?  Only set in INIT */
5239cd68455SMiklos Szeredi 	unsigned async_read:1;
5249cd68455SMiklos Szeredi 
5256ff958edSMiklos Szeredi 	/** Do not send separate SETATTR request before open(O_TRUNC)  */
5266ff958edSMiklos Szeredi 	unsigned atomic_o_trunc:1;
5276ff958edSMiklos Szeredi 
52833670fa2SMiklos Szeredi 	/** Filesystem supports NFS exporting.  Only set in INIT */
52933670fa2SMiklos Szeredi 	unsigned export_support:1;
53033670fa2SMiklos Szeredi 
531a325f9b9STejun Heo 	/** Set if bdi is valid */
532a325f9b9STejun Heo 	unsigned bdi_initialized:1;
533a325f9b9STejun Heo 
534d5cd66c5SPavel Emelyanov 	/** write-back cache policy (default is write-through) */
535d5cd66c5SPavel Emelyanov 	unsigned writeback_cache:1;
536d5cd66c5SPavel Emelyanov 
5375c672ab3SMiklos Szeredi 	/** allow parallel lookups and readdir (default is serialized) */
5385c672ab3SMiklos Szeredi 	unsigned parallel_dirops:1;
5395c672ab3SMiklos Szeredi 
5405e940c1dSMiklos Szeredi 	/** handle fs handles killing suid/sgid/cap on write/chown/trunc */
5415e940c1dSMiklos Szeredi 	unsigned handle_killpriv:1;
5425e940c1dSMiklos Szeredi 
543095da6cbSMiklos Szeredi 	/*
544095da6cbSMiklos Szeredi 	 * The following bitfields are only for optimization purposes
545095da6cbSMiklos Szeredi 	 * and hence races in setting them will not cause malfunction
546095da6cbSMiklos Szeredi 	 */
547095da6cbSMiklos Szeredi 
5487678ac50SAndrew Gallagher 	/** Is open/release not implemented by fs? */
5497678ac50SAndrew Gallagher 	unsigned no_open:1;
5507678ac50SAndrew Gallagher 
551b6aeadedSMiklos Szeredi 	/** Is fsync not implemented by fs? */
552b6aeadedSMiklos Szeredi 	unsigned no_fsync:1;
553b6aeadedSMiklos Szeredi 
55482547981SMiklos Szeredi 	/** Is fsyncdir not implemented by fs? */
55582547981SMiklos Szeredi 	unsigned no_fsyncdir:1;
55682547981SMiklos Szeredi 
557b6aeadedSMiklos Szeredi 	/** Is flush not implemented by fs? */
558b6aeadedSMiklos Szeredi 	unsigned no_flush:1;
559b6aeadedSMiklos Szeredi 
56092a8780eSMiklos Szeredi 	/** Is setxattr not implemented by fs? */
56192a8780eSMiklos Szeredi 	unsigned no_setxattr:1;
56292a8780eSMiklos Szeredi 
56392a8780eSMiklos Szeredi 	/** Is getxattr not implemented by fs? */
56492a8780eSMiklos Szeredi 	unsigned no_getxattr:1;
56592a8780eSMiklos Szeredi 
56692a8780eSMiklos Szeredi 	/** Is listxattr not implemented by fs? */
56792a8780eSMiklos Szeredi 	unsigned no_listxattr:1;
56892a8780eSMiklos Szeredi 
56992a8780eSMiklos Szeredi 	/** Is removexattr not implemented by fs? */
57092a8780eSMiklos Szeredi 	unsigned no_removexattr:1;
57192a8780eSMiklos Szeredi 
57237fb3a30SMiklos Szeredi 	/** Are posix file locking primitives not implemented by fs? */
57371421259SMiklos Szeredi 	unsigned no_lock:1;
57471421259SMiklos Szeredi 
57531d40d74SMiklos Szeredi 	/** Is access not implemented by fs? */
57631d40d74SMiklos Szeredi 	unsigned no_access:1;
57731d40d74SMiklos Szeredi 
578fd72faacSMiklos Szeredi 	/** Is create not implemented by fs? */
579fd72faacSMiklos Szeredi 	unsigned no_create:1;
580fd72faacSMiklos Szeredi 
581a4d27e75SMiklos Szeredi 	/** Is interrupt not implemented by fs? */
582a4d27e75SMiklos Szeredi 	unsigned no_interrupt:1;
583a4d27e75SMiklos Szeredi 
584b2d2272fSMiklos Szeredi 	/** Is bmap not implemented by fs? */
585b2d2272fSMiklos Szeredi 	unsigned no_bmap:1;
586b2d2272fSMiklos Szeredi 
58795668a69STejun Heo 	/** Is poll not implemented by fs? */
58895668a69STejun Heo 	unsigned no_poll:1;
58995668a69STejun Heo 
59078bb6cb9SMiklos Szeredi 	/** Do multi-page cached writes */
59178bb6cb9SMiklos Szeredi 	unsigned big_writes:1;
59278bb6cb9SMiklos Szeredi 
593e0a43ddcSMiklos Szeredi 	/** Don't apply umask to creation modes */
594e0a43ddcSMiklos Szeredi 	unsigned dont_mask:1;
595e0a43ddcSMiklos Szeredi 
59637fb3a30SMiklos Szeredi 	/** Are BSD file locking primitives not implemented by fs? */
59737fb3a30SMiklos Szeredi 	unsigned no_flock:1;
59837fb3a30SMiklos Szeredi 
599519c6040SMiklos Szeredi 	/** Is fallocate not implemented by fs? */
600519c6040SMiklos Szeredi 	unsigned no_fallocate:1;
601519c6040SMiklos Szeredi 
6021560c974SMiklos Szeredi 	/** Is rename with flags implemented by fs? */
6031560c974SMiklos Szeredi 	unsigned no_rename2:1;
6041560c974SMiklos Szeredi 
60572d0d248SBrian Foster 	/** Use enhanced/automatic page cache invalidation. */
60672d0d248SBrian Foster 	unsigned auto_inval_data:1;
60772d0d248SBrian Foster 
608634734b6SEric Wong 	/** Does the filesystem support readdirplus? */
6090b05b183SAnand V. Avati 	unsigned do_readdirplus:1;
6100b05b183SAnand V. Avati 
611634734b6SEric Wong 	/** Does the filesystem want adaptive readdirplus? */
612634734b6SEric Wong 	unsigned readdirplus_auto:1;
613634734b6SEric Wong 
61460b9df7aSMiklos Szeredi 	/** Does the filesystem support asynchronous direct-IO submission? */
61560b9df7aSMiklos Szeredi 	unsigned async_dio:1;
61660b9df7aSMiklos Szeredi 
6170b5da8dbSRavishankar N 	/** Is lseek not implemented by fs? */
6180b5da8dbSRavishankar N 	unsigned no_lseek:1;
6190b5da8dbSRavishankar N 
62060bcc88aSSeth Forshee 	/** Does the filesystem support posix acls? */
62160bcc88aSSeth Forshee 	unsigned posix_acl:1;
62260bcc88aSSeth Forshee 
62329433a29SMiklos Szeredi 	/** Check permissions based on the file mode or not? */
62429433a29SMiklos Szeredi 	unsigned default_permissions:1;
62529433a29SMiklos Szeredi 
62629433a29SMiklos Szeredi 	/** Allow other than the mounter user to access the filesystem ? */
62729433a29SMiklos Szeredi 	unsigned allow_other:1;
62829433a29SMiklos Szeredi 
6290cd5b885SMiklos Szeredi 	/** The number of requests waiting for completion */
6300cd5b885SMiklos Szeredi 	atomic_t num_waiting;
6310cd5b885SMiklos Szeredi 
63245714d65SMiklos Szeredi 	/** Negotiated minor version */
63345714d65SMiklos Szeredi 	unsigned minor;
63445714d65SMiklos Szeredi 
635d8a5ba45SMiklos Szeredi 	/** Backing dev info */
636d8a5ba45SMiklos Szeredi 	struct backing_dev_info bdi;
637f543f253SMiklos Szeredi 
638bafa9654SMiklos Szeredi 	/** Entry on the fuse_conn_list */
639bafa9654SMiklos Szeredi 	struct list_head entry;
640bafa9654SMiklos Szeredi 
641b6f2fcbcSMiklos Szeredi 	/** Device ID from super block */
642b6f2fcbcSMiklos Szeredi 	dev_t dev;
643bafa9654SMiklos Szeredi 
644bafa9654SMiklos Szeredi 	/** Dentries in the control filesystem */
645bafa9654SMiklos Szeredi 	struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
646bafa9654SMiklos Szeredi 
647bafa9654SMiklos Szeredi 	/** number of dentries used in the above array */
648bafa9654SMiklos Szeredi 	int ctl_ndents;
649385a17bfSJeff Dike 
6509c8ef561SMiklos Szeredi 	/** Key for lock owner ID scrambling */
6519c8ef561SMiklos Szeredi 	u32 scramble_key[4];
6520ec7ca41SMiklos Szeredi 
6530ec7ca41SMiklos Szeredi 	/** Reserved request for the DESTROY message */
6540ec7ca41SMiklos Szeredi 	struct fuse_req *destroy_req;
6551fb69e78SMiklos Szeredi 
6561fb69e78SMiklos Szeredi 	/** Version counter for attribute changes */
6571fb69e78SMiklos Szeredi 	u64 attr_version;
65843901aabSTejun Heo 
65943901aabSTejun Heo 	/** Called on final put */
66043901aabSTejun Heo 	void (*release)(struct fuse_conn *);
6613b463ae0SJohn Muir 
6623b463ae0SJohn Muir 	/** Super block for this connection. */
6633b463ae0SJohn Muir 	struct super_block *sb;
6643b463ae0SJohn Muir 
6653b463ae0SJohn Muir 	/** Read/write semaphore to hold when accessing sb. */
6663b463ae0SJohn Muir 	struct rw_semaphore killsb;
667cc080e9eSMiklos Szeredi 
668cc080e9eSMiklos Szeredi 	/** List of device instances belonging to this connection */
669cc080e9eSMiklos Szeredi 	struct list_head devices;
670d8a5ba45SMiklos Szeredi };
671d8a5ba45SMiklos Szeredi 
672d8a5ba45SMiklos Szeredi static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
673d8a5ba45SMiklos Szeredi {
6746383bdaaSMiklos Szeredi 	return sb->s_fs_info;
675d8a5ba45SMiklos Szeredi }
676d8a5ba45SMiklos Szeredi 
677d8a5ba45SMiklos Szeredi static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
678d8a5ba45SMiklos Szeredi {
679d8a5ba45SMiklos Szeredi 	return get_fuse_conn_super(inode->i_sb);
680d8a5ba45SMiklos Szeredi }
681d8a5ba45SMiklos Szeredi 
682d8a5ba45SMiklos Szeredi static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
683d8a5ba45SMiklos Szeredi {
684d8a5ba45SMiklos Szeredi 	return container_of(inode, struct fuse_inode, inode);
685d8a5ba45SMiklos Szeredi }
686d8a5ba45SMiklos Szeredi 
687d8a5ba45SMiklos Szeredi static inline u64 get_node_id(struct inode *inode)
688d8a5ba45SMiklos Szeredi {
689d8a5ba45SMiklos Szeredi 	return get_fuse_inode(inode)->nodeid;
690d8a5ba45SMiklos Szeredi }
691d8a5ba45SMiklos Szeredi 
692334f485dSMiklos Szeredi /** Device operations */
6934b6f5d20SArjan van de Ven extern const struct file_operations fuse_dev_operations;
694334f485dSMiklos Szeredi 
6954269590aSAl Viro extern const struct dentry_operations fuse_dentry_operations;
6960ce267ffSMiklos Szeredi extern const struct dentry_operations fuse_root_dentry_operations;
697dbd561d2SMiklos Szeredi 
698d8a5ba45SMiklos Szeredi /**
6993b463ae0SJohn Muir  * Inode to nodeid comparison.
7003b463ae0SJohn Muir  */
7013b463ae0SJohn Muir int fuse_inode_eq(struct inode *inode, void *_nodeidp);
7023b463ae0SJohn Muir 
7033b463ae0SJohn Muir /**
704e5e5558eSMiklos Szeredi  * Get a filled in inode
705e5e5558eSMiklos Szeredi  */
706b48badf0SMiklos Szeredi struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
7071fb69e78SMiklos Szeredi 			int generation, struct fuse_attr *attr,
7081fb69e78SMiklos Szeredi 			u64 attr_valid, u64 attr_version);
709e5e5558eSMiklos Szeredi 
71013983d06SAl Viro int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
71133670fa2SMiklos Szeredi 		     struct fuse_entry_out *outarg, struct inode **inode);
71233670fa2SMiklos Szeredi 
713e5e5558eSMiklos Szeredi /**
714e5e5558eSMiklos Szeredi  * Send FORGET command
715e5e5558eSMiklos Szeredi  */
71607e77dcaSMiklos Szeredi void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
717b48badf0SMiklos Szeredi 		       u64 nodeid, u64 nlookup);
718e5e5558eSMiklos Szeredi 
71907e77dcaSMiklos Szeredi struct fuse_forget_link *fuse_alloc_forget(void);
72007e77dcaSMiklos Szeredi 
7210b05b183SAnand V. Avati /* Used by READDIRPLUS */
7220b05b183SAnand V. Avati void fuse_force_forget(struct file *file, u64 nodeid);
7230b05b183SAnand V. Avati 
724e5e5558eSMiklos Szeredi /**
725361b1eb5SMiklos Szeredi  * Initialize READ or READDIR request
72604730fefSMiklos Szeredi  */
727a6643094SMiklos Szeredi void fuse_read_fill(struct fuse_req *req, struct file *file,
7282106cb18SMiklos Szeredi 		    loff_t pos, size_t count, int opcode);
72904730fefSMiklos Szeredi 
73004730fefSMiklos Szeredi /**
73104730fefSMiklos Szeredi  * Send OPEN or OPENDIR request
73204730fefSMiklos Szeredi  */
73391fe96b4SMiklos Szeredi int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
73404730fefSMiklos Szeredi 
735acf99433STejun Heo struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
736fd72faacSMiklos Szeredi void fuse_file_free(struct fuse_file *ff);
737c7b7143cSMiklos Szeredi void fuse_finish_open(struct inode *inode, struct file *file);
738fd72faacSMiklos Szeredi 
7398b0797a4SMiklos Szeredi void fuse_sync_release(struct fuse_file *ff, int flags);
740c756e0a4SMiklos Szeredi 
74104730fefSMiklos Szeredi /**
74204730fefSMiklos Szeredi  * Send RELEASE or RELEASEDIR request
74304730fefSMiklos Szeredi  */
7448b0797a4SMiklos Szeredi void fuse_release_common(struct file *file, int opcode);
74504730fefSMiklos Szeredi 
74604730fefSMiklos Szeredi /**
74782547981SMiklos Szeredi  * Send FSYNC or FSYNCDIR request
74882547981SMiklos Szeredi  */
74902c24a82SJosef Bacik int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
75002c24a82SJosef Bacik 		      int datasync, int isdir);
75182547981SMiklos Szeredi 
75282547981SMiklos Szeredi /**
75395668a69STejun Heo  * Notify poll wakeup
75495668a69STejun Heo  */
75595668a69STejun Heo int fuse_notify_poll_wakeup(struct fuse_conn *fc,
75695668a69STejun Heo 			    struct fuse_notify_poll_wakeup_out *outarg);
75795668a69STejun Heo 
75895668a69STejun Heo /**
7591779381dSMiklos Szeredi  * Initialize file operations on a regular file
760b6aeadedSMiklos Szeredi  */
761b6aeadedSMiklos Szeredi void fuse_init_file_inode(struct inode *inode);
762b6aeadedSMiklos Szeredi 
763b6aeadedSMiklos Szeredi /**
7641779381dSMiklos Szeredi  * Initialize inode operations on regular files and special files
765e5e5558eSMiklos Szeredi  */
766e5e5558eSMiklos Szeredi void fuse_init_common(struct inode *inode);
767e5e5558eSMiklos Szeredi 
768e5e5558eSMiklos Szeredi /**
7691779381dSMiklos Szeredi  * Initialize inode and file operations on a directory
770e5e5558eSMiklos Szeredi  */
771e5e5558eSMiklos Szeredi void fuse_init_dir(struct inode *inode);
772e5e5558eSMiklos Szeredi 
773e5e5558eSMiklos Szeredi /**
7741779381dSMiklos Szeredi  * Initialize inode operations on a symlink
775e5e5558eSMiklos Szeredi  */
776e5e5558eSMiklos Szeredi void fuse_init_symlink(struct inode *inode);
777e5e5558eSMiklos Szeredi 
778e5e5558eSMiklos Szeredi /**
779e5e5558eSMiklos Szeredi  * Change attributes of an inode
780e5e5558eSMiklos Szeredi  */
7811fb69e78SMiklos Szeredi void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
7821fb69e78SMiklos Szeredi 			    u64 attr_valid, u64 attr_version);
783e5e5558eSMiklos Szeredi 
7843be5a52bSMiklos Szeredi void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
7853be5a52bSMiklos Szeredi 				   u64 attr_valid);
7863be5a52bSMiklos Szeredi 
787e5e5558eSMiklos Szeredi /**
788334f485dSMiklos Szeredi  * Initialize the client device
789334f485dSMiklos Szeredi  */
790334f485dSMiklos Szeredi int fuse_dev_init(void);
791334f485dSMiklos Szeredi 
792334f485dSMiklos Szeredi /**
793334f485dSMiklos Szeredi  * Cleanup the client device
794334f485dSMiklos Szeredi  */
795334f485dSMiklos Szeredi void fuse_dev_cleanup(void);
796334f485dSMiklos Szeredi 
797bafa9654SMiklos Szeredi int fuse_ctl_init(void);
7987736e8ccSFabian Frederick void __exit fuse_ctl_cleanup(void);
799bafa9654SMiklos Szeredi 
800334f485dSMiklos Szeredi /**
801334f485dSMiklos Szeredi  * Allocate a request
802334f485dSMiklos Szeredi  */
8034250c066SMaxim Patlasov struct fuse_req *fuse_request_alloc(unsigned npages);
804334f485dSMiklos Szeredi 
8054250c066SMaxim Patlasov struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
8063be5a52bSMiklos Szeredi 
807334f485dSMiklos Szeredi /**
808334f485dSMiklos Szeredi  * Free a request
809334f485dSMiklos Szeredi  */
810334f485dSMiklos Szeredi void fuse_request_free(struct fuse_req *req);
811334f485dSMiklos Szeredi 
812334f485dSMiklos Szeredi /**
813b111c8c0SMaxim Patlasov  * Get a request, may fail with -ENOMEM,
814b111c8c0SMaxim Patlasov  * caller should specify # elements in req->pages[] explicitly
815334f485dSMiklos Szeredi  */
816b111c8c0SMaxim Patlasov struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
8178b41e671SMaxim Patlasov struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
8188b41e671SMaxim Patlasov 					     unsigned npages);
819b111c8c0SMaxim Patlasov 
82036cf66edSMaxim Patlasov /*
82136cf66edSMaxim Patlasov  * Increment reference count on request
82236cf66edSMaxim Patlasov  */
82336cf66edSMaxim Patlasov void __fuse_get_request(struct fuse_req *req);
82436cf66edSMaxim Patlasov 
825b111c8c0SMaxim Patlasov /**
82633649c91SMiklos Szeredi  * Gets a requests for a file operation, always succeeds
82733649c91SMiklos Szeredi  */
828b111c8c0SMaxim Patlasov struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
829b111c8c0SMaxim Patlasov 					     struct file *file);
83033649c91SMiklos Szeredi 
83133649c91SMiklos Szeredi /**
832ce1d5a49SMiklos Szeredi  * Decrement reference count of a request.  If count goes to zero free
833ce1d5a49SMiklos Szeredi  * the request.
834334f485dSMiklos Szeredi  */
835334f485dSMiklos Szeredi void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
836334f485dSMiklos Szeredi 
837334f485dSMiklos Szeredi /**
8387c352bdfSMiklos Szeredi  * Send a request (synchronous)
839334f485dSMiklos Szeredi  */
840b93f858aSTejun Heo void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
841334f485dSMiklos Szeredi 
842334f485dSMiklos Szeredi /**
8437078187aSMiklos Szeredi  * Simple request sending that does request allocation and freeing
8447078187aSMiklos Szeredi  */
8457078187aSMiklos Szeredi ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);
8467078187aSMiklos Szeredi 
8477078187aSMiklos Szeredi /**
848334f485dSMiklos Szeredi  * Send a request in the background
849334f485dSMiklos Szeredi  */
850b93f858aSTejun Heo void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
851334f485dSMiklos Szeredi 
852b93f858aSTejun Heo void fuse_request_send_background_locked(struct fuse_conn *fc,
853b93f858aSTejun Heo 					 struct fuse_req *req);
8543be5a52bSMiklos Szeredi 
8555a5fb1eaSMiklos Szeredi /* Abort all requests */
85669a53bf2SMiklos Szeredi void fuse_abort_conn(struct fuse_conn *fc);
85769a53bf2SMiklos Szeredi 
8581e9a4ed9SMiklos Szeredi /**
859e5e5558eSMiklos Szeredi  * Invalidate inode attributes
860e5e5558eSMiklos Szeredi  */
861e5e5558eSMiklos Szeredi void fuse_invalidate_attr(struct inode *inode);
862bafa9654SMiklos Szeredi 
863dbd561d2SMiklos Szeredi void fuse_invalidate_entry_cache(struct dentry *entry);
864dbd561d2SMiklos Szeredi 
865451418fcSAndrew Gallagher void fuse_invalidate_atime(struct inode *inode);
866451418fcSAndrew Gallagher 
867bafa9654SMiklos Szeredi /**
868bafa9654SMiklos Szeredi  * Acquire reference to fuse_conn
869bafa9654SMiklos Szeredi  */
870bafa9654SMiklos Szeredi struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
871bafa9654SMiklos Szeredi 
872bafa9654SMiklos Szeredi /**
8730d179aa5STejun Heo  * Initialize fuse_conn
8740d179aa5STejun Heo  */
875a325f9b9STejun Heo void fuse_conn_init(struct fuse_conn *fc);
8760d179aa5STejun Heo 
8770d179aa5STejun Heo /**
878bafa9654SMiklos Szeredi  * Release reference to fuse_conn
879bafa9654SMiklos Szeredi  */
880bafa9654SMiklos Szeredi void fuse_conn_put(struct fuse_conn *fc);
881bafa9654SMiklos Szeredi 
882cc080e9eSMiklos Szeredi struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
883cc080e9eSMiklos Szeredi void fuse_dev_free(struct fuse_dev *fud);
884cc080e9eSMiklos Szeredi 
885bafa9654SMiklos Szeredi /**
886bafa9654SMiklos Szeredi  * Add connection to control filesystem
887bafa9654SMiklos Szeredi  */
888bafa9654SMiklos Szeredi int fuse_ctl_add_conn(struct fuse_conn *fc);
889bafa9654SMiklos Szeredi 
890bafa9654SMiklos Szeredi /**
891bafa9654SMiklos Szeredi  * Remove connection from control filesystem
892bafa9654SMiklos Szeredi  */
893bafa9654SMiklos Szeredi void fuse_ctl_remove_conn(struct fuse_conn *fc);
894a5bfffacSTimo Savola 
895a5bfffacSTimo Savola /**
896a5bfffacSTimo Savola  * Is file type valid?
897a5bfffacSTimo Savola  */
898a5bfffacSTimo Savola int fuse_valid_type(int m);
899e57ac683SMiklos Szeredi 
900e57ac683SMiklos Szeredi /**
901c2132c1bSAnatol Pomozov  * Is current process allowed to perform filesystem operation?
902e57ac683SMiklos Szeredi  */
903c2132c1bSAnatol Pomozov int fuse_allow_current_process(struct fuse_conn *fc);
904f3332114SMiklos Szeredi 
905f3332114SMiklos Szeredi u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
906bcb4be80SMiklos Szeredi 
907703c7362SSeth Forshee void fuse_update_ctime(struct inode *inode);
908703c7362SSeth Forshee 
909bcb4be80SMiklos Szeredi int fuse_update_attributes(struct inode *inode, struct kstat *stat,
910bcb4be80SMiklos Szeredi 			   struct file *file, bool *refreshed);
9113be5a52bSMiklos Szeredi 
9123be5a52bSMiklos Szeredi void fuse_flush_writepages(struct inode *inode);
9133be5a52bSMiklos Szeredi 
9143be5a52bSMiklos Szeredi void fuse_set_nowrite(struct inode *inode);
9153be5a52bSMiklos Szeredi void fuse_release_nowrite(struct inode *inode);
9165c5c5e51SMiklos Szeredi 
9175c5c5e51SMiklos Szeredi u64 fuse_get_attr_version(struct fuse_conn *fc);
91829d434b3STejun Heo 
9193b463ae0SJohn Muir /**
9203b463ae0SJohn Muir  * File-system tells the kernel to invalidate cache for the given node id.
9213b463ae0SJohn Muir  */
9223b463ae0SJohn Muir int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
9233b463ae0SJohn Muir 			     loff_t offset, loff_t len);
9243b463ae0SJohn Muir 
9253b463ae0SJohn Muir /**
9263b463ae0SJohn Muir  * File-system tells the kernel to invalidate parent attributes and
9273b463ae0SJohn Muir  * the dentry matching parent/name.
928451d0f59SJohn Muir  *
929451d0f59SJohn Muir  * If the child_nodeid is non-zero and:
930451d0f59SJohn Muir  *    - matches the inode number for the dentry matching parent/name,
931451d0f59SJohn Muir  *    - is not a mount point
932451d0f59SJohn Muir  *    - is a file or oan empty directory
933451d0f59SJohn Muir  * then the dentry is unhashed (d_delete()).
9343b463ae0SJohn Muir  */
9353b463ae0SJohn Muir int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
936451d0f59SJohn Muir 			     u64 child_nodeid, struct qstr *name);
9373b463ae0SJohn Muir 
93808cbf542STejun Heo int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
93908cbf542STejun Heo 		 bool isdir);
940ea8cd333SPavel Emelyanov 
941ea8cd333SPavel Emelyanov /**
942ea8cd333SPavel Emelyanov  * fuse_direct_io() flags
943ea8cd333SPavel Emelyanov  */
944ea8cd333SPavel Emelyanov 
945ea8cd333SPavel Emelyanov /** If set, it is WRITE; otherwise - READ */
946ea8cd333SPavel Emelyanov #define FUSE_DIO_WRITE (1 << 0)
947ea8cd333SPavel Emelyanov 
948ea8cd333SPavel Emelyanov /** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
949ea8cd333SPavel Emelyanov #define FUSE_DIO_CUSE  (1 << 1)
950ea8cd333SPavel Emelyanov 
951d22a943fSAl Viro ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
952d22a943fSAl Viro 		       loff_t *ppos, int flags);
95308cbf542STejun Heo long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
95408cbf542STejun Heo 		   unsigned int flags);
955b18da0c5SMiklos Szeredi long fuse_ioctl_common(struct file *file, unsigned int cmd,
956b18da0c5SMiklos Szeredi 		       unsigned long arg, unsigned int flags);
95708cbf542STejun Heo unsigned fuse_file_poll(struct file *file, poll_table *wait);
95808cbf542STejun Heo int fuse_dev_release(struct inode *inode, struct file *file);
95908cbf542STejun Heo 
960b0aa7606SMaxim Patlasov bool fuse_write_update_size(struct inode *inode, loff_t pos);
961b0aa7606SMaxim Patlasov 
962ab9e13f7SMaxim Patlasov int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
9631e18bda8SMiklos Szeredi int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
964a1d75f25SMiklos Szeredi 
96562490330SJan Kara int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
966efb9fa9eSMaxim Patlasov 		    struct file *file);
967efb9fa9eSMaxim Patlasov 
9689759bd51SMiklos Szeredi void fuse_set_initialized(struct fuse_conn *fc);
9699759bd51SMiklos Szeredi 
9705c672ab3SMiklos Szeredi void fuse_unlock_inode(struct inode *inode);
9715c672ab3SMiklos Szeredi void fuse_lock_inode(struct inode *inode);
9725c672ab3SMiklos Szeredi 
97360bcc88aSSeth Forshee int fuse_setxattr(struct inode *inode, const char *name, const void *value,
97460bcc88aSSeth Forshee 		  size_t size, int flags);
97560bcc88aSSeth Forshee ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value,
97660bcc88aSSeth Forshee 		      size_t size);
977703c7362SSeth Forshee ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
97860bcc88aSSeth Forshee int fuse_removexattr(struct inode *inode, const char *name);
979703c7362SSeth Forshee extern const struct xattr_handler *fuse_xattr_handlers[];
98060bcc88aSSeth Forshee extern const struct xattr_handler *fuse_acl_xattr_handlers[];
98160bcc88aSSeth Forshee 
98260bcc88aSSeth Forshee struct posix_acl;
98360bcc88aSSeth Forshee struct posix_acl *fuse_get_acl(struct inode *inode, int type);
98460bcc88aSSeth Forshee int fuse_set_acl(struct inode *inode, struct posix_acl *acl, int type);
985703c7362SSeth Forshee 
98629d434b3STejun Heo #endif /* _FS_FUSE_I_H */
987