Skip to contentSkip to conversation

qom: DECLARE_INTERFACE_CHECKER macro

PATCH New Eduardo Habkost 1 participant 3 messages Aug 9, 2021

lore
Share & tools
lore
#0 lore raw

v3 cover qom: DECLARE_INTERFACE_CHECKER macro

This is an alternative to the series:
Subject: [PATCH 0/3] qom: Replace INTERFACE_CHECK with OBJECT_CHECK
https://lore.kernel.org/qemu-devel/[email protected]/

Instead of removing INTERFACE_CHECK completely, keep it but use a DECLARE_INTERFACE_CHECKER macro to define the type checking functions for interface types.

Maybe one day INTERFACE_CHECK/DECLARE_INTERFACE_CHECKER will be completely replaced with OBJECT_CHECK/DECLARE_INSTANCE_CHECKER, but by now it might be useful to keep the distinction between regular objects and interface types. See discussion at
https://lore.kernel.org/qemu-devel/[email protected]

Based-on: <[email protected]>

Changes v2 -> v3:
* Rebased on top of
Subject: [PATCH for-6.2 00/12] qom: Get rid of all manual usage of OBJECT_CHECK & friends
Date: Fri, 6 Aug 2021 17:11:15 -0400
Message-Id: <[email protected]>
https://lore.kernel.org/qemu-devel/[email protected]

Changes v1 -> v2:
* Move declaration after typedefs, so the code actually compiles

Links to previous versions:
v1: https://lore.kernel.org/qemu-devel/[email protected]
v2: https://lore.kernel.org/qemu-devel/[email protected]

Eduardo Habkost (2):
qom: DECLARE_INTERFACE_CHECKER macro
[autoamted] Use DECLARE_INTERFACE_CHECKER macro

 include/hw/acpi/acpi_dev_interface.h |  5 ++---
 include/hw/arm/linux-boot-if.h       |  4 ++--
 include/hw/fw-path-provider.h        |  4 ++--
 include/hw/hotplug.h                 |  4 ++--
 include/hw/intc/intc.h               |  5 ++---
 include/hw/ipmi/ipmi.h               |  4 ++--
 include/hw/isa/isa.h                 |  4 ++--
 include/hw/mem/memory-device.h       |  4 ++--
 include/hw/nmi.h                     |  4 ++--
 include/hw/ppc/pnv_xscom.h           |  4 ++--
 include/hw/ppc/spapr_irq.h           |  4 ++--
 include/hw/ppc/xics.h                |  4 ++--
 include/hw/ppc/xive.h                | 12 ++++++------
 include/hw/rdma/rdma.h               |  5 ++---
 include/hw/rtc/m48t59.h              |  4 ++--
 include/hw/stream.h                  |  4 ++--
 include/hw/vmstate-if.h              |  4 ++--
 include/qom/object.h                 | 14 ++++++++++++++
 include/qom/object_interfaces.h      |  5 ++---
 include/sysemu/tpm.h                 |  4 ++--
 target/arm/idau.h                    |  4 ++--
 tests/unit/check-qom-interface.c     |  4 ++--
 22 files changed, 60 insertions(+), 50 deletions(-)
Signature · 1 line
2.31.1
#1 lore raw

PATCH v3 1/2 qom: DECLARE_INTERFACE_CHECKER macro

The new macro will be similar to DECLARE_INSTANCE_CHECKER, but for interface types (that use INTEFACE_CHECK instead of OBJECT_CHECK).

---
Changes series v1 -> v2: none
Change series v2 -> v3:
* Rebased on top of
[PATCH for-6.2 00/12] qom: Get rid of all manual usage of OBJECT_CHECK & friends
---
Cc: Paolo Bonzini <[email protected]>
Cc: "Daniel P. Berrangé" <[email protected]>
Cc: Eduardo Habkost <[email protected]>
Cc: [email protected]

---
 include/qom/object.h | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
include/qom/object.h +14 -0
index faae0d841fe..4a9d7017d9f 100644
@@ -178,6 +178,20 @@ struct Object
     OBJ_NAME(const void *obj) \
     { return OBJECT_CHECK(InstanceType, obj, TYPENAME); }
 
