hw/mem/pc-dimm.c

   1 /*
   2  * Dimm device for Memory Hotplug
   3  *
   4  * Copyright ProfitBricks GmbH 2012
   5  * Copyright (C) 2014 Red Hat Inc
   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.1 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 "hw/boards.h"
  23 #include "hw/mem/pc-dimm.h"
  24 #include "hw/qdev-properties.h"
  25 #include "migration/vmstate.h"
  26 #include "hw/mem/nvdimm.h"
  27 #include "hw/mem/memory-device.h"
  28 #include "qapi/error.h"
  29 #include "qapi/visitor.h"
  30 #include "qemu/module.h"
  31 #include "sysemu/hostmem.h"
  32 #include "sysemu/numa.h"
  33 #include "trace.h"
  34
  35 static int pc_dimm_get_free_slot(const int *hint, int max_slots, Error **errp);
  36
  37 static MemoryRegion *pc_dimm_get_memory_region(PCDIMMDevice *dimm, Error **errp)
  38 {
  39     if (!dimm->hostmem) {
  40         error_setg(errp, "'" PC_DIMM_MEMDEV_PROP "' property must be set");
  41         return NULL;
  42     }
  43
  44     return host_memory_backend_get_memory(dimm->hostmem);
  45 }
  46
  47 void pc_dimm_pre_plug(PCDIMMDevice *dimm, MachineState *machine,
  48                       const uint64_t *legacy_align, Error **errp)
  49 {
  50     Error *local_err = NULL;
  51     int slot;
  52
  53     slot = object_property_get_int(OBJECT(dimm), PC_DIMM_SLOT_PROP,
  54                                    &error_abort);
  55     if ((slot < 0 || slot >= machine->ram_slots) &&
  56          slot != PC_DIMM_UNASSIGNED_SLOT) {
  57         error_setg(errp,
  58                    "invalid slot number %d, valid range is [0-%" PRIu64 "]",
  59                    slot, machine->ram_slots - 1);
  60         return;
  61     }
  62
  63     slot = pc_dimm_get_free_slot(slot == PC_DIMM_UNASSIGNED_SLOT ? NULL : &slot,
  64                                  machine->ram_slots, &local_err);
  65     if (local_err) {
  66         error_propagate(errp, local_err);
  67         return;
  68     }
  69     object_property_set_int(OBJECT(dimm), PC_DIMM_SLOT_PROP, slot,
  70                             &error_abort);
  71     trace_mhp_pc_dimm_assigned_slot(slot);
  72
  73     memory_device_pre_plug(MEMORY_DEVICE(dimm), machine, legacy_align,
  74                            errp);
  75 }
  76
  77 void pc_dimm_plug(PCDIMMDevice *dimm, MachineState *machine)
  78 {
  79     MemoryRegion *vmstate_mr = pc_dimm_get_memory_region(dimm,
  80                                                          &error_abort);
  81
  82     memory_device_plug(MEMORY_DEVICE(dimm), machine);
  83     vmstate_register_ram(vmstate_mr, DEVICE(dimm));
  84     /* count only "real" DIMMs, not NVDIMMs */
  85     if (!object_dynamic_cast(OBJECT(dimm), TYPE_NVDIMM)) {
  86         machine->device_memory->dimm_size += memory_region_size(vmstate_mr);
  87     }
  88 }
  89
  90 void pc_dimm_unplug(PCDIMMDevice *dimm, MachineState *machine)
  91 {
  92     MemoryRegion *vmstate_mr = pc_dimm_get_memory_region(dimm,
  93                                                          &error_abort);
  94
  95     memory_device_unplug(MEMORY_DEVICE(dimm), machine);
  96     vmstate_unregister_ram(vmstate_mr, DEVICE(dimm));
  97     if (!object_dynamic_cast(OBJECT(dimm), TYPE_NVDIMM)) {
  98         machine->device_memory->dimm_size -= memory_region_size(vmstate_mr);
  99     }
 100 }
 101
 102 static int pc_dimm_slot2bitmap(Object *obj, void *opaque)
 103 {
 104     unsigned long *bitmap = opaque;
 105
 106     if (object_dynamic_cast(obj, TYPE_PC_DIMM)) {
 107         DeviceState *dev = DEVICE(obj);
 108         if (dev->realized) { /* count only realized DIMMs */
 109             PCDIMMDevice *d = PC_DIMM(obj);
 110             set_bit(d->slot, bitmap);
 111         }
 112     }
 113
 114     object_child_foreach(obj, pc_dimm_slot2bitmap, opaque);
 115     return 0;
 116 }
 117
 118 static int pc_dimm_get_free_slot(const int *hint, int max_slots, Error **errp)
 119 {
 120     unsigned long *bitmap;
 121     int slot = 0;
 122
 123     if (max_slots <= 0) {
 124         error_setg(errp, "no slots where allocated, please specify "
 125                    "the 'slots' option");
 126         return slot;
 127     }
 128
 129     bitmap = bitmap_new(max_slots);
 130     object_child_foreach(qdev_get_machine(), pc_dimm_slot2bitmap, bitmap);
 131
 132     /* check if requested slot is not occupied */
 133     if (hint) {
 134         if (*hint >= max_slots) {
 135             error_setg(errp, "invalid slot# %d, should be less than %d",
 136                        *hint, max_slots);
 137         } else if (!test_bit(*hint, bitmap)) {
 138             slot = *hint;
 139         } else {
 140             error_setg(errp, "slot %d is busy", *hint);
 141         }
 142         goto out;
 143     }
 144
 145     /* search for free slot */
 146     slot = find_first_zero_bit(bitmap, max_slots);
 147     if (slot == max_slots) {
 148         error_setg(errp, "no free slots available");
 149     }
 150 out:
 151     g_free(bitmap);
 152     return slot;
 153 }
 154
 155 static Property pc_dimm_properties[] = {
 156     DEFINE_PROP_UINT64(PC_DIMM_ADDR_PROP, PCDIMMDevice, addr, 0),
 157     DEFINE_PROP_UINT32(PC_DIMM_NODE_PROP, PCDIMMDevice, node, 0),
 158     DEFINE_PROP_INT32(PC_DIMM_SLOT_PROP, PCDIMMDevice, slot,
 159                       PC_DIMM_UNASSIGNED_SLOT),
 160     DEFINE_PROP_LINK(PC_DIMM_MEMDEV_PROP, PCDIMMDevice, hostmem,
 161                      TYPE_MEMORY_BACKEND, HostMemoryBackend *),
 162     DEFINE_PROP_END_OF_LIST(),
 163 };
 164
 165 static void pc_dimm_get_size(Object *obj, Visitor *v, const char *name,
 166                              void *opaque, Error **errp)
 167 {
 168     Error *local_err = NULL;
 169     uint64_t value;
 170
 171     value = memory_device_get_region_size(MEMORY_DEVICE(obj), &local_err);
 172     if (local_err) {
 173         error_propagate(errp, local_err);
 174         return;
 175     }
 176
 177     visit_type_uint64(v, name, &value, errp);
 178 }
 179
 180 static void pc_dimm_init(Object *obj)
 181 {
 182     object_property_add(obj, PC_DIMM_SIZE_PROP, "uint64", pc_dimm_get_size,
 183                         NULL, NULL, NULL);
 184 }
 185
 186 static void pc_dimm_realize(DeviceState *dev, Error **errp)
 187 {
 188     PCDIMMDevice *dimm = PC_DIMM(dev);
 189     PCDIMMDeviceClass *ddc = PC_DIMM_GET_CLASS(dimm);
 190     MachineState *ms = MACHINE(qdev_get_machine());
 191
 192     if (ms->numa_state) {
 193         int nb_numa_nodes = ms->numa_state->num_nodes;
 194
 195         if (((nb_numa_nodes > 0) && (dimm->node >= nb_numa_nodes)) ||
 196             (!nb_numa_nodes && dimm->node)) {
 197             error_setg(errp, "'DIMM property " PC_DIMM_NODE_PROP " has value %"
 198                        PRIu32 "' which exceeds the number of numa nodes: %d",
 199                        dimm->node, nb_numa_nodes ? nb_numa_nodes : 1);
 200             return;
 201         }
 202     } else if (dimm->node > 0) {
 203         error_setg(errp, "machine doesn't support NUMA");
 204         return;
 205     }
 206
 207     if (!dimm->hostmem) {
 208         error_setg(errp, "'" PC_DIMM_MEMDEV_PROP "' property is not set");
 209         return;
 210     } else if (host_memory_backend_is_mapped(dimm->hostmem)) {
 211         error_setg(errp, "can't use already busy memdev: %s",
 212                    object_get_canonical_path_component(OBJECT(dimm->hostmem)));
 213         return;
 214     }
 215
 216     if (ddc->realize) {
 217         ddc->realize(dimm, errp);
 218     }
 219
 220     host_memory_backend_set_mapped(dimm->hostmem, true);
 221 }
 222
 223 static void pc_dimm_unrealize(DeviceState *dev)
 224 {
 225     PCDIMMDevice *dimm = PC_DIMM(dev);
 226     PCDIMMDeviceClass *ddc = PC_DIMM_GET_CLASS(dimm);
 227
 228     if (ddc->unrealize) {
 229         ddc->unrealize(dimm);
 230     }
 231
 232     host_memory_backend_set_mapped(dimm->hostmem, false);
 233 }
 234
 235 static uint64_t pc_dimm_md_get_addr(const MemoryDeviceState *md)
 236 {
 237     return object_property_get_uint(OBJECT(md), PC_DIMM_ADDR_PROP,
 238                                     &error_abort);
 239 }
 240
 241 static void pc_dimm_md_set_addr(MemoryDeviceState *md, uint64_t addr,
 242                                 Error **errp)
 243 {
 244     object_property_set_uint(OBJECT(md), PC_DIMM_ADDR_PROP, addr, errp);
 245 }
 246
 247 static MemoryRegion *pc_dimm_md_get_memory_region(MemoryDeviceState *md,
 248                                                   Error **errp)
 249 {
 250     return pc_dimm_get_memory_region(PC_DIMM(md), errp);
 251 }
 252
 253 static void pc_dimm_md_fill_device_info(const MemoryDeviceState *md,
 254                                         MemoryDeviceInfo *info)
 255 {
 256     PCDIMMDeviceInfo *di = g_new0(PCDIMMDeviceInfo, 1);
 257     const DeviceClass *dc = DEVICE_GET_CLASS(md);
 258     const PCDIMMDevice *dimm = PC_DIMM(md);
 259     const DeviceState *dev = DEVICE(md);
 260
 261     if (dev->id) {
 262         di->id = g_strdup(dev->id);
 263     }
 264     di->hotplugged = dev->hotplugged;
 265     di->hotpluggable = dc->hotpluggable;
 266     di->addr = dimm->addr;
 267     di->slot = dimm->slot;
 268     di->node = dimm->node;
 269     di->size = object_property_get_uint(OBJECT(dimm), PC_DIMM_SIZE_PROP,
 270                                         NULL);
 271     di->memdev = object_get_canonical_path(OBJECT(dimm->hostmem));
 272
 273     if (object_dynamic_cast(OBJECT(dev), TYPE_NVDIMM)) {
 274         info->u.nvdimm.data = di;
 275         info->type = MEMORY_DEVICE_INFO_KIND_NVDIMM;
 276     } else {
 277         info->u.dimm.data = di;
 278         info->type = MEMORY_DEVICE_INFO_KIND_DIMM;
 279     }
 280 }
 281
 282 static void pc_dimm_class_init(ObjectClass *oc, void *data)
 283 {
 284     DeviceClass *dc = DEVICE_CLASS(oc);
 285     MemoryDeviceClass *mdc = MEMORY_DEVICE_CLASS(oc);
 286
 287     dc->realize = pc_dimm_realize;
 288     dc->unrealize = pc_dimm_unrealize;
 289     device_class_set_props(dc, pc_dimm_properties);
 290     dc->desc = "DIMM memory module";
 291
 292     mdc->get_addr = pc_dimm_md_get_addr;
 293     mdc->set_addr = pc_dimm_md_set_addr;
 294     /* for a dimm plugged_size == region_size */
 295     mdc->get_plugged_size = memory_device_get_region_size;
 296     mdc->get_memory_region = pc_dimm_md_get_memory_region;
 297     mdc->fill_device_info = pc_dimm_md_fill_device_info;
 298 }
 299
 300 static const TypeInfo pc_dimm_info = {
 301     .name          = TYPE_PC_DIMM,
 302     .parent        = TYPE_DEVICE,
 303     .instance_size = sizeof(PCDIMMDevice),
 304     .instance_init = pc_dimm_init,
 305     .class_init    = pc_dimm_class_init,
 306     .class_size    = sizeof(PCDIMMDeviceClass),
 307     .interfaces = (InterfaceInfo[]) {
 308         { TYPE_MEMORY_DEVICE },
 309         { }
 310     },
 311 };
 312
 313 static void pc_dimm_register_types(void)
 314 {
 315     type_register_static(&pc_dimm_info);
 316 }
 317
 318 type_init(pc_dimm_register_types)