2 /* -----------------------------------------------------------------------------
3 * $Id: Assembler.h,v 1.8 1999/10/15 11:02:06 sewardj Exp $
5 * (c) The GHC Team 1994-1998.
9 * NB This is one of the few files shared between Hugs and the runtime system,
10 * so it is very important that it not conflict with either and that it not
12 * (In fact, it might be fun to create a GreenCard interface to this file too.)
13 * ---------------------------------------------------------------------------*/
15 /* ToDo: put this somewhere more sensible */
16 extern void DEBUG_LoadSymbols( char *name );
18 /* This file is supposed to be somewhat self-contained because it is one
19 * of the major external interfaces to the runtime system.
20 * Keeping it self-contained reduces the chance of conflict with Hugs
21 * (or anything else that includes it).
22 * The big disadvantage of being self-contained is that definitions
23 * like AsmNat8, etc duplicate definitions in StgTypes.h.
24 * I'm not sure what we can do about this but, if you try to fix it,
25 * please remember why it was done this way in the first place.
29 typedef unsigned char AsmNat8;
30 typedef unsigned int AsmNat;
31 typedef signed int AsmInt;
32 typedef signed long long int AsmInt64; /* ToDo: not portable! */
33 typedef unsigned int AsmWord;
34 typedef void* AsmAddr;
35 typedef unsigned char AsmChar;
36 typedef float AsmFloat; /* ToDo: not on Alphas! */
37 typedef double AsmDouble;
38 typedef char* AsmString;
40 /* I want to #include this file into the file that defines the
41 * functions but I don't want to expose the structures that
42 * these types point to.
43 * This hack is the best I could think of. Surely there's a better way?
45 #ifdef INSIDE_ASSEMBLER_C
46 typedef struct AsmObject_ *AsmObject;
47 typedef struct AsmBCO_ *AsmBCO;
48 typedef struct AsmCAF_ *AsmCAF;
49 typedef struct AsmCon_ *AsmCon;
50 typedef StgInfoTable *AsmInfo;
51 typedef StgClosure *AsmClosure;
52 typedef Instr AsmInstr;
54 /* the types we export are totally opaque */
55 typedef void *AsmObject;
59 typedef void *AsmInfo;
60 typedef void *AsmClosure;
61 typedef unsigned int AsmInstr;
64 typedef int AsmSp; /* stack offset */
65 typedef int AsmPc; /* program counter */
66 typedef AsmSp AsmVar; /* offset of a Var on the stack */
68 /* --------------------------------------------------------------------------
69 * "Types" used within the assembler
71 * Some of these types are synonyms for the same underlying representation
72 * to let Hugs (or whoever) generate useful Haskell types from the type
73 * of a primitive operation.
75 * Extreme care should be taken if you change any of these - the
76 * same constants are hardwired into Hugs (ILLEGAL_REP) and into
77 * pieces of assembly language used to implement foreign import/export.
78 * And, of course, you'll have to change the primop table in Assembler.c
79 * ------------------------------------------------------------------------*/
84 /* The following can be passed to C */
92 STABLE_REP = 's', /* StablePtr a */
93 #ifdef PROVIDE_FOREIGN
94 FOREIGN_REP = 'f', /* ForeignObj */
97 WEAK_REP = 'w', /* Weak a */
99 BARR_REP = 'x', /* PrimByteArray a */
100 MUTBARR_REP = 'm', /* PrimMutableByteArray s a */
102 /* The following can't be passed to C */
104 ALPHA_REP = 'a', /* a */
105 BETA_REP = 'b', /* b */
106 GAMMA_REP = 'c', /* c */
107 BOOL_REP = 'B', /* Bool */
108 IO_REP = 'i', /* IO a */
109 HANDLER_REP = 'H', /* Exception -> IO a */
110 ERROR_REP = 'E', /* Exception */
111 ARR_REP = 'X', /* PrimArray a */
112 REF_REP = 'R', /* Ref s a */
113 MUTARR_REP = 'M', /* PrimMutableArray s a */
114 #ifdef PROVIDE_CONCURRENT
115 THREADID_REP = 'T', /* ThreadId */
116 MVAR_REP = 'r', /* MVar a */
119 /* Allegedly used in the IO monad */
123 /* --------------------------------------------------------------------------
124 * Allocating (top level) heap objects
125 * ------------------------------------------------------------------------*/
127 extern AsmBCO asmBeginBCO ( int /*StgExpr*/ e );
128 extern void asmEndBCO ( AsmBCO bco );
130 extern AsmBCO asmBeginContinuation ( AsmSp sp, int /*List*/ alts );
131 extern void asmEndContinuation ( AsmBCO bco );
133 extern AsmObject asmMkObject ( AsmClosure c );
135 extern AsmCAF asmBeginCAF ( void );
136 extern void asmEndCAF ( AsmCAF caf, AsmBCO body );
138 extern AsmInfo asmMkInfo ( AsmNat tag, AsmNat ptrs );
139 extern AsmCon asmBeginCon ( AsmInfo info );
140 extern void asmEndCon ( AsmCon con );
142 /* NB: we add ptrs to other objects in left-to-right order.
143 * This is different from pushing arguments on the stack which is done
144 * in right to left order.
146 extern void asmAddPtr ( AsmObject obj, AsmObject arg );
148 extern int asmObjectHasClosure( AsmObject obj );
149 extern AsmClosure asmClosureOfObject ( AsmObject obj );
150 extern void asmMarkObject ( AsmObject obj );
152 extern int asmRepSizeW ( AsmRep rep );
154 /* --------------------------------------------------------------------------
155 * Generating instruction streams
156 * ------------------------------------------------------------------------*/
158 extern AsmSp asmBeginArgCheck ( AsmBCO bco );
159 extern void asmEndArgCheck ( AsmBCO bco, AsmSp last_arg );
161 extern AsmSp asmBeginEnter ( AsmBCO bco );
162 extern void asmEndEnter ( AsmBCO bco, AsmSp sp1, AsmSp sp2 );
164 extern AsmVar asmBind ( AsmBCO bco, AsmRep rep );
165 extern void asmVar ( AsmBCO bco, AsmVar v, AsmRep rep );
167 extern AsmSp asmBeginCase ( AsmBCO bco );
168 extern void asmEndCase ( AsmBCO bco );
169 extern AsmSp asmContinuation ( AsmBCO bco, AsmBCO ret_addr );
171 extern AsmSp asmBeginAlt ( AsmBCO bco );
172 extern void asmEndAlt ( AsmBCO bco, AsmSp sp );
173 extern AsmPc asmTest ( AsmBCO bco, AsmWord tag );
174 extern AsmPc asmTestInt ( AsmBCO bco, AsmVar v, AsmInt x );
175 extern void asmFixBranch ( AsmBCO bco, AsmPc pc );
176 extern void asmPanic ( AsmBCO bco );
178 extern AsmVar asmBox ( AsmBCO bco, AsmRep rep );
179 extern AsmVar asmUnbox ( AsmBCO bco, AsmRep rep );
180 extern void asmReturnUnboxed ( AsmBCO bco, AsmRep rep );
182 /* push unboxed Ints, Floats, etc */
183 extern void asmConstInt ( AsmBCO bco, AsmInt x );
184 extern void asmConstAddr ( AsmBCO bco, AsmAddr x );
185 extern void asmConstWord ( AsmBCO bco, AsmWord x );
186 extern void asmConstChar ( AsmBCO bco, AsmChar x );
187 extern void asmConstFloat ( AsmBCO bco, AsmFloat x );
188 extern void asmConstDouble ( AsmBCO bco, AsmDouble x );
189 extern void asmConstInteger ( AsmBCO bco, AsmString x );
191 /* Which monad (if any) does the primop live in? */
193 MONAD_Id, /* no monad (aka the identity monad) */
203 AsmNat8 prefix; /* should be StgInstr */
204 AsmNat8 opcode; /* should be Primop1 or Primop2 */
207 extern const AsmPrim asmPrimOps[]; /* null terminated list */
209 extern const AsmPrim* asmFindPrim ( char* s );
210 extern const AsmPrim* asmFindPrimop ( AsmInstr prefix, AsmInstr op );
211 extern AsmSp asmBeginPrim ( AsmBCO bco );
212 extern void asmEndPrim ( AsmBCO bco, const AsmPrim* prim, AsmSp base );
214 extern AsmBCO asm_BCO_catch ( void );
215 extern AsmBCO asm_BCO_raise ( void );
216 extern AsmBCO asm_BCO_seq ( void );
219 /* --------------------------------------------------------------------------
221 * ------------------------------------------------------------------------*/
223 extern AsmVar asmClosure ( AsmBCO bco, AsmObject p );
224 extern AsmVar asmGHCClosure ( AsmBCO bco, AsmObject p );
226 extern AsmVar asmAllocCONSTR ( AsmBCO bco, AsmInfo info );
228 extern AsmSp asmBeginPack ( AsmBCO bco );
229 extern void asmEndPack ( AsmBCO bco, AsmVar v, AsmSp start, AsmInfo info );
231 extern void asmBeginUnpack ( AsmBCO bco );
232 extern void asmEndUnpack ( AsmBCO bco );
234 extern AsmVar asmAllocAP ( AsmBCO bco, AsmNat size );
235 extern AsmSp asmBeginMkAP ( AsmBCO bco );
236 extern void asmEndMkAP ( AsmBCO bco, AsmVar v, AsmSp start );
238 extern AsmVar asmAllocPAP ( AsmBCO bco, AsmNat size );
239 extern AsmSp asmBeginMkPAP ( AsmBCO bco );
240 extern void asmEndMkPAP ( AsmBCO bco, AsmVar v, AsmSp start );
242 /* --------------------------------------------------------------------------
244 * ------------------------------------------------------------------------*/
246 extern const AsmPrim ccall_Id;
247 extern const AsmPrim ccall_IO;
261 CFunDescriptor* mkDescriptor( char* as, char* rs );
263 /*-------------------------------------------------------------------------*/