Rev 2535 | Rev 2542 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
| Rev 2535 | Rev 2540 | ||
|---|---|---|---|
| 1 | /* |
1 | /* |
| 2 | * Copyright (c) 2007 Jakub Jermar |
2 | * Copyright (c) 2007 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> |
|
| - | 39 | #include <types.h> |
|
| 38 | 40 | ||
| 39 | #define dprintf(...) printf(__VA_ARGS__) |
41 | #define dprintf(...) printf(__VA_ARGS__) |
| 40 | 42 | ||
| 41 | #define VFS_FIRST FIRST_USER_METHOD |
43 | #define VFS_FIRST FIRST_USER_METHOD |
| 42 | 44 | ||
| 43 | #define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST) |
45 | #define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST) |
| 44 | 46 | ||
| - | 47 | typedef int64_t off_t; |
|
| - | 48 | ||
| 45 | typedef enum { |
49 | typedef enum { |
| 46 | VFS_REGISTER = VFS_FIRST, |
50 | VFS_REGISTER = VFS_FIRST, |
| 47 | VFS_MOUNT, |
51 | VFS_MOUNT, |
| 48 | VFS_UNMOUNT, |
52 | VFS_UNMOUNT, |
| 49 | VFS_LOOKUP, |
53 | VFS_LOOKUP, |
| 50 | VFS_OPEN, |
54 | VFS_OPEN, |
| 51 | VFS_CREATE, |
55 | VFS_CREATE, |
| 52 | VFS_CLOSE, |
56 | VFS_CLOSE, |
| 53 | VFS_READ, |
57 | VFS_READ, |
| 54 | VFS_WRITE, |
58 | VFS_WRITE, |
| 55 | VFS_SEEK, |
59 | VFS_SEEK, |
| 56 | VFS_LAST, /* keep this the last member of the enum */ |
60 | VFS_LAST, /* keep this the last member of the enum */ |
| 57 | } vfs_request_t; |
61 | } vfs_request_t; |
| 58 | 62 | ||
| 59 | 63 | ||
| 60 | /** |
64 | /** |
| 61 | * An instance of this structure is associated with a particular FS operation. |
65 | * An instance of this structure is associated with a particular FS operation. |
| 62 | * It tells VFS if the FS supports the operation or maybe if a default one |
66 | * It tells VFS if the FS supports the operation or maybe if a default one |
| 63 | * should be used. |
67 | * should be used. |
| 64 | */ |
68 | */ |
| 65 | typedef enum { |
69 | typedef enum { |
| 66 | VFS_OP_NULL = 0, |
70 | VFS_OP_NULL = 0, |
| 67 | VFS_OP_DEFAULT, |
71 | VFS_OP_DEFAULT, |
| 68 | VFS_OP_DEFINED |
72 | VFS_OP_DEFINED |
| 69 | } vfs_op_t; |
73 | } vfs_op_t; |
| 70 | 74 | ||
| 71 | #define FS_NAME_MAXLEN 20 |
75 | #define FS_NAME_MAXLEN 20 |
| 72 | 76 | ||
| 73 | /** |
77 | /** |
| 74 | * A structure like this is passed to VFS by each individual FS upon its |
78 | * A structure like this is passed to VFS by each individual FS upon its |
| 75 | * registration. It assosiates a human-readable identifier with each |
79 | * registration. It assosiates a human-readable identifier with each |
| 76 | * registered FS. More importantly, through this structure, the FS announces |
80 | * registered FS. More importantly, through this structure, the FS announces |
| 77 | * what operations it supports. |
81 | * what operations it supports. |
| 78 | */ |
82 | */ |
| 79 | typedef struct { |
83 | typedef struct { |
| 80 | /** Unique identifier of the fs. */ |
84 | /** Unique identifier of the fs. */ |
| 81 | char name[FS_NAME_MAXLEN]; |
85 | char name[FS_NAME_MAXLEN]; |
| 82 | 86 | ||
| 83 | /** Operations. */ |
87 | /** Operations. */ |
| 84 | vfs_op_t ops[VFS_LAST - VFS_FIRST]; |
88 | vfs_op_t ops[VFS_LAST - VFS_FIRST]; |
| 85 | } vfs_info_t; |
89 | } vfs_info_t; |
| 86 | 90 | ||
| - | 91 | /** |
|
| - | 92 | * A structure like this will be allocated for each registered file system. |
|
| - | 93 | */ |
|
| 87 | typedef struct { |
94 | typedef struct { |
| 88 | link_t fs_link; |
95 | link_t fs_link; |
| 89 | vfs_info_t vfs_info; |
96 | vfs_info_t vfs_info; |
| 90 | ipcarg_t phone; |
97 | ipcarg_t phone; |
| 91 | } fs_info_t; |
98 | } fs_info_t; |
| 92 | 99 | ||
| - | 100 | /** |
|
| - | 101 | * Instances of this type represent a file system node (e.g. directory, file). |
|
| - | 102 | * They are abstracted away from any file system implementation and contain just |
|
| - | 103 | * enough bits to uniquely identify the object in its file system instance. |
|
| - | 104 | * |
|
| - | 105 | * @note fs_handle, dev_handle and index are meant to be returned in one |
|
| - | 106 | * IPC reply. |
|
| - | 107 | */ |
|
| - | 108 | typedef struct { |
|
| - | 109 | int fs_handle; /**< Global file system ID. */ |
|
| - | 110 | int dev_handle; /**< Global mount device devno. */ |
|
| - | 111 | uint64_t index; /**< Index of the node on its file system. */ |
|
| - | 112 | } vfs_node_t; |
|
| - | 113 | ||
| - | 114 | /** |
|
| - | 115 | * Instances of this type represent an open file. If the file is opened by more |
|
| - | 116 | * than one task, there will be a separate structure allocated for each task. |
|
| - | 117 | */ |
|
| - | 118 | typedef struct { |
|
| - | 119 | vfs_node_t *node; |
|
| - | 120 | ||
| - | 121 | /** Number of file handles referencing this file. */ |
|
| - | 122 | atomic_t refcnt; |
|
| - | 123 | ||
| - | 124 | /** Current position in the file. */ |
|
| - | 125 | off_t pos; |
|
| - | 126 | } vfs_file_t; |
|
| - | 127 | ||
| 93 | extern link_t fs_head; |
128 | extern link_t fs_head; |
| 94 | 129 | ||
| 95 | extern void vfs_register(ipc_callid_t rid, ipc_call_t *request); |
130 | extern void vfs_register(ipc_callid_t rid, ipc_call_t *request); |
| 96 | 131 | ||
| 97 | #endif |
132 | #endif |
| 98 | 133 | ||
| 99 | /** |
134 | /** |
| 100 | * @} |
135 | * @} |
| 101 | */ |
136 | */ |
| 102 | 137 | ||