memory.h 38.4 KB
Newer Older
A
Avi Kivity 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 * Physical memory management API
 *
 * Copyright 2011 Red Hat, Inc. and/or its affiliates
 *
 * Authors:
 *  Avi Kivity <avi@redhat.com>
 *
 * This work is licensed under the terms of the GNU GPL, version 2.  See
 * the COPYING file in the top-level directory.
 *
 */

#ifndef MEMORY_H
#define MEMORY_H

#ifndef CONFIG_USER_ONLY

19 20 21 22 23
#define DIRTY_MEMORY_VGA       0
#define DIRTY_MEMORY_CODE      1
#define DIRTY_MEMORY_MIGRATION 2
#define DIRTY_MEMORY_NUM       3        /* num of dirty bits */

A
Avi Kivity 已提交
24 25 26
#include <stdint.h>
#include <stdbool.h>
#include "qemu-common.h"
27
#include "exec/cpu-common.h"
28
#ifndef CONFIG_USER_ONLY
29
#include "exec/hwaddr.h"
30
#endif
31 32
#include "qemu/queue.h"
#include "qemu/int128.h"
33
#include "qemu/notify.h"
34
#include "qapi/error.h"
P
Peter Crosthwaite 已提交
35
#include "qom/object.h"
A
Avi Kivity 已提交
36

37 38 39
#define MAX_PHYS_ADDR_SPACE_BITS 62
#define MAX_PHYS_ADDR            (((hwaddr)1 << MAX_PHYS_ADDR_SPACE_BITS) - 1)

P
Peter Crosthwaite 已提交
40 41 42 43
#define TYPE_MEMORY_REGION "qemu:memory-region"
#define MEMORY_REGION(obj) \
        OBJECT_CHECK(MemoryRegion, (obj), TYPE_MEMORY_REGION)

A
Avi Kivity 已提交
44
typedef struct MemoryRegionOps MemoryRegionOps;
45
typedef struct MemoryRegionMmio MemoryRegionMmio;
A
Avi Kivity 已提交
46

47 48 49 50 51
struct MemoryRegionMmio {
    CPUReadMemoryFunc *read[3];
    CPUWriteMemoryFunc *write[3];
};

A
Avi Kivity 已提交
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
typedef struct IOMMUTLBEntry IOMMUTLBEntry;

/* See address_space_translate: bit 0 is read, bit 1 is write.  */
typedef enum {
    IOMMU_NONE = 0,
    IOMMU_RO   = 1,
    IOMMU_WO   = 2,
    IOMMU_RW   = 3,
} IOMMUAccessFlags;

struct IOMMUTLBEntry {
    AddressSpace    *target_as;
    hwaddr           iova;
    hwaddr           translated_addr;
    hwaddr           addr_mask;  /* 0xfff = 4k translation */
    IOMMUAccessFlags perm;
};

A
Avi Kivity 已提交
70 71 72 73 74 75 76
/*
 * Memory region callbacks
 */
struct MemoryRegionOps {
    /* Read from the memory region. @addr is relative to @mr; @size is
     * in bytes. */
    uint64_t (*read)(void *opaque,
A
Avi Kivity 已提交
77
                     hwaddr addr,
A
Avi Kivity 已提交
78 79 80 81
                     unsigned size);
    /* Write to the memory region. @addr is relative to @mr; @size is
     * in bytes. */
    void (*write)(void *opaque,
A
Avi Kivity 已提交
82
                  hwaddr addr,
A
Avi Kivity 已提交
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
                  uint64_t data,
                  unsigned size);

    enum device_endian endianness;
    /* Guest-visible constraints: */
    struct {
        /* If nonzero, specify bounds on access sizes beyond which a machine
         * check is thrown.
         */
        unsigned min_access_size;
        unsigned max_access_size;
        /* If true, unaligned accesses are supported.  Otherwise unaligned
         * accesses throw machine checks.
         */
         bool unaligned;
98 99 100 101 102
        /*
         * If present, and returns #false, the transaction is not accepted
         * by the device (and results in machine dependent behaviour such
         * as a machine check exception).
         */
A
Avi Kivity 已提交
103
        bool (*accepts)(void *opaque, hwaddr addr,
104
                        unsigned size, bool is_write);
A
Avi Kivity 已提交
105 106 107 108 109 110 111 112 113 114 115 116 117 118
    } valid;
    /* Internal implementation constraints: */
    struct {
        /* If nonzero, specifies the minimum size implemented.  Smaller sizes
         * will be rounded upwards and a partial result will be returned.
         */
        unsigned min_access_size;
        /* If nonzero, specifies the maximum size implemented.  Larger sizes
         * will be done as a series of accesses with smaller sizes.
         */
        unsigned max_access_size;
        /* If true, unaligned accesses are supported.  Otherwise all accesses
         * are converted to (possibly multiple) naturally aligned accesses.
         */
119
        bool unaligned;
A
Avi Kivity 已提交
120
    } impl;
121

122 123 124 125
    /* If .read and .write are not present, old_mmio may be used for
     * backwards compatibility with old mmio registration
     */
    const MemoryRegionMmio old_mmio;
A
Avi Kivity 已提交
126 127
};

A
Avi Kivity 已提交
128 129 130 131
typedef struct MemoryRegionIOMMUOps MemoryRegionIOMMUOps;

struct MemoryRegionIOMMUOps {
    /* Return a TLB entry that contains a given address. */
132
    IOMMUTLBEntry (*translate)(MemoryRegion *iommu, hwaddr addr, bool is_write);
A
Avi Kivity 已提交
133 134
};

A
Avi Kivity 已提交
135
typedef struct CoalescedMemoryRange CoalescedMemoryRange;
A
Avi Kivity 已提交
136
typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd;
A
Avi Kivity 已提交
137 138

