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.
28 #define str(a,b) #a "_" #b
30 #define OFFSET(s_type, field) ((unsigned int)&(((s_type*)0)->field))
32 #if defined(GEN_HASKELL)
33 #define def_offset(str, offset) \
34 printf("oFFSET_" str " = %d::Int\n", offset);
36 #define def_offset(str, offset) \
37 printf("#define OFFSET_" str " %d\n", offset);
40 #if defined(GEN_HASKELL)
41 #define ctype(type) /* nothing */
44 printf("#define SIZEOF_" #type " %d\n", sizeof(type));
47 #if defined(GEN_HASKELL)
48 #define field_type_(str, s_type, field) /* nothing */
50 #define field_type_(str, s_type, field) \
51 printf("#define REP_" str " I"); \
52 printf("%d\n", sizeof (__typeof__(((((s_type*)0)->field)))) * 8);
55 #define field_type(s_type, field) \
56 field_type_(str(s_type,field),s_type,field);
58 #define field_offset_(str, s_type, field) \
59 def_offset(str, OFFSET(s_type,field));
61 #define field_offset(s_type, field) \
62 field_offset_(str(s_type,field),s_type,field);
64 /* An access macro for use in C-- sources. */
65 #define struct_field_macro(str) \
66 printf("#define " str "(__ptr__) REP_" str "[__ptr__+OFFSET_" str "]\n");
68 /* Outputs the byte offset and MachRep for a field */
69 #define struct_field(s_type, field) \
70 field_offset(s_type, field); \
71 field_type(s_type, field); \
72 struct_field_macro(str(s_type,field))
74 #define struct_field_(str, s_type, field) \
75 field_offset_(str, s_type, field); \
76 field_type_(str, s_type, field); \
77 struct_field_macro(str)
79 #if defined(GEN_HASKELL)
80 #define def_size(str, size) \
81 printf("sIZEOF_" str " = %d::Int\n", size);
83 #define def_size(str, size) \
84 printf("#define SIZEOF_" str " %d\n", size);
87 #if defined(GEN_HASKELL)
88 #define def_closure_size(str, size) /* nothing */
90 #define def_closure_size(str, size) \
91 printf("#define SIZEOF_" str " (SIZEOF_StgHeader+%d)\n", size);
94 #define struct_size(s_type) \
95 def_size(#s_type, sizeof(s_type));
98 * Size of a closure type, minus the header, named SIZEOF_<type>_NoHdr
99 * Also, we #define SIZEOF_<type> to be the size of the whole closure for .cmm.
101 #define closure_size(s_type) \
102 def_size(#s_type "_NoHdr", sizeof(s_type) - sizeof(StgHeader)); \
103 def_closure_size(#s_type, sizeof(s_type) - sizeof(StgHeader));
105 /* An access macro for use in C-- sources. */
106 #define closure_field_macro(str) \
107 printf("#define " str "(__ptr__) REP_" str "[__ptr__+SIZEOF_StgHeader+OFFSET_" str "]\n");
109 #define closure_field_offset_(str, s_type,field) \
110 def_offset(str, OFFSET(s_type,field) - sizeof(StgHeader));
112 #define closure_field_offset(s_type,field) \
113 closure_field_offset_(str(s_type,field),s_type,field);
115 #define closure_payload_macro(str) \
116 printf("#define " str "(__ptr__,__ix__) W_[__ptr__+SIZEOF_StgHeader+OFFSET_" str " + WDS(__ix__)]\n");
118 #define closure_payload(s_type,field) \
119 closure_field_offset_(str(s_type,field),s_type,field); \
120 closure_payload_macro(str(s_type,field));
122 /* Byte offset and MachRep for a closure field, minus the header */
123 #define closure_field(s_type, field) \
124 closure_field_offset(s_type,field) \
125 field_type(s_type, field); \
126 closure_field_macro(str(s_type,field))
128 /* Byte offset and MachRep for a closure field, minus the header */
129 #define closure_field_(str, s_type, field) \
130 closure_field_offset_(str,s_type,field) \
131 field_type_(str, s_type, field); \
132 closure_field_macro(str)
135 * Byte offset and MachRep for a TSO field, minus the header and
138 #define tso_offset(s_type, field) \
139 def_offset(str(s_type,field), OFFSET(s_type,field) - sizeof(StgHeader) - sizeof(StgTSOProfInfo));
141 #define tso_field_macro(str) \
142 printf("#define " str "(__ptr__) REP_" str "[__ptr__+SIZEOF_StgHeader+SIZEOF_OPT_StgTSOProfInfo+SIZEOF_OPT_StgTSOParInfo+SIZEOF_OPT_StgTSOGranInfo+SIZEOF_OPT_StgTSODistInfo+OFFSET_" str "]\n");
144 #define tso_field(s_type, field) \
145 tso_offset(s_type, field); \
146 field_type(s_type, field); \
147 tso_field_macro(str(s_type,field))
149 #define opt_struct_size(s_type, option) \
150 printf("#ifdef " #option "\n"); \
151 printf("#define SIZEOF_OPT_" #s_type " SIZEOF_" #s_type "\n"); \
153 printf("#define SIZEOF_OPT_" #s_type " 0\n"); \
154 printf("#endif\n\n");
156 #define FUN_OFFSET(sym) (OFFSET(Capability,f.sym) - OFFSET(Capability,r))
160 main(int argc, char *argv[])
163 printf("/* This file is created automatically. Do not edit by hand.*/\n\n");
165 printf("#define STD_HDR_SIZE %d\n", sizeofW(StgHeader) - sizeofW(StgProfHeader));
166 /* grrr.. PROFILING is on so we need to subtract sizeofW(StgProfHeader) */
167 printf("#define PROF_HDR_SIZE %d\n", sizeofW(StgProfHeader));
168 printf("#define GRAN_HDR_SIZE %d\n", sizeofW(StgGranHeader));
170 printf("#define STD_ITBL_SIZE %d\n", sizeofW(StgInfoTable));
171 printf("#define RET_ITBL_SIZE %d\n", sizeofW(StgRetInfoTable) - sizeofW(StgInfoTable));
172 printf("#define PROF_ITBL_SIZE %d\n", sizeofW(StgProfInfo));
174 printf("#define GRAN_ITBL_SIZE %d\n", 0);
175 printf("#define TICKY_ITBL_SIZE %d\n", 0);
177 printf("#define BLOCK_SIZE %d\n", BLOCK_SIZE);
178 printf("#define MBLOCK_SIZE %d\n", MBLOCK_SIZE);
183 field_offset(StgRegTable, rR1);
184 field_offset(StgRegTable, rR2);
185 field_offset(StgRegTable, rR3);
186 field_offset(StgRegTable, rR4);
187 field_offset(StgRegTable, rR5);
188 field_offset(StgRegTable, rR6);
189 field_offset(StgRegTable, rR7);
190 field_offset(StgRegTable, rR8);
191 field_offset(StgRegTable, rR9);
192 field_offset(StgRegTable, rR10);
193 field_offset(StgRegTable, rF1);
194 field_offset(StgRegTable, rF2);
195 field_offset(StgRegTable, rF3);
196 field_offset(StgRegTable, rF4);
197 field_offset(StgRegTable, rD1);
198 field_offset(StgRegTable, rD2);
199 field_offset(StgRegTable, rL1);
200 field_offset(StgRegTable, rSp);
201 field_offset(StgRegTable, rSpLim);
202 field_offset(StgRegTable, rHp);
203 field_offset(StgRegTable, rHpLim);
204 field_offset(StgRegTable, rCurrentTSO);
205 field_offset(StgRegTable, rCurrentNursery);
206 field_offset(StgRegTable, rHpAlloc);
208 def_offset("stgGCEnter1", FUN_OFFSET(stgGCEnter1));
209 def_offset("stgGCFun", FUN_OFFSET(stgGCFun));
211 field_offset(Capability, r);
213 struct_field(bdescr, start);
214 struct_field(bdescr, free);
215 struct_field(bdescr, blocks);
216 struct_field(bdescr, gen_no);
217 struct_field(bdescr, link);
219 struct_size(generation);
220 struct_field(generation, mut_list);
222 struct_size(CostCentreStack);
223 struct_field(CostCentreStack, ccsID);
224 struct_field(CostCentreStack, mem_alloc);
225 struct_field(CostCentreStack, scc_count);
226 struct_field(CostCentreStack, prevStack);
228 struct_field(CostCentre, ccID);
229 struct_field(CostCentre, link);
231 struct_field(StgHeader, info);
232 struct_field_("StgHeader_ccs", StgHeader, prof.ccs);
233 struct_field_("StgHeader_ldvw", StgHeader, prof.hp.ldvw);
235 closure_payload(StgClosure,payload);
237 struct_field(StgEntCounter, allocs);
238 struct_field(StgEntCounter, registeredp);
239 struct_field(StgEntCounter, link);
241 closure_size(StgUpdateFrame);
242 closure_size(StgCatchFrame);
243 closure_size(StgStopFrame);
245 closure_size(StgMutArrPtrs);
246 closure_field(StgMutArrPtrs, ptrs);
248 closure_size(StgArrWords);
249 closure_field(StgArrWords, words);
250 closure_payload(StgArrWords, payload);
252 closure_field(StgTSO, link);
253 closure_field(StgTSO, global_link);
254 closure_field(StgTSO, what_next);
255 closure_field(StgTSO, why_blocked);
256 closure_field(StgTSO, block_info);
257 closure_field(StgTSO, blocked_exceptions);
258 closure_field(StgTSO, id);
259 closure_field(StgTSO, saved_errno);
260 closure_field(StgTSO, trec);
261 closure_field_("StgTSO_CCCS", StgTSO, prof.CCCS);
262 tso_field(StgTSO, sp);
263 tso_offset(StgTSO, stack);
264 tso_field(StgTSO, stack_size);
266 struct_size(StgTSOProfInfo);
267 struct_size(StgTSOParInfo);
268 struct_size(StgTSOGranInfo);
269 struct_size(StgTSODistInfo);
271 opt_struct_size(StgTSOProfInfo,PROFILING);
272 opt_struct_size(StgTSOParInfo,PAR);
273 opt_struct_size(StgTSOGranInfo,GRAN);
274 opt_struct_size(StgTSODistInfo,DIST);
276 closure_size(StgBlockingQueue);
277 closure_field(StgBlockingQueue, blocking_queue);
279 closure_field(StgUpdateFrame, updatee);
281 closure_field(StgCatchFrame, handler);
282 closure_field(StgCatchFrame, exceptions_blocked);
284 closure_size(StgPAP);
285 closure_field(StgPAP, n_args);
286 closure_field(StgPAP, fun);
287 closure_field(StgPAP, arity);
288 closure_payload(StgPAP, payload);
291 closure_field(StgAP, n_args);
292 closure_field(StgAP, fun);
293 closure_payload(StgAP, payload);
295 closure_size(StgAP_STACK);
296 closure_field(StgAP_STACK, size);
297 closure_field(StgAP_STACK, fun);
298 closure_payload(StgAP_STACK, payload);
300 closure_field(StgInd, indirectee);
302 closure_size(StgMutVar);
303 closure_field(StgMutVar, var);
305 closure_size(StgAtomicallyFrame);
306 closure_field(StgAtomicallyFrame, waiting);
307 closure_field(StgAtomicallyFrame, code);
309 closure_size(StgCatchSTMFrame);
310 closure_field(StgCatchSTMFrame, handler);
312 closure_size(StgCatchRetryFrame);
313 closure_field(StgCatchRetryFrame, running_alt_code);
314 closure_field(StgCatchRetryFrame, first_code);
315 closure_field(StgCatchRetryFrame, alt_code);
316 closure_field(StgCatchRetryFrame, first_code_trec);
318 closure_size(StgForeignObj);
319 closure_field(StgForeignObj,data);
321 closure_size(StgWeak);
322 closure_field(StgWeak,link);
323 closure_field(StgWeak,key);
324 closure_field(StgWeak,value);
325 closure_field(StgWeak,finalizer);
327 closure_size(StgDeadWeak);
328 closure_field(StgDeadWeak,link);
330 closure_size(StgMVar);
331 closure_field(StgMVar,head);
332 closure_field(StgMVar,tail);
333 closure_field(StgMVar,value);
335 closure_size(StgTVar);
336 closure_field(StgTVar,current_value);
337 closure_field(StgTVar,first_wait_queue_entry);
339 closure_size(StgBCO);
340 closure_field(StgBCO, instrs);
341 closure_field(StgBCO, literals);
342 closure_field(StgBCO, ptrs);
343 closure_field(StgBCO, itbls);
344 closure_field(StgBCO, arity);
345 closure_field(StgBCO, size);
346 closure_payload(StgBCO, bitmap);
348 closure_size(StgStableName);
349 closure_field(StgStableName,sn);
351 struct_field_("RtsFlags_ProfFlags_showCCSOnException",
352 RTS_FLAGS, ProfFlags.showCCSOnException);
353 struct_field_("RtsFlags_DebugFlags_apply",
354 RTS_FLAGS, DebugFlags.apply);
355 struct_field_("RtsFlags_DebugFlags_sanity",
356 RTS_FLAGS, DebugFlags.sanity);
357 struct_field_("RtsFlags_DebugFlags_weak",
358 RTS_FLAGS, DebugFlags.weak);
359 struct_field_("RtsFlags_GcFlags_initialStkSize",
360 RTS_FLAGS, GcFlags.initialStkSize);
362 struct_size(StgFunInfoExtraFwd);
363 struct_field(StgFunInfoExtraFwd, slow_apply);
364 struct_field(StgFunInfoExtraFwd, fun_type);
365 struct_field(StgFunInfoExtraFwd, arity);
366 struct_field(StgFunInfoExtraFwd, bitmap);
368 struct_size(StgFunInfoExtraRev);
369 struct_field(StgFunInfoExtraRev, slow_apply_offset);
370 struct_field(StgFunInfoExtraRev, fun_type);
371 struct_field(StgFunInfoExtraRev, arity);
372 struct_field(StgFunInfoExtraRev, bitmap);
374 struct_field(StgLargeBitmap, size);
375 field_offset(StgLargeBitmap, bitmap);
377 struct_size(snEntry);
378 struct_field(snEntry,sn_obj);
379 struct_field(snEntry,addr);
381 #ifdef mingw32_HOST_OS
382 struct_size(StgAsyncIOResult);
383 struct_field(StgAsyncIOResult, reqID);
384 struct_field(StgAsyncIOResult, len);
385 struct_field(StgAsyncIOResult, errCode);
389 struct_field(MP_INT,_mp_alloc);
390 struct_field(MP_INT,_mp_size);
391 struct_field(MP_INT,_mp_d);