Rev 4389 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 4389 | Rev 4691 | ||
---|---|---|---|
Line 26... | Line 26... | ||
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | /** @addtogroup fs |
29 | /** @addtogroup fs |
30 | * @{ |
30 | * @{ |
31 | */ |
31 | */ |
32 | 32 | ||
33 | #ifndef VFS_VFS_H_ |
33 | #ifndef VFS_VFS_H_ |
34 | #define VFS_VFS_H_ |
34 | #define VFS_VFS_H_ |
35 | 35 | ||
36 | #include <ipc/ipc.h> |
36 | #include <ipc/ipc.h> |
37 | #include <libadt/list.h> |
37 | #include <adt/list.h> |
38 | #include <futex.h> |
- | |
39 | #include <rwlock.h> |
38 | #include <fibril_sync.h> |
40 | #include <sys/types.h> |
39 | #include <sys/types.h> |
- | 40 | #include <devmap.h> |
|
41 | #include <bool.h> |
41 | #include <bool.h> |
- | 42 | #include <ipc/vfs.h> |
|
42 | 43 | ||
43 | // FIXME: according to CONFIG_DEBUG |
44 | // FIXME: according to CONFIG_DEBUG |
44 | // #define dprintf(...) printf(__VA_ARGS__) |
45 | // #define dprintf(...) printf(__VA_ARGS__) |
45 | 46 | ||
46 | #define dprintf(...) |
47 | #define dprintf(...) |
47 | 48 | ||
48 | #define VFS_FIRST IPC_FIRST_USER_METHOD |
- | |
49 | - | ||
50 | /* Basic types. */ |
- | |
51 | typedef int16_t fs_handle_t; |
- | |
52 | typedef int16_t dev_handle_t; |
- | |
53 | typedef uint32_t fs_index_t; |
- | |
54 | - | ||
55 | typedef enum { |
- | |
56 | VFS_READ = VFS_FIRST, |
- | |
57 | VFS_WRITE, |
- | |
58 | VFS_TRUNCATE, |
- | |
59 | VFS_MOUNT, |
- | |
60 | VFS_UNMOUNT, |
- | |
61 | VFS_LAST_CMN, /* keep this the last member of this enum */ |
- | |
62 | } vfs_request_cmn_t; |
- | |
63 | - | ||
64 | typedef enum { |
- | |
65 | VFS_LOOKUP = VFS_LAST_CMN, |
- | |
66 | VFS_MOUNTED, |
- | |
67 | VFS_DESTROY, |
- | |
68 | VFS_LAST_CLNT, /* keep this the last member of this enum */ |
- | |
69 | } vfs_request_clnt_t; |
- | |
70 | - | ||
71 | typedef enum { |
- | |
72 | VFS_REGISTER = VFS_LAST_CMN, |
- | |
73 | VFS_OPEN, |
- | |
74 | VFS_CLOSE, |
- | |
75 | VFS_SEEK, |
- | |
76 | VFS_MKDIR, |
- | |
77 | VFS_UNLINK, |
- | |
78 | VFS_RENAME, |
- | |
79 | VFS_LAST_SRV, /* keep this the last member of this enum */ |
- | |
80 | } vfs_request_srv_t; |
- | |
81 | - | ||
82 | #define FS_NAME_MAXLEN 20 |
- | |
83 | - | ||
84 | /** |
- | |
85 | * A structure like this is passed to VFS by each individual FS upon its |
- | |
86 | * registration. It assosiates a human-readable identifier with each |
- | |
87 | * registered FS. |
- | |
88 | */ |
- | |
89 | typedef struct { |
- | |
90 | /** Unique identifier of the fs. */ |
- | |
91 | char name[FS_NAME_MAXLEN + 1]; |
- | |
92 | } vfs_info_t; |
- | |
93 | - | ||
94 | /** |
49 | /** |
95 | * A structure like this will be allocated for each registered file system. |
50 | * A structure like this will be allocated for each registered file system. |
96 | */ |
51 | */ |
97 | typedef struct { |
52 | typedef struct { |
98 | link_t fs_link; |
53 | link_t fs_link; |
99 | vfs_info_t vfs_info; |
54 | vfs_info_t vfs_info; |
100 | fs_handle_t fs_handle; |
55 | fs_handle_t fs_handle; |
101 | futex_t phone_futex; /**< Phone serializing futex. */ |
56 | fibril_mutex_t phone_lock; |
102 | ipcarg_t phone; |
57 | ipcarg_t phone; |
103 | } fs_info_t; |
58 | } fs_info_t; |
104 | 59 | ||
105 | /** |
60 | /** |
106 | * VFS_PAIR uniquely represents a file system instance. |
61 | * VFS_PAIR uniquely represents a file system instance. |
107 | */ |
62 | */ |
108 | #define VFS_PAIR \ |
63 | #define VFS_PAIR \ |
109 | fs_handle_t fs_handle; \ |
64 | fs_handle_t fs_handle; \ |
110 | dev_handle_t dev_handle; |
65 | dev_handle_t dev_handle; |
111 | 66 | ||
112 | /** |
67 | /** |
113 | * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but |
68 | * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but |
114 | * doesn't contain any state. For a stateful structure, see vfs_node_t. |
69 | * doesn't contain any state. For a stateful structure, see vfs_node_t. |
115 | * |
70 | * |
116 | * @note fs_handle, dev_handle and index are meant to be returned in one |
71 | * @note fs_handle, dev_handle and index are meant to be returned in one |
117 | * IPC reply. |
72 | * IPC reply. |
118 | */ |
73 | */ |
119 | #define VFS_TRIPLET \ |
74 | #define VFS_TRIPLET \ |
120 | VFS_PAIR; \ |
75 | VFS_PAIR; \ |
121 | fs_index_t index; |
76 | fs_index_t index; |
122 | 77 | ||
123 | typedef struct { |
78 | typedef struct { |
124 | VFS_PAIR; |
79 | VFS_PAIR; |
125 | } vfs_pair_t; |
80 | } vfs_pair_t; |
126 | 81 | ||
127 | typedef struct { |
82 | typedef struct { |
128 | VFS_TRIPLET; |
83 | VFS_TRIPLET; |
129 | } vfs_triplet_t; |
84 | } vfs_triplet_t; |
130 | 85 | ||
131 | /* |
- | |
132 | * Lookup flags. |
- | |
133 | */ |
- | |
134 | /** |
- | |
135 | * No lookup flags used. |
- | |
136 | */ |
- | |
137 | #define L_NONE 0 |
- | |
138 | /** |
- | |
139 | * Lookup will succeed only if the object is a regular file. If L_CREATE is |
- | |
140 | * specified, an empty file will be created. This flag is mutually exclusive |
- | |
141 | * with L_DIRECTORY. |
- | |
142 | */ |
- | |
143 | #define L_FILE 1 |
- | |
144 | /** |
- | |
145 | * Lookup wil succeed only if the object is a directory. If L_CREATE is |
- | |
146 | * specified, an empty directory will be created. This flag is mutually |
- | |
147 | * exclusive with L_FILE. |
- | |
148 | */ |
- | |
149 | #define L_DIRECTORY 2 |
- | |
150 | /** |
- | |
151 | * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the |
- | |
152 | * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used. |
- | |
153 | */ |
- | |
154 | #define L_EXCLUSIVE 4 |
- | |
155 | /** |
- | |
156 | * L_CREATE is used for creating both regular files and directories. |
- | |
157 | */ |
- | |
158 | #define L_CREATE 8 |
- | |
159 | /** |
- | |
160 | * L_LINK is used for linking to an already existing nodes. |
- | |
161 | */ |
- | |
162 | #define L_LINK 16 |
- | |
163 | /** |
- | |
164 | * L_UNLINK is used to remove leaves from the file system namespace. This flag |
- | |
165 | * cannot be passed directly by the client, but will be set by VFS during |
- | |
166 | * VFS_UNLINK. |
- | |
167 | */ |
- | |
168 | #define L_UNLINK 32 |
- | |
169 | - | ||
170 | typedef enum vfs_node_type { |
86 | typedef enum vfs_node_type { |
171 | VFS_NODE_UNKNOWN, |
87 | VFS_NODE_UNKNOWN, |
172 | VFS_NODE_FILE, |
88 | VFS_NODE_FILE, |
173 | VFS_NODE_DIRECTORY, |
89 | VFS_NODE_DIRECTORY, |
174 | } vfs_node_type_t; |
90 | } vfs_node_type_t; |
Line 203... | Line 119... | ||
203 | size_t size; /**< Cached size if the node is a file. */ |
119 | size_t size; /**< Cached size if the node is a file. */ |
204 | 120 | ||
205 | /** |
121 | /** |
206 | * Holding this rwlock prevents modifications of the node's contents. |
122 | * Holding this rwlock prevents modifications of the node's contents. |
207 | */ |
123 | */ |
208 | rwlock_t contents_rwlock; |
124 | fibril_rwlock_t contents_rwlock; |
209 | } vfs_node_t; |
125 | } vfs_node_t; |
210 | 126 | ||
211 | /** |
127 | /** |
212 | * Instances of this type represent an open file. If the file is opened by more |
128 | * Instances of this type represent an open file. If the file is opened by more |
213 | * than one task, there will be a separate structure allocated for each task. |
129 | * than one task, there will be a separate structure allocated for each task. |
214 | */ |
130 | */ |
215 | typedef struct { |
131 | typedef struct { |
216 | /** Serializes access to this open file. */ |
132 | /** Serializes access to this open file. */ |
217 | futex_t lock; |
133 | fibril_mutex_t lock; |
218 | 134 | ||
219 | vfs_node_t *node; |
135 | vfs_node_t *node; |
220 | 136 | ||
221 | /** Number of file handles referencing this file. */ |
137 | /** Number of file handles referencing this file. */ |
222 | unsigned refcnt; |
138 | unsigned refcnt; |
Line 226... | Line 142... | ||
226 | 142 | ||
227 | /** Current position in the file. */ |
143 | /** Current position in the file. */ |
228 | off_t pos; |
144 | off_t pos; |
229 | } vfs_file_t; |
145 | } vfs_file_t; |
230 | 146 | ||
231 | extern futex_t nodes_futex; |
147 | extern fibril_mutex_t nodes_mutex; |
232 | 148 | ||
- | 149 | extern fibril_condvar_t fs_head_cv; |
|
- | 150 | extern fibril_mutex_t fs_head_lock; |
|
233 | extern link_t fs_head; /**< List of registered file systems. */ |
151 | extern link_t fs_head; /**< List of registered file systems. */ |
234 | 152 | ||
235 | extern vfs_pair_t rootfs; /**< Root file system. */ |
153 | extern vfs_pair_t rootfs; /**< Root file system. */ |
236 | 154 | ||
237 | #define MAX_PATH_LEN (64 * 1024) |
- | |
238 | - | ||
239 | #define PLB_SIZE (2 * MAX_PATH_LEN) |
- | |
240 | - | ||
241 | /** Each instance of this type describes one path lookup in progress. */ |
155 | /** Each instance of this type describes one path lookup in progress. */ |
242 | typedef struct { |
156 | typedef struct { |
243 | link_t plb_link; /**< Active PLB entries list link. */ |
157 | link_t plb_link; /**< Active PLB entries list link. */ |
244 | unsigned index; /**< Index of the first character in PLB. */ |
158 | unsigned index; /**< Index of the first character in PLB. */ |
245 | size_t len; /**< Number of characters in this PLB entry. */ |
159 | size_t len; /**< Number of characters in this PLB entry. */ |
246 | } plb_entry_t; |
160 | } plb_entry_t; |
247 | 161 | ||
248 | extern futex_t plb_futex; /**< Futex protecting plb and plb_head. */ |
162 | extern fibril_mutex_t plb_mutex;/**< Mutex protecting plb and plb_head. */ |
249 | extern uint8_t *plb; /**< Path Lookup Buffer */ |
163 | extern uint8_t *plb; /**< Path Lookup Buffer */ |
250 | extern link_t plb_head; /**< List of active PLB entries. */ |
164 | extern link_t plb_head; /**< List of active PLB entries. */ |
251 | 165 | ||
252 | #define MAX_MNTOPTS_LEN 256 |
166 | #define MAX_MNTOPTS_LEN 256 |
253 | 167 | ||
254 | /** Holding this rwlock prevents changes in file system namespace. */ |
168 | /** Holding this rwlock prevents changes in file system namespace. */ |
255 | extern rwlock_t namespace_rwlock; |
169 | extern fibril_rwlock_t namespace_rwlock; |
256 | 170 | ||
257 | extern int vfs_grab_phone(fs_handle_t); |
171 | extern int vfs_grab_phone(fs_handle_t); |
258 | extern void vfs_release_phone(int); |
172 | extern void vfs_release_phone(int); |
259 | 173 | ||
260 | extern fs_handle_t fs_name_to_handle(char *, bool); |
174 | extern fs_handle_t fs_name_to_handle(char *, bool); |
261 | 175 | ||
262 | extern int vfs_lookup_internal(char *, int, vfs_lookup_res_t *, vfs_pair_t *, |
176 | extern int vfs_lookup_internal(char *, int, vfs_lookup_res_t *, |
263 | ...); |
177 | vfs_pair_t *, ...); |
- | 178 | extern int vfs_open_node_internal(vfs_lookup_res_t *); |
|
264 | 179 | ||
265 | extern bool vfs_nodes_init(void); |
180 | extern bool vfs_nodes_init(void); |
266 | extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *); |
181 | extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *); |
267 | extern void vfs_node_put(vfs_node_t *); |
182 | extern void vfs_node_put(vfs_node_t *); |
268 | 183 | ||
Line 277... | Line 192... | ||
277 | extern void vfs_file_delref(vfs_file_t *); |
192 | extern void vfs_file_delref(vfs_file_t *); |
278 | 193 | ||
279 | extern void vfs_node_addref(vfs_node_t *); |
194 | extern void vfs_node_addref(vfs_node_t *); |
280 | extern void vfs_node_delref(vfs_node_t *); |
195 | extern void vfs_node_delref(vfs_node_t *); |
281 | 196 | ||
282 | extern void vfs_process_pending_mount(void); |
- | |
283 | extern void vfs_register(ipc_callid_t, ipc_call_t *); |
197 | extern void vfs_register(ipc_callid_t, ipc_call_t *); |
284 | extern void vfs_mount(ipc_callid_t, ipc_call_t *); |
198 | extern void vfs_mount(ipc_callid_t, ipc_call_t *); |
285 | extern void vfs_open(ipc_callid_t, ipc_call_t *); |
199 | extern void vfs_open(ipc_callid_t, ipc_call_t *); |
- | 200 | extern void vfs_open_node(ipc_callid_t, ipc_call_t *); |
|
- | 201 | extern void vfs_sync(ipc_callid_t, ipc_call_t *); |
|
286 | extern void vfs_close(ipc_callid_t, ipc_call_t *); |
202 | extern void vfs_close(ipc_callid_t, ipc_call_t *); |
287 | extern void vfs_read(ipc_callid_t, ipc_call_t *); |
203 | extern void vfs_read(ipc_callid_t, ipc_call_t *); |
288 | extern void vfs_write(ipc_callid_t, ipc_call_t *); |
204 | extern void vfs_write(ipc_callid_t, ipc_call_t *); |
289 | extern void vfs_seek(ipc_callid_t, ipc_call_t *); |
205 | extern void vfs_seek(ipc_callid_t, ipc_call_t *); |
290 | extern void vfs_truncate(ipc_callid_t, ipc_call_t *); |
206 | extern void vfs_truncate(ipc_callid_t, ipc_call_t *); |
- | 207 | extern void vfs_fstat(ipc_callid_t, ipc_call_t *); |
|
- | 208 | extern void vfs_fstat(ipc_callid_t, ipc_call_t *); |
|
- | 209 | extern void vfs_stat(ipc_callid_t, ipc_call_t *); |
|
291 | extern void vfs_mkdir(ipc_callid_t, ipc_call_t *); |
210 | extern void vfs_mkdir(ipc_callid_t, ipc_call_t *); |
292 | extern void vfs_unlink(ipc_callid_t, ipc_call_t *); |
211 | extern void vfs_unlink(ipc_callid_t, ipc_call_t *); |
293 | extern void vfs_rename(ipc_callid_t, ipc_call_t *); |
212 | extern void vfs_rename(ipc_callid_t, ipc_call_t *); |
294 | 213 | ||
295 | #endif |
214 | #endif |