struct MemoryRegion {
P
Peter Crosthwaite 已提交
139
    Object parent_obj;
A
Avi Kivity 已提交
140 141
    /* All fields are private - violators will be prosecuted */
    const MemoryRegionOps *ops;
A
Avi Kivity 已提交
142
    const MemoryRegionIOMMUOps *iommu_ops;
A
Avi Kivity 已提交
143
    void *opaque;
144
    MemoryRegion *container;
145
    Int128 size;
A
Avi Kivity 已提交
146
    hwaddr addr;
147
    void (*destructor)(MemoryRegion *mr);
A
Avi Kivity 已提交
148
    ram_addr_t ram_addr;
A
Avi Kivity 已提交
149
    bool subpage;
150
    bool terminates;
151
    bool romd_mode;
A
Avi Kivity 已提交
152
    bool ram;
153
    bool readonly; /* For RAM regions */
154
    bool enabled;
A
Avi Kivity 已提交
155
    bool rom_device;
156
    bool warning_printed; /* For reservations */
157
    bool flush_coalesced_mmio;
A
Avi Kivity 已提交
158
    MemoryRegion *alias;
A
Avi Kivity 已提交
159
    hwaddr alias_offset;
160
    int32_t priority;
A
Avi Kivity 已提交
161 162 163 164
    bool may_overlap;
    QTAILQ_HEAD(subregions, MemoryRegion) subregions;
    QTAILQ_ENTRY(MemoryRegion) subregions_link;
    QTAILQ_HEAD(coalesced_ranges, CoalescedMemoryRange) coalesced;
165
    const char *name;
A
Avi Kivity 已提交
166
    uint8_t dirty_log_mask;
A
Avi Kivity 已提交
167 168
    unsigned ioeventfd_nb;
    MemoryRegionIoeventfd *ioeventfds;
169
    NotifierList iommu_notify;
A
Avi Kivity 已提交
170 171
};

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
/**
 * MemoryListener: callbacks structure for updates to the physical memory map
 *
 * Allows a component to adjust to changes in the guest-visible memory map.
 * Use with memory_listener_register() and memory_listener_unregister().
 */
struct MemoryListener {
    void (*begin)(MemoryListener *listener);
    void (*commit)(MemoryListener *listener);
    void (*region_add)(MemoryListener *listener, MemoryRegionSection *section);
    void (*region_del)(MemoryListener *listener, MemoryRegionSection *section);
    void (*region_nop)(MemoryListener *listener, MemoryRegionSection *section);
    void (*log_start)(MemoryListener *listener, MemoryRegionSection *section);
    void (*log_stop)(MemoryListener *listener, MemoryRegionSection *section);
    void (*log_sync)(MemoryListener *listener, MemoryRegionSection *section);
    void (*log_global_start)(MemoryListener *listener);
    void (*log_global_stop)(MemoryListener *listener);
    void (*eventfd_add)(MemoryListener *listener, MemoryRegionSection *section,
                        bool match_data, uint64_t data, EventNotifier *e);
    void (*eventfd_del)(MemoryListener *listener, MemoryRegionSection *section,
                        bool match_data, uint64_t data, EventNotifier *e);
    void (*coalesced_mmio_add)(MemoryListener *listener, MemoryRegionSection *section,
                               hwaddr addr, hwaddr len);
    void (*coalesced_mmio_del)(MemoryListener *listener, MemoryRegionSection *section,
                               hwaddr addr, hwaddr len);
    /* Lower = earlier (during add), later (during del) */
    unsigned priority;
    AddressSpace *address_space_filter;
    QTAILQ_ENTRY(MemoryListener) link;
};

A
Avi Kivity 已提交
203 204 205 206 207
/**
 * AddressSpace: describes a mapping of addresses to #MemoryRegion objects
 */
struct AddressSpace {
    /* All fields are private. */
208
    char *name;
A
Avi Kivity 已提交
209 210 211 212
    MemoryRegion *root;
    struct FlatView *current_map;
    int ioeventfd_nb;
    struct MemoryRegionIoeventfd *ioeventfds;
A
Avi Kivity 已提交
213
    struct AddressSpaceDispatch *dispatch;
214
    struct AddressSpaceDispatch *next_dispatch;
215 216
    MemoryListener dispatch_listener;

217
    QTAILQ_ENTRY(AddressSpace) address_spaces_link;
A
Avi Kivity 已提交
218 219
};

220 221 222 223
/**
 * MemoryRegionSection: describes a fragment of a #MemoryRegion
 *
 * @mr: the region, or %NULL if empty
224
 * @address_space: the address space the region is mapped in
225 226 227 228
 * @offset_within_region: the beginning of the section, relative to @mr's start
 * @size: the size of the section; will not exceed @mr's boundaries
 * @offset_within_address_space: the address of the first byte of the section
 *     relative to the region's address space
229
 * @readonly: writes to this section are ignored
230 231 232
 */
struct MemoryRegionSection {
    MemoryRegion *mr;
233
    AddressSpace *address_space;
A
Avi Kivity 已提交
234
    hwaddr offset_within_region;
235
    Int128 size;
A
Avi Kivity 已提交
236
    hwaddr offset_within_address_space;
237
    bool readonly;
238 239
};

A
Avi Kivity 已提交
240 241 242
/**
 * memory_region_init: Initialize a memory region
 *
243
 * The region typically acts as a container for other memory regions.  Use
A
Avi Kivity 已提交
244 245 246
 * memory_region_add_subregion() to add subregions.
 *
 * @mr: the #MemoryRegion to be initialized
247
 * @owner: the object that tracks the region's reference count
A
Avi Kivity 已提交
248 249 250 251
 * @name: used for debugging; not visible to the user or ABI
 * @size: size of the region; any subregions beyond this size will be clipped
 */
