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
21 #include "qemu-common.h"
22 #include "exec/cpu-common.h"
23 #ifndef CONFIG_USER_ONLY
24 #include "exec/hwaddr.h"
26 #include "qemu/queue.h"
27 #include "qemu/int128.h"
28 #include "qemu/notify.h"
30 #define MAX_PHYS_ADDR_SPACE_BITS 62
31 #define MAX_PHYS_ADDR (((hwaddr)1 << MAX_PHYS_ADDR_SPACE_BITS) - 1)
33 typedef struct MemoryRegionOps MemoryRegionOps
;
34 typedef struct MemoryRegionMmio MemoryRegionMmio
;
36 /* Must match *_DIRTY_FLAGS in cpu-all.h. To be replaced with dynamic
39 #define DIRTY_MEMORY_VGA 0
40 #define DIRTY_MEMORY_CODE 1
41 #define DIRTY_MEMORY_MIGRATION 3
43 struct MemoryRegionMmio
{
44 CPUReadMemoryFunc
*read
[3];
45 CPUWriteMemoryFunc
*write
[3];
48 typedef struct IOMMUTLBEntry IOMMUTLBEntry
;
50 /* See address_space_translate: bit 0 is read, bit 1 is write. */
58 struct IOMMUTLBEntry
{
59 AddressSpace
*target_as
;
61 hwaddr translated_addr
;
62 hwaddr addr_mask
; /* 0xfff = 4k translation */
63 IOMMUAccessFlags perm
;
67 * Memory region callbacks
69 struct MemoryRegionOps
{
70 /* Read from the memory region. @addr is relative to @mr; @size is
72 uint64_t (*read
)(void *opaque
,
75 /* Write to the memory region. @addr is relative to @mr; @size is
77 void (*write
)(void *opaque
,
82 enum device_endian endianness
;
83 /* Guest-visible constraints: */
85 /* If nonzero, specify bounds on access sizes beyond which a machine
88 unsigned min_access_size
;
89 unsigned max_access_size
;
90 /* If true, unaligned accesses are supported. Otherwise unaligned
91 * accesses throw machine checks.
95 * If present, and returns #false, the transaction is not accepted
96 * by the device (and results in machine dependent behaviour such
97 * as a machine check exception).
99 bool (*accepts
)(void *opaque
, hwaddr addr
,
100 unsigned size
, bool is_write
);
102 /* Internal implementation constraints: */
104 /* If nonzero, specifies the minimum size implemented. Smaller sizes
105 * will be rounded upwards and a partial result will be returned.
107 unsigned min_access_size
;
108 /* If nonzero, specifies the maximum size implemented. Larger sizes
109 * will be done as a series of accesses with smaller sizes.
111 unsigned max_access_size
;
112 /* If true, unaligned accesses are supported. Otherwise all accesses
113 * are converted to (possibly multiple) naturally aligned accesses.
118 /* If .read and .write are not present, old_mmio may be used for
119 * backwards compatibility with old mmio registration
121 const MemoryRegionMmio old_mmio
;
124 typedef struct MemoryRegionIOMMUOps MemoryRegionIOMMUOps
;
126 struct MemoryRegionIOMMUOps
{
127 /* Return a TLB entry that contains a given address. */
128 IOMMUTLBEntry (*translate
)(MemoryRegion
*iommu
, hwaddr addr
);
131 typedef struct CoalescedMemoryRange CoalescedMemoryRange
;
132 typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd
;
134 struct MemoryRegion
{
135 /* All fields are private - violators will be prosecuted */
136 const MemoryRegionOps
*ops
;
137 const MemoryRegionIOMMUOps
*iommu_ops
;
139 struct Object
*owner
;
140 MemoryRegion
*parent
;
143 void (*destructor
)(MemoryRegion
*mr
);
149 bool readonly
; /* For RAM regions */
152 bool warning_printed
; /* For reservations */
153 bool flush_coalesced_mmio
;
158 QTAILQ_HEAD(subregions
, MemoryRegion
) subregions
;
159 QTAILQ_ENTRY(MemoryRegion
) subregions_link
;
160 QTAILQ_HEAD(coalesced_ranges
, CoalescedMemoryRange
) coalesced
;
162 uint8_t dirty_log_mask
;
163 unsigned ioeventfd_nb
;
164 MemoryRegionIoeventfd
*ioeventfds
;
165 NotifierList iommu_notify
;
168 typedef struct MemoryListener MemoryListener
;
171 * MemoryListener: callbacks structure for updates to the physical memory map
173 * Allows a component to adjust to changes in the guest-visible memory map.
174 * Use with memory_listener_register() and memory_listener_unregister().
176 struct MemoryListener
{
177 void (*begin
)(MemoryListener
*listener
);
178 void (*commit
)(MemoryListener
*listener
);
179 void (*region_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
180 void (*region_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
181 void (*region_nop
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
182 void (*log_start
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
183 void (*log_stop
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
184 void (*log_sync
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
185 void (*log_global_start
)(MemoryListener
*listener
);
186 void (*log_global_stop
)(MemoryListener
*listener
);
187 void (*eventfd_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
188 bool match_data
, uint64_t data
, EventNotifier
*e
);
189 void (*eventfd_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
190 bool match_data
, uint64_t data
, EventNotifier
*e
);
191 void (*coalesced_mmio_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
192 hwaddr addr
, hwaddr len
);
193 void (*coalesced_mmio_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
194 hwaddr addr
, hwaddr len
);
195 /* Lower = earlier (during add), later (during del) */
197 AddressSpace
*address_space_filter
;
198 QTAILQ_ENTRY(MemoryListener
) link
;
202 * AddressSpace: describes a mapping of addresses to #MemoryRegion objects
204 struct AddressSpace
{
205 /* All fields are private. */
208 struct FlatView
*current_map
;
210 struct MemoryRegionIoeventfd
*ioeventfds
;
211 struct AddressSpaceDispatch
*dispatch
;
212 MemoryListener dispatch_listener
;
214 QTAILQ_ENTRY(AddressSpace
) address_spaces_link
;
218 * MemoryRegionSection: describes a fragment of a #MemoryRegion
220 * @mr: the region, or %NULL if empty
221 * @address_space: the address space the region is mapped in
222 * @offset_within_region: the beginning of the section, relative to @mr's start
223 * @size: the size of the section; will not exceed @mr's boundaries
224 * @offset_within_address_space: the address of the first byte of the section
225 * relative to the region's address space
226 * @readonly: writes to this section are ignored
228 struct MemoryRegionSection
{
230 AddressSpace
*address_space
;
231 hwaddr offset_within_region
;
233 hwaddr offset_within_address_space
;
238 * memory_region_init: Initialize a memory region
240 * The region typically acts as a container for other memory regions. Use
241 * memory_region_add_subregion() to add subregions.
243 * @mr: the #MemoryRegion to be initialized
244 * @owner: the object that tracks the region's reference count
245 * @name: used for debugging; not visible to the user or ABI
246 * @size: size of the region; any subregions beyond this size will be clipped
248 void memory_region_init(MemoryRegion
*mr
,
249 struct Object
*owner
,
254 * memory_region_ref: Add 1 to a memory region's reference count
256 * Whenever memory regions are accessed outside the BQL, they need to be
257 * preserved against hot-unplug. MemoryRegions actually do not have their
258 * own reference count; they piggyback on a QOM object, their "owner".
259 * This function adds a reference to the owner.
261 * All MemoryRegions must have an owner if they can disappear, even if the
262 * device they belong to operates exclusively under the BQL. This is because
263 * the region could be returned at any time by memory_region_find, and this
264 * is usually under guest control.
266 * @mr: the #MemoryRegion
268 void memory_region_ref(MemoryRegion
*mr
);
271 * memory_region_unref: Remove 1 to a memory region's reference count
273 * Whenever memory regions are accessed outside the BQL, they need to be
274 * preserved against hot-unplug. MemoryRegions actually do not have their
275 * own reference count; they piggyback on a QOM object, their "owner".
276 * This function removes a reference to the owner and possibly destroys it.
278 * @mr: the #MemoryRegion
280 void memory_region_unref(MemoryRegion
*mr
);
283 * memory_region_init_io: Initialize an I/O memory region.
285 * Accesses into the region will cause the callbacks in @ops to be called.
286 * if @size is nonzero, subregions will be clipped to @size.
288 * @mr: the #MemoryRegion to be initialized.
289 * @owner: the object that tracks the region's reference count
290 * @ops: a structure containing read and write callbacks to be used when
291 * I/O is performed on the region.
292 * @opaque: passed to to the read and write callbacks of the @ops structure.
293 * @name: used for debugging; not visible to the user or ABI
294 * @size: size of the region.
296 void memory_region_init_io(MemoryRegion
*mr
,
297 struct Object
*owner
,
298 const MemoryRegionOps
*ops
,
304 * memory_region_init_ram: Initialize RAM memory region. Accesses into the
305 * region will modify memory directly.
307 * @mr: the #MemoryRegion to be initialized.
308 * @owner: the object that tracks the region's reference count
309 * @name: the name of the region.
310 * @size: size of the region.
312 void memory_region_init_ram(MemoryRegion
*mr
,
313 struct Object
*owner
,
318 * memory_region_init_ram_ptr: Initialize RAM memory region from a
319 * user-provided pointer. Accesses into the
320 * region will modify memory directly.
322 * @mr: the #MemoryRegion to be initialized.
323 * @owner: the object that tracks the region's reference count
324 * @name: the name of the region.
325 * @size: size of the region.
326 * @ptr: memory to be mapped; must contain at least @size bytes.
328 void memory_region_init_ram_ptr(MemoryRegion
*mr
,
329 struct Object
*owner
,
335 * memory_region_init_alias: Initialize a memory region that aliases all or a
336 * part of another memory region.
338 * @mr: the #MemoryRegion to be initialized.
339 * @owner: the object that tracks the region's reference count
340 * @name: used for debugging; not visible to the user or ABI
341 * @orig: the region to be referenced; @mr will be equivalent to
342 * @orig between @offset and @offset + @size - 1.
343 * @offset: start of the section in @orig to be referenced.
344 * @size: size of the region.
346 void memory_region_init_alias(MemoryRegion
*mr
,
347 struct Object
*owner
,
354 * memory_region_init_rom_device: Initialize a ROM memory region. Writes are
355 * handled via callbacks.
357 * @mr: the #MemoryRegion to be initialized.
358 * @owner: the object that tracks the region's reference count
359 * @ops: callbacks for write access handling.
360 * @name: the name of the region.
361 * @size: size of the region.
363 void memory_region_init_rom_device(MemoryRegion
*mr
,
364 struct Object
*owner
,
365 const MemoryRegionOps
*ops
,
371 * memory_region_init_reservation: Initialize a memory region that reserves
374 * A reservation region primariy serves debugging purposes. It claims I/O
375 * space that is not supposed to be handled by QEMU itself. Any access via
376 * the memory API will cause an abort().
378 * @mr: the #MemoryRegion to be initialized
379 * @owner: the object that tracks the region's reference count
380 * @name: used for debugging; not visible to the user or ABI
381 * @size: size of the region.
383 void memory_region_init_reservation(MemoryRegion
*mr
,
384 struct Object
*owner
,
389 * memory_region_init_iommu: Initialize a memory region that translates
392 * An IOMMU region translates addresses and forwards accesses to a target
395 * @mr: the #MemoryRegion to be initialized
396 * @owner: the object that tracks the region's reference count
397 * @ops: a function that translates addresses into the @target region
398 * @name: used for debugging; not visible to the user or ABI
399 * @size: size of the region.
401 void memory_region_init_iommu(MemoryRegion
*mr
,
402 struct Object
*owner
,
403 const MemoryRegionIOMMUOps
*ops
,
408 * memory_region_destroy: Destroy a memory region and reclaim all resources.
410 * @mr: the region to be destroyed. May not currently be a subregion
411 * (see memory_region_add_subregion()) or referenced in an alias
412 * (see memory_region_init_alias()).
414 void memory_region_destroy(MemoryRegion
*mr
);
417 * memory_region_owner: get a memory region's owner.
419 * @mr: the memory region being queried.
421 struct Object
*memory_region_owner(MemoryRegion
*mr
);
424 * memory_region_size: get a memory region's size.
426 * @mr: the memory region being queried.
428 uint64_t memory_region_size(MemoryRegion
*mr
);
431 * memory_region_is_ram: check whether a memory region is random access
433 * Returns %true is a memory region is random access.
435 * @mr: the memory region being queried
437 bool memory_region_is_ram(MemoryRegion
*mr
);
440 * memory_region_is_romd: check whether a memory region is in ROMD mode
442 * Returns %true if a memory region is a ROM device and currently set to allow
445 * @mr: the memory region being queried
447 static inline bool memory_region_is_romd(MemoryRegion
*mr
)
449 return mr
->rom_device
&& mr
->romd_mode
;
453 * memory_region_is_iommu: check whether a memory region is an iommu
455 * Returns %true is a memory region is an iommu.
457 * @mr: the memory region being queried
459 bool memory_region_is_iommu(MemoryRegion
*mr
);
462 * memory_region_notify_iommu: notify a change in an IOMMU translation entry.
464 * @mr: the memory region that was changed
465 * @entry: the new entry in the IOMMU translation table. The entry
466 * replaces all old entries for the same virtual I/O address range.
467 * Deleted entries have .@perm == 0.
469 void memory_region_notify_iommu(MemoryRegion
*mr
,
470 IOMMUTLBEntry entry
);
473 * memory_region_register_iommu_notifier: register a notifier for changes to
474 * IOMMU translation entries.
476 * @mr: the memory region to observe
477 * @n: the notifier to be added; the notifier receives a pointer to an
478 * #IOMMUTLBEntry as the opaque value; the pointer ceases to be
479 * valid on exit from the notifier.
481 void memory_region_register_iommu_notifier(MemoryRegion
*mr
, Notifier
*n
);
484 * memory_region_unregister_iommu_notifier: unregister a notifier for
485 * changes to IOMMU translation entries.
487 * @n: the notifier to be removed.
489 void memory_region_unregister_iommu_notifier(Notifier
*n
);
492 * memory_region_name: get a memory region's name
494 * Returns the string that was used to initialize the memory region.
496 * @mr: the memory region being queried
498 const char *memory_region_name(MemoryRegion
*mr
);
501 * memory_region_is_logging: return whether a memory region is logging writes
503 * Returns %true if the memory region is logging writes
505 * @mr: the memory region being queried
507 bool memory_region_is_logging(MemoryRegion
*mr
);
510 * memory_region_is_rom: check whether a memory region is ROM
512 * Returns %true is a memory region is read-only memory.
514 * @mr: the memory region being queried
516 bool memory_region_is_rom(MemoryRegion
*mr
);
519 * memory_region_get_ram_ptr: Get a pointer into a RAM memory region.
521 * Returns a host pointer to a RAM memory region (created with
522 * memory_region_init_ram() or memory_region_init_ram_ptr()). Use with
525 * @mr: the memory region being queried.
527 void *memory_region_get_ram_ptr(MemoryRegion
*mr
);
530 * memory_region_set_log: Turn dirty logging on or off for a region.
532 * Turns dirty logging on or off for a specified client (display, migration).
533 * Only meaningful for RAM regions.
535 * @mr: the memory region being updated.
536 * @log: whether dirty logging is to be enabled or disabled.
537 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
540 void memory_region_set_log(MemoryRegion
*mr
, bool log
, unsigned client
);
543 * memory_region_get_dirty: Check whether a range of bytes is dirty
544 * for a specified client.
546 * Checks whether a range of bytes has been written to since the last
547 * call to memory_region_reset_dirty() with the same @client. Dirty logging
550 * @mr: the memory region being queried.
551 * @addr: the address (relative to the start of the region) being queried.
552 * @size: the size of the range being queried.
553 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
556 bool memory_region_get_dirty(MemoryRegion
*mr
, hwaddr addr
,
557 hwaddr size
, unsigned client
);
560 * memory_region_set_dirty: Mark a range of bytes as dirty in a memory region.
562 * Marks a range of bytes as dirty, after it has been dirtied outside
565 * @mr: the memory region being dirtied.
566 * @addr: the address (relative to the start of the region) being dirtied.
567 * @size: size of the range being dirtied.
569 void memory_region_set_dirty(MemoryRegion
*mr
, hwaddr addr
,
573 * memory_region_test_and_clear_dirty: Check whether a range of bytes is dirty
574 * for a specified client. It clears them.
576 * Checks whether a range of bytes has been written to since the last
577 * call to memory_region_reset_dirty() with the same @client. Dirty logging
580 * @mr: the memory region being queried.
581 * @addr: the address (relative to the start of the region) being queried.
582 * @size: the size of the range being queried.
583 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
586 bool memory_region_test_and_clear_dirty(MemoryRegion
*mr
, hwaddr addr
,
587 hwaddr size
, unsigned client
);
589 * memory_region_sync_dirty_bitmap: Synchronize a region's dirty bitmap with
590 * any external TLBs (e.g. kvm)
592 * Flushes dirty information from accelerators such as kvm and vhost-net
593 * and makes it available to users of the memory API.
595 * @mr: the region being flushed.
597 void memory_region_sync_dirty_bitmap(MemoryRegion
*mr
);
600 * memory_region_reset_dirty: Mark a range of pages as clean, for a specified
603 * Marks a range of pages as no longer dirty.
605 * @mr: the region being updated.
606 * @addr: the start of the subrange being cleaned.
607 * @size: the size of the subrange being cleaned.
608 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
611 void memory_region_reset_dirty(MemoryRegion
*mr
, hwaddr addr
,
612 hwaddr size
, unsigned client
);
615 * memory_region_set_readonly: Turn a memory region read-only (or read-write)
617 * Allows a memory region to be marked as read-only (turning it into a ROM).
618 * only useful on RAM regions.
620 * @mr: the region being updated.
621 * @readonly: whether rhe region is to be ROM or RAM.
623 void memory_region_set_readonly(MemoryRegion
*mr
, bool readonly
);
626 * memory_region_rom_device_set_romd: enable/disable ROMD mode
628 * Allows a ROM device (initialized with memory_region_init_rom_device() to
629 * set to ROMD mode (default) or MMIO mode. When it is in ROMD mode, the
630 * device is mapped to guest memory and satisfies read access directly.
631 * When in MMIO mode, reads are forwarded to the #MemoryRegion.read function.
632 * Writes are always handled by the #MemoryRegion.write function.
634 * @mr: the memory region to be updated
635 * @romd_mode: %true to put the region into ROMD mode
637 void memory_region_rom_device_set_romd(MemoryRegion
*mr
, bool romd_mode
);
640 * memory_region_set_coalescing: Enable memory coalescing for the region.
642 * Enabled writes to a region to be queued for later processing. MMIO ->write
643 * callbacks may be delayed until a non-coalesced MMIO is issued.
644 * Only useful for IO regions. Roughly similar to write-combining hardware.
646 * @mr: the memory region to be write coalesced
648 void memory_region_set_coalescing(MemoryRegion
*mr
);
651 * memory_region_add_coalescing: Enable memory coalescing for a sub-range of
654 * Like memory_region_set_coalescing(), but works on a sub-range of a region.
655 * Multiple calls can be issued coalesced disjoint ranges.
657 * @mr: the memory region to be updated.
658 * @offset: the start of the range within the region to be coalesced.
659 * @size: the size of the subrange to be coalesced.
661 void memory_region_add_coalescing(MemoryRegion
*mr
,
666 * memory_region_clear_coalescing: Disable MMIO coalescing for the region.
668 * Disables any coalescing caused by memory_region_set_coalescing() or
669 * memory_region_add_coalescing(). Roughly equivalent to uncacheble memory
672 * @mr: the memory region to be updated.
674 void memory_region_clear_coalescing(MemoryRegion
*mr
);
677 * memory_region_set_flush_coalesced: Enforce memory coalescing flush before
680 * Ensure that pending coalesced MMIO request are flushed before the memory
681 * region is accessed. This property is automatically enabled for all regions
682 * passed to memory_region_set_coalescing() and memory_region_add_coalescing().
684 * @mr: the memory region to be updated.
686 void memory_region_set_flush_coalesced(MemoryRegion
*mr
);
689 * memory_region_clear_flush_coalesced: Disable memory coalescing flush before
692 * Clear the automatic coalesced MMIO flushing enabled via
693 * memory_region_set_flush_coalesced. Note that this service has no effect on
694 * memory regions that have MMIO coalescing enabled for themselves. For them,
695 * automatic flushing will stop once coalescing is disabled.
697 * @mr: the memory region to be updated.
699 void memory_region_clear_flush_coalesced(MemoryRegion
*mr
);
702 * memory_region_add_eventfd: Request an eventfd to be triggered when a word
703 * is written to a location.
705 * Marks a word in an IO region (initialized with memory_region_init_io())
706 * as a trigger for an eventfd event. The I/O callback will not be called.
707 * The caller must be prepared to handle failure (that is, take the required
708 * action if the callback _is_ called).
710 * @mr: the memory region being updated.
711 * @addr: the address within @mr that is to be monitored
712 * @size: the size of the access to trigger the eventfd
713 * @match_data: whether to match against @data, instead of just @addr
714 * @data: the data to match against the guest write
715 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
717 void memory_region_add_eventfd(MemoryRegion
*mr
,
725 * memory_region_del_eventfd: Cancel an eventfd.
727 * Cancels an eventfd trigger requested by a previous
728 * memory_region_add_eventfd() call.
730 * @mr: the memory region being updated.
731 * @addr: the address within @mr that is to be monitored
732 * @size: the size of the access to trigger the eventfd
733 * @match_data: whether to match against @data, instead of just @addr
734 * @data: the data to match against the guest write
735 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
737 void memory_region_del_eventfd(MemoryRegion
*mr
,
745 * memory_region_add_subregion: Add a subregion to a container.
747 * Adds a subregion at @offset. The subregion may not overlap with other
748 * subregions (except for those explicitly marked as overlapping). A region
749 * may only be added once as a subregion (unless removed with
750 * memory_region_del_subregion()); use memory_region_init_alias() if you
751 * want a region to be a subregion in multiple locations.
753 * @mr: the region to contain the new subregion; must be a container
754 * initialized with memory_region_init().
755 * @offset: the offset relative to @mr where @subregion is added.
756 * @subregion: the subregion to be added.
758 void memory_region_add_subregion(MemoryRegion
*mr
,
760 MemoryRegion
*subregion
);
762 * memory_region_add_subregion_overlap: Add a subregion to a container
765 * Adds a subregion at @offset. The subregion may overlap with other
766 * subregions. Conflicts are resolved by having a higher @priority hide a
767 * lower @priority. Subregions without priority are taken as @priority 0.
768 * A region may only be added once as a subregion (unless removed with
769 * memory_region_del_subregion()); use memory_region_init_alias() if you
770 * want a region to be a subregion in multiple locations.
772 * @mr: the region to contain the new subregion; must be a container
773 * initialized with memory_region_init().
774 * @offset: the offset relative to @mr where @subregion is added.
775 * @subregion: the subregion to be added.
776 * @priority: used for resolving overlaps; highest priority wins.
778 void memory_region_add_subregion_overlap(MemoryRegion
*mr
,
780 MemoryRegion
*subregion
,
784 * memory_region_get_ram_addr: Get the ram address associated with a memory
787 * DO NOT USE THIS FUNCTION. This is a temporary workaround while the Xen
788 * code is being reworked.
790 ram_addr_t
memory_region_get_ram_addr(MemoryRegion
*mr
);
793 * memory_region_del_subregion: Remove a subregion.
795 * Removes a subregion from its container.
797 * @mr: the container to be updated.
798 * @subregion: the region being removed; must be a current subregion of @mr.
800 void memory_region_del_subregion(MemoryRegion
*mr
,
801 MemoryRegion
*subregion
);
804 * memory_region_set_enabled: dynamically enable or disable a region
806 * Enables or disables a memory region. A disabled memory region
807 * ignores all accesses to itself and its subregions. It does not
808 * obscure sibling subregions with lower priority - it simply behaves as
809 * if it was removed from the hierarchy.
811 * Regions default to being enabled.
813 * @mr: the region to be updated
814 * @enabled: whether to enable or disable the region
816 void memory_region_set_enabled(MemoryRegion
*mr
, bool enabled
);
819 * memory_region_set_address: dynamically update the address of a region
821 * Dynamically updates the address of a region, relative to its parent.
822 * May be used on regions are currently part of a memory hierarchy.
824 * @mr: the region to be updated
825 * @addr: new address, relative to parent region
827 void memory_region_set_address(MemoryRegion
*mr
, hwaddr addr
);
830 * memory_region_set_alias_offset: dynamically update a memory alias's offset
832 * Dynamically updates the offset into the target region that an alias points
833 * to, as if the fourth argument to memory_region_init_alias() has changed.
835 * @mr: the #MemoryRegion to be updated; should be an alias.
836 * @offset: the new offset into the target memory region
838 void memory_region_set_alias_offset(MemoryRegion
*mr
,
842 * memory_region_present: translate an address/size relative to a
843 * MemoryRegion into a #MemoryRegionSection.
845 * Answer whether a #MemoryRegion within @parent covers the address
848 * @parent: a MemoryRegion within which @addr is a relative address
849 * @addr: the area within @parent to be searched
851 bool memory_region_present(MemoryRegion
*parent
, hwaddr addr
);
854 * memory_region_find: translate an address/size relative to a
855 * MemoryRegion into a #MemoryRegionSection.
857 * Locates the first #MemoryRegion within @mr that overlaps the range
858 * given by @addr and @size.
860 * Returns a #MemoryRegionSection that describes a contiguous overlap.
861 * It will have the following characteristics:
862 * .@size = 0 iff no overlap was found
863 * .@mr is non-%NULL iff an overlap was found
865 * Remember that in the return value the @offset_within_region is
866 * relative to the returned region (in the .@mr field), not to the
869 * Similarly, the .@offset_within_address_space is relative to the
870 * address space that contains both regions, the passed and the
871 * returned one. However, in the special case where the @mr argument
872 * has no parent (and thus is the root of the address space), the
873 * following will hold:
874 * .@offset_within_address_space >= @addr
875 * .@offset_within_address_space + .@size <= @addr + @size
877 * @mr: a MemoryRegion within which @addr is a relative address
878 * @addr: start of the area within @as to be searched
879 * @size: size of the area to be searched
881 MemoryRegionSection
memory_region_find(MemoryRegion
*mr
,
882 hwaddr addr
, uint64_t size
);
885 * address_space_sync_dirty_bitmap: synchronize the dirty log for all memory
887 * Synchronizes the dirty page log for an entire address space.
888 * @as: the address space that contains the memory being synchronized
890 void address_space_sync_dirty_bitmap(AddressSpace
*as
);
893 * memory_region_transaction_begin: Start a transaction.
895 * During a transaction, changes will be accumulated and made visible
896 * only when the transaction ends (is committed).
898 void memory_region_transaction_begin(void);
901 * memory_region_transaction_commit: Commit a transaction and make changes
902 * visible to the guest.
904 void memory_region_transaction_commit(void);
907 * memory_listener_register: register callbacks to be called when memory
908 * sections are mapped or unmapped into an address
911 * @listener: an object containing the callbacks to be called
912 * @filter: if non-%NULL, only regions in this address space will be observed
914 void memory_listener_register(MemoryListener
*listener
, AddressSpace
*filter
);
917 * memory_listener_unregister: undo the effect of memory_listener_register()
919 * @listener: an object containing the callbacks to be removed
921 void memory_listener_unregister(MemoryListener
*listener
);
924 * memory_global_dirty_log_start: begin dirty logging for all regions
926 void memory_global_dirty_log_start(void);
929 * memory_global_dirty_log_stop: end dirty logging for all regions
931 void memory_global_dirty_log_stop(void);
933 void mtree_info(fprintf_function mon_printf
, void *f
);
936 * address_space_init: initializes an address space
938 * @as: an uninitialized #AddressSpace
939 * @root: a #MemoryRegion that routes addesses for the address space
940 * @name: an address space name. The name is only used for debugging
943 void address_space_init(AddressSpace
*as
, MemoryRegion
*root
, const char *name
);
947 * address_space_destroy: destroy an address space
949 * Releases all resources associated with an address space. After an address space
950 * is destroyed, its root memory region (given by address_space_init()) may be destroyed
953 * @as: address space to be destroyed
955 void address_space_destroy(AddressSpace
*as
);
958 * address_space_rw: read from or write to an address space.
960 * Return true if the operation hit any unassigned memory or encountered an
963 * @as: #AddressSpace to be accessed
964 * @addr: address within that address space
965 * @buf: buffer with the data transferred
966 * @is_write: indicates the transfer direction
968 bool address_space_rw(AddressSpace
*as
, hwaddr addr
, uint8_t *buf
,
969 int len
, bool is_write
);
972 * address_space_write: write to address space.
974 * Return true if the operation hit any unassigned memory or encountered an
977 * @as: #AddressSpace to be accessed
978 * @addr: address within that address space
979 * @buf: buffer with the data transferred
981 bool address_space_write(AddressSpace
*as
, hwaddr addr
,
982 const uint8_t *buf
, int len
);
985 * address_space_read: read from an address space.
987 * Return true if the operation hit any unassigned memory or encountered an
990 * @as: #AddressSpace to be accessed
991 * @addr: address within that address space
992 * @buf: buffer with the data transferred
994 bool address_space_read(AddressSpace
*as
, hwaddr addr
, uint8_t *buf
, int len
);
996 /* address_space_translate: translate an address range into an address space
997 * into a MemoryRegion and an address range into that section
999 * @as: #AddressSpace to be accessed
1000 * @addr: address within that address space
1001 * @xlat: pointer to address within the returned memory region section's
1003 * @len: pointer to length
1004 * @is_write: indicates the transfer direction
1006 MemoryRegion
*address_space_translate(AddressSpace
*as
, hwaddr addr
,
1007 hwaddr
*xlat
, hwaddr
*len
,
1010 /* address_space_access_valid: check for validity of accessing an address
1013 * Check whether memory is assigned to the given address space range, and
1014 * access is permitted by any IOMMU regions that are active for the address
1017 * For now, addr and len should be aligned to a page size. This limitation
1018 * will be lifted in the future.
1020 * @as: #AddressSpace to be accessed
1021 * @addr: address within that address space
1022 * @len: length of the area to be checked
1023 * @is_write: indicates the transfer direction
1025 bool address_space_access_valid(AddressSpace
*as
, hwaddr addr
, int len
, bool is_write
);
1027 /* address_space_map: map a physical memory region into a host virtual address
1029 * May map a subset of the requested range, given by and returned in @plen.
1030 * May return %NULL if resources needed to perform the mapping are exhausted.
1031 * Use only for reads OR writes - not for read-modify-write operations.
1032 * Use cpu_register_map_client() to know when retrying the map operation is
1033 * likely to succeed.
1035 * @as: #AddressSpace to be accessed
1036 * @addr: address within that address space
1037 * @plen: pointer to length of buffer; updated on return
1038 * @is_write: indicates the transfer direction
1040 void *address_space_map(AddressSpace
*as
, hwaddr addr
,
1041 hwaddr
*plen
, bool is_write
);
1043 /* address_space_unmap: Unmaps a memory region previously mapped by address_space_map()
1045 * Will also mark the memory as dirty if @is_write == %true. @access_len gives
1046 * the amount of memory that was actually read or written by the caller.
1048 * @as: #AddressSpace used
1049 * @addr: address within that address space
1050 * @len: buffer length as returned by address_space_map()
1051 * @access_len: amount of data actually transferred
1052 * @is_write: indicates the transfer direction
1054 void address_space_unmap(AddressSpace
*as
, void *buffer
, hwaddr len
,
1055 int is_write
, hwaddr access_len
);