qemu/hw/mem/nvdimm.c
<<
>>
Prefs
   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 "qapi/error.h"
  27#include "qapi/visitor.h"
  28#include "hw/mem/nvdimm.h"
  29
  30static void nvdimm_get_label_size(Object *obj, Visitor *v, const char *name,
  31                                  void *opaque, Error **errp)
  32{
  33    NVDIMMDevice *nvdimm = NVDIMM(obj);
  34    uint64_t value = nvdimm->label_size;
  35
  36    visit_type_size(v, name, &value, errp);
  37}
  38
  39static void nvdimm_set_label_size(Object *obj, Visitor *v, const char *name,
  40                                  void *opaque, Error **errp)
  41{
  42    NVDIMMDevice *nvdimm = NVDIMM(obj);
  43    Error *local_err = NULL;
  44    uint64_t value;
  45
  46    if (memory_region_size(&nvdimm->nvdimm_mr)) {
  47        error_setg(&local_err, "cannot change property value");
  48        goto out;
  49    }
  50
  51    visit_type_size(v, name, &value, &local_err);
  52    if (local_err) {
  53        goto out;
  54    }
  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);
  59        goto out;
  60    }
  61
  62    nvdimm->label_size = value;
  63out:
  64    error_propagate(errp, local_err);
  65}
  66
  67static void nvdimm_init(Object *obj)
  68{
  69    object_property_add(obj, "label-size", "int",
  70                        nvdimm_get_label_size, nvdimm_set_label_size, NULL,
  71                        NULL, NULL);
  72}
  73
  74static MemoryRegion *nvdimm_get_memory_region(PCDIMMDevice *dimm)
  75{
  76    NVDIMMDevice *nvdimm = NVDIMM(dimm);
  77
  78    return &nvdimm->nvdimm_mr;
  79}
  80
  81static void nvdimm_realize(PCDIMMDevice *dimm, Error **errp)
  82{
  83    MemoryRegion *mr = host_memory_backend_get_memory(dimm->hostmem, errp);
  84    NVDIMMDevice *nvdimm = NVDIMM(dimm);
  85    uint64_t align, pmem_size, size = memory_region_size(mr);
  86
  87    align = memory_region_get_alignment(mr);
  88
  89    pmem_size = size - nvdimm->label_size;
  90    nvdimm->label_data = memory_region_get_ram_ptr(mr) + pmem_size;
  91    pmem_size = QEMU_ALIGN_DOWN(pmem_size, align);
  92
  93    if (size <= nvdimm->label_size || !pmem_size) {
  94        HostMemoryBackend *hostmem = dimm->hostmem;
  95        char *path = object_get_canonical_path_component(OBJECT(hostmem));
  96
  97        error_setg(errp, "the size of memdev %s (0x%" PRIx64 ") is too "
  98                   "small to contain nvdimm label (0x%" PRIx64 ") and "
  99                   "aligned PMEM (0x%" PRIx64 ")",
 100                   path, memory_region_size(mr), nvdimm->label_size, align);
 101        g_free(path);
 102        return;
 103    }
 104
 105    memory_region_init_alias(&nvdimm->nvdimm_mr, OBJECT(dimm),
 106                             "nvdimm-memory", mr, 0, pmem_size);
 107    nvdimm->nvdimm_mr.align = align;
 108}
 109
 110/*
 111 * the caller should check the input parameters before calling
 112 * label read/write functions.
 113 */
 114static void nvdimm_validate_rw_label_data(NVDIMMDevice *nvdimm, uint64_t size,
 115                                        uint64_t offset)
 116{
 117    assert((nvdimm->label_size >= size + offset) && (offset + size > offset));
 118}
 119
 120static void nvdimm_read_label_data(NVDIMMDevice *nvdimm, void *buf,
 121                                   uint64_t size, uint64_t offset)
 122{
 123    nvdimm_validate_rw_label_data(nvdimm, size, offset);
 124
 125    memcpy(buf, nvdimm->label_data + offset, size);
 126}
 127
 128static void nvdimm_write_label_data(NVDIMMDevice *nvdimm, const void *buf,
 129                                    uint64_t size, uint64_t offset)
 130{
 131    MemoryRegion *mr;
 132    PCDIMMDevice *dimm = PC_DIMM(nvdimm);
 133    uint64_t backend_offset;
 134
 135    nvdimm_validate_rw_label_data(nvdimm, size, offset);
 136
 137    memcpy(nvdimm->label_data + offset, buf, size);
 138
 139    mr = host_memory_backend_get_memory(dimm->hostmem, &error_abort);
 140    backend_offset = memory_region_size(mr) - nvdimm->label_size + offset;
 141    memory_region_set_dirty(mr, backend_offset, size);
 142}
 143
 144static MemoryRegion *nvdimm_get_vmstate_memory_region(PCDIMMDevice *dimm)
 145{
 146    return host_memory_backend_get_memory(dimm->hostmem, &error_abort);
 147}
 148
 149static void nvdimm_class_init(ObjectClass *oc, void *data)
 150{
 151    PCDIMMDeviceClass *ddc = PC_DIMM_CLASS(oc);
 152    NVDIMMClass *nvc = NVDIMM_CLASS(oc);
 153
 154    ddc->realize = nvdimm_realize;
 155    ddc->get_memory_region = nvdimm_get_memory_region;
 156    ddc->get_vmstate_memory_region = nvdimm_get_vmstate_memory_region;
 157
 158    nvc->read_label_data = nvdimm_read_label_data;
 159    nvc->write_label_data = nvdimm_write_label_data;
 160}
 161
 162static TypeInfo nvdimm_info = {
 163    .name          = TYPE_NVDIMM,
 164    .parent        = TYPE_PC_DIMM,
 165    .class_size    = sizeof(NVDIMMClass),
 166    .class_init    = nvdimm_class_init,
 167    .instance_size = sizeof(NVDIMMDevice),
 168    .instance_init = nvdimm_init,
 169};
 170
 171static void nvdimm_register_types(void)
 172{
 173    type_register_static(&nvdimm_info);
 174}
 175
 176type_init(nvdimm_register_types)
 177