1
/*****************************************************************************
3
Copyright (c) 1995, 2009, Innobase Oy. All Rights Reserved.
5
This program is free software; you can redistribute it and/or modify it under
6
the terms of the GNU General Public License as published by the Free Software
7
Foundation; version 2 of the License.
9
This program is distributed in the hope that it will be useful, but WITHOUT
10
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
13
You should have received a copy of the GNU General Public License along with
14
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
15
St, Fifth Floor, Boston, MA 02110-1301 USA
17
*****************************************************************************/
19
/**************************************************//**
21
The thread local storage
23
Created 10/5/1995 Heikki Tuuri
24
*******************************************************/
31
#include "sync0sync.h"
32
#include "hash0hash.h"
37
IMPLEMENTATION OF THREAD LOCAL STORAGE
38
======================================
40
The threads sometimes need private data which depends on the thread id.
41
This is implemented as a hash table, where the hash value is calculated
42
from the thread id, to prepare for a large number of threads. The hash table
43
is protected by a mutex. If you need modify the program and put new data to
44
the thread local storage, just add it to struct thr_local_struct in the
47
/** Mutex protecting thr_local_hash */
48
static mutex_t thr_local_mutex;
50
/** The hash table. The module is not yet initialized when it is NULL. */
51
static hash_table_t* thr_local_hash = NULL;
53
/** Thread local data */
54
typedef struct thr_local_struct thr_local_t;
56
/** @brief Thread local data.
57
The private data for each thread should be put to
58
the structure below and the accessor functions written
60
struct thr_local_struct{
61
os_thread_id_t id; /*!< id of the thread which owns this struct */
62
os_thread_t handle; /*!< operating system handle to the thread */
63
ulint slot_no;/*!< the index of the slot in the thread table
65
ibool in_ibuf;/*!< TRUE if the the thread is doing an ibuf
67
hash_node_t hash; /*!< hash chain node */
68
ulint magic_n;/*!< magic number (THR_LOCAL_MAGIC_N) */
71
/** The value of thr_local_struct::magic_n */
72
#define THR_LOCAL_MAGIC_N 1231234
74
/*******************************************************************//**
75
Returns the local storage struct for a thread.
76
@return local storage */
81
os_thread_id_t id) /*!< in: thread id of the thread */
86
ut_ad(thr_local_hash);
87
ut_ad(mutex_own(&thr_local_mutex));
89
/* Look for the local struct in the hash table */
93
HASH_SEARCH(hash, thr_local_hash, os_thread_pf(id),
94
thr_local_t*, local,, os_thread_eq(local->id, id));
96
mutex_exit(&thr_local_mutex);
100
mutex_enter(&thr_local_mutex);
105
ut_ad(local->magic_n == THR_LOCAL_MAGIC_N);
110
/*******************************************************************//**
111
Gets the slot number in the thread table of a thread.
112
@return slot number */
115
thr_local_get_slot_no(
116
/*==================*/
117
os_thread_id_t id) /*!< in: thread id of the thread */
122
mutex_enter(&thr_local_mutex);
124
local = thr_local_get(id);
126
slot_no = local->slot_no;
128
mutex_exit(&thr_local_mutex);
133
/*******************************************************************//**
134
Sets the slot number in the thread table of a thread. */
137
thr_local_set_slot_no(
138
/*==================*/
139
os_thread_id_t id, /*!< in: thread id of the thread */
140
ulint slot_no)/*!< in: slot number */
144
mutex_enter(&thr_local_mutex);
146
local = thr_local_get(id);
148
local->slot_no = slot_no;
150
mutex_exit(&thr_local_mutex);
153
/*******************************************************************//**
154
Returns pointer to the 'in_ibuf' field within the current thread local
156
@return pointer to the in_ibuf field */
159
thr_local_get_in_ibuf_field(void)
160
/*=============================*/
164
mutex_enter(&thr_local_mutex);
166
local = thr_local_get(os_thread_get_curr_id());
168
mutex_exit(&thr_local_mutex);
170
return(&(local->in_ibuf));
173
/*******************************************************************//**
174
Creates a local storage struct for the calling new thread. */
177
thr_local_create(void)
178
/*==================*/
182
if (thr_local_hash == NULL) {
186
local = mem_alloc(sizeof(thr_local_t));
188
local->id = os_thread_get_curr_id();
189
local->handle = os_thread_get_curr();
190
local->magic_n = THR_LOCAL_MAGIC_N;
192
local->in_ibuf = FALSE;
194
mutex_enter(&thr_local_mutex);
196
HASH_INSERT(thr_local_t, hash, thr_local_hash,
197
os_thread_pf(os_thread_get_curr_id()),
200
mutex_exit(&thr_local_mutex);
203
/*******************************************************************//**
204
Frees the local storage struct for the specified thread. */
209
os_thread_id_t id) /*!< in: thread id */
213
mutex_enter(&thr_local_mutex);
215
/* Look for the local struct in the hash table */
217
HASH_SEARCH(hash, thr_local_hash, os_thread_pf(id),
218
thr_local_t*, local,, os_thread_eq(local->id, id));
220
mutex_exit(&thr_local_mutex);
225
HASH_DELETE(thr_local_t, hash, thr_local_hash,
226
os_thread_pf(id), local);
228
mutex_exit(&thr_local_mutex);
230
ut_a(local->magic_n == THR_LOCAL_MAGIC_N);
235
/****************************************************************//**
236
Initializes the thread local storage module. */
243
ut_a(thr_local_hash == NULL);
245
thr_local_hash = hash_create(OS_THREAD_MAX_N + 100);
247
mutex_create(&thr_local_mutex, SYNC_THR_LOCAL);
250
/********************************************************************
251
Close the thread local storage module. */
254
thr_local_close(void)
255
/*=================*/
259
ut_a(thr_local_hash != NULL);
261
/* Free the hash elements. We don't remove them from the table
262
because we are going to destroy the table anyway. */
263
for (i = 0; i < hash_get_n_cells(thr_local_hash); i++) {
266
local = HASH_GET_FIRST(thr_local_hash, i);
269
thr_local_t* prev_local = local;
271
local = HASH_GET_NEXT(hash, prev_local);
272
ut_a(prev_local->magic_n == THR_LOCAL_MAGIC_N);
273
mem_free(prev_local);
277
hash_table_free(thr_local_hash);
278
thr_local_hash = NULL;