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 */
26 #include "exec/cpu-common.h"
27 #ifndef CONFIG_USER_ONLY
28 #include "exec/hwaddr.h"
30 #include "exec/memattrs.h"
31 #include "qemu/queue.h"
32 #include "qemu/int128.h"
33 #include "qemu/notify.h"
34 #include "qapi/error.h"
35 #include "qom/object.h"
38 #define MAX_PHYS_ADDR_SPACE_BITS 62
39 #define MAX_PHYS_ADDR (((hwaddr)1 << MAX_PHYS_ADDR_SPACE_BITS) - 1)
41 #define TYPE_MEMORY_REGION "qemu:memory-region"
42 #define MEMORY_REGION(obj) \
43 OBJECT_CHECK(MemoryRegion, (obj), TYPE_MEMORY_REGION)
45 typedef struct MemoryRegionOps MemoryRegionOps;
46 typedef struct MemoryRegionMmio MemoryRegionMmio;
48 struct MemoryRegionMmio {
49 CPUReadMemoryFunc *read[3];
50 CPUWriteMemoryFunc *write[3];
53 typedef struct IOMMUTLBEntry IOMMUTLBEntry;
55 /* See address_space_translate: bit 0 is read, bit 1 is write. */
63 struct IOMMUTLBEntry {
64 AddressSpace *target_as;
66 hwaddr translated_addr;
67 hwaddr addr_mask; /* 0xfff = 4k translation */
68 IOMMUAccessFlags perm;
71 /* New-style MMIO accessors can indicate that the transaction failed.
72 * A zero (MEMTX_OK) response means success; anything else is a failure
73 * of some kind. The memory subsystem will bitwise-OR together results
74 * if it is synthesizing an operation from multiple smaller accesses.
77 #define MEMTX_ERROR (1U << 0) /* device returned an error */
78 #define MEMTX_DECODE_ERROR (1U << 1) /* nothing at that address */
79 typedef uint32_t MemTxResult;
82 * Memory region callbacks
84 struct MemoryRegionOps {
85 /* Read from the memory region. @addr is relative to @mr; @size is
87 uint64_t (*read)(void *opaque,
90 /* Write to the memory region. @addr is relative to @mr; @size is
92 void (*write)(void *opaque,
97 MemTxResult (*read_with_attrs)(void *opaque,
102 MemTxResult (*write_with_attrs)(void *opaque,
108 enum device_endian endianness;
109 /* Guest-visible constraints: */
111 /* If nonzero, specify bounds on access sizes beyond which a machine
114 unsigned min_access_size;
115 unsigned max_access_size;
116 /* If true, unaligned accesses are supported. Otherwise unaligned
117 * accesses throw machine checks.
121 * If present, and returns #false, the transaction is not accepted
122 * by the device (and results in machine dependent behaviour such
123 * as a machine check exception).
125 bool (*accepts)(void *opaque, hwaddr addr,
126 unsigned size, bool is_write);
128 /* Internal implementation constraints: */
130 /* If nonzero, specifies the minimum size implemented. Smaller sizes
131 * will be rounded upwards and a partial result will be returned.
133 unsigned min_access_size;
134 /* If nonzero, specifies the maximum size implemented. Larger sizes
135 * will be done as a series of accesses with smaller sizes.
137 unsigned max_access_size;
138 /* If true, unaligned accesses are supported. Otherwise all accesses
139 * are converted to (possibly multiple) naturally aligned accesses.
144 /* If .read and .write are not present, old_mmio may be used for
145 * backwards compatibility with old mmio registration
147 const MemoryRegionMmio old_mmio;
150 typedef struct MemoryRegionIOMMUOps MemoryRegionIOMMUOps;
152 struct MemoryRegionIOMMUOps {
153 /* Return a TLB entry that contains a given address. */
154 IOMMUTLBEntry (*translate)(MemoryRegion *iommu, hwaddr addr, bool is_write);
157 typedef struct CoalescedMemoryRange CoalescedMemoryRange;
158 typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd;
160 struct MemoryRegion {
162 /* All fields are private - violators will be prosecuted */
163 const MemoryRegionOps *ops;
164 const MemoryRegionIOMMUOps *iommu_ops;
166 MemoryRegion *container;
169 void (*destructor)(MemoryRegion *mr);
177 bool readonly; /* For RAM regions */
180 bool warning_printed; /* For reservations */
181 bool flush_coalesced_mmio;
183 uint8_t vga_logging_count;
188 QTAILQ_HEAD(subregions, MemoryRegion) subregions;
189 QTAILQ_ENTRY(MemoryRegion) subregions_link;
190 QTAILQ_HEAD(coalesced_ranges, CoalescedMemoryRange) coalesced;
192 uint8_t dirty_log_mask;
193 unsigned ioeventfd_nb;
194 MemoryRegionIoeventfd *ioeventfds;
195 NotifierList iommu_notify;
199 * MemoryListener: callbacks structure for updates to the physical memory map
201 * Allows a component to adjust to changes in the guest-visible memory map.
202 * Use with memory_listener_register() and memory_listener_unregister().
204 struct MemoryListener {
205 void (*begin)(MemoryListener *listener);
206 void (*commit)(MemoryListener *listener);
207 void (*region_add)(MemoryListener *listener, MemoryRegionSection *section);
208 void (*region_del)(MemoryListener *listener, MemoryRegionSection *section);
209 void (*region_nop)(MemoryListener *listener, MemoryRegionSection *section);
210 void (*log_start)(MemoryListener *listener, MemoryRegionSection *section,
212 void (*log_stop)(MemoryListener *listener, MemoryRegionSection *section,
214 void (*log_sync)(MemoryListener *listener, MemoryRegionSection *section);
215 void (*log_global_start)(MemoryListener *listener);
216 void (*log_global_stop)(MemoryListener *listener);
217 void (*eventfd_add)(MemoryListener *listener, MemoryRegionSection *section,
218 bool match_data, uint64_t data, EventNotifier *e);
219 void (*eventfd_del)(MemoryListener *listener, MemoryRegionSection *section,
220 bool match_data, uint64_t data, EventNotifier *e);
221 void (*coalesced_mmio_add)(MemoryListener *listener, MemoryRegionSection *section,
222 hwaddr addr, hwaddr len);
223 void (*coalesced_mmio_del)(MemoryListener *listener, MemoryRegionSection *section,
224 hwaddr addr, hwaddr len);
225 /* Lower = earlier (during add), later (during del) */
227 AddressSpace *address_space_filter;
228 QTAILQ_ENTRY(MemoryListener) link;
232 * AddressSpace: describes a mapping of addresses to #MemoryRegion objects
234 struct AddressSpace {
235 /* All fields are private. */
240 /* Accessed via RCU. */
241 struct FlatView *current_map;
244 struct MemoryRegionIoeventfd *ioeventfds;
245 struct AddressSpaceDispatch *dispatch;
246 struct AddressSpaceDispatch *next_dispatch;
247 MemoryListener dispatch_listener;
249 QTAILQ_ENTRY(AddressSpace) address_spaces_link;
253 * MemoryRegionSection: describes a fragment of a #MemoryRegion
255 * @mr: the region, or %NULL if empty
256 * @address_space: the address space the region is mapped in
257 * @offset_within_region: the beginning of the section, relative to @mr's start
258 * @size: the size of the section; will not exceed @mr's boundaries
259 * @offset_within_address_space: the address of the first byte of the section
260 * relative to the region's address space
261 * @readonly: writes to this section are ignored
263 struct MemoryRegionSection {
265 AddressSpace *address_space;
266 hwaddr offset_within_region;
268 hwaddr offset_within_address_space;
273 * memory_region_init: Initialize a memory region
275 * The region typically acts as a container for other memory regions. Use
276 * memory_region_add_subregion() to add subregions.
278 * @mr: the #MemoryRegion to be initialized
279 * @owner: the object that tracks the region's reference count
280 * @name: used for debugging; not visible to the user or ABI
281 * @size: size of the region; any subregions beyond this size will be clipped
283 void memory_region_init(MemoryRegion *mr,
284 struct Object *owner,
289 * memory_region_ref: Add 1 to a memory region's reference count
291 * Whenever memory regions are accessed outside the BQL, they need to be
292 * preserved against hot-unplug. MemoryRegions actually do not have their
293 * own reference count; they piggyback on a QOM object, their "owner".
294 * This function adds a reference to the owner.
296 * All MemoryRegions must have an owner if they can disappear, even if the
297 * device they belong to operates exclusively under the BQL. This is because
298 * the region could be returned at any time by memory_region_find, and this
299 * is usually under guest control.
301 * @mr: the #MemoryRegion
303 void memory_region_ref(MemoryRegion *mr);
306 * memory_region_unref: Remove 1 to a memory region's reference count
308 * Whenever memory regions are accessed outside the BQL, they need to be
309 * preserved against hot-unplug. MemoryRegions actually do not have their
310 * own reference count; they piggyback on a QOM object, their "owner".
311 * This function removes a reference to the owner and possibly destroys it.
313 * @mr: the #MemoryRegion
315 void memory_region_unref(MemoryRegion *mr);
318 * memory_region_init_io: Initialize an I/O memory region.
320 * Accesses into the region will cause the callbacks in @ops to be called.
321 * if @size is nonzero, subregions will be clipped to @size.
323 * @mr: the #MemoryRegion to be initialized.
324 * @owner: the object that tracks the region's reference count
325 * @ops: a structure containing read and write callbacks to be used when
326 * I/O is performed on the region.
327 * @opaque: passed to to the read and write callbacks of the @ops structure.
328 * @name: used for debugging; not visible to the user or ABI
329 * @size: size of the region.
331 void memory_region_init_io(MemoryRegion *mr,
332 struct Object *owner,
333 const MemoryRegionOps *ops,
339 * memory_region_init_ram: Initialize RAM memory region. Accesses into the
340 * region will modify memory directly.
342 * @mr: the #MemoryRegion to be initialized.
343 * @owner: the object that tracks the region's reference count
344 * @name: the name of the region.
345 * @size: size of the region.
346 * @errp: pointer to Error*, to store an error if it happens.
348 void memory_region_init_ram(MemoryRegion *mr,
349 struct Object *owner,
355 * memory_region_init_resizeable_ram: Initialize memory region with resizeable
356 * RAM. Accesses into the region will
357 * modify memory directly. Only an initial
358 * portion of this RAM is actually used.
359 * The used size can change across reboots.
361 * @mr: the #MemoryRegion to be initialized.
362 * @owner: the object that tracks the region's reference count
363 * @name: the name of the region.
364 * @size: used size of the region.
365 * @max_size: max size of the region.
366 * @resized: callback to notify owner about used size change.
367 * @errp: pointer to Error*, to store an error if it happens.
369 void memory_region_init_resizeable_ram(MemoryRegion *mr,
370 struct Object *owner,
374 void (*resized)(const char*,
380 * memory_region_init_ram_from_file: Initialize RAM memory region with a
383 * @mr: the #MemoryRegion to be initialized.
384 * @owner: the object that tracks the region's reference count
385 * @name: the name of the region.
386 * @size: size of the region.
387 * @share: %true if memory must be mmaped with the MAP_SHARED flag
388 * @path: the path in which to allocate the RAM.
389 * @errp: pointer to Error*, to store an error if it happens.
391 void memory_region_init_ram_from_file(MemoryRegion *mr,
392 struct Object *owner,
401 * memory_region_init_ram_ptr: Initialize RAM memory region from a
402 * user-provided pointer. Accesses into the
403 * region will modify memory directly.
405 * @mr: the #MemoryRegion to be initialized.
406 * @owner: the object that tracks the region's reference count
407 * @name: the name of the region.
408 * @size: size of the region.
409 * @ptr: memory to be mapped; must contain at least @size bytes.
411 void memory_region_init_ram_ptr(MemoryRegion *mr,
412 struct Object *owner,
418 * memory_region_init_alias: Initialize a memory region that aliases all or a
419 * part of another memory region.
421 * @mr: the #MemoryRegion to be initialized.
422 * @owner: the object that tracks the region's reference count
423 * @name: used for debugging; not visible to the user or ABI
424 * @orig: the region to be referenced; @mr will be equivalent to
425 * @orig between @offset and @offset + @size - 1.
426 * @offset: start of the section in @orig to be referenced.
427 * @size: size of the region.
429 void memory_region_init_alias(MemoryRegion *mr,
430 struct Object *owner,
437 * memory_region_init_rom_device: Initialize a ROM memory region. Writes are
438 * handled via callbacks.
440 * @mr: the #MemoryRegion to be initialized.
441 * @owner: the object that tracks the region's reference count
442 * @ops: callbacks for write access handling.
443 * @name: the name of the region.
444 * @size: size of the region.
445 * @errp: pointer to Error*, to store an error if it happens.
447 void memory_region_init_rom_device(MemoryRegion *mr,
448 struct Object *owner,
449 const MemoryRegionOps *ops,
456 * memory_region_init_reservation: Initialize a memory region that reserves
459 * A reservation region primariy serves debugging purposes. It claims I/O
460 * space that is not supposed to be handled by QEMU itself. Any access via
461 * the memory API will cause an abort().
463 * @mr: the #MemoryRegion to be initialized
464 * @owner: the object that tracks the region's reference count
465 * @name: used for debugging; not visible to the user or ABI
466 * @size: size of the region.
468 void memory_region_init_reservation(MemoryRegion *mr,
469 struct Object *owner,
474 * memory_region_init_iommu: Initialize a memory region that translates
477 * An IOMMU region translates addresses and forwards accesses to a target
480 * @mr: the #MemoryRegion to be initialized
481 * @owner: the object that tracks the region's reference count
482 * @ops: a function that translates addresses into the @target region
483 * @name: used for debugging; not visible to the user or ABI
484 * @size: size of the region.
486 void memory_region_init_iommu(MemoryRegion *mr,
487 struct Object *owner,
488 const MemoryRegionIOMMUOps *ops,
493 * memory_region_owner: get a memory region's owner.
495 * @mr: the memory region being queried.
497 struct Object *memory_region_owner(MemoryRegion *mr);
500 * memory_region_size: get a memory region's size.
502 * @mr: the memory region being queried.
504 uint64_t memory_region_size(MemoryRegion *mr);
507 * memory_region_is_ram: check whether a memory region is random access
509 * Returns %true is a memory region is random access.
511 * @mr: the memory region being queried
513 bool memory_region_is_ram(MemoryRegion *mr);
516 * memory_region_is_skip_dump: check whether a memory region should not be
519 * Returns %true is a memory region should not be dumped(e.g. VFIO BAR MMAP).
521 * @mr: the memory region being queried
523 bool memory_region_is_skip_dump(MemoryRegion *mr);
526 * memory_region_set_skip_dump: Set skip_dump flag, dump will ignore this memory
529 * @mr: the memory region being queried
531 void memory_region_set_skip_dump(MemoryRegion *mr);
534 * memory_region_is_romd: check whether a memory region is in ROMD mode
536 * Returns %true if a memory region is a ROM device and currently set to allow
539 * @mr: the memory region being queried
541 static inline bool memory_region_is_romd(MemoryRegion *mr)
543 return mr->rom_device && mr->romd_mode;
547 * memory_region_is_iommu: check whether a memory region is an iommu
549 * Returns %true is a memory region is an iommu.
551 * @mr: the memory region being queried
553 bool memory_region_is_iommu(MemoryRegion *mr);
556 * memory_region_notify_iommu: notify a change in an IOMMU translation entry.
558 * @mr: the memory region that was changed
559 * @entry: the new entry in the IOMMU translation table. The entry
560 * replaces all old entries for the same virtual I/O address range.
561 * Deleted entries have .@perm == 0.
563 void memory_region_notify_iommu(MemoryRegion *mr,
564 IOMMUTLBEntry entry);
567 * memory_region_register_iommu_notifier: register a notifier for changes to
568 * IOMMU translation entries.
570 * @mr: the memory region to observe
571 * @n: the notifier to be added; the notifier receives a pointer to an
572 * #IOMMUTLBEntry as the opaque value; the pointer ceases to be
573 * valid on exit from the notifier.
575 void memory_region_register_iommu_notifier(MemoryRegion *mr, Notifier *n);
578 * memory_region_unregister_iommu_notifier: unregister a notifier for
579 * changes to IOMMU translation entries.
581 * @n: the notifier to be removed.
583 void memory_region_unregister_iommu_notifier(Notifier *n);
586 * memory_region_name: get a memory region's name
588 * Returns the string that was used to initialize the memory region.
590 * @mr: the memory region being queried
592 const char *memory_region_name(const MemoryRegion *mr);
595 * memory_region_is_logging: return whether a memory region is logging writes
597 * Returns %true if the memory region is logging writes for the given client
599 * @mr: the memory region being queried
600 * @client: the client being queried
602 bool memory_region_is_logging(MemoryRegion *mr, uint8_t client);
605 * memory_region_get_dirty_log_mask: return the clients for which a
606 * memory region is logging writes.
608 * Returns a bitmap of clients, in which the DIRTY_MEMORY_* constants
609 * are the bit indices.
611 * @mr: the memory region being queried
613 uint8_t memory_region_get_dirty_log_mask(MemoryRegion *mr);
616 * memory_region_is_rom: check whether a memory region is ROM
618 * Returns %true is a memory region is read-only memory.
620 * @mr: the memory region being queried
622 bool memory_region_is_rom(MemoryRegion *mr);
625 * memory_region_get_fd: Get a file descriptor backing a RAM memory region.
627 * Returns a file descriptor backing a file-based RAM memory region,
628 * or -1 if the region is not a file-based RAM memory region.
630 * @mr: the RAM or alias memory region being queried.
632 int memory_region_get_fd(MemoryRegion *mr);
635 * memory_region_get_ram_ptr: Get a pointer into a RAM memory region.
637 * Returns a host pointer to a RAM memory region (created with
638 * memory_region_init_ram() or memory_region_init_ram_ptr()). Use with
641 * @mr: the memory region being queried.
643 void *memory_region_get_ram_ptr(MemoryRegion *mr);
645 /* memory_region_ram_resize: Resize a RAM region.
647 * Only legal before guest might have detected the memory size: e.g. on
648 * incoming migration, or right after reset.
650 * @mr: a memory region created with @memory_region_init_resizeable_ram.
651 * @newsize: the new size the region
652 * @errp: pointer to Error*, to store an error if it happens.
654 void memory_region_ram_resize(MemoryRegion *mr, ram_addr_t newsize,
658 * memory_region_set_log: Turn dirty logging on or off for a region.
660 * Turns dirty logging on or off for a specified client (display, migration).
661 * Only meaningful for RAM regions.
663 * @mr: the memory region being updated.
664 * @log: whether dirty logging is to be enabled or disabled.
665 * @client: the user of the logging information; %DIRTY_MEMORY_VGA only.
667 void memory_region_set_log(MemoryRegion *mr, bool log, unsigned client);
670 * memory_region_get_dirty: Check whether a range of bytes is dirty
671 * for a specified client.
673 * Checks whether a range of bytes has been written to since the last
674 * call to memory_region_reset_dirty() with the same @client. Dirty logging
677 * @mr: the memory region being queried.
678 * @addr: the address (relative to the start of the region) being queried.
679 * @size: the size of the range being queried.
680 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
683 bool memory_region_get_dirty(MemoryRegion *mr, hwaddr addr,
684 hwaddr size, unsigned client);
687 * memory_region_set_dirty: Mark a range of bytes as dirty in a memory region.
689 * Marks a range of bytes as dirty, after it has been dirtied outside
692 * @mr: the memory region being dirtied.
693 * @addr: the address (relative to the start of the region) being dirtied.
694 * @size: size of the range being dirtied.
696 void memory_region_set_dirty(MemoryRegion *mr, hwaddr addr,
700 * memory_region_test_and_clear_dirty: Check whether a range of bytes is dirty
701 * for a specified client. It clears them.
703 * Checks whether a range of bytes has been written to since the last
704 * call to memory_region_reset_dirty() with the same @client. Dirty logging
707 * @mr: the memory region being queried.
708 * @addr: the address (relative to the start of the region) being queried.
709 * @size: the size of the range being queried.
710 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
713 bool memory_region_test_and_clear_dirty(MemoryRegion *mr, hwaddr addr,
714 hwaddr size, unsigned client);
716 * memory_region_sync_dirty_bitmap: Synchronize a region's dirty bitmap with
717 * any external TLBs (e.g. kvm)
719 * Flushes dirty information from accelerators such as kvm and vhost-net
720 * and makes it available to users of the memory API.
722 * @mr: the region being flushed.
724 void memory_region_sync_dirty_bitmap(MemoryRegion *mr);
727 * memory_region_reset_dirty: Mark a range of pages as clean, for a specified
730 * Marks a range of pages as no longer dirty.
732 * @mr: the region being updated.
733 * @addr: the start of the subrange being cleaned.
734 * @size: the size of the subrange being cleaned.
735 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
738 void memory_region_reset_dirty(MemoryRegion *mr, hwaddr addr,
739 hwaddr size, unsigned client);
742 * memory_region_set_readonly: Turn a memory region read-only (or read-write)
744 * Allows a memory region to be marked as read-only (turning it into a ROM).
745 * only useful on RAM regions.
747 * @mr: the region being updated.
748 * @readonly: whether rhe region is to be ROM or RAM.
750 void memory_region_set_readonly(MemoryRegion *mr, bool readonly);
753 * memory_region_rom_device_set_romd: enable/disable ROMD mode
755 * Allows a ROM device (initialized with memory_region_init_rom_device() to
756 * set to ROMD mode (default) or MMIO mode. When it is in ROMD mode, the
757 * device is mapped to guest memory and satisfies read access directly.
758 * When in MMIO mode, reads are forwarded to the #MemoryRegion.read function.
759 * Writes are always handled by the #MemoryRegion.write function.
761 * @mr: the memory region to be updated
762 * @romd_mode: %true to put the region into ROMD mode
764 void memory_region_rom_device_set_romd(MemoryRegion *mr, bool romd_mode);
767 * memory_region_set_coalescing: Enable memory coalescing for the region.
769 * Enabled writes to a region to be queued for later processing. MMIO ->write
770 * callbacks may be delayed until a non-coalesced MMIO is issued.
771 * Only useful for IO regions. Roughly similar to write-combining hardware.
773 * @mr: the memory region to be write coalesced
775 void memory_region_set_coalescing(MemoryRegion *mr);
778 * memory_region_add_coalescing: Enable memory coalescing for a sub-range of
781 * Like memory_region_set_coalescing(), but works on a sub-range of a region.
782 * Multiple calls can be issued coalesced disjoint ranges.
784 * @mr: the memory region to be updated.
785 * @offset: the start of the range within the region to be coalesced.
786 * @size: the size of the subrange to be coalesced.
788 void memory_region_add_coalescing(MemoryRegion *mr,
793 * memory_region_clear_coalescing: Disable MMIO coalescing for the region.
795 * Disables any coalescing caused by memory_region_set_coalescing() or
796 * memory_region_add_coalescing(). Roughly equivalent to uncacheble memory
799 * @mr: the memory region to be updated.
801 void memory_region_clear_coalescing(MemoryRegion *mr);
804 * memory_region_set_flush_coalesced: Enforce memory coalescing flush before
807 * Ensure that pending coalesced MMIO request are flushed before the memory
808 * region is accessed. This property is automatically enabled for all regions
809 * passed to memory_region_set_coalescing() and memory_region_add_coalescing().
811 * @mr: the memory region to be updated.
813 void memory_region_set_flush_coalesced(MemoryRegion *mr);
816 * memory_region_clear_flush_coalesced: Disable memory coalescing flush before
819 * Clear the automatic coalesced MMIO flushing enabled via
820 * memory_region_set_flush_coalesced. Note that this service has no effect on
821 * memory regions that have MMIO coalescing enabled for themselves. For them,
822 * automatic flushing will stop once coalescing is disabled.
824 * @mr: the memory region to be updated.
826 void memory_region_clear_flush_coalesced(MemoryRegion *mr);
829 * memory_region_set_global_locking: Declares the access processing requires
830 * QEMU's global lock.
832 * When this is invoked, accesses to the memory region will be processed while
833 * holding the global lock of QEMU. This is the default behavior of memory
836 * @mr: the memory region to be updated.
838 void memory_region_set_global_locking(MemoryRegion *mr);
841 * memory_region_clear_global_locking: Declares that access processing does
842 * not depend on the QEMU global lock.
844 * By clearing this property, accesses to the memory region will be processed
845 * outside of QEMU's global lock (unless the lock is held on when issuing the
846 * access request). In this case, the device model implementing the access
847 * handlers is responsible for synchronization of concurrency.
849 * @mr: the memory region to be updated.
851 void memory_region_clear_global_locking(MemoryRegion *mr);
854 * memory_region_add_eventfd: Request an eventfd to be triggered when a word
855 * is written to a location.
857 * Marks a word in an IO region (initialized with memory_region_init_io())
858 * as a trigger for an eventfd event. The I/O callback will not be called.
859 * The caller must be prepared to handle failure (that is, take the required
860 * action if the callback _is_ called).
862 * @mr: the memory region being updated.
863 * @addr: the address within @mr that is to be monitored
864 * @size: the size of the access to trigger the eventfd
865 * @match_data: whether to match against @data, instead of just @addr
866 * @data: the data to match against the guest write
867 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
869 void memory_region_add_eventfd(MemoryRegion *mr,
877 * memory_region_del_eventfd: Cancel an eventfd.
879 * Cancels an eventfd trigger requested by a previous
880 * memory_region_add_eventfd() call.
882 * @mr: the memory region being updated.
883 * @addr: the address within @mr that is to be monitored
884 * @size: the size of the access to trigger the eventfd
885 * @match_data: whether to match against @data, instead of just @addr
886 * @data: the data to match against the guest write
887 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
889 void memory_region_del_eventfd(MemoryRegion *mr,
897 * memory_region_add_subregion: Add a subregion to a container.
899 * Adds a subregion at @offset. The subregion may not overlap with other
900 * subregions (except for those explicitly marked as overlapping). A region
901 * may only be added once as a subregion (unless removed with
902 * memory_region_del_subregion()); use memory_region_init_alias() if you
903 * want a region to be a subregion in multiple locations.
905 * @mr: the region to contain the new subregion; must be a container
906 * initialized with memory_region_init().
907 * @offset: the offset relative to @mr where @subregion is added.
908 * @subregion: the subregion to be added.
910 void memory_region_add_subregion(MemoryRegion *mr,
912 MemoryRegion *subregion);
914 * memory_region_add_subregion_overlap: Add a subregion to a container
917 * Adds a subregion at @offset. The subregion may overlap with other
918 * subregions. Conflicts are resolved by having a higher @priority hide a
919 * lower @priority. Subregions without priority are taken as @priority 0.
920 * A region may only be added once as a subregion (unless removed with
921 * memory_region_del_subregion()); use memory_region_init_alias() if you
922 * want a region to be a subregion in multiple locations.
924 * @mr: the region to contain the new subregion; must be a container
925 * initialized with memory_region_init().
926 * @offset: the offset relative to @mr where @subregion is added.
927 * @subregion: the subregion to be added.
928 * @priority: used for resolving overlaps; highest priority wins.
930 void memory_region_add_subregion_overlap(MemoryRegion *mr,
932 MemoryRegion *subregion,
936 * memory_region_get_ram_addr: Get the ram address associated with a memory
939 * DO NOT USE THIS FUNCTION. This is a temporary workaround while the Xen
940 * code is being reworked.
942 ram_addr_t memory_region_get_ram_addr(MemoryRegion *mr);
944 uint64_t memory_region_get_alignment(const MemoryRegion *mr);
946 * memory_region_del_subregion: Remove a subregion.
948 * Removes a subregion from its container.
950 * @mr: the container to be updated.
951 * @subregion: the region being removed; must be a current subregion of @mr.
953 void memory_region_del_subregion(MemoryRegion *mr,
954 MemoryRegion *subregion);
957 * memory_region_set_enabled: dynamically enable or disable a region
959 * Enables or disables a memory region. A disabled memory region
960 * ignores all accesses to itself and its subregions. It does not
961 * obscure sibling subregions with lower priority - it simply behaves as
962 * if it was removed from the hierarchy.
964 * Regions default to being enabled.
966 * @mr: the region to be updated
967 * @enabled: whether to enable or disable the region
969 void memory_region_set_enabled(MemoryRegion *mr, bool enabled);
972 * memory_region_set_address: dynamically update the address of a region
974 * Dynamically updates the address of a region, relative to its container.
975 * May be used on regions are currently part of a memory hierarchy.
977 * @mr: the region to be updated
978 * @addr: new address, relative to container region
980 void memory_region_set_address(MemoryRegion *mr, hwaddr addr);
983 * memory_region_set_size: dynamically update the size of a region.
985 * Dynamically updates the size of a region.
987 * @mr: the region to be updated
988 * @size: used size of the region.
990 void memory_region_set_size(MemoryRegion *mr, uint64_t size);
993 * memory_region_set_alias_offset: dynamically update a memory alias's offset
995 * Dynamically updates the offset into the target region that an alias points
996 * to, as if the fourth argument to memory_region_init_alias() has changed.
998 * @mr: the #MemoryRegion to be updated; should be an alias.
999 * @offset: the new offset into the target memory region
1001 void memory_region_set_alias_offset(MemoryRegion *mr,
1005 * memory_region_present: checks if an address relative to a @container
1006 * translates into #MemoryRegion within @container
1008 * Answer whether a #MemoryRegion within @container covers the address
1011 * @container: a #MemoryRegion within which @addr is a relative address
1012 * @addr: the area within @container to be searched
1014 bool memory_region_present(MemoryRegion *container, hwaddr addr);
1017 * memory_region_is_mapped: returns true if #MemoryRegion is mapped
1018 * into any address space.
1020 * @mr: a #MemoryRegion which should be checked if it's mapped
1022 bool memory_region_is_mapped(MemoryRegion *mr);
1025 * memory_region_find: translate an address/size relative to a
1026 * MemoryRegion into a #MemoryRegionSection.
1028 * Locates the first #MemoryRegion within @mr that overlaps the range
1029 * given by @addr and @size.
1031 * Returns a #MemoryRegionSection that describes a contiguous overlap.
1032 * It will have the following characteristics:
1033 * .@size = 0 iff no overlap was found
1034 * .@mr is non-%NULL iff an overlap was found
1036 * Remember that in the return value the @offset_within_region is
1037 * relative to the returned region (in the .@mr field), not to the
1040 * Similarly, the .@offset_within_address_space is relative to the
1041 * address space that contains both regions, the passed and the
1042 * returned one. However, in the special case where the @mr argument
1043 * has no container (and thus is the root of the address space), the
1044 * following will hold:
1045 * .@offset_within_address_space >= @addr
1046 * .@offset_within_address_space + .@size <= @addr + @size
1048 * @mr: a MemoryRegion within which @addr is a relative address
1049 * @addr: start of the area within @as to be searched
1050 * @size: size of the area to be searched
1052 MemoryRegionSection memory_region_find(MemoryRegion *mr,
1053 hwaddr addr, uint64_t size);
1056 * address_space_sync_dirty_bitmap: synchronize the dirty log for all memory
1058 * Synchronizes the dirty page log for an entire address space.
1059 * @as: the address space that contains the memory being synchronized
1061 void address_space_sync_dirty_bitmap(AddressSpace *as);
1064 * memory_region_transaction_begin: Start a transaction.
1066 * During a transaction, changes will be accumulated and made visible
1067 * only when the transaction ends (is committed).
1069 void memory_region_transaction_begin(void);
1072 * memory_region_transaction_commit: Commit a transaction and make changes
1073 * visible to the guest.
1075 void memory_region_transaction_commit(void);
1078 * memory_listener_register: register callbacks to be called when memory
1079 * sections are mapped or unmapped into an address
1082 * @listener: an object containing the callbacks to be called
1083 * @filter: if non-%NULL, only regions in this address space will be observed
1085 void memory_listener_register(MemoryListener *listener, AddressSpace *filter);
1088 * memory_listener_unregister: undo the effect of memory_listener_register()
1090 * @listener: an object containing the callbacks to be removed
1092 void memory_listener_unregister(MemoryListener *listener);
1095 * memory_global_dirty_log_start: begin dirty logging for all regions
1097 void memory_global_dirty_log_start(void);
1100 * memory_global_dirty_log_stop: end dirty logging for all regions
1102 void memory_global_dirty_log_stop(void);
1104 void mtree_info(fprintf_function mon_printf, void *f);
1107 * memory_region_dispatch_read: perform a read directly to the specified
1110 * @mr: #MemoryRegion to access
1111 * @addr: address within that region
1112 * @pval: pointer to uint64_t which the data is written to
1113 * @size: size of the access in bytes
1114 * @attrs: memory transaction attributes to use for the access
1116 MemTxResult memory_region_dispatch_read(MemoryRegion *mr,
1122 * memory_region_dispatch_write: perform a write directly to the specified
1125 * @mr: #MemoryRegion to access
1126 * @addr: address within that region
1127 * @data: data to write
1128 * @size: size of the access in bytes
1129 * @attrs: memory transaction attributes to use for the access
1131 MemTxResult memory_region_dispatch_write(MemoryRegion *mr,
1138 * address_space_init: initializes an address space
1140 * @as: an uninitialized #AddressSpace
1141 * @root: a #MemoryRegion that routes addesses for the address space
1142 * @name: an address space name. The name is only used for debugging
1145 void address_space_init(AddressSpace *as, MemoryRegion *root, const char *name);
1149 * address_space_destroy: destroy an address space
1151 * Releases all resources associated with an address space. After an address space
1152 * is destroyed, its root memory region (given by address_space_init()) may be destroyed
1155 * @as: address space to be destroyed
1157 void address_space_destroy(AddressSpace *as);
1160 * address_space_rw: read from or write to an address space.
1162 * Return a MemTxResult indicating whether the operation succeeded
1163 * or failed (eg unassigned memory, device rejected the transaction,
1166 * @as: #AddressSpace to be accessed
1167 * @addr: address within that address space
1168 * @attrs: memory transaction attributes
1169 * @buf: buffer with the data transferred
1170 * @is_write: indicates the transfer direction
1172 MemTxResult address_space_rw(AddressSpace *as, hwaddr addr,
1173 MemTxAttrs attrs, uint8_t *buf,
1174 int len, bool is_write);
1177 * address_space_write: write to address space.
1179 * Return a MemTxResult indicating whether the operation succeeded
1180 * or failed (eg unassigned memory, device rejected the transaction,
1183 * @as: #AddressSpace to be accessed
1184 * @addr: address within that address space
1185 * @attrs: memory transaction attributes
1186 * @buf: buffer with the data transferred
1188 MemTxResult address_space_write(AddressSpace *as, hwaddr addr,
1190 const uint8_t *buf, int len);
1193 * address_space_read: read from an address space.
1195 * Return a MemTxResult indicating whether the operation succeeded
1196 * or failed (eg unassigned memory, device rejected the transaction,
1199 * @as: #AddressSpace to be accessed
1200 * @addr: address within that address space
1201 * @attrs: memory transaction attributes
1202 * @buf: buffer with the data transferred
1204 MemTxResult address_space_read(AddressSpace *as, hwaddr addr, MemTxAttrs attrs,
1205 uint8_t *buf, int len);
1208 * address_space_ld*: load from an address space
1209 * address_space_st*: store to an address space
1211 * These functions perform a load or store of the byte, word,
1212 * longword or quad to the specified address within the AddressSpace.
1213 * The _le suffixed functions treat the data as little endian;
1214 * _be indicates big endian; no suffix indicates "same endianness
1217 * The "guest CPU endianness" accessors are deprecated for use outside
1218 * target-* code; devices should be CPU-agnostic and use either the LE
1219 * or the BE accessors.
1221 * @as #AddressSpace to be accessed
1222 * @addr: address within that address space
1223 * @val: data value, for stores
1224 * @attrs: memory transaction attributes
1225 * @result: location to write the success/failure of the transaction;
1226 * if NULL, this information is discarded
1228 uint32_t address_space_ldub(AddressSpace *as, hwaddr addr,
1229 MemTxAttrs attrs, MemTxResult *result);
1230 uint32_t address_space_lduw_le(AddressSpace *as, hwaddr addr,
1231 MemTxAttrs attrs, MemTxResult *result);
1232 uint32_t address_space_lduw_be(AddressSpace *as, hwaddr addr,
1233 MemTxAttrs attrs, MemTxResult *result);
1234 uint32_t address_space_ldl_le(AddressSpace *as, hwaddr addr,
1235 MemTxAttrs attrs, MemTxResult *result);
1236 uint32_t address_space_ldl_be(AddressSpace *as, hwaddr addr,
1237 MemTxAttrs attrs, MemTxResult *result);
1238 uint64_t address_space_ldq_le(AddressSpace *as, hwaddr addr,
1239 MemTxAttrs attrs, MemTxResult *result);
1240 uint64_t address_space_ldq_be(AddressSpace *as, hwaddr addr,
1241 MemTxAttrs attrs, MemTxResult *result);
1242 void address_space_stb(AddressSpace *as, hwaddr addr, uint32_t val,
1243 MemTxAttrs attrs, MemTxResult *result);
1244 void address_space_stw_le(AddressSpace *as, hwaddr addr, uint32_t val,
1245 MemTxAttrs attrs, MemTxResult *result);
1246 void address_space_stw_be(AddressSpace *as, hwaddr addr, uint32_t val,
1247 MemTxAttrs attrs, MemTxResult *result);
1248 void address_space_stl_le(AddressSpace *as, hwaddr addr, uint32_t val,
1249 MemTxAttrs attrs, MemTxResult *result);
1250 void address_space_stl_be(AddressSpace *as, hwaddr addr, uint32_t val,
1251 MemTxAttrs attrs, MemTxResult *result);
1252 void address_space_stq_le(AddressSpace *as, hwaddr addr, uint64_t val,
1253 MemTxAttrs attrs, MemTxResult *result);
1254 void address_space_stq_be(AddressSpace *as, hwaddr addr, uint64_t val,
1255 MemTxAttrs attrs, MemTxResult *result);
1258 uint32_t address_space_lduw(AddressSpace *as, hwaddr addr,
1259 MemTxAttrs attrs, MemTxResult *result);
1260 uint32_t address_space_ldl(AddressSpace *as, hwaddr addr,
1261 MemTxAttrs attrs, MemTxResult *result);
1262 uint64_t address_space_ldq(AddressSpace *as, hwaddr addr,
1263 MemTxAttrs attrs, MemTxResult *result);
1264 void address_space_stl_notdirty(AddressSpace *as, hwaddr addr, uint32_t val,
1265 MemTxAttrs attrs, MemTxResult *result);
1266 void address_space_stw(AddressSpace *as, hwaddr addr, uint32_t val,
1267 MemTxAttrs attrs, MemTxResult *result);
1268 void address_space_stl(AddressSpace *as, hwaddr addr, uint32_t val,
1269 MemTxAttrs attrs, MemTxResult *result);
1270 void address_space_stq(AddressSpace *as, hwaddr addr, uint64_t val,
1271 MemTxAttrs attrs, MemTxResult *result);
1274 /* address_space_translate: translate an address range into an address space
1275 * into a MemoryRegion and an address range into that section. Should be
1276 * called from an RCU critical section, to avoid that the last reference
1277 * to the returned region disappears after address_space_translate returns.
1279 * @as: #AddressSpace to be accessed
1280 * @addr: address within that address space
1281 * @xlat: pointer to address within the returned memory region section's
1283 * @len: pointer to length
1284 * @is_write: indicates the transfer direction
1286 MemoryRegion *address_space_translate(AddressSpace *as, hwaddr addr,
1287 hwaddr *xlat, hwaddr *len,
1290 /* address_space_access_valid: check for validity of accessing an address
1293 * Check whether memory is assigned to the given address space range, and
1294 * access is permitted by any IOMMU regions that are active for the address
1297 * For now, addr and len should be aligned to a page size. This limitation
1298 * will be lifted in the future.
1300 * @as: #AddressSpace to be accessed
1301 * @addr: address within that address space
1302 * @len: length of the area to be checked
1303 * @is_write: indicates the transfer direction
1305 bool address_space_access_valid(AddressSpace *as, hwaddr addr, int len, bool is_write);
1307 /* address_space_map: map a physical memory region into a host virtual address
1309 * May map a subset of the requested range, given by and returned in @plen.
1310 * May return %NULL if resources needed to perform the mapping are exhausted.
1311 * Use only for reads OR writes - not for read-modify-write operations.
1312 * Use cpu_register_map_client() to know when retrying the map operation is
1313 * likely to succeed.
1315 * @as: #AddressSpace to be accessed
1316 * @addr: address within that address space
1317 * @plen: pointer to length of buffer; updated on return
1318 * @is_write: indicates the transfer direction
1320 void *address_space_map(AddressSpace *as, hwaddr addr,
1321 hwaddr *plen, bool is_write);
1323 /* address_space_unmap: Unmaps a memory region previously mapped by address_space_map()
1325 * Will also mark the memory as dirty if @is_write == %true. @access_len gives
1326 * the amount of memory that was actually read or written by the caller.
1328 * @as: #AddressSpace used
1329 * @addr: address within that address space
1330 * @len: buffer length as returned by address_space_map()
1331 * @access_len: amount of data actually transferred
1332 * @is_write: indicates the transfer direction
1334 void address_space_unmap(AddressSpace *as, void *buffer, hwaddr len,
1335 int is_write, hwaddr access_len);