Subversion Repositories HelenOS

Rev

Rev 4555 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2590 jermar 1
/*
2691 jermar 2
 * Copyright (c) 2008 Jakub Jermar
2590 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
/**
34
 * @file    vfs_node.c
35
 * @brief   Various operations on VFS nodes have their home in this file.
36
 */
37
 
38
#include "vfs.h"
2596 jermar 39
#include <stdlib.h>
40
#include <string.h>
4518 jermar 41
#include <fibril_sync.h>
4509 decky 42
#include <adt/hash_table.h>
2687 jermar 43
#include <assert.h>
2731 jermar 44
#include <async.h>
45
#include <errno.h>
2590 jermar 46
 
4555 jermar 47
/** Mutex protecting the VFS node hash table. */
48
FIBRIL_MUTEX_INITIALIZE(nodes_mutex);
2596 jermar 49
 
50
#define NODES_BUCKETS_LOG   8
51
#define NODES_BUCKETS       (1 << NODES_BUCKETS_LOG)
52
 
53
/** VFS node hash table containing all active, in-memory VFS nodes. */
54
hash_table_t nodes;
55
 
56
#define KEY_FS_HANDLE   0
57
#define KEY_DEV_HANDLE  1
58
#define KEY_INDEX   2
59
 
60
static hash_index_t nodes_hash(unsigned long []);
61
static int nodes_compare(unsigned long [], hash_count_t, link_t *);
62
static void nodes_remove_callback(link_t *);
63
 
64
/** VFS node hash table operations. */
65
hash_table_operations_t nodes_ops = {
66
    .hash = nodes_hash,
67
    .compare = nodes_compare,
68
    .remove_callback = nodes_remove_callback
69
};
70
 
71
/** Initialize the VFS node hash table.
72
 *
73
 * @return      Return true on success, false on failure.
74
 */
75
bool vfs_nodes_init(void)
76
{
77
    return hash_table_create(&nodes, NODES_BUCKETS, 3, &nodes_ops);
78
}
79
 
80
static inline void _vfs_node_addref(vfs_node_t *node)
81
{
82
    node->refcnt++;
83
}
84
 
2593 jermar 85
/** Increment reference count of a VFS node.
86
 *
87
 * @param node      VFS node that will have its refcnt incremented.
88
 */
89
void vfs_node_addref(vfs_node_t *node)
90
{
4555 jermar 91
    fibril_mutex_lock(&nodes_mutex);
2596 jermar 92
    _vfs_node_addref(node);
4555 jermar 93
    fibril_mutex_unlock(&nodes_mutex);
2593 jermar 94
}
95
 
96
/** Decrement reference count of a VFS node.
97
 *
98
 * This function handles the case when the reference count drops to zero.
99
 *
100
 * @param node      VFS node that will have its refcnt decremented.
101
 */
102
void vfs_node_delref(vfs_node_t *node)
103
{
2731 jermar 104
    bool free_vfs_node = false;
105
    bool free_fs_node = false;
106
 
4555 jermar 107
    fibril_mutex_lock(&nodes_mutex);
2596 jermar 108
    if (node->refcnt-- == 1) {
2731 jermar 109
        /*
110
         * We are dropping the last reference to this node.
111
         * Remove it from the VFS node hash table.
112
         */
2596 jermar 113
        unsigned long key[] = {
114
            [KEY_FS_HANDLE] = node->fs_handle,
115
            [KEY_DEV_HANDLE] = node->dev_handle,
116
            [KEY_INDEX] = node->index
117
        };
118
        hash_table_remove(&nodes, key, 3);
2731 jermar 119
        free_vfs_node = true;
120
        if (!node->lnkcnt)
121
            free_fs_node = true;
2596 jermar 122
    }
4555 jermar 123
    fibril_mutex_unlock(&nodes_mutex);
2731 jermar 124
 
125
    if (free_fs_node) {
126
        /*
127
         * The node is not visible in the file system namespace.
128
         * Free up its resources.
129
         */
130
        int phone = vfs_grab_phone(node->fs_handle);
131
        ipcarg_t rc;
4584 jermar 132
        rc = async_req_2_0(phone, VFS_OUT_DESTROY,
2742 jermar 133
            (ipcarg_t)node->dev_handle, (ipcarg_t)node->index);
2731 jermar 134
        assert(rc == EOK);
135
        vfs_release_phone(phone);
136
    }
137
    if (free_vfs_node)
138
        free(node);
2593 jermar 139
}
140
 
