Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
1 jermar 1
/*
2071 jermar 2
 * Copyright (c) 2001-2004 Jakub Jermar
1 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
 
1757 jermar 29
/** @addtogroup genericproc
1702 cejka 30
 * @{
31
 */
32
 
1248 jermar 33
/**
1702 cejka 34
 * @file
1248 jermar 35
 * @brief   Task management.
36
 */
37
 
973 palkovsky 38
#include <main/uinit.h>
1 jermar 39
#include <proc/thread.h>
40
#include <proc/task.h>
1078 jermar 41
#include <proc/uarg.h>
703 jermar 42
#include <mm/as.h>
814 palkovsky 43
#include <mm/slab.h>
2183 jermar 44
#include <atomic.h>
1 jermar 45
#include <synch/spinlock.h>
2109 jermar 46
#include <synch/waitq.h>
1 jermar 47
#include <arch.h>
48
#include <panic.h>
2504 jermar 49
#include <adt/avl.h>
1159 jermar 50
#include <adt/btree.h>
788 jermar 51
#include <adt/list.h>
955 palkovsky 52
#include <ipc/ipc.h>
3004 svoboda 53
#include <ipc/ipcrsc.h>
1174 jermar 54
#include <security/cap.h>
955 palkovsky 55
#include <memstr.h>
1060 palkovsky 56
#include <print.h>
2000 decky 57
#include <lib/elf.h>
1579 jermar 58
#include <errno.h>
2050 decky 59
#include <func.h>
1288 jermar 60
#include <syscall/copy.h>
973 palkovsky 61
 
1170 vana 62
#ifndef LOADED_PROG_STACK_PAGES_NO
63
#define LOADED_PROG_STACK_PAGES_NO 1
64
#endif
1168 vana 65
 
2504 jermar 66
/** Spinlock protecting the tasks_tree AVL tree. */
623 jermar 67
SPINLOCK_INITIALIZE(tasks_lock);
1636 jermar 68
 
2504 jermar 69
/** AVL tree of active tasks.
1636 jermar 70
 *
2504 jermar 71
 * The task is guaranteed to exist after it was found in the tasks_tree as
2087 jermar 72
 * long as:
1636 jermar 73
 * @li the tasks_lock is held,
2087 jermar 74
 * @li the task's lock is held when task's lock is acquired before releasing
75
 *     tasks_lock or
1880 jermar 76
 * @li the task's refcount is greater than 0
1636 jermar 77
 *
78
 */
2504 jermar 79
avltree_t tasks_tree;
1636 jermar 80
 
1005 palkovsky 81
static task_id_t task_counter = 0;
1 jermar 82
 
3001 svoboda 83
/**
84
 * Points to the binary image used as the program loader. All non-initial
85
 * tasks are created from this executable image.
86
 */
87
void *program_loader = NULL;
88
 
89
 
107 decky 90
/** Initialize tasks
91
 *
92
 * Initialize kernel tasks support.
93
 *
94
 */
1 jermar 95
void task_init(void)
96
{
15 jermar 97
    TASK = NULL;
2504 jermar 98
    avltree_create(&tasks_tree);
1 jermar 99
}
100
 
2504 jermar 101
/*
102
 * The idea behind this walker is to remember a single task different from TASK.
103
 */
104
static bool task_done_walker(avltree_node_t *node, void *arg)
105
{
106
    task_t *t = avltree_get_instance(node, task_t, tasks_tree_node);
107
    task_t **tp = (task_t **) arg;
108
 
109
    if (t != TASK) {
110
        *tp = t;
111
        return false;   /* stop walking */
112
    }
113
 
114
    return true;    /* continue the walk */
115
}
116
 
2227 decky 117
/** Kill all tasks except the current task.
118
 *
119
 */
120
void task_done(void)
121
{
122
    task_t *t;
123
    do { /* Repeat until there are any tasks except TASK */
124
 
125
        /* Messing with task structures, avoid deadlock */
126
        ipl_t ipl = interrupts_disable();
127
        spinlock_lock(&tasks_lock);
128
 
129
        t = NULL;
2504 jermar 130
        avltree_walk(&tasks_tree, task_done_walker, &t);
2227 decky 131
 
132
        if (t != NULL) {
133
            task_id_t id = t->taskid;
134
 
135
            spinlock_unlock(&tasks_lock);
136
            interrupts_restore(ipl);
137
 
138
#ifdef CONFIG_DEBUG
139
            printf("Killing task %llu\n", id);
140
#endif          
141
            task_kill(id);
2632 decky 142
            thread_usleep(10000);
2227 decky 143
        } else {
144
            spinlock_unlock(&tasks_lock);
145
            interrupts_restore(ipl);
146
        }
147
 
148
    } while (t != NULL);
149
}
107 decky 150
 
