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>
28 #ifndef CONFIG_DEBUG_ICC_BUS
30 #define PrintDebug(fmt, args...)
34 void v3_force_exit(void *p) {
35 #ifdef CONFIG_DEBUG_ICC_BUS
36 struct guest_info *core=(struct guest_info *)p;
38 PrintDebug("core %u: Forced to exit!\n",core->cpu_id);
41 struct ipi_thunk_data {
42 struct vm_device * target;
49 struct guest_info * core;
50 struct v3_icc_ops * ops;
57 struct icc_bus_state {
58 struct apic_data apics[MAX_APICS];
63 static struct v3_device_ops dev_ops = {
70 #ifdef CONFIG_DEBUG_ICC_BUS
71 static char *shorthand_str[] = {
78 static char *deliverymode_str[] = {
91 static int deliver(uint32_t src_apic, struct apic_data *dest_apic, struct int_cmd_reg *icr, struct icc_bus_state * state, uint32_t extirq) {
93 switch (icr->del_mode) {
96 case 1: // lowest priority
98 PrintDebug("icc_bus: delivering IRQ to core %u\n",dest_apic->core->cpu_id);
99 dest_apic->ops->raise_intr(dest_apic->core,
100 icr->del_mode!=7 ? icr->vec : extirq,
101 dest_apic->priv_data);
102 if (src_apic!=state->ioapic_id && dest_apic->core->cpu_id != src_apic) {
103 // Assume core # is same as logical processor for now
104 // TODO FIX THIS FIX THIS
105 // THERE SHOULD BE: guestapicid->virtualapicid map,
106 // cpu_id->logical processor map
107 // host maitains logical proc->phsysical proc
108 PrintDebug("icc_bus: non-local core, forcing it to exit\n");
109 V3_Call_On_CPU(dest_apic->core->cpu_id,v3_force_exit,(void*)(dest_apic->core));
110 // TODO: do what the print says
115 PrintError("icc_bus: SMI delivery is unsupported\n");
120 PrintError("icc_bus: Reserved delivery mode 3 is unsupported\n");
125 PrintError("icc_bus: NMI delivery is unsupported\n");
130 struct guest_info *core = dest_apic->core;
132 PrintDebug("icc_bus: INIT delivery to core %u\n",core->cpu_id);
134 // TODO: any APIC reset on dest core (shouldn't be needed, but not sure...)
137 if (core->cpu_mode!=INIT) {
138 PrintError("icc_bus: Warning: core %u is not in INIT state, ignored\n",core->cpu_id);
139 // Only a warning, since INIT INIT SIPI is common
143 // We transition the target core to SIPI state
144 core->cpu_mode=SIPI; // note: locking should not be needed here
146 // That should be it since the target core should be
147 // waiting in host on this transition
148 // either it's on another core or on a different preemptive thread
149 // in both cases, it will quickly notice this transition
150 // in particular, we should not need to force an exit here
152 PrintDebug("icc_bus: INIT delivery done\n");
158 struct guest_info *core = dest_apic->core;
161 if (core->cpu_mode!=SIPI) {
162 PrintError("icc_bus: core %u is not in SIPI state, ignored!\n",core->cpu_id);
166 // Write the RIP, CS, and descriptor
167 // assume the rest is already good to go
169 // vector VV -> rip at 0
171 // This means we start executing at linear address VV000
173 // So the selector needs to be VV00
174 // and the base needs to be VV000
177 core->segments.cs.selector = icr->vec<<8;
178 core->segments.cs.limit= 0xffff;
179 core->segments.cs.base = icr->vec<<12;
181 PrintDebug("icc_bus: SIPI delivery (0x%x -> 0x%x:0x0) to core %u\n",
182 icr->vec, core->segments.cs.selector, core->cpu_id);
183 // Maybe need to adjust the APIC?
185 // We transition the target core to SIPI state
186 core->cpu_mode=REAL; // note: locking should not be needed here
188 // As with INIT, we should not need to do anything else
190 PrintDebug("icc_bus: SIPI delivery done\n");
201 // icr_data contains interrupt vector *except* for ext_int
202 // in which case it is given via irq
204 int v3_icc_send_ipi(struct vm_device * icc_bus, uint32_t src_apic, uint64_t icr_data,
205 uint32_t dfr_data, uint32_t extirq) {
207 PrintDebug("icc_bus: icc_bus=%p, src_apic=%u, icr_data=%llx, extirq=%u\n",icc_bus,src_apic,icr_data,extirq);
209 struct int_cmd_reg *icr = (struct int_cmd_reg *)&icr_data;
210 struct dst_fmt_reg *dfr = (struct dst_fmt_reg*)&dfr_data;
211 struct icc_bus_state * state = (struct icc_bus_state *)icc_bus->private_data;
213 // initial sanity checks
214 if (src_apic>=MAX_APICS || (!state->apics[src_apic].present && src_apic!=state->ioapic_id)) {
215 PrintError("icc_bus: Apparently sending from unregistered apic id=%u\n",src_apic);
218 if (icr->dst_mode==0 && !state->apics[icr->dst].present) {
219 PrintError("icc_bus: Attempted send to unregistered apic id=%u\n",icr->dst);
223 PrintDebug("icc_bus: IPI %s %u from %s %u to %s %s %u (icr=0x%llx, dfr=0x%x) (extirq=%u)\n",
224 deliverymode_str[icr->del_mode], icr->vec,
225 src_apic==state->ioapic_id ? "ioapic" : "apic",
227 icr->dst_mode==0 ? "(physical)" : "(logical)",
228 shorthand_str[icr->dst_shorthand], icr->dst,icr->val, dfr->val,
233 if (icr->dst==state->ioapic_id) {
234 PrintError("icc_bus: Attempted send to ioapic ignored\n");
241 switch (icr->dst_shorthand) {
243 case 0: // no shorthand
244 if (icr->dst_mode==0) {
246 struct apic_data * dest_apic = &(state->apics[icr->dst]);
247 if (deliver(src_apic,dest_apic,icr,state,extirq)) {
252 uint8_t mda = icr->dst; // message destination address, not physical address
254 if (dfr->model==0xf) {
257 // mda of sender & ldr of receiver is nonzero
258 // mda=0xff means broadcaset to all
261 for (i=0;i<MAX_APICS;i++) {
262 struct apic_data *dest_apic=&(state->apics[i]);
263 if (dest_apic->present &&
264 dest_apic->ops->should_deliver_flat(dest_apic->core,
266 dest_apic->priv_data)) {
267 if (deliver(src_apic,dest_apic,icr,state,extirq)) {
274 PrintError("icc_bus: use of cluster model not yet supported\n");
282 if (icr->dst==state->ioapic_id) {
283 PrintError("icc_bus: ioapic attempting to send to itself\n");
286 struct apic_data *dest_apic=&(state->apics[src_apic]);
287 if (deliver(src_apic,dest_apic,icr,state,extirq)) {
293 case 3: { // all and all-but-me
295 for (i=0;i<MAX_APICS;i++) {
296 struct apic_data *dest_apic=&(state->apics[i]);
297 if (dest_apic->present && (i!=src_apic || icr->dst_shorthand==2)) {
298 if (deliver(src_apic,dest_apic,icr,state,extirq)) {
312 /* THIS IS A BIG ASSUMPTION: APIC PHYSID == LOGID == CORENUM */
314 int v3_icc_register_apic(struct guest_info * core, struct vm_device * icc_bus,
315 uint8_t apic_num, struct v3_icc_ops * ops, void * priv_data) {
316 struct icc_bus_state * icc = (struct icc_bus_state *)icc_bus->private_data;
317 struct apic_data * apic = &(icc->apics[apic_num]);
319 if (apic->present == 1) {
320 PrintError("icc_bus: Attempt to re-register apic %u\n", apic_num);
325 apic->priv_data = priv_data;
329 PrintDebug("icc_bus: Registered apic %u\n", apic_num);
335 int v3_icc_register_ioapic(struct v3_vm_info *vm, struct vm_device * icc_bus, uint8_t apic_num)
337 struct icc_bus_state * icc = (struct icc_bus_state *)icc_bus->private_data;
339 if (icc->ioapic_id) {
340 PrintError("icc_bus: Attempt to register a second ioapic!\n");
344 icc->ioapic_id=apic_num;
346 PrintDebug("icc_bus: Registered ioapic %u\n", apic_num);
354 static int icc_bus_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
355 PrintDebug("icc_bus: Creating ICC_BUS\n");
357 char * name = v3_cfg_val(cfg, "name");
359 struct icc_bus_state * icc_bus = (struct icc_bus_state *)V3_Malloc(sizeof(struct icc_bus_state));
360 memset(icc_bus, 0, sizeof(struct icc_bus_state));
362 struct vm_device * dev = v3_allocate_device(name, &dev_ops, icc_bus);
364 if (v3_attach_device(vm, dev) == -1) {
365 PrintError("icc_bus: Could not attach device %s\n", name);
374 device_register("ICC_BUS", icc_bus_init)