/*
* $Id$
*
* Copyright (C) 2003-2015 JNode.org
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; If not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
package org.jnode.vm.x86;
import java.io.PrintWriter;
import org.jnode.annotation.KernelSpace;
import org.jnode.annotation.LoadStatics;
import org.jnode.annotation.MagicPermission;
import org.jnode.annotation.NoFieldAlignments;
import org.jnode.annotation.PrivilegedActionPragma;
import org.jnode.annotation.Uninterruptible;
import org.jnode.bootlog.BootLogInstance;
import org.jnode.system.resource.ResourceManager;
import org.jnode.system.resource.ResourceNotFreeException;
import org.jnode.util.NumberUtils;
import org.jnode.vm.CpuID;
import org.jnode.vm.Unsafe;
import org.jnode.vm.VmSystem;
import org.jnode.vm.classmgr.VmIsolatedStatics;
import org.jnode.vm.classmgr.VmSharedStatics;
import org.jnode.vm.facade.VmUtils;
import org.jnode.vm.performance.PerformanceCounters;
import org.jnode.vm.scheduler.VmProcessor;
import org.jnode.vm.scheduler.VmScheduler;
import org.jnode.vm.scheduler.VmThread;
import org.jnode.vm.x86.performance.X86PerformanceCounters;
import org.vmmagic.unboxed.Address;
import org.vmmagic.unboxed.MagicUtils;
import org.vmmagic.unboxed.Word;
/**
* Processor implementation for the X86 architecture.
*
* @author Ewout Prangsma (epr@users.sourceforge.net)
*/
@NoFieldAlignments
@Uninterruptible
@MagicPermission
public abstract class VmX86Processor extends VmProcessor {
/**
* Interrupt vector for Timeslice interrupt
*/
private static final int TIMESLICE_VECTOR = 0x33;
/**
* The IRQ counters
*/
private final int[] irqCount = new int[X86IRQManager.IRQ_COUNT];
/**
* The local API
*/
private LocalAPIC localAPIC;
/**
* Memory address of the EOI register in the local APIC
*/
private Address localApicEOIAddress;
/**
* GDT used in this processor
*/
private GDT gdt;
/**
* Is this a logical processor?
*/
private boolean logical = false;
/**
* Is this the boot processor?
*/
private boolean bootProcessor;
/**
* Must the processor send timeslice interrupts to other cpu's (vm_ints.asm)
*/
volatile Word sendTimeSliceInterrupt;
/**
* The resource manager
*/
private ResourceManager rm;
/**
* Kernel variable (ints.asm)
*/
volatile Word resume_int;
/**
* Kernel variable (ints.asm)
*/
volatile Word resume_intno;
/**
* Kernel variable (ints.asm)
*/
volatile Word resume_error;
/**
* Kernel variable (ints.asm)
*/
volatile Address resume_handler;
/**
* Kernel variable (vm-ints.asm)
*/
volatile int deadLockCounter;
/**
* Kernel variable (vm-inst.asm)
*/
volatile int fxSaveCounter;
/**
* Kernel variable (vm-inst.asm)
*/
volatile int fxRestoreCounter;
/**
* Kernel variable (vm-inst.asm)
*/
volatile int deviceNaCounter;
/**
* My performance counter accessor
*/
transient X86PerformanceCounters perfCounters;
/**
* @param id
*/
public VmX86Processor(int id, VmX86Architecture arch,
VmSharedStatics statics, VmIsolatedStatics isolatedStatics,
VmScheduler scheduler, X86CpuID cpuId) {
super(id, arch, statics, isolatedStatics, scheduler);
if (cpuId != null) {
setCPUID(cpuId);
}
}
/**
* Gets the IRQ counters array.
*
* @return int[]
*/
@Uninterruptible
@KernelSpace
protected final int[] getIrqCounters() {
return irqCount;
}
/**
* Load the CPU id.
*
* @return CpuID
*/
protected CpuID loadCPUID() {
return X86CpuID.loadFromCurrentCpu();
}
/**
* @return Returns the apic.
*/
final LocalAPIC getApic() {
return this.localAPIC;
}
/**
* @param apic The apic to set.
*/
final void setApic(LocalAPIC apic) {
this.localAPIC = apic;
this.localApicEOIAddress = apic.getEOIAddress();
}
/**
* Load the APIC id of the currently executing processor and set it into the
* Id field.
*/
final void loadAndSetApicID() {
if (this.localAPIC != null) {
setId(localAPIC.getId());
}
}
/**
* Send a startup signal to this processor.
*/
@PrivilegedActionPragma
final void startup(ResourceManager rm) throws ResourceNotFreeException {
// Save resource manager, so when this processor starts, it can be
// used right away.
this.rm = rm;
final VmProcessor me = current();
Unsafe.debug("Starting up CPU " + getIdString() + " from "
+ me.getIdString() + '\n');
// Setup kernel structures
setupStructures();
// Setup the boot code
final Address bootCode = setupBootCode(rm, gdt);
// Make sure Local APIC is enabled (the local apic of the current CPU!)
Unsafe.debug("Enabling Local APIC: current state="
+ (localAPIC.isEnabled() ? "enabled" : "disabled") + '\n');
localAPIC.setEnabled(true);
localAPIC.clearErrors();
// TimeUtils.loop(5000);
// Send INIT IPI
Unsafe.debug("Sending INIT IPI to " + getIdString() + '\n');
localAPIC.sendInitIPI(getId(), true);
localAPIC.loopUntilNotBusy();
VmSystem.loop(10);
// Send INIT-DeAssert IPI
Unsafe.debug("Sending INIT-DeAssert IPI to " + getIdString() + '\n');
localAPIC.sendInitIPI(getId(), false);
localAPIC.loopUntilNotBusy();
VmSystem.loop(10);
final int numStarts = 2;
for (int i = 0; i < numStarts; i++) {
// Send STARTUP IPI
Unsafe.debug("Sending STARTUP IPI to " + getIdString() + '\n');
localAPIC.clearErrors();
localAPIC.sendStartupIPI(getId(), bootCode);
localAPIC.loopUntilNotBusy();
// Unsafe.debug("Not busy");
VmSystem.loop(100);
localAPIC.clearErrors();
}
Unsafe.debug("Started up " + getIdString() + '\n');
}
/**
* Create a new thread
*
* @param stack
* @return The new thread
*/
protected abstract VmX86Thread createThread(
VmIsolatedStatics isolatedStatics, byte[] stack);
/**
* Setup the required CPU structures. GDT, TSS, kernel stack, user stack,
* initial thread.
*/
protected final void setupStructures() {
// Clone GDT
this.gdt = new GDT();
setupGDT(gdt);
// Create user stack
final byte[] userStack = new byte[VmThread.DEFAULT_STACK_SLOTS
* getArchitecture().getReferenceSize()];
setupUserStack(userStack);
this.currentThread = createThread(getIsolatedStatics(), userStack);
this.stackEnd = ((VmX86Thread) currentThread).getStackEnd();
// gdt.dump(System.out);
}
/**
* Setup the given GDT for use by this processor.
*
* @param gdt
*/
protected abstract void setupGDT(GDT gdt);
/**
* Setup the initial user stack
*/
protected abstract void setupUserStack(byte[] userStack);
/**
* Setup a memory region with bootcode for this processor.
*
* @param rm
* @return The address of the bootcode.
*/
protected abstract Address setupBootCode(ResourceManager rm, GDT gdt)
throws ResourceNotFreeException;
/**
* Entry point for starting Application processors.
*/
@LoadStatics
@Uninterruptible
static final void applicationProcessorMain() {
final VmX86Processor cpu = (VmX86Processor) current();
Unsafe.debug("Starting Application Processor " + cpu.getIdString()
+ '\n');
// First force a load of CPUID
cpu.getCPUID();
// Prepare for threading
cpu.systemReadyForThreadSwitch();
// Detect and start logical CPU's
try {
detectAndstartLogicalProcessors(cpu.rm);
} catch (ResourceNotFreeException ex) {
BootLogInstance.get().error("Cannot detect logical processors", ex);
}
// Run idle thread.
// The scheduler will fetch other work
Unsafe.debug("Running normal threads on " + cpu.getIdString() + '\n');
cpu.getIdleThread().run();
}
/**
* Detect and start any logical processors found in the currently running
* CPU.
*/
static final void detectAndstartLogicalProcessors(ResourceManager rm)
throws ResourceNotFreeException {
final VmX86Processor cpu = (VmX86Processor) current();
if (cpu.logical) {
return;
}
final X86CpuID cpuid = (X86CpuID) cpu.getCPUID();
if (!cpuid.hasFeature(X86CpuID.FEAT_HTT)) {
// No HTT
return;
}
// Prepare for threading first
cpu.systemReadyForThreadSwitch();
final VmX86Architecture arch = (VmX86Architecture) cpu
.getArchitecture();
final int logCpuCnt = cpuid.getLogicalProcessors();
// Now create and start all logical processors
for (int i = 1; i < logCpuCnt; i++) {
final int logId = cpu.getId() | i;
Unsafe.debug("Adding logical CPU 0x" + NumberUtils.hex(logId, 2));
final VmX86Processor logCpu = (VmX86Processor) arch
.createProcessor(logId, VmUtils.getVm().getSharedStatics(), cpu
.getIsolatedStatics(), cpu.getScheduler());
logCpu.logical = true;
arch.initX86Processor(logCpu);
logCpu.startup(rm);
}
}
/**
* Gets the performance counter accessor of this processor.
*
* @return the accessor object
*/
public final PerformanceCounters getPerformanceCounters() {
if (perfCounters == null) {
synchronized (this) {
if (perfCounters == null) {
perfCounters = X86PerformanceCounters.create(this,
(X86CpuID) getCPUID());
}
}
}
return perfCounters;
}
public void dumpStatistics(PrintWriter out) {
out.println("Type : " + (bootProcessor ? "BSP" : (logical ? "AP-logical" : "AP")));
out.println("CPUID : " + getCPUID());
out.println("fxSave/Res : " + fxSaveCounter + '/' + fxRestoreCounter
+ '/' + deviceNaCounter);
out.println("Local APIC : " + ((localAPIC == null) ? "not present" :
((localAPIC.isEnabled() ? "enabled" : "disabled") + NumberUtils.hex(localAPIC.getErrors(), 4))));
out.println("TimeSliceBC: " + (sendTimeSliceInterrupt.isZero() ? "disabled" : "enabled"));
out.println("TSI : " + MagicUtils.toString(getTSIAddress().loadWord()));
}
/**
* Broadcast a timeslice interrupt to all other processors.
*/
@LoadStatics
@KernelSpace
@Uninterruptible
final void broadcastTimeSliceInterrupt() {
// Unsafe.debug("broadcast ts-int\n");
localAPIC.sendFixedIPI(0, LocalAPIC.ICR_DESTINATION_SHORTHAND_ALL_EX_SELF, TIMESLICE_VECTOR);
// Unsafe.debug("end broadcast ts-int\n");
}
/**
* Is this processor the boot processor?
*
* @return the bootProcessor
*/
public final boolean isBootProcessor() {
return bootProcessor;
}
/**
* @param bootProcessor the bootProcessor to set
*/
final void setBootProcessor(boolean bootProcessor) {
this.bootProcessor = bootProcessor;
}
/**
* @param sendTimeSliceInterrupt the sendTimeSliceInterrupt to set
*/
final void activateTimeSliceInterrupts() {
this.sendTimeSliceInterrupt = Word.one();
}
}