Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
1335 jermar 1
/*
2071 jermar 2
 * Copyright (c) 2006 Ondrej Palkovsky
1335 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
 
1740 jermar 29
/** @addtogroup ns
1649 cejka 30
 * @{
4008 decky 31
 */
1649 cejka 32
 
1335 jermar 33
/**
4008 decky 34
 * @file  ns.c
35
 * @brief Naming service for HelenOS IPC.
1335 jermar 36
 */
37
 
1649 cejka 38
 
1353 jermar 39
#include <ipc/ipc.h>
40
#include <ipc/ns.h>
1596 palkovsky 41
#include <ipc/services.h>
1030 palkovsky 42
#include <stdio.h>
3896 svoboda 43
#include <bool.h>
1030 palkovsky 44
#include <unistd.h>
45
#include <stdlib.h>
46
#include <errno.h>
1335 jermar 47
#include <assert.h>
48
#include <libadt/list.h>
49
#include <libadt/hash_table.h>
1435 palkovsky 50
#include <sysinfo.h>
3896 svoboda 51
#include <loader/loader.h>
1435 palkovsky 52
#include <ddi.h>
53
#include <as.h>
1335 jermar 54
 
4008 decky 55
#define NAME  "ns"
1335 jermar 56
 
4008 decky 57
#define NS_HASH_TABLE_CHAINS  20
1335 jermar 58
 
1336 jermar 59
static int register_service(ipcarg_t service, ipcarg_t phone, ipc_call_t *call);
4008 decky 60
static void connect_to_service(ipcarg_t service, ipc_call_t *call,
2476 jermar 61
    ipc_callid_t callid);
1336 jermar 62
 
3896 svoboda 63
void register_clonable(ipcarg_t service, ipcarg_t phone, ipc_call_t *call,
64
    ipc_callid_t callid);
65
void connect_to_clonable(ipcarg_t service, ipc_call_t *call,
66
    ipc_callid_t callid);
67
 
4008 decky 68
 
1335 jermar 69
/* Static functions implementing NS hash table operations. */
70
static hash_index_t ns_hash(unsigned long *key);
71
static int ns_compare(unsigned long *key, hash_count_t keys, link_t *item);
1336 jermar 72
static void ns_remove(link_t *item);
1335 jermar 73
 
74
/** Operations for NS hash table. */
75
static hash_table_operations_t ns_hash_table_ops = {
76
    .hash = ns_hash,
77
    .compare = ns_compare,
1336 jermar 78
    .remove_callback = ns_remove
1335 jermar 79
};
80
 
81
/** NS hash table structure. */
82
static hash_table_t ns_hash_table;
83
 
84
/** NS hash table item. */
85
typedef struct {
86
    link_t link;
4008 decky 87
    ipcarg_t service;        /**< Number of the service. */
88
    ipcarg_t phone;          /**< Phone registered with the service. */
89
    ipcarg_t in_phone_hash;  /**< Incoming phone hash. */
1335 jermar 90
} hashed_service_t;
91
 
4008 decky 92
/** Pending connection structure. */
93
typedef struct {
94
    link_t link;
95
    ipcarg_t service;        /**< Number of the service. */
96
    ipc_callid_t callid;     /**< Call ID waiting for the connection */
97
    ipcarg_t arg2;           /**< Second argument */
98
    ipcarg_t arg3;           /**< Third argument */
99
} pending_req_t;
1596 palkovsky 100
 
4008 decky 101
static link_t pending_req;
102
 
3896 svoboda 103
/** Request for connection to a clonable service. */
104
typedef struct {
105
    link_t link;
106
    ipcarg_t service;
3904 svoboda 107
    ipc_call_t call;
3896 svoboda 108
    ipc_callid_t callid;
109
} cs_req_t;
110
 
111
/** List of clonable-service connection requests. */
112
static link_t cs_req;
113
 
4008 decky 114
static void *clockaddr = NULL;
115
static void *klogaddr = NULL;
116
 
3896 svoboda 117
/** Return true if @a service is clonable. */
118
static bool service_clonable(int service)
119
{
4008 decky 120
    return (service == SERVICE_LOAD);
3896 svoboda 121
}
122
 
