Subversion Repositories HelenOS

Rev

Rev 2709 | Rev 2731 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 2709 Rev 2730
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_OPEN = VFS_FIRST,
50
    VFS_OPEN = VFS_FIRST,
51
    VFS_CLOSE,
51
    VFS_CLOSE,
52
    VFS_READ,
52
    VFS_READ,
53
    VFS_WRITE,
53
    VFS_WRITE,
54
    VFS_TRUNCATE,
54
    VFS_TRUNCATE,
55
    VFS_RENAME,
55
    VFS_RENAME,
56
    VFS_OPENDIR,
56
    VFS_OPENDIR,
57
    VFS_READDIR,
57
    VFS_READDIR,
58
    VFS_CLOSEDIR,
58
    VFS_CLOSEDIR,
59
    VFS_MKDIR,
59
    VFS_MKDIR,
60
    VFS_UNLINK,
60
    VFS_UNLINK,
61
    VFS_MOUNT,
61
    VFS_MOUNT,
62
    VFS_UNMOUNT,
62
    VFS_UNMOUNT,
63
    VFS_LAST_CMN,   /* keep this the last member of this enum */
63
    VFS_LAST_CMN,   /* keep this the last member of this enum */
64
} vfs_request_cmn_t;
64
} vfs_request_cmn_t;
65
 
65
 
66
typedef enum {
66
typedef enum {
67
    VFS_LOOKUP = VFS_LAST_CMN,
67
    VFS_LOOKUP = VFS_LAST_CMN,
68
    VFS_LAST_CLNT,  /* keep this the last member of this enum */
68
    VFS_LAST_CLNT,  /* keep this the last member of this enum */
69
} vfs_request_clnt_t;
69
} vfs_request_clnt_t;
70
 
70
 
71
typedef enum {
71
typedef enum {
72
    VFS_REGISTER = VFS_LAST_CMN,
72
    VFS_REGISTER = VFS_LAST_CMN,
73
    VFS_SEEK,
73
    VFS_SEEK,
74
    VFS_LAST_SRV,   /* keep this the last member of this enum */
74
    VFS_LAST_SRV,   /* keep this the last member of this enum */
75
} vfs_request_srv_t;
75
} vfs_request_srv_t;
76
 
76
 
77
 
77
 
78
/**
78
/**
79
 * An instance of this structure is associated with a particular FS operation.
79
 * An instance of this structure is associated with a particular FS operation.
80
 * It tells VFS if the FS supports the operation or maybe if a default one
80
 * It tells VFS if the FS supports the operation or maybe if a default one
81
 * should be used.
81
 * should be used.
82
 */
82
 */
83
typedef enum {
83
typedef enum {
84
    VFS_OP_NULL = 0,
84
    VFS_OP_NULL = 0,
85
    VFS_OP_DEFAULT,
85
    VFS_OP_DEFAULT,
86
    VFS_OP_DEFINED
86
    VFS_OP_DEFINED
87
} vfs_op_t;
87
} vfs_op_t;
88
 
88
 
89
#define FS_NAME_MAXLEN  20
89
#define FS_NAME_MAXLEN  20
90
 
90
 
91
/**
91
/**
92
 * A structure like this is passed to VFS by each individual FS upon its
92
 * A structure like this is passed to VFS by each individual FS upon its
93
 * registration. It assosiates a human-readable identifier with each
93
 * registration. It assosiates a human-readable identifier with each
94
 * registered FS. More importantly, through this structure, the FS announces
94
 * registered FS. More importantly, through this structure, the FS announces
95
 * what operations it supports.
95
 * what operations it supports.
96
 */
96
 */
97
typedef struct {
97
typedef struct {
98
    /** Unique identifier of the fs. */
98
    /** Unique identifier of the fs. */
99
    char name[FS_NAME_MAXLEN + 1];
99
    char name[FS_NAME_MAXLEN + 1];
100
   
100
   
101
    /** Operations. */
101
    /** Operations. */
102
    vfs_op_t ops[VFS_LAST_CLNT - VFS_FIRST];
102
    vfs_op_t ops[VFS_LAST_CLNT - VFS_FIRST];
103
} vfs_info_t;
103
} vfs_info_t;
104
 
