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