ghc/includes/mkDerivedConstants.c

   1 /* --------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1992-2004
   4  *
   5  * mkDerivedConstants.c
   6  *
   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.
  11  *
  12  * ------------------------------------------------------------------------*/
  13
  14 #define IN_STG_CODE 0
  15
  16 /*
  17  * We need offsets of profiled things... better be careful that this
  18  * doesn't affect the offsets of anything else.
  19  */
  20 #define PROFILING
  21
  22 #include "Rts.h"
  23 #include "RtsFlags.h"
  24 #include "Storage.h"
  25 #include "OSThreads.h"
  26 #include "Capability.h"
  27
  28 #include <stdio.h>
  29
  30 #define str(a,b) #a "_" #b
  31
  32 #define OFFSET(s_type, field) ((unsigned int)&(((s_type*)0)->field))
  33
  34 #if defined(GEN_HASKELL)
  35 #define def_offset(str, offset) \
  36     printf("oFFSET_" str " = %d::Int\n", offset);
  37 #else
  38 #define def_offset(str, offset) \
  39     printf("#define OFFSET_" str " %d\n", offset);
  40 #endif
  41
  42 #if defined(GEN_HASKELL)
  43 #define ctype(type) /* nothing */
  44 #else
  45 #define ctype(type) \
  46     printf("#define SIZEOF_" #type " %d\n", sizeof(type));
  47 #endif
  48
  49 #if defined(GEN_HASKELL)
  50 #define field_type_(str, s_type, field) /* nothing */
  51 #else
  52 #define field_type_(str, s_type, field) \
  53     printf("#define REP_" str " I"); \
  54     printf("%d\n", sizeof (__typeof__(((((s_type*)0)->field)))) * 8);
  55 #endif
  56
  57 #define field_type(s_type, field) \
  58     field_type_(str(s_type,field),s_type,field);
  59
  60 #define field_offset_(str, s_type, field) \
  61     def_offset(str, OFFSET(s_type,field));
  62
  63 #define field_offset(s_type, field) \
  64     field_offset_(str(s_type,field),s_type,field);
  65
  66 /* An access macro for use in C-- sources. */
  67 #define struct_field_macro(str) \
  68     printf("#define " str "(__ptr__)  REP_" str "[__ptr__+OFFSET_" str "]\n");
  69
  70 /* Outputs the byte offset and MachRep for a field */
  71 #define struct_field(s_type, field)             \
  72     field_offset(s_type, field);                \
  73     field_type(s_type, field);                  \
  74     struct_field_macro(str(s_type,field))
  75
  76 #define struct_field_(str, s_type, field)       \
  77     field_offset_(str, s_type, field);          \
  78     field_type_(str, s_type, field);            \
  79     struct_field_macro(str)
  80
  81 #if defined(GEN_HASKELL)
  82 #define def_size(str, size) \
  83     printf("sIZEOF_" str " = %d::Int\n", size);
  84 #else
  85 #define def_size(str, size) \
  86     printf("#define SIZEOF_" str " %d\n", size);
  87 #endif
  88
  89 #if defined(GEN_HASKELL)
  90 #define def_closure_size(str, size) /* nothing */
  91 #else
  92 #define def_closure_size(str, size) \
  93     printf("#define SIZEOF_" str " (SIZEOF_StgHeader+%d)\n", size);
  94 #endif
  95
  96 #if defined(GEN_HASKELL)
  97 #define def_thunk_size(str, size) /* nothing */
  98 #else
  99 #define def_thunk_size(str, size) \
 100     printf("#define SIZEOF_" str " (SIZEOF_StgThunkHeader+%d)\n", size);
 101 #endif
 102
 103 #define struct_size(s_type) \
 104     def_size(#s_type, sizeof(s_type));
 105
 106 /*
 107  * Size of a closure type, minus the header, named SIZEOF_<type>_NoHdr
 108  * Also, we #define SIZEOF_<type> to be the size of the whole closure for .cmm.
 109  */
 110 #define closure_size(s_type) \
 111     def_size(#s_type "_NoHdr", sizeof(s_type) - sizeof(StgHeader)); \
 112     def_closure_size(#s_type, sizeof(s_type) - sizeof(StgHeader));
 113
 114 #define thunk_size(s_type) \
 115     def_size(#s_type "_NoHdr", sizeof(s_type) - sizeof(StgHeader)); \
 116     def_thunk_size(#s_type, sizeof(s_type) - sizeof(StgHeader));
 117
 118 /* An access macro for use in C-- sources. */
 119 #define closure_field_macro(str) \
 120     printf("#define " str "(__ptr__)  REP_" str "[__ptr__+SIZEOF_StgHeader+OFFSET_" str "]\n");
 121
 122 #define thunk_field_macro(str) \
 123     printf("#define " str "(__ptr__)  REP_" str "[__ptr__+SIZEOF_StgThunkHeader+OFFSET_" str "]\n");
 124
 125 #define closure_field_offset_(str, s_type,field) \
 126     def_offset(str, OFFSET(s_type,field) - sizeof(StgHeader));
 127
 128 #define thunk_field_offset_(str, s_type, field) \
 129     closure_field_offset_(str, s_type, field)
 130
 131 #define closure_field_offset(s_type,field) \
 132     closure_field_offset_(str(s_type,field),s_type,field)
 133
 134 #define thunk_field_offset(s_type,field) \
 135     thunk_field_offset_(str(s_type,field),s_type,field)
 136
 137 #define closure_payload_macro(str) \
 138     printf("#define " str "(__ptr__,__ix__)  W_[__ptr__+SIZEOF_StgHeader+OFFSET_" str " + WDS(__ix__)]\n");
 139
 140 #define thunk_payload_macro(str) \
 141     printf("#define " str "(__ptr__,__ix__)  W_[__ptr__+SIZEOF_StgThunkHeader+OFFSET_" str " + WDS(__ix__)]\n");
 142
 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));
 146
 147 #define thunk_payload(s_type,field) \
 148     thunk_field_offset_(str(s_type,field),s_type,field); \
 149     thunk_payload_macro(str(s_type,field));
 150
 151 /* Byte offset and MachRep for a closure field, minus the header */
 152 #define closure_field(s_type, field) \
 153     closure_field_offset(s_type,field) \
 154     field_type(s_type, field); \
 155     closure_field_macro(str(s_type,field))
 156
 157 #define thunk_field(s_type, field) \
 158     thunk_field_offset(s_type,field) \
 159     field_type(s_type, field); \
 160     thunk_field_macro(str(s_type,field))
 161
 162 /* Byte offset and MachRep for a closure field, minus the header */
 163 #define closure_field_(str, s_type, field) \
 164     closure_field_offset_(str,s_type,field) \
 165     field_type_(str, s_type, field); \
 166     closure_field_macro(str)
 167
 168 #define thunk_field_(str, s_type, field) \
 169     thunk_field_offset_(str,s_type,field) \
 170     field_type_(str, s_type, field); \
 171     thunk_field_macro(str)
 172
 173 /* Byte offset for a TSO field, minus the header and variable prof bit. */
 174 #define tso_payload_offset(s_type, field) \
 175     def_offset(str(s_type,field), OFFSET(s_type,field) - sizeof(StgHeader) - sizeof(StgTSOProfInfo));
 176
 177 /* Full byte offset for a TSO field, for use from Cmm */
 178 #define tso_field_offset_macro(str) \
 179     printf("#define TSO_OFFSET_" str " (SIZEOF_StgHeader+SIZEOF_OPT_StgTSOProfInfo+SIZEOF_OPT_StgTSOParInfo+SIZEOF_OPT_StgTSOGranInfo+SIZEOF_OPT_StgTSODistInfo+OFFSET_" str ")\n");
 180
 181 #define tso_field_offset(s_type, field) \
 182     tso_payload_offset(s_type, field);          \
 183     tso_field_offset_macro(str(s_type,field));
 184
 185 #define tso_field_macro(str) \
 186     printf("#define " str "(__ptr__)  REP_" str "[__ptr__+TSO_OFFSET_" str "]\n")
 187 #define tso_field(s_type, field)                \
 188     field_type(s_type, field);                  \
 189     tso_field_offset(s_type,field);             \
 190     tso_field_macro(str(s_type,field))
 191
 192 #define opt_struct_size(s_type, option)                                 \
 193     printf("#ifdef " #option "\n");                                     \
 194     printf("#define SIZEOF_OPT_" #s_type " SIZEOF_" #s_type "\n");      \
 195     printf("#else\n");                                                  \
 196     printf("#define SIZEOF_OPT_" #s_type " 0\n");                       \
 197     printf("#endif\n\n");
 198
 199 #define FUN_OFFSET(sym) (OFFSET(Capability,f.sym) - OFFSET(Capability,r))
 200
 201
 202 int
 203 main(int argc, char *argv[])
 204 {
 205 #ifndef GEN_HASKELL
 206     printf("/* This file is created automatically.  Do not edit by hand.*/\n\n");
 207
 208     printf("#define STD_HDR_SIZE   %d\n", sizeofW(StgHeader) - sizeofW(StgProfHeader));
 209     /* grrr.. PROFILING is on so we need to subtract sizeofW(StgProfHeader) */
 210     printf("#define PROF_HDR_SIZE  %d\n", sizeofW(StgProfHeader));
 211     printf("#define GRAN_HDR_SIZE  %d\n", sizeofW(StgGranHeader));
 212
 213     printf("#define STD_ITBL_SIZE   %d\n", sizeofW(StgInfoTable));
 214     printf("#define RET_ITBL_SIZE   %d\n", sizeofW(StgRetInfoTable) - sizeofW(StgInfoTable));
 215     printf("#define PROF_ITBL_SIZE  %d\n", sizeofW(StgProfInfo));
 216
 217     printf("#define GRAN_ITBL_SIZE  %d\n", 0);
 218     printf("#define TICKY_ITBL_SIZE %d\n", 0);
 219
 220     printf("#define BLOCK_SIZE   %d\n", BLOCK_SIZE);
 221     printf("#define MBLOCK_SIZE   %d\n", MBLOCK_SIZE);
 222
 223     printf("\n\n");
 224 #endif
 225
 226     field_offset(StgRegTable, rR1);
 227     field_offset(StgRegTable, rR2);
 228     field_offset(StgRegTable, rR3);
 229     field_offset(StgRegTable, rR4);
 230     field_offset(StgRegTable, rR5);
 231     field_offset(StgRegTable, rR6);
 232     field_offset(StgRegTable, rR7);
 233     field_offset(StgRegTable, rR8);
 234     field_offset(StgRegTable, rR9);
 235     field_offset(StgRegTable, rR10);
 236     field_offset(StgRegTable, rF1);
 237     field_offset(StgRegTable, rF2);
 238     field_offset(StgRegTable, rF3);
 239     field_offset(StgRegTable, rF4);
 240     field_offset(StgRegTable, rD1);
 241     field_offset(StgRegTable, rD2);
 242     field_offset(StgRegTable, rL1);
 243     field_offset(StgRegTable, rSp);
 244     field_offset(StgRegTable, rSpLim);
 245     field_offset(StgRegTable, rHp);
 246     field_offset(StgRegTable, rHpLim);
 247     field_offset(StgRegTable, rCurrentTSO);
 248     field_offset(StgRegTable, rCurrentNursery);
 249     field_offset(StgRegTable, rHpAlloc);
 250     struct_field(StgRegTable, rRet);
 251
 252     // Needed for SMP builds
 253     field_offset(StgRegTable, rmp_tmp_w);
 254     field_offset(StgRegTable, rmp_tmp1);
 255     field_offset(StgRegTable, rmp_tmp2);
 256     field_offset(StgRegTable, rmp_result1);
 257     field_offset(StgRegTable, rmp_result2);
 258
 259     def_offset("stgGCEnter1", FUN_OFFSET(stgGCEnter1));
 260     def_offset("stgGCFun", FUN_OFFSET(stgGCFun));
 261
 262     field_offset(Capability, r);
 263
 264     struct_field(bdescr, start);
 265     struct_field(bdescr, free);
 266     struct_field(bdescr, blocks);
 267     struct_field(bdescr, gen_no);
 268     struct_field(bdescr, link);
 269
 270     struct_size(generation);
 271     struct_field(generation, mut_list);
 272
 273     struct_size(CostCentreStack);
 274     struct_field(CostCentreStack, ccsID);
 275     struct_field(CostCentreStack, mem_alloc);
 276     struct_field(CostCentreStack, scc_count);
 277     struct_field(CostCentreStack, prevStack);
 278
 279     struct_field(CostCentre, ccID);
 280     struct_field(CostCentre, link);
 281
 282     struct_field(StgHeader, info);
 283     struct_field_("StgHeader_ccs",  StgHeader, prof.ccs);
 284     struct_field_("StgHeader_ldvw", StgHeader, prof.hp.ldvw);
 285
 286     struct_size(StgSMPThunkHeader);
 287
 288     closure_payload(StgClosure,payload);
 289
 290     struct_field(StgEntCounter, allocs);
 291     struct_field(StgEntCounter, registeredp);
 292     struct_field(StgEntCounter, link);
 293
 294     closure_size(StgUpdateFrame);
 295     closure_size(StgCatchFrame);
 296     closure_size(StgStopFrame);
 297
 298     closure_size(StgMutArrPtrs);
 299     closure_field(StgMutArrPtrs, ptrs);
 300
 301     closure_size(StgArrWords);
 302     closure_field(StgArrWords, words);
 303     closure_payload(StgArrWords, payload);
 304
 305     closure_field(StgTSO, link);
 306     closure_field(StgTSO, global_link);
 307     closure_field(StgTSO, what_next);
 308     closure_field(StgTSO, why_blocked);
 309     closure_field(StgTSO, block_info);
 310     closure_field(StgTSO, blocked_exceptions);
 311     closure_field(StgTSO, id);
 312     closure_field(StgTSO, saved_errno);
 313     closure_field(StgTSO, trec);
 314     closure_field_("StgTSO_CCCS", StgTSO, prof.CCCS);
 315     tso_field(StgTSO, sp);
 316     tso_field_offset(StgTSO, stack);
 317     tso_field(StgTSO, stack_size);
 318
 319     struct_size(StgTSOProfInfo);
 320     struct_size(StgTSOParInfo);
 321     struct_size(StgTSOGranInfo);
 322     struct_size(StgTSODistInfo);
 323
 324     opt_struct_size(StgTSOProfInfo,PROFILING);
 325     opt_struct_size(StgTSOParInfo,PAR);
 326     opt_struct_size(StgTSOGranInfo,GRAN);
 327     opt_struct_size(StgTSODistInfo,DIST);
 328
 329     closure_field(StgUpdateFrame, updatee);
 330
 331     closure_field(StgCatchFrame, handler);
 332     closure_field(StgCatchFrame, exceptions_blocked);
 333
 334     closure_size(StgPAP);
 335     closure_field(StgPAP, n_args);
 336     closure_field(StgPAP, fun);
 337     closure_field(StgPAP, arity);
 338     closure_payload(StgPAP, payload);
 339
 340     closure_size(StgAP);
 341     closure_field(StgAP, n_args);
 342     closure_field(StgAP, fun);
 343     closure_payload(StgAP, payload);
 344
 345     thunk_size(StgAP_STACK);
 346     thunk_field(StgAP_STACK, size);
 347     thunk_field(StgAP_STACK, fun);
 348     thunk_payload(StgAP_STACK, payload);
 349
 350     closure_field(StgInd, indirectee);
 351
 352     closure_size(StgMutVar);
 353     closure_field(StgMutVar, var);
 354
 355     closure_size(StgAtomicallyFrame);
 356     closure_field(StgAtomicallyFrame, code);
 357
 358     closure_size(StgCatchSTMFrame);
 359     closure_field(StgCatchSTMFrame, handler);
 360
 361     closure_size(StgCatchRetryFrame);
 362     closure_field(StgCatchRetryFrame, running_alt_code);
 363     closure_field(StgCatchRetryFrame, first_code);
 364     closure_field(StgCatchRetryFrame, alt_code);
 365     closure_field(StgCatchRetryFrame, first_code_trec);
 366
 367     closure_size(StgWeak);
 368     closure_field(StgWeak,link);
 369     closure_field(StgWeak,key);
 370     closure_field(StgWeak,value);
 371     closure_field(StgWeak,finalizer);
 372
 373     closure_size(StgDeadWeak);
 374     closure_field(StgDeadWeak,link);
 375
 376     closure_size(StgMVar);
 377     closure_field(StgMVar,head);
 378     closure_field(StgMVar,tail);
 379     closure_field(StgMVar,value);
 380
 381     closure_size(StgBCO);
 382     closure_field(StgBCO, instrs);
 383     closure_field(StgBCO, literals);
 384     closure_field(StgBCO, ptrs);
 385     closure_field(StgBCO, itbls);
 386     closure_field(StgBCO, arity);
 387     closure_field(StgBCO, size);
 388     closure_payload(StgBCO, bitmap);
 389
 390     closure_size(StgStableName);
 391     closure_field(StgStableName,sn);
 392
 393     struct_field_("RtsFlags_ProfFlags_showCCSOnException",
 394                   RTS_FLAGS, ProfFlags.showCCSOnException);
 395     struct_field_("RtsFlags_DebugFlags_apply",
 396                   RTS_FLAGS, DebugFlags.apply);
 397     struct_field_("RtsFlags_DebugFlags_sanity",
 398                   RTS_FLAGS, DebugFlags.sanity);
 399     struct_field_("RtsFlags_DebugFlags_weak",
 400                   RTS_FLAGS, DebugFlags.weak);
 401     struct_field_("RtsFlags_GcFlags_initialStkSize",
 402                   RTS_FLAGS, GcFlags.initialStkSize);
 403
 404     struct_size(StgFunInfoExtraFwd);
 405     struct_field(StgFunInfoExtraFwd, slow_apply);
 406     struct_field(StgFunInfoExtraFwd, fun_type);
 407     struct_field(StgFunInfoExtraFwd, arity);
 408     struct_field_("StgFunInfoExtraFwd_bitmap", StgFunInfoExtraFwd, b.bitmap);
 409
 410     struct_size(StgFunInfoExtraRev);
 411     struct_field(StgFunInfoExtraRev, slow_apply_offset);
 412     struct_field(StgFunInfoExtraRev, fun_type);
 413     struct_field(StgFunInfoExtraRev, arity);
 414     struct_field_("StgFunInfoExtraRev_bitmap", StgFunInfoExtraRev, b.bitmap);
 415
 416     struct_field(StgLargeBitmap, size);
 417     field_offset(StgLargeBitmap, bitmap);
 418
 419     struct_size(snEntry);
 420     struct_field(snEntry,sn_obj);
 421     struct_field(snEntry,addr);
 422
 423 #ifdef mingw32_HOST_OS
 424     struct_size(StgAsyncIOResult);
 425     struct_field(StgAsyncIOResult, reqID);
 426     struct_field(StgAsyncIOResult, len);
 427     struct_field(StgAsyncIOResult, errCode);
 428 #endif
 429
 430     struct_size(MP_INT);
 431     struct_field(MP_INT,_mp_alloc);
 432     struct_field(MP_INT,_mp_size);
 433     struct_field(MP_INT,_mp_d);
 434
 435     ctype(mp_limb_t);
 436     return 0;
 437 }