]>
Commit | Line | Data |
---|---|---|
093bc2cd AK |
1 | /* |
2 | * Physical memory management API | |
3 | * | |
4 | * Copyright 2011 Red Hat, Inc. and/or its affiliates | |
5 | * | |
6 | * Authors: | |
7 | * Avi Kivity <avi@redhat.com> | |
8 | * | |
9 | * This work is licensed under the terms of the GNU GPL, version 2. See | |
10 | * the COPYING file in the top-level directory. | |
11 | * | |
12 | */ | |
13 | ||
14 | #ifndef MEMORY_H | |
15 | #define MEMORY_H | |
16 | ||
17 | #ifndef CONFIG_USER_ONLY | |
18 | ||
1ab4c8ce JQ |
19 | #define DIRTY_MEMORY_VGA 0 |
20 | #define DIRTY_MEMORY_CODE 1 | |
21 | #define DIRTY_MEMORY_MIGRATION 2 | |
22 | #define DIRTY_MEMORY_NUM 3 /* num of dirty bits */ | |
23 | ||
093bc2cd AK |
24 | #include <stdint.h> |
25 | #include <stdbool.h> | |
022c62cb | 26 | #include "exec/cpu-common.h" |
ce927ed9 | 27 | #ifndef CONFIG_USER_ONLY |
022c62cb | 28 | #include "exec/hwaddr.h" |
ce927ed9 | 29 | #endif |
cc05c43a | 30 | #include "exec/memattrs.h" |
1de7afc9 | 31 | #include "qemu/queue.h" |
1de7afc9 | 32 | #include "qemu/int128.h" |
06866575 | 33 | #include "qemu/notify.h" |
7f56e740 | 34 | #include "qapi/error.h" |
b4fefef9 | 35 | #include "qom/object.h" |
374f2981 | 36 | #include "qemu/rcu.h" |
093bc2cd | 37 | |
052e87b0 PB |
38 | #define MAX_PHYS_ADDR_SPACE_BITS 62 |
39 | #define MAX_PHYS_ADDR (((hwaddr)1 << MAX_PHYS_ADDR_SPACE_BITS) - 1) | |
40 | ||
b4fefef9 PC |
41 | #define TYPE_MEMORY_REGION "qemu:memory-region" |
42 | #define MEMORY_REGION(obj) \ | |
43 | OBJECT_CHECK(MemoryRegion, (obj), TYPE_MEMORY_REGION) | |
44 | ||
093bc2cd | 45 | typedef struct MemoryRegionOps MemoryRegionOps; |
74901c3b | 46 | typedef struct MemoryRegionMmio MemoryRegionMmio; |
093bc2cd | 47 | |
74901c3b AK |
48 | struct MemoryRegionMmio { |
49 | CPUReadMemoryFunc *read[3]; | |
50 | CPUWriteMemoryFunc *write[3]; | |
51 | }; | |
52 | ||
30951157 AK |
53 | typedef struct IOMMUTLBEntry IOMMUTLBEntry; |
54 | ||
55 | /* See address_space_translate: bit 0 is read, bit 1 is write. */ | |
56 | typedef enum { | |
57 | IOMMU_NONE = 0, | |
58 | IOMMU_RO = 1, | |
59 | IOMMU_WO = 2, | |
60 | IOMMU_RW = 3, | |
61 | } IOMMUAccessFlags; | |
62 | ||
63 | struct IOMMUTLBEntry { | |
64 | AddressSpace *target_as; | |
65 | hwaddr iova; | |
66 | hwaddr translated_addr; | |
67 | hwaddr addr_mask; /* 0xfff = 4k translation */ | |
68 | IOMMUAccessFlags perm; | |
69 | }; | |
70 | ||
cc05c43a PM |
71 | /* New-style MMIO accessors can indicate that the transaction failed. |
72 | * A zero (MEMTX_OK) response means success; anything else is a failure | |
73 | * of some kind. The memory subsystem will bitwise-OR together results | |
74 | * if it is synthesizing an operation from multiple smaller accesses. | |
75 | */ | |
76 | #define MEMTX_OK 0 | |
77 | #define MEMTX_ERROR (1U << 0) /* device returned an error */ | |
78 | #define MEMTX_DECODE_ERROR (1U << 1) /* nothing at that address */ | |
79 | typedef uint32_t MemTxResult; | |
80 | ||
093bc2cd AK |
81 | /* |
82 | * Memory region callbacks | |
83 | */ | |
84 | struct MemoryRegionOps { | |
85 | /* Read from the memory region. @addr is relative to @mr; @size is | |
86 | * in bytes. */ | |
87 | uint64_t (*read)(void *opaque, | |
a8170e5e | 88 | hwaddr addr, |
093bc2cd AK |
89 | unsigned size); |
90 | /* Write to the memory region. @addr is relative to @mr; @size is | |
91 | * in bytes. */ | |
92 | void (*write)(void *opaque, | |
a8170e5e | 93 | hwaddr addr, |
093bc2cd AK |
94 | uint64_t data, |
95 | unsigned size); | |
96 | ||
cc05c43a PM |
97 | MemTxResult (*read_with_attrs)(void *opaque, |
98 | hwaddr addr, | |
99 | uint64_t *data, | |
100 | unsigned size, | |
101 | MemTxAttrs attrs); | |
102 | MemTxResult (*write_with_attrs)(void *opaque, | |
103 | hwaddr addr, | |
104 | uint64_t data, | |
105 | unsigned size, | |
106 | MemTxAttrs attrs); | |
107 | ||
093bc2cd AK |
108 | enum device_endian endianness; |
109 | /* Guest-visible constraints: */ | |
110 | struct { | |
111 | /* If nonzero, specify bounds on access sizes beyond which a machine | |
112 | * check is thrown. | |
113 | */ | |
114 | unsigned min_access_size; | |
115 | unsigned max_access_size; | |
116 | /* If true, unaligned accesses are supported. Otherwise unaligned | |
117 | * accesses throw machine checks. | |
118 | */ | |
119 | bool unaligned; | |
897fa7cf AK |
120 | /* |
121 | * If present, and returns #false, the transaction is not accepted | |
122 | * by the device (and results in machine dependent behaviour such | |
123 | * as a machine check exception). | |
124 | */ | |
a8170e5e | 125 | bool (*accepts)(void *opaque, hwaddr addr, |
897fa7cf | 126 | unsigned size, bool is_write); |
093bc2cd AK |
127 | } valid; |
128 | /* Internal implementation constraints: */ | |
129 | struct { | |
130 | /* If nonzero, specifies the minimum size implemented. Smaller sizes | |
131 | * will be rounded upwards and a partial result will be returned. | |
132 | */ | |
133 | unsigned min_access_size; | |
134 | /* If nonzero, specifies the maximum size implemented. Larger sizes | |
135 | * will be done as a series of accesses with smaller sizes. | |
136 | */ | |
137 | unsigned max_access_size; | |
138 | /* If true, unaligned accesses are supported. Otherwise all accesses | |
139 | * are converted to (possibly multiple) naturally aligned accesses. | |
140 | */ | |
edc1ba7a | 141 | bool unaligned; |
093bc2cd | 142 | } impl; |
627a0e90 | 143 | |
74901c3b AK |
144 | /* If .read and .write are not present, old_mmio may be used for |
145 | * backwards compatibility with old mmio registration | |
146 | */ | |
147 | const MemoryRegionMmio old_mmio; | |
093bc2cd AK |
148 | }; |
149 | ||
30951157 AK |
150 | typedef struct MemoryRegionIOMMUOps MemoryRegionIOMMUOps; |
151 | ||
152 | struct MemoryRegionIOMMUOps { | |
153 | /* Return a TLB entry that contains a given address. */ | |
8d7b8cb9 | 154 | IOMMUTLBEntry (*translate)(MemoryRegion *iommu, hwaddr addr, bool is_write); |
30951157 AK |
155 | }; |
156 | ||
093bc2cd | 157 | typedef struct CoalescedMemoryRange CoalescedMemoryRange; |
3e9d69e7 | 158 | typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd; |
093bc2cd AK |
159 | |
160 | struct MemoryRegion { | |
b4fefef9 | 161 | Object parent_obj; |
093bc2cd AK |
162 | /* All fields are private - violators will be prosecuted */ |
163 | const MemoryRegionOps *ops; | |
30951157 | 164 | const MemoryRegionIOMMUOps *iommu_ops; |
093bc2cd | 165 | void *opaque; |
feca4ac1 | 166 | MemoryRegion *container; |
08dafab4 | 167 | Int128 size; |
a8170e5e | 168 | hwaddr addr; |
545e92e0 | 169 | void (*destructor)(MemoryRegion *mr); |
093bc2cd | 170 | ram_addr_t ram_addr; |
a2b257d6 | 171 | uint64_t align; |
b3b00c78 | 172 | bool subpage; |
14a3c10a | 173 | bool terminates; |
5f9a5ea1 | 174 | bool romd_mode; |
8ea9252a | 175 | bool ram; |
e4dc3f59 | 176 | bool skip_dump; |
fb1cd6f9 | 177 | bool readonly; /* For RAM regions */ |
6bba19ba | 178 | bool enabled; |
75c578dc | 179 | bool rom_device; |
1660e72d | 180 | bool warning_printed; /* For reservations */ |
d410515e | 181 | bool flush_coalesced_mmio; |
196ea131 | 182 | bool global_locking; |
deb809ed | 183 | uint8_t vga_logging_count; |
093bc2cd | 184 | MemoryRegion *alias; |
a8170e5e | 185 | hwaddr alias_offset; |
d33382da | 186 | int32_t priority; |
093bc2cd AK |
187 | bool may_overlap; |
188 | QTAILQ_HEAD(subregions, MemoryRegion) subregions; | |
189 | QTAILQ_ENTRY(MemoryRegion) subregions_link; | |
190 | QTAILQ_HEAD(coalesced_ranges, CoalescedMemoryRange) coalesced; | |
302fa283 | 191 | const char *name; |
5a583347 | 192 | uint8_t dirty_log_mask; |
3e9d69e7 AK |
193 | unsigned ioeventfd_nb; |
194 | MemoryRegionIoeventfd *ioeventfds; | |
06866575 | 195 | NotifierList iommu_notify; |
093bc2cd AK |
196 | }; |
197 | ||
c2fc83e8 PB |
198 | /** |
199 | * MemoryListener: callbacks structure for updates to the physical memory map | |
200 | * | |
201 | * Allows a component to adjust to changes in the guest-visible memory map. | |
202 | * Use with memory_listener_register() and memory_listener_unregister(). | |
203 | */ | |
204 | struct MemoryListener { | |
205 | void (*begin)(MemoryListener *listener); | |
206 | void (*commit)(MemoryListener *listener); | |
207 | void (*region_add)(MemoryListener *listener, MemoryRegionSection *section); | |
208 | void (*region_del)(MemoryListener *listener, MemoryRegionSection *section); | |
209 | void (*region_nop)(MemoryListener *listener, MemoryRegionSection *section); | |
b2dfd71c PB |
210 | void (*log_start)(MemoryListener *listener, MemoryRegionSection *section, |
211 | int old, int new); | |
212 | void (*log_stop)(MemoryListener *listener, MemoryRegionSection *section, | |
213 | int old, int new); | |
c2fc83e8 PB |
214 | void (*log_sync)(MemoryListener *listener, MemoryRegionSection *section); |
215 | void (*log_global_start)(MemoryListener *listener); | |
216 | void (*log_global_stop)(MemoryListener *listener); | |
217 | void (*eventfd_add)(MemoryListener *listener, MemoryRegionSection *section, | |
218 | bool match_data, uint64_t data, EventNotifier *e); | |
219 | void (*eventfd_del)(MemoryListener *listener, MemoryRegionSection *section, | |
220 | bool match_data, uint64_t data, EventNotifier *e); | |
221 | void (*coalesced_mmio_add)(MemoryListener *listener, MemoryRegionSection *section, | |
222 | hwaddr addr, hwaddr len); | |
223 | void (*coalesced_mmio_del)(MemoryListener *listener, MemoryRegionSection *section, | |
224 | hwaddr addr, hwaddr len); | |
225 | /* Lower = earlier (during add), later (during del) */ | |
226 | unsigned priority; | |
227 | AddressSpace *address_space_filter; | |
228 | QTAILQ_ENTRY(MemoryListener) link; | |
229 | }; | |
230 | ||
9ad2bbc1 AK |
231 | /** |
232 | * AddressSpace: describes a mapping of addresses to #MemoryRegion objects | |
233 | */ | |
234 | struct AddressSpace { | |
235 | /* All fields are private. */ | |
374f2981 | 236 | struct rcu_head rcu; |
7dca8043 | 237 | char *name; |
9ad2bbc1 | 238 | MemoryRegion *root; |
374f2981 PB |
239 | |
240 | /* Accessed via RCU. */ | |
9ad2bbc1 | 241 | struct FlatView *current_map; |
374f2981 | 242 | |
9ad2bbc1 AK |
243 | int ioeventfd_nb; |
244 | struct MemoryRegionIoeventfd *ioeventfds; | |
ac1970fb | 245 | struct AddressSpaceDispatch *dispatch; |
00752703 | 246 | struct AddressSpaceDispatch *next_dispatch; |
89ae337a PB |
247 | MemoryListener dispatch_listener; |
248 | ||
0d673e36 | 249 | QTAILQ_ENTRY(AddressSpace) address_spaces_link; |
9ad2bbc1 AK |
250 | }; |
251 | ||
e2177955 AK |
252 | /** |
253 | * MemoryRegionSection: describes a fragment of a #MemoryRegion | |
254 | * | |
255 | * @mr: the region, or %NULL if empty | |
7664e80c | 256 | * @address_space: the address space the region is mapped in |
e2177955 AK |
257 | * @offset_within_region: the beginning of the section, relative to @mr's start |
258 | * @size: the size of the section; will not exceed @mr's boundaries | |
259 | * @offset_within_address_space: the address of the first byte of the section | |
260 | * relative to the region's address space | |
7a8499e8 | 261 | * @readonly: writes to this section are ignored |
e2177955 AK |
262 | */ |
263 | struct MemoryRegionSection { | |
264 | MemoryRegion *mr; | |
f6790af6 | 265 | AddressSpace *address_space; |
a8170e5e | 266 | hwaddr offset_within_region; |
052e87b0 | 267 | Int128 size; |
a8170e5e | 268 | hwaddr offset_within_address_space; |
7a8499e8 | 269 | bool readonly; |
e2177955 AK |
270 | }; |
271 | ||
093bc2cd AK |
272 | /** |
273 | * memory_region_init: Initialize a memory region | |
274 | * | |
69ddaf66 | 275 | * The region typically acts as a container for other memory regions. Use |
093bc2cd AK |
276 | * memory_region_add_subregion() to add subregions. |
277 | * | |
278 | * @mr: the #MemoryRegion to be initialized | |
2c9b15ca | 279 | * @owner: the object that tracks the region's reference count |
093bc2cd AK |
280 | * @name: used for debugging; not visible to the user or ABI |
281 | * @size: size of the region; any subregions beyond this size will be clipped | |
282 | */ | |
283 | void memory_region_init(MemoryRegion *mr, | |
2c9b15ca | 284 | struct Object *owner, |
093bc2cd AK |
285 | const char *name, |
286 | uint64_t size); | |
46637be2 PB |
287 | |
288 | /** | |
289 | * memory_region_ref: Add 1 to a memory region's reference count | |
290 | * | |
291 | * Whenever memory regions are accessed outside the BQL, they need to be | |
292 | * preserved against hot-unplug. MemoryRegions actually do not have their | |
293 | * own reference count; they piggyback on a QOM object, their "owner". | |
294 | * This function adds a reference to the owner. | |
295 | * | |
296 | * All MemoryRegions must have an owner if they can disappear, even if the | |
297 | * device they belong to operates exclusively under the BQL. This is because | |
298 | * the region could be returned at any time by memory_region_find, and this | |
299 | * is usually under guest control. | |
300 | * | |
301 | * @mr: the #MemoryRegion | |
302 | */ | |
303 | void memory_region_ref(MemoryRegion *mr); | |
304 | ||
305 | /** | |
306 | * memory_region_unref: Remove 1 to a memory region's reference count | |
307 | * | |
308 | * Whenever memory regions are accessed outside the BQL, they need to be | |
309 | * preserved against hot-unplug. MemoryRegions actually do not have their | |
310 | * own reference count; they piggyback on a QOM object, their "owner". | |
311 | * This function removes a reference to the owner and possibly destroys it. | |
312 | * | |
313 | * @mr: the #MemoryRegion | |
314 | */ | |
315 | void memory_region_unref(MemoryRegion *mr); | |
316 | ||
093bc2cd AK |
317 | /** |
318 | * memory_region_init_io: Initialize an I/O memory region. | |
319 | * | |
69ddaf66 | 320 | * Accesses into the region will cause the callbacks in @ops to be called. |
093bc2cd AK |
321 | * if @size is nonzero, subregions will be clipped to @size. |
322 | * | |
323 | * @mr: the #MemoryRegion to be initialized. | |
2c9b15ca | 324 | * @owner: the object that tracks the region's reference count |
093bc2cd AK |
325 | * @ops: a structure containing read and write callbacks to be used when |
326 | * I/O is performed on the region. | |
b6af0975 | 327 | * @opaque: passed to the read and write callbacks of the @ops structure. |
093bc2cd AK |
328 | * @name: used for debugging; not visible to the user or ABI |
329 | * @size: size of the region. | |
330 | */ | |
331 | void memory_region_init_io(MemoryRegion *mr, | |
2c9b15ca | 332 | struct Object *owner, |
093bc2cd AK |
333 | const MemoryRegionOps *ops, |
334 | void *opaque, | |
335 | const char *name, | |
336 | uint64_t size); | |
337 | ||
338 | /** | |
339 | * memory_region_init_ram: Initialize RAM memory region. Accesses into the | |
69ddaf66 | 340 | * region will modify memory directly. |
093bc2cd AK |
341 | * |
342 | * @mr: the #MemoryRegion to be initialized. | |
2c9b15ca | 343 | * @owner: the object that tracks the region's reference count |
c5705a77 | 344 | * @name: the name of the region. |
093bc2cd | 345 | * @size: size of the region. |
49946538 | 346 | * @errp: pointer to Error*, to store an error if it happens. |
093bc2cd AK |
347 | */ |
348 | void memory_region_init_ram(MemoryRegion *mr, | |
2c9b15ca | 349 | struct Object *owner, |
093bc2cd | 350 | const char *name, |
49946538 HT |
351 | uint64_t size, |
352 | Error **errp); | |
093bc2cd | 353 | |
60786ef3 MT |
354 | /** |
355 | * memory_region_init_resizeable_ram: Initialize memory region with resizeable | |
356 | * RAM. Accesses into the region will | |
357 | * modify memory directly. Only an initial | |
358 | * portion of this RAM is actually used. | |
359 | * The used size can change across reboots. | |
360 | * | |
361 | * @mr: the #MemoryRegion to be initialized. | |
362 | * @owner: the object that tracks the region's reference count | |
363 | * @name: the name of the region. | |
364 | * @size: used size of the region. | |
365 | * @max_size: max size of the region. | |
366 | * @resized: callback to notify owner about used size change. | |
367 | * @errp: pointer to Error*, to store an error if it happens. | |
368 | */ | |
369 | void memory_region_init_resizeable_ram(MemoryRegion *mr, | |
370 | struct Object *owner, | |
371 | const char *name, | |
372 | uint64_t size, | |
373 | uint64_t max_size, | |
374 | void (*resized)(const char*, | |
375 | uint64_t length, | |
376 | void *host), | |
377 | Error **errp); | |
0b183fc8 PB |
378 | #ifdef __linux__ |
379 | /** | |
380 | * memory_region_init_ram_from_file: Initialize RAM memory region with a | |
381 | * mmap-ed backend. | |
382 | * | |
383 | * @mr: the #MemoryRegion to be initialized. | |
384 | * @owner: the object that tracks the region's reference count | |
385 | * @name: the name of the region. | |
386 | * @size: size of the region. | |
dbcb8981 | 387 | * @share: %true if memory must be mmaped with the MAP_SHARED flag |
0b183fc8 | 388 | * @path: the path in which to allocate the RAM. |
7f56e740 | 389 | * @errp: pointer to Error*, to store an error if it happens. |
0b183fc8 PB |
390 | */ |
391 | void memory_region_init_ram_from_file(MemoryRegion *mr, | |
392 | struct Object *owner, | |
393 | const char *name, | |
394 | uint64_t size, | |
dbcb8981 | 395 | bool share, |
7f56e740 PB |
396 | const char *path, |
397 | Error **errp); | |
0b183fc8 PB |
398 | #endif |
399 | ||
093bc2cd | 400 | /** |
1a7e8cae BZ |
401 | * memory_region_init_ram_ptr: Initialize RAM memory region from a |
402 | * user-provided pointer. Accesses into the | |
403 | * region will modify memory directly. | |
093bc2cd AK |
404 | * |
405 | * @mr: the #MemoryRegion to be initialized. | |
2c9b15ca | 406 | * @owner: the object that tracks the region's reference count |
c5705a77 | 407 | * @name: the name of the region. |
093bc2cd AK |
408 | * @size: size of the region. |
409 | * @ptr: memory to be mapped; must contain at least @size bytes. | |
410 | */ | |
411 | void memory_region_init_ram_ptr(MemoryRegion *mr, | |
2c9b15ca | 412 | struct Object *owner, |
093bc2cd AK |
413 | const char *name, |
414 | uint64_t size, | |
415 | void *ptr); | |
416 | ||
417 | /** | |
418 | * memory_region_init_alias: Initialize a memory region that aliases all or a | |
419 | * part of another memory region. | |
420 | * | |
421 | * @mr: the #MemoryRegion to be initialized. | |
2c9b15ca | 422 | * @owner: the object that tracks the region's reference count |
093bc2cd AK |
423 | * @name: used for debugging; not visible to the user or ABI |
424 | * @orig: the region to be referenced; @mr will be equivalent to | |
425 | * @orig between @offset and @offset + @size - 1. | |
426 | * @offset: start of the section in @orig to be referenced. | |
427 | * @size: size of the region. | |
428 | */ | |
429 | void memory_region_init_alias(MemoryRegion *mr, | |
2c9b15ca | 430 | struct Object *owner, |
093bc2cd AK |
431 | const char *name, |
432 | MemoryRegion *orig, | |
a8170e5e | 433 | hwaddr offset, |
093bc2cd | 434 | uint64_t size); |
d0a9b5bc AK |
435 | |
436 | /** | |
437 | * memory_region_init_rom_device: Initialize a ROM memory region. Writes are | |
438 | * handled via callbacks. | |
439 | * | |
6d6d2abf PF |
440 | * If NULL callbacks pointer is given, then I/O space is not supposed to be |
441 | * handled by QEMU itself. Any access via the memory API will cause an abort(). | |
442 | * | |
d0a9b5bc | 443 | * @mr: the #MemoryRegion to be initialized. |
2c9b15ca | 444 | * @owner: the object that tracks the region's reference count |
d0a9b5bc | 445 | * @ops: callbacks for write access handling. |
c5705a77 | 446 | * @name: the name of the region. |
d0a9b5bc | 447 | * @size: size of the region. |
33e0eb52 | 448 | * @errp: pointer to Error*, to store an error if it happens. |
d0a9b5bc AK |
449 | */ |
450 | void memory_region_init_rom_device(MemoryRegion *mr, | |
2c9b15ca | 451 | struct Object *owner, |
d0a9b5bc | 452 | const MemoryRegionOps *ops, |
75f5941c | 453 | void *opaque, |
d0a9b5bc | 454 | const char *name, |
33e0eb52 HT |
455 | uint64_t size, |
456 | Error **errp); | |
d0a9b5bc | 457 | |
1660e72d JK |
458 | /** |
459 | * memory_region_init_reservation: Initialize a memory region that reserves | |
460 | * I/O space. | |
461 | * | |
462 | * A reservation region primariy serves debugging purposes. It claims I/O | |
463 | * space that is not supposed to be handled by QEMU itself. Any access via | |
464 | * the memory API will cause an abort(). | |
6d6d2abf PF |
465 | * This function is deprecated. Use memory_region_init_io() with NULL |
466 | * callbacks instead. | |
1660e72d JK |
467 | * |
468 | * @mr: the #MemoryRegion to be initialized | |
2c9b15ca | 469 | * @owner: the object that tracks the region's reference count |
1660e72d JK |
470 | * @name: used for debugging; not visible to the user or ABI |
471 | * @size: size of the region. | |
472 | */ | |
6d6d2abf PF |
473 | static inline void memory_region_init_reservation(MemoryRegion *mr, |
474 | Object *owner, | |
1660e72d | 475 | const char *name, |
6d6d2abf PF |
476 | uint64_t size) |
477 | { | |
478 | memory_region_init_io(mr, owner, NULL, mr, name, size); | |
479 | } | |
30951157 AK |
480 | |
481 | /** | |
482 | * memory_region_init_iommu: Initialize a memory region that translates | |
483 | * addresses | |
484 | * | |
485 | * An IOMMU region translates addresses and forwards accesses to a target | |
486 | * memory region. | |
487 | * | |
488 | * @mr: the #MemoryRegion to be initialized | |
2c9b15ca | 489 | * @owner: the object that tracks the region's reference count |
30951157 AK |
490 | * @ops: a function that translates addresses into the @target region |
491 | * @name: used for debugging; not visible to the user or ABI | |
492 | * @size: size of the region. | |
493 | */ | |
494 | void memory_region_init_iommu(MemoryRegion *mr, | |
2c9b15ca | 495 | struct Object *owner, |
30951157 AK |
496 | const MemoryRegionIOMMUOps *ops, |
497 | const char *name, | |
498 | uint64_t size); | |
499 | ||
803c0816 PB |
500 | /** |
501 | * memory_region_owner: get a memory region's owner. | |
502 | * | |
503 | * @mr: the memory region being queried. | |
504 | */ | |
505 | struct Object *memory_region_owner(MemoryRegion *mr); | |
506 | ||
093bc2cd AK |
507 | /** |
508 | * memory_region_size: get a memory region's size. | |
509 | * | |
510 | * @mr: the memory region being queried. | |
511 | */ | |
512 | uint64_t memory_region_size(MemoryRegion *mr); | |
513 | ||
8ea9252a AK |
514 | /** |
515 | * memory_region_is_ram: check whether a memory region is random access | |
516 | * | |
517 | * Returns %true is a memory region is random access. | |
518 | * | |
519 | * @mr: the memory region being queried | |
520 | */ | |
521 | bool memory_region_is_ram(MemoryRegion *mr); | |
522 | ||
e4dc3f59 ND |
523 | /** |
524 | * memory_region_is_skip_dump: check whether a memory region should not be | |
525 | * dumped | |
526 | * | |
527 | * Returns %true is a memory region should not be dumped(e.g. VFIO BAR MMAP). | |
528 | * | |
529 | * @mr: the memory region being queried | |
530 | */ | |
531 | bool memory_region_is_skip_dump(MemoryRegion *mr); | |
532 | ||
533 | /** | |
534 | * memory_region_set_skip_dump: Set skip_dump flag, dump will ignore this memory | |
535 | * region | |
536 | * | |
537 | * @mr: the memory region being queried | |
538 | */ | |
539 | void memory_region_set_skip_dump(MemoryRegion *mr); | |
540 | ||
fd062573 | 541 | /** |
5f9a5ea1 | 542 | * memory_region_is_romd: check whether a memory region is in ROMD mode |
fd062573 | 543 | * |
5f9a5ea1 | 544 | * Returns %true if a memory region is a ROM device and currently set to allow |
fd062573 BS |
545 | * direct reads. |
546 | * | |
547 | * @mr: the memory region being queried | |
548 | */ | |
549 | static inline bool memory_region_is_romd(MemoryRegion *mr) | |
550 | { | |
5f9a5ea1 | 551 | return mr->rom_device && mr->romd_mode; |
fd062573 BS |
552 | } |
553 | ||
30951157 AK |
554 | /** |
555 | * memory_region_is_iommu: check whether a memory region is an iommu | |
556 | * | |
557 | * Returns %true is a memory region is an iommu. | |
558 | * | |
559 | * @mr: the memory region being queried | |
560 | */ | |
561 | bool memory_region_is_iommu(MemoryRegion *mr); | |
562 | ||
06866575 DG |
563 | /** |
564 | * memory_region_notify_iommu: notify a change in an IOMMU translation entry. | |
565 | * | |
566 | * @mr: the memory region that was changed | |
567 | * @entry: the new entry in the IOMMU translation table. The entry | |
568 | * replaces all old entries for the same virtual I/O address range. | |
569 | * Deleted entries have .@perm == 0. | |
570 | */ | |
571 | void memory_region_notify_iommu(MemoryRegion *mr, | |
572 | IOMMUTLBEntry entry); | |
573 | ||
574 | /** | |
575 | * memory_region_register_iommu_notifier: register a notifier for changes to | |
576 | * IOMMU translation entries. | |
577 | * | |
578 | * @mr: the memory region to observe | |
579 | * @n: the notifier to be added; the notifier receives a pointer to an | |
580 | * #IOMMUTLBEntry as the opaque value; the pointer ceases to be | |
581 | * valid on exit from the notifier. | |
582 | */ | |
583 | void memory_region_register_iommu_notifier(MemoryRegion *mr, Notifier *n); | |
584 | ||
a788f227 DG |
585 | /** |
586 | * memory_region_iommu_replay: replay existing IOMMU translations to | |
587 | * a notifier | |
588 | * | |
589 | * @mr: the memory region to observe | |
590 | * @n: the notifier to which to replay iommu mappings | |
591 | * @granularity: Minimum page granularity to replay notifications for | |
592 | * @is_write: Whether to treat the replay as a translate "write" | |
593 | * through the iommu | |
594 | */ | |
595 | void memory_region_iommu_replay(MemoryRegion *mr, Notifier *n, | |
596 | hwaddr granularity, bool is_write); | |
597 | ||
06866575 DG |
598 | /** |
599 | * memory_region_unregister_iommu_notifier: unregister a notifier for | |
600 | * changes to IOMMU translation entries. | |
601 | * | |
602 | * @n: the notifier to be removed. | |
603 | */ | |
604 | void memory_region_unregister_iommu_notifier(Notifier *n); | |
605 | ||
8991c79b AK |
606 | /** |
607 | * memory_region_name: get a memory region's name | |
608 | * | |
609 | * Returns the string that was used to initialize the memory region. | |
610 | * | |
611 | * @mr: the memory region being queried | |
612 | */ | |
5d546d4b | 613 | const char *memory_region_name(const MemoryRegion *mr); |
8991c79b | 614 | |
55043ba3 AK |
615 | /** |
616 | * memory_region_is_logging: return whether a memory region is logging writes | |
617 | * | |
2d1a35be | 618 | * Returns %true if the memory region is logging writes for the given client |
55043ba3 AK |
619 | * |
620 | * @mr: the memory region being queried | |
2d1a35be | 621 | * @client: the client being queried |
55043ba3 | 622 | */ |
2d1a35be PB |
623 | bool memory_region_is_logging(MemoryRegion *mr, uint8_t client); |
624 | ||
625 | /** | |
626 | * memory_region_get_dirty_log_mask: return the clients for which a | |
627 | * memory region is logging writes. | |
628 | * | |
677e7805 PB |
629 | * Returns a bitmap of clients, in which the DIRTY_MEMORY_* constants |
630 | * are the bit indices. | |
2d1a35be PB |
631 | * |
632 | * @mr: the memory region being queried | |
633 | */ | |
634 | uint8_t memory_region_get_dirty_log_mask(MemoryRegion *mr); | |
55043ba3 | 635 | |
ce7923da AK |
636 | /** |
637 | * memory_region_is_rom: check whether a memory region is ROM | |
638 | * | |
639 | * Returns %true is a memory region is read-only memory. | |
640 | * | |
641 | * @mr: the memory region being queried | |
642 | */ | |
643 | bool memory_region_is_rom(MemoryRegion *mr); | |
644 | ||
a35ba7be PB |
645 | /** |
646 | * memory_region_get_fd: Get a file descriptor backing a RAM memory region. | |
647 | * | |
648 | * Returns a file descriptor backing a file-based RAM memory region, | |
649 | * or -1 if the region is not a file-based RAM memory region. | |
650 | * | |
651 | * @mr: the RAM or alias memory region being queried. | |
652 | */ | |
653 | int memory_region_get_fd(MemoryRegion *mr); | |
654 | ||
093bc2cd AK |
655 | /** |
656 | * memory_region_get_ram_ptr: Get a pointer into a RAM memory region. | |
657 | * | |
658 | * Returns a host pointer to a RAM memory region (created with | |
49b24afc PB |
659 | * memory_region_init_ram() or memory_region_init_ram_ptr()). |
660 | * | |
661 | * Use with care; by the time this function returns, the returned pointer is | |
662 | * not protected by RCU anymore. If the caller is not within an RCU critical | |
663 | * section and does not hold the iothread lock, it must have other means of | |
664 | * protecting the pointer, such as a reference to the region that includes | |
665 | * the incoming ram_addr_t. | |
093bc2cd AK |
666 | * |
667 | * @mr: the memory region being queried. | |
668 | */ | |
669 | void *memory_region_get_ram_ptr(MemoryRegion *mr); | |
670 | ||
37d7c084 PB |
671 | /* memory_region_ram_resize: Resize a RAM region. |
672 | * | |
673 | * Only legal before guest might have detected the memory size: e.g. on | |
674 | * incoming migration, or right after reset. | |
675 | * | |
676 | * @mr: a memory region created with @memory_region_init_resizeable_ram. | |
677 | * @newsize: the new size the region | |
678 | * @errp: pointer to Error*, to store an error if it happens. | |
679 | */ | |
680 | void memory_region_ram_resize(MemoryRegion *mr, ram_addr_t newsize, | |
681 | Error **errp); | |
682 | ||
093bc2cd AK |
683 | /** |
684 | * memory_region_set_log: Turn dirty logging on or off for a region. | |
685 | * | |
686 | * Turns dirty logging on or off for a specified client (display, migration). | |
687 | * Only meaningful for RAM regions. | |
688 | * | |
689 | * @mr: the memory region being updated. | |
690 | * @log: whether dirty logging is to be enabled or disabled. | |
dbddac6d | 691 | * @client: the user of the logging information; %DIRTY_MEMORY_VGA only. |
093bc2cd AK |
692 | */ |
693 | void memory_region_set_log(MemoryRegion *mr, bool log, unsigned client); | |
694 | ||
695 | /** | |
cd7a45c9 BS |
696 | * memory_region_get_dirty: Check whether a range of bytes is dirty |
697 | * for a specified client. | |
093bc2cd | 698 | * |
cd7a45c9 | 699 | * Checks whether a range of bytes has been written to since the last |
093bc2cd AK |
700 | * call to memory_region_reset_dirty() with the same @client. Dirty logging |
701 | * must be enabled. | |
702 | * | |
703 | * @mr: the memory region being queried. | |
704 | * @addr: the address (relative to the start of the region) being queried. | |
cd7a45c9 | 705 | * @size: the size of the range being queried. |
093bc2cd AK |
706 | * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or |
707 | * %DIRTY_MEMORY_VGA. | |
708 | */ | |
a8170e5e AK |
709 | bool memory_region_get_dirty(MemoryRegion *mr, hwaddr addr, |
710 | hwaddr size, unsigned client); | |
093bc2cd AK |
711 | |
712 | /** | |
fd4aa979 | 713 | * memory_region_set_dirty: Mark a range of bytes as dirty in a memory region. |
093bc2cd | 714 | * |
fd4aa979 BS |
715 | * Marks a range of bytes as dirty, after it has been dirtied outside |
716 | * guest code. | |
093bc2cd | 717 | * |
fd4aa979 | 718 | * @mr: the memory region being dirtied. |
093bc2cd | 719 | * @addr: the address (relative to the start of the region) being dirtied. |
fd4aa979 | 720 | * @size: size of the range being dirtied. |
093bc2cd | 721 | */ |
a8170e5e AK |
722 | void memory_region_set_dirty(MemoryRegion *mr, hwaddr addr, |
723 | hwaddr size); | |
093bc2cd | 724 | |
6c279db8 JQ |
725 | /** |
726 | * memory_region_test_and_clear_dirty: Check whether a range of bytes is dirty | |
727 | * for a specified client. It clears them. | |
728 | * | |
729 | * Checks whether a range of bytes has been written to since the last | |
730 | * call to memory_region_reset_dirty() with the same @client. Dirty logging | |
731 | * must be enabled. | |
732 | * | |
733 | * @mr: the memory region being queried. | |
734 | * @addr: the address (relative to the start of the region) being queried. | |
735 | * @size: the size of the range being queried. | |
736 | * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or | |
737 | * %DIRTY_MEMORY_VGA. | |
738 | */ | |
739 | bool memory_region_test_and_clear_dirty(MemoryRegion *mr, hwaddr addr, | |
740 | hwaddr size, unsigned client); | |
093bc2cd AK |
741 | /** |
742 | * memory_region_sync_dirty_bitmap: Synchronize a region's dirty bitmap with | |
743 | * any external TLBs (e.g. kvm) | |
744 | * | |
745 | * Flushes dirty information from accelerators such as kvm and vhost-net | |
746 | * and makes it available to users of the memory API. | |
747 | * | |
748 | * @mr: the region being flushed. | |
749 | */ | |
750 | void memory_region_sync_dirty_bitmap(MemoryRegion *mr); | |
751 | ||
752 | /** | |
753 | * memory_region_reset_dirty: Mark a range of pages as clean, for a specified | |
754 | * client. | |
755 | * | |
756 | * Marks a range of pages as no longer dirty. | |
757 | * | |
758 | * @mr: the region being updated. | |
759 | * @addr: the start of the subrange being cleaned. | |
760 | * @size: the size of the subrange being cleaned. | |
761 | * @client: the user of the logging information; %DIRTY_MEMORY_MIGRATION or | |
762 | * %DIRTY_MEMORY_VGA. | |
763 | */ | |
a8170e5e AK |
764 | void memory_region_reset_dirty(MemoryRegion *mr, hwaddr addr, |
765 | hwaddr size, unsigned client); | |
093bc2cd AK |
766 | |
767 | /** | |
768 | * memory_region_set_readonly: Turn a memory region read-only (or read-write) | |
769 | * | |
770 | * Allows a memory region to be marked as read-only (turning it into a ROM). | |
771 | * only useful on RAM regions. | |
772 | * | |
773 | * @mr: the region being updated. | |
774 | * @readonly: whether rhe region is to be ROM or RAM. | |
775 | */ | |
776 | void memory_region_set_readonly(MemoryRegion *mr, bool readonly); | |
777 | ||
d0a9b5bc | 778 | /** |
5f9a5ea1 | 779 | * memory_region_rom_device_set_romd: enable/disable ROMD mode |
d0a9b5bc AK |
780 | * |
781 | * Allows a ROM device (initialized with memory_region_init_rom_device() to | |
5f9a5ea1 JK |
782 | * set to ROMD mode (default) or MMIO mode. When it is in ROMD mode, the |
783 | * device is mapped to guest memory and satisfies read access directly. | |
784 | * When in MMIO mode, reads are forwarded to the #MemoryRegion.read function. | |
785 | * Writes are always handled by the #MemoryRegion.write function. | |
d0a9b5bc AK |
786 | * |
787 | * @mr: the memory region to be updated | |
5f9a5ea1 | 788 | * @romd_mode: %true to put the region into ROMD mode |
d0a9b5bc | 789 | */ |
5f9a5ea1 | 790 | void memory_region_rom_device_set_romd(MemoryRegion *mr, bool romd_mode); |
d0a9b5bc | 791 | |
093bc2cd AK |
792 | /** |
793 | * memory_region_set_coalescing: Enable memory coalescing for the region. | |
794 | * | |
795 | * Enabled writes to a region to be queued for later processing. MMIO ->write | |
796 | * callbacks may be delayed until a non-coalesced MMIO is issued. | |
797 | * Only useful for IO regions. Roughly similar to write-combining hardware. | |
798 | * | |
799 | * @mr: the memory region to be write coalesced | |
800 | */ | |
801 | void memory_region_set_coalescing(MemoryRegion *mr); | |
802 | ||
803 | /** | |
804 | * memory_region_add_coalescing: Enable memory coalescing for a sub-range of | |
805 | * a region. | |
806 | * | |
807 | * Like memory_region_set_coalescing(), but works on a sub-range of a region. | |
808 | * Multiple calls can be issued coalesced disjoint ranges. | |
809 | * | |
810 | * @mr: the memory region to be updated. | |
811 | * @offset: the start of the range within the region to be coalesced. | |
812 | * @size: the size of the subrange to be coalesced. | |
813 | */ | |
814 | void memory_region_add_coalescing(MemoryRegion *mr, | |
a8170e5e | 815 | hwaddr offset, |
093bc2cd AK |
816 | uint64_t size); |
817 | ||
818 | /** | |
819 | * memory_region_clear_coalescing: Disable MMIO coalescing for the region. | |
820 | * | |
821 | * Disables any coalescing caused by memory_region_set_coalescing() or | |
822 | * memory_region_add_coalescing(). Roughly equivalent to uncacheble memory | |
823 | * hardware. | |
824 | * | |
825 | * @mr: the memory region to be updated. | |
826 | */ | |
827 | void memory_region_clear_coalescing(MemoryRegion *mr); | |
828 | ||
d410515e JK |
829 | /** |
830 | * memory_region_set_flush_coalesced: Enforce memory coalescing flush before | |
831 | * accesses. | |
832 | * | |
833 | * Ensure that pending coalesced MMIO request are flushed before the memory | |
834 | * region is accessed. This property is automatically enabled for all regions | |
835 | * passed to memory_region_set_coalescing() and memory_region_add_coalescing(). | |
836 | * | |
837 | * @mr: the memory region to be updated. | |
838 | */ | |
839 | void memory_region_set_flush_coalesced(MemoryRegion *mr); | |
840 | ||
841 | /** | |
842 | * memory_region_clear_flush_coalesced: Disable memory coalescing flush before | |
843 | * accesses. | |
844 | * | |
845 | * Clear the automatic coalesced MMIO flushing enabled via | |
846 | * memory_region_set_flush_coalesced. Note that this service has no effect on | |
847 | * memory regions that have MMIO coalescing enabled for themselves. For them, | |
848 | * automatic flushing will stop once coalescing is disabled. | |
849 | * | |
850 | * @mr: the memory region to be updated. | |
851 | */ | |
852 | void memory_region_clear_flush_coalesced(MemoryRegion *mr); | |
853 | ||
196ea131 JK |
854 | /** |
855 | * memory_region_set_global_locking: Declares the access processing requires | |
856 | * QEMU's global lock. | |
857 | * | |
858 | * When this is invoked, accesses to the memory region will be processed while | |
859 | * holding the global lock of QEMU. This is the default behavior of memory | |
860 | * regions. | |
861 | * | |
862 | * @mr: the memory region to be updated. | |
863 | */ | |
864 | void memory_region_set_global_locking(MemoryRegion *mr); | |
865 | ||
866 | /** | |
867 | * memory_region_clear_global_locking: Declares that access processing does | |
868 | * not depend on the QEMU global lock. | |
869 | * | |
870 | * By clearing this property, accesses to the memory region will be processed | |
871 | * outside of QEMU's global lock (unless the lock is held on when issuing the | |
872 | * access request). In this case, the device model implementing the access | |
873 | * handlers is responsible for synchronization of concurrency. | |
874 | * | |
875 | * @mr: the memory region to be updated. | |
876 | */ | |
877 | void memory_region_clear_global_locking(MemoryRegion *mr); | |
878 | ||
3e9d69e7 AK |
879 | /** |
880 | * memory_region_add_eventfd: Request an eventfd to be triggered when a word | |
881 | * is written to a location. | |
882 | * | |
883 | * Marks a word in an IO region (initialized with memory_region_init_io()) | |
884 | * as a trigger for an eventfd event. The I/O callback will not be called. | |
69ddaf66 | 885 | * The caller must be prepared to handle failure (that is, take the required |
3e9d69e7 AK |
886 | * action if the callback _is_ called). |
887 | * | |
888 | * @mr: the memory region being updated. | |
889 | * @addr: the address within @mr that is to be monitored | |
890 | * @size: the size of the access to trigger the eventfd | |
891 | * @match_data: whether to match against @data, instead of just @addr | |
892 | * @data: the data to match against the guest write | |
893 | * @fd: the eventfd to be triggered when @addr, @size, and @data all match. | |
894 | **/ | |
895 | void memory_region_add_eventfd(MemoryRegion *mr, | |
a8170e5e | 896 | hwaddr addr, |
3e9d69e7 AK |
897 | unsigned size, |
898 | bool match_data, | |
899 | uint64_t data, | |
753d5e14 | 900 | EventNotifier *e); |
3e9d69e7 AK |
901 | |
902 | /** | |
69ddaf66 | 903 | * memory_region_del_eventfd: Cancel an eventfd. |
3e9d69e7 | 904 | * |
69ddaf66 ASRJ |
905 | * Cancels an eventfd trigger requested by a previous |
906 | * memory_region_add_eventfd() call. | |
3e9d69e7 AK |
907 | * |
908 | * @mr: the memory region being updated. | |
909 | * @addr: the address within @mr that is to be monitored | |
910 | * @size: the size of the access to trigger the eventfd | |
911 | * @match_data: whether to match against @data, instead of just @addr | |
912 | * @data: the data to match against the guest write | |
913 | * @fd: the eventfd to be triggered when @addr, @size, and @data all match. | |
914 | */ | |
915 | void memory_region_del_eventfd(MemoryRegion *mr, | |
a8170e5e | 916 | hwaddr addr, |
3e9d69e7 AK |
917 | unsigned size, |
918 | bool match_data, | |
919 | uint64_t data, | |
753d5e14 PB |
920 | EventNotifier *e); |
921 | ||
093bc2cd | 922 | /** |
69ddaf66 | 923 | * memory_region_add_subregion: Add a subregion to a container. |
093bc2cd | 924 | * |
69ddaf66 | 925 | * Adds a subregion at @offset. The subregion may not overlap with other |
093bc2cd AK |
926 | * subregions (except for those explicitly marked as overlapping). A region |
927 | * may only be added once as a subregion (unless removed with | |
928 | * memory_region_del_subregion()); use memory_region_init_alias() if you | |
929 | * want a region to be a subregion in multiple locations. | |
930 | * | |
931 | * @mr: the region to contain the new subregion; must be a container | |
932 | * initialized with memory_region_init(). | |
933 | * @offset: the offset relative to @mr where @subregion is added. | |
934 | * @subregion: the subregion to be added. | |
935 | */ | |
936 | void memory_region_add_subregion(MemoryRegion *mr, | |
a8170e5e | 937 | hwaddr offset, |
093bc2cd AK |
938 | MemoryRegion *subregion); |
939 | /** | |
1a7e8cae BZ |
940 | * memory_region_add_subregion_overlap: Add a subregion to a container |
941 | * with overlap. | |
093bc2cd | 942 | * |
69ddaf66 | 943 | * Adds a subregion at @offset. The subregion may overlap with other |
093bc2cd AK |
944 | * subregions. Conflicts are resolved by having a higher @priority hide a |
945 | * lower @priority. Subregions without priority are taken as @priority 0. | |
946 | * A region may only be added once as a subregion (unless removed with | |
947 | * memory_region_del_subregion()); use memory_region_init_alias() if you | |
948 | * want a region to be a subregion in multiple locations. | |
949 | * | |
950 | * @mr: the region to contain the new subregion; must be a container | |
951 | * initialized with memory_region_init(). | |
952 | * @offset: the offset relative to @mr where @subregion is added. | |
953 | * @subregion: the subregion to be added. | |
954 | * @priority: used for resolving overlaps; highest priority wins. | |
955 | */ | |
956 | void memory_region_add_subregion_overlap(MemoryRegion *mr, | |
a8170e5e | 957 | hwaddr offset, |
093bc2cd | 958 | MemoryRegion *subregion, |
a1ff8ae0 | 959 | int priority); |
e34911c4 AK |
960 | |
961 | /** | |
962 | * memory_region_get_ram_addr: Get the ram address associated with a memory | |
963 | * region | |
964 | * | |
dabdf394 | 965 | * DO NOT USE THIS FUNCTION. This is a temporary workaround while the Xen |
e34911c4 AK |
966 | * code is being reworked. |
967 | */ | |
968 | ram_addr_t memory_region_get_ram_addr(MemoryRegion *mr); | |
969 | ||
a2b257d6 | 970 | uint64_t memory_region_get_alignment(const MemoryRegion *mr); |
093bc2cd AK |
971 | /** |
972 | * memory_region_del_subregion: Remove a subregion. | |
973 | * | |
974 | * Removes a subregion from its container. | |
975 | * | |
976 | * @mr: the container to be updated. | |
977 | * @subregion: the region being removed; must be a current subregion of @mr. | |
978 | */ | |
979 | void memory_region_del_subregion(MemoryRegion *mr, | |
980 | MemoryRegion *subregion); | |
981 | ||
6bba19ba AK |
982 | /* |
983 | * memory_region_set_enabled: dynamically enable or disable a region | |
984 | * | |
985 | * Enables or disables a memory region. A disabled memory region | |
986 | * ignores all accesses to itself and its subregions. It does not | |
987 | * obscure sibling subregions with lower priority - it simply behaves as | |
988 | * if it was removed from the hierarchy. | |
989 | * | |
990 | * Regions default to being enabled. | |
991 | * | |
992 | * @mr: the region to be updated | |
993 | * @enabled: whether to enable or disable the region | |
994 | */ | |
995 | void memory_region_set_enabled(MemoryRegion *mr, bool enabled); | |
996 | ||
2282e1af AK |
997 | /* |
998 | * memory_region_set_address: dynamically update the address of a region | |
999 | * | |
feca4ac1 | 1000 | * Dynamically updates the address of a region, relative to its container. |
2282e1af AK |
1001 | * May be used on regions are currently part of a memory hierarchy. |
1002 | * | |
1003 | * @mr: the region to be updated | |
feca4ac1 | 1004 | * @addr: new address, relative to container region |
2282e1af | 1005 | */ |
a8170e5e | 1006 | void memory_region_set_address(MemoryRegion *mr, hwaddr addr); |
2282e1af | 1007 | |
e7af4c67 MT |
1008 | /* |
1009 | * memory_region_set_size: dynamically update the size of a region. | |
1010 | * | |
1011 | * Dynamically updates the size of a region. | |
1012 | * | |
1013 | * @mr: the region to be updated | |
1014 | * @size: used size of the region. | |
1015 | */ | |
1016 | void memory_region_set_size(MemoryRegion *mr, uint64_t size); | |
1017 | ||
4703359e AK |
1018 | /* |
1019 | * memory_region_set_alias_offset: dynamically update a memory alias's offset | |
1020 | * | |
1021 | * Dynamically updates the offset into the target region that an alias points | |
1022 | * to, as if the fourth argument to memory_region_init_alias() has changed. | |
1023 | * | |
1024 | * @mr: the #MemoryRegion to be updated; should be an alias. | |
1025 | * @offset: the new offset into the target memory region | |
1026 | */ | |
1027 | void memory_region_set_alias_offset(MemoryRegion *mr, | |
a8170e5e | 1028 | hwaddr offset); |
4703359e | 1029 | |
3ce10901 | 1030 | /** |
feca4ac1 PB |
1031 | * memory_region_present: checks if an address relative to a @container |
1032 | * translates into #MemoryRegion within @container | |
3ce10901 | 1033 | * |
feca4ac1 | 1034 | * Answer whether a #MemoryRegion within @container covers the address |
3ce10901 PB |
1035 | * @addr. |
1036 | * | |
feca4ac1 PB |
1037 | * @container: a #MemoryRegion within which @addr is a relative address |
1038 | * @addr: the area within @container to be searched | |
3ce10901 | 1039 | */ |
feca4ac1 | 1040 | bool memory_region_present(MemoryRegion *container, hwaddr addr); |
3ce10901 | 1041 | |
eed2bacf IM |
1042 | /** |
1043 | * memory_region_is_mapped: returns true if #MemoryRegion is mapped | |
1044 | * into any address space. | |
1045 | * | |
1046 | * @mr: a #MemoryRegion which should be checked if it's mapped | |
1047 | */ | |
1048 | bool memory_region_is_mapped(MemoryRegion *mr); | |
1049 | ||
e2177955 | 1050 | /** |
73034e9e PB |
1051 | * memory_region_find: translate an address/size relative to a |
1052 | * MemoryRegion into a #MemoryRegionSection. | |
e2177955 | 1053 | * |
73034e9e PB |
1054 | * Locates the first #MemoryRegion within @mr that overlaps the range |
1055 | * given by @addr and @size. | |
e2177955 AK |
1056 | * |
1057 | * Returns a #MemoryRegionSection that describes a contiguous overlap. | |
1058 | * It will have the following characteristics: | |
e2177955 AK |
1059 | * .@size = 0 iff no overlap was found |
1060 | * .@mr is non-%NULL iff an overlap was found | |
1061 | * | |
73034e9e PB |
1062 | * Remember that in the return value the @offset_within_region is |
1063 | * relative to the returned region (in the .@mr field), not to the | |
1064 | * @mr argument. | |
1065 | * | |
1066 | * Similarly, the .@offset_within_address_space is relative to the | |
1067 | * address space that contains both regions, the passed and the | |
1068 | * returned one. However, in the special case where the @mr argument | |
feca4ac1 | 1069 | * has no container (and thus is the root of the address space), the |
73034e9e PB |
1070 | * following will hold: |
1071 | * .@offset_within_address_space >= @addr | |
1072 | * .@offset_within_address_space + .@size <= @addr + @size | |
1073 | * | |
1074 | * @mr: a MemoryRegion within which @addr is a relative address | |
1075 | * @addr: start of the area within @as to be searched | |
e2177955 AK |
1076 | * @size: size of the area to be searched |
1077 | */ | |
73034e9e | 1078 | MemoryRegionSection memory_region_find(MemoryRegion *mr, |
a8170e5e | 1079 | hwaddr addr, uint64_t size); |
e2177955 | 1080 | |
86e775c6 | 1081 | /** |
1d671369 | 1082 | * address_space_sync_dirty_bitmap: synchronize the dirty log for all memory |
86e775c6 AK |
1083 | * |
1084 | * Synchronizes the dirty page log for an entire address space. | |
1d671369 | 1085 | * @as: the address space that contains the memory being synchronized |
86e775c6 | 1086 | */ |
1d671369 | 1087 | void address_space_sync_dirty_bitmap(AddressSpace *as); |
86e775c6 | 1088 | |
69ddaf66 ASRJ |
1089 | /** |
1090 | * memory_region_transaction_begin: Start a transaction. | |
1091 | * | |
1092 | * During a transaction, changes will be accumulated and made visible | |
dabdf394 | 1093 | * only when the transaction ends (is committed). |
4ef4db86 AK |
1094 | */ |
1095 | void memory_region_transaction_begin(void); | |
69ddaf66 ASRJ |
1096 | |
1097 | /** | |
1098 | * memory_region_transaction_commit: Commit a transaction and make changes | |
1099 | * visible to the guest. | |
4ef4db86 AK |
1100 | */ |
1101 | void memory_region_transaction_commit(void); | |
1102 | ||
7664e80c AK |
1103 | /** |
1104 | * memory_listener_register: register callbacks to be called when memory | |
1105 | * sections are mapped or unmapped into an address | |
1106 | * space | |
1107 | * | |
1108 | * @listener: an object containing the callbacks to be called | |
7376e582 | 1109 | * @filter: if non-%NULL, only regions in this address space will be observed |
7664e80c | 1110 | */ |
f6790af6 | 1111 | void memory_listener_register(MemoryListener *listener, AddressSpace *filter); |
7664e80c AK |
1112 | |
1113 | /** | |
1114 | * memory_listener_unregister: undo the effect of memory_listener_register() | |
1115 | * | |
1116 | * @listener: an object containing the callbacks to be removed | |
1117 | */ | |
1118 | void memory_listener_unregister(MemoryListener *listener); | |
1119 | ||
1120 | /** | |
1121 | * memory_global_dirty_log_start: begin dirty logging for all regions | |
1122 | */ | |
1123 | void memory_global_dirty_log_start(void); | |
1124 | ||
1125 | /** | |
1a7e8cae | 1126 | * memory_global_dirty_log_stop: end dirty logging for all regions |
7664e80c AK |
1127 | */ |
1128 | void memory_global_dirty_log_stop(void); | |
1129 | ||
314e2987 BS |
1130 | void mtree_info(fprintf_function mon_printf, void *f); |
1131 | ||
3b643495 PM |
1132 | /** |
1133 | * memory_region_dispatch_read: perform a read directly to the specified | |
1134 | * MemoryRegion. | |
1135 | * | |
1136 | * @mr: #MemoryRegion to access | |
1137 | * @addr: address within that region | |
1138 | * @pval: pointer to uint64_t which the data is written to | |
1139 | * @size: size of the access in bytes | |
1140 | * @attrs: memory transaction attributes to use for the access | |
1141 | */ | |
1142 | MemTxResult memory_region_dispatch_read(MemoryRegion *mr, | |
1143 | hwaddr addr, | |
1144 | uint64_t *pval, | |
1145 | unsigned size, | |
1146 | MemTxAttrs attrs); | |
1147 | /** | |
1148 | * memory_region_dispatch_write: perform a write directly to the specified | |
1149 | * MemoryRegion. | |
1150 | * | |
1151 | * @mr: #MemoryRegion to access | |
1152 | * @addr: address within that region | |
1153 | * @data: data to write | |
1154 | * @size: size of the access in bytes | |
1155 | * @attrs: memory transaction attributes to use for the access | |
1156 | */ | |
1157 | MemTxResult memory_region_dispatch_write(MemoryRegion *mr, | |
1158 | hwaddr addr, | |
1159 | uint64_t data, | |
1160 | unsigned size, | |
1161 | MemTxAttrs attrs); | |
1162 | ||
9ad2bbc1 AK |
1163 | /** |
1164 | * address_space_init: initializes an address space | |
1165 | * | |
1166 | * @as: an uninitialized #AddressSpace | |
67cc32eb | 1167 | * @root: a #MemoryRegion that routes addresses for the address space |
7dca8043 AK |
1168 | * @name: an address space name. The name is only used for debugging |
1169 | * output. | |
9ad2bbc1 | 1170 | */ |
7dca8043 | 1171 | void address_space_init(AddressSpace *as, MemoryRegion *root, const char *name); |
9ad2bbc1 | 1172 | |
83f3c251 AK |
1173 | |
1174 | /** | |
1175 | * address_space_destroy: destroy an address space | |
1176 | * | |
1177 | * Releases all resources associated with an address space. After an address space | |
1178 | * is destroyed, its root memory region (given by address_space_init()) may be destroyed | |
1179 | * as well. | |
1180 | * | |
1181 | * @as: address space to be destroyed | |
1182 | */ | |
1183 | void address_space_destroy(AddressSpace *as); | |
1184 | ||
ac1970fb AK |
1185 | /** |
1186 | * address_space_rw: read from or write to an address space. | |
1187 | * | |
5c9eb028 PM |
1188 | * Return a MemTxResult indicating whether the operation succeeded |
1189 | * or failed (eg unassigned memory, device rejected the transaction, | |
1190 | * IOMMU fault). | |
fd8aaa76 | 1191 | * |
ac1970fb AK |
1192 | * @as: #AddressSpace to be accessed |
1193 | * @addr: address within that address space | |
5c9eb028 | 1194 | * @attrs: memory transaction attributes |
ac1970fb AK |
1195 | * @buf: buffer with the data transferred |
1196 | * @is_write: indicates the transfer direction | |
1197 | */ | |
5c9eb028 PM |
1198 | MemTxResult address_space_rw(AddressSpace *as, hwaddr addr, |
1199 | MemTxAttrs attrs, uint8_t *buf, | |
1200 | int len, bool is_write); | |
ac1970fb AK |
1201 | |
1202 | /** | |
1203 | * address_space_write: write to address space. | |
1204 | * | |
5c9eb028 PM |
1205 | * Return a MemTxResult indicating whether the operation succeeded |
1206 | * or failed (eg unassigned memory, device rejected the transaction, | |
1207 | * IOMMU fault). | |
fd8aaa76 | 1208 | * |
ac1970fb AK |
1209 | * @as: #AddressSpace to be accessed |
1210 | * @addr: address within that address space | |
5c9eb028 | 1211 | * @attrs: memory transaction attributes |
ac1970fb AK |
1212 | * @buf: buffer with the data transferred |
1213 | */ | |
5c9eb028 PM |
1214 | MemTxResult address_space_write(AddressSpace *as, hwaddr addr, |
1215 | MemTxAttrs attrs, | |
1216 | const uint8_t *buf, int len); | |
ac1970fb AK |
1217 | |
1218 | /** | |
1219 | * address_space_read: read from an address space. | |
1220 | * | |
5c9eb028 PM |
1221 | * Return a MemTxResult indicating whether the operation succeeded |
1222 | * or failed (eg unassigned memory, device rejected the transaction, | |
1223 | * IOMMU fault). | |
fd8aaa76 | 1224 | * |
ac1970fb AK |
1225 | * @as: #AddressSpace to be accessed |
1226 | * @addr: address within that address space | |
5c9eb028 | 1227 | * @attrs: memory transaction attributes |
ac1970fb AK |
1228 | * @buf: buffer with the data transferred |
1229 | */ | |
5c9eb028 PM |
1230 | MemTxResult address_space_read(AddressSpace *as, hwaddr addr, MemTxAttrs attrs, |
1231 | uint8_t *buf, int len); | |
ac1970fb | 1232 | |
50013115 PM |
1233 | /** |
1234 | * address_space_ld*: load from an address space | |
1235 | * address_space_st*: store to an address space | |
1236 | * | |
1237 | * These functions perform a load or store of the byte, word, | |
1238 | * longword or quad to the specified address within the AddressSpace. | |
1239 | * The _le suffixed functions treat the data as little endian; | |
1240 | * _be indicates big endian; no suffix indicates "same endianness | |
1241 | * as guest CPU". | |
1242 | * | |
1243 | * The "guest CPU endianness" accessors are deprecated for use outside | |
1244 | * target-* code; devices should be CPU-agnostic and use either the LE | |
1245 | * or the BE accessors. | |
1246 | * | |
1247 | * @as #AddressSpace to be accessed | |
1248 | * @addr: address within that address space | |
1249 | * @val: data value, for stores | |
1250 | * @attrs: memory transaction attributes | |
1251 | * @result: location to write the success/failure of the transaction; | |
1252 | * if NULL, this information is discarded | |
1253 | */ | |
1254 | uint32_t address_space_ldub(AddressSpace *as, hwaddr addr, | |
1255 | MemTxAttrs attrs, MemTxResult *result); | |
1256 | uint32_t address_space_lduw_le(AddressSpace *as, hwaddr addr, | |
1257 | MemTxAttrs attrs, MemTxResult *result); | |
1258 | uint32_t address_space_lduw_be(AddressSpace *as, hwaddr addr, | |
1259 | MemTxAttrs attrs, MemTxResult *result); | |
1260 | uint32_t address_space_ldl_le(AddressSpace *as, hwaddr addr, | |
1261 | MemTxAttrs attrs, MemTxResult *result); | |
1262 | uint32_t address_space_ldl_be(AddressSpace *as, hwaddr addr, | |
1263 | MemTxAttrs attrs, MemTxResult *result); | |
1264 | uint64_t address_space_ldq_le(AddressSpace *as, hwaddr addr, | |
1265 | MemTxAttrs attrs, MemTxResult *result); | |
1266 | uint64_t address_space_ldq_be(AddressSpace *as, hwaddr addr, | |
1267 | MemTxAttrs attrs, MemTxResult *result); | |
1268 | void address_space_stb(AddressSpace *as, hwaddr addr, uint32_t val, | |
1269 | MemTxAttrs attrs, MemTxResult *result); | |
1270 | void address_space_stw_le(AddressSpace *as, hwaddr addr, uint32_t val, | |
1271 | MemTxAttrs attrs, MemTxResult *result); | |
1272 | void address_space_stw_be(AddressSpace *as, hwaddr addr, uint32_t val, | |
1273 | MemTxAttrs attrs, MemTxResult *result); | |
1274 | void address_space_stl_le(AddressSpace *as, hwaddr addr, uint32_t val, | |
1275 | MemTxAttrs attrs, MemTxResult *result); | |
1276 | void address_space_stl_be(AddressSpace *as, hwaddr addr, uint32_t val, | |
1277 | MemTxAttrs attrs, MemTxResult *result); | |
1278 | void address_space_stq_le(AddressSpace *as, hwaddr addr, uint64_t val, | |
1279 | MemTxAttrs attrs, MemTxResult *result); | |
1280 | void address_space_stq_be(AddressSpace *as, hwaddr addr, uint64_t val, | |
1281 | MemTxAttrs attrs, MemTxResult *result); | |
1282 | ||
1283 | #ifdef NEED_CPU_H | |
1284 | uint32_t address_space_lduw(AddressSpace *as, hwaddr addr, | |
1285 | MemTxAttrs attrs, MemTxResult *result); | |
1286 | uint32_t address_space_ldl(AddressSpace *as, hwaddr addr, | |
1287 | MemTxAttrs attrs, MemTxResult *result); | |
1288 | uint64_t address_space_ldq(AddressSpace *as, hwaddr addr, | |
1289 | MemTxAttrs attrs, MemTxResult *result); | |
1290 | void address_space_stl_notdirty(AddressSpace *as, hwaddr addr, uint32_t val, | |
1291 | MemTxAttrs attrs, MemTxResult *result); | |
1292 | void address_space_stw(AddressSpace *as, hwaddr addr, uint32_t val, | |
1293 | MemTxAttrs attrs, MemTxResult *result); | |
1294 | void address_space_stl(AddressSpace *as, hwaddr addr, uint32_t val, | |
1295 | MemTxAttrs attrs, MemTxResult *result); | |
1296 | void address_space_stq(AddressSpace *as, hwaddr addr, uint64_t val, | |
1297 | MemTxAttrs attrs, MemTxResult *result); | |
1298 | #endif | |
1299 | ||
149f54b5 | 1300 | /* address_space_translate: translate an address range into an address space |
41063e1e PB |
1301 | * into a MemoryRegion and an address range into that section. Should be |
1302 | * called from an RCU critical section, to avoid that the last reference | |
1303 | * to the returned region disappears after address_space_translate returns. | |
149f54b5 PB |
1304 | * |
1305 | * @as: #AddressSpace to be accessed | |
1306 | * @addr: address within that address space | |
1307 | * @xlat: pointer to address within the returned memory region section's | |
1308 | * #MemoryRegion. | |
1309 | * @len: pointer to length | |
1310 | * @is_write: indicates the transfer direction | |
1311 | */ | |
5c8a00ce PB |
1312 | MemoryRegion *address_space_translate(AddressSpace *as, hwaddr addr, |
1313 | hwaddr *xlat, hwaddr *len, | |
1314 | bool is_write); | |
149f54b5 | 1315 | |
51644ab7 PB |
1316 | /* address_space_access_valid: check for validity of accessing an address |
1317 | * space range | |
1318 | * | |
30951157 AK |
1319 | * Check whether memory is assigned to the given address space range, and |
1320 | * access is permitted by any IOMMU regions that are active for the address | |
1321 | * space. | |
51644ab7 PB |
1322 | * |
1323 | * For now, addr and len should be aligned to a page size. This limitation | |
1324 | * will be lifted in the future. | |
1325 | * | |
1326 | * @as: #AddressSpace to be accessed | |
1327 | * @addr: address within that address space | |
1328 | * @len: length of the area to be checked | |
1329 | * @is_write: indicates the transfer direction | |
1330 | */ | |
1331 | bool address_space_access_valid(AddressSpace *as, hwaddr addr, int len, bool is_write); | |
1332 | ||
ac1970fb AK |
1333 | /* address_space_map: map a physical memory region into a host virtual address |
1334 | * | |
1335 | * May map a subset of the requested range, given by and returned in @plen. | |
1336 | * May return %NULL if resources needed to perform the mapping are exhausted. | |
1337 | * Use only for reads OR writes - not for read-modify-write operations. | |
1338 | * Use cpu_register_map_client() to know when retrying the map operation is | |
1339 | * likely to succeed. | |
1340 | * | |
1341 | * @as: #AddressSpace to be accessed | |
1342 | * @addr: address within that address space | |
1343 | * @plen: pointer to length of buffer; updated on return | |
1344 | * @is_write: indicates the transfer direction | |
1345 | */ | |
a8170e5e AK |
1346 | void *address_space_map(AddressSpace *as, hwaddr addr, |
1347 | hwaddr *plen, bool is_write); | |
ac1970fb AK |
1348 | |
1349 | /* address_space_unmap: Unmaps a memory region previously mapped by address_space_map() | |
1350 | * | |
1351 | * Will also mark the memory as dirty if @is_write == %true. @access_len gives | |
1352 | * the amount of memory that was actually read or written by the caller. | |
1353 | * | |
1354 | * @as: #AddressSpace used | |
1355 | * @addr: address within that address space | |
1356 | * @len: buffer length as returned by address_space_map() | |
1357 | * @access_len: amount of data actually transferred | |
1358 | * @is_write: indicates the transfer direction | |
1359 | */ | |
a8170e5e AK |
1360 | void address_space_unmap(AddressSpace *as, void *buffer, hwaddr len, |
1361 | int is_write, hwaddr access_len); | |
ac1970fb AK |
1362 | |
1363 | ||
093bc2cd AK |
1364 | #endif |
1365 | ||
1366 | #endif |