fuse_i.h 9.8 KB
Newer Older
M
Miklos Szeredi 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
  FUSE: Filesystem in Userspace
  Copyright (C) 2001-2005  Miklos Szeredi <miklos@szeredi.hu>

  This program can be distributed under the terms of the GNU GPL.
  See the file COPYING.
*/

#include <linux/fuse.h>
#include <linux/fs.h>
#include <linux/wait.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/mm.h>
#include <linux/backing-dev.h>
#include <asm/semaphore.h>

M
Miklos Szeredi 已提交
18 19 20 21 22 23
/** Max number of pages that can be used in a single read request */
#define FUSE_MAX_PAGES_PER_REQ 32

/** If more requests are outstanding, then the operation will block */
#define FUSE_MAX_OUTSTANDING 10

M
Miklos Szeredi 已提交
24 25 26 27 28 29 30 31 32 33 34 35 36
/** If the FUSE_DEFAULT_PERMISSIONS flag is given, the filesystem
    module will check permissions based on the file mode.  Otherwise no
    permission checking is done in the kernel */
#define FUSE_DEFAULT_PERMISSIONS (1 << 0)

/** If the FUSE_ALLOW_OTHER flag is given, then not only the user
    doing the mount will be allowed to access the filesystem */
#define FUSE_ALLOW_OTHER         (1 << 1)

/** If the FUSE_KERNEL_CACHE flag is given, then cached data will not
    be flushed on open */
#define FUSE_KERNEL_CACHE        (1 << 2)

M
Miklos Szeredi 已提交
37 38 39 40 41 42 43 44 45
/** FUSE inode */
struct fuse_inode {
	/** Inode data */
	struct inode inode;

	/** Unique ID, which identifies the inode between userspace
	 * and kernel */
	u64 nodeid;

46 47 48
	/** Number of lookups on this inode */
	u64 nlookup;

49 50 51
	/** The request used for sending the FORGET message */
	struct fuse_req *forget_req;

M
Miklos Szeredi 已提交
52 53 54 55
	/** Time in jiffies until the file attributes are valid */
	unsigned long i_time;
};

M
Miklos Szeredi 已提交
56 57 58 59 60 61 62 63 64
/** FUSE specific file data */
struct fuse_file {
	/** Request reserved for flush and release */
	struct fuse_req *release_req;

	/** File handle used by userspace */
	u64 fh;
};

M
Miklos Szeredi 已提交
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
/** One input argument of a request */
struct fuse_in_arg {
	unsigned size;
	const void *value;
};

/** The request input */
struct fuse_in {
	/** The request header */
	struct fuse_in_header h;

	/** True if the data for the last argument is in req->pages */
	unsigned argpages:1;

	/** Number of arguments */
	unsigned numargs;

	/** Array of arguments */
	struct fuse_in_arg args[3];
};

/** One output argument of a request */
struct fuse_arg {
	unsigned size;
	void *value;
};

/** The request output */
struct fuse_out {
	/** Header returned from userspace */
	struct fuse_out_header h;

	/** Last argument is variable length (can be shorter than
	    arg->size) */
	unsigned argvar:1;

	/** Last argument is a list of pages to copy data to */
	unsigned argpages:1;

	/** Zero partially or not copied pages */
	unsigned page_zeroing:1;

	/** Number or arguments */
	unsigned numargs;

	/** Array of arguments */
	struct fuse_arg args[3];
};

struct fuse_req;
struct fuse_conn;

/**
 * A request to the client
 */
struct fuse_req {
	/** This can be on either unused_list, pending or processing
	    lists in fuse_conn */
	struct list_head list;

M
Miklos Szeredi 已提交
125 126 127
	/** Entry on the background list */
	struct list_head bg_entry;

M
Miklos Szeredi 已提交
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
	/** refcount */
	atomic_t count;

	/** True if the request has reply */
	unsigned isreply:1;

	/** The request is preallocated */
	unsigned preallocated:1;

	/** The request was interrupted */
	unsigned interrupted:1;

	/** Request is sent in the background */
	unsigned background:1;

	/** Data is being copied to/from the request */
	unsigned locked:1;

	/** Request has been sent to userspace */
	unsigned sent:1;

	/** The request is finished */
	unsigned finished:1;

	/** The request input */
	struct fuse_in in;

	/** The request output */
	struct fuse_out out;

	/** Used to wake up the task waiting for completion of request*/
	wait_queue_head_t waitq;