151
/** Create new task
152
 *
153
 * Create new task with no threads.
154
 *
703 jermar 155
 * @param as Task's address space.
1062 jermar 156
 * @param name Symbolic name.
107 decky 157
 *
973 palkovsky 158
 * @return New task's structure
107 decky 159
 *
160
 */
1062 jermar 161
task_t *task_create(as_t *as, char *name)
1 jermar 162
{
413 jermar 163
    ipl_t ipl;
1 jermar 164
    task_t *ta;
1040 palkovsky 165
    int i;
1 jermar 166
 
822 palkovsky 167
    ta = (task_t *) malloc(sizeof(task_t), 0);
168
 
1185 jermar 169
    task_create_arch(ta);
170
 
822 palkovsky 171
    spinlock_initialize(&ta->lock, "task_ta_lock");
172
    list_initialize(&ta->th_head);
173
    ta->as = as;
1062 jermar 174
    ta->name = name;
2446 jermar 175
    atomic_set(&ta->refcount, 0);
176
    atomic_set(&ta->lifecount, 0);
1839 decky 177
    ta->context = CONTEXT;
1579 jermar 178
 
1174 jermar 179
    ta->capabilities = 0;
2039 decky 180
    ta->cycles = 0;
1040 palkovsky 181
 
2802 jermar 182
    ipc_answerbox_init(&ta->answerbox, ta);
1839 decky 183
    for (i = 0; i < IPC_MAX_PHONES; i++)
1040 palkovsky 184
        ipc_phone_init(&ta->phones[i]);
2087 jermar 185
    if ((ipc_phone_0) && (context_check(ipc_phone_0->task->context,
186
        ta->context)))
1040 palkovsky 187
        ipc_phone_connect(&ta->phones[0], ipc_phone_0);
998 palkovsky 188
    atomic_set(&ta->active_calls, 0);
1460 jermar 189
 
190
    mutex_initialize(&ta->futexes_lock);
191
    btree_create(&ta->futexes);
822 palkovsky 192
 
193
    ipl = interrupts_disable();
1468 jermar 194
 
195
    /*
196
     * Increment address space reference count.
197
     */
2183 jermar 198
    atomic_inc(&as->refcount);
1468 jermar 199
 
822 palkovsky 200
    spinlock_lock(&tasks_lock);
1005 palkovsky 201
    ta->taskid = ++task_counter;
2504 jermar 202
    avltree_node_initialize(&ta->tasks_tree_node);
203
    ta->tasks_tree_node.key = ta->taskid;
204
    avltree_insert(&tasks_tree, &ta->tasks_tree_node);
822 palkovsky 205
    spinlock_unlock(&tasks_lock);
206
    interrupts_restore(ipl);
207
 
1 jermar 208
    return ta;
209
}
210
 
1579 jermar 211
/** Destroy task.
212
 *
213
 * @param t Task to be destroyed.
214
 */
215
void task_destroy(task_t *t)
216
{
2446 jermar 217
    /*
218
     * Remove the task from the task B+tree.
219
     */
220
    spinlock_lock(&tasks_lock);
2504 jermar 221
    avltree_delete(&tasks_tree, &t->tasks_tree_node);
2446 jermar 222
    spinlock_unlock(&tasks_lock);
223
 
224
    /*
225
     * Perform architecture specific task destruction.
226
     */
1587 jermar 227
    task_destroy_arch(t);
2446 jermar 228
 
229
    /*
230
     * Free up dynamically allocated state.
231
     */
1587 jermar 232
    btree_destroy(&t->futexes);
233
 
2446 jermar 234
    /*
235
     * Drop our reference to the address space.
236
     */
2183 jermar 237
    if (atomic_predec(&t->as->refcount) == 0)
1587 jermar 238
        as_destroy(t->as);
239
 
240
    free(t);
241
    TASK = NULL;
1579 jermar 242
}
243
 
973 palkovsky 244
/** Create new task with 1 thread and run it
245
 *
3001 svoboda 246
 * @param as Address space containing a binary program image.
247
 * @param entry_addr Program entry-point address in program address space.
248
 * @param name Program name.
1062 jermar 249
 *
1229 jermar 250
 * @return Task of the running program or NULL on error.
973 palkovsky 251
 */
