Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
2593 jermar 1
/*
2
 * Copyright (c) 2007 Jakub 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_file.c
35
 * @brief   Various operations on files have their home in this file.
36
 */
37
 
38
#include <errno.h>
39
#include <stdlib.h>
40
#include <string.h>
41
#include <assert.h>
42
#include <bool.h>
43
#include "vfs.h"
44
 
45
/**
46
 * This is a per-connection table of open files.
47
 * Our assumption is that each client opens only one connection and therefore
48
 * there is one table of open files per task. However, this may not be the case
49
 * and the client can open more connections to VFS. In that case, there will be
50
 * several tables and several file handle name spaces per task. Besides of this,
51
 * the functionality will stay unchanged. So unless the client knows what it is
52
 * doing, it should open one connection to VFS only.
53
 *
54
 * Allocation of the open files table is deferred until the client makes the
55
 * first VFS_OPEN operation.
56
 *
57
 * This resource being per-connection and, in the first place, per-fibril, we
58
 * don't need to protect it by a futex.
59
 */
60
__thread vfs_file_t **files = NULL;
61
 
62
/** Initialize the table of open files. */
63
bool vfs_files_init(void)
64
{
65
    if (!files) {
66
        files = malloc(MAX_OPEN_FILES * sizeof(vfs_file_t *));
67
        if (!files)
68
            return false;
69
        memset(files, 0, MAX_OPEN_FILES * sizeof(vfs_file_t *));
70
    }
71
    return true;
72
}
73
 
74
/** Allocate a file descriptor.
75
 *
76
 * @return      First available file descriptor or a negative error
77
 *          code.
78
 */
79
int vfs_fd_alloc(void)
80
{
4432 decky 81
    if (!vfs_files_init())
82
        return ENOMEM;
83
 
84
    unsigned int i;
2593 jermar 85
    for (i = 0; i < MAX_OPEN_FILES; i++) {
86
        if (!files[i]) {
87
            files[i] = (vfs_file_t *) malloc(sizeof(vfs_file_t));
88
            if (!files[i])
89
                return ENOMEM;
4432 decky 90
 
2593 jermar 91
            memset(files[i], 0, sizeof(vfs_file_t));
2683 jermar 92
            futex_initialize(&files[i]->lock, 1);
2593 jermar 93
            vfs_file_addref(files[i]);
4432 decky 94
            return (int) i;
2593 jermar 95
        }
96
    }
4432 decky 97
 
2593 jermar 98
    return EMFILE;
99
}
100
 
101
/** Release file descriptor.
102
 *
103
 * @param fd        File descriptor being released.
3215 jermar 104
 *
105
 * @return      EOK on success or EBADF if fd is an invalid file
106
 *          descriptor.
2593 jermar 107
 */
3215 jermar 108
int vfs_fd_free(int fd)
2593 jermar 109
{
4432 decky 110
    if (!vfs_files_init())
111
        return ENOMEM;
112
 
4362 jermar 113
    if ((fd < 0) || (fd >= MAX_OPEN_FILES) || (files[fd] == NULL))
3215 jermar 114
        return EBADF;
4432 decky 115
 
2593 jermar 116
    vfs_file_delref(files[fd]);
117
    files[fd] = NULL;
4432 decky 118
 
3215 jermar 119
    return EOK;
2593 jermar 120
}
121
 
122
/** Increment reference count of VFS file structure.
123
 *
124
 * @param file      File structure that will have reference count
125
 *          incremented.
126
 */
127
void vfs_file_addref(vfs_file_t *file)
128
{
129
    /*
130
     * File structures are per-connection, so no-one, except the current
131
     * fibril, should have a reference to them. This is the reason we don't
132
     * do any synchronization here.
133
     */
134
    file->refcnt++;
135
}
136
 
137
/** Decrement reference count of VFS file structure.
138
 *
139
 * @param file      File structure that will have reference count
140
 *          decremented.
141
 */
142
void vfs_file_delref(vfs_file_t *file)
143
{
144
    if (file->refcnt-- == 1) {
145
        /*
2731 jermar 146
         * Lost the last reference to a file, need to drop our reference
2593 jermar 147
         * to the underlying VFS node.
148
         */
149
        vfs_node_delref(file->node);
150
        free(file);
151
    }
152
}
153
 
154
/** Find VFS file structure for a given file descriptor.
155
 *
156
 * @param fd        File descriptor.
157
 *
158
 * @return      VFS file structure corresponding to fd.
159
 */
160
vfs_file_t *vfs_file_get(int fd)
161
{
4432 decky 162
    if (!vfs_files_init())
163
        return NULL;
164
 
4362 jermar 165
    if ((fd >= 0) && (fd < MAX_OPEN_FILES))
2624 jermar 166
        return files[fd];
4432 decky 167
 
2624 jermar 168
    return NULL;
2593 jermar 169
}
170
 
171
/**
172
 * @}
4432 decky 173
 */