	/** Data for asynchronous requests */
	union {
163
		struct fuse_forget_in forget_in;
M
Miklos Szeredi 已提交
164
		struct fuse_release_in release_in;
M
Miklos Szeredi 已提交
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
		struct fuse_init_in_out init_in_out;
	} misc;

	/** page vector */
	struct page *pages[FUSE_MAX_PAGES_PER_REQ];

	/** number of pages in vector */
	unsigned num_pages;

	/** offset of data on first page */
	unsigned page_offset;

	/** Inode used in the request */
	struct inode *inode;

	/** Second inode used in the request (or NULL) */
	struct inode *inode2;

	/** File used in the request (or NULL) */
	struct file *file;
};

M
Miklos Szeredi 已提交
187 188 189 190 191 192 193 194
/**
 * A Fuse connection.
 *
 * This structure is created, when the filesystem is mounted, and is
 * destroyed, when the client device is closed and the filesystem is
 * unmounted.
 */
struct fuse_conn {
M
Miklos Szeredi 已提交
195 196
	/** Reference count */
	int count;
M
Miklos Szeredi 已提交
197

M
Miklos Szeredi 已提交
198 199 200
	/** The user id for this mount */
	uid_t user_id;

201 202 203
	/** The group id for this mount */
	gid_t group_id;

M
Miklos Szeredi 已提交
204 205 206
	/** The fuse mount flags for this mount */
	unsigned flags;

207 208 209
	/** Maximum read size */
	unsigned max_read;

M
Miklos Szeredi 已提交
210 211 212 213 214 215 216 217 218
	/** Readers of the connection are waiting on this */
	wait_queue_head_t waitq;

	/** The list of pending requests */
	struct list_head pending;

	/** The list of requests being processed */
	struct list_head processing;

M
Miklos Szeredi 已提交
219 220 221 222
	/** Requests put in the background (RELEASE or any other
	    interrupted request) */
	struct list_head background;

M
Miklos Szeredi 已提交
223 224 225 226 227 228 229
	/** Controls the maximum number of outstanding requests */
	struct semaphore outstanding_sem;

	/** This counts the number of outstanding requests if
	    outstanding_sem would go negative */
	unsigned outstanding_debt;

M
Miklos Szeredi 已提交
230 231 232
	/** RW semaphore for exclusion with fuse_put_super() */
	struct rw_semaphore sbput_sem;

M
Miklos Szeredi 已提交
233 234 235 236 237 238
	/** The list of unused requests */
	struct list_head unused_list;

	/** The next unique request id */
	u64 reqctr;

M
Miklos Szeredi 已提交
239 240 241 242 243 244
	/** Mount is active */
	unsigned mounted : 1;

	/** Connection established */
	unsigned connected : 1;

M
Miklos Szeredi 已提交
245 246 247
	/** Connection failed (version mismatch) */
	unsigned conn_error : 1;

M
Miklos Szeredi 已提交
248 249 250 251 252 253
	/** Is fsync not implemented by fs? */
	unsigned no_fsync : 1;

	/** Is flush not implemented by fs? */
	unsigned no_flush : 1;

254 255 256 257 258 259 260 261 262 263 264 265
	/** Is setxattr not implemented by fs? */
	unsigned no_setxattr : 1;

	/** Is getxattr not implemented by fs? */
	unsigned no_getxattr : 1;

	/** Is listxattr not implemented by fs? */
	unsigned no_listxattr : 1;

	/** Is removexattr not implemented by fs? */
	unsigned no_removexattr : 1;

M
Miklos Szeredi 已提交
266 267 268 269
	/** Backing dev info */
	struct backing_dev_info bdi;
};

270 271 272 273 274
struct fuse_getdir_out_i {
	int fd;
	void *file; /* Used by kernel only */
};

M
Miklos Szeredi 已提交
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
static inline struct fuse_conn **get_fuse_conn_super_p(struct super_block *sb)
{
	return (struct fuse_conn **) &sb->s_fs_info;
}

static inline struct fuse_conn *get_fuse_conn_super(struct super_block *sb)
{
	return *get_fuse_conn_super_p(sb);
}

static inline struct fuse_conn *get_fuse_conn(struct inode *inode)
{
	return get_fuse_conn_super(inode->i_sb);
}

static inline struct fuse_inode *get_fuse_inode(struct inode *inode)
{
	return container_of(inode, struct fuse_inode, inode);
}

static inline u64 get_node_id(struct inode *inode)
{
	return get_fuse_inode(inode)->nodeid;
}

