2 * Physical memory management API
4 * Copyright 2011 Red Hat, Inc. and/or its affiliates
7 * Avi Kivity <avi@redhat.com>
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
17 #ifndef CONFIG_USER_ONLY
19 #include "exec/cpu-common.h"
20 #include "exec/hwaddr.h"
21 #include "exec/memattrs.h"
22 #include "exec/ramlist.h"
23 #include "qemu/queue.h"
24 #include "qemu/int128.h"
25 #include "qemu/notify.h"
26 #include "qom/object.h"
28 #include "hw/qdev-core.h"
30 #define RAM_ADDR_INVALID (~(ram_addr_t)0)
32 #define MAX_PHYS_ADDR_SPACE_BITS 62
33 #define MAX_PHYS_ADDR (((hwaddr)1 << MAX_PHYS_ADDR_SPACE_BITS) - 1)
35 #define TYPE_MEMORY_REGION "qemu:memory-region"
36 #define MEMORY_REGION(obj) \
37 OBJECT_CHECK(MemoryRegion, (obj), TYPE_MEMORY_REGION)
39 #define TYPE_IOMMU_MEMORY_REGION "qemu:iommu-memory-region"
40 #define IOMMU_MEMORY_REGION(obj) \
41 OBJECT_CHECK(IOMMUMemoryRegion, (obj), TYPE_IOMMU_MEMORY_REGION)
42 #define IOMMU_MEMORY_REGION_CLASS(klass) \
43 OBJECT_CLASS_CHECK(IOMMUMemoryRegionClass, (klass), \
44 TYPE_IOMMU_MEMORY_REGION)
45 #define IOMMU_MEMORY_REGION_GET_CLASS(obj) \
46 OBJECT_GET_CLASS(IOMMUMemoryRegionClass, (obj), \
47 TYPE_IOMMU_MEMORY_REGION)
49 typedef struct MemoryRegionOps MemoryRegionOps
;
50 typedef struct MemoryRegionMmio MemoryRegionMmio
;
52 struct MemoryRegionMmio
{
53 CPUReadMemoryFunc
*read
[3];
54 CPUWriteMemoryFunc
*write
[3];
57 typedef struct IOMMUTLBEntry IOMMUTLBEntry
;
59 /* See address_space_translate: bit 0 is read, bit 1 is write. */
67 #define IOMMU_ACCESS_FLAG(r, w) (((r) ? IOMMU_RO : 0) | ((w) ? IOMMU_WO : 0))
69 struct IOMMUTLBEntry
{
70 AddressSpace
*target_as
;
72 hwaddr translated_addr
;
73 hwaddr addr_mask
; /* 0xfff = 4k translation */
74 IOMMUAccessFlags perm
;
78 * Bitmap for different IOMMUNotifier capabilities. Each notifier can
79 * register with one or multiple IOMMU Notifier capability bit(s).
82 IOMMU_NOTIFIER_NONE
= 0,
83 /* Notify cache invalidations */
84 IOMMU_NOTIFIER_UNMAP
= 0x1,
85 /* Notify entry changes (newly created entries) */
86 IOMMU_NOTIFIER_MAP
= 0x2,
89 #define IOMMU_NOTIFIER_ALL (IOMMU_NOTIFIER_MAP | IOMMU_NOTIFIER_UNMAP)
92 typedef void (*IOMMUNotify
)(struct IOMMUNotifier
*notifier
,
95 struct IOMMUNotifier
{
97 IOMMUNotifierFlag notifier_flags
;
98 /* Notify for address space range start <= addr <= end */
102 QLIST_ENTRY(IOMMUNotifier
) node
;
104 typedef struct IOMMUNotifier IOMMUNotifier
;
106 /* RAM is pre-allocated and passed into qemu_ram_alloc_from_ptr */
107 #define RAM_PREALLOC (1 << 0)
109 /* RAM is mmap-ed with MAP_SHARED */
110 #define RAM_SHARED (1 << 1)
112 /* Only a portion of RAM (used_length) is actually used, and migrated.
113 * This used_length size can change across reboots.
115 #define RAM_RESIZEABLE (1 << 2)
117 /* UFFDIO_ZEROPAGE is available on this RAMBlock to atomically
118 * zero the page and wake waiting processes.
119 * (Set during postcopy)
121 #define RAM_UF_ZEROPAGE (1 << 3)
123 /* RAM can be migrated */
124 #define RAM_MIGRATABLE (1 << 4)
126 /* RAM is a persistent kind memory */
127 #define RAM_PMEM (1 << 5)
129 static inline void iommu_notifier_init(IOMMUNotifier
*n
, IOMMUNotify fn
,
130 IOMMUNotifierFlag flags
,
131 hwaddr start
, hwaddr end
,
135 n
->notifier_flags
= flags
;
138 n
->iommu_idx
= iommu_idx
;
142 * Memory region callbacks
144 struct MemoryRegionOps
{
145 /* Read from the memory region. @addr is relative to @mr; @size is
147 uint64_t (*read
)(void *opaque
,
150 /* Write to the memory region. @addr is relative to @mr; @size is
152 void (*write
)(void *opaque
,
157 MemTxResult (*read_with_attrs
)(void *opaque
,
162 MemTxResult (*write_with_attrs
)(void *opaque
,
168 enum device_endian endianness
;
169 /* Guest-visible constraints: */
171 /* If nonzero, specify bounds on access sizes beyond which a machine
174 unsigned min_access_size
;
175 unsigned max_access_size
;
176 /* If true, unaligned accesses are supported. Otherwise unaligned
177 * accesses throw machine checks.
181 * If present, and returns #false, the transaction is not accepted
182 * by the device (and results in machine dependent behaviour such
183 * as a machine check exception).
185 bool (*accepts
)(void *opaque
, hwaddr addr
,
186 unsigned size
, bool is_write
,
189 /* Internal implementation constraints: */
191 /* If nonzero, specifies the minimum size implemented. Smaller sizes
192 * will be rounded upwards and a partial result will be returned.
194 unsigned min_access_size
;
195 /* If nonzero, specifies the maximum size implemented. Larger sizes
196 * will be done as a series of accesses with smaller sizes.
198 unsigned max_access_size
;
199 /* If true, unaligned accesses are supported. Otherwise all accesses
200 * are converted to (possibly multiple) naturally aligned accesses.
206 enum IOMMUMemoryRegionAttr
{
207 IOMMU_ATTR_SPAPR_TCE_FD
211 * IOMMUMemoryRegionClass:
213 * All IOMMU implementations need to subclass TYPE_IOMMU_MEMORY_REGION
214 * and provide an implementation of at least the @translate method here
215 * to handle requests to the memory region. Other methods are optional.
217 * The IOMMU implementation must use the IOMMU notifier infrastructure
218 * to report whenever mappings are changed, by calling
219 * memory_region_notify_iommu() (or, if necessary, by calling
220 * memory_region_notify_one() for each registered notifier).
222 * Conceptually an IOMMU provides a mapping from input address
223 * to an output TLB entry. If the IOMMU is aware of memory transaction
224 * attributes and the output TLB entry depends on the transaction
225 * attributes, we represent this using IOMMU indexes. Each index
226 * selects a particular translation table that the IOMMU has:
227 * @attrs_to_index returns the IOMMU index for a set of transaction attributes
228 * @translate takes an input address and an IOMMU index
229 * and the mapping returned can only depend on the input address and the
232 * Most IOMMUs don't care about the transaction attributes and support
233 * only a single IOMMU index. A more complex IOMMU might have one index
234 * for secure transactions and one for non-secure transactions.
236 typedef struct IOMMUMemoryRegionClass
{
238 struct DeviceClass parent_class
;
241 * Return a TLB entry that contains a given address.
243 * The IOMMUAccessFlags indicated via @flag are optional and may
244 * be specified as IOMMU_NONE to indicate that the caller needs
245 * the full translation information for both reads and writes. If
246 * the access flags are specified then the IOMMU implementation
247 * may use this as an optimization, to stop doing a page table
248 * walk as soon as it knows that the requested permissions are not
249 * allowed. If IOMMU_NONE is passed then the IOMMU must do the
250 * full page table walk and report the permissions in the returned
251 * IOMMUTLBEntry. (Note that this implies that an IOMMU may not
252 * return different mappings for reads and writes.)
254 * The returned information remains valid while the caller is
255 * holding the big QEMU lock or is inside an RCU critical section;
256 * if the caller wishes to cache the mapping beyond that it must
257 * register an IOMMU notifier so it can invalidate its cached
258 * information when the IOMMU mapping changes.
260 * @iommu: the IOMMUMemoryRegion
261 * @hwaddr: address to be translated within the memory region
262 * @flag: requested access permissions
263 * @iommu_idx: IOMMU index for the translation
265 IOMMUTLBEntry (*translate
)(IOMMUMemoryRegion
*iommu
, hwaddr addr
,
266 IOMMUAccessFlags flag
, int iommu_idx
);
267 /* Returns minimum supported page size in bytes.
268 * If this method is not provided then the minimum is assumed to
269 * be TARGET_PAGE_SIZE.
271 * @iommu: the IOMMUMemoryRegion
273 uint64_t (*get_min_page_size
)(IOMMUMemoryRegion
*iommu
);
274 /* Called when IOMMU Notifier flag changes (ie when the set of
275 * events which IOMMU users are requesting notification for changes).
276 * Optional method -- need not be provided if the IOMMU does not
277 * need to know exactly which events must be notified.
279 * @iommu: the IOMMUMemoryRegion
280 * @old_flags: events which previously needed to be notified
281 * @new_flags: events which now need to be notified
283 void (*notify_flag_changed
)(IOMMUMemoryRegion
*iommu
,
284 IOMMUNotifierFlag old_flags
,
285 IOMMUNotifierFlag new_flags
);
286 /* Called to handle memory_region_iommu_replay().
288 * The default implementation of memory_region_iommu_replay() is to
289 * call the IOMMU translate method for every page in the address space
290 * with flag == IOMMU_NONE and then call the notifier if translate
291 * returns a valid mapping. If this method is implemented then it
292 * overrides the default behaviour, and must provide the full semantics
293 * of memory_region_iommu_replay(), by calling @notifier for every
294 * translation present in the IOMMU.
296 * Optional method -- an IOMMU only needs to provide this method
297 * if the default is inefficient or produces undesirable side effects.
299 * Note: this is not related to record-and-replay functionality.
301 void (*replay
)(IOMMUMemoryRegion
*iommu
, IOMMUNotifier
*notifier
);
303 /* Get IOMMU misc attributes. This is an optional method that
304 * can be used to allow users of the IOMMU to get implementation-specific
305 * information. The IOMMU implements this method to handle calls
306 * by IOMMU users to memory_region_iommu_get_attr() by filling in
307 * the arbitrary data pointer for any IOMMUMemoryRegionAttr values that
308 * the IOMMU supports. If the method is unimplemented then
309 * memory_region_iommu_get_attr() will always return -EINVAL.
311 * @iommu: the IOMMUMemoryRegion
312 * @attr: attribute being queried
313 * @data: memory to fill in with the attribute data
315 * Returns 0 on success, or a negative errno; in particular
316 * returns -EINVAL for unrecognized or unimplemented attribute types.
318 int (*get_attr
)(IOMMUMemoryRegion
*iommu
, enum IOMMUMemoryRegionAttr attr
,
321 /* Return the IOMMU index to use for a given set of transaction attributes.
323 * Optional method: if an IOMMU only supports a single IOMMU index then
324 * the default implementation of memory_region_iommu_attrs_to_index()
327 * The indexes supported by an IOMMU must be contiguous, starting at 0.
329 * @iommu: the IOMMUMemoryRegion
330 * @attrs: memory transaction attributes
332 int (*attrs_to_index
)(IOMMUMemoryRegion
*iommu
, MemTxAttrs attrs
);
334 /* Return the number of IOMMU indexes this IOMMU supports.
336 * Optional method: if this method is not provided, then
337 * memory_region_iommu_num_indexes() will return 1, indicating that
338 * only a single IOMMU index is supported.
340 * @iommu: the IOMMUMemoryRegion
342 int (*num_indexes
)(IOMMUMemoryRegion
*iommu
);
343 } IOMMUMemoryRegionClass
;
345 typedef struct CoalescedMemoryRange CoalescedMemoryRange
;
346 typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd
;
348 struct MemoryRegion
{
351 /* All fields are private - violators will be prosecuted */
353 /* The following fields should fit in a cache line */
357 bool readonly
; /* For RAM regions */
360 bool flush_coalesced_mmio
;
362 uint8_t dirty_log_mask
;
367 const MemoryRegionOps
*ops
;
369 MemoryRegion
*container
;
372 void (*destructor
)(MemoryRegion
*mr
);
377 bool warning_printed
; /* For reservations */
378 uint8_t vga_logging_count
;
382 QTAILQ_HEAD(, MemoryRegion
) subregions
;
383 QTAILQ_ENTRY(MemoryRegion
) subregions_link
;
384 QTAILQ_HEAD(, CoalescedMemoryRange
) coalesced
;
386 unsigned ioeventfd_nb
;
387 MemoryRegionIoeventfd
*ioeventfds
;
390 struct IOMMUMemoryRegion
{
391 MemoryRegion parent_obj
;
393 QLIST_HEAD(, IOMMUNotifier
) iommu_notify
;
394 IOMMUNotifierFlag iommu_notify_flags
;
397 #define IOMMU_NOTIFIER_FOREACH(n, mr) \
398 QLIST_FOREACH((n), &(mr)->iommu_notify, node)
401 * MemoryListener: callbacks structure for updates to the physical memory map
403 * Allows a component to adjust to changes in the guest-visible memory map.
404 * Use with memory_listener_register() and memory_listener_unregister().
406 struct MemoryListener
{
407 void (*begin
)(MemoryListener
*listener
);
408 void (*commit
)(MemoryListener
*listener
);
409 void (*region_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
410 void (*region_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
411 void (*region_nop
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
412 void (*log_start
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
414 void (*log_stop
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
416 void (*log_sync
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
417 void (*log_global_start
)(MemoryListener
*listener
);
418 void (*log_global_stop
)(MemoryListener
*listener
);
419 void (*eventfd_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
420 bool match_data
, uint64_t data
, EventNotifier
*e
);
421 void (*eventfd_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
422 bool match_data
, uint64_t data
, EventNotifier
*e
);
423 void (*coalesced_io_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
424 hwaddr addr
, hwaddr len
);
425 void (*coalesced_io_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
426 hwaddr addr
, hwaddr len
);
427 /* Lower = earlier (during add), later (during del) */
429 AddressSpace
*address_space
;
430 QTAILQ_ENTRY(MemoryListener
) link
;
431 QTAILQ_ENTRY(MemoryListener
) link_as
;
435 * AddressSpace: describes a mapping of addresses to #MemoryRegion objects
437 struct AddressSpace
{
438 /* All fields are private. */
443 /* Accessed via RCU. */
444 struct FlatView
*current_map
;
447 struct MemoryRegionIoeventfd
*ioeventfds
;
448 QTAILQ_HEAD(, MemoryListener
) listeners
;
449 QTAILQ_ENTRY(AddressSpace
) address_spaces_link
;
452 typedef struct AddressSpaceDispatch AddressSpaceDispatch
;
453 typedef struct FlatRange FlatRange
;
455 /* Flattened global view of current active memory hierarchy. Kept in sorted
463 unsigned nr_allocated
;
464 struct AddressSpaceDispatch
*dispatch
;
468 static inline FlatView
*address_space_to_flatview(AddressSpace
*as
)
470 return atomic_rcu_read(&as
->current_map
);
475 * MemoryRegionSection: describes a fragment of a #MemoryRegion
477 * @mr: the region, or %NULL if empty
478 * @fv: the flat view of the address space the region is mapped in
479 * @offset_within_region: the beginning of the section, relative to @mr's start
480 * @size: the size of the section; will not exceed @mr's boundaries
481 * @offset_within_address_space: the address of the first byte of the section
482 * relative to the region's address space
483 * @readonly: writes to this section are ignored
484 * @nonvolatile: this section is non-volatile
486 struct MemoryRegionSection
{
489 hwaddr offset_within_region
;
491 hwaddr offset_within_address_space
;
497 * memory_region_init: Initialize a memory region
499 * The region typically acts as a container for other memory regions. Use
500 * memory_region_add_subregion() to add subregions.
502 * @mr: the #MemoryRegion to be initialized
503 * @owner: the object that tracks the region's reference count
504 * @name: used for debugging; not visible to the user or ABI
505 * @size: size of the region; any subregions beyond this size will be clipped
507 void memory_region_init(MemoryRegion
*mr
,
508 struct Object
*owner
,
513 * memory_region_ref: Add 1 to a memory region's reference count
515 * Whenever memory regions are accessed outside the BQL, they need to be
516 * preserved against hot-unplug. MemoryRegions actually do not have their
517 * own reference count; they piggyback on a QOM object, their "owner".
518 * This function adds a reference to the owner.
520 * All MemoryRegions must have an owner if they can disappear, even if the
521 * device they belong to operates exclusively under the BQL. This is because
522 * the region could be returned at any time by memory_region_find, and this
523 * is usually under guest control.
525 * @mr: the #MemoryRegion
527 void memory_region_ref(MemoryRegion
*mr
);
530 * memory_region_unref: Remove 1 to a memory region's reference count
532 * Whenever memory regions are accessed outside the BQL, they need to be
533 * preserved against hot-unplug. MemoryRegions actually do not have their
534 * own reference count; they piggyback on a QOM object, their "owner".
535 * This function removes a reference to the owner and possibly destroys it.
537 * @mr: the #MemoryRegion
539 void memory_region_unref(MemoryRegion
*mr
);
542 * memory_region_init_io: Initialize an I/O memory region.
544 * Accesses into the region will cause the callbacks in @ops to be called.
545 * if @size is nonzero, subregions will be clipped to @size.
547 * @mr: the #MemoryRegion to be initialized.
548 * @owner: the object that tracks the region's reference count
549 * @ops: a structure containing read and write callbacks to be used when
550 * I/O is performed on the region.
551 * @opaque: passed to the read and write callbacks of the @ops structure.
552 * @name: used for debugging; not visible to the user or ABI
553 * @size: size of the region.
555 void memory_region_init_io(MemoryRegion
*mr
,
556 struct Object
*owner
,
557 const MemoryRegionOps
*ops
,
563 * memory_region_init_ram_nomigrate: Initialize RAM memory region. Accesses
564 * into the region will modify memory
567 * @mr: the #MemoryRegion to be initialized.
568 * @owner: the object that tracks the region's reference count
569 * @name: Region name, becomes part of RAMBlock name used in migration stream
570 * must be unique within any device
571 * @size: size of the region.
572 * @errp: pointer to Error*, to store an error if it happens.
574 * Note that this function does not do anything to cause the data in the
575 * RAM memory region to be migrated; that is the responsibility of the caller.
577 void memory_region_init_ram_nomigrate(MemoryRegion
*mr
,
578 struct Object
*owner
,
584 * memory_region_init_ram_shared_nomigrate: Initialize RAM memory region.
585 * Accesses into the region will
586 * modify memory directly.
588 * @mr: the #MemoryRegion to be initialized.
589 * @owner: the object that tracks the region's reference count
590 * @name: Region name, becomes part of RAMBlock name used in migration stream
591 * must be unique within any device
592 * @size: size of the region.
593 * @share: allow remapping RAM to different addresses
594 * @errp: pointer to Error*, to store an error if it happens.
596 * Note that this function is similar to memory_region_init_ram_nomigrate.
597 * The only difference is part of the RAM region can be remapped.
599 void memory_region_init_ram_shared_nomigrate(MemoryRegion
*mr
,
600 struct Object
*owner
,
607 * memory_region_init_resizeable_ram: Initialize memory region with resizeable
608 * RAM. Accesses into the region will
609 * modify memory directly. Only an initial
610 * portion of this RAM is actually used.
611 * The used size can change across reboots.
613 * @mr: the #MemoryRegion to be initialized.
614 * @owner: the object that tracks the region's reference count
615 * @name: Region name, becomes part of RAMBlock name used in migration stream
616 * must be unique within any device
617 * @size: used size of the region.
618 * @max_size: max size of the region.
619 * @resized: callback to notify owner about used size change.
620 * @errp: pointer to Error*, to store an error if it happens.
622 * Note that this function does not do anything to cause the data in the
623 * RAM memory region to be migrated; that is the responsibility of the caller.
625 void memory_region_init_resizeable_ram(MemoryRegion
*mr
,
626 struct Object
*owner
,
630 void (*resized
)(const char*,
637 * memory_region_init_ram_from_file: Initialize RAM memory region with a
640 * @mr: the #MemoryRegion to be initialized.
641 * @owner: the object that tracks the region's reference count
642 * @name: Region name, becomes part of RAMBlock name used in migration stream
643 * must be unique within any device
644 * @size: size of the region.
645 * @align: alignment of the region base address; if 0, the default alignment
646 * (getpagesize()) will be used.
647 * @ram_flags: Memory region features:
648 * - RAM_SHARED: memory must be mmaped with the MAP_SHARED flag
649 * - RAM_PMEM: the memory is persistent memory
650 * Other bits are ignored now.
651 * @path: the path in which to allocate the RAM.
652 * @errp: pointer to Error*, to store an error if it happens.
654 * Note that this function does not do anything to cause the data in the
655 * RAM memory region to be migrated; that is the responsibility of the caller.
657 void memory_region_init_ram_from_file(MemoryRegion
*mr
,
658 struct Object
*owner
,
667 * memory_region_init_ram_from_fd: Initialize RAM memory region with a
670 * @mr: the #MemoryRegion to be initialized.
671 * @owner: the object that tracks the region's reference count
672 * @name: the name of the region.
673 * @size: size of the region.
674 * @share: %true if memory must be mmaped with the MAP_SHARED flag
675 * @fd: the fd to mmap.
676 * @errp: pointer to Error*, to store an error if it happens.
678 * Note that this function does not do anything to cause the data in the
679 * RAM memory region to be migrated; that is the responsibility of the caller.
681 void memory_region_init_ram_from_fd(MemoryRegion
*mr
,
682 struct Object
*owner
,
691 * memory_region_init_ram_ptr: Initialize RAM memory region from a
692 * user-provided pointer. Accesses into the
693 * region will modify memory directly.
695 * @mr: the #MemoryRegion to be initialized.
696 * @owner: the object that tracks the region's reference count
697 * @name: Region name, becomes part of RAMBlock name used in migration stream
698 * must be unique within any device
699 * @size: size of the region.
700 * @ptr: memory to be mapped; must contain at least @size bytes.
702 * Note that this function does not do anything to cause the data in the
703 * RAM memory region to be migrated; that is the responsibility of the caller.
705 void memory_region_init_ram_ptr(MemoryRegion
*mr
,
706 struct Object
*owner
,
712 * memory_region_init_ram_device_ptr: Initialize RAM device memory region from
713 * a user-provided pointer.
715 * A RAM device represents a mapping to a physical device, such as to a PCI
716 * MMIO BAR of an vfio-pci assigned device. The memory region may be mapped
717 * into the VM address space and access to the region will modify memory
718 * directly. However, the memory region should not be included in a memory
719 * dump (device may not be enabled/mapped at the time of the dump), and
720 * operations incompatible with manipulating MMIO should be avoided. Replaces
723 * @mr: the #MemoryRegion to be initialized.
724 * @owner: the object that tracks the region's reference count
725 * @name: the name of the region.
726 * @size: size of the region.
727 * @ptr: memory to be mapped; must contain at least @size bytes.
729 * Note that this function does not do anything to cause the data in the
730 * RAM memory region to be migrated; that is the responsibility of the caller.
731 * (For RAM device memory regions, migrating the contents rarely makes sense.)
733 void memory_region_init_ram_device_ptr(MemoryRegion
*mr
,
734 struct Object
*owner
,
740 * memory_region_init_alias: Initialize a memory region that aliases all or a
741 * part of another memory region.
743 * @mr: the #MemoryRegion to be initialized.
744 * @owner: the object that tracks the region's reference count
745 * @name: used for debugging; not visible to the user or ABI
746 * @orig: the region to be referenced; @mr will be equivalent to
747 * @orig between @offset and @offset + @size - 1.
748 * @offset: start of the section in @orig to be referenced.
749 * @size: size of the region.
751 void memory_region_init_alias(MemoryRegion
*mr
,
752 struct Object
*owner
,
759 * memory_region_init_rom_nomigrate: Initialize a ROM memory region.
761 * This has the same effect as calling memory_region_init_ram_nomigrate()
762 * and then marking the resulting region read-only with
763 * memory_region_set_readonly().
765 * Note that this function does not do anything to cause the data in the
766 * RAM side of the memory region to be migrated; that is the responsibility
769 * @mr: the #MemoryRegion to be initialized.
770 * @owner: the object that tracks the region's reference count
771 * @name: Region name, becomes part of RAMBlock name used in migration stream
772 * must be unique within any device
773 * @size: size of the region.
774 * @errp: pointer to Error*, to store an error if it happens.
776 void memory_region_init_rom_nomigrate(MemoryRegion
*mr
,
777 struct Object
*owner
,
783 * memory_region_init_rom_device_nomigrate: Initialize a ROM memory region.
784 * Writes are handled via callbacks.
786 * Note that this function does not do anything to cause the data in the
787 * RAM side of the memory region to be migrated; that is the responsibility
790 * @mr: the #MemoryRegion to be initialized.
791 * @owner: the object that tracks the region's reference count
792 * @ops: callbacks for write access handling (must not be NULL).
793 * @opaque: passed to the read and write callbacks of the @ops structure.
794 * @name: Region name, becomes part of RAMBlock name used in migration stream
795 * must be unique within any device
796 * @size: size of the region.
797 * @errp: pointer to Error*, to store an error if it happens.
799 void memory_region_init_rom_device_nomigrate(MemoryRegion
*mr
,
800 struct Object
*owner
,
801 const MemoryRegionOps
*ops
,
808 * memory_region_init_iommu: Initialize a memory region of a custom type
809 * that translates addresses
811 * An IOMMU region translates addresses and forwards accesses to a target
814 * The IOMMU implementation must define a subclass of TYPE_IOMMU_MEMORY_REGION.
815 * @_iommu_mr should be a pointer to enough memory for an instance of
816 * that subclass, @instance_size is the size of that subclass, and
817 * @mrtypename is its name. This function will initialize @_iommu_mr as an
818 * instance of the subclass, and its methods will then be called to handle
819 * accesses to the memory region. See the documentation of
820 * #IOMMUMemoryRegionClass for further details.
822 * @_iommu_mr: the #IOMMUMemoryRegion to be initialized
823 * @instance_size: the IOMMUMemoryRegion subclass instance size
824 * @mrtypename: the type name of the #IOMMUMemoryRegion
825 * @owner: the object that tracks the region's reference count
826 * @name: used for debugging; not visible to the user or ABI
827 * @size: size of the region.
829 void memory_region_init_iommu(void *_iommu_mr
,
830 size_t instance_size
,
831 const char *mrtypename
,
837 * memory_region_init_ram - Initialize RAM memory region. Accesses into the
838 * region will modify memory directly.
840 * @mr: the #MemoryRegion to be initialized
841 * @owner: the object that tracks the region's reference count (must be
842 * TYPE_DEVICE or a subclass of TYPE_DEVICE, or NULL)
843 * @name: name of the memory region
844 * @size: size of the region in bytes
845 * @errp: pointer to Error*, to store an error if it happens.
847 * This function allocates RAM for a board model or device, and
848 * arranges for it to be migrated (by calling vmstate_register_ram()
849 * if @owner is a DeviceState, or vmstate_register_ram_global() if
852 * TODO: Currently we restrict @owner to being either NULL (for
853 * global RAM regions with no owner) or devices, so that we can
854 * give the RAM block a unique name for migration purposes.
855 * We should lift this restriction and allow arbitrary Objects.
856 * If you pass a non-NULL non-device @owner then we will assert.
858 void memory_region_init_ram(MemoryRegion
*mr
,
859 struct Object
*owner
,
865 * memory_region_init_rom: Initialize a ROM memory region.
867 * This has the same effect as calling memory_region_init_ram()
868 * and then marking the resulting region read-only with
869 * memory_region_set_readonly(). This includes arranging for the
870 * contents to be migrated.
872 * TODO: Currently we restrict @owner to being either NULL (for
873 * global RAM regions with no owner) or devices, so that we can
874 * give the RAM block a unique name for migration purposes.
875 * We should lift this restriction and allow arbitrary Objects.
876 * If you pass a non-NULL non-device @owner then we will assert.
878 * @mr: the #MemoryRegion to be initialized.
879 * @owner: the object that tracks the region's reference count
880 * @name: Region name, becomes part of RAMBlock name used in migration stream
881 * must be unique within any device
882 * @size: size of the region.
883 * @errp: pointer to Error*, to store an error if it happens.
885 void memory_region_init_rom(MemoryRegion
*mr
,
886 struct Object
*owner
,
892 * memory_region_init_rom_device: Initialize a ROM memory region.
893 * Writes are handled via callbacks.
895 * This function initializes a memory region backed by RAM for reads
896 * and callbacks for writes, and arranges for the RAM backing to
897 * be migrated (by calling vmstate_register_ram()
898 * if @owner is a DeviceState, or vmstate_register_ram_global() if
901 * TODO: Currently we restrict @owner to being either NULL (for
902 * global RAM regions with no owner) or devices, so that we can
903 * give the RAM block a unique name for migration purposes.
904 * We should lift this restriction and allow arbitrary Objects.
905 * If you pass a non-NULL non-device @owner then we will assert.
907 * @mr: the #MemoryRegion to be initialized.
908 * @owner: the object that tracks the region's reference count
909 * @ops: callbacks for write access handling (must not be NULL).
910 * @name: Region name, becomes part of RAMBlock name used in migration stream
911 * must be unique within any device
912 * @size: size of the region.
913 * @errp: pointer to Error*, to store an error if it happens.
915 void memory_region_init_rom_device(MemoryRegion
*mr
,
916 struct Object
*owner
,
917 const MemoryRegionOps
*ops
,
925 * memory_region_owner: get a memory region's owner.
927 * @mr: the memory region being queried.
929 struct Object
*memory_region_owner(MemoryRegion
*mr
);
932 * memory_region_size: get a memory region's size.
934 * @mr: the memory region being queried.
936 uint64_t memory_region_size(MemoryRegion
*mr
);
939 * memory_region_is_ram: check whether a memory region is random access
941 * Returns %true if a memory region is random access.
943 * @mr: the memory region being queried
945 static inline bool memory_region_is_ram(MemoryRegion
*mr
)
951 * memory_region_is_ram_device: check whether a memory region is a ram device
953 * Returns %true if a memory region is a device backed ram region
955 * @mr: the memory region being queried
957 bool memory_region_is_ram_device(MemoryRegion
*mr
);
960 * memory_region_is_romd: check whether a memory region is in ROMD mode
962 * Returns %true if a memory region is a ROM device and currently set to allow
965 * @mr: the memory region being queried
967 static inline bool memory_region_is_romd(MemoryRegion
*mr
)
969 return mr
->rom_device
&& mr
->romd_mode
;
973 * memory_region_get_iommu: check whether a memory region is an iommu
975 * Returns pointer to IOMMUMemoryRegion if a memory region is an iommu,
978 * @mr: the memory region being queried
980 static inline IOMMUMemoryRegion
*memory_region_get_iommu(MemoryRegion
*mr
)
983 return memory_region_get_iommu(mr
->alias
);
986 return (IOMMUMemoryRegion
*) mr
;
992 * memory_region_get_iommu_class_nocheck: returns iommu memory region class
993 * if an iommu or NULL if not
995 * Returns pointer to IOMMUMemoryRegionClass if a memory region is an iommu,
996 * otherwise NULL. This is fast path avoiding QOM checking, use with caution.
998 * @mr: the memory region being queried
1000 static inline IOMMUMemoryRegionClass
*memory_region_get_iommu_class_nocheck(
1001 IOMMUMemoryRegion
*iommu_mr
)
1003 return (IOMMUMemoryRegionClass
*) (((Object
*)iommu_mr
)->class);
1006 #define memory_region_is_iommu(mr) (memory_region_get_iommu(mr) != NULL)
1009 * memory_region_iommu_get_min_page_size: get minimum supported page size
1012 * Returns minimum supported page size for an iommu.
1014 * @iommu_mr: the memory region being queried
1016 uint64_t memory_region_iommu_get_min_page_size(IOMMUMemoryRegion
*iommu_mr
);
1019 * memory_region_notify_iommu: notify a change in an IOMMU translation entry.
1021 * The notification type will be decided by entry.perm bits:
1023 * - For UNMAP (cache invalidation) notifies: set entry.perm to IOMMU_NONE.
1024 * - For MAP (newly added entry) notifies: set entry.perm to the
1025 * permission of the page (which is definitely !IOMMU_NONE).
1027 * Note: for any IOMMU implementation, an in-place mapping change
1028 * should be notified with an UNMAP followed by a MAP.
1030 * @iommu_mr: the memory region that was changed
1031 * @iommu_idx: the IOMMU index for the translation table which has changed
1032 * @entry: the new entry in the IOMMU translation table. The entry
1033 * replaces all old entries for the same virtual I/O address range.
1034 * Deleted entries have .@perm == 0.
1036 void memory_region_notify_iommu(IOMMUMemoryRegion
*iommu_mr
,
1038 IOMMUTLBEntry entry
);
1041 * memory_region_notify_one: notify a change in an IOMMU translation
1042 * entry to a single notifier
1044 * This works just like memory_region_notify_iommu(), but it only
1045 * notifies a specific notifier, not all of them.
1047 * @notifier: the notifier to be notified
1048 * @entry: the new entry in the IOMMU translation table. The entry
1049 * replaces all old entries for the same virtual I/O address range.
1050 * Deleted entries have .@perm == 0.
1052 void memory_region_notify_one(IOMMUNotifier
*notifier
,
1053 IOMMUTLBEntry
*entry
);
1056 * memory_region_register_iommu_notifier: register a notifier for changes to
1057 * IOMMU translation entries.
1059 * @mr: the memory region to observe
1060 * @n: the IOMMUNotifier to be added; the notify callback receives a
1061 * pointer to an #IOMMUTLBEntry as the opaque value; the pointer
1062 * ceases to be valid on exit from the notifier.
1064 void memory_region_register_iommu_notifier(MemoryRegion
*mr
,
1068 * memory_region_iommu_replay: replay existing IOMMU translations to
1069 * a notifier with the minimum page granularity returned by
1070 * mr->iommu_ops->get_page_size().
1072 * Note: this is not related to record-and-replay functionality.
1074 * @iommu_mr: the memory region to observe
1075 * @n: the notifier to which to replay iommu mappings
1077 void memory_region_iommu_replay(IOMMUMemoryRegion
*iommu_mr
, IOMMUNotifier
*n
);
1080 * memory_region_iommu_replay_all: replay existing IOMMU translations
1081 * to all the notifiers registered.
1083 * Note: this is not related to record-and-replay functionality.
1085 * @iommu_mr: the memory region to observe
1087 void memory_region_iommu_replay_all(IOMMUMemoryRegion
*iommu_mr
);
1090 * memory_region_unregister_iommu_notifier: unregister a notifier for
1091 * changes to IOMMU translation entries.
1093 * @mr: the memory region which was observed and for which notity_stopped()
1094 * needs to be called
1095 * @n: the notifier to be removed.
1097 void memory_region_unregister_iommu_notifier(MemoryRegion
*mr
,
1101 * memory_region_iommu_get_attr: return an IOMMU attr if get_attr() is
1102 * defined on the IOMMU.
1104 * Returns 0 on success, or a negative errno otherwise. In particular,
1105 * -EINVAL indicates that the IOMMU does not support the requested
1108 * @iommu_mr: the memory region
1109 * @attr: the requested attribute
1110 * @data: a pointer to the requested attribute data
1112 int memory_region_iommu_get_attr(IOMMUMemoryRegion
*iommu_mr
,
1113 enum IOMMUMemoryRegionAttr attr
,
1117 * memory_region_iommu_attrs_to_index: return the IOMMU index to
1118 * use for translations with the given memory transaction attributes.
1120 * @iommu_mr: the memory region
1121 * @attrs: the memory transaction attributes
1123 int memory_region_iommu_attrs_to_index(IOMMUMemoryRegion
*iommu_mr
,
1127 * memory_region_iommu_num_indexes: return the total number of IOMMU
1128 * indexes that this IOMMU supports.
1130 * @iommu_mr: the memory region
1132 int memory_region_iommu_num_indexes(IOMMUMemoryRegion
*iommu_mr
);
1135 * memory_region_name: get a memory region's name
1137 * Returns the string that was used to initialize the memory region.
1139 * @mr: the memory region being queried
1141 const char *memory_region_name(const MemoryRegion
*mr
);
1144 * memory_region_is_logging: return whether a memory region is logging writes
1146 * Returns %true if the memory region is logging writes for the given client
1148 * @mr: the memory region being queried
1149 * @client: the client being queried
1151 bool memory_region_is_logging(MemoryRegion
*mr
, uint8_t client
);
1154 * memory_region_get_dirty_log_mask: return the clients for which a
1155 * memory region is logging writes.
1157 * Returns a bitmap of clients, in which the DIRTY_MEMORY_* constants
1158 * are the bit indices.
1160 * @mr: the memory region being queried
1162 uint8_t memory_region_get_dirty_log_mask(MemoryRegion
*mr
);
1165 * memory_region_is_rom: check whether a memory region is ROM
1167 * Returns %true if a memory region is read-only memory.
1169 * @mr: the memory region being queried
1171 static inline bool memory_region_is_rom(MemoryRegion
*mr
)
1173 return mr
->ram
&& mr
->readonly
;
1177 * memory_region_is_nonvolatile: check whether a memory region is non-volatile
1179 * Returns %true is a memory region is non-volatile memory.
1181 * @mr: the memory region being queried
1183 static inline bool memory_region_is_nonvolatile(MemoryRegion
*mr
)
1185 return mr
->nonvolatile
;
1189 * memory_region_get_fd: Get a file descriptor backing a RAM memory region.
1191 * Returns a file descriptor backing a file-based RAM memory region,
1192 * or -1 if the region is not a file-based RAM memory region.
1194 * @mr: the RAM or alias memory region being queried.
1196 int memory_region_get_fd(MemoryRegion
*mr
);
1199 * memory_region_from_host: Convert a pointer into a RAM memory region
1200 * and an offset within it.
1202 * Given a host pointer inside a RAM memory region (created with
1203 * memory_region_init_ram() or memory_region_init_ram_ptr()), return
1204 * the MemoryRegion and the offset within it.
1206 * Use with care; by the time this function returns, the returned pointer is
1207 * not protected by RCU anymore. If the caller is not within an RCU critical
1208 * section and does not hold the iothread lock, it must have other means of
1209 * protecting the pointer, such as a reference to the region that includes
1210 * the incoming ram_addr_t.
1212 * @ptr: the host pointer to be converted
1213 * @offset: the offset within memory region
1215 MemoryRegion
*memory_region_from_host(void *ptr
, ram_addr_t
*offset
);
1218 * memory_region_get_ram_ptr: Get a pointer into a RAM memory region.
1220 * Returns a host pointer to a RAM memory region (created with
1221 * memory_region_init_ram() or memory_region_init_ram_ptr()).
1223 * Use with care; by the time this function returns, the returned pointer is
1224 * not protected by RCU anymore. If the caller is not within an RCU critical
1225 * section and does not hold the iothread lock, it must have other means of
1226 * protecting the pointer, such as a reference to the region that includes
1227 * the incoming ram_addr_t.
1229 * @mr: the memory region being queried.
1231 void *memory_region_get_ram_ptr(MemoryRegion
*mr
);
1233 /* memory_region_ram_resize: Resize a RAM region.
1235 * Only legal before guest might have detected the memory size: e.g. on
1236 * incoming migration, or right after reset.
1238 * @mr: a memory region created with @memory_region_init_resizeable_ram.
1239 * @newsize: the new size the region
1240 * @errp: pointer to Error*, to store an error if it happens.
1242 void memory_region_ram_resize(MemoryRegion
*mr
, ram_addr_t newsize
,
1246 * memory_region_set_log: Turn dirty logging on or off for a region.
1248 * Turns dirty logging on or off for a specified client (display, migration).
1249 * Only meaningful for RAM regions.
1251 * @mr: the memory region being updated.
1252 * @log: whether dirty logging is to be enabled or disabled.
1253 * @client: the user of the logging information; %DIRTY_MEMORY_VGA only.
1255 void memory_region_set_log(MemoryRegion
*mr
, bool log
, unsigned client
);
1258 * memory_region_get_dirty: Check whether a range of bytes is dirty
1259 * for a specified client.
1261 * Checks whether a range of bytes has been written to since the last
1262 * call to memory_region_reset_dirty() with the same @client. Dirty logging
1265 * @mr: the memory region being queried.
1266 * @addr: the address (relative to the start of the region) being queried.
1267 * @size: the size of the range being queried.
1268 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
1269 * %DIRTY_MEMORY_VGA.
1271 bool memory_region_get_dirty(MemoryRegion
*mr
, hwaddr addr
,
1272 hwaddr size
, unsigned client
);
1275 * memory_region_set_dirty: Mark a range of bytes as dirty in a memory region.
1277 * Marks a range of bytes as dirty, after it has been dirtied outside
1280 * @mr: the memory region being dirtied.
1281 * @addr: the address (relative to the start of the region) being dirtied.
1282 * @size: size of the range being dirtied.
1284 void memory_region_set_dirty(MemoryRegion
*mr
, hwaddr addr
,
1288 * memory_region_snapshot_and_clear_dirty: Get a snapshot of the dirty
1289 * bitmap and clear it.
1291 * Creates a snapshot of the dirty bitmap, clears the dirty bitmap and
1292 * returns the snapshot. The snapshot can then be used to query dirty
1293 * status, using memory_region_snapshot_get_dirty. Snapshotting allows
1294 * querying the same page multiple times, which is especially useful for
1295 * display updates where the scanlines often are not page aligned.
1297 * The dirty bitmap region which gets copyed into the snapshot (and
1298 * cleared afterwards) can be larger than requested. The boundaries
1299 * are rounded up/down so complete bitmap longs (covering 64 pages on
1300 * 64bit hosts) can be copied over into the bitmap snapshot. Which
1301 * isn't a problem for display updates as the extra pages are outside
1302 * the visible area, and in case the visible area changes a full
1303 * display redraw is due anyway. Should other use cases for this
1304 * function emerge we might have to revisit this implementation
1307 * Use g_free to release DirtyBitmapSnapshot.
1309 * @mr: the memory region being queried.
1310 * @addr: the address (relative to the start of the region) being queried.
1311 * @size: the size of the range being queried.
1312 * @client: the user of the logging information; typically %DIRTY_MEMORY_VGA.
1314 DirtyBitmapSnapshot
*memory_region_snapshot_and_clear_dirty(MemoryRegion
*mr
,
1320 * memory_region_snapshot_get_dirty: Check whether a range of bytes is dirty
1321 * in the specified dirty bitmap snapshot.
1323 * @mr: the memory region being queried.
1324 * @snap: the dirty bitmap snapshot
1325 * @addr: the address (relative to the start of the region) being queried.
1326 * @size: the size of the range being queried.
1328 bool memory_region_snapshot_get_dirty(MemoryRegion
*mr
,
1329 DirtyBitmapSnapshot
*snap
,
1330 hwaddr addr
, hwaddr size
);
1333 * memory_region_reset_dirty: Mark a range of pages as clean, for a specified
1336 * Marks a range of pages as no longer dirty.
1338 * @mr: the region being updated.
1339 * @addr: the start of the subrange being cleaned.
1340 * @size: the size of the subrange being cleaned.
1341 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
1342 * %DIRTY_MEMORY_VGA.
1344 void memory_region_reset_dirty(MemoryRegion
*mr
, hwaddr addr
,
1345 hwaddr size
, unsigned client
);
1348 * memory_region_flush_rom_device: Mark a range of pages dirty and invalidate
1349 * TBs (for self-modifying code).
1351 * The MemoryRegionOps->write() callback of a ROM device must use this function
1352 * to mark byte ranges that have been modified internally, such as by directly
1353 * accessing the memory returned by memory_region_get_ram_ptr().
1355 * This function marks the range dirty and invalidates TBs so that TCG can
1356 * detect self-modifying code.
1358 * @mr: the region being flushed.
1359 * @addr: the start, relative to the start of the region, of the range being
1361 * @size: the size, in bytes, of the range being flushed.
1363 void memory_region_flush_rom_device(MemoryRegion
*mr
, hwaddr addr
, hwaddr size
);
1366 * memory_region_set_readonly: Turn a memory region read-only (or read-write)
1368 * Allows a memory region to be marked as read-only (turning it into a ROM).
1369 * only useful on RAM regions.
1371 * @mr: the region being updated.
1372 * @readonly: whether rhe region is to be ROM or RAM.
1374 void memory_region_set_readonly(MemoryRegion
*mr
, bool readonly
);
1377 * memory_region_set_nonvolatile: Turn a memory region non-volatile
1379 * Allows a memory region to be marked as non-volatile.
1380 * only useful on RAM regions.
1382 * @mr: the region being updated.
1383 * @nonvolatile: whether rhe region is to be non-volatile.
1385 void memory_region_set_nonvolatile(MemoryRegion
*mr
, bool nonvolatile
);
1388 * memory_region_rom_device_set_romd: enable/disable ROMD mode
1390 * Allows a ROM device (initialized with memory_region_init_rom_device() to
1391 * set to ROMD mode (default) or MMIO mode. When it is in ROMD mode, the
1392 * device is mapped to guest memory and satisfies read access directly.
1393 * When in MMIO mode, reads are forwarded to the #MemoryRegion.read function.
1394 * Writes are always handled by the #MemoryRegion.write function.
1396 * @mr: the memory region to be updated
1397 * @romd_mode: %true to put the region into ROMD mode
1399 void memory_region_rom_device_set_romd(MemoryRegion
*mr
, bool romd_mode
);
1402 * memory_region_set_coalescing: Enable memory coalescing for the region.
1404 * Enabled writes to a region to be queued for later processing. MMIO ->write
1405 * callbacks may be delayed until a non-coalesced MMIO is issued.
1406 * Only useful for IO regions. Roughly similar to write-combining hardware.
1408 * @mr: the memory region to be write coalesced
1410 void memory_region_set_coalescing(MemoryRegion
*mr
);
1413 * memory_region_add_coalescing: Enable memory coalescing for a sub-range of
1416 * Like memory_region_set_coalescing(), but works on a sub-range of a region.
1417 * Multiple calls can be issued coalesced disjoint ranges.
1419 * @mr: the memory region to be updated.
1420 * @offset: the start of the range within the region to be coalesced.
1421 * @size: the size of the subrange to be coalesced.
1423 void memory_region_add_coalescing(MemoryRegion
*mr
,
1428 * memory_region_clear_coalescing: Disable MMIO coalescing for the region.
1430 * Disables any coalescing caused by memory_region_set_coalescing() or
1431 * memory_region_add_coalescing(). Roughly equivalent to uncacheble memory
1434 * @mr: the memory region to be updated.
1436 void memory_region_clear_coalescing(MemoryRegion
*mr
);
1439 * memory_region_set_flush_coalesced: Enforce memory coalescing flush before
1442 * Ensure that pending coalesced MMIO request are flushed before the memory
1443 * region is accessed. This property is automatically enabled for all regions
1444 * passed to memory_region_set_coalescing() and memory_region_add_coalescing().
1446 * @mr: the memory region to be updated.
1448 void memory_region_set_flush_coalesced(MemoryRegion
*mr
);
1451 * memory_region_clear_flush_coalesced: Disable memory coalescing flush before
1454 * Clear the automatic coalesced MMIO flushing enabled via
1455 * memory_region_set_flush_coalesced. Note that this service has no effect on
1456 * memory regions that have MMIO coalescing enabled for themselves. For them,
1457 * automatic flushing will stop once coalescing is disabled.
1459 * @mr: the memory region to be updated.
1461 void memory_region_clear_flush_coalesced(MemoryRegion
*mr
);
1464 * memory_region_clear_global_locking: Declares that access processing does
1465 * not depend on the QEMU global lock.
1467 * By clearing this property, accesses to the memory region will be processed
1468 * outside of QEMU's global lock (unless the lock is held on when issuing the
1469 * access request). In this case, the device model implementing the access
1470 * handlers is responsible for synchronization of concurrency.
1472 * @mr: the memory region to be updated.
1474 void memory_region_clear_global_locking(MemoryRegion
*mr
);
1477 * memory_region_add_eventfd: Request an eventfd to be triggered when a word
1478 * is written to a location.
1480 * Marks a word in an IO region (initialized with memory_region_init_io())
1481 * as a trigger for an eventfd event. The I/O callback will not be called.
1482 * The caller must be prepared to handle failure (that is, take the required
1483 * action if the callback _is_ called).
1485 * @mr: the memory region being updated.
1486 * @addr: the address within @mr that is to be monitored
1487 * @size: the size of the access to trigger the eventfd
1488 * @match_data: whether to match against @data, instead of just @addr
1489 * @data: the data to match against the guest write
1490 * @e: event notifier to be triggered when @addr, @size, and @data all match.
1492 void memory_region_add_eventfd(MemoryRegion
*mr
,
1500 * memory_region_del_eventfd: Cancel an eventfd.
1502 * Cancels an eventfd trigger requested by a previous
1503 * memory_region_add_eventfd() call.
1505 * @mr: the memory region being updated.
1506 * @addr: the address within @mr that is to be monitored
1507 * @size: the size of the access to trigger the eventfd
1508 * @match_data: whether to match against @data, instead of just @addr
1509 * @data: the data to match against the guest write
1510 * @e: event notifier to be triggered when @addr, @size, and @data all match.
1512 void memory_region_del_eventfd(MemoryRegion
*mr
,
1520 * memory_region_add_subregion: Add a subregion to a container.
1522 * Adds a subregion at @offset. The subregion may not overlap with other
1523 * subregions (except for those explicitly marked as overlapping). A region
1524 * may only be added once as a subregion (unless removed with
1525 * memory_region_del_subregion()); use memory_region_init_alias() if you
1526 * want a region to be a subregion in multiple locations.
1528 * @mr: the region to contain the new subregion; must be a container
1529 * initialized with memory_region_init().
1530 * @offset: the offset relative to @mr where @subregion is added.
1531 * @subregion: the subregion to be added.
1533 void memory_region_add_subregion(MemoryRegion
*mr
,
1535 MemoryRegion
*subregion
);
1537 * memory_region_add_subregion_overlap: Add a subregion to a container
1540 * Adds a subregion at @offset. The subregion may overlap with other
1541 * subregions. Conflicts are resolved by having a higher @priority hide a
1542 * lower @priority. Subregions without priority are taken as @priority 0.
1543 * A region may only be added once as a subregion (unless removed with
1544 * memory_region_del_subregion()); use memory_region_init_alias() if you
1545 * want a region to be a subregion in multiple locations.
1547 * @mr: the region to contain the new subregion; must be a container
1548 * initialized with memory_region_init().
1549 * @offset: the offset relative to @mr where @subregion is added.
1550 * @subregion: the subregion to be added.
1551 * @priority: used for resolving overlaps; highest priority wins.
1553 void memory_region_add_subregion_overlap(MemoryRegion
*mr
,
1555 MemoryRegion
*subregion
,
1559 * memory_region_get_ram_addr: Get the ram address associated with a memory
1562 ram_addr_t
memory_region_get_ram_addr(MemoryRegion
*mr
);
1564 uint64_t memory_region_get_alignment(const MemoryRegion
*mr
);
1566 * memory_region_del_subregion: Remove a subregion.
1568 * Removes a subregion from its container.
1570 * @mr: the container to be updated.
1571 * @subregion: the region being removed; must be a current subregion of @mr.
1573 void memory_region_del_subregion(MemoryRegion
*mr
,
1574 MemoryRegion
*subregion
);
1577 * memory_region_set_enabled: dynamically enable or disable a region
1579 * Enables or disables a memory region. A disabled memory region
1580 * ignores all accesses to itself and its subregions. It does not
1581 * obscure sibling subregions with lower priority - it simply behaves as
1582 * if it was removed from the hierarchy.
1584 * Regions default to being enabled.
1586 * @mr: the region to be updated
1587 * @enabled: whether to enable or disable the region
1589 void memory_region_set_enabled(MemoryRegion
*mr
, bool enabled
);
1592 * memory_region_set_address: dynamically update the address of a region
1594 * Dynamically updates the address of a region, relative to its container.
1595 * May be used on regions are currently part of a memory hierarchy.
1597 * @mr: the region to be updated
1598 * @addr: new address, relative to container region
1600 void memory_region_set_address(MemoryRegion
*mr
, hwaddr addr
);
1603 * memory_region_set_size: dynamically update the size of a region.
1605 * Dynamically updates the size of a region.
1607 * @mr: the region to be updated
1608 * @size: used size of the region.
1610 void memory_region_set_size(MemoryRegion
*mr
, uint64_t size
);
1613 * memory_region_set_alias_offset: dynamically update a memory alias's offset
1615 * Dynamically updates the offset into the target region that an alias points
1616 * to, as if the fourth argument to memory_region_init_alias() has changed.
1618 * @mr: the #MemoryRegion to be updated; should be an alias.
1619 * @offset: the new offset into the target memory region
1621 void memory_region_set_alias_offset(MemoryRegion
*mr
,
1625 * memory_region_present: checks if an address relative to a @container
1626 * translates into #MemoryRegion within @container
1628 * Answer whether a #MemoryRegion within @container covers the address
1631 * @container: a #MemoryRegion within which @addr is a relative address
1632 * @addr: the area within @container to be searched
1634 bool memory_region_present(MemoryRegion
*container
, hwaddr addr
);
1637 * memory_region_is_mapped: returns true if #MemoryRegion is mapped
1638 * into any address space.
1640 * @mr: a #MemoryRegion which should be checked if it's mapped
1642 bool memory_region_is_mapped(MemoryRegion
*mr
);
1645 * memory_region_find: translate an address/size relative to a
1646 * MemoryRegion into a #MemoryRegionSection.
1648 * Locates the first #MemoryRegion within @mr that overlaps the range
1649 * given by @addr and @size.
1651 * Returns a #MemoryRegionSection that describes a contiguous overlap.
1652 * It will have the following characteristics:
1653 * .@size = 0 iff no overlap was found
1654 * .@mr is non-%NULL iff an overlap was found
1656 * Remember that in the return value the @offset_within_region is
1657 * relative to the returned region (in the .@mr field), not to the
1660 * Similarly, the .@offset_within_address_space is relative to the
1661 * address space that contains both regions, the passed and the
1662 * returned one. However, in the special case where the @mr argument
1663 * has no container (and thus is the root of the address space), the
1664 * following will hold:
1665 * .@offset_within_address_space >= @addr
1666 * .@offset_within_address_space + .@size <= @addr + @size
1668 * @mr: a MemoryRegion within which @addr is a relative address
1669 * @addr: start of the area within @as to be searched
1670 * @size: size of the area to be searched
1672 MemoryRegionSection
memory_region_find(MemoryRegion
*mr
,
1673 hwaddr addr
, uint64_t size
);
1676 * memory_global_dirty_log_sync: synchronize the dirty log for all memory
1678 * Synchronizes the dirty page log for all address spaces.
1680 void memory_global_dirty_log_sync(void);
1683 * memory_region_transaction_begin: Start a transaction.
1685 * During a transaction, changes will be accumulated and made visible
1686 * only when the transaction ends (is committed).
1688 void memory_region_transaction_begin(void);
1691 * memory_region_transaction_commit: Commit a transaction and make changes
1692 * visible to the guest.
1694 void memory_region_transaction_commit(void);
1697 * memory_listener_register: register callbacks to be called when memory
1698 * sections are mapped or unmapped into an address
1701 * @listener: an object containing the callbacks to be called
1702 * @filter: if non-%NULL, only regions in this address space will be observed
1704 void memory_listener_register(MemoryListener
*listener
, AddressSpace
*filter
);
1707 * memory_listener_unregister: undo the effect of memory_listener_register()
1709 * @listener: an object containing the callbacks to be removed
1711 void memory_listener_unregister(MemoryListener
*listener
);
1714 * memory_global_dirty_log_start: begin dirty logging for all regions
1716 void memory_global_dirty_log_start(void);
1719 * memory_global_dirty_log_stop: end dirty logging for all regions
1721 void memory_global_dirty_log_stop(void);
1723 void mtree_info(fprintf_function mon_printf
, void *f
, bool flatview
,
1724 bool dispatch_tree
, bool owner
);
1727 * memory_region_dispatch_read: perform a read directly to the specified
1730 * @mr: #MemoryRegion to access
1731 * @addr: address within that region
1732 * @pval: pointer to uint64_t which the data is written to
1733 * @size: size of the access in bytes
1734 * @attrs: memory transaction attributes to use for the access
1736 MemTxResult
memory_region_dispatch_read(MemoryRegion
*mr
,
1742 * memory_region_dispatch_write: perform a write directly to the specified
1745 * @mr: #MemoryRegion to access
1746 * @addr: address within that region
1747 * @data: data to write
1748 * @size: size of the access in bytes
1749 * @attrs: memory transaction attributes to use for the access
1751 MemTxResult
memory_region_dispatch_write(MemoryRegion
*mr
,
1758 * address_space_init: initializes an address space
1760 * @as: an uninitialized #AddressSpace
1761 * @root: a #MemoryRegion that routes addresses for the address space
1762 * @name: an address space name. The name is only used for debugging
1765 void address_space_init(AddressSpace
*as
, MemoryRegion
*root
, const char *name
);
1768 * address_space_destroy: destroy an address space
1770 * Releases all resources associated with an address space. After an address space
1771 * is destroyed, its root memory region (given by address_space_init()) may be destroyed
1774 * @as: address space to be destroyed
1776 void address_space_destroy(AddressSpace
*as
);
1779 * address_space_rw: read from or write to an address space.
1781 * Return a MemTxResult indicating whether the operation succeeded
1782 * or failed (eg unassigned memory, device rejected the transaction,
1785 * @as: #AddressSpace to be accessed
1786 * @addr: address within that address space
1787 * @attrs: memory transaction attributes
1788 * @buf: buffer with the data transferred
1789 * @len: the number of bytes to read or write
1790 * @is_write: indicates the transfer direction
1792 MemTxResult
address_space_rw(AddressSpace
*as
, hwaddr addr
,
1793 MemTxAttrs attrs
, uint8_t *buf
,
1794 int len
, bool is_write
);
1797 * address_space_write: write to address space.
1799 * Return a MemTxResult indicating whether the operation succeeded
1800 * or failed (eg unassigned memory, device rejected the transaction,
1803 * @as: #AddressSpace to be accessed
1804 * @addr: address within that address space
1805 * @attrs: memory transaction attributes
1806 * @buf: buffer with the data transferred
1807 * @len: the number of bytes to write
1809 MemTxResult
address_space_write(AddressSpace
*as
, hwaddr addr
,
1811 const uint8_t *buf
, int len
);
1814 * address_space_write_rom: write to address space, including ROM.
1816 * This function writes to the specified address space, but will
1817 * write data to both ROM and RAM. This is used for non-guest
1818 * writes like writes from the gdb debug stub or initial loading
1821 * Note that portions of the write which attempt to write data to
1822 * a device will be silently ignored -- only real RAM and ROM will
1825 * Return a MemTxResult indicating whether the operation succeeded
1826 * or failed (eg unassigned memory, device rejected the transaction,
1829 * @as: #AddressSpace to be accessed
1830 * @addr: address within that address space
1831 * @attrs: memory transaction attributes
1832 * @buf: buffer with the data transferred
1833 * @len: the number of bytes to write
1835 MemTxResult
address_space_write_rom(AddressSpace
*as
, hwaddr addr
,
1837 const uint8_t *buf
, int len
);
1839 /* address_space_ld*: load from an address space
1840 * address_space_st*: store to an address space
1842 * These functions perform a load or store of the byte, word,
1843 * longword or quad to the specified address within the AddressSpace.
1844 * The _le suffixed functions treat the data as little endian;
1845 * _be indicates big endian; no suffix indicates "same endianness
1848 * The "guest CPU endianness" accessors are deprecated for use outside
1849 * target-* code; devices should be CPU-agnostic and use either the LE
1850 * or the BE accessors.
1852 * @as #AddressSpace to be accessed
1853 * @addr: address within that address space
1854 * @val: data value, for stores
1855 * @attrs: memory transaction attributes
1856 * @result: location to write the success/failure of the transaction;
1857 * if NULL, this information is discarded
1862 #define ARG1_DECL AddressSpace *as
1863 #include "exec/memory_ldst.inc.h"
1867 #define ARG1_DECL AddressSpace *as
1868 #include "exec/memory_ldst_phys.inc.h"
1870 struct MemoryRegionCache
{
1875 MemoryRegionSection mrs
;
1879 #define MEMORY_REGION_CACHE_INVALID ((MemoryRegionCache) { .mrs.mr = NULL })
1882 /* address_space_ld*_cached: load from a cached #MemoryRegion
1883 * address_space_st*_cached: store into a cached #MemoryRegion
1885 * These functions perform a load or store of the byte, word,
1886 * longword or quad to the specified address. The address is
1887 * a physical address in the AddressSpace, but it must lie within
1888 * a #MemoryRegion that was mapped with address_space_cache_init.
1890 * The _le suffixed functions treat the data as little endian;
1891 * _be indicates big endian; no suffix indicates "same endianness
1894 * The "guest CPU endianness" accessors are deprecated for use outside
1895 * target-* code; devices should be CPU-agnostic and use either the LE
1896 * or the BE accessors.
1898 * @cache: previously initialized #MemoryRegionCache to be accessed
1899 * @addr: address within the address space
1900 * @val: data value, for stores
1901 * @attrs: memory transaction attributes
1902 * @result: location to write the success/failure of the transaction;
1903 * if NULL, this information is discarded
1906 #define SUFFIX _cached_slow
1908 #define ARG1_DECL MemoryRegionCache *cache
1909 #include "exec/memory_ldst.inc.h"
1911 /* Inline fast path for direct RAM access. */
1912 static inline uint8_t address_space_ldub_cached(MemoryRegionCache
*cache
,
1913 hwaddr addr
, MemTxAttrs attrs
, MemTxResult
*result
)
1915 assert(addr
< cache
->len
);
1916 if (likely(cache
->ptr
)) {
1917 return ldub_p(cache
->ptr
+ addr
);
1919 return address_space_ldub_cached_slow(cache
, addr
, attrs
, result
);
1923 static inline void address_space_stb_cached(MemoryRegionCache
*cache
,
1924 hwaddr addr
, uint32_t val
, MemTxAttrs attrs
, MemTxResult
*result
)
1926 assert(addr
< cache
->len
);
1927 if (likely(cache
->ptr
)) {
1928 stb_p(cache
->ptr
+ addr
, val
);
1930 address_space_stb_cached_slow(cache
, addr
, val
, attrs
, result
);
1934 #define ENDIANNESS _le
1935 #include "exec/memory_ldst_cached.inc.h"
1937 #define ENDIANNESS _be
1938 #include "exec/memory_ldst_cached.inc.h"
1940 #define SUFFIX _cached
1942 #define ARG1_DECL MemoryRegionCache *cache
1943 #include "exec/memory_ldst_phys.inc.h"
1945 /* address_space_cache_init: prepare for repeated access to a physical
1948 * @cache: #MemoryRegionCache to be filled
1949 * @as: #AddressSpace to be accessed
1950 * @addr: address within that address space
1951 * @len: length of buffer
1952 * @is_write: indicates the transfer direction
1954 * Will only work with RAM, and may map a subset of the requested range by
1955 * returning a value that is less than @len. On failure, return a negative
1958 * Because it only works with RAM, this function can be used for
1959 * read-modify-write operations. In this case, is_write should be %true.
1961 * Note that addresses passed to the address_space_*_cached functions
1962 * are relative to @addr.
1964 int64_t address_space_cache_init(MemoryRegionCache
*cache
,
1971 * address_space_cache_invalidate: complete a write to a #MemoryRegionCache
1973 * @cache: The #MemoryRegionCache to operate on.
1974 * @addr: The first physical address that was written, relative to the
1975 * address that was passed to @address_space_cache_init.
1976 * @access_len: The number of bytes that were written starting at @addr.
1978 void address_space_cache_invalidate(MemoryRegionCache
*cache
,
1983 * address_space_cache_destroy: free a #MemoryRegionCache
1985 * @cache: The #MemoryRegionCache whose memory should be released.
1987 void address_space_cache_destroy(MemoryRegionCache
*cache
);
1989 /* address_space_get_iotlb_entry: translate an address into an IOTLB
1990 * entry. Should be called from an RCU critical section.
1992 IOMMUTLBEntry
address_space_get_iotlb_entry(AddressSpace
*as
, hwaddr addr
,
1993 bool is_write
, MemTxAttrs attrs
);
1995 /* address_space_translate: translate an address range into an address space
1996 * into a MemoryRegion and an address range into that section. Should be
1997 * called from an RCU critical section, to avoid that the last reference
1998 * to the returned region disappears after address_space_translate returns.
2000 * @fv: #FlatView to be accessed
2001 * @addr: address within that address space
2002 * @xlat: pointer to address within the returned memory region section's
2004 * @len: pointer to length
2005 * @is_write: indicates the transfer direction
2006 * @attrs: memory attributes
2008 MemoryRegion
*flatview_translate(FlatView
*fv
,
2009 hwaddr addr
, hwaddr
*xlat
,
2010 hwaddr
*len
, bool is_write
,
2013 static inline MemoryRegion
*address_space_translate(AddressSpace
*as
,
2014 hwaddr addr
, hwaddr
*xlat
,
2015 hwaddr
*len
, bool is_write
,
2018 return flatview_translate(address_space_to_flatview(as
),
2019 addr
, xlat
, len
, is_write
, attrs
);
2022 /* address_space_access_valid: check for validity of accessing an address
2025 * Check whether memory is assigned to the given address space range, and
2026 * access is permitted by any IOMMU regions that are active for the address
2029 * For now, addr and len should be aligned to a page size. This limitation
2030 * will be lifted in the future.
2032 * @as: #AddressSpace to be accessed
2033 * @addr: address within that address space
2034 * @len: length of the area to be checked
2035 * @is_write: indicates the transfer direction
2036 * @attrs: memory attributes
2038 bool address_space_access_valid(AddressSpace
*as
, hwaddr addr
, int len
,
2039 bool is_write
, MemTxAttrs attrs
);
2041 /* address_space_map: map a physical memory region into a host virtual address
2043 * May map a subset of the requested range, given by and returned in @plen.
2044 * May return %NULL if resources needed to perform the mapping are exhausted.
2045 * Use only for reads OR writes - not for read-modify-write operations.
2046 * Use cpu_register_map_client() to know when retrying the map operation is
2047 * likely to succeed.
2049 * @as: #AddressSpace to be accessed
2050 * @addr: address within that address space
2051 * @plen: pointer to length of buffer; updated on return
2052 * @is_write: indicates the transfer direction
2053 * @attrs: memory attributes
2055 void *address_space_map(AddressSpace
*as
, hwaddr addr
,
2056 hwaddr
*plen
, bool is_write
, MemTxAttrs attrs
);
2058 /* address_space_unmap: Unmaps a memory region previously mapped by address_space_map()
2060 * Will also mark the memory as dirty if @is_write == %true. @access_len gives
2061 * the amount of memory that was actually read or written by the caller.
2063 * @as: #AddressSpace used
2064 * @buffer: host pointer as returned by address_space_map()
2065 * @len: buffer length as returned by address_space_map()
2066 * @access_len: amount of data actually transferred
2067 * @is_write: indicates the transfer direction
2069 void address_space_unmap(AddressSpace
*as
, void *buffer
, hwaddr len
,
2070 int is_write
, hwaddr access_len
);
2073 /* Internal functions, part of the implementation of address_space_read. */
2074 MemTxResult
address_space_read_full(AddressSpace
*as
, hwaddr addr
,
2075 MemTxAttrs attrs
, uint8_t *buf
, int len
);
2076 MemTxResult
flatview_read_continue(FlatView
*fv
, hwaddr addr
,
2077 MemTxAttrs attrs
, uint8_t *buf
,
2078 int len
, hwaddr addr1
, hwaddr l
,
2080 void *qemu_map_ram_ptr(RAMBlock
*ram_block
, ram_addr_t addr
);
2082 /* Internal functions, part of the implementation of address_space_read_cached
2083 * and address_space_write_cached. */
2084 void address_space_read_cached_slow(MemoryRegionCache
*cache
,
2085 hwaddr addr
, void *buf
, int len
);
2086 void address_space_write_cached_slow(MemoryRegionCache
*cache
,
2087 hwaddr addr
, const void *buf
, int len
);
2089 static inline bool memory_access_is_direct(MemoryRegion
*mr
, bool is_write
)
2092 return memory_region_is_ram(mr
) &&
2093 !mr
->readonly
&& !memory_region_is_ram_device(mr
);
2095 return (memory_region_is_ram(mr
) && !memory_region_is_ram_device(mr
)) ||
2096 memory_region_is_romd(mr
);
2101 * address_space_read: read from an address space.
2103 * Return a MemTxResult indicating whether the operation succeeded
2104 * or failed (eg unassigned memory, device rejected the transaction,
2105 * IOMMU fault). Called within RCU critical section.
2107 * @as: #AddressSpace to be accessed
2108 * @addr: address within that address space
2109 * @attrs: memory transaction attributes
2110 * @buf: buffer with the data transferred
2112 static inline __attribute__((__always_inline__
))
2113 MemTxResult
address_space_read(AddressSpace
*as
, hwaddr addr
,
2114 MemTxAttrs attrs
, uint8_t *buf
,
2117 MemTxResult result
= MEMTX_OK
;
2123 if (__builtin_constant_p(len
)) {
2126 fv
= address_space_to_flatview(as
);
2128 mr
= flatview_translate(fv
, addr
, &addr1
, &l
, false, attrs
);
2129 if (len
== l
&& memory_access_is_direct(mr
, false)) {
2130 ptr
= qemu_map_ram_ptr(mr
->ram_block
, addr1
);
2131 memcpy(buf
, ptr
, len
);
2133 result
= flatview_read_continue(fv
, addr
, attrs
, buf
, len
,
2139 result
= address_space_read_full(as
, addr
, attrs
, buf
, len
);
2145 * address_space_read_cached: read from a cached RAM region
2147 * @cache: Cached region to be addressed
2148 * @addr: address relative to the base of the RAM region
2149 * @buf: buffer with the data transferred
2150 * @len: length of the data transferred
2153 address_space_read_cached(MemoryRegionCache
*cache
, hwaddr addr
,
2156 assert(addr
< cache
->len
&& len
<= cache
->len
- addr
);
2157 if (likely(cache
->ptr
)) {
2158 memcpy(buf
, cache
->ptr
+ addr
, len
);
2160 address_space_read_cached_slow(cache
, addr
, buf
, len
);
2165 * address_space_write_cached: write to a cached RAM region
2167 * @cache: Cached region to be addressed
2168 * @addr: address relative to the base of the RAM region
2169 * @buf: buffer with the data transferred
2170 * @len: length of the data transferred
2173 address_space_write_cached(MemoryRegionCache
*cache
, hwaddr addr
,
2176 assert(addr
< cache
->len
&& len
<= cache
->len
- addr
);
2177 if (likely(cache
->ptr
)) {
2178 memcpy(cache
->ptr
+ addr
, buf
, len
);
2180 address_space_write_cached_slow(cache
, addr
, buf
, len
);