haiku/headers/os/kernel/fs_interface.h
Axel Dörfler 9c3e90a54e Removed the FS interface functions from vfs.h to a new file fs_interface.h.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@737 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-08-13 13:48:18 +00:00

133 lines
5.8 KiB
C

/* File System Interface Layer Definition
**
** Distributed under the terms of the OpenBeOS License.
*/
#ifndef _FS_INTERFACE_H
#define _FS_INTERFACE_H
#include <ktypes.h>
#include <vfs_types.h>
struct dirent;
struct stat;
struct fs_info;
struct attr_info;
struct index_info;
/* the file system's private data structures */
typedef void *fs_cookie;
typedef void *file_cookie;
typedef void *fs_vnode;
/* passed to fs_write_stat() */
enum write_stat_mask {
FS_WSTAT_MODE = 0x0001,
FS_WSTAT_UID = 0x0002,
FS_WSTAT_GID = 0x0004,
FS_WSTAT_SIZE = 0x0008,
FS_WSTAT_ATIME = 0x0010,
FS_WSTAT_MTIME = 0x0020,
FS_WSTAT_CRTIME = 0x0040
};
#define WFSSTAT_NAME 0x0001
#define B_CURRENT_FS_API_VERSION 3
#ifdef __cplusplus
extern "C" {
#endif
struct fs_calls {
/* general operations */
int (*fs_mount)(fs_id id, const char *device, void *args, fs_cookie *_fs, vnode_id *_rootVnodeID);
int (*fs_unmount)(fs_cookie fs);
int (*fs_read_fs_info)(fs_cookie fs, struct fs_info *info);
int (*fs_write_fs_info)(fs_cookie fs, const struct fs_info *info, int mask);
int (*fs_sync)(fs_cookie fs);
/* vnode operations */
int (*fs_lookup)(fs_cookie fs, fs_vnode dir, const char *name, vnode_id *_id, int *_type);
int (*fs_get_vnode_name)(fs_cookie fs, fs_vnode vnode, char *buffer, size_t bufferSize);
int (*fs_get_vnode)(fs_cookie fs, vnode_id id, fs_vnode *_vnode, bool reenter);
int (*fs_put_vnode)(fs_cookie fs, fs_vnode vnode, bool reenter);
int (*fs_remove_vnode)(fs_cookie fs, fs_vnode vnode, bool reenter);
/* VM file access */
int (*fs_can_page)(fs_cookie fs, fs_vnode v);
ssize_t (*fs_read_page)(fs_cookie fs, fs_vnode v, iovecs *vecs, off_t pos);
ssize_t (*fs_write_page)(fs_cookie fs, fs_vnode v, iovecs *vecs, off_t pos);
/* common operations */
int (*fs_ioctl)(fs_cookie fs, fs_vnode v, file_cookie cookie, ulong op, void *buffer, size_t length);
int (*fs_fsync)(fs_cookie fs, fs_vnode v);
int (*fs_read_link)(fs_cookie fs, fs_vnode link, char *buffer, size_t bufferSize);
int (*fs_write_link)(fs_cookie fs, fs_vnode link, char *toPath);
int (*fs_symlink)(fs_cookie fs, fs_vnode dir, const char *name, const char *path, int mode);
int (*fs_unlink)(fs_cookie fs, fs_vnode dir, const char *name);
int (*fs_rename)(fs_cookie fs, fs_vnode olddir, const char *oldname, fs_vnode newdir, const char *newname);
int (*fs_access)(fs_cookie fs, fs_vnode vnode, int mode);
int (*fs_read_stat)(fs_cookie fs, fs_vnode vnode, struct stat *stat);
int (*fs_write_stat)(fs_cookie fs, fs_vnode vnode, const struct stat *stat, int statMask);
/* file operations */
int (*fs_create)(fs_cookie fs, fs_vnode dir, const char *name, int omode, int perms, file_cookie *_cookie, vnode_id *_newVnodeID);
int (*fs_open)(fs_cookie fs, fs_vnode v, int oflags, file_cookie *_cookie);
int (*fs_close)(fs_cookie fs, fs_vnode v, file_cookie cookie);
int (*fs_free_cookie)(fs_cookie fs, fs_vnode v, file_cookie cookie);
ssize_t (*fs_read)(fs_cookie fs, fs_vnode v, file_cookie cookie, off_t pos, void *buffer, size_t *length);
ssize_t (*fs_write)(fs_cookie fs, fs_vnode v, file_cookie cookie, off_t pos, const void *buffer, size_t *length);
off_t (*fs_seek)(fs_cookie fs, fs_vnode v, file_cookie cookie, off_t pos, int seekType);
/* directory operations */
int (*fs_create_dir)(fs_cookie fs, fs_vnode parent, const char *name, int perms, vnode_id *_newVnodeID);
int (*fs_open_dir)(fs_cookie fs, fs_vnode v, file_cookie *_cookie);
int (*fs_close_dir)(fs_cookie fs, fs_vnode v, file_cookie cookie);
int (*fs_free_dir_cookie)(fs_cookie fs, fs_vnode v, file_cookie cookie);
int (*fs_read_dir)(fs_cookie fs, fs_vnode v, file_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num);
int (*fs_rewind_dir)(fs_cookie fs, fs_vnode v, file_cookie cookie);
/* attribute directory operations */
// int (*fs_open_attr_dir)(fs_cookie fs, fs_vnode v, file_cookie *cookie, int oflags);
// int (*fs_close_attr_dir)(fs_cookie fs, fs_vnode v, file_cookie cookie);
// int (*fs_free_attr_dir_cookie)(fs_cookie fs, fs_vnode v, file_cookie cookie);
// int (*fs_read_attr_dir)(fs_cookie fs, fs_vnode v, file_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num);
// int (*fs_rewind_attr_dir)(fs_cookie fs, fs_vnode v, file_cookie cookie);
//
// /* attribute operations */
// int (*fs_open_attr)(fs_cookie fs, fs_vnode v, file_cookie *cookie, stream_type st, int oflags);
// int (*fs_close_attr)(fs_cookie fs, fs_vnode v, file_cookie cookie);
// int (*fs_free_attr_cookie)(fs_cookie fs, fs_vnode v, file_cookie cookie);
// ssize_t (*fs_read_attr)(fs_cookie fs, fs_vnode v, file_cookie cookie, void *buf, off_t pos, size_t *len);
// ssize_t (*fs_write_attr)(fs_cookie fs, fs_vnode v, file_cookie cookie, const void *buf, off_t pos, size_t *len);
// int (*fs_seek_attr)(fs_cookie fs, fs_vnode v, file_cookie cookie, off_t pos, int st);
// int (*fs_rename_attr)(fs_cookie fs, fs_vnode file, const char *oldname, const char *newname);
//
// /* index directory & index operations */
// int (*fs_open_index_dir)(fs_cookie fs, fs_vnode v, file_cookie *cookie, int oflags);
// int (*fs_close_index_dir)(fs_cookie fs, fs_vnode v, file_cookie cookie);
// int (*fs_free_index_dir_cookie)(fs_cookie fs, fs_vnode v, file_cookie cookie);
// int (*fs_read_index_dir)(fs_cookie fs, fs_vnode v, file_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num);
// int (*fs_rewind_index_dir)(fs_cookie fs, fs_vnode v, file_cookie cookie);
//
// /* query operations */
// int (*fs_open_query)(fs_cookie fs, fs_vnode v, file_cookie *cookie, int oflags);
// int (*fs_close_query)(fs_cookie fs, fs_vnode v, file_cookie cookie);
// int (*fs_free_query_cookie)(fs_cookie fs, fs_vnode v, file_cookie cookie);
// int (*fs_read_query)(fs_cookie fs, fs_vnode v, file_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num);
// int (*fs_rewind_query)(fs_cookie fs, fs_vnode v, file_cookie cookie);
};
#ifdef __cplusplus
}
#endif
#endif /* _FS_INTERFACE_H */