Subversion Repositories HelenOS

Rev

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