qobject.h

   1 /*
   2  * QEMU Object Model.
   3  *
   4  * Based on ideas by Avi Kivity <avi@redhat.com>
   5  *
   6  * Copyright (C) 2009 Red Hat Inc.
   7  *
   8  * Authors:
   9  *  Luiz Capitulino <lcapitulino@redhat.com>
  10  *
  11  * This work is licensed under the terms of the GNU GPL, version 2.  See
  12  * the COPYING 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 <stddef.h>
  36 #include <assert.h>
  37
  38 typedef enum {
  39     QTYPE_NONE,
  40     QTYPE_QINT,
  41 } qtype_code;
  42
  43 struct QObject;
  44
  45 typedef struct QType {
  46     qtype_code code;
  47     void (*destroy)(struct QObject *);
  48 } QType;
  49
  50 typedef struct QObject {
  51     const QType *type;
  52     size_t refcnt;
  53 } QObject;
  54
  55 /* Objects definitions must include this */
  56 #define QObject_HEAD  \
  57     QObject base
  58
  59 /* Get the 'base' part of an object */
  60 #define QOBJECT(obj) (&obj->base)
  61
  62 /* High-level interface for qobject_incref() */
  63 #define QINCREF(obj)      \
  64     assert(obj != NULL);  \
  65     qobject_incref(QOBJECT(obj))
  66
  67 /* High-level interface for qobject_decref() */
  68 #define QDECREF(obj)              \
  69     assert(obj != NULL);          \
  70     qobject_decref(QOBJECT(obj))
  71
  72 /* Initialize an object to default values */
  73 #define QOBJECT_INIT(obj, qtype_type)   \
  74     obj->base.refcnt = 1;               \
  75     obj->base.type   = qtype_type
  76
  77 /**
  78  * qobject_incref(): Increment QObject's reference count
  79  */
  80 static inline void qobject_incref(QObject *obj)
  81 {
  82     obj->refcnt++;
  83 }
  84
  85 /**
  86  * qobject_decref(): Decrement QObject's reference count, deallocate
  87  * when it reaches zero
  88  */
  89 static inline void qobject_decref(QObject *obj)
  90 {
  91     if (--obj->refcnt == 0) {
  92         assert(obj->type != NULL);
  93         assert(obj->type->destroy != NULL);
  94         obj->type->destroy(obj);
  95     }
  96 }
  97
  98 /**
  99  * qobject_type(): Return the QObject's type
 100  */
 101 static inline qtype_code qobject_type(const QObject *obj)
 102 {
 103     assert(obj->type != NULL);
 104     return obj->type->code;
 105 }
 106
 107 #endif /* QOBJECT_H */