Subversion Repositories HelenOS

Rev

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

Rev 2687 Rev 2690
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_REGISTER = VFS_FIRST,
50
    VFS_OPEN = VFS_FIRST,
51
    VFS_MOUNT,
-
 
52
    VFS_UNMOUNT,
-
 
53
    VFS_LOOKUP,
-
 
54
    VFS_OPEN,
-
 
55
    VFS_CREATE,
-
 
56
    VFS_CLOSE,
51
    VFS_CLOSE,
57
    VFS_READ,
52
    VFS_READ,
58
    VFS_WRITE,
53
    VFS_WRITE,
59
    VFS_SEEK,
54
    VFS_TRUNCATE,
60
    VFS_RENAME,
55
    VFS_RENAME,
-
 
56
    VFS_OPENDIR,
-
 
57
    VFS_READDIR,
-
 
58
    VFS_CLOSEDIR,
61
    VFS_UNLINK,
59
    VFS_UNLINK,
-
 
60
    VFS_MOUNT,
-
 
61
    VFS_UNMOUNT,
62
    VFS_LAST,       /* keep this the last member of the enum */
62
    VFS_LAST_CMN,   /* keep this the last member of this enum */
63
} vfs_request_t;
63
} vfs_request_cmn_t;
-
 
64
 
-
 
65
typedef enum {
-
 
66
    VFS_LOOKUP = VFS_LAST_CMN,
-
 
67
    VFS_LAST_CLNT,  /* keep this the last member of this enum */
-
 
68
} vfs_request_clnt_t;
-
 
69
 
-
 
70
typedef enum {
-
 
71
    VFS_REGISTER = VFS_LAST_CMN,
-
 
72
    VFS_SEEK,
-
 
73
    VFS_LAST_SRV,   /* keep this the last member of this enum */
-
 
74
} vfs_request_srv_t;
64
 
75
 
65
 
76
 
66
/**
77
/**
67
 * 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.
68
 * 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
69
 * should be used.
80
 * should be used.
70
 */
81
 */
71
typedef enum {
82
typedef enum {
72
    VFS_OP_NULL = 0,
83
    VFS_OP_NULL = 0,
73
    VFS_OP_DEFAULT,
84
    VFS_OP_DEFAULT,
74
    VFS_OP_DEFINED
85
    VFS_OP_DEFINED
75
} vfs_op_t;
86
} vfs_op_t;
76
 
87
 
77
#define FS_NAME_MAXLEN  20
88
#define FS_NAME_MAXLEN  20
78
 
89
 
79
/**
90
/**
80
 * 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
81
 * registration. It assosiates a human-readable identifier with each
92
 * registration. It assosiates a human-readable identifier with each
82
 * registered FS. More importantly, through this structure, the FS announces
93
 * registered FS. More importantly, through this structure, the FS announces
83
 * what operations it supports.
94
 * what operations it supports.
84
 */
95
 */
85
typedef struct {
96
typedef struct {
86
    /** Unique identifier of the fs. */
97
    /** Unique identifier of the fs. */
87
    char name[FS_NAME_MAXLEN + 1];
98
    char name[FS_NAME_MAXLEN + 1];
88
   
99
   
89
    /** Operations. */
100
    /** Operations. */
90
    vfs_op_t ops[VFS_LAST - VFS_FIRST];
101
    vfs_op_t ops[VFS_LAST_CLNT - VFS_FIRST];
91
} vfs_info_t;
102
} vfs_info_t;
92
 
103
 
93
/**
104
/**
94
 * 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.
95
 */
106
 */
96
typedef struct {
107
typedef struct {
97
    link_t fs_link;
108
    link_t fs_link;
98
    vfs_info_t vfs_info;
109
    vfs_info_t vfs_info;
99
    int fs_handle;
110
    int fs_handle;
100
    atomic_t phone_futex;   /**< Phone serializing futex. */
111
    atomic_t phone_futex;   /**< Phone serializing futex. */
101
    ipcarg_t phone;
112
    ipcarg_t phone;
102
} fs_info_t;
113
} fs_info_t;
103
 
114
 
104
/**
115
/**
105
 * VFS_PAIR uniquely represents a file system instance.
116
 * VFS_PAIR uniquely represents a file system instance.
106
 */
