Subversion Repositories HelenOS

Rev

Rev 2183 | Rev 2436 | 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>
1159 jermar 49
#include <adt/btree.h>
788 jermar 50
#include <adt/list.h>
955 palkovsky 51
#include <ipc/ipc.h>
1174 jermar 52
#include <security/cap.h>
955 palkovsky 53
#include <memstr.h>
1060 palkovsky 54
#include <print.h>
2000 decky 55
#include <lib/elf.h>
1579 jermar 56
#include <errno.h>
2050 decky 57
#include <func.h>
1288 jermar 58
#include <syscall/copy.h>
1597 palkovsky 59
#include <console/klog.h>
973 palkovsky 60
 
1170 vana 61
#ifndef LOADED_PROG_STACK_PAGES_NO
62
#define LOADED_PROG_STACK_PAGES_NO 1
63
#endif
1168 vana 64
 
1636 jermar 65
/** Spinlock protecting the tasks_btree B+tree. */
623 jermar 66
SPINLOCK_INITIALIZE(tasks_lock);
1636 jermar 67
 
68
/** B+tree of active tasks.
69
 *
2087 jermar 70
 * The task is guaranteed to exist after it was found in the tasks_btree as
71
 * long as:
1636 jermar 72
 * @li the tasks_lock is held,
2087 jermar 73
 * @li the task's lock is held when task's lock is acquired before releasing
74
 *     tasks_lock or
1880 jermar 75
 * @li the task's refcount is greater than 0
1636 jermar 76
 *
77
 */
1159 jermar 78
btree_t tasks_btree;
1636 jermar 79
 
1005 palkovsky 80
static task_id_t task_counter = 0;
1 jermar 81
 
1585 jermar 82
static void ktaskclnp(void *arg);
1661 jermar 83
static void ktaskgc(void *arg);
1579 jermar 84
 
107 decky 85
/** Initialize tasks
86
 *
87
 * Initialize kernel tasks support.
88
 *
89
 */
1 jermar 90
void task_init(void)
91
{
15 jermar 92
    TASK = NULL;
1159 jermar 93
    btree_create(&tasks_btree);
1 jermar 94
}
95
 
107 decky 96
 
97
/** Create new task
98
 *
99
 * Create new task with no threads.
100
 *
703 jermar 101
 * @param as Task's address space.
1062 jermar 102
 * @param name Symbolic name.
107 decky 103
 *
973 palkovsky 104
 * @return New task's structure
107 decky 105
 *
106
 */
1062 jermar 107
task_t *task_create(as_t *as, char *name)
1 jermar 108
{
413 jermar 109
    ipl_t ipl;
1 jermar 110
    task_t *ta;
1040 palkovsky 111
    int i;
1 jermar 112
 
822 palkovsky 113
    ta = (task_t *) malloc(sizeof(task_t), 0);
114
 
1185 jermar 115
    task_create_arch(ta);
116
 
822 palkovsky 117
    spinlock_initialize(&ta->lock, "task_ta_lock");
118
    list_initialize(&ta->th_head);
119
    ta->as = as;
1062 jermar 120
    ta->name = name;
1585 jermar 121
    ta->main_thread = NULL;
1579 jermar 122
    ta->refcount = 0;
1839 decky 123
    ta->context = CONTEXT;
1579 jermar 124
 
1174 jermar 125
    ta->capabilities = 0;
1579 jermar 126
    ta->accept_new_threads = true;
2039 decky 127
    ta->cycles = 0;
1040 palkovsky 128
 
955 palkovsky 129
    ipc_answerbox_init(&ta->answerbox);
1839 decky 130
    for (i = 0; i < IPC_MAX_PHONES; i++)
1040 palkovsky 131
        ipc_phone_init(&ta->phones[i]);
2087 jermar 132
    if ((ipc_phone_0) && (context_check(ipc_phone_0->task->context,
133
        ta->context)))
1040 palkovsky 134
        ipc_phone_connect(&ta->phones[0], ipc_phone_0);
998 palkovsky 135
    atomic_set(&ta->active_calls, 0);
1460 jermar 136
 
137
    mutex_initialize(&ta->futexes_lock);
138
    btree_create(&ta->futexes);
822 palkovsky 139
 
140
    ipl = interrupts_disable();
1468 jermar 141
 
142
    /*
143
     * Increment address space reference count.
144
     */
2183 jermar 145
    atomic_inc(&as->refcount);
1468 jermar 146
 
822 palkovsky 147
    spinlock_lock(&tasks_lock);
1005 palkovsky 148
 
149
    ta->taskid = ++task_counter;
1177 jermar 150
    btree_insert(&tasks_btree, (btree_key_t) ta->taskid, (void *) ta, NULL);
1005 palkovsky 151
 
822 palkovsky 152
    spinlock_unlock(&tasks_lock);
153
    interrupts_restore(ipl);
154
 
1 jermar 155
    return ta;
156
}
157
 
