2 * Copyright © 2007 Chris Wilson
3 * Copyright © 2009,2010 Red Hat, Inc.
4 * Copyright © 2011,2012 Google, Inc.
6 * This is part of HarfBuzz, a text shaping library.
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.
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
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.
27 * Chris Wilson <chris@chris-wilson.co.uk>
28 * Red Hat Author(s): Behdad Esfahbod
29 * Google Author(s): Behdad Esfahbod
36 #include "hb-atomic.hh"
37 #include "hb-mutex.hh"
38 #include "hb-vector.hh"
45 template <typename item_t, typename lock_t>
46 struct hb_lockable_set_t
48 hb_vector_t<item_t> items;
50 void init () { items.init (); }
53 item_t *replace_or_insert (T v, lock_t &l, bool replace)
56 item_t *item = items.find (v);
69 item = items.push (v);
76 void remove (T v, lock_t &l)
79 item_t *item = items.find (v);
83 *item = items[items.length - 1];
93 bool find (T v, item_t *i, lock_t &l)
96 item_t *item = items.find (v);
103 template <typename T>
104 item_t *find_or_insert (T v, lock_t &l)
107 item_t *item = items.find (v);
109 item = items.push (v);
115 void fini (lock_t &l)
119 /* No need to lock. */
126 item_t old = items[items.length - 1];
143 #define HB_REFERENCE_COUNT_INERT_VALUE 0
144 #define HB_REFERENCE_COUNT_POISON_VALUE -0x0000DEAD
145 #define HB_REFERENCE_COUNT_INIT {HB_ATOMIC_INT_INIT (HB_REFERENCE_COUNT_INERT_VALUE)}
147 struct hb_reference_count_t
149 mutable hb_atomic_int_t ref_count;
151 void init (int v = 1) { ref_count.set_relaxed (v); }
152 int get_relaxed () const { return ref_count.get_relaxed (); }
153 int inc () const { return ref_count.inc (); }
154 int dec () const { return ref_count.dec (); }
155 void fini () { ref_count.set_relaxed (HB_REFERENCE_COUNT_POISON_VALUE); }
157 bool is_inert () const { return ref_count.get_relaxed () == HB_REFERENCE_COUNT_INERT_VALUE; }
158 bool is_valid () const { return ref_count.get_relaxed () > 0; }
164 struct hb_user_data_array_t
166 struct hb_user_data_item_t {
167 hb_user_data_key_t *key;
169 hb_destroy_func_t destroy;
171 bool operator == (hb_user_data_key_t *other_key) const { return key == other_key; }
172 bool operator == (hb_user_data_item_t &other) const { return key == other.key; }
174 void fini () { if (destroy) destroy (data); }
178 hb_lockable_set_t<hb_user_data_item_t, hb_mutex_t> items;
180 void init () { lock.init (); items.init (); }
182 HB_INTERNAL bool set (hb_user_data_key_t *key,
184 hb_destroy_func_t destroy,
187 HB_INTERNAL void *get (hb_user_data_key_t *key);
189 void fini () { items.fini (lock); lock.fini (); }
197 struct hb_object_header_t
199 hb_reference_count_t ref_count;
200 mutable hb_atomic_int_t writable;
201 hb_atomic_ptr_t<hb_user_data_array_t> user_data;
203 #define HB_OBJECT_HEADER_STATIC \
205 HB_REFERENCE_COUNT_INIT, \
206 HB_ATOMIC_INT_INIT (false), \
207 HB_ATOMIC_PTR_INIT (nullptr) \
215 template <typename Type>
216 static inline void hb_object_trace (const Type *obj, const char *function)
218 DEBUG_MSG (OBJECT, (void *) obj,
221 obj ? obj->header.ref_count.get_relaxed () : 0);
224 template <typename Type>
225 static inline Type *hb_object_create ()
227 Type *obj = (Type *) calloc (1, sizeof (Type));
232 hb_object_init (obj);
233 hb_object_trace (obj, HB_FUNC);
236 template <typename Type>
237 static inline void hb_object_init (Type *obj)
239 obj->header.ref_count.init ();
240 obj->header.writable.set_relaxed (true);
241 obj->header.user_data.init ();
243 template <typename Type>
244 static inline bool hb_object_is_inert (const Type *obj)
246 return unlikely (obj->header.ref_count.is_inert ());
248 template <typename Type>
249 static inline bool hb_object_is_valid (const Type *obj)
251 return likely (obj->header.ref_count.is_valid ());
253 template <typename Type>
254 static inline bool hb_object_is_immutable (const Type *obj)
256 return !obj->header.writable.get_relaxed ();
258 template <typename Type>
259 static inline void hb_object_make_immutable (const Type *obj)
261 obj->header.writable.set_relaxed (false);
263 template <typename Type>
264 static inline Type *hb_object_reference (Type *obj)
266 hb_object_trace (obj, HB_FUNC);
267 if (unlikely (!obj || hb_object_is_inert (obj)))
269 assert (hb_object_is_valid (obj));
270 obj->header.ref_count.inc ();
273 template <typename Type>
274 static inline bool hb_object_destroy (Type *obj)
276 hb_object_trace (obj, HB_FUNC);
277 if (unlikely (!obj || hb_object_is_inert (obj)))
279 assert (hb_object_is_valid (obj));
280 if (obj->header.ref_count.dec () != 1)
283 hb_object_fini (obj);
286 template <typename Type>
287 static inline void hb_object_fini (Type *obj)
289 obj->header.ref_count.fini (); /* Do this before user_data */
290 hb_user_data_array_t *user_data = obj->header.user_data.get ();
298 template <typename Type>
299 static inline bool hb_object_set_user_data (Type *obj,
300 hb_user_data_key_t *key,
302 hb_destroy_func_t destroy,
305 if (unlikely (!obj || hb_object_is_inert (obj)))
307 assert (hb_object_is_valid (obj));
310 hb_user_data_array_t *user_data = obj->header.user_data.get ();
311 if (unlikely (!user_data))
313 user_data = (hb_user_data_array_t *) calloc (sizeof (hb_user_data_array_t), 1);
314 if (unlikely (!user_data))
317 if (unlikely (!obj->header.user_data.cmpexch (nullptr, user_data)))
325 return user_data->set (key, data, destroy, replace);
328 template <typename Type>
329 static inline void *hb_object_get_user_data (Type *obj,
330 hb_user_data_key_t *key)
332 if (unlikely (!obj || hb_object_is_inert (obj)))
334 assert (hb_object_is_valid (obj));
335 hb_user_data_array_t *user_data = obj->header.user_data.get ();
338 return user_data->get (key);
342 #endif /* HB_OBJECT_HH */