Subversion Repositories HelenOS

Rev

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