1579 jermar 158
/** Destroy task.
159
 *
160
 * @param t Task to be destroyed.
161
 */
162
void task_destroy(task_t *t)
163
{
1587 jermar 164
    task_destroy_arch(t);
165
    btree_destroy(&t->futexes);
166
 
2183 jermar 167
    if (atomic_predec(&t->as->refcount) == 0)
1587 jermar 168
        as_destroy(t->as);
169
 
170
    free(t);
171
    TASK = NULL;
1579 jermar 172
}
173
 
973 palkovsky 174
/** Create new task with 1 thread and run it
175
 *
1248 jermar 176
 * @param program_addr Address of program executable image.
1062 jermar 177
 * @param name Program name.
178
 *
1229 jermar 179
 * @return Task of the running program or NULL on error.
973 palkovsky 180
 */
1062 jermar 181
task_t * task_run_program(void *program_addr, char *name)
973 palkovsky 182
{
183
    as_t *as;
184
    as_area_t *a;
185
    int rc;
1585 jermar 186
    thread_t *t1, *t2;
973 palkovsky 187
    task_t *task;
1078 jermar 188
    uspace_arg_t *kernel_uarg;
973 palkovsky 189
 
190
    as = as_create(0);
1115 jermar 191
    ASSERT(as);
973 palkovsky 192
 
1025 palkovsky 193
    rc = elf_load((elf_header_t *) program_addr, as);
973 palkovsky 194
    if (rc != EE_OK) {
1468 jermar 195
        as_destroy(as);
973 palkovsky 196
        return NULL;
197
    }
198
 
1078 jermar 199
    kernel_uarg = (uspace_arg_t *) malloc(sizeof(uspace_arg_t), 0);
2087 jermar 200
    kernel_uarg->uspace_entry =
201
        (void *) ((elf_header_t *) program_addr)->e_entry;
1078 jermar 202
    kernel_uarg->uspace_stack = (void *) USTACK_ADDRESS;
203
    kernel_uarg->uspace_thread_function = NULL;
204
    kernel_uarg->uspace_thread_arg = NULL;
205
    kernel_uarg->uspace_uarg = NULL;
1066 jermar 206
 
1062 jermar 207
    task = task_create(as, name);
1115 jermar 208
    ASSERT(task);
209
 
973 palkovsky 210
    /*
211
     * Create the data as_area.
212
     */
2087 jermar 213
    a = as_area_create(as, AS_AREA_READ | AS_AREA_WRITE | AS_AREA_CACHEABLE,
214
        LOADED_PROG_STACK_PAGES_NO * PAGE_SIZE, USTACK_ADDRESS,
215
        AS_AREA_ATTR_NONE, &anon_backend, NULL);
1115 jermar 216
 
1585 jermar 217
    /*
218
     * Create the main thread.
219
     */
2087 jermar 220
    t1 = thread_create(uinit, kernel_uarg, task, THREAD_FLAG_USPACE,
221
        "uinit", false);
1585 jermar 222
    ASSERT(t1);
973 palkovsky 223
 
1585 jermar 224
    /*
225
     * Create killer thread for the new task.
226
     */
2042 decky 227
    t2 = thread_create(ktaskgc, t1, task, 0, "ktaskgc", true);
1585 jermar 228
    ASSERT(t2);
229
    thread_ready(t2);
230
 
231
    thread_ready(t1);
232
 
973 palkovsky 233
    return task;
234
}
1060 palkovsky 235
 
