hw/arm: versal: Embed the ADMAs into the SoC type
[qemu/ar7.git] / backends / hostmem.c
blob327f9eebc3c7fe9236db575f75031944df14f9a9
1 /*
2 * QEMU Host Memory Backend
4 * Copyright (C) 2013-2014 Red Hat Inc
6 * Authors:
7 * Igor Mammedov <imammedo@redhat.com>
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
13 #include "qemu/osdep.h"
14 #include "sysemu/hostmem.h"
15 #include "sysemu/sysemu.h"
16 #include "hw/boards.h"
17 #include "qapi/error.h"
18 #include "qapi/qapi-builtin-visit.h"
19 #include "qapi/visitor.h"
20 #include "qemu/config-file.h"
21 #include "qom/object_interfaces.h"
22 #include "qemu/mmap-alloc.h"
24 #ifdef CONFIG_NUMA
25 #include <numaif.h>
26 QEMU_BUILD_BUG_ON(HOST_MEM_POLICY_DEFAULT != MPOL_DEFAULT);
27 QEMU_BUILD_BUG_ON(HOST_MEM_POLICY_PREFERRED != MPOL_PREFERRED);
28 QEMU_BUILD_BUG_ON(HOST_MEM_POLICY_BIND != MPOL_BIND);
29 QEMU_BUILD_BUG_ON(HOST_MEM_POLICY_INTERLEAVE != MPOL_INTERLEAVE);
30 #endif
32 char *
33 host_memory_backend_get_name(HostMemoryBackend *backend)
35 if (!backend->use_canonical_path) {
36 return object_get_canonical_path_component(OBJECT(backend));
39 return object_get_canonical_path(OBJECT(backend));
42 static void
43 host_memory_backend_get_size(Object *obj, Visitor *v, const char *name,
44 void *opaque, Error **errp)
46 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
47 uint64_t value = backend->size;
49 visit_type_size(v, name, &value, errp);
52 static void
53 host_memory_backend_set_size(Object *obj, Visitor *v, const char *name,
54 void *opaque, Error **errp)
56 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
57 Error *local_err = NULL;
58 uint64_t value;
60 if (host_memory_backend_mr_inited(backend)) {
61 error_setg(&local_err, "cannot change property %s of %s ",
62 name, object_get_typename(obj));
63 goto out;
66 visit_type_size(v, name, &value, &local_err);
67 if (local_err) {
68 goto out;
70 if (!value) {
71 error_setg(&local_err,
72 "property '%s' of %s doesn't take value '%" PRIu64 "'",
73 name, object_get_typename(obj), value);
74 goto out;
76 backend->size = value;
77 out:
78 error_propagate(errp, local_err);
81 static void
82 host_memory_backend_get_host_nodes(Object *obj, Visitor *v, const char *name,
83 void *opaque, Error **errp)
85 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
86 uint16List *host_nodes = NULL;
87 uint16List **node = &host_nodes;
88 unsigned long value;
90 value = find_first_bit(backend->host_nodes, MAX_NODES);
91 if (value == MAX_NODES) {
92 goto ret;
95 *node = g_malloc0(sizeof(**node));
96 (*node)->value = value;
97 node = &(*node)->next;
99 do {
100 value = find_next_bit(backend->host_nodes, MAX_NODES, value + 1);
101 if (value == MAX_NODES) {
102 break;
105 *node = g_malloc0(sizeof(**node));
106 (*node)->value = value;
107 node = &(*node)->next;
108 } while (true);
110 ret:
111 visit_type_uint16List(v, name, &host_nodes, errp);
114 static void
115 host_memory_backend_set_host_nodes(Object *obj, Visitor *v, const char *name,
116 void *opaque, Error **errp)
118 #ifdef CONFIG_NUMA
119 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
120 uint16List *l, *host_nodes = NULL;
122 visit_type_uint16List(v, name, &host_nodes, errp);
124 for (l = host_nodes; l; l = l->next) {
125 if (l->value >= MAX_NODES) {
126 error_setg(errp, "Invalid host-nodes value: %d", l->value);
127 goto out;
131 for (l = host_nodes; l; l = l->next) {
132 bitmap_set(backend->host_nodes, l->value, 1);
135 out:
136 qapi_free_uint16List(host_nodes);
137 #else
138 error_setg(errp, "NUMA node binding are not supported by this QEMU");
139 #endif
142 static int
143 host_memory_backend_get_policy(Object *obj, Error **errp G_GNUC_UNUSED)
145 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
146 return backend->policy;
149 static void
150 host_memory_backend_set_policy(Object *obj, int policy, Error **errp)
152 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
153 backend->policy = policy;
155 #ifndef CONFIG_NUMA
156 if (policy != HOST_MEM_POLICY_DEFAULT) {
157 error_setg(errp, "NUMA policies are not supported by this QEMU");
159 #endif
162 static bool host_memory_backend_get_merge(Object *obj, Error **errp)
164 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
166 return backend->merge;
169 static void host_memory_backend_set_merge(Object *obj, bool value, Error **errp)
171 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
173 if (!host_memory_backend_mr_inited(backend)) {
174 backend->merge = value;
175 return;
178 if (value != backend->merge) {
179 void *ptr = memory_region_get_ram_ptr(&backend->mr);
180 uint64_t sz = memory_region_size(&backend->mr);
182 qemu_madvise(ptr, sz,
183 value ? QEMU_MADV_MERGEABLE : QEMU_MADV_UNMERGEABLE);
184 backend->merge = value;
188 static bool host_memory_backend_get_dump(Object *obj, Error **errp)
190 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
192 return backend->dump;
195 static void host_memory_backend_set_dump(Object *obj, bool value, Error **errp)
197 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
199 if (!host_memory_backend_mr_inited(backend)) {
200 backend->dump = value;
201 return;
204 if (value != backend->dump) {
205 void *ptr = memory_region_get_ram_ptr(&backend->mr);
206 uint64_t sz = memory_region_size(&backend->mr);
208 qemu_madvise(ptr, sz,
209 value ? QEMU_MADV_DODUMP : QEMU_MADV_DONTDUMP);
210 backend->dump = value;
214 static bool host_memory_backend_get_prealloc(Object *obj, Error **errp)
216 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
218 return backend->prealloc;
221 static void host_memory_backend_set_prealloc(Object *obj, bool value,
222 Error **errp)
224 Error *local_err = NULL;
225 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
227 if (!host_memory_backend_mr_inited(backend)) {
228 backend->prealloc = value;
229 return;
232 if (value && !backend->prealloc) {
233 int fd = memory_region_get_fd(&backend->mr);
234 void *ptr = memory_region_get_ram_ptr(&backend->mr);
235 uint64_t sz = memory_region_size(&backend->mr);
237 os_mem_prealloc(fd, ptr, sz, backend->prealloc_threads, &local_err);
238 if (local_err) {
239 error_propagate(errp, local_err);
240 return;
242 backend->prealloc = true;
246 static void host_memory_backend_get_prealloc_threads(Object *obj, Visitor *v,
247 const char *name, void *opaque, Error **errp)
249 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
250 visit_type_uint32(v, name, &backend->prealloc_threads, errp);
253 static void host_memory_backend_set_prealloc_threads(Object *obj, Visitor *v,
254 const char *name, void *opaque, Error **errp)
256 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
257 Error *local_err = NULL;
258 uint32_t value;
260 visit_type_uint32(v, name, &value, &local_err);
261 if (local_err) {
262 goto out;
264 if (value <= 0) {
265 error_setg(&local_err,
266 "property '%s' of %s doesn't take value '%d'",
267 name, object_get_typename(obj), value);
268 goto out;
270 backend->prealloc_threads = value;
271 out:
272 error_propagate(errp, local_err);
275 static void host_memory_backend_init(Object *obj)
277 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
278 MachineState *machine = MACHINE(qdev_get_machine());
280 /* TODO: convert access to globals to compat properties */
281 backend->merge = machine_mem_merge(machine);
282 backend->dump = machine_dump_guest_core(machine);
283 backend->prealloc_threads = 1;
286 static void host_memory_backend_post_init(Object *obj)
288 object_apply_compat_props(obj);
291 bool host_memory_backend_mr_inited(HostMemoryBackend *backend)
294 * NOTE: We forbid zero-length memory backend, so here zero means
295 * "we haven't inited the backend memory region yet".
297 return memory_region_size(&backend->mr) != 0;
300 MemoryRegion *host_memory_backend_get_memory(HostMemoryBackend *backend)
302 return host_memory_backend_mr_inited(backend) ? &backend->mr : NULL;
305 void host_memory_backend_set_mapped(HostMemoryBackend *backend, bool mapped)
307 backend->is_mapped = mapped;
310 bool host_memory_backend_is_mapped(HostMemoryBackend *backend)
312 return backend->is_mapped;
315 #ifdef __linux__
316 size_t host_memory_backend_pagesize(HostMemoryBackend *memdev)
318 Object *obj = OBJECT(memdev);
319 char *path = object_property_get_str(obj, "mem-path", NULL);
320 size_t pagesize = qemu_mempath_getpagesize(path);
322 g_free(path);
323 return pagesize;
325 #else
326 size_t host_memory_backend_pagesize(HostMemoryBackend *memdev)
328 return qemu_real_host_page_size;
330 #endif
332 static void
333 host_memory_backend_memory_complete(UserCreatable *uc, Error **errp)
335 HostMemoryBackend *backend = MEMORY_BACKEND(uc);
336 HostMemoryBackendClass *bc = MEMORY_BACKEND_GET_CLASS(uc);
337 Error *local_err = NULL;
338 void *ptr;
339 uint64_t sz;
341 if (bc->alloc) {
342 bc->alloc(backend, &local_err);
343 if (local_err) {
344 goto out;
347 ptr = memory_region_get_ram_ptr(&backend->mr);
348 sz = memory_region_size(&backend->mr);
350 if (backend->merge) {
351 qemu_madvise(ptr, sz, QEMU_MADV_MERGEABLE);
353 if (!backend->dump) {
354 qemu_madvise(ptr, sz, QEMU_MADV_DONTDUMP);
356 #ifdef CONFIG_NUMA
357 unsigned long lastbit = find_last_bit(backend->host_nodes, MAX_NODES);
358 /* lastbit == MAX_NODES means maxnode = 0 */
359 unsigned long maxnode = (lastbit + 1) % (MAX_NODES + 1);
360 /* ensure policy won't be ignored in case memory is preallocated
361 * before mbind(). note: MPOL_MF_STRICT is ignored on hugepages so
362 * this doesn't catch hugepage case. */
363 unsigned flags = MPOL_MF_STRICT | MPOL_MF_MOVE;
365 /* check for invalid host-nodes and policies and give more verbose
366 * error messages than mbind(). */
367 if (maxnode && backend->policy == MPOL_DEFAULT) {
368 error_setg(errp, "host-nodes must be empty for policy default,"
369 " or you should explicitly specify a policy other"
370 " than default");
371 return;
372 } else if (maxnode == 0 && backend->policy != MPOL_DEFAULT) {
373 error_setg(errp, "host-nodes must be set for policy %s",
374 HostMemPolicy_str(backend->policy));
375 return;
378 /* We can have up to MAX_NODES nodes, but we need to pass maxnode+1
379 * as argument to mbind() due to an old Linux bug (feature?) which
380 * cuts off the last specified node. This means backend->host_nodes
381 * must have MAX_NODES+1 bits available.
383 assert(sizeof(backend->host_nodes) >=
384 BITS_TO_LONGS(MAX_NODES + 1) * sizeof(unsigned long));
385 assert(maxnode <= MAX_NODES);
386 if (mbind(ptr, sz, backend->policy,
387 maxnode ? backend->host_nodes : NULL, maxnode + 1, flags)) {
388 if (backend->policy != MPOL_DEFAULT || errno != ENOSYS) {
389 error_setg_errno(errp, errno,
390 "cannot bind memory to host NUMA nodes");
391 return;
394 #endif
395 /* Preallocate memory after the NUMA policy has been instantiated.
396 * This is necessary to guarantee memory is allocated with
397 * specified NUMA policy in place.
399 if (backend->prealloc) {
400 os_mem_prealloc(memory_region_get_fd(&backend->mr), ptr, sz,
401 backend->prealloc_threads, &local_err);
402 if (local_err) {
403 goto out;
407 out:
408 error_propagate(errp, local_err);
411 static bool
412 host_memory_backend_can_be_deleted(UserCreatable *uc)
414 if (host_memory_backend_is_mapped(MEMORY_BACKEND(uc))) {
415 return false;
416 } else {
417 return true;
421 static bool host_memory_backend_get_share(Object *o, Error **errp)
423 HostMemoryBackend *backend = MEMORY_BACKEND(o);
425 return backend->share;
428 static void host_memory_backend_set_share(Object *o, bool value, Error **errp)
430 HostMemoryBackend *backend = MEMORY_BACKEND(o);
432 if (host_memory_backend_mr_inited(backend)) {
433 error_setg(errp, "cannot change property value");
434 return;
436 backend->share = value;
439 static bool
440 host_memory_backend_get_use_canonical_path(Object *obj, Error **errp)
442 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
444 return backend->use_canonical_path;
447 static void
448 host_memory_backend_set_use_canonical_path(Object *obj, bool value,
449 Error **errp)
451 HostMemoryBackend *backend = MEMORY_BACKEND(obj);
453 backend->use_canonical_path = value;
456 static void
457 host_memory_backend_class_init(ObjectClass *oc, void *data)
459 UserCreatableClass *ucc = USER_CREATABLE_CLASS(oc);
461 ucc->complete = host_memory_backend_memory_complete;
462 ucc->can_be_deleted = host_memory_backend_can_be_deleted;
464 object_class_property_add_bool(oc, "merge",
465 host_memory_backend_get_merge,
466 host_memory_backend_set_merge, &error_abort);
467 object_class_property_set_description(oc, "merge",
468 "Mark memory as mergeable", &error_abort);
469 object_class_property_add_bool(oc, "dump",
470 host_memory_backend_get_dump,
471 host_memory_backend_set_dump, &error_abort);
472 object_class_property_set_description(oc, "dump",
473 "Set to 'off' to exclude from core dump", &error_abort);
474 object_class_property_add_bool(oc, "prealloc",
475 host_memory_backend_get_prealloc,
476 host_memory_backend_set_prealloc, &error_abort);
477 object_class_property_set_description(oc, "prealloc",
478 "Preallocate memory", &error_abort);
479 object_class_property_add(oc, "prealloc-threads", "int",
480 host_memory_backend_get_prealloc_threads,
481 host_memory_backend_set_prealloc_threads,
482 NULL, NULL, &error_abort);
483 object_class_property_set_description(oc, "prealloc-threads",
484 "Number of CPU threads to use for prealloc", &error_abort);
485 object_class_property_add(oc, "size", "int",
486 host_memory_backend_get_size,
487 host_memory_backend_set_size,
488 NULL, NULL, &error_abort);
489 object_class_property_set_description(oc, "size",
490 "Size of the memory region (ex: 500M)", &error_abort);
491 object_class_property_add(oc, "host-nodes", "int",
492 host_memory_backend_get_host_nodes,
493 host_memory_backend_set_host_nodes,
494 NULL, NULL, &error_abort);
495 object_class_property_set_description(oc, "host-nodes",
496 "Binds memory to the list of NUMA host nodes", &error_abort);
497 object_class_property_add_enum(oc, "policy", "HostMemPolicy",
498 &HostMemPolicy_lookup,
499 host_memory_backend_get_policy,
500 host_memory_backend_set_policy, &error_abort);
501 object_class_property_set_description(oc, "policy",
502 "Set the NUMA policy", &error_abort);
503 object_class_property_add_bool(oc, "share",
504 host_memory_backend_get_share, host_memory_backend_set_share,
505 &error_abort);
506 object_class_property_set_description(oc, "share",
507 "Mark the memory as private to QEMU or shared", &error_abort);
508 object_class_property_add_bool(oc, "x-use-canonical-path-for-ramblock-id",
509 host_memory_backend_get_use_canonical_path,
510 host_memory_backend_set_use_canonical_path, &error_abort);
513 static const TypeInfo host_memory_backend_info = {
514 .name = TYPE_MEMORY_BACKEND,
515 .parent = TYPE_OBJECT,
516 .abstract = true,
517 .class_size = sizeof(HostMemoryBackendClass),
518 .class_init = host_memory_backend_class_init,
519 .instance_size = sizeof(HostMemoryBackend),
520 .instance_init = host_memory_backend_init,
521 .instance_post_init = host_memory_backend_post_init,
522 .interfaces = (InterfaceInfo[]) {
523 { TYPE_USER_CREATABLE },
528 static void register_types(void)
530 type_register_static(&host_memory_backend_info);
533 type_init(register_types);