16 #define DEBUG_TRACE_SWITCH 0
19 #define SWITCH_MAGIC 0x55ECAFFF##FFFACE55 // There is no code in this area
21 #define TIMER_DIVISOR 11931 //~100Hz
25 extern void APStartup(); // 16-bit AP startup code
26 extern Uint GetRIP(); // start.asm
27 extern Uint64 gInitialPML4[512]; // start.asm
28 extern void gInitialKernelStack;
29 extern tSpinlock glThreadListLock;
32 extern int giTotalTickets;
33 extern int giNumActiveThreads;
34 extern tThread gThreadZero;
35 extern tThread *gActiveThreads;
36 extern tThread *gSleepingThreads;
37 extern tThread *gDeleteThreads;
38 extern tThread *Threads_GetNextToRun(int CPU);
39 extern void Threads_Dump(void);
40 extern tThread *Threads_CloneTCB(Uint *Err, Uint Flags);
41 extern void Proc_ReturnToUser(void);
42 extern void GetCPUNum(void);
45 void ArchThreads_Init();
47 void MP_StartAP(int CPU);
48 void MP_SendIPI(Uint8 APICID, int Vector, int DeliveryMode);
51 tThread *Proc_GetCurThread();
52 void Proc_ChangeStack();
53 int Proc_Clone(Uint *Err, Uint Flags);
54 void Proc_StartProcess(Uint16 SS, Uint Stack, Uint Flags, Uint16 CS, Uint IP);
55 void Proc_CallFaultHandler(tThread *Thread);
56 void Proc_Scheduler();
59 // --- Multiprocessing ---
61 volatile int giNumInitingCPUs = 0;
62 tMPInfo *gMPFloatPtr = NULL;
63 tAPIC *gpMP_LocalAPIC = NULL;
64 Uint8 gaAPIC_to_CPU[256] = {0};
65 tCPU gaCPUs[MAX_CPUS];
67 tThread *gCurrentThread = NULL;
71 // --- Error Recovery ---
72 Uint32 gaDoubleFaultStack[1024];
76 * \fn void ArchThreads_Init()
77 * \brief Starts the process scheduler
79 void ArchThreads_Init()
89 // -- Initialise Multiprocessing
90 // Find MP Floating Table
91 // - EBDA/Last 1Kib (640KiB)
92 for(pos = KERNEL_BASE|0x9F000; pos < (KERNEL_BASE|0xA0000); pos += 16) {
93 if( *(Uint*)(pos) == MPPTR_IDENT ) {
94 Log("Possible %p", pos);
95 if( ByteSum((void*)pos, sizeof(tMPInfo)) != 0 ) continue;
96 gMPFloatPtr = (void*)pos;
100 // - Last KiB (512KiB base mem)
102 for(pos = KERNEL_BASE|0x7F000; pos < (KERNEL_BASE|0x80000); pos += 16) {
103 if( *(Uint*)(pos) == MPPTR_IDENT ) {
104 Log("Possible %p", pos);
105 if( ByteSum((void*)pos, sizeof(tMPInfo)) != 0 ) continue;
106 gMPFloatPtr = (void*)pos;
113 for(pos = KERNEL_BASE|0xE0000; pos < (KERNEL_BASE|0x100000); pos += 16) {
114 if( *(Uint*)(pos) == MPPTR_IDENT ) {
115 Log("Possible %p", pos);
116 if( ByteSum((void*)pos, sizeof(tMPInfo)) != 0 ) continue;
117 gMPFloatPtr = (void*)pos;
123 // If the MP Table Exists, parse it
128 Log("gMPFloatPtr = %p", gMPFloatPtr);
129 Log("*gMPFloatPtr = {");
130 Log("\t.Sig = 0x%08x", gMPFloatPtr->Sig);
131 Log("\t.MPConfig = 0x%08x", gMPFloatPtr->MPConfig);
132 Log("\t.Length = 0x%02x", gMPFloatPtr->Length);
133 Log("\t.Version = 0x%02x", gMPFloatPtr->Version);
134 Log("\t.Checksum = 0x%02x", gMPFloatPtr->Checksum);
135 Log("\t.Features = [0x%02x,0x%02x,0x%02x,0x%02x,0x%02x]",
136 gMPFloatPtr->Features[0], gMPFloatPtr->Features[1],
137 gMPFloatPtr->Features[2], gMPFloatPtr->Features[3],
138 gMPFloatPtr->Features[4]
142 mptable = (void*)( KERNEL_BASE|gMPFloatPtr->MPConfig );
143 Log("mptable = %p", mptable);
145 Log("\t.Sig = 0x%08x", mptable->Sig);
146 Log("\t.BaseTableLength = 0x%04x", mptable->BaseTableLength);
147 Log("\t.SpecRev = 0x%02x", mptable->SpecRev);
148 Log("\t.Checksum = 0x%02x", mptable->Checksum);
149 Log("\t.OEMID = '%8c'", mptable->OemID);
150 Log("\t.ProductID = '%8c'", mptable->ProductID);
151 Log("\t.OEMTablePtr = %p'", mptable->OEMTablePtr);
152 Log("\t.OEMTableSize = 0x%04x", mptable->OEMTableSize);
153 Log("\t.EntryCount = 0x%04x", mptable->EntryCount);
154 Log("\t.LocalAPICMemMap = 0x%08x", mptable->LocalAPICMemMap);
155 Log("\t.ExtendedTableLen = 0x%04x", mptable->ExtendedTableLen);
156 Log("\t.ExtendedTableChecksum = 0x%02x", mptable->ExtendedTableChecksum);
159 gpMP_LocalAPIC = (void*)MM_MapHWPage(mptable->LocalAPICMemMap, 1);
161 ents = mptable->Entries;
164 for( i = 0; i < mptable->EntryCount; i ++ )
171 Log("%i: Processor", i);
172 Log("\t.APICID = %i", ents->Proc.APICID);
173 Log("\t.APICVer = 0x%02x", ents->Proc.APICVer);
174 Log("\t.CPUFlags = 0x%02x", ents->Proc.CPUFlags);
175 Log("\t.CPUSignature = 0x%08x", ents->Proc.CPUSignature);
176 Log("\t.FeatureFlags = 0x%08x", ents->Proc.FeatureFlags);
179 if( !(ents->Proc.CPUFlags & 1) ) {
184 // Check if there is too many processors
185 if(giNumCPUs >= MAX_CPUS) {
186 giNumCPUs ++; // If `giNumCPUs` > MAX_CPUS later, it will be clipped
190 // Initialise CPU Info
191 gaAPIC_to_CPU[ents->Proc.APICID] = giNumCPUs;
192 gaCPUs[giNumCPUs].APICID = ents->Proc.APICID;
193 gaCPUs[giNumCPUs].State = 0;
197 if( !(ents->Proc.CPUFlags & 2) )
199 MP_StartAP( giNumCPUs-1 );
206 Log("\t.ID = %i", ents->Bus.ID);
207 Log("\t.TypeString = '%6c'", ents->Bus.TypeString);
211 Log("%i: I/O APIC", i);
212 Log("\t.ID = %i", ents->IOAPIC.ID);
213 Log("\t.Version = 0x%02x", ents->IOAPIC.Version);
214 Log("\t.Flags = 0x%02x", ents->IOAPIC.Flags);
215 Log("\t.Addr = 0x%08x", ents->IOAPIC.Addr);
217 case 3: // I/O Interrupt Assignment
219 Log("%i: I/O Interrupt Assignment", i);
220 Log("\t.IntType = %i", ents->IOInt.IntType);
221 Log("\t.Flags = 0x%04x", ents->IOInt.Flags);
222 Log("\t.SourceBusID = 0x%02x", ents->IOInt.SourceBusID);
223 Log("\t.SourceBusIRQ = 0x%02x", ents->IOInt.SourceBusIRQ);
224 Log("\t.DestAPICID = 0x%02x", ents->IOInt.DestAPICID);
225 Log("\t.DestAPICIRQ = 0x%02x", ents->IOInt.DestAPICIRQ);
227 case 4: // Local Interrupt Assignment
229 Log("%i: Local Interrupt Assignment", i);
230 Log("\t.IntType = %i", ents->LocalInt.IntType);
231 Log("\t.Flags = 0x%04x", ents->LocalInt.Flags);
232 Log("\t.SourceBusID = 0x%02x", ents->LocalInt.SourceBusID);
233 Log("\t.SourceBusIRQ = 0x%02x", ents->LocalInt.SourceBusIRQ);
234 Log("\t.DestLocalAPICID = 0x%02x", ents->LocalInt.DestLocalAPICID);
235 Log("\t.DestLocalAPICIRQ = 0x%02x", ents->LocalInt.DestLocalAPICIRQ);
238 Log("%i: Unknown (%i)", i, ents->Type);
241 ents = (void*)( (Uint)ents + entSize );
244 if( giNumCPUs > MAX_CPUS ) {
245 Warning("Too many CPUs detected (%i), only using %i of them", giNumCPUs, MAX_CPUS);
246 giNumCPUs = MAX_CPUS;
249 while( giNumInitingCPUs )
250 MM_FinishVirtualInit();
252 Panic("Uh oh... MP Table Parsing is unimplemented\n");
255 Log("No MP Table was found, assuming uniprocessor\n");
262 MM_FinishVirtualInit();
266 // Initialise Normal TSS(s)
267 for(pos=0;pos<giNumCPUs;pos++)
272 gTSSs[pos].RSP0 = 0; // Set properly by scheduler
273 gGDT[7+pos*2].LimitLow = sizeof(tTSS) & 0xFFFF;
274 gGDT[7+pos*2].BaseLow = ((Uint)(&gTSSs[pos])) & 0xFFFF;
275 gGDT[7+pos*2].BaseMid = ((Uint)(&gTSSs[pos])) >> 16;
276 gGDT[7+pos*2].BaseHi = ((Uint)(&gTSSs[pos])) >> 24;
277 gGDT[7+pos*2+1].DWord[0] = ((Uint)(&gTSSs[pos])) >> 32;
280 for(pos=0;pos<giNumCPUs;pos++) {
282 __asm__ __volatile__ ("ltr %%ax"::"a"(0x38+pos*16));
288 gaCPUs[0].Current = &gThreadZero;
290 gCurrentThread = &gThreadZero;
293 gThreadZero.MemState.CR3 = (Uint)gInitialPML4 - KERNEL_BASE;
295 // Set timer frequency
296 outb(0x43, 0x34); // Set Channel 0, Low/High, Rate Generator
297 outb(0x40, TIMER_DIVISOR&0xFF); // Low Byte of Divisor
298 outb(0x40, (TIMER_DIVISOR>>8)&0xFF); // High Byte
300 // Create Per-Process Data Block
301 MM_Allocate(MM_PPD_CFG);
308 void MP_StartAP(int CPU)
310 Log("Starting AP %i (APIC %i)", CPU, gaCPUs[CPU].APICID);
311 // Set location of AP startup code and mark for a warm restart
312 *(Uint16*)(KERNEL_BASE|0x467) = (Uint)&APStartup - (KERNEL_BASE|0xFFFF0);
313 *(Uint16*)(KERNEL_BASE|0x469) = 0xFFFF;
314 outb(0x70, 0x0F); outb(0x71, 0x0A); // Warm Reset
315 MP_SendIPI(gaCPUs[CPU].APICID, 0, 5);
319 void MP_SendIPI(Uint8 APICID, int Vector, int DeliveryMode)
321 Uint32 addr = (Uint)gpMP_LocalAPIC + 0x300;
325 val = (Uint)APICID << 24;
326 Log("*%p = 0x%08x", addr+0x10, val);
327 *(Uint32*)(addr+0x10) = val;
329 val = ((DeliveryMode & 7) << 8) | (Vector & 0xFF);
330 Log("*%p = 0x%08x", addr, val);
331 *(Uint32*)addr = val;
336 * \fn void Proc_Start()
337 * \brief Start process scheduler
341 // Start Interrupts (and hence scheduler)
342 __asm__ __volatile__("sti");
346 * \fn tThread *Proc_GetCurThread()
347 * \brief Gets the current thread
349 tThread *Proc_GetCurThread()
352 //return gaCPUs[ gaAPIC_to_CPU[gpMP_LocalAPIC->ID.Val&0xFF] ].Current;
353 return gaCPUs[ GetCPUNum() ].Current;
355 return gCurrentThread;
360 * \fn void Proc_ChangeStack()
361 * \brief Swaps the current stack for a new one (in the proper stack reigon)
363 void Proc_ChangeStack()
366 Uint tmp_rbp, old_rsp;
367 Uint curBase, newBase;
369 __asm__ __volatile__ ("mov %%rsp, %0":"=r"(rsp));
370 __asm__ __volatile__ ("mov %%rbp, %0":"=r"(rbp));
375 newBase = MM_NewKStack();
378 Panic("What the?? Unable to allocate space for initial kernel stack");
382 curBase = (Uint)&gInitialKernelStack;
384 Log("curBase = 0x%x, newBase = 0x%x", curBase, newBase);
386 // Get ESP as a used size
388 Log("memcpy( %p, %p, 0x%x )", (void*)(newBase - rsp), (void*)(curBase - rsp), rsp );
390 memcpy( (void*)(newBase - rsp), (void*)(curBase - rsp), rsp );
391 // Get ESP as an offset in the new stack
394 rbp = newBase - (curBase - rbp);
397 // Repair EBPs & Stack Addresses
398 // Catches arguments also, but may trash stack-address-like values
399 for(tmp_rbp = rsp; tmp_rbp < newBase; tmp_rbp += sizeof(Uint))
401 if(old_rsp < *(Uint*)tmp_rbp && *(Uint*)tmp_rbp < curBase)
402 *(Uint*)tmp_rbp += newBase - curBase;
405 Log("Applying Changes");
406 Proc_GetCurThread()->KernelStack = newBase;
407 __asm__ __volatile__ ("mov %0, %%rsp"::"r"(rsp));
408 __asm__ __volatile__ ("mov %0, %%rbp"::"r"(rbp));
412 * \fn int Proc_Clone(Uint *Err, Uint Flags)
413 * \brief Clone the current process
415 int Proc_Clone(Uint *Err, Uint Flags)
418 tThread *cur = Proc_GetCurThread();
421 __asm__ __volatile__ ("mov %%rsp, %0": "=r"(rsp));
422 __asm__ __volatile__ ("mov %%rbp, %0": "=r"(rbp));
424 newThread = Threads_CloneTCB(Err, Flags);
425 if(!newThread) return -1;
427 // Initialise Memory Space (New Addr space or kernel stack)
428 if(Flags & CLONE_VM) {
429 newThread->MemState.CR3 = MM_Clone();
430 newThread->KernelStack = cur->KernelStack;
432 Uint tmp_rbp, old_rsp = rsp;
435 newThread->MemState.CR3 = cur->MemState.CR3;
438 newThread->KernelStack = MM_NewKStack();
440 if(newThread->KernelStack == 0) {
445 // Get ESP as a used size
446 rsp = cur->KernelStack - rsp;
449 (void*)(newThread->KernelStack - rsp),
450 (void*)(cur->KernelStack - rsp),
453 // Get ESP as an offset in the new stack
454 rsp = newThread->KernelStack - rsp;
456 rbp = newThread->KernelStack - (cur->KernelStack - rbp);
458 // Repair EBPs & Stack Addresses
459 // Catches arguments also, but may trash stack-address-like values
460 for(tmp_rbp = rsp; tmp_rbp < newThread->KernelStack; tmp_rbp += 4)
462 if(old_rsp < *(Uint*)tmp_rbp && *(Uint*)tmp_rbp < cur->KernelStack)
463 *(Uint*)tmp_rbp += newThread->KernelStack - cur->KernelStack;
467 // Save core machine state
468 newThread->SavedState.RSP = rsp;
469 newThread->SavedState.RBP = rbp;
471 if(rip == SWITCH_MAGIC) {
472 outb(0x20, 0x20); // ACK Timer and return as child
477 newThread->SavedState.RIP = rip;
479 // Lock list and add to active
480 Threads_AddActive(newThread);
482 return newThread->TID;
486 * \fn int Proc_SpawnWorker()
487 * \brief Spawns a new worker thread
489 int Proc_SpawnWorker()
494 cur = Proc_GetCurThread();
497 new = malloc( sizeof(tThread) );
499 Warning("Proc_SpawnWorker - Out of heap space!\n");
502 memcpy(new, &gThreadZero, sizeof(tThread));
504 new->TID = giNextTID++;
505 // Create a new worker stack (in PID0's address space)
506 // The stack is relocated by this code
507 new->KernelStack = MM_NewWorkerStack();
509 // Get ESP and EBP based in the new stack
510 __asm__ __volatile__ ("mov %%rsp, %0": "=r"(rsp));
511 __asm__ __volatile__ ("mov %%rbp, %0": "=r"(rbp));
512 rsp = new->KernelStack - (cur->KernelStack - rsp);
513 rbp = new->KernelStack - (cur->KernelStack - rbp);
515 // Save core machine state
516 new->SavedState.RSP = rsp;
517 new->SavedState.RBP = rbp;
519 if(rip == SWITCH_MAGIC) {
520 outb(0x20, 0x20); // ACK Timer and return as child
525 new->SavedState.RIP = rip;
527 new->Status = THREAD_STAT_ACTIVE;
528 Threads_AddActive( new );
534 * \fn Uint Proc_MakeUserStack()
535 * \brief Creates a new user stack
537 Uint Proc_MakeUserStack()
540 Uint base = USER_STACK_TOP - USER_STACK_SZ;
542 // Check Prospective Space
543 for( i = USER_STACK_SZ >> 12; i--; )
544 if( MM_GetPhysAddr( base + (i<<12) ) != 0 )
547 if(i != -1) return 0;
549 // Allocate Stack - Allocate incrementally to clean up MM_Dump output
550 for( i = 0; i < USER_STACK_SZ/4069; i++ )
551 MM_Allocate( base + (i<<12) );
553 return base + USER_STACK_SZ;
558 * \fn void Proc_StartUser(Uint Entrypoint, Uint *Bases, int ArgC, char **ArgV, char **EnvP, int DataSize)
559 * \brief Starts a user task
561 void Proc_StartUser(Uint Entrypoint, Uint *Bases, int ArgC, char **ArgV, char **EnvP, int DataSize)
563 Uint *stack = (void*)Proc_MakeUserStack();
568 LOG("stack = 0x%x", stack);
571 stack = (void*)( (Uint)stack - DataSize );
572 memcpy( stack, ArgV, DataSize );
574 // Adjust Arguments and environment
575 delta = (Uint)stack - (Uint)ArgV;
576 ArgV = (char**)stack;
577 for( i = 0; ArgV[i]; i++ ) ArgV[i] += delta;
580 for( i = 0; EnvP[i]; i++ ) EnvP[i] += delta;
582 // User Mode Segments
583 ss = 0x23; cs = 0x1B;
586 *--stack = (Uint)EnvP;
587 *--stack = (Uint)ArgV;
588 *--stack = (Uint)ArgC;
591 *--stack = 0; // Return Address
593 Proc_StartProcess(ss, (Uint)stack, 0x202, cs, Entrypoint);
596 void Proc_StartProcess(Uint16 SS, Uint Stack, Uint Flags, Uint16 CS, Uint IP)
598 Uint *stack = (void*)Stack;
599 *--stack = SS; //Stack Segment
600 *--stack = Stack; //Stack Pointer
601 *--stack = Flags; //EFLAGS (Resvd (0x2) and IF (0x20))
602 *--stack = CS; //Code Segment
605 *--stack = 0xAAAAAAAA; // eax
606 *--stack = 0xCCCCCCCC; // ecx
607 *--stack = 0xDDDDDDDD; // edx
608 *--stack = 0xBBBBBBBB; // ebx
609 *--stack = 0xD1D1D1D1; // edi
610 *--stack = 0x54545454; // rsp - NOT POPED
611 *--stack = 0x51515151; // esi
612 *--stack = 0xB4B4B4B4; // rbp
616 __asm__ __volatile__ (
617 "mov %%rax,%%rsp;\n\t" // Set stack pointer
618 "iret;\n\t" : : "a" (stack));
623 * \fn int Proc_Demote(Uint *Err, int Dest, tRegs *Regs)
624 * \brief Demotes a process to a lower permission level
625 * \param Err Pointer to user's errno
626 * \param Dest New Permission Level
627 * \param Regs Pointer to user's register structure
629 int Proc_Demote(Uint *Err, int Dest, tRegs *Regs)
631 int cpl = Regs->CS & 3;
633 if(Dest > 3 || Dest < 0) {
644 // Change the Segment Registers
645 Regs->CS = (((Dest+1)<<4) | Dest) - 8;
646 Regs->SS = ((Dest+1)<<4) | Dest;
652 * \brief Calls a signal handler in user mode
653 * \note Used for signals
655 void Proc_CallFaultHandler(tThread *Thread)
657 // Rewinds the stack and calls the user function
659 __asm__ __volatile__ ("mov %0, %%rbp;\n\tcall Proc_ReturnToUser" :: "r"(Thread->FaultHandler));
664 * \fn void Proc_Scheduler(int CPU)
665 * \brief Swap current thread and clears dead threads
667 void Proc_Scheduler(int CPU)
672 // If the spinlock is set, let it complete
673 if(IS_LOCKED(&glThreadListLock)) return;
675 // Clear Delete Queue
676 while(gDeleteThreads)
678 thread = gDeleteThreads->Next;
679 if(gDeleteThreads->IsLocked) { // Only free if structure is unused
680 gDeleteThreads->Status = THREAD_STAT_NULL;
681 free( gDeleteThreads );
683 gDeleteThreads = thread;
686 // Check if there is any tasks running
687 if(giNumActiveThreads == 0) {
688 Log("No Active threads, sleeping");
689 __asm__ __volatile__ ("hlt");
693 // Get current thread
695 thread = gaCPUs[CPU].Current;
697 thread = gCurrentThread;
700 // Reduce remaining quantum and continue timeslice if non-zero
701 if(thread->Remaining--) return;
702 // Reset quantum for next call
703 thread->Remaining = thread->Quantum;
706 __asm__ __volatile__ ("mov %%rsp, %0":"=r"(rsp));
707 __asm__ __volatile__ ("mov %%rbp, %0":"=r"(rbp));
709 if(rip == SWITCH_MAGIC) return; // Check if a switch happened
711 // Save machine state
712 thread->SavedState.RSP = rsp;
713 thread->SavedState.RBP = rbp;
714 thread->SavedState.RIP = rip;
717 thread = Threads_GetNextToRun(CPU);
721 Warning("Hmm... Threads_GetNextToRun returned NULL, I don't think this should happen.\n");
725 #if DEBUG_TRACE_SWITCH
726 Log("Switching to task %i, CR3 = 0x%x, RIP = %p",
728 thread->MemState.CR3,
729 thread->SavedState.RIP
733 // Set current thread
735 gaCPUs[CPU].Current = thread;
737 gCurrentThread = thread;
740 // Update Kernel Stack pointer
741 gTSSs[CPU].RSP0 = thread->KernelStack-4;
745 # error "Todo: Implement PAE Address space switching"
747 __asm__ __volatile__ ("mov %0, %%cr3"::"a"(thread->MemState.CR3));
751 if(thread->SavedState.RSP > 0xC0000000
752 && thread->SavedState.RSP < thread->KernelStack-0x2000) {
753 Log_Warning("Proc", "Possible bad ESP %p (PID %i)", thread->SavedState.ESP);
758 __asm__ __volatile__ (
759 "mov %1, %%rsp\n\t" // Restore RSP
760 "mov %2, %%rbp\n\t" // and RBP
761 "jmp *%3" : : // And return to where we saved state (Proc_Clone or Proc_Scheduler)
762 "a"(SWITCH_MAGIC), "b"(thread->SavedState.RSP),
763 "d"(thread->SavedState.RBP), "c"(thread->SavedState.RIP)
765 for(;;); // Shouldn't reach here
769 EXPORT(Proc_SpawnWorker);