1176 jermar 236
/** Syscall for reading task ID from userspace.
237
 *
2087 jermar 238
 * @param uspace_task_id Userspace address of 8-byte buffer where to store
239
 * current task ID.
1176 jermar 240
 *
1288 jermar 241
 * @return 0 on success or an error code from @ref errno.h.
1176 jermar 242
 */
1780 jermar 243
unative_t sys_task_get_id(task_id_t *uspace_task_id)
1176 jermar 244
{
245
    /*
246
     * No need to acquire lock on TASK because taskid
247
     * remains constant for the lifespan of the task.
248
     */
2087 jermar 249
    return (unative_t) copy_to_uspace(uspace_task_id, &TASK->taskid,
250
        sizeof(TASK->taskid));
1176 jermar 251
}
252
 
1178 jermar 253
/** Find task structure corresponding to task ID.
254
 *
255
 * The tasks_lock must be already held by the caller of this function
256
 * and interrupts must be disabled.
257
 *
258
 * @param id Task ID.
259
 *
260
 * @return Task structure address or NULL if there is no such task ID.
261
 */
262
task_t *task_find_by_id(task_id_t id)
263
{
264
    btree_node_t *leaf;
265
 
266
    return (task_t *) btree_search(&tasks_btree, (btree_key_t) id, &leaf);
267
}
268
 
2039 decky 269
/** Get accounting data of given task.
270
 *
2048 jermar 271
 * Note that task lock of 't' must be already held and
2039 decky 272
 * interrupts must be already disabled.
273
 *
274
 * @param t Pointer to thread.
275
 *
276
 */
277
uint64_t task_get_accounting(task_t *t)
278
{
279
    /* Accumulated value of task */
280
    uint64_t ret = t->cycles;
281
 
282
    /* Current values of threads */
283
    link_t *cur;
284
    for (cur = t->th_head.next; cur != &t->th_head; cur = cur->next) {
285
        thread_t *thr = list_get_instance(cur, thread_t, th_link);
286
 
287
        spinlock_lock(&thr->lock);
2042 decky 288
        /* Process only counted threads */
289
        if (!thr->uncounted) {
2087 jermar 290
            if (thr == THREAD) {
291
                /* Update accounting of current thread */
292
                thread_update_accounting();
293
            }
2042 decky 294
            ret += thr->cycles;
295
        }
2039 decky 296
        spinlock_unlock(&thr->lock);
297
    }
298
 
299
    return ret;
300
}
301
 
1579 jermar 302
/** Kill task.
303
 *
304
 * @param id ID of the task to be killed.
305
 *
306
 * @return 0 on success or an error code from errno.h
307
 */
308
int task_kill(task_id_t id)
309
{
310
    ipl_t ipl;
311
    task_t *ta;
312
    thread_t *t;
313
    link_t *cur;
1600 jermar 314
 
315
    if (id == 1)
316
        return EPERM;
1579 jermar 317
 
318
    ipl = interrupts_disable();
319
    spinlock_lock(&tasks_lock);
320
 
321
    if (!(ta = task_find_by_id(id))) {
322
        spinlock_unlock(&tasks_lock);
323
        interrupts_restore(ipl);
324
        return ENOENT;
325
    }
1588 jermar 326
 
1579 jermar 327
    spinlock_lock(&ta->lock);
328
    ta->refcount++;
329
    spinlock_unlock(&ta->lock);
1587 jermar 330
 
1588 jermar 331
    btree_remove(&tasks_btree, ta->taskid, NULL);
1587 jermar 332
    spinlock_unlock(&tasks_lock);
1579 jermar 333
 
2042 decky 334
    t = thread_create(ktaskclnp, NULL, ta, 0, "ktaskclnp", true);
1579 jermar 335
 
336
    spinlock_lock(&ta->lock);
1580 jermar 337
    ta->accept_new_threads = false;
1579 jermar 338
    ta->refcount--;
1585 jermar 339
 
340
    /*
1687 jermar 341
     * Interrupt all threads except ktaskclnp.
1585 jermar 342
     */
1579 jermar 343
    for (cur = ta->th_head.next; cur != &ta->th_head; cur = cur->next) {
344
        thread_t *thr;
345
        bool  sleeping = false;
346
 
347
        thr = list_get_instance(cur, thread_t, th_link);
348
        if (thr == t)
349
            continue;
350
 
351
        spinlock_lock(&thr->lock);
352
        thr->interrupted = true;
353
        if (thr->state == Sleeping)
354
            sleeping = true;
355
        spinlock_unlock(&thr->lock);
356
 
357
        if (sleeping)
2109 jermar 358
            waitq_interrupt_sleep(thr);
1579 jermar 359
    }
360
 
1580 jermar 361
    spinlock_unlock(&ta->lock);
362
    interrupts_restore(ipl);
1579 jermar 363
 
1580 jermar 364
    if (t)
365
        thread_ready(t);
366
 
1579 jermar 367
    return 0;
368
}
369
 
