ghc/interpreter/storage.h

   1
   2 /* --------------------------------------------------------------------------
   3  * Defines storage datatypes: Text, Name, Module, Tycon, Cell, List, Pair,
   4  * Triple, ...
   5  *
   6  * The Hugs 98 system is Copyright (c) Mark P Jones, Alastair Reid, the
   7  * Yale Haskell Group, and the Oregon Graduate Institute of Science and
   8  * Technology, 1994-1999, All rights reserved.  It is distributed as
   9  * free software under the license in the file "License", which is
  10  * included in the distribution.
  11  *
  12  * $RCSfile: storage.h,v $
  13  * $Revision: 1.16 $
  14  * $Date: 1999/12/03 17:01:25 $
  15  * ------------------------------------------------------------------------*/
  16
  17 /* --------------------------------------------------------------------------
  18  * Typedefs for main data types:
  19  * Many of these type names are used to indicate the intended us of a data
  20  * item, rather than for type checking purposes.  Sadly (although sometimes,
  21  * fortunately), the C compiler cannot distinguish between the use of two
  22  * different names defined to be synonyms for the same types.
  23  * ------------------------------------------------------------------------*/
  24
  25 typedef Int          Text;                       /* text string            */
  26 typedef Unsigned     Syntax;                     /* syntax (assoc,preced)  */
  27 typedef Int          Cell;                       /* general cell value     */
  28 typedef Cell far     *Heap;                      /* storage of heap        */
  29 typedef Cell         Pair;                       /* pair cell              */
  30 typedef Int          StackPtr;                   /* stack pointer          */
  31 typedef Cell         Offset;                     /* offset/generic variable*/
  32 typedef Int          Script;                     /* script file number     */
  33 typedef Int          Module;                     /* module                 */
  34 typedef Cell         Tycon;                      /* type constructor       */
  35 typedef Cell         Type;                       /* type expression        */
  36 typedef Cell         Kind;                       /* kind expression        */
  37 typedef Cell         Kinds;                      /* list of kinds          */
  38 typedef Cell         Constr;                     /* constructor expression */
  39 typedef Cell         Name;                       /* named value            */
  40 typedef Cell         Class;                      /* type class             */
  41 typedef Cell         Inst;                       /* instance of type class */
  42 typedef Cell         Triple;                     /* triple of cell values  */
  43 typedef Cell         List;                       /* list of cells          */
  44 typedef Cell         Bignum;                     /* bignum integer         */
  45 typedef Cell         Float;                      /* floating pt literal    */
  46 #if TREX
  47 typedef Cell         Ext;                        /* extension label        */
  48 #endif
  49
  50 /* --------------------------------------------------------------------------
  51  * Text storage:
  52  * provides storage for the characters making up identifier and symbol
  53  * names, string literals, character constants etc...
  54  * ------------------------------------------------------------------------*/
  55
  56 extern  String       textToStr            Args((Text));
  57 extern  Text         findText             Args((String));
  58 extern  Text         inventText           Args((Void));
  59 extern  Text         inventDictText       Args((Void));
  60 extern  Bool         inventedText         Args((Text));
  61 extern  Text         enZcodeThenFindText  Args((String));
  62 extern  Text         unZcodeThenFindText  Args((String));
  63
  64 /* Variants of textToStr and syntaxOf which work for idents, ops whether
  65  * qualified or unqualified.
  66  */
  67 extern  String       identToStr         Args((Cell));
  68 extern  Text         fixLitText         Args((Text));
  69 extern  Syntax       identSyntax        Args((Cell));
  70 extern  Syntax       defaultSyntax      Args((Text));
  71
  72 /* --------------------------------------------------------------------------
  73  * Specification of syntax (i.e. default written form of application)
  74  * ------------------------------------------------------------------------*/
  75
  76 #define MIN_PREC  0                    /* weakest binding operator         */
  77 #define MAX_PREC  9                    /* strongest binding operator       */
  78 #define FUN_PREC  (MAX_PREC+2)         /* binding of function symbols      */
  79 #define DEF_PREC  MAX_PREC
  80 #define APPLIC    0                    /* written applicatively            */
  81 #define LEFT_ASS  1                    /* left associative infix           */
  82 #define RIGHT_ASS 2                    /* right associative infix          */
  83 #define NON_ASS   3                    /* non associative infix            */
  84 #define DEF_ASS   LEFT_ASS
  85
  86 #define UMINUS_PREC  6                  /* Change these settings at your   */
  87 #define UMINUS_ASSOC LEFT_ASS           /* own risk; they may not work!    */
  88
  89 #define assocOf(x)      ((x)&NON_ASS)
  90 #define precOf(x)       ((x)>>2)
  91 #define mkSyntax(a,p)   ((a)|((p)<<2))
  92 #define DEF_OPSYNTAX    mkSyntax(DEF_ASS,DEF_PREC)
  93 #define NO_SYNTAX       (-1)
  94
  95 extern  Void   addSyntax  Args((Int,Text,Syntax));
  96 extern  Syntax syntaxOf   Args((Text));
  97
  98 /* --------------------------------------------------------------------------
  99  * Heap storage:
 100  * Provides a garbage collectable heap for storage of expressions etc.
 101  * ------------------------------------------------------------------------*/
 102
 103 #define heapAlloc(s) (Heap)(farCalloc(s,sizeof(Cell)))
 104 #define heapBuilt()  (heapFst)
 105 extern  Int          heapSize;
 106 extern  Heap         heapFst, heapSnd;
 107 extern  Heap         heapTopFst;
 108 extern  Heap         heapTopSnd;
 109 extern  Bool         consGC;            /* Set to FALSE to turn off gc from*/
 110                                         /* C stack; use with extreme care! */
 111 extern Int   cellsRecovered;            /* cells recovered by last gc      */
 112
 113 #define fst(c)       heapTopFst[c]
 114 #define snd(c)       heapTopSnd[c]
 115
 116 extern  Pair         pair            Args((Cell,Cell));
 117 extern  Void         garbageCollect  Args((Void));
 118
 119 extern  Void         overwrite       Args((Pair,Pair));
 120 extern  Void         overwrite2      Args((Pair,Cell,Cell));
 121 extern  Cell         markExpr        Args((Cell));
 122 extern  Void         markWithoutMove Args((Cell));
 123
 124 #define mark(v)      v=markExpr(v)
 125
 126 #define isPair(c)    ((c)<0)
 127 #define isGenPair(c) ((c)<0 && -heapSize<=(c))
 128
 129 extern  Cell         whatIs    Args((Cell));
 130
 131 /* --------------------------------------------------------------------------
 132  * Box cell tags are used as the fst element of a pair to indicate that
 133  * the snd element of the pair is to be treated in some special way, other
 134  * than as a Cell.  Examples include holding integer values, variable name
 135  * and string text etc.
 136  * ------------------------------------------------------------------------*/
 137
 138 #define TAGMIN       1            /* Box and constructor cell tag values   */
 139 #define BCSTAG       30           /* Box=TAGMIN..BCSTAG-1                  */
 140 #define isTag(c)     (TAGMIN<=(c) && (c)<SPECMIN) /* Tag cell values       */
 141 #define isBoxTag(c)  (TAGMIN<=(c) && (c)<BCSTAG)  /* Box cell tag values   */
 142 #define isConTag(c)  (BCSTAG<=(c) && (c)<SPECMIN) /* Constr cell tag values*/
 143
 144 #define FREECELL     3            /* Free list cell:          snd :: Cell  */
 145 #define VARIDCELL    4            /* Identifier variable:     snd :: Text  */
 146 #define VAROPCELL    5            /* Operator variable:       snd :: Text  */
 147 #define DICTVAR      6            /* Dictionary variable:     snd :: Text  */
 148 #define CONIDCELL    7            /* Identifier constructor:  snd :: Text  */
 149 #define CONOPCELL    8            /* Operator constructor:    snd :: Text  */
 150 #define STRCELL      9            /* String literal:          snd :: Text  */
 151 #define INTCELL      10           /* Int literal:             snd :: Int   */
 152 #define ADDPAT       11           /* (_+k) pattern discr:     snd :: Int   */
 153 #define FLOATCELL    15           /* Floating Pt literal:     snd :: Text  */
 154 #define BIGCELL      16           /* Integer literal:         snd :: Text  */
 155 #if PTR_ON_HEAP
 156 #define PTRCELL      17           /* C Heap Pointer           snd :: Ptr   */
 157 #if IPARAM
 158 #define IPCELL       19           /* Imp Param Cell:          snd :: Text  */
 159 #define IPVAR        20           /* ?x:                      snd :: Text  */
 160 #endif
 161 #define CPTRCELL     21           /* Native code pointer      snd :: Ptr   */
 162 #endif
 163 #if TREX
 164 #define EXTCOPY      22           /* Copy of an Ext:          snd :: Text  */
 165 #endif
 166
 167 #define qmodOf(c)       (textOf(fst(snd(c))))    /* c ::  QUALIDENT        */
 168 #define qtextOf(c)      (textOf(snd(snd(c))))    /* c ::  QUALIDENT        */
 169 #define mkVar(t)        ap(VARIDCELL,t)
 170 #define mkVarop(t)      ap(VAROPCELL,t)
 171 #define mkCon(t)        ap(CONIDCELL,t)
 172 #define mkConop(t)      ap(CONOPCELL,t)
 173 #define mkQVar(m,t)     ap(QUALIDENT,pair(mkCon(m),mkVar(t)))
 174 #define mkQCon(m,t)     ap(QUALIDENT,pair(mkCon(m),mkCon(t)))
 175 #define mkQVarOp(m,t)   ap(QUALIDENT,pair(mkCon(m),mkVarop(t)))
 176 #define mkQConOp(m,t)   ap(QUALIDENT,pair(mkCon(m),mkConop(t)))
 177 #define intValOf(c)     (snd(c))
 178 #define inventVar()     mkVar(inventText())
 179 #define mkDictVar(t)    ap(DICTVAR,t)
 180 #define inventDictVar() mkDictVar(inventDictText())
 181 #define mkStr(t)        ap(STRCELL,t)
 182 #if IPARAM
 183 #define mkIParam(c)     ap(IPCELL,snd(c))
 184 #define isIP(p)         (whatIs(p) == IPCELL)
 185 #define ipMatch(pi, t)  (isIP(fun(pi)) && textOf(fun(pi)) == t)
 186 #define ipVar(pi)       textOf(fun(pi))
 187 #else
 188 #define isIP(p)         FALSE
 189 #endif
 190
 191 extern  Bool            isVar        Args((Cell));
 192 extern  Bool            isCon        Args((Cell));
 193 extern  Bool            isQVar       Args((Cell));
 194 extern  Bool            isQCon       Args((Cell));
 195 extern  Bool            isQualIdent  Args((Cell));
 196 extern  Bool            isIdent      Args((Cell));
 197 extern  String          stringNegate Args((String));
 198 extern  Text            textOf       Args((Cell));
 199
 200 #define isFloat(c)       (isPair(c) && fst(c)==FLOATCELL)
 201 #define stringToFloat(s) pair(FLOATCELL,findText(s))
 202 #define floatToString(f) textToStr(snd(f))
 203 #define floatOf(f)       atof(floatToString(f))
 204 #define mkFloat(f)       (f)  /* ToDo: is this right? */
 205 #define floatNegate(f)   stringToFloat(stringNegate(floatToString(f)))
 206
 207 #define stringToBignum(s) pair(BIGCELL,findText(s))
 208 #define bignumToString(b) textToStr(snd(b))
 209
 210 #if PTR_ON_HEAP
 211 #define isPtr(c)        (isPair(c) && fst(c)==PTRCELL)
 212 extern  Cell            mkPtr           Args((Ptr));
 213 extern  Ptr             ptrOf           Args((Cell));
 214 #define isCPtr(c)       (isPair(c) && fst(c)==CPTRCELL)
 215 extern  Cell            mkCPtr          Args((Ptr));
 216 extern  Ptr             cptrOf          Args((Cell));
 217 #endif
 218
 219 /* --------------------------------------------------------------------------
 220  * Constructor cell tags are used as the fst element of a pair to indicate
 221  * a particular syntactic construct described by the snd element of the
 222  * pair.
 223  * Note that a cell c will not be treated as an application (AP/isAp) node
 224  * if its first element is a constructor cell tag, whereas a cell whose fst
 225  * element is a special cell will be treated as an application node.
 226  * ------------------------------------------------------------------------*/
 227
 228 #define LETREC       30           /* LETREC     snd :: ([Decl],Exp)        */
 229 #define COND         31           /* COND       snd :: (Exp,Exp,Exp)       */
 230 #define LAMBDA       32           /* LAMBDA     snd :: Alt                 */
 231 #define FINLIST      33           /* FINLIST    snd :: [Exp]               */
 232 #define DOCOMP       34           /* DOCOMP     snd :: (Exp,[Qual])        */
 233 #define BANG         35           /* BANG       snd :: Type                */
 234 #define COMP         36           /* COMP       snd :: (Exp,[Qual])        */
 235 #define ASPAT        37           /* ASPAT      snd :: (Var,Exp)           */
 236 #define ESIGN        38           /* ESIGN      snd :: (Exp,Type)          */
 237 #define RSIGN        39           /* RSIGN      snd :: (Rhs,Type)          */
 238 #define CASE         40           /* CASE       snd :: (Exp,[Alt])         */
 239 #define NUMCASE      41           /* NUMCASE    snd :: (Exp,Disc,Rhs)      */
 240 #define FATBAR       42           /* FATBAR     snd :: (Exp,Exp)           */
 241 #define LAZYPAT      43           /* LAZYPAT    snd :: Exp                 */
 242 #define DERIVE       45           /* DERIVE     snd :: Cell                */
 243 #if BREAK_FLOATS
 244 #define FLOATCELL    46           /* FLOATCELL  snd :: (Int,Int)           */
 245 #endif
 246
 247 #define BOOLQUAL     49           /* BOOLQUAL   snd :: Exp                 */
 248 #define QWHERE       50           /* QWHERE     snd :: [Decl]              */
 249 #define FROMQUAL     51           /* FROMQUAL   snd :: (Exp,Exp)           */
 250 #define DOQUAL       52           /* DOQUAL     snd :: Exp                 */
 251 #define MONADCOMP    53           /* MONADCOMP  snd :: ((m,m0),(Exp,[Qual])*/
 252
 253 #define GUARDED      54           /* GUARDED    snd :: [guarded exprs]     */
 254
 255 #define ARRAY        55           /* Array      snd :: (Bounds,[Values])   */
 256 #define MUTVAR       56           /* Mutvar     snd :: Cell                */
 257 #if INTERNAL_PRIMS
 258 #define HUGSOBJECT   57           /* HUGSOBJECT snd :: Cell                */
 259 #endif
 260
 261 #if IPARAM
 262 #define WITHEXP      58           /* WITHEXP    snd :: [(Var,Exp)]         */
 263 #endif
 264
 265
 266 #define POLYTYPE     60           /* POLYTYPE   snd :: (Kind,Type)         */
 267 #define QUAL         61           /* QUAL       snd :: ([Classes],Type)    */
 268 #define RANK2        62           /* RANK2      snd :: (Int,Type)          */
 269 #define EXIST        63           /* EXIST      snd :: (Int,Type)          */
 270 #define POLYREC      64           /* POLYREC    snd :: (Int,Type)          */
 271 #define BIGLAM       65           /* BIGLAM     snd :: (vars,patterns)     */
 272 #define CDICTS       66           /* CDICTS     snd :: ([Pred],Type)       */
 273
 274 #define LABC         67           /* LABC       snd :: (con,[(Vars,Type)]) */
 275 #define CONFLDS      68           /* CONFLDS    snd :: (con,[Field])       */
 276 #define UPDFLDS      69           /* UPDFLDS    snd :: (Exp,[con],[Field]) */
 277 #if TREX
 278 #define RECORD       70           /* RECORD     snd :: [Val]               */
 279 #define EXTCASE      71           /* EXTCASE    snd :: (Exp,Disc,Rhs)      */
 280 #define RECSEL       72           /* RECSEL     snd :: Ext                 */
 281 #endif
 282 #define IMPDEPS      73           /* IMPDEPS    snd :: [Binding]           */
 283
 284 #define QUALIDENT    74           /* Qualified identifier  snd :: (Id,Id)  */
 285 #define HIDDEN       75           /* hiding import list    snd :: [Entity] */
 286 #define MODULEENT    76           /* module in export list snd :: con      */
 287
 288 #define INFIX        77           /* INFIX      snd :: (see tidyInfix)     */
 289 #define ONLY         78           /* ONLY       snd :: Exp                 */
 290 #define NEG          79           /* NEG        snd :: Exp                 */
 291
 292 /* Used when parsing GHC interface files */
 293 #define DICTAP       80           /* DICTAP     snd :: (QClassId,[Type])   */
 294 #define UNBOXEDTUP   81           /* UNBOXEDTUP snd :: [Type]              */
 295
 296 #if SIZEOF_INTP != SIZEOF_INT
 297 #define PTRCELL      82           /* C Heap Pointer snd :: (Int,Int)       */
 298 #endif
 299
 300 #define STGVAR       92           /* STGVAR     snd :: (StgRhs,info)       */
 301 #define STGAPP       93           /* STGAPP     snd :: (StgVar,[Arg])      */
 302 #define STGPRIM      94           /* STGPRIM    snd :: (PrimOp,[Arg])      */
 303 #define STGCON       95           /* STGCON     snd :: (StgCon,[Arg])      */
 304 #define PRIMCASE     96           /* PRIMCASE   snd :: (Expr,[PrimAlt])    */
 305 #define DEEFALT      97           /* DEEFALT    snd :: (Var,Expr)          */
 306 #define CASEALT      98           /* CASEALT    snd :: (Con,[Var],Expr)    */
 307 #define PRIMALT      99           /* PRIMALT    snd :: ([Var],Expr)        */
 308 /* Last constructor tag must be less than SPECMIN */
 309
 310 /* --------------------------------------------------------------------------
 311  * Special cell values:
 312  * ------------------------------------------------------------------------*/
 313
 314 #define SPECMIN      101
 315 #define isSpec(c)    (SPECMIN<=(c) && (c)<TUPMIN)/* Special cell values    */
 316
 317 #define NONE         101          /* Dummy stub                            */
 318 #define STAR         102          /* Representing the kind of types        */
 319 #if TREX
 320 #define ROW          103          /* Representing the kind of rows         */
 321 #endif
 322 #define WILDCARD     104          /* Wildcard pattern                      */
 323 #define SKOLEM       105          /* Skolem constant                       */
 324
 325 #define DOTDOT       106          /* ".." in import/export list            */
 326
 327 #define NAME         110          /* whatIs code for isName                */
 328 #define TYCON        111          /* whatIs code for isTycon               */
 329 #define CLASS        112          /* whatIs code for isClass               */
 330 #define MODULE       113          /* whatIs code for isModule              */
 331 #define INSTANCE     114          /* whatIs code for isInst                */
 332 #define TUPLE        115          /* whatIs code for tuple constructor     */
 333 #define OFFSET       116          /* whatis code for offset                */
 334 #define AP           117          /* whatIs code for application node      */
 335 #define CHARCELL     118          /* whatIs code for isChar                */
 336 #if TREX
 337 #define EXT          119          /* whatIs code for isExt                 */
 338 #endif
 339
 340 #define SIGDECL      120          /* Signature declaration                 */
 341 #define FIXDECL      121          /* Fixity declaration                    */
 342 #define FUNBIND      122          /* Function binding                      */
 343 #define PATBIND      123          /* Pattern binding                       */
 344
 345 #define DATATYPE     130          /* Datatype type constructor             */
 346 #define NEWTYPE      131          /* Newtype type constructor              */
 347 #define SYNONYM      132          /* Synonym type constructor              */
 348 #define RESTRICTSYN  133          /* Synonym with restricted scope         */
 349
 350 #define NODEPENDS    135          /* Stop calculation of deps in type check*/
 351 #define PREDEFINED   136          /* Predefined name, not yet filled       */
 352
 353 /* --------------------------------------------------------------------------
 354  * Tuple data/type constructors:
 355  * ------------------------------------------------------------------------*/
 356
 357 #define TUPMIN       201
 358 #if TREX
 359 #define isTuple(c)   (TUPMIN<=(c) && (c)<EXTMIN)
 360 #else
 361 #define isTuple(c)   (TUPMIN<=(c) && (c)<OFFMIN)
 362 #endif
 363 #define mkTuple(n)   (TUPMIN+(n))
 364 #define tupleOf(n)   ((Int)((n)-TUPMIN))
 365 extern Text ghcTupleText Args((Tycon));
 366
 367
 368
 369 #if TREX
 370 #define EXTMIN       (TUPMIN+NUM_TUPLES)
 371 #define isExt(c)     (EXTMIN<=(c) && (c)<OFFMIN)
 372 #define extText(e)   tabExt[(e)-EXTMIN]
 373 #define extField(c)  arg(fun(c))
 374 #define extRow(c)    arg(c)
 375
 376 extern Text          DECTABLE(tabExt);
 377 extern Ext           mkExt Args((Text));
 378 #else
 379 #define mkExt(t) NIL
 380 #endif
 381
 382 /* --------------------------------------------------------------------------
 383  * Offsets: (generic types/stack offsets)
 384  * ------------------------------------------------------------------------*/
 385
 386 #if TREX
 387 #define OFFMIN       (EXTMIN+NUM_EXT)
 388 #else
 389 #define OFFMIN       (TUPMIN+NUM_TUPLES)
 390 #endif
 391 #define isOffset(c)  (OFFMIN<=(c) && (c)<MODMIN)
 392 #define offsetOf(c)  ((c)-OFFMIN)
 393 #define mkOffset(o)  (OFFMIN+(o))
 394
 395 /* --------------------------------------------------------------------------
 396  * Object symbols:
 397  * ------------------------------------------------------------------------*/
 398
 399 /* An entry in a very crude object symbol table */
 400 typedef struct { char* nm; void* ad; }
 401    OSym;
 402
 403 /* Indication of section kinds for loaded objects.  Needed by
 404    the GC for deciding whether or not a pointer on the stack
 405    is a code pointer.
 406 */
 407 typedef enum { HUGS_DL_SECTION_CODE_OR_RODATA,
 408                HUGS_DL_SECTION_RWDATA,
 409                HUGS_DL_SECTION_OTHER }
 410    DLSect;
 411
 412 typedef struct { void* start; void* end; DLSect sect; }
 413    DLTabEnt;
 414
 415 /* --------------------------------------------------------------------------
 416  * Modules:
 417  * ------------------------------------------------------------------------*/
 418
 419 #define MODMIN        (OFFMIN+NUM_OFFSETS)
 420
 421 #define isModule(c)   (MODMIN<=(c) && (c)<TYCMIN)
 422 #define mkModule(n)   (MODMIN+(n))
 423 #define module(n)     tabModule[(n)-MODMIN]
 424
 425 /* Under Haskell 1.3, the list of qualified imports is always a subset
 426  * of the list of unqualified imports.  For simplicity and flexibility,
 427  * we do not attempt to exploit this fact - when a module is imported
 428  * unqualified, it is added to both the qualified and unqualified
 429  * import lists.
 430  * Similarily, Haskell 1.3 does not allow a constructor to be imported
 431  * or exported without exporting the type it belongs to but the export
 432  * list is just a flat list of Texts (before static analysis) or
 433  * Tycons, Names and Classes (after static analysis).
 434  */
 435 struct Module {
 436     Text  text;
 437     /* Lists of top level objects (local defns + imports)                  */
 438     List  tycons;
 439     List  names;
 440     List  classes;
 441     List  exports; /* [ Entity | (Entity, NIL|DOTDOT) ] */
 442     /* List of qualified imports.  Used both during compilation and when
 443      * evaluating an expression in the context of the current module.
 444      */
 445     List  qualImports;
 446
 447     /* ptr to malloc'd lump of memory holding the obj file */
 448     void* oImage;
 449
 450     /* ptr to object symbol table; lives in mallocville.
 451        Dynamically expands. */
 452     OSym* oTab;
 453     Int   sizeoTab;
 454     Int   usedoTab;
 455
 456     /* The section-kind entries for this object module.  Dynamically expands. */
 457     DLTabEnt* dlTab;
 458     Int       sizedlTab;
 459     Int       useddlTab;
 460 };
 461
 462 extern Module currentModule;           /* Module currently being processed */
 463 extern struct Module DECTABLE(tabModule);
 464
 465 extern Bool   isValidModule Args((Module));
 466 extern Module newModule     Args((Text));
 467 extern Module findModule    Args((Text));
 468 extern Module findModid     Args((Cell));
 469 extern Void   setCurrModule Args((Module));
 470
 471 extern void      addOTabName     Args((Module,char*,void*));
 472 extern void*     lookupOTabName  Args((Module,char*));
 473 extern char*     nameFromOPtr    Args((void*));
 474
 475 extern void      addDLSect    Args((Module,void*,void*,DLSect));
 476 extern DLSect    lookupDLSect Args((void*));
 477
 478
 479 #define isPrelude(m) (m==modulePrelude)
 480
 481 /* --------------------------------------------------------------------------
 482  * Type constructor names:
 483  * ------------------------------------------------------------------------*/
 484
 485 #define TYCMIN       (MODMIN+NUM_MODULE)
 486 #define isTycon(c)   (TYCMIN<=(c) && (c)<NAMEMIN)
 487 #define mkTycon(n)   (TCMIN+(n))
 488 #define tycon(n)     tabTycon[(n)-TYCMIN]
 489
 490 struct strTycon {
 491     Text   text;
 492     Int    line;
 493     Module mod;                         /* module that defines it          */
 494     Int    arity;
 495     Kind   kind;                        /* kind (includes arity) of Tycon  */
 496     Cell   what;                        /* DATATYPE/SYNONYM/RESTRICTSYN... */
 497     Cell   defn;
 498     Name   conToTag;                    /* used in derived code            */
 499     Name   tagToCon;
 500     Tycon  nextTyconHash;
 501 };
 502
 503 extern struct strTycon DECTABLE(tabTycon);
 504
 505 extern Tycon newTycon     Args((Text));
 506 extern Tycon findTycon    Args((Text));
 507 extern Tycon addTycon     Args((Tycon));
 508 extern Tycon findQualTycon Args((Cell));
 509 extern Tycon addPrimTycon Args((Text,Kind,Int,Cell,Cell));
 510
 511 #define isSynonym(h)    (isTycon(h) && tycon(h).what==SYNONYM)
 512 #define isQualType(t)   (isPair(t) && fst(t)==QUAL)
 513 #define mkPolyType(n,t) pair(POLYTYPE,pair(n,t))
 514 #define isPolyType(t)   (isPair(t) && fst(t)==POLYTYPE)
 515 #define isPolyOrQualType(t) (isPair(t) && (fst(t)==POLYTYPE || fst(t)==QUAL))
 516 #define polySigOf(t)    fst(snd(t))
 517 #define monotypeOf(t)   snd(snd(t))
 518
 519 #define bang(t)         ap(BANG,t)
 520
 521 /* --------------------------------------------------------------------------
 522  * Globally defined name values:
 523  * ------------------------------------------------------------------------*/
 524
 525 #define NAMEMIN      (TYCMIN+NUM_TYCON)
 526 #define isName(c)    (NAMEMIN<=(c) && (c)<INSTMIN)
 527 #define mkName(n)    (NAMEMIN+(n))
 528 #define name(n)      tabName[(n)-NAMEMIN]
 529
 530 struct strName {
 531     Text   text;
 532     Int    line;
 533     Module mod;                         /* module that defines it          */
 534     Syntax syntax;
 535     Cell   parent;
 536     Int    arity;
 537     Int    number;
 538     Cell   type;
 539     Cell   defn;
 540     Cell   stgVar;        /* really StgVar   */
 541     Text   callconv;      /* for foreign import/export */
 542     void*  primop;        /* really StgPrim* */
 543     Name   nextNameHash;
 544 };
 545
 546 extern int numNames Args(( Void ));
 547
 548 extern struct strName DECTABLE(tabName);
 549
 550 /* The number field in a name is used to distinguish various kinds of name:
 551  *   mfunNo(i) = code for member function, offset i
 552  *               members that are sole elements of dict use mfunNo(0)
 553  *               members of dicts with more than one elem use mfunNo(n), n>=1
 554  *   EXECNAME  = code for executable name (bytecodes or primitive)
 555  *   SELNAME   = code for selector function
 556  *   DFUNNAME  = code for dictionary builder or selector
 557  *   cfunNo(i) = code for data constructor
 558  *               datatypes with only one constructor uses cfunNo(0)
 559  *               datatypes with multiple constructors use cfunNo(n), n>=1
 560  */
 561
 562 #define EXECNAME        0
 563 #define SELNAME         1
 564 #define DFUNNAME        2
 565 #define CFUNNAME        3
 566
 567 #define isSfun(n)       (name(n).number==SELNAME)
 568 #define isDfun(n)       (name(n).number==DFUNNAME)
 569
 570 #define isCfun(n)       (name(n).number>=CFUNNAME)
 571 #define cfunOf(n)       (name(n).number-CFUNNAME)
 572 #define cfunNo(i)       ((i)+CFUNNAME)
 573 #define hasCfun(cs)     (nonNull(cs) && isCfun(hd(cs)))
 574
 575 #define isMfun(n)       (name(n).number<0)
 576 #define mfunOf(n)       ((-1)-name(n).number)
 577 #define mfunNo(i)       ((-1)-(i))
 578
 579 extern Name   newName         Args((Text,Cell));
 580 extern Name   findName        Args((Text));
 581 extern Name   addName         Args((Name));
 582 extern Name   findQualName    Args((Cell));
 583 extern Name   addPrimCfun     Args((Text,Int,Int,Cell));
 584 extern Name   addPrimCfunREP  Args((Text,Int,Int,Int));
 585 extern Int    sfunPos         Args((Name,Name));
 586 extern Name   nameFromStgVar  Args((Cell));
 587 extern Name   jrsFindQualName Args((Text,Text));
 588
 589 /* --------------------------------------------------------------------------
 590  * Type class values:
 591  * ------------------------------------------------------------------------*/
 592
 593 #define INSTMIN      (NAMEMIN+NUM_NAME) /* instances                       */
 594 #define isInst(c)    (INSTMIN<=(c) && (c)<CLASSMIN)
 595 #define mkInst(n)    (INSTMIN+(n))
 596 #define instOf(c)    ((Int)((c)-INSTMIN))
 597 #define inst(in)     tabInst[(in)-INSTMIN]
 598
 599 struct strInst {
 600     Class  c;                           /* class C                         */
 601     Int    line;
 602     Module mod;                         /* module that defines it          */
 603     Kinds  kinds;                       /* Kinds of variables in head      */
 604     Cell   head;                        /* :: Pred                         */
 605     List   specifics;                   /* :: [Pred]                       */
 606     Int    numSpecifics;                /* length(specifics)               */
 607     List   implements;
 608     Name   builder;                     /* Dictionary constructor function */
 609 };
 610
 611 /* a predicate (an element :: Pred) is an application of a Class to one or
 612  * more type expressions
 613  */
 614
 615 #define CLASSMIN     (INSTMIN+NUM_INSTS)
 616 #define isClass(c)   (CLASSMIN<=(c) && (c)<CHARMIN)
 617 #define mkClass(n)   (CLASSMIN+(n))
 618 #define cclass(n)    tabClass[(n)-CLASSMIN]
 619
 620 struct strClass {
 621     Text   text;                        /* Name of class                   */
 622     Int    line;                        /* Line where declaration begins   */
 623     Module mod;                         /* module that declares it         */
 624     Int    level;                       /* Level in class hierarchy        */
 625     Int    arity;                       /* Number of arguments             */
 626     Kinds  kinds;                       /* Kinds of constructors in class  */
 627     List   fds;                         /* Functional Dependencies         */
 628     List   xfds;                        /* Xpanded Functional Dependencies */
 629     Cell   head;                        /* Head of class                   */
 630     Name   dcon;                        /* Dictionary constructor function */
 631     List   supers;                      /* :: [Pred]                       */
 632     Int    numSupers;                   /* length(supers)                  */
 633     List   dsels;                       /* Superclass dictionary selectors */
 634     List   members;                     /* :: [Name]                       */
 635     Int    numMembers;                  /* length(members)                 */
 636     List   defaults;                    /* :: [Name]                       */
 637     List   instances;                   /* :: [Inst]                       */
 638 };
 639
 640 extern struct strClass    DECTABLE(tabClass);
 641 extern struct strInst far *tabInst;
 642
 643 extern Class newClass      Args((Text));
 644 extern Class classMax      Args((Void));
 645 extern Class findClass     Args((Text));
 646 extern Class addClass      Args((Class));
 647 extern Class findQualClass Args((Cell));
 648 extern Inst  newInst       Args((Void));
 649 extern Inst  findFirstInst Args((Tycon));
 650 extern Inst  findNextInst  Args((Tycon,Inst));
 651
 652 /* --------------------------------------------------------------------------
 653  * Character values:
 654  * ------------------------------------------------------------------------*/
 655
 656 #define CHARMIN      (CLASSMIN+NUM_CLASSES)
 657 #define MAXCHARVAL   (NUM_CHARS-1)
 658 #define isChar(c)    (CHARMIN<=(c) && (c)<INTMIN)
 659 #define charOf(c)    ((Char)(c-CHARMIN))
 660 #define mkChar(c)    ((Cell)(CHARMIN+(((unsigned)(c))%NUM_CHARS)))
 661
 662 /* --------------------------------------------------------------------------
 663  * Small Integer values:
 664  * ------------------------------------------------------------------------*/
 665
 666 #define INTMIN       (CHARMIN+NUM_CHARS)
 667 #define INTMAX       (MAXPOSINT)
 668 #define isSmall(c)   (INTMIN<=(c))
 669 #define INTZERO      (INTMIN/2 + INTMAX/2)
 670 #define MINSMALLINT  (INTMIN - INTZERO)
 671 #define MAXSMALLINT  (INTMAX - INTZERO)
 672 #define mkDigit(c)   ((Cell)((c)+INTMIN))
 673 #define digitOf(c)   ((Int)((c)-INTMIN))
 674
 675 extern  Bool isInt    Args((Cell));
 676 extern  Int  intOf    Args((Cell));
 677 extern  Cell mkInt    Args((Int));
 678
 679 /* --------------------------------------------------------------------------
 680  * Implementation of triples:
 681  * ------------------------------------------------------------------------*/
 682
 683 #define triple(x,y,z) pair(x,pair(y,z))
 684 #define fst3(c)      fst(c)
 685 #define snd3(c)      fst(snd(c))
 686 #define thd3(c)      snd(snd(c))
 687
 688 /* --------------------------------------------------------------------------
 689  * Implementation of lists:
 690  * ------------------------------------------------------------------------*/
 691
 692 #define NIL          0
 693 #define isNull(c)    ((c)==NIL)
 694 #define nonNull(c)   (c)
 695 #define cons(x,xs)   pair(x,xs)
 696 #define singleton(x)     cons(x,NIL)
 697 #define doubleton(x,y)   cons(x,cons(y,NIL))
 698 #define tripleton(x,y,z) cons(x,cons(y,cons(z,NIL)))
 699 #define hd(c)        fst(c)
 700 #define tl(c)        snd(c)
 701
 702 extern  Int          length       Args((List));
 703 extern  List         appendOnto   Args((List,List));    /* destructive     */
 704 extern  List         dupOnto      Args((List,List));
 705 extern  List         dupList      Args((List));
 706 extern  List         revOnto      Args((List, List));   /* destructive     */
 707 #define rev(xs)      revOnto((xs),NIL)                  /* destructive     */
 708 #define reverse(xs)  revOnto(dupList(xs),NIL)           /* non-destructive */
 709 extern  Cell         cellIsMember Args((Cell,List));
 710 extern  Cell         cellAssoc    Args((Cell,List));
 711 extern  Cell         cellRevAssoc Args((Cell,List));
 712 extern  Bool         eqList       Args((List,List));
 713 extern  Cell         varIsMember  Args((Text,List));
 714 extern  Name         nameIsMember Args((Text,List));
 715 extern  Cell         intIsMember  Args((Int,List));
 716 extern  List         replicate    Args((Int,Cell));
 717 extern  List         diffList     Args((List,List));    /* destructive     */
 718 extern  List         deleteCell   Args((List,Cell));    /* non-destructive */
 719 extern  List         take         Args((Int,List));     /* destructive     */
 720 extern  List         splitAt      Args((Int,List));     /* non-destructive */
 721 extern  Cell         nth          Args((Int,List));
 722 extern  List         removeCell   Args((Cell,List));    /* destructive     */
 723 extern  List         dupListOnto  Args((List,List));    /* non-destructive */
 724 extern  List         nubList      Args((List));         /* non-destructive */
 725
 726 /* The following macros provide `inline expansion' of some common ways of
 727  * traversing, using and modifying lists:
 728  *
 729  * N.B. We use the names _f, _a, _xs, Zs, in an attempt to avoid clashes
 730  *      with identifiers used elsewhere.
 731  */
 732
 733 #define mapBasic(_init,_step)           {List Zs=(_init);\
 734                                          for(;nonNull(Zs);Zs=tl(Zs))  \
 735                                          _step;}
 736 #define mapModify(_init,_step)          mapBasic(_init,hd(Zs)=_step)
 737
 738 #define mapProc(_f,_xs)                 mapBasic(_xs,_f(hd(Zs)))
 739 #define map1Proc(_f,_a,_xs)             mapBasic(_xs,_f(_a,hd(Zs)))
 740 #define map2Proc(_f,_a,_b,_xs)          mapBasic(_xs,_f(_a,_b,hd(Zs)))
 741 #define map3Proc(_f,_a,_b,_c,_xs)       mapBasic(_xs,_f(_a,_b,_c,hd(Zs)))
 742 #define map4Proc(_f,_a,_b,_c,_d,_xs)    mapBasic(_xs,_f(_a,_b,_c,_d,hd(Zs)))
 743
 744 #define mapOver(_f,_xs)                 mapModify(_xs,_f(hd(Zs)))
 745 #define map1Over(_f,_a,_xs)             mapModify(_xs,_f(_a,hd(Zs)))
 746 #define map2Over(_f,_a,_b,_xs)          mapModify(_xs,_f(_a,_b,hd(Zs)))
 747 #define map3Over(_f,_a,_b,_c,_xs)       mapModify(_xs,_f(_a,_b,_c,hd(Zs)))
 748 #define map4Over(_f,_a,_b,_c,_d,_xs)    mapModify(_xs,_f(_a,_b,_c,_d,hd(Zs)))
 749
 750 /* This is just what you want for functions with accumulating parameters */
 751 #define mapAccum(_f,_acc,_xs)           mapBasic(_xs,_acc=_f(_acc,hd(Zs)))
 752 #define map1Accum(_f,_acc,_a,_xs)       mapBasic(_xs,_acc=_f(_acc,_a,hd(Zs)))
 753 #define map2Accum(_f,_acc,_a,_b,_xs)    mapBasic(_xs,_acc=_f(_acc,_a,_b,hd(Zs)))
 754 #define map3Accum(_f,_acc,_a,_b,_c,_xs) mapBasic(_xs,_acc=_f(_acc,_a,_b,_c,hd(Zs)))
 755
 756 /* --------------------------------------------------------------------------
 757  * Implementation of function application nodes:
 758  * ------------------------------------------------------------------------*/
 759
 760 #define ap(f,x)      pair(f,x)
 761 #define ap1(f,x)     ap(f,x)
 762 #define ap2(f,x,y)   ap(ap(f,x),y)
 763 #define ap3(f,x,y,z) ap(ap(ap(f,x),y),z)
 764 #define fun(c)       fst(c)
 765 #define arg(c)       snd(c)
 766 #define isAp(c)      (isPair(c) && !isTag(fst(c)))
 767 extern  Cell         getHead     Args((Cell));
 768 extern  List         getArgs     Args((Cell));
 769 extern  Int          argCount;
 770 extern  Cell         nthArg      Args((Int,Cell));
 771 extern  Int          numArgs     Args((Cell));
 772 extern  Cell         applyToArgs Args((Cell,List));
 773
 774 /* --------------------------------------------------------------------------
 775  * Stack implementation:
 776  *
 777  * NB: Use of macros makes order of evaluation hard to predict.
 778  *     For example, "push(1+pop());" doesn't increment TOS.
 779  * ------------------------------------------------------------------------*/
 780
 781 extern  Cell DECTABLE(cellStack);
 782 extern  StackPtr sp;
 783
 784 #define clearStack() sp=(-1)
 785 #define stackEmpty() (sp==(-1))
 786 #define stack(p)     cellStack[p]
 787 #define chkStack(n)  if (sp>=NUM_STACK-(n)) hugsStackOverflow()
 788 #define push(c)      \
 789   do {               \
 790     chkStack(1);     \
 791     onto(c);         \
 792   } while (0)
 793 #define onto(c)      stack(++sp)=(c);
 794 #define pop()        stack(sp--)
 795 #define drop()       sp--
 796 #define top()        stack(sp)
 797 #define pushed(n)    stack(sp-(n))
 798 #define topfun(f)    top()=ap((f),top())
 799 #define toparg(x)    top()=ap(top(),(x))
 800
 801 extern  Void hugsStackOverflow Args((Void));
 802
 803 #if SYMANTEC_C
 804 #include <Memory.h>
 805 #define STACK_HEADROOM 16384
 806 #define STACK_CHECK if (StackSpace() <= STACK_HEADROOM) \
 807                       internal("Macintosh function parameter stack overflow.");
 808 #else
 809 #define STACK_CHECK
 810 #endif
 811
 812 /* --------------------------------------------------------------------------
 813  * Script file control:
 814  * The implementation of script file storage is hidden.
 815  * ------------------------------------------------------------------------*/
 816
 817 extern Script      startNewScript   Args((String));
 818 extern Bool        moduleThisScript Args((Module));
 819 extern Module      moduleOfScript   Args((Script));
 820 extern Bool        isPreludeScript  Args((Void));
 821 extern Module      lastModule       Args((Void));
 822 extern Script      scriptThisFile   Args((Text));
 823 extern Script      scriptThisName   Args((Name));
 824 extern Script      scriptThisTycon  Args((Tycon));
 825 extern Script      scriptThisInst   Args((Inst));
 826 extern Script      scriptThisClass  Args((Class));
 827 extern String      fileOfModule     Args((Module));
 828 extern Void        dropScriptsFrom  Args((Script));
 829
 830
 831 /* --------------------------------------------------------------------------
 832  * Plugins
 833  * ------------------------------------------------------------------------*/
 834
 835 #if PLUGINS
 836 /* This is an exact copy of the declaration found in GreenCard.h */
 837
 838 typedef int     HugsStackPtr;
 839 typedef int     HugsStablePtr;
 840 typedef Pointer HugsForeign;
 841
 842 typedef struct {
 843
 844   /* evaluate next argument */
 845   int            (*getInt   )     Args(());
 846   unsigned int   (*getWord  )     Args(());
 847   void*          (*getAddr  )     Args(());
 848   float          (*getFloat )     Args(());
 849   double         (*getDouble)     Args(());
 850   char           (*getChar  )     Args(());
 851   HugsForeign    (*getForeign)    Args(());
 852   HugsStablePtr  (*getStablePtr)  Args(());
 853
 854   /* push part of result   */
 855   void           (*putInt   )     Args((int));
 856   void           (*putWord  )     Args((unsigned int));
 857   void           (*putAddr  )     Args((void*));
 858   void           (*putFloat )     Args((double));
 859   void           (*putDouble)     Args((double));
 860   void           (*putChar  )     Args((char));
 861   void           (*putForeign)    Args((HugsForeign, void (*)(HugsForeign)));
 862   void           (*putStablePtr)  Args((HugsStablePtr));
 863
 864   /* return n values in IO monad or Id monad */
 865   void           (*returnIO)      Args((HugsStackPtr, int));
 866   void           (*returnId)      Args((HugsStackPtr, int));
 867   int            (*runIO)         Args((int));
 868
 869   /* free a stable pointer */
 870   void           (*freeStablePtr) Args((HugsStablePtr));
 871
 872   /* register the prim table */
 873   void           (*registerPrims) Args((struct primInfo*));
 874
 875   /* garbage collect */
 876   void           (*garbageCollect) Args(());
 877
 878 } HugsAPI2;
 879
 880 extern  HugsAPI2* hugsAPI2     Args((Void));
 881 typedef Void (*InitModuleFun2) Args((HugsAPI2*));
 882
 883 typedef struct {
 884   Name  nameTrue, nameFalse;
 885   Name  nameNil,  nameCons;
 886   Name  nameJust, nameNothing;
 887   Name  nameLeft, nameRight;
 888   Name  nameUnit;
 889   Name  nameIORun;
 890
 891   Cell  (*makeInt)         Args((Int));
 892
 893   Cell  (*makeChar)        Args((Char));
 894   Char  (*CharOf)          Args((Cell));
 895
 896   Cell  (*makeFloat)       Args((FloatPro));
 897   Cell  (*makeTuple)       Args((Int));
 898   Pair  (*pair)            Args((Cell,Cell));
 899
 900   Cell  (*mkMallocPtr)     Args((Void *, Void (*)(Void *)));
 901   Void *(*derefMallocPtr)  Args((Cell));
 902
 903   Int   (*mkStablePtr)     Args((Cell));
 904   Cell  (*derefStablePtr)  Args((Int));
 905   Void  (*freeStablePtr)   Args((Int));
 906
 907   Void  (*eval)            Args((Cell));
 908   Cell  (*evalWithNoError) Args((Cell));
 909   Void  (*evalFails)       Args((StackPtr));
 910   Int   *whnfArgs;
 911   Cell  *whnfHead;
 912   Int   *whnfInt;
 913   Float *whnfFloat;
 914
 915   Void  (*garbageCollect)  Args(());
 916   Void  (*stackOverflow)   Args(());
 917   Void  (*internal)        Args((String)) HUGS_noreturn;
 918
 919   Void  (*registerPrims)   Args((struct primInfo*));
 920   Name  (*addPrimCfun)     Args((Text,Int,Int,Cell));
 921   Text  (*inventText)      Args(());
 922
 923   Cell *(*Fst)             Args((Cell));
 924   Cell *(*Snd)             Args((Cell));
 925
 926   Cell  *cellStack;
 927   StackPtr *sp;
 928 } HugsAPI1;
 929
 930 extern  HugsAPI1* hugsAPI1     Args((Void));
 931 typedef Void (*InitModuleFun1) Args((HugsAPI1*));
 932 #endif /* PLUGINS */
 933
 934
 935 /* --------------------------------------------------------------------------
 936  * Misc:
 937  * ------------------------------------------------------------------------*/
 938
 939 extern  Void   setLastExpr       Args((Cell));
 940 extern  Cell   getLastExpr       Args((Void));
 941 extern  List   addTyconsMatching Args((String,List));
 942 extern  List   addNamesMatching  Args((String,List));
 943
 944 /*-------------------------------------------------------------------------*/