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 #define THREADED_RTS
  22
  23 #include "Rts.h"
  24
  25 #include "Stable.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) ((size_t)&(((s_type*)0)->field))
  33
  34 #if defined(GEN_HASKELL)
  35 #define def_offset(str, offset)                          \
  36     printf("oFFSET_" str " :: Int\n");                   \
  37     printf("oFFSET_" str " = %lu\n", (unsigned long)offset);
  38 #else
  39 #define def_offset(str, offset) \
  40     printf("#define OFFSET_" str " %lu\n", (unsigned long)offset);
  41 #endif
  42
  43 #if defined(GEN_HASKELL)
  44 #define ctype(type) /* nothing */
  45 #else
  46 #define ctype(type) \
  47     printf("#define SIZEOF_" #type " %lu\n", (unsigned long)sizeof(type));
  48 #endif
  49
  50 #if defined(GEN_HASKELL)
  51 #define field_type_(str, s_type, field) /* nothing */
  52 #define field_type_gcptr_(str, s_type, field) /* nothing */
  53 #else
  54 /* Defining REP_x to be b32 etc
  55    These are both the C-- types used in a load
  56       e.g.  b32[addr]
  57    and the names of the CmmTypes in the compiler
  58       b32 :: CmmType
  59 */
  60 #define field_type_(str, s_type, field) \
  61     printf("#define REP_" str " b"); \
  62     printf("%lu\n", (unsigned long)sizeof (__typeof__(((((s_type*)0)->field)))) * 8);
  63 #define field_type_gcptr_(str, s_type, field) \
  64     printf("#define REP_" str " gcptr\n");
  65 #endif
  66
  67 #define field_type(s_type, field) \
  68     field_type_(str(s_type,field),s_type,field);
  69
  70 #define field_offset_(str, s_type, field) \
  71     def_offset(str, OFFSET(s_type,field));
  72
  73 #define field_offset(s_type, field) \
  74     field_offset_(str(s_type,field),s_type,field);
  75
  76 /* An access macro for use in C-- sources. */
  77 #define struct_field_macro(str) \
  78     printf("#define " str "(__ptr__)  REP_" str "[__ptr__+OFFSET_" str "]\n");
  79
  80 /* Outputs the byte offset and MachRep for a field */
  81 #define struct_field(s_type, field)             \
  82     field_offset(s_type, field);                \
  83     field_type(s_type, field);                  \
  84     struct_field_macro(str(s_type,field))
  85
  86 #define struct_field_(str, s_type, field)       \
  87     field_offset_(str, s_type, field);          \
  88     field_type_(str, s_type, field);            \
  89     struct_field_macro(str)
  90
  91 #if defined(GEN_HASKELL)
  92 #define def_size(str, size)                \
  93     printf("sIZEOF_" str " :: Int\n");     \
  94     printf("sIZEOF_" str " = %lu\n", (unsigned long)size);
  95 #else
  96 #define def_size(str, size) \
  97     printf("#define SIZEOF_" str " %lu\n", (unsigned long)size);
  98 #endif
  99
 100 #if defined(GEN_HASKELL)
 101 #define def_closure_size(str, size) /* nothing */
 102 #else
 103 #define def_closure_size(str, size) \
 104     printf("#define SIZEOF_" str " (SIZEOF_StgHeader+%lu)\n", (unsigned long)size);
 105 #endif
 106
 107 #define struct_size(s_type) \
 108     def_size(#s_type, sizeof(s_type));
 109
 110 /*
 111  * Size of a closure type, minus the header, named SIZEOF_<type>_NoHdr
 112  * Also, we #define SIZEOF_<type> to be the size of the whole closure for .cmm.
 113  */
 114 #define closure_size(s_type) \
 115     def_size(#s_type "_NoHdr", sizeof(s_type) - sizeof(StgHeader)); \
 116     def_closure_size(#s_type, sizeof(s_type) - sizeof(StgHeader));
 117
 118 #define thunk_size(s_type) \
 119     def_size(#s_type "_NoThunkHdr", sizeof(s_type) - sizeof(StgThunkHeader)); \
 120     closure_size(s_type)
 121
 122 /* An access macro for use in C-- sources. */
 123 #define closure_field_macro(str) \
 124     printf("#define " str "(__ptr__)  REP_" str "[__ptr__+SIZEOF_StgHeader+OFFSET_" str "]\n");
 125
 126 #define closure_field_offset_(str, s_type,field) \
 127     def_offset(str, OFFSET(s_type,field) - sizeof(StgHeader));
 128
 129 #define closure_field_offset(s_type,field) \
 130     closure_field_offset_(str(s_type,field),s_type,field)
 131
 132 #define closure_payload_macro(str) \
 133     printf("#define " str "(__ptr__,__ix__)  W_[__ptr__+SIZEOF_StgHeader+OFFSET_" str " + WDS(__ix__)]\n");
 134
 135 #define closure_payload(s_type,field) \
 136     closure_field_offset_(str(s_type,field),s_type,field); \
 137     closure_payload_macro(str(s_type,field));
 138
 139 /* Byte offset and MachRep for a closure field, minus the header */
 140 #define closure_field_(str, s_type, field) \
 141     closure_field_offset_(str,s_type,field) \
 142     field_type_(str, s_type, field); \
 143     closure_field_macro(str)
 144
 145 #define closure_field(s_type, field) \
 146     closure_field_(str(s_type,field),s_type,field)
 147
 148 /* Byte offset and MachRep for a closure field, minus the header */
 149 #define closure_field_gcptr_(str, s_type, field) \
 150     closure_field_offset_(str,s_type,field) \
 151     field_type_gcptr_(str, s_type, field); \
 152     closure_field_macro(str)
 153
 154 #define closure_field_gcptr(s_type, field) \
 155     closure_field_gcptr_(str(s_type,field),s_type,field)
 156
 157 /* Byte offset for a TSO field, minus the header and variable prof bit. */
 158 #define tso_payload_offset(s_type, field) \
 159     def_offset(str(s_type,field), OFFSET(s_type,field) - sizeof(StgHeader) - sizeof(StgTSOProfInfo));
 160
 161 /* Full byte offset for a TSO field, for use from Cmm */
 162 #define tso_field_offset_macro(str) \
 163     printf("#define TSO_OFFSET_" str " (SIZEOF_StgHeader+SIZEOF_OPT_StgTSOProfInfo+OFFSET_" str ")\n");
 164
 165 #define tso_field_offset(s_type, field) \
 166     tso_payload_offset(s_type, field);          \
 167     tso_field_offset_macro(str(s_type,field));
 168
 169 #define tso_field_macro(str) \
 170     printf("#define " str "(__ptr__)  REP_" str "[__ptr__+TSO_OFFSET_" str "]\n")
 171 #define tso_field(s_type, field)                \
 172     field_type(s_type, field);                  \
 173     tso_field_offset(s_type,field);             \
 174     tso_field_macro(str(s_type,field))
 175
 176 #define opt_struct_size(s_type, option)                                 \
 177     printf("#ifdef " #option "\n");                                     \
 178     printf("#define SIZEOF_OPT_" #s_type " SIZEOF_" #s_type "\n");      \
 179     printf("#else\n");                                                  \
 180     printf("#define SIZEOF_OPT_" #s_type " 0\n");                       \
 181     printf("#endif\n\n");
 182
 183 #define FUN_OFFSET(sym) (OFFSET(Capability,f.sym) - OFFSET(Capability,r))
 184
 185
 186 int
 187 main(int argc, char *argv[])
 188 {
 189 #ifndef GEN_HASKELL
 190     printf("/* This file is created automatically.  Do not edit by hand.*/\n\n");
 191
 192     printf("#define STD_HDR_SIZE   %lu\n", (unsigned long)sizeofW(StgHeader) - sizeofW(StgProfHeader));
 193     /* grrr.. PROFILING is on so we need to subtract sizeofW(StgProfHeader) */
 194     printf("#define PROF_HDR_SIZE  %lu\n", (unsigned long)sizeofW(StgProfHeader));
 195
 196     printf("#define BLOCK_SIZE   %u\n", BLOCK_SIZE);
 197     printf("#define MBLOCK_SIZE   %u\n", MBLOCK_SIZE);
 198     printf("#define BLOCKS_PER_MBLOCK  %lu\n", (lnat)BLOCKS_PER_MBLOCK);
 199     // could be derived, but better to save doing the calculation twice
 200
 201     printf("\n\n");
 202 #endif
 203
 204     field_offset(StgRegTable, rR1);
 205     field_offset(StgRegTable, rR2);
 206     field_offset(StgRegTable, rR3);
 207     field_offset(StgRegTable, rR4);
 208     field_offset(StgRegTable, rR5);
 209     field_offset(StgRegTable, rR6);
 210     field_offset(StgRegTable, rR7);
 211     field_offset(StgRegTable, rR8);
 212     field_offset(StgRegTable, rR9);
 213     field_offset(StgRegTable, rR10);
 214     field_offset(StgRegTable, rF1);
 215     field_offset(StgRegTable, rF2);
 216     field_offset(StgRegTable, rF3);
 217     field_offset(StgRegTable, rF4);
 218     field_offset(StgRegTable, rD1);
 219     field_offset(StgRegTable, rD2);
 220     field_offset(StgRegTable, rL1);
 221     field_offset(StgRegTable, rSp);
 222     field_offset(StgRegTable, rSpLim);
 223     field_offset(StgRegTable, rHp);
 224     field_offset(StgRegTable, rHpLim);
 225     field_offset(StgRegTable, rCurrentTSO);
 226     field_offset(StgRegTable, rCurrentNursery);
 227     field_offset(StgRegTable, rHpAlloc);
 228     struct_field(StgRegTable, rRet);
 229     struct_field(StgRegTable, rNursery);
 230
 231     def_offset("stgEagerBlackholeInfo", FUN_OFFSET(stgEagerBlackholeInfo));
 232     def_offset("stgGCEnter1", FUN_OFFSET(stgGCEnter1));
 233     def_offset("stgGCFun", FUN_OFFSET(stgGCFun));
 234
 235     field_offset(Capability, r);
 236     field_offset(Capability, lock);
 237     struct_field(Capability, mut_lists);
 238     struct_field(Capability, context_switch);
 239     struct_field(Capability, sparks);
 240
 241     struct_field(bdescr, start);
 242     struct_field(bdescr, free);
 243     struct_field(bdescr, blocks);
 244     struct_field(bdescr, gen_no);
 245     struct_field(bdescr, link);
 246
 247     struct_size(generation);
 248     struct_field(generation, mut_list);
 249     struct_field(generation, n_new_large_blocks);
 250
 251     struct_size(CostCentreStack);
 252     struct_field(CostCentreStack, ccsID);
 253     struct_field(CostCentreStack, mem_alloc);
 254     struct_field(CostCentreStack, scc_count);
 255     struct_field(CostCentreStack, prevStack);
 256
 257     struct_field(CostCentre, ccID);
 258     struct_field(CostCentre, link);
 259
 260     struct_field(StgHeader, info);
 261     struct_field_("StgHeader_ccs",  StgHeader, prof.ccs);
 262     struct_field_("StgHeader_ldvw", StgHeader, prof.hp.ldvw);
 263
 264     struct_size(StgSMPThunkHeader);
 265
 266     closure_payload(StgClosure,payload);
 267
 268     struct_field(StgEntCounter, allocs);
 269     struct_field(StgEntCounter, registeredp);
 270     struct_field(StgEntCounter, link);
 271     struct_field(StgEntCounter, entry_count);
 272
 273     closure_size(StgUpdateFrame);
 274     closure_size(StgCatchFrame);
 275     closure_size(StgStopFrame);
 276
 277     closure_size(StgMutArrPtrs);
 278     closure_field(StgMutArrPtrs, ptrs);
 279     closure_field(StgMutArrPtrs, size);
 280
 281     closure_size(StgArrWords);
 282     closure_field(StgArrWords, bytes);
 283     closure_payload(StgArrWords, payload);
 284
 285     closure_field(StgTSO, _link);
 286     closure_field(StgTSO, global_link);
 287     closure_field(StgTSO, what_next);
 288     closure_field(StgTSO, why_blocked);
 289     closure_field(StgTSO, block_info);
 290     closure_field(StgTSO, blocked_exceptions);
 291     closure_field(StgTSO, id);
 292     closure_field(StgTSO, cap);
 293     closure_field(StgTSO, saved_errno);
 294     closure_field(StgTSO, trec);
 295     closure_field(StgTSO, flags);
 296     closure_field(StgTSO, dirty);
 297     closure_field(StgTSO, bq);
 298     closure_field_("StgTSO_CCCS", StgTSO, prof.CCCS);
 299     tso_field(StgTSO, sp);
 300     tso_field_offset(StgTSO, stack);
 301     tso_field(StgTSO, stack_size);
 302
 303     struct_size(StgTSOProfInfo);
 304
 305     opt_struct_size(StgTSOProfInfo,PROFILING);
 306
 307     closure_field(StgUpdateFrame, updatee);
 308
 309     closure_field(StgCatchFrame, handler);
 310     closure_field(StgCatchFrame, exceptions_blocked);
 311
 312     closure_size(StgPAP);
 313     closure_field(StgPAP, n_args);
 314     closure_field_gcptr(StgPAP, fun);
 315     closure_field(StgPAP, arity);
 316     closure_payload(StgPAP, payload);
 317
 318     thunk_size(StgAP);
 319     closure_field(StgAP, n_args);
 320     closure_field_gcptr(StgAP, fun);
 321     closure_payload(StgAP, payload);
 322
 323     thunk_size(StgAP_STACK);
 324     closure_field(StgAP_STACK, size);
 325     closure_field_gcptr(StgAP_STACK, fun);
 326     closure_payload(StgAP_STACK, payload);
 327
 328     thunk_size(StgSelector);
 329
 330     closure_field_gcptr(StgInd, indirectee);
 331
 332     closure_size(StgMutVar);
 333     closure_field(StgMutVar, var);
 334
 335     closure_size(StgAtomicallyFrame);
 336     closure_field(StgAtomicallyFrame, code);
 337     closure_field(StgAtomicallyFrame, next_invariant_to_check);
 338     closure_field(StgAtomicallyFrame, result);
 339
 340     closure_field(StgInvariantCheckQueue, invariant);
 341     closure_field(StgInvariantCheckQueue, my_execution);
 342     closure_field(StgInvariantCheckQueue, next_queue_entry);
 343
 344     closure_field(StgAtomicInvariant, code);
 345
 346     closure_field(StgTRecHeader, enclosing_trec);
 347
 348     closure_size(StgCatchSTMFrame);
 349     closure_field(StgCatchSTMFrame, handler);
 350     closure_field(StgCatchSTMFrame, code);
 351
 352     closure_size(StgCatchRetryFrame);
 353     closure_field(StgCatchRetryFrame, running_alt_code);
 354     closure_field(StgCatchRetryFrame, first_code);
 355     closure_field(StgCatchRetryFrame, alt_code);
 356
 357     closure_field(StgTVarWatchQueue, closure);
 358     closure_field(StgTVarWatchQueue, next_queue_entry);
 359     closure_field(StgTVarWatchQueue, prev_queue_entry);
 360
 361     closure_field(StgTVar, current_value);
 362
 363     closure_size(StgWeak);
 364     closure_field(StgWeak,link);
 365     closure_field(StgWeak,key);
 366     closure_field(StgWeak,value);
 367     closure_field(StgWeak,finalizer);
 368     closure_field(StgWeak,cfinalizer);
 369
 370     closure_size(StgDeadWeak);
 371     closure_field(StgDeadWeak,link);
 372
 373     closure_size(StgMVar);
 374     closure_field(StgMVar,head);
 375     closure_field(StgMVar,tail);
 376     closure_field(StgMVar,value);
 377
 378     closure_size(StgMVarTSOQueue);
 379     closure_field(StgMVarTSOQueue, link);
 380     closure_field(StgMVarTSOQueue, tso);
 381
 382     closure_size(StgBCO);
 383     closure_field(StgBCO, instrs);
 384     closure_field(StgBCO, literals);
 385     closure_field(StgBCO, ptrs);
 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     closure_size(StgBlockingQueue);
 394     closure_field(StgBlockingQueue, bh);
 395     closure_field(StgBlockingQueue, owner);
 396     closure_field(StgBlockingQueue, queue);
 397     closure_field(StgBlockingQueue, link);
 398
 399     closure_size(MessageBlackHole);
 400     closure_field(MessageBlackHole, link);
 401     closure_field(MessageBlackHole, tso);
 402     closure_field(MessageBlackHole, bh);
 403
 404     struct_field_("RtsFlags_ProfFlags_showCCSOnException",
 405                   RTS_FLAGS, ProfFlags.showCCSOnException);
 406     struct_field_("RtsFlags_DebugFlags_apply",
 407                   RTS_FLAGS, DebugFlags.apply);
 408     struct_field_("RtsFlags_DebugFlags_sanity",
 409                   RTS_FLAGS, DebugFlags.sanity);
 410     struct_field_("RtsFlags_DebugFlags_weak",
 411                   RTS_FLAGS, DebugFlags.weak);
 412     struct_field_("RtsFlags_GcFlags_initialStkSize",
 413                   RTS_FLAGS, GcFlags.initialStkSize);
 414     struct_field_("RtsFlags_MiscFlags_tickInterval",
 415                   RTS_FLAGS, MiscFlags.tickInterval);
 416
 417     struct_size(StgFunInfoExtraFwd);
 418     struct_field(StgFunInfoExtraFwd, slow_apply);
 419     struct_field(StgFunInfoExtraFwd, fun_type);
 420     struct_field(StgFunInfoExtraFwd, arity);
 421     struct_field_("StgFunInfoExtraFwd_bitmap", StgFunInfoExtraFwd, b.bitmap);
 422
 423     struct_size(StgFunInfoExtraRev);
 424     struct_field(StgFunInfoExtraRev, slow_apply_offset);
 425     struct_field(StgFunInfoExtraRev, fun_type);
 426     struct_field(StgFunInfoExtraRev, arity);
 427     struct_field_("StgFunInfoExtraRev_bitmap", StgFunInfoExtraRev, b.bitmap);
 428
 429     struct_field(StgLargeBitmap, size);
 430     field_offset(StgLargeBitmap, bitmap);
 431
 432     struct_size(snEntry);
 433     struct_field(snEntry,sn_obj);
 434     struct_field(snEntry,addr);
 435
 436 #ifdef mingw32_HOST_OS
 437     struct_size(StgAsyncIOResult);
 438     struct_field(StgAsyncIOResult, reqID);
 439     struct_field(StgAsyncIOResult, len);
 440     struct_field(StgAsyncIOResult, errCode);
 441 #endif
 442
 443     return 0;
 444 }