| 1 | /*
|
|---|
| 2 | * Copyright (c) 2008 Jakub Jermar
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup fs
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 |
|
|---|
| 33 | #ifndef VFS_VFS_H_
|
|---|
| 34 | #define VFS_VFS_H_
|
|---|
| 35 |
|
|---|
| 36 | #include <async.h>
|
|---|
| 37 | #include <adt/list.h>
|
|---|
| 38 | #include <fibril_synch.h>
|
|---|
| 39 | #include <sys/types.h>
|
|---|
| 40 | #include <loc.h>
|
|---|
| 41 | #include <bool.h>
|
|---|
| 42 | #include <ipc/vfs.h>
|
|---|
| 43 |
|
|---|
| 44 | #ifndef dprintf
|
|---|
| 45 | #define dprintf(...)
|
|---|
| 46 | #endif
|
|---|
| 47 |
|
|---|
| 48 | /**
|
|---|
| 49 | * A structure like this will be allocated for each registered file system.
|
|---|
| 50 | */
|
|---|
| 51 | typedef struct {
|
|---|
| 52 | link_t fs_link;
|
|---|
| 53 | vfs_info_t vfs_info;
|
|---|
| 54 | fs_handle_t fs_handle;
|
|---|
| 55 | async_sess_t *sess;
|
|---|
| 56 | } fs_info_t;
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * VFS_PAIR uniquely represents a file system instance.
|
|---|
| 60 | */
|
|---|
| 61 | #define VFS_PAIR \
|
|---|
| 62 | fs_handle_t fs_handle; \
|
|---|
| 63 | service_id_t service_id;
|
|---|
| 64 |
|
|---|
| 65 | /**
|
|---|
| 66 | * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but
|
|---|
| 67 | * doesn't contain any state. For a stateful structure, see vfs_node_t.
|
|---|
| 68 | *
|
|---|
| 69 | * @note fs_handle, service_id and index are meant to be returned in one
|
|---|
| 70 | * IPC reply.
|
|---|
| 71 | */
|
|---|
| 72 | #define VFS_TRIPLET \
|
|---|
| 73 | VFS_PAIR; \
|
|---|
| 74 | fs_index_t index;
|
|---|
| 75 |
|
|---|
| 76 | typedef struct {
|
|---|
| 77 | VFS_PAIR;
|
|---|
| 78 | } vfs_pair_t;
|
|---|
| 79 |
|
|---|
| 80 | typedef struct {
|
|---|
| 81 | VFS_TRIPLET;
|
|---|
| 82 | } vfs_triplet_t;
|
|---|
| 83 |
|
|---|
| 84 | typedef enum vfs_node_type {
|
|---|
| 85 | VFS_NODE_UNKNOWN,
|
|---|
| 86 | VFS_NODE_FILE,
|
|---|
| 87 | VFS_NODE_DIRECTORY,
|
|---|
| 88 | } vfs_node_type_t;
|
|---|
| 89 |
|
|---|
| 90 | typedef struct {
|
|---|
| 91 | vfs_triplet_t triplet;
|
|---|
| 92 | vfs_node_type_t type;
|
|---|
| 93 | aoff64_t size;
|
|---|
| 94 | unsigned int lnkcnt;
|
|---|
| 95 | } vfs_lookup_res_t;
|
|---|
| 96 |
|
|---|
| 97 | /**
|
|---|
| 98 | * Instances of this type represent an active, in-memory VFS node and any state
|
|---|
| 99 | * which may be associated with it.
|
|---|
| 100 | */
|
|---|
| 101 | typedef struct {
|
|---|
| 102 | VFS_TRIPLET; /**< Identity of the node. */
|
|---|
| 103 |
|
|---|
| 104 | /**
|
|---|
| 105 | * Usage counter. This includes, but is not limited to, all vfs_file_t
|
|---|
| 106 | * structures that reference this node.
|
|---|
| 107 | */
|
|---|
| 108 | unsigned refcnt;
|
|---|
| 109 |
|
|---|
| 110 | /** Number of names this node has in the file system namespace. */
|
|---|
| 111 | unsigned lnkcnt;
|
|---|
| 112 |
|
|---|
| 113 | link_t nh_link; /**< Node hash-table link. */
|
|---|
| 114 |
|
|---|
| 115 | vfs_node_type_t type; /**< Partial info about the node type. */
|
|---|
| 116 |
|
|---|
| 117 | aoff64_t size; /**< Cached size if the node is a file. */
|
|---|
| 118 |
|
|---|
| 119 | /**
|
|---|
| 120 | * Holding this rwlock prevents modifications of the node's contents.
|
|---|
| 121 | */
|
|---|
| 122 | fibril_rwlock_t contents_rwlock;
|
|---|
| 123 | } vfs_node_t;
|
|---|
| 124 |
|
|---|
| 125 | /**
|
|---|
| 126 | * Instances of this type represent an open file. If the file is opened by more
|
|---|
| 127 | * than one task, there will be a separate structure allocated for each task.
|
|---|
| 128 | */
|
|---|
| 129 | typedef struct {
|
|---|
| 130 | /** Serializes access to this open file. */
|
|---|
| 131 | fibril_mutex_t lock;
|
|---|
| 132 |
|
|---|
| 133 | vfs_node_t *node;
|
|---|
| 134 |
|
|---|
| 135 | /** Number of file handles referencing this file. */
|
|---|
| 136 | unsigned refcnt;
|
|---|
| 137 |
|
|---|
| 138 | /** Append on write. */
|
|---|
| 139 | bool append;
|
|---|
| 140 |
|
|---|
| 141 | /** Current absolute position in the file. */
|
|---|
| 142 | aoff64_t pos;
|
|---|
| 143 | } vfs_file_t;
|
|---|
| 144 |
|
|---|
| 145 | extern fibril_mutex_t nodes_mutex;
|
|---|
| 146 |
|
|---|
| 147 | extern fibril_condvar_t fs_list_cv;
|
|---|
| 148 | extern fibril_mutex_t fs_list_lock;
|
|---|
| 149 | extern list_t fs_list; /**< List of registered file systems. */
|
|---|
| 150 |
|
|---|
| 151 | extern vfs_pair_t rootfs; /**< Root file system. */
|
|---|
| 152 |
|
|---|
| 153 | /** Each instance of this type describes one path lookup in progress. */
|
|---|
| 154 | typedef struct {
|
|---|
| 155 | link_t plb_link; /**< Active PLB entries list link. */
|
|---|
| 156 | unsigned index; /**< Index of the first character in PLB. */
|
|---|
| 157 | size_t len; /**< Number of characters in this PLB entry. */
|
|---|
| 158 | } plb_entry_t;
|
|---|
| 159 |
|
|---|
| 160 | extern fibril_mutex_t plb_mutex;/**< Mutex protecting plb and plb_entries. */
|
|---|
| 161 | extern uint8_t *plb; /**< Path Lookup Buffer */
|
|---|
| 162 | extern list_t plb_entries; /**< List of active PLB entries. */
|
|---|
| 163 |
|
|---|
| 164 | #define MAX_MNTOPTS_LEN 256
|
|---|
| 165 |
|
|---|
| 166 | /** Holding this rwlock prevents changes in file system namespace. */
|
|---|
| 167 | extern fibril_rwlock_t namespace_rwlock;
|
|---|
| 168 |
|
|---|
| 169 | extern async_exch_t *vfs_exchange_grab(fs_handle_t);
|
|---|
| 170 | extern void vfs_exchange_release(async_exch_t *);
|
|---|
| 171 |
|
|---|
| 172 | extern fs_handle_t fs_name_to_handle(char *, bool);
|
|---|
| 173 | extern vfs_info_t *fs_handle_to_info(fs_handle_t);
|
|---|
| 174 |
|
|---|
| 175 | extern int vfs_lookup_internal(char *, int, vfs_lookup_res_t *,
|
|---|
| 176 | vfs_pair_t *, ...);
|
|---|
| 177 |
|
|---|
| 178 | extern bool vfs_nodes_init(void);
|
|---|
| 179 | extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
|
|---|
| 180 | extern void vfs_node_put(vfs_node_t *);
|
|---|
| 181 | extern void vfs_node_forget(vfs_node_t *);
|
|---|
| 182 | extern unsigned vfs_nodes_refcount_sum_get(fs_handle_t, service_id_t);
|
|---|
| 183 |
|
|---|
| 184 |
|
|---|
| 185 | #define MAX_OPEN_FILES 128
|
|---|
| 186 |
|
|---|
| 187 | extern void *vfs_client_data_create(void);
|
|---|
| 188 | extern void vfs_client_data_destroy(void *);
|
|---|
| 189 |
|
|---|
| 190 | extern void vfs_pass_handle(sysarg_t, sysarg_t, int);
|
|---|
| 191 | extern int vfs_wait_handle_internal(void);
|
|---|
| 192 |
|
|---|
| 193 | extern vfs_file_t *vfs_file_get(int);
|
|---|
| 194 | extern void vfs_file_put(vfs_file_t *);
|
|---|
| 195 | extern int vfs_fd_assign(vfs_file_t *, int);
|
|---|
| 196 | extern int vfs_fd_alloc(bool desc);
|
|---|
| 197 | extern int vfs_fd_free(int);
|
|---|
| 198 |
|
|---|
| 199 | extern void vfs_node_addref(vfs_node_t *);
|
|---|
| 200 | extern void vfs_node_delref(vfs_node_t *);
|
|---|
| 201 | extern int vfs_open_node_remote(vfs_node_t *);
|
|---|
| 202 |
|
|---|
| 203 | extern void vfs_register(ipc_callid_t, ipc_call_t *);
|
|---|
| 204 | extern void vfs_mount(ipc_callid_t, ipc_call_t *);
|
|---|
| 205 | extern void vfs_unmount(ipc_callid_t, ipc_call_t *);
|
|---|
| 206 | extern void vfs_open(ipc_callid_t, ipc_call_t *);
|
|---|
| 207 | extern void vfs_sync(ipc_callid_t, ipc_call_t *);
|
|---|
| 208 | extern void vfs_dup(ipc_callid_t, ipc_call_t *);
|
|---|
| 209 | extern void vfs_close(ipc_callid_t, ipc_call_t *);
|
|---|
| 210 | extern void vfs_read(ipc_callid_t, ipc_call_t *);
|
|---|
| 211 | extern void vfs_write(ipc_callid_t, ipc_call_t *);
|
|---|
| 212 | extern void vfs_seek(ipc_callid_t, ipc_call_t *);
|
|---|
| 213 | extern void vfs_truncate(ipc_callid_t, ipc_call_t *);
|
|---|
| 214 | extern void vfs_fstat(ipc_callid_t, ipc_call_t *);
|
|---|
| 215 | extern void vfs_stat(ipc_callid_t, ipc_call_t *);
|
|---|
| 216 | extern void vfs_mkdir(ipc_callid_t, ipc_call_t *);
|
|---|
| 217 | extern void vfs_unlink(ipc_callid_t, ipc_call_t *);
|
|---|
| 218 | extern void vfs_rename(ipc_callid_t, ipc_call_t *);
|
|---|
| 219 | extern void vfs_wait_handle(ipc_callid_t, ipc_call_t *);
|
|---|
| 220 |
|
|---|
| 221 | #endif
|
|---|
| 222 |
|
|---|
| 223 | /**
|
|---|
| 224 | * @}
|
|---|
| 225 | */
|
|---|
