Rev 2735 | Rev 2752 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 2735 | Rev 2742 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (c) 2008 Jakub Jermar |
2 | * Copyright (c) 2008 Jakub Jermar |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
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 |
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. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
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 |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
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 |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
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 |
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. |
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 <libadt/list.h> |
38 | #include <atomic.h> |
38 | #include <atomic.h> |
39 | #include <rwlock.h> |
39 | #include <rwlock.h> |
40 | #include <sys/types.h> |
40 | #include <sys/types.h> |
41 | #include <bool.h> |
41 | #include <bool.h> |
42 | 42 | ||
43 | #define dprintf(...) printf(__VA_ARGS__) |
43 | #define dprintf(...) printf(__VA_ARGS__) |
44 | 44 | ||
45 | #define VFS_FIRST IPC_FIRST_USER_METHOD |
45 | #define VFS_FIRST IPC_FIRST_USER_METHOD |
46 | 46 | ||
47 | #define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST) |
47 | #define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST) |
48 | 48 | ||
49 | typedef enum { |
49 | typedef enum { |
50 | VFS_READ = VFS_FIRST, |
50 | VFS_READ = VFS_FIRST, |
51 | VFS_WRITE, |
51 | VFS_WRITE, |
52 | VFS_TRUNCATE, |
52 | VFS_TRUNCATE, |
53 | VFS_MOUNT, |
53 | VFS_MOUNT, |
54 | VFS_UNMOUNT, |
54 | VFS_UNMOUNT, |
55 | VFS_LAST_CMN, /* keep this the last member of this enum */ |
55 | VFS_LAST_CMN, /* keep this the last member of this enum */ |
56 | } vfs_request_cmn_t; |
56 | } vfs_request_cmn_t; |
57 | 57 | ||
58 | typedef enum { |
58 | typedef enum { |
59 | VFS_LOOKUP = VFS_LAST_CMN, |
59 | VFS_LOOKUP = VFS_LAST_CMN, |
60 | VFS_FREE, |
60 | VFS_DESTROY, |
61 | VFS_LAST_CLNT, /* keep this the last member of this enum */ |
61 | VFS_LAST_CLNT, /* keep this the last member of this enum */ |
62 | } vfs_request_clnt_t; |
62 | } vfs_request_clnt_t; |
63 | 63 | ||
64 | typedef enum { |
64 | typedef enum { |
65 | VFS_REGISTER = VFS_LAST_CMN, |
65 | VFS_REGISTER = VFS_LAST_CMN, |
66 | VFS_OPEN, |
66 | VFS_OPEN, |
67 | VFS_CLOSE, |
67 | VFS_CLOSE, |
68 | VFS_SEEK, |
68 | VFS_SEEK, |
69 | VFS_MKDIR, |
69 | VFS_MKDIR, |
70 | VFS_UNLINK, |
70 | VFS_UNLINK, |
71 | VFS_RENAME, |
71 | VFS_RENAME, |
72 | VFS_LAST_SRV, /* keep this the last member of this enum */ |
72 | VFS_LAST_SRV, /* keep this the last member of this enum */ |
73 | } vfs_request_srv_t; |
73 | } vfs_request_srv_t; |
74 | 74 | ||
75 | 75 | ||
76 | /** |
76 | /** |
77 | * An instance of this structure is associated with a particular FS operation. |
77 | * An instance of this structure is associated with a particular FS operation. |
78 | * It tells VFS if the FS supports the operation or maybe if a default one |
78 | * It tells VFS if the FS supports the operation or maybe if a default one |
79 | * should be used. |
79 | * should be used. |
80 | */ |
80 | */ |
81 | typedef enum { |
81 | typedef enum { |
82 | VFS_OP_NULL = 0, |
82 | VFS_OP_NULL = 0, |
83 | VFS_OP_DEFAULT, |
83 | VFS_OP_DEFAULT, |
84 | VFS_OP_DEFINED |
84 | VFS_OP_DEFINED |
85 | } vfs_op_t; |
85 | } vfs_op_t; |
86 | 86 | ||
87 | #define FS_NAME_MAXLEN 20 |
87 | #define FS_NAME_MAXLEN 20 |
88 | 88 | ||
89 | /** |
89 | /** |
90 | * A structure like this is passed to VFS by each individual FS upon its |
90 | * A structure like this is passed to VFS by each individual FS upon its |
91 | * registration. It assosiates a human-readable identifier with each |
91 | * registration. It assosiates a human-readable identifier with each |
92 | * registered FS. More importantly, through this structure, the FS announces |
92 | * registered FS. More importantly, through this structure, the FS announces |
93 | * what operations it supports. |
93 | * what operations it supports. |
94 | */ |
94 | */ |
95 | typedef struct { |
95 | typedef struct { |
96 | /** Unique identifier of the fs. */ |
96 | /** Unique identifier of the fs. */ |
97 | char name[FS_NAME_MAXLEN + 1]; |
97 | char name[FS_NAME_MAXLEN + 1]; |
98 | 98 | ||
99 | /** Operations. */ |
99 | /** Operations. */ |
100 | vfs_op_t ops[VFS_LAST_CLNT - VFS_FIRST]; |
100 | vfs_op_t ops[VFS_LAST_CLNT - VFS_FIRST]; |
101 | } vfs_info_t; |
101 | } vfs_info_t; |
102 | 102 | ||
103 | /** |
103 | /** |
104 | * A structure like this will be allocated for each registered file system. |
104 | * A structure like this will be allocated for each registered file system. |
105 | */ |
105 | */ |
106 | typedef struct { |
106 | typedef struct { |
107 | link_t fs_link; |
107 | link_t fs_link; |
108 | vfs_info_t vfs_info; |
108 | vfs_info_t vfs_info; |
109 | int fs_handle; |
109 | int fs_handle; |
110 | atomic_t phone_futex; /**< Phone serializing futex. */ |
110 | atomic_t phone_futex; /**< Phone serializing futex. */ |
111 | ipcarg_t phone; |
111 | ipcarg_t phone; |
112 | } fs_info_t; |
112 | } fs_info_t; |
113 | 113 | ||
114 | /** |
114 | /** |
115 | * VFS_PAIR uniquely represents a file system instance. |
115 | * VFS_PAIR uniquely represents a file system instance. |
116 | */ |
116 | */ |
117 | #define VFS_PAIR \ |
117 | #define VFS_PAIR \ |
118 | int fs_handle; \ |
118 | int fs_handle; \ |
119 | int dev_handle; |
119 | int dev_handle; |
120 | 120 | ||
121 | /** |
121 | /** |
122 | * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but |
122 | * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but |
123 | * doesn't contain any state. For a stateful structure, see vfs_node_t. |
123 | * doesn't contain any state. For a stateful structure, see vfs_node_t. |
124 | * |
124 | * |
125 | * @note fs_handle, dev_handle and index are meant to be returned in one |
125 | * @note fs_handle, dev_handle and index are meant to be returned in one |
126 | * IPC reply. |
126 | * IPC reply. |
127 | */ |
127 | */ |
128 | #define VFS_TRIPLET \ |
128 | #define VFS_TRIPLET \ |
129 | VFS_PAIR; \ |
129 | VFS_PAIR; \ |
130 | uint64_t index; |
130 | uint64_t index; |
131 | 131 | ||
132 | typedef struct { |
132 | typedef struct { |
133 | VFS_PAIR; |
133 | VFS_PAIR; |
134 | } vfs_pair_t; |
134 | } vfs_pair_t; |
135 | 135 | ||
136 | typedef struct { |
136 | typedef struct { |
137 | VFS_TRIPLET; |
137 | VFS_TRIPLET; |
138 | } vfs_triplet_t; |
138 | } vfs_triplet_t; |
139 | 139 | ||
140 | /* |
140 | /* |
141 | * Lookup flags. |
141 | * Lookup flags. |
142 | */ |
142 | */ |
143 | /** |
143 | /** |
144 | * No lookup flags used. |
144 | * No lookup flags used. |
145 | */ |
145 | */ |
146 | #define L_NONE 0 |
146 | #define L_NONE 0 |
147 | /** |
147 | /** |
148 | * Lookup will succeed only if the object is a regular file. If L_CREATE is |
148 | * Lookup will succeed only if the object is a regular file. If L_CREATE is |
149 | * specified, an empty file will be created. This flag is mutually exclusive |
149 | * specified, an empty file will be created. This flag is mutually exclusive |
150 | * with L_DIRECTORY. |
150 | * with L_DIRECTORY. |
151 | */ |
151 | */ |
152 | #define L_FILE 1 |
152 | #define L_FILE 1 |
153 | /** |
153 | /** |
154 | * Lookup wil succeed only if the object is a directory. If L_CREATE is |
154 | * Lookup wil succeed only if the object is a directory. If L_CREATE is |
155 | * specified, an empty directory will be created. This flag is mutually |
155 | * specified, an empty directory will be created. This flag is mutually |
156 | * exclusive with L_FILE. |
156 | * exclusive with L_FILE. |
157 | */ |
157 | */ |
158 | #define L_DIRECTORY 2 |
158 | #define L_DIRECTORY 2 |
159 | /** |
159 | /** |
160 | * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the |
160 | * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the |
161 | * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used. |
161 | * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used. |
162 | */ |
162 | */ |
163 | #define L_EXCLUSIVE 4 |
163 | #define L_EXCLUSIVE 4 |
164 | /** |
164 | /** |
165 | * L_CREATE is used for creating both regular files and directories. |
165 | * L_CREATE is used for creating both regular files and directories. |
166 | */ |
166 | */ |
167 | #define L_CREATE 8 |
167 | #define L_CREATE 8 |
168 | /** |
168 | /** |
169 | * L_DESTROY is used to remove leaves from the file system namespace. This flag |
169 | * L_DESTROY is used to remove leaves from the file system namespace. This flag |
170 | * cannot be passed directly by the client, but will be set by VFS during |
170 | * cannot be passed directly by the client, but will be set by VFS during |
171 | * VFS_UNLINK. |
171 | * VFS_UNLINK. |
172 | */ |
172 | */ |
173 | #define L_DESTROY 16 |
173 | #define L_DESTROY 16 |
174 | 174 | ||
175 | typedef struct { |
175 | typedef struct { |
176 | vfs_triplet_t triplet; |
176 | vfs_triplet_t triplet; |
177 | size_t size; |
177 | size_t size; |
178 | unsigned lnkcnt; |
178 | unsigned lnkcnt; |
179 | } vfs_lookup_res_t; |
179 | } vfs_lookup_res_t; |
180 | 180 | ||
181 | /** |
181 | /** |
182 | * Instances of this type represent an active, in-memory VFS node and any state |
182 | * Instances of this type represent an active, in-memory VFS node and any state |
183 | * which may be associated with it. |
183 | * which may be associated with it. |
184 | */ |
184 | */ |
185 | typedef struct { |
185 | typedef struct { |
186 | VFS_TRIPLET; /**< Identity of the node. */ |
186 | VFS_TRIPLET; /**< Identity of the node. */ |
187 | 187 | ||
188 | /** |
188 | /** |
189 | * Usage counter. This includes, but is not limited to, all vfs_file_t |
189 | * Usage counter. This includes, but is not limited to, all vfs_file_t |
190 | * structures that reference this node. |
190 | * structures that reference this node. |
191 | */ |
191 | */ |
192 | unsigned refcnt; |
192 | unsigned refcnt; |
193 | 193 | ||
194 | /** Number of names this node has in the file system namespace. */ |
194 | /** Number of names this node has in the file system namespace. */ |
195 | unsigned lnkcnt; |
195 | unsigned lnkcnt; |
196 | 196 | ||
197 | link_t nh_link; /**< Node hash-table link. */ |
197 | link_t nh_link; /**< Node hash-table link. */ |
198 | size_t size; /**< Cached size of the file. */ |
198 | size_t size; /**< Cached size of the file. */ |
199 | 199 | ||
200 | /** |
200 | /** |
201 | * Holding this rwlock prevents modifications of the node's contents. |
201 | * Holding this rwlock prevents modifications of the node's contents. |
202 | */ |
202 | */ |
203 | rwlock_t contents_rwlock; |
203 | rwlock_t contents_rwlock; |
204 | } vfs_node_t; |
204 | } vfs_node_t; |
205 | 205 | ||
206 | /** |
206 | /** |
207 | * Instances of this type represent an open file. If the file is opened by more |
207 | * Instances of this type represent an open file. If the file is opened by more |
208 | * than one task, there will be a separate structure allocated for each task. |
208 | * than one task, there will be a separate structure allocated for each task. |
209 | */ |
209 | */ |
210 | typedef struct { |
210 | typedef struct { |
211 | /** Serializes access to this open file. */ |
211 | /** Serializes access to this open file. */ |
212 | futex_t lock; |
212 | futex_t lock; |
213 | 213 | ||
214 | vfs_node_t *node; |
214 | vfs_node_t *node; |
215 | 215 | ||
216 | /** Number of file handles referencing this file. */ |
216 | /** Number of file handles referencing this file. */ |
217 | unsigned refcnt; |
217 | unsigned refcnt; |
218 | 218 | ||
219 | /** Append on write. */ |
219 | /** Append on write. */ |
220 | bool append; |
220 | bool append; |
221 | 221 | ||
222 | /** Current position in the file. */ |
222 | /** Current position in the file. */ |
223 | off_t pos; |
223 | off_t pos; |
224 | } vfs_file_t; |
224 | } vfs_file_t; |
225 | 225 | ||
226 | extern link_t fs_head; /**< List of registered file systems. */ |
226 | extern link_t fs_head; /**< List of registered file systems. */ |
227 | 227 | ||
228 | extern vfs_triplet_t rootfs; /**< Root node of the root file system. */ |
228 | extern vfs_triplet_t rootfs; /**< Root node of the root file system. */ |
229 | 229 | ||
230 | #define MAX_PATH_LEN (64 * 1024) |
230 | #define MAX_PATH_LEN (64 * 1024) |
231 | 231 | ||
232 | #define PLB_SIZE (2 * MAX_PATH_LEN) |
232 | #define PLB_SIZE (2 * MAX_PATH_LEN) |
233 | 233 | ||
234 | /** Each instance of this type describes one path lookup in progress. */ |
234 | /** Each instance of this type describes one path lookup in progress. */ |
235 | typedef struct { |
235 | typedef struct { |
236 | link_t plb_link; /**< Active PLB entries list link. */ |
236 | link_t plb_link; /**< Active PLB entries list link. */ |
237 | unsigned index; /**< Index of the first character in PLB. */ |
237 | unsigned index; /**< Index of the first character in PLB. */ |
238 | size_t len; /**< Number of characters in this PLB entry. */ |
238 | size_t len; /**< Number of characters in this PLB entry. */ |
239 | } plb_entry_t; |
239 | } plb_entry_t; |
240 | 240 | ||
241 | extern atomic_t plb_futex; /**< Futex protecting plb and plb_head. */ |
241 | extern atomic_t plb_futex; /**< Futex protecting plb and plb_head. */ |
242 | extern uint8_t *plb; /**< Path Lookup Buffer */ |
242 | extern uint8_t *plb; /**< Path Lookup Buffer */ |
243 | extern link_t plb_head; /**< List of active PLB entries. */ |
243 | extern link_t plb_head; /**< List of active PLB entries. */ |
244 | 244 | ||
245 | /** Holding this rwlock prevents changes in file system namespace. */ |
245 | /** Holding this rwlock prevents changes in file system namespace. */ |
246 | extern rwlock_t namespace_rwlock; |
246 | extern rwlock_t namespace_rwlock; |
247 | 247 | ||
248 | extern int vfs_grab_phone(int); |
248 | extern int vfs_grab_phone(int); |
249 | extern void vfs_release_phone(int); |
249 | extern void vfs_release_phone(int); |
250 | 250 | ||
251 | extern int fs_name_to_handle(char *, bool); |
251 | extern int fs_name_to_handle(char *, bool); |
252 | 252 | ||
253 | extern int vfs_lookup_internal(char *, size_t, int, vfs_lookup_res_t *, |
253 | extern int vfs_lookup_internal(char *, size_t, int, vfs_lookup_res_t *, |
254 | vfs_pair_t *); |
254 | vfs_pair_t *); |
255 | 255 | ||
256 | extern bool vfs_nodes_init(void); |
256 | extern bool vfs_nodes_init(void); |
257 | extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *); |
257 | extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *); |
258 | extern void vfs_node_put(vfs_node_t *); |
258 | extern void vfs_node_put(vfs_node_t *); |
259 | 259 | ||
260 | #define MAX_OPEN_FILES 128 |
260 | #define MAX_OPEN_FILES 128 |
261 | 261 | ||
262 | extern bool vfs_files_init(void); |
262 | extern bool vfs_files_init(void); |
263 | extern vfs_file_t *vfs_file_get(int); |
263 | extern vfs_file_t *vfs_file_get(int); |
264 | extern int vfs_fd_alloc(void); |
264 | extern int vfs_fd_alloc(void); |
265 | extern void vfs_fd_free(int); |
265 | extern void vfs_fd_free(int); |
266 | 266 | ||
267 | extern void vfs_file_addref(vfs_file_t *); |
267 | extern void vfs_file_addref(vfs_file_t *); |
268 | extern void vfs_file_delref(vfs_file_t *); |
268 | extern void vfs_file_delref(vfs_file_t *); |
269 | 269 | ||
270 | extern void vfs_node_addref(vfs_node_t *); |
270 | extern void vfs_node_addref(vfs_node_t *); |
271 | extern void vfs_node_delref(vfs_node_t *); |
271 | extern void vfs_node_delref(vfs_node_t *); |
272 | 272 | ||
273 | extern void vfs_register(ipc_callid_t, ipc_call_t *); |
273 | extern void vfs_register(ipc_callid_t, ipc_call_t *); |
274 | extern void vfs_mount(ipc_callid_t, ipc_call_t *); |
274 | extern void vfs_mount(ipc_callid_t, ipc_call_t *); |
275 | extern void vfs_open(ipc_callid_t, ipc_call_t *); |
275 | extern void vfs_open(ipc_callid_t, ipc_call_t *); |
276 | extern void vfs_close(ipc_callid_t, ipc_call_t *); |
276 | extern void vfs_close(ipc_callid_t, ipc_call_t *); |
277 | extern void vfs_read(ipc_callid_t, ipc_call_t *); |
277 | extern void vfs_read(ipc_callid_t, ipc_call_t *); |
278 | extern void vfs_write(ipc_callid_t, ipc_call_t *); |
278 | extern void vfs_write(ipc_callid_t, ipc_call_t *); |
279 | extern void vfs_seek(ipc_callid_t, ipc_call_t *); |
279 | extern void vfs_seek(ipc_callid_t, ipc_call_t *); |
280 | extern void vfs_truncate(ipc_callid_t, ipc_call_t *); |
280 | extern void vfs_truncate(ipc_callid_t, ipc_call_t *); |
281 | extern void vfs_mkdir(ipc_callid_t, ipc_call_t *); |
281 | extern void vfs_mkdir(ipc_callid_t, ipc_call_t *); |
282 | extern void vfs_unlink(ipc_callid_t, ipc_call_t *); |
282 | extern void vfs_unlink(ipc_callid_t, ipc_call_t *); |
283 | 283 | ||
284 | #endif |
284 | #endif |
285 | 285 | ||
286 | /** |
286 | /** |
287 | * @} |
287 | * @} |
288 | */ |
288 | */ |
289 | 289 |