Implement memory_region_new_* functions
v4 cover Implement memory_region_new_* functions
Allow creating memory regions that are managed by QOM and freed with their owner as it is already documented and implemented but there was no way to use it.
v4:
- rebase on latest version of clean up series:
Based-on: [email protected]
v3:
- based on split off clean up series
- convert xtfpga from nomigrate as this has no migration compatibility issue
v2:
- rebase on master
- update documentation
- use these function to fix some leaks (there may be more, e.g. in hw/pci-host/bonito but I leave that for later and/or others)
BALATON Zoltan (6):
memory: Add memory_region_new* functions
memory: Update documentation for memory_region_new*() hw/ide/sii3112: Use memory_region_new to avoid leaking regions hw/pci-host/articia: Map PCI memory windows in realize hw/pci-host/articia: Add variable for common type cast hw/xtensa/xtfpga: Fix leaking memory region
docs/devel/memory.rst | 21 ++--- hw/ide/sii3112.c | 30 +++---- hw/pci-host/articia.c | 22 +++-- hw/ppc/amigaone.c | 28 ++----- hw/ppc/pegasos.c | 13 --- hw/xtensa/xtfpga.c | 5 +- include/system/memory.h | 179 ++++++++++++++++++++++++++++++++++++++++ system/memory.c | 172 ++++++++++++++++++++++++++++++++++++++ 8 files changed, 398 insertions(+), 72 deletions(-)
Signature · 1 line
2.41.3
PATCH v4 1/6 memory: Add memory_region_new* functions
These are counterparts of similar memory_region_init* functions but differ in that these allocate the memory region with object_new so the memory region will be managed by QOM and freed with the owner. This behaviour was already documented and the reference tracking is implemented but it could not be used without these functions because memory_region_init* functions call object_initialize that clears the free function of the object so it would not be freed.
--- include/system/memory.h | 81 +++++++++++++++++++ system/memory.c | 172 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 253 insertions(+)
include/system/memory.h +81 -0
@@ -1324,6 +1324,10 @@ void memory_region_init(MemoryRegion *mr,const char *name, uint64_t size); +MemoryRegion *memory_region_new (Object *owner, +const char *name, +uint64_t size); +/** * memory_region_ref: Add 1 to a memory region's reference count *
@@ -1374,6 +1378,12 @@ void memory_region_init_io(MemoryRegion *mr,const char *name, uint64_t size); +MemoryRegion *memory_region_new_io (Object *owner, +const MemoryRegionOps *ops, +void *opaque, +const char *name, +uint64_t size); +/** * memory_region_init_ram_flags_nomigrate: Initialize RAM memory region. * Accesses into the region will
@@ -1400,6 +1410,12 @@ bool memory_region_init_ram_flags_nomigrate(MemoryRegion *mr,uint32_t ram_flags, Error **errp); +MemoryRegion *memory_region_new_ram_flags_nomigrate (Object *owner, +const char *name, +uint64_t size, +uint32_t ram_flags, +Error **errp); +/** * memory_region_init_resizeable_ram: Initialize memory region with resizable * RAM. Accesses into the region will
@@ -1432,6 +1448,16 @@ bool memory_region_init_resizeable_ram(MemoryRegion *mr,uint64_t length, void *host), Error **errp); + +MemoryRegion *memory_region_new_resizeable_ram (Object *owner, +const char *name, +uint64_t size, +uint64_t max_size, +void (*resized)(const char *, +uint64_t length, +void *host), +Error **errp); +#ifdef CONFIG_POSIX /**
@@ -1467,6 +1493,15 @@ bool memory_region_init_ram_from_file(MemoryRegion *mr,ram_addr_t offset, Error **errp); +MemoryRegion *memory_region_new_ram_from_file (Object *owner, +const char *name, +uint64_t size, +uint64_t align, +uint32_t ram_flags, +const char *path, +ram_addr_t offset, +Error **errp); +/** * memory_region_init_ram_from_fd: Initialize RAM memory region with a * mmap-ed backend.
@@ -1495,6 +1530,15 @@ bool memory_region_init_ram_from_fd(MemoryRegion *mr,int fd, ram_addr_t offset, Error **errp); + +MemoryRegion *memory_region_new_ram_from_fd (Object *owner, +const char *name, +uint64_t size, +uint32_t ram_flags, +int fd, +ram_addr_t offset, +Error **errp); +#endif /**
@@ -1518,6 +1562,11 @@ void memory_region_init_ram_ptr(MemoryRegion *mr,uint64_t size, void *ptr); +MemoryRegion *memory_region_new_ram_ptr (Object *owner, +const char *name, +uint64_t size, +void *ptr); +/** * memory_region_init_ram_device_ptr: Initialize RAM device memory region from * a user-provided pointer.
@@ -1546,6 +1595,11 @@ void memory_region_init_ram_device_ptr(MemoryRegion *mr,uint64_t size, void *ptr); +MemoryRegion *memory_region_new_ram_device_ptr (Object *owner, +const char *name, +uint64_t size, +void *ptr); +/** * memory_region_init_alias: Initialize a memory region that aliases all or a * part of another memory region.
@@ -1565,6 +1619,12 @@ void memory_region_init_alias(MemoryRegion *mr,hwaddr offset, uint64_t size); +MemoryRegion *memory_region_new_alias (Object *owner, +const char *name, +MemoryRegion *orig, +hwaddr offset, +uint64_t size); +/** * memory_region_init_iommu: Initialize a memory region of a custom type * that translates addresses
@@ -1630,6 +1690,16 @@ bool memory_region_init_ram_guest_memfd(MemoryRegion *mr,uint64_t size, Error **errp); +MemoryRegion *memory_region_new_ram (Object *owner, +const char *name, +uint64_t size, +Error **errp); + +MemoryRegion *memory_region_new_ram_guest_memfd (Object *owner, +const char *name, +uint64_t size, +Error **errp); +/** * memory_region_init_rom: Initialize a ROM memory region. *
@@ -1659,6 +1729,11 @@ bool memory_region_init_rom(MemoryRegion *mr,uint64_t size, Error **errp); +MemoryRegion *memory_region_new_rom (Object *owner, +const char *name, +uint64_t size, +Error **errp); +/** * memory_region_init_rom_device: Initialize a ROM memory region. * Writes are handled via callbacks.
@@ -1694,6 +1769,12 @@ bool memory_region_init_rom_device(MemoryRegion *mr,uint64_t size, Error **errp); +MemoryRegion *memory_region_new_rom_device (Object *owner, +const MemoryRegionOps *ops, +void *opaque, +const char *name, +uint64_t size, +Error **errp);/** * memory_region_owner: get a memory region's owner.
system/memory.c +172 -0
250 lines not on this page · raw message
Signature · 1 line
2.41.3
PATCH v4 2/6 memory: Update documentation for memory_region_new*()
In reply to BALATON ZoltanClarify the difference between memory_region_new() and memory_region_init() with regard to region lifecycle.
--- docs/devel/memory.rst | 21 ++++----- include/system/memory.h | 98 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 109 insertions(+), 10 deletions(-)
docs/devel/memory.rst +11 -10
@@ -138,7 +138,8 @@ stability. Region lifecycle ---------------- -A region is created by one of the memory_region_init*() functions and +A region is allocated by one of the memory_region_new*() functions or +pre-allocated and initialized by memory_region_init*() functions and attached to an object, which acts as its owner or parent. QEMU ensures that the owner object remains alive as long as the region is visible to the guest, or as long as the region is in use by a virtual CPU or another
@@ -154,16 +155,16 @@ ioeventfd) can be changed during the region lifecycle. They take effect as soon as the region is made visible. This can be immediately, later, or never. -Destruction of a memory region happens automatically when the owner object -dies. When there are multiple memory regions under the same owner object, -the memory API will guarantee all memory regions will be properly detached -and finalized one by one. The order in which memory regions will be -finalized is not guaranteed. +Destruction of a memory region allocated with memory_region_new*() functions +happens automatically when the owner object dies. When there are multiple +memory regions under the same owner object, the memory API will guarantee all +memory regions will be properly detached and finalized one by one. The order +in which memory regions will be finalized is not guaranteed. -If however the memory region is part of a dynamically allocated data -structure, you should free the memory region in the instance_finalize -callback. For an example see VFIOMSIXInfo and VFIOQuirk in -hw/vfio/pci.c. +If however the memory region is part of a separately allocated data structure +and initialized with one of the memory_region_init*() functions, you may have +to free the memory region e.g. in an instance_finalize callback. For an +example see VFIOMSIXInfo and VFIOQuirk in hw/vfio/pci.c. You must not destroy a memory region as long as it may be in use by a device or CPU. In order to do this, as a general rule do not create or
include/system/memory.h +98 -0
170 lines not on this page · raw message
Signature · 1 line
2.41.3
PATCH v4 3/6 hw/ide/sii3112: Use memory_region_new to avoid leaking regions
In reply to BALATON ZoltanMemory regions created with memory_region_init are not freed with their owner. Use memory_region_new instead to let QOM manage the lifetime of the memory regions.
--- hw/ide/sii3112.c | 30 ++++++++++++------------------ 1 file changed, 12 insertions(+), 18 deletions(-)
hw/ide/sii3112.c +12 -18
@@ -31,7 +31,7 @@ typedef struct SiI3112Regs {struct SiI3112PCIState {PCIIDEState i; -MemoryRegion mmio; +SiI3112Regs regs[2 ]; };
@@ -249,39 +249,33 @@ static void sii3112_reset(DeviceState *dev)static void sii3112_pci_realize (PCIDevice *dev,Error **errp) { -SiI3112PCIState *d =SII3112_PCI (dev);PCIIDEState *s =PCI_IDE (dev);DeviceState *ds =DEVICE (dev); -MemoryRegion *mr; -int i; +Object *o =OBJECT (dev); +MemoryRegion *mmio, *mr;pci_config_set_interrupt_pin (dev->config,1 );pci_set_byte (dev->config +PCI_CACHE_LINE_SIZE ,8 );/* BAR5 is in PCI memory space */ -memory_region_init_io (&d->mmio,OBJECT (d), &sii3112_reg_ops, d, -"sii3112.bar5" ,0x200 ); -pci_register_bar (dev,5 ,PCI_BASE_ADDRESS_SPACE_MEMORY , &d->mmio); + mmio =memory_region_new_io (o, &sii3112_reg_ops,SII3112_PCI (dev), +"sii3112.bar5" ,0x200 ); +pci_register_bar (dev,5 ,PCI_BASE_ADDRESS_SPACE_MEMORY , mmio);/* BAR0-BAR4 are PCI I/O space aliases into BAR5 */ - mr =g_new (MemoryRegion,1 ); -memory_region_init_alias (mr,OBJECT (d),"sii3112.bar0" , &d->mmio,0x80 ,8 ); + mr =memory_region_new_alias (o,"sii3112.bar0" , mmio,0x80 ,8 );pci_register_bar (dev,0 ,PCI_BASE_ADDRESS_SPACE_IO , mr); - mr =g_new (MemoryRegion,1 ); -memory_region_init_alias (mr,OBJECT (d),"sii3112.bar1" , &d->mmio,0x88 ,4 ); + mr =memory_region_new_alias (o,"sii3112.bar1" , mmio,0x88 ,4 );pci_register_bar (dev,1 ,PCI_BASE_ADDRESS_SPACE_IO , mr); - mr =g_new (MemoryRegion,1 ); -memory_region_init_alias (mr,OBJECT (d),"sii3112.bar2" , &d->mmio,0xc0 ,8 ); + mr =memory_region_new_alias (o,"sii3112.bar2" , mmio,0xc0 ,8 );pci_register_bar (dev,2 ,PCI_BASE_ADDRESS_SPACE_IO , mr); - mr =g_new (MemoryRegion,1 ); -memory_region_init_alias (mr,OBJECT (d),"sii3112.bar3" , &d->mmio,0xc8 ,4 ); + mr =memory_region_new_alias (o,"sii3112.bar3" , mmio,0xc8 ,4 );pci_register_bar (dev,3 ,PCI_BASE_ADDRESS_SPACE_IO , mr); - mr =g_new (MemoryRegion,1 ); -memory_region_init_alias (mr,OBJECT (d),"sii3112.bar4" , &d->mmio,0 ,16 ); + mr =memory_region_new_alias (o,"sii3112.bar4" , mmio,0 ,16 );pci_register_bar (dev,4 ,PCI_BASE_ADDRESS_SPACE_IO , mr);qdev_init_gpio_in (ds, sii3112_set_irq,2 ); -for (i =0 ; i <2 ; i++) { +for (int i =0 ; i <2 ; i++) {ide_bus_init (&s->bus[i],sizeof (s->bus[i]), ds, i,1 );ide_bus_init_output_irq (&s->bus[i],qdev_get_gpio_in (ds, i));
Signature · 1 line
2.41.3
PATCH v4 4/6 hw/pci-host/articia: Map PCI memory windows in realize
In reply to BALATON ZoltanThese memory windows are a result of the address decoding in the Articia S north bridge so better model it there and not in board code.
--- hw/pci-host/articia.c | 14 +++++++++++++- hw/ppc/amigaone.c | 28 +++++----------------------- hw/ppc/pegasos.c | 13 ------------- 3 files changed, 18 insertions(+), 37 deletions(-)
hw/pci-host/articia.c +13 -1
@@ -22,6 +22,11 @@* Most features are missing but those are not needed by firmware and guests. */ +#define PCI_HIGH_ADDR 0x80000000 +#define PCI_HIGH_SIZE 0x7d000000 +#define PCI_LOW_ADDR 0xfd000000 +#define PCI_LOW_SIZE 0x1000000 + OBJECT_DECLARE_SIMPLE_TYPE(ArticiaState, ARTICIA)OBJECT_DECLARE_SIMPLE_TYPE (ArticiaHostState,ARTICIA_PCI_HOST )
@@ -169,6 +174,7 @@ static void articia_realize(DeviceState *dev, Error **errp) {ArticiaState *s =ARTICIA (dev);PCIHostState *h =PCI_HOST_BRIDGE (dev); +MemoryRegion *mr;PCIDevice *pdev;bitbang_i2c_init (&s->smbus,i2c_init_bus (dev,"smbus" ));
@@ -181,6 +187,13 @@ static void articia_realize(DeviceState *dev, Error **errp) TYPE_ARTICIA, 0x1000000);memory_region_add_subregion_overlap (&s->reg,0 , &s->io,1 ); + mr =memory_region_new_alias (OBJECT (dev),"pci-mem-low" , &s->mem,0 , +PCI_LOW_SIZE ); +memory_region_add_subregion (get_system_memory (),PCI_LOW_ADDR , mr); + mr =memory_region_new_alias (OBJECT (dev),"pci-mem-high" , &s->mem, +PCI_HIGH_ADDR ,PCI_HIGH_SIZE ); +memory_region_add_subregion (get_system_memory (),PCI_HIGH_ADDR , mr); +/* devfn_min is 8 that matches first PCI slot in AmigaOne */ h->bus = pci_register_root_bus(dev, NULL, articia_pcihost_set_irq, amigaone_pcihost_bus0_map_irq, dev, &s->mem,
@@ -191,7 +204,6 @@ static void articia_realize(DeviceState *dev, Error **errp)pci_create_simple (h->bus,PCI_DEVFN (0 ,1 ),TYPE_ARTICIA_PCI_BRIDGE );sysbus_init_mmio (SYS_BUS_DEVICE (dev), &s->reg); -sysbus_init_mmio (SYS_BUS_DEVICE (dev), &s->mem);qdev_init_gpio_out (dev, s->irq,ARRAY_SIZE (s->irq)); }
hw/ppc/amigaone.c +5 -23
@@ -35,13 +35,6 @@#define INITRD_MIN_ADDR 0x600000#define INIT_RAM_ADDR 0x40000000 -#define PCI_HIGH_ADDR 0x80000000 -#define PCI_HIGH_SIZE 0x7d000000 -#define PCI_LOW_ADDR 0xfd000000 -#define PCI_LOW_SIZE 0xe0000 - -#define ARTICIA_ADDR 0xfe000000 -/* * Firmware binary available at * https://www.hyperion-entertainment.com/index.php/downloads?view=files&parent=28
@@ -267,7 +260,7 @@ static void amigaone_init(MachineState *machine) {PowerPCCPU *cpu;CPUPPCState *env; -MemoryRegion *rom, *pci_mem, *mr; +MemoryRegion *rom, *mr;ssize_t sz;PCIBus *pci_bus;Object *via;
@@ -308,8 +301,8 @@ static void amigaone_init(MachineState *machine)qdev_prop_set_drive (dev,"drive" ,blk_by_legacy_dinfo (di)); }sysbus_realize_and_unref (SYS_BUS_DEVICE (dev), &error_fatal); -memory_region_add_subregion (get_system_memory (),NVRAM_ADDR , -sysbus_mmio_get_region (SYS_BUS_DEVICE (dev),0 )); + mr =sysbus_mmio_get_region (SYS_BUS_DEVICE (dev),0 ); +memory_region_add_subregion_overlap (get_system_memory (),NVRAM_ADDR , mr,1 );/* allocate and load firmware */ rom =g_new (MemoryRegion,1 );
@@ -329,8 +322,8 @@ static void amigaone_init(MachineState *machine) }/* Articia S */ - dev =sysbus_create_simple (TYPE_ARTICIA ,ARTICIA_ADDR ,NULL ); - + dev =sysbus_create_simple (TYPE_ARTICIA ,0xfe000000 ,NULL ); + pci_bus =PCI_BUS (qdev_get_child_bus (dev,"pci.0" )); i2c_bus =I2C_BUS (qdev_get_child_bus (dev,"smbus" ));if (machine->ram_size >512 * MiB) { spd_data =spd_data_generate (SDR , machine->ram_size /2 );
@@ -343,17 +336,6 @@ static void amigaone_init(MachineState *machine)smbus_eeprom_init_one (i2c_bus,0x52 , spd_data); } - pci_mem =sysbus_mmio_get_region (SYS_BUS_DEVICE (dev),1 ); - mr =g_new (MemoryRegion,1 ); -memory_region_init_alias (mr,OBJECT (dev),"pci-mem-low" , pci_mem, -0 ,PCI_LOW_SIZE ); -memory_region_add_subregion (get_system_memory (),PCI_LOW_ADDR , mr); - mr =g_new (MemoryRegion,1 ); -memory_region_init_alias (mr,OBJECT (dev),"pci-mem-high" , pci_mem, -PCI_HIGH_ADDR ,PCI_HIGH_SIZE ); -memory_region_add_subregion (get_system_memory (),PCI_HIGH_ADDR , mr); - pci_bus =PCI_BUS (qdev_get_child_bus (dev,"pci.0" )); -/* VIA VT82c686B South Bridge (multifunction PCI device) */ via =OBJECT (pci_create_simple_multifunction (pci_bus,PCI_DEVFN (7 ,0 ),TYPE_VT82C686B_ISA ));
hw/ppc/pegasos.c +0 -13
@@ -213,23 +213,10 @@ static void pegasos_init(MachineState *machine)/* north bridge */ switch (pm->type) {case PEGASOS1 : - { -MemoryRegion *pci_mem, *mr; -/* Articia S */ pm->nb =DEVICE (sysbus_create_simple (TYPE_ARTICIA ,0xfe000000 ,NULL )); - pci_mem =sysbus_mmio_get_region (SYS_BUS_DEVICE (pm->nb),1 ); - mr =g_new (MemoryRegion,1 ); -memory_region_init_alias (mr,OBJECT (pm->nb),"pci-mem-low" , pci_mem, -0 ,0x1000000 ); -memory_region_add_subregion (get_system_memory (),0xfd000000 , mr); - mr =g_new (MemoryRegion,1 ); -memory_region_init_alias (mr,OBJECT (pm->nb),"pci-mem-high" , pci_mem, -0x80000000 ,0x7d000000 ); -memory_region_add_subregion (get_system_memory (),0x80000000 , mr); pci_bus =PCI_BUS (qdev_get_child_bus (pm->nb,"pci.0" ));break ; - }case PEGASOS2 :/* Marvell Discovery II system controller */ pm->nb = DEVICE(sysbus_create_simple(TYPE_MV64361, -1,
Signature · 1 line
2.41.3
PATCH v4 5/6 hw/pci-host/articia: Add variable for common type cast
In reply to BALATON ZoltanWe need the device casted to OBJECT often enough in realize to store it in a local variable that also makes function calls more readable.
--- hw/pci-host/articia.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
hw/pci-host/articia.c +8 -8
@@ -174,24 +174,24 @@ static void articia_realize(DeviceState *dev, Error **errp) {ArticiaState *s =ARTICIA (dev);PCIHostState *h =PCI_HOST_BRIDGE (dev); +Object *o =OBJECT (dev);MemoryRegion *mr;PCIDevice *pdev;bitbang_i2c_init (&s->smbus,i2c_init_bus (dev,"smbus" )); -memory_region_init_io (&s->gpio_reg,OBJECT (s), &articia_gpio_ops, s, +memory_region_init_io (&s->gpio_reg, o, &articia_gpio_ops, s,TYPE_ARTICIA ,4 ); -memory_region_init (&s->mem,OBJECT (dev),"pci-mem" ,UINT64_MAX ); -memory_region_init (&s->io,OBJECT (dev),"pci-io" ,0xc00000 ); -memory_region_init_io (&s->reg,OBJECT (s), &articia_reg_ops, s, +memory_region_init (&s->mem, o,"pci-mem" ,UINT64_MAX ); +memory_region_init (&s->io, o,"pci-io" ,0xc00000 ); +memory_region_init_io (&s->reg, o, &articia_reg_ops, s,TYPE_ARTICIA ,0x1000000 );memory_region_add_subregion_overlap (&s->reg,0 , &s->io,1 ); - mr =memory_region_new_alias (OBJECT (dev),"pci-mem-low" , &s->mem,0 , -PCI_LOW_SIZE ); + mr =memory_region_new_alias (o,"pci-mem-low" , &s->mem,0 ,PCI_LOW_SIZE );memory_region_add_subregion (get_system_memory (),PCI_LOW_ADDR , mr); - mr =memory_region_new_alias (OBJECT (dev),"pci-mem-high" , &s->mem, -PCI_HIGH_ADDR ,PCI_HIGH_SIZE ); + mr =memory_region_new_alias (o,"pci-mem-high" , &s->mem,PCI_HIGH_ADDR , +PCI_HIGH_SIZE );memory_region_add_subregion (get_system_memory (),PCI_HIGH_ADDR , mr);/* devfn_min is 8 that matches first PCI slot in AmigaOne */
Signature · 1 line
2.41.3
PATCH v4 6/6 hw/xtensa/xtfpga: Fix leaking memory region
In reply to BALATON ZoltanUse memory_region_new_ram to avoid leaking memory region.
--- hw/xtensa/xtfpga.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)
hw/xtensa/xtfpga.c +2 -3
@@ -161,9 +161,8 @@ static void xtfpga_net_init(MemoryRegion *address_space,memory_region_add_subregion (address_space, descriptors,sysbus_mmio_get_region (s,1 )); - ram =g_malloc (sizeof (*ram)); -memory_region_init_ram (ram,OBJECT (s),"open_eth.ram" ,16 * KiB, - &error_fatal); + ram =memory_region_new_ram (OBJECT (s),"open_eth.ram" ,16 * KiB, + &error_fatal);memory_region_add_subregion (address_space, buffers, ram); }
Signature · 1 line
2.41.3