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