141
/** Find VFS node.
142
 *
143
 * This function will try to lookup the given triplet in the VFS node hash
144
 * table. In case the triplet is not found there, a new VFS node is created.
145
 * In any case, the VFS node will have its reference count incremented. Every
146
 * node returned by this call should be eventually put back by calling
147
 * vfs_node_put() on it.
148
 *
2691 jermar 149
 * @param result    Populated lookup result structure.
2593 jermar 150
 *
151
 * @return      VFS node corresponding to the given triplet.
152
 */
2691 jermar 153
vfs_node_t *vfs_node_get(vfs_lookup_res_t *result)
2590 jermar 154
{
2596 jermar 155
    unsigned long key[] = {
2691 jermar 156
        [KEY_FS_HANDLE] = result->triplet.fs_handle,
157
        [KEY_DEV_HANDLE] = result->triplet.dev_handle,
158
        [KEY_INDEX] = result->triplet.index
2596 jermar 159
    };
160
    link_t *tmp;
161
    vfs_node_t *node;
162
 
4555 jermar 163
    fibril_mutex_lock(&nodes_mutex);
2596 jermar 164
    tmp = hash_table_find(&nodes, key);
165
    if (!tmp) {
166
        node = (vfs_node_t *) malloc(sizeof(vfs_node_t));
167
        if (!node) {
4555 jermar 168
            fibril_mutex_unlock(&nodes_mutex);
2596 jermar 169
            return NULL;
170
        }
171
        memset(node, 0, sizeof(vfs_node_t));
2691 jermar 172
        node->fs_handle = result->triplet.fs_handle;
2740 jermar 173
        node->dev_handle = result->triplet.dev_handle;
2691 jermar 174
        node->index = result->triplet.index;
175
        node->size = result->size;
2730 jermar 176
        node->lnkcnt = result->lnkcnt;
3653 jermar 177
        node->type = result->type;
2596 jermar 178
        link_initialize(&node->nh_link);
4518 jermar 179
        fibril_rwlock_initialize(&node->contents_rwlock);
2596 jermar 180
        hash_table_insert(&nodes, key, &node->nh_link);
181
    } else {
4463 decky 182
        node = hash_table_get_instance(tmp, vfs_node_t, nh_link);
3653 jermar 183
        if (node->type == VFS_NODE_UNKNOWN &&
184
            result->type != VFS_NODE_UNKNOWN) {
185
            /* Upgrade the node type. */
186
            node->type = result->type;
187
        }
2596 jermar 188
    }
2687 jermar 189
 
2691 jermar 190
    assert(node->size == result->size);
2730 jermar 191
    assert(node->lnkcnt == result->lnkcnt);
3653 jermar 192
    assert(node->type == result->type || result->type == VFS_NODE_UNKNOWN);
2687 jermar 193
 
2596 jermar 194
    _vfs_node_addref(node);
4555 jermar 195
    fibril_mutex_unlock(&nodes_mutex);
2596 jermar 196
 
197
    return node;
2590 jermar 198
}
199
 
2593 jermar 200
/** Return VFS node when no longer needed by the caller.
201
 *
202
 * This function will remove the reference on the VFS node created by
203
 * vfs_node_get(). This function can only be called as a closing bracket to the
204
 * preceding vfs_node_get() call.
205
 *
206
 * @param node      VFS node being released.
207
 */
208
void vfs_node_put(vfs_node_t *node)
209
{
210
    vfs_node_delref(node);
211
}
212
 
2596 jermar 213
hash_index_t nodes_hash(unsigned long key[])
214
{
215
    hash_index_t a = key[KEY_FS_HANDLE] << (NODES_BUCKETS_LOG / 4);
216
    hash_index_t b = (a | key[KEY_DEV_HANDLE]) << (NODES_BUCKETS_LOG / 2);
217
 
2652 jermar 218
    return (b | key[KEY_INDEX]) & (NODES_BUCKETS - 1);
2596 jermar 219
}
220
 
221
int nodes_compare(unsigned long key[], hash_count_t keys, link_t *item)
222
{
223
    vfs_node_t *node = hash_table_get_instance(item, vfs_node_t, nh_link);
224
    return (node->fs_handle == key[KEY_FS_HANDLE]) &&
225
        (node->dev_handle == key[KEY_DEV_HANDLE]) &&
226
        (node->index == key[KEY_INDEX]);
227
}
228
 
229
void nodes_remove_callback(link_t *item)
230
{
231
}
232
 
2590 jermar 233
/**
234
 * @}
4463 decky 235
 */