M
Miklos Szeredi 已提交
300 301 302
/** Device operations */
extern struct file_operations fuse_dev_operations;

M
Miklos Szeredi 已提交
303 304 305 306 307
/**
 * This is the single global spinlock which protects FUSE's structures
 *
 * The following data is protected by this lock:
 *
M
Miklos Szeredi 已提交
308
 *  - the private_data field of the device file
M
Miklos Szeredi 已提交
309
 *  - the s_fs_info field of the super block
M
Miklos Szeredi 已提交
310
 *  - unused_list, pending, processing lists in fuse_conn
M
Miklos Szeredi 已提交
311
 *  - background list in fuse_conn
M
Miklos Szeredi 已提交
312
 *  - the unique request ID counter reqctr in fuse_conn
M
Miklos Szeredi 已提交
313
 *  - the sb (super_block) field in fuse_conn
M
Miklos Szeredi 已提交
314
 *  - the file (device file) field in fuse_conn
M
Miklos Szeredi 已提交
315 316 317
 */
extern spinlock_t fuse_lock;

318 319 320 321
/**
 * Get a filled in inode
 */
struct inode *fuse_iget(struct super_block *sb, unsigned long nodeid,
322
			int generation, struct fuse_attr *attr);
323 324 325 326 327

/**
 * Send FORGET command
 */
void fuse_send_forget(struct fuse_conn *fc, struct fuse_req *req,
328
		      unsigned long nodeid, u64 nlookup);
329

M
Miklos Szeredi 已提交
330 331 332 333 334
/**
 * Initialise file operations on a regular file
 */
void fuse_init_file_inode(struct inode *inode);

335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
/**
 * Initialise inode operations on regular files and special files
 */
void fuse_init_common(struct inode *inode);

/**
 * Initialise inode and file operations on a directory
 */
void fuse_init_dir(struct inode *inode);

/**
 * Initialise inode operations on a symlink
 */
void fuse_init_symlink(struct inode *inode);

/**
 * Change attributes of an inode
 */
void fuse_change_attributes(struct inode *inode, struct fuse_attr *attr);

M
Miklos Szeredi 已提交
355 356 357 358 359 360
/**
 * Check if the connection can be released, and if yes, then free the
 * connection structure
 */
void fuse_release_conn(struct fuse_conn *fc);

M
Miklos Szeredi 已提交
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
/**
 * Initialize the client device
 */
int fuse_dev_init(void);

/**
 * Cleanup the client device
 */
void fuse_dev_cleanup(void);

/**
 * Allocate a request
 */
struct fuse_req *fuse_request_alloc(void);

/**
 * Free a request
 */
void fuse_request_free(struct fuse_req *req);

/**
 * Reinitialize a request, the preallocated flag is left unmodified
 */
void fuse_reset_request(struct fuse_req *req);

/**
 * Reserve a preallocated request
 */
struct fuse_req *fuse_get_request(struct fuse_conn *fc);

/**
 * Reserve a preallocated request, only interruptible by SIGKILL
 */
struct fuse_req *fuse_get_request_nonint(struct fuse_conn *fc);

/**
 * Decrement reference count of a request.  If count goes to zero put
 * on unused list (preallocated) or free reqest (not preallocated).
 */
void fuse_put_request(struct fuse_conn *fc, struct fuse_req *req);

/**
 * Send a request (synchronous, interruptible)
 */
void request_send(struct fuse_conn *fc, struct fuse_req *req);

/**
 * Send a request (synchronous, non-interruptible except by SIGKILL)
 */
void request_send_nonint(struct fuse_conn *fc, struct fuse_req *req);

/**
 * Send a request with no reply
 */
void request_send_noreply(struct fuse_conn *fc, struct fuse_req *req);

/**
 * Send a request in the background
 */
void request_send_background(struct fuse_conn *fc, struct fuse_req *req);

M
Miklos Szeredi 已提交
422 423 424 425 426
/**
 * Release inodes and file assiciated with background request
 */
void fuse_release_background(struct fuse_req *req);

427 428 429 430 431 432 433 434 435 436
/**
 * Get the attributes of a file
 */
int fuse_do_getattr(struct inode *inode);

/**
 * Invalidate inode attributes
 */
void fuse_invalidate_attr(struct inode *inode);

M
Miklos Szeredi 已提交
437 438 439 440
/**
 * Send the INIT message
 */
void fuse_send_init(struct fuse_conn *fc);