Subversion Repositories HelenOS

Rev

Rev 2927 | Rev 3153 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2520 jermar 1
/*
2682 jermar 2
 * Copyright (c) 2008 Jakub Jermar
2520 jermar 3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
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
15
 *   derived from this software without specific prior written permission.
16
 *
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
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
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
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
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
29
/** @addtogroup fs
30
 * @{
31
 */
32
 
33
#ifndef VFS_VFS_H_
34
#define VFS_VFS_H_
35
 
2523 jermar 36
#include <ipc/ipc.h>
2529 jermar 37
#include <libadt/list.h>
2766 jermar 38
#include <futex.h>
2680 jermar 39
#include <rwlock.h>
2542 jermar 40
#include <sys/types.h>
2550 cejka 41
#include <bool.h>
2523 jermar 42
 
3150 svoboda 43
// FIXME: according to CONFIG_DEBUG
44
// #define dprintf(...) printf(__VA_ARGS__)
2535 jermar 45
 
3150 svoboda 46
#define dprintf(...)
47
 
2550 cejka 48
#define VFS_FIRST   IPC_FIRST_USER_METHOD
2523 jermar 49
 
2526 jermar 50
#define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST)   
51
 
2770 jermar 52
/* Basic types. */
53
typedef int16_t fs_handle_t;
54
typedef int16_t dev_handle_t;
55
typedef uint32_t fs_index_t;
56
 
2520 jermar 57
typedef enum {
2731 jermar 58
    VFS_READ = VFS_FIRST,
2523 jermar 59
    VFS_WRITE,
2690 jermar 60
    VFS_TRUNCATE,
61
    VFS_MOUNT,
62
    VFS_UNMOUNT,
63
    VFS_LAST_CMN,   /* keep this the last member of this enum */
64
} vfs_request_cmn_t;
2520 jermar 65
 
2690 jermar 66
typedef enum {
67
    VFS_LOOKUP = VFS_LAST_CMN,
2742 jermar 68
    VFS_DESTROY,
2690 jermar 69
    VFS_LAST_CLNT,  /* keep this the last member of this enum */
70
} vfs_request_clnt_t;
2521 jermar 71
 
2690 jermar 72
typedef enum {
73
    VFS_REGISTER = VFS_LAST_CMN,
2731 jermar 74
    VFS_OPEN,
75
    VFS_CLOSE,
2690 jermar 76
    VFS_SEEK,
2731 jermar 77
    VFS_MKDIR,
78
    VFS_UNLINK,
79
    VFS_RENAME,
2690 jermar 80
    VFS_LAST_SRV,   /* keep this the last member of this enum */
81
} vfs_request_srv_t;
82
 
83
 
2521 jermar 84
/**
85
 * An instance of this structure is associated with a particular FS operation.
86
 * It tells VFS if the FS supports the operation or maybe if a default one
87
 * should be used.
88
 */
89
typedef enum {
2523 jermar 90
    VFS_OP_NULL = 0,
2521 jermar 91
    VFS_OP_DEFAULT,
92
    VFS_OP_DEFINED
93
} vfs_op_t;
94
 
95
#define FS_NAME_MAXLEN  20
96
 
97
/**
98
 * A structure like this is passed to VFS by each individual FS upon its
99
 * registration. It assosiates a human-readable identifier with each
100
 * registered FS. More importantly, through this structure, the FS announces
101
 * what operations it supports.
102
 */
103
typedef struct {
2523 jermar 104
    /** Unique identifier of the fs. */
2641 jermar 105
    char name[FS_NAME_MAXLEN + 1];
2523 jermar 106
 
107
    /** Operations. */
2690 jermar 108
    vfs_op_t ops[VFS_LAST_CLNT - VFS_FIRST];
2521 jermar 109
} vfs_info_t;
110
 
2540 jermar 111
/**
112
 * A structure like this will be allocated for each registered file system.
113
 */
2526 jermar 114
typedef struct {
115
    link_t fs_link;
116
    vfs_info_t vfs_info;
2770 jermar 117
    fs_handle_t fs_handle;
2766 jermar 118
    futex_t phone_futex;    /**< Phone serializing futex. */
2527 jermar 119
    ipcarg_t phone;
2526 jermar 120
} fs_info_t;
121
 
