1 /* --------------------------------------------------------------------------
3 * (c) The GHC Team, 1992-2004
7 * Basically this is a C program that extracts information from the C
8 * declarations in the header files (primarily struct field offsets)
9 * and generates a header file that can be #included into non-C source
10 * containing this information.
12 * ------------------------------------------------------------------------*/
17 * We need offsets of profiled things... better be careful that this
18 * doesn't affect the offsets of anything else.
27 #include "OSThreads.h"
28 #include "Capability.h"
32 #define str(a,b) #a "_" #b
34 #define OFFSET(s_type, field) ((size_t)&(((s_type*)0)->field))
36 #ifdef mingw32_HOST_OS
39 #define SIZET_FMT "zd"
42 #if defined(GEN_HASKELL)
43 #define def_offset(str, offset) \
44 printf("oFFSET_" str " :: Int\n"); \
45 printf("oFFSET_" str " = %" SIZET_FMT "\n", offset);
47 #define def_offset(str, offset) \
48 printf("#define OFFSET_" str " %" SIZET_FMT "\n", offset);
51 #if defined(GEN_HASKELL)
52 #define ctype(type) /* nothing */
55 printf("#define SIZEOF_" #type " %d\n", sizeof(type));
58 #if defined(GEN_HASKELL)
59 #define field_type_(str, s_type, field) /* nothing */
60 #define field_type_gcptr_(str, s_type, field) /* nothing */
62 /* Defining REP_x to be b32 etc
63 These are both the C-- types used in a load
65 and the names of the CmmTypes in the compiler
68 #define field_type_(str, s_type, field) \
69 printf("#define REP_" str " b"); \
70 printf("%d\n", sizeof (__typeof__(((((s_type*)0)->field)))) * 8);
71 #define field_type_gcptr_(str, s_type, field) \
72 printf("#define REP_" str " gcptr\n");
75 #define field_type(s_type, field) \
76 field_type_(str(s_type,field),s_type,field);
78 #define field_offset_(str, s_type, field) \
79 def_offset(str, OFFSET(s_type,field));
81 #define field_offset(s_type, field) \
82 field_offset_(str(s_type,field),s_type,field);
84 /* An access macro for use in C-- sources. */
85 #define struct_field_macro(str) \
86 printf("#define " str "(__ptr__) REP_" str "[__ptr__+OFFSET_" str "]\n");
88 /* Outputs the byte offset and MachRep for a field */
89 #define struct_field(s_type, field) \
90 field_offset(s_type, field); \
91 field_type(s_type, field); \
92 struct_field_macro(str(s_type,field))
94 #define struct_field_(str, s_type, field) \
95 field_offset_(str, s_type, field); \
96 field_type_(str, s_type, field); \
97 struct_field_macro(str)
99 #if defined(GEN_HASKELL)
100 #define def_size(str, size) \
101 printf("sIZEOF_" str " :: Int\n"); \
102 printf("sIZEOF_" str " = %d\n", size);
104 #define def_size(str, size) \
105 printf("#define SIZEOF_" str " %d\n", size);
108 #if defined(GEN_HASKELL)
109 #define def_closure_size(str, size) /* nothing */
111 #define def_closure_size(str, size) \
112 printf("#define SIZEOF_" str " (SIZEOF_StgHeader+%d)\n", size);
115 #define struct_size(s_type) \
116 def_size(#s_type, sizeof(s_type));
119 * Size of a closure type, minus the header, named SIZEOF_<type>_NoHdr
120 * Also, we #define SIZEOF_<type> to be the size of the whole closure for .cmm.
122 #define closure_size(s_type) \
123 def_size(#s_type "_NoHdr", sizeof(s_type) - sizeof(StgHeader)); \
124 def_closure_size(#s_type, sizeof(s_type) - sizeof(StgHeader));
126 #define thunk_size(s_type) \
127 def_size(#s_type "_NoThunkHdr", sizeof(s_type) - sizeof(StgThunkHeader)); \
130 /* An access macro for use in C-- sources. */
131 #define closure_field_macro(str) \
132 printf("#define " str "(__ptr__) REP_" str "[__ptr__+SIZEOF_StgHeader+OFFSET_" str "]\n");
134 #define closure_field_offset_(str, s_type,field) \
135 def_offset(str, OFFSET(s_type,field) - sizeof(StgHeader));
137 #define closure_field_offset(s_type,field) \
138 closure_field_offset_(str(s_type,field),s_type,field)
140 #define closure_payload_macro(str) \
141 printf("#define " str "(__ptr__,__ix__) W_[__ptr__+SIZEOF_StgHeader+OFFSET_" str " + WDS(__ix__)]\n");
143 #define closure_payload(s_type,field) \
144 closure_field_offset_(str(s_type,field),s_type,field); \
145 closure_payload_macro(str(s_type,field));
147 /* Byte offset and MachRep for a closure field, minus the header */
148 #define closure_field_(str, s_type, field) \
149 closure_field_offset_(str,s_type,field) \
150 field_type_(str, s_type, field); \
151 closure_field_macro(str)
153 #define closure_field(s_type, field) \
154 closure_field_(str(s_type,field),s_type,field)
156 /* Byte offset and MachRep for a closure field, minus the header */
157 #define closure_field_gcptr_(str, s_type, field) \
158 closure_field_offset_(str,s_type,field) \
159 field_type_gcptr_(str, s_type, field); \
160 closure_field_macro(str)
162 #define closure_field_gcptr(s_type, field) \
163 closure_field_gcptr_(str(s_type,field),s_type,field)
165 /* Byte offset for a TSO field, minus the header and variable prof bit. */
166 #define tso_payload_offset(s_type, field) \
167 def_offset(str(s_type,field), OFFSET(s_type,field) - sizeof(StgHeader) - sizeof(StgTSOProfInfo));
169 /* Full byte offset for a TSO field, for use from Cmm */
170 #define tso_field_offset_macro(str) \
171 printf("#define TSO_OFFSET_" str " (SIZEOF_StgHeader+SIZEOF_OPT_StgTSOProfInfo+SIZEOF_OPT_StgTSOParInfo+SIZEOF_OPT_StgTSOGranInfo+SIZEOF_OPT_StgTSODistInfo+OFFSET_" str ")\n");
173 #define tso_field_offset(s_type, field) \
174 tso_payload_offset(s_type, field); \
175 tso_field_offset_macro(str(s_type,field));
177 #define tso_field_macro(str) \
178 printf("#define " str "(__ptr__) REP_" str "[__ptr__+TSO_OFFSET_" str "]\n")
179 #define tso_field(s_type, field) \
180 field_type(s_type, field); \
181 tso_field_offset(s_type,field); \
182 tso_field_macro(str(s_type,field))
184 #define opt_struct_size(s_type, option) \
185 printf("#ifdef " #option "\n"); \
186 printf("#define SIZEOF_OPT_" #s_type " SIZEOF_" #s_type "\n"); \
188 printf("#define SIZEOF_OPT_" #s_type " 0\n"); \
189 printf("#endif\n\n");
191 #define FUN_OFFSET(sym) (OFFSET(Capability,f.sym) - OFFSET(Capability,r))
195 main(int argc, char *argv[])
198 printf("/* This file is created automatically. Do not edit by hand.*/\n\n");
200 printf("#define STD_HDR_SIZE %d\n", sizeofW(StgHeader) - sizeofW(StgProfHeader));
201 /* grrr.. PROFILING is on so we need to subtract sizeofW(StgProfHeader) */
202 printf("#define PROF_HDR_SIZE %d\n", sizeofW(StgProfHeader));
203 printf("#define GRAN_HDR_SIZE %d\n", sizeofW(StgGranHeader));
205 printf("#define BLOCK_SIZE %d\n", BLOCK_SIZE);
206 printf("#define MBLOCK_SIZE %d\n", MBLOCK_SIZE);
211 field_offset(StgRegTable, rR1);
212 field_offset(StgRegTable, rR2);
213 field_offset(StgRegTable, rR3);
214 field_offset(StgRegTable, rR4);
215 field_offset(StgRegTable, rR5);
216 field_offset(StgRegTable, rR6);
217 field_offset(StgRegTable, rR7);
218 field_offset(StgRegTable, rR8);
219 field_offset(StgRegTable, rR9);
220 field_offset(StgRegTable, rR10);
221 field_offset(StgRegTable, rF1);
222 field_offset(StgRegTable, rF2);
223 field_offset(StgRegTable, rF3);
224 field_offset(StgRegTable, rF4);
225 field_offset(StgRegTable, rD1);
226 field_offset(StgRegTable, rD2);
227 field_offset(StgRegTable, rL1);
228 field_offset(StgRegTable, rSp);
229 field_offset(StgRegTable, rSpLim);
230 field_offset(StgRegTable, rHp);
231 field_offset(StgRegTable, rHpLim);
232 field_offset(StgRegTable, rCurrentTSO);
233 field_offset(StgRegTable, rCurrentNursery);
234 field_offset(StgRegTable, rHpAlloc);
235 struct_field(StgRegTable, rRet);
237 // Needed for SMP builds
238 field_offset(StgRegTable, rmp_tmp_w);
239 field_offset(StgRegTable, rmp_tmp1);
240 field_offset(StgRegTable, rmp_tmp2);
241 field_offset(StgRegTable, rmp_result1);
242 field_offset(StgRegTable, rmp_result2);
244 def_offset("stgEagerBlackholeInfo", FUN_OFFSET(stgEagerBlackholeInfo));
245 def_offset("stgGCEnter1", FUN_OFFSET(stgGCEnter1));
246 def_offset("stgGCFun", FUN_OFFSET(stgGCFun));
248 field_offset(Capability, r);
249 field_offset(Capability, lock);
250 struct_field(Capability, mut_lists);
251 struct_field(Capability, context_switch);
253 struct_field(bdescr, start);
254 struct_field(bdescr, free);
255 struct_field(bdescr, blocks);
256 struct_field(bdescr, gen_no);
257 struct_field(bdescr, link);
259 struct_size(generation);
260 struct_field(generation, mut_list);
262 struct_size(CostCentreStack);
263 struct_field(CostCentreStack, ccsID);
264 struct_field(CostCentreStack, mem_alloc);
265 struct_field(CostCentreStack, scc_count);
266 struct_field(CostCentreStack, prevStack);
268 struct_field(CostCentre, ccID);
269 struct_field(CostCentre, link);
271 struct_field(StgHeader, info);
272 struct_field_("StgHeader_ccs", StgHeader, prof.ccs);
273 struct_field_("StgHeader_ldvw", StgHeader, prof.hp.ldvw);
275 struct_size(StgSMPThunkHeader);
277 closure_payload(StgClosure,payload);
279 struct_field(StgEntCounter, allocs);
280 struct_field(StgEntCounter, registeredp);
281 struct_field(StgEntCounter, link);
282 struct_field(StgEntCounter, entry_count);
284 closure_size(StgUpdateFrame);
285 closure_size(StgCatchFrame);
286 closure_size(StgStopFrame);
288 closure_size(StgMutArrPtrs);
289 closure_field(StgMutArrPtrs, ptrs);
291 closure_size(StgArrWords);
292 closure_field(StgArrWords, words);
293 closure_payload(StgArrWords, payload);
295 closure_field(StgTSO, _link);
296 closure_field(StgTSO, global_link);
297 closure_field(StgTSO, what_next);
298 closure_field(StgTSO, why_blocked);
299 closure_field(StgTSO, block_info);
300 closure_field(StgTSO, blocked_exceptions);
301 closure_field(StgTSO, id);
302 closure_field(StgTSO, cap);
303 closure_field(StgTSO, saved_errno);
304 closure_field(StgTSO, trec);
305 closure_field(StgTSO, flags);
306 closure_field_("StgTSO_CCCS", StgTSO, prof.CCCS);
307 tso_field(StgTSO, sp);
308 tso_field_offset(StgTSO, stack);
309 tso_field(StgTSO, stack_size);
311 struct_size(StgTSOProfInfo);
312 struct_size(StgTSOParInfo);
313 struct_size(StgTSOGranInfo);
314 struct_size(StgTSODistInfo);
316 opt_struct_size(StgTSOProfInfo,PROFILING);
317 opt_struct_size(StgTSOParInfo,PAR);
318 opt_struct_size(StgTSOGranInfo,GRAN);
319 opt_struct_size(StgTSODistInfo,DIST);
321 closure_field(StgUpdateFrame, updatee);
323 closure_field(StgCatchFrame, handler);
324 closure_field(StgCatchFrame, exceptions_blocked);
326 closure_size(StgPAP);
327 closure_field(StgPAP, n_args);
328 closure_field_gcptr(StgPAP, fun);
329 closure_field(StgPAP, arity);
330 closure_payload(StgPAP, payload);
333 closure_field(StgAP, n_args);
334 closure_field_gcptr(StgAP, fun);
335 closure_payload(StgAP, payload);
337 thunk_size(StgAP_STACK);
338 closure_field(StgAP_STACK, size);
339 closure_field_gcptr(StgAP_STACK, fun);
340 closure_payload(StgAP_STACK, payload);
342 thunk_size(StgSelector);
344 closure_field_gcptr(StgInd, indirectee);
346 closure_size(StgMutVar);
347 closure_field(StgMutVar, var);
349 closure_size(StgAtomicallyFrame);
350 closure_field(StgAtomicallyFrame, code);
351 closure_field(StgAtomicallyFrame, next_invariant_to_check);
353 closure_field(StgInvariantCheckQueue, invariant);
354 closure_field(StgInvariantCheckQueue, my_execution);
355 closure_field(StgInvariantCheckQueue, next_queue_entry);
357 closure_field(StgAtomicInvariant, code);
359 closure_size(StgCatchSTMFrame);
360 closure_field(StgCatchSTMFrame, handler);
361 closure_field(StgCatchSTMFrame, code);
363 closure_size(StgCatchRetryFrame);
364 closure_field(StgCatchRetryFrame, running_alt_code);
365 closure_field(StgCatchRetryFrame, first_code);
366 closure_field(StgCatchRetryFrame, alt_code);
368 closure_field(StgTVarWatchQueue, closure);
369 closure_field(StgTVarWatchQueue, next_queue_entry);
370 closure_field(StgTVarWatchQueue, prev_queue_entry);
372 closure_field(StgTVar, current_value);
374 closure_size(StgWeak);
375 closure_field(StgWeak,link);
376 closure_field(StgWeak,key);
377 closure_field(StgWeak,value);
378 closure_field(StgWeak,finalizer);
380 closure_size(StgDeadWeak);
381 closure_field(StgDeadWeak,link);
383 closure_size(StgMVar);
384 closure_field(StgMVar,head);
385 closure_field(StgMVar,tail);
386 closure_field(StgMVar,value);
388 closure_size(StgBCO);
389 closure_field(StgBCO, instrs);
390 closure_field(StgBCO, literals);
391 closure_field(StgBCO, ptrs);
392 closure_field(StgBCO, arity);
393 closure_field(StgBCO, size);
394 closure_payload(StgBCO, bitmap);
396 closure_size(StgStableName);
397 closure_field(StgStableName,sn);
399 struct_field_("RtsFlags_ProfFlags_showCCSOnException",
400 RTS_FLAGS, ProfFlags.showCCSOnException);
401 struct_field_("RtsFlags_DebugFlags_apply",
402 RTS_FLAGS, DebugFlags.apply);
403 struct_field_("RtsFlags_DebugFlags_sanity",
404 RTS_FLAGS, DebugFlags.sanity);
405 struct_field_("RtsFlags_DebugFlags_weak",
406 RTS_FLAGS, DebugFlags.weak);
407 struct_field_("RtsFlags_GcFlags_initialStkSize",
408 RTS_FLAGS, GcFlags.initialStkSize);
409 struct_field_("RtsFlags_MiscFlags_tickInterval",
410 RTS_FLAGS, MiscFlags.tickInterval);
412 struct_size(StgFunInfoExtraFwd);
413 struct_field(StgFunInfoExtraFwd, slow_apply);
414 struct_field(StgFunInfoExtraFwd, fun_type);
415 struct_field(StgFunInfoExtraFwd, arity);
416 struct_field_("StgFunInfoExtraFwd_bitmap", StgFunInfoExtraFwd, b.bitmap);
418 struct_size(StgFunInfoExtraRev);
419 struct_field(StgFunInfoExtraRev, slow_apply_offset);
420 struct_field(StgFunInfoExtraRev, fun_type);
421 struct_field(StgFunInfoExtraRev, arity);
422 struct_field_("StgFunInfoExtraRev_bitmap", StgFunInfoExtraRev, b.bitmap);
424 struct_field(StgLargeBitmap, size);
425 field_offset(StgLargeBitmap, bitmap);
427 struct_size(snEntry);
428 struct_field(snEntry,sn_obj);
429 struct_field(snEntry,addr);
431 #ifdef mingw32_HOST_OS
432 struct_size(StgAsyncIOResult);
433 struct_field(StgAsyncIOResult, reqID);
434 struct_field(StgAsyncIOResult, len);
435 struct_field(StgAsyncIOResult, errCode);
439 struct_field(MP_INT,_mp_alloc);
440 struct_field(MP_INT,_mp_size);
441 struct_field(MP_INT,_mp_d);