[util] Add mono_thread_hazardous_try_free and mono_thread_hazardous_queue_free.
[mono.git] / mono / utils / hazard-pointer.h
1 /*
2  * hazard-pointer.h: Hazard pointer related code.
3  *
4  * (C) Copyright 2011 Novell, Inc
5  */
6 #ifndef __MONO_HAZARD_POINTER_H__
7 #define __MONO_HAZARD_POINTER_H__
8
9 #include <glib.h>
10 #include <mono/utils/mono-compiler.h>
11 #include <mono/utils/mono-membar.h>
12
13 #define HAZARD_POINTER_COUNT 3
14
15 typedef struct {
16         gpointer hazard_pointers [HAZARD_POINTER_COUNT];
17 } MonoThreadHazardPointers;
18
19 typedef void (*MonoHazardousFreeFunc) (gpointer p);
20
21 typedef enum {
22         HAZARD_FREE_MAY_LOCK,
23         HAZARD_FREE_NO_LOCK,
24 } HazardFreeLocking;
25
26 typedef enum {
27         HAZARD_FREE_SAFE_CTX,
28         HAZARD_FREE_ASYNC_CTX,
29 } HazardFreeContext;
30
31 gboolean mono_thread_hazardous_try_free (gpointer p, MonoHazardousFreeFunc free_func);
32 void mono_thread_hazardous_queue_free (gpointer p, MonoHazardousFreeFunc free_func);
33
34 void mono_thread_hazardous_free_or_queue (gpointer p, MonoHazardousFreeFunc free_func,
35                                           HazardFreeLocking locking, HazardFreeContext context);
36 void mono_thread_hazardous_try_free_all (void);
37 void mono_thread_hazardous_try_free_some (void);
38 MonoThreadHazardPointers* mono_hazard_pointer_get (void);
39 gpointer get_hazardous_pointer (gpointer volatile *pp, MonoThreadHazardPointers *hp, int hazard_index);
40
41 #define mono_hazard_pointer_set(hp,i,v) \
42         do { g_assert ((i) >= 0 && (i) < HAZARD_POINTER_COUNT); \
43                 (hp)->hazard_pointers [(i)] = (v); \
44                 mono_memory_write_barrier (); \
45         } while (0)
46
47 #define mono_hazard_pointer_get_val(hp,i)       \
48         ((hp)->hazard_pointers [(i)])
49
50 #define mono_hazard_pointer_clear(hp,i) \
51         do { g_assert ((i) >= 0 && (i) < HAZARD_POINTER_COUNT); \
52                 mono_memory_write_barrier (); \
53                 (hp)->hazard_pointers [(i)] = NULL; \
54         } while (0)
55
56
57 void mono_thread_small_id_free (int id);
58 int mono_thread_small_id_alloc (void);
59
60 int mono_hazard_pointer_save_for_signal_handler (void);
61 void mono_hazard_pointer_restore_for_signal_handler (int small_id);
62
63 void mono_thread_smr_init (void);
64 void mono_thread_smr_cleanup (void);
65 #endif /*__MONO_HAZARD_POINTER_H__*/