git.oblomov.eu Git - linux-2.6/blob - 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 /** Maximum size of data in a write request */
  25 #define FUSE_MAX_WRITE 4096
  26
  27 /** It could be as large as PATH_MAX, but would that have any uses? */
  28 #define FUSE_NAME_MAX 1024
  29
  30 /** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
  31     module will check permissions based on the file mode.  Otherwise no
  32     permission checking is done in the kernel */
  33 #define FUSE_DEFAULT_PERMISSIONS (1 << 0)
  34
  35 /** If the FUSE_ALLOW_OTHER flag is given, then not only the user
  36     doing the mount will be allowed to access the filesystem */
  37 #define FUSE_ALLOW_OTHER         (1 << 1)
  38
  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 /**
 118  * A request to the client
 119  */
 120 struct fuse_req {
 121         /** This can be on either unused_list, pending or processing
 122             lists in fuse_conn */
 123         struct list_head list;
 124
 125         /** Entry on the background list */
 126         struct list_head bg_entry;
 127
 128         /** refcount */
 129         atomic_t count;
 130
 131         /** True if the request has reply */
 132         unsigned isreply:1;
 133
 134         /** The request is preallocated */
 135         unsigned preallocated:1;
 136
 137         /** The request was interrupted */
 138         unsigned interrupted:1;
 139
 140         /** Request is sent in the background */
 141         unsigned background:1;
 142
 143         /** Data is being copied to/from the request */
 144         unsigned locked:1;
 145
 146         /** Request has been sent to userspace */
 147         unsigned sent:1;
 148
 149         /** The request is finished */
 150         unsigned finished:1;
 151
 152         /** The request input */
 153         struct fuse_in in;
 154
 155         /** The request output */
 156         struct fuse_out out;
 157
 158         /** Used to wake up the task waiting for completion of request*/
 159         wait_queue_head_t waitq;
 160
 161         /** Data for asynchronous requests */
 162         union {
 163                 struct fuse_forget_in forget_in;
 164                 struct fuse_release_in release_in;
 165                 struct fuse_init_in_out init_in_out;
 166         } misc;
 167
 168         /** page vector */
 169         struct page *pages[FUSE_MAX_PAGES_PER_REQ];
 170
 171         /** number of pages in vector */
 172         unsigned num_pages;
 173
 174         /** offset of data on first page */
 175         unsigned page_offset;
 176
 177         /** Inode used in the request */
 178         struct inode *inode;
 179
 180         /** Second inode used in the request (or NULL) */
 181         struct inode *inode2;
 182
 183         /** File used in the request (or NULL) */
 184         struct file *file;
 185 };
 186
 187 /**
 188  * A Fuse connection.
 189  *
 190  * This structure is created, when the filesystem is mounted, and is
 191  * destroyed, when the client device is closed and the filesystem is
 192  * unmounted.
 193  */
 194 struct fuse_conn {
 195         /** Reference count */
 196         int count;
 197
 198         /** The user id for this mount */
 199         uid_t user_id;
 200
 201         /** The group id for this mount */
 202         gid_t group_id;
 203
 204         /** The fuse mount flags for this mount */
 205         unsigned flags;
 206
 207         /** Maximum read size */
 208         unsigned max_read;
 209
 210         /** Maximum write size */
 211         unsigned max_write;
 212
 213         /** Readers of the connection are waiting on this */
 214         wait_queue_head_t waitq;
 215
 216         /** The list of pending requests */
 217         struct list_head pending;
 218
 219         /** The list of requests being processed */
 220         struct list_head processing;
 221
 222         /** Requests put in the background (RELEASE or any other
 223             interrupted request) */
 224         struct list_head background;
 225
 226         /** Controls the maximum number of outstanding requests */
 227         struct semaphore outstanding_sem;
 228
 229         /** This counts the number of outstanding requests if
 230             outstanding_sem would go negative */
 231         unsigned outstanding_debt;
 232
 233         /** RW semaphore for exclusion with fuse_put_super() */
 234         struct rw_semaphore sbput_sem;
 235
 236         /** The list of unused requests */
 237         struct list_head unused_list;
 238
 239         /** The next unique request id */
 240         u64 reqctr;
 241
 242         /** Mount is active */
 243         unsigned mounted : 1;
 244
 245         /** Connection established */
 246         unsigned connected : 1;
 247
 248         /** Connection failed (version mismatch) */
 249         unsigned conn_error : 1;
 250
 251         /** Is fsync not implemented by fs? */
 252         unsigned no_fsync : 1;
 253
 254         /** Is fsyncdir not implemented by fs? */
 255         unsigned no_fsyncdir : 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         /** Is access not implemented by fs? */
 273         unsigned no_access : 1;
 274
 275         /** Is create not implemented by fs? */
 276         unsigned no_create : 1;
 277
 278         /** Negotiated minor version */
 279         unsigned minor;
 280
 281         /** Backing dev info */
 282         struct backing_dev_info bdi;
 283 };
 284
 285 static inline struct fuse_conn **get_fuse_conn_super_p(struct super_block *sb)
 286 {
 287         return (struct fuse_conn **) &sb->s_fs_info;
 288 }
 289
 290 static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
 291 {
 292         return *get_fuse_conn_super_p(sb);
 293 }
 294
 295 static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
 296 {
 297         return get_fuse_conn_super(inode->i_sb);
 298 }
 299
 300 static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
 301 {
 302         return container_of(inode, struct fuse_inode, inode);
 303 }
 304
 305 static inline u64 get_node_id(struct inode *inode)
 306 {
 307         return get_fuse_inode(inode)->nodeid;
 308 }
 309
 310 /** Device operations */
 311 extern struct file_operations fuse_dev_operations;
 312
 313 /**
 314  * This is the single global spinlock which protects FUSE's structures
 315  *
 316  * The following data is protected by this lock:
 317  *
 318  *  - the private_data field of the device file
 319  *  - the s_fs_info field of the super block
 320  *  - unused_list, pending, processing lists in fuse_conn
 321  *  - background list in fuse_conn
 322  *  - the unique request ID counter reqctr in fuse_conn
 323  *  - the sb (super_block) field in fuse_conn
 324  *  - the file (device file) field in fuse_conn
 325  */
 326 extern spinlock_t fuse_lock;
 327
 328 /**
 329  * Get a filled in inode
 330  */
 331 struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
 332                         int generation, struct fuse_attr *attr);
 333
 334 /**
 335  * Send FORGET command
 336  */
 337 void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
 338                       unsigned long nodeid, u64 nlookup);
 339
 340 /**
 341  * Send READ or READDIR request
 342  */
 343 size_t fuse_send_read_common(struct fuse_req *req, struct file *file,
 344                              struct inode *inode, loff_t pos, size_t count,
 345                              int isdir);
 346
 347 /**
 348  * Send OPEN or OPENDIR request
 349  */
 350 int fuse_open_common(struct inode *inode, struct file *file, int isdir);
 351
 352 struct fuse_file *fuse_file_alloc(void);
 353 void fuse_file_free(struct fuse_file *ff);
 354 void fuse_finish_open(struct inode *inode, struct file *file,
 355                       struct fuse_file *ff, struct fuse_open_out *outarg);
 356
 357 /**
 358  * Send a RELEASE request
 359  */
 360 void fuse_send_release(struct fuse_conn *fc, struct fuse_file *ff,
 361                        u64 nodeid, struct inode *inode, int flags, int isdir);
 362
 363 /**
 364  * Send RELEASE or RELEASEDIR request
 365  */
 366 int fuse_release_common(struct inode *inode, struct file *file, int isdir);
 367
 368 /**
 369  * Send FSYNC or FSYNCDIR request
 370  */
 371 int fuse_fsync_common(struct file *file, struct dentry *de, int datasync,
 372                       int isdir);
 373
 374 /**
 375  * Initialize file operations on a regular file
 376  */
 377 void fuse_init_file_inode(struct inode *inode);
 378
 379 /**
 380  * Initialize inode operations on regular files and special files
 381  */
 382 void fuse_init_common(struct inode *inode);
 383
 384 /**
 385  * Initialize inode and file operations on a directory
 386  */
 387 void fuse_init_dir(struct inode *inode);
 388
 389 /**
 390  * Initialize inode operations on a symlink
 391  */
 392 void fuse_init_symlink(struct inode *inode);
 393
 394 /**
 395  * Change attributes of an inode
 396  */
 397 void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr);
 398
 399 /**
 400  * Check if the connection can be released, and if yes, then free the
 401  * connection structure
 402  */
 403 void fuse_release_conn(struct fuse_conn *fc);
 404
 405 /**
 406  * Initialize the client device
 407  */
 408 int fuse_dev_init(void);
 409
 410 /**
 411  * Cleanup the client device
 412  */
 413 void fuse_dev_cleanup(void);
 414
 415 /**
 416  * Allocate a request
 417  */
 418 struct fuse_req *fuse_request_alloc(void);
 419
 420 /**
 421  * Free a request
 422  */
 423 void fuse_request_free(struct fuse_req *req);
 424
 425 /**
 426  * Reinitialize a request, the preallocated flag is left unmodified
 427  */
 428 void fuse_reset_request(struct fuse_req *req);
 429
 430 /**
 431  * Reserve a preallocated request
 432  */
 433 struct fuse_req *fuse_get_request(struct fuse_conn *fc);
 434
 435 /**
 436  * Decrement reference count of a request.  If count goes to zero put
 437  * on unused list (preallocated) or free request (not preallocated).
 438  */
 439 void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);
 440
 441 /**
 442  * Send a request (synchronous)
 443  */
 444 void request_send(struct fuse_conn *fc, struct fuse_req *req);
 445
 446 /**
 447  * Send a request with no reply
 448  */
 449 void request_send_noreply(struct fuse_conn *fc, struct fuse_req *req);
 450
 451 /**
 452  * Send a request in the background
 453  */
 454 void request_send_background(struct fuse_conn *fc, struct fuse_req *req);
 455
 456 /**
 457  * Release inodes and file associated with background request
 458  */
 459 void fuse_release_background(struct fuse_req *req);
 460
 461 /**
 462  * Get the attributes of a file
 463  */
 464 int fuse_do_getattr(struct inode *inode);
 465
 466 /**
 467  * Invalidate inode attributes
 468  */
 469 void fuse_invalidate_attr(struct inode *inode);
 470
 471 /**
 472  * Send the INIT message
 473  */
 474 void fuse_send_init(struct fuse_conn *fc);