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