Rev 4481 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 4481 | Rev 4581 | ||
---|---|---|---|
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_OPEN_NODE = IPC_FIRST_USER_METHOD, |
61 | VFS_READ, |
61 | VFS_READ, |
62 | VFS_WRITE, |
62 | VFS_WRITE, |
63 | VFS_TRUNCATE, |
63 | VFS_TRUNCATE, |
64 | VFS_MOUNT, |
64 | VFS_MOUNT, |
65 | VFS_UNMOUNT, |
65 | VFS_UNMOUNT, |
66 | VFS_DEVICE, |
66 | VFS_DEVICE, |
67 | VFS_SYNC, |
67 | VFS_SYNC, |
68 | VFS_CLOSE, |
68 | VFS_CLOSE, |
69 | VFS_LAST_CMN /* keep this the last member of this enum */ |
69 | VFS_LAST_CMN /* keep this the last member of this enum */ |
70 | } vfs_request_cmn_t; |
70 | } vfs_request_cmn_t; |
71 | 71 | ||
72 | typedef enum { |
72 | typedef enum { |
73 | VFS_LOOKUP = VFS_LAST_CMN, |
73 | VFS_LOOKUP = VFS_LAST_CMN, |
74 | VFS_MOUNTED, |
74 | VFS_MOUNTED, |
75 | VFS_DESTROY, |
75 | VFS_DESTROY, |
76 | VFS_LAST_CLNT /* keep this the last member of this enum */ |
76 | VFS_LAST_CLNT /* keep this the last member of this enum */ |
77 | } vfs_request_clnt_t; |
77 | } vfs_request_clnt_t; |
78 | 78 | ||
79 | typedef enum { |
79 | typedef enum { |
80 | VFS_REGISTER = VFS_LAST_CMN, |
80 | VFS_REGISTER = VFS_LAST_CMN, |
81 | VFS_OPEN, |
81 | VFS_OPEN, |
82 | VFS_SEEK, |
82 | VFS_SEEK, |
83 | VFS_MKDIR, |
83 | VFS_MKDIR, |
84 | VFS_UNLINK, |
84 | VFS_UNLINK, |
85 | VFS_RENAME, |
85 | VFS_RENAME, |
86 | VFS_NODE, |
86 | VFS_NODE, |
87 | VFS_LAST_SRV /* keep this the last member of this enum */ |
87 | VFS_LAST_SRV /* keep this the last member of this enum */ |
88 | } vfs_request_srv_t; |
88 | } vfs_request_srv_t; |
89 | 89 | ||
90 | /* |
90 | /* |
91 | * Lookup flags. |
91 | * Lookup flags. |
92 | */ |
92 | */ |
93 | 93 | ||
94 | /** |
94 | /** |
95 | * No lookup flags used. |
95 | * No lookup flags used. |
96 | */ |
96 | */ |
97 | #define L_NONE 0 |
97 | #define L_NONE 0 |
98 | 98 | ||
99 | /** |
99 | /** |
100 | * Lookup will succeed only if the object is a regular file. If L_CREATE is |
100 | * 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 |
101 | * specified, an empty file will be created. This flag is mutually exclusive |
102 | * with L_DIRECTORY. |
102 | * with L_DIRECTORY. |
103 | */ |
103 | */ |
104 | #define L_FILE 1 |
104 | #define L_FILE 1 |
105 | 105 | ||
106 | /** |
106 | /** |
107 | * Lookup wil succeed only if the object is a directory. If L_CREATE is |
107 | * 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 |
108 | * specified, an empty directory will be created. This flag is mutually |
109 | * exclusive with L_FILE. |
109 | * exclusive with L_FILE. |
110 | */ |
110 | */ |
111 | #define L_DIRECTORY 2 |
111 | #define L_DIRECTORY 2 |
112 | 112 | ||
113 | /** |
113 | /** |
114 | * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the |
114 | * 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. |
115 | * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used. |
116 | */ |
116 | */ |
117 | #define L_EXCLUSIVE 4 |
117 | #define L_EXCLUSIVE 4 |
118 | 118 | ||
119 | /** |
119 | /** |
120 | * L_CREATE is used for creating both regular files and directories. |
120 | * L_CREATE is used for creating both regular files and directories. |
121 | */ |
121 | */ |
122 | #define L_CREATE 8 |
122 | #define L_CREATE 8 |
123 | 123 | ||
124 | /** |
124 | /** |
125 | * L_LINK is used for linking to an already existing nodes. |
125 | * L_LINK is used for linking to an already existing nodes. |
126 | */ |
126 | */ |
127 | #define L_LINK 16 |
127 | #define L_LINK 16 |
128 | 128 | ||
129 | /** |
129 | /** |
130 | * L_UNLINK is used to remove leaves from the file system namespace. This flag |
130 | * 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 |
131 | * cannot be passed directly by the client, but will be set by VFS during |
132 | * VFS_UNLINK. |
132 | * VFS_UNLINK. |
133 | */ |
133 | */ |
134 | #define L_UNLINK 32 |
134 | #define L_UNLINK 32 |
135 | 135 | ||
136 | /** |
136 | /** |
137 | * L_OPEN is used to indicate that the lookup operation is a part of VFS_OPEN |
137 | * 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 |
138 | * 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 |
139 | * resources for the opened file. This flag cannot be passed directly by the |
140 | * client. |
140 | * client. |
141 | */ |
141 | */ |
142 | #define L_OPEN 64 |
142 | #define L_OPEN 64 |
143 | 143 | ||
144 | #endif |
144 | #endif |
145 | 145 | ||
146 | /** @} |
146 | /** @} |
147 | */ |
147 | */ |
148 | 148 |