Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
1 jermar 1
/*
2
 * Copyright (C) 2001-2004 Jakub 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   Thread management functions.
36
 */
37
 
1 jermar 38
#include <proc/scheduler.h>
39
#include <proc/thread.h>
40
#include <proc/task.h>
1078 jermar 41
#include <proc/uarg.h>
1 jermar 42
#include <mm/frame.h>
43
#include <mm/page.h>
44
#include <arch/asm.h>
45
#include <arch.h>
46
#include <synch/synch.h>
47
#include <synch/spinlock.h>
48
#include <synch/waitq.h>
49
#include <synch/rwlock.h>
50
#include <cpu.h>
51
#include <func.h>
52
#include <context.h>
1158 jermar 53
#include <adt/btree.h>
788 jermar 54
#include <adt/list.h>
1 jermar 55
#include <typedefs.h>
56
#include <time/clock.h>
7 jermar 57
#include <config.h>
58
#include <arch/interrupt.h>
10 jermar 59
#include <smp/ipi.h>
76 jermar 60
#include <arch/faddr.h>
1104 jermar 61
#include <atomic.h>
195 vana 62
#include <memstr.h>
777 palkovsky 63
#include <print.h>
787 palkovsky 64
#include <mm/slab.h>
65
#include <debug.h>
1066 jermar 66
#include <main/uinit.h>
1288 jermar 67
#include <syscall/copy.h>
68
#include <errno.h>
7 jermar 69
 
1 jermar 70
 
1571 jermar 71
/** Thread states */
72
char *thread_states[] = {
73
    "Invalid",
74
    "Running",
75
    "Sleeping",
76
    "Ready",
77
    "Entering",
78
    "Exiting",
79
    "Undead"
80
};
81
 
1636 jermar 82
/** Lock protecting the threads_btree B+tree. For locking rules, see declaration thereof. */
1158 jermar 83
SPINLOCK_INITIALIZE(threads_lock);
1 jermar 84
 
1636 jermar 85
/** B+tree of all threads.
86
 *
87
 * When a thread is found in the threads_btree B+tree, it is guaranteed to exist as long
88
 * as the threads_lock is held.
89
 */
90
btree_t threads_btree;     
91
 
623 jermar 92
SPINLOCK_INITIALIZE(tidlock);
1780 jermar 93
uint32_t last_tid = 0;
1 jermar 94
 
787 palkovsky 95
static slab_cache_t *thread_slab;
906 palkovsky 96
#ifdef ARCH_HAS_FPU
97
slab_cache_t *fpu_context_slab;
98
#endif
107 decky 99
 
100
/** Thread wrapper
101
 *
102
 * This wrapper is provided to ensure that every thread
1 jermar 103
 * makes a call to thread_exit() when its implementing
104
 * function returns.
105
 *
413 jermar 106
 * interrupts_disable() is assumed.
107 decky 107
 *
1 jermar 108
 */
452 decky 109
static void cushion(void)
1 jermar 110
{
15 jermar 111
    void (*f)(void *) = THREAD->thread_code;
112
    void *arg = THREAD->thread_arg;
1 jermar 113
 
213 jermar 114
    /* this is where each thread wakes up after its creation */
15 jermar 115
    spinlock_unlock(&THREAD->lock);
413 jermar 116
    interrupts_enable();
1 jermar 117
 
118
    f(arg);
119
    thread_exit();
120
    /* not reached */
121
}
122
 
787 palkovsky 123
/** Initialization and allocation for thread_t structure */
124
static int thr_constructor(void *obj, int kmflags)
125
{
126
    thread_t *t = (thread_t *)obj;
107 decky 127
 
787 palkovsky 128
    spinlock_initialize(&t->lock, "thread_t_lock");
129
    link_initialize(&t->rq_link);
130
    link_initialize(&t->wq_link);
131
    link_initialize(&t->th_link);
132
 
906 palkovsky 133
#ifdef ARCH_HAS_FPU
134
#  ifdef CONFIG_FPU_LAZY
135
    t->saved_fpu_context = NULL;
136
#  else
137
    t->saved_fpu_context = slab_alloc(fpu_context_slab,kmflags);
138
    if (!t->saved_fpu_context)
139
        return -1;
140
#  endif
141
#endif  
142
 
1766 palkovsky 143
    t->kstack = frame_alloc(STACK_FRAMES, FRAME_KA | kmflags);
144
    if (! t->kstack) {
906 palkovsky 145
#ifdef ARCH_HAS_FPU
146
        if (t->saved_fpu_context)
147
            slab_free(fpu_context_slab,t->saved_fpu_context);
148
#endif
842 palkovsky 149
        return -1;
906 palkovsky 150
    }
787 palkovsky 151
 
152
    return 0;
153
}
154
 