void memory_region_init(MemoryRegion *mr,
252
                        struct Object *owner,
A
Avi Kivity 已提交
253 254
                        const char *name,
                        uint64_t size);
P
Paolo Bonzini 已提交
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284

/**
 * memory_region_ref: Add 1 to a memory region's reference count
 *
 * Whenever memory regions are accessed outside the BQL, they need to be
 * preserved against hot-unplug.  MemoryRegions actually do not have their
 * own reference count; they piggyback on a QOM object, their "owner".
 * This function adds a reference to the owner.
 *
 * All MemoryRegions must have an owner if they can disappear, even if the
 * device they belong to operates exclusively under the BQL.  This is because
 * the region could be returned at any time by memory_region_find, and this
 * is usually under guest control.
 *
 * @mr: the #MemoryRegion
 */
void memory_region_ref(MemoryRegion *mr);

/**
 * memory_region_unref: Remove 1 to a memory region's reference count
 *
 * Whenever memory regions are accessed outside the BQL, they need to be
 * preserved against hot-unplug.  MemoryRegions actually do not have their
 * own reference count; they piggyback on a QOM object, their "owner".
 * This function removes a reference to the owner and possibly destroys it.
 *
 * @mr: the #MemoryRegion
 */
void memory_region_unref(MemoryRegion *mr);

A
Avi Kivity 已提交
285 286 287
/**
 * memory_region_init_io: Initialize an I/O memory region.
 *
288
 * Accesses into the region will cause the callbacks in @ops to be called.
A
Avi Kivity 已提交
289 290 291
 * if @size is nonzero, subregions will be clipped to @size.
 *
 * @mr: the #MemoryRegion to be initialized.
292
 * @owner: the object that tracks the region's reference count
A
Avi Kivity 已提交
293 294 295 296 297 298 299
 * @ops: a structure containing read and write callbacks to be used when
 *       I/O is performed on the region.
 * @opaque: passed to to the read and write callbacks of the @ops structure.
 * @name: used for debugging; not visible to the user or ABI
 * @size: size of the region.
 */
void memory_region_init_io(MemoryRegion *mr,
300
                           struct Object *owner,
A
Avi Kivity 已提交
301 302 303 304 305 306 307
                           const MemoryRegionOps *ops,
                           void *opaque,
                           const char *name,
                           uint64_t size);

/**
 * memory_region_init_ram:  Initialize RAM memory region.  Accesses into the
308
 *                          region will modify memory directly.
A
Avi Kivity 已提交
309 310
 *
 * @mr: the #MemoryRegion to be initialized.
311
 * @owner: the object that tracks the region's reference count
312
 * @name: the name of the region.
A
Avi Kivity 已提交
313 314 315
 * @size: size of the region.
 */
void memory_region_init_ram(MemoryRegion *mr,
316
                            struct Object *owner,
A
Avi Kivity 已提交
317 318 319
                            const char *name,
                            uint64_t size);

320 321 322 323 324 325 326 327 328
#ifdef __linux__
/**
 * memory_region_init_ram_from_file:  Initialize RAM memory region with a
 *                                    mmap-ed backend.
 *
 * @mr: the #MemoryRegion to be initialized.
 * @owner: the object that tracks the region's reference count
 * @name: the name of the region.
 * @size: size of the region.
329
 * @share: %true if memory must be mmaped with the MAP_SHARED flag
330
 * @path: the path in which to allocate the RAM.
331
 * @errp: pointer to Error*, to store an error if it happens.
332 333 334 335 336
 */
void memory_region_init_ram_from_file(MemoryRegion *mr,
                                      struct Object *owner,
                                      const char *name,
                                      uint64_t size,
337
                                      bool share,
338 339
                                      const char *path,
                                      Error **errp);
340 341
#endif

A
Avi Kivity 已提交
342
/**
343 344 345
 * memory_region_init_ram_ptr:  Initialize RAM memory region from a
 *                              user-provided pointer.  Accesses into the
 *                              region will modify memory directly.
A
Avi Kivity 已提交
346 347
 *
 * @mr: the #MemoryRegion to be initialized.
348
 * @owner: the object that tracks the region's reference count
349
 * @name: the name of the region.
A
Avi Kivity 已提交
350 351 352 353
 * @size: size of the region.
 * @ptr: memory to be mapped; must contain at least @size bytes.
 */
void memory_region_init_ram_ptr(MemoryRegion *mr,
354
                                struct Object *owner,
A
Avi Kivity 已提交
355 356 357 358 359 360 361 362 363
                                const char *name,
                                uint64_t size,
                                void *ptr);

/**
 * memory_region_init_alias: Initialize a memory region that aliases all or a
 *                           part of another memory region.
 *
 * @mr: the #MemoryRegion to be initialized.
364
 * @owner: the object that tracks the region's reference count
A
Avi Kivity 已提交
365 366 367 368 369 370 371
 * @name: used for debugging; not visible to the user or ABI
 * @orig: the region to be referenced; @mr will be equivalent to
 *        @orig between @offset and @offset + @size - 1.
 * @offset: start of the section in @orig to be referenced.
 * @size: size of the region.
 */
void memory_region_init_alias(MemoryRegion *mr,
372
                              struct Object *owner,
A
Avi Kivity 已提交
373 374
                              const char *name,
                              MemoryRegion *orig,
A
Avi Kivity 已提交
375
                              hwaddr offset,
A
Avi Kivity 已提交
376
                              uint64_t size);
377 378 379 380 381 382

/**
 * memory_region_init_rom_device:  Initialize a ROM memory region.  Writes are
 *                                 handled via callbacks.
 *
 * @mr: the #MemoryRegion to be initialized.
383
 * @owner: the object that tracks the region's reference count
384
 * @ops: callbacks for write access handling.
385
 * @name: the name of the region.
386 387 388
 * @size: size of the region.
 */
