osxfuse/common/fuse_param.h

/*
 * Copyright (c) 2006-2008 Amit Singh/Google Inc.
 * Copyright (c) 2010 Tuxera Inc.
 * Copyright (c) 2011-2012 Benjamin Fleischer
 * All rights reserved.
 */

#ifndef _FUSE_PARAM_H_
#define _FUSE_PARAM_H_

#include <fuse_version.h>

#include <AvailabilityMacros.h>

/* Compile-time tunables (M_OSXFUSE*) */

#define M_OSXFUSE_ENABLE_FIFOFS                0
#define M_OSXFUSE_ENABLE_INTERRUPT             1
#define M_OSXFUSE_ENABLE_SPECFS                0
#define M_OSXFUSE_ENABLE_TSLOCKING             1
#define M_OSXFUSE_ENABLE_UNSUPPORTED           1
#define M_OSXFUSE_ENABLE_XATTR                 1
#define M_OSXFUSE_ENABLE_DSELECT               1

#if M_OSXFUSE_ENABLE_UNSUPPORTED
#  define M_OSXFUSE_ENABLE_EXCHANGE            1
#  define M_OSXFUSE_ENABLE_INTERIM_FSNODE_LOCK 1
#endif /* M_OSXFUSE_ENABLE_UNSUPPORTED */

#if MAC_OS_X_VERSION_MIN_REQUIRED < 1060
#  if M_OSXFUSE_ENABLE_UNSUPPORTED
     /*
      * In Mac OS X 10.5 the file system implementation is responsible for
      * posting kqueue events. Starting with Mac OS X 10.6 VFS took over that
      * job.
      */
#    define M_OSXFUSE_ENABLE_KQUEUE            1
#  endif
#endif /* MAC_OS_X_VERSION_MIN_REQUIRED < 1060 */

#if M_OSXFUSE_ENABLE_INTERIM_FSNODE_LOCK
   /*
    * Options M_OSXFUSE_ENABLE_BIG_LOCK and M_OSXFUSE_ENABLE_HUGE_LOCK are
    * mutually exclusive.
    */
#  define M_OSXFUSE_ENABLE_HUGE_LOCK           0
#  define M_OSXFUSE_ENABLE_BIG_LOCK            1

#  define M_OSXFUSE_ENABLE_LOCK_LOGGING        0
#  define FUSE_VNOP_EXPORT __private_extern__
#else
#  define FUSE_VNOP_EXPORT static
#endif /* M_OSXFUSE_ENABLE_INTERIM_FSNODE_LOCK */

/* User Control */

#define OSXFUSE_POSTUNMOUNT_SIGNAL         SIGKILL

#define MACOSX_ADMIN_GROUP_NAME            "admin"

#define SYSCTL_OSXFUSE_TUNABLES_ADMIN      "vfs.generic." OSXFUSE_NAME ".tunables.admin_group"
#define SYSCTL_OSXFUSE_VERSION_NUMBER      "vfs.generic." OSXFUSE_NAME ".version.number"

#if OSXFUSE_ENABLE_MACFUSE_MODE
#  define SYSCTL_OSXFUSE_MACFUSE_MODE      "vfs.generic." OSXFUSE_NAME ".control.macfuse_mode"
#endif

/* Paths */

#define OSXFUSE_BUNDLE_PATH    "/Library/Filesystems/osxfuse.fs"
#define OSXFUSE_RESOURCES_PATH OSXFUSE_BUNDLE_PATH "/Contents/Resources"
#define OSXFUSE_KEXT_NAME      "osxfuse.kext"
#define OSXFUSE_LOAD_PROG      OSXFUSE_RESOURCES_PATH "/load_osxfuse"
#define OSXFUSE_MOUNT_PROG     OSXFUSE_RESOURCES_PATH "/mount_osxfuse"
#define SYSTEM_KEXTLOAD        "/sbin/kextload"
#define SYSTEM_KEXTUNLOAD      "/sbin/kextunload"

/* Compatible API version */

#define OSXFUSE_MIN_ABI_VERSION            708

/* Device Interface */

/*
 * This is the prefix ("osxfuse" by default) of the name of a FUSE device node
 * in devfs. The suffix is the device number. "/dev/osxfuse0" is the first FUSE
 * device by default. If you change the prefix from the default to something
 * else, the user-space FUSE library will need to know about it too.
 */
#define OSXFUSE_DEVICE_BASENAME            OSXFUSE_NAME

/*
 * This is the number of /dev/osxfuse<n> nodes we will create. <n> goes from
 * 0 to (OSXFUSE_NDEVICES - 1).
 */
#define OSXFUSE_NDEVICES                   24

/*
 * This is the default block size of the virtual storage devices that are
 * implicitly implemented by the FUSE kernel extension. This can be changed
 * on a per-mount basis (there's one such virtual device for each mount).
 */
#define FUSE_DEFAULT_BLOCKSIZE             4096

#define FUSE_MIN_BLOCKSIZE                 512
#define FUSE_MAX_BLOCKSIZE                 MAXPHYS

#ifndef MAX_UPL_TRANSFER
#define MAX_UPL_TRANSFER 256
#endif

/*
 * This is default I/O size used while accessing the virtual storage devices.
 * This can be changed on a per-mount and per-file basis.
 *
 * Nevertheless, the I/O size must be at least as big as the block size.
 */
#define FUSE_DEFAULT_IOSIZE                (16 * PAGE_SIZE)

#define FUSE_MIN_IOSIZE                    512
#define FUSE_MAX_IOSIZE                    (MAX_UPL_TRANSFER * PAGE_SIZE)

#define FUSE_DEFAULT_DAEMON_TIMEOUT                60     /* s */
#define FUSE_MIN_DAEMON_TIMEOUT                    0      /* s */
#define FUSE_MAX_DAEMON_TIMEOUT                    600    /* s */

#ifdef KERNEL

/*
 * This is the soft upper limit on the number of "request tickets" FUSE's
 * user-kernel IPC layer can have for a given mount. This can be modified
 * through the fuse.* sysctl interface.
 */
#define FUSE_DEFAULT_MAX_FREE_TICKETS      1024
#define FUSE_DEFAULT_IOV_PERMANENT_BUFSIZE (1 << 19)
#define FUSE_DEFAULT_IOV_CREDIT            16

/* User-Kernel IPC Buffer */

#define FUSE_MIN_USERKERNEL_BUFSIZE        (128  * 1024)
#define FUSE_MAX_USERKERNEL_BUFSIZE        (16   * 1024 * 1024)

#define FUSE_REASONABLE_XATTRSIZE          FUSE_MIN_USERKERNEL_BUFSIZE

#endif /* KERNEL */

#define FUSE_DEFAULT_USERKERNEL_BUFSIZE    (16   * 1024 * 1024)

#define FUSE_LINK_MAX                      LINK_MAX
#define FUSE_UIO_BACKUP_MAX                8

#define FUSE_MAXNAMLEN                     255

#endif /* _FUSE_PARAM_H_ */