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
  21 #include "qemu/osdep.h"
  22 #include "qemu/error-report.h"
  23 #include "qemu/module.h"
  24 #include "qapi/error.h"
  25 #include "cpu.h"
  26 #include "qapi/visitor.h"
  27 #include "hw/i386/apic.h"
  28 #include "hw/i386/apic_internal.h"
  29 #include "trace.h"
  30 #include "sysemu/hax.h"
  31 #include "sysemu/kvm.h"
  32 #include "hw/qdev-properties.h"
  33 #include "hw/sysbus.h"
  34 #include "migration/vmstate.h"
  35
  36 static int apic_irq_delivered;
  37 bool apic_report_tpr_access;
  38
  39 void cpu_set_apic_base(DeviceState *dev, uint64_t val)
  40 {
  41     trace_cpu_set_apic_base(val);
  42
  43     if (dev) {
  44         APICCommonState *s = APIC_COMMON(dev);
  45         APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
  46         /* switching to x2APIC, reset possibly modified xAPIC ID */
  47         if (!(s->apicbase & MSR_IA32_APICBASE_EXTD) &&
  48             (val & MSR_IA32_APICBASE_EXTD)) {
  49             s->id = s->initial_apic_id;
  50         }
  51         info->set_base(s, val);
  52     }
  53 }
  54
  55 uint64_t cpu_get_apic_base(DeviceState *dev)
  56 {
  57     if (dev) {
  58         APICCommonState *s = APIC_COMMON(dev);
  59         trace_cpu_get_apic_base((uint64_t)s->apicbase);
  60         return s->apicbase;
  61     } else {
  62         trace_cpu_get_apic_base(MSR_IA32_APICBASE_BSP);
  63         return MSR_IA32_APICBASE_BSP;
  64     }
  65 }
  66
  67 void cpu_set_apic_tpr(DeviceState *dev, uint8_t val)
  68 {
  69     APICCommonState *s;
  70     APICCommonClass *info;
  71
  72     if (!dev) {
  73         return;
  74     }
  75
  76     s = APIC_COMMON(dev);
  77     info = APIC_COMMON_GET_CLASS(s);
  78
  79     info->set_tpr(s, val);
  80 }
  81
  82 uint8_t cpu_get_apic_tpr(DeviceState *dev)
  83 {
  84     APICCommonState *s;
  85     APICCommonClass *info;
  86
  87     if (!dev) {
  88         return 0;
  89     }
  90
  91     s = APIC_COMMON(dev);
  92     info = APIC_COMMON_GET_CLASS(s);
  93
  94     return info->get_tpr(s);
  95 }
  96
  97 void apic_enable_tpr_access_reporting(DeviceState *dev, bool enable)
  98 {
  99     APICCommonState *s = APIC_COMMON(dev);
 100     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 101
 102     apic_report_tpr_access = enable;
 103     if (info->enable_tpr_reporting) {
 104         info->enable_tpr_reporting(s, enable);
 105     }
 106 }
 107
 108 void apic_enable_vapic(DeviceState *dev, hwaddr paddr)
 109 {
 110     APICCommonState *s = APIC_COMMON(dev);
 111     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 112
 113     s->vapic_paddr = paddr;
 114     info->vapic_base_update(s);
 115 }
 116
 117 void apic_handle_tpr_access_report(DeviceState *dev, target_ulong ip,
 118                                    TPRAccess access)
 119 {
 120     APICCommonState *s = APIC_COMMON(dev);
 121
 122     vapic_report_tpr_access(s->vapic, CPU(s->cpu), ip, access);
 123 }
 124
 125 void apic_report_irq_delivered(int delivered)
 126 {
 127     apic_irq_delivered += delivered;
 128
 129     trace_apic_report_irq_delivered(apic_irq_delivered);
 130 }
 131
 132 void apic_reset_irq_delivered(void)
 133 {
 134     /* Copy this into a local variable to encourage gcc to emit a plain
 135      * register for a sys/sdt.h marker.  For details on this workaround, see:
 136      * https://sourceware.org/bugzilla/show_bug.cgi?id=13296
 137      */
 138     volatile int a_i_d = apic_irq_delivered;
 139     trace_apic_reset_irq_delivered(a_i_d);
 140
 141     apic_irq_delivered = 0;
 142 }
 143
 144 int apic_get_irq_delivered(void)
 145 {
 146     trace_apic_get_irq_delivered(apic_irq_delivered);
 147
 148     return apic_irq_delivered;
 149 }
 150
 151 void apic_deliver_nmi(DeviceState *dev)
 152 {
 153     APICCommonState *s = APIC_COMMON(dev);
 154     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 155
 156     info->external_nmi(s);
 157 }
 158
 159 bool apic_next_timer(APICCommonState *s, int64_t current_time)
 160 {
 161     int64_t d;
 162
 163     /* We need to store the timer state separately to support APIC
 164      * implementations that maintain a non-QEMU timer, e.g. inside the
 165      * host kernel. This open-coded state allows us to migrate between
 166      * both models. */
 167     s->timer_expiry = -1;
 168
 169     if (s->lvt[APIC_LVT_TIMER] & APIC_LVT_MASKED) {
 170         return false;
 171     }
 172
 173     d = (current_time - s->initial_count_load_time) >> s->count_shift;
 174
 175     if (s->lvt[APIC_LVT_TIMER] & APIC_LVT_TIMER_PERIODIC) {
 176         if (!s->initial_count) {
 177             return false;
 178         }
 179         d = ((d / ((uint64_t)s->initial_count + 1)) + 1) *
 180             ((uint64_t)s->initial_count + 1);
 181     } else {
 182         if (d >= s->initial_count) {
 183             return false;
 184         }
 185         d = (uint64_t)s->initial_count + 1;
 186     }
 187     s->next_time = s->initial_count_load_time + (d << s->count_shift);
 188     s->timer_expiry = s->next_time;
 189     return true;
 190 }
 191
 192 void apic_init_reset(DeviceState *dev)
 193 {
 194     APICCommonState *s;
 195     APICCommonClass *info;
 196     int i;
 197
 198     if (!dev) {
 199         return;
 200     }
 201     s = APIC_COMMON(dev);
 202     s->tpr = 0;
 203     s->spurious_vec = 0xff;
 204     s->log_dest = 0;
 205     s->dest_mode = 0xf;
 206     memset(s->isr, 0, sizeof(s->isr));
 207     memset(s->tmr, 0, sizeof(s->tmr));
 208     memset(s->irr, 0, sizeof(s->irr));
 209     for (i = 0; i < APIC_LVT_NB; i++) {
 210         s->lvt[i] = APIC_LVT_MASKED;
 211     }
 212     s->esr = 0;
 213     memset(s->icr, 0, sizeof(s->icr));
 214     s->divide_conf = 0;
 215     s->count_shift = 0;
 216     s->initial_count = 0;
 217     s->initial_count_load_time = 0;
 218     s->next_time = 0;
 219     s->wait_for_sipi = !cpu_is_bsp(s->cpu);
 220
 221     if (s->timer) {
 222         timer_del(s->timer);
 223     }
 224     s->timer_expiry = -1;
 225
 226     info = APIC_COMMON_GET_CLASS(s);
 227     if (info->reset) {
 228         info->reset(s);
 229     }
 230 }
 231
 232 void apic_designate_bsp(DeviceState *dev, bool bsp)
 233 {
 234     if (dev == NULL) {
 235         return;
 236     }
 237
 238     APICCommonState *s = APIC_COMMON(dev);
 239     if (bsp) {
 240         s->apicbase |= MSR_IA32_APICBASE_BSP;
 241     } else {
 242         s->apicbase &= ~MSR_IA32_APICBASE_BSP;
 243     }
 244 }
 245
 246 static void apic_reset_common(DeviceState *dev)
 247 {
 248     APICCommonState *s = APIC_COMMON(dev);
 249     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 250     uint32_t bsp;
 251
 252     bsp = s->apicbase & MSR_IA32_APICBASE_BSP;
 253     s->apicbase = APIC_DEFAULT_ADDRESS | bsp | MSR_IA32_APICBASE_ENABLE;
 254     s->id = s->initial_apic_id;
 255
 256     apic_reset_irq_delivered();
 257
 258     s->vapic_paddr = 0;
 259     info->vapic_base_update(s);
 260
 261     apic_init_reset(dev);
 262 }
 263
 264 static const VMStateDescription vmstate_apic_common;
 265
 266 static void apic_common_realize(DeviceState *dev, Error **errp)
 267 {
 268     APICCommonState *s = APIC_COMMON(dev);
 269     APICCommonClass *info;
 270     static DeviceState *vapic;
 271     uint32_t instance_id = s->initial_apic_id;
 272
 273     /* Normally initial APIC ID should be no more than hundreds */
 274     assert(instance_id != VMSTATE_INSTANCE_ID_ANY);
 275
 276     info = APIC_COMMON_GET_CLASS(s);
 277     info->realize(dev, errp);
 278
 279     /* Note: We need at least 1M to map the VAPIC option ROM */
 280     if (!vapic && s->vapic_control & VAPIC_ENABLE_MASK &&
 281         !hax_enabled() && ram_size >= 1024 * 1024) {
 282         vapic = sysbus_create_simple("kvmvapic", -1, NULL);
 283     }
 284     s->vapic = vapic;
 285     if (apic_report_tpr_access && info->enable_tpr_reporting) {
 286         info->enable_tpr_reporting(s, true);
 287     }
 288
 289     if (s->legacy_instance_id) {
 290         instance_id = VMSTATE_INSTANCE_ID_ANY;
 291     }
 292     vmstate_register_with_alias_id(NULL, instance_id, &vmstate_apic_common,
 293                                    s, -1, 0, NULL);
 294 }
 295
 296 static void apic_common_unrealize(DeviceState *dev, Error **errp)
 297 {
 298     APICCommonState *s = APIC_COMMON(dev);
 299     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 300
 301     vmstate_unregister(NULL, &vmstate_apic_common, s);
 302     info->unrealize(dev, errp);
 303
 304     if (apic_report_tpr_access && info->enable_tpr_reporting) {
 305         info->enable_tpr_reporting(s, false);
 306     }
 307 }
 308
 309 static int apic_pre_load(void *opaque)
 310 {
 311     APICCommonState *s = APIC_COMMON(opaque);
 312
 313     /* The default is !cpu_is_bsp(s->cpu), but the common value is 0
 314      * so that's what apic_common_sipi_needed checks for.  Reset to
 315      * the value that is assumed when the apic_sipi subsection is
 316      * absent.
 317      */
 318     s->wait_for_sipi = 0;
 319     return 0;
 320 }
 321
 322 static int apic_dispatch_pre_save(void *opaque)
 323 {
 324     APICCommonState *s = APIC_COMMON(opaque);
 325     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 326
 327     if (info->pre_save) {
 328         info->pre_save(s);
 329     }
 330
 331     return 0;
 332 }
 333
 334 static int apic_dispatch_post_load(void *opaque, int version_id)
 335 {
 336     APICCommonState *s = APIC_COMMON(opaque);
 337     APICCommonClass *info = APIC_COMMON_GET_CLASS(s);
 338
 339     if (info->post_load) {
 340         info->post_load(s);
 341     }
 342     return 0;
 343 }
 344
 345 static bool apic_common_sipi_needed(void *opaque)
 346 {
 347     APICCommonState *s = APIC_COMMON(opaque);
 348     return s->wait_for_sipi != 0;
 349 }
 350
 351 static const VMStateDescription vmstate_apic_common_sipi = {
 352     .name = "apic_sipi",
 353     .version_id = 1,
 354     .minimum_version_id = 1,
 355     .needed = apic_common_sipi_needed,
 356     .fields = (VMStateField[]) {
 357         VMSTATE_INT32(sipi_vector, APICCommonState),
 358         VMSTATE_INT32(wait_for_sipi, APICCommonState),
 359         VMSTATE_END_OF_LIST()
 360     }
 361 };
 362
 363 static const VMStateDescription vmstate_apic_common = {
 364     .name = "apic",
 365     .version_id = 3,
 366     .minimum_version_id = 3,
 367     .pre_load = apic_pre_load,
 368     .pre_save = apic_dispatch_pre_save,
 369     .post_load = apic_dispatch_post_load,
 370     .fields = (VMStateField[]) {
 371         VMSTATE_UINT32(apicbase, APICCommonState),
 372         VMSTATE_UINT8(id, APICCommonState),
 373         VMSTATE_UINT8(arb_id, APICCommonState),
 374         VMSTATE_UINT8(tpr, APICCommonState),
 375         VMSTATE_UINT32(spurious_vec, APICCommonState),
 376         VMSTATE_UINT8(log_dest, APICCommonState),
 377         VMSTATE_UINT8(dest_mode, APICCommonState),
 378         VMSTATE_UINT32_ARRAY(isr, APICCommonState, 8),
 379         VMSTATE_UINT32_ARRAY(tmr, APICCommonState, 8),
 380         VMSTATE_UINT32_ARRAY(irr, APICCommonState, 8),
 381         VMSTATE_UINT32_ARRAY(lvt, APICCommonState, APIC_LVT_NB),
 382         VMSTATE_UINT32(esr, APICCommonState),
 383         VMSTATE_UINT32_ARRAY(icr, APICCommonState, 2),
 384         VMSTATE_UINT32(divide_conf, APICCommonState),
 385         VMSTATE_INT32(count_shift, APICCommonState),
 386         VMSTATE_UINT32(initial_count, APICCommonState),
 387         VMSTATE_INT64(initial_count_load_time, APICCommonState),
 388         VMSTATE_INT64(next_time, APICCommonState),
 389         VMSTATE_INT64(timer_expiry,
 390                       APICCommonState), /* open-coded timer state */
 391         VMSTATE_END_OF_LIST()
 392     },
 393     .subsections = (const VMStateDescription*[]) {
 394         &vmstate_apic_common_sipi,
 395         NULL
 396     }
 397 };
 398
 399 static Property apic_properties_common[] = {
 400     DEFINE_PROP_UINT8("version", APICCommonState, version, 0x14),
 401     DEFINE_PROP_BIT("vapic", APICCommonState, vapic_control, VAPIC_ENABLE_BIT,
 402                     true),
 403     DEFINE_PROP_BOOL("legacy-instance-id", APICCommonState, legacy_instance_id,
 404                      false),
 405     DEFINE_PROP_END_OF_LIST(),
 406 };
 407
 408 static void apic_common_get_id(Object *obj, Visitor *v, const char *name,
 409                                void *opaque, Error **errp)
 410 {
 411     APICCommonState *s = APIC_COMMON(obj);
 412     uint32_t value;
 413
 414     value = s->apicbase & MSR_IA32_APICBASE_EXTD ? s->initial_apic_id : s->id;
 415     visit_type_uint32(v, name, &value, errp);
 416 }
 417
 418 static void apic_common_set_id(Object *obj, Visitor *v, const char *name,
 419                                void *opaque, Error **errp)
 420 {
 421     APICCommonState *s = APIC_COMMON(obj);
 422     DeviceState *dev = DEVICE(obj);
 423     Error *local_err = NULL;
 424     uint32_t value;
 425
 426     if (dev->realized) {
 427         qdev_prop_set_after_realize(dev, name, errp);
 428         return;
 429     }
 430
 431     visit_type_uint32(v, name, &value, &local_err);
 432     if (local_err) {
 433         error_propagate(errp, local_err);
 434         return;
 435     }
 436
 437     s->initial_apic_id = value;
 438     s->id = (uint8_t)value;
 439 }
 440
 441 static void apic_common_initfn(Object *obj)
 442 {
 443     APICCommonState *s = APIC_COMMON(obj);
 444
 445     s->id = s->initial_apic_id = -1;
 446     object_property_add(obj, "id", "uint32",
 447                         apic_common_get_id,
 448                         apic_common_set_id, NULL, NULL, NULL);
 449 }
 450
 451 static void apic_common_class_init(ObjectClass *klass, void *data)
 452 {
 453     DeviceClass *dc = DEVICE_CLASS(klass);
 454
 455     dc->reset = apic_reset_common;
 456     dc->props = apic_properties_common;
 457     dc->realize = apic_common_realize;
 458     dc->unrealize = apic_common_unrealize;
 459     /*
 460      * Reason: APIC and CPU need to be wired up by
 461      * x86_cpu_apic_create()
 462      */
 463     dc->user_creatable = false;
 464 }
 465
 466 static const TypeInfo apic_common_type = {
 467     .name = TYPE_APIC_COMMON,
 468     .parent = TYPE_DEVICE,
 469     .instance_size = sizeof(APICCommonState),
 470     .instance_init = apic_common_initfn,
 471     .class_size = sizeof(APICCommonClass),
 472     .class_init = apic_common_class_init,
 473     .abstract = true,
 474 };
 475
 476 static void apic_common_register_types(void)
 477 {
 478     type_register_static(&apic_common_type);
 479 }
 480
 481 type_init(apic_common_register_types)