hw/intc/apic_common.c

   1 /*
   2  *  APIC support - common bits of emulated and KVM kernel model
   3  *
   4  *  Copyright (c) 2004-2005 Fabrice Bellard
   5  *  Copyright (c) 2011      Jan Kiszka, Siemens AG
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, see <http://www.gnu.org/licenses/>
  19  */
  20 #include "hw/i386/apic.h"
  21 #include "hw/i386/apic_internal.h"
  22 #include "trace.h"
  23 #include "sysemu/kvm.h"
  24 #include "hw/qdev.h"
  25 #include "hw/sysbus.h"
  26
  27 static int apic_irq_delivered;
  28 bool apic_report_tpr_access;
  29
  30 void cpu_set_apic_base(DeviceState *dev, uint64_t val)
  31 {
  32     trace_cpu_set_apic_base(val);
  33
  34     if (dev) {
  35         APICCommonState *s = APIC_COMMON(dev);
  36         APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
  37         info->set_base(s, val);
  38     }
  39 }
  40
  41 uint64_t cpu_get_apic_base(DeviceState *dev)
  42 {
  43     if (dev) {
  44         APICCommonState *s = APIC_COMMON(dev);
  45         trace_cpu_get_apic_base((uint64_t)s->apicbase);
  46         return s->apicbase;
  47     } else {
  48         trace_cpu_get_apic_base(MSR_IA32_APICBASE_BSP);
  49         return MSR_IA32_APICBASE_BSP;
  50     }
  51 }
  52
  53 void cpu_set_apic_tpr(DeviceState *dev, uint8_t val)
  54 {
  55     APICCommonState *s;
  56     APICCommonClass *info;
  57
  58     if (!dev) {
  59         return;
  60     }
  61
  62     s = APIC_COMMON(dev);
  63     info = APIC_COMMON_GET_CLASS(s);
  64
  65     info->set_tpr(s, val);
  66 }
  67
  68 uint8_t cpu_get_apic_tpr(DeviceState *dev)
  69 {
  70     APICCommonState *s;
  71     APICCommonClass *info;
  72
  73     if (!dev) {
  74         return 0;
  75     }
  76
  77     s = APIC_COMMON(dev);
  78     info = APIC_COMMON_GET_CLASS(s);
  79
  80     return info->get_tpr(s);
  81 }
  82
  83 void apic_enable_tpr_access_reporting(DeviceState *dev, bool enable)
  84 {
  85     APICCommonState *s = APIC_COMMON(dev);
  86     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
  87
  88     apic_report_tpr_access = enable;
  89     if (info->enable_tpr_reporting) {
  90         info->enable_tpr_reporting(s, enable);
  91     }
  92 }
  93
  94 void apic_enable_vapic(DeviceState *dev, hwaddr paddr)
  95 {
  96     APICCommonState *s = APIC_COMMON(dev);
  97     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
  98
  99     s->vapic_paddr = paddr;
 100     info->vapic_base_update(s);
 101 }
 102
 103 void apic_handle_tpr_access_report(DeviceState *dev, target_ulong ip,
 104                                    TPRAccess access)
 105 {
 106     APICCommonState *s = APIC_COMMON(dev);
 107
 108     vapic_report_tpr_access(s->vapic, CPU(s->cpu), ip, access);
 109 }
 110
 111 void apic_report_irq_delivered(int delivered)
 112 {
 113     apic_irq_delivered += delivered;
 114
 115     trace_apic_report_irq_delivered(apic_irq_delivered);
 116 }
 117
 118 void apic_reset_irq_delivered(void)
 119 {
 120     /* Copy this into a local variable to encourage gcc to emit a plain
 121      * register for a sys/sdt.h marker.  For details on this workaround, see:
 122      * https://sourceware.org/bugzilla/show_bug.cgi?id=13296
 123      */
 124     volatile int a_i_d = apic_irq_delivered;
 125     trace_apic_reset_irq_delivered(a_i_d);
 126
 127     apic_irq_delivered = 0;
 128 }
 129
 130 int apic_get_irq_delivered(void)
 131 {
 132     trace_apic_get_irq_delivered(apic_irq_delivered);
 133
 134     return apic_irq_delivered;
 135 }
 136
 137 void apic_deliver_nmi(DeviceState *dev)
 138 {
 139     APICCommonState *s = APIC_COMMON(dev);
 140     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 141
 142     info->external_nmi(s);
 143 }
 144
 145 bool apic_next_timer(APICCommonState *s, int64_t current_time)
 146 {
 147     int64_t d;
 148
 149     /* We need to store the timer state separately to support APIC
 150      * implementations that maintain a non-QEMU timer, e.g. inside the
 151      * host kernel. This open-coded state allows us to migrate between
 152      * both models. */
 153     s->timer_expiry = -1;
 154
 155     if (s->lvt[APIC_LVT_TIMER] & APIC_LVT_MASKED) {
 156         return false;
 157     }
 158
 159     d = (current_time - s->initial_count_load_time) >> s->count_shift;
 160
 161     if (s->lvt[APIC_LVT_TIMER] & APIC_LVT_TIMER_PERIODIC) {
 162         if (!s->initial_count) {
 163             return false;
 164         }
 165         d = ((d / ((uint64_t)s->initial_count + 1)) + 1) *
 166             ((uint64_t)s->initial_count + 1);
 167     } else {
 168         if (d >= s->initial_count) {
 169             return false;
 170         }
 171         d = (uint64_t)s->initial_count + 1;
 172     }
 173     s->next_time = s->initial_count_load_time + (d << s->count_shift);
 174     s->timer_expiry = s->next_time;
 175     return true;
 176 }
 177
 178 void apic_init_reset(DeviceState *dev)
 179 {
 180     APICCommonState *s;
 181     APICCommonClass *info;
 182     int i;
 183
 184     if (!dev) {
 185         return;
 186     }
 187     s = APIC_COMMON(dev);
 188     s->tpr = 0;
 189     s->spurious_vec = 0xff;
 190     s->log_dest = 0;
 191     s->dest_mode = 0xf;
 192     memset(s->isr, 0, sizeof(s->isr));
 193     memset(s->tmr, 0, sizeof(s->tmr));
 194     memset(s->irr, 0, sizeof(s->irr));
 195     for (i = 0; i < APIC_LVT_NB; i++) {
 196         s->lvt[i] = APIC_LVT_MASKED;
 197     }
 198     s->esr = 0;
 199     memset(s->icr, 0, sizeof(s->icr));
 200     s->divide_conf = 0;
 201     s->count_shift = 0;
 202     s->initial_count = 0;
 203     s->initial_count_load_time = 0;
 204     s->next_time = 0;
 205     s->wait_for_sipi = !cpu_is_bsp(s->cpu);
 206
 207     if (s->timer) {
 208         timer_del(s->timer);
 209     }
 210     s->timer_expiry = -1;
 211
 212     info = APIC_COMMON_GET_CLASS(s);
 213     if (info->reset) {
 214         info->reset(s);
 215     }
 216 }
 217
 218 void apic_designate_bsp(DeviceState *dev, bool bsp)
 219 {
 220     if (dev == NULL) {
 221         return;
 222     }
 223
 224     APICCommonState *s = APIC_COMMON(dev);
 225     if (bsp) {
 226         s->apicbase |= MSR_IA32_APICBASE_BSP;
 227     } else {
 228         s->apicbase &= ~MSR_IA32_APICBASE_BSP;
 229     }
 230 }
 231
 232 static void apic_reset_common(DeviceState *dev)
 233 {
 234     APICCommonState *s = APIC_COMMON(dev);
 235     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 236     uint32_t bsp;
 237
 238     bsp = s->apicbase & MSR_IA32_APICBASE_BSP;
 239     s->apicbase = APIC_DEFAULT_ADDRESS | bsp | MSR_IA32_APICBASE_ENABLE;
 240
 241     s->vapic_paddr = 0;
 242     info->vapic_base_update(s);
 243
 244     apic_init_reset(dev);
 245 }
 246
 247 /* This function is only used for old state version 1 and 2 */
 248 static int apic_load_old(QEMUFile *f, void *opaque, int version_id)
 249 {
 250     APICCommonState *s = opaque;
 251     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 252     int i;
 253
 254     if (version_id > 2) {
 255         return -EINVAL;
 256     }
 257
 258     /* XXX: what if the base changes? (registered memory regions) */
 259     qemu_get_be32s(f, &s->apicbase);
 260     qemu_get_8s(f, &s->id);
 261     qemu_get_8s(f, &s->arb_id);
 262     qemu_get_8s(f, &s->tpr);
 263     qemu_get_be32s(f, &s->spurious_vec);
 264     qemu_get_8s(f, &s->log_dest);
 265     qemu_get_8s(f, &s->dest_mode);
 266     for (i = 0; i < 8; i++) {
 267         qemu_get_be32s(f, &s->isr[i]);
 268         qemu_get_be32s(f, &s->tmr[i]);
 269         qemu_get_be32s(f, &s->irr[i]);
 270     }
 271     for (i = 0; i < APIC_LVT_NB; i++) {
 272         qemu_get_be32s(f, &s->lvt[i]);
 273     }
 274     qemu_get_be32s(f, &s->esr);
 275     qemu_get_be32s(f, &s->icr[0]);
 276     qemu_get_be32s(f, &s->icr[1]);
 277     qemu_get_be32s(f, &s->divide_conf);
 278     s->count_shift = qemu_get_be32(f);
 279     qemu_get_be32s(f, &s->initial_count);
 280     s->initial_count_load_time = qemu_get_be64(f);
 281     s->next_time = qemu_get_be64(f);
 282
 283     if (version_id >= 2) {
 284         s->timer_expiry = qemu_get_be64(f);
 285     }
 286
 287     if (info->post_load) {
 288         info->post_load(s);
 289     }
 290     return 0;
 291 }
 292
 293 static void apic_common_realize(DeviceState *dev, Error **errp)
 294 {
 295     APICCommonState *s = APIC_COMMON(dev);
 296     APICCommonClass *info;
 297     static DeviceState *vapic;
 298     static int apic_no;
 299     static bool mmio_registered;
 300
 301     if (apic_no >= MAX_APICS) {
 302         error_setg(errp, "%s initialization failed.",
 303                    object_get_typename(OBJECT(dev)));
 304         return;
 305     }
 306     s->idx = apic_no++;
 307
 308     info = APIC_COMMON_GET_CLASS(s);
 309     info->realize(dev, errp);
 310     if (!mmio_registered) {
 311         ICCBus *b = ICC_BUS(qdev_get_parent_bus(dev));
 312         memory_region_add_subregion(b->apic_address_space, 0, &s->io_memory);
 313         mmio_registered = true;
 314     }
 315
 316     /* Note: We need at least 1M to map the VAPIC option ROM */
 317     if (!vapic && s->vapic_control & VAPIC_ENABLE_MASK &&
 318         ram_size >= 1024 * 1024) {
 319         vapic = sysbus_create_simple("kvmvapic", -1, NULL);
 320     }
 321     s->vapic = vapic;
 322     if (apic_report_tpr_access && info->enable_tpr_reporting) {
 323         info->enable_tpr_reporting(s, true);
 324     }
 325
 326 }
 327
 328 static int apic_pre_load(void *opaque)
 329 {
 330     APICCommonState *s = APIC_COMMON(opaque);
 331
 332     /* The default is !cpu_is_bsp(s->cpu), but the common value is 0
 333      * so that's what apic_common_sipi_needed checks for.  Reset to
 334      * the value that is assumed when the apic_sipi subsection is
 335      * absent.
 336      */
 337     s->wait_for_sipi = 0;
 338     return 0;
 339 }
 340
 341 static void apic_dispatch_pre_save(void *opaque)
 342 {
 343     APICCommonState *s = APIC_COMMON(opaque);
 344     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 345
 346     if (info->pre_save) {
 347         info->pre_save(s);
 348     }
 349 }
 350
 351 static int apic_dispatch_post_load(void *opaque, int version_id)
 352 {
 353     APICCommonState *s = APIC_COMMON(opaque);
 354     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 355
 356     if (info->post_load) {
 357         info->post_load(s);
 358     }
 359     return 0;
 360 }
 361
 362 static bool apic_common_sipi_needed(void *opaque)
 363 {
 364     APICCommonState *s = APIC_COMMON(opaque);
 365     return s->wait_for_sipi != 0;
 366 }
 367
 368 static const VMStateDescription vmstate_apic_common_sipi = {
 369     .name = "apic_sipi",
 370     .version_id = 1,
 371     .minimum_version_id = 1,
 372     .fields = (VMStateField[]) {
 373         VMSTATE_INT32(sipi_vector, APICCommonState),
 374         VMSTATE_INT32(wait_for_sipi, APICCommonState),
 375         VMSTATE_END_OF_LIST()
 376     }
 377 };
 378
 379 static const VMStateDescription vmstate_apic_common = {
 380     .name = "apic",
 381     .version_id = 3,
 382     .minimum_version_id = 3,
 383     .minimum_version_id_old = 1,
 384     .load_state_old = apic_load_old,
 385     .pre_load = apic_pre_load,
 386     .pre_save = apic_dispatch_pre_save,
 387     .post_load = apic_dispatch_post_load,
 388     .fields = (VMStateField[]) {
 389         VMSTATE_UINT32(apicbase, APICCommonState),
 390         VMSTATE_UINT8(id, APICCommonState),
 391         VMSTATE_UINT8(arb_id, APICCommonState),
 392         VMSTATE_UINT8(tpr, APICCommonState),
 393         VMSTATE_UINT32(spurious_vec, APICCommonState),
 394         VMSTATE_UINT8(log_dest, APICCommonState),
 395         VMSTATE_UINT8(dest_mode, APICCommonState),
 396         VMSTATE_UINT32_ARRAY(isr, APICCommonState, 8),
 397         VMSTATE_UINT32_ARRAY(tmr, APICCommonState, 8),
 398         VMSTATE_UINT32_ARRAY(irr, APICCommonState, 8),
 399         VMSTATE_UINT32_ARRAY(lvt, APICCommonState, APIC_LVT_NB),
 400         VMSTATE_UINT32(esr, APICCommonState),
 401         VMSTATE_UINT32_ARRAY(icr, APICCommonState, 2),
 402         VMSTATE_UINT32(divide_conf, APICCommonState),
 403         VMSTATE_INT32(count_shift, APICCommonState),
 404         VMSTATE_UINT32(initial_count, APICCommonState),
 405         VMSTATE_INT64(initial_count_load_time, APICCommonState),
 406         VMSTATE_INT64(next_time, APICCommonState),
 407         VMSTATE_INT64(timer_expiry,
 408                       APICCommonState), /* open-coded timer state */
 409         VMSTATE_END_OF_LIST()
 410     },
 411     .subsections = (VMStateSubsection[]) {
 412         {
 413             .vmsd = &vmstate_apic_common_sipi,
 414             .needed = apic_common_sipi_needed,
 415         },
 416         VMSTATE_END_OF_LIST()
 417     }
 418 };
 419
 420 static Property apic_properties_common[] = {
 421     DEFINE_PROP_UINT8("id", APICCommonState, id, -1),
 422     DEFINE_PROP_UINT8("version", APICCommonState, version, 0x14),
 423     DEFINE_PROP_BIT("vapic", APICCommonState, vapic_control, VAPIC_ENABLE_BIT,
 424                     true),
 425     DEFINE_PROP_END_OF_LIST(),
 426 };
 427
 428 static void apic_common_class_init(ObjectClass *klass, void *data)
 429 {
 430     ICCDeviceClass *idc = ICC_DEVICE_CLASS(klass);
 431     DeviceClass *dc = DEVICE_CLASS(klass);
 432
 433     dc->vmsd = &vmstate_apic_common;
 434     dc->reset = apic_reset_common;
 435     dc->props = apic_properties_common;
 436     idc->realize = apic_common_realize;
 437     /*
 438      * Reason: APIC and CPU need to be wired up by
 439      * x86_cpu_apic_create()
 440      */
 441     dc->cannot_instantiate_with_device_add_yet = true;
 442 }
 443
 444 static const TypeInfo apic_common_type = {
 445     .name = TYPE_APIC_COMMON,
 446     .parent = TYPE_ICC_DEVICE,
 447     .instance_size = sizeof(APICCommonState),
 448     .class_size = sizeof(APICCommonClass),
 449     .class_init = apic_common_class_init,
 450     .abstract = true,
 451 };
 452
 453 static void apic_common_register_types(void)
 454 {
 455     type_register_static(&apic_common_type);
 456 }
 457
 458 type_init(apic_common_register_types)