man4/fuse.4

   1 .\" Copyright (c) 2016 Julia Computing Inc, Keno Fischer
   2 .\" Description based on include/uapi/fuse.h and code in fs/fuse
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH FUSE 4 2016-12-10 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 /dev/fuse \- Filesystem in Userspace (FUSE) device
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <linux/fuse.h>
  32 .nf
  33 .SH DESCRIPTION
  34
  35 This device is the primary interface between the FUSE filesystem driver
  36 and a user-space process wishing to provide the filesystem (referred to
  37 in the rest of this manual page as the
  38 .IR "filesystem daemon" ).
  39 This manual page is intended for those
  40 interested in understanding the kernel interface itself.
  41 Those implementing a FUSE filesystem may wish to make use of
  42 a user-space library such as
  43 .I libfuse
  44 that abstracts away the low-level interface.
  45
  46 At its core, FUSE is a simple client-server protocol, in which the Linux
  47 kernel is the client and the daemon is the server.
  48 After obtaining a file descriptor for this device, the daemon may
  49 .BR read (2)
  50 requests from that file descriptor and is expected to
  51 .BR write (2)
  52 back its replies.
  53 It is important to note that a file descriptor is
  54 associated with a unique FUSE filesystem.
  55 In particular, opening a second copy of this device,
  56 will not allow access to resources created
  57 through the first file descriptor (and vice versa).
  58 .\"
  59 .SS The basic protocol
  60 Every message that is read by the daemon begins with a header described by
  61 the following structure:
  62
  63 .in +4n
  64 .nf
  65 struct fuse_in_header {
  66     uint32_t len;       /* Total length of the data,
  67                            including this header */
  68     uint32_t opcode;    /* The kind of operation (see below) */
  69     uint64_t unique;    /* A unique identifier for this request */
  70     uint64_t nodeid;    /* ID of the filesystem object
  71                            being operated on */
  72     uint32_t uid;       /* UID of the requesting process */
  73     uint32_t gid;       /* GID of the requesting process */
  74     uint32_t pid;       /* PID of the requesting process */
  75     uint32_t padding;
  76 };
  77 .fi
  78 .in
  79
  80 The header is followed by a variable-length data portion
  81 (which may be empty) specific to the requested operation
  82 (the requested operation is indicated by
  83 .IR opcode ).
  84
  85 The daemon should then process the request and if applicable send
  86 a reply (almost all operations require a reply; if they do not,
  87 this is documented below), by performing a
  88 .BR write (2)
  89 to the file descriptor.
  90 All replies must start with the following header:
  91
  92 .in +4n
  93 .nf
  94 struct fuse_out_header {
  95     uint32_t len;       /* Total length of data written to
  96                            the file descriptor */
  97     int32_t  error;     /* Any error that occurred (0 if none) */
  98     uint64_t unique;    /* The value from the
  99                            corresponding request */
 100 };
 101 .fi
 102 .in
 103
 104 This header is also followed by (potentially empty) variable-sized
 105 data depending on the executed request.
 106 However, if the reply is an error reply (i.e.,
 107 .I error
 108 is set),
 109 then no further payload data should be sent, independent of the request.
 110 .\"
 111 .SS Exchanged messages
 112 This section should contain documentation for each of the messages
 113 in the protocol.
 114 This manual page is currently incomplete,
 115 so not all messages are documented.
 116 For each message, first the struct sent by the kernel is given,
 117 followed by a description of the semantics of the message.
 118 .TP
 119 .BR FUSE_INIT " ( 25 )"
 120
 121 .in +4n
 122 .nf
 123 struct fuse_init_in {
 124     uint32_t major;
 125     uint32_t minor;
 126     uint32_t max_readahead; /* Since protocol v7.6 */
 127     uint32_t flags;         /* Since protocol v7.6 */
 128 };
 129 .fi
 130 .in
 131
 132 This is the first request sent by the kernel to the daemon.
 133 It is used to negotiate the protocol version and other filesystem parameters.
 134 Note that the protocol version may affect the layout of any structure
 135 in the protocol (including this structure).
 136 The daemon must thus remember the negotiated version
 137 and flags for each session.
 138 As of the writing of this man page,
 139 the highest supported kernel protocol version is
 140 .IR 7.26 .
 141
 142 Users should be aware that the descriptions in this manual page
 143 may be incomplete or incorrect for older or more recent protocol versions.
 144
 145 The reply for this request has the following format:
 146
 147 .in +4n
 148 .nf
 149 struct fuse_init_out {
 150     uint32_t major;
 151     uint32_t minor;
 152     uint32_t max_readahead;   /* Since v7.6 */
 153     uint32_t flags;           /* Since v7.6; some flags bits
 154                                  were introduced later */
 155     uint16_t max_background;  /* Since v7.13 */
 156     uint16_t congestion_threshold;  /* Since v7.13 */
 157     uint32_t max_write;       /* Since v7.5 */
 158     uint32_t time_gran;       /* Since v7.6 */
 159     uint32_t unused[9];
 160 };
 161 .fi
 162 .in
 163
 164 If the major version supported by the kernel is larger than that supported
 165 by the daemon, the reply shall consist of only
 166 .I uint32_t major
 167 (following the usual header),
 168 indicating the largest major version supported by the daemon.
 169 The kernel will then issue a new
 170 .B FUSE_INIT
 171 request conforming to the older version.
 172 In the reverse case, the daemon should
 173 quietly fall back to the kernel's major version.
 174
 175 The negotiated minor version is considered to be the minimum
 176 of the minor versions provided by the daemon and the kernel and
 177 both parties should use the protocol corresponding to said minor version.
 178 .TP
 179 .BR FUSE_GETATTR " ( 3 )"
 180 .\" FIXME It looks like this is for implementing a stat(2) type of
 181 .\" operation. There needs to be a sentence here describing what
 182 .\" this option does.
 183
 184 .in +4n
 185 .nf
 186 struct fuse_getattr_in {
 187     uint32_t getattr_flags;
 188     uint32_t dummy;
 189     uint64_t fh;      /* Set only if
 190                          (getattr_flags & FUSE_GETATTR_FH)
 191 };
 192 .fi
 193 .in
 194
 195 As usual, the filesystem object operated on is indicated by
 196 .IR header\->nodeid .
 197 The daemon should compute the attributes
 198 of this object and reply with the following message:
 199 .in +4n
 200
 201 .nf
 202 struct fuse_attr {
 203     uint64_t ino;
 204     uint64_t size;
 205     uint64_t blocks;
 206     uint64_t atime;
 207     uint64_t mtime;
 208     uint64_t ctime;
 209     uint32_t atimensec;
 210     uint32_t mtimensec;
 211     uint32_t ctimensec;
 212     uint32_t mode;
 213     uint32_t nlink;
 214     uint32_t uid;
 215     uint32_t gid;
 216     uint32_t rdev;
 217     uint32_t blksize;
 218     uint32_t padding;
 219 };
 220
 221 struct fuse_attr_out {
 222     /* Attribute cache duration (seconds + nanoseconds) */
 223     uint64_t attr_valid;
 224     uint32_t attr_valid_nsec;
 225     uint32_t dummy;
 226     struct fuse_attr attr;
 227 };
 228 .fi
 229 .in
 230
 231 The fields of
 232 .I struct fuse_attr
 233 describe the attributes of the required file.
 234 For the interpretation of these fields, see
 235 .BR stat (2).
 236 .TP
 237 .BR FUSE_ACCESS " ( 34 )"
 238
 239 .in +4n
 240 .nf
 241 struct fuse_access_in {
 242     uint32_t mask;
 243     uint32_t padding;
 244 };
 245 .fi
 246 .in
 247
 248 If the
 249 .I default_permissions
 250 mount options is not used, this request may be used for permissions checking.
 251 No reply data is expected, but errors may be indicated
 252 as usual in the reply header (in particular, access denied errors
 253 may be indicated, by setting such field to
 254 .BR \-EACCES ).
 255 .TP
 256 .BR FUSE_OPEN " ( 14 ) and " FUSE_OPENDIR " ( 34 )"
 257 .in +4n
 258 .nf
 259 struct fuse_open_in {
 260     uint32_t flags;     /* The flags that were passed
 261                            to the open(2) */
 262     uint32_t unused;
 263 };
 264 .fi
 265 .in
 266
 267 The requested operation is to open the node indicated by
 268 .IR header\->nodeid .
 269 The exact semantics of what this means will depend on the
 270 filesystem being implemented.
 271 However, at the very least the
 272 filesystem should validate that the requested
 273 .I flags
 274 are valid for the indicated resource and then send a reply with the
 275 following format:
 276
 277 .in +4n
 278 .nf
 279
 280 struct fuse_open_out {
 281     uint64_t fh;
 282     uint32_t open_flags;
 283     uint32_t padding;
 284 };
 285
 286 .fi
 287 .in
 288
 289 The
 290 .I fh
 291 field is an opaque identifier that the kernel will use to refer
 292 to this resource
 293 The
 294 .I open_flags
 295 field is a bit mask of any number of
 296 .B FOPEN_*
 297 flags, which indicate properties of this file handle to the kernel.
 298 .TP
 299 .BR FUSE_READ " ( 15 ) and " FUSE_READDIR " ( 28 )"
 300 .in +4n
 301 .nf
 302
 303 struct fuse_read_in {
 304     uint64_t fh;
 305     uint64_t offset;
 306     uint32_t size;
 307     uint32_t read_flags;
 308     uint64_t lock_owner;
 309     uint32_t flags;
 310     uint32_t padding;
 311 };
 312
 313 .fi
 314 .in
 315
 316 The requested action is to read up to
 317 .I size
 318 bytes of the file or directory, starting at
 319 .IR offset .
 320 The bytes should be returned directly following the out header,
 321 with no further special out structure.
 322 .TP
 323 .BR FUSE_INTERRUPT " ( 36 )"
 324 .in +4n
 325 .nf
 326 struct fuse_interrupt_in {
 327     uint64_t unique;
 328 };
 329 .fi
 330 .in
 331
 332 The requested action is to cancel the pending operation indicated by
 333 .IR unique .
 334 This request requires no response.
 335 However, receipt of this message does
 336 not by itself cancel the indicated operation.
 337 The kernel will still expect a reply to said operation (e.g., an
 338 .I EINTR
 339 error or a short read).
 340 At most one
 341 .B FUSE_INTERRUPT
 342 request will be issued for a given operation.
 343 After issuing said operation,
 344 the kernel will wait uninterruptibly for completion of the indicated request.
 345 .TP
 346 .BR FUSE_LOOKUP " ( 1 )"
 347 Directly following the header is a filename to be looked up in the directory
 348 indicated by
 349 .IR header\->nodeid .
 350 The expected reply is of the form:
 351
 352 .in +4n
 353 .nf
 354 struct fuse_entry_out {
 355     uint64_t nodeid;            /* Inode ID */
 356     uint64_t generation;        /* Inode generation */
 357     uint64_t entry_valid;
 358     uint64_t attr_valid;
 359     uint32_t entry_valid_nsec;
 360     uint32_t attr_valid_nsec;
 361     struct fuse_attr attr;
 362 };
 363 .fi
 364 .in
 365
 366 The combination of
 367 .I nodeid
 368 and
 369 .I generation
 370 must be unique for the filesystem's lifetime.
 371
 372 The interpretation of timeouts and
 373 .I attr
 374 is as for
 375 .BR FUSE_GETATTR .
 376 .TP
 377 .BR FUSE_FLUSH " ( 36 )"
 378 .in +4n
 379 .nf
 380 struct fuse_flush_in {
 381     uint64_t fh;
 382     uint32_t unused;
 383     uint32_t padding;
 384     uint64_t lock_owner;
 385 };
 386 .fi
 387 .in
 388
 389 The requested action is to flush any pending changes to the indicated
 390 file handle.
 391 No reply data is expected.
 392 However, an empty reply message
 393 still needs to be issued once the flush operation is complete.
 394 .TP
 395 .BR FUSE_RELEASE " ( 18 ) and " FUSE_RELEASEDIR " ( 29 )"
 396 .in +4n
 397 .nf
 398 struct fuse_release_in {
 399     uint64_t fh;
 400     uint32_t flags;
 401     uint32_t release_flags;
 402     uint64_t lock_owner;
 403 };
 404 .fi
 405 .in
 406
 407 These are the converse of
 408 .BR FUSE_OPEN
 409 and
 410 .BR FUSE_OPENDIR
 411 respectively.
 412 The daemon may now free any resources associated with the
 413 file handle
 414 .I fh
 415 as the kernel will no longer refer to it.
 416 There is no reply data associated with this request,
 417 but a reply still needs to be issued once the request has
 418 been completely processed.
 419 .TP
 420 .BR FUSE_STATFS " ( 17 )"
 421 This operation implements
 422 .BR statfs (2)
 423 for this filesystem.
 424 There is no input data associated with this request.
 425 The expected reply data has the following structure:
 426
 427 .in +4n
 428 .nf
 429 struct fuse_kstatfs {
 430     uint64_t blocks;
 431     uint64_t bfree;
 432     uint64_t bavail;
 433     uint64_t files;
 434     uint64_t ffree;
 435     uint32_t bsize;
 436     uint32_t namelen;
 437     uint32_t frsize;
 438     uint32_t padding;
 439     uint32_t spare[6];
 440 };
 441
 442 struct fuse_statfs_out {
 443     struct fuse_kstatfs st;
 444 };
 445 .fi
 446 .in
 447
 448 For the interpretation of these fields, see
 449 .BR statfs (2).
 450 .SH ERRORS
 451 .TP
 452 .B EPERM
 453 Returned from operations on a
 454 .I /dev/fuse
 455 file descriptor that has not been mounted.
 456 .TP
 457 .B EIO
 458 Returned from
 459 .BR read (2)
 460 operations when the kernel's request is too large for the provided buffer.
 461
 462 .IR Note :
 463 There are various ways in which incorrect use of these interfaces can cause
 464 operations on the provided filesystem's files and directories to fail with
 465 .BR EIO .
 466 Among the possible incorrect uses are
 467 .IP * 3
 468 changing
 469 .I mode & S_IFMT
 470 for an inode that has previously been reported to the kernel; or
 471 .IP *
 472 giving replies to the kernel that are shorter than what the kernel expected.
 473 .TP
 474 .B EINVAL
 475 Returned from
 476 .BR write (2)
 477 if validation of the reply failed.
 478 Not all mistakes in replies will be caught by this validation.
 479 However, basic mistakes, such as short replies or an incorrect
 480 .I unique
 481 value, are detected.
 482 .TP
 483 .B E2BIG
 484 Returned from
 485 .BR read (2)
 486 operations when the kernel's request is too large for the provided buffer
 487 and the request was
 488 .BR FUSE_SETXATTR .
 489 .TP
 490 .B ENODEV
 491 Returned from either operation if the FUSE filesystem was unmounted.