qemu-timer: Make timer_free() imply timer_del()
Subsystems (3)
v2 cover qemu-timer: Make timer_free() imply timer_del()
Currently timer_free() is a simple wrapper for g_free(). This means that the timer being freed must not be currently active, as otherwise QEMU might crash later when the active list is processed and still has a pointer to freed memory on it. As a result almost all calls to timer_free() are preceded by a timer_del() call, as can be seen in the output of
git grep -B1 '\<timer_free\>'
This is unfortunate API design as it makes it easy to accidentally misuse (by forgetting the timer_del()), and the correct use is annoyingly verbose.
Patch 1 makes timer_free() call timer_del() if the timer is active. Patch 2 is a Coccinelle script to remove any timer_del() calls that are immediately before the timer_free().
Patch 3 is the result of running the Coccinelle script on the whole tree.
Patch 4 makes a by-hand cleanup of a bit of the Arm CPU code not caught by Coccinelle because it included a pointless timer_deinit() between timer_del() and timer_free().
I could split up patch 3, but for 58 deleted lines over 42 files created entirely automatedly, it seemed to me to be simpler as one patch.
Changes v1->v2:
* patch 1: unconditionally call timer_del() rather than trying to be clever
* patch 4: new patch
thanks
-- PMM
Peter Maydell (4):
util/qemu-timer: Make timer_free() imply timer_del() scripts/coccinelle: New script to remove unnecessary timer_del() calls Remove superfluous timer_del() calls
target/arm: Remove timer_del()/timer_deinit() before timer_free()
scripts/coccinelle/timer-del-timer-free.cocci | 18 +++++++++++++ include/qemu/timer.h | 25 +++++++++++-------- block/iscsi.c | 2 -- block/nbd.c | 1 - block/qcow2.c | 1 - hw/block/nvme.c | 2 -- hw/char/serial.c | 2 -- hw/char/virtio-serial-bus.c | 2 -- hw/ide/core.c | 1 - hw/input/hid.c | 1 - hw/intc/apic.c | 1 - hw/intc/ioapic.c | 1 - hw/ipmi/ipmi_bmc_extern.c | 1 - hw/net/e1000.c | 3 --- hw/net/e1000e_core.c | 8 ------ hw/net/pcnet-pci.c | 1 - hw/net/rtl8139.c | 1 - hw/net/spapr_llan.c | 1 - hw/net/virtio-net.c | 2 -- hw/s390x/s390-pci-inst.c | 1 - hw/sd/sd.c | 1 - hw/sd/sdhci.c | 2 -- hw/usb/dev-hub.c | 1 - hw/usb/hcd-ehci.c | 1 - hw/usb/hcd-ohci-pci.c | 1 - hw/usb/hcd-uhci.c | 1 - hw/usb/hcd-xhci.c | 1 - hw/usb/redirect.c | 1 - hw/vfio/display.c | 1 - hw/virtio/vhost-vsock-common.c | 1 - hw/virtio/virtio-balloon.c | 1 - hw/virtio/virtio-rng.c | 1 - hw/watchdog/wdt_diag288.c | 1 - hw/watchdog/wdt_i6300esb.c | 1 - migration/colo.c | 1 - monitor/hmp-cmds.c | 1 - net/announce.c | 1 - net/colo-compare.c | 1 - net/slirp.c | 1 - replay/replay-debugging.c | 1 - target/arm/cpu.c | 2 -- target/s390x/cpu.c | 2 -- ui/console.c | 1 - ui/spice-core.c | 1 - util/throttle.c | 1 - 45 files changed, 32 insertions(+), 71 deletions(-) create mode 100644 scripts/coccinelle/timer-del-timer-free.cocci
Signature · 1 line
2.20.1
PATCH v2 1/4 util/qemu-timer: Make timer_free() imply timer_del()
Currently timer_free() is a simple wrapper for g_free(). This means that the timer being freed must not be currently active, as otherwise QEMU might crash later when the active list is processed and still has a pointer to freed memory on it. As a result almost all calls to timer_free() are preceded by a timer_del() call, as can be seen in the output of
git grep -B1 '\<timer_free\>'
This is unfortunate API design as it makes it easy to accidentally misuse (by forgetting the timer_del()), and the correct use is annoyingly verbose.
Make timer_free() imply a timer_del().
--- include/qemu/timer.h | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-)
include/qemu/timer.h +14 -11
@@ -609,17 +609,6 @@ static inline QEMUTimer *timer_new_ms(QEMUClockType type, QEMUTimerCB *cb,*/ void timer_deinit (QEMUTimer *ts); -/** -* timer_free: -* @ts: the timer -* -* Free a timer (it must not be on the active list) -*/ -static inline void timer_free (QEMUTimer *ts) -{ -g_free (ts); -} -/** * timer_del: * @ts: the timer
@@ -631,6 +620,20 @@ static inline void timer_free(QEMUTimer *ts)*/ void timer_del (QEMUTimer *ts); +/** +* timer_free: +* @ts: the timer +* +* Free a timer. This will call timer_del() for you to remove +* the timer from the active list if it was still active. +*/ +static inline void timer_free (QEMUTimer *ts) +{ + +timer_del (ts); +g_free (ts); +} +/** * timer_mod_ns: * @ts: the timer
Signature · 1 line
2.20.1
Re: [PATCH v2 1/4] util/qemu-timer: Make timer_free() imply timer_del()
include/qemu/timer.h static inline void timer_free(QEMUTimer *ts) · line 633
Quoted 4 lines · Peter Maydell
include/qemu/timer.h +4
-0+static inline void timer_free (QEMUTimer *ts) +{ + +timer_del (ts);
Extra whitespace. Otherwise,
r~
PATCH v2 2/4 scripts/coccinelle: New script to remove unnecessary timer_del() calls
In reply to Peter MaydellNow that timer_free() implicitly calls timer_del(), sequences
timer_del(mytimer);
timer_free(mytimer);
can be simplified to just
timer_free(mytimer);
Add a Coccinelle script to do this transformation.
--- scripts/coccinelle/timer-del-timer-free.cocci | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 scripts/coccinelle/timer-del-timer-free.cocci
scripts/coccinelle/timer-del-timer-free.cocci new file +18 -0
@@ -0,0 +1,18 @@ +// Remove superfluous timer_del() calls +// +// Copyright Linaro Limited 2020 +// This work is licensed under the terms of the GNU GPLv2 or later. +// +// spatch --macro-file scripts/cocci-macro-file.h \ +// --sp-file scripts/coccinelle/timer-del-timer-free.cocci \ +// --in-place --dir . +// +// The timer_free() function now implicitly calls timer_del() +// for you, so calls to timer_del() immediately before the +// timer_free() of the same timer can be deleted. + +@@ +expression T; +@@ +-timer_del(T); + timer_free(T);
Signature · 1 line
2.20.1
Re: [PATCH v2 2/4] scripts/coccinelle: New script to remove unnecessary timer_del() calls
Quoted 8 lines · Peter Maydell
Now that
timer_free()implicitly callstimer_del(), sequences
timer_del(mytimer);
timer_free(mytimer);can be simplified to just
timer_free(mytimer);
Quoted 8 lines
Add a Coccinelle script to do this transformation.
Signed-off-by Peter Maydell <[email protected]>Acked-by Paolo Bonzini <[email protected]>--- scripts/coccinelle/timer-del-timer-free.cocci | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 scripts/coccinelle/timer-del-timer-free.cocci
r~
PATCH v2 3/4 Remove superfluous timer_del() calls
In reply to Peter MaydellThis commit is the result of running the timer-del-timer-free.cocci script on the whole source tree.
--- block/iscsi.c | 2 -- block/nbd.c | 1 - block/qcow2.c | 1 - hw/block/nvme.c | 2 -- hw/char/serial.c | 2 -- hw/char/virtio-serial-bus.c | 2 -- hw/ide/core.c | 1 - hw/input/hid.c | 1 - hw/intc/apic.c | 1 - hw/intc/ioapic.c | 1 - hw/ipmi/ipmi_bmc_extern.c | 1 - hw/net/e1000.c | 3 --- hw/net/e1000e_core.c | 8 -------- hw/net/pcnet-pci.c | 1 - hw/net/rtl8139.c | 1 - hw/net/spapr_llan.c | 1 - hw/net/virtio-net.c | 2 -- hw/s390x/s390-pci-inst.c | 1 - hw/sd/sd.c | 1 - hw/sd/sdhci.c | 2 -- hw/usb/dev-hub.c | 1 - hw/usb/hcd-ehci.c | 1 - hw/usb/hcd-ohci-pci.c | 1 - hw/usb/hcd-uhci.c | 1 - hw/usb/hcd-xhci.c | 1 - hw/usb/redirect.c | 1 - hw/vfio/display.c | 1 - hw/virtio/vhost-vsock-common.c | 1 - hw/virtio/virtio-balloon.c | 1 - hw/virtio/virtio-rng.c | 1 - hw/watchdog/wdt_diag288.c | 1 - hw/watchdog/wdt_i6300esb.c | 1 - migration/colo.c | 1 - monitor/hmp-cmds.c | 1 - net/announce.c | 1 - net/colo-compare.c | 1 - net/slirp.c | 1 - replay/replay-debugging.c | 1 - target/s390x/cpu.c | 2 -- ui/console.c | 1 - ui/spice-core.c | 1 - util/throttle.c | 1 - 42 files changed, 58 deletions(-)
block/iscsi.c +0 -2
@@ -1524,12 +1524,10 @@ static void iscsi_detach_aio_context(BlockDriverState *bs) iscsilun->events =0 ;if (iscsilun->nop_timer) { -timer_del (iscsilun->nop_timer);timer_free (iscsilun->nop_timer); iscsilun->nop_timer =NULL ; }if (iscsilun->event_timer) { -timer_del (iscsilun->event_timer);timer_free (iscsilun->event_timer); iscsilun->event_timer =NULL ; }
block/nbd.c +0 -1
@@ -194,7 +194,6 @@ static void nbd_recv_coroutines_wake_all(BDRVNBDState *s)static void reconnect_delay_timer_del (BDRVNBDState *s) {if (s->reconnect_delay_timer) { -timer_del (s->reconnect_delay_timer);timer_free (s->reconnect_delay_timer); s->reconnect_delay_timer =NULL ; }
block/qcow2.c +0 -1
@@ -852,7 +852,6 @@ static void cache_clean_timer_del(BlockDriverState *bs) {BDRVQcow2State *s = bs->opaque;if (s->cache_clean_timer) { -timer_del (s->cache_clean_timer);timer_free (s->cache_clean_timer); s->cache_clean_timer =NULL ; }
hw/block/nvme.c +0 -2
@@ -1052,7 +1052,6 @@ static uint16_t nvme_io_cmd(NvmeCtrl *n, NvmeRequest *req)static void nvme_free_sq (NvmeSQueue *sq,NvmeCtrl *n) { n->sq[sq->sqid] =NULL ; -timer_del (sq->timer);timer_free (sq->timer);g_free (sq->io_req);if (sq->sqid) {
@@ -1334,7 +1333,6 @@ static uint16_t nvme_get_log(NvmeCtrl *n, NvmeRequest *req)static void nvme_free_cq (NvmeCQueue *cq,NvmeCtrl *n) { n->cq[cq->cqid] =NULL ; -timer_del (cq->timer);timer_free (cq->timer);msix_vector_unuse (&n->parent_obj, cq->vector);if (cq->cqid) {
hw/char/serial.c +0 -2
@@ -940,10 +940,8 @@ static void serial_unrealize(DeviceState *dev)qemu_chr_fe_deinit (&s->chr, false); -timer_del (s->modem_status_poll);timer_free (s->modem_status_poll); -timer_del (s->fifo_timeout_timer);timer_free (s->fifo_timeout_timer);fifo8_destroy (&s->recv_fifo);
hw/char/virtio-serial-bus.c +0 -2
@@ -741,7 +741,6 @@ static void virtio_serial_post_load_timer_cb(void *opaque) } }g_free (s->post_load->connected); -timer_del (s->post_load->timer);timer_free (s->post_load->timer);g_free (s->post_load); s->post_load =NULL ;
@@ -1138,7 +1137,6 @@ static void virtio_serial_device_unrealize(DeviceState *dev)g_free (vser->ports_map);if (vser->post_load) {g_free (vser->post_load->connected); -timer_del (vser->post_load->timer);timer_free (vser->post_load->timer);g_free (vser->post_load); }
hw/ide/core.c +0 -1
@@ -2716,7 +2716,6 @@ void ide_init2(IDEBus *bus, qemu_irq irq)void ide_exit (IDEState *s) { -timer_del (s->sector_write_timer);timer_free (s->sector_write_timer);qemu_vfree (s->smart_selftest_data);qemu_vfree (s->io_buffer);
hw/input/hid.c +0 -1
@@ -88,7 +88,6 @@ static void hid_idle_timer(void *opaque)static void hid_del_idle_timer (HIDState *hs) {if (hs->idle_timer) { -timer_del (hs->idle_timer);timer_free (hs->idle_timer); hs->idle_timer =NULL ; }
hw/intc/apic.c +0 -1
@@ -888,7 +888,6 @@ static void apic_unrealize(DeviceState *dev) {APICCommonState *s =APIC (dev); -timer_del (s->timer);timer_free (s->timer); local_apics[s->id] =NULL ; }
hw/intc/ioapic.c +0 -1
@@ -474,7 +474,6 @@ static void ioapic_unrealize(DeviceState *dev) {IOAPICCommonState *s =IOAPIC_COMMON (dev); -timer_del (s->delayed_ioapic_service_timer);timer_free (s->delayed_ioapic_service_timer); }
hw/ipmi/ipmi_bmc_extern.c +0 -1
@@ -510,7 +510,6 @@ static void ipmi_bmc_extern_finalize(Object *obj) {IPMIBmcExtern *ibe =IPMI_BMC_EXTERN (obj); -timer_del (ibe->extern_timer);timer_free (ibe->extern_timer); }
hw/net/e1000.c +0 -3
@@ -1647,11 +1647,8 @@ pci_e1000_uninit(PCIDevice *dev) {E1000State *d =E1000 (dev); -timer_del (d->autoneg_timer);timer_free (d->autoneg_timer); -timer_del (d->mit_timer);timer_free (d->mit_timer); -timer_del (d->flush_queue_timer);timer_free (d->flush_queue_timer);qemu_del_nic (d->nic); }
hw/net/e1000e_core.c +0 -8
@@ -434,23 +434,16 @@ e1000e_intrmgr_pci_unint(E1000ECore *core) {int i; -timer_del (core->radv.timer);timer_free (core->radv.timer); -timer_del (core->rdtr.timer);timer_free (core->rdtr.timer); -timer_del (core->raid.timer);timer_free (core->raid.timer); -timer_del (core->tadv.timer);timer_free (core->tadv.timer); -timer_del (core->tidv.timer);timer_free (core->tidv.timer); -timer_del (core->itr.timer);timer_free (core->itr.timer);for (i =0 ; i <E1000E_MSIX_VEC_NUM ; i++) { -timer_del (core->eitr[i].timer);timer_free (core->eitr[i].timer); } }
@@ -3355,7 +3348,6 @@ e1000e_core_pci_uninit(E1000ECore *core) {int i; -timer_del (core->autoneg_timer);timer_free (core->autoneg_timer);e1000e_intrmgr_pci_unint (core);
hw/net/pcnet-pci.c +0 -1
@@ -183,7 +183,6 @@ static void pci_pcnet_uninit(PCIDevice *dev)PCIPCNetState *d =PCI_PCNET (dev);qemu_free_irq (d->state.irq); -timer_del (d->state.poll_timer);timer_free (d->state.poll_timer);qemu_del_nic (d->state.nic); }
hw/net/rtl8139.c +0 -1
@@ -3338,7 +3338,6 @@ static void pci_rtl8139_uninit(PCIDevice *dev)g_free (s->cplus_txbuffer); s->cplus_txbuffer =NULL ; -timer_del (s->timer);timer_free (s->timer);qemu_del_nic (s->nic); }
hw/net/spapr_llan.c +0 -1
@@ -363,7 +363,6 @@ static void spapr_vlan_instance_finalize(Object *obj) }if (dev->rxp_timer) { -timer_del (dev->rxp_timer);timer_free (dev->rxp_timer); } }
hw/net/virtio-net.c +0 -2
@@ -1869,7 +1869,6 @@ static void virtio_net_rsc_cleanup(VirtIONet *n)g_free (seg); } -timer_del (chain->drain_timer);timer_free (chain->drain_timer);QTAILQ_REMOVE (&n->rsc_chains, chain, next);g_free (chain);
@@ -2652,7 +2651,6 @@ static void virtio_net_del_queue(VirtIONet *n, int index)virtio_del_queue (vdev, index *2 );if (q->tx_timer) { -timer_del (q->tx_timer);timer_free (q->tx_timer); q->tx_timer =NULL ; }else {
hw/s390x/s390-pci-inst.c +0 -1
@@ -953,7 +953,6 @@ void pci_dereg_ioat(S390PCIIOMMU *iommu)void fmb_timer_free (S390PCIBusDevice *pbdev) {if (pbdev->fmb_timer) { -timer_del (pbdev->fmb_timer);timer_free (pbdev->fmb_timer); pbdev->fmb_timer =NULL ; }
hw/sd/sd.c +0 -1
@@ -2132,7 +2132,6 @@ static void sd_instance_finalize(Object *obj) {SDState *sd =SD_CARD (obj); -timer_del (sd->ocr_power_timer);timer_free (sd->ocr_power_timer); }
hw/sd/sdhci.c +0 -2
@@ -1330,9 +1330,7 @@ void sdhci_initfn(SDHCIState *s)void sdhci_uninitfn (SDHCIState *s) { -timer_del (s->insert_timer);timer_free (s->insert_timer); -timer_del (s->transfer_timer);timer_free (s->transfer_timer);g_free (s->fifo_buffer);
hw/usb/dev-hub.c +0 -1
@@ -576,7 +576,6 @@ static void usb_hub_unrealize(USBDevice *dev) &s->ports[i].port); } -timer_del (s->port_timer);timer_free (s->port_timer); }
hw/usb/hcd-ehci.c +0 -1
@@ -2534,7 +2534,6 @@ void usb_ehci_unrealize(EHCIState *s, DeviceState *dev)trace_usb_ehci_unrealize ();if (s->frame_timer) { -timer_del (s->frame_timer);timer_free (s->frame_timer); s->frame_timer =NULL ; }
hw/usb/hcd-ohci-pci.c +0 -1
@@ -97,7 +97,6 @@ static void usb_ohci_exit(PCIDevice *dev)usb_bus_release (&s->bus); } -timer_del (s->eof_timer);timer_free (s->eof_timer); }
hw/usb/hcd-uhci.c +0 -1
@@ -1283,7 +1283,6 @@ static void usb_uhci_exit(PCIDevice *dev)trace_usb_uhci_exit ();if (s->frame_timer) { -timer_del (s->frame_timer);timer_free (s->frame_timer); s->frame_timer =NULL ; }
hw/usb/hcd-xhci.c +0 -1
@@ -3395,7 +3395,6 @@ static void usb_xhci_unrealize(DeviceState *dev) }if (xhci->mfwrap_timer) { -timer_del (xhci->mfwrap_timer);timer_free (xhci->mfwrap_timer); xhci->mfwrap_timer =NULL ; }
hw/usb/redirect.c +0 -1
@@ -1480,7 +1480,6 @@ static void usbredir_unrealize(USBDevice *udev)qemu_bh_delete (dev->chardev_close_bh);qemu_bh_delete (dev->device_reject_bh); -timer_del (dev->attach_timer);timer_free (dev->attach_timer);usbredir_cleanup_device_queues (dev);
hw/vfio/display.c +0 -1
@@ -186,7 +186,6 @@ static void vfio_display_edid_exit(VFIODisplay *dpy)g_free (dpy->edid_regs);g_free (dpy->edid_blob); -timer_del (dpy->edid_link_timer);timer_free (dpy->edid_link_timer); }
hw/virtio/vhost-vsock-common.c +0 -1
@@ -151,7 +151,6 @@ static void vhost_vsock_common_post_load_timer_cleanup(VHostVSockCommon *vvc)return ; } -timer_del (vvc->post_load_timer);timer_free (vvc->post_load_timer); vvc->post_load_timer =NULL ; }
hw/virtio/virtio-balloon.c +0 -1
@@ -204,7 +204,6 @@ static bool balloon_stats_enabled(const VirtIOBalloon *s)static void balloon_stats_destroy_timer (VirtIOBalloon *s) {if (balloon_stats_enabled (s)) { -timer_del (s->stats_timer);timer_free (s->stats_timer); s->stats_timer =NULL ; s->stats_poll_interval =0 ;
hw/virtio/virtio-rng.c +0 -1
@@ -233,7 +233,6 @@ static void virtio_rng_device_unrealize(DeviceState *dev)VirtIORNG *vrng =VIRTIO_RNG (dev);qemu_del_vm_change_state_handler (vrng->vmstate); -timer_del (vrng->rate_limit_timer);timer_free (vrng->rate_limit_timer);virtio_del_queue (vdev,0 );virtio_cleanup (vdev);
hw/watchdog/wdt_diag288.c +0 -1
@@ -110,7 +110,6 @@ static void wdt_diag288_unrealize(DeviceState *dev) {DIAG288State *diag288 =DIAG288 (dev); -timer_del (diag288->timer);timer_free (diag288->timer); }
hw/watchdog/wdt_i6300esb.c +0 -1
@@ -454,7 +454,6 @@ static void i6300esb_exit(PCIDevice *dev) {I6300State *d =WATCHDOG_I6300ESB_DEVICE (dev); -timer_del (d->timer);timer_free (d->timer); }
migration/colo.c +0 -1
@@ -636,7 +636,6 @@ out:* error. */ colo_compare_unregister_notifier (&packets_compare_notifier); -timer_del (s->colo_delay_timer);timer_free (s->colo_delay_timer);qemu_event_destroy (&s->colo_checkpoint_event);
monitor/hmp-cmds.c +0 -1
@@ -1586,7 +1586,6 @@ static void hmp_migrate_status_cb(void *opaque)error_report ("%s" , info->error_desc); }monitor_resume (status->mon); -timer_del (status->timer);timer_free (status->timer);g_free (status); }
net/announce.c +0 -1
@@ -41,7 +41,6 @@ void qemu_announce_timer_del(AnnounceTimer *timer, bool free_named) {bool free_timer = false;if (timer->tm) { -timer_del (timer->tm);timer_free (timer->tm); timer->tm =NULL ; }
net/colo-compare.c +0 -1
@@ -951,7 +951,6 @@ static void colo_compare_timer_init(CompareState *s)static void colo_compare_timer_del (CompareState *s) {if (s->packet_check_timer) { -timer_del (s->packet_check_timer);timer_free (s->packet_check_timer); s->packet_check_timer =NULL ; }
net/slirp.c +0 -1
@@ -184,7 +184,6 @@ static void *net_slirp_timer_new(SlirpTimerCb cb,static void net_slirp_timer_free (void *timer,void *opaque) { -timer_del (timer);timer_free (timer); }
replay/replay-debugging.c +0 -1
@@ -78,7 +78,6 @@ static void replay_delete_break(void)assert (replay_mutex_locked ());if (replay_break_timer) { -timer_del (replay_break_timer);timer_free (replay_break_timer); replay_break_timer =NULL ; }
target/s390x/cpu.c +0 -2
@@ -313,9 +313,7 @@ static void s390_cpu_finalize(Object *obj)#if !defined(CONFIG_USER_ONLY )S390CPU *cpu =S390_CPU (obj); -timer_del (cpu->env.tod_timer);timer_free (cpu->env.tod_timer); -timer_del (cpu->env.cpu_timer);timer_free (cpu->env.cpu_timer);qemu_unregister_reset (s390_cpu_machine_reset_cb, cpu);
ui/console.c +0 -1
@@ -253,7 +253,6 @@ static void gui_setup_refresh(DisplayState *ds)timer_mod (ds->gui_timer,qemu_clock_get_ms (QEMU_CLOCK_REALTIME )); }if (!need_timer && ds->gui_timer !=NULL ) { -timer_del (ds->gui_timer);timer_free (ds->gui_timer); ds->gui_timer =NULL ; }
ui/spice-core.c +0 -1
@@ -76,7 +76,6 @@ static void timer_cancel(SpiceTimer *timer)static void timer_remove (SpiceTimer *timer) { -timer_del (timer->timer);timer_free (timer->timer);g_free (timer); }
util/throttle.c +0 -1
@@ -247,7 +247,6 @@ static void throttle_timer_destroy(QEMUTimer **timer) {assert (*timer !=NULL ); -timer_del (*timer);timer_free (*timer); *timer =NULL ; }
Signature · 1 line
2.20.1
PATCH v2 4/4 target/arm: Remove timer_del()/timer_deinit() before timer_free()
In reply to Peter MaydellThe Arm CPU finalize function uses a sequence of timer_del(), timer_deinit(), timer_free() to free the timer. The timer_deinit() step in this was always unnecessary, and now the timer_del() is implied by timer_free(), so we can collapse this down to simply calling timer_free().
--- target/arm/cpu.c | 2 -- 1 file changed, 2 deletions(-)
target/arm/cpu.c +0 -2
@@ -1304,8 +1304,6 @@ static void arm_cpu_finalizefn(Object *obj) }#ifndef CONFIG_USER_ONLY if (cpu->pmu_timer) { -timer_del (cpu->pmu_timer); -timer_deinit (cpu->pmu_timer);timer_free (cpu->pmu_timer); }#endif
Signature · 1 line
2.20.1
Re: [PATCH v2 4/4] target/arm: Remove timer_del()/timer_deinit() before timer_free()
Quoted 9 lines · Peter Maydell
The Arm CPU finalize function uses a sequence of
timer_del(),timer_deinit(),timer_free()to free the timer. Thetimer_deinit()step in this was always unnecessary, and now thetimer_del()is implied bytimer_free(), so we can collapse this down to simply callingtimer_free().Signed-off-by Peter Maydell <[email protected]>--- target/arm/cpu.c | 2 -- 1 file changed, 2 deletions(-)
r~
Quoted 78 lines · Peter Maydell
Currently
timer_free()is a simple wrapper forg_free(). This means that the timer being freed must not be currently active, as otherwise QEMU might crash later when the active list is processed and still has a pointer to freed memory on it. As a result almost all calls totimer_free()are preceded by atimer_del()call, as can be seen in the output of
git grep -B1 '\<timer_free\>'This is unfortunate API design as it makes it easy to accidentally misuse (by forgetting the
timer_del()), and the correct use is annoyingly verbose.Patch 1 makes
timer_free()calltimer_del()if the timer is active. Patch 2 is a Coccinelle script to remove anytimer_del()calls that are immediately before thetimer_free().
Patch 3 is the result of running the Coccinelle script on the whole tree.
Patch 4 makes a by-hand cleanup of a bit of the Arm CPU code not caught by Coccinelle because it included a pointlesstimer_deinit()betweentimer_del()andtimer_free().I could split up patch 3, but for 58 deleted lines over 42 files created entirely automatedly, it seemed to me to be simpler as one patch.
Changes
v1->v2:
* patch 1: unconditionally calltimer_del()rather than trying to be clever
* patch 4: new patchthanks
-- PMMPeter Maydell (4):
util/qemu-timer: Maketimer_free()implytimer_del()scripts/coccinelle: New script to remove unnecessarytimer_del()calls Remove superfluoustimer_del()calls
target/arm: Remove timer_del()/timer_deinit() beforetimer_free()scripts/coccinelle/timer-del-timer-free.cocci | 18 +++++++++++++ include/qemu/timer.h | 25 +++++++++++-------- block/iscsi.c | 2 -- block/nbd.c | 1 - block/qcow2.c | 1 - hw/block/nvme.c | 2 -- hw/char/serial.c | 2 -- hw/char/virtio-serial-bus.c | 2 -- hw/ide/core.c | 1 - hw/input/hid.c | 1 - hw/intc/apic.c | 1 - hw/intc/ioapic.c | 1 - hw/ipmi/ipmi_bmc_extern.c | 1 - hw/net/e1000.c | 3 --- hw/net/e1000e_core.c | 8 ------ hw/net/pcnet-pci.c | 1 - hw/net/rtl8139.c | 1 - hw/net/spapr_llan.c | 1 - hw/net/virtio-net.c | 2 -- hw/s390x/s390-pci-inst.c | 1 - hw/sd/sd.c | 1 - hw/sd/sdhci.c | 2 -- hw/usb/dev-hub.c | 1 - hw/usb/hcd-ehci.c | 1 - hw/usb/hcd-ohci-pci.c | 1 - hw/usb/hcd-uhci.c | 1 - hw/usb/hcd-xhci.c | 1 - hw/usb/redirect.c | 1 - hw/vfio/display.c | 1 - hw/virtio/vhost-vsock-common.c | 1 - hw/virtio/virtio-balloon.c | 1 - hw/virtio/virtio-rng.c | 1 - hw/watchdog/wdt_diag288.c | 1 - hw/watchdog/wdt_i6300esb.c | 1 - migration/colo.c | 1 - monitor/hmp-cmds.c | 1 - net/announce.c | 1 - net/colo-compare.c | 1 - net/slirp.c | 1 -
Quoted 9 lines
replay/replay-debugging.c | 1 - target/arm/cpu.c | 2 -- target/s390x/cpu.c | 2 -- ui/console.c | 1 - ui/spice-core.c | 1 - util/throttle.c | 1 - 45 files changed, 32 insertions(+), 71 deletions(-) create mode 100644 scripts/coccinelle/timer-del-timer-free.cocci
Quoted 9 lines · Peter Maydell
Currently
timer_free()is a simple wrapper forg_free(). This means that the timer being freed must not be currently active, as otherwise QEMU might crash later when the active list is processed and still has a pointer to freed memory on it. As a result almost all calls totimer_free()are preceded by atimer_del()call, as can be seen in the output of
git grep -B1 '\<timer_free\>'
Quoted 3 lines
This is unfortunate API design as it makes it easy to accidentally misuse (by forgetting the
timer_del()), and the correct use is annoyingly verbose.
I'll take this via the target-arm queue. Thanks to all for the review.
-- PMM