/*
* Copyright (c) 2009 Martin Decky
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* - The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/** @addtogroup libcipc
* @{
*/
/** @file
*/
#ifndef _LIBC_IPC_VFS_H_
#define _LIBC_IPC_VFS_H_
#include <ipc/common.h>
#include <stdint.h>
#include <stdbool.h>
#define FS_NAME_MAXLEN 20
#define FS_LABEL_MAXLEN 256
#define FS_VUID_MAXLEN 128
#define MAX_PATH_LEN (32 * 1024)
#define MAX_MNTOPTS_LEN 256
#define PLB_SIZE (2 * MAX_PATH_LEN)
/* Basic types. */
typedef int16_t fs_handle_t;
typedef uint32_t fs_index_t;
/**
* A structure like this is passed to VFS by each individual FS upon its
* registration. It assosiates a human-readable identifier with each
* registered FS.
*/
typedef struct {
/** Unique identifier of the fs. */
char name[FS_NAME_MAXLEN + 1];
unsigned int instance;
bool concurrent_read_write;
bool write_retains_size;
} vfs_info_t;
/** Data returned by filesystem probe regarding a specific volume. */
typedef struct {
char label[FS_LABEL_MAXLEN + 1];
char vuid[FS_VUID_MAXLEN + 1];
} vfs_fs_probe_info_t;
typedef enum {
VFS_IN_CLONE = IPC_FIRST_USER_METHOD,
VFS_IN_FSPROBE,
VFS_IN_FSTYPES,
VFS_IN_MOUNT,
VFS_IN_OPEN,
VFS_IN_PUT,
VFS_IN_READ,
VFS_IN_REGISTER,
VFS_IN_RENAME,
VFS_IN_RESIZE,
VFS_IN_STAT,
VFS_IN_STATFS,
VFS_IN_SYNC,
VFS_IN_UNLINK,
VFS_IN_UNMOUNT,
VFS_IN_WAIT_HANDLE,
VFS_IN_WALK,
VFS_IN_WRITE,
} vfs_in_request_t;
typedef enum {
VFS_OUT_CLOSE = IPC_FIRST_USER_METHOD,
VFS_OUT_DESTROY,
VFS_OUT_FSPROBE,
VFS_OUT_IS_EMPTY,
VFS_OUT_LINK,
VFS_OUT_LOOKUP,
VFS_OUT_MOUNTED,
VFS_OUT_OPEN_NODE,
VFS_OUT_READ,
VFS_OUT_STAT,
VFS_OUT_STATFS,
VFS_OUT_SYNC,
VFS_OUT_TRUNCATE,
VFS_OUT_UNMOUNTED,
VFS_OUT_WRITE,
VFS_OUT_LAST
} vfs_out_request_t;
/*
* Lookup flags.
*/
/**
* No lookup flags used.
*/
#define L_NONE 0
/**
* Lookup will succeed only if the object is a regular file. If L_CREATE is
* specified, an empty file will be created. This flag is mutually exclusive
* with L_DIRECTORY.
*/
#define L_FILE 1
/**
* Lookup will succeed only if the object is a directory. If L_CREATE is
* specified, an empty directory will be created. This flag is mutually
* exclusive with L_FILE.
*/
#define L_DIRECTORY 2
/**
* Lookup will not cross any mount points.
* If the lookup would have to cross a mount point, it returns EXDEV instead.
*/
#define L_DISABLE_MOUNTS 4
/**
* Lookup will succeed only if the object is a mount point. The flag is mutually
* exclusive with L_FILE.
*/
#define L_MP 8
/**
* When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the
* object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used.
*/
#define L_EXCLUSIVE 16
/**
* L_CREATE is used for creating both regular files and directories.
*/
#define L_CREATE 32
/**
* L_UNLINK is used to remove leaves from the file system namespace. This flag
* cannot be passed directly by the client, but will be set by VFS during
* VFS_UNLINK.
*/
#define L_UNLINK 64
/*
* Walk flags.
*/
enum {
WALK_MAY_CREATE = (1 << 0),
WALK_MUST_CREATE = (1 << 1),
WALK_REGULAR = (1 << 2),
WALK_DIRECTORY = (1 << 3),
WALK_MOUNT_POINT = (1 << 4),
WALK_ALL_FLAGS = WALK_MAY_CREATE | WALK_MUST_CREATE | WALK_REGULAR |
WALK_DIRECTORY | WALK_MOUNT_POINT,
};
enum {
VFS_MOUNT_BLOCKING = 1,
VFS_MOUNT_CONNECT_ONLY = 2,
VFS_MOUNT_NO_REF = 4,
};
enum {
MODE_READ = 1,
MODE_WRITE = 2,
MODE_APPEND = 4,
};
#endif
/** @}
*/