Rev 4581 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
| Rev 4581 | Rev 4718 | ||
|---|---|---|---|
| 1 | /* |
1 | /* |
| 2 | * Copyright (c) 2009 Martin Decky |
2 | * Copyright (c) 2009 Martin Decky |
| 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 libcipc |
29 | /** @addtogroup libcipc |
| 30 | * @{ |
30 | * @{ |
| 31 | */ |
31 | */ |
| 32 | /** @file |
32 | /** @file |
| 33 | */ |
33 | */ |
| 34 | 34 | ||
| 35 | #ifndef LIBC_IPC_VFS_H_ |
35 | #ifndef LIBC_IPC_VFS_H_ |
| 36 | #define LIBC_IPC_VFS_H_ |
36 | #define LIBC_IPC_VFS_H_ |
| 37 | 37 | ||
| 38 | #include <sys/types.h> |
38 | #include <sys/types.h> |
| 39 | #include <ipc/ipc.h> |
39 | #include <ipc/ipc.h> |
| 40 | 40 | ||
| 41 | #define FS_NAME_MAXLEN 20 |
41 | #define FS_NAME_MAXLEN 20 |
| 42 | #define MAX_PATH_LEN (64 * 1024) |
42 | #define MAX_PATH_LEN (64 * 1024) |
| 43 | #define PLB_SIZE (2 * MAX_PATH_LEN) |
43 | #define PLB_SIZE (2 * MAX_PATH_LEN) |
| 44 | 44 | ||
| 45 | /* Basic types. */ |
45 | /* Basic types. */ |
| 46 | typedef int16_t fs_handle_t; |
46 | typedef int16_t fs_handle_t; |
| 47 | typedef uint32_t fs_index_t; |
47 | typedef uint32_t fs_index_t; |
| 48 | 48 | ||
| 49 | /** |
49 | /** |
| 50 | * A structure like this is passed to VFS by each individual FS upon its |
50 | * A structure like this is passed to VFS by each individual FS upon its |
| 51 | * registration. It assosiates a human-readable identifier with each |
51 | * registration. It assosiates a human-readable identifier with each |
| 52 | * registered FS. |
52 | * registered FS. |
| 53 | */ |
53 | */ |
| 54 | typedef struct { |
54 | typedef struct { |
| 55 | /** Unique identifier of the fs. */ |
55 | /** Unique identifier of the fs. */ |
| 56 | char name[FS_NAME_MAXLEN + 1]; |
56 | char name[FS_NAME_MAXLEN + 1]; |
| 57 | } vfs_info_t; |
57 | } vfs_info_t; |
| 58 | 58 | ||
| 59 | typedef enum { |
59 | typedef enum { |
| 60 | VFS_OPEN_NODE = IPC_FIRST_USER_METHOD, |
60 | VFS_IN_OPEN = IPC_FIRST_USER_METHOD, |
| - | 61 | VFS_IN_OPEN_NODE, |
|
| 61 | VFS_READ, |
62 | VFS_IN_READ, |
| 62 | VFS_WRITE, |
63 | VFS_IN_WRITE, |
| - | 64 | VFS_IN_SEEK, |
|
| 63 | VFS_TRUNCATE, |
65 | VFS_IN_TRUNCATE, |
| - | 66 | VFS_IN_FSTAT, |
|
| - | 67 | VFS_IN_CLOSE, |
|
| 64 | VFS_MOUNT, |
68 | VFS_IN_MOUNT, |
| 65 | VFS_UNMOUNT, |
69 | VFS_IN_UNMOUNT, |
| 66 | VFS_DEVICE, |
70 | VFS_IN_SYNC, |
| - | 71 | VFS_IN_REGISTER, |
|
| 67 | VFS_SYNC, |
72 | VFS_IN_MKDIR, |
| 68 | VFS_CLOSE, |
73 | VFS_IN_UNLINK, |
| 69 | VFS_LAST_CMN /* keep this the last member of this enum */ |
74 | VFS_IN_RENAME, |
| - | 75 | VFS_IN_STAT |
|
| 70 | } vfs_request_cmn_t; |
76 | } vfs_in_request_t; |
| 71 | 77 | ||
| 72 | typedef enum { |
78 | typedef enum { |
| 73 | VFS_LOOKUP = VFS_LAST_CMN, |
79 | VFS_OUT_OPEN_NODE = IPC_FIRST_USER_METHOD, |
| 74 | VFS_MOUNTED, |
80 | VFS_OUT_READ, |
| 75 | VFS_DESTROY, |
81 | VFS_OUT_WRITE, |
| 76 | VFS_LAST_CLNT /* keep this the last member of this enum */ |
82 | VFS_OUT_TRUNCATE, |
| 77 | } vfs_request_clnt_t; |
83 | VFS_OUT_CLOSE, |
| 78 | - | ||
| 79 | typedef enum { |
84 | VFS_OUT_MOUNT, |
| 80 | VFS_REGISTER = VFS_LAST_CMN, |
85 | VFS_OUT_MOUNTED, |
| 81 | VFS_OPEN, |
86 | VFS_OUT_UNMOUNT, |
| 82 | VFS_SEEK, |
87 | VFS_OUT_SYNC, |
| 83 | VFS_MKDIR, |
88 | VFS_OUT_STAT, |
| 84 | VFS_UNLINK, |
89 | VFS_OUT_LOOKUP, |
| 85 | VFS_RENAME, |
90 | VFS_OUT_DESTROY, |
| 86 | VFS_NODE, |
91 | VFS_OUT_LAST |
| 87 | VFS_LAST_SRV /* keep this the last member of this enum */ |
- | |
| 88 | } vfs_request_srv_t; |
92 | } vfs_out_request_t; |
| 89 | 93 | ||
| 90 | /* |
94 | /* |
| 91 | * Lookup flags. |
95 | * Lookup flags. |
| 92 | */ |
96 | */ |
| 93 | 97 | ||
| 94 | /** |
98 | /** |
| 95 | * No lookup flags used. |
99 | * No lookup flags used. |
| 96 | */ |
100 | */ |
| 97 | #define L_NONE 0 |
101 | #define L_NONE 0 |
| 98 | 102 | ||
| 99 | /** |
103 | /** |
| 100 | * Lookup will succeed only if the object is a regular file. If L_CREATE is |
104 | * Lookup will succeed only if the object is a regular file. If L_CREATE is |
| 101 | * specified, an empty file will be created. This flag is mutually exclusive |
105 | * specified, an empty file will be created. This flag is mutually exclusive |
| 102 | * with L_DIRECTORY. |
106 | * with L_DIRECTORY. |
| 103 | */ |
107 | */ |
| 104 | #define L_FILE 1 |
108 | #define L_FILE 1 |
| 105 | 109 | ||
| 106 | /** |
110 | /** |
| 107 | * Lookup wil succeed only if the object is a directory. If L_CREATE is |
111 | * Lookup wil succeed only if the object is a directory. If L_CREATE is |
| 108 | * specified, an empty directory will be created. This flag is mutually |
112 | * specified, an empty directory will be created. This flag is mutually |
| 109 | * exclusive with L_FILE. |
113 | * exclusive with L_FILE. |
| 110 | */ |
114 | */ |
| 111 | #define L_DIRECTORY 2 |
115 | #define L_DIRECTORY 2 |
| 112 | 116 | ||
| 113 | /** |
117 | /** |
| 114 | * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the |
118 | * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the |
| 115 | * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used. |
119 | * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used. |
| 116 | */ |
120 | */ |
| 117 | #define L_EXCLUSIVE 4 |
121 | #define L_EXCLUSIVE 4 |
| 118 | 122 | ||
| 119 | /** |
123 | /** |
| 120 | * L_CREATE is used for creating both regular files and directories. |
124 | * L_CREATE is used for creating both regular files and directories. |
| 121 | */ |
125 | */ |
| 122 | #define L_CREATE 8 |
126 | #define L_CREATE 8 |
| 123 | 127 | ||
| 124 | /** |
128 | /** |
| 125 | * L_LINK is used for linking to an already existing nodes. |
129 | * L_LINK is used for linking to an already existing nodes. |
| 126 | */ |
130 | */ |
| 127 | #define L_LINK 16 |
131 | #define L_LINK 16 |
| 128 | 132 | ||
| 129 | /** |
133 | /** |
| 130 | * L_UNLINK is used to remove leaves from the file system namespace. This flag |
134 | * L_UNLINK is used to remove leaves from the file system namespace. This flag |
| 131 | * cannot be passed directly by the client, but will be set by VFS during |
135 | * cannot be passed directly by the client, but will be set by VFS during |
| 132 | * VFS_UNLINK. |
136 | * VFS_UNLINK. |
| 133 | */ |
137 | */ |
| 134 | #define L_UNLINK 32 |
138 | #define L_UNLINK 32 |
| 135 | 139 | ||
| 136 | /** |
140 | /** |
| 137 | * L_OPEN is used to indicate that the lookup operation is a part of VFS_OPEN |
141 | * L_OPEN is used to indicate that the lookup operation is a part of VFS_OPEN |
| 138 | * call from the client. This means that the server might allocate some |
142 | * call from the client. This means that the server might allocate some |
| 139 | * resources for the opened file. This flag cannot be passed directly by the |
143 | * resources for the opened file. This flag cannot be passed directly by the |
| 140 | * client. |
144 | * client. |
| 141 | */ |
145 | */ |
| 142 | #define L_OPEN 64 |
146 | #define L_OPEN 64 |
| 143 | 147 | ||
| 144 | #endif |
148 | #endif |
| 145 | 149 | ||
| 146 | /** @} |
150 | /** @} |
| 147 | */ |
151 | */ |
| 148 | 152 | ||