Statistics
| Branch: | Revision:

root / memory.h @ 1435ddb8

History | View | Annotate | Download (26.2 kB)

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
/* Internal use; thunks between old-style IORange and MemoryRegions. */
47
typedef struct MemoryRegionIORange MemoryRegionIORange;
48
struct MemoryRegionIORange {
49
    IORange iorange;
50
    MemoryRegion *mr;
51
    target_phys_addr_t offset;
52
};
53

    
54
/*
55
 * Memory region callbacks
56
 */
57
struct 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;
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);
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;
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;
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;
114
};
115

    
116
typedef struct CoalescedMemoryRange CoalescedMemoryRange;
117
typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd;
118

    
119
struct MemoryRegion {
120
    /* All fields are private - violators will be prosecuted */
121
    const MemoryRegionOps *ops;
122
    void *opaque;
123
    MemoryRegion *parent;
124
    Int128 size;
125
    target_phys_addr_t addr;
126
    void (*destructor)(MemoryRegion *mr);
127
    ram_addr_t ram_addr;
128
    bool subpage;
129
    bool terminates;
130
    bool readable;
131
    bool ram;
132
    bool readonly; /* For RAM regions */
133
    bool enabled;
134
    bool rom_device;
135
    bool warning_printed; /* For reservations */
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;
144
    uint8_t dirty_log_mask;
145
    unsigned ioeventfd_nb;
146
    MemoryRegionIoeventfd *ioeventfds;
147
};
148

    
149
struct MemoryRegionPortio {
150
    uint32_t offset;
151
    uint32_t len;
152
    unsigned size;
153
    IOPortReadFunc *read;
154
    IOPortWriteFunc *write;
155
};
156

    
157
#define PORTIO_END_OF_LIST() { }
158

    
159
typedef struct MemoryRegionSection MemoryRegionSection;
160

    
161
/**
162
 * MemoryRegionSection: describes a fragment of a #MemoryRegion
163
 *
164
 * @mr: the region, or %NULL if empty
165
 * @address_space: the address space the region is mapped in
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
170
 * @readonly: writes to this section are ignored
171
 */
172
struct MemoryRegionSection {
173
    MemoryRegion *mr;
174
    MemoryRegion *address_space;
175
    target_phys_addr_t offset_within_region;
176
    uint64_t size;
177
    target_phys_addr_t offset_within_address_space;
178
    bool readonly;
179
};
180

    
181
typedef 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
 */
189
struct MemoryListener {
190
    void (*begin)(MemoryListener *listener);
191
    void (*commit)(MemoryListener *listener);
192
    void (*region_add)(MemoryListener *listener, MemoryRegionSection *section);
193
    void (*region_del)(MemoryListener *listener, MemoryRegionSection *section);
194
    void (*region_nop)(MemoryListener *listener, MemoryRegionSection *section);
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);
200
    void (*eventfd_add)(MemoryListener *listener, MemoryRegionSection *section,
201
                        bool match_data, uint64_t data, EventNotifier *e);
202
    void (*eventfd_del)(MemoryListener *listener, MemoryRegionSection *section,
203
                        bool match_data, uint64_t data, EventNotifier *e);
204
    /* Lower = earlier (during add), later (during del) */
205
    unsigned priority;
206
    MemoryRegion *address_space_filter;
207
    QTAILQ_ENTRY(MemoryListener) link;
208
};
209

    
210
/**
211
 * memory_region_init: Initialize a memory region
212
 *
213
 * The region typically acts as a container for other memory regions.  Use
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
 */
220
void 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
 *
226
 * Accesses into the region will cause the callbacks in @ops to be called.
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
 */
236
void 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
244
 *                          region will modify memory directly.
245
 *
246
 * @mr: the #MemoryRegion to be initialized.
247
 * @name: the name of the region.
248
 * @size: size of the region.
249
 */
250
void memory_region_init_ram(MemoryRegion *mr,
251
                            const char *name,
252
                            uint64_t size);