117
 */
107
#define VFS_PAIR    \
118
#define VFS_PAIR    \
108
    int fs_handle;  \
119
    int fs_handle;  \
109
    int dev_handle; 
120
    int dev_handle; 
110
 
121
 
111
/**
122
/**
112
 * 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
113
 * 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.
114
 *
125
 *
115
 * @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
116
 *      IPC reply.
127
 *      IPC reply.
117
 */
128
 */
118
#define VFS_TRIPLET \
129
#define VFS_TRIPLET \
119
    VFS_PAIR;   \
130
    VFS_PAIR;   \
120
    uint64_t index;
131
    uint64_t index;
121
 
132
 
122
typedef struct {
133
typedef struct {
123
    VFS_PAIR;
134
    VFS_PAIR;
124
} vfs_pair_t;
135
} vfs_pair_t;
125
 
136
 
126
typedef struct {
137
typedef struct {
127
    VFS_TRIPLET;
138
    VFS_TRIPLET;
128
} vfs_triplet_t;
139
} vfs_triplet_t;
129
 
140
 
130
/**
141
/**
131
 * Instances of this type represent an active, in-memory VFS node and any state
142
 * Instances of this type represent an active, in-memory VFS node and any state
132
 * which may be associated with it.
143
 * which may be associated with it.
133
 */
144
 */
134
typedef struct {
145
typedef struct {
135
    VFS_TRIPLET;        /**< Identity of the node. */
146
    VFS_TRIPLET;        /**< Identity of the node. */
136
    unsigned refcnt;    /**< Usage counter. */
147
    unsigned refcnt;    /**< Usage counter. */
137
    link_t nh_link;     /**< Node hash-table link. */
148
    link_t nh_link;     /**< Node hash-table link. */
138
    size_t size;        /**< Cached size of the file. */
149
    size_t size;        /**< Cached size of the file. */
139
 
150
 
140
    /**
151
    /**
141
     * Holding this rwlock prevents modifications of the node's contents.
152
     * Holding this rwlock prevents modifications of the node's contents.
142
     */
153
     */
143
    rwlock_t contents_rwlock;
154
    rwlock_t contents_rwlock;
144
} vfs_node_t;
155
} vfs_node_t;
145
 
156
 
146
/**
157
/**
147
 * Instances of this type represent an open file. If the file is opened by more
158
 * Instances of this type represent an open file. If the file is opened by more
148
 * than one task, there will be a separate structure allocated for each task.
159
 * than one task, there will be a separate structure allocated for each task.
149
 */
160
 */
150
typedef struct {
161
typedef struct {
151
    /** Serializes access to this open file. */
162
    /** Serializes access to this open file. */
152
    futex_t lock;
163
    futex_t lock;
153
 
164
 
154
    vfs_node_t *node;
165
    vfs_node_t *node;
155
   
166
   
156
    /** Number of file handles referencing this file. */
167
    /** Number of file handles referencing this file. */
157
    unsigned refcnt;
168
    unsigned refcnt;
158
 
169
 
159
    /** Current position in the file. */
170
    /** Current position in the file. */
160
    off_t pos;
171
    off_t pos;
161
} vfs_file_t;
172
} vfs_file_t;
162
 
173
 
163
extern link_t fs_head;      /**< List of registered file systems. */
174
extern link_t fs_head;      /**< List of registered file systems. */
164
 
175
 
165
extern vfs_triplet_t rootfs;    /**< Root node of the root file system. */
176
extern vfs_triplet_t rootfs;    /**< Root node of the root file system. */
166
 
177
 
167
#define MAX_PATH_LEN        (64 * 1024)
178
#define MAX_PATH_LEN        (64 * 1024)
168
 
179
 
169
#define PLB_SIZE        (2 * MAX_PATH_LEN)
180
#define PLB_SIZE        (2 * MAX_PATH_LEN)
170
 
181
 
171
/** Each instance of this type describes one path lookup in progress. */
182
/** Each instance of this type describes one path lookup in progress. */
172
typedef struct {
183
typedef struct {
173
    link_t  plb_link;   /**< Active PLB entries list link. */
184
    link_t  plb_link;   /**< Active PLB entries list link. */
174
    unsigned index;     /**< Index of the first character in PLB. */
185
    unsigned index;     /**< Index of the first character in PLB. */
175
    size_t len;     /**< Number of characters in this PLB entry. */
186
    size_t len;     /**< Number of characters in this PLB entry. */
176
} plb_entry_t;
187
} plb_entry_t;
177
 
