hw/qdev-core: Fix description of instance_init
PATCH 1/1 hw/qdev-core: Fix description of instance_init
The part of the documentation of DeviceClass that talks about instance_init is partly wrong: instance_init() functions must not abort or exit, since the function is also called during introspection of the device already. So if a device calls exit() during its instance_init() function, QEMU terminates unexpectedly if somebody tries to just have a look at the interfaces from the device with "device_add xyz,help" or with the "device-list-properties" QOM command. This should never happen.
--- include/hw/qdev-core.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
include/hw/qdev-core.h +3 -2
@@ -51,8 +51,9 @@ struct VMStateDescription;* Devices are constructed in two stages, * 1) object instantiation via object_initialize() and * 2) device realization via #DeviceState:realized property. -* The former may not fail (it might assert or exit), the latter may return -* error information to the caller and must be re-entrant. +* The former may not fail (and must not abort or exit, since it is called +* during device introspection already), and the latter may return error +* information to the caller and must be re-entrant. * Trivial field initializations should go into #TypeInfo.instance_init. * Operations depending on @props static properties should go into @realize. * After successful realization, setting static properties will fail.
Signature · 1 line
1.8.3.1
Am 10.09.18 um 10:09 schrieb Thomas Huth:
Quoted 9 lines
The part of the documentation of DeviceClass that talks about
instance_initis partly wrong:instance_init()functions must not abort or exit, since the function is also called during introspection of the device already. So if a device callsexit()during itsinstance_init()function, QEMU terminates unexpectedly if somebody tries to just have a look at the interfaces from the device with "device_addxyz,help" or with the "device-list-properties" QOM command. This should never happen.Signed-off-by Thomas Huth <[email protected]>
Regards,
Andreas
Signature · 3 lines
SUSE Linux GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Jane Smithard, Graham Norton HRB 21284 (AG Nürnberg)
Quoted 9 lines · Thomas Huth
The part of the documentation of DeviceClass that talks about
instance_initis partly wrong:instance_init()functions must not abort or exit, since the function is also called during introspection of the device already. So if a device callsexit()during itsinstance_init()function, QEMU terminates unexpectedly if somebody tries to just have a look at the interfaces from the device with "device_addxyz,help" or with the "device-list-properties" QOM command. This should never happen.Signed-off-by Thomas Huth <[email protected]>
Quoted 21 lines
--- include/hw/qdev-core.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)include/hw/qdev-core.h +3
-2@@ -51,8 +51,9 @@ struct VMStateDescription;* Devices are constructed in two stages, * 1) object instantiation via object_initialize() and * 2) device realization via #DeviceState:realized property. -* The former may not fail (it might assert or exit), the latter may return -* error information to the caller and must be re-entrant. +* The former may not fail (and must not abort or exit, since it is called +* during device introspection already), and the latter may return error +* information to the caller and must be re-entrant. * Trivial field initializations should go into #TypeInfo.instance_init. * Operations depending on @props static properties should go into @realize. * After successful realization, setting static properties will fail.
Quoted 3 lines · Thomas Huth
The part of the documentation of DeviceClass that talks about
instance_initis partly wrong:instance_init()functions must not abort or exit, since the function is also called during introspection of the device already.
I figure it was correct back when the comment was written. It's definitely wrong now.
Quoted 6 lines
So if a device calls
exit()during itsinstance_init()function, QEMU terminates unexpectedly if somebody tries to just have a look at the interfaces from the device with "device_addxyz,help" or with the "device-list-properties" QOM command. This should never happen.Signed-off-by Thomas Huth <[email protected]>