Logo Search packages:      
Sourcecode: fuse version File versions  Download package

fuse_common.h

Go to the documentation of this file.
/*
  FUSE: Filesystem in Userspace
  Copyright (C) 2001-2007  Miklos Szeredi <miklos@szeredi.hu>

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

/** @file */

#if !defined(_FUSE_H_) && !defined(_FUSE_LOWLEVEL_H_)
#error "Never include <fuse_common.h> directly; use <fuse.h> or <fuse_lowlevel.h> instead."
#endif

#ifndef _FUSE_COMMON_H_
#define _FUSE_COMMON_H_

#include "fuse_opt.h"
#include <stdint.h>

/** Major version of FUSE library interface */
00022 #define FUSE_MAJOR_VERSION 2

/** Minor version of FUSE library interface */
00025 #define FUSE_MINOR_VERSION 8

#define FUSE_MAKE_VERSION(maj, min)  ((maj) * 10 + (min))
#define FUSE_VERSION FUSE_MAKE_VERSION(FUSE_MAJOR_VERSION, FUSE_MINOR_VERSION)

/* This interface uses 64 bit off_t */
#if _FILE_OFFSET_BITS != 64
#error Please add -D_FILE_OFFSET_BITS=64 to your compile flags!
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Information about open files
 *
 * Changed in version 2.5
 */
00044 struct fuse_file_info {
      /** Open flags.    Available in open() and release() */
00046       int flags;

      /** Old file handle, don't use */
00049       unsigned long fh_old;

      /** In case of a write operation indicates if this was caused by a
          writepage */
00053       int writepage;

      /** Can be filled in by open, to use direct I/O on this file.
          Introduced in version 2.4 */
00057       unsigned int direct_io : 1;

      /** Can be filled in by open, to indicate, that cached file data
          need not be invalidated.  Introduced in version 2.4 */
00061       unsigned int keep_cache : 1;

      /** Indicates a flush operation.  Set in flush operation, also
          maybe set in highlevel lock operation and lowlevel release
          operation.    Introduced in version 2.6 */
00066       unsigned int flush : 1;

      /** Can be filled in by open, to indicate that the file is not
          seekable.  Introduced in version 2.9 */
00070       unsigned int nonseekable : 1;

      /** Padding.  Do not use*/
00073       unsigned int padding : 28;

      /** File handle.  May be filled in by filesystem in open().
          Available in all other file operations */
00077       uint64_t fh;

      /** Lock owner id.  Available in locking operations and flush */
00080       uint64_t lock_owner;
};

/**
 * Capability bits for 'fuse_conn_info.capable' and 'fuse_conn_info.want'
 *
 * FUSE_CAP_ASYNC_READ: filesystem supports asynchronous read requests
 * FUSE_CAP_POSIX_LOCKS: filesystem supports "remote" locking
 * FUSE_CAP_ATOMIC_O_TRUNC: filesystem handles the O_TRUNC open flag
 * FUSE_CAP_EXPORT_SUPPORT: filesystem handles lookups of "." and ".."
 * FUSE_CAP_BIG_WRITES: filesystem can handle write size larger than 4kB
 * FUSE_CAP_DONT_MASK: don't apply umask to file mode on create operations
 */
00093 #define FUSE_CAP_ASYNC_READ   (1 << 0)
#define FUSE_CAP_POSIX_LOCKS  (1 << 1)
#define FUSE_CAP_ATOMIC_O_TRUNC     (1 << 3)
#define FUSE_CAP_EXPORT_SUPPORT     (1 << 4)
#define FUSE_CAP_BIG_WRITES   (1 << 5)
#define FUSE_CAP_DONT_MASK    (1 << 6)

/**
 * Ioctl flags
 *
 * FUSE_IOCTL_COMPAT: 32bit compat ioctl on 64bit machine
 * FUSE_IOCTL_UNRESTRICTED: not restricted to well-formed ioctls, retry allowed
 * FUSE_IOCTL_RETRY: retry with new iovecs
 *
 * FUSE_IOCTL_MAX_IOV: maximum of in_iovecs + out_iovecs
 */
00109 #define FUSE_IOCTL_COMPAT     (1 << 0)
#define FUSE_IOCTL_UNRESTRICTED     (1 << 1)
#define FUSE_IOCTL_RETRY      (1 << 2)

#define FUSE_IOCTL_MAX_IOV    256

/**
 * Connection information, passed to the ->init() method
 *
 * Some of the elements are read-write, these can be changed to
 * indicate the value requested by the filesystem.  The requested
 * value must usually be smaller than the indicated value.
 */
