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 #define DIRTY_MEMORY_VGA 0
20 #define DIRTY_MEMORY_CODE 1
21 #define DIRTY_MEMORY_MIGRATION 2
22 #define DIRTY_MEMORY_NUM 3 /* num of dirty bits */
24 #include "exec/cpu-common.h"
25 #ifndef CONFIG_USER_ONLY
26 #include "exec/hwaddr.h"
28 #include "exec/memattrs.h"
29 #include "qemu/queue.h"
30 #include "qemu/int128.h"
31 #include "qemu/notify.h"
32 #include "qom/object.h"
35 #define RAM_ADDR_INVALID (~(ram_addr_t)0)
37 #define MAX_PHYS_ADDR_SPACE_BITS 62
38 #define MAX_PHYS_ADDR (((hwaddr)1 << MAX_PHYS_ADDR_SPACE_BITS) - 1)
40 #define TYPE_MEMORY_REGION "qemu:memory-region"
41 #define MEMORY_REGION(obj) \
42 OBJECT_CHECK(MemoryRegion, (obj), TYPE_MEMORY_REGION)
44 typedef struct MemoryRegionOps MemoryRegionOps
;
45 typedef struct MemoryRegionMmio MemoryRegionMmio
;
47 struct MemoryRegionMmio
{
48 CPUReadMemoryFunc
*read
[3];
49 CPUWriteMemoryFunc
*write
[3];
52 typedef struct IOMMUTLBEntry IOMMUTLBEntry
;
54 /* See address_space_translate: bit 0 is read, bit 1 is write. */
62 struct IOMMUTLBEntry
{
63 AddressSpace
*target_as
;
65 hwaddr translated_addr
;
66 hwaddr addr_mask
; /* 0xfff = 4k translation */
67 IOMMUAccessFlags perm
;
71 * Bitmap for different IOMMUNotifier capabilities. Each notifier can
72 * register with one or multiple IOMMU Notifier capability bit(s).
75 IOMMU_NOTIFIER_NONE
= 0,
76 /* Notify cache invalidations */
77 IOMMU_NOTIFIER_UNMAP
= 0x1,
78 /* Notify entry changes (newly created entries) */
79 IOMMU_NOTIFIER_MAP
= 0x2,
82 #define IOMMU_NOTIFIER_ALL (IOMMU_NOTIFIER_MAP | IOMMU_NOTIFIER_UNMAP)
84 struct IOMMUNotifier
{
85 void (*notify
)(struct IOMMUNotifier
*notifier
, IOMMUTLBEntry
*data
);
86 IOMMUNotifierFlag notifier_flags
;
87 QLIST_ENTRY(IOMMUNotifier
) node
;
89 typedef struct IOMMUNotifier IOMMUNotifier
;
91 /* New-style MMIO accessors can indicate that the transaction failed.
92 * A zero (MEMTX_OK) response means success; anything else is a failure
93 * of some kind. The memory subsystem will bitwise-OR together results
94 * if it is synthesizing an operation from multiple smaller accesses.
97 #define MEMTX_ERROR (1U << 0) /* device returned an error */
98 #define MEMTX_DECODE_ERROR (1U << 1) /* nothing at that address */
99 typedef uint32_t MemTxResult
;
102 * Memory region callbacks
104 struct MemoryRegionOps
{
105 /* Read from the memory region. @addr is relative to @mr; @size is
107 uint64_t (*read
)(void *opaque
,
110 /* Write to the memory region. @addr is relative to @mr; @size is
112 void (*write
)(void *opaque
,
117 MemTxResult (*read_with_attrs
)(void *opaque
,
122 MemTxResult (*write_with_attrs
)(void *opaque
,
128 enum device_endian endianness
;
129 /* Guest-visible constraints: */
131 /* If nonzero, specify bounds on access sizes beyond which a machine
134 unsigned min_access_size
;
135 unsigned max_access_size
;
136 /* If true, unaligned accesses are supported. Otherwise unaligned
137 * accesses throw machine checks.
141 * If present, and returns #false, the transaction is not accepted
142 * by the device (and results in machine dependent behaviour such
143 * as a machine check exception).
145 bool (*accepts
)(void *opaque
, hwaddr addr
,
146 unsigned size
, bool is_write
);
148 /* Internal implementation constraints: */
150 /* If nonzero, specifies the minimum size implemented. Smaller sizes
151 * will be rounded upwards and a partial result will be returned.
153 unsigned min_access_size
;
154 /* If nonzero, specifies the maximum size implemented. Larger sizes
155 * will be done as a series of accesses with smaller sizes.
157 unsigned max_access_size
;
158 /* If true, unaligned accesses are supported. Otherwise all accesses
159 * are converted to (possibly multiple) naturally aligned accesses.
164 /* If .read and .write are not present, old_mmio may be used for
165 * backwards compatibility with old mmio registration
167 const MemoryRegionMmio old_mmio
;
170 typedef struct MemoryRegionIOMMUOps MemoryRegionIOMMUOps
;
172 struct MemoryRegionIOMMUOps
{
173 /* Return a TLB entry that contains a given address. */
174 IOMMUTLBEntry (*translate
)(MemoryRegion
*iommu
, hwaddr addr
, bool is_write
);
175 /* Returns minimum supported page size */
176 uint64_t (*get_min_page_size
)(MemoryRegion
*iommu
);
177 /* Called when IOMMU Notifier flag changed */
178 void (*notify_flag_changed
)(MemoryRegion
*iommu
,
179 IOMMUNotifierFlag old_flags
,
180 IOMMUNotifierFlag new_flags
);
183 typedef struct CoalescedMemoryRange CoalescedMemoryRange
;
184 typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd
;
186 struct MemoryRegion
{
189 /* All fields are private - violators will be prosecuted */
191 /* The following fields should fit in a cache line */
195 bool readonly
; /* For RAM regions */
197 bool flush_coalesced_mmio
;
199 uint8_t dirty_log_mask
;
202 const MemoryRegionIOMMUOps
*iommu_ops
;
204 const MemoryRegionOps
*ops
;
206 MemoryRegion
*container
;
209 void (*destructor
)(MemoryRegion
*mr
);
214 bool warning_printed
; /* For reservations */
215 uint8_t vga_logging_count
;
219 QTAILQ_HEAD(subregions
, MemoryRegion
) subregions
;
220 QTAILQ_ENTRY(MemoryRegion
) subregions_link
;
221 QTAILQ_HEAD(coalesced_ranges
, CoalescedMemoryRange
) coalesced
;
223 unsigned ioeventfd_nb
;
224 MemoryRegionIoeventfd
*ioeventfds
;
225 QLIST_HEAD(, IOMMUNotifier
) iommu_notify
;
226 IOMMUNotifierFlag iommu_notify_flags
;
230 * MemoryListener: callbacks structure for updates to the physical memory map
232 * Allows a component to adjust to changes in the guest-visible memory map.
233 * Use with memory_listener_register() and memory_listener_unregister().
235 struct MemoryListener
{
236 void (*begin
)(MemoryListener
*listener
);
237 void (*commit
)(MemoryListener
*listener
);
238 void (*region_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
239 void (*region_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
240 void (*region_nop
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
241 void (*log_start
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
243 void (*log_stop
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
245 void (*log_sync
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
246 void (*log_global_start
)(MemoryListener
*listener
);
247 void (*log_global_stop
)(MemoryListener
*listener
);
248 void (*eventfd_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
249 bool match_data
, uint64_t data
, EventNotifier
*e
);
250 void (*eventfd_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
251 bool match_data
, uint64_t data
, EventNotifier
*e
);
252 void (*coalesced_mmio_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
253 hwaddr addr
, hwaddr len
);
254 void (*coalesced_mmio_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
255 hwaddr addr
, hwaddr len
);
256 /* Lower = earlier (during add), later (during del) */
258 AddressSpace
*address_space
;
259 QTAILQ_ENTRY(MemoryListener
) link
;
260 QTAILQ_ENTRY(MemoryListener
) link_as
;
264 * AddressSpace: describes a mapping of addresses to #MemoryRegion objects
266 struct AddressSpace
{
267 /* All fields are private. */
274 /* Accessed via RCU. */
275 struct FlatView
*current_map
;
278 struct MemoryRegionIoeventfd
*ioeventfds
;
279 struct AddressSpaceDispatch
*dispatch
;
280 struct AddressSpaceDispatch
*next_dispatch
;
281 MemoryListener dispatch_listener
;
282 QTAILQ_HEAD(memory_listeners_as
, MemoryListener
) listeners
;
283 QTAILQ_ENTRY(AddressSpace
) address_spaces_link
;
287 * MemoryRegionSection: describes a fragment of a #MemoryRegion
289 * @mr: the region, or %NULL if empty
290 * @address_space: the address space the region is mapped in
291 * @offset_within_region: the beginning of the section, relative to @mr's start
292 * @size: the size of the section; will not exceed @mr's boundaries
293 * @offset_within_address_space: the address of the first byte of the section
294 * relative to the region's address space
295 * @readonly: writes to this section are ignored
297 struct MemoryRegionSection
{
299 AddressSpace
*address_space
;
300 hwaddr offset_within_region
;
302 hwaddr offset_within_address_space
;
307 * memory_region_init: Initialize a memory region
309 * The region typically acts as a container for other memory regions. Use
310 * memory_region_add_subregion() to add subregions.
312 * @mr: the #MemoryRegion to be initialized
313 * @owner: the object that tracks the region's reference count
314 * @name: used for debugging; not visible to the user or ABI
315 * @size: size of the region; any subregions beyond this size will be clipped
317 void memory_region_init(MemoryRegion
*mr
,
318 struct Object
*owner
,
323 * memory_region_ref: Add 1 to a memory region's reference count
325 * Whenever memory regions are accessed outside the BQL, they need to be
326 * preserved against hot-unplug. MemoryRegions actually do not have their
327 * own reference count; they piggyback on a QOM object, their "owner".
328 * This function adds a reference to the owner.
330 * All MemoryRegions must have an owner if they can disappear, even if the
331 * device they belong to operates exclusively under the BQL. This is because
332 * the region could be returned at any time by memory_region_find, and this
333 * is usually under guest control.
335 * @mr: the #MemoryRegion
337 void memory_region_ref(MemoryRegion
*mr
);
340 * memory_region_unref: Remove 1 to a memory region's reference count
342 * Whenever memory regions are accessed outside the BQL, they need to be
343 * preserved against hot-unplug. MemoryRegions actually do not have their
344 * own reference count; they piggyback on a QOM object, their "owner".
345 * This function removes a reference to the owner and possibly destroys it.
347 * @mr: the #MemoryRegion
349 void memory_region_unref(MemoryRegion
*mr
);
352 * memory_region_init_io: Initialize an I/O memory region.
354 * Accesses into the region will cause the callbacks in @ops to be called.
355 * if @size is nonzero, subregions will be clipped to @size.
357 * @mr: the #MemoryRegion to be initialized.
358 * @owner: the object that tracks the region's reference count
359 * @ops: a structure containing read and write callbacks to be used when
360 * I/O is performed on the region.
361 * @opaque: passed to the read and write callbacks of the @ops structure.
362 * @name: used for debugging; not visible to the user or ABI
363 * @size: size of the region.
365 void memory_region_init_io(MemoryRegion
*mr
,
366 struct Object
*owner
,
367 const MemoryRegionOps
*ops
,
373 * memory_region_init_ram: Initialize RAM memory region. Accesses into the
374 * region will modify memory directly.
376 * @mr: the #MemoryRegion to be initialized.
377 * @owner: the object that tracks the region's reference count
378 * @name: the name of the region.
379 * @size: size of the region.
380 * @errp: pointer to Error*, to store an error if it happens.
382 void memory_region_init_ram(MemoryRegion
*mr
,
383 struct Object
*owner
,
389 * memory_region_init_resizeable_ram: Initialize memory region with resizeable
390 * RAM. Accesses into the region will
391 * modify memory directly. Only an initial
392 * portion of this RAM is actually used.
393 * The used size can change across reboots.
395 * @mr: the #MemoryRegion to be initialized.
396 * @owner: the object that tracks the region's reference count
397 * @name: the name of the region.
398 * @size: used size of the region.
399 * @max_size: max size of the region.
400 * @resized: callback to notify owner about used size change.
401 * @errp: pointer to Error*, to store an error if it happens.
403 void memory_region_init_resizeable_ram(MemoryRegion
*mr
,
404 struct Object
*owner
,
408 void (*resized
)(const char*,
414 * memory_region_init_ram_from_file: Initialize RAM memory region with a
417 * @mr: the #MemoryRegion to be initialized.
418 * @owner: the object that tracks the region's reference count
419 * @name: the name of the region.
420 * @size: size of the region.
421 * @share: %true if memory must be mmaped with the MAP_SHARED flag
422 * @path: the path in which to allocate the RAM.
423 * @errp: pointer to Error*, to store an error if it happens.
425 void memory_region_init_ram_from_file(MemoryRegion
*mr
,
426 struct Object
*owner
,
435 * memory_region_init_ram_ptr: Initialize RAM memory region from a
436 * user-provided pointer. Accesses into the
437 * region will modify memory directly.
439 * @mr: the #MemoryRegion to be initialized.
440 * @owner: the object that tracks the region's reference count
441 * @name: the name of the region.
442 * @size: size of the region.
443 * @ptr: memory to be mapped; must contain at least @size bytes.
445 void memory_region_init_ram_ptr(MemoryRegion
*mr
,
446 struct Object
*owner
,
452 * memory_region_init_ram_device_ptr: Initialize RAM device memory region from
453 * a user-provided pointer.
455 * A RAM device represents a mapping to a physical device, such as to a PCI
456 * MMIO BAR of an vfio-pci assigned device. The memory region may be mapped
457 * into the VM address space and access to the region will modify memory
458 * directly. However, the memory region should not be included in a memory
459 * dump (device may not be enabled/mapped at the time of the dump), and
460 * operations incompatible with manipulating MMIO should be avoided. Replaces
463 * @mr: the #MemoryRegion to be initialized.
464 * @owner: the object that tracks the region's reference count
465 * @name: the name of the region.
466 * @size: size of the region.
467 * @ptr: memory to be mapped; must contain at least @size bytes.
469 void memory_region_init_ram_device_ptr(MemoryRegion
*mr
,
470 struct Object
*owner
,
476 * memory_region_init_alias: Initialize a memory region that aliases all or a
477 * part of another memory region.
479 * @mr: the #MemoryRegion to be initialized.
480 * @owner: the object that tracks the region's reference count
481 * @name: used for debugging; not visible to the user or ABI
482 * @orig: the region to be referenced; @mr will be equivalent to
483 * @orig between @offset and @offset + @size - 1.
484 * @offset: start of the section in @orig to be referenced.
485 * @size: size of the region.
487 void memory_region_init_alias(MemoryRegion
*mr
,
488 struct Object
*owner
,
495 * memory_region_init_rom: Initialize a ROM memory region.
497 * This has the same effect as calling memory_region_init_ram()
498 * and then marking the resulting region read-only with
499 * memory_region_set_readonly().
501 * @mr: the #MemoryRegion to be initialized.
502 * @owner: the object that tracks the region's reference count
503 * @name: the name of the region.
504 * @size: size of the region.
505 * @errp: pointer to Error*, to store an error if it happens.
507 void memory_region_init_rom(MemoryRegion
*mr
,
508 struct Object
*owner
,
514 * memory_region_init_rom_device: Initialize a ROM memory region. Writes are
515 * handled via callbacks.
517 * @mr: the #MemoryRegion to be initialized.
518 * @owner: the object that tracks the region's reference count
519 * @ops: callbacks for write access handling (must not be NULL).
520 * @name: the name of the region.
521 * @size: size of the region.
522 * @errp: pointer to Error*, to store an error if it happens.
524 void memory_region_init_rom_device(MemoryRegion
*mr
,
525 struct Object
*owner
,
526 const MemoryRegionOps
*ops
,
533 * memory_region_init_reservation: Initialize a memory region that reserves
536 * A reservation region primariy serves debugging purposes. It claims I/O
537 * space that is not supposed to be handled by QEMU itself. Any access via
538 * the memory API will cause an abort().
539 * This function is deprecated. Use memory_region_init_io() with NULL
542 * @mr: the #MemoryRegion to be initialized
543 * @owner: the object that tracks the region's reference count
544 * @name: used for debugging; not visible to the user or ABI
545 * @size: size of the region.
547 static inline void memory_region_init_reservation(MemoryRegion
*mr
,
552 memory_region_init_io(mr
, owner
, NULL
, mr
, name
, size
);
556 * memory_region_init_iommu: Initialize a memory region that translates
559 * An IOMMU region translates addresses and forwards accesses to a target
562 * @mr: the #MemoryRegion to be initialized
563 * @owner: the object that tracks the region's reference count
564 * @ops: a function that translates addresses into the @target region
565 * @name: used for debugging; not visible to the user or ABI
566 * @size: size of the region.
568 void memory_region_init_iommu(MemoryRegion
*mr
,
569 struct Object
*owner
,
570 const MemoryRegionIOMMUOps
*ops
,
575 * memory_region_owner: get a memory region's owner.
577 * @mr: the memory region being queried.
579 struct Object
*memory_region_owner(MemoryRegion
*mr
);
582 * memory_region_size: get a memory region's size.
584 * @mr: the memory region being queried.
586 uint64_t memory_region_size(MemoryRegion
*mr
);
589 * memory_region_is_ram: check whether a memory region is random access
591 * Returns %true is a memory region is random access.
593 * @mr: the memory region being queried
595 static inline bool memory_region_is_ram(MemoryRegion
*mr
)
601 * memory_region_is_ram_device: check whether a memory region is a ram device
603 * Returns %true is a memory region is a device backed ram region
605 * @mr: the memory region being queried
607 bool memory_region_is_ram_device(MemoryRegion
*mr
);
610 * memory_region_is_romd: check whether a memory region is in ROMD mode
612 * Returns %true if a memory region is a ROM device and currently set to allow
615 * @mr: the memory region being queried
617 static inline bool memory_region_is_romd(MemoryRegion
*mr
)
619 return mr
->rom_device
&& mr
->romd_mode
;
623 * memory_region_is_iommu: check whether a memory region is an iommu
625 * Returns %true is a memory region is an iommu.
627 * @mr: the memory region being queried
629 static inline bool memory_region_is_iommu(MemoryRegion
*mr
)
632 return memory_region_is_iommu(mr
->alias
);
634 return mr
->iommu_ops
;
639 * memory_region_iommu_get_min_page_size: get minimum supported page size
642 * Returns minimum supported page size for an iommu.
644 * @mr: the memory region being queried
646 uint64_t memory_region_iommu_get_min_page_size(MemoryRegion
*mr
);
649 * memory_region_notify_iommu: notify a change in an IOMMU translation entry.
651 * The notification type will be decided by entry.perm bits:
653 * - For UNMAP (cache invalidation) notifies: set entry.perm to IOMMU_NONE.
654 * - For MAP (newly added entry) notifies: set entry.perm to the
655 * permission of the page (which is definitely !IOMMU_NONE).
657 * Note: for any IOMMU implementation, an in-place mapping change
658 * should be notified with an UNMAP followed by a MAP.
660 * @mr: the memory region that was changed
661 * @entry: the new entry in the IOMMU translation table. The entry
662 * replaces all old entries for the same virtual I/O address range.
663 * Deleted entries have .@perm == 0.
665 void memory_region_notify_iommu(MemoryRegion
*mr
,
666 IOMMUTLBEntry entry
);
669 * memory_region_register_iommu_notifier: register a notifier for changes to
670 * IOMMU translation entries.
672 * @mr: the memory region to observe
673 * @n: the IOMMUNotifier to be added; the notify callback receives a
674 * pointer to an #IOMMUTLBEntry as the opaque value; the pointer
675 * ceases to be valid on exit from the notifier.
677 void memory_region_register_iommu_notifier(MemoryRegion
*mr
,
681 * memory_region_iommu_replay: replay existing IOMMU translations to
682 * a notifier with the minimum page granularity returned by
683 * mr->iommu_ops->get_page_size().
685 * @mr: the memory region to observe
686 * @n: the notifier to which to replay iommu mappings
687 * @is_write: Whether to treat the replay as a translate "write"
690 void memory_region_iommu_replay(MemoryRegion
*mr
, IOMMUNotifier
*n
,
694 * memory_region_unregister_iommu_notifier: unregister a notifier for
695 * changes to IOMMU translation entries.
697 * @mr: the memory region which was observed and for which notity_stopped()
699 * @n: the notifier to be removed.
701 void memory_region_unregister_iommu_notifier(MemoryRegion
*mr
,
705 * memory_region_name: get a memory region's name
707 * Returns the string that was used to initialize the memory region.
709 * @mr: the memory region being queried
711 const char *memory_region_name(const MemoryRegion
*mr
);
714 * memory_region_is_logging: return whether a memory region is logging writes
716 * Returns %true if the memory region is logging writes for the given client
718 * @mr: the memory region being queried
719 * @client: the client being queried
721 bool memory_region_is_logging(MemoryRegion
*mr
, uint8_t client
);
724 * memory_region_get_dirty_log_mask: return the clients for which a
725 * memory region is logging writes.
727 * Returns a bitmap of clients, in which the DIRTY_MEMORY_* constants
728 * are the bit indices.
730 * @mr: the memory region being queried
732 uint8_t memory_region_get_dirty_log_mask(MemoryRegion
*mr
);
735 * memory_region_is_rom: check whether a memory region is ROM
737 * Returns %true is a memory region is read-only memory.
739 * @mr: the memory region being queried
741 static inline bool memory_region_is_rom(MemoryRegion
*mr
)
743 return mr
->ram
&& mr
->readonly
;
748 * memory_region_get_fd: Get a file descriptor backing a RAM memory region.
750 * Returns a file descriptor backing a file-based RAM memory region,
751 * or -1 if the region is not a file-based RAM memory region.
753 * @mr: the RAM or alias memory region being queried.
755 int memory_region_get_fd(MemoryRegion
*mr
);
758 * memory_region_set_fd: Mark a RAM memory region as backed by a
761 * This function is typically used after memory_region_init_ram_ptr().
763 * @mr: the memory region being queried.
764 * @fd: the file descriptor that backs @mr.
766 void memory_region_set_fd(MemoryRegion
*mr
, int fd
);
769 * memory_region_from_host: Convert a pointer into a RAM memory region
770 * and an offset within it.
772 * Given a host pointer inside a RAM memory region (created with
773 * memory_region_init_ram() or memory_region_init_ram_ptr()), return
774 * the MemoryRegion and the offset within it.
776 * Use with care; by the time this function returns, the returned pointer is
777 * not protected by RCU anymore. If the caller is not within an RCU critical
778 * section and does not hold the iothread lock, it must have other means of
779 * protecting the pointer, such as a reference to the region that includes
780 * the incoming ram_addr_t.
782 * @mr: the memory region being queried.
784 MemoryRegion
*memory_region_from_host(void *ptr
, ram_addr_t
*offset
);
787 * memory_region_get_ram_ptr: Get a pointer into a RAM memory region.
789 * Returns a host pointer to a RAM memory region (created with
790 * memory_region_init_ram() or memory_region_init_ram_ptr()).
792 * Use with care; by the time this function returns, the returned pointer is
793 * not protected by RCU anymore. If the caller is not within an RCU critical
794 * section and does not hold the iothread lock, it must have other means of
795 * protecting the pointer, such as a reference to the region that includes
796 * the incoming ram_addr_t.
798 * @mr: the memory region being queried.
800 void *memory_region_get_ram_ptr(MemoryRegion
*mr
);
802 /* memory_region_ram_resize: Resize a RAM region.
804 * Only legal before guest might have detected the memory size: e.g. on
805 * incoming migration, or right after reset.
807 * @mr: a memory region created with @memory_region_init_resizeable_ram.
808 * @newsize: the new size the region
809 * @errp: pointer to Error*, to store an error if it happens.
811 void memory_region_ram_resize(MemoryRegion
*mr
, ram_addr_t newsize
,
815 * memory_region_set_log: Turn dirty logging on or off for a region.
817 * Turns dirty logging on or off for a specified client (display, migration).
818 * Only meaningful for RAM regions.
820 * @mr: the memory region being updated.
821 * @log: whether dirty logging is to be enabled or disabled.
822 * @client: the user of the logging information; %DIRTY_MEMORY_VGA only.
824 void memory_region_set_log(MemoryRegion
*mr
, bool log
, unsigned client
);
827 * memory_region_get_dirty: Check whether a range of bytes is dirty
828 * for a specified client.
830 * Checks whether a range of bytes has been written to since the last
831 * call to memory_region_reset_dirty() with the same @client. Dirty logging
834 * @mr: the memory region being queried.
835 * @addr: the address (relative to the start of the region) being queried.
836 * @size: the size of the range being queried.
837 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
840 bool memory_region_get_dirty(MemoryRegion
*mr
, hwaddr addr
,
841 hwaddr size
, unsigned client
);
844 * memory_region_set_dirty: Mark a range of bytes as dirty in a memory region.
846 * Marks a range of bytes as dirty, after it has been dirtied outside
849 * @mr: the memory region being dirtied.
850 * @addr: the address (relative to the start of the region) being dirtied.
851 * @size: size of the range being dirtied.
853 void memory_region_set_dirty(MemoryRegion
*mr
, hwaddr addr
,
857 * memory_region_test_and_clear_dirty: Check whether a range of bytes is dirty
858 * for a specified client. It clears them.
860 * Checks whether a range of bytes has been written to since the last
861 * call to memory_region_reset_dirty() with the same @client. Dirty logging
864 * @mr: the memory region being queried.
865 * @addr: the address (relative to the start of the region) being queried.
866 * @size: the size of the range being queried.
867 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
870 bool memory_region_test_and_clear_dirty(MemoryRegion
*mr
, hwaddr addr
,
871 hwaddr size
, unsigned client
);
873 * memory_region_sync_dirty_bitmap: Synchronize a region's dirty bitmap with
874 * any external TLBs (e.g. kvm)
876 * Flushes dirty information from accelerators such as kvm and vhost-net
877 * and makes it available to users of the memory API.
879 * @mr: the region being flushed.
881 void memory_region_sync_dirty_bitmap(MemoryRegion
*mr
);
884 * memory_region_reset_dirty: Mark a range of pages as clean, for a specified
887 * Marks a range of pages as no longer dirty.
889 * @mr: the region being updated.
890 * @addr: the start of the subrange being cleaned.
891 * @size: the size of the subrange being cleaned.
892 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
895 void memory_region_reset_dirty(MemoryRegion
*mr
, hwaddr addr
,
896 hwaddr size
, unsigned client
);
899 * memory_region_set_readonly: Turn a memory region read-only (or read-write)
901 * Allows a memory region to be marked as read-only (turning it into a ROM).
902 * only useful on RAM regions.
904 * @mr: the region being updated.
905 * @readonly: whether rhe region is to be ROM or RAM.
907 void memory_region_set_readonly(MemoryRegion
*mr
, bool readonly
);
910 * memory_region_rom_device_set_romd: enable/disable ROMD mode
912 * Allows a ROM device (initialized with memory_region_init_rom_device() to
913 * set to ROMD mode (default) or MMIO mode. When it is in ROMD mode, the
914 * device is mapped to guest memory and satisfies read access directly.
915 * When in MMIO mode, reads are forwarded to the #MemoryRegion.read function.
916 * Writes are always handled by the #MemoryRegion.write function.
918 * @mr: the memory region to be updated
919 * @romd_mode: %true to put the region into ROMD mode
921 void memory_region_rom_device_set_romd(MemoryRegion
*mr
, bool romd_mode
);
924 * memory_region_set_coalescing: Enable memory coalescing for the region.
926 * Enabled writes to a region to be queued for later processing. MMIO ->write
927 * callbacks may be delayed until a non-coalesced MMIO is issued.
928 * Only useful for IO regions. Roughly similar to write-combining hardware.
930 * @mr: the memory region to be write coalesced
932 void memory_region_set_coalescing(MemoryRegion
*mr
);
935 * memory_region_add_coalescing: Enable memory coalescing for a sub-range of
938 * Like memory_region_set_coalescing(), but works on a sub-range of a region.
939 * Multiple calls can be issued coalesced disjoint ranges.
941 * @mr: the memory region to be updated.
942 * @offset: the start of the range within the region to be coalesced.
943 * @size: the size of the subrange to be coalesced.
945 void memory_region_add_coalescing(MemoryRegion
*mr
,
950 * memory_region_clear_coalescing: Disable MMIO coalescing for the region.
952 * Disables any coalescing caused by memory_region_set_coalescing() or
953 * memory_region_add_coalescing(). Roughly equivalent to uncacheble memory
956 * @mr: the memory region to be updated.
958 void memory_region_clear_coalescing(MemoryRegion
*mr
);
961 * memory_region_set_flush_coalesced: Enforce memory coalescing flush before
964 * Ensure that pending coalesced MMIO request are flushed before the memory
965 * region is accessed. This property is automatically enabled for all regions
966 * passed to memory_region_set_coalescing() and memory_region_add_coalescing().
968 * @mr: the memory region to be updated.
970 void memory_region_set_flush_coalesced(MemoryRegion
*mr
);
973 * memory_region_clear_flush_coalesced: Disable memory coalescing flush before
976 * Clear the automatic coalesced MMIO flushing enabled via
977 * memory_region_set_flush_coalesced. Note that this service has no effect on
978 * memory regions that have MMIO coalescing enabled for themselves. For them,
979 * automatic flushing will stop once coalescing is disabled.
981 * @mr: the memory region to be updated.
983 void memory_region_clear_flush_coalesced(MemoryRegion
*mr
);
986 * memory_region_set_global_locking: Declares the access processing requires
987 * QEMU's global lock.
989 * When this is invoked, accesses to the memory region will be processed while
990 * holding the global lock of QEMU. This is the default behavior of memory
993 * @mr: the memory region to be updated.
995 void memory_region_set_global_locking(MemoryRegion
*mr
);
998 * memory_region_clear_global_locking: Declares that access processing does
999 * not depend on the QEMU global lock.
1001 * By clearing this property, accesses to the memory region will be processed
1002 * outside of QEMU's global lock (unless the lock is held on when issuing the
1003 * access request). In this case, the device model implementing the access
1004 * handlers is responsible for synchronization of concurrency.
1006 * @mr: the memory region to be updated.
1008 void memory_region_clear_global_locking(MemoryRegion
*mr
);
1011 * memory_region_add_eventfd: Request an eventfd to be triggered when a word
1012 * is written to a location.
1014 * Marks a word in an IO region (initialized with memory_region_init_io())
1015 * as a trigger for an eventfd event. The I/O callback will not be called.
1016 * The caller must be prepared to handle failure (that is, take the required
1017 * action if the callback _is_ called).
1019 * @mr: the memory region being updated.
1020 * @addr: the address within @mr that is to be monitored
1021 * @size: the size of the access to trigger the eventfd
1022 * @match_data: whether to match against @data, instead of just @addr
1023 * @data: the data to match against the guest write
1024 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
1026 void memory_region_add_eventfd(MemoryRegion
*mr
,
1034 * memory_region_del_eventfd: Cancel an eventfd.
1036 * Cancels an eventfd trigger requested by a previous
1037 * memory_region_add_eventfd() call.
1039 * @mr: the memory region being updated.
1040 * @addr: the address within @mr that is to be monitored
1041 * @size: the size of the access to trigger the eventfd
1042 * @match_data: whether to match against @data, instead of just @addr
1043 * @data: the data to match against the guest write
1044 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
1046 void memory_region_del_eventfd(MemoryRegion
*mr
,
1054 * memory_region_add_subregion: Add a subregion to a container.
1056 * Adds a subregion at @offset. The subregion may not overlap with other
1057 * subregions (except for those explicitly marked as overlapping). A region
1058 * may only be added once as a subregion (unless removed with
1059 * memory_region_del_subregion()); use memory_region_init_alias() if you
1060 * want a region to be a subregion in multiple locations.
1062 * @mr: the region to contain the new subregion; must be a container
1063 * initialized with memory_region_init().
1064 * @offset: the offset relative to @mr where @subregion is added.
1065 * @subregion: the subregion to be added.
1067 void memory_region_add_subregion(MemoryRegion
*mr
,
1069 MemoryRegion
*subregion
);
1071 * memory_region_add_subregion_overlap: Add a subregion to a container
1074 * Adds a subregion at @offset. The subregion may overlap with other
1075 * subregions. Conflicts are resolved by having a higher @priority hide a
1076 * lower @priority. Subregions without priority are taken as @priority 0.
1077 * A region may only be added once as a subregion (unless removed with
1078 * memory_region_del_subregion()); use memory_region_init_alias() if you
1079 * want a region to be a subregion in multiple locations.
1081 * @mr: the region to contain the new subregion; must be a container
1082 * initialized with memory_region_init().
1083 * @offset: the offset relative to @mr where @subregion is added.
1084 * @subregion: the subregion to be added.
1085 * @priority: used for resolving overlaps; highest priority wins.
1087 void memory_region_add_subregion_overlap(MemoryRegion
*mr
,
1089 MemoryRegion
*subregion
,
1093 * memory_region_get_ram_addr: Get the ram address associated with a memory
1096 ram_addr_t
memory_region_get_ram_addr(MemoryRegion
*mr
);
1098 uint64_t memory_region_get_alignment(const MemoryRegion
*mr
);
1100 * memory_region_del_subregion: Remove a subregion.
1102 * Removes a subregion from its container.
1104 * @mr: the container to be updated.
1105 * @subregion: the region being removed; must be a current subregion of @mr.
1107 void memory_region_del_subregion(MemoryRegion
*mr
,
1108 MemoryRegion
*subregion
);
1111 * memory_region_set_enabled: dynamically enable or disable a region
1113 * Enables or disables a memory region. A disabled memory region
1114 * ignores all accesses to itself and its subregions. It does not
1115 * obscure sibling subregions with lower priority - it simply behaves as
1116 * if it was removed from the hierarchy.
1118 * Regions default to being enabled.
1120 * @mr: the region to be updated
1121 * @enabled: whether to enable or disable the region
1123 void memory_region_set_enabled(MemoryRegion
*mr
, bool enabled
);
1126 * memory_region_set_address: dynamically update the address of a region
1128 * Dynamically updates the address of a region, relative to its container.
1129 * May be used on regions are currently part of a memory hierarchy.
1131 * @mr: the region to be updated
1132 * @addr: new address, relative to container region
1134 void memory_region_set_address(MemoryRegion
*mr
, hwaddr addr
);
1137 * memory_region_set_size: dynamically update the size of a region.
1139 * Dynamically updates the size of a region.
1141 * @mr: the region to be updated
1142 * @size: used size of the region.
1144 void memory_region_set_size(MemoryRegion
*mr
, uint64_t size
);
1147 * memory_region_set_alias_offset: dynamically update a memory alias's offset
1149 * Dynamically updates the offset into the target region that an alias points
1150 * to, as if the fourth argument to memory_region_init_alias() has changed.
1152 * @mr: the #MemoryRegion to be updated; should be an alias.
1153 * @offset: the new offset into the target memory region
1155 void memory_region_set_alias_offset(MemoryRegion
*mr
,
1159 * memory_region_present: checks if an address relative to a @container
1160 * translates into #MemoryRegion within @container
1162 * Answer whether a #MemoryRegion within @container covers the address
1165 * @container: a #MemoryRegion within which @addr is a relative address
1166 * @addr: the area within @container to be searched
1168 bool memory_region_present(MemoryRegion
*container
, hwaddr addr
);
1171 * memory_region_is_mapped: returns true if #MemoryRegion is mapped
1172 * into any address space.
1174 * @mr: a #MemoryRegion which should be checked if it's mapped
1176 bool memory_region_is_mapped(MemoryRegion
*mr
);
1179 * memory_region_find: translate an address/size relative to a
1180 * MemoryRegion into a #MemoryRegionSection.
1182 * Locates the first #MemoryRegion within @mr that overlaps the range
1183 * given by @addr and @size.
1185 * Returns a #MemoryRegionSection that describes a contiguous overlap.
1186 * It will have the following characteristics:
1187 * .@size = 0 iff no overlap was found
1188 * .@mr is non-%NULL iff an overlap was found
1190 * Remember that in the return value the @offset_within_region is
1191 * relative to the returned region (in the .@mr field), not to the
1194 * Similarly, the .@offset_within_address_space is relative to the
1195 * address space that contains both regions, the passed and the
1196 * returned one. However, in the special case where the @mr argument
1197 * has no container (and thus is the root of the address space), the
1198 * following will hold:
1199 * .@offset_within_address_space >= @addr
1200 * .@offset_within_address_space + .@size <= @addr + @size
1202 * @mr: a MemoryRegion within which @addr is a relative address
1203 * @addr: start of the area within @as to be searched
1204 * @size: size of the area to be searched
1206 MemoryRegionSection
memory_region_find(MemoryRegion
*mr
,
1207 hwaddr addr
, uint64_t size
);
1210 * memory_global_dirty_log_sync: synchronize the dirty log for all memory
1212 * Synchronizes the dirty page log for all address spaces.
1214 void memory_global_dirty_log_sync(void);
1217 * memory_region_transaction_begin: Start a transaction.
1219 * During a transaction, changes will be accumulated and made visible
1220 * only when the transaction ends (is committed).
1222 void memory_region_transaction_begin(void);
1225 * memory_region_transaction_commit: Commit a transaction and make changes
1226 * visible to the guest.
1228 void memory_region_transaction_commit(void);
1231 * memory_listener_register: register callbacks to be called when memory
1232 * sections are mapped or unmapped into an address
1235 * @listener: an object containing the callbacks to be called
1236 * @filter: if non-%NULL, only regions in this address space will be observed
1238 void memory_listener_register(MemoryListener
*listener
, AddressSpace
*filter
);
1241 * memory_listener_unregister: undo the effect of memory_listener_register()
1243 * @listener: an object containing the callbacks to be removed
1245 void memory_listener_unregister(MemoryListener
*listener
);
1248 * memory_global_dirty_log_start: begin dirty logging for all regions
1250 void memory_global_dirty_log_start(void);
1253 * memory_global_dirty_log_stop: end dirty logging for all regions
1255 void memory_global_dirty_log_stop(void);
1257 void mtree_info(fprintf_function mon_printf
, void *f
);
1260 * memory_region_dispatch_read: perform a read directly to the specified
1263 * @mr: #MemoryRegion to access
1264 * @addr: address within that region
1265 * @pval: pointer to uint64_t which the data is written to
1266 * @size: size of the access in bytes
1267 * @attrs: memory transaction attributes to use for the access
1269 MemTxResult
memory_region_dispatch_read(MemoryRegion
*mr
,
1275 * memory_region_dispatch_write: perform a write directly to the specified
1278 * @mr: #MemoryRegion to access
1279 * @addr: address within that region
1280 * @data: data to write
1281 * @size: size of the access in bytes
1282 * @attrs: memory transaction attributes to use for the access
1284 MemTxResult
memory_region_dispatch_write(MemoryRegion
*mr
,
1291 * address_space_init: initializes an address space
1293 * @as: an uninitialized #AddressSpace
1294 * @root: a #MemoryRegion that routes addresses for the address space
1295 * @name: an address space name. The name is only used for debugging
1298 void address_space_init(AddressSpace
*as
, MemoryRegion
*root
, const char *name
);
1301 * address_space_init_shareable: return an address space for a memory region,
1302 * creating it if it does not already exist
1304 * @root: a #MemoryRegion that routes addresses for the address space
1305 * @name: an address space name. The name is only used for debugging
1308 * This function will return a pointer to an existing AddressSpace
1309 * which was initialized with the specified MemoryRegion, or it will
1310 * create and initialize one if it does not already exist. The ASes
1311 * are reference-counted, so the memory will be freed automatically
1312 * when the AddressSpace is destroyed via address_space_destroy.
1314 AddressSpace
*address_space_init_shareable(MemoryRegion
*root
,
1318 * address_space_destroy: destroy an address space
1320 * Releases all resources associated with an address space. After an address space
1321 * is destroyed, its root memory region (given by address_space_init()) may be destroyed
1324 * @as: address space to be destroyed
1326 void address_space_destroy(AddressSpace
*as
);
1329 * address_space_rw: read from or write to an address space.
1331 * Return a MemTxResult indicating whether the operation succeeded
1332 * or failed (eg unassigned memory, device rejected the transaction,
1335 * @as: #AddressSpace to be accessed
1336 * @addr: address within that address space
1337 * @attrs: memory transaction attributes
1338 * @buf: buffer with the data transferred
1339 * @is_write: indicates the transfer direction
1341 MemTxResult
address_space_rw(AddressSpace
*as
, hwaddr addr
,
1342 MemTxAttrs attrs
, uint8_t *buf
,
1343 int len
, bool is_write
);
1346 * address_space_write: write to address space.
1348 * Return a MemTxResult indicating whether the operation succeeded
1349 * or failed (eg unassigned memory, device rejected the transaction,
1352 * @as: #AddressSpace to be accessed
1353 * @addr: address within that address space
1354 * @attrs: memory transaction attributes
1355 * @buf: buffer with the data transferred
1357 MemTxResult
address_space_write(AddressSpace
*as
, hwaddr addr
,
1359 const uint8_t *buf
, int len
);
1361 /* address_space_ld*: load from an address space
1362 * address_space_st*: store to an address space
1364 * These functions perform a load or store of the byte, word,
1365 * longword or quad to the specified address within the AddressSpace.
1366 * The _le suffixed functions treat the data as little endian;
1367 * _be indicates big endian; no suffix indicates "same endianness
1370 * The "guest CPU endianness" accessors are deprecated for use outside
1371 * target-* code; devices should be CPU-agnostic and use either the LE
1372 * or the BE accessors.
1374 * @as #AddressSpace to be accessed
1375 * @addr: address within that address space
1376 * @val: data value, for stores
1377 * @attrs: memory transaction attributes
1378 * @result: location to write the success/failure of the transaction;
1379 * if NULL, this information is discarded
1381 uint32_t address_space_ldub(AddressSpace
*as
, hwaddr addr
,
1382 MemTxAttrs attrs
, MemTxResult
*result
);
1383 uint32_t address_space_lduw_le(AddressSpace
*as
, hwaddr addr
,
1384 MemTxAttrs attrs
, MemTxResult
*result
);
1385 uint32_t address_space_lduw_be(AddressSpace
*as
, hwaddr addr
,
1386 MemTxAttrs attrs
, MemTxResult
*result
);
1387 uint32_t address_space_ldl_le(AddressSpace
*as
, hwaddr addr
,
1388 MemTxAttrs attrs
, MemTxResult
*result
);
1389 uint32_t address_space_ldl_be(AddressSpace
*as
, hwaddr addr
,
1390 MemTxAttrs attrs
, MemTxResult
*result
);
1391 uint64_t address_space_ldq_le(AddressSpace
*as
, hwaddr addr
,
1392 MemTxAttrs attrs
, MemTxResult
*result
);
1393 uint64_t address_space_ldq_be(AddressSpace
*as
, hwaddr addr
,
1394 MemTxAttrs attrs
, MemTxResult
*result
);
1395 void address_space_stb(AddressSpace
*as
, hwaddr addr
, uint32_t val
,
1396 MemTxAttrs attrs
, MemTxResult
*result
);
1397 void address_space_stw_le(AddressSpace
*as
, hwaddr addr
, uint32_t val
,
1398 MemTxAttrs attrs
, MemTxResult
*result
);
1399 void address_space_stw_be(AddressSpace
*as
, hwaddr addr
, uint32_t val
,
1400 MemTxAttrs attrs
, MemTxResult
*result
);
1401 void address_space_stl_le(AddressSpace
*as
, hwaddr addr
, uint32_t val
,
1402 MemTxAttrs attrs
, MemTxResult
*result
);
1403 void address_space_stl_be(AddressSpace
*as
, hwaddr addr
, uint32_t val
,
1404 MemTxAttrs attrs
, MemTxResult
*result
);
1405 void address_space_stq_le(AddressSpace
*as
, hwaddr addr
, uint64_t val
,
1406 MemTxAttrs attrs
, MemTxResult
*result
);
1407 void address_space_stq_be(AddressSpace
*as
, hwaddr addr
, uint64_t val
,
1408 MemTxAttrs attrs
, MemTxResult
*result
);
1410 uint32_t ldub_phys(AddressSpace
*as
, hwaddr addr
);
1411 uint32_t lduw_le_phys(AddressSpace
*as
, hwaddr addr
);
1412 uint32_t lduw_be_phys(AddressSpace
*as
, hwaddr addr
);
1413 uint32_t ldl_le_phys(AddressSpace
*as
, hwaddr addr
);
1414 uint32_t ldl_be_phys(AddressSpace
*as
, hwaddr addr
);
1415 uint64_t ldq_le_phys(AddressSpace
*as
, hwaddr addr
);
1416 uint64_t ldq_be_phys(AddressSpace
*as
, hwaddr addr
);
1417 void stb_phys(AddressSpace
*as
, hwaddr addr
, uint32_t val
);
1418 void stw_le_phys(AddressSpace
*as
, hwaddr addr
, uint32_t val
);
1419 void stw_be_phys(AddressSpace
*as
, hwaddr addr
, uint32_t val
);
1420 void stl_le_phys(AddressSpace
*as
, hwaddr addr
, uint32_t val
);
1421 void stl_be_phys(AddressSpace
*as
, hwaddr addr
, uint32_t val
);
1422 void stq_le_phys(AddressSpace
*as
, hwaddr addr
, uint64_t val
);
1423 void stq_be_phys(AddressSpace
*as
, hwaddr addr
, uint64_t val
);
1425 struct MemoryRegionCache
{
1433 /* address_space_cache_init: prepare for repeated access to a physical
1436 * @cache: #MemoryRegionCache to be filled
1437 * @as: #AddressSpace to be accessed
1438 * @addr: address within that address space
1439 * @len: length of buffer
1440 * @is_write: indicates the transfer direction
1442 * Will only work with RAM, and may map a subset of the requested range by
1443 * returning a value that is less than @len. On failure, return a negative
1446 * Because it only works with RAM, this function can be used for
1447 * read-modify-write operations. In this case, is_write should be %true.
1449 * Note that addresses passed to the address_space_*_cached functions
1450 * are relative to @addr.
1452 int64_t address_space_cache_init(MemoryRegionCache
*cache
,
1459 * address_space_cache_invalidate: complete a write to a #MemoryRegionCache
1461 * @cache: The #MemoryRegionCache to operate on.
1462 * @addr: The first physical address that was written, relative to the
1463 * address that was passed to @address_space_cache_init.
1464 * @access_len: The number of bytes that were written starting at @addr.
1466 void address_space_cache_invalidate(MemoryRegionCache
*cache
,
1471 * address_space_cache_destroy: free a #MemoryRegionCache
1473 * @cache: The #MemoryRegionCache whose memory should be released.
1475 void address_space_cache_destroy(MemoryRegionCache
*cache
);
1477 /* address_space_ld*_cached: load from a cached #MemoryRegion
1478 * address_space_st*_cached: store into a cached #MemoryRegion
1480 * These functions perform a load or store of the byte, word,
1481 * longword or quad to the specified address. The address is
1482 * a physical address in the AddressSpace, but it must lie within
1483 * a #MemoryRegion that was mapped with address_space_cache_init.
1485 * The _le suffixed functions treat the data as little endian;
1486 * _be indicates big endian; no suffix indicates "same endianness
1489 * The "guest CPU endianness" accessors are deprecated for use outside
1490 * target-* code; devices should be CPU-agnostic and use either the LE
1491 * or the BE accessors.
1493 * @cache: previously initialized #MemoryRegionCache to be accessed
1494 * @addr: address within the address space
1495 * @val: data value, for stores
1496 * @attrs: memory transaction attributes
1497 * @result: location to write the success/failure of the transaction;
1498 * if NULL, this information is discarded
1500 uint32_t address_space_ldub_cached(MemoryRegionCache
*cache
, hwaddr addr
,
1501 MemTxAttrs attrs
, MemTxResult
*result
);
1502 uint32_t address_space_lduw_le_cached(MemoryRegionCache
*cache
, hwaddr addr
,
1503 MemTxAttrs attrs
, MemTxResult
*result
);
1504 uint32_t address_space_lduw_be_cached(MemoryRegionCache
*cache
, hwaddr addr
,
1505 MemTxAttrs attrs
, MemTxResult
*result
);
1506 uint32_t address_space_ldl_le_cached(MemoryRegionCache
*cache
, hwaddr addr
,
1507 MemTxAttrs attrs
, MemTxResult
*result
);
1508 uint32_t address_space_ldl_be_cached(MemoryRegionCache
*cache
, hwaddr addr
,
1509 MemTxAttrs attrs
, MemTxResult
*result
);
1510 uint64_t address_space_ldq_le_cached(MemoryRegionCache
*cache
, hwaddr addr
,
1511 MemTxAttrs attrs
, MemTxResult
*result
);
1512 uint64_t address_space_ldq_be_cached(MemoryRegionCache
*cache
, hwaddr addr
,
1513 MemTxAttrs attrs
, MemTxResult
*result
);
1514 void address_space_stb_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint32_t val
,
1515 MemTxAttrs attrs
, MemTxResult
*result
);
1516 void address_space_stw_le_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint32_t val
,
1517 MemTxAttrs attrs
, MemTxResult
*result
);
1518 void address_space_stw_be_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint32_t val
,
1519 MemTxAttrs attrs
, MemTxResult
*result
);
1520 void address_space_stl_le_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint32_t val
,
1521 MemTxAttrs attrs
, MemTxResult
*result
);
1522 void address_space_stl_be_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint32_t val
,
1523 MemTxAttrs attrs
, MemTxResult
*result
);
1524 void address_space_stq_le_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint64_t val
,
1525 MemTxAttrs attrs
, MemTxResult
*result
);
1526 void address_space_stq_be_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint64_t val
,
1527 MemTxAttrs attrs
, MemTxResult
*result
);
1529 uint32_t ldub_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
);
1530 uint32_t lduw_le_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
);
1531 uint32_t lduw_be_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
);
1532 uint32_t ldl_le_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
);
1533 uint32_t ldl_be_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
);
1534 uint64_t ldq_le_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
);
1535 uint64_t ldq_be_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
);
1536 void stb_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint32_t val
);
1537 void stw_le_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint32_t val
);
1538 void stw_be_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint32_t val
);
1539 void stl_le_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint32_t val
);
1540 void stl_be_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint32_t val
);
1541 void stq_le_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint64_t val
);
1542 void stq_be_phys_cached(MemoryRegionCache
*cache
, hwaddr addr
, uint64_t val
);
1543 /* address_space_get_iotlb_entry: translate an address into an IOTLB
1544 * entry. Should be called from an RCU critical section.
1546 IOMMUTLBEntry
address_space_get_iotlb_entry(AddressSpace
*as
, hwaddr addr
,
1549 /* address_space_translate: translate an address range into an address space
1550 * into a MemoryRegion and an address range into that section. Should be
1551 * called from an RCU critical section, to avoid that the last reference
1552 * to the returned region disappears after address_space_translate returns.
1554 * @as: #AddressSpace to be accessed
1555 * @addr: address within that address space
1556 * @xlat: pointer to address within the returned memory region section's
1558 * @len: pointer to length
1559 * @is_write: indicates the transfer direction
1561 MemoryRegion
*address_space_translate(AddressSpace
*as
, hwaddr addr
,
1562 hwaddr
*xlat
, hwaddr
*len
,
1565 /* address_space_access_valid: check for validity of accessing an address
1568 * Check whether memory is assigned to the given address space range, and
1569 * access is permitted by any IOMMU regions that are active for the address
1572 * For now, addr and len should be aligned to a page size. This limitation
1573 * will be lifted in the future.
1575 * @as: #AddressSpace to be accessed
1576 * @addr: address within that address space
1577 * @len: length of the area to be checked
1578 * @is_write: indicates the transfer direction
1580 bool address_space_access_valid(AddressSpace
*as
, hwaddr addr
, int len
, bool is_write
);
1582 /* address_space_map: map a physical memory region into a host virtual address
1584 * May map a subset of the requested range, given by and returned in @plen.
1585 * May return %NULL if resources needed to perform the mapping are exhausted.
1586 * Use only for reads OR writes - not for read-modify-write operations.
1587 * Use cpu_register_map_client() to know when retrying the map operation is
1588 * likely to succeed.
1590 * @as: #AddressSpace to be accessed
1591 * @addr: address within that address space
1592 * @plen: pointer to length of buffer; updated on return
1593 * @is_write: indicates the transfer direction
1595 void *address_space_map(AddressSpace
*as
, hwaddr addr
,
1596 hwaddr
*plen
, bool is_write
);
1598 /* address_space_unmap: Unmaps a memory region previously mapped by address_space_map()
1600 * Will also mark the memory as dirty if @is_write == %true. @access_len gives
1601 * the amount of memory that was actually read or written by the caller.
1603 * @as: #AddressSpace used
1604 * @addr: address within that address space
1605 * @len: buffer length as returned by address_space_map()
1606 * @access_len: amount of data actually transferred
1607 * @is_write: indicates the transfer direction
1609 void address_space_unmap(AddressSpace
*as
, void *buffer
, hwaddr len
,
1610 int is_write
, hwaddr access_len
);
1613 /* Internal functions, part of the implementation of address_space_read. */
1614 MemTxResult
address_space_read_continue(AddressSpace
*as
, hwaddr addr
,
1615 MemTxAttrs attrs
, uint8_t *buf
,
1616 int len
, hwaddr addr1
, hwaddr l
,
1618 MemTxResult
address_space_read_full(AddressSpace
*as
, hwaddr addr
,
1619 MemTxAttrs attrs
, uint8_t *buf
, int len
);
1620 void *qemu_map_ram_ptr(RAMBlock
*ram_block
, ram_addr_t addr
);
1622 static inline bool memory_access_is_direct(MemoryRegion
*mr
, bool is_write
)
1625 return memory_region_is_ram(mr
) &&
1626 !mr
->readonly
&& !memory_region_is_ram_device(mr
);
1628 return (memory_region_is_ram(mr
) && !memory_region_is_ram_device(mr
)) ||
1629 memory_region_is_romd(mr
);
1634 * address_space_read: read from an address space.
1636 * Return a MemTxResult indicating whether the operation succeeded
1637 * or failed (eg unassigned memory, device rejected the transaction,
1640 * @as: #AddressSpace to be accessed
1641 * @addr: address within that address space
1642 * @attrs: memory transaction attributes
1643 * @buf: buffer with the data transferred
1645 static inline __attribute__((__always_inline__
))
1646 MemTxResult
address_space_read(AddressSpace
*as
, hwaddr addr
, MemTxAttrs attrs
,
1647 uint8_t *buf
, int len
)
1649 MemTxResult result
= MEMTX_OK
;
1654 if (__builtin_constant_p(len
)) {
1658 mr
= address_space_translate(as
, addr
, &addr1
, &l
, false);
1659 if (len
== l
&& memory_access_is_direct(mr
, false)) {
1660 ptr
= qemu_map_ram_ptr(mr
->ram_block
, addr1
);
1661 memcpy(buf
, ptr
, len
);
1663 result
= address_space_read_continue(as
, addr
, attrs
, buf
, len
,
1669 result
= address_space_read_full(as
, addr
, attrs
, buf
, len
);
1675 * address_space_read_cached: read from a cached RAM region
1677 * @cache: Cached region to be addressed
1678 * @addr: address relative to the base of the RAM region
1679 * @buf: buffer with the data transferred
1680 * @len: length of the data transferred
1683 address_space_read_cached(MemoryRegionCache
*cache
, hwaddr addr
,
1686 assert(addr
< cache
->len
&& len
<= cache
->len
- addr
);
1687 memcpy(buf
, cache
->ptr
+ addr
, len
);
1691 * address_space_write_cached: write to a cached RAM region
1693 * @cache: Cached region to be addressed
1694 * @addr: address relative to the base of the RAM region
1695 * @buf: buffer with the data transferred
1696 * @len: length of the data transferred
1699 address_space_write_cached(MemoryRegionCache
*cache
, hwaddr addr
,
1702 assert(addr
< cache
->len
&& len
<= cache
->len
- addr
);
1703 memcpy(cache
->ptr
+ addr
, buf
, len
);