void memory_region_init_rom_device(MemoryRegion *mr,
389
                                   struct Object *owner,
390
                                   const MemoryRegionOps *ops,
391
                                   void *opaque,
392 393 394
                                   const char *name,
                                   uint64_t size);

395 396 397 398 399 400 401 402 403
/**
 * memory_region_init_reservation: Initialize a memory region that reserves
 *                                 I/O space.
 *
 * A reservation region primariy serves debugging purposes.  It claims I/O
 * space that is not supposed to be handled by QEMU itself.  Any access via
 * the memory API will cause an abort().
 *
 * @mr: the #MemoryRegion to be initialized
404
 * @owner: the object that tracks the region's reference count
405 406 407 408
 * @name: used for debugging; not visible to the user or ABI
 * @size: size of the region.
 */
void memory_region_init_reservation(MemoryRegion *mr,
409
                                    struct Object *owner,
410 411
                                    const char *name,
                                    uint64_t size);
A
Avi Kivity 已提交
412 413 414 415 416 417 418 419 420

/**
 * memory_region_init_iommu: Initialize a memory region that translates
 * addresses
 *
 * An IOMMU region translates addresses and forwards accesses to a target
 * memory region.
 *
 * @mr: the #MemoryRegion to be initialized
421
 * @owner: the object that tracks the region's reference count
A
Avi Kivity 已提交
422 423 424 425 426
 * @ops: a function that translates addresses into the @target region
 * @name: used for debugging; not visible to the user or ABI
 * @size: size of the region.
 */
void memory_region_init_iommu(MemoryRegion *mr,
427
                              struct Object *owner,
A
Avi Kivity 已提交
428 429 430 431
                              const MemoryRegionIOMMUOps *ops,
                              const char *name,
                              uint64_t size);

P
Paolo Bonzini 已提交
432 433 434 435 436 437 438
/**
 * memory_region_owner: get a memory region's owner.
 *
 * @mr: the memory region being queried.
 */
struct Object *memory_region_owner(MemoryRegion *mr);

A
Avi Kivity 已提交
439 440 441 442 443 444 445
/**
 * memory_region_size: get a memory region's size.
 *
 * @mr: the memory region being queried.
 */
uint64_t memory_region_size(MemoryRegion *mr);

A
Avi Kivity 已提交
446 447 448 449 450 451 452 453 454
/**
 * memory_region_is_ram: check whether a memory region is random access
 *
 * Returns %true is a memory region is random access.
 *
 * @mr: the memory region being queried
 */
bool memory_region_is_ram(MemoryRegion *mr);

455
/**
456
 * memory_region_is_romd: check whether a memory region is in ROMD mode
457
 *
458
 * Returns %true if a memory region is a ROM device and currently set to allow
459 460 461 462 463 464
 * direct reads.
 *
 * @mr: the memory region being queried
 */
static inline bool memory_region_is_romd(MemoryRegion *mr)
{
465
    return mr->rom_device && mr->romd_mode;
466 467
}

A
Avi Kivity 已提交
468 469 470 471 472 473 474 475 476
/**
 * memory_region_is_iommu: check whether a memory region is an iommu
 *
 * Returns %true is a memory region is an iommu.
 *
 * @mr: the memory region being queried
 */
bool memory_region_is_iommu(MemoryRegion *mr);

477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
/**
 * memory_region_notify_iommu: notify a change in an IOMMU translation entry.
 *
 * @mr: the memory region that was changed
 * @entry: the new entry in the IOMMU translation table.  The entry
 *         replaces all old entries for the same virtual I/O address range.
 *         Deleted entries have .@perm == 0.
 */
void memory_region_notify_iommu(MemoryRegion *mr,
                                IOMMUTLBEntry entry);

/**
 * memory_region_register_iommu_notifier: register a notifier for changes to
 * IOMMU translation entries.
 *
 * @mr: the memory region to observe
 * @n: the notifier to be added; the notifier receives a pointer to an
 *     #IOMMUTLBEntry as the opaque value; the pointer ceases to be
 *     valid on exit from the notifier.
 */
void memory_region_register_iommu_notifier(MemoryRegion *mr, Notifier *n);

/**
 * memory_region_unregister_iommu_notifier: unregister a notifier for
 * changes to IOMMU translation entries.
 *
 * @n: the notifier to be removed.
 */
void memory_region_unregister_iommu_notifier(Notifier *n);

507 508 509 510 511 512 513
/**
 * memory_region_name: get a memory region's name
 *
 * Returns the string that was used to initialize the memory region.
 *
 * @mr: the memory region being queried
 */
514
const char *memory_region_name(const MemoryRegion *mr);
515

516 517 518 519 520 521 522 523 524
/**
 * memory_region_is_logging: return whether a memory region is logging writes
 *
 * Returns %true if the memory region is logging writes
 *
 * @mr: the memory region being queried
 */
bool memory_region_is_logging(MemoryRegion *mr);

A
Avi Kivity 已提交
525 526 527 528 529 530 531 532 533
/**
 * memory_region_is_rom: check whether a memory region is ROM
 *
 * Returns %true is a memory region is read-only memory.
 *
 * @mr: the memory region being queried
 */
bool memory_region_is_rom(MemoryRegion *mr);

534 535 536 537 538 539 540 541 542 543
/**
 * memory_region_get_fd: Get a file descriptor backing a RAM memory region.
 *
 * Returns a file descriptor backing a file-based RAM memory region,
 * or -1 if the region is not a file-based RAM memory region.
 *
 * @mr: the RAM or alias memory region being queried.
 */
int memory_region_get_fd(MemoryRegion *mr);

A
Avi Kivity 已提交
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
/**
 * memory_region_get_ram_ptr: Get a pointer into a RAM memory region.
 *
 * Returns a host pointer to a RAM memory region (created with
 * memory_region_init_ram() or memory_region_init_ram_ptr()).  Use with
 * care.
 *
 * @mr: the memory region being queried.
 */
