fs/fuse/fuse_i.h

   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
  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
  24 /** It could be as large as PATH_MAX, but would that have any uses? */
  25 #define FUSE_NAME_MAX 1024
  26
  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
  36
  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
  46         /** Number of lookups on this inode */
  47         u64 nlookup;
  48
  49         /** The request used for sending the FORGET message */
  50         struct fuse_req *forget_req;
  51
  52         /** Time in jiffies until the file attributes are valid */
  53         unsigned long i_time;
  54 };
  55
  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
  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
 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
 123 /**
 124  * A request to the client
 125  */
 126 struct fuse_req {
 127         /** This can be on either unused_list, pending processing or
 128             io lists in fuse_conn */
 129         struct list_head list;
 130
 131         /** Entry on the background list */
 132         struct list_head bg_entry;
 133
 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
 152         /** State of the request */
 153         enum fuse_req_state state;
 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 {
 166                 struct fuse_forget_in forget_in;
 167                 struct fuse_release_in release_in;
 168                 struct fuse_init_in init_in;
 169                 struct fuse_init_out init_out;
 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
 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 {
 199         /** Reference count */
 200         int count;
 201
 202         /** The user id for this mount */
 203         uid_t user_id;
 204
 205         /** The group id for this mount */
 206         gid_t group_id;
 207
 208         /** The fuse mount flags for this mount */
 209         unsigned flags;
 210
 211         /** Maximum read size */
 212         unsigned max_read;
 213
 214         /** Maximum write size */
 215         unsigned max_write;
 216
 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
 226         /** The list of requests under I/O */
 227         struct list_head io;
 228
 229         /** Requests put in the background (RELEASE or any other
 230             interrupted request) */
 231         struct list_head background;
 232
 233         /** Controls the maximum number of outstanding requests */
 234         struct semaphore outstanding_sem;
 235
 236         /** This counts the number of outstanding requests if
 237             outstanding_sem would go negative */
 238         unsigned outstanding_debt;
 239
 240         /** RW semaphore for exclusion with fuse_put_super() */
 241         struct rw_semaphore sbput_sem;
 242
 243         /** The list of unused requests */
 244         struct list_head unused_list;
 245
 246         /** The next unique request id */
 247         u64 reqctr;
 248
 249         /** Mount is active */
 250         unsigned mounted : 1;
 251
 252         /** Connection established, cleared on umount and device
 253             release */
 254         unsigned connected : 1;
 255
 256         /** Connection failed (version mismatch) */
 257         unsigned conn_error : 1;
 258
 259         /** Is fsync not implemented by fs? */
 260         unsigned no_fsync : 1;
 261
 262         /** Is fsyncdir not implemented by fs? */
 263         unsigned no_fsyncdir : 1;
 264
 265         /** Is flush not implemented by fs? */
 266         unsigned no_flush : 1;
 267
 268         /** Is setxattr not implemented by fs? */
 269         unsigned no_setxattr : 1;
 270
 271         /** Is getxattr not implemented by fs? */
 272         unsigned no_getxattr : 1;
 273
 274         /** Is listxattr not implemented by fs? */
 275         unsigned no_listxattr : 1;
 276
 277         /** Is removexattr not implemented by fs? */
 278         unsigned no_removexattr : 1;
 279
 280         /** Is access not implemented by fs? */
 281         unsigned no_access : 1;
 282
 283         /** Is create not implemented by fs? */
 284         unsigned no_create : 1;
 285
 286         /** Negotiated minor version */
 287         unsigned minor;
 288
 289         /** Backing dev info */
 290         struct backing_dev_info bdi;
 291 };
 292
 293 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
 294 {
 295         return sb->s_fs_info;
 296 }
 297
 298 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
 299 {
 300         return get_fuse_conn_super(inode->i_sb);
 301 }
 302
 303 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
 304 {
 305         return container_of(inode, struct fuse_inode, inode);
 306 }
 307
 308 static inline u64 get_node_id(struct inode *inode)
 309 {
 310         return get_fuse_inode(inode)->nodeid;
 311 }
 312
 313 /** Device operations */
 314 extern struct file_operations fuse_dev_operations;
 315
 316 /**
 317  * This is the single global spinlock which protects FUSE's structures
 318  *
 319  * The following data is protected by this lock:
 320  *
 321  *  - the private_data field of the device file
 322  *  - the s_fs_info field of the super block
 323  *  - unused_list, pending, processing lists in fuse_conn
 324  *  - background list in fuse_conn
 325  *  - the unique request ID counter reqctr in fuse_conn
 326  *  - the sb (super_block) field in fuse_conn
 327  *  - the file (device file) field in fuse_conn
 328  */
 329 extern spinlock_t fuse_lock;
 330
 331 /**
 332  * Get a filled in inode
 333  */
 334 struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
 335                         int generation, struct fuse_attr *attr);
 336
 337 /**
 338  * Send FORGET command
 339  */
 340 void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
 341                       unsigned long nodeid, u64 nlookup);
 342
 343 /**
 344  * Send READ or READDIR request
 345  */
 346 size_t fuse_send_read_common(struct fuse_req *req, struct file *file,
 347                              struct inode *inode, loff_t pos, size_t count,
 348                              int isdir);
 349
 350 /**
 351  * Send OPEN or OPENDIR request
 352  */
 353 int fuse_open_common(struct inode *inode, struct file *file, int isdir);
 354
 355 struct fuse_file *fuse_file_alloc(void);
 356 void fuse_file_free(struct fuse_file *ff);
 357 void fuse_finish_open(struct inode *inode, struct file *file,
 358                       struct fuse_file *ff, struct fuse_open_out *outarg);
 359
 360 /**
 361  * Send a RELEASE request
 362  */
 363 void fuse_send_release(struct fuse_conn *fc, struct fuse_file *ff,
 364                        u64 nodeid, struct inode *inode, int flags, int isdir);
 365
 366 /**
 367  * Send RELEASE or RELEASEDIR request
 368  */
 369 int fuse_release_common(struct inode *inode, struct file *file, int isdir);
 370
 371 /**
 372  * Send FSYNC or FSYNCDIR request
 373  */
 374 int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
 375                       int isdir);
 376
 377 /**
 378  * Initialize file operations on a regular file
 379  */
 380 void fuse_init_file_inode(struct inode *inode);
 381
 382 /**
 383  * Initialize inode operations on regular files and special files
 384  */
 385 void fuse_init_common(struct inode *inode);
 386
 387 /**
 388  * Initialize inode and file operations on a directory
 389  */
 390 void fuse_init_dir(struct inode *inode);
 391
 392 /**
 393  * Initialize inode operations on a symlink
 394  */
 395 void fuse_init_symlink(struct inode *inode);
 396
 397 /**
 398  * Change attributes of an inode
 399  */
 400 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr);
 401
 402 /**
 403  * Check if the connection can be released, and if yes, then free the
 404  * connection structure
 405  */
 406 void fuse_release_conn(struct fuse_conn *fc);
 407
 408 /**
 409  * Initialize the client device
 410  */
 411 int fuse_dev_init(void);
 412
 413 /**
 414  * Cleanup the client device
 415  */
 416 void fuse_dev_cleanup(void);
 417
 418 /**
 419  * Allocate a request
 420  */
 421 struct fuse_req *fuse_request_alloc(void);
 422
 423 /**
 424  * Free a request
 425  */
 426 void fuse_request_free(struct fuse_req *req);
 427
 428 /**
 429  * Reinitialize a request, the preallocated flag is left unmodified
 430  */
 431 void fuse_reset_request(struct fuse_req *req);
 432
 433 /**
 434  * Reserve a preallocated request
 435  */
 436 struct fuse_req *fuse_get_request(struct fuse_conn *fc);
 437
 438 /**
 439  * Decrement reference count of a request.  If count goes to zero put
 440  * on unused list (preallocated) or free request (not preallocated).
 441  */
 442 void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
 443
 444 /**
 445  * Send a request (synchronous)
 446  */
 447 void request_send(struct fuse_conn *fc, struct fuse_req *req);
 448
 449 /**
 450  * Send a request with no reply
 451  */
 452 void request_send_noreply(struct fuse_conn *fc, struct fuse_req *req);
 453
 454 /**
 455  * Send a request in the background
 456  */
 457 void request_send_background(struct fuse_conn *fc, struct fuse_req *req);
 458
 459 /**
 460  * Release inodes and file associated with background request
 461  */
 462 void fuse_release_background(struct fuse_req *req);
 463
 464 /**
 465  * Get the attributes of a file
 466  */
 467 int fuse_do_getattr(struct inode *inode);
 468
 469 /**
 470  * Invalidate inode attributes
 471  */
 472 void fuse_invalidate_attr(struct inode *inode);
 473
 474 /**
 475  * Send the INIT message
 476  */
 477 void fuse_send_init(struct fuse_conn *fc);