188
 
178
extern atomic_t plb_futex;  /**< Futex protecting plb and plb_head. */
189
extern atomic_t plb_futex;  /**< Futex protecting plb and plb_head. */
179
extern uint8_t *plb;        /**< Path Lookup Buffer */
190
extern uint8_t *plb;        /**< Path Lookup Buffer */
180
extern link_t plb_head;     /**< List of active PLB entries. */
191
extern link_t plb_head;     /**< List of active PLB entries. */
181
 
192
 
182
/** Holding this rwlock prevents changes in file system namespace. */
193
/** Holding this rwlock prevents changes in file system namespace. */
183
extern rwlock_t namespace_rwlock;
194
extern rwlock_t namespace_rwlock;
184
 
195
 
185
extern int vfs_grab_phone(int);
196
extern int vfs_grab_phone(int);
186
extern void vfs_release_phone(int);
197
extern void vfs_release_phone(int);
187
 
198
 
188
extern int fs_name_to_handle(char *, bool);
199
extern int fs_name_to_handle(char *, bool);
189
 
200
 
190
extern int vfs_lookup_internal(char *, size_t, vfs_triplet_t *, size_t *,
201
extern int vfs_lookup_internal(char *, size_t, vfs_triplet_t *, size_t *,
191
    vfs_pair_t *);
202
    vfs_pair_t *);
192
 
203
 
193
extern bool vfs_nodes_init(void);
204
extern bool vfs_nodes_init(void);
194
extern vfs_node_t *vfs_node_get(vfs_triplet_t *, size_t);
205
extern vfs_node_t *vfs_node_get(vfs_triplet_t *, size_t);
195
extern void vfs_node_put(vfs_node_t *);
206
extern void vfs_node_put(vfs_node_t *);
196
 
207
 
197
#define MAX_OPEN_FILES  128
208
#define MAX_OPEN_FILES  128
198
 
209
 
199
extern bool vfs_files_init(void);
210
extern bool vfs_files_init(void);
200
extern vfs_file_t *vfs_file_get(int);
211
extern vfs_file_t *vfs_file_get(int);
201
extern int vfs_fd_alloc(void);
212
extern int vfs_fd_alloc(void);
202
extern void vfs_fd_free(int);
213
extern void vfs_fd_free(int);
203
 
214
 
204
extern void vfs_file_addref(vfs_file_t *);
215
extern void vfs_file_addref(vfs_file_t *);
205
extern void vfs_file_delref(vfs_file_t *);
216
extern void vfs_file_delref(vfs_file_t *);
206
 
217
 
207
extern void vfs_node_addref(vfs_node_t *);
218
extern void vfs_node_addref(vfs_node_t *);
208
extern void vfs_node_delref(vfs_node_t *);
219
extern void vfs_node_delref(vfs_node_t *);
209
 
220
 
210
extern void vfs_register(ipc_callid_t, ipc_call_t *);
221
extern void vfs_register(ipc_callid_t, ipc_call_t *);
211
extern void vfs_mount(ipc_callid_t, ipc_call_t *);
222
extern void vfs_mount(ipc_callid_t, ipc_call_t *);
212
extern void vfs_open(ipc_callid_t, ipc_call_t *);
223
extern void vfs_open(ipc_callid_t, ipc_call_t *);
213
extern void vfs_read(ipc_callid_t, ipc_call_t *);
224
extern void vfs_read(ipc_callid_t, ipc_call_t *);
214
extern void vfs_write(ipc_callid_t, ipc_call_t *);
225
extern void vfs_write(ipc_callid_t, ipc_call_t *);
215
extern void vfs_seek(ipc_callid_t, ipc_call_t *);
226
extern void vfs_seek(ipc_callid_t, ipc_call_t *);
216
 
227
 
217
#endif
228
#endif
218
 
229
 
219
/**
230
/**
220
 * @}
231
 * @}
221
 */
232
 */
222
 
233