1060 palkovsky 370
/** Print task list */
371
void task_print_list(void)
372
{
373
    link_t *cur;
374
    ipl_t ipl;
375
 
376
    /* Messing with thread structures, avoid deadlock */
377
    ipl = interrupts_disable();
378
    spinlock_lock(&tasks_lock);
2035 decky 379
 
2087 jermar 380
    printf("taskid name       ctx address    as         cycles     threads "
381
        "calls  callee\n");
382
    printf("------ ---------- --- ---------- ---------- ---------- ------- "        "------ ------>\n");
1060 palkovsky 383
 
2087 jermar 384
    for (cur = tasks_btree.leaf_head.next; cur != &tasks_btree.leaf_head;
385
        cur = cur->next) {
1159 jermar 386
        btree_node_t *node;
2118 decky 387
        unsigned int i;
1159 jermar 388
 
389
        node = list_get_instance(cur, btree_node_t, leaf_link);
390
        for (i = 0; i < node->keys; i++) {
391
            task_t *t;
392
            int j;
393
 
394
            t = (task_t *) node->value[i];
395
 
396
            spinlock_lock(&t->lock);
2039 decky 397
 
2050 decky 398
            uint64_t cycles;
2039 decky 399
            char suffix;
2050 decky 400
            order(task_get_accounting(t), &cycles, &suffix);
2039 decky 401
 
2216 decky 402
            printf("%-6llu %-10s %-3ld %#10zx %#10zx %9llu%c %7zd "
2087 jermar 403
                "%6zd", t->taskid, t->name, t->context, t, t->as,
404
                cycles, suffix, t->refcount,
405
                atomic_get(&t->active_calls));
2035 decky 406
            for (j = 0; j < IPC_MAX_PHONES; j++) {
1159 jermar 407
                if (t->phones[j].callee)
2087 jermar 408
                    printf(" %zd:%#zx", j,
409
                        t->phones[j].callee);
1159 jermar 410
            }
411
            printf("\n");
2039 decky 412
 
1159 jermar 413
            spinlock_unlock(&t->lock);
1060 palkovsky 414
        }
415
    }
416
 
417
    spinlock_unlock(&tasks_lock);
418
    interrupts_restore(ipl);
419
}
1579 jermar 420
 
