1/*
2 * Non-Volatile Dual In-line Memory Module Virtualization Implementation
3 *
4 * Copyright(C) 2015 Intel Corporation.
5 *
6 * Author:
7 * Xiao Guangrong <guangrong.xiao@linux.intel.com>
8 *
9 * Currently, it only supports PMEM Virtualization.
10 *
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.
15 *
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.
20 *
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/>
23 */
24
25#include "qemu/osdep.h"
26#include "qemu/module.h"
27#include "qemu/pmem.h"
28#include "qapi/error.h"
29#include "qapi/visitor.h"
30#include "hw/mem/nvdimm.h"
31#include "hw/qdev-properties.h"
32#include "hw/mem/memory-device.h"
33#include "sysemu/hostmem.h"
34
35static void nvdimm_get_label_size(Object *obj, Visitor *v, const char *name,
36 void *opaque, Error **errp)
37{
38 NVDIMMDevice *nvdimm = NVDIMM(obj);
39 uint64_t value = nvdimm->label_size;
40
41 visit_type_size(v, name, &value, errp);
42}
43
44static void nvdimm_set_label_size(Object *obj, Visitor *v, const char *name,
45 void *opaque, Error **errp)
46{
47 NVDIMMDevice *nvdimm = NVDIMM(obj);
48 Error *local_err = NULL;
49 uint64_t value;
50
51 if (nvdimm->nvdimm_mr) {
52 error_setg(&local_err, "cannot change property value");
53 goto out;
54 }
55
56 visit_type_size(v, name, &value, &local_err);
57 if (local_err) {
58 goto out;
59 }
60 if (value < MIN_NAMESPACE_LABEL_SIZE) {
61 error_setg(&local_err, "Property '%s.%s' (0x%" PRIx64 ") is required"
62 " at least 0x%lx", object_get_typename(obj),
63 name, value, MIN_NAMESPACE_LABEL_SIZE);
64 goto out;
65 }
66
67 nvdimm->label_size = value;
68out:
69 error_propagate(errp, local_err);
70}
71
72static void nvdimm_init(Object *obj)
73{
74 object_property_add(obj, NVDIMM_LABEL_SIZE_PROP, "int",
75 nvdimm_get_label_size, nvdimm_set_label_size, NULL,
76 NULL, NULL);
77}
78
79static void nvdimm_finalize(Object *obj)
80{
81 NVDIMMDevice *nvdimm = NVDIMM(obj);
82
83 g_free(nvdimm->nvdimm_mr);
84}
85
86static void nvdimm_prepare_memory_region(NVDIMMDevice *nvdimm, Error **errp)
87{
88 PCDIMMDevice *dimm = PC_DIMM(nvdimm);
89 uint64_t align, pmem_size, size;
90 MemoryRegion *mr;
91
92 g_assert(!nvdimm->nvdimm_mr);
93
94 if (!dimm->hostmem) {
95 error_setg(errp, "'" PC_DIMM_MEMDEV_PROP "' property must be set");
96 return;
97 }
98
99 mr = host_memory_backend_get_memory(dimm->hostmem);
100 align = memory_region_get_alignment(mr);
101 size = memory_region_size(mr);
102
103 pmem_size = size - nvdimm->label_size;
104 nvdimm->label_data = memory_region_get_ram_ptr(mr) + pmem_size;
105 pmem_size = QEMU_ALIGN_DOWN(pmem_size, align);
106
107 if (size <= nvdimm->label_size || !pmem_size) {
108 HostMemoryBackend *hostmem = dimm->hostmem;
109 char *path = object_get_canonical_path_component(OBJECT(hostmem));
110
111 error_setg(errp, "the size of memdev %s (0x%" PRIx64 ") is too "
112 "small to contain nvdimm label (0x%" PRIx64 ") and "
113 "aligned PMEM (0x%" PRIx64 ")",
114 path, memory_region_size(mr), nvdimm->label_size, align);
115 g_free(path);
116 return;
117 }
118
119 nvdimm->nvdimm_mr = g_new(MemoryRegion, 1);
120 memory_region_init_alias(nvdimm->nvdimm_mr, OBJECT(dimm),
121 "nvdimm-memory", mr, 0, pmem_size);
122 memory_region_set_nonvolatile(nvdimm->nvdimm_mr, true);
123 nvdimm->nvdimm_mr->align = align;
124}
125
126static MemoryRegion *nvdimm_md_get_memory_region(MemoryDeviceState *md,
127 Error **errp)
128{
129 NVDIMMDevice *nvdimm = NVDIMM(md);
130 Error *local_err = NULL;
131
132 if (!nvdimm->nvdimm_mr) {
133 nvdimm_prepare_memory_region(nvdimm, &local_err);
134 if (local_err) {
135 error_propagate(errp, local_err);
136 return NULL;
137 }
138 }
139 return nvdimm->nvdimm_mr;
140}
141
142static void nvdimm_realize(PCDIMMDevice *dimm, Error **errp)
143{
144 NVDIMMDevice *nvdimm = NVDIMM(dimm);
145
146 if (!nvdimm->nvdimm_mr) {
147 nvdimm_prepare_memory_region(nvdimm, errp);
148 }
149}
150
151/*
152 * the caller should check the input parameters before calling
153 * label read/write functions.
154 */
155static void nvdimm_validate_rw_label_data(NVDIMMDevice *nvdimm, uint64_t size,
156 uint64_t offset)
157{
158 assert((nvdimm->label_size >= size + offset) && (offset + size > offset));
159}
160
161static void nvdimm_read_label_data(NVDIMMDevice *nvdimm, void *buf,
162 uint64_t size, uint64_t offset)
163{
164 nvdimm_validate_rw_label_data(nvdimm, size, offset);
165
166 memcpy(buf, nvdimm->label_data + offset, size);
167}
168
169static void nvdimm_write_label_data(NVDIMMDevice *nvdimm, const void *buf,
170 uint64_t size, uint64_t offset)
171{
172 MemoryRegion *mr;
173 PCDIMMDevice *dimm = PC_DIMM(nvdimm);
174 bool is_pmem = object_property_get_bool(OBJECT(dimm->hostmem),
175 "pmem", NULL);
176 uint64_t backend_offset;
177
178 nvdimm_validate_rw_label_data(nvdimm, size, offset);
179
180 if (!is_pmem) {
181 memcpy(nvdimm->label_data + offset, buf, size);
182 } else {
183 pmem_memcpy_persist(nvdimm->label_data + offset, buf, size);
184 }
185
186 mr = host_memory_backend_get_memory(dimm->hostmem);
187 backend_offset = memory_region_size(mr) - nvdimm->label_size + offset;
188 memory_region_set_dirty(mr, backend_offset, size);
189}
190
191static Property nvdimm_properties[] = {
192 DEFINE_PROP_BOOL(NVDIMM_UNARMED_PROP, NVDIMMDevice, unarmed, false),
193 DEFINE_PROP_END_OF_LIST(),
194};
195
196static void nvdimm_class_init(ObjectClass *oc, void *data)
197{
198 PCDIMMDeviceClass *ddc = PC_DIMM_CLASS(oc);
199 MemoryDeviceClass *mdc = MEMORY_DEVICE_CLASS(oc);
200 NVDIMMClass *nvc = NVDIMM_CLASS(oc);
201 DeviceClass *dc = DEVICE_CLASS(oc);
202
203 ddc->realize = nvdimm_realize;
204 mdc->get_memory_region = nvdimm_md_get_memory_region;
205 dc->props = nvdimm_properties;
206
207 nvc->read_label_data = nvdimm_read_label_data;
208 nvc->write_label_data = nvdimm_write_label_data;
209}
210
211static TypeInfo nvdimm_info = {
212 .name = TYPE_NVDIMM,
213 .parent = TYPE_PC_DIMM,
214 .class_size = sizeof(NVDIMMClass),
215 .class_init = nvdimm_class_init,
216 .instance_size = sizeof(NVDIMMDevice),
217 .instance_init = nvdimm_init,
218 .instance_finalize = nvdimm_finalize,
219};
220
221static void nvdimm_register_types(void)
222{
223 type_register_static(&nvdimm_info);
224}
225
226type_init(nvdimm_register_types)
227