3001 svoboda 252
task_t *task_create_from_as(as_t *as, uintptr_t entry_addr, char *name)
973 palkovsky 253
{
254
    as_area_t *a;
2446 jermar 255
    thread_t *t;
973 palkovsky 256
    task_t *task;
1078 jermar 257
    uspace_arg_t *kernel_uarg;
973 palkovsky 258
 
1078 jermar 259
    kernel_uarg = (uspace_arg_t *) malloc(sizeof(uspace_arg_t), 0);
3001 svoboda 260
    kernel_uarg->uspace_entry = (void *) entry_addr;
1078 jermar 261
    kernel_uarg->uspace_stack = (void *) USTACK_ADDRESS;
262
    kernel_uarg->uspace_thread_function = NULL;
263
    kernel_uarg->uspace_thread_arg = NULL;
264
    kernel_uarg->uspace_uarg = NULL;
1066 jermar 265
 
1062 jermar 266
    task = task_create(as, name);
1115 jermar 267
    ASSERT(task);
268
 
973 palkovsky 269
    /*
270
     * Create the data as_area.
271
     */
2087 jermar 272
    a = as_area_create(as, AS_AREA_READ | AS_AREA_WRITE | AS_AREA_CACHEABLE,
273
        LOADED_PROG_STACK_PAGES_NO * PAGE_SIZE, USTACK_ADDRESS,
274
        AS_AREA_ATTR_NONE, &anon_backend, NULL);
1115 jermar 275
 
1585 jermar 276
    /*
277
     * Create the main thread.
278
     */
2446 jermar 279
    t = thread_create(uinit, kernel_uarg, task, THREAD_FLAG_USPACE,
2087 jermar 280
        "uinit", false);
2446 jermar 281
    ASSERT(t);
973 palkovsky 282
 
283
    return task;
284
}
1060 palkovsky 285
 
3001 svoboda 286
/** Parse an executable image in the physical memory.
287
 *
288
 * If the image belongs to a program loader, it is registered as such,
289
 * (and *task is set to NULL). Otherwise a task is created from the
290
 * executable image. The task is returned in *task.
291
 *
292
 * @param program_addr Address of program executable image.
293
 * @param name Program name.
294
 * @param task Where to store the pointer to the newly created task.
295
 *
296
 * @return EOK on success or negative error code.
297
 */
298
int task_parse_initial(void *program_addr, char *name, task_t **task)
299
{
300
    as_t *as;
301
    unsigned int rc;
302
 
303
    as = as_create(0);
304
    ASSERT(as);
305
 
306
    rc = elf_load((elf_header_t *) program_addr, as, 0);
307
    if (rc != EE_OK) {
308
        as_destroy(as);
309
        *task = NULL;
310
        if (rc != EE_LOADER)
311
            return ENOTSUP;
312
 
313
        /* Register image as the program loader */
314
        ASSERT(program_loader == NULL);
315
        program_loader = program_addr;
316
        return EOK;
317
    }
318
 
319
    *task = task_create_from_as(as, ((elf_header_t *) program_addr)->e_entry,
320
        name);
321
 
322
    return EOK;
323
}
324
 
325
/** Create a task from the program loader image.
326
 *
327
 * @param name Program name.
3004 svoboda 328
 * @param t Buffer for storing pointer to the newly created task.
3001 svoboda 329
 *
330
 * @return Task of the running program or NULL on error.
331
 */
3004 svoboda 332
int task_create_from_loader(char *name, task_t **t)
3001 svoboda 333
{
334
    as_t *as;
335
    unsigned int rc;
3004 svoboda 336
    void *loader;
3001 svoboda 337
 
338
    as = as_create(0);
339
    ASSERT(as);
340
 
3004 svoboda 341
    loader = program_loader;
342
    if (!loader) return ENOENT;
343
 
3001 svoboda 344
    rc = elf_load((elf_header_t *) program_loader, as, ELD_F_LOADER);
345
    if (rc != EE_OK) {
346
        as_destroy(as);
3004 svoboda 347
        return ENOENT;
3001 svoboda 348
    }
349
 
3004 svoboda 350
    *t = task_create_from_as(
3001 svoboda 351
        as, ((elf_header_t *) program_loader)->e_entry, name); 
3004 svoboda 352
 
353
    return EOK;
3001 svoboda 354
}
355
 
356
/** Make task ready.
357
 *
358
 * Switch task's thread to the ready state.
359
 *
360
 * @param ta Task to make ready.
361
 */
362
void task_ready(task_t *t)
363
{
364
    thread_t *th;
365
 
366
    th = list_get_instance(t->th_head.next, thread_t, th_link);
367
    thread_ready(th);
368
}
369
 