104
 
105
/**
105
/**
106
 * A structure like this will be allocated for each registered file system.
106
 * A structure like this will be allocated for each registered file system.
107
 */
107
 */
108
typedef struct {
108
typedef struct {
109
    link_t fs_link;
109
    link_t fs_link;
110
    vfs_info_t vfs_info;
110
    vfs_info_t vfs_info;
111
    int fs_handle;
111
    int fs_handle;
112
    atomic_t phone_futex;   /**< Phone serializing futex. */
112
    atomic_t phone_futex;   /**< Phone serializing futex. */
113
    ipcarg_t phone;
113
    ipcarg_t phone;
114
} fs_info_t;
114
} fs_info_t;
115
 
115
 
116
/**
116
/**
117
 * VFS_PAIR uniquely represents a file system instance.
117
 * VFS_PAIR uniquely represents a file system instance.
118
 */
118
 */
119
#define VFS_PAIR    \
119
#define VFS_PAIR    \
120
    int fs_handle;  \
120
    int fs_handle;  \
121
    int dev_handle; 
121
    int dev_handle; 
122
 
122
 
123
/**
123
/**
124
 * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but
124
 * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but
125
 * doesn't contain any state. For a stateful structure, see vfs_node_t.
125
 * doesn't contain any state. For a stateful structure, see vfs_node_t.
126
 *
126
 *
127
 * @note    fs_handle, dev_handle and index are meant to be returned in one
127
 * @note    fs_handle, dev_handle and index are meant to be returned in one
128
 *      IPC reply.
128
 *      IPC reply.
129
 */
129
 */
130
#define VFS_TRIPLET \
130
#define VFS_TRIPLET \
131
    VFS_PAIR;   \
131
    VFS_PAIR;   \
132
    uint64_t index;
132
    uint64_t index;
133
 
133
 
134
typedef struct {
134
typedef struct {
135
    VFS_PAIR;
135
    VFS_PAIR;
136
} vfs_pair_t;
136
} vfs_pair_t;
137
 
137
 
138
typedef struct {
138
typedef struct {
139
    VFS_TRIPLET;
139
    VFS_TRIPLET;
140
} vfs_triplet_t;
140
} vfs_triplet_t;
141
 
141
 
142
/*
142
/*
143
 * Lookup flags.
143
 * Lookup flags.
144
 */
144
 */
145
/**
145
/**
146
 * Lookup will succeed only if the object is a regular file.  If L_CREATE is
146
 * Lookup will succeed only if the object is a regular file.  If L_CREATE is
147
 * specified, an empty file will be created. This flag is mutually exclusive
147
 * specified, an empty file will be created. This flag is mutually exclusive
148
 * with L_DIRECTORY.
148
 * with L_DIRECTORY.
149
 */
149
 */
150
#define L_FILE      1
150
#define L_FILE      1
151
/**
151
/**
152
 * Lookup wil succeed only if the object is a directory. If L_CREATE is
152
 * Lookup wil succeed only if the object is a directory. If L_CREATE is
153
 * specified, an empty directory will be created. This flag is mutually
153
 * specified, an empty directory will be created. This flag is mutually
154
 * exclusive with L_FILE.
154
 * exclusive with L_FILE.
155
 */
155
 */
156
#define L_DIRECTORY 2
156
#define L_DIRECTORY 2
157
/**
157
/**
158
 * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the
158
 * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the
159
 * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used.
159
 * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used.
160
 */
160
 */
161
#define L_EXCLUSIVE 4
161
#define L_EXCLUSIVE 4
162
/**
162
/**
163
 * L_CREATE is used for creating both regular files and directories.
163
 * L_CREATE is used for creating both regular files and directories.
164
 */
164
 */
165
#define L_CREATE    8
165
#define L_CREATE    8
166
/**
166
/**
167
 * L_DESTROY is used to remove leaves from the file system namespace. This flag
167
 * L_DESTROY is used to remove leaves from the file system namespace. This flag
168
 * cannot be passed directly by the client, but will be set by VFS during
168
 * cannot be passed directly by the client, but will be set by VFS during
169
 * VFS_UNLINK.
169
 * VFS_UNLINK.
170
 */
170
 */
