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"
26 typedef struct MemoryRegionOps MemoryRegionOps
;
27 typedef struct MemoryRegion MemoryRegion
;
29 /* Must match *_DIRTY_FLAGS in cpu-all.h. To be replaced with dynamic
32 #define DIRTY_MEMORY_VGA 0
33 #define DIRTY_MEMORY_CODE 1
34 #define DIRTY_MEMORY_MIGRATION 3
37 * Memory region callbacks
39 struct MemoryRegionOps
{
40 /* Read from the memory region. @addr is relative to @mr; @size is
42 uint64_t (*read
)(void *opaque
,
43 target_phys_addr_t addr
,
45 /* Write to the memory region. @addr is relative to @mr; @size is
47 void (*write
)(void *opaque
,
48 target_phys_addr_t addr
,
52 enum device_endian endianness
;
53 /* Guest-visible constraints: */
55 /* If nonzero, specify bounds on access sizes beyond which a machine
58 unsigned min_access_size
;
59 unsigned max_access_size
;
60 /* If true, unaligned accesses are supported. Otherwise unaligned
61 * accesses throw machine checks.
65 /* Internal implementation constraints: */
67 /* If nonzero, specifies the minimum size implemented. Smaller sizes
68 * will be rounded upwards and a partial result will be returned.
70 unsigned min_access_size
;
71 /* If nonzero, specifies the maximum size implemented. Larger sizes
72 * will be done as a series of accesses with smaller sizes.
74 unsigned max_access_size
;
75 /* If true, unaligned accesses are supported. Otherwise all accesses
76 * are converted to (possibly multiple) naturally aligned accesses.
82 typedef struct CoalescedMemoryRange CoalescedMemoryRange
;
85 /* All fields are private - violators will be prosecuted */
86 const MemoryRegionOps
*ops
;
90 target_phys_addr_t addr
;
91 target_phys_addr_t offset
;
95 target_phys_addr_t alias_offset
;
98 QTAILQ_HEAD(subregions
, MemoryRegion
) subregions
;
99 QTAILQ_ENTRY(MemoryRegion
) subregions_link
;
100 QTAILQ_HEAD(coalesced_ranges
, CoalescedMemoryRange
) coalesced
;
102 uint8_t dirty_log_mask
;
106 * memory_region_init: Initialize a memory region
108 * The region typically acts as a container for other memory regions. Us
109 * memory_region_add_subregion() to add subregions.
111 * @mr: the #MemoryRegion to be initialized
112 * @name: used for debugging; not visible to the user or ABI
113 * @size: size of the region; any subregions beyond this size will be clipped
115 void memory_region_init(MemoryRegion
*mr
,
119 * memory_region_init_io: Initialize an I/O memory region.
121 * Accesses into the region will be cause the callbacks in @ops to be called.
122 * if @size is nonzero, subregions will be clipped to @size.
124 * @mr: the #MemoryRegion to be initialized.
125 * @ops: a structure containing read and write callbacks to be used when
126 * I/O is performed on the region.
127 * @opaque: passed to to the read and write callbacks of the @ops structure.
128 * @name: used for debugging; not visible to the user or ABI
129 * @size: size of the region.
131 void memory_region_init_io(MemoryRegion
*mr
,
132 const MemoryRegionOps
*ops
,
138 * memory_region_init_ram: Initialize RAM memory region. Accesses into the
139 * region will be modify memory directly.
141 * @mr: the #MemoryRegion to be initialized.
142 * @dev: a device associated with the region; may be %NULL.
143 * @name: the name of the region; the pair (@dev, @name) must be globally
144 * unique. The name is part of the save/restore ABI and so cannot be
146 * @size: size of the region.
148 void memory_region_init_ram(MemoryRegion
*mr
,
149 DeviceState
*dev
, /* FIXME: layering violation */
154 * memory_region_init_ram: Initialize RAM memory region from a user-provided.
155 * pointer. Accesses into the region will be modify
158 * @mr: the #MemoryRegion to be initialized.
159 * @dev: a device associated with the region; may be %NULL.
160 * @name: the name of the region; the pair (@dev, @name) must be globally
161 * unique. The name is part of the save/restore ABI and so cannot be
163 * @size: size of the region.
164 * @ptr: memory to be mapped; must contain at least @size bytes.
166 void memory_region_init_ram_ptr(MemoryRegion
*mr
,
167 DeviceState
*dev
, /* FIXME: layering violation */
173 * memory_region_init_alias: Initialize a memory region that aliases all or a
174 * part of another memory region.
176 * @mr: the #MemoryRegion to be initialized.
177 * @name: used for debugging; not visible to the user or ABI
178 * @orig: the region to be referenced; @mr will be equivalent to
179 * @orig between @offset and @offset + @size - 1.
180 * @offset: start of the section in @orig to be referenced.
181 * @size: size of the region.
183 void memory_region_init_alias(MemoryRegion
*mr
,
186 target_phys_addr_t offset
,
189 * memory_region_destroy: Destroy a memory region and relaim all resources.
191 * @mr: the region to be destroyed. May not currently be a subregion
192 * (see memory_region_add_subregion()) or referenced in an alias
193 * (see memory_region_init_alias()).
195 void memory_region_destroy(MemoryRegion
*mr
);
198 * memory_region_size: get a memory region's size.
200 * @mr: the memory region being queried.
202 uint64_t memory_region_size(MemoryRegion
*mr
);
205 * memory_region_get_ram_ptr: Get a pointer into a RAM memory region.
207 * Returns a host pointer to a RAM memory region (created with
208 * memory_region_init_ram() or memory_region_init_ram_ptr()). Use with
211 * @mr: the memory region being queried.
213 void *memory_region_get_ram_ptr(MemoryRegion
*mr
);
216 * memory_region_set_offset: Sets an offset to be added to MemoryRegionOps
219 * This function is deprecated and should not be used in new code.
221 void memory_region_set_offset(MemoryRegion
*mr
, target_phys_addr_t offset
);
224 * memory_region_set_log: Turn dirty logging on or off for a region.
226 * Turns dirty logging on or off for a specified client (display, migration).
227 * Only meaningful for RAM regions.
229 * @mr: the memory region being updated.
230 * @log: whether dirty logging is to be enabled or disabled.
231 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
234 void memory_region_set_log(MemoryRegion
*mr
, bool log
, unsigned client
);
237 * memory_region_get_dirty: Check whether a page is dirty for a specified
240 * Checks whether a page has been written to since the last
241 * call to memory_region_reset_dirty() with the same @client. Dirty logging
244 * @mr: the memory region being queried.
245 * @addr: the address (relative to the start of the region) being queried.
246 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
249 bool memory_region_get_dirty(MemoryRegion
*mr
, target_phys_addr_t addr
,
253 * memory_region_set_dirty: Mark a page as dirty in a memory region.
255 * Marks a page as dirty, after it has been dirtied outside guest code.
257 * @mr: the memory region being queried.
258 * @addr: the address (relative to the start of the region) being dirtied.
260 void memory_region_set_dirty(MemoryRegion
*mr
, target_phys_addr_t addr
);
263 * memory_region_sync_dirty_bitmap: Synchronize a region's dirty bitmap with
264 * any external TLBs (e.g. kvm)
266 * Flushes dirty information from accelerators such as kvm and vhost-net
267 * and makes it available to users of the memory API.
269 * @mr: the region being flushed.
271 void memory_region_sync_dirty_bitmap(MemoryRegion
*mr
);
274 * memory_region_reset_dirty: Mark a range of pages as clean, for a specified
277 * Marks a range of pages as no longer dirty.
279 * @mr: the region being updated.
280 * @addr: the start of the subrange being cleaned.
281 * @size: the size of the subrange being cleaned.
282 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
285 void memory_region_reset_dirty(MemoryRegion
*mr
, target_phys_addr_t addr
,
286 target_phys_addr_t size
, unsigned client
);
289 * memory_region_set_readonly: Turn a memory region read-only (or read-write)
291 * Allows a memory region to be marked as read-only (turning it into a ROM).
292 * only useful on RAM regions.
294 * @mr: the region being updated.
295 * @readonly: whether rhe region is to be ROM or RAM.
297 void memory_region_set_readonly(MemoryRegion
*mr
, bool readonly
);
300 * memory_region_set_coalescing: Enable memory coalescing for the region.
302 * Enabled writes to a region to be queued for later processing. MMIO ->write
303 * callbacks may be delayed until a non-coalesced MMIO is issued.
304 * Only useful for IO regions. Roughly similar to write-combining hardware.
306 * @mr: the memory region to be write coalesced
308 void memory_region_set_coalescing(MemoryRegion
*mr
);
311 * memory_region_add_coalescing: Enable memory coalescing for a sub-range of
314 * Like memory_region_set_coalescing(), but works on a sub-range of a region.
315 * Multiple calls can be issued coalesced disjoint ranges.
317 * @mr: the memory region to be updated.
318 * @offset: the start of the range within the region to be coalesced.
319 * @size: the size of the subrange to be coalesced.
321 void memory_region_add_coalescing(MemoryRegion
*mr
,
322 target_phys_addr_t offset
,
326 * memory_region_clear_coalescing: Disable MMIO coalescing for the region.
328 * Disables any coalescing caused by memory_region_set_coalescing() or
329 * memory_region_add_coalescing(). Roughly equivalent to uncacheble memory
332 * @mr: the memory region to be updated.
334 void memory_region_clear_coalescing(MemoryRegion
*mr
);
337 * memory_region_add_subregion: Add a sub-region to a container.
339 * Adds a sub-region at @offset. The sub-region may not overlap with other
340 * subregions (except for those explicitly marked as overlapping). A region
341 * may only be added once as a subregion (unless removed with
342 * memory_region_del_subregion()); use memory_region_init_alias() if you
343 * want a region to be a subregion in multiple locations.
345 * @mr: the region to contain the new subregion; must be a container
346 * initialized with memory_region_init().
347 * @offset: the offset relative to @mr where @subregion is added.
348 * @subregion: the subregion to be added.
350 void memory_region_add_subregion(MemoryRegion
*mr
,
351 target_phys_addr_t offset
,
352 MemoryRegion
*subregion
);
354 * memory_region_add_subregion: Add a sub-region to a container, with overlap.
356 * Adds a sub-region at @offset. The sub-region may overlap with other
357 * subregions. Conflicts are resolved by having a higher @priority hide a
358 * lower @priority. Subregions without priority are taken as @priority 0.
359 * A region may only be added once as a subregion (unless removed with
360 * memory_region_del_subregion()); use memory_region_init_alias() if you
361 * want a region to be a subregion in multiple locations.
363 * @mr: the region to contain the new subregion; must be a container
364 * initialized with memory_region_init().
365 * @offset: the offset relative to @mr where @subregion is added.
366 * @subregion: the subregion to be added.
367 * @priority: used for resolving overlaps; highest priority wins.
369 void memory_region_add_subregion_overlap(MemoryRegion
*mr
,
370 target_phys_addr_t offset
,
371 MemoryRegion
*subregion
,
374 * memory_region_del_subregion: Remove a subregion.
376 * Removes a subregion from its container.
378 * @mr: the container to be updated.
379 * @subregion: the region being removed; must be a current subregion of @mr.
381 void memory_region_del_subregion(MemoryRegion
*mr
,
382 MemoryRegion
*subregion
);