Subversion Repositories HelenOS

Rev

Rev 2526 | Rev 2531 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 2526 Rev 2527
1
/*
1
/*
2
 * Copyright (c) 2007 Jakub Jermar
2
 * Copyright (c) 2007 Jakub Jermar
3
 * All rights reserved.
3
 * All rights reserved.
4
 *
4
 *
5
 * Redistribution and use in source and binary forms, with or without
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
6
 * modification, are permitted provided that the following conditions
7
 * are met:
7
 * are met:
8
 *
8
 *
9
 * - Redistributions of source code must retain the above copyright
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
12
 *   notice, this list of conditions and the following disclaimer in the
13
 *   documentation and/or other materials provided with the distribution.
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
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.
15
 *   derived from this software without specific prior written permission.
16
 *
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
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
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
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
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
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
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.
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
27
 */
28
 
28
 
29
/** @addtogroup fs
29
/** @addtogroup fs
30
 * @{
30
 * @{
31
 */
31
 */
32
 
32
 
33
/**
33
/**
34
 * @file    vfs.c
34
 * @file    vfs.c
35
 * @brief   VFS multiplexer for HelenOS.
35
 * @brief   VFS multiplexer for HelenOS.
36
 */
36
 */
37
 
37
 
38
#include <ipc/ipc.h>
38
#include <ipc/ipc.h>
39
#include <ipc/services.h>
39
#include <ipc/services.h>
40
#include <async.h>
40
#include <async.h>
41
#include <errno.h>
41
#include <errno.h>
42
#include <stdlib.h>
42
#include <stdlib.h>
43
#include <string.h>
43
#include <string.h>
44
#include <ctype.h>
44
#include <ctype.h>
45
#include <bool.h>
45
#include <bool.h>
46
#include <futex.h>
46
#include <futex.h>
47
#include <libadt/list.h>
47
#include <libadt/list.h>
48
#include "vfs.h"
48
#include "vfs.h"
49
 
49
 
50
atomic_t fs_head_futex = FUTEX_INITIALIZER;
50
atomic_t fs_head_futex = FUTEX_INITIALIZER;
51
link_t fs_head;
51
link_t fs_head;
52
 
52
 
53
/** Verify the VFS info structure.
53
/** Verify the VFS info structure.
54
 *
54
 *
55
 * @param info      Info structure to be verified.
55
 * @param info      Info structure to be verified.
56
 *
56
 *
57
 * @return      Non-zero if the info structure is sane, zero otherwise.
57
 * @return      Non-zero if the info structure is sane, zero otherwise.
58
 */
58
 */
59
static bool vfs_info_sane(vfs_info_t *info)
59
static bool vfs_info_sane(vfs_info_t *info)
60
{
60
{
61
    int i;
61
    int i;
62
 
62
 
63
    /*
63
    /*
64
     * Check if the name is non-empty and is composed solely of ASCII
64
     * Check if the name is non-empty and is composed solely of ASCII
65
     * characters [a-z]+[a-z0-9_-]*.
65
     * characters [a-z]+[a-z0-9_-]*.
66
     */
66
     */
67
    if (!islower(info->name[0]))
67
    if (!islower(info->name[0]))
68
        return false;
68
        return false;
69
    for (i = 1; i < FS_NAME_MAXLEN; i++) {
69
    for (i = 1; i < FS_NAME_MAXLEN; i++) {
70
        if (!(islower(info->name[i]) || isdigit(info->name[i])) &&
70
        if (!(islower(info->name[i]) || isdigit(info->name[i])) &&
71
            (info->name[i] != '-') && (info->name[i] != '_')) {
71
            (info->name[i] != '-') && (info->name[i] != '_')) {
72
            if (info->name[i] == '\0')
72
            if (info->name[i] == '\0')
73
                break;
73
                break;
74
            else
74
            else
75
                return false;
75
                return false;
76
        }
76
        }
77
    }
77
    }
78
   
78
   
79
 
79
 
80
    /*
80
    /*
81
     * Check if the FS implements mandatory VFS operations.
81
     * Check if the FS implements mandatory VFS operations.
82
     */
82
     */
83
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_REGISTER)] != VFS_OP_DEFINED)
83
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_REGISTER)] != VFS_OP_DEFINED)
84
        return false;
84
        return false;
85
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_MOUNT)] != VFS_OP_DEFINED)
85
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_MOUNT)] != VFS_OP_DEFINED)
86
        return false;
86
        return false;
87
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_UNMOUNT)] != VFS_OP_DEFINED)
87
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_UNMOUNT)] != VFS_OP_DEFINED)
88
        return false;
88
        return false;
-
 
89
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_LOOKUP)] != VFS_OP_DEFINED)
-
 
90
        return false;
89
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_OPEN)] != VFS_OP_DEFINED)
91
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_OPEN)] != VFS_OP_DEFINED)
90
        return false;