155
/** Destruction of thread_t object */
156
static int thr_destructor(void *obj)
157
{
158
    thread_t *t = (thread_t *)obj;
159
 
1760 palkovsky 160
    frame_free(KA2PA(t->kstack));
906 palkovsky 161
#ifdef ARCH_HAS_FPU
162
    if (t->saved_fpu_context)
163
        slab_free(fpu_context_slab,t->saved_fpu_context);
164
#endif
787 palkovsky 165
    return 1; /* One page freed */
166
}
167
 
107 decky 168
/** Initialize threads
169
 *
170
 * Initialize kernel threads support.
171
 *
172
 */
1 jermar 173
void thread_init(void)
174
{
15 jermar 175
    THREAD = NULL;
625 palkovsky 176
    atomic_set(&nrdy,0);
787 palkovsky 177
    thread_slab = slab_cache_create("thread_slab",
178
                    sizeof(thread_t),0,
179
                    thr_constructor, thr_destructor, 0);
906 palkovsky 180
#ifdef ARCH_HAS_FPU
181
    fpu_context_slab = slab_cache_create("fpu_slab",
182
                         sizeof(fpu_context_t),
183
                         FPU_CONTEXT_ALIGN,
184
                         NULL, NULL, 0);
185
#endif
1158 jermar 186
 
187
    btree_create(&threads_btree);
1 jermar 188
}
189
 
107 decky 190
/** Make thread ready
191
 *
192
 * Switch thread t to the ready state.
193
 *
194
 * @param t Thread to make ready.
195
 *
196
 */
1 jermar 197
void thread_ready(thread_t *t)
198
{
199
    cpu_t *cpu;
200
    runq_t *r;
413 jermar 201
    ipl_t ipl;
625 palkovsky 202
    int i, avg;
1 jermar 203
 
413 jermar 204
    ipl = interrupts_disable();
1 jermar 205
 
206
    spinlock_lock(&t->lock);
207
 
1086 palkovsky 208
    ASSERT(! (t->state == Ready));
209
 
413 jermar 210
    i = (t->priority < RQ_COUNT -1) ? ++t->priority : t->priority;
1 jermar 211
 
16 jermar 212
    cpu = CPU;
1 jermar 213
    if (t->flags & X_WIRED) {
214
        cpu = t->cpu;
215
    }
1083 palkovsky 216
    t->state = Ready;
1 jermar 217
    spinlock_unlock(&t->lock);
218
 
107 decky 219
    /*
1 jermar 220
     * Append t to respective ready queue on respective processor.
221
     */
222
    r = &cpu->rq[i];
223
    spinlock_lock(&r->lock);
224
    list_append(&t->rq_link, &r->rq_head);
225
    r->n++;
226
    spinlock_unlock(&r->lock);
227
 
475 jermar 228
    atomic_inc(&nrdy);
625 palkovsky 229
    avg = atomic_get(&nrdy) / config.cpu_active;
783 palkovsky 230
    atomic_inc(&cpu->nrdy);
1 jermar 231
 
413 jermar 232
    interrupts_restore(ipl);
1 jermar 233
}
234
 
787 palkovsky 235
/** Destroy thread memory structure
236
 *
237
 * Detach thread from all queues, cpus etc. and destroy it.
238
 *
239
 * Assume thread->lock is held!!
240
 */
241
void thread_destroy(thread_t *t)
242
{
1579 jermar 243
    bool destroy_task = false; 
244
 
1581 jermar 245
    ASSERT(t->state == Exiting || t->state == Undead);
787 palkovsky 246
    ASSERT(t->task);
247
    ASSERT(t->cpu);
248
 
249
    spinlock_lock(&t->cpu->lock);
250
    if(t->cpu->fpu_owner==t)
251
        t->cpu->fpu_owner=NULL;
252
    spinlock_unlock(&t->cpu->lock);
253
 
1579 jermar 254
    spinlock_unlock(&t->lock);
255
 
256
    spinlock_lock(&threads_lock);
1780 jermar 257
    btree_remove(&threads_btree, (btree_key_t) ((uintptr_t ) t), NULL);
1579 jermar 258
    spinlock_unlock(&threads_lock);
259
 
787 palkovsky 260
    /*
261
     * Detach from the containing task.
262
     */
263
    spinlock_lock(&t->task->lock);
264
    list_remove(&t->th_link);
1579 jermar 265
    if (--t->task->refcount == 0) {
266
        t->task->accept_new_threads = false;
267
        destroy_task = true;
268
    }
269
    spinlock_unlock(&t->task->lock);   
787 palkovsky 270
 
1579 jermar 271
    if (destroy_task)
272
        task_destroy(t->task);
787 palkovsky 273
 
274
    slab_free(thread_slab, t);
275
}
276
 