+/**
+ * DECLARE_INTERFACE_CHECKER:
+ * @InstanceType: instance type
+ * @OBJ_NAME: the object name in uppercase with underscore separators
+ * @TYPENAME: type name
+ *
+ * This macro will provide the instance type cast functions for a
+ * QOM interface type.
+ */
+#define DECLARE_INTERFACE_CHECKER(InstanceType, OBJ_NAME, TYPENAME) \
+    static inline G_GNUC_UNUSED InstanceType * \
+    OBJ_NAME(const void *obj) \
+    { return INTERFACE_CHECK(InstanceType, obj, TYPENAME); }
+
 /**
  * DECLARE_CLASS_CHECKERS:
  * @ClassType: class struct name
Signature · 1 line
2.31.1
#2 lore raw

PATCH v3 2/2 Use DECLARE_INTERFACE_CHECKER macro

In reply to Eduardo Habkost

Replace manual INTERFACE_CHECK macros with DECLARE_INTERFACE_CHECKER, which is less error prone.

Generated using:

 $ ./scripts/codeconverter/converter.py -i \
   --pattern=InterfaceCheckMacro $(g grep -l '' -- '*.[ch]')
---
 include/hw/acpi/acpi_dev_interface.h |  5 ++---
 include/hw/arm/linux-boot-if.h       |  4 ++--
 include/hw/fw-path-provider.h        |  4 ++--
 include/hw/hotplug.h                 |  4 ++--
 include/hw/intc/intc.h               |  5 ++---
 include/hw/ipmi/ipmi.h               |  4 ++--
 include/hw/isa/isa.h                 |  4 ++--
 include/hw/mem/memory-device.h       |  4 ++--
 include/hw/nmi.h                     |  4 ++--
 include/hw/ppc/pnv_xscom.h           |  4 ++--
 include/hw/ppc/spapr_irq.h           |  4 ++--
 include/hw/ppc/xics.h                |  4 ++--
 include/hw/ppc/xive.h                | 12 ++++++------
 include/hw/rdma/rdma.h               |  5 ++---
 include/hw/rtc/m48t59.h              |  4 ++--
 include/hw/stream.h                  |  4 ++--
 include/hw/vmstate-if.h              |  4 ++--
 include/qom/object_interfaces.h      |  5 ++---
 include/sysemu/tpm.h                 |  4 ++--
 target/arm/idau.h                    |  4 ++--
 tests/unit/check-qom-interface.c     |  4 ++--
 21 files changed, 46 insertions(+), 50 deletions(-)
include/hw/acpi/acpi_dev_interface.h +2 -3
index c9c7c17e043..f99b8b380eb 100644
@@ -22,9 +22,8 @@ typedef struct AcpiDeviceIfClass AcpiDeviceIfClass;
 DECLARE_CLASS_CHECKERS(AcpiDeviceIfClass, ACPI_DEVICE_IF,
                        TYPE_ACPI_DEVICE_IF)
 typedef struct AcpiDeviceIf AcpiDeviceIf;
-#define ACPI_DEVICE_IF(obj) \
-     INTERFACE_CHECK(AcpiDeviceIf, (obj), \
-                     TYPE_ACPI_DEVICE_IF)
+DECLARE_INTERFACE_CHECKER(AcpiDeviceIf, ACPI_DEVICE_IF,
+                          TYPE_ACPI_DEVICE_IF)
 
 
 void acpi_send_event(DeviceState *dev, AcpiEventStatusBits event);
include/hw/arm/linux-boot-if.h +2 -2
index 295e282c36e..17b8083f954 100644
@@ -13,8 +13,8 @@ typedef struct ARMLinuxBootIfClass ARMLinuxBootIfClass;
 DECLARE_CLASS_CHECKERS(ARMLinuxBootIfClass, ARM_LINUX_BOOT_IF,
                        TYPE_ARM_LINUX_BOOT_IF)
 typedef struct ARMLinuxBootIf ARMLinuxBootIf;
-#define ARM_LINUX_BOOT_IF(obj) \
-    INTERFACE_CHECK(ARMLinuxBootIf, (obj), TYPE_ARM_LINUX_BOOT_IF)
+DECLARE_INTERFACE_CHECKER(ARMLinuxBootIf, ARM_LINUX_BOOT_IF,
+                          TYPE_ARM_LINUX_BOOT_IF)
 
 
 struct ARMLinuxBootIfClass {
include/hw/fw-path-provider.h +2 -2
index 33d91daed52..639fe9d821a 100644
@@ -26,8 +26,8 @@ typedef struct FWPathProviderClass FWPathProviderClass;
 DECLARE_CLASS_CHECKERS(FWPathProviderClass, FW_PATH_PROVIDER,
                        TYPE_FW_PATH_PROVIDER)
 typedef struct FWPathProvider FWPathProvider;
-#define FW_PATH_PROVIDER(obj) \
-     INTERFACE_CHECK(FWPathProvider, (obj), TYPE_FW_PATH_PROVIDER)
+DECLARE_INTERFACE_CHECKER(FWPathProvider, FW_PATH_PROVIDER,
+                          TYPE_FW_PATH_PROVIDER)
 
 
 struct FWPathProviderClass {
include/hw/hotplug.h +2 -2
index 75d32d69e2b..5dc7435a4c5 100644
@@ -20,8 +20,8 @@ typedef struct HotplugHandlerClass HotplugHandlerClass;
 DECLARE_CLASS_CHECKERS(HotplugHandlerClass, HOTPLUG_HANDLER,
                        TYPE_HOTPLUG_HANDLER)
 typedef struct HotplugHandler HotplugHandler;
-#define HOTPLUG_HANDLER(obj) \
-     INTERFACE_CHECK(HotplugHandler, (obj), TYPE_HOTPLUG_HANDLER)
+DECLARE_INTERFACE_CHECKER(HotplugHandler, HOTPLUG_HANDLER,
+                          TYPE_HOTPLUG_HANDLER)
 
 
 /**
include/hw/intc/intc.h +2 -3
index 7c57c3a0379..a31b5341acb 100644
@@ -9,9 +9,8 @@ typedef struct InterruptStatsProviderClass InterruptStatsProviderClass;
 DECLARE_CLASS_CHECKERS(InterruptStatsProviderClass, INTERRUPT_STATS_PROVIDER,
                        TYPE_INTERRUPT_STATS_PROVIDER)
 typedef struct InterruptStatsProvider InterruptStatsProvider;
-#define INTERRUPT_STATS_PROVIDER(obj) \
-    INTERFACE_CHECK(InterruptStatsProvider, (obj), \
-                    TYPE_INTERRUPT_STATS_PROVIDER)
+DECLARE_INTERFACE_CHECKER(InterruptStatsProvider, INTERRUPT_STATS_PROVIDER,
+                          TYPE_INTERRUPT_STATS_PROVIDER)
 
 
 struct InterruptStatsProviderClass {
include/hw/ipmi/ipmi.h +2 -2
index d655352fa95..983e7366e75 100644
@@ -110,8 +110,8 @@ uint32_t ipmi_next_uuid(void);
  */
 #define TYPE_IPMI_INTERFACE "ipmi-interface"
 typedef struct IPMIInterface IPMIInterface;
