8 #include <threads_int.h>
15 #include <arch_config.h>
19 #define DEBUG_TRACE_SWITCH 0
20 #define BREAK_ON_SWITCH 0 // Break into bochs debugger on a task switch
28 Uint8 State; // 0: Unavaliable, 1: Idle, 2: Active
36 extern void APStartup(void); // 16-bit AP startup code
38 extern Uint GetRIP(void); // start.asm
39 extern Uint SaveState(Uint *RSP, Uint *Regs);
40 extern Uint Proc_CloneInt(Uint *RSP, Uint *CR3);
41 extern void NewTaskHeader(void); // Actually takes cdecl args
43 extern Uint64 gInitialPML4[512]; // start.asm
46 extern int giTotalTickets;
47 extern int giNumActiveThreads;
48 extern tThread gThreadZero;
49 extern void Threads_Dump(void);
50 extern void Proc_ReturnToUser(tVAddr Handler, tVAddr KStackTop, int Argument);
51 extern void Time_UpdateTimestamp(void);
52 extern void SwitchTasks(Uint NewSP, Uint *OldSP, Uint NewIP, Uint *OldIO, Uint CR3);
55 //void ArchThreads_Init(void);
57 void MP_StartAP(int CPU);
58 void MP_SendIPI(Uint8 APICID, int Vector, int DeliveryMode);
60 void Proc_IdleTask(void *unused);
61 //void Proc_Start(void);
62 //tThread *Proc_GetCurThread(void);
63 // int Proc_NewKThread(void (*Fcn)(void*), void *Data);
64 // int Proc_Clone(Uint *Err, Uint Flags);
65 // int Proc_SpawnWorker(void);
66 Uint Proc_MakeUserStack(void);
67 //void Proc_StartUser(Uint Entrypoint, Uint *Bases, int ArgC, char **ArgV, char **EnvP, int DataSize);
68 void Proc_StartProcess(Uint16 SS, Uint Stack, Uint Flags, Uint16 CS, Uint IP) NORETURN;
69 int Proc_Demote(Uint *Err, int Dest, tRegs *Regs);
70 //void Proc_CallFaultHandler(tThread *Thread);
71 //void Proc_DumpThreadCPUState(tThread *Thread);
72 //void Proc_Reschedule(void);
73 void Proc_Scheduler(int CPU, Uint RSP, Uint RIP);
76 //!\brief Used by desctab.asm in SyscallStub
77 const int ci_offsetof_tThread_KernelStack = offsetof(tThread, KernelStack);
78 // --- Multiprocessing ---
80 volatile int giNumInitingCPUs = 0;
81 tMPInfo *gMPFloatPtr = NULL;
82 tAPIC *gpMP_LocalAPIC = NULL;
83 Uint8 gaAPIC_to_CPU[256] = {0};
85 tCPU gaCPUs[MAX_CPUS];
88 // --- Error Recovery ---
89 Uint32 gaDoubleFaultStack[1024];
93 * \fn void ArchThreads_Init(void)
94 * \brief Starts the process scheduler
96 void ArchThreads_Init(void)
103 // Mark BSP as active
106 // -- Initialise Multiprocessing
107 // Find MP Floating Table
108 // - EBDA/Last 1Kib (640KiB)
109 for(pos = KERNEL_BASE|0x9F000; pos < (KERNEL_BASE|0xA0000); pos += 16) {
110 if( *(Uint*)(pos) == MPPTR_IDENT ) {
111 Log("Possible %p", pos);
112 if( ByteSum((void*)pos, sizeof(tMPInfo)) != 0 ) continue;
113 gMPFloatPtr = (void*)pos;
117 // - Last KiB (512KiB base mem)
119 for(pos = KERNEL_BASE|0x7F000; pos < (KERNEL_BASE|0x80000); pos += 16) {
120 if( *(Uint*)(pos) == MPPTR_IDENT ) {
121 Log("Possible %p", pos);
122 if( ByteSum((void*)pos, sizeof(tMPInfo)) != 0 ) continue;
123 gMPFloatPtr = (void*)pos;
130 for(pos = KERNEL_BASE|0xE0000; pos < (KERNEL_BASE|0x100000); pos += 16) {
131 if( *(Uint*)(pos) == MPPTR_IDENT ) {
132 Log("Possible %p", pos);
133 if( ByteSum((void*)pos, sizeof(tMPInfo)) != 0 ) continue;
134 gMPFloatPtr = (void*)pos;
140 // If the MP Table Exists, parse it
145 Log("gMPFloatPtr = %p", gMPFloatPtr);
146 Log("*gMPFloatPtr = {");
147 Log("\t.Sig = 0x%08x", gMPFloatPtr->Sig);
148 Log("\t.MPConfig = 0x%08x", gMPFloatPtr->MPConfig);
149 Log("\t.Length = 0x%02x", gMPFloatPtr->Length);
150 Log("\t.Version = 0x%02x", gMPFloatPtr->Version);
151 Log("\t.Checksum = 0x%02x", gMPFloatPtr->Checksum);
152 Log("\t.Features = [0x%02x,0x%02x,0x%02x,0x%02x,0x%02x]",
153 gMPFloatPtr->Features[0], gMPFloatPtr->Features[1],
154 gMPFloatPtr->Features[2], gMPFloatPtr->Features[3],
155 gMPFloatPtr->Features[4]
159 mptable = (void*)( KERNEL_BASE|gMPFloatPtr->MPConfig );
160 Log("mptable = %p", mptable);
162 Log("\t.Sig = 0x%08x", mptable->Sig);
163 Log("\t.BaseTableLength = 0x%04x", mptable->BaseTableLength);
164 Log("\t.SpecRev = 0x%02x", mptable->SpecRev);
165 Log("\t.Checksum = 0x%02x", mptable->Checksum);
166 Log("\t.OEMID = '%8c'", mptable->OemID);
167 Log("\t.ProductID = '%8c'", mptable->ProductID);
168 Log("\t.OEMTablePtr = %p'", mptable->OEMTablePtr);
169 Log("\t.OEMTableSize = 0x%04x", mptable->OEMTableSize);
170 Log("\t.EntryCount = 0x%04x", mptable->EntryCount);
171 Log("\t.LocalAPICMemMap = 0x%08x", mptable->LocalAPICMemMap);
172 Log("\t.ExtendedTableLen = 0x%04x", mptable->ExtendedTableLen);
173 Log("\t.ExtendedTableChecksum = 0x%02x", mptable->ExtendedTableChecksum);
176 gpMP_LocalAPIC = (void*)MM_MapHWPage(mptable->LocalAPICMemMap, 1);
178 ents = mptable->Entries;
181 for( i = 0; i < mptable->EntryCount; i ++ )
188 Log("%i: Processor", i);
189 Log("\t.APICID = %i", ents->Proc.APICID);
190 Log("\t.APICVer = 0x%02x", ents->Proc.APICVer);
191 Log("\t.CPUFlags = 0x%02x", ents->Proc.CPUFlags);
192 Log("\t.CPUSignature = 0x%08x", ents->Proc.CPUSignature);
193 Log("\t.FeatureFlags = 0x%08x", ents->Proc.FeatureFlags);
196 if( !(ents->Proc.CPUFlags & 1) ) {
201 // Check if there is too many processors
202 if(giNumCPUs >= MAX_CPUS) {
203 giNumCPUs ++; // If `giNumCPUs` > MAX_CPUS later, it will be clipped
207 // Initialise CPU Info
208 gaAPIC_to_CPU[ents->Proc.APICID] = giNumCPUs;
209 gaCPUs[giNumCPUs].APICID = ents->Proc.APICID;
210 gaCPUs[giNumCPUs].State = 0;
214 if( !(ents->Proc.CPUFlags & 2) )
216 MP_StartAP( giNumCPUs-1 );
223 Log("\t.ID = %i", ents->Bus.ID);
224 Log("\t.TypeString = '%6c'", ents->Bus.TypeString);
228 Log("%i: I/O APIC", i);
229 Log("\t.ID = %i", ents->IOAPIC.ID);
230 Log("\t.Version = 0x%02x", ents->IOAPIC.Version);
231 Log("\t.Flags = 0x%02x", ents->IOAPIC.Flags);
232 Log("\t.Addr = 0x%08x", ents->IOAPIC.Addr);
234 case 3: // I/O Interrupt Assignment
236 Log("%i: I/O Interrupt Assignment", i);
237 Log("\t.IntType = %i", ents->IOInt.IntType);
238 Log("\t.Flags = 0x%04x", ents->IOInt.Flags);
239 Log("\t.SourceBusID = 0x%02x", ents->IOInt.SourceBusID);
240 Log("\t.SourceBusIRQ = 0x%02x", ents->IOInt.SourceBusIRQ);
241 Log("\t.DestAPICID = 0x%02x", ents->IOInt.DestAPICID);
242 Log("\t.DestAPICIRQ = 0x%02x", ents->IOInt.DestAPICIRQ);
244 case 4: // Local Interrupt Assignment
246 Log("%i: Local Interrupt Assignment", i);
247 Log("\t.IntType = %i", ents->LocalInt.IntType);
248 Log("\t.Flags = 0x%04x", ents->LocalInt.Flags);
249 Log("\t.SourceBusID = 0x%02x", ents->LocalInt.SourceBusID);
250 Log("\t.SourceBusIRQ = 0x%02x", ents->LocalInt.SourceBusIRQ);
251 Log("\t.DestLocalAPICID = 0x%02x", ents->LocalInt.DestLocalAPICID);
252 Log("\t.DestLocalAPICIRQ = 0x%02x", ents->LocalInt.DestLocalAPICIRQ);
255 Log("%i: Unknown (%i)", i, ents->Type);
258 ents = (void*)( (Uint)ents + entSize );
261 if( giNumCPUs > MAX_CPUS ) {
262 Warning("Too many CPUs detected (%i), only using %i of them", giNumCPUs, MAX_CPUS);
263 giNumCPUs = MAX_CPUS;
266 while( giNumInitingCPUs )
267 MM_FinishVirtualInit();
269 Panic("Uh oh... MP Table Parsing is unimplemented\n");
272 Log("No MP Table was found, assuming uniprocessor\n");
279 MM_FinishVirtualInit();
283 // Initialise Normal TSS(s)
284 for(pos=0;pos<giNumCPUs;pos++)
289 gTSSs[pos].RSP0 = 0; // Set properly by scheduler
290 gGDT[7+pos*2].LimitLow = sizeof(tTSS) & 0xFFFF;
291 gGDT[7+pos*2].BaseLow = ((Uint)(&gTSSs[pos])) & 0xFFFF;
292 gGDT[7+pos*2].BaseMid = ((Uint)(&gTSSs[pos])) >> 16;
293 gGDT[7+pos*2].BaseHi = ((Uint)(&gTSSs[pos])) >> 24;
294 gGDT[7+pos*2+1].DWord[0] = ((Uint)(&gTSSs[pos])) >> 32;
297 for(pos=0;pos<giNumCPUs;pos++) {
298 __asm__ __volatile__ ("ltr %%ax"::"a"(0x38+pos*16));
301 __asm__ __volatile__ ("ltr %%ax"::"a"(0x38));
304 // Set Debug registers
305 __asm__ __volatile__ ("mov %0, %%db0" : : "r"(&gThreadZero));
306 __asm__ __volatile__ ("mov %%rax, %%db1" : : "a"(0));
308 gaCPUs[0].Current = &gThreadZero;
310 gThreadZero.MemState.CR3 = (Uint)gInitialPML4 - KERNEL_BASE;
311 gThreadZero.CurCPU = 0;
312 gThreadZero.KernelStack = 0xFFFFA00000000000 + KERNEL_STACK_SIZE;
314 // Set timer frequency
315 outb(0x43, 0x34); // Set Channel 0, Low/High, Rate Generator
316 outb(0x40, PIT_TIMER_DIVISOR&0xFF); // Low Byte of Divisor
317 outb(0x40, (PIT_TIMER_DIVISOR>>8)&0xFF); // High Byte
319 // Create Per-Process Data Block
320 if( !MM_Allocate(MM_PPD_CFG) )
322 Warning("Oh, hell, Unable to allocate PPD for Thread#0");
325 Log_Log("Proc", "Multithreading initialised");
329 void MP_StartAP(int CPU)
331 Log("Starting AP %i (APIC %i)", CPU, gaCPUs[CPU].APICID);
332 // Set location of AP startup code and mark for a warm restart
333 *(Uint16*)(KERNEL_BASE|0x467) = (Uint)&APStartup - (KERNEL_BASE|0xFFFF0);
334 *(Uint16*)(KERNEL_BASE|0x469) = 0xFFFF;
335 outb(0x70, 0x0F); outb(0x71, 0x0A); // Warm Reset
336 MP_SendIPI(gaCPUs[CPU].APICID, 0, 5);
340 void MP_SendIPI(Uint8 APICID, int Vector, int DeliveryMode)
342 Uint32 addr = (Uint)gpMP_LocalAPIC + 0x300;
346 val = (Uint)APICID << 24;
347 Log("*%p = 0x%08x", addr+0x10, val);
348 *(Uint32*)(addr+0x10) = val;
350 val = ((DeliveryMode & 7) << 8) | (Vector & 0xFF);
351 Log("*%p = 0x%08x", addr, val);
352 *(Uint32*)addr = val;
359 void Proc_IdleTask(void *ptr)
362 cpu->IdleThread = Proc_GetCurThread();
363 cpu->IdleThread->ThreadName = (char*)"Idle Thread";
364 Threads_SetPriority( cpu->IdleThread, -1 ); // Never called randomly
365 cpu->IdleThread->Quantum = 1; // 1 slice quantum
367 HALT(); // Just yeilds
373 * \fn void Proc_Start(void)
374 * \brief Start process scheduler
376 void Proc_Start(void)
384 for( i = 0; i < giNumCPUs; i ++ )
387 if(i) gaCPUs[i].Current = NULL;
389 Proc_NewKThread(Proc_IdleTask, &gaCPUs[i]);
392 gaCPUs[i].IdleThread = Threads_GetThread(tid);
396 if( i != giProc_BootProcessorID ) {
401 // BSP still should run the current task
402 gaCPUs[0].Current = &gThreadZero;
404 // Start interrupts and wait for APs to come up
405 Log("Waiting for APs to come up\n");
406 __asm__ __volatile__ ("sti");
407 while( giNumInitingCPUs ) __asm__ __volatile__ ("hlt");
409 Proc_NewKThread(Proc_IdleTask, &gaCPUs[0]);
411 // Start Interrupts (and hence scheduler)
412 __asm__ __volatile__("sti");
414 MM_FinishVirtualInit();
415 Log_Log("Proc", "Multithreading started");
419 * \fn tThread *Proc_GetCurThread(void)
420 * \brief Gets the current thread
422 tThread *Proc_GetCurThread(void)
425 return gaCPUs[ GetCPUNum() ].Current;
427 return gaCPUs[ 0 ].Current;
434 void Proc_ClearThread(tThread *Thread)
436 Log_Warning("Proc", "TODO: Nuke address space etc");
440 * \brief Create a new kernel thread
442 int Proc_NewKThread(void (*Fcn)(void*), void *Data)
445 tThread *newThread, *cur;
447 cur = Proc_GetCurThread();
448 newThread = Threads_CloneTCB(0);
449 if(!newThread) return -1;
452 newThread->MemState.CR3 = cur->MemState.CR3;
455 newThread->KernelStack = MM_NewKStack();
457 if(newThread->KernelStack == 0) {
462 rsp = newThread->KernelStack;
463 *(Uint*)(rsp-=8) = (Uint)Data; // Data (shadowed)
464 *(Uint*)(rsp-=8) = 1; // Number of params
465 *(Uint*)(rsp-=8) = (Uint)Fcn; // Function to call
466 *(Uint*)(rsp-=8) = (Uint)newThread; // Thread ID
468 newThread->SavedState.RSP = rsp;
469 newThread->SavedState.RIP = (Uint)&NewTaskHeader;
470 // Log("New (KThread) %p, rsp = %p\n", newThread->SavedState.RIP, newThread->SavedState.RSP);
473 Threads_AddActive(newThread);
475 return newThread->TID;
479 * \fn int Proc_Clone(Uint Flags)
480 * \brief Clone the current process
482 int Proc_Clone(Uint Flags)
484 tThread *newThread, *cur = Proc_GetCurThread();
488 if( !(Flags & CLONE_VM) ) {
489 Log_Error("Proc", "Proc_Clone: Don't leave CLONE_VM unset, use Proc_NewKThread instead");
494 newThread = Threads_CloneTCB(Flags);
495 if(!newThread) return -1;
497 // Save core machine state
498 rip = Proc_CloneInt(&newThread->SavedState.RSP, &newThread->MemState.CR3);
499 if(rip == 0) return 0; // Child
500 newThread->KernelStack = cur->KernelStack;
501 newThread->SavedState.RIP = rip;
505 Log("New (Clone) %p, rsp = %p, cr3 = %p", rip, newThread->SavedState.RSP, newThread->MemState.CR3);
508 __asm__ __volatile__ ("mov %%cr3, %0" : "=r" (cr3));
509 Log("Current CR3 = 0x%x, PADDR(RSP) = 0x%x", cr3, MM_GetPhysAddr(newThread->SavedState.RSP));
514 // Lock list and add to active
515 Threads_AddActive(newThread);
517 return newThread->TID;
521 * \fn int Proc_SpawnWorker(void)
522 * \brief Spawns a new worker thread
524 int Proc_SpawnWorker(void (*Fcn)(void*), void *Data)
527 Uint stack_contents[4];
529 cur = Proc_GetCurThread();
532 new = malloc( sizeof(tThread) );
534 Warning("Proc_SpawnWorker - Out of heap space!\n");
537 memcpy(new, &gThreadZero, sizeof(tThread));
539 new->TID = giNextTID++;
541 // Create the stack contents
542 stack_contents[3] = (Uint)Data;
543 stack_contents[2] = 1;
544 stack_contents[1] = (Uint)Fcn;
545 stack_contents[0] = (Uint)new;
547 // Create a new worker stack (in PID0's address space)
548 // The stack is relocated by this code
549 new->KernelStack = MM_NewWorkerStack(stack_contents, sizeof(stack_contents));
551 new->SavedState.RSP = new->KernelStack - sizeof(stack_contents);
552 new->SavedState.RIP = (Uint)&NewTaskHeader;
554 // Log("New (Worker) %p, rsp = %p\n", new->SavedState.RIP, new->SavedState.RSP);
557 new->Status = THREAD_STAT_PREINIT;
558 Threads_AddActive( new );
564 * \brief Creates a new user stack
566 Uint Proc_MakeUserStack(void)
569 Uint base = USER_STACK_TOP - USER_STACK_SZ;
571 // Check Prospective Space
572 for( i = USER_STACK_SZ >> 12; i--; )
574 if( MM_GetPhysAddr( base + (i<<12) ) != 0 )
578 if(i != -1) return 0;
580 // Allocate Stack - Allocate incrementally to clean up MM_Dump output
581 for( i = 0; i < (USER_STACK_SZ-USER_STACK_PREALLOC)/0x1000; i++ )
583 MM_AllocateZero( base + (i<<12) );
585 for( ; i < USER_STACK_SZ/0x1000; i++ )
587 tPAddr alloc = MM_Allocate( base + (i<<12) );
591 Log_Error("Proc", "Unable to allocate user stack (%i pages requested)", USER_STACK_SZ/0x1000);
593 MM_Deallocate( base + (i<<12) );
598 return base + USER_STACK_SZ;
602 void Proc_StartUser(Uint Entrypoint, Uint Base, int ArgC, char **ArgV, int DataSize)
612 stack = (void*)Proc_MakeUserStack();
614 Log_Error("Proc", "Unable to create user stack!");
617 stack -= (DataSize+7)/8;
618 LOG("stack = 0x%x", stack);
619 Log("stack = %p, DataSize = %i", stack, DataSize);
620 memcpy( stack, ArgV, DataSize );
623 // Adjust Arguments and environment
624 delta = (Uint)stack - (Uint)ArgV;
625 ArgV = (char**)stack;
626 for( i = 0; ArgV[i]; i++ ) ArgV[i] += delta;
628 for( i = 0; envp[i]; i++ ) envp[i] += delta;
630 // User Mode Segments
632 ss = 0x23; cs = 0x2B;
635 *--stack = (Uint)envp;
636 *--stack = (Uint)ArgV;
637 *--stack = (Uint)ArgC;
640 Proc_StartProcess(ss, (Uint)stack, 0x202, cs, Entrypoint);
643 void Proc_StartProcess(Uint16 SS, Uint Stack, Uint Flags, Uint16 CS, Uint IP)
645 if( !(CS == 0x1B || CS == 0x2B) || SS != 0x23 ) {
646 Log_Error("Proc", "Proc_StartProcess: CS / SS are not valid (%x, %x)",
650 // Log("Proc_StartProcess: (SS=%x, Stack=%p, Flags=%x, CS=%x, IP=%p)", SS, Stack, Flags, CS, IP);
651 // MM_DumpTables(0, USER_MAX);
655 __asm__ __volatile__ (
656 "mov %0, %%rsp;\n\t" // Set stack pointer
657 "mov %2, %%r11;\n\t" // Set RFLAGS
659 : : "r" (Stack), "c" (IP), "r" (Flags)
665 __asm__ __volatile__ (
666 "mov %0, %%rsp;\n\t" // Set stack pointer
667 "mov %2, %%r11;\n\t" // Set RFLAGS
669 : : "r" (Stack), "c" (IP), "r" (Flags)
676 * \fn int Proc_Demote(Uint *Err, int Dest, tRegs *Regs)
677 * \brief Demotes a process to a lower permission level
678 * \param Err Pointer to user's errno
679 * \param Dest New Permission Level
680 * \param Regs Pointer to user's register structure
682 int Proc_Demote(Uint *Err, int Dest, tRegs *Regs)
684 int cpl = Regs->CS & 3;
686 if(Dest > 3 || Dest < 0) {
697 // Change the Segment Registers
698 Regs->CS = (((Dest+1)<<4) | Dest) - 8;
699 Regs->SS = ((Dest+1)<<4) | Dest;
705 * \brief Calls a signal handler in user mode
706 * \note Used for signals
708 void Proc_CallFaultHandler(tThread *Thread)
711 Proc_ReturnToUser(Thread->FaultHandler, Thread->KernelStack, Thread->CurFaultNum);
715 void Proc_DumpThreadCPUState(tThread *Thread)
717 Log(" At %04x:%016llx", Thread->SavedState.UserCS, Thread->SavedState.UserRIP);
720 void Proc_Reschedule(void)
722 tThread *nextthread, *curthread;
723 int cpu = GetCPUNum();
725 // TODO: Wait for it?
726 if(IS_LOCKED(&glThreadListLock)) return;
728 curthread = gaCPUs[cpu].Current;
730 nextthread = Threads_GetNextToRun(cpu, curthread);
732 if(nextthread == curthread) return ;
734 nextthread = gaCPUs[cpu].IdleThread;
738 #if DEBUG_TRACE_SWITCH
739 LogF("\nSwitching to task CR3 = 0x%x, RIP = %p, RSP = %p - %i (%s)\n",
740 nextthread->MemState.CR3,
741 nextthread->SavedState.RIP,
742 nextthread->SavedState.RSP,
744 nextthread->ThreadName
749 gaCPUs[cpu].Current = nextthread;
750 gTSSs[cpu].RSP0 = nextthread->KernelStack-4;
751 __asm__ __volatile__ ("mov %0, %%db0" : : "r" (nextthread));
754 nextthread->SavedState.RSP, &curthread->SavedState.RSP,
755 nextthread->SavedState.RIP, &curthread->SavedState.RIP,
756 nextthread->MemState.CR3
762 * \fn void Proc_Scheduler(int CPU)
763 * \brief Swap current thread and clears dead threads
765 void Proc_Scheduler(int CPU, Uint RSP, Uint RIP)
771 // If the spinlock is set, let it complete
772 if(IS_LOCKED(&glThreadListLock)) return;
774 // Get current thread
775 thread = gaCPUs[CPU].Current;
780 // Reduce remaining quantum and continue timeslice if non-zero
781 if(thread->Remaining--) return;
782 // Reset quantum for next call
783 thread->Remaining = thread->Quantum;
785 // TODO: Make this more stable somehow
787 regs = (tRegs*)(RSP+(1)*8); // CurThread
788 thread->SavedState.UserCS = regs->CS;
789 thread->SavedState.UserRIP = regs->RIP;
801 EXPORT(Proc_SpawnWorker);