memory.h

   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"
  25 #include "iorange.h"
  26 #include "ioport.h"
  27 #include "int128.h"
  28
  29 typedef struct MemoryRegionOps MemoryRegionOps;
  30 typedef struct MemoryRegion MemoryRegion;
  31 typedef struct MemoryRegionPortio MemoryRegionPortio;
  32 typedef struct MemoryRegionMmio MemoryRegionMmio;
  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
  41 struct MemoryRegionMmio {
  42     CPUReadMemoryFunc *read[3];
  43     CPUWriteMemoryFunc *write[3];
  44 };
  45
  46 /*
  47  * Memory region callbacks
  48  */
  49 struct MemoryRegionOps {
  50     /* Read from the memory region. @addr is relative to @mr; @size is
  51      * in bytes. */
  52     uint64_t (*read)(void *opaque,
  53                      target_phys_addr_t addr,
  54                      unsigned size);
  55     /* Write to the memory region. @addr is relative to @mr; @size is
  56      * in bytes. */
  57     void (*write)(void *opaque,
  58                   target_phys_addr_t addr,
  59                   uint64_t data,
  60                   unsigned size);
  61
  62     enum device_endian endianness;
  63     /* Guest-visible constraints: */
  64     struct {
  65         /* If nonzero, specify bounds on access sizes beyond which a machine
  66          * check is thrown.
  67          */
  68         unsigned min_access_size;
  69         unsigned max_access_size;
  70         /* If true, unaligned accesses are supported.  Otherwise unaligned
  71          * accesses throw machine checks.
  72          */
  73          bool unaligned;
  74         /*
  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).
  78          */
  79         bool (*accepts)(void *opaque, target_phys_addr_t addr,
  80                         unsigned size, bool is_write);
  81     } valid;
  82     /* Internal implementation constraints: */
  83     struct {
  84         /* If nonzero, specifies the minimum size implemented.  Smaller sizes
  85          * will be rounded upwards and a partial result will be returned.
  86          */
  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.
  90          */
  91         unsigned max_access_size;
  92         /* If true, unaligned accesses are supported.  Otherwise all accesses
  93          * are converted to (possibly multiple) naturally aligned accesses.
  94          */
  95          bool unaligned;
  96     } impl;
  97
  98     /* If .read and .write are not present, old_portio may be used for
  99      * backwards compatibility with old portio registration
 100      */
 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
 104      */
 105     const MemoryRegionMmio old_mmio;
 106 };
 107
 108 typedef struct CoalescedMemoryRange CoalescedMemoryRange;
 109 typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd;
 110
 111 struct MemoryRegion {
 112     /* All fields are private - violators will be prosecuted */
 113     const MemoryRegionOps *ops;
 114     void *opaque;
 115     MemoryRegion *parent;
 116     Int128 size;
 117     target_phys_addr_t addr;
 118     target_phys_addr_t offset;
 119     void (*destructor)(MemoryRegion *mr);
 120     ram_addr_t ram_addr;
 121     IORange iorange;
 122     bool subpage;
 123     bool terminates;
 124     bool readable;
 125     bool ram;
 126     bool readonly; /* For RAM regions */
 127     bool enabled;
 128     bool rom_device;
 129     bool warning_printed; /* For reservations */
 130     MemoryRegion *alias;
 131     target_phys_addr_t alias_offset;
 132     unsigned priority;
 133     bool may_overlap;
 134     QTAILQ_HEAD(subregions, MemoryRegion) subregions;
 135     QTAILQ_ENTRY(MemoryRegion) subregions_link;
 136     QTAILQ_HEAD(coalesced_ranges, CoalescedMemoryRange) coalesced;
 137     const char *name;
 138     uint8_t dirty_log_mask;
 139     unsigned ioeventfd_nb;
 140     MemoryRegionIoeventfd *ioeventfds;
 141 };
 142
 143 struct MemoryRegionPortio {
 144     uint32_t offset;
 145     uint32_t len;
 146     unsigned size;
 147     IOPortReadFunc *read;
 148     IOPortWriteFunc *write;
 149 };
 150
 151 #define PORTIO_END_OF_LIST() { }
 152
 153 typedef struct MemoryRegionSection MemoryRegionSection;
 154
 155 /**
 156  * MemoryRegionSection: describes a fragment of a #MemoryRegion
 157  *
 158  * @mr: the region, or %NULL if empty
 159  * @address_space: the address space the region is mapped in
 160  * @offset_within_region: the beginning of the section, relative to @mr's start
 161  * @size: the size of the section; will not exceed @mr's boundaries
 162  * @offset_within_address_space: the address of the first byte of the section
 163  *     relative to the region's address space
 164  */
 165 struct MemoryRegionSection {
 166     MemoryRegion *mr;
 167     MemoryRegion *address_space;
 168     target_phys_addr_t offset_within_region;
 169     uint64_t size;
 170     target_phys_addr_t offset_within_address_space;
 171 };
 172
 173 typedef struct MemoryListener MemoryListener;
 174
 175 /**
 176  * MemoryListener: callbacks structure for updates to the physical memory map
 177  *
 178  * Allows a component to adjust to changes in the guest-visible memory map.
 179  * Use with memory_listener_register() and memory_listener_unregister().
 180  */
 181 struct MemoryListener {
 182     void (*region_add)(MemoryListener *listener, MemoryRegionSection *section);
 183     void (*region_del)(MemoryListener *listener, MemoryRegionSection *section);
 184     void (*log_start)(MemoryListener *listener, MemoryRegionSection *section);
 185     void (*log_stop)(MemoryListener *listener, MemoryRegionSection *section);
 186     void (*log_sync)(MemoryListener *listener, MemoryRegionSection *section);
 187     void (*log_global_start)(MemoryListener *listener);
 188     void (*log_global_stop)(MemoryListener *listener);
 189     QLIST_ENTRY(MemoryListener) link;
 190 };
 191
 192 /**
 193  * memory_region_init: Initialize a memory region
 194  *
 195  * The region typically acts as a container for other memory regions.  Use
 196  * memory_region_add_subregion() to add subregions.
 197  *
 198  * @mr: the #MemoryRegion to be initialized
 199  * @name: used for debugging; not visible to the user or ABI
 200  * @size: size of the region; any subregions beyond this size will be clipped
 201  */
 202 void memory_region_init(MemoryRegion *mr,
 203                         const char *name,
 204                         uint64_t size);
 205 /**
 206  * memory_region_init_io: Initialize an I/O memory region.
 207  *
 208  * Accesses into the region will cause the callbacks in @ops to be called.
 209  * if @size is nonzero, subregions will be clipped to @size.
 210  *
 211  * @mr: the #MemoryRegion to be initialized.
 212  * @ops: a structure containing read and write callbacks to be used when
 213  *       I/O is performed on the region.
 214  * @opaque: passed to to the read and write callbacks of the @ops structure.
 215  * @name: used for debugging; not visible to the user or ABI
 216  * @size: size of the region.
 217  */
 218 void memory_region_init_io(MemoryRegion *mr,
 219                            const MemoryRegionOps *ops,
 220                            void *opaque,
 221                            const char *name,
 222                            uint64_t size);
 223
 224 /**
 225  * memory_region_init_ram:  Initialize RAM memory region.  Accesses into the
 226  *                          region will modify memory directly.
 227  *
 228  * @mr: the #MemoryRegion to be initialized.
 229  * @name: the name of the region.
 230  * @size: size of the region.
 231  */
 232 void memory_region_init_ram(MemoryRegion *mr,
 233                             const char *name,
 234                             uint64_t size);
 235
 236 /**
 237  * memory_region_init_ram:  Initialize RAM memory region from a user-provided.
 238  *                          pointer.  Accesses into the region will modify
 239  *                          memory directly.
 240  *
 241  * @mr: the #MemoryRegion to be initialized.
 242  * @name: the name of the region.
 243  * @size: size of the region.
 244  * @ptr: memory to be mapped; must contain at least @size bytes.
 245  */
 246 void memory_region_init_ram_ptr(MemoryRegion *mr,
 247                                 const char *name,
 248                                 uint64_t size,
 249                                 void *ptr);
 250
 251 /**
 252  * memory_region_init_alias: Initialize a memory region that aliases all or a
 253  *                           part of another memory region.
 254  *
 255  * @mr: the #MemoryRegion to be initialized.
 256  * @name: used for debugging; not visible to the user or ABI
 257  * @orig: the region to be referenced; @mr will be equivalent to
 258  *        @orig between @offset and @offset + @size - 1.
 259  * @offset: start of the section in @orig to be referenced.
 260  * @size: size of the region.
 261  */
 262 void memory_region_init_alias(MemoryRegion *mr,
 263                               const char *name,
 264                               MemoryRegion *orig,
 265                               target_phys_addr_t offset,
 266                               uint64_t size);
 267
 268 /**
 269  * memory_region_init_rom_device:  Initialize a ROM memory region.  Writes are
 270  *                                 handled via callbacks.
 271  *
 272  * @mr: the #MemoryRegion to be initialized.
 273  * @ops: callbacks for write access handling.
 274  * @name: the name of the region.
 275  * @size: size of the region.
 276  */
 277 void memory_region_init_rom_device(MemoryRegion *mr,
 278                                    const MemoryRegionOps *ops,
 279                                    void *opaque,
 280                                    const char *name,
 281                                    uint64_t size);
 282
 283 /**
 284  * memory_region_init_reservation: Initialize a memory region that reserves
 285  *                                 I/O space.
 286  *
 287  * A reservation region primariy serves debugging purposes.  It claims I/O
 288  * space that is not supposed to be handled by QEMU itself.  Any access via
 289  * the memory API will cause an abort().
 290  *
 291  * @mr: the #MemoryRegion to be initialized
 292  * @name: used for debugging; not visible to the user or ABI
 293  * @size: size of the region.
 294  */
 295 void memory_region_init_reservation(MemoryRegion *mr,
 296                                     const char *name,
 297                                     uint64_t size);
 298 /**
 299  * memory_region_destroy: Destroy a memory region and reclaim all resources.
 300  *
 301  * @mr: the region to be destroyed.  May not currently be a subregion
 302  *      (see memory_region_add_subregion()) or referenced in an alias
 303  *      (see memory_region_init_alias()).
 304  */
 305 void memory_region_destroy(MemoryRegion *mr);
 306
 307 /**
 308  * memory_region_size: get a memory region's size.
 309  *
 310  * @mr: the memory region being queried.
 311  */
 312 uint64_t memory_region_size(MemoryRegion *mr);
 313
 314 /**
 315  * memory_region_is_ram: check whether a memory region is random access
 316  *
 317  * Returns %true is a memory region is random access.
 318  *
 319  * @mr: the memory region being queried
 320  */
 321 bool memory_region_is_ram(MemoryRegion *mr);
 322
 323 /**
 324  * memory_region_name: get a memory region's name
 325  *
 326  * Returns the string that was used to initialize the memory region.
 327  *
 328  * @mr: the memory region being queried
 329  */
 330 const char *memory_region_name(MemoryRegion *mr);
 331
 332 /**
 333  * memory_region_is_logging: return whether a memory region is logging writes
 334  *
 335  * Returns %true if the memory region is logging writes
 336  *
 337  * @mr: the memory region being queried
 338  */
 339 bool memory_region_is_logging(MemoryRegion *mr);
 340
 341 /**
 342  * memory_region_is_rom: check whether a memory region is ROM
 343  *
 344  * Returns %true is a memory region is read-only memory.
 345  *
 346  * @mr: the memory region being queried
 347  */
 348 bool memory_region_is_rom(MemoryRegion *mr);
 349
 350 /**
 351  * memory_region_get_ram_ptr: Get a pointer into a RAM memory region.
 352  *
 353  * Returns a host pointer to a RAM memory region (created with
 354  * memory_region_init_ram() or memory_region_init_ram_ptr()).  Use with
 355  * care.
 356  *
 357  * @mr: the memory region being queried.
 358  */
 359 void *memory_region_get_ram_ptr(MemoryRegion *mr);
 360
 361 /**
 362  * memory_region_set_offset: Sets an offset to be added to MemoryRegionOps
 363  *                           callbacks.
 364  *
 365  * This function is deprecated and should not be used in new code.
 366  */
 367 void memory_region_set_offset(MemoryRegion *mr, target_phys_addr_t offset);
 368
 369 /**
 370  * memory_region_set_log: Turn dirty logging on or off for a region.
 371  *
 372  * Turns dirty logging on or off for a specified client (display, migration).
 373  * Only meaningful for RAM regions.
 374  *
 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
 378  *          %DIRTY_MEMORY_VGA.
 379  */
 380 void memory_region_set_log(MemoryRegion *mr, bool log, unsigned client);
 381
 382 /**
 383  * memory_region_get_dirty: Check whether a range of bytes is dirty
 384  *                          for a specified client.
 385  *
 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
 388  * must be enabled.
 389  *
 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
 394  *          %DIRTY_MEMORY_VGA.
 395  */
 396 bool memory_region_get_dirty(MemoryRegion *mr, target_phys_addr_t addr,
 397                              target_phys_addr_t size, unsigned client);
 398
 399 /**
 400  * memory_region_set_dirty: Mark a range of bytes as dirty in a memory region.
 401  *
 402  * Marks a range of bytes as dirty, after it has been dirtied outside
 403  * guest code.
 404  *
 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.
 408  */
 409 void memory_region_set_dirty(MemoryRegion *mr, target_phys_addr_t addr,
 410                              target_phys_addr_t size);
 411
 412 /**
 413  * memory_region_sync_dirty_bitmap: Synchronize a region's dirty bitmap with
 414  *                                  any external TLBs (e.g. kvm)
 415  *
 416  * Flushes dirty information from accelerators such as kvm and vhost-net
 417  * and makes it available to users of the memory API.
 418  *
 419  * @mr: the region being flushed.
 420  */
 421 void memory_region_sync_dirty_bitmap(MemoryRegion *mr);
 422
 423 /**
 424  * memory_region_reset_dirty: Mark a range of pages as clean, for a specified
 425  *                            client.
 426  *
 427  * Marks a range of pages as no longer dirty.
 428  *
 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
 433  *          %DIRTY_MEMORY_VGA.
 434  */
 435 void memory_region_reset_dirty(MemoryRegion *mr, target_phys_addr_t addr,
 436                                target_phys_addr_t size, unsigned client);
 437
 438 /**
 439  * memory_region_set_readonly: Turn a memory region read-only (or read-write)
 440  *
 441  * Allows a memory region to be marked as read-only (turning it into a ROM).
 442  * only useful on RAM regions.
 443  *
 444  * @mr: the region being updated.
 445  * @readonly: whether rhe region is to be ROM or RAM.
 446  */
 447 void memory_region_set_readonly(MemoryRegion *mr, bool readonly);
 448
 449 /**
 450  * memory_region_rom_device_set_readable: enable/disable ROM readability
 451  *
 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.
 456  *
 457  * @mr: the memory region to be updated
 458  * @readable: whether reads are satisified directly (%true) or via callbacks
 459  *            (%false)
 460  */
 461 void memory_region_rom_device_set_readable(MemoryRegion *mr, bool readable);
 462
 463 /**
 464  * memory_region_set_coalescing: Enable memory coalescing for the region.
 465  *
 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.
 469  *
 470  * @mr: the memory region to be write coalesced
 471  */
 472 void memory_region_set_coalescing(MemoryRegion *mr);
 473
 474 /**
 475  * memory_region_add_coalescing: Enable memory coalescing for a sub-range of
 476  *                               a region.
 477  *
 478  * Like memory_region_set_coalescing(), but works on a sub-range of a region.
 479  * Multiple calls can be issued coalesced disjoint ranges.
 480  *
 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.
 484  */
 485 void memory_region_add_coalescing(MemoryRegion *mr,
 486                                   target_phys_addr_t offset,
 487                                   uint64_t size);
 488
 489 /**
 490  * memory_region_clear_coalescing: Disable MMIO coalescing for the region.
 491  *
 492  * Disables any coalescing caused by memory_region_set_coalescing() or
 493  * memory_region_add_coalescing().  Roughly equivalent to uncacheble memory
 494  * hardware.
 495  *
 496  * @mr: the memory region to be updated.
 497  */
 498 void memory_region_clear_coalescing(MemoryRegion *mr);
 499
 500 /**
 501  * memory_region_add_eventfd: Request an eventfd to be triggered when a word
 502  *                            is written to a location.
 503  *
 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).
 508  *
 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.
 515  **/
 516 void memory_region_add_eventfd(MemoryRegion *mr,
 517                                target_phys_addr_t addr,
 518                                unsigned size,
 519                                bool match_data,
 520                                uint64_t data,
 521                                int fd);
 522
 523 /**
 524  * memory_region_del_eventfd: Cancel an eventfd.
 525  *
 526  * Cancels an eventfd trigger requested by a previous
 527  * memory_region_add_eventfd() call.
 528  *
 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.
 535  */
 536 void memory_region_del_eventfd(MemoryRegion *mr,
 537                                target_phys_addr_t addr,
 538                                unsigned size,
 539                                bool match_data,
 540                                uint64_t data,
 541                                int fd);
 542 /**
 543  * memory_region_add_subregion: Add a subregion to a container.
 544  *
 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.
 550  *
 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.
 555  */
 556 void memory_region_add_subregion(MemoryRegion *mr,
 557                                  target_phys_addr_t offset,
 558                                  MemoryRegion *subregion);
 559 /**
 560  * memory_region_add_subregion: Add a subregion to a container, with overlap.
 561  *
 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.
 568  *
 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.
 574  */
 575 void memory_region_add_subregion_overlap(MemoryRegion *mr,
 576                                          target_phys_addr_t offset,
 577                                          MemoryRegion *subregion,
 578                                          unsigned priority);
 579
 580 /**
 581  * memory_region_get_ram_addr: Get the ram address associated with a memory
 582  *                             region
 583  *
 584  * DO NOT USE THIS FUNCTION.  This is a temporary workaround while the Xen
 585  * code is being reworked.
 586  */
 587 ram_addr_t memory_region_get_ram_addr(MemoryRegion *mr);
 588
 589 /**
 590  * memory_region_del_subregion: Remove a subregion.
 591  *
 592  * Removes a subregion from its container.
 593  *
 594  * @mr: the container to be updated.
 595  * @subregion: the region being removed; must be a current subregion of @mr.
 596  */
 597 void memory_region_del_subregion(MemoryRegion *mr,
 598                                  MemoryRegion *subregion);
 599
 600 /*
 601  * memory_region_set_enabled: dynamically enable or disable a region
 602  *
 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.
 607  *
 608  * Regions default to being enabled.
 609  *
 610  * @mr: the region to be updated
 611  * @enabled: whether to enable or disable the region
 612  */
 613 void memory_region_set_enabled(MemoryRegion *mr, bool enabled);
 614
 615 /*
 616  * memory_region_set_address: dynamically update the address of a region
 617  *
 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.
 620  *
 621  * @mr: the region to be updated
 622  * @addr: new address, relative to parent region
 623  */
 624 void memory_region_set_address(MemoryRegion *mr, target_phys_addr_t addr);
 625
 626 /*
 627  * memory_region_set_alias_offset: dynamically update a memory alias's offset
 628  *
 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.
 631  *
 632  * @mr: the #MemoryRegion to be updated; should be an alias.
 633  * @offset: the new offset into the target memory region
 634  */
 635 void memory_region_set_alias_offset(MemoryRegion *mr,
 636                                     target_phys_addr_t offset);
 637
 638 /**
 639  * memory_region_find: locate a MemoryRegion in an address space
 640  *
 641  * Locates the first #MemoryRegion within an address space given by
 642  * @address_space that overlaps the range given by @addr and @size.
 643  *
 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
 650  *
 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
 655  */
 656 MemoryRegionSection memory_region_find(MemoryRegion *address_space,
 657                                        target_phys_addr_t addr, uint64_t size);
 658
 659
 660 /**
 661  * memory_global_sync_dirty_bitmap: synchronize the dirty log for all memory
 662  *
 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
 666  */
 667 void memory_global_sync_dirty_bitmap(MemoryRegion *address_space);
 668
 669 /**
 670  * memory_region_transaction_begin: Start a transaction.
 671  *
 672  * During a transaction, changes will be accumulated and made visible
 673  * only when the transaction ends (is committed).
 674  */
 675 void memory_region_transaction_begin(void);
 676
 677 /**
 678  * memory_region_transaction_commit: Commit a transaction and make changes
 679  *                                   visible to the guest.
 680  */
 681 void memory_region_transaction_commit(void);
 682
 683 /**
 684  * memory_listener_register: register callbacks to be called when memory
 685  *                           sections are mapped or unmapped into an address
 686  *                           space
 687  *
 688  * @listener: an object containing the callbacks to be called
 689  */
 690 void memory_listener_register(MemoryListener *listener);
 691
 692 /**
 693  * memory_listener_unregister: undo the effect of memory_listener_register()
 694  *
 695  * @listener: an object containing the callbacks to be removed
 696  */
 697 void memory_listener_unregister(MemoryListener *listener);
 698
 699 /**
 700  * memory_global_dirty_log_start: begin dirty logging for all regions
 701  */
 702 void memory_global_dirty_log_start(void);
 703
 704 /**
 705  * memory_global_dirty_log_stop: begin dirty logging for all regions
 706  */
 707 void memory_global_dirty_log_stop(void);
 708
 709 void mtree_info(fprintf_function mon_printf, void *f);
 710
 711 #endif
 712
 713 #endif