3908 decky 123
static void get_as_area(ipc_callid_t callid, ipc_call_t *call, char *name, void **addr)
1435 palkovsky 124
{
125
    void *ph_addr;
3908 decky 126
 
1596 palkovsky 127
    if (!*addr) {
2015 jermar 128
        ph_addr = (void *) sysinfo_value(name);
1435 palkovsky 129
        if (!ph_addr) {
2619 jermar 130
            ipc_answer_0(callid, ENOENT);
1435 palkovsky 131
            return;
132
        }
2141 jermar 133
        *addr = as_get_mappable_page(PAGE_SIZE);
3908 decky 134
        if (physmem_map(ph_addr, *addr, 1,
135
            AS_AREA_READ | AS_AREA_CACHEABLE) != 0) {
136
            ipc_answer_0(callid, ENOENT);
137
            return;
138
        }
1435 palkovsky 139
    }
2619 jermar 140
    ipc_answer_2(callid, EOK, (ipcarg_t) *addr, AS_AREA_READ);
1435 palkovsky 141
}
142
 
4008 decky 143
/** Process pending connection requests */
144
static void process_pending_req()
145
{
146
    link_t *cur;
147
 
148
loop:
149
    for (cur = pending_req.next; cur != &pending_req; cur = cur->next) {
150
        pending_req_t *pr = list_get_instance(cur, pending_req_t, link);
151
 
152
        unsigned long keys[3] = {
153
            pr->service,
154
            0,
155
 
156
        };
157
 
158
        link_t *link = hash_table_find(&ns_hash_table, keys);
159
        if (!link)
160
            continue;
161
 
162
        hashed_service_t *hs = hash_table_get_instance(link, hashed_service_t, link);
163
        ipcarg_t retval = ipc_forward_fast(pr->callid, hs->phone,
164
            pr->arg2, pr->arg3, 0, IPC_FF_NONE);
165
 
166
        if (!(pr->callid & IPC_CALLID_NOTIFICATION))
167
            ipc_answer_0(pr->callid, retval);
168
 
169
        list_remove(cur);
170
        free(pr);
171
        goto loop;
172
    }
173
}
174
 
1030 palkovsky 175
int main(int argc, char **argv)
176
{
3083 decky 177
    printf(NAME ": HelenOS IPC Naming Service\n");
178
 
2476 jermar 179
    if (!hash_table_create(&ns_hash_table, NS_HASH_TABLE_CHAINS, 3,
180
        &ns_hash_table_ops)) {
4008 decky 181
        printf(NAME ": No memory available for services\n");
1335 jermar 182
        return ENOMEM;
183
    }
4008 decky 184
 
185
    list_initialize(&pending_req);
3896 svoboda 186
    list_initialize(&cs_req);
3083 decky 187
 
188
    printf(NAME ": Accepting connections\n");
4008 decky 189
    while (true) {
190
        process_pending_req();
191
 
192
        ipc_call_t call;
193
        ipc_callid_t callid = ipc_wait_for_call(&call);
194
        ipcarg_t retval;
195
 
1091 palkovsky 196
        switch (IPC_GET_METHOD(call)) {
2677 jermar 197
        case IPC_M_SHARE_IN:
1596 palkovsky 198
            switch (IPC_GET_ARG3(call)) {
199
            case SERVICE_MEM_REALTIME:
3908 decky 200
                get_as_area(callid, &call, "clock.faddr", &clockaddr);
1596 palkovsky 201
                break;
202
            case SERVICE_MEM_KLOG:
3908 decky 203
                get_as_area(callid, &call, "klog.faddr", &klogaddr);
1596 palkovsky 204
                break;
205
            default:
2619 jermar 206
                ipc_answer_0(callid, ENOENT);
1596 palkovsky 207
            }
1435 palkovsky 208
            continue;
1089 palkovsky 209
        case IPC_M_PHONE_HUNGUP:
2588 jermar 210
            retval = EOK;
1089 palkovsky 211
            break;
1336 jermar 212
        case IPC_M_CONNECT_TO_ME:
1335 jermar 213
            /*
1336 jermar 214
             * Server requests service registration.
1335 jermar 215
             */
3896 svoboda 216
            if (service_clonable(IPC_GET_ARG1(call))) {
217
                register_clonable(IPC_GET_ARG1(call),
218
                    IPC_GET_ARG5(call), &call, callid);
219
                continue;
220
            } else {
221
                retval = register_service(IPC_GET_ARG1(call),
222
                    IPC_GET_ARG5(call), &call);
223
            }
1030 palkovsky 224
            break;
1089 palkovsky 225
        case IPC_M_CONNECT_ME_TO:
1336 jermar 226
            /*
227
             * Client requests to be connected to a service.
228
             */
3896 svoboda 229
            if (service_clonable(IPC_GET_ARG1(call))) {
230
                connect_to_clonable(IPC_GET_ARG1(call),
231
                    &call, callid);
232
                continue;
233
            } else {
4008 decky 234
                connect_to_service(IPC_GET_ARG1(call), &call,
235
                    callid);
236
                continue;
3896 svoboda 237
            }
1061 palkovsky 238
            break;
1030 palkovsky 239
        default:
240
            retval = ENOENT;
241
            break;
242
        }
4008 decky 243
 
244
        if (!(callid & IPC_CALLID_NOTIFICATION))
2619 jermar 245
            ipc_answer_0(callid, retval);
1030 palkovsky 246
    }
3083 decky 247
 
248
    /* Not reached */
249
    return 0;
1030 palkovsky 250
}
1335 jermar 251
 
