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 "cpu-common.h"
24 #include "qemu-queue.h"
29 typedef struct MemoryRegionOps MemoryRegionOps
;
30 typedef struct MemoryRegion MemoryRegion
;
31 typedef struct MemoryRegionPortio MemoryRegionPortio
;
32 typedef struct MemoryRegionMmio MemoryRegionMmio
;
34 /* Must match *_DIRTY_FLAGS in cpu-all.h. To be replaced with dynamic
37 #define DIRTY_MEMORY_VGA 0
38 #define DIRTY_MEMORY_CODE 1
39 #define DIRTY_MEMORY_MIGRATION 3
41 struct MemoryRegionMmio
{
42 CPUReadMemoryFunc
*read
[3];
43 CPUWriteMemoryFunc
*write
[3];
47 * Memory region callbacks
49 struct MemoryRegionOps
{
50 /* Read from the memory region. @addr is relative to @mr; @size is
52 uint64_t (*read
)(void *opaque
,
53 target_phys_addr_t addr
,
55 /* Write to the memory region. @addr is relative to @mr; @size is
57 void (*write
)(void *opaque
,
58 target_phys_addr_t addr
,
62 enum device_endian endianness
;
63 /* Guest-visible constraints: */
65 /* If nonzero, specify bounds on access sizes beyond which a machine
68 unsigned min_access_size
;
69 unsigned max_access_size
;
70 /* If true, unaligned accesses are supported. Otherwise unaligned
71 * accesses throw machine checks.
75 * If present, and returns #false, the transaction is not accepted
76 * by the device (and results in machine dependent behaviour such
77 * as a machine check exception).
79 bool (*accepts
)(void *opaque
, target_phys_addr_t addr
,
80 unsigned size
, bool is_write
);
82 /* Internal implementation constraints: */
84 /* If nonzero, specifies the minimum size implemented. Smaller sizes
85 * will be rounded upwards and a partial result will be returned.
87 unsigned min_access_size
;
88 /* If nonzero, specifies the maximum size implemented. Larger sizes
89 * will be done as a series of accesses with smaller sizes.
91 unsigned max_access_size
;
92 /* If true, unaligned accesses are supported. Otherwise all accesses
93 * are converted to (possibly multiple) naturally aligned accesses.
98 /* If .read and .write are not present, old_portio may be used for
99 * backwards compatibility with old portio registration
101 const MemoryRegionPortio
*old_portio
;
102 /* If .read and .write are not present, old_mmio may be used for
103 * backwards compatibility with old mmio registration
105 const MemoryRegionMmio old_mmio
;
108 typedef struct CoalescedMemoryRange CoalescedMemoryRange
;
109 typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd
;
111 struct MemoryRegion
{
112 /* All fields are private - violators will be prosecuted */
113 const MemoryRegionOps
*ops
;
115 MemoryRegion
*parent
;
117 target_phys_addr_t addr
;
118 void (*destructor
)(MemoryRegion
*mr
);
125 bool readonly
; /* For RAM regions */
128 bool warning_printed
; /* For reservations */
130 target_phys_addr_t alias_offset
;
133 QTAILQ_HEAD(subregions
, MemoryRegion
) subregions
;
134 QTAILQ_ENTRY(MemoryRegion
) subregions_link
;
135 QTAILQ_HEAD(coalesced_ranges
, CoalescedMemoryRange
) coalesced
;
137 uint8_t dirty_log_mask
;
138 unsigned ioeventfd_nb
;
139 MemoryRegionIoeventfd
*ioeventfds
;
142 struct MemoryRegionPortio
{
146 IOPortReadFunc
*read
;
147 IOPortWriteFunc
*write
;
150 #define PORTIO_END_OF_LIST() { }
152 typedef struct MemoryRegionSection MemoryRegionSection
;
155 * MemoryRegionSection: describes a fragment of a #MemoryRegion
157 * @mr: the region, or %NULL if empty
158 * @address_space: the address space the region is mapped in
159 * @offset_within_region: the beginning of the section, relative to @mr's start
160 * @size: the size of the section; will not exceed @mr's boundaries
161 * @offset_within_address_space: the address of the first byte of the section
162 * relative to the region's address space
163 * @readonly: writes to this section are ignored
165 struct MemoryRegionSection
{
167 MemoryRegion
*address_space
;
168 target_phys_addr_t offset_within_region
;
170 target_phys_addr_t offset_within_address_space
;
174 typedef struct MemoryListener MemoryListener
;
177 * MemoryListener: callbacks structure for updates to the physical memory map
179 * Allows a component to adjust to changes in the guest-visible memory map.
180 * Use with memory_listener_register() and memory_listener_unregister().
182 struct MemoryListener
{
183 void (*region_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
184 void (*region_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
185 void (*log_start
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
186 void (*log_stop
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
187 void (*log_sync
)(MemoryListener
*listener
, MemoryRegionSection
*section
);
188 void (*log_global_start
)(MemoryListener
*listener
);
189 void (*log_global_stop
)(MemoryListener
*listener
);
190 void (*eventfd_add
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
191 bool match_data
, uint64_t data
, int fd
);
192 void (*eventfd_del
)(MemoryListener
*listener
, MemoryRegionSection
*section
,
193 bool match_data
, uint64_t data
, int fd
);
194 /* Lower = earlier (during add), later (during del) */
196 MemoryRegion
*address_space_filter
;
197 QTAILQ_ENTRY(MemoryListener
) link
;
201 * memory_region_init: Initialize a memory region
203 * The region typically acts as a container for other memory regions. Use
204 * memory_region_add_subregion() to add subregions.
206 * @mr: the #MemoryRegion to be initialized
207 * @name: used for debugging; not visible to the user or ABI
208 * @size: size of the region; any subregions beyond this size will be clipped
210 void memory_region_init(MemoryRegion
*mr
,
214 * memory_region_init_io: Initialize an I/O memory region.
216 * Accesses into the region will cause the callbacks in @ops to be called.
217 * if @size is nonzero, subregions will be clipped to @size.
219 * @mr: the #MemoryRegion to be initialized.
220 * @ops: a structure containing read and write callbacks to be used when
221 * I/O is performed on the region.
222 * @opaque: passed to to the read and write callbacks of the @ops structure.
223 * @name: used for debugging; not visible to the user or ABI
224 * @size: size of the region.
226 void memory_region_init_io(MemoryRegion
*mr
,
227 const MemoryRegionOps
*ops
,
233 * memory_region_init_ram: Initialize RAM memory region. Accesses into the
234 * region will modify memory directly.
236 * @mr: the #MemoryRegion to be initialized.
237 * @name: the name of the region.
238 * @size: size of the region.
240 void memory_region_init_ram(MemoryRegion
*mr
,
245 * memory_region_init_ram: Initialize RAM memory region from a user-provided.
246 * pointer. Accesses into the region will modify
249 * @mr: the #MemoryRegion to be initialized.
250 * @name: the name of the region.
251 * @size: size of the region.
252 * @ptr: memory to be mapped; must contain at least @size bytes.
254 void memory_region_init_ram_ptr(MemoryRegion
*mr
,
260 * memory_region_init_alias: Initialize a memory region that aliases all or a
261 * part of another memory region.
263 * @mr: the #MemoryRegion to be initialized.
264 * @name: used for debugging; not visible to the user or ABI
265 * @orig: the region to be referenced; @mr will be equivalent to
266 * @orig between @offset and @offset + @size - 1.
267 * @offset: start of the section in @orig to be referenced.
268 * @size: size of the region.
270 void memory_region_init_alias(MemoryRegion
*mr
,
273 target_phys_addr_t offset
,
277 * memory_region_init_rom_device: Initialize a ROM memory region. Writes are
278 * handled via callbacks.
280 * @mr: the #MemoryRegion to be initialized.
281 * @ops: callbacks for write access handling.
282 * @name: the name of the region.
283 * @size: size of the region.
285 void memory_region_init_rom_device(MemoryRegion
*mr
,
286 const MemoryRegionOps
*ops
,
292 * memory_region_init_reservation: Initialize a memory region that reserves
295 * A reservation region primariy serves debugging purposes. It claims I/O
296 * space that is not supposed to be handled by QEMU itself. Any access via
297 * the memory API will cause an abort().
299 * @mr: the #MemoryRegion to be initialized
300 * @name: used for debugging; not visible to the user or ABI
301 * @size: size of the region.
303 void memory_region_init_reservation(MemoryRegion
*mr
,
307 * memory_region_destroy: Destroy a memory region and reclaim all resources.
309 * @mr: the region to be destroyed. May not currently be a subregion
310 * (see memory_region_add_subregion()) or referenced in an alias
311 * (see memory_region_init_alias()).
313 void memory_region_destroy(MemoryRegion
*mr
);
316 * memory_region_size: get a memory region's size.
318 * @mr: the memory region being queried.
320 uint64_t memory_region_size(MemoryRegion
*mr
);
323 * memory_region_is_ram: check whether a memory region is random access
325 * Returns %true is a memory region is random access.
327 * @mr: the memory region being queried
329 bool memory_region_is_ram(MemoryRegion
*mr
);
332 * memory_region_name: get a memory region's name
334 * Returns the string that was used to initialize the memory region.
336 * @mr: the memory region being queried
338 const char *memory_region_name(MemoryRegion
*mr
);
341 * memory_region_is_logging: return whether a memory region is logging writes
343 * Returns %true if the memory region is logging writes
345 * @mr: the memory region being queried
347 bool memory_region_is_logging(MemoryRegion
*mr
);
350 * memory_region_is_rom: check whether a memory region is ROM
352 * Returns %true is a memory region is read-only memory.
354 * @mr: the memory region being queried
356 bool memory_region_is_rom(MemoryRegion
*mr
);
359 * memory_region_get_ram_ptr: Get a pointer into a RAM memory region.
361 * Returns a host pointer to a RAM memory region (created with
362 * memory_region_init_ram() or memory_region_init_ram_ptr()). Use with
365 * @mr: the memory region being queried.
367 void *memory_region_get_ram_ptr(MemoryRegion
*mr
);
370 * memory_region_set_log: Turn dirty logging on or off for a region.
372 * Turns dirty logging on or off for a specified client (display, migration).
373 * Only meaningful for RAM regions.
375 * @mr: the memory region being updated.
376 * @log: whether dirty logging is to be enabled or disabled.
377 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
380 void memory_region_set_log(MemoryRegion
*mr
, bool log
, unsigned client
);
383 * memory_region_get_dirty: Check whether a range of bytes is dirty
384 * for a specified client.
386 * Checks whether a range of bytes has been written to since the last
387 * call to memory_region_reset_dirty() with the same @client. Dirty logging
390 * @mr: the memory region being queried.
391 * @addr: the address (relative to the start of the region) being queried.
392 * @size: the size of the range being queried.
393 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
396 bool memory_region_get_dirty(MemoryRegion
*mr
, target_phys_addr_t addr
,
397 target_phys_addr_t size
, unsigned client
);
400 * memory_region_set_dirty: Mark a range of bytes as dirty in a memory region.
402 * Marks a range of bytes as dirty, after it has been dirtied outside
405 * @mr: the memory region being dirtied.
406 * @addr: the address (relative to the start of the region) being dirtied.
407 * @size: size of the range being dirtied.
409 void memory_region_set_dirty(MemoryRegion
*mr
, target_phys_addr_t addr
,
410 target_phys_addr_t size
);
413 * memory_region_sync_dirty_bitmap: Synchronize a region's dirty bitmap with
414 * any external TLBs (e.g. kvm)
416 * Flushes dirty information from accelerators such as kvm and vhost-net
417 * and makes it available to users of the memory API.
419 * @mr: the region being flushed.
421 void memory_region_sync_dirty_bitmap(MemoryRegion
*mr
);
424 * memory_region_reset_dirty: Mark a range of pages as clean, for a specified
427 * Marks a range of pages as no longer dirty.
429 * @mr: the region being updated.
430 * @addr: the start of the subrange being cleaned.
431 * @size: the size of the subrange being cleaned.
432 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
435 void memory_region_reset_dirty(MemoryRegion
*mr
, target_phys_addr_t addr
,
436 target_phys_addr_t size
, unsigned client
);
439 * memory_region_set_readonly: Turn a memory region read-only (or read-write)
441 * Allows a memory region to be marked as read-only (turning it into a ROM).
442 * only useful on RAM regions.
444 * @mr: the region being updated.
445 * @readonly: whether rhe region is to be ROM or RAM.
447 void memory_region_set_readonly(MemoryRegion
*mr
, bool readonly
);
450 * memory_region_rom_device_set_readable: enable/disable ROM readability
452 * Allows a ROM device (initialized with memory_region_init_rom_device() to
453 * to be marked as readable (default) or not readable. When it is readable,
454 * the device is mapped to guest memory. When not readable, reads are
455 * forwarded to the #MemoryRegion.read function.
457 * @mr: the memory region to be updated
458 * @readable: whether reads are satisified directly (%true) or via callbacks
461 void memory_region_rom_device_set_readable(MemoryRegion
*mr
, bool readable
);
464 * memory_region_set_coalescing: Enable memory coalescing for the region.
466 * Enabled writes to a region to be queued for later processing. MMIO ->write
467 * callbacks may be delayed until a non-coalesced MMIO is issued.
468 * Only useful for IO regions. Roughly similar to write-combining hardware.
470 * @mr: the memory region to be write coalesced
472 void memory_region_set_coalescing(MemoryRegion
*mr
);
475 * memory_region_add_coalescing: Enable memory coalescing for a sub-range of
478 * Like memory_region_set_coalescing(), but works on a sub-range of a region.
479 * Multiple calls can be issued coalesced disjoint ranges.
481 * @mr: the memory region to be updated.
482 * @offset: the start of the range within the region to be coalesced.
483 * @size: the size of the subrange to be coalesced.
485 void memory_region_add_coalescing(MemoryRegion
*mr
,
486 target_phys_addr_t offset
,
490 * memory_region_clear_coalescing: Disable MMIO coalescing for the region.
492 * Disables any coalescing caused by memory_region_set_coalescing() or
493 * memory_region_add_coalescing(). Roughly equivalent to uncacheble memory
496 * @mr: the memory region to be updated.
498 void memory_region_clear_coalescing(MemoryRegion
*mr
);
501 * memory_region_add_eventfd: Request an eventfd to be triggered when a word
502 * is written to a location.
504 * Marks a word in an IO region (initialized with memory_region_init_io())
505 * as a trigger for an eventfd event. The I/O callback will not be called.
506 * The caller must be prepared to handle failure (that is, take the required
507 * action if the callback _is_ called).
509 * @mr: the memory region being updated.
510 * @addr: the address within @mr that is to be monitored
511 * @size: the size of the access to trigger the eventfd
512 * @match_data: whether to match against @data, instead of just @addr
513 * @data: the data to match against the guest write
514 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
516 void memory_region_add_eventfd(MemoryRegion
*mr
,
517 target_phys_addr_t addr
,
524 * memory_region_del_eventfd: Cancel an eventfd.
526 * Cancels an eventfd trigger requested by a previous
527 * memory_region_add_eventfd() call.
529 * @mr: the memory region being updated.
530 * @addr: the address within @mr that is to be monitored
531 * @size: the size of the access to trigger the eventfd
532 * @match_data: whether to match against @data, instead of just @addr
533 * @data: the data to match against the guest write
534 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
536 void memory_region_del_eventfd(MemoryRegion
*mr
,
537 target_phys_addr_t addr
,
543 * memory_region_add_subregion: Add a subregion to a container.
545 * Adds a subregion at @offset. The subregion may not overlap with other
546 * subregions (except for those explicitly marked as overlapping). A region
547 * may only be added once as a subregion (unless removed with
548 * memory_region_del_subregion()); use memory_region_init_alias() if you
549 * want a region to be a subregion in multiple locations.
551 * @mr: the region to contain the new subregion; must be a container
552 * initialized with memory_region_init().
553 * @offset: the offset relative to @mr where @subregion is added.
554 * @subregion: the subregion to be added.
556 void memory_region_add_subregion(MemoryRegion
*mr
,
557 target_phys_addr_t offset
,
558 MemoryRegion
*subregion
);
560 * memory_region_add_subregion: Add a subregion to a container, with overlap.
562 * Adds a subregion at @offset. The subregion may overlap with other
563 * subregions. Conflicts are resolved by having a higher @priority hide a
564 * lower @priority. Subregions without priority are taken as @priority 0.
565 * A region may only be added once as a subregion (unless removed with
566 * memory_region_del_subregion()); use memory_region_init_alias() if you
567 * want a region to be a subregion in multiple locations.
569 * @mr: the region to contain the new subregion; must be a container
570 * initialized with memory_region_init().
571 * @offset: the offset relative to @mr where @subregion is added.
572 * @subregion: the subregion to be added.
573 * @priority: used for resolving overlaps; highest priority wins.
575 void memory_region_add_subregion_overlap(MemoryRegion
*mr
,
576 target_phys_addr_t offset
,
577 MemoryRegion
*subregion
,
581 * memory_region_get_ram_addr: Get the ram address associated with a memory
584 * DO NOT USE THIS FUNCTION. This is a temporary workaround while the Xen
585 * code is being reworked.
587 ram_addr_t
memory_region_get_ram_addr(MemoryRegion
*mr
);
590 * memory_region_del_subregion: Remove a subregion.
592 * Removes a subregion from its container.
594 * @mr: the container to be updated.
595 * @subregion: the region being removed; must be a current subregion of @mr.
597 void memory_region_del_subregion(MemoryRegion
*mr
,
598 MemoryRegion
*subregion
);
601 * memory_region_set_enabled: dynamically enable or disable a region
603 * Enables or disables a memory region. A disabled memory region
604 * ignores all accesses to itself and its subregions. It does not
605 * obscure sibling subregions with lower priority - it simply behaves as
606 * if it was removed from the hierarchy.
608 * Regions default to being enabled.
610 * @mr: the region to be updated
611 * @enabled: whether to enable or disable the region
613 void memory_region_set_enabled(MemoryRegion
*mr
, bool enabled
);
616 * memory_region_set_address: dynamically update the address of a region
618 * Dynamically updates the address of a region, relative to its parent.
619 * May be used on regions are currently part of a memory hierarchy.
621 * @mr: the region to be updated
622 * @addr: new address, relative to parent region
624 void memory_region_set_address(MemoryRegion
*mr
, target_phys_addr_t addr
);
627 * memory_region_set_alias_offset: dynamically update a memory alias's offset
629 * Dynamically updates the offset into the target region that an alias points
630 * to, as if the fourth argument to memory_region_init_alias() has changed.
632 * @mr: the #MemoryRegion to be updated; should be an alias.
633 * @offset: the new offset into the target memory region
635 void memory_region_set_alias_offset(MemoryRegion
*mr
,
636 target_phys_addr_t offset
);
639 * memory_region_find: locate a MemoryRegion in an address space
641 * Locates the first #MemoryRegion within an address space given by
642 * @address_space that overlaps the range given by @addr and @size.
644 * Returns a #MemoryRegionSection that describes a contiguous overlap.
645 * It will have the following characteristics:
646 * .@offset_within_address_space >= @addr
647 * .@offset_within_address_space + .@size <= @addr + @size
648 * .@size = 0 iff no overlap was found
649 * .@mr is non-%NULL iff an overlap was found
651 * @address_space: a top-level (i.e. parentless) region that contains
652 * the region to be found
653 * @addr: start of the area within @address_space to be searched
654 * @size: size of the area to be searched
656 MemoryRegionSection
memory_region_find(MemoryRegion
*address_space
,
657 target_phys_addr_t addr
, uint64_t size
);
661 * memory_global_sync_dirty_bitmap: synchronize the dirty log for all memory
663 * Synchronizes the dirty page log for an entire address space.
664 * @address_space: a top-level (i.e. parentless) region that contains the
665 * memory being synchronized
667 void memory_global_sync_dirty_bitmap(MemoryRegion
*address_space
);
670 * memory_region_transaction_begin: Start a transaction.
672 * During a transaction, changes will be accumulated and made visible
673 * only when the transaction ends (is committed).
675 void memory_region_transaction_begin(void);
678 * memory_region_transaction_commit: Commit a transaction and make changes
679 * visible to the guest.
681 void memory_region_transaction_commit(void);
684 * memory_listener_register: register callbacks to be called when memory
685 * sections are mapped or unmapped into an address
688 * @listener: an object containing the callbacks to be called
689 * @filter: if non-%NULL, only regions in this address space will be observed
691 void memory_listener_register(MemoryListener
*listener
, MemoryRegion
*filter
);
694 * memory_listener_unregister: undo the effect of memory_listener_register()
696 * @listener: an object containing the callbacks to be removed
698 void memory_listener_unregister(MemoryListener
*listener
);
701 * memory_global_dirty_log_start: begin dirty logging for all regions
703 void memory_global_dirty_log_start(void);
706 * memory_global_dirty_log_stop: begin dirty logging for all regions
708 void memory_global_dirty_log_stop(void);
710 void mtree_info(fprintf_function mon_printf
, void *f
);