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