2540 jermar 122
/**
2587 jermar 123
 * VFS_PAIR uniquely represents a file system instance.
124
 */
2770 jermar 125
#define VFS_PAIR        \
126
    fs_handle_t fs_handle;  \
127
    dev_handle_t dev_handle;
2587 jermar 128
 
129
/**
130
 * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but
131
 * doesn't contain any state. For a stateful structure, see vfs_node_t.
2540 jermar 132
 *
133
 * @note    fs_handle, dev_handle and index are meant to be returned in one
134
 *      IPC reply.
135
 */
2587 jermar 136
#define VFS_TRIPLET \
137
    VFS_PAIR;   \
2770 jermar 138
    fs_index_t index;
2587 jermar 139
 
2540 jermar 140
typedef struct {
2587 jermar 141
    VFS_PAIR;
142
} vfs_pair_t;
143
 
144
typedef struct {
145
    VFS_TRIPLET;
146
} vfs_triplet_t;
147
 
2704 jermar 148
/*
149
 * Lookup flags.
150
 */
151
/**
2735 jermar 152
 * No lookup flags used.
153
 */
154
#define L_NONE      0
155
/**
2704 jermar 156
 * Lookup will succeed only if the object is a regular file.  If L_CREATE is
157
 * specified, an empty file will be created. This flag is mutually exclusive
158
 * with L_DIRECTORY.
159
 */
2700 jermar 160
#define L_FILE      1
2704 jermar 161
/**
162
 * Lookup wil succeed only if the object is a directory. If L_CREATE is
163
 * specified, an empty directory will be created. This flag is mutually
164
 * exclusive with L_FILE.
165
 */
2700 jermar 166
#define L_DIRECTORY 2
2704 jermar 167
/**
168
 * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the
169
 * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used.
170
 */
171
#define L_EXCLUSIVE 4
172
/**
173
 * L_CREATE is used for creating both regular files and directories.
174
 */
175
#define L_CREATE    8
176
/**
2763 jermar 177
 * L_LINK is used for linking to an already existing nodes.
178
 */
179
#define L_LINK      16
180
/**
181
 * L_UNLINK is used to remove leaves from the file system namespace. This flag
2704 jermar 182
 * cannot be passed directly by the client, but will be set by VFS during
183
 * VFS_UNLINK.
184
 */
2763 jermar 185
#define L_UNLINK    32  
186
/**
187
 * L_PARENT performs a lookup but returns the triplet of the parent node.
188
 * This flag may not be combined with any other lookup flag.
189
 */
190
#define L_PARENT    64  
2700 jermar 191
 
2691 jermar 192
typedef struct {
193
    vfs_triplet_t triplet;
194
    size_t size;
2730 jermar 195
    unsigned lnkcnt;
2691 jermar 196
} vfs_lookup_res_t;
197
 
2587 jermar 198
/**
199
 * Instances of this type represent an active, in-memory VFS node and any state
200
 * which may be associated with it.
201
 */
202
typedef struct {
203
    VFS_TRIPLET;        /**< Identity of the node. */
2730 jermar 204
 
205
    /**
206
     * Usage counter.  This includes, but is not limited to, all vfs_file_t
207
     * structures that reference this node.
208
     */
209
    unsigned refcnt;
210
 
211
    /** Number of names this node has in the file system namespace. */
212
    unsigned lnkcnt;
213
 
2593 jermar 214
    link_t nh_link;     /**< Node hash-table link. */
2821 jermar 215
    size_t size;        /**< Cached size if the node is a file. */
2679 jermar 216
 
2682 jermar 217
    /**
218
     * Holding this rwlock prevents modifications of the node's contents.
219
     */
220
    rwlock_t contents_rwlock;
2540 jermar 221
} vfs_node_t;
222
 
223
/**
224
 * Instances of this type represent an open file. If the file is opened by more
225
 * than one task, there will be a separate structure allocated for each task.
226
 */