1176 jermar 370
/** Syscall for reading task ID from userspace.
371
 *
2087 jermar 372
 * @param uspace_task_id Userspace address of 8-byte buffer where to store
373
 * current task ID.
1176 jermar 374
 *
1288 jermar 375
 * @return 0 on success or an error code from @ref errno.h.
1176 jermar 376
 */
1780 jermar 377
unative_t sys_task_get_id(task_id_t *uspace_task_id)
1176 jermar 378
{
379
    /*
380
     * No need to acquire lock on TASK because taskid
381
     * remains constant for the lifespan of the task.
382
     */
2087 jermar 383
    return (unative_t) copy_to_uspace(uspace_task_id, &TASK->taskid,
384
        sizeof(TASK->taskid));
1176 jermar 385
}
386
 
3001 svoboda 387
/** Syscall for creating a new task from userspace.
388
 *
3004 svoboda 389
 * Creates a new task from the program loader image, connects a phone
390
 * to it and stores the phone id into the provided buffer.
3001 svoboda 391
 *
3004 svoboda 392
 * @param uspace_phone_id Userspace address where to store the phone id.
3001 svoboda 393
 *
394
 * @return 0 on success or an error code from @ref errno.h.
395
 */
3004 svoboda 396
unative_t sys_task_spawn(int *uspace_phone_id)
3001 svoboda 397
{
398
    task_t *t;
3004 svoboda 399
    int fake_id;
3001 svoboda 400
    int rc;
3004 svoboda 401
    int phone_id;
3001 svoboda 402
 
3004 svoboda 403
    fake_id = 0;
404
 
3001 svoboda 405
    /* Before we even try creating the task, see if we can write the id */
3004 svoboda 406
    rc = (unative_t) copy_to_uspace(uspace_phone_id, &fake_id,
3001 svoboda 407
        sizeof(fake_id));
408
    if (rc != 0)
409
        return rc;
410
 
3004 svoboda 411
    phone_id = phone_alloc();
412
    if (phone_id < 0)
413
        return ELIMIT;
3001 svoboda 414
 
3004 svoboda 415
    rc = task_create_from_loader("loader", &t);
416
    if (rc != 0)
417
        return rc;
418
 
419
    phone_connect(phone_id, &t->answerbox);
420
 
3001 svoboda 421
    /* No need to aquire lock before task_ready() */
3004 svoboda 422
    rc = (unative_t) copy_to_uspace(uspace_phone_id, &phone_id,
423
        sizeof(phone_id));
3001 svoboda 424
    if (rc != 0) {
425
        /* Ooops */
3004 svoboda 426
        ipc_phone_hangup(&TASK->phones[phone_id]);
3001 svoboda 427
        task_kill(t->taskid);
428
        return rc;
429
    }
430
 
431
    task_ready(t);
432
 
433
    return EOK;
434
}
435
 
1178 jermar 436
/** Find task structure corresponding to task ID.
437
 *
438
 * The tasks_lock must be already held by the caller of this function
439
 * and interrupts must be disabled.
440
 *
441
 * @param id Task ID.
442
 *
443
 * @return Task structure address or NULL if there is no such task ID.
444
 */
445
task_t *task_find_by_id(task_id_t id)
446
{
2504 jermar 447
    avltree_node_t *node;
1178 jermar 448
 
2504 jermar 449
    node = avltree_search(&tasks_tree, (avltree_key_t) id);
450
 
451
    if (node)
452
        return avltree_get_instance(node, task_t, tasks_tree_node);
453
    return NULL;
1178 jermar 454
}
455
 
2039 decky 456
/** Get accounting data of given task.
457
 *
2048 jermar 458
 * Note that task lock of 't' must be already held and
2039 decky 459
 * interrupts must be already disabled.
460
 *
461
 * @param t Pointer to thread.
462
 *
463
 */
464
uint64_t task_get_accounting(task_t *t)
465
{
466
    /* Accumulated value of task */
467
    uint64_t ret = t->cycles;
468
 
469
    /* Current values of threads */
470
    link_t *cur;
471
    for (cur = t->th_head.next; cur != &t->th_head; cur = cur->next) {
472
        thread_t *thr = list_get_instance(cur, thread_t, th_link);
473
 
474
        spinlock_lock(&thr->lock);
2042 decky 475
        /* Process only counted threads */
476
        if (!thr->uncounted) {
2087 jermar 477
            if (thr == THREAD) {
478
                /* Update accounting of current thread */
479
                thread_update_accounting();
480
            }
2042 decky 481
            ret += thr->cycles;
482
        }
2039 decky 483
        spinlock_unlock(&thr->lock);
484
    }
485
 
486
    return ret;
487
}
488
 
