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/memop.h"
23 #include "exec/ramlist.h"
24 #include "qemu/bswap.h"
25 #include "qemu/queue.h"
26 #include "qemu/int128.h"
27 #include "qemu/notify.h"
28 #include "qom/object.h"
31 #define RAM_ADDR_INVALID (~(ram_addr_t)0)
33 #define MAX_PHYS_ADDR_SPACE_BITS 62
34 #define MAX_PHYS_ADDR (((hwaddr)1 << MAX_PHYS_ADDR_SPACE_BITS) - 1)
36 #define TYPE_MEMORY_REGION "memory-region"
37 DECLARE_INSTANCE_CHECKER(MemoryRegion
, MEMORY_REGION
,
40 #define TYPE_IOMMU_MEMORY_REGION "iommu-memory-region"
41 typedef struct IOMMUMemoryRegionClass IOMMUMemoryRegionClass
;
42 DECLARE_OBJ_CHECKERS(IOMMUMemoryRegion
, IOMMUMemoryRegionClass
,
43 IOMMU_MEMORY_REGION
, TYPE_IOMMU_MEMORY_REGION
)
45 #define TYPE_RAM_DISCARD_MANAGER "qemu:ram-discard-manager"
46 typedef struct RamDiscardManagerClass RamDiscardManagerClass
;
47 typedef struct RamDiscardManager RamDiscardManager
;
48 DECLARE_OBJ_CHECKERS(RamDiscardManager
, RamDiscardManagerClass
,
49 RAM_DISCARD_MANAGER
, TYPE_RAM_DISCARD_MANAGER
);
52 void fuzz_dma_read_cb(size_t addr
,
56 static inline void fuzz_dma_read_cb(size_t addr
,
64 /* Possible bits for global_dirty_log_{start|stop} */
66 /* Dirty tracking enabled because migration is running */
67 #define GLOBAL_DIRTY_MIGRATION (1U << 0)
69 /* Dirty tracking enabled because measuring dirty rate */
70 #define GLOBAL_DIRTY_DIRTY_RATE (1U << 1)
72 /* Dirty tracking enabled because dirty limit */
73 #define GLOBAL_DIRTY_LIMIT (1U << 2)
75 #define GLOBAL_DIRTY_MASK (0x7)
77 extern unsigned int global_dirty_tracking
;
79 typedef struct MemoryRegionOps MemoryRegionOps
;
81 struct ReservedRegion
{
88 * struct MemoryRegionSection: describes a fragment of a #MemoryRegion
90 * @mr: the region, or %NULL if empty
91 * @fv: the flat view of the address space the region is mapped in
92 * @offset_within_region: the beginning of the section, relative to @mr's start
93 * @size: the size of the section; will not exceed @mr's boundaries
94 * @offset_within_address_space: the address of the first byte of the section
95 * relative to the region's address space
96 * @readonly: writes to this section are ignored
97 * @nonvolatile: this section is non-volatile
99 struct MemoryRegionSection
{
103 hwaddr offset_within_region
;
104 hwaddr offset_within_address_space
;
109 typedef struct IOMMUTLBEntry IOMMUTLBEntry
;
111 /* See address_space_translate: bit 0 is read, bit 1 is write. */
119 #define IOMMU_ACCESS_FLAG(r, w) (((r) ? IOMMU_RO : 0) | ((w) ? IOMMU_WO : 0))
121 struct IOMMUTLBEntry
{
122 AddressSpace
*target_as
;
124 hwaddr translated_addr
;
125 hwaddr addr_mask
; /* 0xfff = 4k translation */
126 IOMMUAccessFlags perm
;
130 * Bitmap for different IOMMUNotifier capabilities. Each notifier can
131 * register with one or multiple IOMMU Notifier capability bit(s).
133 * Normally there're two use cases for the notifiers:
135 * (1) When the device needs accurate synchronizations of the vIOMMU page
136 * tables, it needs to register with both MAP|UNMAP notifies (which
137 * is defined as IOMMU_NOTIFIER_IOTLB_EVENTS below).
139 * Regarding to accurate synchronization, it's when the notified
140 * device maintains a shadow page table and must be notified on each
141 * guest MAP (page table entry creation) and UNMAP (invalidation)
142 * events (e.g. VFIO). Both notifications must be accurate so that
143 * the shadow page table is fully in sync with the guest view.
145 * (2) When the device doesn't need accurate synchronizations of the
146 * vIOMMU page tables, it needs to register only with UNMAP or
147 * DEVIOTLB_UNMAP notifies.
149 * It's when the device maintains a cache of IOMMU translations
150 * (IOTLB) and is able to fill that cache by requesting translations
151 * from the vIOMMU through a protocol similar to ATS (Address
152 * Translation Service).
154 * Note that in this mode the vIOMMU will not maintain a shadowed
155 * page table for the address space, and the UNMAP messages can cover
156 * more than the pages that used to get mapped. The IOMMU notifiee
157 * should be able to take care of over-sized invalidations.
160 IOMMU_NOTIFIER_NONE
= 0,
161 /* Notify cache invalidations */
162 IOMMU_NOTIFIER_UNMAP
= 0x1,
163 /* Notify entry changes (newly created entries) */
164 IOMMU_NOTIFIER_MAP
= 0x2,
165 /* Notify changes on device IOTLB entries */
166 IOMMU_NOTIFIER_DEVIOTLB_UNMAP
= 0x04,
169 #define IOMMU_NOTIFIER_IOTLB_EVENTS (IOMMU_NOTIFIER_MAP | IOMMU_NOTIFIER_UNMAP)
170 #define IOMMU_NOTIFIER_DEVIOTLB_EVENTS IOMMU_NOTIFIER_DEVIOTLB_UNMAP
171 #define IOMMU_NOTIFIER_ALL (IOMMU_NOTIFIER_IOTLB_EVENTS | \
172 IOMMU_NOTIFIER_DEVIOTLB_EVENTS)
174 struct IOMMUNotifier
;
175 typedef void (*IOMMUNotify
)(struct IOMMUNotifier
*notifier
,
176 IOMMUTLBEntry
*data
);
178 struct IOMMUNotifier
{
180 IOMMUNotifierFlag notifier_flags
;
181 /* Notify for address space range start <= addr <= end */
185 QLIST_ENTRY(IOMMUNotifier
) node
;
187 typedef struct IOMMUNotifier IOMMUNotifier
;
189 typedef struct IOMMUTLBEvent
{
190 IOMMUNotifierFlag type
;
194 /* RAM is pre-allocated and passed into qemu_ram_alloc_from_ptr */
195 #define RAM_PREALLOC (1 << 0)
197 /* RAM is mmap-ed with MAP_SHARED */
198 #define RAM_SHARED (1 << 1)
200 /* Only a portion of RAM (used_length) is actually used, and migrated.
201 * Resizing RAM while migrating can result in the migration being canceled.
203 #define RAM_RESIZEABLE (1 << 2)
205 /* UFFDIO_ZEROPAGE is available on this RAMBlock to atomically
206 * zero the page and wake waiting processes.
207 * (Set during postcopy)
209 #define RAM_UF_ZEROPAGE (1 << 3)
211 /* RAM can be migrated */
212 #define RAM_MIGRATABLE (1 << 4)
214 /* RAM is a persistent kind memory */
215 #define RAM_PMEM (1 << 5)
219 * UFFDIO_WRITEPROTECT is used on this RAMBlock to
220 * support 'write-tracking' migration type.
221 * Implies ram_state->ram_wt_enabled.
223 #define RAM_UF_WRITEPROTECT (1 << 6)
226 * RAM is mmap-ed with MAP_NORESERVE. When set, reserving swap space (or huge
227 * pages if applicable) is skipped: will bail out if not supported. When not
228 * set, the OS will do the reservation, if supported for the memory type.
230 #define RAM_NORESERVE (1 << 7)
232 /* RAM that isn't accessible through normal means. */
233 #define RAM_PROTECTED (1 << 8)
235 /* RAM is an mmap-ed named file */
236 #define RAM_NAMED_FILE (1 << 9)
238 static inline void iommu_notifier_init(IOMMUNotifier
*n
, IOMMUNotify fn
,
239 IOMMUNotifierFlag flags
,
240 hwaddr start
, hwaddr end
,
244 n
->notifier_flags
= flags
;
247 n
->iommu_idx
= iommu_idx
;
251 * Memory region callbacks
253 struct MemoryRegionOps
{
254 /* Read from the memory region. @addr is relative to @mr; @size is
256 uint64_t (*read
)(void *opaque
,
259 /* Write to the memory region. @addr is relative to @mr; @size is
261 void (*write
)(void *opaque
,
266 MemTxResult (*read_with_attrs
)(void *opaque
,
271 MemTxResult (*write_with_attrs
)(void *opaque
,
277 enum device_endian endianness
;
278 /* Guest-visible constraints: */
280 /* If nonzero, specify bounds on access sizes beyond which a machine
283 unsigned min_access_size
;
284 unsigned max_access_size
;
285 /* If true, unaligned accesses are supported. Otherwise unaligned
286 * accesses throw machine checks.
290 * If present, and returns #false, the transaction is not accepted
291 * by the device (and results in machine dependent behaviour such
292 * as a machine check exception).
294 bool (*accepts
)(void *opaque
, hwaddr addr
,
295 unsigned size
, bool is_write
,
298 /* Internal implementation constraints: */
300 /* If nonzero, specifies the minimum size implemented. Smaller sizes
301 * will be rounded upwards and a partial result will be returned.
303 unsigned min_access_size
;
304 /* If nonzero, specifies the maximum size implemented. Larger sizes
305 * will be done as a series of accesses with smaller sizes.
307 unsigned max_access_size
;
308 /* If true, unaligned accesses are supported. Otherwise all accesses
309 * are converted to (possibly multiple) naturally aligned accesses.
315 typedef struct MemoryRegionClass
{
317 ObjectClass parent_class
;
321 enum IOMMUMemoryRegionAttr
{
322 IOMMU_ATTR_SPAPR_TCE_FD
326 * IOMMUMemoryRegionClass:
328 * All IOMMU implementations need to subclass TYPE_IOMMU_MEMORY_REGION
329 * and provide an implementation of at least the @translate method here
330 * to handle requests to the memory region. Other methods are optional.
332 * The IOMMU implementation must use the IOMMU notifier infrastructure
333 * to report whenever mappings are changed, by calling
334 * memory_region_notify_iommu() (or, if necessary, by calling
335 * memory_region_notify_iommu_one() for each registered notifier).
337 * Conceptually an IOMMU provides a mapping from input address
338 * to an output TLB entry. If the IOMMU is aware of memory transaction
339 * attributes and the output TLB entry depends on the transaction
340 * attributes, we represent this using IOMMU indexes. Each index
341 * selects a particular translation table that the IOMMU has:
343 * @attrs_to_index returns the IOMMU index for a set of transaction attributes
345 * @translate takes an input address and an IOMMU index
347 * and the mapping returned can only depend on the input address and the
350 * Most IOMMUs don't care about the transaction attributes and support
351 * only a single IOMMU index. A more complex IOMMU might have one index
352 * for secure transactions and one for non-secure transactions.
354 struct IOMMUMemoryRegionClass
{
356 MemoryRegionClass parent_class
;
362 * Return a TLB entry that contains a given address.
364 * The IOMMUAccessFlags indicated via @flag are optional and may
365 * be specified as IOMMU_NONE to indicate that the caller needs
366 * the full translation information for both reads and writes. If
367 * the access flags are specified then the IOMMU implementation
368 * may use this as an optimization, to stop doing a page table
369 * walk as soon as it knows that the requested permissions are not
370 * allowed. If IOMMU_NONE is passed then the IOMMU must do the
371 * full page table walk and report the permissions in the returned
372 * IOMMUTLBEntry. (Note that this implies that an IOMMU may not
373 * return different mappings for reads and writes.)
375 * The returned information remains valid while the caller is
376 * holding the big QEMU lock or is inside an RCU critical section;
377 * if the caller wishes to cache the mapping beyond that it must
378 * register an IOMMU notifier so it can invalidate its cached
379 * information when the IOMMU mapping changes.
381 * @iommu: the IOMMUMemoryRegion
383 * @hwaddr: address to be translated within the memory region
385 * @flag: requested access permission
387 * @iommu_idx: IOMMU index for the translation
389 IOMMUTLBEntry (*translate
)(IOMMUMemoryRegion
*iommu
, hwaddr addr
,
390 IOMMUAccessFlags flag
, int iommu_idx
);
392 * @get_min_page_size:
394 * Returns minimum supported page size in bytes.
396 * If this method is not provided then the minimum is assumed to
397 * be TARGET_PAGE_SIZE.
399 * @iommu: the IOMMUMemoryRegion
401 uint64_t (*get_min_page_size
)(IOMMUMemoryRegion
*iommu
);
403 * @notify_flag_changed:
405 * Called when IOMMU Notifier flag changes (ie when the set of
406 * events which IOMMU users are requesting notification for changes).
407 * Optional method -- need not be provided if the IOMMU does not
408 * need to know exactly which events must be notified.
410 * @iommu: the IOMMUMemoryRegion
412 * @old_flags: events which previously needed to be notified
414 * @new_flags: events which now need to be notified
416 * Returns 0 on success, or a negative errno; in particular
417 * returns -EINVAL if the new flag bitmap is not supported by the
418 * IOMMU memory region. In case of failure, the error object
421 int (*notify_flag_changed
)(IOMMUMemoryRegion
*iommu
,
422 IOMMUNotifierFlag old_flags
,
423 IOMMUNotifierFlag new_flags
,
428 * Called to handle memory_region_iommu_replay().
430 * The default implementation of memory_region_iommu_replay() is to
431 * call the IOMMU translate method for every page in the address space
432 * with flag == IOMMU_NONE and then call the notifier if translate
433 * returns a valid mapping. If this method is implemented then it
434 * overrides the default behaviour, and must provide the full semantics
435 * of memory_region_iommu_replay(), by calling @notifier for every
436 * translation present in the IOMMU.
438 * Optional method -- an IOMMU only needs to provide this method
439 * if the default is inefficient or produces undesirable side effects.
441 * Note: this is not related to record-and-replay functionality.
443 void (*replay
)(IOMMUMemoryRegion
*iommu
, IOMMUNotifier
*notifier
);
448 * Get IOMMU misc attributes. This is an optional method that
449 * can be used to allow users of the IOMMU to get implementation-specific
450 * information. The IOMMU implements this method to handle calls
451 * by IOMMU users to memory_region_iommu_get_attr() by filling in
452 * the arbitrary data pointer for any IOMMUMemoryRegionAttr values that
453 * the IOMMU supports. If the method is unimplemented then
454 * memory_region_iommu_get_attr() will always return -EINVAL.
456 * @iommu: the IOMMUMemoryRegion
458 * @attr: attribute being queried
460 * @data: memory to fill in with the attribute data
462 * Returns 0 on success, or a negative errno; in particular
463 * returns -EINVAL for unrecognized or unimplemented attribute types.
465 int (*get_attr
)(IOMMUMemoryRegion
*iommu
, enum IOMMUMemoryRegionAttr attr
,
471 * Return the IOMMU index to use for a given set of transaction attributes.
473 * Optional method: if an IOMMU only supports a single IOMMU index then
474 * the default implementation of memory_region_iommu_attrs_to_index()
477 * The indexes supported by an IOMMU must be contiguous, starting at 0.
479 * @iommu: the IOMMUMemoryRegion
480 * @attrs: memory transaction attributes
482 int (*attrs_to_index
)(IOMMUMemoryRegion
*iommu
, MemTxAttrs attrs
);
487 * Return the number of IOMMU indexes this IOMMU supports.
489 * Optional method: if this method is not provided, then
490 * memory_region_iommu_num_indexes() will return 1, indicating that
491 * only a single IOMMU index is supported.
493 * @iommu: the IOMMUMemoryRegion
495 int (*num_indexes
)(IOMMUMemoryRegion
*iommu
);
498 * @iommu_set_page_size_mask:
500 * Restrict the page size mask that can be supported with a given IOMMU
501 * memory region. Used for example to propagate host physical IOMMU page
502 * size mask limitations to the virtual IOMMU.
504 * Optional method: if this method is not provided, then the default global
507 * @iommu: the IOMMUMemoryRegion
509 * @page_size_mask: a bitmask of supported page sizes. At least one bit,
510 * representing the smallest page size, must be set. Additional set bits
511 * represent supported block sizes. For example a host physical IOMMU that
512 * uses page tables with a page size of 4kB, and supports 2MB and 4GB
513 * blocks, will set mask 0x40201000. A granule of 4kB with indiscriminate
514 * block sizes is specified with mask 0xfffffffffffff000.
516 * Returns 0 on success, or a negative error. In case of failure, the error
517 * object must be created.
519 int (*iommu_set_page_size_mask
)(IOMMUMemoryRegion
*iommu
,
520 uint64_t page_size_mask
,
524 typedef struct RamDiscardListener RamDiscardListener
;
525 typedef int (*NotifyRamPopulate
)(RamDiscardListener
*rdl
,
526 MemoryRegionSection
*section
);
527 typedef void (*NotifyRamDiscard
)(RamDiscardListener
*rdl
,
528 MemoryRegionSection
*section
);
530 struct RamDiscardListener
{
534 * Notification that previously discarded memory is about to get populated.
535 * Listeners are able to object. If any listener objects, already
536 * successfully notified listeners are notified about a discard again.
538 * @rdl: the #RamDiscardListener getting notified
539 * @section: the #MemoryRegionSection to get populated. The section
540 * is aligned within the memory region to the minimum granularity
541 * unless it would exceed the registered section.
543 * Returns 0 on success. If the notification is rejected by the listener,
544 * an error is returned.
546 NotifyRamPopulate notify_populate
;
551 * Notification that previously populated memory was discarded successfully
552 * and listeners should drop all references to such memory and prevent
553 * new population (e.g., unmap).
555 * @rdl: the #RamDiscardListener getting notified
556 * @section: the #MemoryRegionSection to get populated. The section
557 * is aligned within the memory region to the minimum granularity
558 * unless it would exceed the registered section.
560 NotifyRamDiscard notify_discard
;
563 * @double_discard_supported:
565 * The listener suppors getting @notify_discard notifications that span
566 * already discarded parts.
568 bool double_discard_supported
;
570 MemoryRegionSection
*section
;
571 QLIST_ENTRY(RamDiscardListener
) next
;
574 static inline void ram_discard_listener_init(RamDiscardListener
*rdl
,
575 NotifyRamPopulate populate_fn
,
576 NotifyRamDiscard discard_fn
,
577 bool double_discard_supported
)
579 rdl
->notify_populate
= populate_fn
;
580 rdl
->notify_discard
= discard_fn
;
581 rdl
->double_discard_supported
= double_discard_supported
;
584 typedef int (*ReplayRamPopulate
)(MemoryRegionSection
*section
, void *opaque
);
585 typedef void (*ReplayRamDiscard
)(MemoryRegionSection
*section
, void *opaque
);
588 * RamDiscardManagerClass:
590 * A #RamDiscardManager coordinates which parts of specific RAM #MemoryRegion
591 * regions are currently populated to be used/accessed by the VM, notifying
592 * after parts were discarded (freeing up memory) and before parts will be
593 * populated (consuming memory), to be used/accessed by the VM.
595 * A #RamDiscardManager can only be set for a RAM #MemoryRegion while the
596 * #MemoryRegion isn't mapped yet; it cannot change while the #MemoryRegion is
599 * The #RamDiscardManager is intended to be used by technologies that are
600 * incompatible with discarding of RAM (e.g., VFIO, which may pin all
601 * memory inside a #MemoryRegion), and require proper coordination to only
602 * map the currently populated parts, to hinder parts that are expected to
603 * remain discarded from silently getting populated and consuming memory.
604 * Technologies that support discarding of RAM don't have to bother and can
605 * simply map the whole #MemoryRegion.
607 * An example #RamDiscardManager is virtio-mem, which logically (un)plugs
608 * memory within an assigned RAM #MemoryRegion, coordinated with the VM.
609 * Logically unplugging memory consists of discarding RAM. The VM agreed to not
610 * access unplugged (discarded) memory - especially via DMA. virtio-mem will
611 * properly coordinate with listeners before memory is plugged (populated),
612 * and after memory is unplugged (discarded).
614 * Listeners are called in multiples of the minimum granularity (unless it
615 * would exceed the registered range) and changes are aligned to the minimum
616 * granularity within the #MemoryRegion. Listeners have to prepare for memory
617 * becoming discarded in a different granularity than it was populated and the
620 struct RamDiscardManagerClass
{
622 InterfaceClass parent_class
;
627 * @get_min_granularity:
629 * Get the minimum granularity in which listeners will get notified
630 * about changes within the #MemoryRegion via the #RamDiscardManager.
632 * @rdm: the #RamDiscardManager
633 * @mr: the #MemoryRegion
635 * Returns the minimum granularity.
637 uint64_t (*get_min_granularity
)(const RamDiscardManager
*rdm
,
638 const MemoryRegion
*mr
);
643 * Check whether the given #MemoryRegionSection is completely populated
644 * (i.e., no parts are currently discarded) via the #RamDiscardManager.
645 * There are no alignment requirements.
647 * @rdm: the #RamDiscardManager
648 * @section: the #MemoryRegionSection
650 * Returns whether the given range is completely populated.
652 bool (*is_populated
)(const RamDiscardManager
*rdm
,
653 const MemoryRegionSection
*section
);
658 * Call the #ReplayRamPopulate callback for all populated parts within the
659 * #MemoryRegionSection via the #RamDiscardManager.
661 * In case any call fails, no further calls are made.
663 * @rdm: the #RamDiscardManager
664 * @section: the #MemoryRegionSection
665 * @replay_fn: the #ReplayRamPopulate callback
666 * @opaque: pointer to forward to the callback
668 * Returns 0 on success, or a negative error if any notification failed.
670 int (*replay_populated
)(const RamDiscardManager
*rdm
,
671 MemoryRegionSection
*section
,
672 ReplayRamPopulate replay_fn
, void *opaque
);
677 * Call the #ReplayRamDiscard callback for all discarded parts within the
678 * #MemoryRegionSection via the #RamDiscardManager.
680 * @rdm: the #RamDiscardManager
681 * @section: the #MemoryRegionSection
682 * @replay_fn: the #ReplayRamDiscard callback
683 * @opaque: pointer to forward to the callback
685 void (*replay_discarded
)(const RamDiscardManager
*rdm
,
686 MemoryRegionSection
*section
,
687 ReplayRamDiscard replay_fn
, void *opaque
);
690 * @register_listener:
692 * Register a #RamDiscardListener for the given #MemoryRegionSection and
693 * immediately notify the #RamDiscardListener about all populated parts
694 * within the #MemoryRegionSection via the #RamDiscardManager.
696 * In case any notification fails, no further notifications are triggered
697 * and an error is logged.
699 * @rdm: the #RamDiscardManager
700 * @rdl: the #RamDiscardListener
701 * @section: the #MemoryRegionSection
703 void (*register_listener
)(RamDiscardManager
*rdm
,
704 RamDiscardListener
*rdl
,
705 MemoryRegionSection
*section
);
708 * @unregister_listener:
710 * Unregister a previously registered #RamDiscardListener via the
711 * #RamDiscardManager after notifying the #RamDiscardListener about all
712 * populated parts becoming unpopulated within the registered
713 * #MemoryRegionSection.
715 * @rdm: the #RamDiscardManager
716 * @rdl: the #RamDiscardListener
718 void (*unregister_listener
)(RamDiscardManager
*rdm
,
719 RamDiscardListener
*rdl
);
722 uint64_t ram_discard_manager_get_min_granularity(const RamDiscardManager
*rdm
,
723 const MemoryRegion
*mr
);
725 bool ram_discard_manager_is_populated(const RamDiscardManager
*rdm
,
726 const MemoryRegionSection
*section
);
728 int ram_discard_manager_replay_populated(const RamDiscardManager
*rdm
,
729 MemoryRegionSection
*section
,
730 ReplayRamPopulate replay_fn
,
733 void ram_discard_manager_replay_discarded(const RamDiscardManager
*rdm
,
734 MemoryRegionSection
*section
,
735 ReplayRamDiscard replay_fn
,
738 void ram_discard_manager_register_listener(RamDiscardManager
*rdm
,
739 RamDiscardListener
*rdl
,
740 MemoryRegionSection
*section
);
742 void ram_discard_manager_unregister_listener(RamDiscardManager
*rdm
,
743 RamDiscardListener
*rdl
);
745 bool memory_get_xlat_addr(IOMMUTLBEntry
*iotlb
, void **vaddr
,
746 ram_addr_t
*ram_addr
, bool *read_only
,
747 bool *mr_has_discard_manager
);
749 typedef struct CoalescedMemoryRange CoalescedMemoryRange
;
750 typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd
;
754 * A struct representing a memory region.
756 struct MemoryRegion
{
761 /* The following fields should fit in a cache line */
765 bool readonly
; /* For RAM regions */
768 bool flush_coalesced_mmio
;
769 uint8_t dirty_log_mask
;
773 /* owner as TYPE_DEVICE. Used for re-entrancy checks in MR access hotpath */
776 const MemoryRegionOps
*ops
;
778 MemoryRegion
*container
;
779 int mapped_via_alias
; /* Mapped via an alias, container might be NULL */
782 void (*destructor
)(MemoryRegion
*mr
);
787 bool warning_printed
; /* For reservations */
788 uint8_t vga_logging_count
;
792 QTAILQ_HEAD(, MemoryRegion
) subregions
;
793 QTAILQ_ENTRY(MemoryRegion
) subregions_link
;
794 QTAILQ_HEAD(, CoalescedMemoryRange
) coalesced
;
796 unsigned ioeventfd_nb
;
797 MemoryRegionIoeventfd
*ioeventfds
;
798 RamDiscardManager
*rdm
; /* Only for RAM */
800 /* For devices designed to perform re-entrant IO into their own IO MRs */
801 bool disable_reentrancy_guard
;
804 struct IOMMUMemoryRegion
{
805 MemoryRegion parent_obj
;
807 QLIST_HEAD(, IOMMUNotifier
) iommu_notify
;
808 IOMMUNotifierFlag iommu_notify_flags
;
811 #define IOMMU_NOTIFIER_FOREACH(n, mr) \
812 QLIST_FOREACH((n), &(mr)->iommu_notify, node)
814 #define MEMORY_LISTENER_PRIORITY_MIN 0
815 #define MEMORY_LISTENER_PRIORITY_ACCEL 10
816 #define MEMORY_LISTENER_PRIORITY_DEV_BACKEND 10
819 * struct MemoryListener: callbacks structure for updates to the physical memory map
821 * Allows a component to adjust to changes in the guest-visible memory map.
822 * Use with memory_listener_register() and memory_listener_unregister().
824 struct MemoryListener
{
828 * Called at the beginning of an address space update transaction.
829 * Followed by calls to #MemoryListener.region_add(),
830 * #MemoryListener.region_del(), #MemoryListener.region_nop(),
831 * #MemoryListener.log_start() and #MemoryListener.log_stop() in
832 * increasing address order.
834 * @listener: The #MemoryListener.
836 void (*begin
)(MemoryListener
*listener
);
841 * Called at the end of an address space update transaction,
842 * after the last call to #MemoryListener.region_add(),
843 * #MemoryListener.region_del() or #MemoryListener.region_nop(),
844 * #MemoryListener.log_start() and #MemoryListener.log_stop().
846 * @listener: The #MemoryListener.
848 void (*commit
)(MemoryListener
*listener
);
853 * Called during an address space update transaction,
854 * for a section of the address space that is new in this address space
855 * space since the last transaction.
857 * @listener: The #MemoryListener.
858 * @section: The new #MemoryRegionSection.
860 void (*region_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
865 * Called during an address space update transaction,
866 * for a section of the address space that has disappeared in the address
867 * space since the last transaction.
869 * @listener: The #MemoryListener.
870 * @section: The old #MemoryRegionSection.
872 void (*region_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
877 * Called during an address space update transaction,
878 * for a section of the address space that is in the same place in the address
879 * space as in the last transaction.
881 * @listener: The #MemoryListener.
882 * @section: The #MemoryRegionSection.
884 void (*region_nop
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
889 * Called during an address space update transaction, after
890 * one of #MemoryListener.region_add(), #MemoryListener.region_del() or
891 * #MemoryListener.region_nop(), if dirty memory logging clients have
892 * become active since the last transaction.
894 * @listener: The #MemoryListener.
895 * @section: The #MemoryRegionSection.
896 * @old: A bitmap of dirty memory logging clients that were active in
897 * the previous transaction.
898 * @new: A bitmap of dirty memory logging clients that are active in
899 * the current transaction.
901 void (*log_start
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
907 * Called during an address space update transaction, after
908 * one of #MemoryListener.region_add(), #MemoryListener.region_del() or
909 * #MemoryListener.region_nop() and possibly after
910 * #MemoryListener.log_start(), if dirty memory logging clients have
911 * become inactive since the last transaction.
913 * @listener: The #MemoryListener.
914 * @section: The #MemoryRegionSection.
915 * @old: A bitmap of dirty memory logging clients that were active in
916 * the previous transaction.
917 * @new: A bitmap of dirty memory logging clients that are active in
918 * the current transaction.
920 void (*log_stop
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
926 * Called by memory_region_snapshot_and_clear_dirty() and
927 * memory_global_dirty_log_sync(), before accessing QEMU's "official"
928 * copy of the dirty memory bitmap for a #MemoryRegionSection.
930 * @listener: The #MemoryListener.
931 * @section: The #MemoryRegionSection.
933 void (*log_sync
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
938 * This is the global version of @log_sync when the listener does
939 * not have a way to synchronize the log with finer granularity.
940 * When the listener registers with @log_sync_global defined, then
941 * its @log_sync must be NULL. Vice versa.
943 * @listener: The #MemoryListener.
944 * @last_stage: The last stage to synchronize the log during migration.
945 * The caller should guarantee that the synchronization with true for
946 * @last_stage is triggered for once after all VCPUs have been stopped.
948 void (*log_sync_global
)(MemoryListener
*listener
, bool last_stage
);
953 * Called before reading the dirty memory bitmap for a
954 * #MemoryRegionSection.
956 * @listener: The #MemoryListener.
957 * @section: The #MemoryRegionSection.
959 void (*log_clear
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
964 * Called by memory_global_dirty_log_start(), which
965 * enables the %DIRTY_LOG_MIGRATION client on all memory regions in
966 * the address space. #MemoryListener.log_global_start() is also
967 * called when a #MemoryListener is added, if global dirty logging is
968 * active at that time.
970 * @listener: The #MemoryListener.
972 void (*log_global_start
)(MemoryListener
*listener
);
977 * Called by memory_global_dirty_log_stop(), which
978 * disables the %DIRTY_LOG_MIGRATION client on all memory regions in
981 * @listener: The #MemoryListener.
983 void (*log_global_stop
)(MemoryListener
*listener
);
986 * @log_global_after_sync:
988 * Called after reading the dirty memory bitmap
989 * for any #MemoryRegionSection.
991 * @listener: The #MemoryListener.
993 void (*log_global_after_sync
)(MemoryListener
*listener
);
998 * Called during an address space update transaction,
999 * for a section of the address space that has had a new ioeventfd
1000 * registration since the last transaction.
1002 * @listener: The #MemoryListener.
1003 * @section: The new #MemoryRegionSection.
1004 * @match_data: The @match_data parameter for the new ioeventfd.
1005 * @data: The @data parameter for the new ioeventfd.
1006 * @e: The #EventNotifier parameter for the new ioeventfd.
1008 void (*eventfd_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
1009 bool match_data
, uint64_t data
, EventNotifier
*e
);
1014 * Called during an address space update transaction,
1015 * for a section of the address space that has dropped an ioeventfd
1016 * registration since the last transaction.
1018 * @listener: The #MemoryListener.
1019 * @section: The new #MemoryRegionSection.
1020 * @match_data: The @match_data parameter for the dropped ioeventfd.
1021 * @data: The @data parameter for the dropped ioeventfd.
1022 * @e: The #EventNotifier parameter for the dropped ioeventfd.
1024 void (*eventfd_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
1025 bool match_data
, uint64_t data
, EventNotifier
*e
);
1028 * @coalesced_io_add:
1030 * Called during an address space update transaction,
1031 * for a section of the address space that has had a new coalesced
1032 * MMIO range registration since the last transaction.
1034 * @listener: The #MemoryListener.
1035 * @section: The new #MemoryRegionSection.
1036 * @addr: The starting address for the coalesced MMIO range.
1037 * @len: The length of the coalesced MMIO range.
1039 void (*coalesced_io_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
1040 hwaddr addr
, hwaddr len
);
1043 * @coalesced_io_del:
1045 * Called during an address space update transaction,
1046 * for a section of the address space that has dropped a coalesced
1047 * MMIO range since the last transaction.
1049 * @listener: The #MemoryListener.
1050 * @section: The new #MemoryRegionSection.
1051 * @addr: The starting address for the coalesced MMIO range.
1052 * @len: The length of the coalesced MMIO range.
1054 void (*coalesced_io_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
1055 hwaddr addr
, hwaddr len
);
1059 * Govern the order in which memory listeners are invoked. Lower priorities
1060 * are invoked earlier for "add" or "start" callbacks, and later for "delete"
1061 * or "stop" callbacks.
1068 * Name of the listener. It can be used in contexts where we'd like to
1069 * identify one memory listener with the rest.
1074 AddressSpace
*address_space
;
1075 QTAILQ_ENTRY(MemoryListener
) link
;
1076 QTAILQ_ENTRY(MemoryListener
) link_as
;
1080 * struct AddressSpace: describes a mapping of addresses to #MemoryRegion objects
1082 struct AddressSpace
{
1084 struct rcu_head rcu
;
1088 /* Accessed via RCU. */
1089 struct FlatView
*current_map
;
1092 struct MemoryRegionIoeventfd
*ioeventfds
;
1093 QTAILQ_HEAD(, MemoryListener
) listeners
;
1094 QTAILQ_ENTRY(AddressSpace
) address_spaces_link
;
1097 typedef struct AddressSpaceDispatch AddressSpaceDispatch
;
1098 typedef struct FlatRange FlatRange
;
1100 /* Flattened global view of current active memory hierarchy. Kept in sorted
1104 struct rcu_head rcu
;
1108 unsigned nr_allocated
;
1109 struct AddressSpaceDispatch
*dispatch
;
1113 static inline FlatView
*address_space_to_flatview(AddressSpace
*as
)
1115 return qatomic_rcu_read(&as
->current_map
);
1119 * typedef flatview_cb: callback for flatview_for_each_range()
1121 * @start: start address of the range within the FlatView
1122 * @len: length of the range in bytes
1123 * @mr: MemoryRegion covering this range
1124 * @offset_in_region: offset of the first byte of the range within @mr
1125 * @opaque: data pointer passed to flatview_for_each_range()
1127 * Returns: true to stop the iteration, false to keep going.
1129 typedef bool (*flatview_cb
)(Int128 start
,
1131 const MemoryRegion
*mr
,
1132 hwaddr offset_in_region
,
1136 * flatview_for_each_range: Iterate through a FlatView
1137 * @fv: the FlatView to iterate through
1138 * @cb: function to call for each range
1139 * @opaque: opaque data pointer to pass to @cb
1141 * A FlatView is made up of a list of non-overlapping ranges, each of
1142 * which is a slice of a MemoryRegion. This function iterates through
1143 * each range in @fv, calling @cb. The callback function can terminate
1144 * iteration early by returning 'true'.
1146 void flatview_for_each_range(FlatView
*fv
, flatview_cb cb
, void *opaque
);
1148 static inline bool MemoryRegionSection_eq(MemoryRegionSection
*a
,
1149 MemoryRegionSection
*b
)
1151 return a
->mr
== b
->mr
&&
1153 a
->offset_within_region
== b
->offset_within_region
&&
1154 a
->offset_within_address_space
== b
->offset_within_address_space
&&
1155 int128_eq(a
->size
, b
->size
) &&
1156 a
->readonly
== b
->readonly
&&
1157 a
->nonvolatile
== b
->nonvolatile
;
1161 * memory_region_section_new_copy: Copy a memory region section
1163 * Allocate memory for a new copy, copy the memory region section, and
1164 * properly take a reference on all relevant members.
1166 * @s: the #MemoryRegionSection to copy
1168 MemoryRegionSection
*memory_region_section_new_copy(MemoryRegionSection
*s
);
1171 * memory_region_section_new_copy: Free a copied memory region section
1173 * Free a copy of a memory section created via memory_region_section_new_copy().
1174 * properly dropping references on all relevant members.
1176 * @s: the #MemoryRegionSection to copy
1178 void memory_region_section_free_copy(MemoryRegionSection
*s
);
1181 * memory_region_init: Initialize a memory region
1183 * The region typically acts as a container for other memory regions. Use
1184 * memory_region_add_subregion() to add subregions.
1186 * @mr: the #MemoryRegion to be initialized
1187 * @owner: the object that tracks the region's reference count
1188 * @name: used for debugging; not visible to the user or ABI
1189 * @size: size of the region; any subregions beyond this size will be clipped
1191 void memory_region_init(MemoryRegion
*mr
,
1197 * memory_region_ref: Add 1 to a memory region's reference count
1199 * Whenever memory regions are accessed outside the BQL, they need to be
1200 * preserved against hot-unplug. MemoryRegions actually do not have their
1201 * own reference count; they piggyback on a QOM object, their "owner".
1202 * This function adds a reference to the owner.
1204 * All MemoryRegions must have an owner if they can disappear, even if the
1205 * device they belong to operates exclusively under the BQL. This is because
1206 * the region could be returned at any time by memory_region_find, and this
1207 * is usually under guest control.
1209 * @mr: the #MemoryRegion
1211 void memory_region_ref(MemoryRegion
*mr
);
1214 * memory_region_unref: Remove 1 to a memory region's reference count
1216 * Whenever memory regions are accessed outside the BQL, they need to be
1217 * preserved against hot-unplug. MemoryRegions actually do not have their
1218 * own reference count; they piggyback on a QOM object, their "owner".
1219 * This function removes a reference to the owner and possibly destroys it.
1221 * @mr: the #MemoryRegion
1223 void memory_region_unref(MemoryRegion
*mr
);
1226 * memory_region_init_io: Initialize an I/O memory region.
1228 * Accesses into the region will cause the callbacks in @ops to be called.
1229 * if @size is nonzero, subregions will be clipped to @size.
1231 * @mr: the #MemoryRegion to be initialized.
1232 * @owner: the object that tracks the region's reference count
1233 * @ops: a structure containing read and write callbacks to be used when
1234 * I/O is performed on the region.
1235 * @opaque: passed to the read and write callbacks of the @ops structure.
1236 * @name: used for debugging; not visible to the user or ABI
1237 * @size: size of the region.
1239 void memory_region_init_io(MemoryRegion
*mr
,
1241 const MemoryRegionOps
*ops
,
1247 * memory_region_init_ram_nomigrate: Initialize RAM memory region. Accesses
1248 * into the region will modify memory
1251 * @mr: the #MemoryRegion to be initialized.
1252 * @owner: the object that tracks the region's reference count
1253 * @name: Region name, becomes part of RAMBlock name used in migration stream
1254 * must be unique within any device
1255 * @size: size of the region.
1256 * @errp: pointer to Error*, to store an error if it happens.
1258 * Note that this function does not do anything to cause the data in the
1259 * RAM memory region to be migrated; that is the responsibility of the caller.
1261 void memory_region_init_ram_nomigrate(MemoryRegion
*mr
,
1268 * memory_region_init_ram_flags_nomigrate: Initialize RAM memory region.
1269 * Accesses into the region will
1270 * modify memory directly.
1272 * @mr: the #MemoryRegion to be initialized.
1273 * @owner: the object that tracks the region's reference count
1274 * @name: Region name, becomes part of RAMBlock name used in migration stream
1275 * must be unique within any device
1276 * @size: size of the region.
1277 * @ram_flags: RamBlock flags. Supported flags: RAM_SHARED, RAM_NORESERVE.
1278 * @errp: pointer to Error*, to store an error if it happens.
1280 * Note that this function does not do anything to cause the data in the
1281 * RAM memory region to be migrated; that is the responsibility of the caller.
1283 void memory_region_init_ram_flags_nomigrate(MemoryRegion
*mr
,
1291 * memory_region_init_resizeable_ram: Initialize memory region with resizable
1292 * RAM. Accesses into the region will
1293 * modify memory directly. Only an initial
1294 * portion of this RAM is actually used.
1295 * Changing the size while migrating
1296 * can result in the migration being
1299 * @mr: the #MemoryRegion to be initialized.
1300 * @owner: the object that tracks the region's reference count
1301 * @name: Region name, becomes part of RAMBlock name used in migration stream
1302 * must be unique within any device
1303 * @size: used size of the region.
1304 * @max_size: max size of the region.
1305 * @resized: callback to notify owner about used size change.
1306 * @errp: pointer to Error*, to store an error if it happens.
1308 * Note that this function does not do anything to cause the data in the
1309 * RAM memory region to be migrated; that is the responsibility of the caller.
1311 void memory_region_init_resizeable_ram(MemoryRegion
*mr
,
1316 void (*resized
)(const char*,
1323 * memory_region_init_ram_from_file: Initialize RAM memory region with a
1326 * @mr: the #MemoryRegion to be initialized.
1327 * @owner: the object that tracks the region's reference count
1328 * @name: Region name, becomes part of RAMBlock name used in migration stream
1329 * must be unique within any device
1330 * @size: size of the region.
1331 * @align: alignment of the region base address; if 0, the default alignment
1332 * (getpagesize()) will be used.
1333 * @ram_flags: RamBlock flags. Supported flags: RAM_SHARED, RAM_PMEM,
1335 * @path: the path in which to allocate the RAM.
1336 * @offset: offset within the file referenced by path
1337 * @readonly: true to open @path for reading, false for read/write.
1338 * @errp: pointer to Error*, to store an error if it happens.
1340 * Note that this function does not do anything to cause the data in the
1341 * RAM memory region to be migrated; that is the responsibility of the caller.
1343 void memory_region_init_ram_from_file(MemoryRegion
*mr
,
1355 * memory_region_init_ram_from_fd: Initialize RAM memory region with a
1358 * @mr: the #MemoryRegion to be initialized.
1359 * @owner: the object that tracks the region's reference count
1360 * @name: the name of the region.
1361 * @size: size of the region.
1362 * @ram_flags: RamBlock flags. Supported flags: RAM_SHARED, RAM_PMEM,
1363 * RAM_NORESERVE, RAM_PROTECTED.
1364 * @fd: the fd to mmap.
1365 * @offset: offset within the file referenced by fd
1366 * @errp: pointer to Error*, to store an error if it happens.
1368 * Note that this function does not do anything to cause the data in the
1369 * RAM memory region to be migrated; that is the responsibility of the caller.
1371 void memory_region_init_ram_from_fd(MemoryRegion
*mr
,
1382 * memory_region_init_ram_ptr: Initialize RAM memory region from a
1383 * user-provided pointer. Accesses into the
1384 * region will modify memory directly.
1386 * @mr: the #MemoryRegion to be initialized.
1387 * @owner: the object that tracks the region's reference count
1388 * @name: Region name, becomes part of RAMBlock name used in migration stream
1389 * must be unique within any device
1390 * @size: size of the region.
1391 * @ptr: memory to be mapped; must contain at least @size bytes.
1393 * Note that this function does not do anything to cause the data in the
1394 * RAM memory region to be migrated; that is the responsibility of the caller.
1396 void memory_region_init_ram_ptr(MemoryRegion
*mr
,
1403 * memory_region_init_ram_device_ptr: Initialize RAM device memory region from
1404 * a user-provided pointer.
1406 * A RAM device represents a mapping to a physical device, such as to a PCI
1407 * MMIO BAR of an vfio-pci assigned device. The memory region may be mapped
1408 * into the VM address space and access to the region will modify memory
1409 * directly. However, the memory region should not be included in a memory
1410 * dump (device may not be enabled/mapped at the time of the dump), and
1411 * operations incompatible with manipulating MMIO should be avoided. Replaces
1414 * @mr: the #MemoryRegion to be initialized.
1415 * @owner: the object that tracks the region's reference count
1416 * @name: the name of the region.
1417 * @size: size of the region.
1418 * @ptr: memory to be mapped; must contain at least @size bytes.
1420 * Note that this function does not do anything to cause the data in the
1421 * RAM memory region to be migrated; that is the responsibility of the caller.
1422 * (For RAM device memory regions, migrating the contents rarely makes sense.)
1424 void memory_region_init_ram_device_ptr(MemoryRegion
*mr
,
1431 * memory_region_init_alias: Initialize a memory region that aliases all or a
1432 * part of another memory region.
1434 * @mr: the #MemoryRegion to be initialized.
1435 * @owner: the object that tracks the region's reference count
1436 * @name: used for debugging; not visible to the user or ABI
1437 * @orig: the region to be referenced; @mr will be equivalent to
1438 * @orig between @offset and @offset + @size - 1.
1439 * @offset: start of the section in @orig to be referenced.
1440 * @size: size of the region.
1442 void memory_region_init_alias(MemoryRegion
*mr
,
1450 * memory_region_init_rom_nomigrate: Initialize a ROM memory region.
1452 * This has the same effect as calling memory_region_init_ram_nomigrate()
1453 * and then marking the resulting region read-only with
1454 * memory_region_set_readonly().
1456 * Note that this function does not do anything to cause the data in the
1457 * RAM side of the memory region to be migrated; that is the responsibility
1460 * @mr: the #MemoryRegion to be initialized.
1461 * @owner: the object that tracks the region's reference count
1462 * @name: Region name, becomes part of RAMBlock name used in migration stream
1463 * must be unique within any device
1464 * @size: size of the region.
1465 * @errp: pointer to Error*, to store an error if it happens.
1467 void memory_region_init_rom_nomigrate(MemoryRegion
*mr
,
1474 * memory_region_init_rom_device_nomigrate: Initialize a ROM memory region.
1475 * Writes are handled via callbacks.
1477 * Note that this function does not do anything to cause the data in the
1478 * RAM side of the memory region to be migrated; that is the responsibility
1481 * @mr: the #MemoryRegion to be initialized.
1482 * @owner: the object that tracks the region's reference count
1483 * @ops: callbacks for write access handling (must not be NULL).
1484 * @opaque: passed to the read and write callbacks of the @ops structure.
1485 * @name: Region name, becomes part of RAMBlock name used in migration stream
1486 * must be unique within any device
1487 * @size: size of the region.
1488 * @errp: pointer to Error*, to store an error if it happens.
1490 void memory_region_init_rom_device_nomigrate(MemoryRegion
*mr
,
1492 const MemoryRegionOps
*ops
,
1499 * memory_region_init_iommu: Initialize a memory region of a custom type
1500 * that translates addresses
1502 * An IOMMU region translates addresses and forwards accesses to a target
1505 * The IOMMU implementation must define a subclass of TYPE_IOMMU_MEMORY_REGION.
1506 * @_iommu_mr should be a pointer to enough memory for an instance of
1507 * that subclass, @instance_size is the size of that subclass, and
1508 * @mrtypename is its name. This function will initialize @_iommu_mr as an
1509 * instance of the subclass, and its methods will then be called to handle
1510 * accesses to the memory region. See the documentation of
1511 * #IOMMUMemoryRegionClass for further details.
1513 * @_iommu_mr: the #IOMMUMemoryRegion to be initialized
1514 * @instance_size: the IOMMUMemoryRegion subclass instance size
1515 * @mrtypename: the type name of the #IOMMUMemoryRegion
1516 * @owner: the object that tracks the region's reference count
1517 * @name: used for debugging; not visible to the user or ABI
1518 * @size: size of the region.
1520 void memory_region_init_iommu(void *_iommu_mr
,
1521 size_t instance_size
,
1522 const char *mrtypename
,
1528 * memory_region_init_ram - Initialize RAM memory region. Accesses into the
1529 * region will modify memory directly.
1531 * @mr: the #MemoryRegion to be initialized
1532 * @owner: the object that tracks the region's reference count (must be
1533 * TYPE_DEVICE or a subclass of TYPE_DEVICE, or NULL)
1534 * @name: name of the memory region
1535 * @size: size of the region in bytes
1536 * @errp: pointer to Error*, to store an error if it happens.
1538 * This function allocates RAM for a board model or device, and
1539 * arranges for it to be migrated (by calling vmstate_register_ram()
1540 * if @owner is a DeviceState, or vmstate_register_ram_global() if
1543 * TODO: Currently we restrict @owner to being either NULL (for
1544 * global RAM regions with no owner) or devices, so that we can
1545 * give the RAM block a unique name for migration purposes.
1546 * We should lift this restriction and allow arbitrary Objects.
1547 * If you pass a non-NULL non-device @owner then we will assert.
1549 void memory_region_init_ram(MemoryRegion
*mr
,
1556 * memory_region_init_rom: Initialize a ROM memory region.
1558 * This has the same effect as calling memory_region_init_ram()
1559 * and then marking the resulting region read-only with
1560 * memory_region_set_readonly(). This includes arranging for the
1561 * contents to be migrated.
1563 * TODO: Currently we restrict @owner to being either NULL (for
1564 * global RAM regions with no owner) or devices, so that we can
1565 * give the RAM block a unique name for migration purposes.
1566 * We should lift this restriction and allow arbitrary Objects.
1567 * If you pass a non-NULL non-device @owner then we will assert.
1569 * @mr: the #MemoryRegion to be initialized.
1570 * @owner: the object that tracks the region's reference count
1571 * @name: Region name, becomes part of RAMBlock name used in migration stream
1572 * must be unique within any device
1573 * @size: size of the region.
1574 * @errp: pointer to Error*, to store an error if it happens.
1576 void memory_region_init_rom(MemoryRegion
*mr
,
1583 * memory_region_init_rom_device: Initialize a ROM memory region.
1584 * Writes are handled via callbacks.
1586 * This function initializes a memory region backed by RAM for reads
1587 * and callbacks for writes, and arranges for the RAM backing to
1588 * be migrated (by calling vmstate_register_ram()
1589 * if @owner is a DeviceState, or vmstate_register_ram_global() if
1592 * TODO: Currently we restrict @owner to being either NULL (for
1593 * global RAM regions with no owner) or devices, so that we can
1594 * give the RAM block a unique name for migration purposes.
1595 * We should lift this restriction and allow arbitrary Objects.
1596 * If you pass a non-NULL non-device @owner then we will assert.
1598 * @mr: the #MemoryRegion to be initialized.
1599 * @owner: the object that tracks the region's reference count
1600 * @ops: callbacks for write access handling (must not be NULL).
1601 * @opaque: passed to the read and write callbacks of the @ops structure.
1602 * @name: Region name, becomes part of RAMBlock name used in migration stream
1603 * must be unique within any device
1604 * @size: size of the region.
1605 * @errp: pointer to Error*, to store an error if it happens.
1607 void memory_region_init_rom_device(MemoryRegion
*mr
,
1609 const MemoryRegionOps
*ops
,
1617 * memory_region_owner: get a memory region's owner.
1619 * @mr: the memory region being queried.
1621 Object
*memory_region_owner(MemoryRegion
*mr
);
1624 * memory_region_size: get a memory region's size.
1626 * @mr: the memory region being queried.
1628 uint64_t memory_region_size(MemoryRegion
*mr
);
1631 * memory_region_is_ram: check whether a memory region is random access
1633 * Returns %true if a memory region is random access.
1635 * @mr: the memory region being queried
1637 static inline bool memory_region_is_ram(MemoryRegion
*mr
)
1643 * memory_region_is_ram_device: check whether a memory region is a ram device
1645 * Returns %true if a memory region is a device backed ram region
1647 * @mr: the memory region being queried
1649 bool memory_region_is_ram_device(MemoryRegion
*mr
);
1652 * memory_region_is_romd: check whether a memory region is in ROMD mode
1654 * Returns %true if a memory region is a ROM device and currently set to allow
1657 * @mr: the memory region being queried
1659 static inline bool memory_region_is_romd(MemoryRegion
*mr
)
1661 return mr
->rom_device
&& mr
->romd_mode
;
1665 * memory_region_is_protected: check whether a memory region is protected
1667 * Returns %true if a memory region is protected RAM and cannot be accessed
1668 * via standard mechanisms, e.g. DMA.
1670 * @mr: the memory region being queried
1672 bool memory_region_is_protected(MemoryRegion
*mr
);
1675 * memory_region_get_iommu: check whether a memory region is an iommu
1677 * Returns pointer to IOMMUMemoryRegion if a memory region is an iommu,
1680 * @mr: the memory region being queried
1682 static inline IOMMUMemoryRegion
*memory_region_get_iommu(MemoryRegion
*mr
)
1685 return memory_region_get_iommu(mr
->alias
);
1688 return (IOMMUMemoryRegion
*) mr
;
1694 * memory_region_get_iommu_class_nocheck: returns iommu memory region class
1695 * if an iommu or NULL if not
1697 * Returns pointer to IOMMUMemoryRegionClass if a memory region is an iommu,
1698 * otherwise NULL. This is fast path avoiding QOM checking, use with caution.
1700 * @iommu_mr: the memory region being queried
1702 static inline IOMMUMemoryRegionClass
*memory_region_get_iommu_class_nocheck(
1703 IOMMUMemoryRegion
*iommu_mr
)
1705 return (IOMMUMemoryRegionClass
*) (((Object
*)iommu_mr
)->class);
1708 #define memory_region_is_iommu(mr) (memory_region_get_iommu(mr) != NULL)
1711 * memory_region_iommu_get_min_page_size: get minimum supported page size
1714 * Returns minimum supported page size for an iommu.
1716 * @iommu_mr: the memory region being queried
1718 uint64_t memory_region_iommu_get_min_page_size(IOMMUMemoryRegion
*iommu_mr
);
1721 * memory_region_notify_iommu: notify a change in an IOMMU translation entry.
1723 * Note: for any IOMMU implementation, an in-place mapping change
1724 * should be notified with an UNMAP followed by a MAP.
1726 * @iommu_mr: the memory region that was changed
1727 * @iommu_idx: the IOMMU index for the translation table which has changed
1728 * @event: TLB event with the new entry in the IOMMU translation table.
1729 * The entry replaces all old entries for the same virtual I/O address
1732 void memory_region_notify_iommu(IOMMUMemoryRegion
*iommu_mr
,
1734 IOMMUTLBEvent event
);
1737 * memory_region_notify_iommu_one: notify a change in an IOMMU translation
1738 * entry to a single notifier
1740 * This works just like memory_region_notify_iommu(), but it only
1741 * notifies a specific notifier, not all of them.
1743 * @notifier: the notifier to be notified
1744 * @event: TLB event with the new entry in the IOMMU translation table.
1745 * The entry replaces all old entries for the same virtual I/O address
1748 void memory_region_notify_iommu_one(IOMMUNotifier
*notifier
,
1749 IOMMUTLBEvent
*event
);
1752 * memory_region_unmap_iommu_notifier_range: notify a unmap for an IOMMU
1753 * translation that covers the
1754 * range of a notifier
1756 * @notifier: the notifier to be notified
1758 void memory_region_unmap_iommu_notifier_range(IOMMUNotifier
*notifier
);
1762 * memory_region_register_iommu_notifier: register a notifier for changes to
1763 * IOMMU translation entries.
1765 * Returns 0 on success, or a negative errno otherwise. In particular,
1766 * -EINVAL indicates that at least one of the attributes of the notifier
1767 * is not supported (flag/range) by the IOMMU memory region. In case of error
1768 * the error object must be created.
1770 * @mr: the memory region to observe
1771 * @n: the IOMMUNotifier to be added; the notify callback receives a
1772 * pointer to an #IOMMUTLBEntry as the opaque value; the pointer
1773 * ceases to be valid on exit from the notifier.
1774 * @errp: pointer to Error*, to store an error if it happens.
1776 int memory_region_register_iommu_notifier(MemoryRegion
*mr
,
1777 IOMMUNotifier
*n
, Error
**errp
);
1780 * memory_region_iommu_replay: replay existing IOMMU translations to
1781 * a notifier with the minimum page granularity returned by
1782 * mr->iommu_ops->get_page_size().
1784 * Note: this is not related to record-and-replay functionality.
1786 * @iommu_mr: the memory region to observe
1787 * @n: the notifier to which to replay iommu mappings
1789 void memory_region_iommu_replay(IOMMUMemoryRegion
*iommu_mr
, IOMMUNotifier
*n
);
1792 * memory_region_unregister_iommu_notifier: unregister a notifier for
1793 * changes to IOMMU translation entries.
1795 * @mr: the memory region which was observed and for which notity_stopped()
1796 * needs to be called
1797 * @n: the notifier to be removed.
1799 void memory_region_unregister_iommu_notifier(MemoryRegion
*mr
,
1803 * memory_region_iommu_get_attr: return an IOMMU attr if get_attr() is
1804 * defined on the IOMMU.
1806 * Returns 0 on success, or a negative errno otherwise. In particular,
1807 * -EINVAL indicates that the IOMMU does not support the requested
1810 * @iommu_mr: the memory region
1811 * @attr: the requested attribute
1812 * @data: a pointer to the requested attribute data
1814 int memory_region_iommu_get_attr(IOMMUMemoryRegion
*iommu_mr
,
1815 enum IOMMUMemoryRegionAttr attr
,
1819 * memory_region_iommu_attrs_to_index: return the IOMMU index to
1820 * use for translations with the given memory transaction attributes.
1822 * @iommu_mr: the memory region
1823 * @attrs: the memory transaction attributes
1825 int memory_region_iommu_attrs_to_index(IOMMUMemoryRegion
*iommu_mr
,
1829 * memory_region_iommu_num_indexes: return the total number of IOMMU
1830 * indexes that this IOMMU supports.
1832 * @iommu_mr: the memory region
1834 int memory_region_iommu_num_indexes(IOMMUMemoryRegion
*iommu_mr
);
1837 * memory_region_iommu_set_page_size_mask: set the supported page
1838 * sizes for a given IOMMU memory region
1840 * @iommu_mr: IOMMU memory region
1841 * @page_size_mask: supported page size mask
1842 * @errp: pointer to Error*, to store an error if it happens.
1844 int memory_region_iommu_set_page_size_mask(IOMMUMemoryRegion
*iommu_mr
,
1845 uint64_t page_size_mask
,
1849 * memory_region_name: get a memory region's name
1851 * Returns the string that was used to initialize the memory region.
1853 * @mr: the memory region being queried
1855 const char *memory_region_name(const MemoryRegion
*mr
);
1858 * memory_region_is_logging: return whether a memory region is logging writes
1860 * Returns %true if the memory region is logging writes for the given client
1862 * @mr: the memory region being queried
1863 * @client: the client being queried
1865 bool memory_region_is_logging(MemoryRegion
*mr
, uint8_t client
);
1868 * memory_region_get_dirty_log_mask: return the clients for which a
1869 * memory region is logging writes.
1871 * Returns a bitmap of clients, in which the DIRTY_MEMORY_* constants
1872 * are the bit indices.
1874 * @mr: the memory region being queried
1876 uint8_t memory_region_get_dirty_log_mask(MemoryRegion
*mr
);
1879 * memory_region_is_rom: check whether a memory region is ROM
1881 * Returns %true if a memory region is read-only memory.
1883 * @mr: the memory region being queried
1885 static inline bool memory_region_is_rom(MemoryRegion
*mr
)
1887 return mr
->ram
&& mr
->readonly
;
1891 * memory_region_is_nonvolatile: check whether a memory region is non-volatile
1893 * Returns %true is a memory region is non-volatile memory.
1895 * @mr: the memory region being queried
1897 static inline bool memory_region_is_nonvolatile(MemoryRegion
*mr
)
1899 return mr
->nonvolatile
;
1903 * memory_region_get_fd: Get a file descriptor backing a RAM memory region.
1905 * Returns a file descriptor backing a file-based RAM memory region,
1906 * or -1 if the region is not a file-based RAM memory region.
1908 * @mr: the RAM or alias memory region being queried.
1910 int memory_region_get_fd(MemoryRegion
*mr
);
1913 * memory_region_from_host: Convert a pointer into a RAM memory region
1914 * and an offset within it.
1916 * Given a host pointer inside a RAM memory region (created with
1917 * memory_region_init_ram() or memory_region_init_ram_ptr()), return
1918 * the MemoryRegion and the offset within it.
1920 * Use with care; by the time this function returns, the returned pointer is
1921 * not protected by RCU anymore. If the caller is not within an RCU critical
1922 * section and does not hold the iothread lock, it must have other means of
1923 * protecting the pointer, such as a reference to the region that includes
1924 * the incoming ram_addr_t.
1926 * @ptr: the host pointer to be converted
1927 * @offset: the offset within memory region
1929 MemoryRegion
*memory_region_from_host(void *ptr
, ram_addr_t
*offset
);
1932 * memory_region_get_ram_ptr: Get a pointer into a RAM memory region.
1934 * Returns a host pointer to a RAM memory region (created with
1935 * memory_region_init_ram() or memory_region_init_ram_ptr()).
1937 * Use with care; by the time this function returns, the returned pointer is
1938 * not protected by RCU anymore. If the caller is not within an RCU critical
1939 * section and does not hold the iothread lock, it must have other means of
1940 * protecting the pointer, such as a reference to the region that includes
1941 * the incoming ram_addr_t.
1943 * @mr: the memory region being queried.
1945 void *memory_region_get_ram_ptr(MemoryRegion
*mr
);
1947 /* memory_region_ram_resize: Resize a RAM region.
1949 * Resizing RAM while migrating can result in the migration being canceled.
1950 * Care has to be taken if the guest might have already detected the memory.
1952 * @mr: a memory region created with @memory_region_init_resizeable_ram.
1953 * @newsize: the new size the region
1954 * @errp: pointer to Error*, to store an error if it happens.
1956 void memory_region_ram_resize(MemoryRegion
*mr
, ram_addr_t newsize
,
1960 * memory_region_msync: Synchronize selected address range of
1961 * a memory mapped region
1963 * @mr: the memory region to be msync
1964 * @addr: the initial address of the range to be sync
1965 * @size: the size of the range to be sync
1967 void memory_region_msync(MemoryRegion
*mr
, hwaddr addr
, hwaddr size
);
1970 * memory_region_writeback: Trigger cache writeback for
1971 * selected address range
1973 * @mr: the memory region to be updated
1974 * @addr: the initial address of the range to be written back
1975 * @size: the size of the range to be written back
1977 void memory_region_writeback(MemoryRegion
*mr
, hwaddr addr
, hwaddr size
);
1980 * memory_region_set_log: Turn dirty logging on or off for a region.
1982 * Turns dirty logging on or off for a specified client (display, migration).
1983 * Only meaningful for RAM regions.
1985 * @mr: the memory region being updated.
1986 * @log: whether dirty logging is to be enabled or disabled.
1987 * @client: the user of the logging information; %DIRTY_MEMORY_VGA only.
1989 void memory_region_set_log(MemoryRegion
*mr
, bool log
, unsigned client
);
1992 * memory_region_set_dirty: Mark a range of bytes as dirty in a memory region.
1994 * Marks a range of bytes as dirty, after it has been dirtied outside
1997 * @mr: the memory region being dirtied.
1998 * @addr: the address (relative to the start of the region) being dirtied.
1999 * @size: size of the range being dirtied.
2001 void memory_region_set_dirty(MemoryRegion
*mr
, hwaddr addr
,
2005 * memory_region_clear_dirty_bitmap - clear dirty bitmap for memory range
2007 * This function is called when the caller wants to clear the remote
2008 * dirty bitmap of a memory range within the memory region. This can
2009 * be used by e.g. KVM to manually clear dirty log when
2010 * KVM_CAP_MANUAL_DIRTY_LOG_PROTECT is declared support by the host
2013 * @mr: the memory region to clear the dirty log upon
2014 * @start: start address offset within the memory region
2015 * @len: length of the memory region to clear dirty bitmap
2017 void memory_region_clear_dirty_bitmap(MemoryRegion
*mr
, hwaddr start
,
2021 * memory_region_snapshot_and_clear_dirty: Get a snapshot of the dirty
2022 * bitmap and clear it.
2024 * Creates a snapshot of the dirty bitmap, clears the dirty bitmap and
2025 * returns the snapshot. The snapshot can then be used to query dirty
2026 * status, using memory_region_snapshot_get_dirty. Snapshotting allows
2027 * querying the same page multiple times, which is especially useful for
2028 * display updates where the scanlines often are not page aligned.
2030 * The dirty bitmap region which gets copied into the snapshot (and
2031 * cleared afterwards) can be larger than requested. The boundaries
2032 * are rounded up/down so complete bitmap longs (covering 64 pages on
2033 * 64bit hosts) can be copied over into the bitmap snapshot. Which
2034 * isn't a problem for display updates as the extra pages are outside
2035 * the visible area, and in case the visible area changes a full
2036 * display redraw is due anyway. Should other use cases for this
2037 * function emerge we might have to revisit this implementation
2040 * Use g_free to release DirtyBitmapSnapshot.
2042 * @mr: the memory region being queried.
2043 * @addr: the address (relative to the start of the region) being queried.
2044 * @size: the size of the range being queried.
2045 * @client: the user of the logging information; typically %DIRTY_MEMORY_VGA.
2047 DirtyBitmapSnapshot
*memory_region_snapshot_and_clear_dirty(MemoryRegion
*mr
,
2053 * memory_region_snapshot_get_dirty: Check whether a range of bytes is dirty
2054 * in the specified dirty bitmap snapshot.
2056 * @mr: the memory region being queried.
2057 * @snap: the dirty bitmap snapshot
2058 * @addr: the address (relative to the start of the region) being queried.
2059 * @size: the size of the range being queried.
2061 bool memory_region_snapshot_get_dirty(MemoryRegion
*mr
,
2062 DirtyBitmapSnapshot
*snap
,
2063 hwaddr addr
, hwaddr size
);
2066 * memory_region_reset_dirty: Mark a range of pages as clean, for a specified
2069 * Marks a range of pages as no longer dirty.
2071 * @mr: the region being updated.
2072 * @addr: the start of the subrange being cleaned.
2073 * @size: the size of the subrange being cleaned.
2074 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
2075 * %DIRTY_MEMORY_VGA.
2077 void memory_region_reset_dirty(MemoryRegion
*mr
, hwaddr addr
,
2078 hwaddr size
, unsigned client
);
2081 * memory_region_flush_rom_device: Mark a range of pages dirty and invalidate
2082 * TBs (for self-modifying code).
2084 * The MemoryRegionOps->write() callback of a ROM device must use this function
2085 * to mark byte ranges that have been modified internally, such as by directly
2086 * accessing the memory returned by memory_region_get_ram_ptr().
2088 * This function marks the range dirty and invalidates TBs so that TCG can
2089 * detect self-modifying code.
2091 * @mr: the region being flushed.
2092 * @addr: the start, relative to the start of the region, of the range being
2094 * @size: the size, in bytes, of the range being flushed.
2096 void memory_region_flush_rom_device(MemoryRegion
*mr
, hwaddr addr
, hwaddr size
);
2099 * memory_region_set_readonly: Turn a memory region read-only (or read-write)
2101 * Allows a memory region to be marked as read-only (turning it into a ROM).
2102 * only useful on RAM regions.
2104 * @mr: the region being updated.
2105 * @readonly: whether rhe region is to be ROM or RAM.
2107 void memory_region_set_readonly(MemoryRegion
*mr
, bool readonly
);
2110 * memory_region_set_nonvolatile: Turn a memory region non-volatile
2112 * Allows a memory region to be marked as non-volatile.
2113 * only useful on RAM regions.
2115 * @mr: the region being updated.
2116 * @nonvolatile: whether rhe region is to be non-volatile.
2118 void memory_region_set_nonvolatile(MemoryRegion
*mr
, bool nonvolatile
);
2121 * memory_region_rom_device_set_romd: enable/disable ROMD mode
2123 * Allows a ROM device (initialized with memory_region_init_rom_device() to
2124 * set to ROMD mode (default) or MMIO mode. When it is in ROMD mode, the
2125 * device is mapped to guest memory and satisfies read access directly.
2126 * When in MMIO mode, reads are forwarded to the #MemoryRegion.read function.
2127 * Writes are always handled by the #MemoryRegion.write function.
2129 * @mr: the memory region to be updated
2130 * @romd_mode: %true to put the region into ROMD mode
2132 void memory_region_rom_device_set_romd(MemoryRegion
*mr
, bool romd_mode
);
2135 * memory_region_set_coalescing: Enable memory coalescing for the region.
2137 * Enabled writes to a region to be queued for later processing. MMIO ->write
2138 * callbacks may be delayed until a non-coalesced MMIO is issued.
2139 * Only useful for IO regions. Roughly similar to write-combining hardware.
2141 * @mr: the memory region to be write coalesced
2143 void memory_region_set_coalescing(MemoryRegion
*mr
);
2146 * memory_region_add_coalescing: Enable memory coalescing for a sub-range of
2149 * Like memory_region_set_coalescing(), but works on a sub-range of a region.
2150 * Multiple calls can be issued coalesced disjoint ranges.
2152 * @mr: the memory region to be updated.
2153 * @offset: the start of the range within the region to be coalesced.
2154 * @size: the size of the subrange to be coalesced.
2156 void memory_region_add_coalescing(MemoryRegion
*mr
,
2161 * memory_region_clear_coalescing: Disable MMIO coalescing for the region.
2163 * Disables any coalescing caused by memory_region_set_coalescing() or
2164 * memory_region_add_coalescing(). Roughly equivalent to uncacheble memory
2167 * @mr: the memory region to be updated.
2169 void memory_region_clear_coalescing(MemoryRegion
*mr
);
2172 * memory_region_set_flush_coalesced: Enforce memory coalescing flush before
2175 * Ensure that pending coalesced MMIO request are flushed before the memory
2176 * region is accessed. This property is automatically enabled for all regions
2177 * passed to memory_region_set_coalescing() and memory_region_add_coalescing().
2179 * @mr: the memory region to be updated.
2181 void memory_region_set_flush_coalesced(MemoryRegion
*mr
);
2184 * memory_region_clear_flush_coalesced: Disable memory coalescing flush before
2187 * Clear the automatic coalesced MMIO flushing enabled via
2188 * memory_region_set_flush_coalesced. Note that this service has no effect on
2189 * memory regions that have MMIO coalescing enabled for themselves. For them,
2190 * automatic flushing will stop once coalescing is disabled.
2192 * @mr: the memory region to be updated.
2194 void memory_region_clear_flush_coalesced(MemoryRegion
*mr
);
2197 * memory_region_add_eventfd: Request an eventfd to be triggered when a word
2198 * is written to a location.
2200 * Marks a word in an IO region (initialized with memory_region_init_io())
2201 * as a trigger for an eventfd event. The I/O callback will not be called.
2202 * The caller must be prepared to handle failure (that is, take the required
2203 * action if the callback _is_ called).
2205 * @mr: the memory region being updated.
2206 * @addr: the address within @mr that is to be monitored
2207 * @size: the size of the access to trigger the eventfd
2208 * @match_data: whether to match against @data, instead of just @addr
2209 * @data: the data to match against the guest write
2210 * @e: event notifier to be triggered when @addr, @size, and @data all match.
2212 void memory_region_add_eventfd(MemoryRegion
*mr
,
2220 * memory_region_del_eventfd: Cancel an eventfd.
2222 * Cancels an eventfd trigger requested by a previous
2223 * memory_region_add_eventfd() call.
2225 * @mr: the memory region being updated.
2226 * @addr: the address within @mr that is to be monitored
2227 * @size: the size of the access to trigger the eventfd
2228 * @match_data: whether to match against @data, instead of just @addr
2229 * @data: the data to match against the guest write
2230 * @e: event notifier to be triggered when @addr, @size, and @data all match.
2232 void memory_region_del_eventfd(MemoryRegion
*mr
,
2240 * memory_region_add_subregion: Add a subregion to a container.
2242 * Adds a subregion at @offset. The subregion may not overlap with other
2243 * subregions (except for those explicitly marked as overlapping). A region
2244 * may only be added once as a subregion (unless removed with
2245 * memory_region_del_subregion()); use memory_region_init_alias() if you
2246 * want a region to be a subregion in multiple locations.
2248 * @mr: the region to contain the new subregion; must be a container
2249 * initialized with memory_region_init().
2250 * @offset: the offset relative to @mr where @subregion is added.
2251 * @subregion: the subregion to be added.
2253 void memory_region_add_subregion(MemoryRegion
*mr
,
2255 MemoryRegion
*subregion
);
2257 * memory_region_add_subregion_overlap: Add a subregion to a container
2260 * Adds a subregion at @offset. The subregion may overlap with other
2261 * subregions. Conflicts are resolved by having a higher @priority hide a
2262 * lower @priority. Subregions without priority are taken as @priority 0.
2263 * A region may only be added once as a subregion (unless removed with
2264 * memory_region_del_subregion()); use memory_region_init_alias() if you
2265 * want a region to be a subregion in multiple locations.
2267 * @mr: the region to contain the new subregion; must be a container
2268 * initialized with memory_region_init().
2269 * @offset: the offset relative to @mr where @subregion is added.
2270 * @subregion: the subregion to be added.
2271 * @priority: used for resolving overlaps; highest priority wins.
2273 void memory_region_add_subregion_overlap(MemoryRegion
*mr
,
2275 MemoryRegion
*subregion
,
2279 * memory_region_get_ram_addr: Get the ram address associated with a memory
2282 * @mr: the region to be queried
2284 ram_addr_t
memory_region_get_ram_addr(MemoryRegion
*mr
);
2286 uint64_t memory_region_get_alignment(const MemoryRegion
*mr
);
2288 * memory_region_del_subregion: Remove a subregion.
2290 * Removes a subregion from its container.
2292 * @mr: the container to be updated.
2293 * @subregion: the region being removed; must be a current subregion of @mr.
2295 void memory_region_del_subregion(MemoryRegion
*mr
,
2296 MemoryRegion
*subregion
);
2299 * memory_region_set_enabled: dynamically enable or disable a region
2301 * Enables or disables a memory region. A disabled memory region
2302 * ignores all accesses to itself and its subregions. It does not
2303 * obscure sibling subregions with lower priority - it simply behaves as
2304 * if it was removed from the hierarchy.
2306 * Regions default to being enabled.
2308 * @mr: the region to be updated
2309 * @enabled: whether to enable or disable the region
2311 void memory_region_set_enabled(MemoryRegion
*mr
, bool enabled
);
2314 * memory_region_set_address: dynamically update the address of a region
2316 * Dynamically updates the address of a region, relative to its container.
2317 * May be used on regions are currently part of a memory hierarchy.
2319 * @mr: the region to be updated
2320 * @addr: new address, relative to container region
2322 void memory_region_set_address(MemoryRegion
*mr
, hwaddr addr
);
2325 * memory_region_set_size: dynamically update the size of a region.
2327 * Dynamically updates the size of a region.
2329 * @mr: the region to be updated
2330 * @size: used size of the region.
2332 void memory_region_set_size(MemoryRegion
*mr
, uint64_t size
);
2335 * memory_region_set_alias_offset: dynamically update a memory alias's offset
2337 * Dynamically updates the offset into the target region that an alias points
2338 * to, as if the fourth argument to memory_region_init_alias() has changed.
2340 * @mr: the #MemoryRegion to be updated; should be an alias.
2341 * @offset: the new offset into the target memory region
2343 void memory_region_set_alias_offset(MemoryRegion
*mr
,
2347 * memory_region_present: checks if an address relative to a @container
2348 * translates into #MemoryRegion within @container
2350 * Answer whether a #MemoryRegion within @container covers the address
2353 * @container: a #MemoryRegion within which @addr is a relative address
2354 * @addr: the area within @container to be searched
2356 bool memory_region_present(MemoryRegion
*container
, hwaddr addr
);
2359 * memory_region_is_mapped: returns true if #MemoryRegion is mapped
2360 * into another memory region, which does not necessarily imply that it is
2361 * mapped into an address space.
2363 * @mr: a #MemoryRegion which should be checked if it's mapped
2365 bool memory_region_is_mapped(MemoryRegion
*mr
);
2368 * memory_region_get_ram_discard_manager: get the #RamDiscardManager for a
2371 * The #RamDiscardManager cannot change while a memory region is mapped.
2373 * @mr: the #MemoryRegion
2375 RamDiscardManager
*memory_region_get_ram_discard_manager(MemoryRegion
*mr
);
2378 * memory_region_has_ram_discard_manager: check whether a #MemoryRegion has a
2379 * #RamDiscardManager assigned
2381 * @mr: the #MemoryRegion
2383 static inline bool memory_region_has_ram_discard_manager(MemoryRegion
*mr
)
2385 return !!memory_region_get_ram_discard_manager(mr
);
2389 * memory_region_set_ram_discard_manager: set the #RamDiscardManager for a
2392 * This function must not be called for a mapped #MemoryRegion, a #MemoryRegion
2393 * that does not cover RAM, or a #MemoryRegion that already has a
2394 * #RamDiscardManager assigned.
2396 * @mr: the #MemoryRegion
2397 * @rdm: #RamDiscardManager to set
2399 void memory_region_set_ram_discard_manager(MemoryRegion
*mr
,
2400 RamDiscardManager
*rdm
);
2403 * memory_region_find: translate an address/size relative to a
2404 * MemoryRegion into a #MemoryRegionSection.
2406 * Locates the first #MemoryRegion within @mr that overlaps the range
2407 * given by @addr and @size.
2409 * Returns a #MemoryRegionSection that describes a contiguous overlap.
2410 * It will have the following characteristics:
2411 * - @size = 0 iff no overlap was found
2412 * - @mr is non-%NULL iff an overlap was found
2414 * Remember that in the return value the @offset_within_region is
2415 * relative to the returned region (in the .@mr field), not to the
2418 * Similarly, the .@offset_within_address_space is relative to the
2419 * address space that contains both regions, the passed and the
2420 * returned one. However, in the special case where the @mr argument
2421 * has no container (and thus is the root of the address space), the
2422 * following will hold:
2423 * - @offset_within_address_space >= @addr
2424 * - @offset_within_address_space + .@size <= @addr + @size
2426 * @mr: a MemoryRegion within which @addr is a relative address
2427 * @addr: start of the area within @as to be searched
2428 * @size: size of the area to be searched
2430 MemoryRegionSection
memory_region_find(MemoryRegion
*mr
,
2431 hwaddr addr
, uint64_t size
);
2434 * memory_global_dirty_log_sync: synchronize the dirty log for all memory
2436 * Synchronizes the dirty page log for all address spaces.
2438 * @last_stage: whether this is the last stage of live migration
2440 void memory_global_dirty_log_sync(bool last_stage
);
2443 * memory_global_dirty_log_sync: synchronize the dirty log for all memory
2445 * Synchronizes the vCPUs with a thread that is reading the dirty bitmap.
2446 * This function must be called after the dirty log bitmap is cleared, and
2447 * before dirty guest memory pages are read. If you are using
2448 * #DirtyBitmapSnapshot, memory_region_snapshot_and_clear_dirty() takes
2449 * care of doing this.
2451 void memory_global_after_dirty_log_sync(void);
2454 * memory_region_transaction_begin: Start a transaction.
2456 * During a transaction, changes will be accumulated and made visible
2457 * only when the transaction ends (is committed).
2459 void memory_region_transaction_begin(void);
2462 * memory_region_transaction_commit: Commit a transaction and make changes
2463 * visible to the guest.
2465 void memory_region_transaction_commit(void);
2468 * memory_listener_register: register callbacks to be called when memory
2469 * sections are mapped or unmapped into an address
2472 * @listener: an object containing the callbacks to be called
2473 * @filter: if non-%NULL, only regions in this address space will be observed
2475 void memory_listener_register(MemoryListener
*listener
, AddressSpace
*filter
);
2478 * memory_listener_unregister: undo the effect of memory_listener_register()
2480 * @listener: an object containing the callbacks to be removed
2482 void memory_listener_unregister(MemoryListener
*listener
);
2485 * memory_global_dirty_log_start: begin dirty logging for all regions
2487 * @flags: purpose of starting dirty log, migration or dirty rate
2489 void memory_global_dirty_log_start(unsigned int flags
);
2492 * memory_global_dirty_log_stop: end dirty logging for all regions
2494 * @flags: purpose of stopping dirty log, migration or dirty rate
2496 void memory_global_dirty_log_stop(unsigned int flags
);
2498 void mtree_info(bool flatview
, bool dispatch_tree
, bool owner
, bool disabled
);
2500 bool memory_region_access_valid(MemoryRegion
*mr
, hwaddr addr
,
2501 unsigned size
, bool is_write
,
2505 * memory_region_dispatch_read: perform a read directly to the specified
2508 * @mr: #MemoryRegion to access
2509 * @addr: address within that region
2510 * @pval: pointer to uint64_t which the data is written to
2511 * @op: size, sign, and endianness of the memory operation
2512 * @attrs: memory transaction attributes to use for the access
2514 MemTxResult
memory_region_dispatch_read(MemoryRegion
*mr
,
2520 * memory_region_dispatch_write: perform a write directly to the specified
2523 * @mr: #MemoryRegion to access
2524 * @addr: address within that region
2525 * @data: data to write
2526 * @op: size, sign, and endianness of the memory operation
2527 * @attrs: memory transaction attributes to use for the access
2529 MemTxResult
memory_region_dispatch_write(MemoryRegion
*mr
,
2536 * address_space_init: initializes an address space
2538 * @as: an uninitialized #AddressSpace
2539 * @root: a #MemoryRegion that routes addresses for the address space
2540 * @name: an address space name. The name is only used for debugging
2543 void address_space_init(AddressSpace
*as
, MemoryRegion
*root
, const char *name
);
2546 * address_space_destroy: destroy an address space
2548 * Releases all resources associated with an address space. After an address space
2549 * is destroyed, its root memory region (given by address_space_init()) may be destroyed
2552 * @as: address space to be destroyed
2554 void address_space_destroy(AddressSpace
*as
);
2557 * address_space_remove_listeners: unregister all listeners of an address space
2559 * Removes all callbacks previously registered with memory_listener_register()
2562 * @as: an initialized #AddressSpace
2564 void address_space_remove_listeners(AddressSpace
*as
);
2567 * address_space_rw: read from or write to an address space.
2569 * Return a MemTxResult indicating whether the operation succeeded
2570 * or failed (eg unassigned memory, device rejected the transaction,
2573 * @as: #AddressSpace to be accessed
2574 * @addr: address within that address space
2575 * @attrs: memory transaction attributes
2576 * @buf: buffer with the data transferred
2577 * @len: the number of bytes to read or write
2578 * @is_write: indicates the transfer direction
2580 MemTxResult
address_space_rw(AddressSpace
*as
, hwaddr addr
,
2581 MemTxAttrs attrs
, void *buf
,
2582 hwaddr len
, bool is_write
);
2585 * address_space_write: write to address space.
2587 * Return a MemTxResult indicating whether the operation succeeded
2588 * or failed (eg unassigned memory, device rejected the transaction,
2591 * @as: #AddressSpace to be accessed
2592 * @addr: address within that address space
2593 * @attrs: memory transaction attributes
2594 * @buf: buffer with the data transferred
2595 * @len: the number of bytes to write
2597 MemTxResult
address_space_write(AddressSpace
*as
, hwaddr addr
,
2599 const void *buf
, hwaddr len
);
2602 * address_space_write_rom: write to address space, including ROM.
2604 * This function writes to the specified address space, but will
2605 * write data to both ROM and RAM. This is used for non-guest
2606 * writes like writes from the gdb debug stub or initial loading
2609 * Note that portions of the write which attempt to write data to
2610 * a device will be silently ignored -- only real RAM and ROM will
2613 * Return a MemTxResult indicating whether the operation succeeded
2614 * or failed (eg unassigned memory, device rejected the transaction,
2617 * @as: #AddressSpace to be accessed
2618 * @addr: address within that address space
2619 * @attrs: memory transaction attributes
2620 * @buf: buffer with the data transferred
2621 * @len: the number of bytes to write
2623 MemTxResult
address_space_write_rom(AddressSpace
*as
, hwaddr addr
,
2625 const void *buf
, hwaddr len
);
2627 /* address_space_ld*: load from an address space
2628 * address_space_st*: store to an address space
2630 * These functions perform a load or store of the byte, word,
2631 * longword or quad to the specified address within the AddressSpace.
2632 * The _le suffixed functions treat the data as little endian;
2633 * _be indicates big endian; no suffix indicates "same endianness
2636 * The "guest CPU endianness" accessors are deprecated for use outside
2637 * target-* code; devices should be CPU-agnostic and use either the LE
2638 * or the BE accessors.
2640 * @as #AddressSpace to be accessed
2641 * @addr: address within that address space
2642 * @val: data value, for stores
2643 * @attrs: memory transaction attributes
2644 * @result: location to write the success/failure of the transaction;
2645 * if NULL, this information is discarded
2650 #define ARG1_DECL AddressSpace *as
2651 #include "exec/memory_ldst.h.inc"
2655 #define ARG1_DECL AddressSpace *as
2656 #include "exec/memory_ldst_phys.h.inc"
2658 struct MemoryRegionCache
{
2663 MemoryRegionSection mrs
;
2667 #define MEMORY_REGION_CACHE_INVALID ((MemoryRegionCache) { .mrs.mr = NULL })
2670 /* address_space_ld*_cached: load from a cached #MemoryRegion
2671 * address_space_st*_cached: store into a cached #MemoryRegion
2673 * These functions perform a load or store of the byte, word,
2674 * longword or quad to the specified address. The address is
2675 * a physical address in the AddressSpace, but it must lie within
2676 * a #MemoryRegion that was mapped with address_space_cache_init.
2678 * The _le suffixed functions treat the data as little endian;
2679 * _be indicates big endian; no suffix indicates "same endianness
2682 * The "guest CPU endianness" accessors are deprecated for use outside
2683 * target-* code; devices should be CPU-agnostic and use either the LE
2684 * or the BE accessors.
2686 * @cache: previously initialized #MemoryRegionCache to be accessed
2687 * @addr: address within the address space
2688 * @val: data value, for stores
2689 * @attrs: memory transaction attributes
2690 * @result: location to write the success/failure of the transaction;
2691 * if NULL, this information is discarded
2694 #define SUFFIX _cached_slow
2696 #define ARG1_DECL MemoryRegionCache *cache
2697 #include "exec/memory_ldst.h.inc"
2699 /* Inline fast path for direct RAM access. */
2700 static inline uint8_t address_space_ldub_cached(MemoryRegionCache
*cache
,
2701 hwaddr addr
, MemTxAttrs attrs
, MemTxResult
*result
)
2703 assert(addr
< cache
->len
);
2704 if (likely(cache
->ptr
)) {
2705 return ldub_p(cache
->ptr
+ addr
);
2707 return address_space_ldub_cached_slow(cache
, addr
, attrs
, result
);
2711 static inline void address_space_stb_cached(MemoryRegionCache
*cache
,
2712 hwaddr addr
, uint8_t val
, MemTxAttrs attrs
, MemTxResult
*result
)
2714 assert(addr
< cache
->len
);
2715 if (likely(cache
->ptr
)) {
2716 stb_p(cache
->ptr
+ addr
, val
);
2718 address_space_stb_cached_slow(cache
, addr
, val
, attrs
, result
);
2722 #define ENDIANNESS _le
2723 #include "exec/memory_ldst_cached.h.inc"
2725 #define ENDIANNESS _be
2726 #include "exec/memory_ldst_cached.h.inc"
2728 #define SUFFIX _cached
2730 #define ARG1_DECL MemoryRegionCache *cache
2731 #include "exec/memory_ldst_phys.h.inc"
2733 /* address_space_cache_init: prepare for repeated access to a physical
2736 * @cache: #MemoryRegionCache to be filled
2737 * @as: #AddressSpace to be accessed
2738 * @addr: address within that address space
2739 * @len: length of buffer
2740 * @is_write: indicates the transfer direction
2742 * Will only work with RAM, and may map a subset of the requested range by
2743 * returning a value that is less than @len. On failure, return a negative
2746 * Because it only works with RAM, this function can be used for
2747 * read-modify-write operations. In this case, is_write should be %true.
2749 * Note that addresses passed to the address_space_*_cached functions
2750 * are relative to @addr.
2752 int64_t address_space_cache_init(MemoryRegionCache
*cache
,
2759 * address_space_cache_invalidate: complete a write to a #MemoryRegionCache
2761 * @cache: The #MemoryRegionCache to operate on.
2762 * @addr: The first physical address that was written, relative to the
2763 * address that was passed to @address_space_cache_init.
2764 * @access_len: The number of bytes that were written starting at @addr.
2766 void address_space_cache_invalidate(MemoryRegionCache
*cache
,
2771 * address_space_cache_destroy: free a #MemoryRegionCache
2773 * @cache: The #MemoryRegionCache whose memory should be released.
2775 void address_space_cache_destroy(MemoryRegionCache
*cache
);
2777 /* address_space_get_iotlb_entry: translate an address into an IOTLB
2778 * entry. Should be called from an RCU critical section.
2780 IOMMUTLBEntry
address_space_get_iotlb_entry(AddressSpace
*as
, hwaddr addr
,
2781 bool is_write
, MemTxAttrs attrs
);
2783 /* address_space_translate: translate an address range into an address space
2784 * into a MemoryRegion and an address range into that section. Should be
2785 * called from an RCU critical section, to avoid that the last reference
2786 * to the returned region disappears after address_space_translate returns.
2788 * @fv: #FlatView to be accessed
2789 * @addr: address within that address space
2790 * @xlat: pointer to address within the returned memory region section's
2792 * @len: pointer to length
2793 * @is_write: indicates the transfer direction
2794 * @attrs: memory attributes
2796 MemoryRegion
*flatview_translate(FlatView
*fv
,
2797 hwaddr addr
, hwaddr
*xlat
,
2798 hwaddr
*len
, bool is_write
,
2801 static inline MemoryRegion
*address_space_translate(AddressSpace
*as
,
2802 hwaddr addr
, hwaddr
*xlat
,
2803 hwaddr
*len
, bool is_write
,
2806 return flatview_translate(address_space_to_flatview(as
),
2807 addr
, xlat
, len
, is_write
, attrs
);
2810 /* address_space_access_valid: check for validity of accessing an address
2813 * Check whether memory is assigned to the given address space range, and
2814 * access is permitted by any IOMMU regions that are active for the address
2817 * For now, addr and len should be aligned to a page size. This limitation
2818 * will be lifted in the future.
2820 * @as: #AddressSpace to be accessed
2821 * @addr: address within that address space
2822 * @len: length of the area to be checked
2823 * @is_write: indicates the transfer direction
2824 * @attrs: memory attributes
2826 bool address_space_access_valid(AddressSpace
*as
, hwaddr addr
, hwaddr len
,
2827 bool is_write
, MemTxAttrs attrs
);
2829 /* address_space_map: map a physical memory region into a host virtual address
2831 * May map a subset of the requested range, given by and returned in @plen.
2832 * May return %NULL and set *@plen to zero(0), if resources needed to perform
2833 * the mapping are exhausted.
2834 * Use only for reads OR writes - not for read-modify-write operations.
2835 * Use cpu_register_map_client() to know when retrying the map operation is
2836 * likely to succeed.
2838 * @as: #AddressSpace to be accessed
2839 * @addr: address within that address space
2840 * @plen: pointer to length of buffer; updated on return
2841 * @is_write: indicates the transfer direction
2842 * @attrs: memory attributes
2844 void *address_space_map(AddressSpace
*as
, hwaddr addr
,
2845 hwaddr
*plen
, bool is_write
, MemTxAttrs attrs
);
2847 /* address_space_unmap: Unmaps a memory region previously mapped by address_space_map()
2849 * Will also mark the memory as dirty if @is_write == %true. @access_len gives
2850 * the amount of memory that was actually read or written by the caller.
2852 * @as: #AddressSpace used
2853 * @buffer: host pointer as returned by address_space_map()
2854 * @len: buffer length as returned by address_space_map()
2855 * @access_len: amount of data actually transferred
2856 * @is_write: indicates the transfer direction
2858 void address_space_unmap(AddressSpace
*as
, void *buffer
, hwaddr len
,
2859 bool is_write
, hwaddr access_len
);
2862 /* Internal functions, part of the implementation of address_space_read. */
2863 MemTxResult
address_space_read_full(AddressSpace
*as
, hwaddr addr
,
2864 MemTxAttrs attrs
, void *buf
, hwaddr len
);
2865 MemTxResult
flatview_read_continue(FlatView
*fv
, hwaddr addr
,
2866 MemTxAttrs attrs
, void *buf
,
2867 hwaddr len
, hwaddr addr1
, hwaddr l
,
2869 void *qemu_map_ram_ptr(RAMBlock
*ram_block
, ram_addr_t addr
);
2871 /* Internal functions, part of the implementation of address_space_read_cached
2872 * and address_space_write_cached. */
2873 MemTxResult
address_space_read_cached_slow(MemoryRegionCache
*cache
,
2874 hwaddr addr
, void *buf
, hwaddr len
);
2875 MemTxResult
address_space_write_cached_slow(MemoryRegionCache
*cache
,
2876 hwaddr addr
, const void *buf
,
2879 int memory_access_size(MemoryRegion
*mr
, unsigned l
, hwaddr addr
);
2880 bool prepare_mmio_access(MemoryRegion
*mr
);
2882 static inline bool memory_access_is_direct(MemoryRegion
*mr
, bool is_write
)
2885 return memory_region_is_ram(mr
) && !mr
->readonly
&&
2886 !mr
->rom_device
&& !memory_region_is_ram_device(mr
);
2888 return (memory_region_is_ram(mr
) && !memory_region_is_ram_device(mr
)) ||
2889 memory_region_is_romd(mr
);
2894 * address_space_read: read from an address space.
2896 * Return a MemTxResult indicating whether the operation succeeded
2897 * or failed (eg unassigned memory, device rejected the transaction,
2898 * IOMMU fault). Called within RCU critical section.
2900 * @as: #AddressSpace to be accessed
2901 * @addr: address within that address space
2902 * @attrs: memory transaction attributes
2903 * @buf: buffer with the data transferred
2904 * @len: length of the data transferred
2906 static inline __attribute__((__always_inline__
))
2907 MemTxResult
address_space_read(AddressSpace
*as
, hwaddr addr
,
2908 MemTxAttrs attrs
, void *buf
,
2911 MemTxResult result
= MEMTX_OK
;
2917 if (__builtin_constant_p(len
)) {
2919 RCU_READ_LOCK_GUARD();
2920 fv
= address_space_to_flatview(as
);
2922 mr
= flatview_translate(fv
, addr
, &addr1
, &l
, false, attrs
);
2923 if (len
== l
&& memory_access_is_direct(mr
, false)) {
2924 ptr
= qemu_map_ram_ptr(mr
->ram_block
, addr1
);
2925 memcpy(buf
, ptr
, len
);
2927 result
= flatview_read_continue(fv
, addr
, attrs
, buf
, len
,
2932 result
= address_space_read_full(as
, addr
, attrs
, buf
, len
);
2938 * address_space_read_cached: read from a cached RAM region
2940 * @cache: Cached region to be addressed
2941 * @addr: address relative to the base of the RAM region
2942 * @buf: buffer with the data transferred
2943 * @len: length of the data transferred
2945 static inline MemTxResult
2946 address_space_read_cached(MemoryRegionCache
*cache
, hwaddr addr
,
2947 void *buf
, hwaddr len
)
2949 assert(addr
< cache
->len
&& len
<= cache
->len
- addr
);
2950 fuzz_dma_read_cb(cache
->xlat
+ addr
, len
, cache
->mrs
.mr
);
2951 if (likely(cache
->ptr
)) {
2952 memcpy(buf
, cache
->ptr
+ addr
, len
);
2955 return address_space_read_cached_slow(cache
, addr
, buf
, len
);
2960 * address_space_write_cached: write to a cached RAM region
2962 * @cache: Cached region to be addressed
2963 * @addr: address relative to the base of the RAM region
2964 * @buf: buffer with the data transferred
2965 * @len: length of the data transferred
2967 static inline MemTxResult
2968 address_space_write_cached(MemoryRegionCache
*cache
, hwaddr addr
,
2969 const void *buf
, hwaddr len
)
2971 assert(addr
< cache
->len
&& len
<= cache
->len
- addr
);
2972 if (likely(cache
->ptr
)) {
2973 memcpy(cache
->ptr
+ addr
, buf
, len
);
2976 return address_space_write_cached_slow(cache
, addr
, buf
, len
);
2981 * address_space_set: Fill address space with a constant byte.
2983 * Return a MemTxResult indicating whether the operation succeeded
2984 * or failed (eg unassigned memory, device rejected the transaction,
2987 * @as: #AddressSpace to be accessed
2988 * @addr: address within that address space
2989 * @c: constant byte to fill the memory
2990 * @len: the number of bytes to fill with the constant byte
2991 * @attrs: memory transaction attributes
2993 MemTxResult
address_space_set(AddressSpace
*as
, hwaddr addr
,
2994 uint8_t c
, hwaddr len
, MemTxAttrs attrs
);
2997 /* enum device_endian to MemOp. */
2998 static inline MemOp
devend_memop(enum device_endian end
)
3000 QEMU_BUILD_BUG_ON(DEVICE_HOST_ENDIAN
!= DEVICE_LITTLE_ENDIAN
&&
3001 DEVICE_HOST_ENDIAN
!= DEVICE_BIG_ENDIAN
);
3003 #if HOST_BIG_ENDIAN != TARGET_BIG_ENDIAN
3004 /* Swap if non-host endianness or native (target) endianness */
3005 return (end
== DEVICE_HOST_ENDIAN
) ? 0 : MO_BSWAP
;
3007 const int non_host_endianness
=
3008 DEVICE_LITTLE_ENDIAN
^ DEVICE_BIG_ENDIAN
^ DEVICE_HOST_ENDIAN
;
3010 /* In this case, native (target) endianness needs no swap. */
3011 return (end
== non_host_endianness
) ? MO_BSWAP
: 0;
3017 * Inhibit technologies that require discarding of pages in RAM blocks, e.g.,
3018 * to manage the actual amount of memory consumed by the VM (then, the memory
3019 * provided by RAM blocks might be bigger than the desired memory consumption).
3020 * This *must* be set if:
3021 * - Discarding parts of a RAM blocks does not result in the change being
3022 * reflected in the VM and the pages getting freed.
3023 * - All memory in RAM blocks is pinned or duplicated, invaldiating any previous
3025 * - Discarding parts of a RAM blocks will result in integrity issues (e.g.,
3027 * Technologies that only temporarily pin the current working set of a
3028 * driver are fine, because we don't expect such pages to be discarded
3029 * (esp. based on guest action like balloon inflation).
3031 * This is *not* to be used to protect from concurrent discards (esp.,
3034 * Returns 0 if successful. Returns -EBUSY if a technology that relies on
3035 * discards to work reliably is active.
3037 int ram_block_discard_disable(bool state
);
3040 * See ram_block_discard_disable(): only disable uncoordinated discards,
3041 * keeping coordinated discards (via the RamDiscardManager) enabled.
3043 int ram_block_uncoordinated_discard_disable(bool state
);
3046 * Inhibit technologies that disable discarding of pages in RAM blocks.
3048 * Returns 0 if successful. Returns -EBUSY if discards are already set to
3051 int ram_block_discard_require(bool state
);
3054 * See ram_block_discard_require(): only inhibit technologies that disable
3055 * uncoordinated discarding of pages in RAM blocks, allowing co-existance with
3056 * technologies that only inhibit uncoordinated discards (via the
3057 * RamDiscardManager).
3059 int ram_block_coordinated_discard_require(bool state
);
3062 * Test if any discarding of memory in ram blocks is disabled.
3064 bool ram_block_discard_is_disabled(void);
3067 * Test if any discarding of memory in ram blocks is required to work reliably.
3069 bool ram_block_discard_is_required(void);