Subversion Repositories HelenOS

Rev

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

Rev 2691 Rev 2693
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
typedef struct {
141
typedef struct {
142
    vfs_triplet_t triplet;
142
    vfs_triplet_t triplet;
143
    size_t size;
143
    size_t size;
144
} vfs_lookup_res_t;
144
} vfs_lookup_res_t;
145
 
145
 
146
/**
146
/**
147
 * Instances of this type represent an active, in-memory VFS node and any state
147
 * Instances of this type represent an active, in-memory VFS node and any state
148
 * which may be associated with it.
148
 * which may be associated with it.
149
 */
149
 */
150
typedef struct {
150
typedef struct {
151
    VFS_TRIPLET;        /**< Identity of the node. */
151
    VFS_TRIPLET;        /**< Identity of the node. */
152
    unsigned refcnt;    /**< Usage counter. */
152
    unsigned refcnt;    /**< Usage counter. */
153
    link_t nh_link;     /**< Node hash-table link. */
153
    link_t nh_link;     /**< Node hash-table link. */
154
    size_t size;        /**< Cached size of the file. */
154
    size_t size;        /**< Cached size of the file. */
155
 
155
 
156
    /**
156
    /**
157
     * Holding this rwlock prevents modifications of the node's contents.
157
     * Holding this rwlock prevents modifications of the node's contents.
158
     */
158
     */
159
    rwlock_t contents_rwlock;
159
    rwlock_t contents_rwlock;
160
} vfs_node_t;
160
} vfs_node_t;
161
 
161
 
162
/**
162
/**
163
 * Instances of this type represent an open file. If the file is opened by more
163
 * Instances of this type represent an open file. If the file is opened by more
164
 * than one task, there will be a separate structure allocated for each task.
164
 * than one task, there will be a separate structure allocated for each task.
165
 */
165
 */
166
typedef struct {
166
typedef struct {
167
    /** Serializes access to this open file. */
167
    /** Serializes access to this open file. */
168
    futex_t lock;
168
    futex_t lock;
169
 
169
 
170
    vfs_node_t *node;
170
    vfs_node_t *node;
171
   
171
   
172
    /** Number of file handles referencing this file. */
172
    /** Number of file handles referencing this file. */
173
    unsigned refcnt;
173
    unsigned refcnt;
174
 
174
 
175
    /** Current position in the file. */
175
    /** Current position in the file. */
176
    off_t pos;
176
    off_t pos;
177
} vfs_file_t;
177
} vfs_file_t;
178
 
178
 
179
extern link_t fs_head;      /**< List of registered file systems. */
179
extern link_t fs_head;      /**< List of registered file systems. */
180
 
180
 
181
extern vfs_triplet_t rootfs;    /**< Root node of the root file system. */
181
extern vfs_triplet_t rootfs;    /**< Root node of the root file system. */
182
 
182
 
183
#define MAX_PATH_LEN        (64 * 1024)
183
#define MAX_PATH_LEN        (64 * 1024)
184
 
184
 
185
#define PLB_SIZE        (2 * MAX_PATH_LEN)
185
#define PLB_SIZE        (2 * MAX_PATH_LEN)
186
 
186
 
187
/** Each instance of this type describes one path lookup in progress. */
187
/** Each instance of this type describes one path lookup in progress. */
188
typedef struct {
188
typedef struct {
189
    link_t  plb_link;   /**< Active PLB entries list link. */
189
    link_t  plb_link;   /**< Active PLB entries list link. */
190
    unsigned index;     /**< Index of the first character in PLB. */
190
    unsigned index;     /**< Index of the first character in PLB. */
191
    size_t len;     /**< Number of characters in this PLB entry. */
191
    size_t len;     /**< Number of characters in this PLB entry. */
192
} plb_entry_t;
192
} plb_entry_t;
193
 
193
 
194
extern atomic_t plb_futex;  /**< Futex protecting plb and plb_head. */
194
extern atomic_t plb_futex;  /**< Futex protecting plb and plb_head. */
195
extern uint8_t *plb;        /**< Path Lookup Buffer */
195
extern uint8_t *plb;        /**< Path Lookup Buffer */
196
extern link_t plb_head;     /**< List of active PLB entries. */
196
extern link_t plb_head;     /**< List of active PLB entries. */
197
 
197
 
198
/** Holding this rwlock prevents changes in file system namespace. */
198
/** Holding this rwlock prevents changes in file system namespace. */
199
extern rwlock_t namespace_rwlock;
199
extern rwlock_t namespace_rwlock;
200
 
200
 
201
extern int vfs_grab_phone(int);
201
extern int vfs_grab_phone(int);
202
extern void vfs_release_phone(int);
202
extern void vfs_release_phone(int);
203
 
203
 
204
extern int fs_name_to_handle(char *, bool);
204
extern int fs_name_to_handle(char *, bool);
205
 
205
 
206
extern int vfs_lookup_internal(char *, size_t, vfs_lookup_res_t *,
206
extern int vfs_lookup_internal(char *, size_t, vfs_lookup_res_t *,
207
    vfs_pair_t *);
207
    vfs_pair_t *);
208
 
208
 
209
extern bool vfs_nodes_init(void);
209
extern bool vfs_nodes_init(void);
210
extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
210
extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
211
extern void vfs_node_put(vfs_node_t *);
211
extern void vfs_node_put(vfs_node_t *);
212
 
212
 
213
#define MAX_OPEN_FILES  128
213
#define MAX_OPEN_FILES  128
214
 
214
 
215
extern bool vfs_files_init(void);
215
extern bool vfs_files_init(void);
216
extern vfs_file_t *vfs_file_get(int);
216
extern vfs_file_t *vfs_file_get(int);
217
extern int vfs_fd_alloc(void);
217
extern int vfs_fd_alloc(void);
218
extern void vfs_fd_free(int);
218
extern void vfs_fd_free(int);
219
 
219
 
220
extern void vfs_file_addref(vfs_file_t *);
220
extern void vfs_file_addref(vfs_file_t *);
221
extern void vfs_file_delref(vfs_file_t *);
221
extern void vfs_file_delref(vfs_file_t *);
222
 
222
 
223
extern void vfs_node_addref(vfs_node_t *);
223
extern void vfs_node_addref(vfs_node_t *);
224
extern void vfs_node_delref(vfs_node_t *);
224
extern void vfs_node_delref(vfs_node_t *);
225
 
225
 
226
extern void vfs_register(ipc_callid_t, ipc_call_t *);
226
extern void vfs_register(ipc_callid_t, ipc_call_t *);
227
extern void vfs_mount(ipc_callid_t, ipc_call_t *);
227
extern void vfs_mount(ipc_callid_t, ipc_call_t *);
228
extern void vfs_open(ipc_callid_t, ipc_call_t *);
228
extern void vfs_open(ipc_callid_t, ipc_call_t *);
229
extern void vfs_read(ipc_callid_t, ipc_call_t *);
229
extern void vfs_read(ipc_callid_t, ipc_call_t *);
230
extern void vfs_write(ipc_callid_t, ipc_call_t *);
230
extern void vfs_write(ipc_callid_t, ipc_call_t *);
231
extern void vfs_seek(ipc_callid_t, ipc_call_t *);
231
extern void vfs_seek(ipc_callid_t, ipc_call_t *);
-
 
232
extern void vfs_truncate(ipc_callid_t, ipc_call_t *);
232
 
233
 
233
#endif
234
#endif
234
 
235
 
235
/**
236
/**
236
 * @}
237
 * @}
237
 */
238
 */
238
 
239