Updated dutch voice translations
[kugel-rb.git] / firmware / thread.c
blob5c404b11968d96cab2988a6cd45b7e273356b9e6
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2002 by Ulf Ralberg
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
21 #include "config.h"
22 #include <stdbool.h>
23 #include "thread.h"
24 #include "panic.h"
25 #include "sprintf.h"
26 #include "system.h"
27 #include "kernel.h"
28 #include "cpu.h"
29 #include "string.h"
30 #ifdef RB_PROFILE
31 #include <profile.h>
32 #endif
33 /****************************************************************************
34 * ATTENTION!! *
35 * See notes below on implementing processor-specific portions! *
36 ***************************************************************************/
38 /* Define THREAD_EXTRA_CHECKS as 1 to enable additional state checks */
39 #ifdef DEBUG
40 #define THREAD_EXTRA_CHECKS 1 /* Always 1 for DEBUG */
41 #else
42 #define THREAD_EXTRA_CHECKS 0
43 #endif
45 /**
46 * General locking order to guarantee progress. Order must be observed but
47 * all stages are not nescessarily obligatory. Going from 1) to 3) is
48 * perfectly legal.
50 * 1) IRQ
51 * This is first because of the likelyhood of having an interrupt occur that
52 * also accesses one of the objects farther down the list. Any non-blocking
53 * synchronization done may already have a lock on something during normal
54 * execution and if an interrupt handler running on the same processor as
55 * the one that has the resource locked were to attempt to access the
56 * resource, the interrupt handler would wait forever waiting for an unlock
57 * that will never happen. There is no danger if the interrupt occurs on
58 * a different processor because the one that has the lock will eventually
59 * unlock and the other processor's handler may proceed at that time. Not
60 * nescessary when the resource in question is definitely not available to
61 * interrupt handlers.
63 * 2) Kernel Object
64 * 1) May be needed beforehand if the kernel object allows dual-use such as
65 * event queues. The kernel object must have a scheme to protect itself from
66 * access by another processor and is responsible for serializing the calls
67 * to block_thread(_w_tmo) and wakeup_thread both to themselves and to each
68 * other. Objects' queues are also protected here.
70 * 3) Thread Slot
71 * This locks access to the thread's slot such that its state cannot be
72 * altered by another processor when a state change is in progress such as
73 * when it is in the process of going on a blocked list. An attempt to wake
74 * a thread while it is still blocking will likely desync its state with
75 * the other resources used for that state.
77 * 4) Core Lists
78 * These lists are specific to a particular processor core and are accessible
79 * by all processor cores and interrupt handlers. The running (rtr) list is
80 * the prime example where a thread may be added by any means.
83 /*---------------------------------------------------------------------------
84 * Processor specific: core_sleep/core_wake/misc. notes
86 * ARM notes:
87 * FIQ is not dealt with by the scheduler code and is simply restored if it
88 * must by masked for some reason - because threading modifies a register
89 * that FIQ may also modify and there's no way to accomplish it atomically.
90 * s3c2440 is such a case.
92 * Audio interrupts are generally treated at a higher priority than others
93 * usage of scheduler code with interrupts higher than HIGHEST_IRQ_LEVEL
94 * are not in general safe. Special cases may be constructed on a per-
95 * source basis and blocking operations are not available.
97 * core_sleep procedure to implement for any CPU to ensure an asychronous
98 * wakup never results in requiring a wait until the next tick (up to
99 * 10000uS!). May require assembly and careful instruction ordering.
101 * 1) On multicore, stay awake if directed to do so by another. If so, goto
102 * step 4.
103 * 2) If processor requires, atomically reenable interrupts and perform step
104 * 3.
105 * 3) Sleep the CPU core. If wakeup itself enables interrupts (stop #0x2000
106 * on Coldfire) goto step 5.
107 * 4) Enable interrupts.
108 * 5) Exit procedure.
110 * core_wake and multprocessor notes for sleep/wake coordination:
111 * If possible, to wake up another processor, the forcing of an interrupt on
112 * the woken core by the waker core is the easiest way to ensure a non-
113 * delayed wake and immediate execution of any woken threads. If that isn't
114 * available then some careful non-blocking synchonization is needed (as on
115 * PP targets at the moment).
116 *---------------------------------------------------------------------------
119 /* Cast to the the machine pointer size, whose size could be < 4 or > 32
120 * (someday :). */
121 #define DEADBEEF ((uintptr_t)0xdeadbeefdeadbeefull)
122 struct core_entry cores[NUM_CORES] IBSS_ATTR;
123 struct thread_entry threads[MAXTHREADS] IBSS_ATTR;
125 static const char main_thread_name[] = "main";
126 extern uintptr_t stackbegin[];
127 extern uintptr_t stackend[];
129 static inline void core_sleep(IF_COP_VOID(unsigned int core))
130 __attribute__((always_inline));
132 void check_tmo_threads(void)
133 __attribute__((noinline));
135 static inline void block_thread_on_l(struct thread_entry *thread, unsigned state)
136 __attribute__((always_inline));
138 static void add_to_list_tmo(struct thread_entry *thread)
139 __attribute__((noinline));
141 static void core_schedule_wakeup(struct thread_entry *thread)
142 __attribute__((noinline));
144 #if NUM_CORES > 1
145 static inline void run_blocking_ops(
146 unsigned int core, struct thread_entry *thread)
147 __attribute__((always_inline));
148 #endif
150 static void thread_stkov(struct thread_entry *thread)
151 __attribute__((noinline));
153 static inline void store_context(void* addr)
154 __attribute__((always_inline));
156 static inline void load_context(const void* addr)
157 __attribute__((always_inline));
159 void switch_thread(void)
160 __attribute__((noinline));
162 /****************************************************************************
163 * Processor-specific section
166 #if defined(MAX_PHYS_SECTOR_SIZE) && MEM == 64
167 /* Support a special workaround object for large-sector disks */
168 #define IF_NO_SKIP_YIELD(...) __VA_ARGS__
169 #else
170 #define IF_NO_SKIP_YIELD(...)
171 #endif
173 #if defined(CPU_ARM)
174 /*---------------------------------------------------------------------------
175 * Start the thread running and terminate it if it returns
176 *---------------------------------------------------------------------------
178 static void __attribute__((naked,used)) start_thread(void)
180 /* r0 = context */
181 asm volatile (
182 "ldr sp, [r0, #32] \n" /* Load initial sp */
183 "ldr r4, [r0, #40] \n" /* start in r4 since it's non-volatile */
184 "mov r1, #0 \n" /* Mark thread as running */
185 "str r1, [r0, #40] \n"
186 #if NUM_CORES > 1
187 "ldr r0, =invalidate_icache \n" /* Invalidate this core's cache. */
188 "mov lr, pc \n" /* This could be the first entry into */
189 "bx r0 \n" /* plugin or codec code for this core. */
190 #endif
191 "mov lr, pc \n" /* Call thread function */
192 "bx r4 \n"
193 ); /* No clobber list - new thread doesn't care */
194 thread_exit();
195 //asm volatile (".ltorg"); /* Dump constant pool */
198 /* For startup, place context pointer in r4 slot, start_thread pointer in r5
199 * slot, and thread function pointer in context.start. See load_context for
200 * what happens when thread is initially going to run. */
201 #define THREAD_STARTUP_INIT(core, thread, function) \
202 ({ (thread)->context.r[0] = (uint32_t)&(thread)->context, \
203 (thread)->context.r[1] = (uint32_t)start_thread, \
204 (thread)->context.start = (uint32_t)function; })
206 /*---------------------------------------------------------------------------
207 * Store non-volatile context.
208 *---------------------------------------------------------------------------
210 static inline void store_context(void* addr)
212 asm volatile(
213 "stmia %0, { r4-r11, sp, lr } \n"
214 : : "r" (addr)
218 /*---------------------------------------------------------------------------
219 * Load non-volatile context.
220 *---------------------------------------------------------------------------
222 static inline void load_context(const void* addr)
224 asm volatile(
225 "ldr r0, [%0, #40] \n" /* Load start pointer */
226 "cmp r0, #0 \n" /* Check for NULL */
227 "ldmneia %0, { r0, pc } \n" /* If not already running, jump to start */
228 "ldmia %0, { r4-r11, sp, lr } \n" /* Load regs r4 to r14 from context */
229 : : "r" (addr) : "r0" /* only! */
233 #if defined (CPU_PP)
235 #if NUM_CORES > 1
236 extern uintptr_t cpu_idlestackbegin[];
237 extern uintptr_t cpu_idlestackend[];
238 extern uintptr_t cop_idlestackbegin[];
239 extern uintptr_t cop_idlestackend[];
240 static uintptr_t * const idle_stacks[NUM_CORES] =
242 [CPU] = cpu_idlestackbegin,
243 [COP] = cop_idlestackbegin
246 #if CONFIG_CPU == PP5002
247 /* Bytes to emulate the PP502x mailbox bits */
248 struct core_semaphores
250 volatile uint8_t intend_wake; /* 00h */
251 volatile uint8_t stay_awake; /* 01h */
252 volatile uint8_t intend_sleep; /* 02h */
253 volatile uint8_t unused; /* 03h */
256 static struct core_semaphores core_semaphores[NUM_CORES] IBSS_ATTR;
257 #endif /* CONFIG_CPU == PP5002 */
259 #endif /* NUM_CORES */
261 #if CONFIG_CORELOCK == SW_CORELOCK
262 /* Software core locks using Peterson's mutual exclusion algorithm */
264 /*---------------------------------------------------------------------------
265 * Initialize the corelock structure.
266 *---------------------------------------------------------------------------
268 void corelock_init(struct corelock *cl)
270 memset(cl, 0, sizeof (*cl));
273 #if 1 /* Assembly locks to minimize overhead */
274 /*---------------------------------------------------------------------------
275 * Wait for the corelock to become free and acquire it when it does.
276 *---------------------------------------------------------------------------
278 void corelock_lock(struct corelock *cl) __attribute__((naked));
279 void corelock_lock(struct corelock *cl)
281 /* Relies on the fact that core IDs are complementary bitmasks (0x55,0xaa) */
282 asm volatile (
283 "mov r1, %0 \n" /* r1 = PROCESSOR_ID */
284 "ldrb r1, [r1] \n"
285 "strb r1, [r0, r1, lsr #7] \n" /* cl->myl[core] = core */
286 "eor r2, r1, #0xff \n" /* r2 = othercore */
287 "strb r2, [r0, #2] \n" /* cl->turn = othercore */
288 "1: \n"
289 "ldrb r3, [r0, r2, lsr #7] \n" /* cl->myl[othercore] == 0 ? */
290 "cmp r3, #0 \n" /* yes? lock acquired */
291 "bxeq lr \n"
292 "ldrb r3, [r0, #2] \n" /* || cl->turn == core ? */
293 "cmp r3, r1 \n"
294 "bxeq lr \n" /* yes? lock acquired */
295 "b 1b \n" /* keep trying */
296 : : "i"(&PROCESSOR_ID)
298 (void)cl;
301 /*---------------------------------------------------------------------------
302 * Try to aquire the corelock. If free, caller gets it, otherwise return 0.
303 *---------------------------------------------------------------------------
305 int corelock_try_lock(struct corelock *cl) __attribute__((naked));
306 int corelock_try_lock(struct corelock *cl)
308 /* Relies on the fact that core IDs are complementary bitmasks (0x55,0xaa) */
309 asm volatile (
310 "mov r1, %0 \n" /* r1 = PROCESSOR_ID */
311 "ldrb r1, [r1] \n"
312 "mov r3, r0 \n"
313 "strb r1, [r0, r1, lsr #7] \n" /* cl->myl[core] = core */
314 "eor r2, r1, #0xff \n" /* r2 = othercore */
315 "strb r2, [r0, #2] \n" /* cl->turn = othercore */
316 "ldrb r0, [r3, r2, lsr #7] \n" /* cl->myl[othercore] == 0 ? */
317 "eors r0, r0, r2 \n" /* yes? lock acquired */
318 "bxne lr \n"
319 "ldrb r0, [r3, #2] \n" /* || cl->turn == core? */
320 "ands r0, r0, r1 \n"
321 "streqb r0, [r3, r1, lsr #7] \n" /* if not, cl->myl[core] = 0 */
322 "bx lr \n" /* return result */
323 : : "i"(&PROCESSOR_ID)
326 return 0;
327 (void)cl;
330 /*---------------------------------------------------------------------------
331 * Release ownership of the corelock
332 *---------------------------------------------------------------------------
334 void corelock_unlock(struct corelock *cl) __attribute__((naked));
335 void corelock_unlock(struct corelock *cl)
337 asm volatile (
338 "mov r1, %0 \n" /* r1 = PROCESSOR_ID */
339 "ldrb r1, [r1] \n"
340 "mov r2, #0 \n" /* cl->myl[core] = 0 */
341 "strb r2, [r0, r1, lsr #7] \n"
342 "bx lr \n"
343 : : "i"(&PROCESSOR_ID)
345 (void)cl;
347 #else /* C versions for reference */
348 /*---------------------------------------------------------------------------
349 * Wait for the corelock to become free and aquire it when it does.
350 *---------------------------------------------------------------------------
352 void corelock_lock(struct corelock *cl)
354 const unsigned int core = CURRENT_CORE;
355 const unsigned int othercore = 1 - core;
357 cl->myl[core] = core;
358 cl->turn = othercore;
360 for (;;)
362 if (cl->myl[othercore] == 0 || cl->turn == core)
363 break;
367 /*---------------------------------------------------------------------------
368 * Try to aquire the corelock. If free, caller gets it, otherwise return 0.
369 *---------------------------------------------------------------------------
371 int corelock_try_lock(struct corelock *cl)
373 const unsigned int core = CURRENT_CORE;
374 const unsigned int othercore = 1 - core;
376 cl->myl[core] = core;
377 cl->turn = othercore;
379 if (cl->myl[othercore] == 0 || cl->turn == core)
381 return 1;
384 cl->myl[core] = 0;
385 return 0;
388 /*---------------------------------------------------------------------------
389 * Release ownership of the corelock
390 *---------------------------------------------------------------------------
392 void corelock_unlock(struct corelock *cl)
394 cl->myl[CURRENT_CORE] = 0;
396 #endif /* ASM / C selection */
398 #endif /* CONFIG_CORELOCK == SW_CORELOCK */
400 /*---------------------------------------------------------------------------
401 * Put core in a power-saving state if waking list wasn't repopulated and if
402 * no other core requested a wakeup for it to perform a task.
403 *---------------------------------------------------------------------------
405 #ifdef CPU_PP502x
406 #if NUM_CORES == 1
407 static inline void core_sleep(void)
409 sleep_core(CURRENT_CORE);
410 enable_irq();
412 #else
413 static inline void core_sleep(unsigned int core)
415 #if 1
416 asm volatile (
417 "mov r0, #4 \n" /* r0 = 0x4 << core */
418 "mov r0, r0, lsl %[c] \n"
419 "str r0, [%[mbx], #4] \n" /* signal intent to sleep */
420 "ldr r1, [%[mbx], #0] \n" /* && !(MBX_MSG_STAT & (0x10<<core)) ? */
421 "tst r1, r0, lsl #2 \n"
422 "moveq r1, #0x80000000 \n" /* Then sleep */
423 "streq r1, [%[ctl], %[c], lsl #2] \n"
424 "moveq r1, #0 \n" /* Clear control reg */
425 "streq r1, [%[ctl], %[c], lsl #2] \n"
426 "orr r1, r0, r0, lsl #2 \n" /* Signal intent to wake - clear wake flag */
427 "str r1, [%[mbx], #8] \n"
428 "1: \n" /* Wait for wake procedure to finish */
429 "ldr r1, [%[mbx], #0] \n"
430 "tst r1, r0, lsr #2 \n"
431 "bne 1b \n"
433 : [ctl]"r"(&CPU_CTL), [mbx]"r"(MBX_BASE), [c]"r"(core)
434 : "r0", "r1");
435 #else /* C version for reference */
436 /* Signal intent to sleep */
437 MBX_MSG_SET = 0x4 << core;
439 /* Something waking or other processor intends to wake us? */
440 if ((MBX_MSG_STAT & (0x10 << core)) == 0)
442 sleep_core(core);
443 wake_core(core);
446 /* Signal wake - clear wake flag */
447 MBX_MSG_CLR = 0x14 << core;
449 /* Wait for other processor to finish wake procedure */
450 while (MBX_MSG_STAT & (0x1 << core));
451 #endif /* ASM/C selection */
452 enable_irq();
454 #endif /* NUM_CORES */
455 #elif CONFIG_CPU == PP5002
456 #if NUM_CORES == 1
457 static inline void core_sleep(void)
459 sleep_core(CURRENT_CORE);
460 enable_irq();
462 #else
463 /* PP5002 has no mailboxes - emulate using bytes */
464 static inline void core_sleep(unsigned int core)
466 #if 1
467 asm volatile (
468 "mov r0, #1 \n" /* Signal intent to sleep */
469 "strb r0, [%[sem], #2] \n"
470 "ldrb r0, [%[sem], #1] \n" /* && stay_awake == 0? */
471 "cmp r0, #0 \n"
472 "bne 2f \n"
473 /* Sleep: PP5002 crashes if the instruction that puts it to sleep is
474 * located at 0xNNNNNNN0. 4/8/C works. This sequence makes sure
475 * that the correct alternative is executed. Don't change the order
476 * of the next 4 instructions! */
477 "tst pc, #0x0c \n"
478 "mov r0, #0xca \n"
479 "strne r0, [%[ctl], %[c], lsl #2] \n"
480 "streq r0, [%[ctl], %[c], lsl #2] \n"
481 "nop \n" /* nop's needed because of pipeline */
482 "nop \n"
483 "nop \n"
484 "2: \n"
485 "mov r0, #0 \n" /* Clear stay_awake and sleep intent */
486 "strb r0, [%[sem], #1] \n"
487 "strb r0, [%[sem], #2] \n"
488 "1: \n" /* Wait for wake procedure to finish */
489 "ldrb r0, [%[sem], #0] \n"
490 "cmp r0, #0 \n"
491 "bne 1b \n"
493 : [sem]"r"(&core_semaphores[core]), [c]"r"(core),
494 [ctl]"r"(&CPU_CTL)
495 : "r0"
497 #else /* C version for reference */
498 /* Signal intent to sleep */
499 core_semaphores[core].intend_sleep = 1;
501 /* Something waking or other processor intends to wake us? */
502 if (core_semaphores[core].stay_awake == 0)
504 sleep_core(core);
507 /* Signal wake - clear wake flag */
508 core_semaphores[core].stay_awake = 0;
509 core_semaphores[core].intend_sleep = 0;
511 /* Wait for other processor to finish wake procedure */
512 while (core_semaphores[core].intend_wake != 0);
514 /* Enable IRQ */
515 #endif /* ASM/C selection */
516 enable_irq();
518 #endif /* NUM_CORES */
519 #endif /* PP CPU type */
521 /*---------------------------------------------------------------------------
522 * Wake another processor core that is sleeping or prevent it from doing so
523 * if it was already destined. FIQ, IRQ should be disabled before calling.
524 *---------------------------------------------------------------------------
526 #if NUM_CORES == 1
527 /* Shared single-core build debugging version */
528 void core_wake(void)
530 /* No wakey - core already wakey */
532 #elif defined (CPU_PP502x)
533 void core_wake(unsigned int othercore)
535 #if 1
536 /* avoid r0 since that contains othercore */
537 asm volatile (
538 "mrs r3, cpsr \n" /* Disable IRQ */
539 "orr r1, r3, #0x80 \n"
540 "msr cpsr_c, r1 \n"
541 "mov r2, #0x11 \n" /* r2 = (0x11 << othercore) */
542 "mov r2, r2, lsl %[oc] \n" /* Signal intent to wake othercore */
543 "str r2, [%[mbx], #4] \n"
544 "1: \n" /* If it intends to sleep, let it first */
545 "ldr r1, [%[mbx], #0] \n" /* (MSG_MSG_STAT & (0x4 << othercore)) != 0 ? */
546 "eor r1, r1, #0xc \n"
547 "tst r1, r2, lsr #2 \n"
548 "ldr r1, [%[ctl], %[oc], lsl #2] \n" /* && (PROC_CTL(othercore) & PROC_SLEEP) == 0 ? */
549 "tsteq r1, #0x80000000 \n"
550 "beq 1b \n" /* Wait for sleep or wake */
551 "tst r1, #0x80000000 \n" /* If sleeping, wake it */
552 "movne r1, #0x0 \n"
553 "strne r1, [%[ctl], %[oc], lsl #2] \n"
554 "mov r1, r2, lsr #4 \n"
555 "str r1, [%[mbx], #8] \n" /* Done with wake procedure */
556 "msr cpsr_c, r3 \n" /* Restore IRQ */
558 : [ctl]"r"(&PROC_CTL(CPU)), [mbx]"r"(MBX_BASE),
559 [oc]"r"(othercore)
560 : "r1", "r2", "r3");
561 #else /* C version for reference */
562 /* Disable interrupts - avoid reentrancy from the tick */
563 int oldlevel = disable_irq_save();
565 /* Signal intent to wake other processor - set stay awake */
566 MBX_MSG_SET = 0x11 << othercore;
568 /* If it intends to sleep, wait until it does or aborts */
569 while ((MBX_MSG_STAT & (0x4 << othercore)) != 0 &&
570 (PROC_CTL(othercore) & PROC_SLEEP) == 0);
572 /* If sleeping, wake it up */
573 if (PROC_CTL(othercore) & PROC_SLEEP)
574 PROC_CTL(othercore) = 0;
576 /* Done with wake procedure */
577 MBX_MSG_CLR = 0x1 << othercore;
578 restore_irq(oldlevel);
579 #endif /* ASM/C selection */
581 #elif CONFIG_CPU == PP5002
582 /* PP5002 has no mailboxes - emulate using bytes */
583 void core_wake(unsigned int othercore)
585 #if 1
586 /* avoid r0 since that contains othercore */
587 asm volatile (
588 "mrs r3, cpsr \n" /* Disable IRQ */
589 "orr r1, r3, #0x80 \n"
590 "msr cpsr_c, r1 \n"
591 "mov r1, #1 \n" /* Signal intent to wake other core */
592 "orr r1, r1, r1, lsl #8 \n" /* and set stay_awake */
593 "strh r1, [%[sem], #0] \n"
594 "mov r2, #0x8000 \n"
595 "1: \n" /* If it intends to sleep, let it first */
596 "ldrb r1, [%[sem], #2] \n" /* intend_sleep != 0 ? */
597 "cmp r1, #1 \n"
598 "ldr r1, [%[st]] \n" /* && not sleeping ? */
599 "tsteq r1, r2, lsr %[oc] \n"
600 "beq 1b \n" /* Wait for sleep or wake */
601 "tst r1, r2, lsr %[oc] \n"
602 "ldrne r2, =0xcf004054 \n" /* If sleeping, wake it */
603 "movne r1, #0xce \n"
604 "strne r1, [r2, %[oc], lsl #2] \n"
605 "mov r1, #0 \n" /* Done with wake procedure */
606 "strb r1, [%[sem], #0] \n"
607 "msr cpsr_c, r3 \n" /* Restore IRQ */
609 : [sem]"r"(&core_semaphores[othercore]),
610 [st]"r"(&PROC_STAT),
611 [oc]"r"(othercore)
612 : "r1", "r2", "r3"
614 #else /* C version for reference */
615 /* Disable interrupts - avoid reentrancy from the tick */
616 int oldlevel = disable_irq_save();
618 /* Signal intent to wake other processor - set stay awake */
619 core_semaphores[othercore].intend_wake = 1;
620 core_semaphores[othercore].stay_awake = 1;
622 /* If it intends to sleep, wait until it does or aborts */
623 while (core_semaphores[othercore].intend_sleep != 0 &&
624 (PROC_STAT & PROC_SLEEPING(othercore)) == 0);
626 /* If sleeping, wake it up */
627 if (PROC_STAT & PROC_SLEEPING(othercore))
628 wake_core(othercore);
630 /* Done with wake procedure */
631 core_semaphores[othercore].intend_wake = 0;
632 restore_irq(oldlevel);
633 #endif /* ASM/C selection */
635 #endif /* CPU type */
637 #if NUM_CORES > 1
638 /*---------------------------------------------------------------------------
639 * Switches to a stack that always resides in the Rockbox core.
641 * Needed when a thread suicides on a core other than the main CPU since the
642 * stack used when idling is the stack of the last thread to run. This stack
643 * may not reside in the core firmware in which case the core will continue
644 * to use a stack from an unloaded module until another thread runs on it.
645 *---------------------------------------------------------------------------
647 static inline void switch_to_idle_stack(const unsigned int core)
649 asm volatile (
650 "str sp, [%0] \n" /* save original stack pointer on idle stack */
651 "mov sp, %0 \n" /* switch stacks */
652 : : "r"(&idle_stacks[core][IDLE_STACK_WORDS-1]));
653 (void)core;
656 /*---------------------------------------------------------------------------
657 * Perform core switch steps that need to take place inside switch_thread.
659 * These steps must take place while before changing the processor and after
660 * having entered switch_thread since switch_thread may not do a normal return
661 * because the stack being used for anything the compiler saved will not belong
662 * to the thread's destination core and it may have been recycled for other
663 * purposes by the time a normal context load has taken place. switch_thread
664 * will also clobber anything stashed in the thread's context or stored in the
665 * nonvolatile registers if it is saved there before the call since the
666 * compiler's order of operations cannot be known for certain.
668 static void core_switch_blk_op(unsigned int core, struct thread_entry *thread)
670 /* Flush our data to ram */
671 flush_icache();
672 /* Stash thread in r4 slot */
673 thread->context.r[0] = (uint32_t)thread;
674 /* Stash restart address in r5 slot */
675 thread->context.r[1] = thread->context.start;
676 /* Save sp in context.sp while still running on old core */
677 thread->context.sp = idle_stacks[core][IDLE_STACK_WORDS-1];
680 /*---------------------------------------------------------------------------
681 * Machine-specific helper function for switching the processor a thread is
682 * running on. Basically, the thread suicides on the departing core and is
683 * reborn on the destination. Were it not for gcc's ill-behavior regarding
684 * naked functions written in C where it actually clobbers non-volatile
685 * registers before the intended prologue code, this would all be much
686 * simpler. Generic setup is done in switch_core itself.
689 /*---------------------------------------------------------------------------
690 * This actually performs the core switch.
692 static void __attribute__((naked))
693 switch_thread_core(unsigned int core, struct thread_entry *thread)
695 /* Pure asm for this because compiler behavior isn't sufficiently predictable.
696 * Stack access also isn't permitted until restoring the original stack and
697 * context. */
698 asm volatile (
699 "stmfd sp!, { r4-r12, lr } \n" /* Stack all non-volatile context on current core */
700 "ldr r2, =idle_stacks \n" /* r2 = &idle_stacks[core][IDLE_STACK_WORDS] */
701 "ldr r2, [r2, r0, lsl #2] \n"
702 "add r2, r2, %0*4 \n"
703 "stmfd r2!, { sp } \n" /* save original stack pointer on idle stack */
704 "mov sp, r2 \n" /* switch stacks */
705 "adr r2, 1f \n" /* r2 = new core restart address */
706 "str r2, [r1, #40] \n" /* thread->context.start = r2 */
707 "ldr pc, =switch_thread \n" /* r0 = thread after call - see load_context */
708 "1: \n"
709 "ldr sp, [r0, #32] \n" /* Reload original sp from context structure */
710 "mov r1, #0 \n" /* Clear start address */
711 "str r1, [r0, #40] \n"
712 "ldr r0, =invalidate_icache \n" /* Invalidate new core's cache */
713 "mov lr, pc \n"
714 "bx r0 \n"
715 "ldmfd sp!, { r4-r12, pc } \n" /* Restore non-volatile context to new core and return */
716 ".ltorg \n" /* Dump constant pool */
717 : : "i"(IDLE_STACK_WORDS)
719 (void)core; (void)thread;
722 /*---------------------------------------------------------------------------
723 * Do any device-specific inits for the threads and synchronize the kernel
724 * initializations.
725 *---------------------------------------------------------------------------
727 static void core_thread_init(unsigned int core)
729 if (core == CPU)
731 /* Wake up coprocessor and let it initialize kernel and threads */
732 #ifdef CPU_PP502x
733 MBX_MSG_CLR = 0x3f;
734 #endif
735 wake_core(COP);
736 /* Sleep until COP has finished */
737 sleep_core(CPU);
739 else
741 /* Wake the CPU and return */
742 wake_core(CPU);
745 #endif /* NUM_CORES */
747 #elif CONFIG_CPU == S3C2440
749 /*---------------------------------------------------------------------------
750 * Put core in a power-saving state if waking list wasn't repopulated.
751 *---------------------------------------------------------------------------
753 static inline void core_sleep(void)
755 /* FIQ also changes the CLKCON register so FIQ must be disabled
756 when changing it here */
757 asm volatile (
758 "mrs r0, cpsr \n"
759 "orr r2, r0, #0x40 \n" /* Disable FIQ */
760 "bic r0, r0, #0x80 \n" /* Prepare IRQ enable */
761 "msr cpsr_c, r2 \n"
762 "mov r1, #0x4c000000 \n" /* CLKCON = 0x4c00000c */
763 "ldr r2, [r1, #0xc] \n" /* Set IDLE bit */
764 "orr r2, r2, #4 \n"
765 "str r2, [r1, #0xc] \n"
766 "msr cpsr_c, r0 \n" /* Enable IRQ, restore FIQ */
767 "mov r2, #0 \n" /* wait for IDLE */
768 "1: \n"
769 "add r2, r2, #1 \n"
770 "cmp r2, #10 \n"
771 "bne 1b \n"
772 "orr r2, r0, #0xc0 \n" /* Disable IRQ, FIQ */
773 "msr cpsr_c, r2 \n"
774 "ldr r2, [r1, #0xc] \n" /* Reset IDLE bit */
775 "bic r2, r2, #4 \n"
776 "str r2, [r1, #0xc] \n"
777 "msr cpsr_c, r0 \n" /* Enable IRQ, restore FIQ */
778 : : : "r0", "r1", "r2");
780 #elif defined(CPU_TCC77X)
781 static inline void core_sleep(void)
783 #warning TODO: Implement core_sleep
784 enable_irq();
786 #elif defined(CPU_TCC780X)
787 static inline void core_sleep(void)
789 /* Single core only for now. Use the generic ARMv5 wait for IRQ */
790 asm volatile (
791 "mov r0, #0 \n"
792 "mcr p15, 0, r0, c7, c0, 4 \n" /* Wait for interrupt */
793 : : : "r0"
795 enable_irq();
797 #elif CONFIG_CPU == IMX31L
798 static inline void core_sleep(void)
800 asm volatile (
801 "mov r0, #0 \n"
802 "mcr p15, 0, r0, c7, c0, 4 \n" /* Wait for interrupt */
803 : : : "r0"
805 enable_irq();
807 #elif CONFIG_CPU == DM320
808 static inline void core_sleep(void)
810 asm volatile (
811 "mov r0, #0 \n"
812 "mcr p15, 0, r0, c7, c0, 4 \n" /* Wait for interrupt */
813 : : : "r0"
815 enable_irq();
817 #else
818 static inline void core_sleep(void)
820 #warning core_sleep not implemented, battery life will be decreased
821 enable_irq();
823 #endif /* CONFIG_CPU == */
825 #elif defined(CPU_COLDFIRE)
826 /*---------------------------------------------------------------------------
827 * Start the thread running and terminate it if it returns
828 *---------------------------------------------------------------------------
830 void start_thread(void); /* Provide C access to ASM label */
831 static void __attribute__((used)) __start_thread(void)
833 /* a0=macsr, a1=context */
834 asm volatile (
835 "start_thread: \n" /* Start here - no naked attribute */
836 "move.l %a0, %macsr \n" /* Set initial mac status reg */
837 "lea.l 48(%a1), %a1 \n"
838 "move.l (%a1)+, %sp \n" /* Set initial stack */
839 "move.l (%a1), %a2 \n" /* Fetch thread function pointer */
840 "clr.l (%a1) \n" /* Mark thread running */
841 "jsr (%a2) \n" /* Call thread function */
843 thread_exit();
846 /* Set EMAC unit to fractional mode with saturation for each new thread,
847 * since that's what'll be the most useful for most things which the dsp
848 * will do. Codecs should still initialize their preferred modes
849 * explicitly. Context pointer is placed in d2 slot and start_thread
850 * pointer in d3 slot. thread function pointer is placed in context.start.
851 * See load_context for what happens when thread is initially going to
852 * run.
854 #define THREAD_STARTUP_INIT(core, thread, function) \
855 ({ (thread)->context.macsr = EMAC_FRACTIONAL | EMAC_SATURATE, \
856 (thread)->context.d[0] = (uint32_t)&(thread)->context, \
857 (thread)->context.d[1] = (uint32_t)start_thread, \
858 (thread)->context.start = (uint32_t)(function); })
860 /*---------------------------------------------------------------------------
861 * Store non-volatile context.
862 *---------------------------------------------------------------------------
864 static inline void store_context(void* addr)
866 asm volatile (
867 "move.l %%macsr,%%d0 \n"
868 "movem.l %%d0/%%d2-%%d7/%%a2-%%a7,(%0) \n"
869 : : "a" (addr) : "d0" /* only! */
873 /*---------------------------------------------------------------------------
874 * Load non-volatile context.
875 *---------------------------------------------------------------------------
877 static inline void load_context(const void* addr)
879 asm volatile (
880 "move.l 52(%0), %%d0 \n" /* Get start address */
881 "beq.b 1f \n" /* NULL -> already running */
882 "movem.l (%0), %%a0-%%a2 \n" /* a0=macsr, a1=context, a2=start_thread */
883 "jmp (%%a2) \n" /* Start the thread */
884 "1: \n"
885 "movem.l (%0), %%d0/%%d2-%%d7/%%a2-%%a7 \n" /* Load context */
886 "move.l %%d0, %%macsr \n"
887 : : "a" (addr) : "d0" /* only! */
891 /*---------------------------------------------------------------------------
892 * Put core in a power-saving state if waking list wasn't repopulated.
893 *---------------------------------------------------------------------------
895 static inline void core_sleep(void)
897 /* Supervisor mode, interrupts enabled upon wakeup */
898 asm volatile ("stop #0x2000");
901 #elif CONFIG_CPU == SH7034
902 /*---------------------------------------------------------------------------
903 * Start the thread running and terminate it if it returns
904 *---------------------------------------------------------------------------
906 void start_thread(void); /* Provide C access to ASM label */
907 static void __attribute__((used)) __start_thread(void)
909 /* r8 = context */
910 asm volatile (
911 "_start_thread: \n" /* Start here - no naked attribute */
912 "mov.l @(4, r8), r0 \n" /* Fetch thread function pointer */
913 "mov.l @(28, r8), r15 \n" /* Set initial sp */
914 "mov #0, r1 \n" /* Start the thread */
915 "jsr @r0 \n"
916 "mov.l r1, @(36, r8) \n" /* Clear start address */
918 thread_exit();
921 /* Place context pointer in r8 slot, function pointer in r9 slot, and
922 * start_thread pointer in context_start */
923 #define THREAD_STARTUP_INIT(core, thread, function) \
924 ({ (thread)->context.r[0] = (uint32_t)&(thread)->context, \
925 (thread)->context.r[1] = (uint32_t)(function), \
926 (thread)->context.start = (uint32_t)start_thread; })
928 /*---------------------------------------------------------------------------
929 * Store non-volatile context.
930 *---------------------------------------------------------------------------
932 static inline void store_context(void* addr)
934 asm volatile (
935 "add #36, %0 \n" /* Start at last reg. By the time routine */
936 "sts.l pr, @-%0 \n" /* is done, %0 will have the original value */
937 "mov.l r15,@-%0 \n"
938 "mov.l r14,@-%0 \n"
939 "mov.l r13,@-%0 \n"
940 "mov.l r12,@-%0 \n"
941 "mov.l r11,@-%0 \n"
942 "mov.l r10,@-%0 \n"
943 "mov.l r9, @-%0 \n"
944 "mov.l r8, @-%0 \n"
945 : : "r" (addr)
949 /*---------------------------------------------------------------------------
950 * Load non-volatile context.
951 *---------------------------------------------------------------------------
953 static inline void load_context(const void* addr)
955 asm volatile (
956 "mov.l @(36, %0), r0 \n" /* Get start address */
957 "tst r0, r0 \n"
958 "bt .running \n" /* NULL -> already running */
959 "jmp @r0 \n" /* r8 = context */
960 ".running: \n"
961 "mov.l @%0+, r8 \n" /* Executes in delay slot and outside it */
962 "mov.l @%0+, r9 \n"
963 "mov.l @%0+, r10 \n"
964 "mov.l @%0+, r11 \n"
965 "mov.l @%0+, r12 \n"
966 "mov.l @%0+, r13 \n"
967 "mov.l @%0+, r14 \n"
968 "mov.l @%0+, r15 \n"
969 "lds.l @%0+, pr \n"
970 : : "r" (addr) : "r0" /* only! */
974 /*---------------------------------------------------------------------------
975 * Put core in a power-saving state.
976 *---------------------------------------------------------------------------
978 static inline void core_sleep(void)
980 asm volatile (
981 "and.b #0x7f, @(r0, gbr) \n" /* Clear SBY (bit 7) in SBYCR */
982 "mov #0, r1 \n" /* Enable interrupts */
983 "ldc r1, sr \n" /* Following instruction cannot be interrupted */
984 "sleep \n" /* Execute standby */
985 : : "z"(&SBYCR-GBR) : "r1");
988 #elif CPU_MIPS == 32
990 /*---------------------------------------------------------------------------
991 * Start the thread running and terminate it if it returns
992 *---------------------------------------------------------------------------
994 void start_thread(void); /* Provide C access to ASM label */
995 #if 0
996 static void __attribute__((used)) __start_thread(void)
999 /* $v0 = context */
1000 asm volatile (
1001 ".set noreorder \n"
1002 "_start_thread: \n" /* Start here - no naked attribute */
1003 "lw $8, (4)$2 \n" /* Fetch thread function pointer ($8 = $t0, $2 = $v0) */
1004 "lw $29, (108)$2 \n" /* Set initial sp(=$29) */
1005 "jalr $8 \n" /* Start the thread ($8 = $t0,)*/
1006 "sw $0, (116)$2 \n" /* Clear start address ($2 = $v0) */
1007 ".set reorder \n"
1009 thread_exit();
1012 #else
1013 void start_thread(void)
1015 return;
1017 #endif
1019 /* Place context pointer in $v0 slot, function pointer in $v1 slot, and
1020 * start_thread pointer in context_start */
1021 #define THREAD_STARTUP_INIT(core, thread, function) \
1022 ({ (thread)->context.r[0] = (uint32_t)&(thread)->context, \
1023 (thread)->context.r[1] = (uint32_t)(function), \
1024 (thread)->context.start = (uint32_t)start_thread; })
1026 /*---------------------------------------------------------------------------
1027 * Store non-volatile context.
1028 *---------------------------------------------------------------------------
1030 static inline void store_context(void* addr)
1032 #if 0
1033 asm volatile (
1034 ".set noreorder \n"
1035 ".set noat \n"
1036 "sw $1, (0)%0 \n"
1037 "sw $2,(4)%0 \n" /* $v0 */
1038 "sw $3,(8)%0 \n" /* $v1 */
1039 "sw $4,(12)%0 \n" /* $a0 */
1040 "sw $5,(16)%0 \n" /* $a1 */
1041 "sw $6,(20)%0 \n" /* $a2 */
1042 "sw $7,(24)%0 \n" /* $a3 */
1043 "sw $8,(28)%0 \n" /* $t0 */
1044 "sw $9,(32)%0 \n" /* $t1 */
1045 "sw $10,(36)%0 \n" /* $t2 */
1046 "sw $11,(40)%0 \n" /* $t3 */
1047 "sw $12,(44)%0 \n" /* $t4 */
1048 "sw $13,(48)%0 \n" /* $t5 */
1049 "sw $14,(52)%0 \n" /* $t6 */
1050 "sw $15,(56)%0 \n" /* $t7 */
1051 "sw $24,(60)%0 \n" /* $t8 */
1052 "sw $25,(64)%0 \n" /* $t9 */
1053 "sw $16,(68)%0 \n" /* $s0 */
1054 "sw $17,(72)%0 \n" /* $s1 */
1055 "sw $18,(76)%0 \n" /* $s2 */
1056 "sw $19,(80)%0 \n" /* $s3 */
1057 "sw $20,(84)%0 \n" /* $s4 */
1058 "sw $21,(88)%0 \n" /* $s5 */
1059 "sw $22,(92)%0 \n" /* $s6 */
1060 "sw $23,(96)%0 \n" /* $s7 */
1061 "sw $28,(100)%0 \n" /* gp */
1062 "sw $30,(104)%0 \n" /* fp */
1063 "sw $29,(108)%0 \n" /* sp */
1064 "sw $31,(112)%0 \n" /* ra */
1065 ".set reorder \n"
1066 : : "r" (addr)
1068 #endif
1071 /*---------------------------------------------------------------------------
1072 * Load non-volatile context.
1073 *---------------------------------------------------------------------------
1075 static inline void load_context(const void* addr)
1077 #if 0
1078 asm volatile (
1079 ".set noat \n"
1080 ".set noreorder \n"
1081 "lw $8, 116(%0) \n" /* Get start address ($8 = $t0) */
1082 //"tst r0, r0 \n"
1083 "j .running \n" /* NULL -> already running */
1084 "jr $8 \n" /* $t0 = $8 = context */
1085 ".running: \n"
1086 "lw $1, (0)%0 \n"
1087 "lw $2,(4)%0 \n" /* $v0 */
1088 "lw $3,(8)%0 \n" /* $v1 */
1089 "lw $4,(12)%0 \n" /* $a0 */
1090 "lw $5,(16)%0 \n" /* $a1 */
1091 "lw $6,(20)%0 \n" /* $a2 */
1092 "lw $7,(24)%0 \n" /* $a3 */
1093 "lw $8,(28)%0 \n" /* $t0 */
1094 "lw $9,(32)%0 \n" /* $t1 */
1095 "lw $10,(36)%0 \n" /* $t2 */
1096 "lw $11,(40)%0 \n" /* $t3 */
1097 "lw $12,(44)%0 \n" /* $t4 */
1098 "lw $13,(48)%0 \n" /* $t5 */
1099 "lw $14,(52)%0 \n" /* $t6 */
1100 "lw $15,(56)%0 \n" /* $t7 */
1101 "lw $24,(60)%0 \n" /* $t8 */
1102 "lw $25,(64)%0 \n" /* $t9 */
1103 "lw $16,(68)%0 \n" /* $s0 */
1104 "lw $17,(72)%0 \n" /* $s1 */
1105 "lw $18,(76)%0 \n" /* $s2 */
1106 "lw $19,(80)%0 \n" /* $s3 */
1107 "lw $20,(84)%0 \n" /* $s4 */
1108 "lw $21,(88)%0 \n" /* $s5 */
1109 "lw $22,(92)%0 \n" /* $s6 */
1110 "lw $23,(96)%0 \n" /* $s7 */
1111 "lw $28,(100)%0 \n" /* gp */
1112 "lw $30,(104)%0 \n" /* fp */
1113 "lw $29,(108)%0 \n" /* sp */
1114 "lw $31,(112)%0 \n" /* ra */
1115 ".set reorder \n"
1116 : : "r" (addr) : "v0" /* only! */
1118 #endif
1121 /*---------------------------------------------------------------------------
1122 * Put core in a power-saving state.
1123 *---------------------------------------------------------------------------
1125 static inline void core_sleep(void)
1128 REG_CPM_LCR &= ~CPM_LCR_LPM_MASK;
1129 REG_CPM_LCR |= CPM_LCR_LPM_SLEEP;
1131 asm volatile(".set mips3 \n"
1132 "wait \n"
1133 ".set mips0 \n"
1136 REG_CPM_LCR &= ~CPM_LCR_LPM_MASK;
1137 REG_CPM_LCR |= CPM_LCR_LPM_IDLE;
1142 #endif /* CONFIG_CPU == */
1145 * End Processor-specific section
1146 ***************************************************************************/
1148 #if THREAD_EXTRA_CHECKS
1149 static void thread_panicf(const char *msg, struct thread_entry *thread)
1151 IF_COP( const unsigned int core = thread->core; )
1152 static char name[32];
1153 thread_get_name(name, 32, thread);
1154 panicf ("%s %s" IF_COP(" (%d)"), msg, name IF_COP(, core));
1156 static void thread_stkov(struct thread_entry *thread)
1158 thread_panicf("Stkov", thread);
1160 #define THREAD_PANICF(msg, thread) \
1161 thread_panicf(msg, thread)
1162 #define THREAD_ASSERT(exp, msg, thread) \
1163 ({ if (!({ exp; })) thread_panicf((msg), (thread)); })
1164 #else
1165 static void thread_stkov(struct thread_entry *thread)
1167 IF_COP( const unsigned int core = thread->core; )
1168 static char name[32];
1169 thread_get_name(name, 32, thread);
1170 panicf("Stkov %s" IF_COP(" (%d)"), name IF_COP(, core));
1172 #define THREAD_PANICF(msg, thread)
1173 #define THREAD_ASSERT(exp, msg, thread)
1174 #endif /* THREAD_EXTRA_CHECKS */
1176 /* Thread locking */
1177 #if NUM_CORES > 1
1178 #define LOCK_THREAD(thread) \
1179 ({ corelock_lock(&(thread)->slot_cl); })
1180 #define TRY_LOCK_THREAD(thread) \
1181 ({ corelock_try_lock(&thread->slot_cl); })
1182 #define UNLOCK_THREAD(thread) \
1183 ({ corelock_unlock(&(thread)->slot_cl); })
1184 #define UNLOCK_THREAD_AT_TASK_SWITCH(thread) \
1185 ({ unsigned int _core = (thread)->core; \
1186 cores[_core].blk_ops.flags |= TBOP_UNLOCK_CORELOCK; \
1187 cores[_core].blk_ops.cl_p = &(thread)->slot_cl; })
1188 #else
1189 #define LOCK_THREAD(thread) \
1190 ({ })
1191 #define TRY_LOCK_THREAD(thread) \
1192 ({ })
1193 #define UNLOCK_THREAD(thread) \
1194 ({ })
1195 #define UNLOCK_THREAD_AT_TASK_SWITCH(thread) \
1196 ({ })
1197 #endif
1199 /* RTR list */
1200 #define RTR_LOCK(core) \
1201 ({ corelock_lock(&cores[core].rtr_cl); })
1202 #define RTR_UNLOCK(core) \
1203 ({ corelock_unlock(&cores[core].rtr_cl); })
1205 #ifdef HAVE_PRIORITY_SCHEDULING
1206 #define rtr_add_entry(core, priority) \
1207 prio_add_entry(&cores[core].rtr, (priority))
1209 #define rtr_subtract_entry(core, priority) \
1210 prio_subtract_entry(&cores[core].rtr, (priority))
1212 #define rtr_move_entry(core, from, to) \
1213 prio_move_entry(&cores[core].rtr, (from), (to))
1214 #else
1215 #define rtr_add_entry(core, priority)
1216 #define rtr_add_entry_inl(core, priority)
1217 #define rtr_subtract_entry(core, priority)
1218 #define rtr_subtract_entry_inl(core, priotity)
1219 #define rtr_move_entry(core, from, to)
1220 #define rtr_move_entry_inl(core, from, to)
1221 #endif
1223 /*---------------------------------------------------------------------------
1224 * Thread list structure - circular:
1225 * +------------------------------+
1226 * | |
1227 * +--+---+<-+---+<-+---+<-+---+<-+
1228 * Head->| T | | T | | T | | T |
1229 * +->+---+->+---+->+---+->+---+--+
1230 * | |
1231 * +------------------------------+
1232 *---------------------------------------------------------------------------
1235 /*---------------------------------------------------------------------------
1236 * Adds a thread to a list of threads using "insert last". Uses the "l"
1237 * links.
1238 *---------------------------------------------------------------------------
1240 static void add_to_list_l(struct thread_entry **list,
1241 struct thread_entry *thread)
1243 struct thread_entry *l = *list;
1245 if (l == NULL)
1247 /* Insert into unoccupied list */
1248 thread->l.prev = thread;
1249 thread->l.next = thread;
1250 *list = thread;
1251 return;
1254 /* Insert last */
1255 thread->l.prev = l->l.prev;
1256 thread->l.next = l;
1257 l->l.prev->l.next = thread;
1258 l->l.prev = thread;
1261 /*---------------------------------------------------------------------------
1262 * Removes a thread from a list of threads. Uses the "l" links.
1263 *---------------------------------------------------------------------------
1265 static void remove_from_list_l(struct thread_entry **list,
1266 struct thread_entry *thread)
1268 struct thread_entry *prev, *next;
1270 next = thread->l.next;
1272 if (thread == next)
1274 /* The only item */
1275 *list = NULL;
1276 return;
1279 if (thread == *list)
1281 /* List becomes next item */
1282 *list = next;
1285 prev = thread->l.prev;
1287 /* Fix links to jump over the removed entry. */
1288 next->l.prev = prev;
1289 prev->l.next = next;
1292 /*---------------------------------------------------------------------------
1293 * Timeout list structure - circular reverse (to make "remove item" O(1)),
1294 * NULL-terminated forward (to ease the far more common forward traversal):
1295 * +------------------------------+
1296 * | |
1297 * +--+---+<-+---+<-+---+<-+---+<-+
1298 * Head->| T | | T | | T | | T |
1299 * +---+->+---+->+---+->+---+-X
1300 *---------------------------------------------------------------------------
1303 /*---------------------------------------------------------------------------
1304 * Add a thread from the core's timout list by linking the pointers in its
1305 * tmo structure.
1306 *---------------------------------------------------------------------------
1308 static void add_to_list_tmo(struct thread_entry *thread)
1310 struct thread_entry *tmo = cores[IF_COP_CORE(thread->core)].timeout;
1311 THREAD_ASSERT(thread->tmo.prev == NULL,
1312 "add_to_list_tmo->already listed", thread);
1314 thread->tmo.next = NULL;
1316 if (tmo == NULL)
1318 /* Insert into unoccupied list */
1319 thread->tmo.prev = thread;
1320 cores[IF_COP_CORE(thread->core)].timeout = thread;
1321 return;
1324 /* Insert Last */
1325 thread->tmo.prev = tmo->tmo.prev;
1326 tmo->tmo.prev->tmo.next = thread;
1327 tmo->tmo.prev = thread;
1330 /*---------------------------------------------------------------------------
1331 * Remove a thread from the core's timout list by unlinking the pointers in
1332 * its tmo structure. Sets thread->tmo.prev to NULL to indicate the timeout
1333 * is cancelled.
1334 *---------------------------------------------------------------------------
1336 static void remove_from_list_tmo(struct thread_entry *thread)
1338 struct thread_entry **list = &cores[IF_COP_CORE(thread->core)].timeout;
1339 struct thread_entry *prev = thread->tmo.prev;
1340 struct thread_entry *next = thread->tmo.next;
1342 THREAD_ASSERT(prev != NULL, "remove_from_list_tmo->not listed", thread);
1344 if (next != NULL)
1345 next->tmo.prev = prev;
1347 if (thread == *list)
1349 /* List becomes next item and empty if next == NULL */
1350 *list = next;
1351 /* Mark as unlisted */
1352 thread->tmo.prev = NULL;
1354 else
1356 if (next == NULL)
1357 (*list)->tmo.prev = prev;
1358 prev->tmo.next = next;
1359 /* Mark as unlisted */
1360 thread->tmo.prev = NULL;
1365 #ifdef HAVE_PRIORITY_SCHEDULING
1366 /*---------------------------------------------------------------------------
1367 * Priority distribution structure (one category for each possible priority):
1369 * +----+----+----+ ... +-----+
1370 * hist: | F0 | F1 | F2 | | F31 |
1371 * +----+----+----+ ... +-----+
1372 * mask: | b0 | b1 | b2 | | b31 |
1373 * +----+----+----+ ... +-----+
1375 * F = count of threads at priority category n (frequency)
1376 * b = bitmask of non-zero priority categories (occupancy)
1378 * / if H[n] != 0 : 1
1379 * b[n] = |
1380 * \ else : 0
1382 *---------------------------------------------------------------------------
1383 * Basic priority inheritance priotocol (PIP):
1385 * Mn = mutex n, Tn = thread n
1387 * A lower priority thread inherits the priority of the highest priority
1388 * thread blocked waiting for it to complete an action (such as release a
1389 * mutex or respond to a message via queue_send):
1391 * 1) T2->M1->T1
1393 * T1 owns M1, T2 is waiting for M1 to realease M1. If T2 has a higher
1394 * priority than T1 then T1 inherits the priority of T2.
1396 * 2) T3
1397 * \/
1398 * T2->M1->T1
1400 * Situation is like 1) but T2 and T3 are both queued waiting for M1 and so
1401 * T1 inherits the higher of T2 and T3.
1403 * 3) T3->M2->T2->M1->T1
1405 * T1 owns M1, T2 owns M2. If T3 has a higher priority than both T1 and T2,
1406 * then T1 inherits the priority of T3 through T2.
1408 * Blocking chains can grow arbitrarily complex (though it's best that they
1409 * not form at all very often :) and build-up from these units.
1410 *---------------------------------------------------------------------------
1413 /*---------------------------------------------------------------------------
1414 * Increment frequency at category "priority"
1415 *---------------------------------------------------------------------------
1417 static inline unsigned int prio_add_entry(
1418 struct priority_distribution *pd, int priority)
1420 unsigned int count;
1421 /* Enough size/instruction count difference for ARM makes it worth it to
1422 * use different code (192 bytes for ARM). Only thing better is ASM. */
1423 #ifdef CPU_ARM
1424 count = pd->hist[priority];
1425 if (++count == 1)
1426 pd->mask |= 1 << priority;
1427 pd->hist[priority] = count;
1428 #else /* This one's better for Coldfire */
1429 if ((count = ++pd->hist[priority]) == 1)
1430 pd->mask |= 1 << priority;
1431 #endif
1433 return count;
1436 /*---------------------------------------------------------------------------
1437 * Decrement frequency at category "priority"
1438 *---------------------------------------------------------------------------
1440 static inline unsigned int prio_subtract_entry(
1441 struct priority_distribution *pd, int priority)
1443 unsigned int count;
1445 #ifdef CPU_ARM
1446 count = pd->hist[priority];
1447 if (--count == 0)
1448 pd->mask &= ~(1 << priority);
1449 pd->hist[priority] = count;
1450 #else
1451 if ((count = --pd->hist[priority]) == 0)
1452 pd->mask &= ~(1 << priority);
1453 #endif
1455 return count;
1458 /*---------------------------------------------------------------------------
1459 * Remove from one category and add to another
1460 *---------------------------------------------------------------------------
1462 static inline void prio_move_entry(
1463 struct priority_distribution *pd, int from, int to)
1465 uint32_t mask = pd->mask;
1467 #ifdef CPU_ARM
1468 unsigned int count;
1470 count = pd->hist[from];
1471 if (--count == 0)
1472 mask &= ~(1 << from);
1473 pd->hist[from] = count;
1475 count = pd->hist[to];
1476 if (++count == 1)
1477 mask |= 1 << to;
1478 pd->hist[to] = count;
1479 #else
1480 if (--pd->hist[from] == 0)
1481 mask &= ~(1 << from);
1483 if (++pd->hist[to] == 1)
1484 mask |= 1 << to;
1485 #endif
1487 pd->mask = mask;
1490 /*---------------------------------------------------------------------------
1491 * Change the priority and rtr entry for a running thread
1492 *---------------------------------------------------------------------------
1494 static inline void set_running_thread_priority(
1495 struct thread_entry *thread, int priority)
1497 const unsigned int core = IF_COP_CORE(thread->core);
1498 RTR_LOCK(core);
1499 rtr_move_entry(core, thread->priority, priority);
1500 thread->priority = priority;
1501 RTR_UNLOCK(core);
1504 /*---------------------------------------------------------------------------
1505 * Finds the highest priority thread in a list of threads. If the list is
1506 * empty, the PRIORITY_IDLE is returned.
1508 * It is possible to use the struct priority_distribution within an object
1509 * instead of scanning the remaining threads in the list but as a compromise,
1510 * the resulting per-object memory overhead is saved at a slight speed
1511 * penalty under high contention.
1512 *---------------------------------------------------------------------------
1514 static int find_highest_priority_in_list_l(
1515 struct thread_entry * const thread)
1517 if (thread != NULL)
1519 /* Go though list until the ending up at the initial thread */
1520 int highest_priority = thread->priority;
1521 struct thread_entry *curr = thread;
1525 int priority = curr->priority;
1527 if (priority < highest_priority)
1528 highest_priority = priority;
1530 curr = curr->l.next;
1532 while (curr != thread);
1534 return highest_priority;
1537 return PRIORITY_IDLE;
1540 /*---------------------------------------------------------------------------
1541 * Register priority with blocking system and bubble it down the chain if
1542 * any until we reach the end or something is already equal or higher.
1544 * NOTE: A simultaneous circular wait could spin deadlock on multiprocessor
1545 * targets but that same action also guarantees a circular block anyway and
1546 * those are prevented, right? :-)
1547 *---------------------------------------------------------------------------
1549 static struct thread_entry *
1550 blocker_inherit_priority(struct thread_entry *current)
1552 const int priority = current->priority;
1553 struct blocker *bl = current->blocker;
1554 struct thread_entry * const tstart = current;
1555 struct thread_entry *bl_t = bl->thread;
1557 /* Blocker cannot change since the object protection is held */
1558 LOCK_THREAD(bl_t);
1560 for (;;)
1562 struct thread_entry *next;
1563 int bl_pr = bl->priority;
1565 if (priority >= bl_pr)
1566 break; /* Object priority already high enough */
1568 bl->priority = priority;
1570 /* Add this one */
1571 prio_add_entry(&bl_t->pdist, priority);
1573 if (bl_pr < PRIORITY_IDLE)
1575 /* Not first waiter - subtract old one */
1576 prio_subtract_entry(&bl_t->pdist, bl_pr);
1579 if (priority >= bl_t->priority)
1580 break; /* Thread priority high enough */
1582 if (bl_t->state == STATE_RUNNING)
1584 /* Blocking thread is a running thread therefore there are no
1585 * further blockers. Change the "run queue" on which it
1586 * resides. */
1587 set_running_thread_priority(bl_t, priority);
1588 break;
1591 bl_t->priority = priority;
1593 /* If blocking thread has a blocker, apply transitive inheritance */
1594 bl = bl_t->blocker;
1596 if (bl == NULL)
1597 break; /* End of chain or object doesn't support inheritance */
1599 next = bl->thread;
1601 if (next == tstart)
1602 break; /* Full-circle - deadlock! */
1604 UNLOCK_THREAD(current);
1606 #if NUM_CORES > 1
1607 for (;;)
1609 LOCK_THREAD(next);
1611 /* Blocker could change - retest condition */
1612 if (bl->thread == next)
1613 break;
1615 UNLOCK_THREAD(next);
1616 next = bl->thread;
1618 #endif
1619 current = bl_t;
1620 bl_t = next;
1623 UNLOCK_THREAD(bl_t);
1625 return current;
1628 /*---------------------------------------------------------------------------
1629 * Readjust priorities when waking a thread blocked waiting for another
1630 * in essence "releasing" the thread's effect on the object owner. Can be
1631 * performed from any context.
1632 *---------------------------------------------------------------------------
1634 struct thread_entry *
1635 wakeup_priority_protocol_release(struct thread_entry *thread)
1637 const int priority = thread->priority;
1638 struct blocker *bl = thread->blocker;
1639 struct thread_entry * const tstart = thread;
1640 struct thread_entry *bl_t = bl->thread;
1642 /* Blocker cannot change since object will be locked */
1643 LOCK_THREAD(bl_t);
1645 thread->blocker = NULL; /* Thread not blocked */
1647 for (;;)
1649 struct thread_entry *next;
1650 int bl_pr = bl->priority;
1652 if (priority > bl_pr)
1653 break; /* Object priority higher */
1655 next = *thread->bqp;
1657 if (next == NULL)
1659 /* No more threads in queue */
1660 prio_subtract_entry(&bl_t->pdist, bl_pr);
1661 bl->priority = PRIORITY_IDLE;
1663 else
1665 /* Check list for highest remaining priority */
1666 int queue_pr = find_highest_priority_in_list_l(next);
1668 if (queue_pr == bl_pr)
1669 break; /* Object priority not changing */
1671 /* Change queue priority */
1672 prio_move_entry(&bl_t->pdist, bl_pr, queue_pr);
1673 bl->priority = queue_pr;
1676 if (bl_pr > bl_t->priority)
1677 break; /* thread priority is higher */
1679 bl_pr = find_first_set_bit(bl_t->pdist.mask);
1681 if (bl_pr == bl_t->priority)
1682 break; /* Thread priority not changing */
1684 if (bl_t->state == STATE_RUNNING)
1686 /* No further blockers */
1687 set_running_thread_priority(bl_t, bl_pr);
1688 break;
1691 bl_t->priority = bl_pr;
1693 /* If blocking thread has a blocker, apply transitive inheritance */
1694 bl = bl_t->blocker;
1696 if (bl == NULL)
1697 break; /* End of chain or object doesn't support inheritance */
1699 next = bl->thread;
1701 if (next == tstart)
1702 break; /* Full-circle - deadlock! */
1704 UNLOCK_THREAD(thread);
1706 #if NUM_CORES > 1
1707 for (;;)
1709 LOCK_THREAD(next);
1711 /* Blocker could change - retest condition */
1712 if (bl->thread == next)
1713 break;
1715 UNLOCK_THREAD(next);
1716 next = bl->thread;
1718 #endif
1719 thread = bl_t;
1720 bl_t = next;
1723 UNLOCK_THREAD(bl_t);
1725 #if NUM_CORES > 1
1726 if (thread != tstart)
1728 /* Relock original if it changed */
1729 LOCK_THREAD(tstart);
1731 #endif
1733 return cores[CURRENT_CORE].running;
1736 /*---------------------------------------------------------------------------
1737 * Transfer ownership to a thread waiting for an objects and transfer
1738 * inherited priority boost from other waiters. This algorithm knows that
1739 * blocking chains may only unblock from the very end.
1741 * Only the owning thread itself may call this and so the assumption that
1742 * it is the running thread is made.
1743 *---------------------------------------------------------------------------
1745 struct thread_entry *
1746 wakeup_priority_protocol_transfer(struct thread_entry *thread)
1748 /* Waking thread inherits priority boost from object owner */
1749 struct blocker *bl = thread->blocker;
1750 struct thread_entry *bl_t = bl->thread;
1751 struct thread_entry *next;
1752 int bl_pr;
1754 THREAD_ASSERT(thread_get_current() == bl_t,
1755 "UPPT->wrong thread", thread_get_current());
1757 LOCK_THREAD(bl_t);
1759 bl_pr = bl->priority;
1761 /* Remove the object's boost from the owning thread */
1762 if (prio_subtract_entry(&bl_t->pdist, bl_pr) == 0 &&
1763 bl_pr <= bl_t->priority)
1765 /* No more threads at this priority are waiting and the old level is
1766 * at least the thread level */
1767 int priority = find_first_set_bit(bl_t->pdist.mask);
1769 if (priority != bl_t->priority)
1771 /* Adjust this thread's priority */
1772 set_running_thread_priority(bl_t, priority);
1776 next = *thread->bqp;
1778 if (next == NULL)
1780 /* Expected shortcut - no more waiters */
1781 bl_pr = PRIORITY_IDLE;
1783 else
1785 if (thread->priority <= bl_pr)
1787 /* Need to scan threads remaining in queue */
1788 bl_pr = find_highest_priority_in_list_l(next);
1791 if (prio_add_entry(&thread->pdist, bl_pr) == 1 &&
1792 bl_pr < thread->priority)
1794 /* Thread priority must be raised */
1795 thread->priority = bl_pr;
1799 bl->thread = thread; /* This thread pwns */
1800 bl->priority = bl_pr; /* Save highest blocked priority */
1801 thread->blocker = NULL; /* Thread not blocked */
1803 UNLOCK_THREAD(bl_t);
1805 return bl_t;
1808 /*---------------------------------------------------------------------------
1809 * No threads must be blocked waiting for this thread except for it to exit.
1810 * The alternative is more elaborate cleanup and object registration code.
1811 * Check this for risk of silent data corruption when objects with
1812 * inheritable blocking are abandoned by the owner - not precise but may
1813 * catch something.
1814 *---------------------------------------------------------------------------
1816 static void check_for_obj_waiters(const char *function, struct thread_entry *thread)
1818 /* Only one bit in the mask should be set with a frequency on 1 which
1819 * represents the thread's own base priority */
1820 uint32_t mask = thread->pdist.mask;
1821 if ((mask & (mask - 1)) != 0 ||
1822 thread->pdist.hist[find_first_set_bit(mask)] > 1)
1824 unsigned char name[32];
1825 thread_get_name(name, 32, thread);
1826 panicf("%s->%s with obj. waiters", function, name);
1829 #endif /* HAVE_PRIORITY_SCHEDULING */
1831 /*---------------------------------------------------------------------------
1832 * Move a thread back to a running state on its core.
1833 *---------------------------------------------------------------------------
1835 static void core_schedule_wakeup(struct thread_entry *thread)
1837 const unsigned int core = IF_COP_CORE(thread->core);
1839 RTR_LOCK(core);
1841 thread->state = STATE_RUNNING;
1843 add_to_list_l(&cores[core].running, thread);
1844 rtr_add_entry(core, thread->priority);
1846 RTR_UNLOCK(core);
1848 #if NUM_CORES > 1
1849 if (core != CURRENT_CORE)
1850 core_wake(core);
1851 #endif
1854 /*---------------------------------------------------------------------------
1855 * Check the core's timeout list when at least one thread is due to wake.
1856 * Filtering for the condition is done before making the call. Resets the
1857 * tick when the next check will occur.
1858 *---------------------------------------------------------------------------
1860 void check_tmo_threads(void)
1862 const unsigned int core = CURRENT_CORE;
1863 const long tick = current_tick; /* snapshot the current tick */
1864 long next_tmo_check = tick + 60*HZ; /* minimum duration: once/minute */
1865 struct thread_entry *next = cores[core].timeout;
1867 /* If there are no processes waiting for a timeout, just keep the check
1868 tick from falling into the past. */
1870 /* Break the loop once we have walked through the list of all
1871 * sleeping processes or have removed them all. */
1872 while (next != NULL)
1874 /* Check sleeping threads. Allow interrupts between checks. */
1875 enable_irq();
1877 struct thread_entry *curr = next;
1879 next = curr->tmo.next;
1881 /* Lock thread slot against explicit wakeup */
1882 disable_irq();
1883 LOCK_THREAD(curr);
1885 unsigned state = curr->state;
1887 if (state < TIMEOUT_STATE_FIRST)
1889 /* Cleanup threads no longer on a timeout but still on the
1890 * list. */
1891 remove_from_list_tmo(curr);
1893 else if (TIME_BEFORE(tick, curr->tmo_tick))
1895 /* Timeout still pending - this will be the usual case */
1896 if (TIME_BEFORE(curr->tmo_tick, next_tmo_check))
1898 /* Earliest timeout found so far - move the next check up
1899 to its time */
1900 next_tmo_check = curr->tmo_tick;
1903 else
1905 /* Sleep timeout has been reached so bring the thread back to
1906 * life again. */
1907 if (state == STATE_BLOCKED_W_TMO)
1909 #if NUM_CORES > 1
1910 /* Lock the waiting thread's kernel object */
1911 struct corelock *ocl = curr->obj_cl;
1913 if (corelock_try_lock(ocl) == 0)
1915 /* Need to retry in the correct order though the need is
1916 * unlikely */
1917 UNLOCK_THREAD(curr);
1918 corelock_lock(ocl);
1919 LOCK_THREAD(curr);
1921 if (curr->state != STATE_BLOCKED_W_TMO)
1923 /* Thread was woken or removed explicitely while slot
1924 * was unlocked */
1925 corelock_unlock(ocl);
1926 remove_from_list_tmo(curr);
1927 UNLOCK_THREAD(curr);
1928 continue;
1931 #endif /* NUM_CORES */
1933 remove_from_list_l(curr->bqp, curr);
1935 #ifdef HAVE_WAKEUP_EXT_CB
1936 if (curr->wakeup_ext_cb != NULL)
1937 curr->wakeup_ext_cb(curr);
1938 #endif
1940 #ifdef HAVE_PRIORITY_SCHEDULING
1941 if (curr->blocker != NULL)
1942 wakeup_priority_protocol_release(curr);
1943 #endif
1944 corelock_unlock(ocl);
1946 /* else state == STATE_SLEEPING */
1948 remove_from_list_tmo(curr);
1950 RTR_LOCK(core);
1952 curr->state = STATE_RUNNING;
1954 add_to_list_l(&cores[core].running, curr);
1955 rtr_add_entry(core, curr->priority);
1957 RTR_UNLOCK(core);
1960 UNLOCK_THREAD(curr);
1963 cores[core].next_tmo_check = next_tmo_check;
1966 /*---------------------------------------------------------------------------
1967 * Performs operations that must be done before blocking a thread but after
1968 * the state is saved.
1969 *---------------------------------------------------------------------------
1971 #if NUM_CORES > 1
1972 static inline void run_blocking_ops(
1973 unsigned int core, struct thread_entry *thread)
1975 struct thread_blk_ops *ops = &cores[core].blk_ops;
1976 const unsigned flags = ops->flags;
1978 if (flags == TBOP_CLEAR)
1979 return;
1981 switch (flags)
1983 case TBOP_SWITCH_CORE:
1984 core_switch_blk_op(core, thread);
1985 /* Fall-through */
1986 case TBOP_UNLOCK_CORELOCK:
1987 corelock_unlock(ops->cl_p);
1988 break;
1991 ops->flags = TBOP_CLEAR;
1993 #endif /* NUM_CORES > 1 */
1995 #ifdef RB_PROFILE
1996 void profile_thread(void)
1998 profstart(cores[CURRENT_CORE].running - threads);
2000 #endif
2002 /*---------------------------------------------------------------------------
2003 * Prepares a thread to block on an object's list and/or for a specified
2004 * duration - expects object and slot to be appropriately locked if needed
2005 * and interrupts to be masked.
2006 *---------------------------------------------------------------------------
2008 static inline void block_thread_on_l(struct thread_entry *thread,
2009 unsigned state)
2011 /* If inlined, unreachable branches will be pruned with no size penalty
2012 because state is passed as a constant parameter. */
2013 const unsigned int core = IF_COP_CORE(thread->core);
2015 /* Remove the thread from the list of running threads. */
2016 RTR_LOCK(core);
2017 remove_from_list_l(&cores[core].running, thread);
2018 rtr_subtract_entry(core, thread->priority);
2019 RTR_UNLOCK(core);
2021 /* Add a timeout to the block if not infinite */
2022 switch (state)
2024 case STATE_BLOCKED:
2025 case STATE_BLOCKED_W_TMO:
2026 /* Put the thread into a new list of inactive threads. */
2027 add_to_list_l(thread->bqp, thread);
2029 if (state == STATE_BLOCKED)
2030 break;
2032 /* Fall-through */
2033 case STATE_SLEEPING:
2034 /* If this thread times out sooner than any other thread, update
2035 next_tmo_check to its timeout */
2036 if (TIME_BEFORE(thread->tmo_tick, cores[core].next_tmo_check))
2038 cores[core].next_tmo_check = thread->tmo_tick;
2041 if (thread->tmo.prev == NULL)
2043 add_to_list_tmo(thread);
2045 /* else thread was never removed from list - just keep it there */
2046 break;
2049 /* Remember the the next thread about to block. */
2050 cores[core].block_task = thread;
2052 /* Report new state. */
2053 thread->state = state;
2056 /*---------------------------------------------------------------------------
2057 * Switch thread in round robin fashion for any given priority. Any thread
2058 * that removed itself from the running list first must specify itself in
2059 * the paramter.
2061 * INTERNAL: Intended for use by kernel and not for programs.
2062 *---------------------------------------------------------------------------
2064 void switch_thread(void)
2066 #ifndef ONDA_VX747
2068 const unsigned int core = CURRENT_CORE;
2069 struct thread_entry *block = cores[core].block_task;
2070 struct thread_entry *thread = cores[core].running;
2072 /* Get context to save - next thread to run is unknown until all wakeups
2073 * are evaluated */
2074 if (block != NULL)
2076 cores[core].block_task = NULL;
2078 #if NUM_CORES > 1
2079 if (thread == block)
2081 /* This was the last thread running and another core woke us before
2082 * reaching here. Force next thread selection to give tmo threads or
2083 * other threads woken before this block a first chance. */
2084 block = NULL;
2086 else
2087 #endif
2089 /* Blocking task is the old one */
2090 thread = block;
2094 #ifdef RB_PROFILE
2095 profile_thread_stopped(thread - threads);
2096 #endif
2098 /* Begin task switching by saving our current context so that we can
2099 * restore the state of the current thread later to the point prior
2100 * to this call. */
2101 store_context(&thread->context);
2103 /* Check if the current thread stack is overflown */
2104 if (thread->stack[0] != DEADBEEF)
2105 thread_stkov(thread);
2107 #if NUM_CORES > 1
2108 /* Run any blocking operations requested before switching/sleeping */
2109 run_blocking_ops(core, thread);
2110 #endif
2112 #ifdef HAVE_PRIORITY_SCHEDULING
2113 IF_NO_SKIP_YIELD( if (thread->skip_count != -1) )
2114 /* Reset the value of thread's skip count */
2115 thread->skip_count = 0;
2116 #endif
2118 for (;;)
2120 /* If there are threads on a timeout and the earliest wakeup is due,
2121 * check the list and wake any threads that need to start running
2122 * again. */
2123 if (!TIME_BEFORE(current_tick, cores[core].next_tmo_check))
2125 check_tmo_threads();
2128 disable_irq();
2129 RTR_LOCK(core);
2131 thread = cores[core].running;
2133 if (thread == NULL)
2135 /* Enter sleep mode to reduce power usage - woken up on interrupt
2136 * or wakeup request from another core - expected to enable
2137 * interrupts. */
2138 RTR_UNLOCK(core);
2139 core_sleep(IF_COP(core));
2141 else
2143 #ifdef HAVE_PRIORITY_SCHEDULING
2144 /* Select the new task based on priorities and the last time a
2145 * process got CPU time relative to the highest priority runnable
2146 * task. */
2147 struct priority_distribution *pd = &cores[core].rtr;
2148 int max = find_first_set_bit(pd->mask);
2150 if (block == NULL)
2152 /* Not switching on a block, tentatively select next thread */
2153 thread = thread->l.next;
2156 for (;;)
2158 int priority = thread->priority;
2159 int diff;
2161 /* This ridiculously simple method of aging seems to work
2162 * suspiciously well. It does tend to reward CPU hogs (under
2163 * yielding) but that's generally not desirable at all. On the
2164 * plus side, it, relatively to other threads, penalizes excess
2165 * yielding which is good if some high priority thread is
2166 * performing no useful work such as polling for a device to be
2167 * ready. Of course, aging is only employed when higher and lower
2168 * priority threads are runnable. The highest priority runnable
2169 * thread(s) are never skipped. */
2170 if (priority <= max ||
2171 IF_NO_SKIP_YIELD( thread->skip_count == -1 || )
2172 (diff = priority - max, ++thread->skip_count > diff*diff))
2174 cores[core].running = thread;
2175 break;
2178 thread = thread->l.next;
2180 #else
2181 /* Without priority use a simple FCFS algorithm */
2182 if (block == NULL)
2184 /* Not switching on a block, select next thread */
2185 thread = thread->l.next;
2186 cores[core].running = thread;
2188 #endif /* HAVE_PRIORITY_SCHEDULING */
2190 RTR_UNLOCK(core);
2191 enable_irq();
2192 break;
2196 /* And finally give control to the next thread. */
2197 load_context(&thread->context);
2199 #ifdef RB_PROFILE
2200 profile_thread_started(thread - threads);
2201 #endif
2203 #endif
2206 /*---------------------------------------------------------------------------
2207 * Sleeps a thread for at least a specified number of ticks with zero being
2208 * a wait until the next tick.
2210 * INTERNAL: Intended for use by kernel and not for programs.
2211 *---------------------------------------------------------------------------
2213 void sleep_thread(int ticks)
2215 struct thread_entry *current = cores[CURRENT_CORE].running;
2217 LOCK_THREAD(current);
2219 /* Set our timeout, remove from run list and join timeout list. */
2220 current->tmo_tick = current_tick + ticks + 1;
2221 block_thread_on_l(current, STATE_SLEEPING);
2223 UNLOCK_THREAD(current);
2226 /*---------------------------------------------------------------------------
2227 * Indefinitely block a thread on a blocking queue for explicit wakeup.
2229 * INTERNAL: Intended for use by kernel objects and not for programs.
2230 *---------------------------------------------------------------------------
2232 void block_thread(struct thread_entry *current)
2234 /* Set the state to blocked and take us off of the run queue until we
2235 * are explicitly woken */
2236 LOCK_THREAD(current);
2238 /* Set the list for explicit wakeup */
2239 block_thread_on_l(current, STATE_BLOCKED);
2241 #ifdef HAVE_PRIORITY_SCHEDULING
2242 if (current->blocker != NULL)
2244 /* Object supports PIP */
2245 current = blocker_inherit_priority(current);
2247 #endif
2249 UNLOCK_THREAD(current);
2252 /*---------------------------------------------------------------------------
2253 * Block a thread on a blocking queue for a specified time interval or until
2254 * explicitly woken - whichever happens first.
2256 * INTERNAL: Intended for use by kernel objects and not for programs.
2257 *---------------------------------------------------------------------------
2259 void block_thread_w_tmo(struct thread_entry *current, int timeout)
2261 /* Get the entry for the current running thread. */
2262 LOCK_THREAD(current);
2264 /* Set the state to blocked with the specified timeout */
2265 current->tmo_tick = current_tick + timeout;
2267 /* Set the list for explicit wakeup */
2268 block_thread_on_l(current, STATE_BLOCKED_W_TMO);
2270 #ifdef HAVE_PRIORITY_SCHEDULING
2271 if (current->blocker != NULL)
2273 /* Object supports PIP */
2274 current = blocker_inherit_priority(current);
2276 #endif
2278 UNLOCK_THREAD(current);
2281 /*---------------------------------------------------------------------------
2282 * Explicitly wakeup a thread on a blocking queue. Only effects threads of
2283 * STATE_BLOCKED and STATE_BLOCKED_W_TMO.
2285 * This code should be considered a critical section by the caller meaning
2286 * that the object's corelock should be held.
2288 * INTERNAL: Intended for use by kernel objects and not for programs.
2289 *---------------------------------------------------------------------------
2291 unsigned int wakeup_thread(struct thread_entry **list)
2293 struct thread_entry *thread = *list;
2294 unsigned int result = THREAD_NONE;
2296 /* Check if there is a blocked thread at all. */
2297 if (thread == NULL)
2298 return result;
2300 LOCK_THREAD(thread);
2302 /* Determine thread's current state. */
2303 switch (thread->state)
2305 case STATE_BLOCKED:
2306 case STATE_BLOCKED_W_TMO:
2307 remove_from_list_l(list, thread);
2309 result = THREAD_OK;
2311 #ifdef HAVE_PRIORITY_SCHEDULING
2312 struct thread_entry *current;
2313 struct blocker *bl = thread->blocker;
2315 if (bl == NULL)
2317 /* No inheritance - just boost the thread by aging */
2318 IF_NO_SKIP_YIELD( if (thread->skip_count != -1) )
2319 thread->skip_count = thread->priority;
2320 current = cores[CURRENT_CORE].running;
2322 else
2324 /* Call the specified unblocking PIP */
2325 current = bl->wakeup_protocol(thread);
2328 if (current != NULL && thread->priority < current->priority
2329 IF_COP( && thread->core == current->core ))
2331 /* Woken thread is higher priority and exists on the same CPU core;
2332 * recommend a task switch. Knowing if this is an interrupt call
2333 * would be helpful here. */
2334 result |= THREAD_SWITCH;
2336 #endif /* HAVE_PRIORITY_SCHEDULING */
2338 core_schedule_wakeup(thread);
2339 break;
2341 /* Nothing to do. State is not blocked. */
2342 #if THREAD_EXTRA_CHECKS
2343 default:
2344 THREAD_PANICF("wakeup_thread->block invalid", thread);
2345 case STATE_RUNNING:
2346 case STATE_KILLED:
2347 break;
2348 #endif
2351 UNLOCK_THREAD(thread);
2352 return result;
2355 /*---------------------------------------------------------------------------
2356 * Wakeup an entire queue of threads - returns bitwise-or of return bitmask
2357 * from each operation or THREAD_NONE of nothing was awakened. Object owning
2358 * the queue must be locked first.
2360 * INTERNAL: Intended for use by kernel objects and not for programs.
2361 *---------------------------------------------------------------------------
2363 unsigned int thread_queue_wake(struct thread_entry **list)
2365 unsigned result = THREAD_NONE;
2367 for (;;)
2369 unsigned int rc = wakeup_thread(list);
2371 if (rc == THREAD_NONE)
2372 break; /* No more threads */
2374 result |= rc;
2377 return result;
2380 /*---------------------------------------------------------------------------
2381 * Find an empty thread slot or MAXTHREADS if none found. The slot returned
2382 * will be locked on multicore.
2383 *---------------------------------------------------------------------------
2385 static struct thread_entry * find_empty_thread_slot(void)
2387 /* Any slot could be on an interrupt-accessible list */
2388 IF_COP( int oldlevel = disable_irq_save(); )
2389 struct thread_entry *thread = NULL;
2390 int n;
2392 for (n = 0; n < MAXTHREADS; n++)
2394 /* Obtain current slot state - lock it on multicore */
2395 struct thread_entry *t = &threads[n];
2396 LOCK_THREAD(t);
2398 if (t->state == STATE_KILLED IF_COP( && t->name != THREAD_DESTRUCT ))
2400 /* Slot is empty - leave it locked and caller will unlock */
2401 thread = t;
2402 break;
2405 /* Finished examining slot - no longer busy - unlock on multicore */
2406 UNLOCK_THREAD(t);
2409 IF_COP( restore_irq(oldlevel); ) /* Reenable interrups - this slot is
2410 not accesible to them yet */
2411 return thread;
2415 /*---------------------------------------------------------------------------
2416 * Place the current core in idle mode - woken up on interrupt or wake
2417 * request from another core.
2418 *---------------------------------------------------------------------------
2420 void core_idle(void)
2422 IF_COP( const unsigned int core = CURRENT_CORE; )
2423 disable_irq();
2424 core_sleep(IF_COP(core));
2427 /*---------------------------------------------------------------------------
2428 * Create a thread. If using a dual core architecture, specify which core to
2429 * start the thread on.
2431 * Return ID if context area could be allocated, else NULL.
2432 *---------------------------------------------------------------------------
2434 struct thread_entry*
2435 create_thread(void (*function)(void), void* stack, size_t stack_size,
2436 unsigned flags, const char *name
2437 IF_PRIO(, int priority)
2438 IF_COP(, unsigned int core))
2440 unsigned int i;
2441 unsigned int stack_words;
2442 uintptr_t stackptr, stackend;
2443 struct thread_entry *thread;
2444 unsigned state;
2445 int oldlevel;
2447 thread = find_empty_thread_slot();
2448 if (thread == NULL)
2450 return NULL;
2453 oldlevel = disable_irq_save();
2455 /* Munge the stack to make it easy to spot stack overflows */
2456 stackptr = ALIGN_UP((uintptr_t)stack, sizeof (uintptr_t));
2457 stackend = ALIGN_DOWN((uintptr_t)stack + stack_size, sizeof (uintptr_t));
2458 stack_size = stackend - stackptr;
2459 stack_words = stack_size / sizeof (uintptr_t);
2461 for (i = 0; i < stack_words; i++)
2463 ((uintptr_t *)stackptr)[i] = DEADBEEF;
2466 /* Store interesting information */
2467 thread->name = name;
2468 thread->stack = (uintptr_t *)stackptr;
2469 thread->stack_size = stack_size;
2470 thread->queue = NULL;
2471 #ifdef HAVE_WAKEUP_EXT_CB
2472 thread->wakeup_ext_cb = NULL;
2473 #endif
2474 #ifdef HAVE_SCHEDULER_BOOSTCTRL
2475 thread->cpu_boost = 0;
2476 #endif
2477 #ifdef HAVE_PRIORITY_SCHEDULING
2478 memset(&thread->pdist, 0, sizeof(thread->pdist));
2479 thread->blocker = NULL;
2480 thread->base_priority = priority;
2481 thread->priority = priority;
2482 thread->skip_count = priority;
2483 prio_add_entry(&thread->pdist, priority);
2484 #endif
2486 #if NUM_CORES > 1
2487 thread->core = core;
2489 /* Writeback stack munging or anything else before starting */
2490 if (core != CURRENT_CORE)
2492 flush_icache();
2494 #endif
2496 /* Thread is not on any timeout list but be a bit paranoid */
2497 thread->tmo.prev = NULL;
2499 state = (flags & CREATE_THREAD_FROZEN) ?
2500 STATE_FROZEN : STATE_RUNNING;
2502 thread->context.sp = (typeof (thread->context.sp))stackend;
2504 /* Load the thread's context structure with needed startup information */
2505 THREAD_STARTUP_INIT(core, thread, function);
2507 thread->state = state;
2509 if (state == STATE_RUNNING)
2510 core_schedule_wakeup(thread);
2512 UNLOCK_THREAD(thread);
2514 restore_irq(oldlevel);
2516 return thread;
2519 #ifdef HAVE_SCHEDULER_BOOSTCTRL
2520 /*---------------------------------------------------------------------------
2521 * Change the boost state of a thread boosting or unboosting the CPU
2522 * as required.
2523 *---------------------------------------------------------------------------
2525 static inline void boost_thread(struct thread_entry *thread, bool boost)
2527 if ((thread->cpu_boost != 0) != boost)
2529 thread->cpu_boost = boost;
2530 cpu_boost(boost);
2534 void trigger_cpu_boost(void)
2536 struct thread_entry *current = cores[CURRENT_CORE].running;
2537 boost_thread(current, true);
2540 void cancel_cpu_boost(void)
2542 struct thread_entry *current = cores[CURRENT_CORE].running;
2543 boost_thread(current, false);
2545 #endif /* HAVE_SCHEDULER_BOOSTCTRL */
2547 /*---------------------------------------------------------------------------
2548 * Block the current thread until another thread terminates. A thread may
2549 * wait on itself to terminate which prevents it from running again and it
2550 * will need to be killed externally.
2551 * Parameter is the ID as returned from create_thread().
2552 *---------------------------------------------------------------------------
2554 void thread_wait(struct thread_entry *thread)
2556 struct thread_entry *current = cores[CURRENT_CORE].running;
2558 if (thread == NULL)
2559 thread = current;
2561 /* Lock thread-as-waitable-object lock */
2562 corelock_lock(&thread->waiter_cl);
2564 /* Be sure it hasn't been killed yet */
2565 if (thread->state != STATE_KILLED)
2567 IF_COP( current->obj_cl = &thread->waiter_cl; )
2568 current->bqp = &thread->queue;
2570 disable_irq();
2571 block_thread(current);
2573 corelock_unlock(&thread->waiter_cl);
2575 switch_thread();
2576 return;
2579 corelock_unlock(&thread->waiter_cl);
2582 /*---------------------------------------------------------------------------
2583 * Exit the current thread. The Right Way to Do Things (TM).
2584 *---------------------------------------------------------------------------
2586 void thread_exit(void)
2588 const unsigned int core = CURRENT_CORE;
2589 struct thread_entry *current = cores[core].running;
2591 /* Cancel CPU boost if any */
2592 cancel_cpu_boost();
2594 disable_irq();
2596 corelock_lock(&current->waiter_cl);
2597 LOCK_THREAD(current);
2599 #if defined (ALLOW_REMOVE_THREAD) && NUM_CORES > 1
2600 if (current->name == THREAD_DESTRUCT)
2602 /* Thread being killed - become a waiter */
2603 UNLOCK_THREAD(current);
2604 corelock_unlock(&current->waiter_cl);
2605 thread_wait(current);
2606 THREAD_PANICF("thread_exit->WK:*R", current);
2608 #endif
2610 #ifdef HAVE_PRIORITY_SCHEDULING
2611 check_for_obj_waiters("thread_exit", current);
2612 #endif
2614 if (current->tmo.prev != NULL)
2616 /* Cancel pending timeout list removal */
2617 remove_from_list_tmo(current);
2620 /* Switch tasks and never return */
2621 block_thread_on_l(current, STATE_KILLED);
2623 #if NUM_CORES > 1
2624 /* Switch to the idle stack if not on the main core (where "main"
2625 * runs) - we can hope gcc doesn't need the old stack beyond this
2626 * point. */
2627 if (core != CPU)
2629 switch_to_idle_stack(core);
2632 flush_icache();
2633 #endif
2634 current->name = NULL;
2636 /* Signal this thread */
2637 thread_queue_wake(&current->queue);
2638 corelock_unlock(&current->waiter_cl);
2639 /* Slot must be unusable until thread is really gone */
2640 UNLOCK_THREAD_AT_TASK_SWITCH(current);
2641 switch_thread();
2642 /* This should never and must never be reached - if it is, the
2643 * state is corrupted */
2644 THREAD_PANICF("thread_exit->K:*R", current);
2647 #ifdef ALLOW_REMOVE_THREAD
2648 /*---------------------------------------------------------------------------
2649 * Remove a thread from the scheduler. Not The Right Way to Do Things in
2650 * normal programs.
2652 * Parameter is the ID as returned from create_thread().
2654 * Use with care on threads that are not under careful control as this may
2655 * leave various objects in an undefined state.
2656 *---------------------------------------------------------------------------
2658 void remove_thread(struct thread_entry *thread)
2660 #if NUM_CORES > 1
2661 /* core is not constant here because of core switching */
2662 unsigned int core = CURRENT_CORE;
2663 unsigned int old_core = NUM_CORES;
2664 struct corelock *ocl = NULL;
2665 #else
2666 const unsigned int core = CURRENT_CORE;
2667 #endif
2668 struct thread_entry *current = cores[core].running;
2670 unsigned state;
2671 int oldlevel;
2673 if (thread == NULL)
2674 thread = current;
2676 if (thread == current)
2677 thread_exit(); /* Current thread - do normal exit */
2679 oldlevel = disable_irq_save();
2681 corelock_lock(&thread->waiter_cl);
2682 LOCK_THREAD(thread);
2684 state = thread->state;
2686 if (state == STATE_KILLED)
2688 goto thread_killed;
2691 #if NUM_CORES > 1
2692 if (thread->name == THREAD_DESTRUCT)
2694 /* Thread being killed - become a waiter */
2695 UNLOCK_THREAD(thread);
2696 corelock_unlock(&thread->waiter_cl);
2697 restore_irq(oldlevel);
2698 thread_wait(thread);
2699 return;
2702 thread->name = THREAD_DESTRUCT; /* Slot can't be used for now */
2704 #ifdef HAVE_PRIORITY_SCHEDULING
2705 check_for_obj_waiters("remove_thread", thread);
2706 #endif
2708 if (thread->core != core)
2710 /* Switch cores and safely extract the thread there */
2711 /* Slot HAS to be unlocked or a deadlock could occur which means other
2712 * threads have to be guided into becoming thread waiters if they
2713 * attempt to remove it. */
2714 unsigned int new_core = thread->core;
2716 corelock_unlock(&thread->waiter_cl);
2718 UNLOCK_THREAD(thread);
2719 restore_irq(oldlevel);
2721 old_core = switch_core(new_core);
2723 oldlevel = disable_irq_save();
2725 corelock_lock(&thread->waiter_cl);
2726 LOCK_THREAD(thread);
2728 state = thread->state;
2729 core = new_core;
2730 /* Perform the extraction and switch ourselves back to the original
2731 processor */
2733 #endif /* NUM_CORES > 1 */
2735 if (thread->tmo.prev != NULL)
2737 /* Clean thread off the timeout list if a timeout check hasn't
2738 * run yet */
2739 remove_from_list_tmo(thread);
2742 #ifdef HAVE_SCHEDULER_BOOSTCTRL
2743 /* Cancel CPU boost if any */
2744 boost_thread(thread, false);
2745 #endif
2747 IF_COP( retry_state: )
2749 switch (state)
2751 case STATE_RUNNING:
2752 RTR_LOCK(core);
2753 /* Remove thread from ready to run tasks */
2754 remove_from_list_l(&cores[core].running, thread);
2755 rtr_subtract_entry(core, thread->priority);
2756 RTR_UNLOCK(core);
2757 break;
2758 case STATE_BLOCKED:
2759 case STATE_BLOCKED_W_TMO:
2760 /* Remove thread from the queue it's blocked on - including its
2761 * own if waiting there */
2762 #if NUM_CORES > 1
2763 if (&thread->waiter_cl != thread->obj_cl)
2765 ocl = thread->obj_cl;
2767 if (corelock_try_lock(ocl) == 0)
2769 UNLOCK_THREAD(thread);
2770 corelock_lock(ocl);
2771 LOCK_THREAD(thread);
2773 if (thread->state != state)
2775 /* Something woke the thread */
2776 state = thread->state;
2777 corelock_unlock(ocl);
2778 goto retry_state;
2782 #endif
2783 remove_from_list_l(thread->bqp, thread);
2785 #ifdef HAVE_WAKEUP_EXT_CB
2786 if (thread->wakeup_ext_cb != NULL)
2787 thread->wakeup_ext_cb(thread);
2788 #endif
2790 #ifdef HAVE_PRIORITY_SCHEDULING
2791 if (thread->blocker != NULL)
2793 /* Remove thread's priority influence from its chain */
2794 wakeup_priority_protocol_release(thread);
2796 #endif
2798 #if NUM_CORES > 1
2799 if (ocl != NULL)
2800 corelock_unlock(ocl);
2801 #endif
2802 break;
2803 /* Otherwise thread is frozen and hasn't run yet */
2806 thread->state = STATE_KILLED;
2808 /* If thread was waiting on itself, it will have been removed above.
2809 * The wrong order would result in waking the thread first and deadlocking
2810 * since the slot is already locked. */
2811 thread_queue_wake(&thread->queue);
2813 thread->name = NULL;
2815 thread_killed: /* Thread was already killed */
2816 /* Removal complete - safe to unlock and reenable interrupts */
2817 corelock_unlock(&thread->waiter_cl);
2818 UNLOCK_THREAD(thread);
2819 restore_irq(oldlevel);
2821 #if NUM_CORES > 1
2822 if (old_core < NUM_CORES)
2824 /* Did a removal on another processor's thread - switch back to
2825 native core */
2826 switch_core(old_core);
2828 #endif
2830 #endif /* ALLOW_REMOVE_THREAD */
2832 #ifdef HAVE_PRIORITY_SCHEDULING
2833 /*---------------------------------------------------------------------------
2834 * Sets the thread's relative base priority for the core it runs on. Any
2835 * needed inheritance changes also may happen.
2836 *---------------------------------------------------------------------------
2838 int thread_set_priority(struct thread_entry *thread, int priority)
2840 int old_base_priority = -1;
2842 /* A little safety measure */
2843 if (priority < HIGHEST_PRIORITY || priority > LOWEST_PRIORITY)
2844 return -1;
2846 if (thread == NULL)
2847 thread = cores[CURRENT_CORE].running;
2849 /* Thread could be on any list and therefore on an interrupt accessible
2850 one - disable interrupts */
2851 int oldlevel = disable_irq_save();
2853 LOCK_THREAD(thread);
2855 /* Make sure it's not killed */
2856 if (thread->state != STATE_KILLED)
2858 int old_priority = thread->priority;
2860 old_base_priority = thread->base_priority;
2861 thread->base_priority = priority;
2863 prio_move_entry(&thread->pdist, old_base_priority, priority);
2864 priority = find_first_set_bit(thread->pdist.mask);
2866 if (old_priority == priority)
2868 /* No priority change - do nothing */
2870 else if (thread->state == STATE_RUNNING)
2872 /* This thread is running - change location on the run
2873 * queue. No transitive inheritance needed. */
2874 set_running_thread_priority(thread, priority);
2876 else
2878 thread->priority = priority;
2880 if (thread->blocker != NULL)
2882 /* Bubble new priority down the chain */
2883 struct blocker *bl = thread->blocker; /* Blocker struct */
2884 struct thread_entry *bl_t = bl->thread; /* Blocking thread */
2885 struct thread_entry * const tstart = thread; /* Initial thread */
2886 const int highest = MIN(priority, old_priority); /* Higher of new or old */
2888 for (;;)
2890 struct thread_entry *next; /* Next thread to check */
2891 int bl_pr; /* Highest blocked thread */
2892 int queue_pr; /* New highest blocked thread */
2893 #if NUM_CORES > 1
2894 /* Owner can change but thread cannot be dislodged - thread
2895 * may not be the first in the queue which allows other
2896 * threads ahead in the list to be given ownership during the
2897 * operation. If thread is next then the waker will have to
2898 * wait for us and the owner of the object will remain fixed.
2899 * If we successfully grab the owner -- which at some point
2900 * is guaranteed -- then the queue remains fixed until we
2901 * pass by. */
2902 for (;;)
2904 LOCK_THREAD(bl_t);
2906 /* Double-check the owner - retry if it changed */
2907 if (bl->thread == bl_t)
2908 break;
2910 UNLOCK_THREAD(bl_t);
2911 bl_t = bl->thread;
2913 #endif
2914 bl_pr = bl->priority;
2916 if (highest > bl_pr)
2917 break; /* Object priority won't change */
2919 /* This will include the thread being set */
2920 queue_pr = find_highest_priority_in_list_l(*thread->bqp);
2922 if (queue_pr == bl_pr)
2923 break; /* Object priority not changing */
2925 /* Update thread boost for this object */
2926 bl->priority = queue_pr;
2927 prio_move_entry(&bl_t->pdist, bl_pr, queue_pr);
2928 bl_pr = find_first_set_bit(bl_t->pdist.mask);
2930 if (bl_t->priority == bl_pr)
2931 break; /* Blocking thread priority not changing */
2933 if (bl_t->state == STATE_RUNNING)
2935 /* Thread not blocked - we're done */
2936 set_running_thread_priority(bl_t, bl_pr);
2937 break;
2940 bl_t->priority = bl_pr;
2941 bl = bl_t->blocker; /* Blocking thread has a blocker? */
2943 if (bl == NULL)
2944 break; /* End of chain */
2946 next = bl->thread;
2948 if (next == tstart)
2949 break; /* Full-circle */
2951 UNLOCK_THREAD(thread);
2953 thread = bl_t;
2954 bl_t = next;
2955 } /* for (;;) */
2957 UNLOCK_THREAD(bl_t);
2962 UNLOCK_THREAD(thread);
2964 restore_irq(oldlevel);
2966 return old_base_priority;
2969 /*---------------------------------------------------------------------------
2970 * Returns the current base priority for a thread.
2971 *---------------------------------------------------------------------------
2973 int thread_get_priority(struct thread_entry *thread)
2975 /* Simple, quick probe. */
2976 if (thread == NULL)
2977 thread = cores[CURRENT_CORE].running;
2979 return thread->base_priority;
2981 #endif /* HAVE_PRIORITY_SCHEDULING */
2983 /*---------------------------------------------------------------------------
2984 * Starts a frozen thread - similar semantics to wakeup_thread except that
2985 * the thread is on no scheduler or wakeup queue at all. It exists simply by
2986 * virtue of the slot having a state of STATE_FROZEN.
2987 *---------------------------------------------------------------------------
2989 void thread_thaw(struct thread_entry *thread)
2991 int oldlevel = disable_irq_save();
2992 LOCK_THREAD(thread);
2994 if (thread->state == STATE_FROZEN)
2995 core_schedule_wakeup(thread);
2997 UNLOCK_THREAD(thread);
2998 restore_irq(oldlevel);
3001 /*---------------------------------------------------------------------------
3002 * Return the ID of the currently executing thread.
3003 *---------------------------------------------------------------------------
3005 struct thread_entry * thread_get_current(void)
3007 return cores[CURRENT_CORE].running;
3010 #if NUM_CORES > 1
3011 /*---------------------------------------------------------------------------
3012 * Switch the processor that the currently executing thread runs on.
3013 *---------------------------------------------------------------------------
3015 unsigned int switch_core(unsigned int new_core)
3017 const unsigned int core = CURRENT_CORE;
3018 struct thread_entry *current = cores[core].running;
3020 if (core == new_core)
3022 /* No change - just return same core */
3023 return core;
3026 int oldlevel = disable_irq_save();
3027 LOCK_THREAD(current);
3029 if (current->name == THREAD_DESTRUCT)
3031 /* Thread being killed - deactivate and let process complete */
3032 UNLOCK_THREAD(current);
3033 restore_irq(oldlevel);
3034 thread_wait(current);
3035 /* Should never be reached */
3036 THREAD_PANICF("switch_core->D:*R", current);
3039 /* Get us off the running list for the current core */
3040 RTR_LOCK(core);
3041 remove_from_list_l(&cores[core].running, current);
3042 rtr_subtract_entry(core, current->priority);
3043 RTR_UNLOCK(core);
3045 /* Stash return value (old core) in a safe place */
3046 current->retval = core;
3048 /* If a timeout hadn't yet been cleaned-up it must be removed now or
3049 * the other core will likely attempt a removal from the wrong list! */
3050 if (current->tmo.prev != NULL)
3052 remove_from_list_tmo(current);
3055 /* Change the core number for this thread slot */
3056 current->core = new_core;
3058 /* Do not use core_schedule_wakeup here since this will result in
3059 * the thread starting to run on the other core before being finished on
3060 * this one. Delay the list unlock to keep the other core stuck
3061 * until this thread is ready. */
3062 RTR_LOCK(new_core);
3064 rtr_add_entry(new_core, current->priority);
3065 add_to_list_l(&cores[new_core].running, current);
3067 /* Make a callback into device-specific code, unlock the wakeup list so
3068 * that execution may resume on the new core, unlock our slot and finally
3069 * restore the interrupt level */
3070 cores[core].blk_ops.flags = TBOP_SWITCH_CORE;
3071 cores[core].blk_ops.cl_p = &cores[new_core].rtr_cl;
3072 cores[core].block_task = current;
3074 UNLOCK_THREAD(current);
3076 /* Alert other core to activity */
3077 core_wake(new_core);
3079 /* Do the stack switching, cache_maintenence and switch_thread call -
3080 requires native code */
3081 switch_thread_core(core, current);
3083 /* Finally return the old core to caller */
3084 return current->retval;
3086 #endif /* NUM_CORES > 1 */
3088 /*---------------------------------------------------------------------------
3089 * Initialize threading API. This assumes interrupts are not yet enabled. On
3090 * multicore setups, no core is allowed to proceed until create_thread calls
3091 * are safe to perform.
3092 *---------------------------------------------------------------------------
3094 void init_threads(void)
3096 const unsigned int core = CURRENT_CORE;
3097 struct thread_entry *thread;
3099 /* CPU will initialize first and then sleep */
3100 thread = find_empty_thread_slot();
3102 if (thread == NULL)
3104 /* WTF? There really must be a slot available at this stage.
3105 * This can fail if, for example, .bss isn't zero'ed out by the loader
3106 * or threads is in the wrong section. */
3107 THREAD_PANICF("init_threads->no slot", NULL);
3110 /* Initialize initially non-zero members of core */
3111 cores[core].next_tmo_check = current_tick; /* Something not in the past */
3113 /* Initialize initially non-zero members of slot */
3114 UNLOCK_THREAD(thread); /* No sync worries yet */
3115 thread->name = main_thread_name;
3116 thread->state = STATE_RUNNING;
3117 IF_COP( thread->core = core; )
3118 #ifdef HAVE_PRIORITY_SCHEDULING
3119 corelock_init(&cores[core].rtr_cl);
3120 thread->base_priority = PRIORITY_USER_INTERFACE;
3121 prio_add_entry(&thread->pdist, PRIORITY_USER_INTERFACE);
3122 thread->priority = PRIORITY_USER_INTERFACE;
3123 rtr_add_entry(core, PRIORITY_USER_INTERFACE);
3124 #endif
3125 corelock_init(&thread->waiter_cl);
3126 corelock_init(&thread->slot_cl);
3128 add_to_list_l(&cores[core].running, thread);
3130 if (core == CPU)
3132 thread->stack = stackbegin;
3133 thread->stack_size = (uintptr_t)stackend - (uintptr_t)stackbegin;
3134 #if NUM_CORES > 1 /* This code path will not be run on single core targets */
3135 /* Wait for other processors to finish their inits since create_thread
3136 * isn't safe to call until the kernel inits are done. The first
3137 * threads created in the system must of course be created by CPU. */
3138 core_thread_init(CPU);
3140 else
3142 /* Initial stack is the idle stack */
3143 thread->stack = idle_stacks[core];
3144 thread->stack_size = IDLE_STACK_SIZE;
3145 /* After last processor completes, it should signal all others to
3146 * proceed or may signal the next and call thread_exit(). The last one
3147 * to finish will signal CPU. */
3148 core_thread_init(core);
3149 /* Other cores do not have a main thread - go idle inside switch_thread
3150 * until a thread can run on the core. */
3151 thread_exit();
3152 #endif /* NUM_CORES */
3156 /* Shared stack scan helper for thread_stack_usage and idle_stack_usage */
3157 #if NUM_CORES == 1
3158 static inline int stack_usage(uintptr_t *stackptr, size_t stack_size)
3159 #else
3160 static int stack_usage(uintptr_t *stackptr, size_t stack_size)
3161 #endif
3163 unsigned int stack_words = stack_size / sizeof (uintptr_t);
3164 unsigned int i;
3165 int usage = 0;
3167 for (i = 0; i < stack_words; i++)
3169 if (stackptr[i] != DEADBEEF)
3171 usage = ((stack_words - i) * 100) / stack_words;
3172 break;
3176 return usage;
3179 /*---------------------------------------------------------------------------
3180 * Returns the maximum percentage of stack a thread ever used while running.
3181 * NOTE: Some large buffer allocations that don't use enough the buffer to
3182 * overwrite stackptr[0] will not be seen.
3183 *---------------------------------------------------------------------------
3185 int thread_stack_usage(const struct thread_entry *thread)
3187 return stack_usage(thread->stack, thread->stack_size);
3190 #if NUM_CORES > 1
3191 /*---------------------------------------------------------------------------
3192 * Returns the maximum percentage of the core's idle stack ever used during
3193 * runtime.
3194 *---------------------------------------------------------------------------
3196 int idle_stack_usage(unsigned int core)
3198 return stack_usage(idle_stacks[core], IDLE_STACK_SIZE);
3200 #endif
3202 /*---------------------------------------------------------------------------
3203 * Fills in the buffer with the specified thread's name. If the name is NULL,
3204 * empty, or the thread is in destruct state a formatted ID is written
3205 * instead.
3206 *---------------------------------------------------------------------------
3208 void thread_get_name(char *buffer, int size,
3209 struct thread_entry *thread)
3211 if (size <= 0)
3212 return;
3214 *buffer = '\0';
3216 if (thread)
3218 /* Display thread name if one or ID if none */
3219 const char *name = thread->name;
3220 const char *fmt = "%s";
3221 if (name == NULL IF_COP(|| name == THREAD_DESTRUCT) || *name == '\0')
3223 name = (const char *)thread;
3224 fmt = "%08lX";
3226 snprintf(buffer, size, fmt, name);