2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu>
11 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Jack Lange <jarusl@cs.northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
20 #include <palacios/vmm_dev_mgr.h>
21 #include <palacios/vmm_sprintf.h>
22 #include <palacios/vm_guest.h>
23 #include <devices/icc_bus.h>
24 #include <devices/apic_regs.h>
29 #ifndef CONFIG_DEBUG_ICC_BUS
31 #define PrintDebug(fmt, args...)
35 void v3_force_exit(void *p) {
36 struct guest_info *core=(struct guest_info *)p;
37 PrintDebug("core %u: Forced to exit!\n",core->cpu_id);
40 struct ipi_thunk_data {
41 struct vm_device * target;
48 struct guest_info * core;
49 struct v3_icc_ops * ops;
56 struct icc_bus_state {
57 struct apic_data apics[MAX_APICS];
62 static struct v3_device_ops dev_ops = {
70 static char *shorthand_str[] = {
77 static char *deliverymode_str[] = {
90 static int deliver(uint32_t src_apic, struct apic_data *dest_apic, struct int_cmd_reg *icr, struct icc_bus_state * state) {
92 switch (icr->del_mode) {
95 case 1: // lowest priority
96 PrintDebug("icc_bus: delivering IRQ to core %u\n",dest_apic->core->cpu_id);
97 dest_apic->ops->raise_intr(dest_apic->core, icr->vec, dest_apic->priv_data);
98 if (src_apic!=state->ioapic_id && dest_apic->core->cpu_id != src_apic) {
99 // Assume core # is same as logical processor for now
100 // TODO FIX THIS FIX THIS
101 // THERE SHOULD BE: guestapicid->virtualapicid map,
102 // cpu_id->logical processor map
103 // host maitains logical proc->phsysical proc
104 PrintDebug("icc_bus: non-local core, forcing it to exit\n");
105 V3_Call_On_CPU(dest_apic->core->cpu_id,v3_force_exit,(void*)(dest_apic->core));
106 // TODO: do what the print says
111 PrintError("icc_bus: SMI delivery is unsupported\n");
117 PrintError("icc_bus: Reserved delivery mode 3 is unsupported\n");
122 PrintError("icc_bus: NMI delivery is unsupported\n");
127 struct guest_info *core = dest_apic->core;
129 PrintDebug("icc_bus: INIT delivery to core %u\n",core->cpu_id);
131 // TODO: any APIC reset on dest core (shouldn't be needed, but not sure...)
134 if (core->cpu_mode!=INIT) {
135 PrintError("icc_bus: Warning: core %u is not in INIT state, ignored\n",core->cpu_id);
136 // Only a warning, since INIT INIT SIPI is common
140 // We transition the target core to SIPI state
141 core->cpu_mode=SIPI; // note: locking should not be needed here
143 // That should be it since the target core should be
144 // waiting in host on this transition
145 // either it's on another core or on a different preemptive thread
146 // in both cases, it will quickly notice this transition
147 // in particular, we should not need to force an exit here
149 PrintDebug("icc_bus: INIT delivery done\n");
155 struct guest_info *core = dest_apic->core;
156 uint64_t rip = icr->vec << 12; // vector encodes target address;
158 PrintDebug("icc_bus: SIPI delivery (0x%x -> rip=0x%p) to core %u\n",
159 icr->vec, (void*)rip, core->cpu_id);
162 if (core->cpu_mode!=SIPI) {
163 PrintError("icc_bus: core %u is not in SIPI state, ignored!\n",core->cpu_id);
167 // Write the RIP, CS, and descriptor
168 // assume the rest is already good to go
169 core->rip=rip & 0xffff;
170 core->segments.cs.selector = (rip >> 4) & 0xf000;
171 core->segments.cs.limit= 0xffff;
172 core->segments.cs.base = rip & 0xf0000;
174 // Maybe need to adjust the APIC?
176 // We transition the target core to SIPI state
177 core->cpu_mode=REAL; // note: locking should not be needed here
179 // As with INIT, we should not need to do anything else
181 PrintDebug("icc_bus: SIPI delivery done\n");
192 int v3_icc_send_ipi(struct vm_device * icc_bus, uint32_t src_apic, uint64_t icr_data) {
194 PrintDebug("icc_bus: icc_bus=%p, src_apic=%u, icr_data=%llx\n",icc_bus,src_apic,icr_data);
196 struct int_cmd_reg *icr = (struct int_cmd_reg *)&icr_data;
197 struct icc_bus_state * state = (struct icc_bus_state *)icc_bus->private_data;
199 // initial sanity checks
200 if (src_apic>=MAX_APICS || (!state->apics[src_apic].present && src_apic!=state->ioapic_id)) {
201 PrintError("icc_bus: Apparently sending from unregistered apic id=%u\n",src_apic);
204 if (icr->dst_mode==0 && !state->apics[icr->dst].present) {
205 PrintError("icc_bus: Attempted send to unregistered apic id=%u\n",icr->dst);
209 struct apic_data * dest_apic = &(state->apics[icr->dst]);
212 PrintDebug("icc_bus: IPI %s %u from %s %u to %s %u (icr=0x%llx)\n",
213 deliverymode_str[icr->del_mode], icr->vec, src_apic==state->ioapic_id ? "ioapic" : "apic",
214 src_apic, shorthand_str[icr->dst_shorthand], icr->dst,icr->val);
219 switch (icr->dst_shorthand) {
221 case 0: // no shorthand
222 if (deliver(src_apic,dest_apic,icr,state)) {
228 if (icr->dst==state->ioapic_id) {
229 PrintError("icc_bus: ioapic attempting to send to itself\n");
232 if (deliver(src_apic,dest_apic,icr,state)) {
238 case 3: { // all and all-but-me
240 for (i=0;i<MAX_APICS;i++) {
241 dest_apic=&(state->apics[i]);
242 if (dest_apic->present && (i!=src_apic || icr->dst_shorthand==2)) {
243 if (deliver(src_apic,dest_apic,icr,state)) {
257 /* THIS IS A BIG ASSUMPTION: APIC PHYSID == LOGID == CORENUM */
259 int v3_icc_register_apic(struct guest_info * core, struct vm_device * icc_bus,
260 uint8_t apic_num, struct v3_icc_ops * ops, void * priv_data) {
261 struct icc_bus_state * icc = (struct icc_bus_state *)icc_bus->private_data;
262 struct apic_data * apic = &(icc->apics[apic_num]);
264 if (apic->present == 1) {
265 PrintError("icc_bus: Attempt to re-register apic %u\n", apic_num);
270 apic->priv_data = priv_data;
274 PrintDebug("icc_bus: Registered apic %u\n", apic_num);
280 int v3_icc_register_ioapic(struct v3_vm_info *vm, struct vm_device * icc_bus, uint8_t apic_num)
282 struct icc_bus_state * icc = (struct icc_bus_state *)icc_bus->private_data;
284 if (icc->ioapic_id) {
285 PrintError("icc_bus: Attempt to register a second ioapic!\n");
289 icc->ioapic_id=apic_num;
291 PrintDebug("icc_bus: Registered ioapic %u\n", apic_num);
299 static int icc_bus_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
300 PrintDebug("icc_bus: Creating ICC_BUS\n");
302 char * name = v3_cfg_val(cfg, "name");
304 struct icc_bus_state * icc_bus = (struct icc_bus_state *)V3_Malloc(sizeof(struct icc_bus_state));
305 memset(icc_bus, 0, sizeof(struct icc_bus_state));
307 struct vm_device * dev = v3_allocate_device(name, &dev_ops, icc_bus);
309 if (v3_attach_device(vm, dev) == -1) {
310 PrintError("icc_bus: Could not attach device %s\n", name);
319 device_register("ICC_BUS", icc_bus_init)