227
typedef struct {
2683 jermar 228
    /** Serializes access to this open file. */
229
    futex_t lock;
230
 
2540 jermar 231
    vfs_node_t *node;
232
 
233
    /** Number of file handles referencing this file. */
2593 jermar 234
    unsigned refcnt;
2540 jermar 235
 
2709 jermar 236
    /** Append on write. */
237
    bool append;
238
 
2540 jermar 239
    /** Current position in the file. */
240
    off_t pos;
241
} vfs_file_t;
242
 
2766 jermar 243
extern futex_t nodes_futex;
244
 
2542 jermar 245
extern link_t fs_head;      /**< List of registered file systems. */
2535 jermar 246
 
2587 jermar 247
extern vfs_triplet_t rootfs;    /**< Root node of the root file system. */
2535 jermar 248
 
2542 jermar 249
#define MAX_PATH_LEN        (64 * 1024)
250
 
251
#define PLB_SIZE        (2 * MAX_PATH_LEN)
252
 
253
/** Each instance of this type describes one path lookup in progress. */
254
typedef struct {
255
    link_t  plb_link;   /**< Active PLB entries list link. */
256
    unsigned index;     /**< Index of the first character in PLB. */
257
    size_t len;     /**< Number of characters in this PLB entry. */
258
} plb_entry_t;
259
 
2766 jermar 260
extern futex_t plb_futex;   /**< Futex protecting plb and plb_head. */
2542 jermar 261
extern uint8_t *plb;        /**< Path Lookup Buffer */
262
extern link_t plb_head;     /**< List of active PLB entries. */
263
 
2681 jermar 264
/** Holding this rwlock prevents changes in file system namespace. */
265
extern rwlock_t namespace_rwlock;
2593 jermar 266
 
2770 jermar 267
extern int vfs_grab_phone(fs_handle_t);
2546 jermar 268
extern void vfs_release_phone(int);
269
 
2770 jermar 270
extern fs_handle_t fs_name_to_handle(char *, bool);
2548 jermar 271
 
2763 jermar 272
extern int vfs_lookup_internal(char *, int, vfs_lookup_res_t *, vfs_pair_t *,
273
    ...);
2593 jermar 274
 
2596 jermar 275
extern bool vfs_nodes_init(void);
2691 jermar 276
extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
2593 jermar 277
extern void vfs_node_put(vfs_node_t *);
2544 jermar 278
 
2596 jermar 279
#define MAX_OPEN_FILES  128
280
 
2593 jermar 281
extern bool vfs_files_init(void);
282
extern vfs_file_t *vfs_file_get(int);
283
extern int vfs_fd_alloc(void);
284
extern void vfs_fd_free(int);
285
 
286
extern void vfs_file_addref(vfs_file_t *);
287
extern void vfs_file_delref(vfs_file_t *);
288
 
289
extern void vfs_node_addref(vfs_node_t *);
290
extern void vfs_node_delref(vfs_node_t *);
291
 
2542 jermar 292
extern void vfs_register(ipc_callid_t, ipc_call_t *);
2544 jermar 293
extern void vfs_mount(ipc_callid_t, ipc_call_t *);
2560 jermar 294
extern void vfs_open(ipc_callid_t, ipc_call_t *);
2734 jermar 295
extern void vfs_close(ipc_callid_t, ipc_call_t *);
2625 jermar 296
extern void vfs_read(ipc_callid_t, ipc_call_t *);
2666 jermar 297
extern void vfs_write(ipc_callid_t, ipc_call_t *);
2684 jermar 298
extern void vfs_seek(ipc_callid_t, ipc_call_t *);
2693 jermar 299
extern void vfs_truncate(ipc_callid_t, ipc_call_t *);
2707 jermar 300
extern void vfs_mkdir(ipc_callid_t, ipc_call_t *);
2735 jermar 301
extern void vfs_unlink(ipc_callid_t, ipc_call_t *);
2763 jermar 302
extern void vfs_rename(ipc_callid_t, ipc_call_t *);
2542 jermar 303
 
2520 jermar 304
#endif
305
 
306
/**
307
 * @}
2523 jermar 308
 */