107 decky 277
/** Create new thread
278
 *
279
 * Create a new thread.
280
 *
281
 * @param func  Thread's implementing function.
282
 * @param arg   Thread's implementing function argument.
283
 * @param task  Task to which the thread belongs.
284
 * @param flags Thread flags.
1062 jermar 285
 * @param name  Symbolic name.
107 decky 286
 *
287
 * @return New thread's structure on success, NULL on failure.
288
 *
289
 */
1062 jermar 290
thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name)
1 jermar 291
{
292
    thread_t *t;
822 palkovsky 293
    ipl_t ipl;
294
 
787 palkovsky 295
    t = (thread_t *) slab_alloc(thread_slab, 0);
842 palkovsky 296
    if (!t)
297
        return NULL;
1171 jermar 298
 
299
    thread_create_arch(t);
1 jermar 300
 
822 palkovsky 301
    /* Not needed, but good for debugging */
1780 jermar 302
    memsetb((uintptr_t)t->kstack, THREAD_STACK_SIZE * 1<<STACK_FRAMES, 0);
822 palkovsky 303
 
304
    ipl = interrupts_disable();
305
    spinlock_lock(&tidlock);
306
    t->tid = ++last_tid;
307
    spinlock_unlock(&tidlock);
308
    interrupts_restore(ipl);
309
 
310
    context_save(&t->saved_context);
1780 jermar 311
    context_set(&t->saved_context, FADDR(cushion), (uintptr_t) t->kstack, THREAD_STACK_SIZE);
822 palkovsky 312
 
313
    the_initialize((the_t *) t->kstack);
314
 
315
    ipl = interrupts_disable();
316
    t->saved_context.ipl = interrupts_read();
317
    interrupts_restore(ipl);
318
 
1066 jermar 319
    memcpy(t->name, name, THREAD_NAME_BUFLEN);
320
 
822 palkovsky 321
    t->thread_code = func;
322
    t->thread_arg = arg;
323
    t->ticks = -1;
324
    t->priority = -1;       /* start in rq[0] */
325
    t->cpu = NULL;
326
    t->flags = 0;
327
    t->state = Entering;
328
    t->call_me = NULL;
329
    t->call_me_with = NULL;
330
 
331
    timeout_initialize(&t->sleep_timeout);
1502 jermar 332
    t->sleep_interruptible = false;
822 palkovsky 333
    t->sleep_queue = NULL;
334
    t->timeout_pending = 0;
1288 jermar 335
 
336
    t->in_copy_from_uspace = false;
337
    t->in_copy_to_uspace = false;
1579 jermar 338
 
339
    t->interrupted = false;
1661 jermar 340
    t->join_type = None;
1571 jermar 341
    t->detached = false;
342
    waitq_initialize(&t->join_wq);
343
 
822 palkovsky 344
    t->rwlock_holder_type = RWLOCK_NONE;
210 decky 345
 
822 palkovsky 346
    t->task = task;
347
 
860 decky 348
    t->fpu_context_exists = 0;
349
    t->fpu_context_engaged = 0;
822 palkovsky 350
 
351
    /*
1579 jermar 352
     * Attach to the containing task.
353
     */
1687 jermar 354
    ipl = interrupts_disable();  
1579 jermar 355
    spinlock_lock(&task->lock);
356
    if (!task->accept_new_threads) {
357
        spinlock_unlock(&task->lock);
358
        slab_free(thread_slab, t);
1687 jermar 359
        interrupts_restore(ipl);
1579 jermar 360
        return NULL;
361
    }
362
    list_append(&t->th_link, &task->th_head);
1585 jermar 363
    if (task->refcount++ == 0)
364
        task->main_thread = t;
1579 jermar 365
    spinlock_unlock(&task->lock);
366
 
367
    /*
822 palkovsky 368
     * Register this thread in the system-wide list.
369
     */
370
    spinlock_lock(&threads_lock);
1780 jermar 371
    btree_insert(&threads_btree, (btree_key_t) ((uintptr_t) t), (void *) t, NULL);
822 palkovsky 372
    spinlock_unlock(&threads_lock);
373
 
374
    interrupts_restore(ipl);
860 decky 375
 
1 jermar 376
    return t;
377
}
378
 
