Subversion Repositories HelenOS

Rev

Rev 4401 | Rev 4509 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 4401 Rev 4463
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>
Line 38... Line 38...
38 
#include <futex.h>
 38 
#include <futex.h>
39 
#include <rwlock.h>
 39 
#include <rwlock.h>
40 
#include <sys/types.h>
 40 
#include <sys/types.h>
41 
#include <devmap.h>
 41 
#include <devmap.h>
42 
#include <bool.h>
 42 
#include <bool.h>
- 
 
 43 
#include <ipc/vfs.h>
43 
 
 44 
 
44 
// FIXME: according to CONFIG_DEBUG
 45 
// FIXME: according to CONFIG_DEBUG
45 
// #define dprintf(...) printf(__VA_ARGS__)
 46 
// #define dprintf(...)  printf(__VA_ARGS__)
46 
 
 47 
 
47 
#define dprintf(...)
 48 
#define dprintf(...)
48 
 
 49 
 
49 
#define VFS_FIRST   IPC_FIRST_USER_METHOD
 - 
 
50 
 
 - 
 
51 
/* Basic types. */
 - 
 
52 
typedef int16_t fs_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 
/**
 50 
/**
95 
 * A structure like this will be allocated for each registered file system.
 51 
 * A structure like this will be allocated for each registered file system.
96 
 */
 52 
 */
97 
typedef struct {
 53 
typedef struct {
98 
    link_t fs_link;
 54 
    link_t fs_link;
Line 103... Line 59...
103 
} fs_info_t;
 59 
} fs_info_t;
104 
 
 60 
 
105 
/**
 61 
/**
106 
 * VFS_PAIR uniquely represents a file system instance.
 62 
 * VFS_PAIR uniquely represents a file system instance.
107 
 */
 63 
 */
108 
#define VFS_PAIR        \
 64 
#define VFS_PAIR \
109 
    fs_handle_t fs_handle;  \
 65 
    fs_handle_t fs_handle; \
110 
    dev_handle_t dev_handle;
 66 
    dev_handle_t dev_handle;
111 
 
 67 
 
112 
/**
 68 
/**
113 
 * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but
 69 
 * 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.
 70 
 * doesn't contain any state. For a stateful structure, see vfs_node_t.
115 
 *
 71 
 *
116 
 * @note    fs_handle, dev_handle and index are meant to be returned in one
 72 
 * @note    fs_handle, dev_handle and index are meant to be returned in one
117 
 *      IPC reply.
 73 
 *      IPC reply.
118 
 */
 74 
 */
119 
#define VFS_TRIPLET \
 75 
#define VFS_TRIPLET \
120 
    VFS_PAIR;   \
 76 
    VFS_PAIR; \
121 
    fs_index_t index;
 77 
    fs_index_t index;
122 
 
 78 
 
123 
typedef struct {
 79 
typedef struct {
124 
    VFS_PAIR;
 80 
    VFS_PAIR;
125 
} vfs_pair_t;
 81 
} vfs_pair_t;
126 
 
 82 
 
127 
typedef struct {
 83 
typedef struct {
128 
    VFS_TRIPLET;
 84 
    VFS_TRIPLET;
129 
} vfs_triplet_t;
 85 
} vfs_triplet_t;
130 
 
 86 
 
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 {
 87 
typedef enum vfs_node_type {
171 
    VFS_NODE_UNKNOWN,
 88 
    VFS_NODE_UNKNOWN,
172 
    VFS_NODE_FILE,
 89 
    VFS_NODE_FILE,
173 
    VFS_NODE_DIRECTORY,
 90 
    VFS_NODE_DIRECTORY,
174 
} vfs_node_type_t;
 91 
} vfs_node_type_t;
Line 232... Line 149...
232 
 
 149 
 
233 
extern link_t fs_head;      /**< List of registered file systems. */
 150 
extern link_t fs_head;      /**< List of registered file systems. */
234 
 
 151 
 
235 
extern vfs_pair_t rootfs;   /**< Root file system. */
 152 
extern vfs_pair_t rootfs;   /**< Root file system. */
236 
 
 153 
 
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. */
 154 
/** Each instance of this type describes one path lookup in progress. */
242 
typedef struct {
 155 
typedef struct {
243 
    link_t  plb_link;   /**< Active PLB entries list link. */
 156 
    link_t  plb_link;   /**< Active PLB entries list link. */
244 
    unsigned index;     /**< Index of the first character in PLB. */
 157 
    unsigned index;     /**< Index of the first character in PLB. */
245 
    size_t len;     /**< Number of characters in this PLB entry. */
 158 
    size_t len;     /**< Number of characters in this PLB entry. */
Line 257... Line 170...
257 
extern int vfs_grab_phone(fs_handle_t);
 170 
extern int vfs_grab_phone(fs_handle_t);
258 
extern void vfs_release_phone(int);
 171 
extern void vfs_release_phone(int);
259 
 
 172 
 
260 
extern fs_handle_t fs_name_to_handle(char *, bool);
 173 
extern fs_handle_t fs_name_to_handle(char *, bool);
261 
 
 174 
 
262 
extern int vfs_lookup_internal(char *, int, vfs_lookup_res_t *, vfs_pair_t *,
 175 
extern int vfs_lookup_internal(char *, int, vfs_lookup_res_t *,
263 
    ...);
 176 
    vfs_pair_t *, ...);
- 
 
 177 
extern int vfs_open_node_internal(vfs_lookup_res_t *);
264 
 
 178 
 
265 
extern bool vfs_nodes_init(void);
 179 
extern bool vfs_nodes_init(void);
266 
extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
 180 
extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
267 
extern void vfs_node_put(vfs_node_t *);
 181 
extern void vfs_node_put(vfs_node_t *);
268 
 
 182 
 
Line 281... Line 195...
281 
 
 195 
 
282 
extern void vfs_process_pending_mount(void);
 196 
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_device(ipc_callid_t, ipc_call_t *);
- 
 
 202 
extern void vfs_sync(ipc_callid_t, ipc_call_t *);
- 
 
 203 
extern void vfs_node(ipc_callid_t, ipc_call_t *);
286 
extern void vfs_close(ipc_callid_t, ipc_call_t *);
 204 
extern void vfs_close(ipc_callid_t, ipc_call_t *);
287 
extern void vfs_read(ipc_callid_t, ipc_call_t *);
 205 
extern void vfs_read(ipc_callid_t, ipc_call_t *);
288 
extern void vfs_write(ipc_callid_t, ipc_call_t *);
 206 
extern void vfs_write(ipc_callid_t, ipc_call_t *);
289 
extern void vfs_seek(ipc_callid_t, ipc_call_t *);
 207 
extern void vfs_seek(ipc_callid_t, ipc_call_t *);
290 
extern void vfs_truncate(ipc_callid_t, ipc_call_t *);
 208 
extern void vfs_truncate(ipc_callid_t, ipc_call_t *);