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