1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Purpose: Provides internal function tracing in the form of a stack.
* The FUNC_ENTER() macro adds the function name to the function
* stack whenever a function is entered.
* As the functions return with FUNC_LEAVE,
* entries are removed from the stack.
*
* A function stack has a fixed maximum size. If this size is
* exceeded then the stack will be truncated and only the
* first called functions will have entries on the stack. This is
* expected to be a rare condition.
*
*/
#include "H5private.h" /* Generic Functions */
#include "H5FSprivate.h" /* Private function stack routines */
#ifdef H5_HAVE_FUNCSTACK
#ifdef H5_HAVE_THREADSAFE
/*
* The per-thread function stack. pthread_once() initializes a special
* key that will be used by all threads to create a stack specific to
* each thread individually. The association of stacks to threads will
* be handled by the pthread library.
*
* In order for this macro to work, H5FS_get_my_stack() must be preceeded
* by "H5FS_t *fstack =".
*/
static H5FS_t *H5FS_get_stack(void);
#define H5FS_get_my_stack() H5FS_get_stack()
#else /* H5_HAVE_THREADSAFE */
/*
* The function stack. Eventually we'll have some sort of global table so each
* thread has it's own stack. The stacks will be created on demand when the
* thread first calls H5FS_push(). */
H5FS_t H5FS_stack_g[1];
#define H5FS_get_my_stack() (H5FS_stack_g+0)
#endif /* H5_HAVE_THREADSAFE */
#ifdef H5_HAVE_THREADSAFE
/*-------------------------------------------------------------------------
* Function: H5FS_get_stack
*
* Purpose: Support function for H5FS_get_my_stack() to initialize and
* acquire per-thread function stack.
*
* Return: Success: function stack (H5FS_t *)
*
* Failure: NULL
*
* Programmer: Quincey Koziol
* February 6, 2003
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static H5FS_t *
H5FS_get_stack(void)
{
H5FS_t *fstack;
FUNC_ENTER_NOAPI_NOFUNC_NOFS(H5FS_get_stack);
fstack = pthread_getspecific(H5TS_funcstk_key_g);
if (!fstack) {
/* no associated value with current thread - create one */
fstack = (H5FS_t *)HDmalloc(sizeof(H5FS_t)); /* Don't use H5MM_malloc() here, it causes infinite recursion */
HDassert(fstack);
/* Set the thread-specific info */
fstack->nused=0;
/* (It's not necessary to release this in this API, it is
* released by the "key destructor" set up in the H5TS
* routines. See calls to pthread_key_create() in H5TS.c -QAK)
*/
pthread_setspecific(H5TS_funcstk_key_g, (void *)fstack);
}
FUNC_LEAVE_NOAPI_NOFS(fstack);
} /* end H5FS_get_stack() */
#endif /* H5_HAVE_THREADSAFE */
/*-------------------------------------------------------------------------
* Function: H5FS_print
*
* Purpose: Prints the function stack in some default way.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* THursday, February 6, 2003
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5FS_print(FILE *stream)
{
H5FS_t *fstack = H5FS_get_my_stack (); /* Get the correct function stack */
const int indent = 2; /* Indention level */
int i; /* Local index ariable */
/* Don't push this function on the function stack... :-) */
FUNC_ENTER_NOAPI_NOFUNC_NOFS(H5FS_print);
/* Sanity check */
assert(fstack);
/* Default to outputting information to stderr */
if (!stream)
stream = stderr;
HDfprintf (stream, "HDF5-DIAG: Function stack from %s ", H5_lib_vers_info_g);
/* try show the process or thread id in multiple processes cases*/
#ifdef H5_HAVE_THREADSAFE
HDfprintf (stream, "thread %d.", (int)pthread_self());
#else /* H5_HAVE_THREADSAFE */
HDfprintf (stream, "thread 0.");
#endif /* H5_HAVE_THREADSAFE */
if (fstack && fstack->nused>0)
HDfprintf (stream, " Back trace follows.");
HDfputc ('\n', stream);
for (i=fstack->nused-1; i>=0; --i)
HDfprintf(stream, "%*s#%03d: Routine: %s\n", indent, "", i, fstack->slot[i]);
FUNC_LEAVE_NOAPI_NOFS(SUCCEED);
} /* end H5FS_print() */
/*-------------------------------------------------------------------------
* Function: H5FS_push
*
* Purpose: Pushes a new record onto function stack for the current
* thread.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Thursday, February 6, 2003
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5FS_push(const char *func_name)
{
H5FS_t *fstack = H5FS_get_my_stack ();
/* Don't push this function on the function stack... :-) */
FUNC_ENTER_NOAPI_NOFUNC_NOFS(H5FS_push);
/* Sanity check */
assert (fstack);
assert (func_name);
/*
* Push the function if there's room. Otherwise just increment count
*/
if (fstack->nused<H5FS_NSLOTS)
fstack->slot[fstack->nused] = func_name;
fstack->nused++;
FUNC_LEAVE_NOAPI_NOFS(SUCCEED);
} /* end H5FS_push() */
/*-------------------------------------------------------------------------
* Function: H5FS_pop
*
* Purpose: Pops a record off function stack for the current thread.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Thursday, February 6, 2003
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5FS_pop(void)
{
H5FS_t *fstack = H5FS_get_my_stack ();
/* Don't push this function on the function stack... :-) */
FUNC_ENTER_NOAPI_NOFUNC_NOFS(H5FS_pop);
/* Sanity check */
assert (fstack);
assert (fstack->nused>0);
/* Pop the function. */
fstack->nused--;
FUNC_LEAVE_NOAPI_NOFS(SUCCEED);
} /* end H5FS_pop() */
#endif /* H5_HAVE_FUNCSTACK */
|