92
        return false;
91
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_CLOSE)] != VFS_OP_DEFINED)
93
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_CLOSE)] != VFS_OP_DEFINED)
92
        return false;
94
        return false;
93
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_READ)] != VFS_OP_DEFINED)
95
    if (info->ops[IPC_METHOD_TO_VFS_OP(VFS_READ)] != VFS_OP_DEFINED)
94
        return false;
96
        return false;
95
   
97
   
96
    /*
98
    /*
97
     * Check if each operation is either not defined, defined or default.
99
     * Check if each operation is either not defined, defined or default.
98
     */
100
     */
99
    for (i = VFS_FIRST; i < VFS_LAST; i++) {
101
    for (i = VFS_FIRST; i < VFS_LAST; i++) {
100
        if ((IPC_METHOD_TO_VFS_OP(i) != VFS_OP_NULL) &&
102
        if ((IPC_METHOD_TO_VFS_OP(i) != VFS_OP_NULL) &&
101
            (IPC_METHOD_TO_VFS_OP(i) != VFS_OP_DEFAULT) &&
103
            (IPC_METHOD_TO_VFS_OP(i) != VFS_OP_DEFAULT) &&
102
            (IPC_METHOD_TO_VFS_OP(i) != VFS_OP_DEFINED))
104
            (IPC_METHOD_TO_VFS_OP(i) != VFS_OP_DEFINED))
103
            return false;  
105
            return false;  
104
    }
106
    }
105
    return true;
107
    return true;
106
}
108
}
107
 
109
 
108
/** VFS_REGISTER protocol function.
110
/** VFS_REGISTER protocol function.
109
 *
111
 *
110
 * @param rid       Hash of the call with the request.
112
 * @param rid       Hash of the call with the request.
111
 * @param request   Call structure with the request.
113
 * @param request   Call structure with the request.
112
 */
114
 */