253

    
254
/**
255
 * memory_region_init_ram:  Initialize RAM memory region from a user-provided.
256
 *                          pointer.  Accesses into the region will modify
257
 *                          memory directly.
258
 *
259
 * @mr: the #MemoryRegion to be initialized.
260
 * @name: the name of the region.
261
 * @size: size of the region.
262
 * @ptr: memory to be mapped; must contain at least @size bytes.
263
 */
264
void memory_region_init_ram_ptr(MemoryRegion *mr,
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
 */
280
void memory_region_init_alias(MemoryRegion *mr,
281
                              const char *name,
282
                              MemoryRegion *orig,
283
                              target_phys_addr_t offset,
284
                              uint64_t size);
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.
292
 * @name: the name of the region.
293
 * @size: size of the region.
294
 */
295
void memory_region_init_rom_device(MemoryRegion *mr,
296
                                   const MemoryRegionOps *ops,
297
                                   void *opaque,
298
                                   const char *name,
299
                                   uint64_t size);
300

    
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
 */
313
void memory_region_init_reservation(MemoryRegion *mr,
314
                                    const char *name,
315
                                    uint64_t size);
316
/**
317
 * memory_region_destroy: Destroy a memory region and reclaim all resources.
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
 */
323
void 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
 */
330
uint64_t memory_region_size(MemoryRegion *mr);
331

    
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
 */
339
bool memory_region_is_ram(MemoryRegion *mr);
340

    
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
 */
349
static inline bool memory_region_is_romd(MemoryRegion *mr)
350
{
351
    return mr->rom_device && mr->readable;
352
}
353

    
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
 */
361
const char *memory_region_name(MemoryRegion *mr);
362

    
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
 */
370
bool memory_region_is_logging(MemoryRegion *mr);
371

    
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
 */
379
bool memory_region_is_rom(MemoryRegion *mr);
380

    
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
 */
390
void *memory_region_get_ram_ptr(MemoryRegion *mr);
391

    
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
 */
403
void memory_region_set_log(MemoryRegion *mr, bool log, unsigned client);
404

    
405
/**
406
 * memory_region_get_dirty: Check whether a range of bytes is dirty
407
 *                          for a specified client.
408
 *
409
 * Checks whether a range of bytes has been written to since the last
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.
415
 * @size: the size of the range being queried.
416
 * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or
417
 *          %DIRTY_MEMORY_VGA.
418
 */
419
bool memory_region_get_dirty(MemoryRegion *mr, target_phys_addr_t addr,
420
                             target_phys_addr_t size, unsigned client);
421

    
422
/**
423
 * memory_region_set_dirty: Mark a range of bytes as dirty in a memory region.
424
 *
425
 * Marks a range of bytes as dirty, after it has been dirtied outside
426
 * guest code.
427
 *
428
 * @mr: the memory region being dirtied.
429
 * @addr: the address (relative to the start of the region) being dirtied.
430
 * @size: size of the range being dirtied.
431
 */
432
void memory_region_set_dirty(MemoryRegion *mr, target_phys_addr_t addr,
433
                             target_phys_addr_t size);
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
 */
444
void 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
 */
458
void 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
 */
470
void memory_region_set_readonly(MemoryRegion *mr, bool readonly);
471

    
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
 */
484
void memory_region_rom_device_set_readable(MemoryRegion *mr, bool readable);
485

    
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
 */
495
void 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
 */
508
void 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
 */
521
void memory_region_clear_coalescing(MemoryRegion *mr);
522

    
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.
529
 * The caller must be prepared to handle failure (that is, take the required
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
 **/
539
void memory_region_add_eventfd(MemoryRegion *mr,
540
                               target_phys_addr_t addr,
541
                               unsigned size,
542
                               bool match_data,
543
                               uint64_t data,
544
                               EventNotifier *e);
545

    
546
/**
547
 * memory_region_del_eventfd: Cancel an eventfd.
548
 *
549
 * Cancels an eventfd trigger requested by a previous
550
 * memory_region_add_eventfd() call.
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
 */
559
void memory_region_del_eventfd(MemoryRegion *mr,
560
                               target_phys_addr_t addr,
561
                               unsigned size,
562
                               bool match_data,
563
                               uint64_t data,
564
                               EventNotifier *e);
565

    
566
/**
567
 * memory_region_add_subregion: Add a subregion to a container.
568
 *
569
 * Adds a subregion at @offset.  The subregion may not overlap with other
570
 * subregions (except for those explicitly marked as overlapping).  A region
571
 * may only be added once as a subregion (unless removed with
572
 * memory_region_del_subregion()); use memory_region_init_alias() if you
573
 * want a region to be a subregion in multiple locations.
574
 *
575
 * @mr: the region to contain the new subregion; must be a container
576
 *      initialized with memory_region_init().
577
 * @offset: the offset relative to @mr where @subregion is added.
578
 * @subregion: the subregion to be added.
579
 */
580
void memory_region_add_subregion(MemoryRegion *mr,
581
                                 target_phys_addr_t offset,
582
                                 MemoryRegion *subregion);
583
/**
584
 * memory_region_add_subregion: Add a subregion to a container, with overlap.
585
 *
586
 * Adds a subregion at @offset.  The subregion may overlap with other
587
 * subregions.  Conflicts are resolved by having a higher @priority hide a
588
 * lower @priority. Subregions without priority are taken as @priority 0.
589
 * A region may only be added once as a subregion (unless removed with
590
 * memory_region_del_subregion()); use memory_region_init_alias() if you
591
 * want a region to be a subregion in multiple locations.
592
 *
593
 * @mr: the region to contain the new subregion; must be a container
594
 *      initialized with memory_region_init().
595
 * @offset: the offset relative to @mr where @subregion is added.
596
 * @subregion: the subregion to be added.
597
 * @priority: used for resolving overlaps; highest priority wins.
598
 */
599
void memory_region_add_subregion_overlap(MemoryRegion *mr,
600
                                         target_phys_addr_t offset,
601
                                         MemoryRegion *subregion,
602
                                         unsigned priority);
603

    
604
/**
605
 * memory_region_get_ram_addr: Get the ram address associated with a memory
606
 *                             region
607
 *
608
 * DO NOT USE THIS FUNCTION.  This is a temporary workaround while the Xen
609
 * code is being reworked.
610
 */
611
ram_addr_t memory_region_get_ram_addr(MemoryRegion *mr);
612

    
613
/**
614
 * memory_region_del_subregion: Remove a subregion.
615
 *
616
 * Removes a subregion from its container.
617
 *
618
 * @mr: the container to be updated.
619
 * @subregion: the region being removed; must be a current subregion of @mr.
620
 */
621
void memory_region_del_subregion(MemoryRegion *mr,
622
                                 MemoryRegion *subregion);
623

    
624
/*
625
 * memory_region_set_enabled: dynamically enable or disable a region
626
 *
627
 * Enables or disables a memory region.  A disabled memory region
628
 * ignores all accesses to itself and its subregions.  It does not
629
 * obscure sibling subregions with lower priority - it simply behaves as
630
 * if it was removed from the hierarchy.
631
 *
632
 * Regions default to being enabled.
633
 *
634
 * @mr: the region to be updated
635
 * @enabled: whether to enable or disable the region
636
 */
637
void memory_region_set_enabled(MemoryRegion *mr, bool enabled);
638

    
639
/*
640
 * memory_region_set_address: dynamically update the address of a region
641
 *
642
 * Dynamically updates the address of a region, relative to its parent.
643
 * May be used on regions are currently part of a memory hierarchy.
644
 *
645
 * @mr: the region to be updated
646
 * @addr: new address, relative to parent region
647
 */
648
void memory_region_set_address(MemoryRegion *mr, target_phys_addr_t addr);
649

    
650
/*
651
 * memory_region_set_alias_offset: dynamically update a memory alias's offset
652
 *
653
 * Dynamically updates the offset into the target region that an alias points
654
 * to, as if the fourth argument to memory_region_init_alias() has changed.
655
 *
656
 * @mr: the #MemoryRegion to be updated; should be an alias.
657
 * @offset: the new offset into the target memory region
658
 */
659
void memory_region_set_alias_offset(MemoryRegion *mr,
660
                                    target_phys_addr_t offset);
661

    
662
/**
663
 * memory_region_find: locate a MemoryRegion in an address space
664
 *
665
 * Locates the first #MemoryRegion within an address space given by
666
 * @address_space that overlaps the range given by @addr and @size.
667
 *
668
 * Returns a #MemoryRegionSection that describes a contiguous overlap.
669
 * It will have the following characteristics:
670
 *    .@offset_within_address_space >= @addr
671
 *    .@offset_within_address_space + .@size <= @addr + @size
672
 *    .@size = 0 iff no overlap was found
673
 *    .@mr is non-%NULL iff an overlap was found
674
 *
675
 * @address_space: a top-level (i.e. parentless) region that contains
676
 *       the region to be found
677
 * @addr: start of the area within @address_space to be searched
678
 * @size: size of the area to be searched
679
 */
680
MemoryRegionSection memory_region_find(MemoryRegion *address_space,
681
                                       target_phys_addr_t addr, uint64_t size);
682

    
683
/**
684
 * memory_region_section_addr: get offset within MemoryRegionSection
685
 *
686
 * Returns offset within MemoryRegionSection
687
 *
688
 * @section: the memory region section being queried
689
 * @addr: address in address space
690
 */
691
static inline target_phys_addr_t
692
memory_region_section_addr(MemoryRegionSection *section,
693
                           target_phys_addr_t addr)
694
{
695
    addr -= section->offset_within_address_space;
696
    addr += section->offset_within_region;
697
    return addr;
698
}
699

    
700
/**
701
 * memory_global_sync_dirty_bitmap: synchronize the dirty log for all memory
702
 *
703
 * Synchronizes the dirty page log for an entire address space.
704
 * @address_space: a top-level (i.e. parentless) region that contains the
705
 *       memory being synchronized
706
 */
707
void memory_global_sync_dirty_bitmap(MemoryRegion *address_space);
708

    
709
/**
710
 * memory_region_transaction_begin: Start a transaction.
711
 *
712
 * During a transaction, changes will be accumulated and made visible
713
 * only when the transaction ends (is committed).
714
 */
715
void memory_region_transaction_begin(void);
716

    
717
/**
718
 * memory_region_transaction_commit: Commit a transaction and make changes
719
 *                                   visible to the guest.
720
 */
721
void memory_region_transaction_commit(void);
722

    
723
/**
724
 * memory_listener_register: register callbacks to be called when memory
725
 *                           sections are mapped or unmapped into an address
726
 *                           space
727
 *
728
 * @listener: an object containing the callbacks to be called
729
 * @filter: if non-%NULL, only regions in this address space will be observed
730
 */
731
void memory_listener_register(MemoryListener *listener, MemoryRegion *filter);
732

    
733
/**
734
 * memory_listener_unregister: undo the effect of memory_listener_register()
735
 *
736
 * @listener: an object containing the callbacks to be removed
737
 */
738
void memory_listener_unregister(MemoryListener *listener);
739

    
740
/**
741
 * memory_global_dirty_log_start: begin dirty logging for all regions
742
 */
743
void memory_global_dirty_log_start(void);
744

    
745
/**
746
 * memory_global_dirty_log_stop: begin dirty logging for all regions
747
 */
748
void memory_global_dirty_log_stop(void);
749

    
750
void mtree_info(fprintf_function mon_printf, void *f);
751

    
752
#endif
753

    
754
#endif