4 * Copyright IBM, Corp. 2011
7 * Anthony Liguori <aliguori@us.ibm.com>
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
20 #include "qemu-queue.h"
26 typedef struct TypeImpl
*Type
;
28 typedef struct ObjectClass ObjectClass
;
29 typedef struct Object Object
;
31 typedef struct TypeInfo TypeInfo
;
33 typedef struct InterfaceClass InterfaceClass
;
34 typedef struct InterfaceInfo InterfaceInfo
;
36 #define TYPE_OBJECT NULL
40 * @title:Base Object Type System
41 * @short_description: interfaces for creating new types and objects
43 * The QEMU Object Model provides a framework for registering user creatable
44 * types and instantiating objects from those types. QOM provides the following
47 * - System for dynamically registering types
48 * - Support for single-inheritance of types
49 * - Multiple inheritance of stateless interfaces
52 * <title>Creating a minimal type</title>
56 * #define TYPE_MY_DEVICE "my-device"
58 * // No new virtual functions: we can reuse the typedef for the
60 * typedef DeviceClass MyDeviceClass;
61 * typedef struct MyDevice
65 * int reg0, reg1, reg2;
68 * static TypeInfo my_device_info = {
69 * .name = TYPE_MY_DEVICE,
70 * .parent = TYPE_DEVICE,
71 * .instance_size = sizeof(MyDevice),
74 * static void my_device_register_types(void)
76 * type_register_static(&my_device_info);
79 * type_init(my_device_register_types)
83 * In the above example, we create a simple type that is described by #TypeInfo.
84 * #TypeInfo describes information about the type including what it inherits
85 * from, the instance and class size, and constructor/destructor hooks.
87 * Every type has an #ObjectClass associated with it. #ObjectClass derivatives
88 * are instantiated dynamically but there is only ever one instance for any
89 * given type. The #ObjectClass typically holds a table of function pointers
90 * for the virtual methods implemented by this type.
92 * Using object_new(), a new #Object derivative will be instantiated. You can
93 * cast an #Object to a subclass (or base-class) type using
94 * object_dynamic_cast(). You typically want to define macro wrappers around
95 * OBJECT_CHECK() and OBJECT_CLASS_CHECK() to make it easier to convert to a
99 * <title>Typecasting macros</title>
101 * #define MY_DEVICE_GET_CLASS(obj) \
102 * OBJECT_GET_CLASS(MyDeviceClass, obj, TYPE_MY_DEVICE)
103 * #define MY_DEVICE_CLASS(klass) \
104 * OBJECT_CLASS_CHECK(MyDeviceClass, klass, TYPE_MY_DEVICE)
105 * #define MY_DEVICE(obj) \
106 * OBJECT_CHECK(MyDevice, obj, TYPE_MY_DEVICE)
110 * # Class Initialization #
112 * Before an object is initialized, the class for the object must be
113 * initialized. There is only one class object for all instance objects
114 * that is created lazily.
116 * Classes are initialized by first initializing any parent classes (if
117 * necessary). After the parent class object has initialized, it will be
118 * copied into the current class object and any additional storage in the
119 * class object is zero filled.
121 * The effect of this is that classes automatically inherit any virtual
122 * function pointers that the parent class has already initialized. All
123 * other fields will be zero filled.
125 * Once all of the parent classes have been initialized, #TypeInfo::class_init
126 * is called to let the class being instantiated provide default initialize for
127 * its virtual functions. Here is how the above example might be modified
128 * to introduce an overridden virtual function:
131 * <title>Overriding a virtual function</title>
135 * void my_device_class_init(ObjectClass *klass, void *class_data)
137 * DeviceClass *dc = DEVICE_CLASS(klass);
138 * dc->reset = my_device_reset;
141 * static TypeInfo my_device_info = {
142 * .name = TYPE_MY_DEVICE,
143 * .parent = TYPE_DEVICE,
144 * .instance_size = sizeof(MyDevice),
145 * .class_init = my_device_class_init,
150 * Introducing new virtual functions requires a class to define its own
151 * struct and to add a .class_size member to the TypeInfo. Each function
152 * will also have a wrapper to call it easily:
155 * <title>Defining an abstract class</title>
159 * typedef struct MyDeviceClass
161 * DeviceClass parent;
163 * void (*frobnicate) (MyDevice *obj);
166 * static TypeInfo my_device_info = {
167 * .name = TYPE_MY_DEVICE,
168 * .parent = TYPE_DEVICE,
169 * .instance_size = sizeof(MyDevice),
170 * .abstract = true, // or set a default in my_device_class_init
171 * .class_size = sizeof(MyDeviceClass),
174 * void my_device_frobnicate(MyDevice *obj)
176 * MyDeviceClass *klass = MY_DEVICE_GET_CLASS(obj);
178 * klass->frobnicate(obj);
185 * Interfaces allow a limited form of multiple inheritance. Instances are
186 * similar to normal types except for the fact that are only defined by
187 * their classes and never carry any state. You can dynamically cast an object
188 * to one of its #Interface types and vice versa.
193 * ObjectPropertyAccessor:
194 * @obj: the object that owns the property
195 * @v: the visitor that contains the property data
196 * @opaque: the object property opaque
197 * @name: the name of the property
198 * @errp: a pointer to an Error that is filled if getting/setting fails.
200 * Called when trying to get/set a property.
202 typedef void (ObjectPropertyAccessor
)(Object
*obj
,
206 struct Error
**errp
);
209 * ObjectPropertyRelease:
210 * @obj: the object that owns the property
211 * @name: the name of the property
212 * @opaque: the opaque registered with the property
214 * Called when a property is removed from a object.
216 typedef void (ObjectPropertyRelease
)(Object
*obj
,
220 typedef struct ObjectProperty
224 ObjectPropertyAccessor
*get
;
225 ObjectPropertyAccessor
*set
;
226 ObjectPropertyRelease
*release
;
229 QTAILQ_ENTRY(ObjectProperty
) node
;
235 * The base for all classes. The only thing that #ObjectClass contains is an
236 * integer type handle.
247 * The base for all objects. The first member of this object is a pointer to
248 * a #ObjectClass. Since C guarantees that the first member of a structure
249 * always begins at byte 0 of that structure, as long as any sub-object places
250 * its parent as the first member, we can cast directly to a #Object.
252 * As a result, #Object contains a reference to the objects type as its
253 * first member. This allows identification of the real type of the object at
256 * #Object also contains a list of #Interfaces that this object
264 QTAILQ_HEAD(, ObjectProperty
) properties
;
271 * @name: The name of the type.
272 * @parent: The name of the parent type.
273 * @instance_size: The size of the object (derivative of #Object). If
274 * @instance_size is 0, then the size of the object will be the size of the
276 * @instance_init: This function is called to initialize an object. The parent
277 * class will have already been initialized so the type is only responsible
278 * for initializing its own members.
279 * @instance_finalize: This function is called during object destruction. This
280 * is called before the parent @instance_finalize function has been called.
281 * An object should only free the members that are unique to its type in this
283 * @abstract: If this field is true, then the class is considered abstract and
284 * cannot be directly instantiated.
285 * @class_size: The size of the class object (derivative of #ObjectClass)
286 * for this object. If @class_size is 0, then the size of the class will be
287 * assumed to be the size of the parent class. This allows a type to avoid
288 * implementing an explicit class type if they are not adding additional
290 * @class_init: This function is called after all parent class initialization
291 * has occurred to allow a class to set its default virtual method pointers.
292 * This is also the function to use to override virtual methods from a parent
294 * @class_finalize: This function is called during class destruction and is
295 * meant to release and dynamic parameters allocated by @class_init.
296 * @class_data: Data to pass to the @class_init and @class_finalize functions.
297 * This can be useful when building dynamic classes.
298 * @interfaces: The list of interfaces associated with this type. This
299 * should point to a static array that's terminated with a zero filled
307 size_t instance_size
;
308 void (*instance_init
)(Object
*obj
);
309 void (*instance_finalize
)(Object
*obj
);
314 void (*class_init
)(ObjectClass
*klass
, void *data
);
315 void (*class_finalize
)(ObjectClass
*klass
, void *data
);
318 InterfaceInfo
*interfaces
;
323 * @obj: A derivative of #Object
325 * Converts an object to a #Object. Since all objects are #Objects,
326 * this function will always succeed.
328 #define OBJECT(obj) \
333 * @class: A derivative of #ObjectClass.
335 * Converts a class to an #ObjectClass. Since all objects are #Objects,
336 * this function will always succeed.
338 #define OBJECT_CLASS(class) \
339 ((ObjectClass *)(class))
343 * @type: The C type to use for the return value.
344 * @obj: A derivative of @type to cast.
345 * @name: The QOM typename of @type
347 * A type safe version of @object_dynamic_cast_assert. Typically each class
348 * will define a macro based on this type to perform type safe dynamic_casts to
351 * If an invalid object is passed to this function, a run time assert will be
354 #define OBJECT_CHECK(type, obj, name) \
355 ((type *)object_dynamic_cast_assert(OBJECT(obj), (name)))
358 * OBJECT_CLASS_CHECK:
359 * @class: The C type to use for the return value.
360 * @obj: A derivative of @type to cast.
361 * @name: the QOM typename of @class.
363 * A type safe version of @object_class_dynamic_cast_assert. This macro is
364 * typically wrapped by each type to perform type safe casts of a class to a
365 * specific class type.
367 #define OBJECT_CLASS_CHECK(class, obj, name) \
368 ((class *)object_class_dynamic_cast_assert(OBJECT_CLASS(obj), (name)))
372 * @class: The C type to use for the return value.
373 * @obj: The object to obtain the class for.
374 * @name: The QOM typename of @obj.
376 * This function will return a specific class for a given object. Its generally
377 * used by each type to provide a type safe macro to get a specific class type
380 #define OBJECT_GET_CLASS(class, obj, name) \
381 OBJECT_CLASS_CHECK(class, object_get_class(OBJECT(obj)), name)
385 * @parent_class: the base class
387 * The class for all interfaces. Subclasses of this class should only add
390 struct InterfaceClass
392 ObjectClass parent_class
;
397 * @type: The name of the interface.
398 * @interface_initfn: This method is called during class initialization and is
399 * used to initialize an interface associated with a class. This function
400 * should initialize any default virtual functions for a class and/or override
401 * virtual functions in a parent class.
403 * The information associated with an interface.
409 void (*interface_initfn
)(ObjectClass
*class, void *data
);
412 #define TYPE_INTERFACE "interface"
416 * @typename: The name of the type of the object to instantiate.
418 * This function will initialize a new object using heap allocated memory. This
419 * function should be paired with object_delete() to free the resources
420 * associated with the object.
422 * Returns: The newly allocated and instantiated object.
424 Object
*object_new(const char *typename
);
427 * object_new_with_type:
428 * @type: The type of the object to instantiate.
430 * This function will initialize a new object using heap allocated memory. This
431 * function should be paired with object_delete() to free the resources
432 * associated with the object.
434 * Returns: The newly allocated and instantiated object.
436 Object
*object_new_with_type(Type type
);
440 * @obj: The object to free.
442 * Finalize an object and then free the memory associated with it. This should
443 * be paired with object_new() to free the resources associated with an object.
445 void object_delete(Object
*obj
);
448 * object_initialize_with_type:
449 * @obj: A pointer to the memory to be used for the object.
450 * @type: The type of the object to instantiate.
452 * This function will initialize an object. The memory for the object should
453 * have already been allocated.
455 void object_initialize_with_type(void *data
, Type type
);
459 * @obj: A pointer to the memory to be used for the object.
460 * @typename: The name of the type of the object to instantiate.
462 * This function will initialize an object. The memory for the object should
463 * have already been allocated.
465 void object_initialize(void *obj
, const char *typename
);
469 * @obj: The object to finalize.
471 * This function destroys and object without freeing the memory associated with
474 void object_finalize(void *obj
);
477 * object_dynamic_cast:
478 * @obj: The object to cast.
479 * @typename: The @typename to cast to.
481 * This function will determine if @obj is-a @typename. @obj can refer to an
482 * object or an interface associated with an object.
484 * Returns: This function returns @obj on success or #NULL on failure.
486 Object
*object_dynamic_cast(Object
*obj
, const char *typename
);
489 * object_dynamic_cast_assert:
491 * See object_dynamic_cast() for a description of the parameters of this
492 * function. The only difference in behavior is that this function asserts
493 * instead of returning #NULL on failure.
495 Object
*object_dynamic_cast_assert(Object
*obj
, const char *typename
);
499 * @obj: A derivative of #Object
501 * Returns: The #ObjectClass of the type associated with @obj.
503 ObjectClass
*object_get_class(Object
*obj
);
506 * object_get_typename:
507 * @obj: A derivative of #Object.
509 * Returns: The QOM typename of @obj.
511 const char *object_get_typename(Object
*obj
);
514 * type_register_static:
515 * @info: The #TypeInfo of the new type.
517 * @info and all of the strings it points to should exist for the life time
518 * that the type is registered.
520 * Returns: 0 on failure, the new #Type on success.
522 Type
type_register_static(const TypeInfo
*info
);
524 #define type_register_static_alias(info, name) do { } while (0)
528 * @info: The #TypeInfo of the new type
530 * Unlike type_register_static(), this call does not require @info or its
531 * string members to continue to exist after the call returns.
533 * Returns: 0 on failure, the new #Type on success.
535 Type
type_register(const TypeInfo
*info
);
538 * object_class_dynamic_cast_assert:
539 * @klass: The #ObjectClass to attempt to cast.
540 * @typename: The QOM typename of the class to cast to.
542 * Returns: This function always returns @klass and asserts on failure.
544 ObjectClass
*object_class_dynamic_cast_assert(ObjectClass
*klass
,
545 const char *typename
);
547 ObjectClass
*object_class_dynamic_cast(ObjectClass
*klass
,
548 const char *typename
);
551 * object_class_get_name:
552 * @klass: The class to obtain the QOM typename for.
554 * Returns: The QOM typename for @klass.
556 const char *object_class_get_name(ObjectClass
*klass
);
558 ObjectClass
*object_class_by_name(const char *typename
);
560 void object_class_foreach(void (*fn
)(ObjectClass
*klass
, void *opaque
),
561 const char *implements_type
, bool include_abstract
,
565 * object_class_get_list:
566 * @implements_type: The type to filter for, including its derivatives.
567 * @include_abstract: Whether to include abstract classes.
569 * Returns: A singly-linked list of the classes in reverse hashtable order.
571 GSList
*object_class_get_list(const char *implements_type
,
572 bool include_abstract
);
578 * Increase the reference count of a object. A object cannot be freed as long
579 * as its reference count is greater than zero.
581 void object_ref(Object
*obj
);
587 * Decrease the reference count of a object. A object cannot be freed as long
588 * as its reference count is greater than zero.
590 void object_unref(Object
*obj
);
593 * object_property_add:
594 * @obj: the object to add a property to
595 * @name: the name of the property. This can contain any character except for
596 * a forward slash. In general, you should use hyphens '-' instead of
597 * underscores '_' when naming properties.
598 * @type: the type name of the property. This namespace is pretty loosely
599 * defined. Sub namespaces are constructed by using a prefix and then
600 * to angle brackets. For instance, the type 'virtio-net-pci' in the
601 * 'link' namespace would be 'link<virtio-net-pci>'.
602 * @get: The getter to be called to read a property. If this is NULL, then
603 * the property cannot be read.
604 * @set: the setter to be called to write a property. If this is NULL,
605 * then the property cannot be written.
606 * @release: called when the property is removed from the object. This is
607 * meant to allow a property to free its opaque upon object
608 * destruction. This may be NULL.
609 * @opaque: an opaque pointer to pass to the callbacks for the property
610 * @errp: returns an error if this function fails
612 void object_property_add(Object
*obj
, const char *name
, const char *type
,
613 ObjectPropertyAccessor
*get
,
614 ObjectPropertyAccessor
*set
,
615 ObjectPropertyRelease
*release
,
616 void *opaque
, struct Error
**errp
);
618 void object_property_del(Object
*obj
, const char *name
, struct Error
**errp
);
620 void object_unparent(Object
*obj
);
623 * object_property_get:
625 * @v: the visitor that will receive the property value. This should be an
626 * Output visitor and the data will be written with @name as the name.
627 * @name: the name of the property
628 * @errp: returns an error if this function fails
630 * Reads a property from a object.
632 void object_property_get(Object
*obj
, struct Visitor
*v
, const char *name
,
633 struct Error
**errp
);
636 * object_property_set_str:
637 * @value: the value to be written to the property
638 * @name: the name of the property
639 * @errp: returns an error if this function fails
641 * Writes a string value to a property.
643 void object_property_set_str(Object
*obj
, const char *value
,
644 const char *name
, struct Error
**errp
);
647 * object_property_get_str:
649 * @name: the name of the property
650 * @errp: returns an error if this function fails
652 * Returns: the value of the property, converted to a C string, or NULL if
653 * an error occurs (including when the property value is not a string).
654 * The caller should free the string.
656 char *object_property_get_str(Object
*obj
, const char *name
,
657 struct Error
**errp
);
660 * object_property_set_link:
661 * @value: the value to be written to the property
662 * @name: the name of the property
663 * @errp: returns an error if this function fails
665 * Writes an object's canonical path to a property.
667 void object_property_set_link(Object
*obj
, Object
*value
,
668 const char *name
, struct Error
**errp
);
671 * object_property_get_link:
673 * @name: the name of the property
674 * @errp: returns an error if this function fails
676 * Returns: the value of the property, resolved from a path to an Object,
677 * or NULL if an error occurs (including when the property value is not a
678 * string or not a valid object path).
680 Object
*object_property_get_link(Object
*obj
, const char *name
,
681 struct Error
**errp
);
684 * object_property_set_bool:
685 * @value: the value to be written to the property
686 * @name: the name of the property
687 * @errp: returns an error if this function fails
689 * Writes a bool value to a property.
691 void object_property_set_bool(Object
*obj
, bool value
,
692 const char *name
, struct Error
**errp
);
695 * object_property_get_bool:
697 * @name: the name of the property
698 * @errp: returns an error if this function fails
700 * Returns: the value of the property, converted to a boolean, or NULL if
701 * an error occurs (including when the property value is not a bool).
703 bool object_property_get_bool(Object
*obj
, const char *name
,
704 struct Error
**errp
);
707 * object_property_set_int:
708 * @value: the value to be written to the property
709 * @name: the name of the property
710 * @errp: returns an error if this function fails
712 * Writes an integer value to a property.
714 void object_property_set_int(Object
*obj
, int64_t value
,
715 const char *name
, struct Error
**errp
);
718 * object_property_get_int:
720 * @name: the name of the property
721 * @errp: returns an error if this function fails
723 * Returns: the value of the property, converted to an integer, or NULL if
724 * an error occurs (including when the property value is not an integer).
726 int64_t object_property_get_int(Object
*obj
, const char *name
,
727 struct Error
**errp
);
730 * object_property_set:
732 * @v: the visitor that will be used to write the property value. This should
733 * be an Input visitor and the data will be first read with @name as the
734 * name and then written as the property value.
735 * @name: the name of the property
736 * @errp: returns an error if this function fails
738 * Writes a property to a object.
740 void object_property_set(Object
*obj
, struct Visitor
*v
, const char *name
,
741 struct Error
**errp
);
744 * object_property_parse:
746 * @string: the string that will be used to parse the property value.
747 * @name: the name of the property
748 * @errp: returns an error if this function fails
750 * Parses a string and writes the result into a property of an object.
752 void object_property_parse(Object
*obj
, const char *string
,
753 const char *name
, struct Error
**errp
);
756 * object_property_print:
758 * @name: the name of the property
759 * @errp: returns an error if this function fails
761 * Returns a string representation of the value of the property. The
762 * caller shall free the string.
764 char *object_property_print(Object
*obj
, const char *name
,
765 struct Error
**errp
);
768 * object_property_get_type:
770 * @name: the name of the property
771 * @errp: returns an error if this function fails
773 * Returns: The type name of the property.
775 const char *object_property_get_type(Object
*obj
, const char *name
,
776 struct Error
**errp
);
781 * Returns: the root object of the composition tree
783 Object
*object_get_root(void);
786 * object_get_canonical_path:
788 * Returns: The canonical path for a object. This is the path within the
789 * composition tree starting from the root.
791 gchar
*object_get_canonical_path(Object
*obj
);
794 * object_resolve_path:
795 * @path: the path to resolve
796 * @ambiguous: returns true if the path resolution failed because of an
799 * There are two types of supported paths--absolute paths and partial paths.
801 * Absolute paths are derived from the root object and can follow child<> or
802 * link<> properties. Since they can follow link<> properties, they can be
803 * arbitrarily long. Absolute paths look like absolute filenames and are
804 * prefixed with a leading slash.
806 * Partial paths look like relative filenames. They do not begin with a
807 * prefix. The matching rules for partial paths are subtle but designed to make
808 * specifying objects easy. At each level of the composition tree, the partial
809 * path is matched as an absolute path. The first match is not returned. At
810 * least two matches are searched for. A successful result is only returned if
811 * only one match is found. If more than one match is found, a flag is
812 * returned to indicate that the match was ambiguous.
814 * Returns: The matched object or NULL on path lookup failure.
816 Object
*object_resolve_path(const char *path
, bool *ambiguous
);
819 * object_resolve_path_type:
820 * @path: the path to resolve
821 * @typename: the type to look for.
822 * @ambiguous: returns true if the path resolution failed because of an
825 * This is similar to object_resolve_path. However, when looking for a
826 * partial path only matches that implement the given type are considered.
827 * This restricts the search and avoids spuriously flagging matches as
830 * For both partial and absolute paths, the return value goes through
831 * a dynamic cast to @typename. This is important if either the link,
832 * or the typename itself are of interface types.
834 * Returns: The matched object or NULL on path lookup failure.
836 Object
*object_resolve_path_type(const char *path
, const char *typename
,
840 * object_property_add_child:
841 * @obj: the object to add a property to
842 * @name: the name of the property
843 * @child: the child object
844 * @errp: if an error occurs, a pointer to an area to store the area
846 * Child properties form the composition tree. All objects need to be a child
847 * of another object. Objects can only be a child of one object.
849 * There is no way for a child to determine what its parent is. It is not
850 * a bidirectional relationship. This is by design.
852 * The value of a child property as a C string will be the child object's
853 * canonical path. It can be retrieved using object_property_get_str().
854 * The child object itself can be retrieved using object_property_get_link().
856 void object_property_add_child(Object
*obj
, const char *name
,
857 Object
*child
, struct Error
**errp
);
860 * object_property_add_link:
861 * @obj: the object to add a property to
862 * @name: the name of the property
863 * @type: the qobj type of the link
864 * @child: a pointer to where the link object reference is stored
865 * @errp: if an error occurs, a pointer to an area to store the area
867 * Links establish relationships between objects. Links are unidirectional
868 * although two links can be combined to form a bidirectional relationship
871 * Links form the graph in the object model.
873 void object_property_add_link(Object
*obj
, const char *name
,
874 const char *type
, Object
**child
,
875 struct Error
**errp
);
878 * object_property_add_str:
879 * @obj: the object to add a property to
880 * @name: the name of the property
881 * @get: the getter or NULL if the property is write-only. This function must
882 * return a string to be freed by g_free().
883 * @set: the setter or NULL if the property is read-only
884 * @errp: if an error occurs, a pointer to an area to store the error
886 * Add a string property using getters/setters. This function will add a
887 * property of type 'string'.
889 void object_property_add_str(Object
*obj
, const char *name
,
890 char *(*get
)(Object
*, struct Error
**),
891 void (*set
)(Object
*, const char *, struct Error
**),
892 struct Error
**errp
);