1338 jermar 252
/** Register service.
1336 jermar 253
 *
4008 decky 254
 * @param service Service to be registered.
255
 * @param phone   Phone to be used for connections to the service.
256
 * @param call    Pointer to call structure.
1336 jermar 257
 *
4008 decky 258
 * @return Zero on success or a value from @ref errno.h.
259
 *
1336 jermar 260
 */
261
int register_service(ipcarg_t service, ipcarg_t phone, ipc_call_t *call)
262
{
2476 jermar 263
    unsigned long keys[3] = {
264
        service,
265
        call->in_phone_hash,
266
 
267
    };
4008 decky 268
 
269
    if (hash_table_find(&ns_hash_table, keys))
1336 jermar 270
        return EEXISTS;
4008 decky 271
 
272
    hashed_service_t *hs = (hashed_service_t *) malloc(sizeof(hashed_service_t));
273
    if (!hs)
1336 jermar 274
        return ENOMEM;
4008 decky 275
 
1336 jermar 276
    link_initialize(&hs->link);
277
    hs->service = service;
278
    hs->phone = phone;
279
    hs->in_phone_hash = call->in_phone_hash;
280
    hash_table_insert(&ns_hash_table, keys, &hs->link);
4008 decky 281
 
1336 jermar 282
    return 0;
283
}
284
 
285
/** Connect client to service.
286
 *
4008 decky 287
 * @param service Service to be connected to.
288
 * @param call    Pointer to call structure.
289
 * @param callid  Call ID of the request.
1336 jermar 290
 *
291
 * @return Zero on success or a value from @ref errno.h.
4008 decky 292
 *
1336 jermar 293
 */
4008 decky 294
void connect_to_service(ipcarg_t service, ipc_call_t *call, ipc_callid_t callid)
1336 jermar 295
{
4008 decky 296
    ipcarg_t retval;
297
    unsigned long keys[3] = {
298
        service,
299
        0,
300
 
301
    };
302
 
303
    link_t *link = hash_table_find(&ns_hash_table, keys);
304
    if (!link) {
305
        if (IPC_GET_ARG4(*call) & IPC_FLAG_BLOCKING) {
306
            /* Blocking connection, add to pending list */
307
            pending_req_t *pr = (pending_req_t *) malloc(sizeof(pending_req_t));
308
            if (!pr) {
309
                retval = ENOMEM;
310
                goto out;
311
            }
312
 
313
            pr->service = service;
314
            pr->callid = callid;
315
            pr->arg2 = IPC_GET_ARG2(*call);
316
            pr->arg3 = IPC_GET_ARG3(*call);
317
            list_append(&pr->link, &pending_req);
318
            return;
319
        }
320
        retval = ENOENT;
321
        goto out;
1336 jermar 322
    }
4008 decky 323
 
324
    hashed_service_t *hs = hash_table_get_instance(link, hashed_service_t, link);
325
    retval = ipc_forward_fast(callid, hs->phone, IPC_GET_ARG2(*call),
326
        IPC_GET_ARG3(*call), 0, IPC_FF_NONE);
327
out:
328
    if (!(callid & IPC_CALLID_NOTIFICATION))
329
        ipc_answer_0(callid, retval);
1336 jermar 330
}
331
 
3896 svoboda 332
/** Register clonable service.
333
 *
4008 decky 334
 * @param service Service to be registered.
335
 * @param phone   Phone to be used for connections to the service.
336
 * @param call    Pointer to call structure.
337
 *
3896 svoboda 338
 */
339
void register_clonable(ipcarg_t service, ipcarg_t phone, ipc_call_t *call,
340
    ipc_callid_t callid)
