blob: d6d55641a5a685c27d291b701682ef277df05fbb [file] [log] [blame]
Miklos Szeredid8a5ba42005-09-09 13:10:26 -07001/*
2 FUSE: Filesystem in Userspace
Miklos Szeredi1729a162008-11-26 12:03:54 +01003 Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -07004
5 This program can be distributed under the terms of the GNU GPL.
6 See the file COPYING.
7*/
8
Tejun Heo29d434b2008-10-16 16:08:57 +02009#ifndef _FS_FUSE_I_H
10#define _FS_FUSE_I_H
11
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070012#include <linux/fuse.h>
13#include <linux/fs.h>
Miklos Szeredi51eb01e2006-06-25 05:48:50 -070014#include <linux/mount.h>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070015#include <linux/wait.h>
16#include <linux/list.h>
17#include <linux/spinlock.h>
18#include <linux/mm.h>
19#include <linux/backing-dev.h>
Miklos Szeredibafa9652006-06-25 05:48:51 -070020#include <linux/mutex.h>
Miklos Szeredi3be5a522008-04-30 00:54:41 -070021#include <linux/rwsem.h>
Tejun Heo95668a62008-11-26 12:03:55 +010022#include <linux/rbtree.h>
23#include <linux/poll.h>
Miklos Szeredi5a18ec12011-02-25 14:44:58 +010024#include <linux/workqueue.h>
Seth Forshee744742d2016-03-11 10:35:34 -060025#include <linux/kref.h>
Seth Forshee60bcc882016-08-29 08:46:37 -050026#include <linux/xattr.h>
Seth Forshee0b6e9ea2014-07-02 16:29:19 -050027#include <linux/pid_namespace.h>
Elena Reshetova4e8c2eb2017-03-03 11:04:03 +020028#include <linux/refcount.h>
Eric W. Biederman8cb08322018-02-21 11:18:07 -060029#include <linux/user_namespace.h>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070030
Miklos Szeredi334f4852005-09-09 13:10:27 -070031/** Max number of pages that can be used in a single read request */
32#define FUSE_MAX_PAGES_PER_REQ 32
33
Miklos Szeredi3be5a522008-04-30 00:54:41 -070034/** Bias for fi->writectr, meaning new writepages must not be sent */
35#define FUSE_NOWRITE INT_MIN
36
Miklos Szeredi1d3d7522006-01-06 00:19:40 -080037/** It could be as large as PATH_MAX, but would that have any uses? */
38#define FUSE_NAME_MAX 1024
39
Miklos Szeredibafa9652006-06-25 05:48:51 -070040/** Number of dentries for each connection in the control filesystem */
Csaba Henk79a9d992009-08-26 19:18:24 +020041#define FUSE_CTL_NUM_DENTRIES 5
Miklos Szeredibafa9652006-06-25 05:48:51 -070042
Maxim Patlasov4250c062012-10-26 19:48:07 +040043/** Number of page pointers embedded in fuse_req */
44#define FUSE_REQ_INLINE_PAGES 1
45
Miklos Szeredibafa9652006-06-25 05:48:51 -070046/** List of active connections */
47extern struct list_head fuse_conn_list;
48
49/** Global mutex protecting fuse_conn_list and the control filesystem */
50extern struct mutex fuse_mutex;
Miklos Szeredi413ef8c2005-09-09 13:10:35 -070051
Csaba Henk79a9d992009-08-26 19:18:24 +020052/** Module parameters */
53extern unsigned max_user_bgreq;
54extern unsigned max_user_congthresh;
55
Miklos Szeredi07e77dc2010-12-07 20:16:56 +010056/* One forget request */
57struct fuse_forget_link {
Miklos Szeredi02c048b2010-12-07 20:16:56 +010058 struct fuse_forget_one forget_one;
Miklos Szeredi07e77dc2010-12-07 20:16:56 +010059 struct fuse_forget_link *next;
60};
61
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070062/** FUSE inode */
63struct fuse_inode {
64 /** Inode data */
65 struct inode inode;
66
67 /** Unique ID, which identifies the inode between userspace
68 * and kernel */
69 u64 nodeid;
70
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070071 /** Number of lookups on this inode */
72 u64 nlookup;
73
Miklos Szeredie5e55582005-09-09 13:10:28 -070074 /** The request used for sending the FORGET message */
Miklos Szeredi07e77dc2010-12-07 20:16:56 +010075 struct fuse_forget_link *forget;
Miklos Szeredie5e55582005-09-09 13:10:28 -070076
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070077 /** Time in jiffies until the file attributes are valid */
Miklos Szeredi0a0898c2006-07-30 03:04:10 -070078 u64 i_time;
Miklos Szerediebc14c42007-10-16 23:31:03 -070079
80 /** The sticky bit in inode->i_mode may have been removed, so
81 preserve the original mode */
Al Viro541af6a2011-07-26 03:17:33 -040082 umode_t orig_i_mode;
Miklos Szeredi1fb69e72007-10-18 03:06:58 -070083
Pavel Shilovsky45c72cd2012-05-10 19:49:38 +040084 /** 64 bit inode number */
85 u64 orig_ino;
86
Miklos Szeredi1fb69e72007-10-18 03:06:58 -070087 /** Version of last attribute change */
88 u64 attr_version;
Miklos Szeredi93a8c3c2007-10-18 03:07:03 -070089
90 /** Files usable in writepage. Protected by fc->lock */
91 struct list_head write_files;
Miklos Szeredi3be5a522008-04-30 00:54:41 -070092
93 /** Writepages pending on truncate or fsync */
94 struct list_head queued_writes;
95
96 /** Number of sent writes, a negative bias (FUSE_NOWRITE)
97 * means more writes are blocked */
98 int writectr;
99
100 /** Waitq for writepage completion */
101 wait_queue_head_t page_waitq;
102
103 /** List of writepage requestst (pending or sent) */
104 struct list_head writepages;
Feng Shuo4582a4a2013-01-15 11:23:28 +0800105
106 /** Miscellaneous bits describing inode state */
107 unsigned long state;
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200108
109 /** Lock for serializing lookup and readdir for back compatibility*/
110 struct mutex mutex;
Feng Shuo4582a4a2013-01-15 11:23:28 +0800111};
112
113/** FUSE inode state bits */
114enum {
115 /** Advise readdirplus */
116 FUSE_I_ADVISE_RDPLUS,
Miklos Szeredi6314efe2013-10-01 16:41:22 +0200117 /** Initialized with readdirplus */
118 FUSE_I_INIT_RDPLUS,
Maxim Patlasov06a7c3c2013-08-30 17:06:04 +0400119 /** An operation changing file size is in progress */
120 FUSE_I_SIZE_UNSTABLE,
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700121};
122
Miklos Szeredida5e4712009-04-28 16:56:36 +0200123struct fuse_conn;
124
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700125/** FUSE specific file data */
126struct fuse_file {
Miklos Szeredida5e4712009-04-28 16:56:36 +0200127 /** Fuse connection for this file */
128 struct fuse_conn *fc;
129
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700130 /** Request reserved for flush and release */
Miklos Szeredi33649c92006-06-25 05:48:52 -0700131 struct fuse_req *reserved_req;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700132
Tejun Heoacf99432008-11-26 12:03:55 +0100133 /** Kernel file handle guaranteed to be unique */
134 u64 kh;
135
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700136 /** File handle used by userspace */
137 u64 fh;
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700138
Miklos Szeredida5e4712009-04-28 16:56:36 +0200139 /** Node id of this file */
140 u64 nodeid;
141
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700142 /** Refcount */
Elena Reshetova4e8c2eb2017-03-03 11:04:03 +0200143 refcount_t count;
Miklos Szeredi93a8c3c2007-10-18 03:07:03 -0700144
Miklos Szeredic7b71432009-04-28 16:56:37 +0200145 /** FOPEN_* flags returned by open */
146 u32 open_flags;
147
Miklos Szeredi93a8c3c2007-10-18 03:07:03 -0700148 /** Entry on inode's write_files list */
149 struct list_head write_entry;
Tejun Heo95668a62008-11-26 12:03:55 +0100150
151 /** RB node to be linked on fuse_conn->polled_files */
152 struct rb_node polled_node;
153
154 /** Wait queue head for poll */
155 wait_queue_head_t poll_wait;
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200156
157 /** Has flock been performed on this file? */
158 bool flock:1;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700159};
160
Miklos Szeredi334f4852005-09-09 13:10:27 -0700161/** One input argument of a request */
162struct fuse_in_arg {
163 unsigned size;
164 const void *value;
165};
166
167/** The request input */
168struct fuse_in {
169 /** The request header */
170 struct fuse_in_header h;
171
172 /** True if the data for the last argument is in req->pages */
173 unsigned argpages:1;
174
175 /** Number of arguments */
176 unsigned numargs;
177
178 /** Array of arguments */
179 struct fuse_in_arg args[3];
180};
181
182/** One output argument of a request */
183struct fuse_arg {
184 unsigned size;
185 void *value;
186};
187
188/** The request output */
189struct fuse_out {
190 /** Header returned from userspace */
191 struct fuse_out_header h;
192
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800193 /*
194 * The following bitfields are not changed during the request
195 * processing
196 */
197
Miklos Szeredi334f4852005-09-09 13:10:27 -0700198 /** Last argument is variable length (can be shorter than
199 arg->size) */
200 unsigned argvar:1;
201
202 /** Last argument is a list of pages to copy data to */
203 unsigned argpages:1;
204
205 /** Zero partially or not copied pages */
206 unsigned page_zeroing:1;
207
Miklos Szeredice534fb2010-05-25 15:06:07 +0200208 /** Pages may be replaced with new ones */
209 unsigned page_replace:1;
210
Miklos Szeredi334f4852005-09-09 13:10:27 -0700211 /** Number or arguments */
212 unsigned numargs;
213
214 /** Array of arguments */
Miklos Szeredif704dcb2014-12-12 09:49:05 +0100215 struct fuse_arg args[2];
Miklos Szeredi334f4852005-09-09 13:10:27 -0700216};
217
Maxim Patlasovb2430d72012-10-26 19:49:24 +0400218/** FUSE page descriptor */
219struct fuse_page_desc {
220 unsigned int length;
221 unsigned int offset;
222};
223
Miklos Szeredi70781872014-12-12 09:49:05 +0100224struct fuse_args {
225 struct {
226 struct {
227 uint32_t opcode;
228 uint64_t nodeid;
229 } h;
230 unsigned numargs;
231 struct fuse_in_arg args[3];
232
233 } in;
234 struct {
235 unsigned argvar:1;
236 unsigned numargs;
237 struct fuse_arg args[2];
238 } out;
239};
240
241#define FUSE_ARGS(args) struct fuse_args args = {}
242
Maxim Patlasov01e9d112012-12-14 19:20:41 +0400243/** The request IO state (for asynchronous processing) */
244struct fuse_io_priv {
Seth Forshee744742d2016-03-11 10:35:34 -0600245 struct kref refcnt;
Maxim Patlasov01e9d112012-12-14 19:20:41 +0400246 int async;
247 spinlock_t lock;
248 unsigned reqs;
249 ssize_t bytes;
250 size_t size;
251 __u64 offset;
252 bool write;
Ashish Samant61c12b42017-07-12 19:26:58 -0700253 bool should_dirty;
Maxim Patlasov01e9d112012-12-14 19:20:41 +0400254 int err;
255 struct kiocb *iocb;
Christoph Hellwig9d5722b2015-02-02 14:59:43 +0100256 struct completion *done;
Ashish Sangwan7879c4e2016-04-07 17:18:11 +0530257 bool blocking;
Maxim Patlasov01e9d112012-12-14 19:20:41 +0400258};
259
Miklos Szeredie1c0eec2017-09-12 16:57:53 +0200260#define FUSE_IO_PRIV_SYNC(i) \
Seth Forshee744742d2016-03-11 10:35:34 -0600261{ \
Peter Zijlstra1e24edc2016-11-14 17:12:23 +0100262 .refcnt = KREF_INIT(1), \
Seth Forshee744742d2016-03-11 10:35:34 -0600263 .async = 0, \
Miklos Szeredie1c0eec2017-09-12 16:57:53 +0200264 .iocb = i, \
Seth Forshee744742d2016-03-11 10:35:34 -0600265}
266
Miklos Szeredi334f4852005-09-09 13:10:27 -0700267/**
Miklos Szeredi825d6d32015-07-01 16:25:58 +0200268 * Request flags
269 *
270 * FR_ISREPLY: set if the request has reply
271 * FR_FORCE: force sending of the request even if interrupted
272 * FR_BACKGROUND: request is sent in the background
273 * FR_WAITING: request is counted as "waiting"
274 * FR_ABORTED: the request was aborted
275 * FR_INTERRUPTED: the request has been interrupted
276 * FR_LOCKED: data is being copied to/from the request
Miklos Szeredi33e14b42015-07-01 16:26:01 +0200277 * FR_PENDING: request is not yet in userspace
278 * FR_SENT: request is in userspace, waiting for an answer
279 * FR_FINISHED: request is finished
Miklos Szeredi77cd9d42015-07-01 16:26:06 +0200280 * FR_PRIVATE: request is on private list
Miklos Szeredi825d6d32015-07-01 16:25:58 +0200281 */
282enum fuse_req_flag {
283 FR_ISREPLY,
284 FR_FORCE,
285 FR_BACKGROUND,
286 FR_WAITING,
287 FR_ABORTED,
288 FR_INTERRUPTED,
289 FR_LOCKED,
Miklos Szeredi33e14b42015-07-01 16:26:01 +0200290 FR_PENDING,
291 FR_SENT,
292 FR_FINISHED,
Miklos Szeredi77cd9d42015-07-01 16:26:06 +0200293 FR_PRIVATE,
Miklos Szeredi825d6d32015-07-01 16:25:58 +0200294};
295
296/**
Miklos Szeredi334f4852005-09-09 13:10:27 -0700297 * A request to the client
Miklos Szeredidc008092015-07-01 16:25:58 +0200298 *
299 * .waitq.lock protects the following fields:
300 * - FR_ABORTED
301 * - FR_LOCKED (may also be modified under fc->lock, tested under both)
Miklos Szeredi334f4852005-09-09 13:10:27 -0700302 */
303struct fuse_req {
Miklos Szeredice1d5a42006-04-10 22:54:58 -0700304 /** This can be on either pending processing or io lists in
305 fuse_conn */
Miklos Szeredi334f4852005-09-09 13:10:27 -0700306 struct list_head list;
307
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700308 /** Entry on the interrupts list */
309 struct list_head intr_entry;
310
Miklos Szeredi334f4852005-09-09 13:10:27 -0700311 /** refcount */
Elena Reshetovaec99f6d2017-03-03 11:04:04 +0200312 refcount_t count;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700313
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700314 /** Unique ID for the interrupt request */
315 u64 intr_unique;
316
Miklos Szeredi825d6d32015-07-01 16:25:58 +0200317 /* Request flags, updated with test/set/clear_bit() */
318 unsigned long flags;
Miklos Szeredi9bc5ddd2006-04-11 21:16:09 +0200319
Miklos Szeredi334f4852005-09-09 13:10:27 -0700320 /** The request input */
321 struct fuse_in in;
322
323 /** The request output */
324 struct fuse_out out;
325
326 /** Used to wake up the task waiting for completion of request*/
327 wait_queue_head_t waitq;
328
329 /** Data for asynchronous requests */
330 union {
Miklos Szeredib57d4262008-02-06 01:38:39 -0800331 struct {
Miklos Szeredibaebccb2014-12-12 09:49:04 +0100332 struct fuse_release_in in;
333 struct inode *inode;
Miklos Szeredib57d4262008-02-06 01:38:39 -0800334 } release;
Miklos Szeredi3ec870d2006-01-06 00:19:41 -0800335 struct fuse_init_in init_in;
336 struct fuse_init_out init_out;
Tejun Heo08cbf542009-04-14 10:54:53 +0900337 struct cuse_init_in cuse_init_in;
Miklos Szeredi5c5c5e52008-04-30 00:54:43 -0700338 struct {
339 struct fuse_read_in in;
340 u64 attr_ver;
341 } read;
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700342 struct {
343 struct fuse_write_in in;
344 struct fuse_write_out out;
Miklos Szeredi8b284dc2013-10-01 16:44:53 +0200345 struct fuse_req *next;
Miklos Szeredib25e82e2007-10-18 03:07:03 -0700346 } write;
Miklos Szeredi2d45ba32010-07-12 14:41:40 +0200347 struct fuse_notify_retrieve_in retrieve_in;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700348 } misc;
349
350 /** page vector */
Maxim Patlasov4250c062012-10-26 19:48:07 +0400351 struct page **pages;
352
Maxim Patlasovb2430d72012-10-26 19:49:24 +0400353 /** page-descriptor vector */
354 struct fuse_page_desc *page_descs;
355
Maxim Patlasov4250c062012-10-26 19:48:07 +0400356 /** size of the 'pages' array */
357 unsigned max_pages;
358
359 /** inline page vector */
360 struct page *inline_pages[FUSE_REQ_INLINE_PAGES];
Miklos Szeredi334f4852005-09-09 13:10:27 -0700361
Maxim Patlasovb2430d72012-10-26 19:49:24 +0400362 /** inline page-descriptor vector */
363 struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES];
364
Miklos Szeredi334f4852005-09-09 13:10:27 -0700365 /** number of pages in vector */
366 unsigned num_pages;
367
Miklos Szeredi334f4852005-09-09 13:10:27 -0700368 /** File used in the request (or NULL) */
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700369 struct fuse_file *ff;
Miklos Szeredi64c6d8e2006-01-16 22:14:42 -0800370
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700371 /** Inode used in the request or NULL */
372 struct inode *inode;
373
Maxim Patlasov01e9d112012-12-14 19:20:41 +0400374 /** AIO control block */
375 struct fuse_io_priv *io;
376
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700377 /** Link on fi->writepages */
378 struct list_head writepages_entry;
379
Miklos Szeredi64c6d8e2006-01-16 22:14:42 -0800380 /** Request completion callback */
381 void (*end)(struct fuse_conn *, struct fuse_req *);
Miklos Szeredi33649c92006-06-25 05:48:52 -0700382
383 /** Request is stolen from fuse_file->reserved_req */
384 struct file *stolen_file;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700385};
386
Miklos Szeredif88996a2015-07-01 16:26:01 +0200387struct fuse_iqueue {
Miklos Szeredie16714d2015-07-01 16:26:01 +0200388 /** Connection established */
389 unsigned connected;
390
Miklos Szeredif88996a2015-07-01 16:26:01 +0200391 /** Readers of the connection are waiting on this */
392 wait_queue_head_t waitq;
393
394 /** The next unique request id */
395 u64 reqctr;
396
397 /** The list of pending requests */
398 struct list_head pending;
399
400 /** Pending interrupts */
401 struct list_head interrupts;
402
403 /** Queue of pending forgets */
404 struct fuse_forget_link forget_list_head;
405 struct fuse_forget_link *forget_list_tail;
406
407 /** Batching of FORGET requests (positive indicates FORGET batch) */
408 int forget_batch;
409
410 /** O_ASYNC requests */
411 struct fasync_struct *fasync;
412};
413
Miklos Szeredi3a2b5b92015-07-01 16:26:04 +0200414struct fuse_pqueue {
Miklos Szeredie96edd92015-07-01 16:26:04 +0200415 /** Connection established */
416 unsigned connected;
417
Miklos Szeredi45a91cb2015-07-01 16:26:06 +0200418 /** Lock protecting accessess to members of this structure */
419 spinlock_t lock;
420
Miklos Szeredi3a2b5b92015-07-01 16:26:04 +0200421 /** The list of requests being processed */
422 struct list_head processing;
423
424 /** The list of requests under I/O */
425 struct list_head io;
426};
427
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700428/**
Miklos Szeredicc080e92015-07-01 16:26:08 +0200429 * Fuse device instance
430 */
431struct fuse_dev {
432 /** Fuse connection for this device */
433 struct fuse_conn *fc;
434
Miklos Szeredic36960462015-07-01 16:26:09 +0200435 /** Processing queue */
436 struct fuse_pqueue pq;
437
Miklos Szeredicc080e92015-07-01 16:26:08 +0200438 /** list entry on fc->devices */
439 struct list_head entry;
440};
441
442/**
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700443 * A Fuse connection.
444 *
445 * This structure is created, when the filesystem is mounted, and is
446 * destroyed, when the client device is closed and the filesystem is
447 * unmounted.
448 */
449struct fuse_conn {
Miklos Szeredid7133112006-04-10 22:54:55 -0700450 /** Lock protecting accessess to members of this structure */
451 spinlock_t lock;
452
Miklos Szeredibafa9652006-06-25 05:48:51 -0700453 /** Refcount */
Elena Reshetova095fc40a2017-03-03 11:04:05 +0200454 refcount_t count;
Miklos Szeredibafa9652006-06-25 05:48:51 -0700455
Miklos Szeredic36960462015-07-01 16:26:09 +0200456 /** Number of fuse_dev's */
457 atomic_t dev_count;
458
Al Virodd3e2c552013-10-03 21:21:39 -0400459 struct rcu_head rcu;
460
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700461 /** The user id for this mount */
Eric W. Biederman499dcf22012-02-07 16:26:03 -0800462 kuid_t user_id;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700463
Miklos Szeredi87729a52005-09-09 13:10:34 -0700464 /** The group id for this mount */
Eric W. Biederman499dcf22012-02-07 16:26:03 -0800465 kgid_t group_id;
Miklos Szeredi87729a52005-09-09 13:10:34 -0700466
Seth Forshee0b6e9ea2014-07-02 16:29:19 -0500467 /** The pid namespace for this mount */
468 struct pid_namespace *pid_ns;
469
Eric W. Biederman8cb08322018-02-21 11:18:07 -0600470 /** The user namespace for this mount */
471 struct user_namespace *user_ns;
472
Miklos Szeredidb50b962005-09-09 13:10:33 -0700473 /** Maximum read size */
474 unsigned max_read;
475
Miklos Szeredi413ef8c2005-09-09 13:10:35 -0700476 /** Maximum write size */
477 unsigned max_write;
478
Miklos Szeredif88996a2015-07-01 16:26:01 +0200479 /** Input queue */
480 struct fuse_iqueue iq;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700481
Tejun Heoacf99432008-11-26 12:03:55 +0100482 /** The next unique kernel file handle */
483 u64 khctr;
484
Tejun Heo95668a62008-11-26 12:03:55 +0100485 /** rbtree of fuse_files waiting for poll events indexed by ph */
486 struct rb_root polled_files;
487
Csaba Henk7a6d3c82009-07-01 17:28:41 -0700488 /** Maximum number of outstanding background requests */
489 unsigned max_background;
490
491 /** Number of background requests at which congestion starts */
492 unsigned congestion_threshold;
493
Miklos Szeredi08a53cd2006-04-10 22:54:59 -0700494 /** Number of requests currently in the background */
495 unsigned num_background;
496
Miklos Szeredid12def12008-02-06 01:38:39 -0800497 /** Number of background requests currently queued for userspace */
498 unsigned active_background;
499
500 /** The list of background requests set aside for later queuing */
501 struct list_head bg_queue;
502
Kirill Tkhaiae2dffa2018-08-27 18:29:46 +0300503 /** Protects: max_background, congestion_threshold, num_background,
504 * active_background, bg_queue, blocked */
505 spinlock_t bg_lock;
506
Maxim Patlasov796523fb2013-03-21 18:02:15 +0400507 /** Flag indicating that INIT reply has been received. Allocating
508 * any fuse request will be suspended until the flag is set */
509 int initialized;
510
Miklos Szeredi08a53cd2006-04-10 22:54:59 -0700511 /** Flag indicating if connection is blocked. This will be
512 the case before the INIT reply is received, and if there
513 are too many outstading backgrounds requests */
514 int blocked;
515
516 /** waitq for blocked connection */
517 wait_queue_head_t blocked_waitq;
518
Miklos Szeredide5e3de2007-10-16 23:31:00 -0700519 /** waitq for reserved requests */
520 wait_queue_head_t reserved_req_waitq;
521
Miklos Szeredi69a53bf2006-01-16 22:14:41 -0800522 /** Connection established, cleared on umount, connection
523 abort and device release */
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800524 unsigned connected;
Miklos Szeredi1e9a4ed2005-09-09 13:10:31 -0700525
Szymon Lukasz3b7008b2017-11-09 21:23:35 +0100526 /** Connection aborted via sysfs */
527 bool aborted;
528
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800529 /** Connection failed (version mismatch). Cannot race with
530 setting other bitfields since it is only set once in INIT
531 reply, before any other request, and never cleared */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100532 unsigned conn_error:1;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700533
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800534 /** Connection successful. Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100535 unsigned conn_init:1;
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800536
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800537 /** Do readpages asynchronously? Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100538 unsigned async_read:1;
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800539
Szymon Lukasz3b7008b2017-11-09 21:23:35 +0100540 /** Return an unique read error after abort. Only set in INIT */
541 unsigned abort_err:1;
542
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700543 /** Do not send separate SETATTR request before open(O_TRUNC) */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100544 unsigned atomic_o_trunc:1;
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700545
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700546 /** Filesystem supports NFS exporting. Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100547 unsigned export_support:1;
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700548
Pavel Emelyanovd5cd66c2013-10-10 17:10:30 +0400549 /** write-back cache policy (default is write-through) */
550 unsigned writeback_cache:1;
551
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200552 /** allow parallel lookups and readdir (default is serialized) */
553 unsigned parallel_dirops:1;
554
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200555 /** handle fs handles killing suid/sgid/cap on write/chown/trunc */
556 unsigned handle_killpriv:1;
557
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800558 /*
559 * The following bitfields are only for optimization purposes
560 * and hence races in setting them will not cause malfunction
561 */
562
Andrew Gallagher7678ac52013-11-05 16:05:52 +0100563 /** Is open/release not implemented by fs? */
564 unsigned no_open:1;
565
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700566 /** Is fsync not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100567 unsigned no_fsync:1;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700568
Miklos Szeredi82547982005-09-09 13:10:38 -0700569 /** Is fsyncdir not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100570 unsigned no_fsyncdir:1;
Miklos Szeredi82547982005-09-09 13:10:38 -0700571
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700572 /** Is flush not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100573 unsigned no_flush:1;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700574
Miklos Szeredi92a87802005-09-09 13:10:31 -0700575 /** Is setxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100576 unsigned no_setxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700577
578 /** Is getxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100579 unsigned no_getxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700580
581 /** Is listxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100582 unsigned no_listxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700583
584 /** Is removexattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100585 unsigned no_removexattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700586
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200587 /** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100588 unsigned no_lock:1;
Miklos Szeredi71421252006-06-25 05:48:52 -0700589
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800590 /** Is access not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100591 unsigned no_access:1;
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800592
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800593 /** Is create not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100594 unsigned no_create:1;
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800595
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700596 /** Is interrupt not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100597 unsigned no_interrupt:1;
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700598
Miklos Szeredib2d22722006-12-06 20:35:51 -0800599 /** Is bmap not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100600 unsigned no_bmap:1;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800601
Tejun Heo95668a62008-11-26 12:03:55 +0100602 /** Is poll not implemented by fs? */
603 unsigned no_poll:1;
604
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700605 /** Do multi-page cached writes */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100606 unsigned big_writes:1;
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700607
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200608 /** Don't apply umask to creation modes */
609 unsigned dont_mask:1;
610
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200611 /** Are BSD file locking primitives not implemented by fs? */
612 unsigned no_flock:1;
613
Miklos Szeredi519c6042012-04-26 10:56:36 +0200614 /** Is fallocate not implemented by fs? */
615 unsigned no_fallocate:1;
616
Miklos Szeredi1560c972014-04-28 16:43:44 +0200617 /** Is rename with flags implemented by fs? */
618 unsigned no_rename2:1;
619
Brian Foster72d0d242012-07-16 15:23:48 -0400620 /** Use enhanced/automatic page cache invalidation. */
621 unsigned auto_inval_data:1;
622
Eric Wong634734b2013-02-06 22:29:01 +0000623 /** Does the filesystem support readdirplus? */
Anand V. Avati0b05b182012-08-19 08:53:23 -0400624 unsigned do_readdirplus:1;
625
Eric Wong634734b2013-02-06 22:29:01 +0000626 /** Does the filesystem want adaptive readdirplus? */
627 unsigned readdirplus_auto:1;
628
Miklos Szeredi60b9df72013-05-01 14:37:21 +0200629 /** Does the filesystem support asynchronous direct-IO submission? */
630 unsigned async_dio:1;
631
Ravishankar N0b5da8d2015-06-30 23:40:22 +0530632 /** Is lseek not implemented by fs? */
633 unsigned no_lseek:1;
634
Seth Forshee60bcc882016-08-29 08:46:37 -0500635 /** Does the filesystem support posix acls? */
636 unsigned posix_acl:1;
637
Miklos Szeredi29433a22016-10-01 07:32:32 +0200638 /** Check permissions based on the file mode or not? */
639 unsigned default_permissions:1;
640
641 /** Allow other than the mounter user to access the filesystem ? */
642 unsigned allow_other:1;
643
Niels de Vos88bc7d52018-08-21 14:36:31 +0200644 /** Does the filesystem support copy_file_range? */
645 unsigned no_copy_file_range:1;
646
Miklos Szeredi0cd5b882006-01-16 22:14:38 -0800647 /** The number of requests waiting for completion */
648 atomic_t num_waiting;
649
Miklos Szeredi45714d62006-01-06 00:19:36 -0800650 /** Negotiated minor version */
651 unsigned minor;
652
Miklos Szeredibafa9652006-06-25 05:48:51 -0700653 /** Entry on the fuse_conn_list */
654 struct list_head entry;
655
Miklos Szeredib6f2fcb2008-04-30 00:54:34 -0700656 /** Device ID from super block */
657 dev_t dev;
Miklos Szeredibafa9652006-06-25 05:48:51 -0700658
659 /** Dentries in the control filesystem */
660 struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
661
662 /** number of dentries used in the above array */
663 int ctl_ndents;
Jeff Dike385a17b2006-04-10 22:54:52 -0700664
Miklos Szeredi9c8ef562006-06-25 05:48:55 -0700665 /** Key for lock owner ID scrambling */
666 u32 scramble_key[4];
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800667
668 /** Reserved request for the DESTROY message */
669 struct fuse_req *destroy_req;
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700670
671 /** Version counter for attribute changes */
672 u64 attr_version;
Tejun Heo43901aa2008-11-26 12:03:56 +0100673
674 /** Called on final put */
675 void (*release)(struct fuse_conn *);
John Muir3b463ae2009-05-31 11:13:57 -0400676
677 /** Super block for this connection. */
678 struct super_block *sb;
679
680 /** Read/write semaphore to hold when accessing sb. */
681 struct rw_semaphore killsb;
Miklos Szeredicc080e92015-07-01 16:26:08 +0200682
683 /** List of device instances belonging to this connection */
684 struct list_head devices;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700685};
686
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700687static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
688{
Miklos Szeredi6383bda2006-01-16 22:14:29 -0800689 return sb->s_fs_info;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700690}
691
692static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
693{
694 return get_fuse_conn_super(inode->i_sb);
695}
696
697static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
698{
699 return container_of(inode, struct fuse_inode, inode);
700}
701
702static inline u64 get_node_id(struct inode *inode)
703{
704 return get_fuse_inode(inode)->nodeid;
705}
706
Miklos Szeredi334f4852005-09-09 13:10:27 -0700707/** Device operations */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800708extern const struct file_operations fuse_dev_operations;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700709
Al Viro42695902009-02-20 05:59:13 +0000710extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredi0ce267f2016-10-18 15:36:48 +0200711extern const struct dentry_operations fuse_root_dentry_operations;
Miklos Szeredidbd561d2008-07-25 01:49:00 -0700712
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700713/**
John Muir3b463ae2009-05-31 11:13:57 -0400714 * Inode to nodeid comparison.
715 */
716int fuse_inode_eq(struct inode *inode, void *_nodeidp);
717
718/**
Miklos Szeredie5e55582005-09-09 13:10:28 -0700719 * Get a filled in inode
720 */
Miklos Szeredib48badf2008-04-30 00:54:44 -0700721struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700722 int generation, struct fuse_attr *attr,
723 u64 attr_valid, u64 attr_version);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700724
Al Viro13983d02016-07-20 22:34:44 -0400725int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700726 struct fuse_entry_out *outarg, struct inode **inode);
727
Miklos Szeredie5e55582005-09-09 13:10:28 -0700728/**
729 * Send FORGET command
730 */
Miklos Szeredi07e77dc2010-12-07 20:16:56 +0100731void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
732 u64 nodeid, u64 nlookup);
733
734struct fuse_forget_link *fuse_alloc_forget(void);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700735
Anand V. Avati0b05b182012-08-19 08:53:23 -0400736/* Used by READDIRPLUS */
737void fuse_force_forget(struct file *file, u64 nodeid);
738
Miklos Szeredie5e55582005-09-09 13:10:28 -0700739/**
Miklos Szeredi361b1eb52006-01-16 22:14:45 -0800740 * Initialize READ or READDIR request
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700741 */
Miklos Szeredia6643092007-11-28 16:22:00 -0800742void fuse_read_fill(struct fuse_req *req, struct file *file,
Miklos Szeredi2106cb12009-04-28 16:56:37 +0200743 loff_t pos, size_t count, int opcode);
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700744
745/**
746 * Send OPEN or OPENDIR request
747 */
Miklos Szeredi91fe96b2009-04-28 16:56:37 +0200748int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700749
Tejun Heoacf99432008-11-26 12:03:55 +0100750struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800751void fuse_file_free(struct fuse_file *ff);
Miklos Szeredic7b71432009-04-28 16:56:37 +0200752void fuse_finish_open(struct inode *inode, struct file *file);
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800753
Miklos Szeredi8b0797a2009-04-28 16:56:39 +0200754void fuse_sync_release(struct fuse_file *ff, int flags);
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700755
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700756/**
757 * Send RELEASE or RELEASEDIR request
758 */
Miklos Szeredi8b0797a2009-04-28 16:56:39 +0200759void fuse_release_common(struct file *file, int opcode);
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700760
761/**
Miklos Szeredi82547982005-09-09 13:10:38 -0700762 * Send FSYNC or FSYNCDIR request
763 */
Josef Bacik02c24a82011-07-16 20:44:56 -0400764int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
765 int datasync, int isdir);
Miklos Szeredi82547982005-09-09 13:10:38 -0700766
767/**
Tejun Heo95668a62008-11-26 12:03:55 +0100768 * Notify poll wakeup
769 */
770int fuse_notify_poll_wakeup(struct fuse_conn *fc,
771 struct fuse_notify_poll_wakeup_out *outarg);
772
773/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800774 * Initialize file operations on a regular file
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700775 */
776void fuse_init_file_inode(struct inode *inode);
777
778/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800779 * Initialize inode operations on regular files and special files
Miklos Szeredie5e55582005-09-09 13:10:28 -0700780 */
781void fuse_init_common(struct inode *inode);
782
783/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800784 * Initialize inode and file operations on a directory
Miklos Szeredie5e55582005-09-09 13:10:28 -0700785 */
786void fuse_init_dir(struct inode *inode);
787
788/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800789 * Initialize inode operations on a symlink
Miklos Szeredie5e55582005-09-09 13:10:28 -0700790 */
791void fuse_init_symlink(struct inode *inode);
792
793/**
794 * Change attributes of an inode
795 */
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700796void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
797 u64 attr_valid, u64 attr_version);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700798
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700799void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
800 u64 attr_valid);
801
Miklos Szeredie5e55582005-09-09 13:10:28 -0700802/**
Miklos Szeredi334f4852005-09-09 13:10:27 -0700803 * Initialize the client device
804 */
805int fuse_dev_init(void);
806
807/**
808 * Cleanup the client device
809 */
810void fuse_dev_cleanup(void);
811
Miklos Szeredibafa9652006-06-25 05:48:51 -0700812int fuse_ctl_init(void);
Fabian Frederick7736e8c2014-04-23 18:14:42 +0200813void __exit fuse_ctl_cleanup(void);
Miklos Szeredibafa9652006-06-25 05:48:51 -0700814
Miklos Szeredi334f4852005-09-09 13:10:27 -0700815/**
816 * Allocate a request
817 */
Maxim Patlasov4250c062012-10-26 19:48:07 +0400818struct fuse_req *fuse_request_alloc(unsigned npages);
Miklos Szeredi334f4852005-09-09 13:10:27 -0700819
Maxim Patlasov4250c062012-10-26 19:48:07 +0400820struct fuse_req *fuse_request_alloc_nofs(unsigned npages);
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700821
Miklos Szeredi334f4852005-09-09 13:10:27 -0700822/**
823 * Free a request
824 */
825void fuse_request_free(struct fuse_req *req);
826
827/**
Maxim Patlasovb111c8c2012-10-26 19:48:30 +0400828 * Get a request, may fail with -ENOMEM,
829 * caller should specify # elements in req->pages[] explicitly
Miklos Szeredi334f4852005-09-09 13:10:27 -0700830 */
Maxim Patlasovb111c8c2012-10-26 19:48:30 +0400831struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages);
Maxim Patlasov8b41e672013-03-21 18:02:04 +0400832struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc,
833 unsigned npages);
Maxim Patlasovb111c8c2012-10-26 19:48:30 +0400834
Maxim Patlasov36cf66e2012-12-14 19:20:51 +0400835/*
836 * Increment reference count on request
837 */
838void __fuse_get_request(struct fuse_req *req);
839
Maxim Patlasovb111c8c2012-10-26 19:48:30 +0400840/**
Miklos Szeredi33649c92006-06-25 05:48:52 -0700841 * Gets a requests for a file operation, always succeeds
842 */
Maxim Patlasovb111c8c2012-10-26 19:48:30 +0400843struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc,
844 struct file *file);
Miklos Szeredi33649c92006-06-25 05:48:52 -0700845
846/**
Miklos Szeredice1d5a42006-04-10 22:54:58 -0700847 * Decrement reference count of a request. If count goes to zero free
848 * the request.
Miklos Szeredi334f4852005-09-09 13:10:27 -0700849 */
850void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
851
852/**
Miklos Szeredi7c352bd2005-09-09 13:10:39 -0700853 * Send a request (synchronous)
Miklos Szeredi334f4852005-09-09 13:10:27 -0700854 */
Tejun Heob93f8582008-11-26 12:03:55 +0100855void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req);
Miklos Szeredi334f4852005-09-09 13:10:27 -0700856
857/**
Miklos Szeredi70781872014-12-12 09:49:05 +0100858 * Simple request sending that does request allocation and freeing
859 */
860ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);
861
862/**
Miklos Szeredi334f4852005-09-09 13:10:27 -0700863 * Send a request in the background
864 */
Tejun Heob93f8582008-11-26 12:03:55 +0100865void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req);
Miklos Szeredi334f4852005-09-09 13:10:27 -0700866
Kirill Tkhaiae2dffa2018-08-27 18:29:46 +0300867void fuse_request_send_background_nocheck(struct fuse_conn *fc,
868 struct fuse_req *req);
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700869
Miklos Szeredi5a5fb1e2006-04-26 10:48:55 +0200870/* Abort all requests */
Szymon Lukasz3b7008b2017-11-09 21:23:35 +0100871void fuse_abort_conn(struct fuse_conn *fc, bool is_abort);
Miklos Szeredib8f95e52018-07-26 16:13:11 +0200872void fuse_wait_aborted(struct fuse_conn *fc);
Miklos Szeredi69a53bf2006-01-16 22:14:41 -0800873
Miklos Szeredi1e9a4ed2005-09-09 13:10:31 -0700874/**
Miklos Szeredie5e55582005-09-09 13:10:28 -0700875 * Invalidate inode attributes
876 */
877void fuse_invalidate_attr(struct inode *inode);
Miklos Szeredibafa9652006-06-25 05:48:51 -0700878
Miklos Szeredidbd561d2008-07-25 01:49:00 -0700879void fuse_invalidate_entry_cache(struct dentry *entry);
880
Andrew Gallagher451418f2013-11-05 03:55:43 -0800881void fuse_invalidate_atime(struct inode *inode);
882
Miklos Szeredibafa9652006-06-25 05:48:51 -0700883/**
884 * Acquire reference to fuse_conn
885 */
886struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
887
888/**
Tejun Heo0d179aa2008-11-26 12:03:55 +0100889 * Initialize fuse_conn
890 */
Eric W. Biederman8cb08322018-02-21 11:18:07 -0600891void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns);
Tejun Heo0d179aa2008-11-26 12:03:55 +0100892
893/**
Miklos Szeredibafa9652006-06-25 05:48:51 -0700894 * Release reference to fuse_conn
895 */
896void fuse_conn_put(struct fuse_conn *fc);
897
Miklos Szeredicc080e92015-07-01 16:26:08 +0200898struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
899void fuse_dev_free(struct fuse_dev *fud);
900
Miklos Szeredibafa9652006-06-25 05:48:51 -0700901/**
902 * Add connection to control filesystem
903 */
904int fuse_ctl_add_conn(struct fuse_conn *fc);
905
906/**
907 * Remove connection from control filesystem
908 */
909void fuse_ctl_remove_conn(struct fuse_conn *fc);
Timo Savolaa5bfffac2007-04-08 16:04:00 -0700910
911/**
912 * Is file type valid?
913 */
914int fuse_valid_type(int m);
Miklos Szeredie57ac682007-10-18 03:06:58 -0700915
916/**
Anatol Pomozovc2132c12013-01-14 22:30:00 -0800917 * Is current process allowed to perform filesystem operation?
Miklos Szeredie57ac682007-10-18 03:06:58 -0700918 */
Anatol Pomozovc2132c12013-01-14 22:30:00 -0800919int fuse_allow_current_process(struct fuse_conn *fc);
Miklos Szeredif3332112007-10-18 03:07:04 -0700920
921u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
Miklos Szeredibcb4be82007-11-28 16:21:59 -0800922
Seth Forshee703c7362016-08-29 08:46:36 -0500923void fuse_update_ctime(struct inode *inode);
924
Miklos Szeredi5b97eea2017-09-12 16:57:54 +0200925int fuse_update_attributes(struct inode *inode, struct file *file);
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700926
927void fuse_flush_writepages(struct inode *inode);
928
929void fuse_set_nowrite(struct inode *inode);
930void fuse_release_nowrite(struct inode *inode);
Miklos Szeredi5c5c5e52008-04-30 00:54:43 -0700931
932u64 fuse_get_attr_version(struct fuse_conn *fc);
Tejun Heo29d434b2008-10-16 16:08:57 +0200933
John Muir3b463ae2009-05-31 11:13:57 -0400934/**
935 * File-system tells the kernel to invalidate cache for the given node id.
936 */
937int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
938 loff_t offset, loff_t len);
939
940/**
941 * File-system tells the kernel to invalidate parent attributes and
942 * the dentry matching parent/name.
John Muir451d0f52011-12-06 21:50:06 +0100943 *
944 * If the child_nodeid is non-zero and:
945 * - matches the inode number for the dentry matching parent/name,
946 * - is not a mount point
947 * - is a file or oan empty directory
948 * then the dentry is unhashed (d_delete()).
John Muir3b463ae2009-05-31 11:13:57 -0400949 */
950int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
John Muir451d0f52011-12-06 21:50:06 +0100951 u64 child_nodeid, struct qstr *name);
John Muir3b463ae2009-05-31 11:13:57 -0400952
Tejun Heo08cbf542009-04-14 10:54:53 +0900953int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
954 bool isdir);
Pavel Emelyanovea8cd332013-10-10 17:12:05 +0400955
956/**
957 * fuse_direct_io() flags
958 */
959
960/** If set, it is WRITE; otherwise - READ */
961#define FUSE_DIO_WRITE (1 << 0)
962
963/** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
964#define FUSE_DIO_CUSE (1 << 1)
965
Al Virod22a9432014-03-16 15:50:47 -0400966ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
967 loff_t *ppos, int flags);
Tejun Heo08cbf542009-04-14 10:54:53 +0900968long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
969 unsigned int flags);
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100970long fuse_ioctl_common(struct file *file, unsigned int cmd,
971 unsigned long arg, unsigned int flags);
Al Viro076ccb72017-07-03 01:02:18 -0400972__poll_t fuse_file_poll(struct file *file, poll_table *wait);
Tejun Heo08cbf542009-04-14 10:54:53 +0900973int fuse_dev_release(struct inode *inode, struct file *file);
974
Maxim Patlasovb0aa7602013-12-26 19:51:11 +0400975bool fuse_write_update_size(struct inode *inode, loff_t pos);
976
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200977int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi1e18bda2014-04-28 14:19:23 +0200978int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200979
Jan Kara62490332016-05-26 17:12:41 +0200980int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
Maxim Patlasovefb9fa92012-12-18 14:05:08 +0400981 struct file *file);
982
Miklos Szeredi9759bd512015-01-06 10:45:35 +0100983void fuse_set_initialized(struct fuse_conn *fc);
984
Miklos Szeredi63576c12018-07-26 16:13:11 +0200985void fuse_unlock_inode(struct inode *inode, bool locked);
986bool fuse_lock_inode(struct inode *inode);
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200987
Seth Forshee60bcc882016-08-29 08:46:37 -0500988int fuse_setxattr(struct inode *inode, const char *name, const void *value,
989 size_t size, int flags);
990ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value,
991 size_t size);
Seth Forshee703c7362016-08-29 08:46:36 -0500992ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
Seth Forshee60bcc882016-08-29 08:46:37 -0500993int fuse_removexattr(struct inode *inode, const char *name);
Seth Forshee703c7362016-08-29 08:46:36 -0500994extern const struct xattr_handler *fuse_xattr_handlers[];
Seth Forshee60bcc882016-08-29 08:46:37 -0500995extern const struct xattr_handler *fuse_acl_xattr_handlers[];
Eric W. Biedermane45b2542018-05-04 11:47:28 -0500996extern const struct xattr_handler *fuse_no_acl_xattr_handlers[];
Seth Forshee60bcc882016-08-29 08:46:37 -0500997
998struct posix_acl;
999struct posix_acl *fuse_get_acl(struct inode *inode, int type);
1000int fuse_set_acl(struct inode *inode, struct posix_acl *acl, int type);
Seth Forshee703c7362016-08-29 08:46:36 -05001001
Tejun Heo29d434b2008-10-16 16:08:57 +02001002#endif /* _FS_FUSE_I_H */