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 #include "RtsFlags.h"
  25 #include "Storage.h"
  26 #include "Stable.h"
  27 #include "OSThreads.h"
  28 #include "Capability.h"
  29
  30 #include <stdio.h>
  31
  32 #define str(a,b) #a "_" #b
  33
  34 #define OFFSET(s_type, field) ((size_t)&(((s_type*)0)->field))
  35
  36 #ifdef mingw32_HOST_OS
  37 #define SIZET_FMT "d"
  38 #else
  39 #define SIZET_FMT "zd"
  40 #endif
  41
  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);
  46 #else
  47 #define def_offset(str, offset) \
  48     printf("#define OFFSET_" str " %" SIZET_FMT "\n", offset);
  49 #endif
  50
  51 #if defined(GEN_HASKELL)
  52 #define ctype(type) /* nothing */
  53 #else
  54 #define ctype(type) \
  55     printf("#define SIZEOF_" #type " %d\n", sizeof(type));
  56 #endif
  57
  58 #if defined(GEN_HASKELL)
  59 #define field_type_(str, s_type, field) /* nothing */
  60 #define field_type_gcptr_(str, s_type, field) /* nothing */
  61 #else
  62 /* Defining REP_x to be b32 etc
  63    These are both the C-- types used in a load
  64       e.g.  b32[addr]
  65    and the names of the CmmTypes in the compiler
  66       b32 :: CmmType
  67 */
  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");
  73 #endif
  74
  75 #define field_type(s_type, field) \
  76     field_type_(str(s_type,field),s_type,field);
  77
  78 #define field_offset_(str, s_type, field) \
  79     def_offset(str, OFFSET(s_type,field));
  80
  81 #define field_offset(s_type, field) \
  82     field_offset_(str(s_type,field),s_type,field);
  83
  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");
  87
  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))
  93
  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)
  98
  99 #if defined(GEN_HASKELL)
 100 #define def_size(str, size)                \
 101     printf("sIZEOF_" str " :: Int\n");     \
 102     printf("sIZEOF_" str " = %d\n", size);
 103 #else
 104 #define def_size(str, size) \
 105     printf("#define SIZEOF_" str " %d\n", size);
 106 #endif
 107
 108 #if defined(GEN_HASKELL)
 109 #define def_closure_size(str, size) /* nothing */
 110 #else
 111 #define def_closure_size(str, size) \
 112     printf("#define SIZEOF_" str " (SIZEOF_StgHeader+%d)\n", size);
 113 #endif
 114
 115 #define struct_size(s_type) \
 116     def_size(#s_type, sizeof(s_type));
 117
 118 /*
 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.
 121  */
 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));
 125
 126 #define thunk_size(s_type) \
 127     def_size(#s_type "_NoThunkHdr", sizeof(s_type) - sizeof(StgThunkHeader)); \
 128     closure_size(s_type)
 129
 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");
 133
 134 #define closure_field_offset_(str, s_type,field) \
 135     def_offset(str, OFFSET(s_type,field) - sizeof(StgHeader));
 136
 137 #define closure_field_offset(s_type,field) \
 138     closure_field_offset_(str(s_type,field),s_type,field)
 139
 140 #define closure_payload_macro(str) \
 141     printf("#define " str "(__ptr__,__ix__)  W_[__ptr__+SIZEOF_StgHeader+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 /* 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)
 152
 153 #define closure_field(s_type, field) \
 154     closure_field_(str(s_type,field),s_type,field)
 155
 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)
 161
 162 #define closure_field_gcptr(s_type, field) \
 163     closure_field_gcptr_(str(s_type,field),s_type,field)
 164
 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));
 168
 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");
 172
 173 #define tso_field_offset(s_type, field) \
 174     tso_payload_offset(s_type, field);          \
 175     tso_field_offset_macro(str(s_type,field));
 176
 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))
 183
 184 #define opt_struct_size(s_type, option)                                 \
 185     printf("#ifdef " #option "\n");                                     \
 186     printf("#define SIZEOF_OPT_" #s_type " SIZEOF_" #s_type "\n");      \
 187     printf("#else\n");                                                  \
 188     printf("#define SIZEOF_OPT_" #s_type " 0\n");                       \
 189     printf("#endif\n\n");
 190
 191 #define FUN_OFFSET(sym) (OFFSET(Capability,f.sym) - OFFSET(Capability,r))
 192
 193
 194 int
 195 main(int argc, char *argv[])
 196 {
 197 #ifndef GEN_HASKELL
 198     printf("/* This file is created automatically.  Do not edit by hand.*/\n\n");
 199
 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));
 204
 205     printf("#define BLOCK_SIZE   %d\n", BLOCK_SIZE);
 206     printf("#define MBLOCK_SIZE   %d\n", MBLOCK_SIZE);
 207
 208     printf("\n\n");
 209 #endif
 210
 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);
 236
 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);
 243
 244     def_offset("stgEagerBlackholeInfo", FUN_OFFSET(stgEagerBlackholeInfo));
 245     def_offset("stgGCEnter1", FUN_OFFSET(stgGCEnter1));
 246     def_offset("stgGCFun", FUN_OFFSET(stgGCFun));
 247
 248     field_offset(Capability, r);
 249     field_offset(Capability, lock);
 250     struct_field(Capability, mut_lists);
 251     struct_field(Capability, context_switch);
 252
 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);
 258
 259     struct_size(generation);
 260     struct_field(generation, mut_list);
 261
 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);
 267
 268     struct_field(CostCentre, ccID);
 269     struct_field(CostCentre, link);
 270
 271     struct_field(StgHeader, info);
 272     struct_field_("StgHeader_ccs",  StgHeader, prof.ccs);
 273     struct_field_("StgHeader_ldvw", StgHeader, prof.hp.ldvw);
 274
 275     struct_size(StgSMPThunkHeader);
 276
 277     closure_payload(StgClosure,payload);
 278
 279     struct_field(StgEntCounter, allocs);
 280     struct_field(StgEntCounter, registeredp);
 281     struct_field(StgEntCounter, link);
 282     struct_field(StgEntCounter, entry_count);
 283
 284     closure_size(StgUpdateFrame);
 285     closure_size(StgCatchFrame);
 286     closure_size(StgStopFrame);
 287
 288     closure_size(StgMutArrPtrs);
 289     closure_field(StgMutArrPtrs, ptrs);
 290
 291     closure_size(StgArrWords);
 292     closure_field(StgArrWords, words);
 293     closure_payload(StgArrWords, payload);
 294
 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);
 310
 311     struct_size(StgTSOProfInfo);
 312     struct_size(StgTSOParInfo);
 313     struct_size(StgTSOGranInfo);
 314     struct_size(StgTSODistInfo);
 315
 316     opt_struct_size(StgTSOProfInfo,PROFILING);
 317     opt_struct_size(StgTSOParInfo,PAR);
 318     opt_struct_size(StgTSOGranInfo,GRAN);
 319     opt_struct_size(StgTSODistInfo,DIST);
 320
 321     closure_field(StgUpdateFrame, updatee);
 322
 323     closure_field(StgCatchFrame, handler);
 324     closure_field(StgCatchFrame, exceptions_blocked);
 325
 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);
 331
 332     thunk_size(StgAP);
 333     closure_field(StgAP, n_args);
 334     closure_field_gcptr(StgAP, fun);
 335     closure_payload(StgAP, payload);
 336
 337     thunk_size(StgAP_STACK);
 338     closure_field(StgAP_STACK, size);
 339     closure_field_gcptr(StgAP_STACK, fun);
 340     closure_payload(StgAP_STACK, payload);
 341
 342     thunk_size(StgSelector);
 343
 344     closure_field_gcptr(StgInd, indirectee);
 345
 346     closure_size(StgMutVar);
 347     closure_field(StgMutVar, var);
 348
 349     closure_size(StgAtomicallyFrame);
 350     closure_field(StgAtomicallyFrame, code);
 351     closure_field(StgAtomicallyFrame, next_invariant_to_check);
 352
 353     closure_field(StgInvariantCheckQueue, invariant);
 354     closure_field(StgInvariantCheckQueue, my_execution);
 355     closure_field(StgInvariantCheckQueue, next_queue_entry);
 356
 357     closure_field(StgAtomicInvariant, code);
 358
 359     closure_size(StgCatchSTMFrame);
 360     closure_field(StgCatchSTMFrame, handler);
 361     closure_field(StgCatchSTMFrame, code);
 362
 363     closure_size(StgCatchRetryFrame);
 364     closure_field(StgCatchRetryFrame, running_alt_code);
 365     closure_field(StgCatchRetryFrame, first_code);
 366     closure_field(StgCatchRetryFrame, alt_code);
 367
 368     closure_field(StgTVarWatchQueue, closure);
 369     closure_field(StgTVarWatchQueue, next_queue_entry);
 370     closure_field(StgTVarWatchQueue, prev_queue_entry);
 371
 372     closure_field(StgTVar, current_value);
 373
 374     closure_size(StgWeak);
 375     closure_field(StgWeak,link);
 376     closure_field(StgWeak,key);
 377     closure_field(StgWeak,value);
 378     closure_field(StgWeak,finalizer);
 379
 380     closure_size(StgDeadWeak);
 381     closure_field(StgDeadWeak,link);
 382
 383     closure_size(StgMVar);
 384     closure_field(StgMVar,head);
 385     closure_field(StgMVar,tail);
 386     closure_field(StgMVar,value);
 387
 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);
 395
 396     closure_size(StgStableName);
 397     closure_field(StgStableName,sn);
 398
 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);
 411
 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);
 417
 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);
 423
 424     struct_field(StgLargeBitmap, size);
 425     field_offset(StgLargeBitmap, bitmap);
 426
 427     struct_size(snEntry);
 428     struct_field(snEntry,sn_obj);
 429     struct_field(snEntry,addr);
 430
 431 #ifdef mingw32_HOST_OS
 432     struct_size(StgAsyncIOResult);
 433     struct_field(StgAsyncIOResult, reqID);
 434     struct_field(StgAsyncIOResult, len);
 435     struct_field(StgAsyncIOResult, errCode);
 436 #endif
 437
 438     struct_size(MP_INT);
 439     struct_field(MP_INT,_mp_alloc);
 440     struct_field(MP_INT,_mp_size);
 441     struct_field(MP_INT,_mp_d);
 442
 443     ctype(mp_limb_t);
 444     return 0;
 445 }