/* File System Interface Layer Definition * * Copyright 2004-2006, Haiku Inc. All Rights Reserved. * Distributed under the terms of the MIT License. */ #ifndef _FS_INTERFACE_H #define _FS_INTERFACE_H #include #include #include #include #include struct dirent; struct stat; struct fs_info; struct select_sync; typedef dev_t mount_id; typedef ino_t vnode_id; /* the file system's private data structures */ typedef void *fs_volume; typedef void *fs_cookie; typedef void *fs_vnode; /* passed to write_stat() */ enum write_stat_mask { FS_WRITE_STAT_MODE = 0x0001, FS_WRITE_STAT_UID = 0x0002, FS_WRITE_STAT_GID = 0x0004, FS_WRITE_STAT_SIZE = 0x0008, FS_WRITE_STAT_ATIME = 0x0010, FS_WRITE_STAT_MTIME = 0x0020, FS_WRITE_STAT_CRTIME = 0x0040 // NOTE: Changing these constants will break // src/kits/storage/LibBeAdapter.cpp:_kern_write_stat(). }; /* passed to write_fs_info() */ #define FS_WRITE_FSINFO_NAME 0x0001 struct file_io_vec { off_t offset; off_t length; }; #define B_CURRENT_FS_API_VERSION "/v1" #ifdef __cplusplus extern "C" { #endif typedef struct file_system_module_info { struct module_info info; const char *pretty_name; /* scanning (the device is write locked) */ float (*identify_partition)(int fd, partition_data *partition, void **cookie); status_t (*scan_partition)(int fd, partition_data *partition, void *cookie); void (*free_identify_partition_cookie)(partition_data *partition, void *cookie); void (*free_partition_content_cookie)(partition_data *partition); /* general operations */ status_t (*mount)(mount_id id, const char *device, uint32 flags, const char *args, fs_volume *_fs, vnode_id *_rootVnodeID); status_t (*unmount)(fs_volume fs); status_t (*read_fs_info)(fs_volume fs, struct fs_info *info); status_t (*write_fs_info)(fs_volume fs, const struct fs_info *info, uint32 mask); status_t (*sync)(fs_volume fs); /* vnode operations */ status_t (*lookup)(fs_volume fs, fs_vnode dir, const char *name, vnode_id *_id, int *_type); status_t (*get_vnode_name)(fs_volume fs, fs_vnode vnode, char *buffer, size_t bufferSize); status_t (*get_vnode)(fs_volume fs, vnode_id id, fs_vnode *_vnode, bool reenter); status_t (*put_vnode)(fs_volume fs, fs_vnode vnode, bool reenter); status_t (*remove_vnode)(fs_volume fs, fs_vnode vnode, bool reenter); /* VM file access */ bool (*can_page)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); status_t (*read_pages)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, off_t pos, const iovec *vecs, size_t count, size_t *_numBytes, bool reenter); status_t (*write_pages)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, off_t pos, const iovec *vecs, size_t count, size_t *_numBytes, bool reenter); /* cache file access */ status_t (*get_file_map)(fs_volume fs, fs_vnode vnode, off_t offset, size_t size, struct file_io_vec *vecs, size_t *_count); /* common operations */ status_t (*ioctl)(fs_volume fs, fs_vnode v, fs_cookie cookie, ulong op, void *buffer, size_t length); status_t (*set_flags)(fs_volume fs, fs_vnode v, fs_cookie cookie, int flags); status_t (*select)(fs_volume fs, fs_vnode v, fs_cookie cookie, uint8 event, uint32 ref, selectsync *sync); status_t (*deselect)(fs_volume fs, fs_vnode v, fs_cookie cookie, uint8 event, selectsync *sync); status_t (*fsync)(fs_volume fs, fs_vnode v); status_t (*read_link)(fs_volume fs, fs_vnode link, char *buffer, size_t *_bufferSize); status_t (*write_link)(fs_volume fs, fs_vnode link, char *toPath); status_t (*create_symlink)(fs_volume fs, fs_vnode dir, const char *name, const char *path, int mode); status_t (*link)(fs_volume fs, fs_vnode dir, const char *name, fs_vnode vnode); status_t (*unlink)(fs_volume fs, fs_vnode dir, const char *name); status_t (*rename)(fs_volume fs, fs_vnode fromDir, const char *fromName, fs_vnode toDir, const char *toName); status_t (*access)(fs_volume fs, fs_vnode vnode, int mode); status_t (*read_stat)(fs_volume fs, fs_vnode vnode, struct stat *stat); status_t (*write_stat)(fs_volume fs, fs_vnode vnode, const struct stat *stat, uint32 statMask); /* file operations */ status_t (*create)(fs_volume fs, fs_vnode dir, const char *name, int openMode, int perms, fs_cookie *_cookie, vnode_id *_newVnodeID); status_t (*open)(fs_volume fs, fs_vnode v, int openMode, fs_cookie *_cookie); status_t (*close)(fs_volume fs, fs_vnode v, fs_cookie cookie); status_t (*free_cookie)(fs_volume fs, fs_vnode v, fs_cookie cookie); status_t (*read)(fs_volume fs, fs_vnode v, fs_cookie cookie, off_t pos, void *buffer, size_t *length); status_t (*write)(fs_volume fs, fs_vnode v, fs_cookie cookie, off_t pos, const void *buffer, size_t *length); /* directory operations */ status_t (*create_dir)(fs_volume fs, fs_vnode parent, const char *name, int perms, vnode_id *_newVnodeID); status_t (*remove_dir)(fs_volume fs, fs_vnode parent, const char *name); status_t (*open_dir)(fs_volume fs, fs_vnode vnode, fs_cookie *_cookie); status_t (*close_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); status_t (*free_dir_cookie)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); status_t (*read_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num); status_t (*rewind_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); /* attribute directory operations */ status_t (*open_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie *_cookie); status_t (*close_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); status_t (*free_attr_dir_cookie)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); status_t (*read_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num); status_t (*rewind_attr_dir)(fs_volume fs, fs_vnode vnode, fs_cookie cookie); /* attribute operations */ status_t (*create_attr)(fs_volume fs, fs_vnode file, const char *name, uint32 type, int openMode, fs_cookie *_cookie); status_t (*open_attr)(fs_volume fs, fs_vnode file, const char *name, int openMode, fs_cookie *_cookie); status_t (*close_attr)(fs_volume fs, fs_vnode file, fs_cookie cookie); status_t (*free_attr_cookie)(fs_volume fs, fs_vnode file, fs_cookie cookie); status_t (*read_attr)(fs_volume fs, fs_vnode file, fs_cookie cookie, off_t pos, void *buffer, size_t *length); status_t (*write_attr)(fs_volume fs, fs_vnode file, fs_cookie cookie, off_t pos, const void *buffer, size_t *length); status_t (*read_attr_stat)(fs_volume fs, fs_vnode file, fs_cookie cookie, struct stat *stat); status_t (*write_attr_stat)(fs_volume fs, fs_vnode file, fs_cookie cookie, const struct stat *stat, int statMask); status_t (*rename_attr)(fs_volume fs, fs_vnode fromFile, const char *fromName, fs_vnode toFile, const char *toName); status_t (*remove_attr)(fs_volume fs, fs_vnode file, const char *name); /* index directory & index operations */ status_t (*open_index_dir)(fs_volume fs, fs_cookie *cookie); status_t (*close_index_dir)(fs_volume fs, fs_cookie cookie); status_t (*free_index_dir_cookie)(fs_volume fs, fs_cookie cookie); status_t (*read_index_dir)(fs_volume fs, fs_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num); status_t (*rewind_index_dir)(fs_volume fs, fs_cookie cookie); status_t (*create_index)(fs_volume fs, const char *name, uint32 type, uint32 flags); status_t (*remove_index)(fs_volume fs, const char *name); status_t (*read_index_stat)(fs_volume fs, const char *name, struct stat *stat); /* query operations */ status_t (*open_query)(fs_volume fs, const char *query, uint32 flags, port_id port, uint32 token, fs_cookie *_cookie); status_t (*close_query)(fs_volume fs, fs_cookie cookie); status_t (*free_query_cookie)(fs_volume fs, fs_cookie cookie); status_t (*read_query)(fs_volume fs, fs_cookie cookie, struct dirent *buffer, size_t bufferSize, uint32 *_num); status_t (*rewind_query)(fs_volume fs, fs_cookie cookie); /* capability querying (the device is read locked) */ // ToDo: this will probably be combined to a single call bool (*supports_defragmenting)(partition_data *partition, bool *whileMounted); bool (*supports_repairing)(partition_data *partition, bool checkOnly, bool *whileMounted); bool (*supports_resizing)(partition_data *partition, bool *whileMounted); bool (*supports_moving)(partition_data *partition, bool *isNoOp); bool (*supports_setting_content_name)(partition_data *partition, bool *whileMounted); bool (*supports_setting_content_parameters)(partition_data *partition, bool *whileMounted); bool (*supports_initializing)(partition_data *partition); bool (*validate_resize)(partition_data *partition, off_t *size); bool (*validate_move)(partition_data *partition, off_t *start); bool (*validate_set_content_name)(partition_data *partition, char *name); bool (*validate_set_content_parameters)(partition_data *partition, const char *parameters); bool (*validate_initialize)(partition_data *partition, char *name, const char *parameters); /* shadow partition modification (device is write locked) */ status_t (*shadow_changed)(partition_data *partition, uint32 operation); /* writing (the device is NOT locked) */ status_t (*defragment)(int fd, partition_id partition, disk_job_id job); status_t (*repair)(int fd, partition_id partition, bool checkOnly, disk_job_id job); status_t (*resize)(int fd, partition_id partition, off_t size, disk_job_id job); status_t (*move)(int fd, partition_id partition, off_t offset, disk_job_id job); status_t (*set_content_name)(int fd, partition_id partition, const char *name, disk_job_id job); status_t (*set_content_parameters)(int fd, partition_id partition, const char *parameters, disk_job_id job); status_t (*initialize)(const char *partition, const char *name, const char *parameters, disk_job_id job); // This is pretty close to how the hook in R5 looked. Save the job ID, of // course and that the parameters were given as (void*, size_t) pair. } file_system_module_info; /* file system add-ons only prototypes */ extern status_t new_vnode(mount_id mountID, vnode_id vnodeID, fs_vnode privateNode); extern status_t publish_vnode(mount_id mountID, vnode_id vnodeID, fs_vnode privateNode); extern status_t get_vnode(mount_id mountID, vnode_id vnodeID, fs_vnode *_privateNode); extern status_t put_vnode(mount_id mountID, vnode_id vnodeID); extern status_t remove_vnode(mount_id mountID, vnode_id vnodeID); extern status_t unremove_vnode(mount_id mountID, vnode_id vnodeID); extern status_t notify_listener(int op, mount_id device, vnode_id parentNode, vnode_id toParentNode, vnode_id node, const char *name); extern status_t send_notification(port_id port, long token, ulong what, long op, mount_id device, mount_id toDevice, vnode_id parentNode, vnode_id toParentNode, vnode_id node, const char *name); extern status_t notify_entry_created(mount_id device, vnode_id directory, const char *name, vnode_id node); extern status_t notify_entry_removed(mount_id device, vnode_id directory, const char *name, vnode_id node); extern status_t notify_entry_moved(mount_id device, vnode_id fromDirectory, const char *fromName, vnode_id toDirectory, const char *toName, vnode_id node); extern status_t notify_stat_changed(mount_id device, vnode_id node, uint32 statFields); extern status_t notify_attribute_changed(mount_id device, vnode_id node, const char *attribute, int32 cause); extern status_t notify_query_entry_created(port_id port, int32 token, mount_id device, vnode_id directory, const char *name, vnode_id node); extern status_t notify_query_entry_removed(port_id port, int32 token, mount_id device, vnode_id directory, const char *name, vnode_id node); #ifdef __cplusplus } #endif #endif /* _FS_INTERFACE_H */