171
#define L_DESTROY   16
171
#define L_DESTROY   16
172
 
172
 
173
typedef struct {
173
typedef struct {
174
    vfs_triplet_t triplet;
174
    vfs_triplet_t triplet;
175
    size_t size;
175
    size_t size;
-
 
176
    unsigned lnkcnt;
176
} vfs_lookup_res_t;
177
} vfs_lookup_res_t;
177
 
178
 
178
/**
179
/**
179
 * Instances of this type represent an active, in-memory VFS node and any state
180
 * Instances of this type represent an active, in-memory VFS node and any state
180
 * which may be associated with it.
181
 * which may be associated with it.
181
 */
182
 */
182
typedef struct {
183
typedef struct {
183
    VFS_TRIPLET;        /**< Identity of the node. */
184
    VFS_TRIPLET;        /**< Identity of the node. */
-
 
185
 
-
 
186
    /**
-
 
187
     * Usage counter.  This includes, but is not limited to, all vfs_file_t
-
 
188
     * structures that reference this node.
-
 
189
     */
184
    unsigned refcnt;    /**< Usage counter. */
190
    unsigned refcnt;
-
 
191
   
-
 
192
    /** Number of names this node has in the file system namespace. */
-
 
193
    unsigned lnkcnt;
-
 
194
 
185
    link_t nh_link;     /**< Node hash-table link. */
195
    link_t nh_link;     /**< Node hash-table link. */
186
    size_t size;        /**< Cached size of the file. */
196
    size_t size;        /**< Cached size of the file. */
187
 
197
 
188
    /**
198
    /**
189
     * Holding this rwlock prevents modifications of the node's contents.
199
     * Holding this rwlock prevents modifications of the node's contents.
190
     */
200
     */
191
    rwlock_t contents_rwlock;
201
    rwlock_t contents_rwlock;
192
} vfs_node_t;
202
} vfs_node_t;
193
 
203
 
194
/**
204
/**
195
 * Instances of this type represent an open file. If the file is opened by more
205
 * Instances of this type represent an open file. If the file is opened by more
196
 * than one task, there will be a separate structure allocated for each task.
206
 * than one task, there will be a separate structure allocated for each task.
197
 */
207
 */
198
typedef struct {
208
typedef struct {
199
    /** Serializes access to this open file. */
209
    /** Serializes access to this open file. */
200
    futex_t lock;
210
    futex_t lock;
201
 
211
 
202
    vfs_node_t *node;
212
    vfs_node_t *node;
203
   
213
   
204
    /** Number of file handles referencing this file. */
214
    /** Number of file handles referencing this file. */
205
    unsigned refcnt;
215
    unsigned refcnt;
206
 
216
 
207
    /** Append on write. */
217
    /** Append on write. */
208
    bool append;
218
    bool append;
209
 
219
 
210
    /** Current position in the file. */
220
    /** Current position in the file. */
211
    off_t pos;
221
    off_t pos;
212
} vfs_file_t;
222
} vfs_file_t;
213
 
223
 
214
extern link_t fs_head;      /**< List of registered file systems. */
224
extern link_t fs_head;      /**< List of registered file systems. */
215
 
225
 
216
extern vfs_triplet_t rootfs;    /**< Root node of the root file system. */
226
extern vfs_triplet_t rootfs;    /**< Root node of the root file system. */
217
 
227
 
218
#define MAX_PATH_LEN        (64 * 1024)
228
#define MAX_PATH_LEN        (64 * 1024)
219
 
229
 
220
#define PLB_SIZE        (2 * MAX_PATH_LEN)
230
#define PLB_SIZE        (2 * MAX_PATH_LEN)
221
 
231
 
222
/** Each instance of this type describes one path lookup in progress. */
232
/** Each instance of this type describes one path lookup in progress. */
223
typedef struct {
233
typedef struct {
224
    link_t  plb_link;   /**< Active PLB entries list link. */
234
    link_t  plb_link;   /**< Active PLB entries list link. */
225
    unsigned index;     /**< Index of the first character in PLB. */
235
    unsigned index;     /**< Index of the first character in PLB. */
226
    size_t len;     /**< Number of characters in this PLB entry. */
236
    size_t len;     /**< Number of characters in this PLB entry. */
227
} plb_entry_t;
237
} plb_entry_t;
228
 
