xref: /openbmc/linux/fs/fuse/fuse_i.h (revision 744742d692e37ad5c20630e57d526c8f2e2fe3c9)
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>
25*744742d6SSeth Forshee #include <linux/kref.h>
26d8a5ba45SMiklos Szeredi 
27334f485dSMiklos Szeredi /** Max number of pages that can be used in a single read request */
28334f485dSMiklos Szeredi #define FUSE_MAX_PAGES_PER_REQ 32
29334f485dSMiklos Szeredi 
303be5a52bSMiklos Szeredi /** Bias for fi->writectr, meaning new writepages must not be sent */
313be5a52bSMiklos Szeredi #define FUSE_NOWRITE INT_MIN
323be5a52bSMiklos Szeredi 
331d3d752bSMiklos Szeredi /** It could be as large as PATH_MAX, but would that have any uses? */
341d3d752bSMiklos Szeredi #define FUSE_NAME_MAX 1024
351d3d752bSMiklos Szeredi 
36bafa9654SMiklos Szeredi /** Number of dentries for each connection in the control filesystem */
3779a9d994SCsaba Henk #define FUSE_CTL_NUM_DENTRIES 5
38bafa9654SMiklos Szeredi 
391e9a4ed9SMiklos Szeredi /** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
401e9a4ed9SMiklos Szeredi     module will check permissions based on the file mode.  Otherwise no
411e9a4ed9SMiklos Szeredi     permission checking is done in the kernel */
421e9a4ed9SMiklos Szeredi #define FUSE_DEFAULT_PERMISSIONS (1 << 0)
431e9a4ed9SMiklos Szeredi 
441e9a4ed9SMiklos Szeredi /** If the FUSE_ALLOW_OTHER flag is given, then not only the user
451e9a4ed9SMiklos Szeredi     doing the mount will be allowed to access the filesystem */
461e9a4ed9SMiklos Szeredi #define FUSE_ALLOW_OTHER         (1 << 1)
471e9a4ed9SMiklos Szeredi 
484250c066SMaxim Patlasov /** Number of page pointers embedded in fuse_req */
494250c066SMaxim Patlasov #define FUSE_REQ_INLINE_PAGES 1
504250c066SMaxim Patlasov 
51bafa9654SMiklos Szeredi /** List of active connections */
52bafa9654SMiklos Szeredi extern struct list_head fuse_conn_list;
53bafa9654SMiklos Szeredi 
54bafa9654SMiklos Szeredi /** Global mutex protecting fuse_conn_list and the control filesystem */
55bafa9654SMiklos Szeredi extern struct mutex fuse_mutex;
56413ef8cbSMiklos Szeredi 
5779a9d994SCsaba Henk /** Module parameters */
5879a9d994SCsaba Henk extern unsigned max_user_bgreq;
5979a9d994SCsaba Henk extern unsigned max_user_congthresh;
6079a9d994SCsaba Henk 
6107e77dcaSMiklos Szeredi /* One forget request */
6207e77dcaSMiklos Szeredi struct fuse_forget_link {
6302c048b9SMiklos Szeredi 	struct fuse_forget_one forget_one;
6407e77dcaSMiklos Szeredi 	struct fuse_forget_link *next;
6507e77dcaSMiklos Szeredi };
6607e77dcaSMiklos Szeredi 
67d8a5ba45SMiklos Szeredi /** FUSE inode */
68d8a5ba45SMiklos Szeredi struct fuse_inode {
69d8a5ba45SMiklos Szeredi 	/** Inode data */
70d8a5ba45SMiklos Szeredi 	struct inode inode;
71d8a5ba45SMiklos Szeredi 
72d8a5ba45SMiklos Szeredi 	/** Unique ID, which identifies the inode between userspace
73d8a5ba45SMiklos Szeredi 	 * and kernel */
74d8a5ba45SMiklos Szeredi 	u64 nodeid;
75d8a5ba45SMiklos Szeredi 
769e6268dbSMiklos Szeredi 	/** Number of lookups on this inode */
779e6268dbSMiklos Szeredi 	u64 nlookup;
789e6268dbSMiklos Szeredi 
79e5e5558eSMiklos Szeredi 	/** The request used for sending the FORGET message */
8007e77dcaSMiklos Szeredi 	struct fuse_forget_link *forget;
81e5e5558eSMiklos Szeredi 
82d8a5ba45SMiklos Szeredi 	/** Time in jiffies until the file attributes are valid */
830a0898cfSMiklos Szeredi 	u64 i_time;
84ebc14c4dSMiklos Szeredi 
85ebc14c4dSMiklos Szeredi 	/** The sticky bit in inode->i_mode may have been removed, so
86ebc14c4dSMiklos Szeredi 	    preserve the original mode */
87541af6a0SAl Viro 	umode_t orig_i_mode;
881fb69e78SMiklos Szeredi 
8945c72cd7SPavel Shilovsky 	/** 64 bit inode number */
9045c72cd7SPavel Shilovsky 	u64 orig_ino;
9145c72cd7SPavel Shilovsky 
921fb69e78SMiklos Szeredi 	/** Version of last attribute change */
931fb69e78SMiklos Szeredi 	u64 attr_version;
9493a8c3cdSMiklos Szeredi 
9593a8c3cdSMiklos Szeredi 	/** Files usable in writepage.  Protected by fc->lock */
9693a8c3cdSMiklos Szeredi 	struct list_head write_files;
973be5a52bSMiklos Szeredi 
983be5a52bSMiklos Szeredi 	/** Writepages pending on truncate or fsync */
993be5a52bSMiklos Szeredi 	struct list_head queued_writes;
1003be5a52bSMiklos Szeredi 
1013be5a52bSMiklos Szeredi 	/** Number of sent writes, a negative bias (FUSE_NOWRITE)
1023be5a52bSMiklos Szeredi 	 * means more writes are blocked */
1033be5a52bSMiklos Szeredi 	int writectr;
1043be5a52bSMiklos Szeredi 
1053be5a52bSMiklos Szeredi 	/** Waitq for writepage completion */
1063be5a52bSMiklos Szeredi 	wait_queue_head_t page_waitq;
1073be5a52bSMiklos Szeredi 
1083be5a52bSMiklos Szeredi 	/** List of writepage requestst (pending or sent) */
1093be5a52bSMiklos Szeredi 	struct list_head writepages;
1104582a4abSFeng Shuo 
1114582a4abSFeng Shuo 	/** Miscellaneous bits describing inode state */
1124582a4abSFeng Shuo 	unsigned long state;
1134582a4abSFeng Shuo };
1144582a4abSFeng Shuo 
1154582a4abSFeng Shuo /** FUSE inode state bits */
1164582a4abSFeng Shuo enum {
1174582a4abSFeng Shuo 	/** Advise readdirplus  */
1184582a4abSFeng Shuo 	FUSE_I_ADVISE_RDPLUS,
1196314efeeSMiklos Szeredi 	/** Initialized with readdirplus */
1206314efeeSMiklos Szeredi 	FUSE_I_INIT_RDPLUS,
12106a7c3c2SMaxim Patlasov 	/** An operation changing file size is in progress  */
12206a7c3c2SMaxim Patlasov 	FUSE_I_SIZE_UNSTABLE,
123d8a5ba45SMiklos Szeredi };
124d8a5ba45SMiklos Szeredi 
125da5e4714SMiklos Szeredi struct fuse_conn;
126da5e4714SMiklos Szeredi 
127b6aeadedSMiklos Szeredi /** FUSE specific file data */
128b6aeadedSMiklos Szeredi struct fuse_file {
129da5e4714SMiklos Szeredi 	/** Fuse connection for this file */
130da5e4714SMiklos Szeredi 	struct fuse_conn *fc;
131da5e4714SMiklos Szeredi 
132b6aeadedSMiklos Szeredi 	/** Request reserved for flush and release */
13333649c91SMiklos Szeredi 	struct fuse_req *reserved_req;
134b6aeadedSMiklos Szeredi 
135acf99433STejun Heo 	/** Kernel file handle guaranteed to be unique */
136acf99433STejun Heo 	u64 kh;
137acf99433STejun Heo 
138b6aeadedSMiklos Szeredi 	/** File handle used by userspace */
139b6aeadedSMiklos Szeredi 	u64 fh;
140c756e0a4SMiklos Szeredi 
141da5e4714SMiklos Szeredi 	/** Node id of this file */
142da5e4714SMiklos Szeredi 	u64 nodeid;
143da5e4714SMiklos Szeredi 
144c756e0a4SMiklos Szeredi 	/** Refcount */
145c756e0a4SMiklos Szeredi 	atomic_t count;
14693a8c3cdSMiklos Szeredi 
147c7b7143cSMiklos Szeredi 	/** FOPEN_* flags returned by open */
148c7b7143cSMiklos Szeredi 	u32 open_flags;
149c7b7143cSMiklos Szeredi 
15093a8c3cdSMiklos Szeredi 	/** Entry on inode's write_files list */
15193a8c3cdSMiklos Szeredi 	struct list_head write_entry;
15295668a69STejun Heo 
15395668a69STejun Heo 	/** RB node to be linked on fuse_conn->polled_files */
15495668a69STejun Heo 	struct rb_node polled_node;
15595668a69STejun Heo 
15695668a69STejun Heo 	/** Wait queue head for poll */
15795668a69STejun Heo 	wait_queue_head_t poll_wait;
15837fb3a30SMiklos Szeredi 
15937fb3a30SMiklos Szeredi 	/** Has flock been performed on this file? */
16037fb3a30SMiklos Szeredi 	bool flock:1;
161b6aeadedSMiklos Szeredi };
162b6aeadedSMiklos Szeredi 
163334f485dSMiklos Szeredi /** One input argument of a request */
164334f485dSMiklos Szeredi struct fuse_in_arg {
165334f485dSMiklos Szeredi 	unsigned size;
166334f485dSMiklos Szeredi 	const void *value;
167334f485dSMiklos Szeredi };
168334f485dSMiklos Szeredi 
169334f485dSMiklos Szeredi /** The request input */
170334f485dSMiklos Szeredi struct fuse_in {
171334f485dSMiklos Szeredi 	/** The request header */
172334f485dSMiklos Szeredi 	struct fuse_in_header h;
173334f485dSMiklos Szeredi 
174334f485dSMiklos Szeredi 	/** True if the data for the last argument is in req->pages */
175334f485dSMiklos Szeredi 	unsigned argpages:1;
176334f485dSMiklos Szeredi 
177334f485dSMiklos Szeredi 	/** Number of arguments */
178334f485dSMiklos Szeredi 	unsigned numargs;
179334f485dSMiklos Szeredi 
180334f485dSMiklos Szeredi 	/** Array of arguments */
181334f485dSMiklos Szeredi 	struct fuse_in_arg args[3];
182334f485dSMiklos Szeredi };
183334f485dSMiklos Szeredi 
184334f485dSMiklos Szeredi /** One output argument of a request */
185334f485dSMiklos Szeredi struct fuse_arg {
186334f485dSMiklos Szeredi 	unsigned size;
187334f485dSMiklos Szeredi 	void *value;
188334f485dSMiklos Szeredi };
189334f485dSMiklos Szeredi 
190334f485dSMiklos Szeredi /** The request output */
191334f485dSMiklos Szeredi struct fuse_out {
192334f485dSMiklos Szeredi 	/** Header returned from userspace */
193334f485dSMiklos Szeredi 	struct fuse_out_header h;
194334f485dSMiklos Szeredi 
195095da6cbSMiklos Szeredi 	/*
196095da6cbSMiklos Szeredi 	 * The following bitfields are not changed during the request
197095da6cbSMiklos Szeredi 	 * processing
198095da6cbSMiklos Szeredi 	 */
199095da6cbSMiklos Szeredi 
200334f485dSMiklos Szeredi 	/** Last argument is variable length (can be shorter than
201334f485dSMiklos Szeredi 	    arg->size) */
202334f485dSMiklos Szeredi 	unsigned argvar:1;
203334f485dSMiklos Szeredi 
204334f485dSMiklos Szeredi 	/** Last argument is a list of pages to copy data to */
205334f485dSMiklos Szeredi 	unsigned argpages:1;
206334f485dSMiklos Szeredi 
207334f485dSMiklos Szeredi 	/** Zero partially or not copied pages */
208334f485dSMiklos Szeredi 	unsigned page_zeroing:1;
209334f485dSMiklos Szeredi 
210ce534fb0SMiklos Szeredi 	/** Pages may be replaced with new ones */
211ce534fb0SMiklos Szeredi 	unsigned page_replace:1;
212ce534fb0SMiklos Szeredi 
213334f485dSMiklos Szeredi 	/** Number or arguments */
214334f485dSMiklos Szeredi 	unsigned numargs;
215334f485dSMiklos Szeredi 
216334f485dSMiklos Szeredi 	/** Array of arguments */
217f704dcb5SMiklos Szeredi 	struct fuse_arg args[2];
218334f485dSMiklos Szeredi };
219334f485dSMiklos Szeredi 
220b2430d75SMaxim Patlasov /** FUSE page descriptor */
221b2430d75SMaxim Patlasov struct fuse_page_desc {
222b2430d75SMaxim Patlasov 	unsigned int length;
223b2430d75SMaxim Patlasov 	unsigned int offset;
224b2430d75SMaxim Patlasov };
225b2430d75SMaxim Patlasov 
2267078187aSMiklos Szeredi struct fuse_args {
2277078187aSMiklos Szeredi 	struct {
2287078187aSMiklos Szeredi 		struct {
2297078187aSMiklos Szeredi 			uint32_t opcode;
2307078187aSMiklos Szeredi 			uint64_t nodeid;
2317078187aSMiklos Szeredi 		} h;
2327078187aSMiklos Szeredi 		unsigned numargs;
2337078187aSMiklos Szeredi 		struct fuse_in_arg args[3];
2347078187aSMiklos Szeredi 
2357078187aSMiklos Szeredi 	} in;
2367078187aSMiklos Szeredi 	struct {
2377078187aSMiklos Szeredi 		unsigned argvar:1;
2387078187aSMiklos Szeredi 		unsigned numargs;
2397078187aSMiklos Szeredi 		struct fuse_arg args[2];
2407078187aSMiklos Szeredi 	} out;
2417078187aSMiklos Szeredi };
2427078187aSMiklos Szeredi 
2437078187aSMiklos Szeredi #define FUSE_ARGS(args) struct fuse_args args = {}
2447078187aSMiklos Szeredi 
24501e9d11aSMaxim Patlasov /** The request IO state (for asynchronous processing) */
24601e9d11aSMaxim Patlasov struct fuse_io_priv {
247*744742d6SSeth Forshee 	struct kref refcnt;
24801e9d11aSMaxim Patlasov 	int async;
24901e9d11aSMaxim Patlasov 	spinlock_t lock;
25001e9d11aSMaxim Patlasov 	unsigned reqs;
25101e9d11aSMaxim Patlasov 	ssize_t bytes;
25201e9d11aSMaxim Patlasov 	size_t size;
25301e9d11aSMaxim Patlasov 	__u64 offset;
25401e9d11aSMaxim Patlasov 	bool write;
25501e9d11aSMaxim Patlasov 	int err;
25601e9d11aSMaxim Patlasov 	struct kiocb *iocb;
25701e9d11aSMaxim Patlasov 	struct file *file;
2589d5722b7SChristoph Hellwig 	struct completion *done;
25901e9d11aSMaxim Patlasov };
26001e9d11aSMaxim Patlasov 
261*744742d6SSeth Forshee #define FUSE_IO_PRIV_SYNC(f) \
262*744742d6SSeth Forshee {					\
263*744742d6SSeth Forshee 	.refcnt = { ATOMIC_INIT(1) },	\
264*744742d6SSeth Forshee 	.async = 0,			\
265*744742d6SSeth Forshee 	.file = f,			\
266*744742d6SSeth Forshee }
267*744742d6SSeth Forshee 
268334f485dSMiklos Szeredi /**
269825d6d33SMiklos Szeredi  * Request flags
270825d6d33SMiklos Szeredi  *
271825d6d33SMiklos Szeredi  * FR_ISREPLY:		set if the request has reply
272825d6d33SMiklos Szeredi  * FR_FORCE:		force sending of the request even if interrupted
273825d6d33SMiklos Szeredi  * FR_BACKGROUND:	request is sent in the background
274825d6d33SMiklos Szeredi  * FR_WAITING:		request is counted as "waiting"
275825d6d33SMiklos Szeredi  * FR_ABORTED:		the request was aborted
276825d6d33SMiklos Szeredi  * FR_INTERRUPTED:	the request has been interrupted
277825d6d33SMiklos Szeredi  * FR_LOCKED:		data is being copied to/from the request
27833e14b4dSMiklos Szeredi  * FR_PENDING:		request is not yet in userspace
27933e14b4dSMiklos Szeredi  * FR_SENT:		request is in userspace, waiting for an answer
28033e14b4dSMiklos Szeredi  * FR_FINISHED:		request is finished
28177cd9d48SMiklos Szeredi  * FR_PRIVATE:		request is on private list
282825d6d33SMiklos Szeredi  */
283825d6d33SMiklos Szeredi enum fuse_req_flag {
284825d6d33SMiklos Szeredi 	FR_ISREPLY,
285825d6d33SMiklos Szeredi 	FR_FORCE,
286825d6d33SMiklos Szeredi 	FR_BACKGROUND,
287825d6d33SMiklos Szeredi 	FR_WAITING,
288825d6d33SMiklos Szeredi 	FR_ABORTED,
289825d6d33SMiklos Szeredi 	FR_INTERRUPTED,
290825d6d33SMiklos Szeredi 	FR_LOCKED,
29133e14b4dSMiklos Szeredi 	FR_PENDING,
29233e14b4dSMiklos Szeredi 	FR_SENT,
29333e14b4dSMiklos Szeredi 	FR_FINISHED,
29477cd9d48SMiklos Szeredi 	FR_PRIVATE,
295825d6d33SMiklos Szeredi };
296825d6d33SMiklos Szeredi 
297825d6d33SMiklos Szeredi /**
298334f485dSMiklos Szeredi  * A request to the client
299dc00809aSMiklos Szeredi  *
300dc00809aSMiklos Szeredi  * .waitq.lock protects the following fields:
301dc00809aSMiklos Szeredi  *   - FR_ABORTED
302dc00809aSMiklos Szeredi  *   - FR_LOCKED (may also be modified under fc->lock, tested under both)
303334f485dSMiklos Szeredi  */
304334f485dSMiklos Szeredi struct fuse_req {
305ce1d5a49SMiklos Szeredi 	/** This can be on either pending processing or io lists in
306ce1d5a49SMiklos Szeredi 	    fuse_conn */
307334f485dSMiklos Szeredi 	struct list_head list;
308334f485dSMiklos Szeredi 
309a4d27e75SMiklos Szeredi 	/** Entry on the interrupts list  */
310a4d27e75SMiklos Szeredi 	struct list_head intr_entry;
311a4d27e75SMiklos Szeredi 
312334f485dSMiklos Szeredi 	/** refcount */
313334f485dSMiklos Szeredi 	atomic_t count;
314334f485dSMiklos Szeredi 
315a4d27e75SMiklos Szeredi 	/** Unique ID for the interrupt request */
316a4d27e75SMiklos Szeredi 	u64 intr_unique;
317a4d27e75SMiklos Szeredi 
318825d6d33SMiklos Szeredi 	/* Request flags, updated with test/set/clear_bit() */
319825d6d33SMiklos Szeredi 	unsigned long flags;
3209bc5dddaSMiklos Szeredi 
321334f485dSMiklos Szeredi 	/** The request input */
322334f485dSMiklos Szeredi 	struct fuse_in in;
323334f485dSMiklos Szeredi 
324334f485dSMiklos Szeredi 	/** The request output */
325334f485dSMiklos Szeredi 	struct fuse_out out;
326334f485dSMiklos Szeredi 
327334f485dSMiklos Szeredi 	/** Used to wake up the task waiting for completion of request*/
328334f485dSMiklos Szeredi 	wait_queue_head_t waitq;
329334f485dSMiklos Szeredi 
330334f485dSMiklos Szeredi 	/** Data for asynchronous requests */
331334f485dSMiklos Szeredi 	union {
332b57d4264SMiklos Szeredi 		struct {
333b57d4264SMiklos Szeredi 			struct fuse_release_in in;
334baebccbeSMiklos Szeredi 			struct inode *inode;
335b57d4264SMiklos Szeredi 		} release;
3363ec870d5SMiklos Szeredi 		struct fuse_init_in init_in;
3373ec870d5SMiklos Szeredi 		struct fuse_init_out init_out;
33808cbf542STejun Heo 		struct cuse_init_in cuse_init_in;
3395c5c5e51SMiklos Szeredi 		struct {
3405c5c5e51SMiklos Szeredi 			struct fuse_read_in in;
3415c5c5e51SMiklos Szeredi 			u64 attr_ver;
3425c5c5e51SMiklos Szeredi 		} read;
343b25e82e5SMiklos Szeredi 		struct {
344b25e82e5SMiklos Szeredi 			struct fuse_write_in in;
345b25e82e5SMiklos Szeredi 			struct fuse_write_out out;
3468b284dc4SMiklos Szeredi 			struct fuse_req *next;
347b25e82e5SMiklos Szeredi 		} write;
3482d45ba38SMiklos Szeredi 		struct fuse_notify_retrieve_in retrieve_in;
349334f485dSMiklos Szeredi 	} misc;
350334f485dSMiklos Szeredi 
351334f485dSMiklos Szeredi 	/** page vector */
3524250c066SMaxim Patlasov 	struct page **pages;
3534250c066SMaxim Patlasov 
354b2430d75SMaxim Patlasov 	/** page-descriptor vector */
355b2430d75SMaxim Patlasov 	struct fuse_page_desc *page_descs;
356b2430d75SMaxim Patlasov 
3574250c066SMaxim Patlasov 	/** size of the 'pages' array */
3584250c066SMaxim Patlasov 	unsigned max_pages;
3594250c066SMaxim Patlasov 
3604250c066SMaxim Patlasov 	/** inline page vector */
3614250c066SMaxim Patlasov 	struct page *inline_pages[FUSE_REQ_INLINE_PAGES];
362334f485dSMiklos Szeredi 
363b2430d75SMaxim Patlasov 	/** inline page-descriptor vector */
364b2430d75SMaxim Patlasov 	struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];
365b2430d75SMaxim Patlasov 
366334f485dSMiklos Szeredi 	/** number of pages in vector */
367334f485dSMiklos Szeredi 	unsigned num_pages;
368334f485dSMiklos Szeredi 
369334f485dSMiklos Szeredi 	/** File used in the request (or NULL) */
370c756e0a4SMiklos Szeredi 	struct fuse_file *ff;
37164c6d8edSMiklos Szeredi 
3723be5a52bSMiklos Szeredi 	/** Inode used in the request or NULL */
3733be5a52bSMiklos Szeredi 	struct inode *inode;
3743be5a52bSMiklos Szeredi 
37501e9d11aSMaxim Patlasov 	/** AIO control block */
37601e9d11aSMaxim Patlasov 	struct fuse_io_priv *io;
37701e9d11aSMaxim Patlasov 
3783be5a52bSMiklos Szeredi 	/** Link on fi->writepages */
3793be5a52bSMiklos Szeredi 	struct list_head writepages_entry;
3803be5a52bSMiklos Szeredi 
38164c6d8edSMiklos Szeredi 	/** Request completion callback */
38264c6d8edSMiklos Szeredi 	void (*end)(struct fuse_conn *, struct fuse_req *);
38333649c91SMiklos Szeredi 
38433649c91SMiklos Szeredi 	/** Request is stolen from fuse_file->reserved_req */
38533649c91SMiklos Szeredi 	struct file *stolen_file;
386334f485dSMiklos Szeredi };
387334f485dSMiklos Szeredi 
388f88996a9SMiklos Szeredi struct fuse_iqueue {
389e16714d8SMiklos Szeredi 	/** Connection established */
390e16714d8SMiklos Szeredi 	unsigned connected;
391e16714d8SMiklos Szeredi 
392f88996a9SMiklos Szeredi 	/** Readers of the connection are waiting on this */
393f88996a9SMiklos Szeredi 	wait_queue_head_t waitq;
394f88996a9SMiklos Szeredi 
395f88996a9SMiklos Szeredi 	/** The next unique request id */
396f88996a9SMiklos Szeredi 	u64 reqctr;
397f88996a9SMiklos Szeredi 
398f88996a9SMiklos Szeredi 	/** The list of pending requests */
399f88996a9SMiklos Szeredi 	struct list_head pending;
400f88996a9SMiklos Szeredi 
401f88996a9SMiklos Szeredi 	/** Pending interrupts */
402f88996a9SMiklos Szeredi 	struct list_head interrupts;
403f88996a9SMiklos Szeredi 
404f88996a9SMiklos Szeredi 	/** Queue of pending forgets */
405f88996a9SMiklos Szeredi 	struct fuse_forget_link forget_list_head;
406f88996a9SMiklos Szeredi 	struct fuse_forget_link *forget_list_tail;
407f88996a9SMiklos Szeredi 
408f88996a9SMiklos Szeredi 	/** Batching of FORGET requests (positive indicates FORGET batch) */
409f88996a9SMiklos Szeredi 	int forget_batch;
410f88996a9SMiklos Szeredi 
411f88996a9SMiklos Szeredi 	/** O_ASYNC requests */
412f88996a9SMiklos Szeredi 	struct fasync_struct *fasync;
413f88996a9SMiklos Szeredi };
414f88996a9SMiklos Szeredi 
4153a2b5b9cSMiklos Szeredi struct fuse_pqueue {
416e96edd94SMiklos Szeredi 	/** Connection established */
417e96edd94SMiklos Szeredi 	unsigned connected;
418e96edd94SMiklos Szeredi 
41945a91cb1SMiklos Szeredi 	/** Lock protecting accessess to  members of this structure */
42045a91cb1SMiklos Szeredi 	spinlock_t lock;
42145a91cb1SMiklos Szeredi 
4223a2b5b9cSMiklos Szeredi 	/** The list of requests being processed */
4233a2b5b9cSMiklos Szeredi 	struct list_head processing;
4243a2b5b9cSMiklos Szeredi 
4253a2b5b9cSMiklos Szeredi 	/** The list of requests under I/O */
4263a2b5b9cSMiklos Szeredi 	struct list_head io;
4273a2b5b9cSMiklos Szeredi };
4283a2b5b9cSMiklos Szeredi 
429d8a5ba45SMiklos Szeredi /**
430cc080e9eSMiklos Szeredi  * Fuse device instance
431cc080e9eSMiklos Szeredi  */
432cc080e9eSMiklos Szeredi struct fuse_dev {
433cc080e9eSMiklos Szeredi 	/** Fuse connection for this device */
434cc080e9eSMiklos Szeredi 	struct fuse_conn *fc;
435cc080e9eSMiklos Szeredi 
436c3696046SMiklos Szeredi 	/** Processing queue */
437c3696046SMiklos Szeredi 	struct fuse_pqueue pq;
438c3696046SMiklos Szeredi 
439cc080e9eSMiklos Szeredi 	/** list entry on fc->devices */
440cc080e9eSMiklos Szeredi 	struct list_head entry;
441cc080e9eSMiklos Szeredi };
442cc080e9eSMiklos Szeredi 
443cc080e9eSMiklos Szeredi /**
444d8a5ba45SMiklos Szeredi  * A Fuse connection.
445d8a5ba45SMiklos Szeredi  *
446d8a5ba45SMiklos Szeredi  * This structure is created, when the filesystem is mounted, and is
447d8a5ba45SMiklos Szeredi  * destroyed, when the client device is closed and the filesystem is
448d8a5ba45SMiklos Szeredi  * unmounted.
449d8a5ba45SMiklos Szeredi  */
450d8a5ba45SMiklos Szeredi struct fuse_conn {
451d7133114SMiklos Szeredi 	/** Lock protecting accessess to  members of this structure */
452d7133114SMiklos Szeredi 	spinlock_t lock;
453d7133114SMiklos Szeredi 
454bafa9654SMiklos Szeredi 	/** Refcount */
455bafa9654SMiklos Szeredi 	atomic_t count;
456bafa9654SMiklos Szeredi 
457c3696046SMiklos Szeredi 	/** Number of fuse_dev's */
458c3696046SMiklos Szeredi 	atomic_t dev_count;
459c3696046SMiklos Szeredi 
460dd3e2c55SAl Viro 	struct rcu_head rcu;
461dd3e2c55SAl Viro 
462d8a5ba45SMiklos Szeredi 	/** The user id for this mount */
463499dcf20SEric W. Biederman 	kuid_t user_id;
464d8a5ba45SMiklos Szeredi 
46587729a55SMiklos Szeredi 	/** The group id for this mount */
466499dcf20SEric W. Biederman 	kgid_t group_id;
46787729a55SMiklos Szeredi 
4681e9a4ed9SMiklos Szeredi 	/** The fuse mount flags for this mount */
4691e9a4ed9SMiklos Szeredi 	unsigned flags;
4701e9a4ed9SMiklos Szeredi 
471db50b96cSMiklos Szeredi 	/** Maximum read size */
472db50b96cSMiklos Szeredi 	unsigned max_read;
473db50b96cSMiklos Szeredi 
474413ef8cbSMiklos Szeredi 	/** Maximum write size */
475413ef8cbSMiklos Szeredi 	unsigned max_write;
476413ef8cbSMiklos Szeredi 
477f88996a9SMiklos Szeredi 	/** Input queue */
478f88996a9SMiklos Szeredi 	struct fuse_iqueue iq;
479334f485dSMiklos Szeredi 
480acf99433STejun Heo 	/** The next unique kernel file handle */
481acf99433STejun Heo 	u64 khctr;
482acf99433STejun Heo 
48395668a69STejun Heo 	/** rbtree of fuse_files waiting for poll events indexed by ph */
48495668a69STejun Heo 	struct rb_root polled_files;
48595668a69STejun Heo 
4867a6d3c8bSCsaba Henk 	/** Maximum number of outstanding background requests */
4877a6d3c8bSCsaba Henk 	unsigned max_background;
4887a6d3c8bSCsaba Henk 
4897a6d3c8bSCsaba Henk 	/** Number of background requests at which congestion starts */
4907a6d3c8bSCsaba Henk 	unsigned congestion_threshold;
4917a6d3c8bSCsaba Henk 
49208a53cdcSMiklos Szeredi 	/** Number of requests currently in the background */
49308a53cdcSMiklos Szeredi 	unsigned num_background;
49408a53cdcSMiklos Szeredi 
495d12def1bSMiklos Szeredi 	/** Number of background requests currently queued for userspace */
496d12def1bSMiklos Szeredi 	unsigned active_background;
497d12def1bSMiklos Szeredi 
498d12def1bSMiklos Szeredi 	/** The list of background requests set aside for later queuing */
499d12def1bSMiklos Szeredi 	struct list_head bg_queue;
500d12def1bSMiklos Szeredi 
501796523fbSMaxim Patlasov 	/** Flag indicating that INIT reply has been received. Allocating
502796523fbSMaxim Patlasov 	 * any fuse request will be suspended until the flag is set */
503796523fbSMaxim Patlasov 	int initialized;
504796523fbSMaxim Patlasov 
50508a53cdcSMiklos Szeredi 	/** Flag indicating if connection is blocked.  This will be
50608a53cdcSMiklos Szeredi 	    the case before the INIT reply is received, and if there
50708a53cdcSMiklos Szeredi 	    are too many outstading backgrounds requests */
50808a53cdcSMiklos Szeredi 	int blocked;
50908a53cdcSMiklos Szeredi 
51008a53cdcSMiklos Szeredi 	/** waitq for blocked connection */
51108a53cdcSMiklos Szeredi 	wait_queue_head_t blocked_waitq;
51208a53cdcSMiklos Szeredi 
513de5e3decSMiklos Szeredi 	/** waitq for reserved requests */
514de5e3decSMiklos Szeredi 	wait_queue_head_t reserved_req_waitq;
515de5e3decSMiklos Szeredi 
51669a53bf2SMiklos Szeredi 	/** Connection established, cleared on umount, connection
51769a53bf2SMiklos Szeredi 	    abort and device release */
518095da6cbSMiklos Szeredi 	unsigned connected;
5191e9a4ed9SMiklos Szeredi 
520095da6cbSMiklos Szeredi 	/** Connection failed (version mismatch).  Cannot race with
521095da6cbSMiklos Szeredi 	    setting other bitfields since it is only set once in INIT
522095da6cbSMiklos Szeredi 	    reply, before any other request, and never cleared */
523334f485dSMiklos Szeredi 	unsigned conn_error:1;
524334f485dSMiklos Szeredi 
5250ec7ca41SMiklos Szeredi 	/** Connection successful.  Only set in INIT */
5260ec7ca41SMiklos Szeredi 	unsigned conn_init:1;
5270ec7ca41SMiklos Szeredi 
5289cd68455SMiklos Szeredi 	/** Do readpages asynchronously?  Only set in INIT */
5299cd68455SMiklos Szeredi 	unsigned async_read:1;
5309cd68455SMiklos Szeredi 
5316ff958edSMiklos Szeredi 	/** Do not send separate SETATTR request before open(O_TRUNC)  */
5326ff958edSMiklos Szeredi 	unsigned atomic_o_trunc:1;
5336ff958edSMiklos Szeredi 
53433670fa2SMiklos Szeredi 	/** Filesystem supports NFS exporting.  Only set in INIT */
53533670fa2SMiklos Szeredi 	unsigned export_support:1;
53633670fa2SMiklos Szeredi 
537a325f9b9STejun Heo 	/** Set if bdi is valid */
538a325f9b9STejun Heo 	unsigned bdi_initialized:1;
539a325f9b9STejun Heo 
540d5cd66c5SPavel Emelyanov 	/** write-back cache policy (default is write-through) */
541d5cd66c5SPavel Emelyanov 	unsigned writeback_cache:1;
542d5cd66c5SPavel Emelyanov 
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 
6200cd5b885SMiklos Szeredi 	/** The number of requests waiting for completion */
6210cd5b885SMiklos Szeredi 	atomic_t num_waiting;
6220cd5b885SMiklos Szeredi 
62345714d65SMiklos Szeredi 	/** Negotiated minor version */
62445714d65SMiklos Szeredi 	unsigned minor;
62545714d65SMiklos Szeredi 
626d8a5ba45SMiklos Szeredi 	/** Backing dev info */
627d8a5ba45SMiklos Szeredi 	struct backing_dev_info bdi;
628f543f253SMiklos Szeredi 
629bafa9654SMiklos Szeredi 	/** Entry on the fuse_conn_list */
630bafa9654SMiklos Szeredi 	struct list_head entry;
631bafa9654SMiklos Szeredi 
632b6f2fcbcSMiklos Szeredi 	/** Device ID from super block */
633b6f2fcbcSMiklos Szeredi 	dev_t dev;
634bafa9654SMiklos Szeredi 
635bafa9654SMiklos Szeredi 	/** Dentries in the control filesystem */
636bafa9654SMiklos Szeredi 	struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
637bafa9654SMiklos Szeredi 
638bafa9654SMiklos Szeredi 	/** number of dentries used in the above array */
639bafa9654SMiklos Szeredi 	int ctl_ndents;
640385a17bfSJeff Dike 
6419c8ef561SMiklos Szeredi 	/** Key for lock owner ID scrambling */
6429c8ef561SMiklos Szeredi 	u32 scramble_key[4];
6430ec7ca41SMiklos Szeredi 
6440ec7ca41SMiklos Szeredi 	/** Reserved request for the DESTROY message */
6450ec7ca41SMiklos Szeredi 	struct fuse_req *destroy_req;
6461fb69e78SMiklos Szeredi 
6471fb69e78SMiklos Szeredi 	/** Version counter for attribute changes */
6481fb69e78SMiklos Szeredi 	u64 attr_version;
64943901aabSTejun Heo 
65043901aabSTejun Heo 	/** Called on final put */
65143901aabSTejun Heo 	void (*release)(struct fuse_conn *);
6523b463ae0SJohn Muir 
6533b463ae0SJohn Muir 	/** Super block for this connection. */
6543b463ae0SJohn Muir 	struct super_block *sb;
6553b463ae0SJohn Muir 
6563b463ae0SJohn Muir 	/** Read/write semaphore to hold when accessing sb. */
6573b463ae0SJohn Muir 	struct rw_semaphore killsb;
658cc080e9eSMiklos Szeredi 
659cc080e9eSMiklos Szeredi 	/** List of device instances belonging to this connection */
660cc080e9eSMiklos Szeredi 	struct list_head devices;
661d8a5ba45SMiklos Szeredi };
662d8a5ba45SMiklos Szeredi 
663d8a5ba45SMiklos Szeredi static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
664d8a5ba45SMiklos Szeredi {
6656383bdaaSMiklos Szeredi 	return sb->s_fs_info;
666d8a5ba45SMiklos Szeredi }
667d8a5ba45SMiklos Szeredi 
668d8a5ba45SMiklos Szeredi static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
669d8a5ba45SMiklos Szeredi {
670d8a5ba45SMiklos Szeredi 	return get_fuse_conn_super(inode->i_sb);
671d8a5ba45SMiklos Szeredi }
672d8a5ba45SMiklos Szeredi 
673d8a5ba45SMiklos Szeredi static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
674d8a5ba45SMiklos Szeredi {
675d8a5ba45SMiklos Szeredi 	return container_of(inode, struct fuse_inode, inode);
676d8a5ba45SMiklos Szeredi }
677d8a5ba45SMiklos Szeredi 
678d8a5ba45SMiklos Szeredi static inline u64 get_node_id(struct inode *inode)
679d8a5ba45SMiklos Szeredi {
680d8a5ba45SMiklos Szeredi 	return get_fuse_inode(inode)->nodeid;
681d8a5ba45SMiklos Szeredi }
682d8a5ba45SMiklos Szeredi 
683334f485dSMiklos Szeredi /** Device operations */
6844b6f5d20SArjan van de Ven extern const struct file_operations fuse_dev_operations;
685334f485dSMiklos Szeredi 
6864269590aSAl Viro extern const struct dentry_operations fuse_dentry_operations;
687dbd561d2SMiklos Szeredi 
688d8a5ba45SMiklos Szeredi /**
6893b463ae0SJohn Muir  * Inode to nodeid comparison.
6903b463ae0SJohn Muir  */
6913b463ae0SJohn Muir int fuse_inode_eq(struct inode *inode, void *_nodeidp);
6923b463ae0SJohn Muir 
6933b463ae0SJohn Muir /**
694e5e5558eSMiklos Szeredi  * Get a filled in inode
695e5e5558eSMiklos Szeredi  */
696b48badf0SMiklos Szeredi struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
6971fb69e78SMiklos Szeredi 			int generation, struct fuse_attr *attr,
6981fb69e78SMiklos Szeredi 			u64 attr_valid, u64 attr_version);
699e5e5558eSMiklos Szeredi 
70033670fa2SMiklos Szeredi int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name,
70133670fa2SMiklos Szeredi 		     struct fuse_entry_out *outarg, struct inode **inode);
70233670fa2SMiklos Szeredi 
703e5e5558eSMiklos Szeredi /**
704e5e5558eSMiklos Szeredi  * Send FORGET command
705e5e5558eSMiklos Szeredi  */
70607e77dcaSMiklos Szeredi void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
707b48badf0SMiklos Szeredi 		       u64 nodeid, u64 nlookup);
708e5e5558eSMiklos Szeredi 
70907e77dcaSMiklos Szeredi struct fuse_forget_link *fuse_alloc_forget(void);
71007e77dcaSMiklos Szeredi 
7110b05b183SAnand V. Avati /* Used by READDIRPLUS */
7120b05b183SAnand V. Avati void fuse_force_forget(struct file *file, u64 nodeid);
7130b05b183SAnand V. Avati 
714e5e5558eSMiklos Szeredi /**
715361b1eb5SMiklos Szeredi  * Initialize READ or READDIR request
71604730fefSMiklos Szeredi  */
717a6643094SMiklos Szeredi void fuse_read_fill(struct fuse_req *req, struct file *file,
7182106cb18SMiklos Szeredi 		    loff_t pos, size_t count, int opcode);
71904730fefSMiklos Szeredi 
72004730fefSMiklos Szeredi /**
72104730fefSMiklos Szeredi  * Send OPEN or OPENDIR request
72204730fefSMiklos Szeredi  */
72391fe96b4SMiklos Szeredi int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
72404730fefSMiklos Szeredi 
725acf99433STejun Heo struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
726c7b7143cSMiklos Szeredi struct fuse_file *fuse_file_get(struct fuse_file *ff);
727fd72faacSMiklos Szeredi void fuse_file_free(struct fuse_file *ff);
728c7b7143cSMiklos Szeredi void fuse_finish_open(struct inode *inode, struct file *file);
729fd72faacSMiklos Szeredi 
7308b0797a4SMiklos Szeredi void fuse_sync_release(struct fuse_file *ff, int flags);
731c756e0a4SMiklos Szeredi 
73204730fefSMiklos Szeredi /**
73304730fefSMiklos Szeredi  * Send RELEASE or RELEASEDIR request
73404730fefSMiklos Szeredi  */
7358b0797a4SMiklos Szeredi void fuse_release_common(struct file *file, int opcode);
73604730fefSMiklos Szeredi 
73704730fefSMiklos Szeredi /**
73882547981SMiklos Szeredi  * Send FSYNC or FSYNCDIR request
73982547981SMiklos Szeredi  */
74002c24a82SJosef Bacik int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
74102c24a82SJosef Bacik 		      int datasync, int isdir);
74282547981SMiklos Szeredi 
74382547981SMiklos Szeredi /**
74495668a69STejun Heo  * Notify poll wakeup
74595668a69STejun Heo  */
74695668a69STejun Heo int fuse_notify_poll_wakeup(struct fuse_conn *fc,
74795668a69STejun Heo 			    struct fuse_notify_poll_wakeup_out *outarg);
74895668a69STejun Heo 
74995668a69STejun Heo /**
7501779381dSMiklos Szeredi  * Initialize file operations on a regular file
751b6aeadedSMiklos Szeredi  */
752b6aeadedSMiklos Szeredi void fuse_init_file_inode(struct inode *inode);
753b6aeadedSMiklos Szeredi 
754b6aeadedSMiklos Szeredi /**
7551779381dSMiklos Szeredi  * Initialize inode operations on regular files and special files
756e5e5558eSMiklos Szeredi  */
757e5e5558eSMiklos Szeredi void fuse_init_common(struct inode *inode);
758e5e5558eSMiklos Szeredi 
759e5e5558eSMiklos Szeredi /**
7601779381dSMiklos Szeredi  * Initialize inode and file operations on a directory
761e5e5558eSMiklos Szeredi  */
762e5e5558eSMiklos Szeredi void fuse_init_dir(struct inode *inode);
763e5e5558eSMiklos Szeredi 
764e5e5558eSMiklos Szeredi /**
7651779381dSMiklos Szeredi  * Initialize inode operations on a symlink
766e5e5558eSMiklos Szeredi  */
767e5e5558eSMiklos Szeredi void fuse_init_symlink(struct inode *inode);
768e5e5558eSMiklos Szeredi 
769e5e5558eSMiklos Szeredi /**
770e5e5558eSMiklos Szeredi  * Change attributes of an inode
771e5e5558eSMiklos Szeredi  */
7721fb69e78SMiklos Szeredi void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
7731fb69e78SMiklos Szeredi 			    u64 attr_valid, u64 attr_version);
774e5e5558eSMiklos Szeredi 
7753be5a52bSMiklos Szeredi void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
7763be5a52bSMiklos Szeredi 				   u64 attr_valid);
7773be5a52bSMiklos Szeredi 
778e5e5558eSMiklos Szeredi /**
779334f485dSMiklos Szeredi  * Initialize the client device
780334f485dSMiklos Szeredi  */
781334f485dSMiklos Szeredi int fuse_dev_init(void);
782334f485dSMiklos Szeredi 
783334f485dSMiklos Szeredi /**
784334f485dSMiklos Szeredi  * Cleanup the client device
785334f485dSMiklos Szeredi  */
786334f485dSMiklos Szeredi void fuse_dev_cleanup(void);
787334f485dSMiklos Szeredi 
788bafa9654SMiklos Szeredi int fuse_ctl_init(void);
7897736e8ccSFabian Frederick void __exit fuse_ctl_cleanup(void);
790bafa9654SMiklos Szeredi 
791334f485dSMiklos Szeredi /**
792334f485dSMiklos Szeredi  * Allocate a request
793334f485dSMiklos Szeredi  */
7944250c066SMaxim Patlasov struct fuse_req *fuse_request_alloc(unsigned npages);
795334f485dSMiklos Szeredi 
7964250c066SMaxim Patlasov struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
7973be5a52bSMiklos Szeredi 
798334f485dSMiklos Szeredi /**
799334f485dSMiklos Szeredi  * Free a request
800334f485dSMiklos Szeredi  */
801334f485dSMiklos Szeredi void fuse_request_free(struct fuse_req *req);
802334f485dSMiklos Szeredi 
803334f485dSMiklos Szeredi /**
804b111c8c0SMaxim Patlasov  * Get a request, may fail with -ENOMEM,
805b111c8c0SMaxim Patlasov  * caller should specify # elements in req->pages[] explicitly
806334f485dSMiklos Szeredi  */
807b111c8c0SMaxim Patlasov struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
8088b41e671SMaxim Patlasov struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
8098b41e671SMaxim Patlasov 					     unsigned npages);
810b111c8c0SMaxim Patlasov 
81136cf66edSMaxim Patlasov /*
81236cf66edSMaxim Patlasov  * Increment reference count on request
81336cf66edSMaxim Patlasov  */
81436cf66edSMaxim Patlasov void __fuse_get_request(struct fuse_req *req);
81536cf66edSMaxim Patlasov 
816b111c8c0SMaxim Patlasov /**
81733649c91SMiklos Szeredi  * Gets a requests for a file operation, always succeeds
81833649c91SMiklos Szeredi  */
819b111c8c0SMaxim Patlasov struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
820b111c8c0SMaxim Patlasov 					     struct file *file);
82133649c91SMiklos Szeredi 
82233649c91SMiklos Szeredi /**
823ce1d5a49SMiklos Szeredi  * Decrement reference count of a request.  If count goes to zero free
824ce1d5a49SMiklos Szeredi  * the request.
825334f485dSMiklos Szeredi  */
826334f485dSMiklos Szeredi void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
827334f485dSMiklos Szeredi 
828334f485dSMiklos Szeredi /**
8297c352bdfSMiklos Szeredi  * Send a request (synchronous)
830334f485dSMiklos Szeredi  */
831b93f858aSTejun Heo void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
832334f485dSMiklos Szeredi 
833334f485dSMiklos Szeredi /**
8347078187aSMiklos Szeredi  * Simple request sending that does request allocation and freeing
8357078187aSMiklos Szeredi  */
8367078187aSMiklos Szeredi ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);
8377078187aSMiklos Szeredi 
8387078187aSMiklos Szeredi /**
839334f485dSMiklos Szeredi  * Send a request in the background
840334f485dSMiklos Szeredi  */
841b93f858aSTejun Heo void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
842334f485dSMiklos Szeredi 
843b93f858aSTejun Heo void fuse_request_send_background_locked(struct fuse_conn *fc,
844b93f858aSTejun Heo 					 struct fuse_req *req);
8453be5a52bSMiklos Szeredi 
8465a5fb1eaSMiklos Szeredi /* Abort all requests */
84769a53bf2SMiklos Szeredi void fuse_abort_conn(struct fuse_conn *fc);
84869a53bf2SMiklos Szeredi 
8491e9a4ed9SMiklos Szeredi /**
850e5e5558eSMiklos Szeredi  * Invalidate inode attributes
851e5e5558eSMiklos Szeredi  */
852e5e5558eSMiklos Szeredi void fuse_invalidate_attr(struct inode *inode);
853bafa9654SMiklos Szeredi 
854dbd561d2SMiklos Szeredi void fuse_invalidate_entry_cache(struct dentry *entry);
855dbd561d2SMiklos Szeredi 
856451418fcSAndrew Gallagher void fuse_invalidate_atime(struct inode *inode);
857451418fcSAndrew Gallagher 
858bafa9654SMiklos Szeredi /**
859bafa9654SMiklos Szeredi  * Acquire reference to fuse_conn
860bafa9654SMiklos Szeredi  */
861bafa9654SMiklos Szeredi struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
862bafa9654SMiklos Szeredi 
863bafa9654SMiklos Szeredi /**
8640d179aa5STejun Heo  * Initialize fuse_conn
8650d179aa5STejun Heo  */
866a325f9b9STejun Heo void fuse_conn_init(struct fuse_conn *fc);
8670d179aa5STejun Heo 
8680d179aa5STejun Heo /**
869bafa9654SMiklos Szeredi  * Release reference to fuse_conn
870bafa9654SMiklos Szeredi  */
871bafa9654SMiklos Szeredi void fuse_conn_put(struct fuse_conn *fc);
872bafa9654SMiklos Szeredi 
873cc080e9eSMiklos Szeredi struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
874cc080e9eSMiklos Szeredi void fuse_dev_free(struct fuse_dev *fud);
875cc080e9eSMiklos Szeredi 
876bafa9654SMiklos Szeredi /**
877bafa9654SMiklos Szeredi  * Add connection to control filesystem
878bafa9654SMiklos Szeredi  */
879bafa9654SMiklos Szeredi int fuse_ctl_add_conn(struct fuse_conn *fc);
880bafa9654SMiklos Szeredi 
881bafa9654SMiklos Szeredi /**
882bafa9654SMiklos Szeredi  * Remove connection from control filesystem
883bafa9654SMiklos Szeredi  */
884bafa9654SMiklos Szeredi void fuse_ctl_remove_conn(struct fuse_conn *fc);
885a5bfffacSTimo Savola 
886a5bfffacSTimo Savola /**
887a5bfffacSTimo Savola  * Is file type valid?
888a5bfffacSTimo Savola  */
889a5bfffacSTimo Savola int fuse_valid_type(int m);
890e57ac683SMiklos Szeredi 
891e57ac683SMiklos Szeredi /**
892c2132c1bSAnatol Pomozov  * Is current process allowed to perform filesystem operation?
893e57ac683SMiklos Szeredi  */
894c2132c1bSAnatol Pomozov int fuse_allow_current_process(struct fuse_conn *fc);
895f3332114SMiklos Szeredi 
896f3332114SMiklos Szeredi u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
897bcb4be80SMiklos Szeredi 
898bcb4be80SMiklos Szeredi int fuse_update_attributes(struct inode *inode, struct kstat *stat,
899bcb4be80SMiklos Szeredi 			   struct file *file, bool *refreshed);
9003be5a52bSMiklos Szeredi 
9013be5a52bSMiklos Szeredi void fuse_flush_writepages(struct inode *inode);
9023be5a52bSMiklos Szeredi 
9033be5a52bSMiklos Szeredi void fuse_set_nowrite(struct inode *inode);
9043be5a52bSMiklos Szeredi void fuse_release_nowrite(struct inode *inode);
9055c5c5e51SMiklos Szeredi 
9065c5c5e51SMiklos Szeredi u64 fuse_get_attr_version(struct fuse_conn *fc);
90729d434b3STejun Heo 
9083b463ae0SJohn Muir /**
9093b463ae0SJohn Muir  * File-system tells the kernel to invalidate cache for the given node id.
9103b463ae0SJohn Muir  */
9113b463ae0SJohn Muir int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
9123b463ae0SJohn Muir 			     loff_t offset, loff_t len);
9133b463ae0SJohn Muir 
9143b463ae0SJohn Muir /**
9153b463ae0SJohn Muir  * File-system tells the kernel to invalidate parent attributes and
9163b463ae0SJohn Muir  * the dentry matching parent/name.
917451d0f59SJohn Muir  *
918451d0f59SJohn Muir  * If the child_nodeid is non-zero and:
919451d0f59SJohn Muir  *    - matches the inode number for the dentry matching parent/name,
920451d0f59SJohn Muir  *    - is not a mount point
921451d0f59SJohn Muir  *    - is a file or oan empty directory
922451d0f59SJohn Muir  * then the dentry is unhashed (d_delete()).
9233b463ae0SJohn Muir  */
9243b463ae0SJohn Muir int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
925451d0f59SJohn Muir 			     u64 child_nodeid, struct qstr *name);
9263b463ae0SJohn Muir 
92708cbf542STejun Heo int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
92808cbf542STejun Heo 		 bool isdir);
929ea8cd333SPavel Emelyanov 
930ea8cd333SPavel Emelyanov /**
931ea8cd333SPavel Emelyanov  * fuse_direct_io() flags
932ea8cd333SPavel Emelyanov  */
933ea8cd333SPavel Emelyanov 
934ea8cd333SPavel Emelyanov /** If set, it is WRITE; otherwise - READ */
935ea8cd333SPavel Emelyanov #define FUSE_DIO_WRITE (1 << 0)
936ea8cd333SPavel Emelyanov 
937ea8cd333SPavel Emelyanov /** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
938ea8cd333SPavel Emelyanov #define FUSE_DIO_CUSE  (1 << 1)
939ea8cd333SPavel Emelyanov 
940d22a943fSAl Viro ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
941d22a943fSAl Viro 		       loff_t *ppos, int flags);
94208cbf542STejun Heo long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
94308cbf542STejun Heo 		   unsigned int flags);
944b18da0c5SMiklos Szeredi long fuse_ioctl_common(struct file *file, unsigned int cmd,
945b18da0c5SMiklos Szeredi 		       unsigned long arg, unsigned int flags);
94608cbf542STejun Heo unsigned fuse_file_poll(struct file *file, poll_table *wait);
94708cbf542STejun Heo int fuse_dev_release(struct inode *inode, struct file *file);
94808cbf542STejun Heo 
949b0aa7606SMaxim Patlasov bool fuse_write_update_size(struct inode *inode, loff_t pos);
950b0aa7606SMaxim Patlasov 
951ab9e13f7SMaxim Patlasov int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
9521e18bda8SMiklos Szeredi int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
953a1d75f25SMiklos Szeredi 
954efb9fa9eSMaxim Patlasov int fuse_do_setattr(struct inode *inode, struct iattr *attr,
955efb9fa9eSMaxim Patlasov 		    struct file *file);
956efb9fa9eSMaxim Patlasov 
9579759bd51SMiklos Szeredi void fuse_set_initialized(struct fuse_conn *fc);
9589759bd51SMiklos Szeredi 
95929d434b3STejun Heo #endif /* _FS_FUSE_I_H */
960