-#define IPMI_INTERFACE(obj) \
-     INTERFACE_CHECK(IPMIInterface, (obj), TYPE_IPMI_INTERFACE)
+DECLARE_INTERFACE_CHECKER(IPMIInterface, IPMI_INTERFACE,
+                          TYPE_IPMI_INTERFACE)
 typedef struct IPMIInterfaceClass IPMIInterfaceClass;
 DECLARE_CLASS_CHECKERS(IPMIInterfaceClass, IPMI_INTERFACE,
                        TYPE_IPMI_INTERFACE)
include/hw/isa/isa.h +2 -2
index d4417b34b63..a4a733a1836 100644
@@ -35,8 +35,8 @@ static inline uint16_t applesmc_port(void)
 typedef struct IsaDmaClass IsaDmaClass;
 DECLARE_CLASS_CHECKERS(IsaDmaClass, ISADMA,
                        TYPE_ISADMA)
-#define ISADMA(obj) \
-    INTERFACE_CHECK(IsaDma, (obj), TYPE_ISADMA)
+DECLARE_INTERFACE_CHECKER(IsaDma, ISADMA,
+                          TYPE_ISADMA)
 
 typedef enum {
     ISADMA_TRANSFER_VERIFY,
include/hw/mem/memory-device.h +2 -2
index a83428209b9..bfdc2fc1f56 100644
@@ -23,8 +23,8 @@ typedef struct MemoryDeviceClass MemoryDeviceClass;
 DECLARE_CLASS_CHECKERS(MemoryDeviceClass, MEMORY_DEVICE,
                        TYPE_MEMORY_DEVICE)
 typedef struct MemoryDeviceState MemoryDeviceState;
-#define MEMORY_DEVICE(obj) \
-     INTERFACE_CHECK(MemoryDeviceState, (obj), TYPE_MEMORY_DEVICE)
+DECLARE_INTERFACE_CHECKER(MemoryDeviceState, MEMORY_DEVICE,
+                          TYPE_MEMORY_DEVICE)
 
 
 /**
include/hw/nmi.h +2 -2
index 529ab736f8f..5e087308336 100644
@@ -30,8 +30,8 @@ typedef struct NMIClass NMIClass;
 DECLARE_CLASS_CHECKERS(NMIClass, NMI,
                        TYPE_NMI)
 typedef struct NMIState NMIState;
-#define NMI(obj) \
-     INTERFACE_CHECK(NMIState, (obj), TYPE_NMI)
+DECLARE_INTERFACE_CHECKER(NMIState, NMI,
+                          TYPE_NMI)
 
 
 struct NMIClass {
include/hw/ppc/pnv_xscom.h +2 -2
index 2ff9f7a8d6f..360b723bb85 100644
@@ -25,8 +25,8 @@
 typedef struct PnvXScomInterface PnvXScomInterface;
 
 #define TYPE_PNV_XSCOM_INTERFACE "pnv-xscom-interface"
-#define PNV_XSCOM_INTERFACE(obj) \
-    INTERFACE_CHECK(PnvXScomInterface, (obj), TYPE_PNV_XSCOM_INTERFACE)
+DECLARE_INTERFACE_CHECKER(PnvXScomInterface, PNV_XSCOM_INTERFACE,
+                          TYPE_PNV_XSCOM_INTERFACE)
 typedef struct PnvXScomInterfaceClass PnvXScomInterfaceClass;
 DECLARE_CLASS_CHECKERS(PnvXScomInterfaceClass, PNV_XSCOM_INTERFACE,
                        TYPE_PNV_XSCOM_INTERFACE)
include/hw/ppc/spapr_irq.h +2 -2
index c22a72c9e27..105e1fb4e71 100644
@@ -34,8 +34,8 @@ struct SpaprMachineState;
 typedef struct SpaprInterruptController SpaprInterruptController;
 
 #define TYPE_SPAPR_INTC "spapr-interrupt-controller"
-#define SPAPR_INTC(obj)                                     \
-    INTERFACE_CHECK(SpaprInterruptController, (obj), TYPE_SPAPR_INTC)
+DECLARE_INTERFACE_CHECKER(SpaprInterruptController, SPAPR_INTC,
+                          TYPE_SPAPR_INTC)
 typedef struct SpaprInterruptControllerClass SpaprInterruptControllerClass;
 DECLARE_CLASS_CHECKERS(SpaprInterruptControllerClass, SPAPR_INTC,
                        TYPE_SPAPR_INTC)
include/hw/ppc/xics.h +2 -2
index 00b80b08c27..375e5ce7fb7 100644
@@ -137,8 +137,8 @@ struct ICSIRQState {
 };
 
 #define TYPE_XICS_FABRIC "xics-fabric"
-#define XICS_FABRIC(obj)                                     \
-    INTERFACE_CHECK(XICSFabric, (obj), TYPE_XICS_FABRIC)
+DECLARE_INTERFACE_CHECKER(XICSFabric, XICS_FABRIC,
+                          TYPE_XICS_FABRIC)
 typedef struct XICSFabricClass XICSFabricClass;
 DECLARE_CLASS_CHECKERS(XICSFabricClass, XICS_FABRIC,
                        TYPE_XICS_FABRIC)
include/hw/ppc/xive.h +6 -6
index 445eccfe6b7..7f25b853ae4 100644
@@ -152,8 +152,8 @@
 typedef struct XiveNotifier XiveNotifier;
 
 #define TYPE_XIVE_NOTIFIER "xive-notifier"
-#define XIVE_NOTIFIER(obj)                                     \
-    INTERFACE_CHECK(XiveNotifier, (obj), TYPE_XIVE_NOTIFIER)
+DECLARE_INTERFACE_CHECKER(XiveNotifier, XIVE_NOTIFIER,
+                          TYPE_XIVE_NOTIFIER)
 typedef struct XiveNotifierClass XiveNotifierClass;
 DECLARE_CLASS_CHECKERS(XiveNotifierClass, XIVE_NOTIFIER,
                        TYPE_XIVE_NOTIFIER)
@@ -385,8 +385,8 @@ typedef struct XiveTCTXMatch {
 } XiveTCTXMatch;
 
 #define TYPE_XIVE_PRESENTER "xive-presenter"
-#define XIVE_PRESENTER(obj)                                     \
-    INTERFACE_CHECK(XivePresenter, (obj), TYPE_XIVE_PRESENTER)
+DECLARE_INTERFACE_CHECKER(XivePresenter, XIVE_PRESENTER,
+                          TYPE_XIVE_PRESENTER)
 typedef struct XivePresenterClass XivePresenterClass;
 DECLARE_CLASS_CHECKERS(XivePresenterClass, XIVE_PRESENTER,
                        TYPE_XIVE_PRESENTER)
@@ -410,8 +410,8 @@ int xive_presenter_tctx_match(XivePresenter *xptr, XiveTCTX *tctx,
  */
 
 #define TYPE_XIVE_FABRIC "xive-fabric"
-#define XIVE_FABRIC(obj)                                     \
-    INTERFACE_CHECK(XiveFabric, (obj), TYPE_XIVE_FABRIC)
+DECLARE_INTERFACE_CHECKER(XiveFabric, XIVE_FABRIC,
+                          TYPE_XIVE_FABRIC)
 typedef struct XiveFabricClass XiveFabricClass;
 DECLARE_CLASS_CHECKERS(XiveFabricClass, XIVE_FABRIC,
                        TYPE_XIVE_FABRIC)
include/hw/rdma/rdma.h +2 -3
index e64104d631e..b8ebe5767df 100644
@@ -23,9 +23,8 @@ typedef struct RdmaProviderClass RdmaProviderClass;
 DECLARE_CLASS_CHECKERS(RdmaProviderClass, RDMA_PROVIDER,
                        INTERFACE_RDMA_PROVIDER)
 typedef struct RdmaProvider RdmaProvider;
-#define RDMA_PROVIDER(obj) \
-    INTERFACE_CHECK(RdmaProvider, (obj), \
-                    INTERFACE_RDMA_PROVIDER)
+DECLARE_INTERFACE_CHECKER(RdmaProvider, RDMA_PROVIDER,
+                          INTERFACE_RDMA_PROVIDER)
 
 
 struct RdmaProviderClass {
include/hw/rtc/m48t59.h +2 -2
index 0b5beb9e2d6..77aee0bc29d 100644
@@ -35,8 +35,8 @@ typedef struct NvramClass NvramClass;
 DECLARE_CLASS_CHECKERS(NvramClass, NVRAM,
                        TYPE_NVRAM)
 typedef struct Nvram Nvram;
-#define NVRAM(obj) \
-    INTERFACE_CHECK(Nvram, (obj), TYPE_NVRAM)
+DECLARE_INTERFACE_CHECKER(Nvram, NVRAM,
+                          TYPE_NVRAM)
 
 
 struct NvramClass {
include/hw/stream.h +2 -2
index 3190cc0dc73..1c2ae5a99d0 100644
@@ -9,8 +9,8 @@ typedef struct StreamSinkClass StreamSinkClass;
 DECLARE_CLASS_CHECKERS(StreamSinkClass, STREAM_SINK,
                        TYPE_STREAM_SINK)
 typedef struct StreamSink StreamSink;
-#define STREAM_SINK(obj) \
-     INTERFACE_CHECK(StreamSink, (obj), TYPE_STREAM_SINK)
+DECLARE_INTERFACE_CHECKER(StreamSink, STREAM_SINK,
+                          TYPE_STREAM_SINK)
 
 
 typedef void (*StreamCanPushNotifyFn)(void *opaque);
include/hw/vmstate-if.h +2 -2
index 0250956967c..a869e521341 100644
@@ -17,8 +17,8 @@ typedef struct VMStateIfClass VMStateIfClass;
 DECLARE_CLASS_CHECKERS(VMStateIfClass, VMSTATE_IF,
                        TYPE_VMSTATE_IF)
 typedef struct VMStateIf VMStateIf;
-#define VMSTATE_IF(obj)                             \
-    INTERFACE_CHECK(VMStateIf, (obj), TYPE_VMSTATE_IF)
+DECLARE_INTERFACE_CHECKER(VMStateIf, VMSTATE_IF,
+                          TYPE_VMSTATE_IF)
 
 
 struct VMStateIfClass {
include/qom/object_interfaces.h +2 -3
index 57d5f6c0532..253bf62eb36 100644
@@ -11,9 +11,8 @@ typedef struct UserCreatableClass UserCreatableClass;
 DECLARE_CLASS_CHECKERS(UserCreatableClass, USER_CREATABLE,
                        TYPE_USER_CREATABLE)
 typedef struct UserCreatable UserCreatable;
-#define USER_CREATABLE(obj) \
-     INTERFACE_CHECK(UserCreatable, (obj), \
-                     TYPE_USER_CREATABLE)
+DECLARE_INTERFACE_CHECKER(UserCreatable, USER_CREATABLE,
+                          TYPE_USER_CREATABLE)
 
 
 /**
include/sysemu/tpm.h +2 -2
index 4a02a8e0266..7cca7a2960c 100644
@@ -32,8 +32,8 @@ typedef struct TPMIfClass TPMIfClass;
 DECLARE_CLASS_CHECKERS(TPMIfClass, TPM_IF,
                        TYPE_TPM_IF)
 typedef struct TPMIf TPMIf;
-#define TPM_IF(obj)                             \
-    INTERFACE_CHECK(TPMIf, (obj), TYPE_TPM_IF)
+DECLARE_INTERFACE_CHECKER(TPMIf, TPM_IF,
+                          TYPE_TPM_IF)
 
 
 struct TPMIfClass {
target/arm/idau.h +2 -2
index 600ac9066cf..95a18934942 100644
@@ -32,8 +32,8 @@
 
 #define TYPE_IDAU_INTERFACE "idau-interface"
 typedef struct IDAUInterface IDAUInterface;
-#define IDAU_INTERFACE(obj) \
-    INTERFACE_CHECK(IDAUInterface, (obj), TYPE_IDAU_INTERFACE)
+DECLARE_INTERFACE_CHECKER(IDAUInterface, IDAU_INTERFACE,
+                          TYPE_IDAU_INTERFACE)
 typedef struct IDAUInterfaceClass IDAUInterfaceClass;
 DECLARE_CLASS_CHECKERS(IDAUInterfaceClass, IDAU_INTERFACE,
                        TYPE_IDAU_INTERFACE)
tests/unit/check-qom-interface.c +2 -2
index 4f534d09085..bacfd00b05c 100644
@@ -20,8 +20,8 @@ typedef struct TestIfClass TestIfClass;
 DECLARE_CLASS_CHECKERS(TestIfClass, TEST_IF,
                        TYPE_TEST_IF)
 typedef struct TestIf TestIf;
-#define TEST_IF(obj) \
-     INTERFACE_CHECK(TestIf, (obj), TYPE_TEST_IF)
+DECLARE_INTERFACE_CHECKER(TestIf, TEST_IF,
+                          TYPE_TEST_IF)
 
 
 struct TestIfClass {
Signature · 1 line
2.31.1