include/qapi/qmp/qobject.h

   1 /*
   2  * QEMU Object Model.
   3  *
   4  * Based on ideas by Avi Kivity <avi@redhat.com>
   5  *
   6  * Copyright (C) 2009, 2015 Red Hat Inc.
   7  *
   8  * Authors:
   9  *  Luiz Capitulino <lcapitulino@redhat.com>
  10  *
  11  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
  12  * See the COPYING.LIB file in the top-level directory.
  13  *
  14  * QObject Reference Counts Terminology
  15  * ------------------------------------
  16  *
  17  *  - Returning references: A function that returns an object may
  18  *  return it as either a weak or a strong reference.  If the reference
  19  *  is strong, you are responsible for calling QDECREF() on the reference
  20  *  when you are done.
  21  *
  22  *  If the reference is weak, the owner of the reference may free it at
  23  *  any time in the future.  Before storing the reference anywhere, you
  24  *  should call QINCREF() to make the reference strong.
  25  *
  26  *  - Transferring ownership: when you transfer ownership of a reference
  27  *  by calling a function, you are no longer responsible for calling
  28  *  QDECREF() when the reference is no longer needed.  In other words,
  29  *  when the function returns you must behave as if the reference to the
  30  *  passed object was weak.
  31  */
  32 #ifndef QOBJECT_H
  33 #define QOBJECT_H
  34
  35 #include "qapi-builtin-types.h"
  36
  37 struct QObject {
  38     QType type;
  39     size_t refcnt;
  40 };
  41
  42 /* Get the 'base' part of an object */
  43 #define QOBJECT(obj) (&(obj)->base)
  44
  45 /* High-level interface for qobject_incref() */
  46 #define QINCREF(obj)      \
  47     qobject_incref(QOBJECT(obj))
  48
  49 /* High-level interface for qobject_decref() */
  50 #define QDECREF(obj)              \
  51     qobject_decref(obj ? QOBJECT(obj) : NULL)
  52
  53 /* Initialize an object to default values */
  54 static inline void qobject_init(QObject *obj, QType type)
  55 {
  56     assert(QTYPE_NONE < type && type < QTYPE__MAX);
  57     obj->refcnt = 1;
  58     obj->type = type;
  59 }
  60
  61 /**
  62  * qobject_incref(): Increment QObject's reference count
  63  */
  64 static inline void qobject_incref(QObject *obj)
  65 {
  66     if (obj)
  67         obj->refcnt++;
  68 }
  69
  70 /**
  71  * qobject_is_equal(): Return whether the two objects are equal.
  72  *
  73  * Any of the pointers may be NULL; return true if both are.  Always
  74  * return false if only one is (therefore a QNull object is not
  75  * considered equal to a NULL pointer).
  76  */
  77 bool qobject_is_equal(const QObject *x, const QObject *y);
  78
  79 /**
  80  * qobject_destroy(): Free resources used by the object
  81  */
  82 void qobject_destroy(QObject *obj);
  83
  84 /**
  85  * qobject_decref(): Decrement QObject's reference count, deallocate
  86  * when it reaches zero
  87  */
  88 static inline void qobject_decref(QObject *obj)
  89 {
  90     assert(!obj || obj->refcnt);
  91     if (obj && --obj->refcnt == 0) {
  92         qobject_destroy(obj);
  93     }
  94 }
  95
  96 /**
  97  * qobject_type(): Return the QObject's type
  98  */
  99 static inline QType qobject_type(const QObject *obj)
 100 {
 101     assert(QTYPE_NONE < obj->type && obj->type < QTYPE__MAX);
 102     return obj->type;
 103 }
 104
 105 #endif /* QOBJECT_H */