341
{
342
    if (list_empty(&cs_req)) {
343
        /* There was no pending connection request. */
344
        printf(NAME ": Unexpected clonable server.\n");
345
        ipc_answer_0(callid, EBUSY);
346
        return;
347
    }
4008 decky 348
 
349
    cs_req_t *csr = list_get_instance(cs_req.next, cs_req_t, link);
3896 svoboda 350
    list_remove(&csr->link);
4008 decky 351
 
3896 svoboda 352
    /* Currently we can only handle a single type of clonable service. */
353
    assert(csr->service == SERVICE_LOAD);
4008 decky 354
 
3896 svoboda 355
    ipc_answer_0(callid, EOK);
4008 decky 356
 
357
    int rc = ipc_forward_fast(csr->callid, phone, IPC_GET_ARG2(csr->call),
3904 svoboda 358
        IPC_GET_ARG3(csr->call), 0, IPC_FF_NONE);
4241 svoboda 359
 
3896 svoboda 360
    free(csr);
4241 svoboda 361
    ipc_hangup(phone);
3896 svoboda 362
}
363
 
364
/** Connect client to clonable service.
365
 *
4008 decky 366
 * @param service Service to be connected to.
367
 * @param call    Pointer to call structure.
368
 * @param callid  Call ID of the request.
3896 svoboda 369
 *
4008 decky 370
 * @return Zero on success or a value from @ref errno.h.
371
 *
3896 svoboda 372
 */
373
void connect_to_clonable(ipcarg_t service, ipc_call_t *call,
374
    ipc_callid_t callid)
375
{
376
    assert(service == SERVICE_LOAD);
4008 decky 377
 
378
    cs_req_t *csr = malloc(sizeof(cs_req_t));
3896 svoboda 379
    if (csr == NULL) {
380
        ipc_answer_0(callid, ENOMEM);
381
        return;
382
    }
4008 decky 383
 
3896 svoboda 384
    /* Spawn a loader. */
4008 decky 385
    int rc = loader_spawn("loader");
386
 
3896 svoboda 387
    if (rc < 0) {
388
        free(csr);
389
        ipc_answer_0(callid, rc);
390
        return;
391
    }
4008 decky 392
 
3896 svoboda 393
    csr->service = service;
3904 svoboda 394
    csr->call = *call;
3896 svoboda 395
    csr->callid = callid;
4008 decky 396
 
3896 svoboda 397
    /*
398
     * We can forward the call only after the server we spawned connects
399
     * to us. Meanwhile we might need to service more connection requests.
400
     * Thus we store the call in a queue.
401
     */
402
    list_append(&csr->link, &cs_req);
403
}
404
 
1335 jermar 405
/** Compute hash index into NS hash table.
406
 *
1336 jermar 407
 * @param key Pointer keys. However, only the first key (i.e. service number)
4008 decky 408
 *            is used to compute the hash index.
409
 *
1336 jermar 410
 * @return Hash index corresponding to key[0].
4008 decky 411
 *
1335 jermar 412
 */
413
hash_index_t ns_hash(unsigned long *key)
414
{
415
    assert(key);
4008 decky 416
    return (*key % NS_HASH_TABLE_CHAINS);
1335 jermar 417
}
418
 
419
/** Compare a key with hashed item.
420
 *
1336 jermar 421
 * This compare function always ignores the third key.
422
 * It exists only to make it possible to remove records
423
 * originating from connection with key[1] in_phone_hash
424
 * value. Note that this is close to being classified
425
 * as a nasty hack.
426
 *
4008 decky 427
 * @param key  Array of keys.
1336 jermar 428
 * @param keys Must be lesser or equal to 3.
1335 jermar 429
 * @param item Pointer to a hash table item.
4008 decky 430
 *
1335 jermar 431
 * @return Non-zero if the key matches the item, zero otherwise.
4008 decky 432
 *
1335 jermar 433
 */
1336 jermar 434
int ns_compare(unsigned long key[], hash_count_t keys, link_t *item)
1335 jermar 435
{
436
    assert(key);
1336 jermar 437
    assert(keys <= 3);
1335 jermar 438
    assert(item);
439
 
4008 decky 440
    hashed_service_t *hs = hash_table_get_instance(item, hashed_service_t, link);
1335 jermar 441
 
1336 jermar 442
    if (keys == 2)
443
        return key[1] == hs->in_phone_hash;
444
    else
445
        return key[0] == hs->service;
1335 jermar 446
}
1336 jermar 447
 
448
/** Perform actions after removal of item from the hash table.
449
 *
450
 * @param item Item that was removed from the hash table.
4008 decky 451
 *
1336 jermar 452
 */
453
void ns_remove(link_t *item)
454
{
455
    assert(item);
456
    free(hash_table_get_instance(item, hashed_service_t, link));
457
}
1719 decky 458
 
4008 decky 459
/**
1649 cejka 460
 * @}
461
 */