hw/mem/nvdimm.c

   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
  35 static 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
  44 static 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     if (!visit_type_size(v, name, &value, &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_get_uuid(Object *obj, Visitor *v, const char *name,
  72                                   void *opaque, Error **errp)
  73 {
  74     NVDIMMDevice *nvdimm = NVDIMM(obj);
  75     char *value = NULL;
  76
  77     value = qemu_uuid_unparse_strdup(&nvdimm->uuid);
  78
  79     visit_type_str(v, name, &value, errp);
  80     g_free(value);
  81 }
  82
  83
  84 static void nvdimm_set_uuid(Object *obj, Visitor *v, const char *name,
  85                                   void *opaque, Error **errp)
  86 {
  87     NVDIMMDevice *nvdimm = NVDIMM(obj);
  88     Error *local_err = NULL;
  89     char *value;
  90
  91     if (!visit_type_str(v, name, &value, &local_err)) {
  92         goto out;
  93     }
  94
  95     if (qemu_uuid_parse(value, &nvdimm->uuid) != 0) {
  96         error_setg(errp, "Property '%s.%s' has invalid value",
  97                    object_get_typename(obj), name);
  98     }
  99     g_free(value);
 100
 101 out:
 102     error_propagate(errp, local_err);
 103 }
 104
 105
 106 static void nvdimm_init(Object *obj)
 107 {
 108     object_property_add(obj, NVDIMM_LABEL_SIZE_PROP, "int",
 109                         nvdimm_get_label_size, nvdimm_set_label_size, NULL,
 110                         NULL);
 111
 112     object_property_add(obj, NVDIMM_UUID_PROP, "QemuUUID", nvdimm_get_uuid,
 113                         nvdimm_set_uuid, NULL, NULL);
 114 }
 115
 116 static void nvdimm_finalize(Object *obj)
 117 {
 118     NVDIMMDevice *nvdimm = NVDIMM(obj);
 119
 120     g_free(nvdimm->nvdimm_mr);
 121 }
 122
 123 static void nvdimm_prepare_memory_region(NVDIMMDevice *nvdimm, Error **errp)
 124 {
 125     PCDIMMDevice *dimm = PC_DIMM(nvdimm);
 126     uint64_t align, pmem_size, size;
 127     MemoryRegion *mr;
 128
 129     g_assert(!nvdimm->nvdimm_mr);
 130
 131     if (!dimm->hostmem) {
 132         error_setg(errp, "'" PC_DIMM_MEMDEV_PROP "' property must be set");
 133         return;
 134     }
 135
 136     mr = host_memory_backend_get_memory(dimm->hostmem);
 137     align = memory_region_get_alignment(mr);
 138     size = memory_region_size(mr);
 139
 140     pmem_size = size - nvdimm->label_size;
 141     nvdimm->label_data = memory_region_get_ram_ptr(mr) + pmem_size;
 142     pmem_size = QEMU_ALIGN_DOWN(pmem_size, align);
 143
 144     if (size <= nvdimm->label_size || !pmem_size) {
 145         HostMemoryBackend *hostmem = dimm->hostmem;
 146         char *path = object_get_canonical_path_component(OBJECT(hostmem));
 147
 148         error_setg(errp, "the size of memdev %s (0x%" PRIx64 ") is too "
 149                    "small to contain nvdimm label (0x%" PRIx64 ") and "
 150                    "aligned PMEM (0x%" PRIx64 ")",
 151                    path, memory_region_size(mr), nvdimm->label_size, align);
 152         g_free(path);
 153         return;
 154     }
 155
 156     nvdimm->nvdimm_mr = g_new(MemoryRegion, 1);
 157     memory_region_init_alias(nvdimm->nvdimm_mr, OBJECT(dimm),
 158                              "nvdimm-memory", mr, 0, pmem_size);
 159     memory_region_set_nonvolatile(nvdimm->nvdimm_mr, true);
 160     nvdimm->nvdimm_mr->align = align;
 161 }
 162
 163 static MemoryRegion *nvdimm_md_get_memory_region(MemoryDeviceState *md,
 164                                                  Error **errp)
 165 {
 166     NVDIMMDevice *nvdimm = NVDIMM(md);
 167     Error *local_err = NULL;
 168
 169     if (!nvdimm->nvdimm_mr) {
 170         nvdimm_prepare_memory_region(nvdimm, &local_err);
 171         if (local_err) {
 172             error_propagate(errp, local_err);
 173             return NULL;
 174         }
 175     }
 176     return nvdimm->nvdimm_mr;
 177 }
 178
 179 static void nvdimm_realize(PCDIMMDevice *dimm, Error **errp)
 180 {
 181     NVDIMMDevice *nvdimm = NVDIMM(dimm);
 182
 183     if (!nvdimm->nvdimm_mr) {
 184         nvdimm_prepare_memory_region(nvdimm, errp);
 185     }
 186 }
 187
 188 /*
 189  * the caller should check the input parameters before calling
 190  * label read/write functions.
 191  */
 192 static void nvdimm_validate_rw_label_data(NVDIMMDevice *nvdimm, uint64_t size,
 193                                         uint64_t offset)
 194 {
 195     assert((nvdimm->label_size >= size + offset) && (offset + size > offset));
 196 }
 197
 198 static void nvdimm_read_label_data(NVDIMMDevice *nvdimm, void *buf,
 199                                    uint64_t size, uint64_t offset)
 200 {
 201     nvdimm_validate_rw_label_data(nvdimm, size, offset);
 202
 203     memcpy(buf, nvdimm->label_data + offset, size);
 204 }
 205
 206 static void nvdimm_write_label_data(NVDIMMDevice *nvdimm, const void *buf,
 207                                     uint64_t size, uint64_t offset)
 208 {
 209     MemoryRegion *mr;
 210     PCDIMMDevice *dimm = PC_DIMM(nvdimm);
 211     bool is_pmem = object_property_get_bool(OBJECT(dimm->hostmem),
 212                                             "pmem", NULL);
 213     uint64_t backend_offset;
 214
 215     nvdimm_validate_rw_label_data(nvdimm, size, offset);
 216
 217     if (!is_pmem) {
 218         memcpy(nvdimm->label_data + offset, buf, size);
 219     } else {
 220         pmem_memcpy_persist(nvdimm->label_data + offset, buf, size);
 221     }
 222
 223     mr = host_memory_backend_get_memory(dimm->hostmem);
 224     backend_offset = memory_region_size(mr) - nvdimm->label_size + offset;
 225     memory_region_set_dirty(mr, backend_offset, size);
 226 }
 227
 228 static Property nvdimm_properties[] = {
 229     DEFINE_PROP_BOOL(NVDIMM_UNARMED_PROP, NVDIMMDevice, unarmed, false),
 230     DEFINE_PROP_END_OF_LIST(),
 231 };
 232
 233 static void nvdimm_class_init(ObjectClass *oc, void *data)
 234 {
 235     PCDIMMDeviceClass *ddc = PC_DIMM_CLASS(oc);
 236     MemoryDeviceClass *mdc = MEMORY_DEVICE_CLASS(oc);
 237     NVDIMMClass *nvc = NVDIMM_CLASS(oc);
 238     DeviceClass *dc = DEVICE_CLASS(oc);
 239
 240     ddc->realize = nvdimm_realize;
 241     mdc->get_memory_region = nvdimm_md_get_memory_region;
 242     device_class_set_props(dc, nvdimm_properties);
 243
 244     nvc->read_label_data = nvdimm_read_label_data;
 245     nvc->write_label_data = nvdimm_write_label_data;
 246 }
 247
 248 static TypeInfo nvdimm_info = {
 249     .name          = TYPE_NVDIMM,
 250     .parent        = TYPE_PC_DIMM,
 251     .class_size    = sizeof(NVDIMMClass),
 252     .class_init    = nvdimm_class_init,
 253     .instance_size = sizeof(NVDIMMDevice),
 254     .instance_init = nvdimm_init,
 255     .instance_finalize = nvdimm_finalize,
 256 };
 257
 258 static void nvdimm_register_types(void)
 259 {
 260     type_register_static(&nvdimm_info);
 261 }
 262
 263 type_init(nvdimm_register_types)