Subversion Repositories HelenOS

Rev

Rev 4518 | Rev 4555 | 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
 * @{
4463 decky 31
 */
2520 jermar 32
 
33
#ifndef VFS_VFS_H_
34
#define VFS_VFS_H_
35
 
2523 jermar 36
#include <ipc/ipc.h>
4509 decky 37
#include <adt/list.h>
4518 jermar 38
#include <fibril_sync.h>
2766 jermar 39
#include <futex.h>
2542 jermar 40
#include <sys/types.h>
4401 svoboda 41
#include <devmap.h>
2550 cejka 42
#include <bool.h>
4463 decky 43
#include <ipc/vfs.h>
2523 jermar 44
 
3079 decky 45
// FIXME: according to CONFIG_DEBUG
4463 decky 46
// #define dprintf(...)  printf(__VA_ARGS__)
2535 jermar 47
 
3079 decky 48
#define dprintf(...)
49
 
2521 jermar 50
/**
2540 jermar 51
 * A structure like this will be allocated for each registered file system.
52
 */
2526 jermar 53
typedef struct {
54
    link_t fs_link;
55
    vfs_info_t vfs_info;
2770 jermar 56
    fs_handle_t fs_handle;
4518 jermar 57
    fibril_mutex_t phone_lock;
2527 jermar 58
    ipcarg_t phone;
2526 jermar 59
} fs_info_t;
60
 
2540 jermar 61
/**
2587 jermar 62
 * VFS_PAIR uniquely represents a file system instance.
63
 */
4463 decky 64
#define VFS_PAIR \
65
    fs_handle_t fs_handle; \
2770 jermar 66
    dev_handle_t dev_handle;
2587 jermar 67
 
68
/**
69
 * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but
70
 * doesn't contain any state. For a stateful structure, see vfs_node_t.
2540 jermar 71
 *
72
 * @note    fs_handle, dev_handle and index are meant to be returned in one
73
 *      IPC reply.
74
 */
4463 decky 75
#define VFS_TRIPLET \
76
    VFS_PAIR; \
2770 jermar 77
    fs_index_t index;
2587 jermar 78
 
2540 jermar 79
typedef struct {
2587 jermar 80
    VFS_PAIR;
81
} vfs_pair_t;
82
 
83
typedef struct {
84
    VFS_TRIPLET;
85
} vfs_triplet_t;
86
 
3653 jermar 87
typedef enum vfs_node_type {
88
    VFS_NODE_UNKNOWN,
89
    VFS_NODE_FILE,
90
    VFS_NODE_DIRECTORY,
91
} vfs_node_type_t;
92
 
2691 jermar 93
typedef struct {
94
    vfs_triplet_t triplet;
3653 jermar 95
    vfs_node_type_t type;
2691 jermar 96
    size_t size;
2730 jermar 97
    unsigned lnkcnt;
2691 jermar 98
} vfs_lookup_res_t;
99
 
2587 jermar 100
/**
101
 * Instances of this type represent an active, in-memory VFS node and any state
102
 * which may be associated with it.
103
 */
104
typedef struct {
105
    VFS_TRIPLET;        /**< Identity of the node. */
2730 jermar 106
 
107
    /**
108
     * Usage counter.  This includes, but is not limited to, all vfs_file_t
109
     * structures that reference this node.
110
     */
111
    unsigned refcnt;
112
 
113
    /** Number of names this node has in the file system namespace. */
114
    unsigned lnkcnt;
115
 
2593 jermar 116
    link_t nh_link;     /**< Node hash-table link. */
3653 jermar 117
 
118
    vfs_node_type_t type;   /**< Partial info about the node type. */
119
 
2821 jermar 120
    size_t size;        /**< Cached size if the node is a file. */
2679 jermar 121
 
2682 jermar 122
    /**
123
     * Holding this rwlock prevents modifications of the node's contents.
124
     */
4518 jermar 125
    fibril_rwlock_t contents_rwlock;
2540 jermar 126
} vfs_node_t;
127
 
128
/**
129
 * Instances of this type represent an open file. If the file is opened by more
130
 * than one task, there will be a separate structure allocated for each task.
131
 */
132
typedef struct {
2683 jermar 133
    /** Serializes access to this open file. */
4518 jermar 134
    fibril_mutex_t lock;
2683 jermar 135
 
2540 jermar 136
    vfs_node_t *node;
137
 
138
    /** Number of file handles referencing this file. */
2593 jermar 139
    unsigned refcnt;
2540 jermar 140
 
2709 jermar 141
    /** Append on write. */
142
    bool append;
143
 
2540 jermar 144
    /** Current position in the file. */
145
    off_t pos;
146
} vfs_file_t;
147
 
2766 jermar 148
extern futex_t nodes_futex;
149
 
2542 jermar 150
extern link_t fs_head;      /**< List of registered file systems. */
2535 jermar 151
 
3109 jermar 152
extern vfs_pair_t rootfs;   /**< Root file system. */
2535 jermar 153
 
2542 jermar 154
/** Each instance of this type describes one path lookup in progress. */
155
typedef struct {
156
    link_t  plb_link;   /**< Active PLB entries list link. */
157
    unsigned index;     /**< Index of the first character in PLB. */
158
    size_t len;     /**< Number of characters in this PLB entry. */
159
} plb_entry_t;
160
 
2766 jermar 161
extern futex_t plb_futex;   /**< Futex protecting plb and plb_head. */
2542 jermar 162
extern uint8_t *plb;        /**< Path Lookup Buffer */
163
extern link_t plb_head;     /**< List of active PLB entries. */
164
 
4305 jermar 165
#define MAX_MNTOPTS_LEN     256
166
 
2681 jermar 167
/** Holding this rwlock prevents changes in file system namespace. */
4518 jermar 168
extern fibril_rwlock_t namespace_rwlock;
2593 jermar 169
 
2770 jermar 170
extern int vfs_grab_phone(fs_handle_t);
2546 jermar 171
extern void vfs_release_phone(int);
172
 
4539 jermar 173
extern fibril_mutex_t fs_head_lock;
174
extern bool pending_new_fs;
175
extern fibril_condvar_t pending_cv;
176
 
2770 jermar 177
extern fs_handle_t fs_name_to_handle(char *, bool);
2548 jermar 178
 
4463 decky 179
extern int vfs_lookup_internal(char *, int, vfs_lookup_res_t *,
180
    vfs_pair_t *, ...);
181
extern int vfs_open_node_internal(vfs_lookup_res_t *);
2593 jermar 182
 
2596 jermar 183
extern bool vfs_nodes_init(void);
2691 jermar 184
extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
2593 jermar 185
extern void vfs_node_put(vfs_node_t *);
2544 jermar 186
 
2596 jermar 187
#define MAX_OPEN_FILES  128
188
 
2593 jermar 189
extern bool vfs_files_init(void);
190
extern vfs_file_t *vfs_file_get(int);
191
extern int vfs_fd_alloc(void);
3215 jermar 192
extern int vfs_fd_free(int);
2593 jermar 193
 
194
extern void vfs_file_addref(vfs_file_t *);
195
extern void vfs_file_delref(vfs_file_t *);
196
 
197
extern void vfs_node_addref(vfs_node_t *);
198
extern void vfs_node_delref(vfs_node_t *);
199
 
4010 decky 200
extern void vfs_process_pending_mount(void);
2542 jermar 201
extern void vfs_register(ipc_callid_t, ipc_call_t *);
2544 jermar 202
extern void vfs_mount(ipc_callid_t, ipc_call_t *);
2560 jermar 203
extern void vfs_open(ipc_callid_t, ipc_call_t *);
4463 decky 204
extern void vfs_open_node(ipc_callid_t, ipc_call_t *);
205
extern void vfs_device(ipc_callid_t, ipc_call_t *);
206
extern void vfs_sync(ipc_callid_t, ipc_call_t *);
207
extern void vfs_node(ipc_callid_t, ipc_call_t *);
2734 jermar 208
extern void vfs_close(ipc_callid_t, ipc_call_t *);
2625 jermar 209
extern void vfs_read(ipc_callid_t, ipc_call_t *);
2666 jermar 210
extern void vfs_write(ipc_callid_t, ipc_call_t *);
2684 jermar 211
extern void vfs_seek(ipc_callid_t, ipc_call_t *);
2693 jermar 212
extern void vfs_truncate(ipc_callid_t, ipc_call_t *);
2707 jermar 213
extern void vfs_mkdir(ipc_callid_t, ipc_call_t *);
2735 jermar 214
extern void vfs_unlink(ipc_callid_t, ipc_call_t *);
2763 jermar 215
extern void vfs_rename(ipc_callid_t, ipc_call_t *);
2542 jermar 216
 
2520 jermar 217
#endif
218
 
219
/**
220
 * @}
2523 jermar 221
 */