void *memory_region_get_ram_ptr(MemoryRegion *mr);

/**
 * memory_region_set_log: Turn dirty logging on or off for a region.
 *
 * Turns dirty logging on or off for a specified client (display, migration).
 * Only meaningful for RAM regions.
 *
 * @mr: the memory region being updated.
 * @log: whether dirty logging is to be enabled or disabled.
 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
 *          %DIRTY_MEMORY_VGA.
 */
void memory_region_set_log(MemoryRegion *mr, bool log, unsigned client);

/**
569 570
 * memory_region_get_dirty: Check whether a range of bytes is dirty
 *                          for a specified client.
A
Avi Kivity 已提交
571
 *
572
 * Checks whether a range of bytes has been written to since the last
A
Avi Kivity 已提交
573 574 575 576 577
 * call to memory_region_reset_dirty() with the same @client.  Dirty logging
 * must be enabled.
 *
 * @mr: the memory region being queried.
 * @addr: the address (relative to the start of the region) being queried.
578
 * @size: the size of the range being queried.
A
Avi Kivity 已提交
579 580 581
 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
 *          %DIRTY_MEMORY_VGA.
 */
A
Avi Kivity 已提交
582 583
bool memory_region_get_dirty(MemoryRegion *mr, hwaddr addr,
                             hwaddr size, unsigned client);
A
Avi Kivity 已提交
584 585

/**
586
 * memory_region_set_dirty: Mark a range of bytes as dirty in a memory region.
A
Avi Kivity 已提交
587
 *
588 589
 * Marks a range of bytes as dirty, after it has been dirtied outside
 * guest code.
A
Avi Kivity 已提交
590
 *
591
 * @mr: the memory region being dirtied.
A
Avi Kivity 已提交
592
 * @addr: the address (relative to the start of the region) being dirtied.
593
 * @size: size of the range being dirtied.
A
Avi Kivity 已提交
594
 */
A
Avi Kivity 已提交
595 596
void memory_region_set_dirty(MemoryRegion *mr, hwaddr addr,
                             hwaddr size);
A
Avi Kivity 已提交
597

598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
/**
 * memory_region_test_and_clear_dirty: Check whether a range of bytes is dirty
 *                                     for a specified client. It clears them.
 *
 * Checks whether a range of bytes has been written to since the last
 * call to memory_region_reset_dirty() with the same @client.  Dirty logging
 * must be enabled.
 *
 * @mr: the memory region being queried.
 * @addr: the address (relative to the start of the region) being queried.
 * @size: the size of the range being queried.
 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
 *          %DIRTY_MEMORY_VGA.
 */
bool memory_region_test_and_clear_dirty(MemoryRegion *mr, hwaddr addr,
                                        hwaddr size, unsigned client);
A
Avi Kivity 已提交
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
/**
 * memory_region_sync_dirty_bitmap: Synchronize a region's dirty bitmap with
 *                                  any external TLBs (e.g. kvm)
 *
 * Flushes dirty information from accelerators such as kvm and vhost-net
 * and makes it available to users of the memory API.
 *
 * @mr: the region being flushed.
 */
void memory_region_sync_dirty_bitmap(MemoryRegion *mr);

/**
 * memory_region_reset_dirty: Mark a range of pages as clean, for a specified
 *                            client.
 *
 * Marks a range of pages as no longer dirty.
 *
 * @mr: the region being updated.
 * @addr: the start of the subrange being cleaned.
 * @size: the size of the subrange being cleaned.
 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
 *          %DIRTY_MEMORY_VGA.
 */
A
Avi Kivity 已提交
637 638
void memory_region_reset_dirty(MemoryRegion *mr, hwaddr addr,
                               hwaddr size, unsigned client);
A
Avi Kivity 已提交
639 640 641 642 643 644 645 646 647 648 649 650

/**
 * memory_region_set_readonly: Turn a memory region read-only (or read-write)
 *
 * Allows a memory region to be marked as read-only (turning it into a ROM).
 * only useful on RAM regions.
 *
 * @mr: the region being updated.
 * @readonly: whether rhe region is to be ROM or RAM.
 */
void memory_region_set_readonly(MemoryRegion *mr, bool readonly);

651
/**
652
 * memory_region_rom_device_set_romd: enable/disable ROMD mode
653 654
 *
 * Allows a ROM device (initialized with memory_region_init_rom_device() to
655 656 657 658
 * set to ROMD mode (default) or MMIO mode.  When it is in ROMD mode, the
 * device is mapped to guest memory and satisfies read access directly.
 * When in MMIO mode, reads are forwarded to the #MemoryRegion.read function.
 * Writes are always handled by the #MemoryRegion.write function.
659 660
 *
 * @mr: the memory region to be updated
661
 * @romd_mode: %true to put the region into ROMD mode
662
 */
663
void memory_region_rom_device_set_romd(MemoryRegion *mr, bool romd_mode);
664

A
Avi Kivity 已提交
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
/**
 * memory_region_set_coalescing: Enable memory coalescing for the region.
 *
 * Enabled writes to a region to be queued for later processing. MMIO ->write
 * callbacks may be delayed until a non-coalesced MMIO is issued.
 * Only useful for IO regions.  Roughly similar to write-combining hardware.
 *
 * @mr: the memory region to be write coalesced
 */
void memory_region_set_coalescing(MemoryRegion *mr);

/**
 * memory_region_add_coalescing: Enable memory coalescing for a sub-range of
 *                               a region.
 *
 * Like memory_region_set_coalescing(), but works on a sub-range of a region.
 * Multiple calls can be issued coalesced disjoint ranges.
 *
 * @mr: the memory region to be updated.
 * @offset: the start of the range within the region to be coalesced.
 * @size: the size of the subrange to be coalesced.
 */
