Implement __set_dtls() in terms of __get_dtls()
[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 /* Initialize the slab caches for allocating dtls keys and values. */
66 int dtls_cache_init()
67 {
68   /* Make sure this only runs once */
69   static bool initialized = false;
70   if (initialized)
71       return 0;
72   initialized = true;
73
74   /* Initialize the global cache of dtls_keys */
75   __dtls_keys_cache = kmem_cache_create("dtls_keys_cache",
76     sizeof(struct dtls_key), __alignof__(struct dtls_key), 0, NULL, NULL);
77
78   /* Initialize the global cache of dtls_values */
79   __dtls_values_cache = kmem_cache_create("dtls_values_cache",
80     sizeof(struct dtls_value), __alignof__(struct dtls_value), 0, NULL, NULL);
81
82   return 0;
83 }
84
85 static dtls_key_t __allocate_dtls_key() 
86 {
87   dtls_cache_init();
88   dtls_key_t key = kmem_cache_alloc(__dtls_keys_cache, 0);
89   assert(key);
90   key->ref_count = 1;
91   return key;
92 }
93
94 static void __maybe_free_dtls_key(dtls_key_t key)
95 {
96   int ref_count = __sync_add_and_fetch(&key->ref_count, -1);
97   if (ref_count == 0)
98     kmem_cache_free(__dtls_keys_cache, key);
99 }
100
101 static struct dtls_value *__allocate_dtls_value()
102 {
103   struct dtls_value *v;
104   v = kmem_cache_alloc(__dtls_values_cache, 0);
105   assert(v);
106   return v;
107 }
108
109 static void __free_dtls_value(struct dtls_value *v)
110 {
111   kmem_cache_free(__dtls_values_cache, v);
112 }
113
114 dtls_key_t dtls_key_create(dtls_dtor_t dtor)
115 {
116   dtls_key_t key = __allocate_dtls_key();
117   key->valid = true;
118   key->dtor = dtor;
119   return key;
120 }
121
122 void dtls_key_delete(dtls_key_t key)
123 {
124   assert(key);
125   key->valid = false;
126   __maybe_free_dtls_key(key);
127 }
128
129 static inline void *__get_dtls(dtls_data_t *dtls_data, dtls_key_t key)
130 {
131   assert(key);
132
133   struct dtls_value *v = NULL;
134   TAILQ_FOREACH(v, &dtls_data->list, link)
135     if(v->key == key) return v->dtls;
136   return v;
137 }
138
139 static inline void __set_dtls(dtls_data_t *dtls_data, dtls_key_t key, void *dtls)
140 {
141   assert(key);
142   __sync_fetch_and_add(&key->ref_count, 1);
143
144   struct dtls_value *v = __get_dtls(dtls_data, key);
145   if (!v) {
146     v = __allocate_dtls_value();
147     v->key = key;
148     TAILQ_INSERT_HEAD(&dtls_data->list, v, link);
149   }
150   v->dtls = dtls;
151 }
152
153 static inline void __destroy_dtls(dtls_data_t *dtls_data)
154 {
155  struct dtls_value *v,*n;
156   v = TAILQ_FIRST(&dtls_data->list);
157   while(v != NULL) {
158     dtls_key_t key = v->key;
159   
160         // The dtor must be called outside of a spinlock so that it can call
161         // code that may deschedule it for a while (i.e. a mutex). Probably a
162         // good idea anyway since it can be arbitrarily long and is written by the
163         // user. Note, there is a small race here on the valid field, whereby we
164         // may run a destructor on an invalid key. At least the keys memory wont
165         // be deleted though, as protected by the ref count. Any reasonable usage
166         // of this interface should safeguard that a key is never destroyed before
167         // all of the threads that use it have exited anyway.
168     if (key->valid && key->dtor) {
169           void *dtls = v->dtls;
170       v->dtls = NULL;
171       key->dtor(dtls);
172     }
173     __maybe_free_dtls_key(key);
174
175     n = TAILQ_NEXT(v, link);
176     TAILQ_REMOVE(&dtls_data->list, v, link);
177     __free_dtls_value(v);
178     v = n;
179   }
180 }
181
182 void set_dtls(dtls_key_t key, void *dtls)
183 {
184   bool initialized = true;
185   dtls_data_t *dtls_data = NULL;
186   if(!__dtls_initialized) {
187     initialized = false;
188     __dtls_initialized  = true;
189   }
190   dtls_data = &__dtls_data;
191   if(!initialized) {
192     TAILQ_INIT(&dtls_data->list);
193   }
194   __set_dtls(dtls_data, key, dtls);
195 }
196
197 void *get_dtls(dtls_key_t key)
198 {
199   dtls_data_t *dtls_data = NULL;
200   if(!__dtls_initialized)
201     return NULL;
202   dtls_data = &__dtls_data;
203   return __get_dtls(dtls_data, key);
204 }
205
206 void destroy_dtls()
207 {
208   dtls_data_t *dtls_data = NULL;
209   if(!__dtls_initialized)
210     return;
211   dtls_data = &__dtls_data;
212   __destroy_dtls(dtls_data);
213 }
214