xref: /openbmc/qemu/hw/mem/pc-dimm.c (revision 534cdbf56c2a72952ffde9a258160f5586cea886)
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 typedef struct pc_dimms_capacity {
31      uint64_t size;
32      Error    **errp;
33 } pc_dimms_capacity;
34 
35 void pc_dimm_memory_plug(DeviceState *dev, MachineState *machine,
36                          uint64_t align, Error **errp)
37 {
38     int slot;
39     PCDIMMDevice *dimm = PC_DIMM(dev);
40     PCDIMMDeviceClass *ddc = PC_DIMM_GET_CLASS(dimm);
41     MemoryRegion *vmstate_mr = ddc->get_vmstate_memory_region(dimm);
42     Error *local_err = NULL;
43     MemoryRegion *mr;
44     uint64_t addr;
45 
46     mr = ddc->get_memory_region(dimm, &local_err);
47     if (local_err) {
48         goto out;
49     }
50 
51     addr = object_property_get_uint(OBJECT(dimm),
52                                     PC_DIMM_ADDR_PROP, &local_err);
53     if (local_err) {
54         goto out;
55     }
56 
57     addr = memory_device_get_free_addr(machine, !addr ? NULL : &addr, align,
58                                        memory_region_size(mr), &local_err);
59     if (local_err) {
60         goto out;
61     }
62 
63     object_property_set_uint(OBJECT(dev), addr, PC_DIMM_ADDR_PROP, &local_err);
64     if (local_err) {
65         goto out;
66     }
67     trace_mhp_pc_dimm_assigned_address(addr);
68 
69     slot = object_property_get_int(OBJECT(dev), PC_DIMM_SLOT_PROP, &local_err);
70     if (local_err) {
71         goto out;
72     }
73 
74     slot = pc_dimm_get_free_slot(slot == PC_DIMM_UNASSIGNED_SLOT ? NULL : &slot,
75                                  machine->ram_slots, &local_err);
76     if (local_err) {
77         goto out;
78     }
79     object_property_set_int(OBJECT(dev), slot, PC_DIMM_SLOT_PROP, &local_err);
80     if (local_err) {
81         goto out;
82     }
83     trace_mhp_pc_dimm_assigned_slot(slot);
84 
85     memory_device_plug_region(machine, mr, addr);
86     vmstate_register_ram(vmstate_mr, dev);
87 
88 out:
89     error_propagate(errp, local_err);
90 }
91 
92 void pc_dimm_memory_unplug(DeviceState *dev, MachineState *machine)
93 {
94     PCDIMMDevice *dimm = PC_DIMM(dev);
95     PCDIMMDeviceClass *ddc = PC_DIMM_GET_CLASS(dimm);
96     MemoryRegion *vmstate_mr = ddc->get_vmstate_memory_region(dimm);
97     MemoryRegion *mr = ddc->get_memory_region(dimm, &error_abort);
98 
99     memory_device_unplug_region(machine, mr);
100     vmstate_unregister_ram(vmstate_mr, dev);
101 }
102 
103 static int pc_dimm_slot2bitmap(Object *obj, void *opaque)
104 {
105     unsigned long *bitmap = opaque;
106 
107     if (object_dynamic_cast(obj, TYPE_PC_DIMM)) {
108         DeviceState *dev = DEVICE(obj);
109         if (dev->realized) { /* count only realized DIMMs */
110             PCDIMMDevice *d = PC_DIMM(obj);
111             set_bit(d->slot, bitmap);
112         }
113     }
114 
115     object_child_foreach(obj, pc_dimm_slot2bitmap, opaque);
116     return 0;
117 }
118 
119 int pc_dimm_get_free_slot(const int *hint, int max_slots, Error **errp)
120 {
121     unsigned long *bitmap = bitmap_new(max_slots);
122     int slot = 0;
123 
124     object_child_foreach(qdev_get_machine(), pc_dimm_slot2bitmap, bitmap);
125 
126     /* check if requested slot is not occupied */
127     if (hint) {
128         if (*hint >= max_slots) {
129             error_setg(errp, "invalid slot# %d, should be less than %d",
130                        *hint, max_slots);
131         } else if (!test_bit(*hint, bitmap)) {
132             slot = *hint;
133         } else {
134             error_setg(errp, "slot %d is busy", *hint);
135         }
136         goto out;
137     }
138 
139     /* search for free slot */
140     slot = find_first_zero_bit(bitmap, max_slots);
141     if (slot == max_slots) {
142         error_setg(errp, "no free slots available");
143     }
144 out:
145     g_free(bitmap);
146     return slot;
147 }
148 
149 static Property pc_dimm_properties[] = {
150     DEFINE_PROP_UINT64(PC_DIMM_ADDR_PROP, PCDIMMDevice, addr, 0),
151     DEFINE_PROP_UINT32(PC_DIMM_NODE_PROP, PCDIMMDevice, node, 0),
152     DEFINE_PROP_INT32(PC_DIMM_SLOT_PROP, PCDIMMDevice, slot,
153                       PC_DIMM_UNASSIGNED_SLOT),
154     DEFINE_PROP_LINK(PC_DIMM_MEMDEV_PROP, PCDIMMDevice, hostmem,
155                      TYPE_MEMORY_BACKEND, HostMemoryBackend *),
156     DEFINE_PROP_END_OF_LIST(),
157 };
158 
159 static void pc_dimm_get_size(Object *obj, Visitor *v, const char *name,
160                              void *opaque, Error **errp)
161 {
162     uint64_t value;
163     MemoryRegion *mr;
164     PCDIMMDevice *dimm = PC_DIMM(obj);
165     PCDIMMDeviceClass *ddc = PC_DIMM_GET_CLASS(obj);
166 
167     mr = ddc->get_memory_region(dimm, errp);
168     if (!mr) {
169         return;
170     }
171     value = memory_region_size(mr);
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, errp);
226 }
227 
228 static MemoryRegion *pc_dimm_get_vmstate_memory_region(PCDIMMDevice *dimm)
229 {
230     return host_memory_backend_get_memory(dimm->hostmem, &error_abort);
231 }
232 
233 static uint64_t pc_dimm_md_get_addr(const MemoryDeviceState *md)
234 {
235     const PCDIMMDevice *dimm = PC_DIMM(md);
236 
237     return dimm->addr;
238 }
239 
240 static uint64_t pc_dimm_md_get_region_size(const MemoryDeviceState *md)
241 {
242     /* dropping const here is fine as we don't touch the memory region */
243     PCDIMMDevice *dimm = PC_DIMM(md);
244     const PCDIMMDeviceClass *ddc = PC_DIMM_GET_CLASS(md);
245     MemoryRegion *mr;
246 
247     mr = ddc->get_memory_region(dimm, &error_abort);
248     if (!mr) {
249         return 0;
250     }
251 
252     return memory_region_size(mr);
253 }
254 
255 static void pc_dimm_md_fill_device_info(const MemoryDeviceState *md,
256                                         MemoryDeviceInfo *info)
257 {
258     PCDIMMDeviceInfo *di = g_new0(PCDIMMDeviceInfo, 1);
259     const DeviceClass *dc = DEVICE_GET_CLASS(md);
260     const PCDIMMDevice *dimm = PC_DIMM(md);
261     const DeviceState *dev = DEVICE(md);
262 
263     if (dev->id) {
264         di->has_id = true;
265         di->id = g_strdup(dev->id);
266     }
267     di->hotplugged = dev->hotplugged;
268     di->hotpluggable = dc->hotpluggable;
269     di->addr = dimm->addr;
270     di->slot = dimm->slot;
271     di->node = dimm->node;
272     di->size = object_property_get_uint(OBJECT(dimm), PC_DIMM_SIZE_PROP,
273                                         NULL);
274     di->memdev = object_get_canonical_path(OBJECT(dimm->hostmem));
275 
276     if (object_dynamic_cast(OBJECT(dev), TYPE_NVDIMM)) {
277         info->u.nvdimm.data = di;
278         info->type = MEMORY_DEVICE_INFO_KIND_NVDIMM;
279     } else {
280         info->u.dimm.data = di;
281         info->type = MEMORY_DEVICE_INFO_KIND_DIMM;
282     }
283 }
284 
285 static void pc_dimm_class_init(ObjectClass *oc, void *data)
286 {
287     DeviceClass *dc = DEVICE_CLASS(oc);
288     PCDIMMDeviceClass *ddc = PC_DIMM_CLASS(oc);
289     MemoryDeviceClass *mdc = MEMORY_DEVICE_CLASS(oc);
290 
291     dc->realize = pc_dimm_realize;
292     dc->unrealize = pc_dimm_unrealize;
293     dc->props = pc_dimm_properties;
294     dc->desc = "DIMM memory module";
295 
296     ddc->get_memory_region = pc_dimm_get_memory_region;
297     ddc->get_vmstate_memory_region = pc_dimm_get_vmstate_memory_region;
298 
299     mdc->get_addr = pc_dimm_md_get_addr;
300     /* for a dimm plugged_size == region_size */
301     mdc->get_plugged_size = pc_dimm_md_get_region_size;
302     mdc->get_region_size = pc_dimm_md_get_region_size;
303     mdc->fill_device_info = pc_dimm_md_fill_device_info;
304 }
305 
306 static TypeInfo pc_dimm_info = {
307     .name          = TYPE_PC_DIMM,
308     .parent        = TYPE_DEVICE,
309     .instance_size = sizeof(PCDIMMDevice),
310     .instance_init = pc_dimm_init,
311     .class_init    = pc_dimm_class_init,
312     .class_size    = sizeof(PCDIMMDeviceClass),
313     .interfaces = (InterfaceInfo[]) {
314         { TYPE_MEMORY_DEVICE },
315         { }
316     },
317 };
318 
319 static void pc_dimm_register_types(void)
320 {
321     type_register_static(&pc_dimm_info);
322 }
323 
324 type_init(pc_dimm_register_types)
325