void memory_region_add_coalescing(MemoryRegion *mr,
A
Avi Kivity 已提交
688
                                  hwaddr offset,
A
Avi Kivity 已提交
689 690 691 692 693 694 695 696 697 698 699 700 701
                                  uint64_t size);

/**
 * memory_region_clear_coalescing: Disable MMIO coalescing for the region.
 *
 * Disables any coalescing caused by memory_region_set_coalescing() or
 * memory_region_add_coalescing().  Roughly equivalent to uncacheble memory
 * hardware.
 *
 * @mr: the memory region to be updated.
 */
void memory_region_clear_coalescing(MemoryRegion *mr);

702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
/**
 * memory_region_set_flush_coalesced: Enforce memory coalescing flush before
 *                                    accesses.
 *
 * Ensure that pending coalesced MMIO request are flushed before the memory
 * region is accessed. This property is automatically enabled for all regions
 * passed to memory_region_set_coalescing() and memory_region_add_coalescing().
 *
 * @mr: the memory region to be updated.
 */
void memory_region_set_flush_coalesced(MemoryRegion *mr);

/**
 * memory_region_clear_flush_coalesced: Disable memory coalescing flush before
 *                                      accesses.
 *
 * Clear the automatic coalesced MMIO flushing enabled via
 * memory_region_set_flush_coalesced. Note that this service has no effect on
 * memory regions that have MMIO coalescing enabled for themselves. For them,
 * automatic flushing will stop once coalescing is disabled.
 *
 * @mr: the memory region to be updated.
 */
void memory_region_clear_flush_coalesced(MemoryRegion *mr);

A
Avi Kivity 已提交
727 728 729 730 731 732
/**
 * memory_region_add_eventfd: Request an eventfd to be triggered when a word
 *                            is written to a location.
 *
 * Marks a word in an IO region (initialized with memory_region_init_io())
 * as a trigger for an eventfd event.  The I/O callback will not be called.
733
 * The caller must be prepared to handle failure (that is, take the required
A
Avi Kivity 已提交
734 735 736 737 738 739 740 741 742 743
 * action if the callback _is_ called).
 *
 * @mr: the memory region being updated.
 * @addr: the address within @mr that is to be monitored
 * @size: the size of the access to trigger the eventfd
 * @match_data: whether to match against @data, instead of just @addr
 * @data: the data to match against the guest write
 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
 **/
void memory_region_add_eventfd(MemoryRegion *mr,
A
Avi Kivity 已提交
744
                               hwaddr addr,
A
Avi Kivity 已提交
745 746 747
                               unsigned size,
                               bool match_data,
                               uint64_t data,
748
                               EventNotifier *e);
A
Avi Kivity 已提交
749 750

/**
751
 * memory_region_del_eventfd: Cancel an eventfd.
A
Avi Kivity 已提交
752
 *
753 754
 * Cancels an eventfd trigger requested by a previous
 * memory_region_add_eventfd() call.
A
Avi Kivity 已提交
755 756 757 758 759 760 761 762 763
 *
 * @mr: the memory region being updated.
 * @addr: the address within @mr that is to be monitored
 * @size: the size of the access to trigger the eventfd
 * @match_data: whether to match against @data, instead of just @addr
 * @data: the data to match against the guest write
 * @fd: the eventfd to be triggered when @addr, @size, and @data all match.
 */
void memory_region_del_eventfd(MemoryRegion *mr,
A
Avi Kivity 已提交
764
                               hwaddr addr,
A
Avi Kivity 已提交
765 766 767
                               unsigned size,
                               bool match_data,
                               uint64_t data,
768 769
                               EventNotifier *e);

A
Avi Kivity 已提交
770
/**
771
 * memory_region_add_subregion: Add a subregion to a container.
A
Avi Kivity 已提交
772
 *
773
 * Adds a subregion at @offset.  The subregion may not overlap with other
A
Avi Kivity 已提交
774 775 776 777 778 779 780 781 782 783 784
 * subregions (except for those explicitly marked as overlapping).  A region
 * may only be added once as a subregion (unless removed with
 * memory_region_del_subregion()); use memory_region_init_alias() if you
 * want a region to be a subregion in multiple locations.
 *
 * @mr: the region to contain the new subregion; must be a container
 *      initialized with memory_region_init().
 * @offset: the offset relative to @mr where @subregion is added.
 * @subregion: the subregion to be added.
 */
void memory_region_add_subregion(MemoryRegion *mr,
A
Avi Kivity 已提交
785
                                 hwaddr offset,
A
Avi Kivity 已提交
786 787
                                 MemoryRegion *subregion);
/**
788 789
 * memory_region_add_subregion_overlap: Add a subregion to a container
 *                                      with overlap.
A
Avi Kivity 已提交
790
 *
791
 * Adds a subregion at @offset.  The subregion may overlap with other
A
Avi Kivity 已提交
792 793 794 795 796 797 798 799 800 801 802 803 804
 * subregions.  Conflicts are resolved by having a higher @priority hide a
 * lower @priority. Subregions without priority are taken as @priority 0.
 * A region may only be added once as a subregion (unless removed with
 * memory_region_del_subregion()); use memory_region_init_alias() if you
 * want a region to be a subregion in multiple locations.
 *
 * @mr: the region to contain the new subregion; must be a container
 *      initialized with memory_region_init().
 * @offset: the offset relative to @mr where @subregion is added.
 * @subregion: the subregion to be added.
 * @priority: used for resolving overlaps; highest priority wins.
 */
void memory_region_add_subregion_overlap(MemoryRegion *mr,
A
Avi Kivity 已提交
805
                                         hwaddr offset,
A
Avi Kivity 已提交
806
                                         MemoryRegion *subregion,
807
                                         int priority);
