Rename CMK_TLS_THREAD to the more descriptive CMK_HAS_TLS_VARIABLES
[charm.git] / src / QuickThreads / qt.h
1 /*****************************************************************************
2  * $Source$
3  * $Author$
4  * $Date$
5  * $Revision$
6  *****************************************************************************/
7
8 #ifndef QT_H
9 #define QT_H
10
11 #ifdef __cplusplus
12 extern "C" {
13 #endif
14
15 #include <qtmd.h>
16
17 /* A QuickThreads thread is represented by it's current stack pointer.
18    To restart a thread, you merely need pass the current sp (qt_t*) to
19    a QuickThreads primitive.  `qt_t*' is a location on the stack.  To
20    improve type checking, represent it by a particular struct. */
21
22 typedef struct qt_t {
23   char dummy;
24 } qt_t;
25
26
27 /* Alignment is guaranteed to be a power of two. */
28 #ifndef QT_STKALIGN
29   #error "Need to know the machine-dependent stack alignment."
30 #endif
31
32 #define QT_STKROUNDUP(bytes) \
33   (((bytes)+QT_STKALIGN) & ~(QT_STKALIGN-1))
34
35
36 /* Find ``top'' of the stack, space on the stack. */
37 #ifndef QT_SP
38 #ifdef QT_GROW_DOWN
39 #define QT_SP(sto, size)        ((qt_t *)(&((char *)(sto))[(size)]))
40 #endif
41 #ifdef QT_GROW_UP
42 #define QT_SP(sto, size)        ((void *)(sto))
43 #endif
44 #if !defined(QT_SP)
45   #error "QT_H: Stack must grow up or down!"
46 #endif
47 #endif
48
49
50 /* The type of the user function:
51    For non-varargs, takes one void* function.
52    For varargs, takes some number of arguments. */
53 typedef void *(qt_userf_t)(void *pu);
54 typedef void *(qt_vuserf_t)(int arg0, ...);
55
56 /* For non-varargs, just call a client-supplied function,
57    it does all startup and cleanup, and also calls the user's
58    function. */
59 typedef void (qt_only_t)(void *pu, void *pt, qt_userf_t *userf);
60
61 /* For varargs, call `startup', then call the user's function,
62    then call `cleanup'. */
63 typedef void (qt_startup_t)(void *pt);
64 typedef void (qt_cleanup_t)(void *pt, void *vuserf_return);
65
66
67 /* Internal helper for putting stuff on stack. */
68 #ifndef QT_SPUT
69 #define QT_SPUT(top, at, val)   \
70     (((qt_word_t *)(top))[(at)] = (qt_word_t)(val))
71 #endif
72
73
74 /* Push arguments for the non-varargs case. */
75 #ifndef QT_ARGS
76
77 #ifndef QT_ARGS_MD
78 #define QT_ARGS_MD (0)
79 #endif
80
81 #ifndef QT_STKBASE
82   #error "Need to know the machine-dependent stack allocation."
83 #endif
84
85 /* All things are put on the stack relative to the final value of
86    the stack pointer. */
87 #ifdef QT_GROW_DOWN
88 #define QT_ADJ(sp)      (((char *)sp) - QT_STKBASE)
89 #else
90 #define QT_ADJ(sp)      (((char *)sp) + QT_STKBASE)
91 #endif
92
93 #define QT_ARGS(sp, pu, pt, userf, only) \
94     (QT_ARGS_MD (QT_ADJ(sp)), \
95      QT_SPUT (QT_ADJ(sp), QT_ONLY_INDEX, only), \
96      QT_SPUT (QT_ADJ(sp), QT_USER_INDEX, userf), \
97      QT_SPUT (QT_ADJ(sp), QT_ARGT_INDEX, pt), \
98      QT_SPUT (QT_ADJ(sp), QT_ARGU_INDEX, pu), \
99      ((qt_t *)QT_ADJ(sp)))
100
101 #endif
102
103
104 /* Push arguments for the varargs case.
105    Has to be a function call because initialization is an expression
106    and we need to loop to copy nbytes of stuff on to the stack.
107    But that's probably OK, it's not terribly cheap, anyway. */
108
109 #ifdef QT_VARGS_DEFAULT
110 #ifndef QT_VARGS_MD0
111 #define QT_VARGS_MD0(sp, vasize)        (sp)
112 #endif
113 #ifndef QT_VARGS_MD1
114 #define QT_VARGS_MD1(sp)        do { ; } while (0)
115 #endif
116
117 #ifndef QT_VSTKBASE
118   #error "Need base stack size for varargs functions."
119 #endif
120
121 /* Sometimes the stack pointer needs to munged a bit when storing
122    the list of arguments. */
123 #ifndef QT_VARGS_ADJUST
124 #define QT_VARGS_ADJUST(sp)     (sp)
125 #endif
126
127 /* All things are put on the stack relative to the final value of
128    the stack pointer. */
129 #ifdef QT_GROW_DOWN
130 #define QT_VADJ(sp)     (((char *)sp) - QT_VSTKBASE)
131 #else
132 #define QT_VADJ(sp)     (((char *)sp) + QT_VSTKBASE)
133 #endif
134
135 extern qt_t *qt_vargs (qt_t *sp, int nbytes, void *vargs,
136                        void *pt, qt_startup_t *startup,
137                        qt_vuserf_t *vuserf, qt_cleanup_t *cleanup);
138
139 #ifndef QT_VARGS
140 #define QT_VARGS(sp, nbytes, vargs, pt, startup, vuserf, cleanup) \
141       (qt_vargs (sp, nbytes, vargs, pt, startup, vuserf, cleanup))
142 #endif
143
144 #endif
145
146
147 /* Save the state of the thread and call the helper function
148    using the stack of the new thread. */
149 typedef void *(qt_helper_t)(qt_t *old, void *a0, void *a1);
150 typedef void *(qt_block_t)(qt_helper_t *helper, void *a0, void *a1,
151                           qt_t *newthread);
152
153 /* Rearrange the parameters so that things passed to the helper
154    function are already in the right argument registers. */
155 #ifndef QT_ABORT
156 extern qt_abort (qt_helper_t *h, void *a0, void *a1, qt_t *newthread);
157 /* The following does, technically, `return' a value, but the
158    user had better not rely on it, since the function never
159    returns. */ 
160 #define QT_ABORT(h, a0, a1, newthread) \
161     do { qt_abort (h, a0, a1, newthread); } while (0)
162 #endif
163
164 #ifndef QT_BLOCK
165 extern void *qt_block (qt_helper_t *h, void *a0, void *a1,
166                        qt_t *newthread);
167 #define QT_BLOCK(h, a0, a1, newthread) \
168     (qt_block (h, a0, a1, newthread))
169 #endif
170
171 #ifndef QT_BLOCKI
172 extern void *qt_blocki (qt_helper_t *h, void *a0, void *a1,
173                         qt_t *newthread);
174 #define QT_BLOCKI(h, a0, a1, newthread) \
175     (qt_blocki (h, a0, a1, newthread))
176 #endif
177
178 #ifdef __cplusplus
179 }               /* Match `extern "C" {' at top. */
180 #endif
181
182 #endif /* ndef QT_H */