]> git.proxmox.com Git - qemu.git/blame - memory.h
ehci: Fix NULL ptr deref when unplugging an USB dev with an iso stream active
[qemu.git] / memory.h
CommitLineData
093bc2cd
AK
1/*
2 * Physical memory management API
3 *
4 * Copyright 2011 Red Hat, Inc. and/or its affiliates
5 *
6 * Authors:
7 * Avi Kivity <avi@redhat.com>
8 *
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
11 *
12 */
13
14#ifndef MEMORY_H
15#define MEMORY_H
16
17#ifndef CONFIG_USER_ONLY
18
19#include <stdint.h>
20#include <stdbool.h>
21#include "qemu-common.h"
22#include "cpu-common.h"
23#include "targphys.h"
24#include "qemu-queue.h"
658b2224 25#include "iorange.h"
627a0e90 26#include "ioport.h"
08dafab4 27#include "int128.h"
093bc2cd
AK
28
29typedef struct MemoryRegionOps MemoryRegionOps;
30typedef struct MemoryRegion MemoryRegion;
627a0e90 31typedef struct MemoryRegionPortio MemoryRegionPortio;
74901c3b 32typedef struct MemoryRegionMmio MemoryRegionMmio;
093bc2cd
AK
33
34/* Must match *_DIRTY_FLAGS in cpu-all.h. To be replaced with dynamic
35 * registration.
36 */
37#define DIRTY_MEMORY_VGA 0
38#define DIRTY_MEMORY_CODE 1
39#define DIRTY_MEMORY_MIGRATION 3
40
74901c3b
AK
41struct MemoryRegionMmio {
42 CPUReadMemoryFunc *read[3];
43 CPUWriteMemoryFunc *write[3];
44};
45
a2d33521
AK
46/* Internal use; thunks between old-style IORange and MemoryRegions. */
47typedef struct MemoryRegionIORange MemoryRegionIORange;
48struct MemoryRegionIORange {
49 IORange iorange;
50 MemoryRegion *mr;
51 target_phys_addr_t offset;
52};
53
093bc2cd
AK
54/*
55 * Memory region callbacks
56 */
57struct MemoryRegionOps {
58 /* Read from the memory region. @addr is relative to @mr; @size is
59 * in bytes. */
60 uint64_t (*read)(void *opaque,
61 target_phys_addr_t addr,
62 unsigned size);
63 /* Write to the memory region. @addr is relative to @mr; @size is
64 * in bytes. */
65 void (*write)(void *opaque,
66 target_phys_addr_t addr,
67 uint64_t data,
68 unsigned size);
69
70 enum device_endian endianness;
71 /* Guest-visible constraints: */
72 struct {
73 /* If nonzero, specify bounds on access sizes beyond which a machine
74 * check is thrown.
75 */
76 unsigned min_access_size;
77 unsigned max_access_size;
78 /* If true, unaligned accesses are supported. Otherwise unaligned
79 * accesses throw machine checks.
80 */
81 bool unaligned;
897fa7cf
AK
82 /*
83 * If present, and returns #false, the transaction is not accepted
84 * by the device (and results in machine dependent behaviour such
85 * as a machine check exception).
86 */
87 bool (*accepts)(void *opaque, target_phys_addr_t addr,
88 unsigned size, bool is_write);
093bc2cd
AK
89 } valid;
90 /* Internal implementation constraints: */
91 struct {
92 /* If nonzero, specifies the minimum size implemented. Smaller sizes
93 * will be rounded upwards and a partial result will be returned.
94 */
95 unsigned min_access_size;
96 /* If nonzero, specifies the maximum size implemented. Larger sizes
97 * will be done as a series of accesses with smaller sizes.
98 */
99 unsigned max_access_size;
100 /* If true, unaligned accesses are supported. Otherwise all accesses
101 * are converted to (possibly multiple) naturally aligned accesses.
102 */
103 bool unaligned;
104 } impl;
627a0e90
AK
105
106 /* If .read and .write are not present, old_portio may be used for
107 * backwards compatibility with old portio registration
108 */
109 const MemoryRegionPortio *old_portio;
74901c3b
AK
110 /* If .read and .write are not present, old_mmio may be used for
111 * backwards compatibility with old mmio registration
112 */
113 const MemoryRegionMmio old_mmio;
093bc2cd
AK
114};
115
116typedef struct CoalescedMemoryRange CoalescedMemoryRange;
3e9d69e7 117typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd;
093bc2cd
AK
118
119struct MemoryRegion {
120 /* All fields are private - violators will be prosecuted */
121 const MemoryRegionOps *ops;
122 void *opaque;
123 MemoryRegion *parent;
08dafab4 124 Int128 size;
093bc2cd 125 target_phys_addr_t addr;
545e92e0 126 void (*destructor)(MemoryRegion *mr);
093bc2cd 127 ram_addr_t ram_addr;
b3b00c78 128 bool subpage;
14a3c10a 129 bool terminates;
d0a9b5bc 130 bool readable;
8ea9252a 131 bool ram;
fb1cd6f9 132 bool readonly; /* For RAM regions */
6bba19ba 133 bool enabled;
75c578dc 134 bool rom_device;
1660e72d 135 bool warning_printed; /* For reservations */
093bc2cd
AK
136 MemoryRegion *alias;
137 target_phys_addr_t alias_offset;
138 unsigned priority;
139 bool may_overlap;
140 QTAILQ_HEAD(subregions, MemoryRegion) subregions;
141 QTAILQ_ENTRY(MemoryRegion) subregions_link;
142 QTAILQ_HEAD(coalesced_ranges, CoalescedMemoryRange) coalesced;
143 const char *name;
5a583347 144 uint8_t dirty_log_mask;
3e9d69e7
AK
145 unsigned ioeventfd_nb;
146 MemoryRegionIoeventfd *ioeventfds;
093bc2cd
AK
147};
148
627a0e90
AK
149struct MemoryRegionPortio {
150 uint32_t offset;
151 uint32_t len;
152 unsigned size;
153 IOPortReadFunc *read;
154 IOPortWriteFunc *write;
155};
156
2dd30228 157#define PORTIO_END_OF_LIST() { }
627a0e90 158
e2177955
AK
159typedef struct MemoryRegionSection MemoryRegionSection;
160
161/**
162 * MemoryRegionSection: describes a fragment of a #MemoryRegion
163 *
164 * @mr: the region, or %NULL if empty
7664e80c 165 * @address_space: the address space the region is mapped in
e2177955
AK
166 * @offset_within_region: the beginning of the section, relative to @mr's start
167 * @size: the size of the section; will not exceed @mr's boundaries
168 * @offset_within_address_space: the address of the first byte of the section
169 * relative to the region's address space
7a8499e8 170 * @readonly: writes to this section are ignored
e2177955
AK
171 */
172struct MemoryRegionSection {
173 MemoryRegion *mr;
7664e80c 174 MemoryRegion *address_space;
e2177955
AK
175 target_phys_addr_t offset_within_region;
176 uint64_t size;
177 target_phys_addr_t offset_within_address_space;
7a8499e8 178 bool readonly;
e2177955
AK
179};
180
7664e80c
AK
181typedef struct MemoryListener MemoryListener;
182
183/**
184 * MemoryListener: callbacks structure for updates to the physical memory map
185 *
186 * Allows a component to adjust to changes in the guest-visible memory map.
187 * Use with memory_listener_register() and memory_listener_unregister().
188 */
189struct MemoryListener {
50c1e149
AK
190 void (*begin)(MemoryListener *listener);
191 void (*commit)(MemoryListener *listener);
7664e80c
AK
192 void (*region_add)(MemoryListener *listener, MemoryRegionSection *section);
193 void (*region_del)(MemoryListener *listener, MemoryRegionSection *section);
50c1e149 194 void (*region_nop)(MemoryListener *listener, MemoryRegionSection *section);
7664e80c
AK
195 void (*log_start)(MemoryListener *listener, MemoryRegionSection *section);
196 void (*log_stop)(MemoryListener *listener, MemoryRegionSection *section);
197 void (*log_sync)(MemoryListener *listener, MemoryRegionSection *section);
198 void (*log_global_start)(MemoryListener *listener);
199 void (*log_global_stop)(MemoryListener *listener);
80a1ea37
AK
200 void (*eventfd_add)(MemoryListener *listener, MemoryRegionSection *section,
201 bool match_data, uint64_t data, int fd);
202 void (*eventfd_del)(MemoryListener *listener, MemoryRegionSection *section,
203 bool match_data, uint64_t data, int fd);
72e22d2f
AK
204 /* Lower = earlier (during add), later (during del) */
205 unsigned priority;
7376e582 206 MemoryRegion *address_space_filter;
72e22d2f 207 QTAILQ_ENTRY(MemoryListener) link;
7664e80c
AK
208};
209
093bc2cd
AK
210/**
211 * memory_region_init: Initialize a memory region
212 *
69ddaf66 213 * The region typically acts as a container for other memory regions. Use
093bc2cd
AK
214 * memory_region_add_subregion() to add subregions.
215 *
216 * @mr: the #MemoryRegion to be initialized
217 * @name: used for debugging; not visible to the user or ABI
218 * @size: size of the region; any subregions beyond this size will be clipped
219 */
220void memory_region_init(MemoryRegion *mr,
221 const char *name,
222 uint64_t size);
223/**
224 * memory_region_init_io: Initialize an I/O memory region.
225 *
69ddaf66 226 * Accesses into the region will cause the callbacks in @ops to be called.
093bc2cd
AK
227 * if @size is nonzero, subregions will be clipped to @size.
228 *
229 * @mr: the #MemoryRegion to be initialized.
230 * @ops: a structure containing read and write callbacks to be used when
231 * I/O is performed on the region.
232 * @opaque: passed to to the read and write callbacks of the @ops structure.
233 * @name: used for debugging; not visible to the user or ABI
234 * @size: size of the region.
235 */
236void memory_region_init_io(MemoryRegion *mr,
237 const MemoryRegionOps *ops,
238 void *opaque,
239 const char *name,
240 uint64_t size);
241
242/**
243 * memory_region_init_ram: Initialize RAM memory region. Accesses into the
69ddaf66 244 * region will modify memory directly.
093bc2cd
AK
245 *
246 * @mr: the #MemoryRegion to be initialized.
c5705a77 247 * @name: the name of the region.
093bc2cd
AK
248 * @size: size of the region.
249 */
250void memory_region_init_ram(MemoryRegion *mr,
093bc2cd
AK
251 const char *name,
252 uint64_t size);
253
254/**
255 * memory_region_init_ram: Initialize RAM memory region from a user-provided.
69ddaf66 256 * pointer. Accesses into the region will modify
093bc2cd
AK
257 * memory directly.
258 *
259 * @mr: the #MemoryRegion to be initialized.
c5705a77 260 * @name: the name of the region.
093bc2cd
AK
261 * @size: size of the region.
262 * @ptr: memory to be mapped; must contain at least @size bytes.
263 */
264void memory_region_init_ram_ptr(MemoryRegion *mr,
093bc2cd
AK
265 const char *name,
266 uint64_t size,
267 void *ptr);
268
269/**
270 * memory_region_init_alias: Initialize a memory region that aliases all or a
271 * part of another memory region.
272 *
273 * @mr: the #MemoryRegion to be initialized.
274 * @name: used for debugging; not visible to the user or ABI
275 * @orig: the region to be referenced; @mr will be equivalent to
276 * @orig between @offset and @offset + @size - 1.
277 * @offset: start of the section in @orig to be referenced.
278 * @size: size of the region.
279 */
280void memory_region_init_alias(MemoryRegion *mr,
281 const char *name,
282 MemoryRegion *orig,
283 target_phys_addr_t offset,
284 uint64_t size);
d0a9b5bc
AK
285
286/**
287 * memory_region_init_rom_device: Initialize a ROM memory region. Writes are
288 * handled via callbacks.
289 *
290 * @mr: the #MemoryRegion to be initialized.
291 * @ops: callbacks for write access handling.
c5705a77 292 * @name: the name of the region.
d0a9b5bc
AK
293 * @size: size of the region.
294 */
295void memory_region_init_rom_device(MemoryRegion *mr,
296 const MemoryRegionOps *ops,
75f5941c 297 void *opaque,
d0a9b5bc
AK
298 const char *name,
299 uint64_t size);
300
1660e72d
JK
301/**
302 * memory_region_init_reservation: Initialize a memory region that reserves
303 * I/O space.
304 *
305 * A reservation region primariy serves debugging purposes. It claims I/O
306 * space that is not supposed to be handled by QEMU itself. Any access via
307 * the memory API will cause an abort().
308 *
309 * @mr: the #MemoryRegion to be initialized
310 * @name: used for debugging; not visible to the user or ABI
311 * @size: size of the region.
312 */
313void memory_region_init_reservation(MemoryRegion *mr,
314 const char *name,
315 uint64_t size);
093bc2cd 316/**
69ddaf66 317 * memory_region_destroy: Destroy a memory region and reclaim all resources.
093bc2cd
AK
318 *
319 * @mr: the region to be destroyed. May not currently be a subregion
320 * (see memory_region_add_subregion()) or referenced in an alias
321 * (see memory_region_init_alias()).
322 */
323void memory_region_destroy(MemoryRegion *mr);
324
325/**
326 * memory_region_size: get a memory region's size.
327 *
328 * @mr: the memory region being queried.
329 */
330uint64_t memory_region_size(MemoryRegion *mr);
331
8ea9252a
AK
332/**
333 * memory_region_is_ram: check whether a memory region is random access
334 *
335 * Returns %true is a memory region is random access.
336 *
337 * @mr: the memory region being queried
338 */
339bool memory_region_is_ram(MemoryRegion *mr);
340
fd062573
BS
341/**
342 * memory_region_is_romd: check whether a memory region is ROMD
343 *
344 * Returns %true is a memory region is ROMD and currently set to allow
345 * direct reads.
346 *
347 * @mr: the memory region being queried
348 */
349static inline bool memory_region_is_romd(MemoryRegion *mr)
350{
351 return mr->rom_device && mr->readable;
352}
353
8991c79b
AK
354/**
355 * memory_region_name: get a memory region's name
356 *
357 * Returns the string that was used to initialize the memory region.
358 *
359 * @mr: the memory region being queried
360 */
361const char *memory_region_name(MemoryRegion *mr);
362
55043ba3
AK
363/**
364 * memory_region_is_logging: return whether a memory region is logging writes
365 *
366 * Returns %true if the memory region is logging writes
367 *
368 * @mr: the memory region being queried
369 */
370bool memory_region_is_logging(MemoryRegion *mr);
371
ce7923da
AK
372/**
373 * memory_region_is_rom: check whether a memory region is ROM
374 *
375 * Returns %true is a memory region is read-only memory.
376 *
377 * @mr: the memory region being queried
378 */
379bool memory_region_is_rom(MemoryRegion *mr);
380
093bc2cd
AK
381/**
382 * memory_region_get_ram_ptr: Get a pointer into a RAM memory region.
383 *
384 * Returns a host pointer to a RAM memory region (created with
385 * memory_region_init_ram() or memory_region_init_ram_ptr()). Use with
386 * care.
387 *
388 * @mr: the memory region being queried.
389 */
390void *memory_region_get_ram_ptr(MemoryRegion *mr);
391
093bc2cd
AK
392/**
393 * memory_region_set_log: Turn dirty logging on or off for a region.
394 *
395 * Turns dirty logging on or off for a specified client (display, migration).
396 * Only meaningful for RAM regions.
397 *
398 * @mr: the memory region being updated.
399 * @log: whether dirty logging is to be enabled or disabled.
400 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
401 * %DIRTY_MEMORY_VGA.
402 */
403void memory_region_set_log(MemoryRegion *mr, bool log, unsigned client);
404
405/**
cd7a45c9
BS
406 * memory_region_get_dirty: Check whether a range of bytes is dirty
407 * for a specified client.
093bc2cd 408 *
cd7a45c9 409 * Checks whether a range of bytes has been written to since the last
093bc2cd
AK
410 * call to memory_region_reset_dirty() with the same @client. Dirty logging
411 * must be enabled.
412 *
413 * @mr: the memory region being queried.
414 * @addr: the address (relative to the start of the region) being queried.
cd7a45c9 415 * @size: the size of the range being queried.
093bc2cd
AK
416 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
417 * %DIRTY_MEMORY_VGA.
418 */
419bool memory_region_get_dirty(MemoryRegion *mr, target_phys_addr_t addr,
cd7a45c9 420 target_phys_addr_t size, unsigned client);
093bc2cd
AK
421
422/**
fd4aa979 423 * memory_region_set_dirty: Mark a range of bytes as dirty in a memory region.
093bc2cd 424 *
fd4aa979
BS
425 * Marks a range of bytes as dirty, after it has been dirtied outside
426 * guest code.
093bc2cd 427 *
fd4aa979 428 * @mr: the memory region being dirtied.
093bc2cd 429 * @addr: the address (relative to the start of the region) being dirtied.
fd4aa979 430 * @size: size of the range being dirtied.
093bc2cd 431 */
fd4aa979
BS
432void memory_region_set_dirty(MemoryRegion *mr, target_phys_addr_t addr,
433 target_phys_addr_t size);
093bc2cd
AK
434
435/**
436 * memory_region_sync_dirty_bitmap: Synchronize a region's dirty bitmap with
437 * any external TLBs (e.g. kvm)
438 *
439 * Flushes dirty information from accelerators such as kvm and vhost-net
440 * and makes it available to users of the memory API.
441 *
442 * @mr: the region being flushed.
443 */
444void memory_region_sync_dirty_bitmap(MemoryRegion *mr);
445
446/**
447 * memory_region_reset_dirty: Mark a range of pages as clean, for a specified
448 * client.
449 *
450 * Marks a range of pages as no longer dirty.
451 *
452 * @mr: the region being updated.
453 * @addr: the start of the subrange being cleaned.
454 * @size: the size of the subrange being cleaned.
455 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
456 * %DIRTY_MEMORY_VGA.
457 */
458void memory_region_reset_dirty(MemoryRegion *mr, target_phys_addr_t addr,
459 target_phys_addr_t size, unsigned client);
460
461/**
462 * memory_region_set_readonly: Turn a memory region read-only (or read-write)
463 *
464 * Allows a memory region to be marked as read-only (turning it into a ROM).
465 * only useful on RAM regions.
466 *
467 * @mr: the region being updated.
468 * @readonly: whether rhe region is to be ROM or RAM.
469 */
470void memory_region_set_readonly(MemoryRegion *mr, bool readonly);
471
d0a9b5bc
AK
472/**
473 * memory_region_rom_device_set_readable: enable/disable ROM readability
474 *
475 * Allows a ROM device (initialized with memory_region_init_rom_device() to
476 * to be marked as readable (default) or not readable. When it is readable,
477 * the device is mapped to guest memory. When not readable, reads are
478 * forwarded to the #MemoryRegion.read function.
479 *
480 * @mr: the memory region to be updated
481 * @readable: whether reads are satisified directly (%true) or via callbacks
482 * (%false)
483 */
484void memory_region_rom_device_set_readable(MemoryRegion *mr, bool readable);
485
093bc2cd
AK
486/**
487 * memory_region_set_coalescing: Enable memory coalescing for the region.
488 *
489 * Enabled writes to a region to be queued for later processing. MMIO ->write
490 * callbacks may be delayed until a non-coalesced MMIO is issued.
491 * Only useful for IO regions. Roughly similar to write-combining hardware.
492 *
493 * @mr: the memory region to be write coalesced
494 */
495void memory_region_set_coalescing(MemoryRegion *mr);
496
497/**
498 * memory_region_add_coalescing: Enable memory coalescing for a sub-range of
499 * a region.
500 *
501 * Like memory_region_set_coalescing(), but works on a sub-range of a region.
502 * Multiple calls can be issued coalesced disjoint ranges.
503 *
504 * @mr: the memory region to be updated.
505 * @offset: the start of the range within the region to be coalesced.
506 * @size: the size of the subrange to be coalesced.
507 */
508void memory_region_add_coalescing(MemoryRegion *mr,
509 target_phys_addr_t offset,
510 uint64_t size);
511
512/**
513 * memory_region_clear_coalescing: Disable MMIO coalescing for the region.
514 *
515 * Disables any coalescing caused by memory_region_set_coalescing() or
516 * memory_region_add_coalescing(). Roughly equivalent to uncacheble memory
517 * hardware.
518 *
519 * @mr: the memory region to be updated.
520 */
521void memory_region_clear_coalescing(MemoryRegion *mr);
522
3e9d69e7
AK
523/**
524 * memory_region_add_eventfd: Request an eventfd to be triggered when a word
525 * is written to a location.
526 *
527 * Marks a word in an IO region (initialized with memory_region_init_io())
528 * as a trigger for an eventfd event. The I/O callback will not be called.
69ddaf66 529 * The caller must be prepared to handle failure (that is, take the required
3e9d69e7
AK
530 * action if the callback _is_ called).
531 *
532 * @mr: the memory region being updated.
533 * @addr: the address within @mr that is to be monitored
534 * @size: the size of the access to trigger the eventfd
535 * @match_data: whether to match against @data, instead of just @addr
536 * @data: the data to match against the guest write
537 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
538 **/
539void memory_region_add_eventfd(MemoryRegion *mr,
540 target_phys_addr_t addr,
541 unsigned size,
542 bool match_data,
543 uint64_t data,
544 int fd);
545
546/**
69ddaf66 547 * memory_region_del_eventfd: Cancel an eventfd.
3e9d69e7 548 *
69ddaf66
ASRJ
549 * Cancels an eventfd trigger requested by a previous
550 * memory_region_add_eventfd() call.
3e9d69e7
AK
551 *
552 * @mr: the memory region being updated.
553 * @addr: the address within @mr that is to be monitored
554 * @size: the size of the access to trigger the eventfd
555 * @match_data: whether to match against @data, instead of just @addr
556 * @data: the data to match against the guest write
557 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
558 */
559void memory_region_del_eventfd(MemoryRegion *mr,
560 target_phys_addr_t addr,
561 unsigned size,
562 bool match_data,
563 uint64_t data,
564 int fd);
093bc2cd 565/**
69ddaf66 566 * memory_region_add_subregion: Add a subregion to a container.
093bc2cd 567 *
69ddaf66 568 * Adds a subregion at @offset. The subregion may not overlap with other
093bc2cd
AK
569 * subregions (except for those explicitly marked as overlapping). A region
570 * may only be added once as a subregion (unless removed with
571 * memory_region_del_subregion()); use memory_region_init_alias() if you
572 * want a region to be a subregion in multiple locations.
573 *
574 * @mr: the region to contain the new subregion; must be a container
575 * initialized with memory_region_init().
576 * @offset: the offset relative to @mr where @subregion is added.
577 * @subregion: the subregion to be added.
578 */
579void memory_region_add_subregion(MemoryRegion *mr,
580 target_phys_addr_t offset,
581 MemoryRegion *subregion);
582/**
69ddaf66 583 * memory_region_add_subregion: Add a subregion to a container, with overlap.
093bc2cd 584 *
69ddaf66 585 * Adds a subregion at @offset. The subregion may overlap with other
093bc2cd
AK
586 * subregions. Conflicts are resolved by having a higher @priority hide a
587 * lower @priority. Subregions without priority are taken as @priority 0.
588 * A region may only be added once as a subregion (unless removed with
589 * memory_region_del_subregion()); use memory_region_init_alias() if you
590 * want a region to be a subregion in multiple locations.
591 *
592 * @mr: the region to contain the new subregion; must be a container
593 * initialized with memory_region_init().
594 * @offset: the offset relative to @mr where @subregion is added.
595 * @subregion: the subregion to be added.
596 * @priority: used for resolving overlaps; highest priority wins.
597 */
598void memory_region_add_subregion_overlap(MemoryRegion *mr,
599 target_phys_addr_t offset,
600 MemoryRegion *subregion,
601 unsigned priority);
e34911c4
AK
602
603/**
604 * memory_region_get_ram_addr: Get the ram address associated with a memory
605 * region
606 *
dabdf394 607 * DO NOT USE THIS FUNCTION. This is a temporary workaround while the Xen
e34911c4
AK
608 * code is being reworked.
609 */
610ram_addr_t memory_region_get_ram_addr(MemoryRegion *mr);
611
093bc2cd
AK
612/**
613 * memory_region_del_subregion: Remove a subregion.
614 *
615 * Removes a subregion from its container.
616 *
617 * @mr: the container to be updated.
618 * @subregion: the region being removed; must be a current subregion of @mr.
619 */
620void memory_region_del_subregion(MemoryRegion *mr,
621 MemoryRegion *subregion);
622
6bba19ba
AK
623/*
624 * memory_region_set_enabled: dynamically enable or disable a region
625 *
626 * Enables or disables a memory region. A disabled memory region
627 * ignores all accesses to itself and its subregions. It does not
628 * obscure sibling subregions with lower priority - it simply behaves as
629 * if it was removed from the hierarchy.
630 *
631 * Regions default to being enabled.
632 *
633 * @mr: the region to be updated
634 * @enabled: whether to enable or disable the region
635 */
636void memory_region_set_enabled(MemoryRegion *mr, bool enabled);
637
2282e1af
AK
638/*
639 * memory_region_set_address: dynamically update the address of a region
640 *
641 * Dynamically updates the address of a region, relative to its parent.
642 * May be used on regions are currently part of a memory hierarchy.
643 *
644 * @mr: the region to be updated
645 * @addr: new address, relative to parent region
646 */
647void memory_region_set_address(MemoryRegion *mr, target_phys_addr_t addr);
648
4703359e
AK
649/*
650 * memory_region_set_alias_offset: dynamically update a memory alias's offset
651 *
652 * Dynamically updates the offset into the target region that an alias points
653 * to, as if the fourth argument to memory_region_init_alias() has changed.
654 *
655 * @mr: the #MemoryRegion to be updated; should be an alias.
656 * @offset: the new offset into the target memory region
657 */
658void memory_region_set_alias_offset(MemoryRegion *mr,
659 target_phys_addr_t offset);
660
e2177955
AK
661/**
662 * memory_region_find: locate a MemoryRegion in an address space
663 *
664 * Locates the first #MemoryRegion within an address space given by
665 * @address_space that overlaps the range given by @addr and @size.
666 *
667 * Returns a #MemoryRegionSection that describes a contiguous overlap.
668 * It will have the following characteristics:
669 * .@offset_within_address_space >= @addr
670 * .@offset_within_address_space + .@size <= @addr + @size
671 * .@size = 0 iff no overlap was found
672 * .@mr is non-%NULL iff an overlap was found
673 *
674 * @address_space: a top-level (i.e. parentless) region that contains
675 * the region to be found
676 * @addr: start of the area within @address_space to be searched
677 * @size: size of the area to be searched
678 */
679MemoryRegionSection memory_region_find(MemoryRegion *address_space,
680 target_phys_addr_t addr, uint64_t size);
681
fd062573
BS
682/**
683 * memory_region_section_addr: get offset within MemoryRegionSection
684 *
685 * Returns offset within MemoryRegionSection
686 *
687 * @section: the memory region section being queried
688 * @addr: address in address space
689 */
690static inline target_phys_addr_t
691memory_region_section_addr(MemoryRegionSection *section,
692 target_phys_addr_t addr)
693{
694 addr -= section->offset_within_address_space;
695 addr += section->offset_within_region;
696 return addr;
697}
86e775c6
AK
698
699/**
700 * memory_global_sync_dirty_bitmap: synchronize the dirty log for all memory
701 *
702 * Synchronizes the dirty page log for an entire address space.
703 * @address_space: a top-level (i.e. parentless) region that contains the
704 * memory being synchronized
705 */
706void memory_global_sync_dirty_bitmap(MemoryRegion *address_space);
707
69ddaf66
ASRJ
708/**
709 * memory_region_transaction_begin: Start a transaction.
710 *
711 * During a transaction, changes will be accumulated and made visible
dabdf394 712 * only when the transaction ends (is committed).
4ef4db86
AK
713 */
714void memory_region_transaction_begin(void);
69ddaf66
ASRJ
715
716/**
717 * memory_region_transaction_commit: Commit a transaction and make changes
718 * visible to the guest.
4ef4db86
AK
719 */
720void memory_region_transaction_commit(void);
721
7664e80c
AK
722/**
723 * memory_listener_register: register callbacks to be called when memory
724 * sections are mapped or unmapped into an address
725 * space
726 *
727 * @listener: an object containing the callbacks to be called
7376e582 728 * @filter: if non-%NULL, only regions in this address space will be observed
7664e80c 729 */
7376e582 730void memory_listener_register(MemoryListener *listener, MemoryRegion *filter);
7664e80c
AK
731
732/**
733 * memory_listener_unregister: undo the effect of memory_listener_register()
734 *
735 * @listener: an object containing the callbacks to be removed
736 */
737void memory_listener_unregister(MemoryListener *listener);
738
739/**
740 * memory_global_dirty_log_start: begin dirty logging for all regions
741 */
742void memory_global_dirty_log_start(void);
743
744/**
745 * memory_global_dirty_log_stop: begin dirty logging for all regions
746 */
747void memory_global_dirty_log_stop(void);
748
314e2987
BS
749void mtree_info(fprintf_function mon_printf, void *f);
750
093bc2cd
AK
751#endif
752
753#endif