Subversion Repositories HelenOS

Rev

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

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