Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 1 | /* |
| 2 | FUSE: Filesystem in Userspace |
Miklos Szeredi | 149f607 | 2005-01-10 12:29:28 +0000 | [diff] [blame] | 3 | Copyright (C) 2001-2005 Miklos Szeredi <miklos@szeredi.hu> |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 4 | |
Miklos Szeredi | 8b39a9f | 2002-10-25 12:41:16 +0000 | [diff] [blame] | 5 | This program can be distributed under the terms of the GNU LGPL. |
| 6 | See the file COPYING.LIB. |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 7 | */ |
| 8 | |
Miklos Szeredi | acd4e06 | 2001-12-08 20:29:20 +0000 | [diff] [blame] | 9 | #ifndef _FUSE_H_ |
| 10 | #define _FUSE_H_ |
| 11 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 12 | /* This file defines the library interface of FUSE */ |
| 13 | |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 14 | /* IMPORTANT: you should define FUSE_USE_VERSION before including this |
| 15 | header. To use the new API define it to 22 (recommended for any |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 16 | new application), to use the old API define it to 21 (this is the |
| 17 | default), to use the even older 1.X API define it to 11. */ |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 18 | |
Miklos Szeredi | 76c1752 | 2005-07-13 14:08:19 +0000 | [diff] [blame] | 19 | #include "fuse_common.h" |
| 20 | |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 21 | #include <sys/types.h> |
| 22 | #include <sys/stat.h> |
Miklos Szeredi | 18e75e4 | 2004-02-19 14:23:27 +0000 | [diff] [blame] | 23 | #include <sys/statfs.h> |
Miklos Szeredi | 5e18348 | 2001-10-31 14:52:35 +0000 | [diff] [blame] | 24 | #include <utime.h> |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 25 | |
Miklos Szeredi | 8fb48fe | 2004-11-08 14:48:52 +0000 | [diff] [blame] | 26 | #ifdef __cplusplus |
| 27 | extern "C" { |
| 28 | #endif |
| 29 | |
Miklos Szeredi | cc8c975 | 2001-11-21 10:03:39 +0000 | [diff] [blame] | 30 | /* ----------------------------------------------------------- * |
| 31 | * Basic FUSE API * |
| 32 | * ----------------------------------------------------------- */ |
| 33 | |
Miklos Szeredi | 2df1c04 | 2001-11-06 15:07:17 +0000 | [diff] [blame] | 34 | /** Handle for a FUSE filesystem */ |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 35 | struct fuse; |
Miklos Szeredi | 2df1c04 | 2001-11-06 15:07:17 +0000 | [diff] [blame] | 36 | |
Miklos Szeredi | a148242 | 2005-08-14 23:00:27 +0000 | [diff] [blame] | 37 | /** Structure containing a raw command */ |
| 38 | struct fuse_cmd; |
| 39 | |
Miklos Szeredi | 18fce98 | 2005-04-01 21:07:35 +0000 | [diff] [blame] | 40 | /** Function to add an entry in a readdir() operation |
| 41 | * |
| 42 | * @param buf the buffer passed to the readdir() operation |
| 43 | * @param name the file name of the directory entry |
Miklos Szeredi | ab97456 | 2005-04-07 15:40:21 +0000 | [diff] [blame] | 44 | * @param stat file attributes, can be NULL |
| 45 | * @param off offset of the next entry or zero |
| 46 | * @return 1 if buffer is full, zero otherwise |
Miklos Szeredi | 18fce98 | 2005-04-01 21:07:35 +0000 | [diff] [blame] | 47 | */ |
Miklos Szeredi | ab97456 | 2005-04-07 15:40:21 +0000 | [diff] [blame] | 48 | typedef int (*fuse_fill_dir_t) (void *buf, const char *name, |
Miklos Szeredi | f6e0ec6 | 2005-08-03 09:11:06 +0000 | [diff] [blame] | 49 | const struct stat *stbuf, off_t off); |
Miklos Szeredi | ab97456 | 2005-04-07 15:40:21 +0000 | [diff] [blame] | 50 | |
| 51 | /* Used by deprecated getdir() method */ |
| 52 | typedef struct fuse_dirhandle *fuse_dirh_t; |
| 53 | typedef int (*fuse_dirfil_t) (fuse_dirh_t h, const char *name, int type, |
| 54 | ino_t ino); |
Miklos Szeredi | 18fce98 | 2005-04-01 21:07:35 +0000 | [diff] [blame] | 55 | |
Miklos Szeredi | 2df1c04 | 2001-11-06 15:07:17 +0000 | [diff] [blame] | 56 | /** |
| 57 | * The file system operations: |
| 58 | * |
| 59 | * Most of these should work very similarly to the well known UNIX |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 60 | * file system operations. A major exception is that instead of |
| 61 | * returning an error in 'errno', the operation should return the |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 62 | * negated error value (-errno) directly. |
Miklos Szeredi | e56818b | 2004-12-12 11:45:24 +0000 | [diff] [blame] | 63 | * |
| 64 | * All methods are optional, but some are essential for a useful |
Miklos Szeredi | 31066bb | 2005-08-01 14:49:31 +0000 | [diff] [blame] | 65 | * filesystem (e.g. getattr). Open, flush, release, fsync, opendir, |
| 66 | * releasedir, fsyncdir, init and destroy are special purpose methods, |
| 67 | * without which a full featured filesystem can still be implemented. |
Miklos Szeredi | e2e4ac2 | 2004-05-18 08:45:28 +0000 | [diff] [blame] | 68 | */ |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 69 | struct fuse_operations { |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 70 | /** Get file attributes. |
| 71 | * |
| 72 | * Similar to stat(). The 'st_dev' and 'st_blksize' fields are |
| 73 | * ignored. The 'st_ino' field is ignored except if the 'use_ino' |
| 74 | * mount option is given. |
| 75 | */ |
| 76 | int (*getattr) (const char *, struct stat *); |
| 77 | |
| 78 | /** Read the target of a symbolic link |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 79 | * |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 80 | * The buffer should be filled with a null terminated string. The |
| 81 | * buffer size argument includes the space for the terminating |
| 82 | * null character. If the linkname is too long to fit in the |
| 83 | * buffer, it should be truncated. The return value should be 0 |
| 84 | * for success. |
| 85 | */ |
| 86 | int (*readlink) (const char *, char *, size_t); |
| 87 | |
Miklos Szeredi | ab97456 | 2005-04-07 15:40:21 +0000 | [diff] [blame] | 88 | /* Deprecated, use readdir() instead */ |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 89 | int (*getdir) (const char *, fuse_dirh_t, fuse_dirfil_t); |
| 90 | |
| 91 | /** Create a file node |
| 92 | * |
| 93 | * There is no create() operation, mknod() will be called for |
| 94 | * creation of all non-directory, non-symlink nodes. |
| 95 | */ |
| 96 | int (*mknod) (const char *, mode_t, dev_t); |
| 97 | |
| 98 | /** Create a directory */ |
| 99 | int (*mkdir) (const char *, mode_t); |
| 100 | |
| 101 | /** Remove a file */ |
| 102 | int (*unlink) (const char *); |
| 103 | |
| 104 | /** Remove a directory */ |
| 105 | int (*rmdir) (const char *); |
| 106 | |
| 107 | /** Create a symbolic link */ |
| 108 | int (*symlink) (const char *, const char *); |
| 109 | |
| 110 | /** Rename a file */ |
| 111 | int (*rename) (const char *, const char *); |
| 112 | |
| 113 | /** Create a hard link to a file */ |
| 114 | int (*link) (const char *, const char *); |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 115 | |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 116 | /** Change the permission bits of a file */ |
| 117 | int (*chmod) (const char *, mode_t); |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 118 | |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 119 | /** Change the owner and group of a file */ |
| 120 | int (*chown) (const char *, uid_t, gid_t); |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 121 | |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 122 | /** Change the size of a file */ |
| 123 | int (*truncate) (const char *, off_t); |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 124 | |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 125 | /** Change the access and/or modification times of a file */ |
| 126 | int (*utime) (const char *, struct utimbuf *); |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 127 | |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 128 | /** File open operation |
| 129 | * |
| 130 | * No creation, or trunctation flags (O_CREAT, O_EXCL, O_TRUNC) |
Miklos Szeredi | fa84866 | 2005-09-08 15:16:14 +0000 | [diff] [blame^] | 131 | * will be passed to open(). Open should check if the operation |
| 132 | * is permitted for the given flags. Optionally open may also |
| 133 | * return an arbitary filehandle in the fuse_file_info structure, |
| 134 | * which will be passed to all file operations. |
Miklos Szeredi | 31066bb | 2005-08-01 14:49:31 +0000 | [diff] [blame] | 135 | * |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 136 | * Changed in version 2.2 |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 137 | */ |
| 138 | int (*open) (const char *, struct fuse_file_info *); |
| 139 | |
| 140 | /** Read data from an open file |
| 141 | * |
| 142 | * Read should return exactly the number of bytes requested except |
| 143 | * on EOF or error, otherwise the rest of the data will be |
| 144 | * substituted with zeroes. An exception to this is when the |
| 145 | * 'direct_io' mount option is specified, in which case the return |
| 146 | * value of the read system call will reflect the return value of |
| 147 | * this operation. |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 148 | * |
| 149 | * Changed in version 2.2 |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 150 | */ |
| 151 | int (*read) (const char *, char *, size_t, off_t, struct fuse_file_info *); |
| 152 | |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 153 | /** Write data to an open file |
| 154 | * |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 155 | * Write should return exactly the number of bytes requested |
| 156 | * except on error. An exception to this is when the 'direct_io' |
| 157 | * mount option is specified (see read operation). |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 158 | * |
| 159 | * Changed in version 2.2 |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 160 | */ |
| 161 | int (*write) (const char *, const char *, size_t, off_t, |
| 162 | struct fuse_file_info *); |
| 163 | |
| 164 | /** Get file system statistics |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 165 | * |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 166 | * The 'f_type' and 'f_fsid' fields are ignored |
| 167 | */ |
| 168 | int (*statfs) (const char *, struct statfs *); |
| 169 | |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 170 | /** Possibly flush cached data |
| 171 | * |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 172 | * BIG NOTE: This is not equivalent to fsync(). It's not a |
Miklos Szeredi | e56818b | 2004-12-12 11:45:24 +0000 | [diff] [blame] | 173 | * request to sync dirty data. |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 174 | * |
| 175 | * Flush is called on each close() of a file descriptor. So if a |
| 176 | * filesystem wants to return write errors in close() and the file |
| 177 | * has cached dirty data, this is a good place to write back data |
Miklos Szeredi | e56818b | 2004-12-12 11:45:24 +0000 | [diff] [blame] | 178 | * and return any errors. Since many applications ignore close() |
| 179 | * errors this is not always useful. |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 180 | * |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 181 | * NOTE: The flush() method may be called more than once for each |
| 182 | * open(). This happens if more than one file descriptor refers |
| 183 | * to an opened file due to dup(), dup2() or fork() calls. It is |
| 184 | * not possible to determine if a flush is final, so each flush |
| 185 | * should be treated equally. Multiple write-flush sequences are |
| 186 | * relatively rare, so this shouldn't be a problem. |
Miklos Szeredi | 9b813af | 2005-07-21 07:59:37 +0000 | [diff] [blame] | 187 | * |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 188 | * Changed in version 2.2 |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 189 | */ |
| 190 | int (*flush) (const char *, struct fuse_file_info *); |
| 191 | |
| 192 | /** Release an open file |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 193 | * |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 194 | * Release is called when there are no more references to an open |
| 195 | * file: all file descriptors are closed and all memory mappings |
| 196 | * are unmapped. |
| 197 | * |
| 198 | * For every open() call there will be exactly one release() call |
Miklos Szeredi | e56818b | 2004-12-12 11:45:24 +0000 | [diff] [blame] | 199 | * with the same flags and file descriptor. It is possible to |
| 200 | * have a file opened more than once, in which case only the last |
| 201 | * release will mean, that no more reads/writes will happen on the |
| 202 | * file. The return value of release is ignored. |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 203 | * |
| 204 | * Changed in version 2.2 |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 205 | */ |
| 206 | int (*release) (const char *, struct fuse_file_info *); |
| 207 | |
| 208 | /** Synchronize file contents |
| 209 | * |
| 210 | * If the datasync parameter is non-zero, then only the user data |
| 211 | * should be flushed, not the meta data. |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 212 | * |
| 213 | * Changed in version 2.2 |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 214 | */ |
| 215 | int (*fsync) (const char *, int, struct fuse_file_info *); |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 216 | |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 217 | /** Set extended attributes */ |
| 218 | int (*setxattr) (const char *, const char *, const char *, size_t, int); |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 219 | |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 220 | /** Get extended attributes */ |
| 221 | int (*getxattr) (const char *, const char *, char *, size_t); |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 222 | |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 223 | /** List extended attributes */ |
| 224 | int (*listxattr) (const char *, char *, size_t); |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 225 | |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 226 | /** Remove extended attributes */ |
Miklos Szeredi | 3ed8423 | 2004-03-30 15:17:26 +0000 | [diff] [blame] | 227 | int (*removexattr) (const char *, const char *); |
Miklos Szeredi | f43f063 | 2005-02-28 11:46:56 +0000 | [diff] [blame] | 228 | |
Miklos Szeredi | 009b878 | 2005-08-01 13:36:53 +0000 | [diff] [blame] | 229 | /** Open directory |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 230 | * |
Miklos Szeredi | fa84866 | 2005-09-08 15:16:14 +0000 | [diff] [blame^] | 231 | * This method should check if the open operation is permitted for |
| 232 | * this directory |
| 233 | * |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 234 | * Introduced in version 2.3 |
Miklos Szeredi | f43f063 | 2005-02-28 11:46:56 +0000 | [diff] [blame] | 235 | */ |
| 236 | int (*opendir) (const char *, struct fuse_file_info *); |
Miklos Szeredi | 159bd7e | 2005-02-28 17:32:16 +0000 | [diff] [blame] | 237 | |
Miklos Szeredi | 18fce98 | 2005-04-01 21:07:35 +0000 | [diff] [blame] | 238 | /** Read directory |
| 239 | * |
Miklos Szeredi | ab97456 | 2005-04-07 15:40:21 +0000 | [diff] [blame] | 240 | * This supersedes the old getdir() interface. New applications |
| 241 | * should use this. |
| 242 | * |
| 243 | * The filesystem may choose between two modes of operation: |
Miklos Szeredi | 21019c9 | 2005-05-09 11:22:41 +0000 | [diff] [blame] | 244 | * |
Miklos Szeredi | ab97456 | 2005-04-07 15:40:21 +0000 | [diff] [blame] | 245 | * 1) The readdir implementation ignores the offset parameter, and |
| 246 | * passes zero to the filler function's offset. The filler |
| 247 | * function will not return '1' (unless an error happens), so the |
| 248 | * whole directory is read in a single readdir operation. This |
| 249 | * works just like the old getdir() method. |
| 250 | * |
| 251 | * 2) The readdir implementation keeps track of the offsets of the |
| 252 | * directory entries. It uses the offset parameter and always |
| 253 | * passes non-zero offset to the filler function. When the buffer |
| 254 | * is full (or an error happens) the filler function will return |
| 255 | * '1'. |
Miklos Szeredi | 9b813af | 2005-07-21 07:59:37 +0000 | [diff] [blame] | 256 | * |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 257 | * Introduced in version 2.3 |
Miklos Szeredi | 18fce98 | 2005-04-01 21:07:35 +0000 | [diff] [blame] | 258 | */ |
Miklos Szeredi | ab97456 | 2005-04-07 15:40:21 +0000 | [diff] [blame] | 259 | int (*readdir) (const char *, void *, fuse_fill_dir_t, off_t, |
Miklos Szeredi | 18fce98 | 2005-04-01 21:07:35 +0000 | [diff] [blame] | 260 | struct fuse_file_info *); |
| 261 | |
Miklos Szeredi | 9b813af | 2005-07-21 07:59:37 +0000 | [diff] [blame] | 262 | /** Release directory |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 263 | * |
| 264 | * Introduced in version 2.3 |
| 265 | */ |
Miklos Szeredi | 18fce98 | 2005-04-01 21:07:35 +0000 | [diff] [blame] | 266 | int (*releasedir) (const char *, struct fuse_file_info *); |
| 267 | |
Miklos Szeredi | 4283ee7 | 2005-03-21 12:09:04 +0000 | [diff] [blame] | 268 | /** Synchronize directory contents |
| 269 | * |
| 270 | * If the datasync parameter is non-zero, then only the user data |
Miklos Szeredi | 18fce98 | 2005-04-01 21:07:35 +0000 | [diff] [blame] | 271 | * should be flushed, not the meta data |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 272 | * |
| 273 | * Introduced in version 2.3 |
Miklos Szeredi | 4283ee7 | 2005-03-21 12:09:04 +0000 | [diff] [blame] | 274 | */ |
| 275 | int (*fsyncdir) (const char *, int, struct fuse_file_info *); |
| 276 | |
Miklos Szeredi | 159bd7e | 2005-02-28 17:32:16 +0000 | [diff] [blame] | 277 | /** |
| 278 | * Initialize filesystem |
| 279 | * |
| 280 | * The return value will passed in the private_data field of |
| 281 | * fuse_context to all file operations and as a parameter to the |
| 282 | * destroy() method. |
Miklos Szeredi | 9b813af | 2005-07-21 07:59:37 +0000 | [diff] [blame] | 283 | * |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 284 | * Introduced in version 2.3 |
Miklos Szeredi | 159bd7e | 2005-02-28 17:32:16 +0000 | [diff] [blame] | 285 | */ |
| 286 | void *(*init) (void); |
| 287 | |
| 288 | /** |
| 289 | * Clean up filesystem |
Miklos Szeredi | 18fce98 | 2005-04-01 21:07:35 +0000 | [diff] [blame] | 290 | * |
Miklos Szeredi | 159bd7e | 2005-02-28 17:32:16 +0000 | [diff] [blame] | 291 | * Called on filesystem exit. |
Miklos Szeredi | 9b813af | 2005-07-21 07:59:37 +0000 | [diff] [blame] | 292 | * |
Miklos Szeredi | 437d811 | 2005-07-06 09:14:20 +0000 | [diff] [blame] | 293 | * Introduced in version 2.3 |
Miklos Szeredi | 159bd7e | 2005-02-28 17:32:16 +0000 | [diff] [blame] | 294 | */ |
| 295 | void (*destroy) (void *); |
Miklos Szeredi | a181e61 | 2001-11-06 12:03:23 +0000 | [diff] [blame] | 296 | }; |
| 297 | |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 298 | /** Extra context that may be needed by some filesystems |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 299 | * |
| 300 | * The uid, gid and pid fields are not filled in case of a writepage |
| 301 | * operation. |
| 302 | */ |
Miklos Szeredi | 2e50d43 | 2001-12-20 12:17:25 +0000 | [diff] [blame] | 303 | struct fuse_context { |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 304 | /** Pointer to the fuse object */ |
Miklos Szeredi | d169f31 | 2004-09-22 08:48:26 +0000 | [diff] [blame] | 305 | struct fuse *fuse; |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 306 | |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 307 | /** User ID of the calling process */ |
Miklos Szeredi | 2e50d43 | 2001-12-20 12:17:25 +0000 | [diff] [blame] | 308 | uid_t uid; |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 309 | |
| 310 | /** Group ID of the calling process */ |
Miklos Szeredi | 2e50d43 | 2001-12-20 12:17:25 +0000 | [diff] [blame] | 311 | gid_t gid; |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 312 | |
| 313 | /** Thread ID of the calling process */ |
Miklos Szeredi | 1f18db5 | 2004-09-27 06:54:49 +0000 | [diff] [blame] | 314 | pid_t pid; |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 315 | |
Miklos Szeredi | 159bd7e | 2005-02-28 17:32:16 +0000 | [diff] [blame] | 316 | /** Private filesystem data */ |
Miklos Szeredi | 8fb48fe | 2004-11-08 14:48:52 +0000 | [diff] [blame] | 317 | void *private_data; |
Miklos Szeredi | 2e50d43 | 2001-12-20 12:17:25 +0000 | [diff] [blame] | 318 | }; |
| 319 | |
Miklos Szeredi | a4b0c77 | 2002-04-19 15:57:02 +0000 | [diff] [blame] | 320 | /* |
Miklos Szeredi | 0e53508 | 2003-10-13 10:08:06 +0000 | [diff] [blame] | 321 | * Main function of FUSE. |
| 322 | * |
| 323 | * This is for the lazy. This is all that has to be called from the |
| 324 | * main() function. |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 325 | * |
Miklos Szeredi | 0e53508 | 2003-10-13 10:08:06 +0000 | [diff] [blame] | 326 | * This function does the following: |
Miklos Szeredi | 307242f | 2004-01-26 11:28:44 +0000 | [diff] [blame] | 327 | * - parses command line options (-d -s and -h) |
Miklos Szeredi | bd7661b | 2004-07-23 17:16:29 +0000 | [diff] [blame] | 328 | * - passes relevant mount options to the fuse_mount() |
Miklos Szeredi | 0e53508 | 2003-10-13 10:08:06 +0000 | [diff] [blame] | 329 | * - installs signal handlers for INT, HUP, TERM and PIPE |
| 330 | * - registers an exit handler to unmount the filesystem on program exit |
Miklos Szeredi | 0e53508 | 2003-10-13 10:08:06 +0000 | [diff] [blame] | 331 | * - creates a fuse handle |
| 332 | * - registers the operations |
| 333 | * - calls either the single-threaded or the multi-threaded event loop |
| 334 | * |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 335 | * Note: this is currently implemented as a macro. |
| 336 | * |
Miklos Szeredi | 0e53508 | 2003-10-13 10:08:06 +0000 | [diff] [blame] | 337 | * @param argc the argument counter passed to the main() function |
| 338 | * @param argv the argument vector passed to the main() function |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 339 | * @param op the file system operation |
Miklos Szeredi | 5dc8a80 | 2004-10-21 09:35:10 +0000 | [diff] [blame] | 340 | * @return 0 on success, nonzero on failure |
Miklos Szeredi | 0e53508 | 2003-10-13 10:08:06 +0000 | [diff] [blame] | 341 | */ |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 342 | /* |
| 343 | int fuse_main(int argc, char *argv[], const struct fuse_operations *op); |
| 344 | */ |
| 345 | #define fuse_main(argc, argv, op) \ |
Miklos Szeredi | f458b8c | 2004-12-07 16:46:42 +0000 | [diff] [blame] | 346 | fuse_main_real(argc, argv, op, sizeof(*(op))) |
Miklos Szeredi | 891b874 | 2004-07-29 09:27:49 +0000 | [diff] [blame] | 347 | |
Miklos Szeredi | 0e53508 | 2003-10-13 10:08:06 +0000 | [diff] [blame] | 348 | /* ----------------------------------------------------------- * |
| 349 | * More detailed API * |
| 350 | * ----------------------------------------------------------- */ |
| 351 | |
| 352 | /* |
Miklos Szeredi | a4b0c77 | 2002-04-19 15:57:02 +0000 | [diff] [blame] | 353 | * Create a FUSE mountpoint |
| 354 | * |
| 355 | * Returns a control file descriptor suitable for passing to |
| 356 | * fuse_new() |
| 357 | * |
| 358 | * @param mountpoint the mount point path |
Miklos Szeredi | bd7661b | 2004-07-23 17:16:29 +0000 | [diff] [blame] | 359 | * @param opts a comma separated list of mount options. Can be NULL. |
Miklos Szeredi | a4b0c77 | 2002-04-19 15:57:02 +0000 | [diff] [blame] | 360 | * @return the control file descriptor on success, -1 on failure |
| 361 | */ |
Miklos Szeredi | bd7661b | 2004-07-23 17:16:29 +0000 | [diff] [blame] | 362 | int fuse_mount(const char *mountpoint, const char *opts); |
Miklos Szeredi | a4b0c77 | 2002-04-19 15:57:02 +0000 | [diff] [blame] | 363 | |
Miklos Szeredi | 0f48a26 | 2002-12-05 14:23:01 +0000 | [diff] [blame] | 364 | /* |
| 365 | * Umount a FUSE mountpoint |
| 366 | * |
| 367 | * @param mountpoint the mount point path |
| 368 | */ |
| 369 | void fuse_unmount(const char *mountpoint); |
| 370 | |
Miklos Szeredi | 2df1c04 | 2001-11-06 15:07:17 +0000 | [diff] [blame] | 371 | /** |
Miklos Szeredi | 8cffdb9 | 2001-11-09 14:49:18 +0000 | [diff] [blame] | 372 | * Create a new FUSE filesystem. |
Miklos Szeredi | 2df1c04 | 2001-11-06 15:07:17 +0000 | [diff] [blame] | 373 | * |
Miklos Szeredi | 8cffdb9 | 2001-11-09 14:49:18 +0000 | [diff] [blame] | 374 | * @param fd the control file descriptor |
Miklos Szeredi | bd7661b | 2004-07-23 17:16:29 +0000 | [diff] [blame] | 375 | * @param opts mount options to be used by the library |
Miklos Szeredi | 2e50d43 | 2001-12-20 12:17:25 +0000 | [diff] [blame] | 376 | * @param op the operations |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 377 | * @param op_size the size of the fuse_operations structure |
Miklos Szeredi | 2df1c04 | 2001-11-06 15:07:17 +0000 | [diff] [blame] | 378 | * @return the created FUSE handle |
| 379 | */ |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 380 | struct fuse *fuse_new(int fd, const char *opts, |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 381 | const struct fuse_operations *op, size_t op_size); |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 382 | |
Miklos Szeredi | 2df1c04 | 2001-11-06 15:07:17 +0000 | [diff] [blame] | 383 | /** |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 384 | * Destroy the FUSE handle. |
Miklos Szeredi | 0f48a26 | 2002-12-05 14:23:01 +0000 | [diff] [blame] | 385 | * |
| 386 | * The filesystem is not unmounted. |
| 387 | * |
| 388 | * @param f the FUSE handle |
| 389 | */ |
| 390 | void fuse_destroy(struct fuse *f); |
| 391 | |
| 392 | /** |
Miklos Szeredi | 2df1c04 | 2001-11-06 15:07:17 +0000 | [diff] [blame] | 393 | * FUSE event loop. |
| 394 | * |
| 395 | * Requests from the kernel are processed, and the apropriate |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 396 | * operations are called. |
Miklos Szeredi | 2df1c04 | 2001-11-06 15:07:17 +0000 | [diff] [blame] | 397 | * |
| 398 | * @param f the FUSE handle |
Miklos Szeredi | b2cf956 | 2004-09-16 08:42:40 +0000 | [diff] [blame] | 399 | * @return 0 if no error occured, -1 otherwise |
Miklos Szeredi | 2df1c04 | 2001-11-06 15:07:17 +0000 | [diff] [blame] | 400 | */ |
Miklos Szeredi | b2cf956 | 2004-09-16 08:42:40 +0000 | [diff] [blame] | 401 | int fuse_loop(struct fuse *f); |
Miklos Szeredi | 85c74fc | 2001-10-28 19:44:14 +0000 | [diff] [blame] | 402 | |
Miklos Szeredi | 0f48a26 | 2002-12-05 14:23:01 +0000 | [diff] [blame] | 403 | /** |
| 404 | * Exit from event loop |
| 405 | * |
| 406 | * @param f the FUSE handle |
| 407 | */ |
| 408 | void fuse_exit(struct fuse *f); |
| 409 | |
Miklos Szeredi | 2df1c04 | 2001-11-06 15:07:17 +0000 | [diff] [blame] | 410 | /** |
Miklos Szeredi | fff56ab | 2001-11-16 10:12:59 +0000 | [diff] [blame] | 411 | * FUSE event loop with multiple threads |
| 412 | * |
| 413 | * Requests from the kernel are processed, and the apropriate |
| 414 | * operations are called. Request are processed in parallel by |
| 415 | * distributing them between multiple threads. |
| 416 | * |
| 417 | * Calling this function requires the pthreads library to be linked to |
| 418 | * the application. |
| 419 | * |
| 420 | * @param f the FUSE handle |
Miklos Szeredi | b2cf956 | 2004-09-16 08:42:40 +0000 | [diff] [blame] | 421 | * @return 0 if no error occured, -1 otherwise |
Miklos Szeredi | fff56ab | 2001-11-16 10:12:59 +0000 | [diff] [blame] | 422 | */ |
Miklos Szeredi | b2cf956 | 2004-09-16 08:42:40 +0000 | [diff] [blame] | 423 | int fuse_loop_mt(struct fuse *f); |
Miklos Szeredi | fff56ab | 2001-11-16 10:12:59 +0000 | [diff] [blame] | 424 | |
| 425 | /** |
Miklos Szeredi | 2e50d43 | 2001-12-20 12:17:25 +0000 | [diff] [blame] | 426 | * Get the current context |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 427 | * |
Miklos Szeredi | 2e50d43 | 2001-12-20 12:17:25 +0000 | [diff] [blame] | 428 | * The context is only valid for the duration of a filesystem |
| 429 | * operation, and thus must not be stored and used later. |
| 430 | * |
| 431 | * @param f the FUSE handle |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 432 | * @return the context |
Miklos Szeredi | 2e50d43 | 2001-12-20 12:17:25 +0000 | [diff] [blame] | 433 | */ |
Miklos Szeredi | d169f31 | 2004-09-22 08:48:26 +0000 | [diff] [blame] | 434 | struct fuse_context *fuse_get_context(void); |
Miklos Szeredi | 2e50d43 | 2001-12-20 12:17:25 +0000 | [diff] [blame] | 435 | |
Miklos Szeredi | bd7661b | 2004-07-23 17:16:29 +0000 | [diff] [blame] | 436 | /** |
Miklos Szeredi | 76c1752 | 2005-07-13 14:08:19 +0000 | [diff] [blame] | 437 | * Obsolete, doesn't do anything |
Miklos Szeredi | 9b813af | 2005-07-21 07:59:37 +0000 | [diff] [blame] | 438 | * |
Miklos Szeredi | bd10a7b | 2005-07-15 09:59:59 +0000 | [diff] [blame] | 439 | * @return -EINVAL |
Miklos Szeredi | 5dc8a80 | 2004-10-21 09:35:10 +0000 | [diff] [blame] | 440 | */ |
| 441 | int fuse_invalidate(struct fuse *f, const char *path); |
| 442 | |
| 443 | /** |
Miklos Szeredi | bd7661b | 2004-07-23 17:16:29 +0000 | [diff] [blame] | 444 | * Check whether a mount option should be passed to the kernel or the |
| 445 | * library |
| 446 | * |
| 447 | * @param opt the option to check |
| 448 | * @return 1 if it is a library option, 0 otherwise |
| 449 | */ |
| 450 | int fuse_is_lib_option(const char *opt); |
| 451 | |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 452 | /** |
| 453 | * The real main function |
Miklos Szeredi | e518374 | 2005-02-02 11:14:04 +0000 | [diff] [blame] | 454 | * |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 455 | * Do not call this directly, use fuse_main() |
| 456 | */ |
Miklos Szeredi | f458b8c | 2004-12-07 16:46:42 +0000 | [diff] [blame] | 457 | int fuse_main_real(int argc, char *argv[], const struct fuse_operations *op, |
| 458 | size_t op_size); |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 459 | |
Miklos Szeredi | cc8c975 | 2001-11-21 10:03:39 +0000 | [diff] [blame] | 460 | /* ----------------------------------------------------------- * |
Miklos Szeredi | 680a69a | 2001-11-16 13:31:14 +0000 | [diff] [blame] | 461 | * Advanced API for event handling, don't worry about this... * |
| 462 | * ----------------------------------------------------------- */ |
Miklos Szeredi | fff56ab | 2001-11-16 10:12:59 +0000 | [diff] [blame] | 463 | |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 464 | /** Function type used to process commands */ |
Miklos Szeredi | f830a7f | 2001-11-16 17:46:45 +0000 | [diff] [blame] | 465 | typedef void (*fuse_processor_t)(struct fuse *, struct fuse_cmd *, void *); |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 466 | |
| 467 | /** This is the part of fuse_main() before the event loop */ |
Miklos Szeredi | f458b8c | 2004-12-07 16:46:42 +0000 | [diff] [blame] | 468 | struct fuse *fuse_setup(int argc, char *argv[], |
| 469 | const struct fuse_operations *op, size_t op_size, |
Miklos Szeredi | 5dc8a80 | 2004-10-21 09:35:10 +0000 | [diff] [blame] | 470 | char **mountpoint, int *multithreaded, int *fd); |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 471 | |
| 472 | /** This is the part of fuse_main() after the event loop */ |
Miklos Szeredi | f458b8c | 2004-12-07 16:46:42 +0000 | [diff] [blame] | 473 | void fuse_teardown(struct fuse *fuse, int fd, char *mountpoint); |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 474 | |
| 475 | /** Read a single command. If none are read, return NULL */ |
Miklos Szeredi | f458b8c | 2004-12-07 16:46:42 +0000 | [diff] [blame] | 476 | struct fuse_cmd *fuse_read_cmd(struct fuse *f); |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 477 | |
| 478 | /** Process a single command */ |
Miklos Szeredi | f458b8c | 2004-12-07 16:46:42 +0000 | [diff] [blame] | 479 | void fuse_process_cmd(struct fuse *f, struct fuse_cmd *cmd); |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 480 | |
| 481 | /** Multi threaded event loop, which calls the custom command |
| 482 | processor function */ |
Miklos Szeredi | f458b8c | 2004-12-07 16:46:42 +0000 | [diff] [blame] | 483 | int fuse_loop_mt_proc(struct fuse *f, fuse_processor_t proc, void *data); |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 484 | |
| 485 | /** Return the exited flag, which indicates if fuse_exit() has been |
| 486 | called */ |
Miklos Szeredi | e2aa2e2 | 2005-07-15 13:31:36 +0000 | [diff] [blame] | 487 | int fuse_exited(struct fuse *f); |
Miklos Szeredi | d59bb9d | 2004-12-07 10:04:24 +0000 | [diff] [blame] | 488 | |
| 489 | /** Set function which can be used to get the current context */ |
Miklos Szeredi | f458b8c | 2004-12-07 16:46:42 +0000 | [diff] [blame] | 490 | void fuse_set_getcontext_func(struct fuse_context *(*func)(void)); |
Miklos Szeredi | f830a7f | 2001-11-16 17:46:45 +0000 | [diff] [blame] | 491 | |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 492 | /* ----------------------------------------------------------- * |
| 493 | * Compatibility stuff * |
| 494 | * ----------------------------------------------------------- */ |
| 495 | |
| 496 | #if FUSE_USE_VERSION == 21 || FUSE_USE_VERSION == 11 |
Miklos Szeredi | e56818b | 2004-12-12 11:45:24 +0000 | [diff] [blame] | 497 | # include "fuse_compat.h" |
Miklos Szeredi | f458b8c | 2004-12-07 16:46:42 +0000 | [diff] [blame] | 498 | # define fuse_dirfil_t fuse_dirfil_t_compat |
| 499 | # define __fuse_read_cmd fuse_read_cmd |
| 500 | # define __fuse_process_cmd fuse_process_cmd |
| 501 | # define __fuse_loop_mt fuse_loop_mt_proc |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 502 | # undef fuse_main |
| 503 | # undef FUSE_MINOR_VERSION |
| 504 | # undef FUSE_MAJOR_VERSION |
| 505 | # if FUSE_USE_VERSION == 21 |
| 506 | # define FUSE_MAJOR_VERSION 2 |
| 507 | # define FUSE_MINOR_VERSION 1 |
Miklos Szeredi | f458b8c | 2004-12-07 16:46:42 +0000 | [diff] [blame] | 508 | # define fuse_operations fuse_operations_compat2 |
| 509 | # define fuse_main fuse_main_compat2 |
| 510 | # define fuse_new fuse_new_compat2 |
| 511 | # define __fuse_setup fuse_setup_compat2 |
| 512 | # define __fuse_teardown fuse_teardown |
| 513 | # define __fuse_exited fuse_exited |
| 514 | # define __fuse_set_getcontext_func fuse_set_getcontext_func |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 515 | # else |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 516 | # define FUSE_MAJOR_VERSION 1 |
| 517 | # define FUSE_MINOR_VERSION 1 |
Miklos Szeredi | f458b8c | 2004-12-07 16:46:42 +0000 | [diff] [blame] | 518 | # define fuse_statfs fuse_statfs_compat1 |
| 519 | # define fuse_operations fuse_operations_compat1 |
| 520 | # define fuse_main fuse_main_compat1 |
| 521 | # define fuse_new fuse_new_compat1 |
| 522 | # define fuse_mount fuse_mount_compat1 |
| 523 | # define FUSE_DEBUG FUSE_DEBUG_COMPAT1 |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 524 | # endif |
Miklos Szeredi | 799993c | 2004-12-04 21:20:05 +0000 | [diff] [blame] | 525 | #elif FUSE_USE_VERSION < 22 |
| 526 | # error Compatibility with API version other than 21 and 11 not supported |
Miklos Szeredi | 0b6a0ad | 2004-12-04 00:40:50 +0000 | [diff] [blame] | 527 | #endif |
| 528 | |
Miklos Szeredi | acd4e06 | 2001-12-08 20:29:20 +0000 | [diff] [blame] | 529 | #ifdef __cplusplus |
| 530 | } |
| 531 | #endif |
| 532 | |
| 533 | #endif /* _FUSE_H_ */ |