1579 jermar 489
/** Kill task.
490
 *
2446 jermar 491
 * This function is idempotent.
492
 * It signals all the task's threads to bail it out.
493
 *
1579 jermar 494
 * @param id ID of the task to be killed.
495
 *
496
 * @return 0 on success or an error code from errno.h
497
 */
498
int task_kill(task_id_t id)
499
{
500
    ipl_t ipl;
501
    task_t *ta;
502
    link_t *cur;
1600 jermar 503
 
504
    if (id == 1)
505
        return EPERM;
1579 jermar 506
 
507
    ipl = interrupts_disable();
508
    spinlock_lock(&tasks_lock);
509
    if (!(ta = task_find_by_id(id))) {
510
        spinlock_unlock(&tasks_lock);
511
        interrupts_restore(ipl);
512
        return ENOENT;
513
    }
1587 jermar 514
    spinlock_unlock(&tasks_lock);
1579 jermar 515
 
1585 jermar 516
    /*
1687 jermar 517
     * Interrupt all threads except ktaskclnp.
2446 jermar 518
     */
519
    spinlock_lock(&ta->lock);
1579 jermar 520
    for (cur = ta->th_head.next; cur != &ta->th_head; cur = cur->next) {
521
        thread_t *thr;
2446 jermar 522
        bool sleeping = false;
1579 jermar 523
 
524
        thr = list_get_instance(cur, thread_t, th_link);
525
 
526
        spinlock_lock(&thr->lock);
527
        thr->interrupted = true;
528
        if (thr->state == Sleeping)
529
            sleeping = true;
530
        spinlock_unlock(&thr->lock);
531
 
532
        if (sleeping)
2109 jermar 533
            waitq_interrupt_sleep(thr);
1579 jermar 534
    }
1580 jermar 535
    spinlock_unlock(&ta->lock);
536
    interrupts_restore(ipl);
1579 jermar 537
 
538
    return 0;
539
}
540
 
2504 jermar 541
static bool task_print_walker(avltree_node_t *node, void *arg)
542
{
543
    task_t *t = avltree_get_instance(node, task_t, tasks_tree_node);
544
    int j;
545
 
546
    spinlock_lock(&t->lock);
547
 
548
    uint64_t cycles;
549
    char suffix;
550
    order(task_get_accounting(t), &cycles, &suffix);
2712 decky 551
 
552
    if (sizeof(void *) == 4)
553
        printf("%-6llu %-10s %-3ld %#10zx %#10zx %9llu%c %7zd %6zd",
554
            t->taskid, t->name, t->context, t, t->as, cycles, suffix,
555
            t->refcount, atomic_get(&t->active_calls));
556
    else
557
        printf("%-6llu %-10s %-3ld %#18zx %#18zx %9llu%c %7zd %6zd",
558
            t->taskid, t->name, t->context, t, t->as, cycles, suffix,
559
            t->refcount, atomic_get(&t->active_calls));
2504 jermar 560
    for (j = 0; j < IPC_MAX_PHONES; j++) {
561
        if (t->phones[j].callee)
562
            printf(" %zd:%#zx", j, t->phones[j].callee);
563
    }
564
    printf("\n");
565
 
566
    spinlock_unlock(&t->lock);
567
    return true;
568
}
569
 
1060 palkovsky 570
/** Print task list */
571
void task_print_list(void)
572
{
573
    ipl_t ipl;
574
 
2227 decky 575
    /* Messing with task structures, avoid deadlock */
1060 palkovsky 576
    ipl = interrupts_disable();
577
    spinlock_lock(&tasks_lock);
2035 decky 578
 
2712 decky 579
    if (sizeof(void *) == 4) {
580
        printf("taskid name       ctx address    as         "
581
            "cycles     threads calls  callee\n");
582
        printf("------ ---------- --- ---------- ---------- "
583
            "---------- ------- ------ ------>\n");
584
    } else {
585
        printf("taskid name       ctx address            as                 "
586
            "cycles     threads calls  callee\n");
587
        printf("------ ---------- --- ------------------ ------------------ "
588
            "---------- ------- ------ ------>\n");
589
    }
1060 palkovsky 590
 
2504 jermar 591
    avltree_walk(&tasks_tree, task_print_walker, NULL);
1159 jermar 592
 
1060 palkovsky 593
    spinlock_unlock(&tasks_lock);
594
    interrupts_restore(ipl);
595
}
1579 jermar 596
 
1757 jermar 597
/** @}
1702 cejka 598
 */