4 * - Common Thread Control
12 #define DEBUG_TRACE_TICKETS 0 // Trace ticket counts
13 #define DEBUG_TRACE_STATE 0 // Trace state changes (sleep/wake)
17 #define SCHED_LOTTERY 1 // Lottery scheduler
18 #define SCHED_RR_SIM 2 // Single Queue Round Robin
19 #define SCHED_RR_PRI 3 // Multi Queue Round Robin
21 #define SCHEDULER_TYPE SCHED_LOTTERY
24 #define DEFAULT_QUANTUM 10
25 #define DEFAULT_PRIORITY 5
26 #define MIN_PRIORITY 10
27 const enum eConfigTypes cCONFIG_TYPES[] = {
28 CFGT_HEAPSTR, // e.g. CFG_VFS_CWD
29 CFGT_INT, // e.g. CFG_VFS_MAXFILES
34 extern void ArchThreads_Init(void);
35 extern void Proc_CallFaultHandler(tThread *Thread);
36 extern void Proc_DumpThreadCPUState(tThread *Thread);
37 extern int GetCPUNum(void);
40 void Threads_Init(void);
42 int Threads_SetName(const char *NewName);
44 char *Threads_GetName(int ID);
46 void Threads_SetPriority(tThread *Thread, int Pri);
47 tThread *Threads_CloneTCB(Uint *Err, Uint Flags);
48 int Threads_WaitTID(int TID, int *status);
49 tThread *Threads_GetThread(Uint TID);
51 void Threads_AddToDelete(tThread *Thread);
52 tThread *Threads_int_DelFromQueue(tThread **List, tThread *Thread);
54 void Threads_Exit(int TID, int Status);
55 void Threads_Kill(tThread *Thread, int Status);
56 void Threads_Yield(void);
57 void Threads_Sleep(void);
58 int Threads_Wake(tThread *Thread);
59 void Threads_AddActive(tThread *Thread);
60 tThread *Threads_RemActive(void);
62 void Threads_ToggleTrace(int TID);
63 void Threads_Fault(int Num);
64 void Threads_SegFault(tVAddr Addr);
66 int Threads_GetPID(void);
67 int Threads_GetTID(void);
68 tUID Threads_GetUID(void);
69 tGID Threads_GetGID(void);
70 int Threads_SetUID(Uint *Errno, tUID ID);
71 int Threads_SetGID(Uint *Errno, tUID ID);
73 void Threads_Dump(void);
74 void Threads_DumpActive(void);
76 int Mutex_Acquire(tMutex *Mutex);
77 void Mutex_Release(tMutex *Mutex);
78 int Mutex_IsLocked(tMutex *Mutex);
83 // Only used for the core kernel
84 tThread gThreadZero = {
85 .Status = THREAD_STAT_ACTIVE, // Status
86 .ThreadName = (char*)"ThreadZero", // Name
87 .Quantum = DEFAULT_QUANTUM, // Default Quantum
88 .Remaining = DEFAULT_QUANTUM, // Current Quantum
89 .Priority = DEFAULT_PRIORITY // Number of tickets
93 tShortSpinlock glThreadListLock; ///\note NEVER use a heap function while locked
94 // --- Current State ---
95 volatile int giNumActiveThreads = 0; // Number of threads on the active queue
96 volatile Uint giNextTID = 1; // Next TID to allocate
97 // --- Thread Lists ---
98 tThread *gAllThreads = NULL; // All allocated threads
99 tThread *gSleepingThreads = NULL; // Sleeping Threads
100 tThread *gDeleteThreads = NULL; // Threads to delete
101 int giNumCPUs = 1; // Number of CPUs
102 BOOL gaThreads_NoTaskSwitch[MAX_CPUS]; // Disables task switches for each core (Pseudo-IF)
103 // --- Scheduler Types ---
104 #if SCHEDULER_TYPE == SCHED_LOTTERY
105 const int caiTICKET_COUNTS[MIN_PRIORITY+1] = {100,81,64,49,36,25,16,9,4,1,0};
106 volatile int giFreeTickets = 0; // Number of tickets held by non-scheduled threads
107 tThread *gActiveThreads = NULL; // Currently Running Threads
108 #elif SCHEDULER_TYPE == SCHED_RR_SIM
109 tThread *gActiveThreads = NULL; // Currently Running Threads
110 #elif SCHEDULER_TYPE == SCHED_RR_PRI
111 tThread *gaActiveThreads[MIN_PRIORITY+1]; // Active threads for each priority level
113 # error "Unkown scheduler type"
118 * \fn void Threads_Init(void)
119 * \brief Initialse the thread list
121 void Threads_Init(void)
125 Log_Debug("Threads", "Offsets of tThread");
126 Log_Debug("Threads", ".Priority = %i", offsetof(tThread, Priority));
128 // Create Initial Task
129 #if SCHEDULER_TYPE == SCHED_RR_PRI
130 gaActiveThreads[gThreadZero.Priority] = &gThreadZero;
132 gActiveThreads = &gThreadZero;
135 gAllThreads = &gThreadZero;
136 giNumActiveThreads = 1;
142 * \fn void Threads_SetName(const char *NewName)
143 * \brief Sets the current thread's name
144 * \param NewName New name for the thread
145 * \return Boolean Failure
147 int Threads_SetName(const char *NewName)
149 tThread *cur = Proc_GetCurThread();
150 char *oldname = cur->ThreadName;
152 // NOTE: There is a possibility of non-thread safety here
153 // A thread could read the current name pointer before it is zeroed
155 cur->ThreadName = NULL;
157 if( IsHeap(oldname) ) free( oldname );
159 cur->ThreadName = strdup(NewName);
164 * \fn char *Threads_GetName(int ID)
165 * \brief Gets a thread's name
166 * \param ID Thread ID (-1 indicates current thread)
167 * \return Pointer to name
168 * \retval NULL Failure
170 char *Threads_GetName(tTID ID)
173 return Proc_GetCurThread()->ThreadName;
175 return Threads_GetThread(ID)->ThreadName;
179 * \fn void Threads_SetPriority(tThread *Thread, int Pri)
180 * \brief Sets the priority of a task
181 * \param Thread Thread to update ticket count (NULL means current thread)
182 * \param Pri New priority
184 void Threads_SetPriority(tThread *Thread, int Pri)
186 // Get current thread
187 if(Thread == NULL) Thread = Proc_GetCurThread();
189 // - If < 0, set to lowest priority
190 // - Minumum priority is actualy a high number, 0 is highest
191 if(Pri < 0) Pri = MIN_PRIORITY;
192 if(Pri > MIN_PRIORITY) Pri = MIN_PRIORITY;
194 // Do we actually have to do anything?
195 if( Pri == Thread->Priority ) return;
197 #if SCHEDULER_TYPE == SCHED_RR_PRI
198 SHORTLOCK( &glThreadListLock );
199 // Remove from old priority
200 Threads_int_DelFromQueue( &gaActiveThreads[Thread->Priority], Thread );
202 Thread->Next = gaActiveThreads[Pri];
203 gaActiveThreads[Pri] = Thread;
204 Thread->Priority = Pri;
205 SHORTREL( &glThreadListLock );
207 // If this isn't the current thread, we need to lock
208 if( Thread != Proc_GetCurThread() )
210 SHORTLOCK( &glThreadListLock );
212 #if SCHEDULER_TYPE == SCHED_LOTTERY
213 giFreeTickets -= caiTICKET_COUNTS[Thread->Priority] - caiTICKET_COUNTS[Pri];
214 # if DEBUG_TRACE_TICKETS
215 Log("Threads_SetTickets: new giFreeTickets = %i [-%i+%i]",
217 caiTICKET_COUNTS[Thread->Priority], caiTICKET_COUNTS[Pri]);
220 Thread->Priority = Pri;
221 SHORTREL( &glThreadListLock );
224 Thread->Priority = Pri;
227 #if DEBUG_TRACE_STATE
228 Log("Threads_SetPriority: %p(%i %s) pri set %i",
229 Thread, Thread->TID, Thread->ThreadName,
235 * \fn tThread *Threads_CloneTCB(Uint *Err, Uint Flags)
236 * \brief Clone the TCB of the current thread
237 * \param Err Error pointer
238 * \param Flags Flags for something... (What is this for?)
240 tThread *Threads_CloneTCB(Uint *Err, Uint Flags)
244 cur = Proc_GetCurThread();
246 // Allocate and duplicate
247 new = malloc(sizeof(tThread));
248 if(new == NULL) { *Err = -ENOMEM; return NULL; }
249 memcpy(new, cur, sizeof(tThread));
253 memset( &new->IsLocked, 0, sizeof(new->IsLocked));
254 new->Status = THREAD_STAT_PREINIT;
258 new->TID = giNextTID++;
260 new->bInstrTrace = 0;
263 new->ThreadName = strdup(cur->ThreadName);
265 // Set Thread Group ID (PID)
267 new->TGID = new->TID;
269 new->TGID = cur->TGID;
271 // Messages are not inherited
272 new->Messages = NULL;
273 new->LastMessage = NULL;
276 new->Remaining = new->Quantum = cur->Quantum;
277 new->Priority = cur->Priority;
279 // Set Signal Handlers
280 new->CurFaultNum = 0;
281 new->FaultHandler = cur->FaultHandler;
283 for( i = 0; i < NUM_CFG_ENTRIES; i ++ )
285 switch(cCONFIG_TYPES[i])
288 new->Config[i] = cur->Config[i];
292 new->Config[i] = (Uint) strdup( (void*)cur->Config[i] );
299 // Maintain a global list of threads
300 SHORTLOCK( &glThreadListLock );
301 new->GlobalPrev = NULL; // Protect against bugs
302 new->GlobalNext = gAllThreads;
303 gAllThreads->GlobalPrev = new;
305 SHORTREL( &glThreadListLock );
311 * \fn tThread *Threads_CloneTCB(Uint *Err, Uint Flags)
312 * \brief Clone the TCB of the current thread
314 tThread *Threads_CloneThreadZero(void)
318 cur = Proc_GetCurThread();
320 // Allocate and duplicate
321 new = malloc(sizeof(tThread));
325 memcpy(new, &gThreadZero, sizeof(tThread));
329 memset( &new->IsLocked, 0, sizeof(new->IsLocked));
330 new->Status = THREAD_STAT_PREINIT;
334 new->TID = giNextTID++;
338 new->ThreadName = NULL;
340 // Messages are not inherited
341 new->Messages = NULL;
342 new->LastMessage = NULL;
345 new->Remaining = new->Quantum = cur->Quantum;
346 new->Priority = cur->Priority;
347 new->bInstrTrace = 0;
349 // Set Signal Handlers
350 new->CurFaultNum = 0;
351 new->FaultHandler = cur->FaultHandler;
353 for( i = 0; i < NUM_CFG_ENTRIES; i ++ )
355 switch(cCONFIG_TYPES[i])
358 new->Config[i] = cur->Config[i];
362 new->Config[i] = (Uint) strdup( (void*)cur->Config[i] );
369 // Maintain a global list of threads
370 SHORTLOCK( &glThreadListLock );
371 new->GlobalPrev = NULL; // Protect against bugs
372 new->GlobalNext = gAllThreads;
373 gAllThreads->GlobalPrev = new;
375 SHORTREL( &glThreadListLock );
381 * \brief Get a configuration pointer from the Per-Thread data area
382 * \param ID Config slot ID
383 * \return Pointer at ID
385 Uint *Threads_GetCfgPtr(int ID)
387 if(ID < 0 || ID >= NUM_CFG_ENTRIES) {
388 Warning("Threads_GetCfgPtr: Index %i is out of bounds", ID);
392 return &Proc_GetCurThread()->Config[ID];
396 * \brief Wait for a task to change state
397 * \param TID Thread ID to wait on (-1: Any child thread, 0: Any Child/Sibling, <-1: -PID)
398 * \param Status Thread return status
399 * \return TID of child that changed state
401 tTID Threads_WaitTID(int TID, int *Status)
405 Log_Error("Threads", "TODO: Threads_WaitTID(TID=-1) - Any Child");
409 // Any peer/child thread
411 Log_Error("Threads", "TODO: Threads_WaitTID(TID=0) - Any Child/Sibling");
417 Log_Error("Threads", "TODO: Threads_WaitTID(TID<0) - TGID");
423 tThread *t = Threads_GetThread(TID);
424 int initStatus = t->Status;
427 // Wait for the thread to die!
428 if(initStatus != THREAD_STAT_ZOMBIE) {
429 // TODO: Handle child also being suspended if wanted
430 while(t->Status != THREAD_STAT_ZOMBIE) {
432 Log_Debug("Threads", "%i waiting for %i, t->Status = %i",
433 Threads_GetTID(), t->TID, t->Status);
438 Log_Debug("Threads", "%i waiting for %i, t->Status = %i",
439 Threads_GetTID(), t->TID, t->Status);
443 case THREAD_STAT_ZOMBIE:
445 t->Status = THREAD_STAT_DEAD;
446 // TODO: Child return value?
447 if(Status) *Status = t->RetStatus;
448 // add to delete queue
449 Threads_AddToDelete( t );
452 if(Status) *Status = -1;
462 * \brief Gets a thread given its TID
463 * \param TID Thread ID
464 * \return Thread pointer
466 tThread *Threads_GetThread(Uint TID)
470 // Search global list
471 for(thread = gAllThreads;
473 thread = thread->GlobalNext)
475 if(thread->TID == TID)
479 Log("Unable to find TID %i on main list\n", TID);
485 * \brief Adds a thread to the delete queue
486 * \param Thread Thread to delete
488 void Threads_AddToDelete(tThread *Thread)
490 // Add to delete queue
491 // TODO: Is locking needed?
493 Thread->Next = gDeleteThreads;
494 gDeleteThreads = Thread;
497 gDeleteThreads = Thread;
502 * \brief Deletes an entry from a list
503 * \param List Pointer to the list head
504 * \param Thread Thread to find
507 tThread *Threads_int_DelFromQueue(tThread **List, tThread *Thread)
509 tThread *ret, *prev = NULL;
512 ret && ret != Thread;
513 prev = ret, ret = ret->Next
516 // Is the thread on the list
518 //LogF("%p(%s) is not on list %p\n", Thread, Thread->ThreadName, List);
523 *List = Thread->Next;
524 //LogF("%p(%s) removed from head of %p\n", Thread, Thread->ThreadName, List);
527 prev->Next = Thread->Next;
528 //LogF("%p(%s) removed from %p (prev=%p)\n", Thread, Thread->ThreadName, List, prev);
535 * \brief Exit the current process (or another?)
536 * \param TID Thread ID to kill
537 * \param Status Exit status
539 void Threads_Exit(int TID, int Status)
542 Threads_Kill( Proc_GetCurThread(), (Uint)Status & 0xFF );
544 Threads_Kill( Threads_GetThread(TID), (Uint)Status & 0xFF );
546 // Halt forever, just in case
551 * \fn void Threads_Kill(tThread *Thread, int Status)
552 * \brief Kill a thread
553 * \param Thread Thread to kill
554 * \param Status Status code to return to the parent
556 void Threads_Kill(tThread *Thread, int Status)
559 int isCurThread = Thread == Proc_GetCurThread();
561 // TODO: Kill all children
565 // TODO: I should keep a .Parent pointer, and a .Children list
566 for(child = gAllThreads;
568 child = child->GlobalNext)
570 if(child->Parent == Thread)
571 Threads_Kill(child, -1);
576 ///\note Double lock is needed due to overlap of lock areas
578 // Lock thread (stop us recieving messages)
579 SHORTLOCK( &Thread->IsLocked );
581 // Clear Message Queue
582 while( Thread->Messages )
584 msg = Thread->Messages->Next;
585 free( Thread->Messages );
586 Thread->Messages = msg;
590 SHORTLOCK( &glThreadListLock );
592 switch(Thread->Status)
594 case THREAD_STAT_PREINIT: // Only on main list
597 // Currently active thread
598 case THREAD_STAT_ACTIVE:
599 #if SCHEDULER_TYPE == SCHED_RR_PRI
600 if( Threads_int_DelFromQueue( &gaActiveThreads[Thread->Priority], Thread ) )
602 if( Threads_int_DelFromQueue( &gActiveThreads, Thread ) )
605 // Ensure that we are not rescheduled
606 Thread->Remaining = 0; // Clear Remaining Quantum
607 Thread->Quantum = 0; // Clear Quantum to indicate dead thread
609 // Update bookkeeping
610 giNumActiveThreads --;
611 #if SCHEDULER_TYPE == SCHED_LOTTERY
612 if( Thread != Proc_GetCurThread() )
613 giFreeTickets -= caiTICKET_COUNTS[ Thread->Priority ];
618 Log_Warning("Threads",
619 "Threads_Kill - Thread %p(%i,%s) marked as active, but not on list",
620 Thread, Thread->TID, Thread->ThreadName
624 // Kill it while it sleeps!
625 case THREAD_STAT_SLEEPING:
626 if( !Threads_int_DelFromQueue( &gSleepingThreads, Thread ) )
628 Log_Warning("Threads",
629 "Threads_Kill - Thread %p(%i,%s) marked as sleeping, but not on list",
630 Thread, Thread->TID, Thread->ThreadName
635 // Brains!... You cannot kill
636 case THREAD_STAT_ZOMBIE:
637 Log_Warning("Threads", "Threads_Kill - Thread %p(%i,%s) is undead, you cannot kill it",
638 Thread, Thread->TID, Thread->ThreadName);
639 SHORTREL( &glThreadListLock );
640 SHORTREL( &Thread->IsLocked );
644 Log_Warning("Threads", "Threads_Kill - BUG Un-checked status (%i)",
650 Thread->RetStatus = Status;
652 // Don't Zombie if we are being killed because our parent is
655 Thread->Status = THREAD_STAT_DEAD;
656 Threads_AddToDelete( Thread );
658 Thread->Status = THREAD_STAT_ZOMBIE;
660 Threads_Wake( Thread->Parent );
663 Log("Thread %i went *hurk* (%i)", Thread->TID, Status);
666 SHORTREL( &glThreadListLock );
667 SHORTREL( &Thread->IsLocked ); // TODO: We may not actually be released...
677 * \brief Yield remainder of the current thread's timeslice
679 void Threads_Yield(void)
681 tThread *thread = Proc_GetCurThread();
682 thread->Remaining = 0;
683 //while(thread->Remaining == 0)
688 * \fn void Threads_Sleep(void)
689 * \brief Take the current process off the run queue
691 void Threads_Sleep(void)
693 tThread *cur = Proc_GetCurThread();
696 SHORTLOCK( &glThreadListLock );
698 // Don't sleep if there is a message waiting
699 if( cur->Messages ) {
700 SHORTREL( &glThreadListLock );
704 // Remove us from running queue
706 // Mark thread as sleeping
707 cur->Status = THREAD_STAT_SLEEPING;
709 // Add to Sleeping List (at the top)
710 cur->Next = gSleepingThreads;
711 gSleepingThreads = cur;
714 #if DEBUG_TRACE_STATE
715 Log("Threads_Sleep: %p (%i %s) sleeping", cur, cur->TID, cur->ThreadName);
719 SHORTREL( &glThreadListLock );
721 while(cur->Status != THREAD_STAT_ACTIVE) HALT();
726 * \fn int Threads_Wake( tThread *Thread )
727 * \brief Wakes a sleeping/waiting thread up
728 * \param Thread Thread to wake
729 * \return Boolean Failure (Returns ERRNO)
730 * \warning This should ONLY be called with task switches disabled
732 int Threads_Wake(tThread *Thread)
737 switch(Thread->Status)
739 case THREAD_STAT_ACTIVE:
740 Log("Threads_Wake - Waking awake thread (%i)", Thread->TID);
743 case THREAD_STAT_SLEEPING:
744 SHORTLOCK( &glThreadListLock );
745 // Remove from sleeping queue
746 Threads_int_DelFromQueue(&gSleepingThreads, Thread);
748 Threads_AddActive( Thread );
750 #if DEBUG_TRACE_STATE
751 Log("Threads_Sleep: %p (%i %s) woken", Thread, Thread->TID, Thread->ThreadName);
753 SHORTREL( &glThreadListLock );
756 case THREAD_STAT_WAITING:
757 Warning("Threads_Wake - Waiting threads are not currently supported");
760 case THREAD_STAT_DEAD:
761 Warning("Threads_Wake - Attempt to wake dead thread (%i)", Thread->TID);
765 Warning("Threads_Wake - Unknown process status (%i)\n", Thread->Status);
771 * \brief Wake a thread given the TID
772 * \param TID Thread ID to wake
773 * \return Boolean Faulure (errno)
775 int Threads_WakeTID(tTID TID)
777 tThread *thread = Threads_GetThread(TID);
781 ret = Threads_Wake( thread );
782 //Log_Debug("Threads", "TID %i woke %i (%p)", Threads_GetTID(), TID, thread);
786 void Threads_ToggleTrace(int TID)
788 tThread *thread = Threads_GetThread(TID);
790 thread->bInstrTrace = !thread->bInstrTrace;
794 * \brief Adds a thread to the active queue
796 void Threads_AddActive(tThread *Thread)
798 SHORTLOCK( &glThreadListLock );
800 if( Thread->Status == THREAD_STAT_ACTIVE ) {
801 tThread *cur = Proc_GetCurThread();
802 Warning("WTF, CPU%i %p (%i %s) is adding %p (%i %s) when it is active",
803 GetCPUNum(), cur, cur->TID, cur->ThreadName, Thread, Thread->TID, Thread->ThreadName);
804 SHORTREL( &glThreadListLock );
809 Thread->Status = THREAD_STAT_ACTIVE;
810 // Add to active list
811 #if SCHEDULER_TYPE == SCHED_RR_PRI
812 Thread->Next = gaActiveThreads[Thread->Priority];
813 gaActiveThreads[Thread->Priority] = Thread;
815 Thread->Next = gActiveThreads;
816 gActiveThreads = Thread;
819 // Update bookkeeping
820 giNumActiveThreads ++;
822 #if SCHEDULER_TYPE == SCHED_LOTTERY
825 // Only change the ticket count if the thread is un-scheduled
826 if(Thread->CurCPU != -1)
829 delta = caiTICKET_COUNTS[ Thread->Priority ];
831 giFreeTickets += delta;
832 # if DEBUG_TRACE_TICKETS
833 Log("CPU%i %p (%i %s) added, new giFreeTickets = %i [+%i]",
834 GetCPUNum(), Thread, Thread->TID, Thread->ThreadName,
841 SHORTREL( &glThreadListLock );
845 * \brief Removes the current thread from the active queue
846 * \warning This should ONLY be called with task switches disabled
847 * \return Current thread pointer
849 tThread *Threads_RemActive(void)
851 tThread *ret = Proc_GetCurThread();
853 SHORTLOCK( &glThreadListLock );
855 // Delete from active queue
856 #if SCHEDULER_TYPE == SCHED_RR_PRI
857 if( !Threads_int_DelFromQueue(&gaActiveThreads[ret->Priority], ret) )
859 if( !Threads_int_DelFromQueue(&gActiveThreads, ret) )
862 SHORTREL( &glThreadListLock );
869 giNumActiveThreads --;
870 // no need to decrement tickets, scheduler did it for us
872 #if SCHEDULER_TYPE == SCHED_LOTTERY && DEBUG_TRACE_TICKETS
873 Log("CPU%i %p (%i %s) removed, giFreeTickets = %i [nc]",
874 GetCPUNum(), ret, ret->TID, ret->ThreadName, giFreeTickets);
877 SHORTREL( &glThreadListLock );
883 * \fn void Threads_SetFaultHandler(Uint Handler)
884 * \brief Sets the signal handler for a signal
886 void Threads_SetFaultHandler(Uint Handler)
888 //Log_Debug("Threads", "Threads_SetFaultHandler: Handler = %p", Handler);
889 Proc_GetCurThread()->FaultHandler = Handler;
893 * \fn void Threads_Fault(int Num)
894 * \brief Calls a fault handler
896 void Threads_Fault(int Num)
898 tThread *thread = Proc_GetCurThread();
900 Log_Log("Threads", "Threads_Fault: thread = %p", thread);
904 Log_Log("Threads", "Threads_Fault: thread->FaultHandler = %p", thread->FaultHandler);
906 switch(thread->FaultHandler)
909 Threads_Kill(thread, -1);
912 case 1: // Dump Core?
913 Threads_Kill(thread, -1);
918 // Double Fault? Oh, F**k
919 if(thread->CurFaultNum != 0) {
920 Threads_Kill(thread, -1); // For now, just kill
924 thread->CurFaultNum = Num;
926 Proc_CallFaultHandler(thread);
930 * \fn void Threads_SegFault(tVAddr Addr)
931 * \brief Called when a Segment Fault occurs
933 void Threads_SegFault(tVAddr Addr)
935 Warning("Thread #%i committed a segfault at address %p", Proc_GetCurThread()->TID, Addr);
937 //Threads_Exit( 0, -1 );
940 // --- Process Structure Access Functions ---
941 tPID Threads_GetPID(void)
943 return Proc_GetCurThread()->TGID;
945 tTID Threads_GetTID(void)
947 return Proc_GetCurThread()->TID;
949 tUID Threads_GetUID(void)
951 return Proc_GetCurThread()->UID;
953 tGID Threads_GetGID(void)
955 return Proc_GetCurThread()->GID;
958 int Threads_SetUID(Uint *Errno, tUID ID)
960 tThread *t = Proc_GetCurThread();
965 Log_Debug("Threads", "TID %i's UID set to %i", t->TID, ID);
970 int Threads_SetGID(Uint *Errno, tGID ID)
972 tThread *t = Proc_GetCurThread();
977 Log_Debug("Threads", "TID %i's GID set to %i", t->TID, ID);
983 * \fn void Threads_Dump(void)
985 void Threads_DumpActive(void)
988 #if SCHEDULER_TYPE == SCHED_RR_PRI
992 Log("Active Threads: (%i reported)", giNumActiveThreads);
994 #if SCHEDULER_TYPE == SCHED_RR_PRI
995 for( i = 0; i < MIN_PRIORITY+1; i++ )
997 for(thread=gaActiveThreads[i];thread;thread=thread->Next)
999 for(thread=gActiveThreads;thread;thread=thread->Next)
1002 Log(" %p %i (%i) - %s (CPU %i)",
1003 thread, thread->TID, thread->TGID, thread->ThreadName, thread->CurCPU);
1004 if(thread->Status != THREAD_STAT_ACTIVE)
1005 Log(" ERROR State (%i) != THREAD_STAT_ACTIVE (%i)", thread->Status, THREAD_STAT_ACTIVE);
1006 Log(" Priority %i, Quantum %i", thread->Priority, thread->Quantum);
1007 Log(" KStack 0x%x", thread->KernelStack);
1008 if( thread->bInstrTrace )
1009 Log(" Tracing Enabled");
1010 Proc_DumpThreadCPUState(thread);
1013 #if SCHEDULER_TYPE == SCHED_RR_PRI
1019 * \fn void Threads_Dump(void)
1020 * \brief Dumps a list of currently running threads
1022 void Threads_Dump(void)
1026 Log("--- Thread Dump ---");
1027 Threads_DumpActive();
1029 Log("All Threads:");
1030 for(thread=gAllThreads;thread;thread=thread->GlobalNext)
1032 Log(" %p %i (%i) - %s (CPU %i)",
1033 thread, thread->TID, thread->TGID, thread->ThreadName, thread->CurCPU);
1034 Log(" State %i (%s)", thread->Status, casTHREAD_STAT[thread->Status]);
1035 switch(thread->Status)
1037 case THREAD_STAT_MUTEXSLEEP:
1038 Log(" Mutex Pointer: %p", thread->WaitPointer);
1040 case THREAD_STAT_SEMAPHORESLEEP:
1041 Log(" Semaphore Pointer: %p", thread->WaitPointer);
1042 Log(" Semaphore Name: %s:%s",
1043 ((tSemaphore*)thread->WaitPointer)->ModName,
1044 ((tSemaphore*)thread->WaitPointer)->Name
1047 case THREAD_STAT_ZOMBIE:
1048 Log(" Return Status: %i", thread->RetStatus);
1052 Log(" Priority %i, Quantum %i", thread->Priority, thread->Quantum);
1053 Log(" KStack 0x%x", thread->KernelStack);
1054 if( thread->bInstrTrace )
1055 Log(" Tracing Enabled");
1056 Proc_DumpThreadCPUState(thread);
1061 * \brief Gets the next thread to run
1062 * \param CPU Current CPU
1063 * \param Last The thread the CPU was running
1065 tThread *Threads_GetNextToRun(int CPU, tThread *Last)
1069 // If this CPU has the lock, we must let it complete
1070 if( CPU_HAS_LOCK( &glThreadListLock ) )
1073 // Don't change threads if the current CPU has switches disabled
1074 if( gaThreads_NoTaskSwitch[CPU] )
1079 SHORTLOCK( &glThreadListLock );
1081 // Clear Delete Queue
1082 // - I should probably put this in a worker thread to avoid calling free() in the scheduler
1083 // DEFINITELY - free() can deadlock in this case
1084 while(gDeleteThreads)
1086 thread = gDeleteThreads->Next;
1087 // Only free if structure is unused
1088 if( !IS_LOCKED(&gDeleteThreads->IsLocked) )
1091 gDeleteThreads->Status = THREAD_STAT_BURIED;
1093 if( IsHeap(gDeleteThreads->ThreadName) )
1094 free(gDeleteThreads->ThreadName);
1095 // Remove from global list
1096 if( gDeleteThreads == gAllThreads )
1097 gAllThreads = gDeleteThreads->GlobalNext;
1099 gDeleteThreads->GlobalPrev->GlobalNext = gDeleteThreads->GlobalNext;
1100 free( gDeleteThreads );
1102 gDeleteThreads = thread;
1105 // No active threads, just take a nap
1106 if(giNumActiveThreads == 0) {
1107 SHORTREL( &glThreadListLock );
1108 #if DEBUG_TRACE_TICKETS
1109 Log("No active threads");
1114 #if SCHEDULER_TYPE != SCHED_RR_PRI
1115 // Special case: 1 thread
1116 if(giNumActiveThreads == 1) {
1117 if( gActiveThreads->CurCPU == -1 )
1118 gActiveThreads->CurCPU = CPU;
1120 SHORTREL( &glThreadListLock );
1122 if( gActiveThreads->CurCPU == CPU )
1123 return gActiveThreads;
1125 return NULL; // CPU has nothing to do
1129 // Allow the old thread to be scheduled again
1131 if( Last->Status == THREAD_STAT_ACTIVE ) {
1132 #if SCHEDULER_TYPE == SCHED_LOTTERY
1133 giFreeTickets += caiTICKET_COUNTS[ Last->Priority ];
1134 # if DEBUG_TRACE_TICKETS
1135 LogF("Log: CPU%i released %p (%i %s) into the pool (%i [+%i] tickets in pool)\n",
1136 CPU, Last, Last->TID, Last->ThreadName, giFreeTickets,
1137 caiTICKET_COUNTS[ Last->Priority ]);
1141 #if SCHEDULER_TYPE == SCHED_LOTTERY && DEBUG_TRACE_TICKETS
1143 LogF("Log: CPU%i released %p (%i %s)->Status = %i (Released,not in pool)\n",
1144 CPU, Last, Last->TID, Last->ThreadName, Last->Status);
1150 // Lottery Scheduler
1152 #if SCHEDULER_TYPE == SCHED_LOTTERY
1157 for(thread = gActiveThreads; thread; thread = thread->Next) {
1158 if(thread->CurCPU >= 0) continue;
1159 if(thread->Status != THREAD_STAT_ACTIVE)
1160 Panic("Bookkeeping fail - %p %i(%s) is on the active queue with a status of %i",
1161 thread, thread->TID, thread->ThreadName, thread->Status);
1162 if(thread->Next == thread) {
1163 Panic("Bookkeeping fail - %p %i(%s) loops back on itself",
1164 thread, thread->TID, thread->ThreadName, thread->Status);
1166 number += caiTICKET_COUNTS[ thread->Priority ];
1168 if(number != giFreeTickets) {
1169 Panic("Bookkeeping fail (giFreeTickets(%i) != number(%i)) - CPU%i",
1170 giFreeTickets, number, CPU);
1174 // No free tickets (all tasks delegated to cores)
1175 if( giFreeTickets == 0 ) {
1176 SHORTREL(&glThreadListLock);
1180 // Get the ticket number
1181 ticket = number = rand() % giFreeTickets;
1183 // Find the next thread
1184 for(thread=gActiveThreads;thread;thread=thread->Next)
1186 if(thread->CurCPU >= 0) continue;
1187 if( caiTICKET_COUNTS[ thread->Priority ] > number) break;
1188 number -= caiTICKET_COUNTS[ thread->Priority ];
1191 // If we didn't find a thread, something went wrong
1195 for(thread=gActiveThreads;thread;thread=thread->Next) {
1196 if(thread->CurCPU >= 0) continue;
1197 number += caiTICKET_COUNTS[ thread->Priority ];
1199 Panic("Bookeeping Failed - giFreeTickets(%i) > true count (%i)",
1200 giFreeTickets, number);
1203 giFreeTickets -= caiTICKET_COUNTS[ thread->Priority ];
1204 # if DEBUG_TRACE_TICKETS
1205 LogF("Log: CPU%i allocated %p (%i %s), (%i [-%i] tickets in pool), \n",
1206 CPU, thread, thread->TID, thread->ThreadName,
1207 giFreeTickets, caiTICKET_COUNTS[ thread->Priority ]);
1212 // Priority based round robin scheduler
1214 #elif SCHEDULER_TYPE == SCHED_RR_PRI
1217 for( i = 0; i < MIN_PRIORITY + 1; i ++ )
1219 for(thread = gaActiveThreads[i]; thread; thread = thread->Next)
1221 if( thread->CurCPU == -1 ) break;
1223 // If we fall onto the same queue again, special handling is
1225 if( i == Last->Priority ) {
1226 tThread *savedThread = thread;
1228 // Find the next unscheduled thread in the list
1229 for( thread = Last->Next; thread; thread = thread->Next )
1231 if( thread->CurCPU == -1 ) break;
1233 // If we don't find anything after, just use the one
1235 if( !thread ) thread = savedThread;
1237 // Found a thread? Schedule it!
1243 SHORTREL(&glThreadListLock);
1247 #elif SCHEDULER_TYPE == SCHED_RR_SIM
1249 // Find the next unscheduled thread in the list
1250 for( thread = Last->Next; thread; thread = thread->Next )
1252 if( thread->CurCPU == -1 ) break;
1254 // If we don't find anything after, search from the beginning
1257 for(thread = gActiveThreads; thread; thread = thread->Next)
1259 if( thread->CurCPU == -1 ) break;
1265 SHORTREL(&glThreadListLock);
1270 # error "Unimplemented scheduling algorithm"
1273 // Make the new thread non-schedulable
1274 thread->CurCPU = CPU;
1276 SHORTREL( &glThreadListLock );
1281 // Acquire mutex (see mutex.h for documentation)
1282 int Mutex_Acquire(tMutex *Mutex)
1284 tThread *us = Proc_GetCurThread();
1287 SHORTLOCK( &Mutex->Protector );
1289 //Log("Mutex_Acquire: (%p)", Mutex);
1291 // Check if the lock is already held
1292 if( Mutex->Owner ) {
1293 SHORTLOCK( &glThreadListLock );
1294 // - Remove from active list
1295 us = Threads_RemActive();
1297 // - Mark as sleeping
1298 us->Status = THREAD_STAT_MUTEXSLEEP;
1299 us->WaitPointer = Mutex;
1302 if(Mutex->LastWaiting) {
1303 Mutex->LastWaiting->Next = us;
1304 Mutex->LastWaiting = us;
1307 Mutex->Waiting = us;
1308 Mutex->LastWaiting = us;
1311 #if DEBUG_TRACE_STATE
1312 Log("%p (%i %s) waiting on mutex %p",
1313 us, us->TID, us->ThreadName, Mutex);
1320 for( t = Mutex->Waiting; t; t = t->Next, i++ )
1321 Log("[%i] (tMutex)%p->Waiting[%i] = %p (%i %s)", us->TID, Mutex, i,
1322 t, t->TID, t->ThreadName);
1326 SHORTREL( &glThreadListLock );
1327 SHORTREL( &Mutex->Protector );
1328 while(us->Status == THREAD_STAT_MUTEXSLEEP) Threads_Yield();
1329 // We're only woken when we get the lock
1330 us->WaitPointer = NULL;
1332 // Ooh, let's take it!
1335 SHORTREL( &Mutex->Protector );
1339 extern tMutex glPhysAlloc;
1340 if( Mutex != &glPhysAlloc )
1341 LogF("Mutex %p taken by %i %p\n", Mutex, us->TID, __builtin_return_address(0));
1348 void Mutex_Release(tMutex *Mutex)
1350 SHORTLOCK( &Mutex->Protector );
1351 //Log("Mutex_Release: (%p)", Mutex);
1352 if( Mutex->Waiting ) {
1353 Mutex->Owner = Mutex->Waiting; // Set owner
1354 Mutex->Waiting = Mutex->Waiting->Next; // Next!
1355 // Reset ->LastWaiting to NULL if we have just removed the last waiting thread
1356 // 2010-10-02 21:50 - Comemerating the death of the longest single
1357 // blocker in the Acess2 history. REMEMBER TO
1358 // FUCKING MAINTAIN YOUR FUCKING LISTS DIPWIT
1359 if( Mutex->LastWaiting == Mutex->Owner )
1360 Mutex->LastWaiting = NULL;
1363 SHORTLOCK( &glThreadListLock );
1364 if( Mutex->Owner->Status != THREAD_STAT_ACTIVE )
1365 Threads_AddActive(Mutex->Owner);
1366 SHORTREL( &glThreadListLock );
1369 Mutex->Owner = NULL;
1371 SHORTREL( &Mutex->Protector );
1374 extern tMutex glPhysAlloc;
1375 if( Mutex != &glPhysAlloc )
1376 LogF("Mutex %p released by %i %p\n", Mutex, Threads_GetTID(), __builtin_return_address(0));
1380 // Check if a mutex is locked
1381 int Mutex_IsLocked(tMutex *Mutex)
1383 return Mutex->Owner != NULL;
1387 // Initialise a semaphore
1389 void Semaphore_Init(tSemaphore *Sem, int Value, int MaxValue, const char *Module, const char *Name)
1391 memset(Sem, 0, sizeof(tSemaphore));
1393 Sem->ModName = Module;
1395 Sem->MaxValue = MaxValue;
1398 // Wait for items to be avaliable
1400 int Semaphore_Wait(tSemaphore *Sem, int MaxToTake)
1404 if( MaxToTake < 0 ) {
1405 Log_Warning("Threads", "Semaphore_Wait: User bug - MaxToTake(%i) < 0, Sem=%p(%s)",
1406 MaxToTake, Sem, Sem->Name);
1409 SHORTLOCK( &Sem->Protector );
1411 // Check if there's already items avaliable
1412 if( Sem->Value > 0 ) {
1413 // Take what we need
1414 if( MaxToTake && Sem->Value > MaxToTake )
1418 Sem->Value -= taken;
1419 SHORTREL( &Sem->Protector );
1423 SHORTLOCK( &glThreadListLock );
1425 // - Remove from active list
1426 us = Threads_RemActive();
1428 // - Mark as sleeping
1429 us->Status = THREAD_STAT_SEMAPHORESLEEP;
1430 us->WaitPointer = Sem;
1431 us->RetStatus = MaxToTake; // Use RetStatus as a temp variable
1434 if(Sem->LastWaiting) {
1435 Sem->LastWaiting->Next = us;
1436 Sem->LastWaiting = us;
1440 Sem->LastWaiting = us;
1443 #if DEBUG_TRACE_STATE
1444 Log("%p (%i %s) waiting on semaphore %p %s:%s",
1445 us, us->TID, us->ThreadName,
1446 Sem, Sem->ModName, Sem->Name);
1449 SHORTREL( &glThreadListLock );
1450 SHORTREL( &Sem->Protector );
1451 while(us->Status == THREAD_STAT_SEMAPHORESLEEP) Threads_Yield();
1452 // We're only woken when there's something avaliable
1453 us->WaitPointer = NULL;
1455 taken = us->RetStatus;
1457 // Get the lock again
1458 SHORTLOCK( &Sem->Protector );
1461 // While there is space, and there are thread waiting
1462 // wake the first thread and give it what it wants (or what's left)
1463 while( (Sem->MaxValue == 0 || Sem->Value < Sem->MaxValue) && Sem->Signaling )
1466 tThread *toWake = Sem->Signaling;
1468 Sem->Signaling = Sem->Signaling->Next;
1469 // Reset ->LastWaiting to NULL if we have just removed the last waiting thread
1470 if( Sem->Signaling == NULL )
1471 Sem->LastSignaling = NULL;
1473 // Figure out how much to give
1474 if( toWake->RetStatus && Sem->Value + toWake->RetStatus < Sem->MaxValue )
1475 given = toWake->RetStatus;
1477 given = Sem->MaxValue - Sem->Value;
1478 Sem->Value -= given;
1481 #if DEBUG_TRACE_STATE
1482 Log("%p (%i %s) woken by wait on %p %s:%s",
1483 toWake, toWake->TID, toWake->ThreadName,
1484 Sem, Sem->ModName, Sem->Name);
1487 // Save the number we gave to the thread's status
1488 toWake->RetStatus = given;
1491 SHORTLOCK( &glThreadListLock );
1492 if( toWake->Status != THREAD_STAT_ACTIVE )
1493 Threads_AddActive(toWake);
1494 SHORTREL( &glThreadListLock );
1496 SHORTREL( &Sem->Protector );
1502 // Add items to a semaphore
1504 int Semaphore_Signal(tSemaphore *Sem, int AmmountToAdd)
1509 if( AmmountToAdd < 0 ) {
1510 Log_Warning("Threads", "Semaphore_Signal: User bug - AmmountToAdd(%i) < 0, Sem=%p(%s)",
1511 AmmountToAdd, Sem, Sem->Name);
1513 SHORTLOCK( &Sem->Protector );
1515 // Check if we have to block
1516 if( Sem->MaxValue && Sem->Value == Sem->MaxValue )
1520 Log_Debug("Threads", "Semaphore_Signal: IDLE Sem = %s:%s", Sem->ModName, Sem->Name);
1521 Log_Debug("Threads", "Semaphore_Signal: Sem->Value(%i) == Sem->MaxValue(%i)", Sem->Value, Sem->MaxValue);
1524 SHORTLOCK( &glThreadListLock );
1525 // - Remove from active list
1526 us = Threads_RemActive();
1528 // - Mark as sleeping
1529 us->Status = THREAD_STAT_SEMAPHORESLEEP;
1530 us->WaitPointer = Sem;
1531 us->RetStatus = AmmountToAdd; // Use RetStatus as a temp variable
1534 if(Sem->LastSignaling) {
1535 Sem->LastSignaling->Next = us;
1536 Sem->LastSignaling = us;
1539 Sem->Signaling = us;
1540 Sem->LastSignaling = us;
1543 #if DEBUG_TRACE_STATE
1544 Log("%p (%i %s) signaling semaphore %p %s:%s",
1545 us, us->TID, us->ThreadName,
1546 Sem, Sem->ModName, Sem->Name);
1549 SHORTREL( &glThreadListLock );
1550 SHORTREL( &Sem->Protector );
1551 while(us->Status == THREAD_STAT_SEMAPHORESLEEP) Threads_Yield();
1552 // We're only woken when there's something avaliable
1553 us->WaitPointer = NULL;
1555 added = us->RetStatus;
1557 // Get the lock again
1558 SHORTLOCK( &Sem->Protector );
1563 // Figure out how much we need to take off
1564 if( Sem->MaxValue && Sem->Value + AmmountToAdd > Sem->MaxValue)
1565 added = Sem->MaxValue - Sem->Value;
1567 added = AmmountToAdd;
1568 Sem->Value += added;
1571 // While there are items avaliable, and there are thread waiting
1572 // wake the first thread and give it what it wants (or what's left)
1573 while( Sem->Value && Sem->Waiting )
1575 tThread *toWake = Sem->Waiting;
1577 // Remove thread from list (double ended, so clear LastWaiting if needed)
1578 Sem->Waiting = Sem->Waiting->Next;
1579 if( Sem->Waiting == NULL )
1580 Sem->LastWaiting = NULL;
1582 // Figure out how much to give to woken thread
1583 // - Requested count is stored in ->RetStatus
1584 if( toWake->RetStatus && Sem->Value > toWake->RetStatus )
1585 given = toWake->RetStatus;
1588 Sem->Value -= given;
1590 // Save the number we gave to the thread's status
1591 toWake->RetStatus = given;
1593 if(toWake->bInstrTrace)
1594 Log("%s(%i) given %i from %p", toWake->ThreadName, toWake->TID, given, Sem);
1595 #if DEBUG_TRACE_STATE
1596 Log("%p (%i %s) woken by signal on %p %s:%s",
1597 toWake, toWake->TID, toWake->ThreadName,
1598 Sem, Sem->ModName, Sem->Name);
1602 SHORTLOCK( &glThreadListLock );
1603 if( toWake->Status != THREAD_STAT_ACTIVE )
1604 Threads_AddActive(toWake);
1605 SHORTREL( &glThreadListLock );
1607 SHORTREL( &Sem->Protector );
1613 // Get the current value of a semaphore
1615 int Semaphore_GetValue(tSemaphore *Sem)
1621 EXPORT(Threads_GetUID);
1622 EXPORT(Threads_GetGID);
1623 EXPORT(Mutex_Acquire);
1624 EXPORT(Mutex_Release);
1625 EXPORT(Mutex_IsLocked);
1626 EXPORT(Semaphore_Init);
1627 EXPORT(Semaphore_Wait);
1628 EXPORT(Semaphore_Signal);