238
 
229
extern atomic_t plb_futex;  /**< Futex protecting plb and plb_head. */
239
extern atomic_t plb_futex;  /**< Futex protecting plb and plb_head. */
230
extern uint8_t *plb;        /**< Path Lookup Buffer */
240
extern uint8_t *plb;        /**< Path Lookup Buffer */
231
extern link_t plb_head;     /**< List of active PLB entries. */
241
extern link_t plb_head;     /**< List of active PLB entries. */
232
 
242
 
233
/** Holding this rwlock prevents changes in file system namespace. */
243
/** Holding this rwlock prevents changes in file system namespace. */
234
extern rwlock_t namespace_rwlock;
244
extern rwlock_t namespace_rwlock;
235
 
245
 
236
extern int vfs_grab_phone(int);
246
extern int vfs_grab_phone(int);
237
extern void vfs_release_phone(int);
247
extern void vfs_release_phone(int);
238
 
248
 
239
extern int fs_name_to_handle(char *, bool);
249
extern int fs_name_to_handle(char *, bool);
240
 
250
 
241
extern int vfs_lookup_internal(char *, size_t, int, vfs_lookup_res_t *,
251
extern int vfs_lookup_internal(char *, size_t, int, vfs_lookup_res_t *,
242
    vfs_pair_t *);
252
    vfs_pair_t *);
243
 
253
 
244
extern bool vfs_nodes_init(void);
254
extern bool vfs_nodes_init(void);
245
extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
255
extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
246
extern void vfs_node_put(vfs_node_t *);
256
extern void vfs_node_put(vfs_node_t *);
247
 
257
 
248
#define MAX_OPEN_FILES  128
258
#define MAX_OPEN_FILES  128
249
 
259
 
250
extern bool vfs_files_init(void);
260
extern bool vfs_files_init(void);
251
extern vfs_file_t *vfs_file_get(int);
261
extern vfs_file_t *vfs_file_get(int);
252
extern int vfs_fd_alloc(void);
262
extern int vfs_fd_alloc(void);
253
extern void vfs_fd_free(int);
263
extern void vfs_fd_free(int);
254
 
264
 
255
extern void vfs_file_addref(vfs_file_t *);
265
extern void vfs_file_addref(vfs_file_t *);
256
extern void vfs_file_delref(vfs_file_t *);
266
extern void vfs_file_delref(vfs_file_t *);
257
 
267
 
258
extern void vfs_node_addref(vfs_node_t *);
268
extern void vfs_node_addref(vfs_node_t *);
259
extern void vfs_node_delref(vfs_node_t *);
269
extern void vfs_node_delref(vfs_node_t *);
260
 
270
 
261
extern void vfs_register(ipc_callid_t, ipc_call_t *);
271
extern void vfs_register(ipc_callid_t, ipc_call_t *);
262
extern void vfs_mount(ipc_callid_t, ipc_call_t *);
272
extern void vfs_mount(ipc_callid_t, ipc_call_t *);
263
extern void vfs_open(ipc_callid_t, ipc_call_t *);
273
extern void vfs_open(ipc_callid_t, ipc_call_t *);
264
extern void vfs_read(ipc_callid_t, ipc_call_t *);
274
extern void vfs_read(ipc_callid_t, ipc_call_t *);
265
extern void vfs_write(ipc_callid_t, ipc_call_t *);
275
extern void vfs_write(ipc_callid_t, ipc_call_t *);
266
extern void vfs_seek(ipc_callid_t, ipc_call_t *);
276
extern void vfs_seek(ipc_callid_t, ipc_call_t *);
267
extern void vfs_truncate(ipc_callid_t, ipc_call_t *);
277
extern void vfs_truncate(ipc_callid_t, ipc_call_t *);
268
extern void vfs_mkdir(ipc_callid_t, ipc_call_t *);
278
extern void vfs_mkdir(ipc_callid_t, ipc_call_t *);
269
 
279
 
270
#endif
280
#endif
271
 
281
 
272
/**
282
/**
273
 * @}
283
 * @}
274
 */
284
 */
275
 
285