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