Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 1 | /* |
| 2 | FUSE: Filesystem in Userspace |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 3 | Copyright (C) 2001-2008 Miklos Szeredi <miklos@szeredi.hu> |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 4 | |
| 5 | This program can be distributed under the terms of the GNU GPL. |
| 6 | See the file COPYING. |
| 7 | */ |
| 8 | |
Tejun Heo | 29d434b | 2008-10-16 16:08:57 +0200 | [diff] [blame] | 9 | #ifndef _FS_FUSE_I_H |
| 10 | #define _FS_FUSE_I_H |
| 11 | |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 12 | #include <linux/fuse.h> |
| 13 | #include <linux/fs.h> |
Miklos Szeredi | 51eb01e | 2006-06-25 05:48:50 -0700 | [diff] [blame] | 14 | #include <linux/mount.h> |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 15 | #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 Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 20 | #include <linux/mutex.h> |
Miklos Szeredi | 3be5a52 | 2008-04-30 00:54:41 -0700 | [diff] [blame] | 21 | #include <linux/rwsem.h> |
Tejun Heo | 95668a6 | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 22 | #include <linux/rbtree.h> |
| 23 | #include <linux/poll.h> |
Miklos Szeredi | 5a18ec1 | 2011-02-25 14:44:58 +0100 | [diff] [blame] | 24 | #include <linux/workqueue.h> |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 25 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 26 | /** Max number of pages that can be used in a single read request */ |
| 27 | #define FUSE_MAX_PAGES_PER_REQ 32 |
| 28 | |
Miklos Szeredi | 3be5a52 | 2008-04-30 00:54:41 -0700 | [diff] [blame] | 29 | /** Bias for fi->writectr, meaning new writepages must not be sent */ |
| 30 | #define FUSE_NOWRITE INT_MIN |
| 31 | |
Miklos Szeredi | 1d3d752 | 2006-01-06 00:19:40 -0800 | [diff] [blame] | 32 | /** It could be as large as PATH_MAX, but would that have any uses? */ |
| 33 | #define FUSE_NAME_MAX 1024 |
| 34 | |
Miklos Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 35 | /** Number of dentries for each connection in the control filesystem */ |
Csaba Henk | 79a9d99 | 2009-08-26 19:18:24 +0200 | [diff] [blame] | 36 | #define FUSE_CTL_NUM_DENTRIES 5 |
Miklos Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 37 | |
Miklos Szeredi | 1e9a4ed | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 38 | /** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem |
| 39 | module will check permissions based on the file mode. Otherwise no |
| 40 | permission checking is done in the kernel */ |
| 41 | #define FUSE_DEFAULT_PERMISSIONS (1 << 0) |
| 42 | |
| 43 | /** If the FUSE_ALLOW_OTHER flag is given, then not only the user |
| 44 | doing the mount will be allowed to access the filesystem */ |
| 45 | #define FUSE_ALLOW_OTHER (1 << 1) |
| 46 | |
Maxim Patlasov | 4250c06 | 2012-10-26 19:48:07 +0400 | [diff] [blame] | 47 | /** Number of page pointers embedded in fuse_req */ |
| 48 | #define FUSE_REQ_INLINE_PAGES 1 |
| 49 | |
Miklos Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 50 | /** List of active connections */ |
| 51 | extern struct list_head fuse_conn_list; |
| 52 | |
| 53 | /** Global mutex protecting fuse_conn_list and the control filesystem */ |
| 54 | extern struct mutex fuse_mutex; |
Miklos Szeredi | 413ef8c | 2005-09-09 13:10:35 -0700 | [diff] [blame] | 55 | |
Csaba Henk | 79a9d99 | 2009-08-26 19:18:24 +0200 | [diff] [blame] | 56 | /** Module parameters */ |
| 57 | extern unsigned max_user_bgreq; |
| 58 | extern unsigned max_user_congthresh; |
| 59 | |
Miklos Szeredi | 07e77dc | 2010-12-07 20:16:56 +0100 | [diff] [blame] | 60 | /* One forget request */ |
| 61 | struct fuse_forget_link { |
Miklos Szeredi | 02c048b | 2010-12-07 20:16:56 +0100 | [diff] [blame] | 62 | struct fuse_forget_one forget_one; |
Miklos Szeredi | 07e77dc | 2010-12-07 20:16:56 +0100 | [diff] [blame] | 63 | struct fuse_forget_link *next; |
| 64 | }; |
| 65 | |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 66 | /** FUSE inode */ |
| 67 | struct 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 Szeredi | 9e6268d | 2005-09-09 13:10:29 -0700 | [diff] [blame] | 75 | /** Number of lookups on this inode */ |
| 76 | u64 nlookup; |
| 77 | |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 78 | /** The request used for sending the FORGET message */ |
Miklos Szeredi | 07e77dc | 2010-12-07 20:16:56 +0100 | [diff] [blame] | 79 | struct fuse_forget_link *forget; |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 80 | |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 81 | /** Time in jiffies until the file attributes are valid */ |
Miklos Szeredi | 0a0898c | 2006-07-30 03:04:10 -0700 | [diff] [blame] | 82 | u64 i_time; |
Miklos Szeredi | ebc14c4 | 2007-10-16 23:31:03 -0700 | [diff] [blame] | 83 | |
| 84 | /** The sticky bit in inode->i_mode may have been removed, so |
| 85 | preserve the original mode */ |
Al Viro | 541af6a | 2011-07-26 03:17:33 -0400 | [diff] [blame] | 86 | umode_t orig_i_mode; |
Miklos Szeredi | 1fb69e7 | 2007-10-18 03:06:58 -0700 | [diff] [blame] | 87 | |
Pavel Shilovsky | 45c72cd | 2012-05-10 19:49:38 +0400 | [diff] [blame] | 88 | /** 64 bit inode number */ |
| 89 | u64 orig_ino; |
| 90 | |
Miklos Szeredi | 1fb69e7 | 2007-10-18 03:06:58 -0700 | [diff] [blame] | 91 | /** Version of last attribute change */ |
| 92 | u64 attr_version; |
Miklos Szeredi | 93a8c3c | 2007-10-18 03:07:03 -0700 | [diff] [blame] | 93 | |
| 94 | /** Files usable in writepage. Protected by fc->lock */ |
| 95 | struct list_head write_files; |
Miklos Szeredi | 3be5a52 | 2008-04-30 00:54:41 -0700 | [diff] [blame] | 96 | |
| 97 | /** Writepages pending on truncate or fsync */ |
| 98 | struct list_head queued_writes; |
| 99 | |
| 100 | /** Number of sent writes, a negative bias (FUSE_NOWRITE) |
| 101 | * means more writes are blocked */ |
| 102 | int writectr; |
| 103 | |
| 104 | /** Waitq for writepage completion */ |
| 105 | wait_queue_head_t page_waitq; |
| 106 | |
| 107 | /** List of writepage requestst (pending or sent) */ |
| 108 | struct list_head writepages; |
Feng Shuo | 4582a4a | 2013-01-15 11:23:28 +0800 | [diff] [blame] | 109 | |
| 110 | /** Miscellaneous bits describing inode state */ |
| 111 | unsigned long state; |
| 112 | }; |
| 113 | |
| 114 | /** FUSE inode state bits */ |
| 115 | enum { |
| 116 | /** Advise readdirplus */ |
| 117 | FUSE_I_ADVISE_RDPLUS, |
Miklos Szeredi | 6314efe | 2013-10-01 16:41:22 +0200 | [diff] [blame] | 118 | /** Initialized with readdirplus */ |
| 119 | FUSE_I_INIT_RDPLUS, |
Maxim Patlasov | 06a7c3c | 2013-08-30 17:06:04 +0400 | [diff] [blame] | 120 | /** An operation changing file size is in progress */ |
| 121 | FUSE_I_SIZE_UNSTABLE, |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 122 | }; |
| 123 | |
Miklos Szeredi | da5e471 | 2009-04-28 16:56:36 +0200 | [diff] [blame] | 124 | struct fuse_conn; |
| 125 | |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 126 | /** FUSE specific file data */ |
| 127 | struct fuse_file { |
Miklos Szeredi | da5e471 | 2009-04-28 16:56:36 +0200 | [diff] [blame] | 128 | /** Fuse connection for this file */ |
| 129 | struct fuse_conn *fc; |
| 130 | |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 131 | /** Request reserved for flush and release */ |
Miklos Szeredi | 33649c9 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 132 | struct fuse_req *reserved_req; |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 133 | |
Tejun Heo | acf9943 | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 134 | /** Kernel file handle guaranteed to be unique */ |
| 135 | u64 kh; |
| 136 | |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 137 | /** File handle used by userspace */ |
| 138 | u64 fh; |
Miklos Szeredi | c756e0a | 2007-10-16 23:31:00 -0700 | [diff] [blame] | 139 | |
Miklos Szeredi | da5e471 | 2009-04-28 16:56:36 +0200 | [diff] [blame] | 140 | /** Node id of this file */ |
| 141 | u64 nodeid; |
| 142 | |
Miklos Szeredi | c756e0a | 2007-10-16 23:31:00 -0700 | [diff] [blame] | 143 | /** Refcount */ |
| 144 | atomic_t count; |
Miklos Szeredi | 93a8c3c | 2007-10-18 03:07:03 -0700 | [diff] [blame] | 145 | |
Miklos Szeredi | c7b7143 | 2009-04-28 16:56:37 +0200 | [diff] [blame] | 146 | /** FOPEN_* flags returned by open */ |
| 147 | u32 open_flags; |
| 148 | |
Miklos Szeredi | 93a8c3c | 2007-10-18 03:07:03 -0700 | [diff] [blame] | 149 | /** Entry on inode's write_files list */ |
| 150 | struct list_head write_entry; |
Tejun Heo | 95668a6 | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 151 | |
| 152 | /** RB node to be linked on fuse_conn->polled_files */ |
| 153 | struct rb_node polled_node; |
| 154 | |
| 155 | /** Wait queue head for poll */ |
| 156 | wait_queue_head_t poll_wait; |
Miklos Szeredi | 37fb3a3 | 2011-08-08 16:08:08 +0200 | [diff] [blame] | 157 | |
| 158 | /** Has flock been performed on this file? */ |
| 159 | bool flock:1; |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 160 | }; |
| 161 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 162 | /** One input argument of a request */ |
| 163 | struct fuse_in_arg { |
| 164 | unsigned size; |
| 165 | const void *value; |
| 166 | }; |
| 167 | |
| 168 | /** The request input */ |
| 169 | struct fuse_in { |
| 170 | /** The request header */ |
| 171 | struct fuse_in_header h; |
| 172 | |
| 173 | /** True if the data for the last argument is in req->pages */ |
| 174 | unsigned argpages:1; |
| 175 | |
| 176 | /** Number of arguments */ |
| 177 | unsigned numargs; |
| 178 | |
| 179 | /** Array of arguments */ |
| 180 | struct fuse_in_arg args[3]; |
| 181 | }; |
| 182 | |
| 183 | /** One output argument of a request */ |
| 184 | struct fuse_arg { |
| 185 | unsigned size; |
| 186 | void *value; |
| 187 | }; |
| 188 | |
| 189 | /** The request output */ |
| 190 | struct fuse_out { |
| 191 | /** Header returned from userspace */ |
| 192 | struct fuse_out_header h; |
| 193 | |
Miklos Szeredi | 095da6c | 2006-01-16 22:14:52 -0800 | [diff] [blame] | 194 | /* |
| 195 | * The following bitfields are not changed during the request |
| 196 | * processing |
| 197 | */ |
| 198 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 199 | /** Last argument is variable length (can be shorter than |
| 200 | arg->size) */ |
| 201 | unsigned argvar:1; |
| 202 | |
| 203 | /** Last argument is a list of pages to copy data to */ |
| 204 | unsigned argpages:1; |
| 205 | |
| 206 | /** Zero partially or not copied pages */ |
| 207 | unsigned page_zeroing:1; |
| 208 | |
Miklos Szeredi | ce534fb | 2010-05-25 15:06:07 +0200 | [diff] [blame] | 209 | /** Pages may be replaced with new ones */ |
| 210 | unsigned page_replace:1; |
| 211 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 212 | /** Number or arguments */ |
| 213 | unsigned numargs; |
| 214 | |
| 215 | /** Array of arguments */ |
| 216 | struct fuse_arg args[3]; |
| 217 | }; |
| 218 | |
Maxim Patlasov | b2430d7 | 2012-10-26 19:49:24 +0400 | [diff] [blame] | 219 | /** FUSE page descriptor */ |
| 220 | struct fuse_page_desc { |
| 221 | unsigned int length; |
| 222 | unsigned int offset; |
| 223 | }; |
| 224 | |
Miklos Szeredi | 83cfd49 | 2006-01-16 22:14:31 -0800 | [diff] [blame] | 225 | /** The request state */ |
| 226 | enum fuse_req_state { |
| 227 | FUSE_REQ_INIT = 0, |
| 228 | FUSE_REQ_PENDING, |
| 229 | FUSE_REQ_READING, |
| 230 | FUSE_REQ_SENT, |
Miklos Szeredi | a4d27e7 | 2006-06-25 05:48:54 -0700 | [diff] [blame] | 231 | FUSE_REQ_WRITING, |
Miklos Szeredi | 83cfd49 | 2006-01-16 22:14:31 -0800 | [diff] [blame] | 232 | FUSE_REQ_FINISHED |
| 233 | }; |
| 234 | |
Maxim Patlasov | 01e9d11 | 2012-12-14 19:20:41 +0400 | [diff] [blame] | 235 | /** The request IO state (for asynchronous processing) */ |
| 236 | struct fuse_io_priv { |
| 237 | int async; |
| 238 | spinlock_t lock; |
| 239 | unsigned reqs; |
| 240 | ssize_t bytes; |
| 241 | size_t size; |
| 242 | __u64 offset; |
| 243 | bool write; |
| 244 | int err; |
| 245 | struct kiocb *iocb; |
| 246 | struct file *file; |
| 247 | }; |
| 248 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 249 | /** |
| 250 | * A request to the client |
| 251 | */ |
| 252 | struct fuse_req { |
Miklos Szeredi | ce1d5a4 | 2006-04-10 22:54:58 -0700 | [diff] [blame] | 253 | /** This can be on either pending processing or io lists in |
| 254 | fuse_conn */ |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 255 | struct list_head list; |
| 256 | |
Miklos Szeredi | a4d27e7 | 2006-06-25 05:48:54 -0700 | [diff] [blame] | 257 | /** Entry on the interrupts list */ |
| 258 | struct list_head intr_entry; |
| 259 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 260 | /** refcount */ |
| 261 | atomic_t count; |
| 262 | |
Miklos Szeredi | a4d27e7 | 2006-06-25 05:48:54 -0700 | [diff] [blame] | 263 | /** Unique ID for the interrupt request */ |
| 264 | u64 intr_unique; |
| 265 | |
Miklos Szeredi | 095da6c | 2006-01-16 22:14:52 -0800 | [diff] [blame] | 266 | /* |
| 267 | * The following bitfields are either set once before the |
| 268 | * request is queued or setting/clearing them is protected by |
Miklos Szeredi | d713311 | 2006-04-10 22:54:55 -0700 | [diff] [blame] | 269 | * fuse_conn->lock |
Miklos Szeredi | 095da6c | 2006-01-16 22:14:52 -0800 | [diff] [blame] | 270 | */ |
| 271 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 272 | /** True if the request has reply */ |
| 273 | unsigned isreply:1; |
| 274 | |
Miklos Szeredi | 51eb01e | 2006-06-25 05:48:50 -0700 | [diff] [blame] | 275 | /** Force sending of the request even if interrupted */ |
| 276 | unsigned force:1; |
| 277 | |
Miklos Szeredi | f9a2842 | 2006-06-25 05:48:53 -0700 | [diff] [blame] | 278 | /** The request was aborted */ |
| 279 | unsigned aborted:1; |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 280 | |
| 281 | /** Request is sent in the background */ |
| 282 | unsigned background:1; |
| 283 | |
Miklos Szeredi | a4d27e7 | 2006-06-25 05:48:54 -0700 | [diff] [blame] | 284 | /** The request has been interrupted */ |
| 285 | unsigned interrupted:1; |
| 286 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 287 | /** Data is being copied to/from the request */ |
| 288 | unsigned locked:1; |
| 289 | |
Miklos Szeredi | 9bc5ddd | 2006-04-11 21:16:09 +0200 | [diff] [blame] | 290 | /** Request is counted as "waiting" */ |
| 291 | unsigned waiting:1; |
| 292 | |
Miklos Szeredi | 83cfd49 | 2006-01-16 22:14:31 -0800 | [diff] [blame] | 293 | /** State of the request */ |
| 294 | enum fuse_req_state state; |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 295 | |
| 296 | /** The request input */ |
| 297 | struct fuse_in in; |
| 298 | |
| 299 | /** The request output */ |
| 300 | struct fuse_out out; |
| 301 | |
| 302 | /** Used to wake up the task waiting for completion of request*/ |
| 303 | wait_queue_head_t waitq; |
| 304 | |
| 305 | /** Data for asynchronous requests */ |
| 306 | union { |
Miklos Szeredi | b57d426 | 2008-02-06 01:38:39 -0800 | [diff] [blame] | 307 | struct { |
Miklos Szeredi | 5a18ec1 | 2011-02-25 14:44:58 +0100 | [diff] [blame] | 308 | union { |
| 309 | struct fuse_release_in in; |
| 310 | struct work_struct work; |
| 311 | }; |
Miklos Szeredi | b0be46e | 2009-04-28 16:56:36 +0200 | [diff] [blame] | 312 | struct path path; |
Miklos Szeredi | b57d426 | 2008-02-06 01:38:39 -0800 | [diff] [blame] | 313 | } release; |
Miklos Szeredi | 3ec870d | 2006-01-06 00:19:41 -0800 | [diff] [blame] | 314 | struct fuse_init_in init_in; |
| 315 | struct fuse_init_out init_out; |
Tejun Heo | 08cbf54 | 2009-04-14 10:54:53 +0900 | [diff] [blame] | 316 | struct cuse_init_in cuse_init_in; |
Miklos Szeredi | 5c5c5e5 | 2008-04-30 00:54:43 -0700 | [diff] [blame] | 317 | struct { |
| 318 | struct fuse_read_in in; |
| 319 | u64 attr_ver; |
| 320 | } read; |
Miklos Szeredi | b25e82e | 2007-10-18 03:07:03 -0700 | [diff] [blame] | 321 | struct { |
| 322 | struct fuse_write_in in; |
| 323 | struct fuse_write_out out; |
Miklos Szeredi | 8b284dc | 2013-10-01 16:44:53 +0200 | [diff] [blame] | 324 | struct fuse_req *next; |
Miklos Szeredi | b25e82e | 2007-10-18 03:07:03 -0700 | [diff] [blame] | 325 | } write; |
Miklos Szeredi | 2d45ba3 | 2010-07-12 14:41:40 +0200 | [diff] [blame] | 326 | struct fuse_notify_retrieve_in retrieve_in; |
Miklos Szeredi | 7142125 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 327 | struct fuse_lk_in lk_in; |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 328 | } misc; |
| 329 | |
| 330 | /** page vector */ |
Maxim Patlasov | 4250c06 | 2012-10-26 19:48:07 +0400 | [diff] [blame] | 331 | struct page **pages; |
| 332 | |
Maxim Patlasov | b2430d7 | 2012-10-26 19:49:24 +0400 | [diff] [blame] | 333 | /** page-descriptor vector */ |
| 334 | struct fuse_page_desc *page_descs; |
| 335 | |
Maxim Patlasov | 4250c06 | 2012-10-26 19:48:07 +0400 | [diff] [blame] | 336 | /** size of the 'pages' array */ |
| 337 | unsigned max_pages; |
| 338 | |
| 339 | /** inline page vector */ |
| 340 | struct page *inline_pages[FUSE_REQ_INLINE_PAGES]; |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 341 | |
Maxim Patlasov | b2430d7 | 2012-10-26 19:49:24 +0400 | [diff] [blame] | 342 | /** inline page-descriptor vector */ |
| 343 | struct fuse_page_desc inline_page_descs[FUSE_REQ_INLINE_PAGES]; |
| 344 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 345 | /** number of pages in vector */ |
| 346 | unsigned num_pages; |
| 347 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 348 | /** File used in the request (or NULL) */ |
Miklos Szeredi | c756e0a | 2007-10-16 23:31:00 -0700 | [diff] [blame] | 349 | struct fuse_file *ff; |
Miklos Szeredi | 64c6d8e | 2006-01-16 22:14:42 -0800 | [diff] [blame] | 350 | |
Miklos Szeredi | 3be5a52 | 2008-04-30 00:54:41 -0700 | [diff] [blame] | 351 | /** Inode used in the request or NULL */ |
| 352 | struct inode *inode; |
| 353 | |
Maxim Patlasov | 01e9d11 | 2012-12-14 19:20:41 +0400 | [diff] [blame] | 354 | /** AIO control block */ |
| 355 | struct fuse_io_priv *io; |
| 356 | |
Miklos Szeredi | 3be5a52 | 2008-04-30 00:54:41 -0700 | [diff] [blame] | 357 | /** Link on fi->writepages */ |
| 358 | struct list_head writepages_entry; |
| 359 | |
Miklos Szeredi | 64c6d8e | 2006-01-16 22:14:42 -0800 | [diff] [blame] | 360 | /** Request completion callback */ |
| 361 | void (*end)(struct fuse_conn *, struct fuse_req *); |
Miklos Szeredi | 33649c9 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 362 | |
| 363 | /** Request is stolen from fuse_file->reserved_req */ |
| 364 | struct file *stolen_file; |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 365 | }; |
| 366 | |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 367 | /** |
| 368 | * A Fuse connection. |
| 369 | * |
| 370 | * This structure is created, when the filesystem is mounted, and is |
| 371 | * destroyed, when the client device is closed and the filesystem is |
| 372 | * unmounted. |
| 373 | */ |
| 374 | struct fuse_conn { |
Miklos Szeredi | d713311 | 2006-04-10 22:54:55 -0700 | [diff] [blame] | 375 | /** Lock protecting accessess to members of this structure */ |
| 376 | spinlock_t lock; |
| 377 | |
Miklos Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 378 | /** Refcount */ |
| 379 | atomic_t count; |
| 380 | |
Al Viro | dd3e2c5 | 2013-10-03 21:21:39 -0400 | [diff] [blame] | 381 | struct rcu_head rcu; |
| 382 | |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 383 | /** The user id for this mount */ |
Eric W. Biederman | 499dcf2 | 2012-02-07 16:26:03 -0800 | [diff] [blame] | 384 | kuid_t user_id; |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 385 | |
Miklos Szeredi | 87729a5 | 2005-09-09 13:10:34 -0700 | [diff] [blame] | 386 | /** The group id for this mount */ |
Eric W. Biederman | 499dcf2 | 2012-02-07 16:26:03 -0800 | [diff] [blame] | 387 | kgid_t group_id; |
Miklos Szeredi | 87729a5 | 2005-09-09 13:10:34 -0700 | [diff] [blame] | 388 | |
Miklos Szeredi | 1e9a4ed | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 389 | /** The fuse mount flags for this mount */ |
| 390 | unsigned flags; |
| 391 | |
Miklos Szeredi | db50b96 | 2005-09-09 13:10:33 -0700 | [diff] [blame] | 392 | /** Maximum read size */ |
| 393 | unsigned max_read; |
| 394 | |
Miklos Szeredi | 413ef8c | 2005-09-09 13:10:35 -0700 | [diff] [blame] | 395 | /** Maximum write size */ |
| 396 | unsigned max_write; |
| 397 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 398 | /** Readers of the connection are waiting on this */ |
| 399 | wait_queue_head_t waitq; |
| 400 | |
| 401 | /** The list of pending requests */ |
| 402 | struct list_head pending; |
| 403 | |
| 404 | /** The list of requests being processed */ |
| 405 | struct list_head processing; |
| 406 | |
Miklos Szeredi | d77a1d5 | 2006-01-16 22:14:31 -0800 | [diff] [blame] | 407 | /** The list of requests under I/O */ |
| 408 | struct list_head io; |
| 409 | |
Tejun Heo | acf9943 | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 410 | /** The next unique kernel file handle */ |
| 411 | u64 khctr; |
| 412 | |
Tejun Heo | 95668a6 | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 413 | /** rbtree of fuse_files waiting for poll events indexed by ph */ |
| 414 | struct rb_root polled_files; |
| 415 | |
Csaba Henk | 7a6d3c8 | 2009-07-01 17:28:41 -0700 | [diff] [blame] | 416 | /** Maximum number of outstanding background requests */ |
| 417 | unsigned max_background; |
| 418 | |
| 419 | /** Number of background requests at which congestion starts */ |
| 420 | unsigned congestion_threshold; |
| 421 | |
Miklos Szeredi | 08a53cd | 2006-04-10 22:54:59 -0700 | [diff] [blame] | 422 | /** Number of requests currently in the background */ |
| 423 | unsigned num_background; |
| 424 | |
Miklos Szeredi | d12def1 | 2008-02-06 01:38:39 -0800 | [diff] [blame] | 425 | /** Number of background requests currently queued for userspace */ |
| 426 | unsigned active_background; |
| 427 | |
| 428 | /** The list of background requests set aside for later queuing */ |
| 429 | struct list_head bg_queue; |
| 430 | |
Miklos Szeredi | a4d27e7 | 2006-06-25 05:48:54 -0700 | [diff] [blame] | 431 | /** Pending interrupts */ |
| 432 | struct list_head interrupts; |
| 433 | |
Miklos Szeredi | 07e77dc | 2010-12-07 20:16:56 +0100 | [diff] [blame] | 434 | /** Queue of pending forgets */ |
| 435 | struct fuse_forget_link forget_list_head; |
| 436 | struct fuse_forget_link *forget_list_tail; |
| 437 | |
| 438 | /** Batching of FORGET requests (positive indicates FORGET batch) */ |
| 439 | int forget_batch; |
| 440 | |
Maxim Patlasov | 796523fb | 2013-03-21 18:02:15 +0400 | [diff] [blame] | 441 | /** Flag indicating that INIT reply has been received. Allocating |
| 442 | * any fuse request will be suspended until the flag is set */ |
| 443 | int initialized; |
| 444 | |
Miklos Szeredi | 08a53cd | 2006-04-10 22:54:59 -0700 | [diff] [blame] | 445 | /** Flag indicating if connection is blocked. This will be |
| 446 | the case before the INIT reply is received, and if there |
| 447 | are too many outstading backgrounds requests */ |
| 448 | int blocked; |
| 449 | |
| 450 | /** waitq for blocked connection */ |
| 451 | wait_queue_head_t blocked_waitq; |
| 452 | |
Miklos Szeredi | de5e3de | 2007-10-16 23:31:00 -0700 | [diff] [blame] | 453 | /** waitq for reserved requests */ |
| 454 | wait_queue_head_t reserved_req_waitq; |
| 455 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 456 | /** The next unique request id */ |
| 457 | u64 reqctr; |
| 458 | |
Miklos Szeredi | 69a53bf | 2006-01-16 22:14:41 -0800 | [diff] [blame] | 459 | /** Connection established, cleared on umount, connection |
| 460 | abort and device release */ |
Miklos Szeredi | 095da6c | 2006-01-16 22:14:52 -0800 | [diff] [blame] | 461 | unsigned connected; |
Miklos Szeredi | 1e9a4ed | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 462 | |
Miklos Szeredi | 095da6c | 2006-01-16 22:14:52 -0800 | [diff] [blame] | 463 | /** Connection failed (version mismatch). Cannot race with |
| 464 | setting other bitfields since it is only set once in INIT |
| 465 | reply, before any other request, and never cleared */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 466 | unsigned conn_error:1; |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 467 | |
Miklos Szeredi | 0ec7ca4 | 2006-12-06 20:35:52 -0800 | [diff] [blame] | 468 | /** Connection successful. Only set in INIT */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 469 | unsigned conn_init:1; |
Miklos Szeredi | 0ec7ca4 | 2006-12-06 20:35:52 -0800 | [diff] [blame] | 470 | |
Miklos Szeredi | 9cd6845 | 2006-02-01 03:04:40 -0800 | [diff] [blame] | 471 | /** Do readpages asynchronously? Only set in INIT */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 472 | unsigned async_read:1; |
Miklos Szeredi | 9cd6845 | 2006-02-01 03:04:40 -0800 | [diff] [blame] | 473 | |
Miklos Szeredi | 6ff958e | 2007-10-18 03:07:02 -0700 | [diff] [blame] | 474 | /** Do not send separate SETATTR request before open(O_TRUNC) */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 475 | unsigned atomic_o_trunc:1; |
Miklos Szeredi | 6ff958e | 2007-10-18 03:07:02 -0700 | [diff] [blame] | 476 | |
Miklos Szeredi | 33670fa | 2008-07-25 01:49:02 -0700 | [diff] [blame] | 477 | /** Filesystem supports NFS exporting. Only set in INIT */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 478 | unsigned export_support:1; |
Miklos Szeredi | 33670fa | 2008-07-25 01:49:02 -0700 | [diff] [blame] | 479 | |
Tejun Heo | a325f9b | 2009-04-14 10:54:52 +0900 | [diff] [blame] | 480 | /** Set if bdi is valid */ |
| 481 | unsigned bdi_initialized:1; |
| 482 | |
Miklos Szeredi | 095da6c | 2006-01-16 22:14:52 -0800 | [diff] [blame] | 483 | /* |
| 484 | * The following bitfields are only for optimization purposes |
| 485 | * and hence races in setting them will not cause malfunction |
| 486 | */ |
| 487 | |
Andrew Gallagher | 7678ac5 | 2013-11-05 16:05:52 +0100 | [diff] [blame] | 488 | /** Is open/release not implemented by fs? */ |
| 489 | unsigned no_open:1; |
| 490 | |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 491 | /** Is fsync not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 492 | unsigned no_fsync:1; |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 493 | |
Miklos Szeredi | 8254798 | 2005-09-09 13:10:38 -0700 | [diff] [blame] | 494 | /** Is fsyncdir not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 495 | unsigned no_fsyncdir:1; |
Miklos Szeredi | 8254798 | 2005-09-09 13:10:38 -0700 | [diff] [blame] | 496 | |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 497 | /** Is flush not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 498 | unsigned no_flush:1; |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 499 | |
Miklos Szeredi | 92a8780 | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 500 | /** Is setxattr not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 501 | unsigned no_setxattr:1; |
Miklos Szeredi | 92a8780 | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 502 | |
| 503 | /** Is getxattr not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 504 | unsigned no_getxattr:1; |
Miklos Szeredi | 92a8780 | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 505 | |
| 506 | /** Is listxattr not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 507 | unsigned no_listxattr:1; |
Miklos Szeredi | 92a8780 | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 508 | |
| 509 | /** Is removexattr not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 510 | unsigned no_removexattr:1; |
Miklos Szeredi | 92a8780 | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 511 | |
Miklos Szeredi | 37fb3a3 | 2011-08-08 16:08:08 +0200 | [diff] [blame] | 512 | /** Are posix file locking primitives not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 513 | unsigned no_lock:1; |
Miklos Szeredi | 7142125 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 514 | |
Miklos Szeredi | 31d40d7 | 2005-11-07 00:59:50 -0800 | [diff] [blame] | 515 | /** Is access not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 516 | unsigned no_access:1; |
Miklos Szeredi | 31d40d7 | 2005-11-07 00:59:50 -0800 | [diff] [blame] | 517 | |
Miklos Szeredi | fd72faa | 2005-11-07 00:59:51 -0800 | [diff] [blame] | 518 | /** Is create not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 519 | unsigned no_create:1; |
Miklos Szeredi | fd72faa | 2005-11-07 00:59:51 -0800 | [diff] [blame] | 520 | |
Miklos Szeredi | a4d27e7 | 2006-06-25 05:48:54 -0700 | [diff] [blame] | 521 | /** Is interrupt not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 522 | unsigned no_interrupt:1; |
Miklos Szeredi | a4d27e7 | 2006-06-25 05:48:54 -0700 | [diff] [blame] | 523 | |
Miklos Szeredi | b2d2272 | 2006-12-06 20:35:51 -0800 | [diff] [blame] | 524 | /** Is bmap not implemented by fs? */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 525 | unsigned no_bmap:1; |
Miklos Szeredi | b2d2272 | 2006-12-06 20:35:51 -0800 | [diff] [blame] | 526 | |
Tejun Heo | 95668a6 | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 527 | /** Is poll not implemented by fs? */ |
| 528 | unsigned no_poll:1; |
| 529 | |
Miklos Szeredi | 78bb6cb | 2008-05-12 14:02:32 -0700 | [diff] [blame] | 530 | /** Do multi-page cached writes */ |
Miklos Szeredi | 1729a16 | 2008-11-26 12:03:54 +0100 | [diff] [blame] | 531 | unsigned big_writes:1; |
Miklos Szeredi | 78bb6cb | 2008-05-12 14:02:32 -0700 | [diff] [blame] | 532 | |
Miklos Szeredi | e0a43dd | 2009-06-30 20:12:23 +0200 | [diff] [blame] | 533 | /** Don't apply umask to creation modes */ |
| 534 | unsigned dont_mask:1; |
| 535 | |
Miklos Szeredi | 37fb3a3 | 2011-08-08 16:08:08 +0200 | [diff] [blame] | 536 | /** Are BSD file locking primitives not implemented by fs? */ |
| 537 | unsigned no_flock:1; |
| 538 | |
Miklos Szeredi | 519c604 | 2012-04-26 10:56:36 +0200 | [diff] [blame] | 539 | /** Is fallocate not implemented by fs? */ |
| 540 | unsigned no_fallocate:1; |
| 541 | |
Brian Foster | 72d0d24 | 2012-07-16 15:23:48 -0400 | [diff] [blame] | 542 | /** Use enhanced/automatic page cache invalidation. */ |
| 543 | unsigned auto_inval_data:1; |
| 544 | |
Eric Wong | 634734b | 2013-02-06 22:29:01 +0000 | [diff] [blame] | 545 | /** Does the filesystem support readdirplus? */ |
Anand V. Avati | 0b05b18 | 2012-08-19 08:53:23 -0400 | [diff] [blame] | 546 | unsigned do_readdirplus:1; |
| 547 | |
Eric Wong | 634734b | 2013-02-06 22:29:01 +0000 | [diff] [blame] | 548 | /** Does the filesystem want adaptive readdirplus? */ |
| 549 | unsigned readdirplus_auto:1; |
| 550 | |
Miklos Szeredi | 60b9df7 | 2013-05-01 14:37:21 +0200 | [diff] [blame] | 551 | /** Does the filesystem support asynchronous direct-IO submission? */ |
| 552 | unsigned async_dio:1; |
| 553 | |
Miklos Szeredi | 0cd5b88 | 2006-01-16 22:14:38 -0800 | [diff] [blame] | 554 | /** The number of requests waiting for completion */ |
| 555 | atomic_t num_waiting; |
| 556 | |
Miklos Szeredi | 45714d6 | 2006-01-06 00:19:36 -0800 | [diff] [blame] | 557 | /** Negotiated minor version */ |
| 558 | unsigned minor; |
| 559 | |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 560 | /** Backing dev info */ |
| 561 | struct backing_dev_info bdi; |
Miklos Szeredi | f543f25 | 2006-01-16 22:14:35 -0800 | [diff] [blame] | 562 | |
Miklos Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 563 | /** Entry on the fuse_conn_list */ |
| 564 | struct list_head entry; |
| 565 | |
Miklos Szeredi | b6f2fcb | 2008-04-30 00:54:34 -0700 | [diff] [blame] | 566 | /** Device ID from super block */ |
| 567 | dev_t dev; |
Miklos Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 568 | |
| 569 | /** Dentries in the control filesystem */ |
| 570 | struct dentry *ctl_dentry[FUSE_CTL_NUM_DENTRIES]; |
| 571 | |
| 572 | /** number of dentries used in the above array */ |
| 573 | int ctl_ndents; |
Jeff Dike | 385a17b | 2006-04-10 22:54:52 -0700 | [diff] [blame] | 574 | |
| 575 | /** O_ASYNC requests */ |
| 576 | struct fasync_struct *fasync; |
Miklos Szeredi | 9c8ef56 | 2006-06-25 05:48:55 -0700 | [diff] [blame] | 577 | |
| 578 | /** Key for lock owner ID scrambling */ |
| 579 | u32 scramble_key[4]; |
Miklos Szeredi | 0ec7ca4 | 2006-12-06 20:35:52 -0800 | [diff] [blame] | 580 | |
| 581 | /** Reserved request for the DESTROY message */ |
| 582 | struct fuse_req *destroy_req; |
Miklos Szeredi | 1fb69e7 | 2007-10-18 03:06:58 -0700 | [diff] [blame] | 583 | |
| 584 | /** Version counter for attribute changes */ |
| 585 | u64 attr_version; |
Tejun Heo | 43901aa | 2008-11-26 12:03:56 +0100 | [diff] [blame] | 586 | |
| 587 | /** Called on final put */ |
| 588 | void (*release)(struct fuse_conn *); |
John Muir | 3b463ae | 2009-05-31 11:13:57 -0400 | [diff] [blame] | 589 | |
| 590 | /** Super block for this connection. */ |
| 591 | struct super_block *sb; |
| 592 | |
| 593 | /** Read/write semaphore to hold when accessing sb. */ |
| 594 | struct rw_semaphore killsb; |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 595 | }; |
| 596 | |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 597 | static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb) |
| 598 | { |
Miklos Szeredi | 6383bda | 2006-01-16 22:14:29 -0800 | [diff] [blame] | 599 | return sb->s_fs_info; |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 600 | } |
| 601 | |
| 602 | static inline struct fuse_conn *get_fuse_conn(struct inode *inode) |
| 603 | { |
| 604 | return get_fuse_conn_super(inode->i_sb); |
| 605 | } |
| 606 | |
| 607 | static inline struct fuse_inode *get_fuse_inode(struct inode *inode) |
| 608 | { |
| 609 | return container_of(inode, struct fuse_inode, inode); |
| 610 | } |
| 611 | |
| 612 | static inline u64 get_node_id(struct inode *inode) |
| 613 | { |
| 614 | return get_fuse_inode(inode)->nodeid; |
| 615 | } |
| 616 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 617 | /** Device operations */ |
Arjan van de Ven | 4b6f5d2 | 2006-03-28 01:56:42 -0800 | [diff] [blame] | 618 | extern const struct file_operations fuse_dev_operations; |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 619 | |
Al Viro | 4269590 | 2009-02-20 05:59:13 +0000 | [diff] [blame] | 620 | extern const struct dentry_operations fuse_dentry_operations; |
Miklos Szeredi | dbd561d | 2008-07-25 01:49:00 -0700 | [diff] [blame] | 621 | |
Miklos Szeredi | d8a5ba4 | 2005-09-09 13:10:26 -0700 | [diff] [blame] | 622 | /** |
John Muir | 3b463ae | 2009-05-31 11:13:57 -0400 | [diff] [blame] | 623 | * Inode to nodeid comparison. |
| 624 | */ |
| 625 | int fuse_inode_eq(struct inode *inode, void *_nodeidp); |
| 626 | |
| 627 | /** |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 628 | * Get a filled in inode |
| 629 | */ |
Miklos Szeredi | b48badf | 2008-04-30 00:54:44 -0700 | [diff] [blame] | 630 | struct inode *fuse_iget(struct super_block *sb, u64 nodeid, |
Miklos Szeredi | 1fb69e7 | 2007-10-18 03:06:58 -0700 | [diff] [blame] | 631 | int generation, struct fuse_attr *attr, |
| 632 | u64 attr_valid, u64 attr_version); |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 633 | |
Miklos Szeredi | 33670fa | 2008-07-25 01:49:02 -0700 | [diff] [blame] | 634 | int fuse_lookup_name(struct super_block *sb, u64 nodeid, struct qstr *name, |
| 635 | struct fuse_entry_out *outarg, struct inode **inode); |
| 636 | |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 637 | /** |
| 638 | * Send FORGET command |
| 639 | */ |
Miklos Szeredi | 07e77dc | 2010-12-07 20:16:56 +0100 | [diff] [blame] | 640 | void fuse_queue_forget(struct fuse_conn *fc, struct fuse_forget_link *forget, |
| 641 | u64 nodeid, u64 nlookup); |
| 642 | |
| 643 | struct fuse_forget_link *fuse_alloc_forget(void); |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 644 | |
Anand V. Avati | 0b05b18 | 2012-08-19 08:53:23 -0400 | [diff] [blame] | 645 | /* Used by READDIRPLUS */ |
| 646 | void fuse_force_forget(struct file *file, u64 nodeid); |
| 647 | |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 648 | /** |
Miklos Szeredi | 361b1eb5 | 2006-01-16 22:14:45 -0800 | [diff] [blame] | 649 | * Initialize READ or READDIR request |
Miklos Szeredi | 04730fe | 2005-09-09 13:10:36 -0700 | [diff] [blame] | 650 | */ |
Miklos Szeredi | a664309 | 2007-11-28 16:22:00 -0800 | [diff] [blame] | 651 | void fuse_read_fill(struct fuse_req *req, struct file *file, |
Miklos Szeredi | 2106cb1 | 2009-04-28 16:56:37 +0200 | [diff] [blame] | 652 | loff_t pos, size_t count, int opcode); |
Miklos Szeredi | 04730fe | 2005-09-09 13:10:36 -0700 | [diff] [blame] | 653 | |
| 654 | /** |
| 655 | * Send OPEN or OPENDIR request |
| 656 | */ |
Miklos Szeredi | 91fe96b | 2009-04-28 16:56:37 +0200 | [diff] [blame] | 657 | int fuse_open_common(struct inode *inode, struct file *file, bool isdir); |
Miklos Szeredi | 04730fe | 2005-09-09 13:10:36 -0700 | [diff] [blame] | 658 | |
Tejun Heo | acf9943 | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 659 | struct fuse_file *fuse_file_alloc(struct fuse_conn *fc); |
Miklos Szeredi | c7b7143 | 2009-04-28 16:56:37 +0200 | [diff] [blame] | 660 | struct fuse_file *fuse_file_get(struct fuse_file *ff); |
Miklos Szeredi | fd72faa | 2005-11-07 00:59:51 -0800 | [diff] [blame] | 661 | void fuse_file_free(struct fuse_file *ff); |
Miklos Szeredi | c7b7143 | 2009-04-28 16:56:37 +0200 | [diff] [blame] | 662 | void fuse_finish_open(struct inode *inode, struct file *file); |
Miklos Szeredi | fd72faa | 2005-11-07 00:59:51 -0800 | [diff] [blame] | 663 | |
Miklos Szeredi | 8b0797a | 2009-04-28 16:56:39 +0200 | [diff] [blame] | 664 | void fuse_sync_release(struct fuse_file *ff, int flags); |
Miklos Szeredi | c756e0a | 2007-10-16 23:31:00 -0700 | [diff] [blame] | 665 | |
Miklos Szeredi | 04730fe | 2005-09-09 13:10:36 -0700 | [diff] [blame] | 666 | /** |
| 667 | * Send RELEASE or RELEASEDIR request |
| 668 | */ |
Miklos Szeredi | 8b0797a | 2009-04-28 16:56:39 +0200 | [diff] [blame] | 669 | void fuse_release_common(struct file *file, int opcode); |
Miklos Szeredi | 04730fe | 2005-09-09 13:10:36 -0700 | [diff] [blame] | 670 | |
| 671 | /** |
Miklos Szeredi | 8254798 | 2005-09-09 13:10:38 -0700 | [diff] [blame] | 672 | * Send FSYNC or FSYNCDIR request |
| 673 | */ |
Josef Bacik | 02c24a8 | 2011-07-16 20:44:56 -0400 | [diff] [blame] | 674 | int fuse_fsync_common(struct file *file, loff_t start, loff_t end, |
| 675 | int datasync, int isdir); |
Miklos Szeredi | 8254798 | 2005-09-09 13:10:38 -0700 | [diff] [blame] | 676 | |
| 677 | /** |
Tejun Heo | 95668a6 | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 678 | * Notify poll wakeup |
| 679 | */ |
| 680 | int fuse_notify_poll_wakeup(struct fuse_conn *fc, |
| 681 | struct fuse_notify_poll_wakeup_out *outarg); |
| 682 | |
| 683 | /** |
Miklos Szeredi | 1779381 | 2005-10-30 15:02:51 -0800 | [diff] [blame] | 684 | * Initialize file operations on a regular file |
Miklos Szeredi | b6aeade | 2005-09-09 13:10:30 -0700 | [diff] [blame] | 685 | */ |
| 686 | void fuse_init_file_inode(struct inode *inode); |
| 687 | |
| 688 | /** |
Miklos Szeredi | 1779381 | 2005-10-30 15:02:51 -0800 | [diff] [blame] | 689 | * Initialize inode operations on regular files and special files |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 690 | */ |
| 691 | void fuse_init_common(struct inode *inode); |
| 692 | |
| 693 | /** |
Miklos Szeredi | 1779381 | 2005-10-30 15:02:51 -0800 | [diff] [blame] | 694 | * Initialize inode and file operations on a directory |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 695 | */ |
| 696 | void fuse_init_dir(struct inode *inode); |
| 697 | |
| 698 | /** |
Miklos Szeredi | 1779381 | 2005-10-30 15:02:51 -0800 | [diff] [blame] | 699 | * Initialize inode operations on a symlink |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 700 | */ |
| 701 | void fuse_init_symlink(struct inode *inode); |
| 702 | |
| 703 | /** |
| 704 | * Change attributes of an inode |
| 705 | */ |
Miklos Szeredi | 1fb69e7 | 2007-10-18 03:06:58 -0700 | [diff] [blame] | 706 | void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr, |
| 707 | u64 attr_valid, u64 attr_version); |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 708 | |
Miklos Szeredi | 3be5a52 | 2008-04-30 00:54:41 -0700 | [diff] [blame] | 709 | void fuse_change_attributes_common(struct inode *inode, struct fuse_attr *attr, |
| 710 | u64 attr_valid); |
| 711 | |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 712 | /** |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 713 | * Initialize the client device |
| 714 | */ |
| 715 | int fuse_dev_init(void); |
| 716 | |
| 717 | /** |
| 718 | * Cleanup the client device |
| 719 | */ |
| 720 | void fuse_dev_cleanup(void); |
| 721 | |
Miklos Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 722 | int fuse_ctl_init(void); |
| 723 | void fuse_ctl_cleanup(void); |
| 724 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 725 | /** |
| 726 | * Allocate a request |
| 727 | */ |
Maxim Patlasov | 4250c06 | 2012-10-26 19:48:07 +0400 | [diff] [blame] | 728 | struct fuse_req *fuse_request_alloc(unsigned npages); |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 729 | |
Maxim Patlasov | 4250c06 | 2012-10-26 19:48:07 +0400 | [diff] [blame] | 730 | struct fuse_req *fuse_request_alloc_nofs(unsigned npages); |
Miklos Szeredi | 3be5a52 | 2008-04-30 00:54:41 -0700 | [diff] [blame] | 731 | |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 732 | /** |
| 733 | * Free a request |
| 734 | */ |
| 735 | void fuse_request_free(struct fuse_req *req); |
| 736 | |
| 737 | /** |
Maxim Patlasov | b111c8c | 2012-10-26 19:48:30 +0400 | [diff] [blame] | 738 | * Get a request, may fail with -ENOMEM, |
| 739 | * caller should specify # elements in req->pages[] explicitly |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 740 | */ |
Maxim Patlasov | b111c8c | 2012-10-26 19:48:30 +0400 | [diff] [blame] | 741 | struct fuse_req *fuse_get_req(struct fuse_conn *fc, unsigned npages); |
Maxim Patlasov | 8b41e67 | 2013-03-21 18:02:04 +0400 | [diff] [blame] | 742 | struct fuse_req *fuse_get_req_for_background(struct fuse_conn *fc, |
| 743 | unsigned npages); |
Maxim Patlasov | b111c8c | 2012-10-26 19:48:30 +0400 | [diff] [blame] | 744 | |
Maxim Patlasov | 36cf66e | 2012-12-14 19:20:51 +0400 | [diff] [blame] | 745 | /* |
| 746 | * Increment reference count on request |
| 747 | */ |
| 748 | void __fuse_get_request(struct fuse_req *req); |
| 749 | |
Maxim Patlasov | b111c8c | 2012-10-26 19:48:30 +0400 | [diff] [blame] | 750 | /** |
| 751 | * Get a request, may fail with -ENOMEM, |
| 752 | * useful for callers who doesn't use req->pages[] |
| 753 | */ |
| 754 | static inline struct fuse_req *fuse_get_req_nopages(struct fuse_conn *fc) |
| 755 | { |
| 756 | return fuse_get_req(fc, 0); |
| 757 | } |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 758 | |
| 759 | /** |
Miklos Szeredi | 33649c9 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 760 | * Gets a requests for a file operation, always succeeds |
| 761 | */ |
Maxim Patlasov | b111c8c | 2012-10-26 19:48:30 +0400 | [diff] [blame] | 762 | struct fuse_req *fuse_get_req_nofail_nopages(struct fuse_conn *fc, |
| 763 | struct file *file); |
Miklos Szeredi | 33649c9 | 2006-06-25 05:48:52 -0700 | [diff] [blame] | 764 | |
| 765 | /** |
Miklos Szeredi | ce1d5a4 | 2006-04-10 22:54:58 -0700 | [diff] [blame] | 766 | * Decrement reference count of a request. If count goes to zero free |
| 767 | * the request. |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 768 | */ |
| 769 | void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req); |
| 770 | |
| 771 | /** |
Miklos Szeredi | 7c352bd | 2005-09-09 13:10:39 -0700 | [diff] [blame] | 772 | * Send a request (synchronous) |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 773 | */ |
Tejun Heo | b93f858 | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 774 | void fuse_request_send(struct fuse_conn *fc, struct fuse_req *req); |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 775 | |
| 776 | /** |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 777 | * Send a request in the background |
| 778 | */ |
Tejun Heo | b93f858 | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 779 | void fuse_request_send_background(struct fuse_conn *fc, struct fuse_req *req); |
Miklos Szeredi | 334f485 | 2005-09-09 13:10:27 -0700 | [diff] [blame] | 780 | |
Tejun Heo | b93f858 | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 781 | void fuse_request_send_background_locked(struct fuse_conn *fc, |
| 782 | struct fuse_req *req); |
Miklos Szeredi | 3be5a52 | 2008-04-30 00:54:41 -0700 | [diff] [blame] | 783 | |
Miklos Szeredi | 5a5fb1e | 2006-04-26 10:48:55 +0200 | [diff] [blame] | 784 | /* Abort all requests */ |
Miklos Szeredi | 69a53bf | 2006-01-16 22:14:41 -0800 | [diff] [blame] | 785 | void fuse_abort_conn(struct fuse_conn *fc); |
| 786 | |
Miklos Szeredi | 1e9a4ed | 2005-09-09 13:10:31 -0700 | [diff] [blame] | 787 | /** |
Miklos Szeredi | e5e5558 | 2005-09-09 13:10:28 -0700 | [diff] [blame] | 788 | * Invalidate inode attributes |
| 789 | */ |
| 790 | void fuse_invalidate_attr(struct inode *inode); |
Miklos Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 791 | |
Miklos Szeredi | dbd561d | 2008-07-25 01:49:00 -0700 | [diff] [blame] | 792 | void fuse_invalidate_entry_cache(struct dentry *entry); |
| 793 | |
Andrew Gallagher | 451418f | 2013-11-05 03:55:43 -0800 | [diff] [blame] | 794 | void fuse_invalidate_atime(struct inode *inode); |
| 795 | |
Miklos Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 796 | /** |
| 797 | * Acquire reference to fuse_conn |
| 798 | */ |
| 799 | struct fuse_conn *fuse_conn_get(struct fuse_conn *fc); |
| 800 | |
Tejun Heo | 08cbf54 | 2009-04-14 10:54:53 +0900 | [diff] [blame] | 801 | void fuse_conn_kill(struct fuse_conn *fc); |
| 802 | |
Miklos Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 803 | /** |
Tejun Heo | 0d179aa | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 804 | * Initialize fuse_conn |
| 805 | */ |
Tejun Heo | a325f9b | 2009-04-14 10:54:52 +0900 | [diff] [blame] | 806 | void fuse_conn_init(struct fuse_conn *fc); |
Tejun Heo | 0d179aa | 2008-11-26 12:03:55 +0100 | [diff] [blame] | 807 | |
| 808 | /** |
Miklos Szeredi | bafa965 | 2006-06-25 05:48:51 -0700 | [diff] [blame] | 809 | * Release reference to fuse_conn |
| 810 | */ |
| 811 | void fuse_conn_put(struct fuse_conn *fc); |
| 812 | |
| 813 | /** |
| 814 | * Add connection to control filesystem |
| 815 | */ |
| 816 | int fuse_ctl_add_conn(struct fuse_conn *fc); |
| 817 | |
| 818 | /** |
| 819 | * Remove connection from control filesystem |
| 820 | */ |
| 821 | void fuse_ctl_remove_conn(struct fuse_conn *fc); |
Timo Savola | a5bfffac | 2007-04-08 16:04:00 -0700 | [diff] [blame] | 822 | |
| 823 | /** |
| 824 | * Is file type valid? |
| 825 | */ |
| 826 | int fuse_valid_type(int m); |
Miklos Szeredi | e57ac68 | 2007-10-18 03:06:58 -0700 | [diff] [blame] | 827 | |
| 828 | /** |
Anatol Pomozov | c2132c1 | 2013-01-14 22:30:00 -0800 | [diff] [blame] | 829 | * Is current process allowed to perform filesystem operation? |
Miklos Szeredi | e57ac68 | 2007-10-18 03:06:58 -0700 | [diff] [blame] | 830 | */ |
Anatol Pomozov | c2132c1 | 2013-01-14 22:30:00 -0800 | [diff] [blame] | 831 | int fuse_allow_current_process(struct fuse_conn *fc); |
Miklos Szeredi | f333211 | 2007-10-18 03:07:04 -0700 | [diff] [blame] | 832 | |
| 833 | u64 fuse_lock_owner_id(struct fuse_conn *fc, fl_owner_t id); |
Miklos Szeredi | bcb4be8 | 2007-11-28 16:21:59 -0800 | [diff] [blame] | 834 | |
| 835 | int fuse_update_attributes(struct inode *inode, struct kstat *stat, |
| 836 | struct file *file, bool *refreshed); |
Miklos Szeredi | 3be5a52 | 2008-04-30 00:54:41 -0700 | [diff] [blame] | 837 | |
| 838 | void fuse_flush_writepages(struct inode *inode); |
| 839 | |
| 840 | void fuse_set_nowrite(struct inode *inode); |
| 841 | void fuse_release_nowrite(struct inode *inode); |
Miklos Szeredi | 5c5c5e5 | 2008-04-30 00:54:43 -0700 | [diff] [blame] | 842 | |
| 843 | u64 fuse_get_attr_version(struct fuse_conn *fc); |
Tejun Heo | 29d434b | 2008-10-16 16:08:57 +0200 | [diff] [blame] | 844 | |
John Muir | 3b463ae | 2009-05-31 11:13:57 -0400 | [diff] [blame] | 845 | /** |
| 846 | * File-system tells the kernel to invalidate cache for the given node id. |
| 847 | */ |
| 848 | int fuse_reverse_inval_inode(struct super_block *sb, u64 nodeid, |
| 849 | loff_t offset, loff_t len); |
| 850 | |
| 851 | /** |
| 852 | * File-system tells the kernel to invalidate parent attributes and |
| 853 | * the dentry matching parent/name. |
John Muir | 451d0f5 | 2011-12-06 21:50:06 +0100 | [diff] [blame] | 854 | * |
| 855 | * If the child_nodeid is non-zero and: |
| 856 | * - matches the inode number for the dentry matching parent/name, |
| 857 | * - is not a mount point |
| 858 | * - is a file or oan empty directory |
| 859 | * then the dentry is unhashed (d_delete()). |
John Muir | 3b463ae | 2009-05-31 11:13:57 -0400 | [diff] [blame] | 860 | */ |
| 861 | int fuse_reverse_inval_entry(struct super_block *sb, u64 parent_nodeid, |
John Muir | 451d0f5 | 2011-12-06 21:50:06 +0100 | [diff] [blame] | 862 | u64 child_nodeid, struct qstr *name); |
John Muir | 3b463ae | 2009-05-31 11:13:57 -0400 | [diff] [blame] | 863 | |
Tejun Heo | 08cbf54 | 2009-04-14 10:54:53 +0900 | [diff] [blame] | 864 | int fuse_do_open(struct fuse_conn *fc, u64 nodeid, struct file *file, |
| 865 | bool isdir); |
Maxim Patlasov | 36cf66e | 2012-12-14 19:20:51 +0400 | [diff] [blame] | 866 | ssize_t fuse_direct_io(struct fuse_io_priv *io, const struct iovec *iov, |
Miklos Szeredi | fb05f41 | 2012-11-10 16:55:56 +0100 | [diff] [blame] | 867 | unsigned long nr_segs, size_t count, loff_t *ppos, |
| 868 | int write); |
Tejun Heo | 08cbf54 | 2009-04-14 10:54:53 +0900 | [diff] [blame] | 869 | long fuse_do_ioctl(struct file *file, unsigned int cmd, unsigned long arg, |
| 870 | unsigned int flags); |
Miklos Szeredi | b18da0c | 2011-12-13 11:58:49 +0100 | [diff] [blame] | 871 | long fuse_ioctl_common(struct file *file, unsigned int cmd, |
| 872 | unsigned long arg, unsigned int flags); |
Tejun Heo | 08cbf54 | 2009-04-14 10:54:53 +0900 | [diff] [blame] | 873 | unsigned fuse_file_poll(struct file *file, poll_table *wait); |
| 874 | int fuse_dev_release(struct inode *inode, struct file *file); |
| 875 | |
Miklos Szeredi | a1d75f2 | 2010-07-12 14:41:40 +0200 | [diff] [blame] | 876 | void fuse_write_update_size(struct inode *inode, loff_t pos); |
| 877 | |
Maxim Patlasov | efb9fa9 | 2012-12-18 14:05:08 +0400 | [diff] [blame] | 878 | int fuse_do_setattr(struct inode *inode, struct iattr *attr, |
| 879 | struct file *file); |
| 880 | |
Tejun Heo | 29d434b | 2008-10-16 16:08:57 +0200 | [diff] [blame] | 881 | #endif /* _FS_FUSE_I_H */ |