113
static void vfs_register(ipc_callid_t rid, ipc_call_t *request)
115
static void vfs_register(ipc_callid_t rid, ipc_call_t *request)
114
{
116
{
115
    ipc_callid_t callid;
117
    ipc_callid_t callid;
116
    ipc_call_t call;
118
    ipc_call_t call;
117
    int rc;
119
    int rc;
118
    size_t size;
120
    size_t size;
119
 
121
 
120
    /*
122
    /*
121
     * The first call has to be IPC_M_DATA_SEND in which we receive the
123
     * The first call has to be IPC_M_DATA_SEND in which we receive the
122
     * VFS info structure from the client FS.
124
     * VFS info structure from the client FS.
123
     */
125
     */
124
    if (!ipc_data_send_accept(&callid, &call, NULL, &size)) {
126
    if (!ipc_data_send_accept(&callid, &call, NULL, &size)) {
125
        /*
127
        /*
126
         * The client doesn't obey the same protocol as we do.
128
         * The client doesn't obey the same protocol as we do.
127
         */
129
         */
128
        ipc_answer_fast(callid, EINVAL, 0, 0);
130
        ipc_answer_fast(callid, EINVAL, 0, 0);
129
        ipc_answer_fast(rid, EINVAL, 0, 0);
131
        ipc_answer_fast(rid, EINVAL, 0, 0);
130
        return;
132
        return;
131
    }
133
    }
132
   
134
   
133
    /*
135
    /*
134
     * We know the size of the VFS info structure. See if the client
136
     * We know the size of the VFS info structure. See if the client
135
     * understands this easy concept too.
137
     * understands this easy concept too.
136
     */
138
     */
137
    if (size != sizeof(vfs_info_t)) {
139
    if (size != sizeof(vfs_info_t)) {
138
        /*
140
        /*
139
         * The client is sending us something, which cannot be
141
         * The client is sending us something, which cannot be
140
         * the info structure.
142
         * the info structure.
141
         */
143
         */
142
        ipc_answer_fast(callid, EINVAL, 0, 0);
144
        ipc_answer_fast(callid, EINVAL, 0, 0);
143
        ipc_answer_fast(rid, EINVAL, 0, 0);
145
        ipc_answer_fast(rid, EINVAL, 0, 0);
144
        return;
146
        return;
145
    }
147
    }
146
    fs_info_t *fs_info;
148
    fs_info_t *fs_info;
147
 
149
 
148
    /*
150
    /*
149
     * Allocate and initialize a buffer for the fs_info structure.
151
     * Allocate and initialize a buffer for the fs_info structure.
150
     */
152
     */
151
    fs_info = (fs_info_t *) malloc(sizeof(fs_info_t));
153
    fs_info = (fs_info_t *) malloc(sizeof(fs_info_t));
152
    if (!fs_info) {
154
    if (!fs_info) {
153
        ipc_answer_fast(callid, ENOMEM, 0, 0);
155
        ipc_answer_fast(callid, ENOMEM, 0, 0);
154
        ipc_answer_fast(rid, ENOMEM, 0, 0);
156
        ipc_answer_fast(rid, ENOMEM, 0, 0);
155
        return;
157
        return;
156
    }
158
    }
157
    link_initialize(&fs_info->fs_link);
159
    link_initialize(&fs_info->fs_link);
158
       
160
       
159
    rc = ipc_data_send_answer(callid, &call, &fs_info->vfs_info, size);
161
    rc = ipc_data_send_answer(callid, &call, &fs_info->vfs_info, size);
160
    if (!rc) {
162
    if (!rc) {
161
        free(fs_info);
163
        free(fs_info);
162
        ipc_answer_fast(callid, rc, 0, 0);
164
        ipc_answer_fast(callid, rc, 0, 0);
163
        ipc_answer_fast(rid, rc, 0, 0);
165
        ipc_answer_fast(rid, rc, 0, 0);
164
        return;
166
        return;
165
    }
167
    }
166
       
168
       
167
    if (!vfs_info_sane(&fs_info->vfs_info)) {
169
    if (!vfs_info_sane(&fs_info->vfs_info)) {
168
        free(fs_info);
170
        free(fs_info);
169
        ipc_answer_fast(callid, EINVAL, 0, 0);
171
        ipc_answer_fast(callid, EINVAL, 0, 0);
170
        ipc_answer_fast(rid, EINVAL, 0, 0);
172
        ipc_answer_fast(rid, EINVAL, 0, 0);
171
        return;
173
        return;
172
    }
174
    }
173
       
175
       
174
    futex_down(&fs_head_futex);
176
    futex_down(&fs_head_futex);
175
 
177
 
176
    /*
178
    /*
177
     * Check for duplicit registrations.
179
     * Check for duplicit registrations.
178
     */
180
     */
179
    link_t *cur;
181
    link_t *cur;
180
    for (cur = fs_head.next; cur != &fs_head; cur = cur->next) {
182
    for (cur = fs_head.next; cur != &fs_head; cur = cur->next) {
181
        fs_info_t *fi = list_get_instance(cur, fs_info_t,
183
        fs_info_t *fi = list_get_instance(cur, fs_info_t,
182
            fs_link);
184
            fs_link);
183
        /* TODO: replace strcmp with strncmp once we have it */
185
        /* TODO: replace strcmp with strncmp once we have it */
184
        if (strcmp(fs_info->vfs_info.name, fi->vfs_info.name) == 0) {
186
        if (strcmp(fs_info->vfs_info.name, fi->vfs_info.name) == 0) {
185
            /*
187
            /*
186
             * We already register a fs like this.
188
             * We already register a fs like this.
187
             */
189
             */
188
            futex_up(&fs_head_futex);
190
            futex_up(&fs_head_futex);
189
            free(fs_info);
191
            free(fs_info);
190
            ipc_answer_fast(callid, EEXISTS, 0, 0);
192
            ipc_answer_fast(callid, EEXISTS, 0, 0);
191
            ipc_answer_fast(rid, EEXISTS, 0, 0);
193
            ipc_answer_fast(rid, EEXISTS, 0, 0);
192
            return;
194
            return;
193
        }
195
        }
194
    }
196
    }
195
   
197
 
-
 
198
    /*
-
 
199
     * Add fs_info to the list of registered FS's.
-
 
200
     */
-
 
201
    list_append(&fs_info->fs_link, &fs_head);
-
 
202
 
196
    /*
203
    /*
197
     * TODO:
-
 
198
     * 1. send the client the IPC_M_CONNECT_TO_ME call so that it makes a
204
     * ACK receiving a properly formatted, non-duplicit vfs_info.
199
     *    callback connection.
-
 
200
     * 2. add the fs_info into fs_head
-
 
201
     */
205
     */
-
 
206
    ipc_answer_fast(callid, EOK, 0, 0);
-
 
207
   
-
 
208
    /*
-
 
209
     * Now we want the client to send us the IPC_M_CONNECT_TO_ME call so
-
 
210
     * that a callback connection is created and we have a phone through
-
 
211
     * which to forward VFS requests to it.
-
 
212
     */
-
 
213
    callid = async_get_call(&call);
-
 
214
    if (IPC_GET_METHOD(call) != IPC_M_CONNECT_TO_ME) {
-
 
215
        list_remove(&fs_info->fs_link);
-
 
216
        futex_up(&fs_head_futex);
-
 
217
        free(fs_info);
-
 
218
        ipc_answer_fast(callid, EINVAL, 0, 0);
-
 
219
        ipc_answer_fast(rid, EINVAL, 0, 0);
-
 
220
        return;
-
 
221
    }
-
 
222
    fs_info->phone = IPC_GET_ARG3(call);
-
 
223
    ipc_answer_fast(callid, EOK, 0, 0);
202
 
224
 
203
    futex_up(&fs_head_futex);
225
    futex_up(&fs_head_futex);
-
 
226
 
-
 
227
    /*
-
 
228
     * That was it. The FS has been registered.
-
 
229
     */
-
 
230
    ipc_answer_fast(rid, EOK, 0, 0);
204
}
231
}
205
 
