2 * Non-Volatile Dual In-line Memory Module Virtualization Implementation
4 * Copyright(C) 2015 Intel Corporation.
7 * Xiao Guangrong <guangrong.xiao@linux.intel.com>
9 * Currently, it only supports PMEM Virtualization.
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; either
14 * version 2 of the License, or (at your option) any later version.
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with this library; if not, see <http://www.gnu.org/licenses/>
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
27 #include "qapi/visitor.h"
28 #include "hw/mem/nvdimm.h"
30 static void nvdimm_get_label_size(Object
*obj
, Visitor
*v
, const char *name
,
31 void *opaque
, Error
**errp
)
33 NVDIMMDevice
*nvdimm
= NVDIMM(obj
);
34 uint64_t value
= nvdimm
->label_size
;
36 visit_type_size(v
, name
, &value
, errp
);
39 static void nvdimm_set_label_size(Object
*obj
, Visitor
*v
, const char *name
,
40 void *opaque
, Error
**errp
)
42 NVDIMMDevice
*nvdimm
= NVDIMM(obj
);
43 Error
*local_err
= NULL
;
46 if (nvdimm
->nvdimm_mr
) {
47 error_setg(&local_err
, "cannot change property value");
51 visit_type_size(v
, name
, &value
, &local_err
);
55 if (value
< MIN_NAMESPACE_LABEL_SIZE
) {
56 error_setg(&local_err
, "Property '%s.%s' (0x%" PRIx64
") is required"
57 " at least 0x%lx", object_get_typename(obj
),
58 name
, value
, MIN_NAMESPACE_LABEL_SIZE
);
62 nvdimm
->label_size
= value
;
64 error_propagate(errp
, local_err
);
67 static void nvdimm_init(Object
*obj
)
69 object_property_add(obj
, NVDIMM_LABEL_SIZE_PROP
, "int",
70 nvdimm_get_label_size
, nvdimm_set_label_size
, NULL
,
74 static void nvdimm_finalize(Object
*obj
)
76 NVDIMMDevice
*nvdimm
= NVDIMM(obj
);
78 g_free(nvdimm
->nvdimm_mr
);
81 static void nvdimm_prepare_memory_region(NVDIMMDevice
*nvdimm
, Error
**errp
)
83 PCDIMMDevice
*dimm
= PC_DIMM(nvdimm
);
84 uint64_t align
, pmem_size
, size
;
87 g_assert(!nvdimm
->nvdimm_mr
);
90 error_setg(errp
, "'" PC_DIMM_MEMDEV_PROP
"' property must be set");
94 mr
= host_memory_backend_get_memory(dimm
->hostmem
);
95 align
= memory_region_get_alignment(mr
);
96 size
= memory_region_size(mr
);
98 pmem_size
= size
- nvdimm
->label_size
;
99 nvdimm
->label_data
= memory_region_get_ram_ptr(mr
) + pmem_size
;
100 pmem_size
= QEMU_ALIGN_DOWN(pmem_size
, align
);
102 if (size
<= nvdimm
->label_size
|| !pmem_size
) {
103 HostMemoryBackend
*hostmem
= dimm
->hostmem
;
104 char *path
= object_get_canonical_path_component(OBJECT(hostmem
));
106 error_setg(errp
, "the size of memdev %s (0x%" PRIx64
") is too "
107 "small to contain nvdimm label (0x%" PRIx64
") and "
108 "aligned PMEM (0x%" PRIx64
")",
109 path
, memory_region_size(mr
), nvdimm
->label_size
, align
);
114 nvdimm
->nvdimm_mr
= g_new(MemoryRegion
, 1);
115 memory_region_init_alias(nvdimm
->nvdimm_mr
, OBJECT(dimm
),
116 "nvdimm-memory", mr
, 0, pmem_size
);
117 nvdimm
->nvdimm_mr
->align
= align
;
120 static MemoryRegion
*nvdimm_get_memory_region(PCDIMMDevice
*dimm
, Error
**errp
)
122 NVDIMMDevice
*nvdimm
= NVDIMM(dimm
);
123 Error
*local_err
= NULL
;
125 if (!nvdimm
->nvdimm_mr
) {
126 nvdimm_prepare_memory_region(nvdimm
, &local_err
);
128 error_propagate(errp
, local_err
);
132 return nvdimm
->nvdimm_mr
;
135 static void nvdimm_realize(PCDIMMDevice
*dimm
, Error
**errp
)
137 NVDIMMDevice
*nvdimm
= NVDIMM(dimm
);
139 if (!nvdimm
->nvdimm_mr
) {
140 nvdimm_prepare_memory_region(nvdimm
, errp
);
145 * the caller should check the input parameters before calling
146 * label read/write functions.
148 static void nvdimm_validate_rw_label_data(NVDIMMDevice
*nvdimm
, uint64_t size
,
151 assert((nvdimm
->label_size
>= size
+ offset
) && (offset
+ size
> offset
));
154 static void nvdimm_read_label_data(NVDIMMDevice
*nvdimm
, void *buf
,
155 uint64_t size
, uint64_t offset
)
157 nvdimm_validate_rw_label_data(nvdimm
, size
, offset
);
159 memcpy(buf
, nvdimm
->label_data
+ offset
, size
);
162 static void nvdimm_write_label_data(NVDIMMDevice
*nvdimm
, const void *buf
,
163 uint64_t size
, uint64_t offset
)
166 PCDIMMDevice
*dimm
= PC_DIMM(nvdimm
);
167 uint64_t backend_offset
;
169 nvdimm_validate_rw_label_data(nvdimm
, size
, offset
);
171 memcpy(nvdimm
->label_data
+ offset
, buf
, size
);
173 mr
= host_memory_backend_get_memory(dimm
->hostmem
);
174 backend_offset
= memory_region_size(mr
) - nvdimm
->label_size
+ offset
;
175 memory_region_set_dirty(mr
, backend_offset
, size
);
178 static Property nvdimm_properties
[] = {
179 DEFINE_PROP_BOOL(NVDIMM_UNARMED_PROP
, NVDIMMDevice
, unarmed
, false),
180 DEFINE_PROP_END_OF_LIST(),
183 static void nvdimm_class_init(ObjectClass
*oc
, void *data
)
185 PCDIMMDeviceClass
*ddc
= PC_DIMM_CLASS(oc
);
186 NVDIMMClass
*nvc
= NVDIMM_CLASS(oc
);
187 DeviceClass
*dc
= DEVICE_CLASS(oc
);
189 ddc
->realize
= nvdimm_realize
;
190 ddc
->get_memory_region
= nvdimm_get_memory_region
;
191 dc
->props
= nvdimm_properties
;
193 nvc
->read_label_data
= nvdimm_read_label_data
;
194 nvc
->write_label_data
= nvdimm_write_label_data
;
197 static TypeInfo nvdimm_info
= {
199 .parent
= TYPE_PC_DIMM
,
200 .class_size
= sizeof(NVDIMMClass
),
201 .class_init
= nvdimm_class_init
,
202 .instance_size
= sizeof(NVDIMMDevice
),
203 .instance_init
= nvdimm_init
,
204 .instance_finalize
= nvdimm_finalize
,
207 static void nvdimm_register_types(void)
209 type_register_static(&nvdimm_info
);
212 type_init(nvdimm_register_types
)