1687 jermar 379
/** Terminate thread.
107 decky 380
 *
381
 * End current thread execution and switch it to the exiting
382
 * state. All pending timeouts are executed.
383
 *
384
 */
1 jermar 385
void thread_exit(void)
386
{
413 jermar 387
    ipl_t ipl;
1 jermar 388
 
389
restart:
413 jermar 390
    ipl = interrupts_disable();
15 jermar 391
    spinlock_lock(&THREAD->lock);
392
    if (THREAD->timeout_pending) { /* busy waiting for timeouts in progress */
393
        spinlock_unlock(&THREAD->lock);
413 jermar 394
        interrupts_restore(ipl);
1 jermar 395
        goto restart;
396
    }
15 jermar 397
    THREAD->state = Exiting;
398
    spinlock_unlock(&THREAD->lock);
1 jermar 399
    scheduler();
1595 palkovsky 400
 
401
    /* Not reached */
402
    while (1)
403
        ;
1 jermar 404
}
405
 
107 decky 406
 
407
/** Thread sleep
408
 *
409
 * Suspend execution of the current thread.
410
 *
411
 * @param sec Number of seconds to sleep.
412
 *
413
 */
1780 jermar 414
void thread_sleep(uint32_t sec)
1 jermar 415
{
125 jermar 416
    thread_usleep(sec*1000000);
1 jermar 417
}
107 decky 418
 
1571 jermar 419
/** Wait for another thread to exit.
420
 *
421
 * @param t Thread to join on exit.
422
 * @param usec Timeout in microseconds.
423
 * @param flags Mode of operation.
424
 *
425
 * @return An error code from errno.h or an error code from synch.h.
426
 */
1780 jermar 427
int thread_join_timeout(thread_t *t, uint32_t usec, int flags)
1571 jermar 428
{
429
    ipl_t ipl;
430
    int rc;
431
 
432
    if (t == THREAD)
433
        return EINVAL;
434
 
435
    /*
436
     * Since thread join can only be called once on an undetached thread,
437
     * the thread pointer is guaranteed to be still valid.
438
     */
439
 
440
    ipl = interrupts_disable();
441
    spinlock_lock(&t->lock);
442
    ASSERT(!t->detached);
443
    spinlock_unlock(&t->lock);
1687 jermar 444
    interrupts_restore(ipl);
1571 jermar 445
 
1687 jermar 446
    rc = waitq_sleep_timeout(&t->join_wq, usec, flags);
1571 jermar 447
 
448
    return rc; 
449
}
450
 
451
/** Detach thread.
452
 *
453
 * Mark the thread as detached, if the thread is already in the Undead state,
454
 * deallocate its resources.
455
 *
456
 * @param t Thread to be detached.
457
 */
458
void thread_detach(thread_t *t)
459
{
460
    ipl_t ipl;
461
 
462
    /*
463
     * Since the thread is expected to not be already detached,
464
     * pointer to it must be still valid.
465
     */
466
    ipl = interrupts_disable();
467
    spinlock_lock(&t->lock);
468
    ASSERT(!t->detached);
469
    if (t->state == Undead) {
470
        thread_destroy(t);  /* unlocks &t->lock */
471
        interrupts_restore(ipl);
472
        return;
473
    } else {
474
        t->detached = true;
475
    }
476
    spinlock_unlock(&t->lock);
477
    interrupts_restore(ipl);
478
}
479
 
107 decky 480
/** Thread usleep
481
 *
482
 * Suspend execution of the current thread.
483
 *
484
 * @param usec Number of microseconds to sleep.
485
 *
486
 */
1780 jermar 487
void thread_usleep(uint32_t usec)
1 jermar 488
{
489
    waitq_t wq;
490
 
491
    waitq_initialize(&wq);
492
 
1502 jermar 493
    (void) waitq_sleep_timeout(&wq, usec, SYNCH_FLAGS_NON_BLOCKING);
1 jermar 494
}
495
 
107 decky 496
/** Register thread out-of-context invocation
497
 *
498
 * Register a function and its argument to be executed
499
 * on next context switch to the current thread.
500
 *
501
 * @param call_me      Out-of-context function.
502
 * @param call_me_with Out-of-context function argument.
503
 *
504
 */