808 809 810 811 812

/**
 * memory_region_get_ram_addr: Get the ram address associated with a memory
 *                             region
 *
813
 * DO NOT USE THIS FUNCTION.  This is a temporary workaround while the Xen
814 815 816 817
 * code is being reworked.
 */
ram_addr_t memory_region_get_ram_addr(MemoryRegion *mr);

A
Avi Kivity 已提交
818 819 820 821 822 823 824 825 826 827 828
/**
 * memory_region_del_subregion: Remove a subregion.
 *
 * Removes a subregion from its container.
 *
 * @mr: the container to be updated.
 * @subregion: the region being removed; must be a current subregion of @mr.
 */
void memory_region_del_subregion(MemoryRegion *mr,
                                 MemoryRegion *subregion);

829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
/*
 * memory_region_set_enabled: dynamically enable or disable a region
 *
 * Enables or disables a memory region.  A disabled memory region
 * ignores all accesses to itself and its subregions.  It does not
 * obscure sibling subregions with lower priority - it simply behaves as
 * if it was removed from the hierarchy.
 *
 * Regions default to being enabled.
 *
 * @mr: the region to be updated
 * @enabled: whether to enable or disable the region
 */
void memory_region_set_enabled(MemoryRegion *mr, bool enabled);

844 845 846
/*
 * memory_region_set_address: dynamically update the address of a region
 *
847
 * Dynamically updates the address of a region, relative to its container.
848 849 850
 * May be used on regions are currently part of a memory hierarchy.
 *
 * @mr: the region to be updated
851
 * @addr: new address, relative to container region
852
 */
A
Avi Kivity 已提交
853
void memory_region_set_address(MemoryRegion *mr, hwaddr addr);
854

855 856 857 858 859 860 861 862 863 864
/*
 * memory_region_set_alias_offset: dynamically update a memory alias's offset
 *
 * Dynamically updates the offset into the target region that an alias points
 * to, as if the fourth argument to memory_region_init_alias() has changed.
 *
 * @mr: the #MemoryRegion to be updated; should be an alias.
 * @offset: the new offset into the target memory region
 */
void memory_region_set_alias_offset(MemoryRegion *mr,
A
Avi Kivity 已提交
865
                                    hwaddr offset);
866

867
/**
868 869
 * memory_region_present: checks if an address relative to a @container
 * translates into #MemoryRegion within @container
870
 *
871
 * Answer whether a #MemoryRegion within @container covers the address
872 873
 * @addr.
 *
874 875
 * @container: a #MemoryRegion within which @addr is a relative address
 * @addr: the area within @container to be searched
876
 */
877
bool memory_region_present(MemoryRegion *container, hwaddr addr);
878

879 880 881 882 883 884 885 886
/**
 * memory_region_is_mapped: returns true if #MemoryRegion is mapped
 * into any address space.
 *
 * @mr: a #MemoryRegion which should be checked if it's mapped
 */
bool memory_region_is_mapped(MemoryRegion *mr);

887
/**
888 889
 * memory_region_find: translate an address/size relative to a
 * MemoryRegion into a #MemoryRegionSection.
890
 *
891 892
 * Locates the first #MemoryRegion within @mr that overlaps the range
 * given by @addr and @size.
893 894 895 896 897 898
 *
 * Returns a #MemoryRegionSection that describes a contiguous overlap.
 * It will have the following characteristics:
 *    .@size = 0 iff no overlap was found
 *    .@mr is non-%NULL iff an overlap was found
 *
899 900 901 902 903 904 905
 * Remember that in the return value the @offset_within_region is
 * relative to the returned region (in the .@mr field), not to the
 * @mr argument.
 *
 * Similarly, the .@offset_within_address_space is relative to the
 * address space that contains both regions, the passed and the
 * returned one.  However, in the special case where the @mr argument
906
 * has no container (and thus is the root of the address space), the
907 908 909 910 911 912
 * following will hold:
 *    .@offset_within_address_space >= @addr
 *    .@offset_within_address_space + .@size <= @addr + @size
 *
 * @mr: a MemoryRegion within which @addr is a relative address
 * @addr: start of the area within @as to be searched
913 914
 * @size: size of the area to be searched
 */
915
MemoryRegionSection memory_region_find(MemoryRegion *mr,
A
Avi Kivity 已提交
916
                                       hwaddr addr, uint64_t size);
917

918
/**
919
 * address_space_sync_dirty_bitmap: synchronize the dirty log for all memory
920 921
 *
 * Synchronizes the dirty page log for an entire address space.
922
 * @as: the address space that contains the memory being synchronized
923
 */
924
void address_space_sync_dirty_bitmap(AddressSpace *as);
925

926 927 928 929
/**
 * memory_region_transaction_begin: Start a transaction.
 *
 * During a transaction, changes will be accumulated and made visible
930
 * only when the transaction ends (is committed).
A
Avi Kivity 已提交
931 932
 */
void memory_region_transaction_begin(void);
933 934 935 936

/**
 * memory_region_transaction_commit: Commit a transaction and make changes
 *                                   visible to the guest.
A
Avi Kivity 已提交
937 938 939
 */
void memory_region_transaction_commit(void);

940 941 942 943 944 945
/**
 * memory_listener_register: register callbacks to be called when memory
 *                           sections are mapped or unmapped into an address
 *                           space
 *
 * @listener: an object containing the callbacks to be called
946
 * @filter: if non-%NULL, only regions in this address space will be observed
947
 */
948
void memory_listener_register(MemoryListener *listener, AddressSpace *filter);
949 950 951 952 953 954 955 956 957 958 959 960 961 962

/**
 * memory_listener_unregister: undo the effect of memory_listener_register()
 *
 * @listener: an object containing the callbacks to be removed
 */
void memory_listener_unregister(MemoryListener *listener);

