palacios/src/devices/icc_bus.c

   1 /*
   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.
   5  *
   6  * The V3VEE Project is a joint project between Northwestern University
   7  * and the University of New Mexico.  You can find out more at
   8  * http://www.v3vee.org
   9  *
  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.
  13  *
  14  * Author: Jack Lange <jarusl@cs.northwestern.edu>
  15  *
  16  * This is free software.  You are permitted to use,
  17  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  18  */
  19
  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>
  25
  26 #define MAX_APICS 256
  27
  28 #ifndef CONFIG_DEBUG_ICC_BUS
  29 #undef PrintDebug
  30 #define PrintDebug(fmt, args...)
  31 #endif
  32
  33
  34 void v3_force_exit(void *p) {
  35 #ifdef CONFIG_DEBUG_ICC_BUS
  36     struct guest_info *core=(struct guest_info *)p;
  37 #endif
  38     PrintDebug("core %u: Forced to exit!\n",core->cpu_id);
  39 }
  40
  41 struct ipi_thunk_data {
  42     struct vm_device * target;
  43     uint64_t val;
  44 };
  45
  46
  47
  48 struct apic_data {
  49     struct guest_info * core;
  50     struct v3_icc_ops * ops;
  51
  52     void * priv_data;
  53     int present;
  54 };
  55
  56
  57 struct icc_bus_state {
  58     struct apic_data apics[MAX_APICS];
  59
  60     uint32_t         ioapic_id;
  61 };
  62
  63 static struct v3_device_ops dev_ops = {
  64     .free = NULL,
  65     .reset = NULL,
  66     .start = NULL,
  67     .stop = NULL,
  68 };
  69
  70 #ifdef CONFIG_DEBUG_ICC_BUS
  71 static char *shorthand_str[] = {
  72     "(no shorthand)",
  73     "(self)",
  74     "(all)",
  75     "(all-but-me)",
  76  };
  77
  78 static char *deliverymode_str[] = {
  79     "(fixed)",
  80     "(lowest priority)",
  81     "(SMI)",
  82     "(reserved)",
  83     "(NMI)",
  84     "(INIT)",
  85     "(Start Up)",
  86     "(ExtInt)",
  87 };
  88 #endif
  89
  90
  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) {
  92
  93     switch (icr->del_mode) {
  94
  95         case 0:  //fixed
  96         case 1: // lowest priority
  97         case 7: // ExtInt
  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
 111             }
 112             break;
 113
 114         case 2:   //SMI
 115             PrintError("icc_bus: SMI delivery is unsupported\n");
 116             return -1;
 117             break;
 118
 119         case 3:  //reserved
 120             PrintError("icc_bus: Reserved delivery mode 3 is unsupported\n");
 121             return -1;
 122             break;
 123
 124         case 4:  //NMI
 125             PrintError("icc_bus: NMI delivery is unsupported\n");
 126             return -1;
 127             break;
 128
 129         case 5: { //INIT
 130             struct guest_info *core = dest_apic->core;
 131
 132             PrintDebug("icc_bus: INIT delivery to core %u\n",core->cpu_id);
 133
 134             // TODO: any APIC reset on dest core (shouldn't be needed, but not sure...)
 135
 136             // Sanity check
 137             if (core->cpu_mode != INIT) {
 138                 PrintError("icc_bus: Warning: core %u is not in INIT state (mode = %d), ignored\n",core->cpu_id, core->cpu_mode);
 139                 // Only a warning, since INIT INIT SIPI is common
 140                 break;
 141             }
 142
 143             // We transition the target core to SIPI state
 144             core->cpu_mode = SIPI;  // note: locking should not be needed here
 145
 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
 151
 152             PrintDebug("icc_bus: INIT delivery done\n");
 153
 154         }
 155             break;
 156
 157         case 6: { //SIPI
 158             struct guest_info *core = dest_apic->core;
 159
 160             // Sanity check
 161             if (core->cpu_mode!=SIPI) {
 162                 PrintError("icc_bus: core %u is not in SIPI state (mode = %d), ignored!\n",core->cpu_id, core->cpu_mode);
 163                 break;
 164             }
 165
 166             // Write the RIP, CS, and descriptor
 167             // assume the rest is already good to go
 168             //
 169             // vector VV -> rip at 0
 170             //              CS = VV00
 171             //  This means we start executing at linear address VV000
 172             //
 173             // So the selector needs to be VV00
 174             // and the base needs to be VV000
 175             //
 176             core->rip = 0;
 177             core->segments.cs.selector = icr->vec << 8;
 178             core->segments.cs.limit = 0xffff;
 179             core->segments.cs.base = icr->vec << 12;
 180
 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?
 184
 185             // We transition the target core to SIPI state
 186             core->cpu_mode = REAL;  // note: locking should not be needed here
 187
 188             // As with INIT, we should not need to do anything else
 189
 190             PrintDebug("icc_bus: SIPI delivery done\n");
 191
 192         }
 193             break;
 194     }
 195
 196     return 0;
 197 }
 198
 199
 200 //
 201 // icr_data contains interrupt vector *except* for ext_int
 202 // in which case it is given via irq
 203 //
 204
 205 int v3_icc_send_ipi(struct vm_device * icc_bus, uint32_t src_apic, uint64_t icr_data, uint32_t extirq) {
 206
 207     struct int_cmd_reg *icr = (struct int_cmd_reg *)&icr_data;
 208
 209     struct icc_bus_state * state = (struct icc_bus_state *)icc_bus->private_data;
 210     struct apic_data * dest_apic = NULL;
 211     PrintDebug("icc_bus: icc_bus=%p, src_apic=%u, icr_data=%llx, extirq=%u\n",
 212                icc_bus, src_apic, icr_data, extirq);
 213
 214     // initial sanity checks
 215     if ((src_apic >= MAX_APICS) ||
 216         ((state->apics[src_apic].present == 0) &&
 217          (src_apic != state->ioapic_id))) {
 218         PrintError("icc_bus: Apparently sending from unregistered apic id=%u\n",src_apic);
 219         return -1;
 220     }
 221
 222
 223     if ((icr->dst_mode == 0) && (state->apics[icr->dst].present == 0)) {
 224         PrintError("icc_bus: Attempted send to unregistered apic id=%u\n", icr->dst);
 225         return -1;
 226     }
 227
 228     dest_apic =  &(state->apics[icr->dst]);
 229
 230
 231     PrintDebug("icc_bus: IPI %s %u from %s %u to %s %s %u (icr=0x%llx, extirq=%u)\n",
 232                deliverymode_str[icr->del_mode], icr->vec,
 233                src_apic==state->ioapic_id ? "ioapic" : "apic",
 234                src_apic,
 235                icr->dst_mode==0 ? "(physical)" : "(logical)",
 236                shorthand_str[icr->dst_shorthand], icr->dst,icr->val,
 237                extirq);
 238
 239     /*
 240
 241     if (icr->dst==state->ioapic_id) {
 242         PrintError("icc_bus: Attempted send to ioapic ignored\n");
 243         return -1;
 244     }
 245     */
 246
 247
 248
 249     switch (icr->dst_shorthand) {
 250
 251         case 0:  // no shorthand
 252
 253             if (icr->dst_mode==0) {
 254                 // physical delivery
 255                 struct apic_data * dest_apic =  &(state->apics[icr->dst]);
 256                 if (deliver(src_apic,dest_apic,icr,state,extirq)) {
 257                     return -1;
 258                 }
 259             } else {
 260                 // logical delivery
 261                 int i;
 262                 uint8_t mda = icr->dst;
 263                 for (i=0;i<MAX_APICS;i++) {
 264                     struct apic_data *dest_apic=&(state->apics[i]);
 265                     if (dest_apic->present &&
 266                         dest_apic->ops->should_deliver(dest_apic->core,
 267                                                        mda,
 268                                                        dest_apic->priv_data)) {
 269                         if (deliver(src_apic,dest_apic,icr,state,extirq)) {
 270                             return -1;
 271                         }
 272                     }
 273                 }
 274             }
 275
 276             break;
 277
 278         case 1:  // self
 279
 280             if (icr->dst_mode==0) {
 281                 // physical delivery
 282                 if (icr->dst==state->ioapic_id) {
 283                     PrintError("icc_bus: ioapic attempting to send to itself\n");
 284                     return -1;
 285                 }
 286                 struct apic_data *dest_apic=&(state->apics[src_apic]);
 287                 if (deliver(src_apic,dest_apic,icr,state,extirq)) {
 288                     return -1;
 289                 }
 290             } else {
 291                 // logical delivery
 292                 PrintError("icc_bus: use of logical delivery in self is not yet supported.\n");
 293
 294                 return -1;
 295             }
 296             break;
 297
 298         case 2:
 299
 300         case 3: { // all and all-but-me
 301             // assuming that logical verus physical doesn't matter
 302             // although it is odd that both are used
 303             int i;
 304             for (i=0;i<MAX_APICS;i++) {
 305                 struct apic_data *dest_apic=&(state->apics[i]);
 306                 if (dest_apic->present && (i!=src_apic || icr->dst_shorthand==2)) {
 307                     if (deliver(src_apic,dest_apic,icr,state,extirq)) {
 308                         return -1;
 309                     }
 310                 }
 311             }
 312         }
 313             break;
 314
 315         default:
 316             return -1;
 317     }
 318
 319
 320     return 0;
 321 }
 322
 323
 324
 325 /* THIS IS A BIG ASSUMPTION: APIC PHYSID == LOGID == CORENUM */
 326
 327 int v3_icc_register_apic(struct guest_info  * core, struct vm_device * icc_bus,
 328                          uint8_t apic_num, struct v3_icc_ops * ops, void * priv_data) {
 329     struct icc_bus_state * icc = (struct icc_bus_state *)icc_bus->private_data;
 330     struct apic_data * apic = &(icc->apics[apic_num]);
 331
 332     if (apic->present == 1) {
 333         PrintError("icc_bus: Attempt to re-register apic %u\n", apic_num);
 334         return -1;
 335     }
 336
 337     apic->present = 1;
 338     apic->priv_data = priv_data;
 339     apic->core = core;
 340     apic->ops = ops;
 341
 342     PrintDebug("icc_bus: Registered apic %u\n", apic_num);
 343
 344     return 0;
 345 }
 346
 347
 348 int v3_icc_register_ioapic(struct v3_vm_info *vm, struct vm_device * icc_bus, uint8_t apic_num)
 349 {
 350     struct icc_bus_state * icc = (struct icc_bus_state *)icc_bus->private_data;
 351
 352     if (icc->ioapic_id) {
 353         PrintError("icc_bus: Attempt to register a second ioapic!\n");
 354         return -1;
 355     }
 356
 357     icc->ioapic_id=apic_num;
 358
 359     PrintDebug("icc_bus: Registered ioapic %u\n", apic_num);
 360
 361
 362     return 0;
 363 }
 364
 365
 366 static int icc_bus_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
 367     PrintDebug("icc_bus: Creating ICC_BUS\n");
 368
 369     char * dev_id = v3_cfg_val(cfg, "ID");
 370
 371     struct icc_bus_state * icc_bus = (struct icc_bus_state *)V3_Malloc(sizeof(struct icc_bus_state));
 372     memset(icc_bus, 0, sizeof(struct icc_bus_state));
 373
 374     struct vm_device * dev = v3_allocate_device(dev_id, &dev_ops, icc_bus);
 375
 376     if (v3_attach_device(vm, dev) == -1) {
 377         PrintError("icc_bus: Could not attach device %s\n", dev_id);
 378         return -1;
 379     }
 380
 381     return 0;
 382 }
 383
 384
 385
 386 device_register("ICC_BUS", icc_bus_init)