blob: e64336e48aadf78b5692aaff6530409b5c2e7b3c [file] [log] [blame]
Miklos Szeredi85c74fc2001-10-28 19:44:14 +00001/*
2 FUSE: Filesystem in Userspace
Miklos Szeredi149f6072005-01-10 12:29:28 +00003 Copyright (C) 2001-2005 Miklos Szeredi <miklos@szeredi.hu>
Miklos Szeredi85c74fc2001-10-28 19:44:14 +00004
Miklos Szeredi8b39a9f2002-10-25 12:41:16 +00005 This program can be distributed under the terms of the GNU LGPL.
6 See the file COPYING.LIB.
Miklos Szeredi85c74fc2001-10-28 19:44:14 +00007*/
8
Miklos Szerediacd4e062001-12-08 20:29:20 +00009#ifndef _FUSE_H_
10#define _FUSE_H_
11
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000012/* This file defines the library interface of FUSE */
13
Miklos Szeredi0b6a0ad2004-12-04 00:40:50 +000014/* 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 Szeredid59bb9d2004-12-07 10:04:24 +000016 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 Szeredi0b6a0ad2004-12-04 00:40:50 +000018
Miklos Szeredi76c17522005-07-13 14:08:19 +000019#include "fuse_common.h"
20
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000021#include <sys/types.h>
22#include <sys/stat.h>
Miklos Szeredi18e75e42004-02-19 14:23:27 +000023#include <sys/statfs.h>
Miklos Szeredi5e183482001-10-31 14:52:35 +000024#include <utime.h>
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000025
Miklos Szeredi8fb48fe2004-11-08 14:48:52 +000026#ifdef __cplusplus
27extern "C" {
28#endif
29
Miklos Szeredicc8c9752001-11-21 10:03:39 +000030/* ----------------------------------------------------------- *
31 * Basic FUSE API *
32 * ----------------------------------------------------------- */
33
Miklos Szeredi2df1c042001-11-06 15:07:17 +000034/** Handle for a FUSE filesystem */
Miklos Szeredi85c74fc2001-10-28 19:44:14 +000035struct fuse;
Miklos Szeredi2df1c042001-11-06 15:07:17 +000036
Miklos Szeredia1482422005-08-14 23:00:27 +000037/** Structure containing a raw command */
38struct fuse_cmd;
39
Miklos Szeredi18fce982005-04-01 21:07:35 +000040/** 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 Szerediab974562005-04-07 15:40:21 +000044 * @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 Szeredi18fce982005-04-01 21:07:35 +000047 */
Miklos Szerediab974562005-04-07 15:40:21 +000048typedef int (*fuse_fill_dir_t) (void *buf, const char *name,
Miklos Szeredif6e0ec62005-08-03 09:11:06 +000049 const struct stat *stbuf, off_t off);
Miklos Szerediab974562005-04-07 15:40:21 +000050
51/* Used by deprecated getdir() method */
52typedef struct fuse_dirhandle *fuse_dirh_t;
53typedef int (*fuse_dirfil_t) (fuse_dirh_t h, const char *name, int type,
54 ino_t ino);
Miklos Szeredi18fce982005-04-01 21:07:35 +000055
Miklos Szeredi2df1c042001-11-06 15:07:17 +000056/**
57 * The file system operations:
58 *
59 * Most of these should work very similarly to the well known UNIX
Miklos Szeredid59bb9d2004-12-07 10:04:24 +000060 * file system operations. A major exception is that instead of
61 * returning an error in 'errno', the operation should return the
Miklos Szeredie5183742005-02-02 11:14:04 +000062 * negated error value (-errno) directly.
Miklos Szeredie56818b2004-12-12 11:45:24 +000063 *
64 * All methods are optional, but some are essential for a useful
Miklos Szeredi31066bb2005-08-01 14:49:31 +000065 * 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 Szeredie2e4ac22004-05-18 08:45:28 +000068 */
Miklos Szeredia181e612001-11-06 12:03:23 +000069struct fuse_operations {
Miklos Szeredid59bb9d2004-12-07 10:04:24 +000070 /** 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 Szeredie5183742005-02-02 11:14:04 +000079 *
Miklos Szeredid59bb9d2004-12-07 10:04:24 +000080 * 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 Szerediab974562005-04-07 15:40:21 +000088 /* Deprecated, use readdir() instead */
Miklos Szeredid59bb9d2004-12-07 10:04:24 +000089 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 Szeredie5183742005-02-02 11:14:04 +0000115
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000116 /** Change the permission bits of a file */
117 int (*chmod) (const char *, mode_t);
Miklos Szeredie5183742005-02-02 11:14:04 +0000118
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000119 /** Change the owner and group of a file */
120 int (*chown) (const char *, uid_t, gid_t);
Miklos Szeredie5183742005-02-02 11:14:04 +0000121
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000122 /** Change the size of a file */
123 int (*truncate) (const char *, off_t);
Miklos Szeredie5183742005-02-02 11:14:04 +0000124
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000125 /** Change the access and/or modification times of a file */
126 int (*utime) (const char *, struct utimbuf *);
Miklos Szeredie5183742005-02-02 11:14:04 +0000127
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000128 /** File open operation
129 *
130 * No creation, or trunctation flags (O_CREAT, O_EXCL, O_TRUNC)
Miklos Szeredifa848662005-09-08 15:16:14 +0000131 * 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 Szeredi31066bb2005-08-01 14:49:31 +0000135 *
Miklos Szeredi437d8112005-07-06 09:14:20 +0000136 * Changed in version 2.2
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000137 */
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 Szeredi437d8112005-07-06 09:14:20 +0000148 *
149 * Changed in version 2.2
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000150 */
151 int (*read) (const char *, char *, size_t, off_t, struct fuse_file_info *);
152
Miklos Szeredie5183742005-02-02 11:14:04 +0000153 /** Write data to an open file
154 *
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000155 * 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 Szeredi437d8112005-07-06 09:14:20 +0000158 *
159 * Changed in version 2.2
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000160 */
161 int (*write) (const char *, const char *, size_t, off_t,
162 struct fuse_file_info *);
163
164 /** Get file system statistics
Miklos Szeredie5183742005-02-02 11:14:04 +0000165 *
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000166 * The 'f_type' and 'f_fsid' fields are ignored
167 */
168 int (*statfs) (const char *, struct statfs *);
169
Miklos Szeredie5183742005-02-02 11:14:04 +0000170 /** Possibly flush cached data
171 *
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000172 * BIG NOTE: This is not equivalent to fsync(). It's not a
Miklos Szeredie56818b2004-12-12 11:45:24 +0000173 * request to sync dirty data.
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000174 *
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 Szeredie56818b2004-12-12 11:45:24 +0000178 * and return any errors. Since many applications ignore close()
179 * errors this is not always useful.
Miklos Szeredie5183742005-02-02 11:14:04 +0000180 *
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000181 * 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 Szeredi9b813af2005-07-21 07:59:37 +0000187 *
Miklos Szeredi437d8112005-07-06 09:14:20 +0000188 * Changed in version 2.2
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000189 */
190 int (*flush) (const char *, struct fuse_file_info *);
191
192 /** Release an open file
Miklos Szeredie5183742005-02-02 11:14:04 +0000193 *
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000194 * 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 Szeredie56818b2004-12-12 11:45:24 +0000199 * 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 Szeredi437d8112005-07-06 09:14:20 +0000203 *
204 * Changed in version 2.2
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000205 */
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 Szeredi437d8112005-07-06 09:14:20 +0000212 *
213 * Changed in version 2.2
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000214 */
215 int (*fsync) (const char *, int, struct fuse_file_info *);
Miklos Szeredie5183742005-02-02 11:14:04 +0000216
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000217 /** Set extended attributes */
218 int (*setxattr) (const char *, const char *, const char *, size_t, int);
Miklos Szeredie5183742005-02-02 11:14:04 +0000219
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000220 /** Get extended attributes */
221 int (*getxattr) (const char *, const char *, char *, size_t);
Miklos Szeredie5183742005-02-02 11:14:04 +0000222
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000223 /** List extended attributes */
224 int (*listxattr) (const char *, char *, size_t);
Miklos Szeredie5183742005-02-02 11:14:04 +0000225
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000226 /** Remove extended attributes */
Miklos Szeredi3ed84232004-03-30 15:17:26 +0000227 int (*removexattr) (const char *, const char *);
Miklos Szeredif43f0632005-02-28 11:46:56 +0000228
Miklos Szeredi009b8782005-08-01 13:36:53 +0000229 /** Open directory
Miklos Szeredi437d8112005-07-06 09:14:20 +0000230 *
Miklos Szeredifa848662005-09-08 15:16:14 +0000231 * This method should check if the open operation is permitted for
232 * this directory
233 *
Miklos Szeredi437d8112005-07-06 09:14:20 +0000234 * Introduced in version 2.3
Miklos Szeredif43f0632005-02-28 11:46:56 +0000235 */
236 int (*opendir) (const char *, struct fuse_file_info *);
Miklos Szeredi159bd7e2005-02-28 17:32:16 +0000237
Miklos Szeredi18fce982005-04-01 21:07:35 +0000238 /** Read directory
239 *
Miklos Szerediab974562005-04-07 15:40:21 +0000240 * This supersedes the old getdir() interface. New applications
241 * should use this.
242 *
243 * The filesystem may choose between two modes of operation:
Miklos Szeredi21019c92005-05-09 11:22:41 +0000244 *
Miklos Szerediab974562005-04-07 15:40:21 +0000245 * 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 Szeredi9b813af2005-07-21 07:59:37 +0000256 *
Miklos Szeredi437d8112005-07-06 09:14:20 +0000257 * Introduced in version 2.3
Miklos Szeredi18fce982005-04-01 21:07:35 +0000258 */
Miklos Szerediab974562005-04-07 15:40:21 +0000259 int (*readdir) (const char *, void *, fuse_fill_dir_t, off_t,
Miklos Szeredi18fce982005-04-01 21:07:35 +0000260 struct fuse_file_info *);
261
Miklos Szeredi9b813af2005-07-21 07:59:37 +0000262 /** Release directory
Miklos Szeredi437d8112005-07-06 09:14:20 +0000263 *
264 * Introduced in version 2.3
265 */
Miklos Szeredi18fce982005-04-01 21:07:35 +0000266 int (*releasedir) (const char *, struct fuse_file_info *);
267
Miklos Szeredi4283ee72005-03-21 12:09:04 +0000268 /** Synchronize directory contents
269 *
270 * If the datasync parameter is non-zero, then only the user data
Miklos Szeredi18fce982005-04-01 21:07:35 +0000271 * should be flushed, not the meta data
Miklos Szeredi437d8112005-07-06 09:14:20 +0000272 *
273 * Introduced in version 2.3
Miklos Szeredi4283ee72005-03-21 12:09:04 +0000274 */
275 int (*fsyncdir) (const char *, int, struct fuse_file_info *);
276
Miklos Szeredi159bd7e2005-02-28 17:32:16 +0000277 /**
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 Szeredi9b813af2005-07-21 07:59:37 +0000283 *
Miklos Szeredi437d8112005-07-06 09:14:20 +0000284 * Introduced in version 2.3
Miklos Szeredi159bd7e2005-02-28 17:32:16 +0000285 */
286 void *(*init) (void);
287
288 /**
289 * Clean up filesystem
Miklos Szeredi18fce982005-04-01 21:07:35 +0000290 *
Miklos Szeredi159bd7e2005-02-28 17:32:16 +0000291 * Called on filesystem exit.
Miklos Szeredi9b813af2005-07-21 07:59:37 +0000292 *
Miklos Szeredi437d8112005-07-06 09:14:20 +0000293 * Introduced in version 2.3
Miklos Szeredi159bd7e2005-02-28 17:32:16 +0000294 */
295 void (*destroy) (void *);
Miklos Szeredia181e612001-11-06 12:03:23 +0000296};
297
Miklos Szeredie5183742005-02-02 11:14:04 +0000298/** Extra context that may be needed by some filesystems
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000299 *
300 * The uid, gid and pid fields are not filled in case of a writepage
301 * operation.
302 */
Miklos Szeredi2e50d432001-12-20 12:17:25 +0000303struct fuse_context {
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000304 /** Pointer to the fuse object */
Miklos Szeredid169f312004-09-22 08:48:26 +0000305 struct fuse *fuse;
Miklos Szeredie5183742005-02-02 11:14:04 +0000306
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000307 /** User ID of the calling process */
Miklos Szeredi2e50d432001-12-20 12:17:25 +0000308 uid_t uid;
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000309
310 /** Group ID of the calling process */
Miklos Szeredi2e50d432001-12-20 12:17:25 +0000311 gid_t gid;
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000312
313 /** Thread ID of the calling process */
Miklos Szeredi1f18db52004-09-27 06:54:49 +0000314 pid_t pid;
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000315
Miklos Szeredi159bd7e2005-02-28 17:32:16 +0000316 /** Private filesystem data */
Miklos Szeredi8fb48fe2004-11-08 14:48:52 +0000317 void *private_data;
Miklos Szeredi2e50d432001-12-20 12:17:25 +0000318};
319
Miklos Szeredia4b0c772002-04-19 15:57:02 +0000320/*
Miklos Szeredi0e535082003-10-13 10:08:06 +0000321 * 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 Szeredie5183742005-02-02 11:14:04 +0000325 *
Miklos Szeredi0e535082003-10-13 10:08:06 +0000326 * This function does the following:
Miklos Szeredi307242f2004-01-26 11:28:44 +0000327 * - parses command line options (-d -s and -h)
Miklos Szeredibd7661b2004-07-23 17:16:29 +0000328 * - passes relevant mount options to the fuse_mount()
Miklos Szeredi0e535082003-10-13 10:08:06 +0000329 * - installs signal handlers for INT, HUP, TERM and PIPE
330 * - registers an exit handler to unmount the filesystem on program exit
Miklos Szeredi0e535082003-10-13 10:08:06 +0000331 * - creates a fuse handle
332 * - registers the operations
333 * - calls either the single-threaded or the multi-threaded event loop
334 *
Miklos Szeredi0b6a0ad2004-12-04 00:40:50 +0000335 * Note: this is currently implemented as a macro.
336 *
Miklos Szeredi0e535082003-10-13 10:08:06 +0000337 * @param argc the argument counter passed to the main() function
338 * @param argv the argument vector passed to the main() function
Miklos Szeredie5183742005-02-02 11:14:04 +0000339 * @param op the file system operation
Miklos Szeredi5dc8a802004-10-21 09:35:10 +0000340 * @return 0 on success, nonzero on failure
Miklos Szeredi0e535082003-10-13 10:08:06 +0000341 */
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000342/*
343int fuse_main(int argc, char *argv[], const struct fuse_operations *op);
344*/
345#define fuse_main(argc, argv, op) \
Miklos Szeredif458b8c2004-12-07 16:46:42 +0000346 fuse_main_real(argc, argv, op, sizeof(*(op)))
Miklos Szeredi891b8742004-07-29 09:27:49 +0000347
Miklos Szeredi0e535082003-10-13 10:08:06 +0000348/* ----------------------------------------------------------- *
349 * More detailed API *
350 * ----------------------------------------------------------- */
351
352/*
Miklos Szeredia4b0c772002-04-19 15:57:02 +0000353 * 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 Szeredibd7661b2004-07-23 17:16:29 +0000359 * @param opts a comma separated list of mount options. Can be NULL.
Miklos Szeredia4b0c772002-04-19 15:57:02 +0000360 * @return the control file descriptor on success, -1 on failure
361 */
Miklos Szeredibd7661b2004-07-23 17:16:29 +0000362int fuse_mount(const char *mountpoint, const char *opts);
Miklos Szeredia4b0c772002-04-19 15:57:02 +0000363
Miklos Szeredi0f48a262002-12-05 14:23:01 +0000364/*
365 * Umount a FUSE mountpoint
366 *
367 * @param mountpoint the mount point path
368 */
369void fuse_unmount(const char *mountpoint);
370
Miklos Szeredi2df1c042001-11-06 15:07:17 +0000371/**
Miklos Szeredi8cffdb92001-11-09 14:49:18 +0000372 * Create a new FUSE filesystem.
Miklos Szeredi2df1c042001-11-06 15:07:17 +0000373 *
Miklos Szeredi8cffdb92001-11-09 14:49:18 +0000374 * @param fd the control file descriptor
Miklos Szeredibd7661b2004-07-23 17:16:29 +0000375 * @param opts mount options to be used by the library
Miklos Szeredi2e50d432001-12-20 12:17:25 +0000376 * @param op the operations
Miklos Szeredi0b6a0ad2004-12-04 00:40:50 +0000377 * @param op_size the size of the fuse_operations structure
Miklos Szeredi2df1c042001-11-06 15:07:17 +0000378 * @return the created FUSE handle
379 */
Miklos Szeredie5183742005-02-02 11:14:04 +0000380struct fuse *fuse_new(int fd, const char *opts,
Miklos Szeredi0b6a0ad2004-12-04 00:40:50 +0000381 const struct fuse_operations *op, size_t op_size);
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000382
Miklos Szeredi2df1c042001-11-06 15:07:17 +0000383/**
Miklos Szeredie5183742005-02-02 11:14:04 +0000384 * Destroy the FUSE handle.
Miklos Szeredi0f48a262002-12-05 14:23:01 +0000385 *
386 * The filesystem is not unmounted.
387 *
388 * @param f the FUSE handle
389 */
390void fuse_destroy(struct fuse *f);
391
392/**
Miklos Szeredi2df1c042001-11-06 15:07:17 +0000393 * FUSE event loop.
394 *
395 * Requests from the kernel are processed, and the apropriate
Miklos Szeredie5183742005-02-02 11:14:04 +0000396 * operations are called.
Miklos Szeredi2df1c042001-11-06 15:07:17 +0000397 *
398 * @param f the FUSE handle
Miklos Szeredib2cf9562004-09-16 08:42:40 +0000399 * @return 0 if no error occured, -1 otherwise
Miklos Szeredi2df1c042001-11-06 15:07:17 +0000400 */
Miklos Szeredib2cf9562004-09-16 08:42:40 +0000401int fuse_loop(struct fuse *f);
Miklos Szeredi85c74fc2001-10-28 19:44:14 +0000402
Miklos Szeredi0f48a262002-12-05 14:23:01 +0000403/**
404 * Exit from event loop
405 *
406 * @param f the FUSE handle
407 */
408void fuse_exit(struct fuse *f);
409
Miklos Szeredi2df1c042001-11-06 15:07:17 +0000410/**
Miklos Szeredifff56ab2001-11-16 10:12:59 +0000411 * 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 Szeredib2cf9562004-09-16 08:42:40 +0000421 * @return 0 if no error occured, -1 otherwise
Miklos Szeredifff56ab2001-11-16 10:12:59 +0000422 */
Miklos Szeredib2cf9562004-09-16 08:42:40 +0000423int fuse_loop_mt(struct fuse *f);
Miklos Szeredifff56ab2001-11-16 10:12:59 +0000424
425/**
Miklos Szeredi2e50d432001-12-20 12:17:25 +0000426 * Get the current context
Miklos Szeredie5183742005-02-02 11:14:04 +0000427 *
Miklos Szeredi2e50d432001-12-20 12:17:25 +0000428 * 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 Szeredie5183742005-02-02 11:14:04 +0000432 * @return the context
Miklos Szeredi2e50d432001-12-20 12:17:25 +0000433 */
Miklos Szeredid169f312004-09-22 08:48:26 +0000434struct fuse_context *fuse_get_context(void);
Miklos Szeredi2e50d432001-12-20 12:17:25 +0000435
Miklos Szeredibd7661b2004-07-23 17:16:29 +0000436/**
Miklos Szeredi76c17522005-07-13 14:08:19 +0000437 * Obsolete, doesn't do anything
Miklos Szeredi9b813af2005-07-21 07:59:37 +0000438 *
Miklos Szeredibd10a7b2005-07-15 09:59:59 +0000439 * @return -EINVAL
Miklos Szeredi5dc8a802004-10-21 09:35:10 +0000440 */
441int fuse_invalidate(struct fuse *f, const char *path);
442
443/**
Miklos Szeredibd7661b2004-07-23 17:16:29 +0000444 * 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 */
450int fuse_is_lib_option(const char *opt);
451
Miklos Szeredi0b6a0ad2004-12-04 00:40:50 +0000452/**
453 * The real main function
Miklos Szeredie5183742005-02-02 11:14:04 +0000454 *
Miklos Szeredi0b6a0ad2004-12-04 00:40:50 +0000455 * Do not call this directly, use fuse_main()
456 */
Miklos Szeredif458b8c2004-12-07 16:46:42 +0000457int fuse_main_real(int argc, char *argv[], const struct fuse_operations *op,
458 size_t op_size);
Miklos Szeredi0b6a0ad2004-12-04 00:40:50 +0000459
Miklos Szeredicc8c9752001-11-21 10:03:39 +0000460/* ----------------------------------------------------------- *
Miklos Szeredi680a69a2001-11-16 13:31:14 +0000461 * Advanced API for event handling, don't worry about this... *
462 * ----------------------------------------------------------- */
Miklos Szeredifff56ab2001-11-16 10:12:59 +0000463
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000464/** Function type used to process commands */
Miklos Szeredif830a7f2001-11-16 17:46:45 +0000465typedef void (*fuse_processor_t)(struct fuse *, struct fuse_cmd *, void *);
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000466
467/** This is the part of fuse_main() before the event loop */
Miklos Szeredif458b8c2004-12-07 16:46:42 +0000468struct fuse *fuse_setup(int argc, char *argv[],
469 const struct fuse_operations *op, size_t op_size,
Miklos Szeredi5dc8a802004-10-21 09:35:10 +0000470 char **mountpoint, int *multithreaded, int *fd);
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000471
472/** This is the part of fuse_main() after the event loop */
Miklos Szeredif458b8c2004-12-07 16:46:42 +0000473void fuse_teardown(struct fuse *fuse, int fd, char *mountpoint);
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000474
475/** Read a single command. If none are read, return NULL */
Miklos Szeredif458b8c2004-12-07 16:46:42 +0000476struct fuse_cmd *fuse_read_cmd(struct fuse *f);
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000477
478/** Process a single command */
Miklos Szeredif458b8c2004-12-07 16:46:42 +0000479void fuse_process_cmd(struct fuse *f, struct fuse_cmd *cmd);
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000480
481/** Multi threaded event loop, which calls the custom command
482 processor function */
Miklos Szeredif458b8c2004-12-07 16:46:42 +0000483int fuse_loop_mt_proc(struct fuse *f, fuse_processor_t proc, void *data);
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000484
485/** Return the exited flag, which indicates if fuse_exit() has been
486 called */
Miklos Szeredie2aa2e22005-07-15 13:31:36 +0000487int fuse_exited(struct fuse *f);
Miklos Szeredid59bb9d2004-12-07 10:04:24 +0000488
489/** Set function which can be used to get the current context */
Miklos Szeredif458b8c2004-12-07 16:46:42 +0000490void fuse_set_getcontext_func(struct fuse_context *(*func)(void));
Miklos Szeredif830a7f2001-11-16 17:46:45 +0000491
Miklos Szeredi0b6a0ad2004-12-04 00:40:50 +0000492/* ----------------------------------------------------------- *
493 * Compatibility stuff *
494 * ----------------------------------------------------------- */
495
496#if FUSE_USE_VERSION == 21 || FUSE_USE_VERSION == 11
Miklos Szeredie56818b2004-12-12 11:45:24 +0000497# include "fuse_compat.h"
Miklos Szeredif458b8c2004-12-07 16:46:42 +0000498# 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 Szeredi0b6a0ad2004-12-04 00:40:50 +0000502# 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 Szeredif458b8c2004-12-07 16:46:42 +0000508# 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 Szeredi0b6a0ad2004-12-04 00:40:50 +0000515# else
Miklos Szeredi0b6a0ad2004-12-04 00:40:50 +0000516# define FUSE_MAJOR_VERSION 1
517# define FUSE_MINOR_VERSION 1
Miklos Szeredif458b8c2004-12-07 16:46:42 +0000518# 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 Szeredi0b6a0ad2004-12-04 00:40:50 +0000524# endif
Miklos Szeredi799993c2004-12-04 21:20:05 +0000525#elif FUSE_USE_VERSION < 22
526# error Compatibility with API version other than 21 and 11 not supported
Miklos Szeredi0b6a0ad2004-12-04 00:40:50 +0000527#endif
528
Miklos Szerediacd4e062001-12-08 20:29:20 +0000529#ifdef __cplusplus
530}
531#endif
532
533#endif /* _FUSE_H_ */