/**
 * memory_global_dirty_log_start: begin dirty logging for all regions
 */
void memory_global_dirty_log_start(void);

/**
963
 * memory_global_dirty_log_stop: end dirty logging for all regions
964 965 966
 */
void memory_global_dirty_log_stop(void);

B
Blue Swirl 已提交
967 968
void mtree_info(fprintf_function mon_printf, void *f);

A
Avi Kivity 已提交
969 970 971 972 973
/**
 * address_space_init: initializes an address space
 *
 * @as: an uninitialized #AddressSpace
 * @root: a #MemoryRegion that routes addesses for the address space
974 975
 * @name: an address space name.  The name is only used for debugging
 *        output.
A
Avi Kivity 已提交
976
 */
977
void address_space_init(AddressSpace *as, MemoryRegion *root, const char *name);
A
Avi Kivity 已提交
978

A
Avi Kivity 已提交
979 980 981 982 983 984 985 986 987 988 989 990

/**
 * address_space_destroy: destroy an address space
 *
 * Releases all resources associated with an address space.  After an address space
 * is destroyed, its root memory region (given by address_space_init()) may be destroyed
 * as well.
 *
 * @as: address space to be destroyed
 */
void address_space_destroy(AddressSpace *as);

A
Avi Kivity 已提交
991 992 993
/**
 * address_space_rw: read from or write to an address space.
 *
A
Avi Kivity 已提交
994 995
 * Return true if the operation hit any unassigned memory or encountered an
 * IOMMU fault.
996
 *
A
Avi Kivity 已提交
997 998 999 1000 1001
 * @as: #AddressSpace to be accessed
 * @addr: address within that address space
 * @buf: buffer with the data transferred
 * @is_write: indicates the transfer direction
 */
1002
bool address_space_rw(AddressSpace *as, hwaddr addr, uint8_t *buf,
A
Avi Kivity 已提交
1003 1004 1005 1006 1007
                      int len, bool is_write);

/**
 * address_space_write: write to address space.
 *
A
Avi Kivity 已提交
1008 1009
 * Return true if the operation hit any unassigned memory or encountered an
 * IOMMU fault.
1010
 *
A
Avi Kivity 已提交
1011 1012 1013 1014
 * @as: #AddressSpace to be accessed
 * @addr: address within that address space
 * @buf: buffer with the data transferred
 */
1015
bool address_space_write(AddressSpace *as, hwaddr addr,
A
Avi Kivity 已提交
1016 1017 1018 1019 1020
                         const uint8_t *buf, int len);

/**
 * address_space_read: read from an address space.
 *
A
Avi Kivity 已提交
1021 1022
 * Return true if the operation hit any unassigned memory or encountered an
 * IOMMU fault.
1023
 *
A
Avi Kivity 已提交
1024 1025 1026 1027
 * @as: #AddressSpace to be accessed
 * @addr: address within that address space
 * @buf: buffer with the data transferred
 */
1028
bool address_space_read(AddressSpace *as, hwaddr addr, uint8_t *buf, int len);
A
Avi Kivity 已提交
1029

1030
/* address_space_translate: translate an address range into an address space
1031
 * into a MemoryRegion and an address range into that section
1032 1033 1034 1035 1036 1037 1038 1039
 *
 * @as: #AddressSpace to be accessed
 * @addr: address within that address space
 * @xlat: pointer to address within the returned memory region section's
 * #MemoryRegion.
 * @len: pointer to length
 * @is_write: indicates the transfer direction
 */
1040 1041 1042
MemoryRegion *address_space_translate(AddressSpace *as, hwaddr addr,
                                      hwaddr *xlat, hwaddr *len,
                                      bool is_write);
1043

1044 1045 1046
/* address_space_access_valid: check for validity of accessing an address
 * space range
 *
A
Avi Kivity 已提交
1047 1048 1049
 * Check whether memory is assigned to the given address space range, and
 * access is permitted by any IOMMU regions that are active for the address
 * space.
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
 *
 * For now, addr and len should be aligned to a page size.  This limitation
 * will be lifted in the future.
 *
 * @as: #AddressSpace to be accessed
 * @addr: address within that address space
 * @len: length of the area to be checked
 * @is_write: indicates the transfer direction
 */
bool address_space_access_valid(AddressSpace *as, hwaddr addr, int len, bool is_write);

A
Avi Kivity 已提交
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
/* address_space_map: map a physical memory region into a host virtual address
 *
 * May map a subset of the requested range, given by and returned in @plen.
 * May return %NULL if resources needed to perform the mapping are exhausted.
 * Use only for reads OR writes - not for read-modify-write operations.
 * Use cpu_register_map_client() to know when retrying the map operation is
 * likely to succeed.
 *
 * @as: #AddressSpace to be accessed
 * @addr: address within that address space
 * @plen: pointer to length of buffer; updated on return
 * @is_write: indicates the transfer direction
 */
A
Avi Kivity 已提交
1074 1075
void *address_space_map(AddressSpace *as, hwaddr addr,
                        hwaddr *plen, bool is_write);
A
Avi Kivity 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087

/* address_space_unmap: Unmaps a memory region previously mapped by address_space_map()
 *
 * Will also mark the memory as dirty if @is_write == %true.  @access_len gives
 * the amount of memory that was actually read or written by the caller.
 *
 * @as: #AddressSpace used
 * @addr: address within that address space
 * @len: buffer length as returned by address_space_map()
 * @access_len: amount of data actually transferred
 * @is_write: indicates the transfer direction
 */
A
Avi Kivity 已提交
1088 1089
void address_space_unmap(AddressSpace *as, void *buffer, hwaddr len,
                         int is_write, hwaddr access_len);
A
Avi Kivity 已提交
1090 1091


A
Avi Kivity 已提交
1092 1093 1094
#endif

#endif