Subversion Repositories HelenOS

Rev

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