Remove all spinlocks
[akaros.git] / user / parlib / dtls.c
1 /*
2  * Copyright (c) 2012 The Regents of the University of California
3  * Kevin Klues <klueska@cs.berkeley.edu>
4  *
5  * This file is part of Parlib.
6  *
7  * Parlib is free software: you can redistribute it and/or modify
8  * it under the terms of the Lesser GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  * 
12  * Parlib is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * Lesser GNU General Public License for more details.
16  * 
17  * See COPYING.LESSER for details on the GNU Lesser General Public License.
18  * See COPYING for details on the GNU General Public License.
19  */
20
21 #include <stddef.h>
22 #include <assert.h>
23 #include <parlib/spinlock.h>
24 #include <parlib/dtls.h>
25 #include <parlib/slab.h>
26
27 /* The current dymamic tls implementation uses a locked linked list
28  * to find the key for a given thread. We should probably find a better way to
29  * do this based on a custom lock-free hash table or something. */
30 #include <sys/queue.h>
31 #include <parlib/spinlock.h>
32
33 /* The dynamic tls key structure */
34 struct dtls_key {
35   int ref_count;
36   bool valid;
37   void (*dtor)(void*);
38 };
39
40 /* The definition of a dtls_key list and its elements */
41 struct dtls_value {
42   TAILQ_ENTRY(dtls_value) link;
43   struct dtls_key *key;
44   void *dtls;
45 }; 
46 TAILQ_HEAD(dtls_list, dtls_value);
47
48 /* A struct containing all of the per thread (i.e. vcore or uthread) data
49  * associated with dtls */
50 typedef struct dtls_data {
51   /* A per-thread list of dtls regions */
52   struct dtls_list list;
53
54 } dtls_data_t;
55
56 /* A slab of dtls keys (global to all threads) */
57 static struct kmem_cache *__dtls_keys_cache;
58
59 /* A slab of values for use when mapping a dtls_key to its per-thread value */
60 struct kmem_cache *__dtls_values_cache;
61   
62 static __thread dtls_data_t __dtls_data;
63 static __thread bool __dtls_initialized = false;
64
65 static dtls_key_t __allocate_dtls_key() 
66 {
67   dtls_key_t key = kmem_cache_alloc(__dtls_keys_cache, 0);
68   assert(key);
69   key->ref_count = 1;
70   return key;
71 }
72
73 static void __maybe_free_dtls_key(dtls_key_t key)
74 {
75   int ref_count = __sync_add_and_fetch(&key->ref_count, -1);
76   if (ref_count == 0)
77     kmem_cache_free(__dtls_keys_cache, key);
78 }
79
80 /* Constructor to get a reference to the main thread's TLS descriptor */
81 int dtls_lib_init()
82 {
83   /* Make sure this only runs once */
84   static bool initialized = false;
85   if (initialized)
86       return 0;
87   initialized = true;
88   
89   /* Initialize the global cache of dtls_keys */
90   __dtls_keys_cache = kmem_cache_create("dtls_keys_cache", 
91     sizeof(struct dtls_key), __alignof__(struct dtls_key), 0, NULL, NULL);
92   
93   __dtls_values_cache = kmem_cache_create("dtls_values_cache", 
94     sizeof(struct dtls_value), __alignof__(struct dtls_value), 0, NULL, NULL);
95   
96   return 0;
97 }
98
99 dtls_key_t dtls_key_create(dtls_dtor_t dtor)
100 {
101   dtls_lib_init();
102   dtls_key_t key = __allocate_dtls_key();
103   key->valid = true;
104   key->dtor = dtor;
105   return key;
106 }
107
108 void dtls_key_delete(dtls_key_t key)
109 {
110   assert(key);
111   key->valid = false;
112   __maybe_free_dtls_key(key);
113 }
114
115 static inline void __set_dtls(dtls_data_t *dtls_data, dtls_key_t key, void *dtls)
116 {
117   assert(key);
118   __sync_fetch_and_add(&key->ref_count, 1);
119
120   struct dtls_value *v = NULL;
121   TAILQ_FOREACH(v, &dtls_data->list, link)
122     if(v->key == key) break;
123
124   if(!v) {
125     v = kmem_cache_alloc(__dtls_values_cache, 0);
126     assert(v);
127     v->key = key;
128     TAILQ_INSERT_HEAD(&dtls_data->list, v, link);
129   }
130   v->dtls = dtls;
131 }
132
133 static inline void *__get_dtls(dtls_data_t *dtls_data, dtls_key_t key)
134 {
135   assert(key);
136
137   struct dtls_value *v = NULL;
138   TAILQ_FOREACH(v, &dtls_data->list, link)
139     if(v->key == key) return v->dtls;
140   return v;
141 }
142
143 static inline void __destroy_dtls(dtls_data_t *dtls_data)
144 {
145  struct dtls_value *v,*n;
146   v = TAILQ_FIRST(&dtls_data->list);
147   while(v != NULL) {
148     dtls_key_t key = v->key;
149   
150         // The dtor must be called outside of a spinlock so that it can call
151         // code that may deschedule it for a while (i.e. a mutex). Probably a
152         // good idea anyway since it can be arbitrarily long and is written by the
153         // user. Note, there is a small race here on the valid field, whereby we
154         // may run a destructor on an invalid key. At least the keys memory wont
155         // be deleted though, as protected by the ref count. Any reasonable usage
156         // of this interface should safeguard that a key is never destroyed before
157         // all of the threads that use it have exited anyway.
158     if (key->valid && key->dtor) {
159           void *dtls = v->dtls;
160       v->dtls = NULL;
161       key->dtor(dtls);
162     }
163     __maybe_free_dtls_key(key);
164
165     n = TAILQ_NEXT(v, link);
166     TAILQ_REMOVE(&dtls_data->list, v, link);
167     kmem_cache_free(__dtls_values_cache, v);
168     v = n;
169   }
170 }
171
172 void set_dtls(dtls_key_t key, void *dtls)
173 {
174   bool initialized = true;
175   dtls_data_t *dtls_data = NULL;
176   if(!__dtls_initialized) {
177     initialized = false;
178     __dtls_initialized  = true;
179   }
180   dtls_data = &__dtls_data;
181   if(!initialized) {
182     TAILQ_INIT(&dtls_data->list);
183   }
184   __set_dtls(dtls_data, key, dtls);
185 }
186
187 void *get_dtls(dtls_key_t key)
188 {
189   dtls_data_t *dtls_data = NULL;
190   if(!__dtls_initialized)
191     return NULL;
192   dtls_data = &__dtls_data;
193   return __get_dtls(dtls_data, key);
194 }
195
196 void destroy_dtls()
197 {
198   dtls_data_t *dtls_data = NULL;
199   if(!__dtls_initialized)
200     return;
201   dtls_data = &__dtls_data;
202   __destroy_dtls(dtls_data);
203 }
204