blob: 9454f2328bd09b488f64a1fb5dbc10c91c21f3d4 [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
Kirill Smelkovf2294482019-03-27 09:15:17 +000012#ifndef pr_fmt
13# define pr_fmt(fmt) "fuse: " fmt
14#endif
15
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070016#include <linux/fuse.h>
17#include <linux/fs.h>
Miklos Szeredi51eb01e2006-06-25 05:48:50 -070018#include <linux/mount.h>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070019#include <linux/wait.h>
20#include <linux/list.h>
21#include <linux/spinlock.h>
22#include <linux/mm.h>
23#include <linux/backing-dev.h>
Miklos Szeredibafa9652006-06-25 05:48:51 -070024#include <linux/mutex.h>
Miklos Szeredi3be5a522008-04-30 00:54:41 -070025#include <linux/rwsem.h>
Tejun Heo95668a62008-11-26 12:03:55 +010026#include <linux/rbtree.h>
27#include <linux/poll.h>
Miklos Szeredi5a18ec12011-02-25 14:44:58 +010028#include <linux/workqueue.h>
Seth Forshee744742d2016-03-11 10:35:34 -060029#include <linux/kref.h>
Seth Forshee60bcc882016-08-29 08:46:37 -050030#include <linux/xattr.h>
Seth Forshee0b6e9ea2014-07-02 16:29:19 -050031#include <linux/pid_namespace.h>
Elena Reshetova4e8c2eb2017-03-03 11:04:03 +020032#include <linux/refcount.h>
Eric W. Biederman8cb08322018-02-21 11:18:07 -060033#include <linux/user_namespace.h>
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070034
Constantine Shulyupin5da784c2018-09-06 15:37:06 +030035/** Default max number of pages that can be used in a single read request */
36#define FUSE_DEFAULT_MAX_PAGES_PER_REQ 32
37
38/** Maximum of max_pages received in init_out */
39#define FUSE_MAX_MAX_PAGES 256
Miklos Szeredi334f4852005-09-09 13:10:27 -070040
Miklos Szeredi3be5a522008-04-30 00:54:41 -070041/** Bias for fi->writectr, meaning new writepages must not be sent */
42#define FUSE_NOWRITE INT_MIN
43
Miklos Szeredi1d3d7522006-01-06 00:19:40 -080044/** It could be as large as PATH_MAX, but would that have any uses? */
45#define FUSE_NAME_MAX 1024
46
Miklos Szeredibafa9652006-06-25 05:48:51 -070047/** Number of dentries for each connection in the control filesystem */
Csaba Henk79a9d992009-08-26 19:18:24 +020048#define FUSE_CTL_NUM_DENTRIES 5
Miklos Szeredibafa9652006-06-25 05:48:51 -070049
Miklos Szeredibafa9652006-06-25 05:48:51 -070050/** List of active connections */
51extern struct list_head fuse_conn_list;
52
53/** Global mutex protecting fuse_conn_list and the control filesystem */
54extern struct mutex fuse_mutex;
Miklos Szeredi413ef8c2005-09-09 13:10:35 -070055
Csaba Henk79a9d992009-08-26 19:18:24 +020056/** Module parameters */
57extern unsigned max_user_bgreq;
58extern unsigned max_user_congthresh;
59
Miklos Szeredi07e77dc2010-12-07 20:16:56 +010060/* One forget request */
61struct fuse_forget_link {
Miklos Szeredi02c048b2010-12-07 20:16:56 +010062 struct fuse_forget_one forget_one;
Miklos Szeredi07e77dc2010-12-07 20:16:56 +010063 struct fuse_forget_link *next;
64};
65
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070066/** FUSE inode */
67struct fuse_inode {
68 /** Inode data */
69 struct inode inode;
70
71 /** Unique ID, which identifies the inode between userspace
72 * and kernel */
73 u64 nodeid;
74
Miklos Szeredi9e6268d2005-09-09 13:10:29 -070075 /** Number of lookups on this inode */
76 u64 nlookup;
77
Miklos Szeredie5e55582005-09-09 13:10:28 -070078 /** The request used for sending the FORGET message */
Miklos Szeredi07e77dc2010-12-07 20:16:56 +010079 struct fuse_forget_link *forget;
Miklos Szeredie5e55582005-09-09 13:10:28 -070080
Miklos Szeredid8a5ba42005-09-09 13:10:26 -070081 /** Time in jiffies until the file attributes are valid */
Miklos Szeredi0a0898c2006-07-30 03:04:10 -070082 u64 i_time;
Miklos Szerediebc14c42007-10-16 23:31:03 -070083
Miklos Szeredi2f1e8192018-10-15 15:43:06 +020084 /* Which attributes are invalid */
85 u32 inval_mask;
86
Miklos Szerediebc14c42007-10-16 23:31:03 -070087 /** The sticky bit in inode->i_mode may have been removed, so
88 preserve the original mode */
Al Viro541af6a2011-07-26 03:17:33 -040089 umode_t orig_i_mode;
Miklos Szeredi1fb69e72007-10-18 03:06:58 -070090
Pavel Shilovsky45c72cd2012-05-10 19:49:38 +040091 /** 64 bit inode number */
92 u64 orig_ino;
93
Miklos Szeredi1fb69e72007-10-18 03:06:58 -070094 /** Version of last attribute change */
95 u64 attr_version;
Miklos Szeredi93a8c3c2007-10-18 03:07:03 -070096
Miklos Szerediab2257e2018-10-01 10:07:05 +020097 union {
98 /* Write related fields (regular file only) */
99 struct {
Kirill Tkhaif15ecfe2018-11-09 13:33:22 +0300100 /* Files usable in writepage. Protected by fi->lock */
Miklos Szerediab2257e2018-10-01 10:07:05 +0200101 struct list_head write_files;
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700102
Miklos Szerediab2257e2018-10-01 10:07:05 +0200103 /* Writepages pending on truncate or fsync */
104 struct list_head queued_writes;
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700105
Miklos Szerediab2257e2018-10-01 10:07:05 +0200106 /* Number of sent writes, a negative bias
107 * (FUSE_NOWRITE) means more writes are blocked */
108 int writectr;
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700109
Miklos Szerediab2257e2018-10-01 10:07:05 +0200110 /* Waitq for writepage completion */
111 wait_queue_head_t page_waitq;
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700112
Miklos Szerediab2257e2018-10-01 10:07:05 +0200113 /* List of writepage requestst (pending or sent) */
114 struct list_head writepages;
115 };
Feng Shuo4582a4a2013-01-15 11:23:28 +0800116
Miklos Szerediab2257e2018-10-01 10:07:05 +0200117 /* readdir cache (directory only) */
118 struct {
119 /* true if fully cached */
120 bool cached;
Miklos Szeredi69e34552018-10-01 10:07:04 +0200121
Miklos Szerediab2257e2018-10-01 10:07:05 +0200122 /* size of cache */
123 loff_t size;
Miklos Szeredi69e34552018-10-01 10:07:04 +0200124
Miklos Szerediab2257e2018-10-01 10:07:05 +0200125 /* position at end of cache (position of next entry) */
126 loff_t pos;
Miklos Szeredi69e34552018-10-01 10:07:04 +0200127
Miklos Szerediab2257e2018-10-01 10:07:05 +0200128 /* version of the cache */
129 u64 version;
Miklos Szeredi34949272018-10-01 10:07:04 +0200130
Miklos Szerediab2257e2018-10-01 10:07:05 +0200131 /* modification time of directory when cache was
132 * started */
133 struct timespec64 mtime;
Miklos Szeredi71188832018-10-01 10:07:04 +0200134
Miklos Szerediab2257e2018-10-01 10:07:05 +0200135 /* iversion of directory when cache was started */
136 u64 iversion;
Miklos Szeredi261aaba72018-10-01 10:07:05 +0200137
Miklos Szerediab2257e2018-10-01 10:07:05 +0200138 /* protects above fields */
139 spinlock_t lock;
140 } rdc;
141 };
Miklos Szeredi69e34552018-10-01 10:07:04 +0200142
Feng Shuo4582a4a2013-01-15 11:23:28 +0800143 /** Miscellaneous bits describing inode state */
144 unsigned long state;
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200145
146 /** Lock for serializing lookup and readdir for back compatibility*/
147 struct mutex mutex;
Kirill Tkhaif15ecfe2018-11-09 13:33:22 +0300148
149 /** Lock to protect write related fields */
150 spinlock_t lock;
Feng Shuo4582a4a2013-01-15 11:23:28 +0800151};
152
153/** FUSE inode state bits */
154enum {
155 /** Advise readdirplus */
156 FUSE_I_ADVISE_RDPLUS,
Miklos Szeredi6314efe2013-10-01 16:41:22 +0200157 /** Initialized with readdirplus */
158 FUSE_I_INIT_RDPLUS,
Maxim Patlasov06a7c3c2013-08-30 17:06:04 +0400159 /** An operation changing file size is in progress */
160 FUSE_I_SIZE_UNSTABLE,
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700161};
162
Miklos Szeredida5e4712009-04-28 16:56:36 +0200163struct fuse_conn;
Miklos Szeredi4cb54862019-09-10 15:04:10 +0200164struct fuse_release_args;
Miklos Szeredida5e4712009-04-28 16:56:36 +0200165
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700166/** FUSE specific file data */
167struct fuse_file {
Miklos Szeredida5e4712009-04-28 16:56:36 +0200168 /** Fuse connection for this file */
169 struct fuse_conn *fc;
170
Miklos Szeredi4cb54862019-09-10 15:04:10 +0200171 /* Argument space reserved for release */
172 struct fuse_release_args *release_args;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700173
Tejun Heoacf99432008-11-26 12:03:55 +0100174 /** Kernel file handle guaranteed to be unique */
175 u64 kh;
176
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700177 /** File handle used by userspace */
178 u64 fh;
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700179
Miklos Szeredida5e4712009-04-28 16:56:36 +0200180 /** Node id of this file */
181 u64 nodeid;
182
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700183 /** Refcount */
Elena Reshetova4e8c2eb2017-03-03 11:04:03 +0200184 refcount_t count;
Miklos Szeredi93a8c3c2007-10-18 03:07:03 -0700185
Miklos Szeredic7b71432009-04-28 16:56:37 +0200186 /** FOPEN_* flags returned by open */
187 u32 open_flags;
188
Miklos Szeredi93a8c3c2007-10-18 03:07:03 -0700189 /** Entry on inode's write_files list */
190 struct list_head write_entry;
Tejun Heo95668a62008-11-26 12:03:55 +0100191
Miklos Szeredi5d7bc7e2018-10-01 10:07:04 +0200192 /* Readdir related */
193 struct {
194 /*
195 * Protects below fields against (crazy) parallel readdir on
196 * same open file. Uncontended in the normal case.
197 */
198 struct mutex lock;
199
200 /* Dir stream position */
201 loff_t pos;
202
203 /* Offset in cache */
204 loff_t cache_off;
Miklos Szeredi34949272018-10-01 10:07:04 +0200205
206 /* Version of cache we are reading */
207 u64 version;
208
Miklos Szeredi5d7bc7e2018-10-01 10:07:04 +0200209 } readdir;
210
Tejun Heo95668a62008-11-26 12:03:55 +0100211 /** RB node to be linked on fuse_conn->polled_files */
212 struct rb_node polled_node;
213
214 /** Wait queue head for poll */
215 wait_queue_head_t poll_wait;
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200216
217 /** Has flock been performed on this file? */
218 bool flock:1;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700219};
220
Miklos Szeredi334f4852005-09-09 13:10:27 -0700221/** One input argument of a request */
222struct fuse_in_arg {
223 unsigned size;
224 const void *value;
225};
226
Miklos Szeredi334f4852005-09-09 13:10:27 -0700227/** One output argument of a request */
228struct fuse_arg {
229 unsigned size;
230 void *value;
231};
232
Maxim Patlasovb2430d72012-10-26 19:49:24 +0400233/** FUSE page descriptor */
234struct fuse_page_desc {
235 unsigned int length;
236 unsigned int offset;
237};
238
Miklos Szeredi70781872014-12-12 09:49:05 +0100239struct fuse_args {
Miklos Szeredid5b48542019-09-10 15:04:08 +0200240 uint64_t nodeid;
Miklos Szeredi1f4e9d02019-09-10 15:04:08 +0200241 uint32_t opcode;
242 unsigned short in_numargs;
243 unsigned short out_numargs;
Miklos Szeredic500eba2019-09-10 15:04:08 +0200244 bool force:1;
Miklos Szeredi454a7612019-09-10 15:04:08 +0200245 bool noreply:1;
Miklos Szeredie4137542019-09-10 15:04:08 +0200246 bool nocreds:1;
Miklos Szeredi68583162019-09-10 15:04:09 +0200247 bool in_pages:1;
248 bool out_pages:1;
Miklos Szeredi1f4e9d02019-09-10 15:04:08 +0200249 bool out_argvar:1;
Miklos Szeredi68583162019-09-10 15:04:09 +0200250 bool page_zeroing:1;
251 bool page_replace:1;
Miklos Szeredid5b48542019-09-10 15:04:08 +0200252 struct fuse_in_arg in_args[3];
Miklos Szeredid5b48542019-09-10 15:04:08 +0200253 struct fuse_arg out_args[2];
Miklos Szeredi12597282019-09-10 15:04:10 +0200254 void (*end)(struct fuse_conn *fc, struct fuse_args *args, int error);
Miklos Szeredi70781872014-12-12 09:49:05 +0100255};
256
Miklos Szeredi68583162019-09-10 15:04:09 +0200257struct fuse_args_pages {
258 struct fuse_args args;
259 struct page **pages;
260 struct fuse_page_desc *descs;
261 unsigned int num_pages;
262};
263
Miklos Szeredi70781872014-12-12 09:49:05 +0100264#define FUSE_ARGS(args) struct fuse_args args = {}
265
Maxim Patlasov01e9d112012-12-14 19:20:41 +0400266/** The request IO state (for asynchronous processing) */
267struct fuse_io_priv {
Seth Forshee744742d2016-03-11 10:35:34 -0600268 struct kref refcnt;
Maxim Patlasov01e9d112012-12-14 19:20:41 +0400269 int async;
270 spinlock_t lock;
271 unsigned reqs;
272 ssize_t bytes;
273 size_t size;
274 __u64 offset;
275 bool write;
Ashish Samant61c12b42017-07-12 19:26:58 -0700276 bool should_dirty;
Maxim Patlasov01e9d112012-12-14 19:20:41 +0400277 int err;
278 struct kiocb *iocb;
Christoph Hellwig9d5722b2015-02-02 14:59:43 +0100279 struct completion *done;
Ashish Sangwan7879c4e2016-04-07 17:18:11 +0530280 bool blocking;
Maxim Patlasov01e9d112012-12-14 19:20:41 +0400281};
282
Miklos Szeredie1c0eec2017-09-12 16:57:53 +0200283#define FUSE_IO_PRIV_SYNC(i) \
Seth Forshee744742d2016-03-11 10:35:34 -0600284{ \
Peter Zijlstra1e24edc2016-11-14 17:12:23 +0100285 .refcnt = KREF_INIT(1), \
Seth Forshee744742d2016-03-11 10:35:34 -0600286 .async = 0, \
Miklos Szeredie1c0eec2017-09-12 16:57:53 +0200287 .iocb = i, \
Seth Forshee744742d2016-03-11 10:35:34 -0600288}
289
Miklos Szeredi334f4852005-09-09 13:10:27 -0700290/**
Miklos Szeredi825d6d32015-07-01 16:25:58 +0200291 * Request flags
292 *
293 * FR_ISREPLY: set if the request has reply
294 * FR_FORCE: force sending of the request even if interrupted
295 * FR_BACKGROUND: request is sent in the background
296 * FR_WAITING: request is counted as "waiting"
297 * FR_ABORTED: the request was aborted
298 * FR_INTERRUPTED: the request has been interrupted
299 * FR_LOCKED: data is being copied to/from the request
Miklos Szeredi33e14b42015-07-01 16:26:01 +0200300 * FR_PENDING: request is not yet in userspace
301 * FR_SENT: request is in userspace, waiting for an answer
302 * FR_FINISHED: request is finished
Miklos Szeredi77cd9d42015-07-01 16:26:06 +0200303 * FR_PRIVATE: request is on private list
Miklos Szeredi825d6d32015-07-01 16:25:58 +0200304 */
305enum fuse_req_flag {
306 FR_ISREPLY,
307 FR_FORCE,
308 FR_BACKGROUND,
309 FR_WAITING,
310 FR_ABORTED,
311 FR_INTERRUPTED,
312 FR_LOCKED,
Miklos Szeredi33e14b42015-07-01 16:26:01 +0200313 FR_PENDING,
314 FR_SENT,
315 FR_FINISHED,
Miklos Szeredi77cd9d42015-07-01 16:26:06 +0200316 FR_PRIVATE,
Miklos Szeredi825d6d32015-07-01 16:25:58 +0200317};
318
319/**
Miklos Szeredi334f4852005-09-09 13:10:27 -0700320 * A request to the client
Miklos Szeredidc008092015-07-01 16:25:58 +0200321 *
322 * .waitq.lock protects the following fields:
323 * - FR_ABORTED
324 * - FR_LOCKED (may also be modified under fc->lock, tested under both)
Miklos Szeredi334f4852005-09-09 13:10:27 -0700325 */
326struct fuse_req {
Miklos Szeredice1d5a42006-04-10 22:54:58 -0700327 /** This can be on either pending processing or io lists in
328 fuse_conn */
Miklos Szeredi334f4852005-09-09 13:10:27 -0700329 struct list_head list;
330
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700331 /** Entry on the interrupts list */
332 struct list_head intr_entry;
333
Miklos Szeredi12597282019-09-10 15:04:10 +0200334 /* Input/output arguments */
335 struct fuse_args *args;
336
Miklos Szeredi334f4852005-09-09 13:10:27 -0700337 /** refcount */
Elena Reshetovaec99f6d2017-03-03 11:04:04 +0200338 refcount_t count;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700339
Miklos Szeredi825d6d32015-07-01 16:25:58 +0200340 /* Request flags, updated with test/set/clear_bit() */
341 unsigned long flags;
Miklos Szeredi9bc5ddd2006-04-11 21:16:09 +0200342
Miklos Szeredid4993772019-09-10 15:04:11 +0200343 /* The request input header */
344 struct {
345 struct fuse_in_header h;
346 } in;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700347
Miklos Szeredid4993772019-09-10 15:04:11 +0200348 /* The request output header */
349 struct {
350 struct fuse_out_header h;
351 } out;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700352
353 /** Used to wake up the task waiting for completion of request*/
354 wait_queue_head_t waitq;
355
Miklos Szeredi334f4852005-09-09 13:10:27 -0700356 /** page vector */
Maxim Patlasov4250c062012-10-26 19:48:07 +0400357 struct page **pages;
358
Maxim Patlasovb2430d72012-10-26 19:49:24 +0400359 /** page-descriptor vector */
360 struct fuse_page_desc *page_descs;
361
Miklos Szeredi334f4852005-09-09 13:10:27 -0700362 /** number of pages in vector */
363 unsigned num_pages;
364
Miklos Szeredi334f4852005-09-09 13:10:27 -0700365};
366
Miklos Szeredif88996a2015-07-01 16:26:01 +0200367struct fuse_iqueue {
Miklos Szeredie16714d2015-07-01 16:26:01 +0200368 /** Connection established */
369 unsigned connected;
370
Eric Biggers76e43c82019-09-08 20:15:18 -0700371 /** Lock protecting accesses to members of this structure */
372 spinlock_t lock;
373
Miklos Szeredif88996a2015-07-01 16:26:01 +0200374 /** Readers of the connection are waiting on this */
375 wait_queue_head_t waitq;
376
377 /** The next unique request id */
378 u64 reqctr;
379
380 /** The list of pending requests */
381 struct list_head pending;
382
383 /** Pending interrupts */
384 struct list_head interrupts;
385
386 /** Queue of pending forgets */
387 struct fuse_forget_link forget_list_head;
388 struct fuse_forget_link *forget_list_tail;
389
390 /** Batching of FORGET requests (positive indicates FORGET batch) */
391 int forget_batch;
392
393 /** O_ASYNC requests */
394 struct fasync_struct *fasync;
395};
396
Kirill Tkhaibe2ff422018-09-11 13:12:14 +0300397#define FUSE_PQ_HASH_BITS 8
398#define FUSE_PQ_HASH_SIZE (1 << FUSE_PQ_HASH_BITS)
399
Miklos Szeredi3a2b5b92015-07-01 16:26:04 +0200400struct fuse_pqueue {
Miklos Szeredie96edd92015-07-01 16:26:04 +0200401 /** Connection established */
402 unsigned connected;
403
Miklos Szeredi45a91cb2015-07-01 16:26:06 +0200404 /** Lock protecting accessess to members of this structure */
405 spinlock_t lock;
406
Kirill Tkhaibe2ff422018-09-11 13:12:14 +0300407 /** Hash table of requests being processed */
408 struct list_head *processing;
Miklos Szeredi3a2b5b92015-07-01 16:26:04 +0200409
410 /** The list of requests under I/O */
411 struct list_head io;
412};
413
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700414/**
Miklos Szeredicc080e92015-07-01 16:26:08 +0200415 * Fuse device instance
416 */
417struct fuse_dev {
418 /** Fuse connection for this device */
419 struct fuse_conn *fc;
420
Miklos Szeredic36960462015-07-01 16:26:09 +0200421 /** Processing queue */
422 struct fuse_pqueue pq;
423
Miklos Szeredicc080e92015-07-01 16:26:08 +0200424 /** list entry on fc->devices */
425 struct list_head entry;
426};
427
428/**
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700429 * A Fuse connection.
430 *
431 * This structure is created, when the filesystem is mounted, and is
432 * destroyed, when the client device is closed and the filesystem is
433 * unmounted.
434 */
435struct fuse_conn {
Miklos Szeredid7133112006-04-10 22:54:55 -0700436 /** Lock protecting accessess to members of this structure */
437 spinlock_t lock;
438
Miklos Szeredibafa9652006-06-25 05:48:51 -0700439 /** Refcount */
Elena Reshetova095fc40a2017-03-03 11:04:05 +0200440 refcount_t count;
Miklos Szeredibafa9652006-06-25 05:48:51 -0700441
Miklos Szeredic36960462015-07-01 16:26:09 +0200442 /** Number of fuse_dev's */
443 atomic_t dev_count;
444
Al Virodd3e2c552013-10-03 21:21:39 -0400445 struct rcu_head rcu;
446
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700447 /** The user id for this mount */
Eric W. Biederman499dcf22012-02-07 16:26:03 -0800448 kuid_t user_id;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700449
Miklos Szeredi87729a52005-09-09 13:10:34 -0700450 /** The group id for this mount */
Eric W. Biederman499dcf22012-02-07 16:26:03 -0800451 kgid_t group_id;
Miklos Szeredi87729a52005-09-09 13:10:34 -0700452
Seth Forshee0b6e9ea2014-07-02 16:29:19 -0500453 /** The pid namespace for this mount */
454 struct pid_namespace *pid_ns;
455
Eric W. Biederman8cb08322018-02-21 11:18:07 -0600456 /** The user namespace for this mount */
457 struct user_namespace *user_ns;
458
Miklos Szeredidb50b962005-09-09 13:10:33 -0700459 /** Maximum read size */
460 unsigned max_read;
461
Miklos Szeredi413ef8c2005-09-09 13:10:35 -0700462 /** Maximum write size */
463 unsigned max_write;
464
Constantine Shulyupin5da784c2018-09-06 15:37:06 +0300465 /** Maxmum number of pages that can be used in a single request */
466 unsigned int max_pages;
467
Miklos Szeredif88996a2015-07-01 16:26:01 +0200468 /** Input queue */
469 struct fuse_iqueue iq;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700470
Tejun Heoacf99432008-11-26 12:03:55 +0100471 /** The next unique kernel file handle */
Miklos Szeredi75126f52019-01-24 10:40:17 +0100472 atomic64_t khctr;
Tejun Heoacf99432008-11-26 12:03:55 +0100473
Tejun Heo95668a62008-11-26 12:03:55 +0100474 /** rbtree of fuse_files waiting for poll events indexed by ph */
475 struct rb_root polled_files;
476
Csaba Henk7a6d3c82009-07-01 17:28:41 -0700477 /** Maximum number of outstanding background requests */
478 unsigned max_background;
479
480 /** Number of background requests at which congestion starts */
481 unsigned congestion_threshold;
482
Miklos Szeredi08a53cd2006-04-10 22:54:59 -0700483 /** Number of requests currently in the background */
484 unsigned num_background;
485
Miklos Szeredid12def12008-02-06 01:38:39 -0800486 /** Number of background requests currently queued for userspace */
487 unsigned active_background;
488
489 /** The list of background requests set aside for later queuing */
490 struct list_head bg_queue;
491
Kirill Tkhaiae2dffa2018-08-27 18:29:46 +0300492 /** Protects: max_background, congestion_threshold, num_background,
493 * active_background, bg_queue, blocked */
494 spinlock_t bg_lock;
495
Maxim Patlasov796523fb2013-03-21 18:02:15 +0400496 /** Flag indicating that INIT reply has been received. Allocating
497 * any fuse request will be suspended until the flag is set */
498 int initialized;
499
Miklos Szeredi08a53cd2006-04-10 22:54:59 -0700500 /** Flag indicating if connection is blocked. This will be
501 the case before the INIT reply is received, and if there
502 are too many outstading backgrounds requests */
503 int blocked;
504
505 /** waitq for blocked connection */
506 wait_queue_head_t blocked_waitq;
507
Miklos Szeredi69a53bf2006-01-16 22:14:41 -0800508 /** Connection established, cleared on umount, connection
509 abort and device release */
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800510 unsigned connected;
Miklos Szeredi1e9a4ed2005-09-09 13:10:31 -0700511
Szymon Lukasz3b7008b2017-11-09 21:23:35 +0100512 /** Connection aborted via sysfs */
513 bool aborted;
514
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800515 /** Connection failed (version mismatch). Cannot race with
516 setting other bitfields since it is only set once in INIT
517 reply, before any other request, and never cleared */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100518 unsigned conn_error:1;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700519
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800520 /** Connection successful. Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100521 unsigned conn_init:1;
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800522
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800523 /** Do readpages asynchronously? Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100524 unsigned async_read:1;
Miklos Szeredi9cd68452006-02-01 03:04:40 -0800525
Szymon Lukasz3b7008b2017-11-09 21:23:35 +0100526 /** Return an unique read error after abort. Only set in INIT */
527 unsigned abort_err:1;
528
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700529 /** Do not send separate SETATTR request before open(O_TRUNC) */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100530 unsigned atomic_o_trunc:1;
Miklos Szeredi6ff958e2007-10-18 03:07:02 -0700531
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700532 /** Filesystem supports NFS exporting. Only set in INIT */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100533 unsigned export_support:1;
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700534
Pavel Emelyanovd5cd66c2013-10-10 17:10:30 +0400535 /** write-back cache policy (default is write-through) */
536 unsigned writeback_cache:1;
537
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200538 /** allow parallel lookups and readdir (default is serialized) */
539 unsigned parallel_dirops:1;
540
Miklos Szeredi5e940c12016-10-01 07:32:32 +0200541 /** handle fs handles killing suid/sgid/cap on write/chown/trunc */
542 unsigned handle_killpriv:1;
543
Dan Schatzberg5571f1e2018-10-11 08:17:00 -0700544 /** cache READLINK responses in page cache */
545 unsigned cache_symlinks:1;
546
Miklos Szeredi095da6c2006-01-16 22:14:52 -0800547 /*
548 * The following bitfields are only for optimization purposes
549 * and hence races in setting them will not cause malfunction
550 */
551
Andrew Gallagher7678ac52013-11-05 16:05:52 +0100552 /** Is open/release not implemented by fs? */
553 unsigned no_open:1;
554
Chad Austind9a9ea92019-01-07 16:53:17 -0800555 /** Is opendir/releasedir not implemented by fs? */
556 unsigned no_opendir:1;
557
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700558 /** Is fsync not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100559 unsigned no_fsync:1;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700560
Miklos Szeredi82547982005-09-09 13:10:38 -0700561 /** Is fsyncdir not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100562 unsigned no_fsyncdir:1;
Miklos Szeredi82547982005-09-09 13:10:38 -0700563
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700564 /** Is flush not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100565 unsigned no_flush:1;
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700566
Miklos Szeredi92a87802005-09-09 13:10:31 -0700567 /** Is setxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100568 unsigned no_setxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700569
570 /** Is getxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100571 unsigned no_getxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700572
573 /** Is listxattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100574 unsigned no_listxattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700575
576 /** Is removexattr not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100577 unsigned no_removexattr:1;
Miklos Szeredi92a87802005-09-09 13:10:31 -0700578
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200579 /** Are posix file locking primitives not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100580 unsigned no_lock:1;
Miklos Szeredi71421252006-06-25 05:48:52 -0700581
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800582 /** Is access not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100583 unsigned no_access:1;
Miklos Szeredi31d40d72005-11-07 00:59:50 -0800584
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800585 /** Is create not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100586 unsigned no_create:1;
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800587
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700588 /** Is interrupt not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100589 unsigned no_interrupt:1;
Miklos Szeredia4d27e72006-06-25 05:48:54 -0700590
Miklos Szeredib2d22722006-12-06 20:35:51 -0800591 /** Is bmap not implemented by fs? */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100592 unsigned no_bmap:1;
Miklos Szeredib2d22722006-12-06 20:35:51 -0800593
Tejun Heo95668a62008-11-26 12:03:55 +0100594 /** Is poll not implemented by fs? */
595 unsigned no_poll:1;
596
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700597 /** Do multi-page cached writes */
Miklos Szeredi1729a162008-11-26 12:03:54 +0100598 unsigned big_writes:1;
Miklos Szeredi78bb6cb2008-05-12 14:02:32 -0700599
Miklos Szeredie0a43dd2009-06-30 20:12:23 +0200600 /** Don't apply umask to creation modes */
601 unsigned dont_mask:1;
602
Miklos Szeredi37fb3a32011-08-08 16:08:08 +0200603 /** Are BSD file locking primitives not implemented by fs? */
604 unsigned no_flock:1;
605
Miklos Szeredi519c6042012-04-26 10:56:36 +0200606 /** Is fallocate not implemented by fs? */
607 unsigned no_fallocate:1;
608
Miklos Szeredi1560c972014-04-28 16:43:44 +0200609 /** Is rename with flags implemented by fs? */
610 unsigned no_rename2:1;
611
Brian Foster72d0d242012-07-16 15:23:48 -0400612 /** Use enhanced/automatic page cache invalidation. */
613 unsigned auto_inval_data:1;
614
Kirill Smelkovad2ba642019-03-27 11:14:15 +0000615 /** Filesystem is fully reponsible for page cache invalidation. */
616 unsigned explicit_inval_data:1;
617
Eric Wong634734b2013-02-06 22:29:01 +0000618 /** Does the filesystem support readdirplus? */
Anand V. Avati0b05b182012-08-19 08:53:23 -0400619 unsigned do_readdirplus:1;
620
Eric Wong634734b2013-02-06 22:29:01 +0000621 /** Does the filesystem want adaptive readdirplus? */
622 unsigned readdirplus_auto:1;
623
Miklos Szeredi60b9df72013-05-01 14:37:21 +0200624 /** Does the filesystem support asynchronous direct-IO submission? */
625 unsigned async_dio:1;
626
Ravishankar N0b5da8d2015-06-30 23:40:22 +0530627 /** Is lseek not implemented by fs? */
628 unsigned no_lseek:1;
629
Seth Forshee60bcc882016-08-29 08:46:37 -0500630 /** Does the filesystem support posix acls? */
631 unsigned posix_acl:1;
632
Miklos Szeredi29433a22016-10-01 07:32:32 +0200633 /** Check permissions based on the file mode or not? */
634 unsigned default_permissions:1;
635
636 /** Allow other than the mounter user to access the filesystem ? */
637 unsigned allow_other:1;
638
Niels de Vos88bc7d52018-08-21 14:36:31 +0200639 /** Does the filesystem support copy_file_range? */
640 unsigned no_copy_file_range:1;
641
Miklos Szeredi1ccd1ea2019-09-10 15:04:09 +0200642 /* Send DESTROY request */
643 unsigned int destroy:1;
644
Miklos Szeredi0cd5b882006-01-16 22:14:38 -0800645 /** The number of requests waiting for completion */
646 atomic_t num_waiting;
647
Miklos Szeredi45714d62006-01-06 00:19:36 -0800648 /** Negotiated minor version */
649 unsigned minor;
650
Miklos Szeredibafa9652006-06-25 05:48:51 -0700651 /** Entry on the fuse_conn_list */
652 struct list_head entry;
653
Miklos Szeredib6f2fcb2008-04-30 00:54:34 -0700654 /** Device ID from super block */
655 dev_t dev;
Miklos Szeredibafa9652006-06-25 05:48:51 -0700656
657 /** Dentries in the control filesystem */
658 struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES];
659
660 /** number of dentries used in the above array */
661 int ctl_ndents;
Jeff Dike385a17b2006-04-10 22:54:52 -0700662
Miklos Szeredi9c8ef562006-06-25 05:48:55 -0700663 /** Key for lock owner ID scrambling */
664 u32 scramble_key[4];
Miklos Szeredi0ec7ca42006-12-06 20:35:52 -0800665
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700666 /** Version counter for attribute changes */
Kirill Tkhai4510d862018-11-09 13:33:17 +0300667 atomic64_t attr_version;
Tejun Heo43901aa2008-11-26 12:03:56 +0100668
669 /** Called on final put */
670 void (*release)(struct fuse_conn *);
John Muir3b463ae2009-05-31 11:13:57 -0400671
672 /** Super block for this connection. */
673 struct super_block *sb;
674
675 /** Read/write semaphore to hold when accessing sb. */
676 struct rw_semaphore killsb;
Miklos Szeredicc080e92015-07-01 16:26:08 +0200677
678 /** List of device instances belonging to this connection */
679 struct list_head devices;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700680};
681
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700682static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
683{
Miklos Szeredi6383bda2006-01-16 22:14:29 -0800684 return sb->s_fs_info;
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700685}
686
687static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
688{
689 return get_fuse_conn_super(inode->i_sb);
690}
691
692static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
693{
694 return container_of(inode, struct fuse_inode, inode);
695}
696
697static inline u64 get_node_id(struct inode *inode)
698{
699 return get_fuse_inode(inode)->nodeid;
700}
701
Miklos Szeredid123d8e2018-09-28 16:43:23 +0200702static inline int invalid_nodeid(u64 nodeid)
703{
704 return !nodeid || nodeid == FUSE_ROOT_ID;
705}
706
Kirill Tkhai4510d862018-11-09 13:33:17 +0300707static inline u64 fuse_get_attr_version(struct fuse_conn *fc)
708{
709 return atomic64_read(&fc->attr_version);
710}
711
Miklos Szeredi334f4852005-09-09 13:10:27 -0700712/** Device operations */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800713extern const struct file_operations fuse_dev_operations;
Miklos Szeredi334f4852005-09-09 13:10:27 -0700714
Al Viro42695902009-02-20 05:59:13 +0000715extern const struct dentry_operations fuse_dentry_operations;
Miklos Szeredi0ce267f2016-10-18 15:36:48 +0200716extern const struct dentry_operations fuse_root_dentry_operations;
Miklos Szeredidbd561d2008-07-25 01:49:00 -0700717
Miklos Szeredid8a5ba42005-09-09 13:10:26 -0700718/**
John Muir3b463ae2009-05-31 11:13:57 -0400719 * Inode to nodeid comparison.
720 */
721int fuse_inode_eq(struct inode *inode, void *_nodeidp);
722
723/**
Miklos Szeredie5e55582005-09-09 13:10:28 -0700724 * Get a filled in inode
725 */
Miklos Szeredib48badf2008-04-30 00:54:44 -0700726struct inode *fuse_iget(struct super_block *sb, u64 nodeid,
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700727 int generation, struct fuse_attr *attr,
728 u64 attr_valid, u64 attr_version);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700729
Al Viro13983d02016-07-20 22:34:44 -0400730int fuse_lookup_name(struct super_block *sb, u64 nodeid, const struct qstr *name,
Miklos Szeredi33670fa2008-07-25 01:49:02 -0700731 struct fuse_entry_out *outarg, struct inode **inode);
732
Miklos Szeredie5e55582005-09-09 13:10:28 -0700733/**
734 * Send FORGET command
735 */
Miklos Szeredi07e77dc2010-12-07 20:16:56 +0100736void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget,
737 u64 nodeid, u64 nlookup);
738
739struct fuse_forget_link *fuse_alloc_forget(void);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700740
Miklos Szeredi43f50982019-09-10 15:04:10 +0200741/*
Miklos Szeredi361b1eb52006-01-16 22:14:45 -0800742 * Initialize READ or READDIR request
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700743 */
Miklos Szeredi43f50982019-09-10 15:04:10 +0200744struct fuse_io_args {
745 union {
746 struct {
747 struct fuse_read_in in;
748 u64 attr_ver;
749 } read;
750 struct {
751 struct fuse_write_in in;
752 struct fuse_write_out out;
753 } write;
754 };
755 struct fuse_args_pages ap;
756 struct fuse_io_priv *io;
757 struct fuse_file *ff;
758};
759
760void fuse_read_args_fill(struct fuse_io_args *ia, struct file *file, loff_t pos,
761 size_t count, int opcode);
762
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700763
764/**
765 * Send OPEN or OPENDIR request
766 */
Miklos Szeredi91fe96b2009-04-28 16:56:37 +0200767int fuse_open_common(struct inode *inode, struct file *file, bool isdir);
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700768
Tejun Heoacf99432008-11-26 12:03:55 +0100769struct fuse_file *fuse_file_alloc(struct fuse_conn *fc);
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800770void fuse_file_free(struct fuse_file *ff);
Miklos Szeredic7b71432009-04-28 16:56:37 +0200771void fuse_finish_open(struct inode *inode, struct file *file);
Miklos Szeredifd72faa2005-11-07 00:59:51 -0800772
Kirill Tkhaiebf84d02018-11-09 13:33:11 +0300773void fuse_sync_release(struct fuse_inode *fi, struct fuse_file *ff, int flags);
Miklos Szeredic756e0a2007-10-16 23:31:00 -0700774
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700775/**
776 * Send RELEASE or RELEASEDIR request
777 */
Chad Austin2e64ff12018-12-10 10:54:52 -0800778void fuse_release_common(struct file *file, bool isdir);
Miklos Szeredi04730fe2005-09-09 13:10:36 -0700779
780/**
Miklos Szeredi82547982005-09-09 13:10:38 -0700781 * Send FSYNC or FSYNCDIR request
782 */
Josef Bacik02c24a82011-07-16 20:44:56 -0400783int fuse_fsync_common(struct file *file, loff_t start, loff_t end,
Miklos Szeredia9c2d1e2018-12-03 10:14:43 +0100784 int datasync, int opcode);
Miklos Szeredi82547982005-09-09 13:10:38 -0700785
786/**
Tejun Heo95668a62008-11-26 12:03:55 +0100787 * Notify poll wakeup
788 */
789int fuse_notify_poll_wakeup(struct fuse_conn *fc,
790 struct fuse_notify_poll_wakeup_out *outarg);
791
792/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800793 * Initialize file operations on a regular file
Miklos Szeredib6aeade2005-09-09 13:10:30 -0700794 */
795void fuse_init_file_inode(struct inode *inode);
796
797/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800798 * Initialize inode operations on regular files and special files
Miklos Szeredie5e55582005-09-09 13:10:28 -0700799 */
800void fuse_init_common(struct inode *inode);
801
802/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800803 * Initialize inode and file operations on a directory
Miklos Szeredie5e55582005-09-09 13:10:28 -0700804 */
805void fuse_init_dir(struct inode *inode);
806
807/**
Miklos Szeredi17793812005-10-30 15:02:51 -0800808 * Initialize inode operations on a symlink
Miklos Szeredie5e55582005-09-09 13:10:28 -0700809 */
810void fuse_init_symlink(struct inode *inode);
811
812/**
813 * Change attributes of an inode
814 */
Miklos Szeredi1fb69e72007-10-18 03:06:58 -0700815void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr,
816 u64 attr_valid, u64 attr_version);
Miklos Szeredie5e55582005-09-09 13:10:28 -0700817
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700818void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr,
819 u64 attr_valid);
820
Miklos Szeredie5e55582005-09-09 13:10:28 -0700821/**
Miklos Szeredi334f4852005-09-09 13:10:27 -0700822 * Initialize the client device
823 */
824int fuse_dev_init(void);
825
826/**
827 * Cleanup the client device
828 */
829void fuse_dev_cleanup(void);
830
Miklos Szeredibafa9652006-06-25 05:48:51 -0700831int fuse_ctl_init(void);
Fabian Frederick7736e8c2014-04-23 18:14:42 +0200832void __exit fuse_ctl_cleanup(void);
Miklos Szeredibafa9652006-06-25 05:48:51 -0700833
Miklos Szeredi334f4852005-09-09 13:10:27 -0700834/**
Miklos Szeredi70781872014-12-12 09:49:05 +0100835 * Simple request sending that does request allocation and freeing
836 */
837ssize_t fuse_simple_request(struct fuse_conn *fc, struct fuse_args *args);
Miklos Szeredi12597282019-09-10 15:04:10 +0200838int fuse_simple_background(struct fuse_conn *fc, struct fuse_args *args,
839 gfp_t gfp_flags);
Miklos Szeredi70781872014-12-12 09:49:05 +0100840
Miklos Szeredi5a5fb1e2006-04-26 10:48:55 +0200841/* Abort all requests */
Miklos Szeredieb98e3bd2019-01-24 10:40:16 +0100842void fuse_abort_conn(struct fuse_conn *fc);
Miklos Szeredib8f95e52018-07-26 16:13:11 +0200843void fuse_wait_aborted(struct fuse_conn *fc);
Miklos Szeredi69a53bf2006-01-16 22:14:41 -0800844
Miklos Szeredi1e9a4ed2005-09-09 13:10:31 -0700845/**
Miklos Szeredie5e55582005-09-09 13:10:28 -0700846 * Invalidate inode attributes
847 */
848void fuse_invalidate_attr(struct inode *inode);
Miklos Szeredibafa9652006-06-25 05:48:51 -0700849
Miklos Szeredidbd561d2008-07-25 01:49:00 -0700850void fuse_invalidate_entry_cache(struct dentry *entry);
851
Andrew Gallagher451418f2013-11-05 03:55:43 -0800852void fuse_invalidate_atime(struct inode *inode);
853
Miklos Szeredid123d8e2018-09-28 16:43:23 +0200854u64 entry_attr_timeout(struct fuse_entry_out *o);
855void fuse_change_entry_timeout(struct dentry *entry, struct fuse_entry_out *o);
856
Miklos Szeredibafa9652006-06-25 05:48:51 -0700857/**
858 * Acquire reference to fuse_conn
859 */
860struct fuse_conn *fuse_conn_get(struct fuse_conn *fc);
861
862/**
Tejun Heo0d179aa2008-11-26 12:03:55 +0100863 * Initialize fuse_conn
864 */
Eric W. Biederman8cb08322018-02-21 11:18:07 -0600865void fuse_conn_init(struct fuse_conn *fc, struct user_namespace *user_ns);
Tejun Heo0d179aa2008-11-26 12:03:55 +0100866
867/**
Miklos Szeredibafa9652006-06-25 05:48:51 -0700868 * Release reference to fuse_conn
869 */
870void fuse_conn_put(struct fuse_conn *fc);
871
Miklos Szeredicc080e92015-07-01 16:26:08 +0200872struct fuse_dev *fuse_dev_alloc(struct fuse_conn *fc);
873void fuse_dev_free(struct fuse_dev *fud);
874
Miklos Szeredibafa9652006-06-25 05:48:51 -0700875/**
876 * Add connection to control filesystem
877 */
878int fuse_ctl_add_conn(struct fuse_conn *fc);
879
880/**
881 * Remove connection from control filesystem
882 */
883void fuse_ctl_remove_conn(struct fuse_conn *fc);
Timo Savolaa5bfffac2007-04-08 16:04:00 -0700884
885/**
886 * Is file type valid?
887 */
888int fuse_valid_type(int m);
Miklos Szeredie57ac682007-10-18 03:06:58 -0700889
890/**
Anatol Pomozovc2132c12013-01-14 22:30:00 -0800891 * Is current process allowed to perform filesystem operation?
Miklos Szeredie57ac682007-10-18 03:06:58 -0700892 */
Anatol Pomozovc2132c12013-01-14 22:30:00 -0800893int fuse_allow_current_process(struct fuse_conn *fc);
Miklos Szeredif3332112007-10-18 03:07:04 -0700894
895u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id);
Miklos Szeredibcb4be82007-11-28 16:21:59 -0800896
Seth Forshee703c7362016-08-29 08:46:36 -0500897void fuse_update_ctime(struct inode *inode);
898
Miklos Szeredi5b97eea2017-09-12 16:57:54 +0200899int fuse_update_attributes(struct inode *inode, struct file *file);
Miklos Szeredi3be5a522008-04-30 00:54:41 -0700900
901void fuse_flush_writepages(struct inode *inode);
902
903void fuse_set_nowrite(struct inode *inode);
904void fuse_release_nowrite(struct inode *inode);
Miklos Szeredi5c5c5e52008-04-30 00:54:43 -0700905
John Muir3b463ae2009-05-31 11:13:57 -0400906/**
907 * File-system tells the kernel to invalidate cache for the given node id.
908 */
909int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid,
910 loff_t offset, loff_t len);
911
912/**
913 * File-system tells the kernel to invalidate parent attributes and
914 * the dentry matching parent/name.
John Muir451d0f52011-12-06 21:50:06 +0100915 *
916 * If the child_nodeid is non-zero and:
917 * - matches the inode number for the dentry matching parent/name,
918 * - is not a mount point
919 * - is a file or oan empty directory
920 * then the dentry is unhashed (d_delete()).
John Muir3b463ae2009-05-31 11:13:57 -0400921 */
922int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid,
John Muir451d0f52011-12-06 21:50:06 +0100923 u64 child_nodeid, struct qstr *name);
John Muir3b463ae2009-05-31 11:13:57 -0400924
Tejun Heo08cbf542009-04-14 10:54:53 +0900925int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file,
926 bool isdir);
Pavel Emelyanovea8cd332013-10-10 17:12:05 +0400927
928/**
929 * fuse_direct_io() flags
930 */
931
932/** If set, it is WRITE; otherwise - READ */
933#define FUSE_DIO_WRITE (1 << 0)
934
935/** CUSE pass fuse_direct_io() a file which f_mapping->host is not from FUSE */
936#define FUSE_DIO_CUSE (1 << 1)
937
Al Virod22a9432014-03-16 15:50:47 -0400938ssize_t fuse_direct_io(struct fuse_io_priv *io, struct iov_iter *iter,
939 loff_t *ppos, int flags);
Tejun Heo08cbf542009-04-14 10:54:53 +0900940long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
941 unsigned int flags);
Miklos Szeredib18da0c2011-12-13 11:58:49 +0100942long fuse_ioctl_common(struct file *file, unsigned int cmd,
943 unsigned long arg, unsigned int flags);
Al Viro076ccb72017-07-03 01:02:18 -0400944__poll_t fuse_file_poll(struct file *file, poll_table *wait);
Tejun Heo08cbf542009-04-14 10:54:53 +0900945int fuse_dev_release(struct inode *inode, struct file *file);
946
Maxim Patlasovb0aa7602013-12-26 19:51:11 +0400947bool fuse_write_update_size(struct inode *inode, loff_t pos);
948
Maxim Patlasovab9e13f2014-04-28 14:19:24 +0200949int fuse_flush_times(struct inode *inode, struct fuse_file *ff);
Miklos Szeredi1e18bda2014-04-28 14:19:23 +0200950int fuse_write_inode(struct inode *inode, struct writeback_control *wbc);
Miklos Szeredia1d75f22010-07-12 14:41:40 +0200951
Jan Kara62490332016-05-26 17:12:41 +0200952int fuse_do_setattr(struct dentry *dentry, struct iattr *attr,
Maxim Patlasovefb9fa92012-12-18 14:05:08 +0400953 struct file *file);
954
Miklos Szeredi9759bd512015-01-06 10:45:35 +0100955void fuse_set_initialized(struct fuse_conn *fc);
956
Miklos Szeredi63576c12018-07-26 16:13:11 +0200957void fuse_unlock_inode(struct inode *inode, bool locked);
958bool fuse_lock_inode(struct inode *inode);
Miklos Szeredi5c672ab2016-06-30 13:10:49 +0200959
Seth Forshee60bcc882016-08-29 08:46:37 -0500960int fuse_setxattr(struct inode *inode, const char *name, const void *value,
961 size_t size, int flags);
962ssize_t fuse_getxattr(struct inode *inode, const char *name, void *value,
963 size_t size);
Seth Forshee703c7362016-08-29 08:46:36 -0500964ssize_t fuse_listxattr(struct dentry *entry, char *list, size_t size);
Seth Forshee60bcc882016-08-29 08:46:37 -0500965int fuse_removexattr(struct inode *inode, const char *name);
Seth Forshee703c7362016-08-29 08:46:36 -0500966extern const struct xattr_handler *fuse_xattr_handlers[];
Seth Forshee60bcc882016-08-29 08:46:37 -0500967extern const struct xattr_handler *fuse_acl_xattr_handlers[];
Eric W. Biedermane45b2542018-05-04 11:47:28 -0500968extern const struct xattr_handler *fuse_no_acl_xattr_handlers[];
Seth Forshee60bcc882016-08-29 08:46:37 -0500969
970struct posix_acl;
971struct posix_acl *fuse_get_acl(struct inode *inode, int type);
972int fuse_set_acl(struct inode *inode, struct posix_acl *acl, int type);
Seth Forshee703c7362016-08-29 08:46:36 -0500973
Miklos Szeredid123d8e2018-09-28 16:43:23 +0200974
975/* readdir.c */
976int fuse_readdir(struct file *file, struct dir_context *ctx);
977
Tejun Heo29d434b2008-10-16 16:08:57 +0200978#endif /* _FS_FUSE_I_H */