include/fuse_common.h File Reference

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

Data Structures
struct	fuse_file_info
struct	fuse_conn_info
Defines
#define	FUSE_MAJOR_VERSION   2
#define	FUSE_MINOR_VERSION   8
#define	FUSE_CAP_ASYNC_READ   (1 << 0)
#define	FUSE_IOCTL_COMPAT   (1 << 0)
Functions
struct fuse_chan *	fuse_mount (const char *mountpoint, struct fuse_args *args)
void	fuse_unmount (const char *mountpoint, struct fuse_chan *ch)
int	fuse_parse_cmdline (struct fuse_args *args, char **mountpoint, int *multithreaded, int *foreground)
int	fuse_daemonize (int foreground)
int	fuse_version (void)
void	fuse_pollhandle_destroy (struct fuse_pollhandle *ph)
int	fuse_set_signal_handlers (struct fuse_session *se)
void	fuse_remove_signal_handlers (struct fuse_session *se)

---

Detailed Description

---

Define Documentation

#define FUSE_CAP_ASYNC_READ   (1 << 0)

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_BIG_WRITES: filesystem can handle write size larger than 4kB

#define FUSE_IOCTL_COMPAT   (1 << 0)

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

#define FUSE_MAJOR_VERSION   2

Major version of FUSE library interface

#define FUSE_MINOR_VERSION   8

Minor version of FUSE library interface

---

Function Documentation

int fuse_daemonize

(

int

foreground

)

Go into the background

Parameters:

foreground

if true, stay in the foreground

Returns:

0 on success, -1 on failure

struct fuse_chan* fuse_mount	(	const char *	mountpoint,
		struct fuse_args *	args
	)			[read]

Create a FUSE mountpoint

Returns a control file descriptor suitable for passing to fuse_new()

Parameters:

	mountpoint	the mount point path
	args	argument vector

Returns:

the communication channel on success, NULL on failure

int fuse_parse_cmdline	(	struct fuse_args *	args,
		char **	mountpoint,
		int *	multithreaded,
		int *	foreground
	)

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

Parameters:

	args	argument vector
	mountpoint	the returned mountpoint, should be freed after use
	multithreaded	set to 1 unless the '-s' option is present
	foreground	set to 1 if one of the relevant options is present

Returns:

0 on success, -1 on failure

void fuse_pollhandle_destroy

(

struct fuse_pollhandle *

ph

)

Destroy poll handle

Parameters:

ph

the poll handle

void fuse_remove_signal_handlers

(

struct fuse_session *

se

)

Restore default signal handlers

Resets global session. After this fuse_set_signal_handlers() may be called again.

Parameters:

se

the same session as given in fuse_set_signal_handlers()

int fuse_set_signal_handlers

(

struct fuse_session *

se

)

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.

Parameters:

se

the session to exit

Returns:

0 on success, -1 on failure

void fuse_unmount	(	const char *	mountpoint,
		struct fuse_chan *	ch
	)

Umount a FUSE mountpoint

Parameters:

	mountpoint	the mount point path
	ch	the communication channel

int fuse_version

(

void

)

Get the version of the library

Returns:

the version