src/hb-object.hh

   1 /*
   2  * Copyright © 2007  Chris Wilson
   3  * Copyright © 2009,2010  Red Hat, Inc.
   4  * Copyright © 2011,2012  Google, Inc.
   5  *
   6  *  This is part of HarfBuzz, a text shaping library.
   7  *
   8  * Permission is hereby granted, without written agreement and without
   9  * license or royalty fees, to use, copy, modify, and distribute this
  10  * software and its documentation for any purpose, provided that the
  11  * above copyright notice and the following two paragraphs appear in
  12  * all copies of this software.
  13  *
  14  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  15  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  16  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  17  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  18  * DAMAGE.
  19  *
  20  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  21  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  22  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  23  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  24  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  25  *
  26  * Contributor(s):
  27  *      Chris Wilson <chris@chris-wilson.co.uk>
  28  * Red Hat Author(s): Behdad Esfahbod
  29  * Google Author(s): Behdad Esfahbod
  30  */
  31
  32 #ifndef HB_OBJECT_HH
  33 #define HB_OBJECT_HH
  34
  35 #include "hb.hh"
  36 #include "hb-atomic.hh"
  37 #include "hb-mutex.hh"
  38 #include "hb-vector.hh"
  39
  40
  41 /*
  42  * Lockable set
  43  */
  44
  45 template <typename item_t, typename lock_t>
  46 struct hb_lockable_set_t
  47 {
  48   hb_vector_t<item_t> items;
  49
  50   void init () { items.init (); }
  51
  52   template <typename T>
  53   item_t *replace_or_insert (T v, lock_t &l, bool replace)
  54   {
  55     l.lock ();
  56     item_t *item = items.lsearch (v);
  57     if (item) {
  58       if (replace) {
  59         item_t old = *item;
  60         *item = v;
  61         l.unlock ();
  62         old.fini ();
  63       }
  64       else {
  65         item = nullptr;
  66         l.unlock ();
  67       }
  68     } else {
  69       item = items.push (v);
  70       l.unlock ();
  71     }
  72     return item;
  73   }
  74
  75   template <typename T>
  76   void remove (T v, lock_t &l)
  77   {
  78     l.lock ();
  79     item_t *item = items.lsearch (v);
  80     if (item)
  81     {
  82       item_t old = *item;
  83       *item = items[items.length - 1];
  84       items.pop ();
  85       l.unlock ();
  86       old.fini ();
  87     } else {
  88       l.unlock ();
  89     }
  90   }
  91
  92   template <typename T>
  93   bool find (T v, item_t *i, lock_t &l)
  94   {
  95     l.lock ();
  96     item_t *item = items.lsearch (v);
  97     if (item)
  98       *i = *item;
  99     l.unlock ();
 100     return !!item;
 101   }
 102
 103   template <typename T>
 104   item_t *find_or_insert (T v, lock_t &l)
 105   {
 106     l.lock ();
 107     item_t *item = items.find (v);
 108     if (!item) {
 109       item = items.push (v);
 110     }
 111     l.unlock ();
 112     return item;
 113   }
 114
 115   void fini (lock_t &l)
 116   {
 117     if (!items.length)
 118     {
 119       /* No need to lock. */
 120       items.fini ();
 121       return;
 122     }
 123     l.lock ();
 124     while (items.length)
 125     {
 126       item_t old = items[items.length - 1];
 127       items.pop ();
 128       l.unlock ();
 129       old.fini ();
 130       l.lock ();
 131     }
 132     items.fini ();
 133     l.unlock ();
 134   }
 135
 136 };
 137
 138
 139 /*
 140  * Reference-count.
 141  */
 142
 143 struct hb_reference_count_t
 144 {
 145   mutable hb_atomic_int_t ref_count;
 146
 147   void init (int v = 1) { ref_count.set_relaxed (v); }
 148   int get_relaxed () const { return ref_count.get_relaxed (); }
 149   int inc () const { return ref_count.inc (); }
 150   int dec () const { return ref_count.dec (); }
 151   void fini () { ref_count.set_relaxed (-0x0000DEAD); }
 152
 153   bool is_inert () const { return !ref_count.get_relaxed (); }
 154   bool is_valid () const { return ref_count.get_relaxed () > 0; }
 155 };
 156
 157
 158 /* user_data */
 159
 160 struct hb_user_data_array_t
 161 {
 162   struct hb_user_data_item_t {
 163     hb_user_data_key_t *key;
 164     void *data;
 165     hb_destroy_func_t destroy;
 166
 167     bool operator == (const hb_user_data_key_t *other_key) const { return key == other_key; }
 168     bool operator == (const hb_user_data_item_t &other) const { return key == other.key; }
 169
 170     void fini () { if (destroy) destroy (data); }
 171   };
 172
 173   hb_mutex_t lock;
 174   hb_lockable_set_t<hb_user_data_item_t, hb_mutex_t> items;
 175
 176   void init () { lock.init (); items.init (); }
 177
 178   HB_INTERNAL bool set (hb_user_data_key_t *key,
 179                         void *              data,
 180                         hb_destroy_func_t   destroy,
 181                         hb_bool_t           replace);
 182
 183   HB_INTERNAL void *get (hb_user_data_key_t *key);
 184
 185   void fini () { items.fini (lock); lock.fini (); }
 186 };
 187
 188
 189 /*
 190  * Object header
 191  */
 192
 193 struct hb_object_header_t
 194 {
 195   hb_reference_count_t ref_count;
 196   mutable hb_atomic_int_t writable = 0;
 197   hb_atomic_ptr_t<hb_user_data_array_t> user_data;
 198
 199   bool is_inert () const { return !ref_count.get_relaxed (); }
 200 };
 201 #define HB_OBJECT_HEADER_STATIC {}
 202
 203
 204 /*
 205  * Object
 206  */
 207
 208 template <typename Type>
 209 static inline void hb_object_trace (const Type *obj, const char *function)
 210 {
 211   DEBUG_MSG (OBJECT, (void *) obj,
 212              "%s refcount=%d",
 213              function,
 214              obj ? obj->header.ref_count.get_relaxed () : 0);
 215 }
 216
 217 template <typename Type>
 218 static inline Type *hb_object_create ()
 219 {
 220   Type *obj = (Type *) hb_calloc (1, sizeof (Type));
 221
 222   if (unlikely (!obj))
 223     return obj;
 224
 225   hb_object_init (obj);
 226   hb_object_trace (obj, HB_FUNC);
 227   return obj;
 228 }
 229 template <typename Type>
 230 static inline void hb_object_init (Type *obj)
 231 {
 232   obj->header.ref_count.init ();
 233   obj->header.writable.set_relaxed (true);
 234   obj->header.user_data.init ();
 235 }
 236 template <typename Type>
 237 static inline bool hb_object_is_valid (const Type *obj)
 238 {
 239   return likely (obj->header.ref_count.is_valid ());
 240 }
 241 template <typename Type>
 242 static inline bool hb_object_is_immutable (const Type *obj)
 243 {
 244   return !obj->header.writable.get_relaxed ();
 245 }
 246 template <typename Type>
 247 static inline void hb_object_make_immutable (const Type *obj)
 248 {
 249   obj->header.writable.set_relaxed (false);
 250 }
 251 template <typename Type>
 252 static inline Type *hb_object_reference (Type *obj)
 253 {
 254   hb_object_trace (obj, HB_FUNC);
 255   if (unlikely (!obj || obj->header.is_inert ()))
 256     return obj;
 257   assert (hb_object_is_valid (obj));
 258   obj->header.ref_count.inc ();
 259   return obj;
 260 }
 261 template <typename Type>
 262 static inline bool hb_object_destroy (Type *obj)
 263 {
 264   hb_object_trace (obj, HB_FUNC);
 265   if (unlikely (!obj || obj->header.is_inert ()))
 266     return false;
 267   assert (hb_object_is_valid (obj));
 268   if (obj->header.ref_count.dec () != 1)
 269     return false;
 270
 271   hb_object_fini (obj);
 272   return true;
 273 }
 274 template <typename Type>
 275 static inline void hb_object_fini (Type *obj)
 276 {
 277   obj->header.ref_count.fini (); /* Do this before user_data */
 278   hb_user_data_array_t *user_data = obj->header.user_data.get ();
 279   if (user_data)
 280   {
 281     user_data->fini ();
 282     hb_free (user_data);
 283     user_data = nullptr;
 284   }
 285 }
 286 template <typename Type>
 287 static inline bool hb_object_set_user_data (Type               *obj,
 288                                             hb_user_data_key_t *key,
 289                                             void *              data,
 290                                             hb_destroy_func_t   destroy,
 291                                             hb_bool_t           replace)
 292 {
 293   if (unlikely (!obj || obj->header.is_inert ()))
 294     return false;
 295   assert (hb_object_is_valid (obj));
 296
 297 retry:
 298   hb_user_data_array_t *user_data = obj->header.user_data.get ();
 299   if (unlikely (!user_data))
 300   {
 301     user_data = (hb_user_data_array_t *) hb_calloc (sizeof (hb_user_data_array_t), 1);
 302     if (unlikely (!user_data))
 303       return false;
 304     user_data->init ();
 305     if (unlikely (!obj->header.user_data.cmpexch (nullptr, user_data)))
 306     {
 307       user_data->fini ();
 308       hb_free (user_data);
 309       goto retry;
 310     }
 311   }
 312
 313   return user_data->set (key, data, destroy, replace);
 314 }
 315
 316 template <typename Type>
 317 static inline void *hb_object_get_user_data (Type               *obj,
 318                                              hb_user_data_key_t *key)
 319 {
 320   if (unlikely (!obj || obj->header.is_inert ()))
 321     return nullptr;
 322   assert (hb_object_is_valid (obj));
 323   hb_user_data_array_t *user_data = obj->header.user_data.get ();
 324   if (!user_data)
 325     return nullptr;
 326   return user_data->get (key);
 327 }
 328
 329
 330 #endif /* HB_OBJECT_HH */