232
 
206
static void vfs_connection(ipc_callid_t iid, ipc_call_t *icall)
233
static void vfs_connection(ipc_callid_t iid, ipc_call_t *icall)
207
{
234
{
208
    bool keep_on_going = 1;
235
    bool keep_on_going = 1;
209
 
236
 
210
    /*
237
    /*
211
     * The connection was opened via the IPC_CONNECT_ME_TO call.
238
     * The connection was opened via the IPC_CONNECT_ME_TO call.
212
     * This call needs to be answered.
239
     * This call needs to be answered.
213
     */
240
     */
214
    ipc_answer_fast(iid, EOK, 0, 0);
241
    ipc_answer_fast(iid, EOK, 0, 0);
215
 
242
 
216
    /*
243
    /*
217
     * Here we enter the main connection fibril loop.
244
     * Here we enter the main connection fibril loop.
218
     * The logic behind this loop and the protocol is that we'd like to keep
245
     * The logic behind this loop and the protocol is that we'd like to keep
219
     * each connection open for a while before we close it. The benefit of
246
     * each connection open for a while before we close it. The benefit of
220
     * this is that the client doesn't have to establish a new connection
247
     * this is that the client doesn't have to establish a new connection
221
     * upon each request.  On the other hand, the client must be ready to
248
     * upon each request.  On the other hand, the client must be ready to
222
     * re-establish a connection if we hang it up due to reaching of maximum
249
     * re-establish a connection if we hang it up due to reaching of maximum
223
     * number of requests per connection or due to the client timing out.
250
     * number of requests per connection or due to the client timing out.
224
     */
251
     */
225
     
252
     
226
    while (keep_on_going) {
253
    while (keep_on_going) {
227
        ipc_callid_t callid;
254
        ipc_callid_t callid;
228
        ipc_call_t call;
255
        ipc_call_t call;
229
 
256
 
230
        callid = async_get_call(&call);
257
        callid = async_get_call(&call);
231
       
258
       
232
        switch (IPC_GET_METHOD(call)) {
259
        switch (IPC_GET_METHOD(call)) {
233
        case IPC_M_PHONE_HUNGUP:
260
        case IPC_M_PHONE_HUNGUP:
234
            keep_on_going = false;
261
            keep_on_going = false;
235
            break;
262
            break;
236
        case VFS_REGISTER:
263
        case VFS_REGISTER:
237
            vfs_register(callid, &call);
264
            vfs_register(callid, &call);
238
            keep_on_going = false;
265
            keep_on_going = false;
239
            break;
266
            break;
240
        case VFS_MOUNT:
267
        case VFS_MOUNT:
241
        case VFS_UNMOUNT:
268
        case VFS_UNMOUNT:
242
        case VFS_OPEN:
269
        case VFS_OPEN:
243
        case VFS_CREATE:
270
        case VFS_CREATE:
244
        case VFS_CLOSE:
271
        case VFS_CLOSE:
245
        case VFS_READ:
272
        case VFS_READ:
246
        case VFS_WRITE:
273
        case VFS_WRITE:
247
        case VFS_SEEK:
274
        case VFS_SEEK:
248
        default:
275
        default:
249
            ipc_answer_fast(callid, ENOTSUP, 0, 0);
276
            ipc_answer_fast(callid, ENOTSUP, 0, 0);
250
            break;
277
            break;
251
        }
278
        }
252
    }
279
    }
253
 
280
 
254
    /* TODO: cleanup after the client */
281
    /* TODO: cleanup after the client */
255
   
282
   
256
}
283
}
257
 
284
 
258
int main(int argc, char **argv)
285
int main(int argc, char **argv)
259
{
286
{
260
    ipcarg_t phonead;
287
    ipcarg_t phonead;
261
 
288
 
262
    list_initialize(&fs_head);
289
    list_initialize(&fs_head);
263
    async_set_client_connection(vfs_connection);
290
    async_set_client_connection(vfs_connection);
264
    ipc_connect_to_me(PHONE_NS, SERVICE_VFS, 0, &phonead);
291
    ipc_connect_to_me(PHONE_NS, SERVICE_VFS, 0, &phonead);
265
    async_manager();
292
    async_manager();
266
    return 0;
293
    return 0;
267
}
294
}
268
 
295
 
269
/**
296
/**
270
 * @}
297
 * @}
271
 */
298
 */
272
 
299