2 * Dimm device for Memory Hotplug
4 * Copyright ProfitBricks GmbH 2012
5 * Copyright (C) 2014 Red Hat Inc
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.
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.
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/>
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"
35 static int pc_dimm_get_free_slot(const int *hint
, int max_slots
, Error
**errp
);
37 void pc_dimm_pre_plug(PCDIMMDevice
*dimm
, MachineState
*machine
,
38 const uint64_t *legacy_align
, Error
**errp
)
40 Error
*local_err
= NULL
;
43 slot
= object_property_get_int(OBJECT(dimm
), PC_DIMM_SLOT_PROP
,
45 if ((slot
< 0 || slot
>= machine
->ram_slots
) &&
46 slot
!= PC_DIMM_UNASSIGNED_SLOT
) {
47 error_setg(&local_err
, "invalid slot number, valid range is [0-%"
48 PRIu64
"]", machine
->ram_slots
- 1);
52 slot
= pc_dimm_get_free_slot(slot
== PC_DIMM_UNASSIGNED_SLOT
? NULL
: &slot
,
53 machine
->ram_slots
, &local_err
);
57 object_property_set_int(OBJECT(dimm
), slot
, PC_DIMM_SLOT_PROP
,
59 trace_mhp_pc_dimm_assigned_slot(slot
);
61 memory_device_pre_plug(MEMORY_DEVICE(dimm
), machine
, legacy_align
,
64 error_propagate(errp
, local_err
);
67 void pc_dimm_plug(PCDIMMDevice
*dimm
, MachineState
*machine
, Error
**errp
)
69 PCDIMMDeviceClass
*ddc
= PC_DIMM_GET_CLASS(dimm
);
70 MemoryRegion
*vmstate_mr
= ddc
->get_vmstate_memory_region(dimm
,
73 memory_device_plug(MEMORY_DEVICE(dimm
), machine
);
74 vmstate_register_ram(vmstate_mr
, DEVICE(dimm
));
77 void pc_dimm_unplug(PCDIMMDevice
*dimm
, MachineState
*machine
)
79 PCDIMMDeviceClass
*ddc
= PC_DIMM_GET_CLASS(dimm
);
80 MemoryRegion
*vmstate_mr
= ddc
->get_vmstate_memory_region(dimm
,
83 memory_device_unplug(MEMORY_DEVICE(dimm
), machine
);
84 vmstate_unregister_ram(vmstate_mr
, DEVICE(dimm
));
87 static int pc_dimm_slot2bitmap(Object
*obj
, void *opaque
)
89 unsigned long *bitmap
= opaque
;
91 if (object_dynamic_cast(obj
, TYPE_PC_DIMM
)) {
92 DeviceState
*dev
= DEVICE(obj
);
93 if (dev
->realized
) { /* count only realized DIMMs */
94 PCDIMMDevice
*d
= PC_DIMM(obj
);
95 set_bit(d
->slot
, bitmap
);
99 object_child_foreach(obj
, pc_dimm_slot2bitmap
, opaque
);
103 static int pc_dimm_get_free_slot(const int *hint
, int max_slots
, Error
**errp
)
105 unsigned long *bitmap
;
108 if (max_slots
<= 0) {
109 error_setg(errp
, "no slots where allocated, please specify "
110 "the 'slots' option");
114 bitmap
= bitmap_new(max_slots
);
115 object_child_foreach(qdev_get_machine(), pc_dimm_slot2bitmap
, bitmap
);
117 /* check if requested slot is not occupied */
119 if (*hint
>= max_slots
) {
120 error_setg(errp
, "invalid slot# %d, should be less than %d",
122 } else if (!test_bit(*hint
, bitmap
)) {
125 error_setg(errp
, "slot %d is busy", *hint
);
130 /* search for free slot */
131 slot
= find_first_zero_bit(bitmap
, max_slots
);
132 if (slot
== max_slots
) {
133 error_setg(errp
, "no free slots available");
140 static Property pc_dimm_properties
[] = {
141 DEFINE_PROP_UINT64(PC_DIMM_ADDR_PROP
, PCDIMMDevice
, addr
, 0),
142 DEFINE_PROP_UINT32(PC_DIMM_NODE_PROP
, PCDIMMDevice
, node
, 0),
143 DEFINE_PROP_INT32(PC_DIMM_SLOT_PROP
, PCDIMMDevice
, slot
,
144 PC_DIMM_UNASSIGNED_SLOT
),
145 DEFINE_PROP_LINK(PC_DIMM_MEMDEV_PROP
, PCDIMMDevice
, hostmem
,
146 TYPE_MEMORY_BACKEND
, HostMemoryBackend
*),
147 DEFINE_PROP_END_OF_LIST(),
150 static void pc_dimm_get_size(Object
*obj
, Visitor
*v
, const char *name
,
151 void *opaque
, Error
**errp
)
153 Error
*local_err
= NULL
;
156 value
= memory_device_get_region_size(MEMORY_DEVICE(obj
), &local_err
);
158 error_propagate(errp
, local_err
);
162 visit_type_uint64(v
, name
, &value
, errp
);
165 static void pc_dimm_init(Object
*obj
)
167 object_property_add(obj
, PC_DIMM_SIZE_PROP
, "uint64", pc_dimm_get_size
,
168 NULL
, NULL
, NULL
, &error_abort
);
171 static void pc_dimm_realize(DeviceState
*dev
, Error
**errp
)
173 PCDIMMDevice
*dimm
= PC_DIMM(dev
);
174 PCDIMMDeviceClass
*ddc
= PC_DIMM_GET_CLASS(dimm
);
176 if (!dimm
->hostmem
) {
177 error_setg(errp
, "'" PC_DIMM_MEMDEV_PROP
"' property is not set");
179 } else if (host_memory_backend_is_mapped(dimm
->hostmem
)) {
180 char *path
= object_get_canonical_path_component(OBJECT(dimm
->hostmem
));
181 error_setg(errp
, "can't use already busy memdev: %s", path
);
185 if (((nb_numa_nodes
> 0) && (dimm
->node
>= nb_numa_nodes
)) ||
186 (!nb_numa_nodes
&& dimm
->node
)) {
187 error_setg(errp
, "'DIMM property " PC_DIMM_NODE_PROP
" has value %"
188 PRIu32
"' which exceeds the number of numa nodes: %d",
189 dimm
->node
, nb_numa_nodes
? nb_numa_nodes
: 1);
194 ddc
->realize(dimm
, errp
);
197 host_memory_backend_set_mapped(dimm
->hostmem
, true);
200 static void pc_dimm_unrealize(DeviceState
*dev
, Error
**errp
)
202 PCDIMMDevice
*dimm
= PC_DIMM(dev
);
204 host_memory_backend_set_mapped(dimm
->hostmem
, false);
207 static MemoryRegion
*pc_dimm_get_memory_region(PCDIMMDevice
*dimm
, Error
**errp
)
209 if (!dimm
->hostmem
) {
210 error_setg(errp
, "'" PC_DIMM_MEMDEV_PROP
"' property must be set");
214 return host_memory_backend_get_memory(dimm
->hostmem
);
217 static uint64_t pc_dimm_md_get_addr(const MemoryDeviceState
*md
)
219 return object_property_get_uint(OBJECT(md
), PC_DIMM_ADDR_PROP
, &error_abort
);
222 static void pc_dimm_md_set_addr(MemoryDeviceState
*md
, uint64_t addr
,
225 object_property_set_uint(OBJECT(md
), addr
, PC_DIMM_ADDR_PROP
, errp
);
228 static MemoryRegion
*pc_dimm_md_get_memory_region(MemoryDeviceState
*md
,
231 return pc_dimm_get_memory_region(PC_DIMM(md
), errp
);
234 static void pc_dimm_md_fill_device_info(const MemoryDeviceState
*md
,
235 MemoryDeviceInfo
*info
)
237 PCDIMMDeviceInfo
*di
= g_new0(PCDIMMDeviceInfo
, 1);
238 const DeviceClass
*dc
= DEVICE_GET_CLASS(md
);
239 const PCDIMMDevice
*dimm
= PC_DIMM(md
);
240 const DeviceState
*dev
= DEVICE(md
);
244 di
->id
= g_strdup(dev
->id
);
246 di
->hotplugged
= dev
->hotplugged
;
247 di
->hotpluggable
= dc
->hotpluggable
;
248 di
->addr
= dimm
->addr
;
249 di
->slot
= dimm
->slot
;
250 di
->node
= dimm
->node
;
251 di
->size
= object_property_get_uint(OBJECT(dimm
), PC_DIMM_SIZE_PROP
,
253 di
->memdev
= object_get_canonical_path(OBJECT(dimm
->hostmem
));
255 if (object_dynamic_cast(OBJECT(dev
), TYPE_NVDIMM
)) {
256 info
->u
.nvdimm
.data
= di
;
257 info
->type
= MEMORY_DEVICE_INFO_KIND_NVDIMM
;
259 info
->u
.dimm
.data
= di
;
260 info
->type
= MEMORY_DEVICE_INFO_KIND_DIMM
;
264 static void pc_dimm_class_init(ObjectClass
*oc
, void *data
)
266 DeviceClass
*dc
= DEVICE_CLASS(oc
);
267 PCDIMMDeviceClass
*ddc
= PC_DIMM_CLASS(oc
);
268 MemoryDeviceClass
*mdc
= MEMORY_DEVICE_CLASS(oc
);
270 dc
->realize
= pc_dimm_realize
;
271 dc
->unrealize
= pc_dimm_unrealize
;
272 dc
->props
= pc_dimm_properties
;
273 dc
->desc
= "DIMM memory module";
275 ddc
->get_vmstate_memory_region
= pc_dimm_get_memory_region
;
277 mdc
->get_addr
= pc_dimm_md_get_addr
;
278 mdc
->set_addr
= pc_dimm_md_set_addr
;
279 /* for a dimm plugged_size == region_size */
280 mdc
->get_plugged_size
= memory_device_get_region_size
;
281 mdc
->get_memory_region
= pc_dimm_md_get_memory_region
;
282 mdc
->fill_device_info
= pc_dimm_md_fill_device_info
;
285 static TypeInfo pc_dimm_info
= {
286 .name
= TYPE_PC_DIMM
,
287 .parent
= TYPE_DEVICE
,
288 .instance_size
= sizeof(PCDIMMDevice
),
289 .instance_init
= pc_dimm_init
,
290 .class_init
= pc_dimm_class_init
,
291 .class_size
= sizeof(PCDIMMDeviceClass
),
292 .interfaces
= (InterfaceInfo
[]) {
293 { TYPE_MEMORY_DEVICE
},
298 static void pc_dimm_register_types(void)
300 type_register_static(&pc_dimm_info
);
303 type_init(pc_dimm_register_types
)