1585 jermar 421
/** Kernel thread used to cleanup the task after it is killed. */
1580 jermar 422
void ktaskclnp(void *arg)
1579 jermar 423
{
1580 jermar 424
    ipl_t ipl;
1585 jermar 425
    thread_t *t = NULL, *main_thread;
1580 jermar 426
    link_t *cur;
1661 jermar 427
    bool again;
1580 jermar 428
 
429
    thread_detach(THREAD);
430
 
431
loop:
432
    ipl = interrupts_disable();
433
    spinlock_lock(&TASK->lock);
434
 
1585 jermar 435
    main_thread = TASK->main_thread;
436
 
1579 jermar 437
    /*
1580 jermar 438
     * Find a thread to join.
439
     */
1661 jermar 440
    again = false;
1580 jermar 441
    for (cur = TASK->th_head.next; cur != &TASK->th_head; cur = cur->next) {
442
        t = list_get_instance(cur, thread_t, th_link);
1661 jermar 443
 
444
        spinlock_lock(&t->lock);
445
        if (t == THREAD) {
446
            spinlock_unlock(&t->lock);
1580 jermar 447
            continue;
1661 jermar 448
        } else if (t == main_thread) {
449
            spinlock_unlock(&t->lock);
1585 jermar 450
            continue;
1661 jermar 451
        } else if (t->join_type != None) {
452
            spinlock_unlock(&t->lock);
453
            again = true;
454
            continue;
455
        } else {
456
            t->join_type = TaskClnp;
457
            spinlock_unlock(&t->lock);
458
            again = false;
1580 jermar 459
            break;
1661 jermar 460
        }
1580 jermar 461
    }
462
 
463
    spinlock_unlock(&TASK->lock);
464
    interrupts_restore(ipl);
465
 
1661 jermar 466
    if (again) {
467
        /*
468
         * Other cleanup (e.g. ktaskgc) is in progress.
469
         */
470
        scheduler();
471
        goto loop;
472
    }
473
 
1580 jermar 474
    if (t != THREAD) {
2087 jermar 475
        ASSERT(t != main_thread);   /* uninit is joined and detached
476
                         * in ktaskgc */
1580 jermar 477
        thread_join(t);
478
        thread_detach(t);
2087 jermar 479
        goto loop;          /* go for another thread */
1580 jermar 480
    }
481
 
482
    /*
483
     * Now there are no other threads in this task
484
     * and no new threads can be created.
485
     */
1880 jermar 486
 
1583 jermar 487
    ipc_cleanup();
488
    futex_cleanup();
2216 decky 489
    klog_printf("Cleanup of task %llu completed.", TASK->taskid);
1579 jermar 490
}
1585 jermar 491
 
1684 jermar 492
/** Kernel thread used to kill the userspace task when its main thread exits.
1585 jermar 493
 *
494
 * This thread waits until the main userspace thread (i.e. uninit) exits.
1661 jermar 495
 * When this happens, the task is killed. In the meantime, exited threads
496
 * are garbage collected.
1585 jermar 497
 *
498
 * @param arg Pointer to the thread structure of the task's main thread.
499
 */
1661 jermar 500
void ktaskgc(void *arg)
1585 jermar 501
{
502
    thread_t *t = (thread_t *) arg;
1661 jermar 503
loop:  
1585 jermar 504
    /*
505
     * Userspace threads cannot detach themselves,
506
     * therefore the thread pointer is guaranteed to be valid.
507
     */
2087 jermar 508
    if (thread_join_timeout(t, 1000000, SYNCH_FLAGS_NONE) ==
509
        ESYNCH_TIMEOUT) {   /* sleep uninterruptibly here! */
1661 jermar 510
        ipl_t ipl;
511
        link_t *cur;
512
        thread_t *thr = NULL;
513
 
514
        /*
2087 jermar 515
         * The join timed out. Try to do some garbage collection of
516
         * Undead threads.
1661 jermar 517
         */
518
more_gc:       
519
        ipl = interrupts_disable();
520
        spinlock_lock(&TASK->lock);
521
 
2087 jermar 522
        for (cur = TASK->th_head.next; cur != &TASK->th_head;
523
            cur = cur->next) {
1661 jermar 524
            thr = list_get_instance(cur, thread_t, th_link);
525
            spinlock_lock(&thr->lock);
2087 jermar 526
            if (thr != t && thr->state == Undead &&
527
                thr->join_type == None) {
1661 jermar 528
                thr->join_type = TaskGC;
529
                spinlock_unlock(&thr->lock);
530
                break;
531
            }
532
            spinlock_unlock(&thr->lock);
533
            thr = NULL;
534
        }
535
        spinlock_unlock(&TASK->lock);
1676 jermar 536
        interrupts_restore(ipl);
1661 jermar 537
 
538
        if (thr) {
539
            thread_join(thr);
540
            thread_detach(thr);
541
            scheduler();
542
            goto more_gc;
543
        }
544
 
545
        goto loop;
546
    }
1585 jermar 547
    thread_detach(t);
548
    task_kill(TASK->taskid);
549
}
1702 cejka 550
 
1757 jermar 551
/** @}
1702 cejka 552
 */