Commit | Line | Data |
---|---|---|
d8a5ba45 MS |
1 | /* |
2 | FUSE: Filesystem in Userspace | |
3 | Copyright (C) 2001-2005 Miklos Szeredi <miklos@szeredi.hu> | |
4 | ||
5 | This program can be distributed under the terms of the GNU GPL. | |
6 | See the file COPYING. | |
7 | */ | |
8 | ||
9 | #include <linux/fuse.h> | |
10 | #include <linux/fs.h> | |
11 | #include <linux/wait.h> | |
12 | #include <linux/list.h> | |
13 | #include <linux/spinlock.h> | |
14 | #include <linux/mm.h> | |
15 | #include <linux/backing-dev.h> | |
16 | #include <asm/semaphore.h> | |
17 | ||
334f485d MS |
18 | /** Max number of pages that can be used in a single read request */ |
19 | #define FUSE_MAX_PAGES_PER_REQ 32 | |
20 | ||
21 | /** If more requests are outstanding, then the operation will block */ | |
22 | #define FUSE_MAX_OUTSTANDING 10 | |
23 | ||
1d3d752b MS |
24 | /** It could be as large as PATH_MAX, but would that have any uses? */ |
25 | #define FUSE_NAME_MAX 1024 | |
26 | ||
1e9a4ed9 MS |
27 | /** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem |
28 | module will check permissions based on the file mode. Otherwise no | |
29 | permission checking is done in the kernel */ | |
30 | #define FUSE_DEFAULT_PERMISSIONS (1 << 0) | |
31 | ||
32 | /** If the FUSE_ALLOW_OTHER flag is given, then not only the user | |
33 | doing the mount will be allowed to access the filesystem */ | |
34 | #define FUSE_ALLOW_OTHER (1 << 1) | |
35 | ||
413ef8cb | 36 | |
d8a5ba45 MS |
37 | /** FUSE inode */ |
38 | struct fuse_inode { | |
39 | /** Inode data */ | |
40 | struct inode inode; | |
41 | ||
42 | /** Unique ID, which identifies the inode between userspace | |
43 | * and kernel */ | |
44 | u64 nodeid; | |
45 | ||
9e6268db MS |
46 | /** Number of lookups on this inode */ |
47 | u64 nlookup; | |
48 | ||
e5e5558e MS |
49 | /** The request used for sending the FORGET message */ |
50 | struct fuse_req *forget_req; | |
51 | ||
d8a5ba45 MS |
52 | /** Time in jiffies until the file attributes are valid */ |
53 | unsigned long i_time; | |
54 | }; | |
55 | ||
b6aeaded MS |
56 | /** FUSE specific file data */ |
57 | struct fuse_file { | |
58 | /** Request reserved for flush and release */ | |
59 | struct fuse_req *release_req; | |
60 | ||
61 | /** File handle used by userspace */ | |
62 | u64 fh; | |
63 | }; | |
64 | ||
334f485d MS |
65 | /** One input argument of a request */ |
66 | struct fuse_in_arg { | |
67 | unsigned size; | |
68 | const void *value; | |
69 | }; | |
70 | ||
71 | /** The request input */ | |
72 | struct fuse_in { | |
73 | /** The request header */ | |
74 | struct fuse_in_header h; | |
75 | ||
76 | /** True if the data for the last argument is in req->pages */ | |
77 | unsigned argpages:1; | |
78 | ||
79 | /** Number of arguments */ | |
80 | unsigned numargs; | |
81 | ||
82 | /** Array of arguments */ | |
83 | struct fuse_in_arg args[3]; | |
84 | }; | |
85 | ||
86 | /** One output argument of a request */ | |
87 | struct fuse_arg { | |
88 | unsigned size; | |
89 | void *value; | |
90 | }; | |
91 | ||
92 | /** The request output */ | |
93 | struct fuse_out { | |
94 | /** Header returned from userspace */ | |
95 | struct fuse_out_header h; | |
96 | ||
97 | /** Last argument is variable length (can be shorter than | |
98 | arg->size) */ | |
99 | unsigned argvar:1; | |
100 | ||
101 | /** Last argument is a list of pages to copy data to */ | |
102 | unsigned argpages:1; | |
103 | ||
104 | /** Zero partially or not copied pages */ | |
105 | unsigned page_zeroing:1; | |
106 | ||
107 | /** Number or arguments */ | |
108 | unsigned numargs; | |
109 | ||
110 | /** Array of arguments */ | |
111 | struct fuse_arg args[3]; | |
112 | }; | |
113 | ||
83cfd493 MS |
114 | /** The request state */ |
115 | enum fuse_req_state { | |
116 | FUSE_REQ_INIT = 0, | |
117 | FUSE_REQ_PENDING, | |
118 | FUSE_REQ_READING, | |
119 | FUSE_REQ_SENT, | |
120 | FUSE_REQ_FINISHED | |
121 | }; | |
122 | ||
334f485d MS |
123 | /** |
124 | * A request to the client | |
125 | */ | |
126 | struct fuse_req { | |
127 | /** This can be on either unused_list, pending or processing | |
128 | lists in fuse_conn */ | |
129 | struct list_head list; | |
130 | ||
1e9a4ed9 MS |
131 | /** Entry on the background list */ |
132 | struct list_head bg_entry; | |
133 | ||
334f485d MS |
134 | /** refcount */ |
135 | atomic_t count; | |
136 | ||
137 | /** True if the request has reply */ | |
138 | unsigned isreply:1; | |
139 | ||
140 | /** The request is preallocated */ | |
141 | unsigned preallocated:1; | |
142 | ||
143 | /** The request was interrupted */ | |
144 | unsigned interrupted:1; | |
145 | ||
146 | /** Request is sent in the background */ | |
147 | unsigned background:1; | |
148 | ||
149 | /** Data is being copied to/from the request */ | |
150 | unsigned locked:1; | |
151 | ||
83cfd493 MS |
152 | /** State of the request */ |
153 | enum fuse_req_state state; | |
334f485d MS |
154 | |
155 | /** The request input */ | |
156 | struct fuse_in in; | |
157 | ||
158 | /** The request output */ | |
159 | struct fuse_out out; | |
160 | ||
161 | /** Used to wake up the task waiting for completion of request*/ | |
162 | wait_queue_head_t waitq; | |
163 | ||
164 | /** Data for asynchronous requests */ | |
165 | union { | |
e5e5558e | 166 | struct fuse_forget_in forget_in; |
b6aeaded | 167 | struct fuse_release_in release_in; |
3ec870d5 MS |
168 | struct fuse_init_in init_in; |
169 | struct fuse_init_out init_out; | |
334f485d MS |
170 | } misc; |
171 | ||
172 | /** page vector */ | |
173 | struct page *pages[FUSE_MAX_PAGES_PER_REQ]; | |
174 | ||
175 | /** number of pages in vector */ | |
176 | unsigned num_pages; | |
177 | ||
178 | /** offset of data on first page */ | |
179 | unsigned page_offset; | |
180 | ||
181 | /** Inode used in the request */ | |
182 | struct inode *inode; | |
183 | ||
184 | /** Second inode used in the request (or NULL) */ | |
185 | struct inode *inode2; | |
186 | ||
187 | /** File used in the request (or NULL) */ | |
188 | struct file *file; | |
189 | }; | |
190 | ||
d8a5ba45 MS |
191 | /** |
192 | * A Fuse connection. | |
193 | * | |
194 | * This structure is created, when the filesystem is mounted, and is | |
195 | * destroyed, when the client device is closed and the filesystem is | |
196 | * unmounted. | |
197 | */ | |
198 | struct fuse_conn { | |
1e9a4ed9 MS |
199 | /** Reference count */ |
200 | int count; | |
334f485d | 201 | |
d8a5ba45 MS |
202 | /** The user id for this mount */ |
203 | uid_t user_id; | |
204 | ||
87729a55 MS |
205 | /** The group id for this mount */ |
206 | gid_t group_id; | |
207 | ||
1e9a4ed9 MS |
208 | /** The fuse mount flags for this mount */ |
209 | unsigned flags; | |
210 | ||
db50b96c MS |
211 | /** Maximum read size */ |
212 | unsigned max_read; | |
213 | ||
413ef8cb MS |
214 | /** Maximum write size */ |
215 | unsigned max_write; | |
216 | ||
334f485d MS |
217 | /** Readers of the connection are waiting on this */ |
218 | wait_queue_head_t waitq; | |
219 | ||
220 | /** The list of pending requests */ | |
221 | struct list_head pending; | |
222 | ||
223 | /** The list of requests being processed */ | |
224 | struct list_head processing; | |
225 | ||
1e9a4ed9 MS |
226 | /** Requests put in the background (RELEASE or any other |
227 | interrupted request) */ | |
228 | struct list_head background; | |
229 | ||
334f485d MS |
230 | /** Controls the maximum number of outstanding requests */ |
231 | struct semaphore outstanding_sem; | |
232 | ||
233 | /** This counts the number of outstanding requests if | |
234 | outstanding_sem would go negative */ | |
235 | unsigned outstanding_debt; | |
236 | ||
1e9a4ed9 MS |
237 | /** RW semaphore for exclusion with fuse_put_super() */ |
238 | struct rw_semaphore sbput_sem; | |
239 | ||
334f485d MS |
240 | /** The list of unused requests */ |
241 | struct list_head unused_list; | |
242 | ||
243 | /** The next unique request id */ | |
244 | u64 reqctr; | |
245 | ||
1e9a4ed9 MS |
246 | /** Mount is active */ |
247 | unsigned mounted : 1; | |
248 | ||
249 | /** Connection established */ | |
250 | unsigned connected : 1; | |
251 | ||
334f485d MS |
252 | /** Connection failed (version mismatch) */ |
253 | unsigned conn_error : 1; | |
254 | ||
b6aeaded MS |
255 | /** Is fsync not implemented by fs? */ |
256 | unsigned no_fsync : 1; | |
257 | ||
82547981 MS |
258 | /** Is fsyncdir not implemented by fs? */ |
259 | unsigned no_fsyncdir : 1; | |
260 | ||
b6aeaded MS |
261 | /** Is flush not implemented by fs? */ |
262 | unsigned no_flush : 1; | |
263 | ||
92a8780e MS |
264 | /** Is setxattr not implemented by fs? */ |
265 | unsigned no_setxattr : 1; | |
266 | ||
267 | /** Is getxattr not implemented by fs? */ | |
268 | unsigned no_getxattr : 1; | |
269 | ||
270 | /** Is listxattr not implemented by fs? */ | |
271 | unsigned no_listxattr : 1; | |
272 | ||
273 | /** Is removexattr not implemented by fs? */ | |
274 | unsigned no_removexattr : 1; | |
275 | ||
31d40d74 MS |
276 | /** Is access not implemented by fs? */ |
277 | unsigned no_access : 1; | |
278 | ||
fd72faac MS |
279 | /** Is create not implemented by fs? */ |
280 | unsigned no_create : 1; | |
281 | ||
45714d65 MS |
282 | /** Negotiated minor version */ |
283 | unsigned minor; | |
284 | ||
d8a5ba45 MS |
285 | /** Backing dev info */ |
286 | struct backing_dev_info bdi; | |
287 | }; | |
288 | ||
d8a5ba45 MS |
289 | static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb) |
290 | { | |
6383bdaa | 291 | return sb->s_fs_info; |
d8a5ba45 MS |
292 | } |
293 | ||
294 | static inline struct fuse_conn *get_fuse_conn(struct inode *inode) | |
295 | { | |
296 | return get_fuse_conn_super(inode->i_sb); | |
297 | } | |
298 | ||
299 | static inline struct fuse_inode *get_fuse_inode(struct inode *inode) | |
300 | { | |
301 | return container_of(inode, struct fuse_inode, inode); | |
302 | } | |
303 | ||
304 | static inline u64 get_node_id(struct inode *inode) | |
305 | { | |
306 | return get_fuse_inode(inode)->nodeid; | |
307 | } | |
308 | ||
334f485d MS |
309 | /** Device operations */ |
310 | extern struct file_operations fuse_dev_operations; | |
311 | ||
d8a5ba45 MS |
312 | /** |
313 | * This is the single global spinlock which protects FUSE's structures | |
314 | * | |
315 | * The following data is protected by this lock: | |
316 | * | |
334f485d | 317 | * - the private_data field of the device file |
d8a5ba45 | 318 | * - the s_fs_info field of the super block |
334f485d | 319 | * - unused_list, pending, processing lists in fuse_conn |
1e9a4ed9 | 320 | * - background list in fuse_conn |
334f485d | 321 | * - the unique request ID counter reqctr in fuse_conn |
d8a5ba45 | 322 | * - the sb (super_block) field in fuse_conn |
334f485d | 323 | * - the file (device file) field in fuse_conn |
d8a5ba45 MS |
324 | */ |
325 | extern spinlock_t fuse_lock; | |
326 | ||
e5e5558e MS |
327 | /** |
328 | * Get a filled in inode | |
329 | */ | |
330 | struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid, | |
9e6268db | 331 | int generation, struct fuse_attr *attr); |
e5e5558e MS |
332 | |
333 | /** | |
334 | * Send FORGET command | |
335 | */ | |
336 | void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req, | |
9e6268db | 337 | unsigned long nodeid, u64 nlookup); |
e5e5558e | 338 | |
04730fef MS |
339 | /** |
340 | * Send READ or READDIR request | |
341 | */ | |
342 | size_t fuse_send_read_common(struct fuse_req *req, struct file *file, | |
343 | struct inode *inode, loff_t pos, size_t count, | |
344 | int isdir); | |
345 | ||
346 | /** | |
347 | * Send OPEN or OPENDIR request | |
348 | */ | |
349 | int fuse_open_common(struct inode *inode, struct file *file, int isdir); | |
350 | ||
fd72faac MS |
351 | struct fuse_file *fuse_file_alloc(void); |
352 | void fuse_file_free(struct fuse_file *ff); | |
353 | void fuse_finish_open(struct inode *inode, struct file *file, | |
354 | struct fuse_file *ff, struct fuse_open_out *outarg); | |
355 | ||
356 | /** | |
357 | * Send a RELEASE request | |
358 | */ | |
359 | void fuse_send_release(struct fuse_conn *fc, struct fuse_file *ff, | |
360 | u64 nodeid, struct inode *inode, int flags, int isdir); | |
361 | ||
04730fef MS |
362 | /** |
363 | * Send RELEASE or RELEASEDIR request | |
364 | */ | |
365 | int fuse_release_common(struct inode *inode, struct file *file, int isdir); | |
366 | ||
82547981 MS |
367 | /** |
368 | * Send FSYNC or FSYNCDIR request | |
369 | */ | |
370 | int fuse_fsync_common(struct file *file, struct dentry *de, int datasync, | |
371 | int isdir); | |
372 | ||
b6aeaded | 373 | /** |
1779381d | 374 | * Initialize file operations on a regular file |
b6aeaded MS |
375 | */ |
376 | void fuse_init_file_inode(struct inode *inode); | |
377 | ||
e5e5558e | 378 | /** |
1779381d | 379 | * Initialize inode operations on regular files and special files |
e5e5558e MS |
380 | */ |
381 | void fuse_init_common(struct inode *inode); | |
382 | ||
383 | /** | |
1779381d | 384 | * Initialize inode and file operations on a directory |
e5e5558e MS |
385 | */ |
386 | void fuse_init_dir(struct inode *inode); | |
387 | ||
388 | /** | |
1779381d | 389 | * Initialize inode operations on a symlink |
e5e5558e MS |
390 | */ |
391 | void fuse_init_symlink(struct inode *inode); | |
392 | ||
393 | /** | |
394 | * Change attributes of an inode | |
395 | */ | |
396 | void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr); | |
397 | ||
d8a5ba45 MS |
398 | /** |
399 | * Check if the connection can be released, and if yes, then free the | |
400 | * connection structure | |
401 | */ | |
402 | void fuse_release_conn(struct fuse_conn *fc); | |
403 | ||
334f485d MS |
404 | /** |
405 | * Initialize the client device | |
406 | */ | |
407 | int fuse_dev_init(void); | |
408 | ||
409 | /** | |
410 | * Cleanup the client device | |
411 | */ | |
412 | void fuse_dev_cleanup(void); | |
413 | ||
414 | /** | |
415 | * Allocate a request | |
416 | */ | |
417 | struct fuse_req *fuse_request_alloc(void); | |
418 | ||
419 | /** | |
420 | * Free a request | |
421 | */ | |
422 | void fuse_request_free(struct fuse_req *req); | |
423 | ||
424 | /** | |
425 | * Reinitialize a request, the preallocated flag is left unmodified | |
426 | */ | |
427 | void fuse_reset_request(struct fuse_req *req); | |
428 | ||
429 | /** | |
430 | * Reserve a preallocated request | |
431 | */ | |
432 | struct fuse_req *fuse_get_request(struct fuse_conn *fc); | |
433 | ||
334f485d MS |
434 | /** |
435 | * Decrement reference count of a request. If count goes to zero put | |
1779381d | 436 | * on unused list (preallocated) or free request (not preallocated). |
334f485d MS |
437 | */ |
438 | void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req); | |
439 | ||
440 | /** | |
7c352bdf | 441 | * Send a request (synchronous) |
334f485d MS |
442 | */ |
443 | void request_send(struct fuse_conn *fc, struct fuse_req *req); | |
444 | ||
334f485d MS |
445 | /** |
446 | * Send a request with no reply | |
447 | */ | |
448 | void request_send_noreply(struct fuse_conn *fc, struct fuse_req *req); | |
449 | ||
450 | /** | |
451 | * Send a request in the background | |
452 | */ | |
453 | void request_send_background(struct fuse_conn *fc, struct fuse_req *req); | |
454 | ||
1e9a4ed9 | 455 | /** |
1779381d | 456 | * Release inodes and file associated with background request |
1e9a4ed9 MS |
457 | */ |
458 | void fuse_release_background(struct fuse_req *req); | |
459 | ||
e5e5558e MS |
460 | /** |
461 | * Get the attributes of a file | |
462 | */ | |
463 | int fuse_do_getattr(struct inode *inode); | |
464 | ||
465 | /** | |
466 | * Invalidate inode attributes | |
467 | */ | |
468 | void fuse_invalidate_attr(struct inode *inode); | |
469 | ||
334f485d MS |
470 | /** |
471 | * Send the INIT message | |
472 | */ | |
473 | void fuse_send_init(struct fuse_conn *fc); |