00122 struct fuse_conn_info {
      /**
       * Major version of the protocol (read-only)
       */
00126       unsigned proto_major;

      /**
       * Minor version of the protocol (read-only)
       */
00131       unsigned proto_minor;

      /**
       * Is asynchronous read supported (read-write)
       */
00136       unsigned async_read;

      /**
       * Maximum size of the write buffer
       */
00141       unsigned max_write;

      /**
       * Maximum readahead
       */
00146       unsigned max_readahead;

      /**
       * Capability flags, that the kernel supports
       */
00151       unsigned capable;

      /**
       * Capability flags, that the filesystem wants to enable
       */
00156       unsigned want;

      /**
       * For future use.
       */
00161       unsigned reserved[25];
};

struct fuse_session;
struct fuse_chan;
struct fuse_pollhandle;

/**
 * Create a FUSE mountpoint
 *
 * Returns a control file descriptor suitable for passing to
 * fuse_new()
 *
 * @param mountpoint the mount point path
 * @param args argument vector
 * @return the communication channel on success, NULL on failure
 */
struct fuse_chan *fuse_mount(const char *mountpoint, struct fuse_args *args);

/**
 * Umount a FUSE mountpoint
 *
 * @param mountpoint the mount point path
 * @param ch the communication channel
 */
void fuse_unmount(const char *mountpoint, struct fuse_chan *ch);

/**
 * Parse common options
 *
 * The following options are parsed:
 *
 *   '-f'        foreground
 *   '-d' '-odebug'  foreground, but keep the debug option
 *   '-s'        single threaded
 *   '-h' '--help'   help
 *   '-ho'       help without header
 *   '-ofsname=..'   file system name, if not present, then set to the program
 *               name
 *
 * All parameters may be NULL
 *
 * @param args argument vector
 * @param mountpoint the returned mountpoint, should be freed after use
 * @param multithreaded set to 1 unless the '-s' option is present
 * @param foreground set to 1 if one of the relevant options is present
 * @return 0 on success, -1 on failure
 */
int fuse_parse_cmdline(struct fuse_args *args, char **mountpoint,
                   int *multithreaded, int *foreground);

/**
 * Go into the background
 *
 * @param foreground if true, stay in the foreground
 * @return 0 on success, -1 on failure
 */
int fuse_daemonize(int foreground);

/**
 * Get the version of the library
 *
 * @return the version
 */
int fuse_version(void);

/**
 * Destroy poll handle
 *
 * @param ph the poll handle
 */
void fuse_pollhandle_destroy(struct fuse_pollhandle *ph);

/* ----------------------------------------------------------- *
 * Signal handling                                     *
 * ----------------------------------------------------------- */

/**
 * Exit session on HUP, TERM and INT signals and ignore PIPE signal
 *
 * Stores session in a global variable.    May only be called once per
 * process until fuse_remove_signal_handlers() is called.
 *
 * @param se the session to exit
 * @return 0 on success, -1 on failure
 */
int fuse_set_signal_handlers(struct fuse_session *se);

/**
 * Restore default signal handlers
 *
 * Resets global session.  After this fuse_set_signal_handlers() may
 * be called again.
 *
 * @param se the same session as given in fuse_set_signal_handlers()
 */
void fuse_remove_signal_handlers(struct fuse_session *se);

/* ----------------------------------------------------------- *
 * Compatibility stuff                                 *
 * ----------------------------------------------------------- */

#if FUSE_USE_VERSION < 26
#    ifdef __FreeBSD__
#      if FUSE_USE_VERSION < 25
#          error On FreeBSD API version 25 or greater must be used
#      endif
#    endif
#    include "fuse_common_compat.h"
#    undef FUSE_MINOR_VERSION
#    undef fuse_main
#    define fuse_unmount fuse_unmount_compat22
#    if FUSE_USE_VERSION == 25
#      define FUSE_MINOR_VERSION 5
#      define fuse_mount fuse_mount_compat25
#    elif FUSE_USE_VERSION == 24 || FUSE_USE_VERSION == 22
#      define FUSE_MINOR_VERSION 4
#      define fuse_mount fuse_mount_compat22
#    elif FUSE_USE_VERSION == 21
#      define FUSE_MINOR_VERSION 1
#      define fuse_mount fuse_mount_compat22
#    elif FUSE_USE_VERSION == 11
#      warning Compatibility with API version 11 is deprecated
#      undef FUSE_MAJOR_VERSION
#      define FUSE_MAJOR_VERSION 1
#      define FUSE_MINOR_VERSION 1
#      define fuse_mount fuse_mount_compat1
#    else
#      error Compatibility with API version other than 21, 22, 24, 25 and 11 not supported
#    endif
#endif

#ifdef __cplusplus
}
#endif

#endif /* _FUSE_COMMON_H_ */

Generated by  Doxygen 1.6.0   Back to index