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