1 jermar 505
void thread_register_call_me(void (* call_me)(void *), void *call_me_with)
506
{
413 jermar 507
    ipl_t ipl;
1 jermar 508
 
413 jermar 509
    ipl = interrupts_disable();
15 jermar 510
    spinlock_lock(&THREAD->lock);
511
    THREAD->call_me = call_me;
512
    THREAD->call_me_with = call_me_with;
513
    spinlock_unlock(&THREAD->lock);
413 jermar 514
    interrupts_restore(ipl);
1 jermar 515
}
777 palkovsky 516
 
517
/** Print list of threads debug info */
518
void thread_print_list(void)
519
{
520
    link_t *cur;
521
    ipl_t ipl;
522
 
523
    /* Messing with thread structures, avoid deadlock */
524
    ipl = interrupts_disable();
525
    spinlock_lock(&threads_lock);
526
 
1158 jermar 527
    for (cur = threads_btree.leaf_head.next; cur != &threads_btree.leaf_head; cur = cur->next) {
528
        btree_node_t *node;
529
        int i;
530
 
531
        node = list_get_instance(cur, btree_node_t, leaf_link);
532
        for (i = 0; i < node->keys; i++) {
533
            thread_t *t;
534
 
535
            t = (thread_t *) node->value[i];
1735 decky 536
            printf("%s: address=%#zx, tid=%zd, state=%s, task=%#zx, code=%#zx, stack=%#zx, cpu=",
1158 jermar 537
                t->name, t, t->tid, thread_states[t->state], t->task, t->thread_code, t->kstack);
538
            if (t->cpu)
1458 palkovsky 539
                printf("cpu%zd", t->cpu->id);
1158 jermar 540
            else
541
                printf("none");
1458 palkovsky 542
            if (t->state == Sleeping) {
1735 decky 543
                printf(", kst=%#zx", t->kstack);
544
                printf(", wq=%#zx", t->sleep_queue);
1458 palkovsky 545
            }
1158 jermar 546
            printf("\n");
547
        }
777 palkovsky 548
    }
549
 
550
    spinlock_unlock(&threads_lock);
1060 palkovsky 551
    interrupts_restore(ipl);
777 palkovsky 552
}
1066 jermar 553
 
1158 jermar 554
/** Check whether thread exists.
555
 *
556
 * Note that threads_lock must be already held and
557
 * interrupts must be already disabled.
558
 *
559
 * @param t Pointer to thread.
560
 *
561
 * @return True if thread t is known to the system, false otherwise.
562
 */
563
bool thread_exists(thread_t *t)
564
{
565
    btree_node_t *leaf;
566
 
1780 jermar 567
    return btree_search(&threads_btree, (btree_key_t) ((uintptr_t) t), &leaf) != NULL;
1158 jermar 568
}
569
 
1066 jermar 570
/** Process syscall to create new thread.
571
 *
572
 */
1780 jermar 573
unative_t sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name)
1066 jermar 574
{
1210 vana 575
    thread_t *t;
576
    char namebuf[THREAD_NAME_BUFLEN];
1103 jermar 577
    uspace_arg_t *kernel_uarg;
1780 jermar 578
    uint32_t tid;
1288 jermar 579
    int rc;
1066 jermar 580
 
1288 jermar 581
    rc = copy_from_uspace(namebuf, uspace_name, THREAD_NAME_BUFLEN);
582
    if (rc != 0)
1780 jermar 583
        return (unative_t) rc;
1066 jermar 584
 
1078 jermar 585
    kernel_uarg = (uspace_arg_t *) malloc(sizeof(uspace_arg_t), 0);
1288 jermar 586
    rc = copy_from_uspace(kernel_uarg, uspace_uarg, sizeof(uspace_arg_t));
587
    if (rc != 0) {
588
        free(kernel_uarg);
1780 jermar 589
        return (unative_t) rc;
1288 jermar 590
    }
1078 jermar 591
 
1210 vana 592
    if ((t = thread_create(uinit, kernel_uarg, TASK, 0, namebuf))) {
1066 jermar 593
        tid = t->tid;
1210 vana 594
        thread_ready(t);
1780 jermar 595
        return (unative_t) tid;
1210 vana 596
    } else {
1078 jermar 597
        free(kernel_uarg);
1210 vana 598
    }
1066 jermar 599
 
1780 jermar 600
    return (unative_t) ENOMEM;
1066 jermar 601
}
602
 
603
/** Process syscall to terminate thread.
604
 *
605
 */
1780 jermar 606
unative_t sys_thread_exit(int uspace_status)
1066 jermar 607
{
1210 vana 608
    thread_exit();
609
    /* Unreachable */
610
    return 0;
1066 jermar 611
}
1702 cejka 612
 
1757 jermar 613
/** @}
1702 cejka 614
 */