Stg.h 14.2 KB
Newer Older
1
/* -----------------------------------------------------------------------------
2
 *
3
 * (c) The GHC Team, 1998-2009
4
 *
5
6
7
8
9
 * Top-level include file for everything required when compiling .hc
 * code.  NOTE: in .hc files, Stg.h must be included *before* any
 * other headers, because we define some register variables which must
 * be done before any inline functions are defined (some system
 * headers have been known to define the odd inline function).
10
 *
11
12
13
14
15
16
17
 * We generally try to keep as little visible as possible when
 * compiling .hc files.  So for example the definitions of the
 * InfoTable structs, closure structs and other RTS types are not
 * visible here.  The compiler knows enough about the representations
 * of these types to generate code which manipulates them directly
 * with pointer arithmetic.
 *
18
19
20
21
22
23
 * In ordinary C code, do not #include this file directly: #include
 * "Rts.h" instead.
 *
 * To understand the structure of the RTS headers, see the wiki:
 *   http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
 *
24
25
26
27
28
 * ---------------------------------------------------------------------------*/

#ifndef STG_H
#define STG_H

Simon Marlow's avatar
Simon Marlow committed
29
30
31
32
33
34
35
36
37
38
/*
 * If we are compiling a .hc file, then we want all the register
 * variables.  This is the what happens if you #include "Stg.h" first:
 * we assume this is a .hc file, and set IN_STG_CODE==1, which later
 * causes the register variables to be enabled in stg/Regs.h.
 *
 * If instead "Rts.h" is included first, then we are compiling a
 * vanilla C file.  Everything from Stg.h is provided, except that
 * IN_STG_CODE is not defined, and the register variables will not be
 * active.
39
 */
40
41
#ifndef IN_STG_CODE
# define IN_STG_CODE 1
Ian Lynagh's avatar
Ian Lynagh committed
42

43
44
// Turn on C99 for .hc code.  This gives us the INFINITY and NAN
// constants from math.h, which we occasionally need to use in .hc (#1861)
Ian Lynagh's avatar
Ian Lynagh committed
45
# define _ISOC99_SOURCE
Ian Lynagh's avatar
Ian Lynagh committed
46
47
48
49

// We need _BSD_SOURCE so that math.h defines things like gamma
// on Linux
# define _BSD_SOURCE
50
51
52
#endif

#if IN_STG_CODE == 0
53
# define NO_GLOBAL_REG_DECLS	/* don't define fixed registers */
54
55
#endif

56
/* Configuration */
57
#include "ghcconfig.h"
sof's avatar
sof committed
58

59
60
61
62
63
/* The code generator calls the math functions directly in .hc code.
   NB. after configuration stuff above, because this sets #defines
   that depend on config info, such as __USE_FILE_OFFSET64 */
#include <math.h>

64
65
66
/* -----------------------------------------------------------------------------
   Useful definitions
   -------------------------------------------------------------------------- */
67

68
/*
Simon Marlow's avatar
Simon Marlow committed
69
 * The C backend likes to refer to labels by just mentioning their
70
71
72
73
 * names.  Howevver, when a symbol is declared as a variable in C, the
 * C compiler will implicitly dereference it when it occurs in source.
 * So we must subvert this behaviour for .hc files by declaring
 * variables as arrays, which eliminates the implicit dereference.
74
 */
75
76
77
#if IN_STG_CODE
#define RTS_VAR(x) (x)[]
#define RTS_DEREF(x) (*(x))
78
#else
79
80
#define RTS_VAR(x) x
#define RTS_DEREF(x) x
81
82
#endif

83
/* bit macros
sof's avatar
sof committed
84
 */
85
86
#define BITS_PER_BYTE 8
#define BITS_IN(x) (BITS_PER_BYTE * sizeof(x))
sof's avatar
sof committed
87

88
89
/* Compute offsets of struct fields
 */
Ian Lynagh's avatar
Ian Lynagh committed
90
#define STG_FIELD_OFFSET(s_type, field) ((StgWord)&(((s_type*)0)->field))
91

sof's avatar
sof committed
92
/*
93
 * 'Portable' inlining:
Simon Marlow's avatar
Simon Marlow committed
94
 * INLINE_HEADER is for inline functions in header files (macros)
95
 * STATIC_INLINE is for inline functions in source files
96
97
 * EXTERN_INLINE is for functions that we want to inline sometimes 
 * (we also compile a static version of the function; see Inlines.c)
sof's avatar
sof committed
98
 */
99
#if defined(__GNUC__) || defined( __INTEL_COMPILER)
Simon Marlow's avatar
Simon Marlow committed
100

sof's avatar
sof committed
101
102
103
# define INLINE_HEADER static inline
# define INLINE_ME inline
# define STATIC_INLINE INLINE_HEADER
Simon Marlow's avatar
Simon Marlow committed
104

105
106
107
108
109
// The special "extern inline" behaviour is now only supported by gcc
// when _GNUC_GNU_INLINE__ is defined, and you have to use
// __attribute__((gnu_inline)).  So when we don't have this, we use
// ordinary static inline.
//
110
111
112
113
114
// Apple's gcc defines __GNUC_GNU_INLINE__ without providing
// gnu_inline, so we exclude MacOS X and fall through to the safe
// version.
//
#if defined(__GNUC_GNU_INLINE__) && !defined(__APPLE__)
115
116
117
118
119
120
121
122
123
124
125
126
#  if defined(KEEP_INLINES)
#    define EXTERN_INLINE inline
#  else
#    define EXTERN_INLINE extern inline __attribute__((gnu_inline))
#  endif
#else
#  if defined(KEEP_INLINES)
#    define EXTERN_INLINE
#  else
#    define EXTERN_INLINE INLINE_HEADER
#  endif
#endif
Simon Marlow's avatar
Simon Marlow committed
127

sof's avatar
sof committed
128
#elif defined(_MSC_VER)
Simon Marlow's avatar
Simon Marlow committed
129

sof's avatar
sof committed
130
131
132
# define INLINE_HEADER __inline static
# define INLINE_ME __inline
# define STATIC_INLINE INLINE_HEADER
Simon Marlow's avatar
Simon Marlow committed
133
134
135
136
137
138
139

# if defined(KEEP_INLINES)
#  define EXTERN_INLINE __inline
# else
#  define EXTERN_INLINE __inline extern
# endif

sof's avatar
sof committed
140
#else
Simon Marlow's avatar
Simon Marlow committed
141

sof's avatar
sof committed
142
# error "Don't know how to inline functions with your C compiler."
Simon Marlow's avatar
Simon Marlow committed
143

sof's avatar
sof committed
144
145
#endif

Simon Marlow's avatar
Simon Marlow committed
146

147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/*
 * GCC attributes
 */
#if defined(__GNUC__)
#define GNU_ATTRIBUTE(at) __attribute__((at))
#else
#define GNU_ATTRIBUTE(at)
#endif

#if __GNUC__ >= 3 
#define GNUC3_ATTRIBUTE(at) __attribute__((at))
#else
#define GNUC3_ATTRIBUTE(at)
#endif

Simon Marlow's avatar
Simon Marlow committed
162
163
164
165
166
167
#if __GNUC__ > 4 || __GNUC__ == 4 && __GNUC_MINOR__ >= 3
#define GNUC_ATTR_HOT __attribute__((hot))
#else
#define GNUC_ATTR_HOT /* nothing */
#endif

168
169
#define STG_UNUSED    GNUC3_ATTRIBUTE(__unused__)

170
/* -----------------------------------------------------------------------------
171
   Global type definitions
172
173
   -------------------------------------------------------------------------- */

174
#include "MachDeps.h"
Simon Marlow's avatar
Simon Marlow committed
175
#include "stg/Types.h"
176

177
178
179
180
181
182
183
184
/* -----------------------------------------------------------------------------
   Shorthand forms
   -------------------------------------------------------------------------- */

typedef StgChar		C_;
typedef StgWord		W_;
typedef StgWord*	P_;
typedef StgInt		I_;
185
typedef StgWord StgWordArray[];
186
typedef StgFunPtr       F_;
Simon Marlow's avatar
Simon Marlow committed
187

188
189
#define EI_(X)          extern StgWordArray (X) GNU_ATTRIBUTE(aligned (8))
#define II_(X)          static StgWordArray (X) GNU_ATTRIBUTE(aligned (8))
Simon Marlow's avatar
Simon Marlow committed
190
191
192
#define IF_(f)		static StgFunPtr GNUC3_ATTRIBUTE(used) f(void) 
#define FN_(f)		StgFunPtr f(void)
#define EF_(f)		extern StgFunPtr f(void)
193

194
195
196
197
198
199
/* -----------------------------------------------------------------------------
   Tail calls

   This needs to be up near the top as the register line on alpha needs
   to be before all procedures (inline & out-of-line).
   -------------------------------------------------------------------------- */
200

Simon Marlow's avatar
Simon Marlow committed
201
#include "stg/TailCalls.h"
202

203
204
205
206
/* -----------------------------------------------------------------------------
   Other Stg stuff...
   -------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
207
208
209
210
#include "stg/DLL.h"
#include "stg/MachRegs.h"
#include "stg/Regs.h"
#include "stg/Ticky.h"
Ian Lynagh's avatar
Ian Lynagh committed
211

212
213
214
215
216
#if IN_STG_CODE
/*
 * This is included later for RTS sources, after definitions of
 * StgInfoTable, StgClosure and so on. 
 */
Simon Marlow's avatar
Simon Marlow committed
217
#include "stg/MiscClosures.h"
218
219
#endif

Simon Marlow's avatar
Simon Marlow committed
220
#include "stg/SMP.h" // write_barrier() inline is required 
221

222
/* -----------------------------------------------------------------------------
223
224
225
226
227
228
229
230
   Moving Floats and Doubles

   ASSIGN_FLT is for assigning a float to memory (usually the
              stack/heap).  The memory address is guaranteed to be
	      StgWord aligned (currently == sizeof(void *)).

   PK_FLT     is for pulling a float out of memory.  The memory is
              guaranteed to be StgWord aligned.
231
232
   -------------------------------------------------------------------------- */

233
234
INLINE_HEADER void	  ASSIGN_FLT (W_ [], StgFloat);
INLINE_HEADER StgFloat    PK_FLT     (W_ []);
235

236
#if ALIGNMENT_FLOAT <= ALIGNMENT_LONG
237

238
239
INLINE_HEADER void     ASSIGN_FLT(W_ p_dest[], StgFloat src) { *(StgFloat *)p_dest = src; }
INLINE_HEADER StgFloat PK_FLT    (W_ p_src[])                { return *(StgFloat *)p_src; }
240

241
#else  /* ALIGNMENT_FLOAT > ALIGNMENT_UNSIGNED_INT */
242

243
244
245
246
247
248
INLINE_HEADER void ASSIGN_FLT(W_ p_dest[], StgFloat src)
{
    float_thing y;
    y.f = src;
    *p_dest = y.fu;
}
249

250
251
252
253
254
255
256
257
258
259
260
261
262
INLINE_HEADER StgFloat PK_FLT(W_ p_src[])
{
    float_thing y;
    y.fu = *p_src;
    return(y.f);
}

#endif /* ALIGNMENT_FLOAT > ALIGNMENT_LONG */

#if ALIGNMENT_DOUBLE <= ALIGNMENT_LONG

INLINE_HEADER void	  ASSIGN_DBL (W_ [], StgDouble);
INLINE_HEADER StgDouble   PK_DBL     (W_ []);
263

264
265
INLINE_HEADER void      ASSIGN_DBL(W_ p_dest[], StgDouble src) { *(StgDouble *)p_dest = src; }
INLINE_HEADER StgDouble PK_DBL    (W_ p_src[])                 { return *(StgDouble *)p_src; }
sof's avatar
sof committed
266

267
268
269
270
271
272
#else	/* ALIGNMENT_DOUBLE > ALIGNMENT_LONG */

/* Sparc uses two floating point registers to hold a double.  We can
 * write ASSIGN_DBL and PK_DBL by directly accessing the registers
 * independently - unfortunately this code isn't writable in C, we
 * have to use inline assembler.
273
 */
274
#if sparc_HOST_ARCH
275
276
277
278
279
280
281
282
283
284
285
286
287
288

#define ASSIGN_DBL(dst0,src) \
    { StgPtr dst = (StgPtr)(dst0); \
      __asm__("st %2,%0\n\tst %R2,%1" : "=m" (((P_)(dst))[0]), \
	"=m" (((P_)(dst))[1]) : "f" (src)); \
    }

#define PK_DBL(src0) \
    ( { StgPtr src = (StgPtr)(src0); \
        register double d; \
      __asm__("ld %1,%0\n\tld %2,%R0" : "=f" (d) : \
	"m" (((P_)(src))[0]), "m" (((P_)(src))[1])); d; \
    } )

289
#else /* ! sparc_HOST_ARCH */
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318

INLINE_HEADER void	  ASSIGN_DBL (W_ [], StgDouble);
INLINE_HEADER StgDouble   PK_DBL     (W_ []);

typedef struct
  { StgWord dhi;
    StgWord dlo;
  } unpacked_double;

typedef union
  { StgDouble d;
    unpacked_double du;
  } double_thing;

INLINE_HEADER void ASSIGN_DBL(W_ p_dest[], StgDouble src)
{
    double_thing y;
    y.d = src;
    p_dest[0] = y.du.dhi;
    p_dest[1] = y.du.dlo;
}

/* GCC also works with this version, but it generates
   the same code as the previous one, and is not ANSI

#define ASSIGN_DBL( p_dest, src ) \
	*p_dest = ((double_thing) src).du.dhi; \
	*(p_dest+1) = ((double_thing) src).du.dlo \
*/
319

320
321
322
323
324
325
326
INLINE_HEADER StgDouble PK_DBL(W_ p_src[])
{
    double_thing y;
    y.du.dhi = p_src[0];
    y.du.dlo = p_src[1];
    return(y.d);
}
327

328
#endif /* ! sparc_HOST_ARCH */
329

330
#endif /* ALIGNMENT_DOUBLE > ALIGNMENT_UNSIGNED_INT */
331
332


333
334
335
336
337
338
339
340
341
/* -----------------------------------------------------------------------------
   Moving 64-bit quantities around

   ASSIGN_Word64      assign an StgWord64/StgInt64 to a memory location
   PK_Word64          load an StgWord64/StgInt64 from a amemory location

   In both cases the memory location might not be 64-bit aligned.
   -------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
342
#if SIZEOF_HSWORD == 4
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412

typedef struct
  { StgWord dhi;
    StgWord dlo;
  } unpacked_double_word;

typedef union
  { StgInt64 i;
    unpacked_double_word iu;
  } int64_thing;

typedef union
  { StgWord64 w;
    unpacked_double_word wu;
  } word64_thing;

INLINE_HEADER void ASSIGN_Word64(W_ p_dest[], StgWord64 src)
{
    word64_thing y;
    y.w = src;
    p_dest[0] = y.wu.dhi;
    p_dest[1] = y.wu.dlo;
}

INLINE_HEADER StgWord64 PK_Word64(W_ p_src[])
{
    word64_thing y;
    y.wu.dhi = p_src[0];
    y.wu.dlo = p_src[1];
    return(y.w);
}

INLINE_HEADER void ASSIGN_Int64(W_ p_dest[], StgInt64 src)
{
    int64_thing y;
    y.i = src;
    p_dest[0] = y.iu.dhi;
    p_dest[1] = y.iu.dlo;
}

INLINE_HEADER StgInt64 PK_Int64(W_ p_src[])
{
    int64_thing y;
    y.iu.dhi = p_src[0];
    y.iu.dlo = p_src[1];
    return(y.i);
}

#elif SIZEOF_VOID_P == 8

INLINE_HEADER void ASSIGN_Word64(W_ p_dest[], StgWord64 src)
{
	p_dest[0] = src;
}

INLINE_HEADER StgWord64 PK_Word64(W_ p_src[])
{
    return p_src[0];
}

INLINE_HEADER void ASSIGN_Int64(W_ p_dest[], StgInt64 src)
{
    p_dest[0] = src;
}

INLINE_HEADER StgInt64 PK_Int64(W_ p_src[])
{
    return p_src[0];
}

Simon Marlow's avatar
Simon Marlow committed
413
#endif /* SIZEOF_HSWORD == 4 */
414
415
416
417

/* -----------------------------------------------------------------------------
   Split markers
   -------------------------------------------------------------------------- */
418

419
420
421
422
423
424
425
426
427
428
#if defined(USE_SPLIT_MARKERS)
#if defined(LEADING_UNDERSCORE)
#define __STG_SPLIT_MARKER __asm__("\n___stg_split_marker:");
#else
#define __STG_SPLIT_MARKER __asm__("\n__stg_split_marker:");
#endif
#else
#define __STG_SPLIT_MARKER /* nothing */
#endif

429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
/* -----------------------------------------------------------------------------
   Write-combining store
   -------------------------------------------------------------------------- */

INLINE_HEADER void
wcStore (StgPtr p, StgWord w)
{
#ifdef x86_64_HOST_ARCH    
    __asm__(
	"movnti\t%1, %0"
	: "=m" (*p)
	: "r" (w)
	);
#else
      *p = w;
#endif
}

447
448
449
/* -----------------------------------------------------------------------------
   Integer multiply with overflow
   -------------------------------------------------------------------------- */
450

451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
/* Multiply with overflow checking.
 *
 * This is tricky - the usual sign rules for add/subtract don't apply.  
 *
 * On 32-bit machines we use gcc's 'long long' types, finding
 * overflow with some careful bit-twiddling.
 *
 * On 64-bit machines where gcc's 'long long' type is also 64-bits,
 * we use a crude approximation, testing whether either operand is
 * larger than 32-bits; if neither is, then we go ahead with the
 * multiplication.
 *
 * Return non-zero if there is any possibility that the signed multiply
 * of a and b might overflow.  Return zero only if you are absolutely sure
 * that it won't overflow.  If in doubt, return non-zero.
 */
467

468
#if SIZEOF_VOID_P == 4
469

470
471
472
473
474
475
#ifdef WORDS_BIGENDIAN
#define RTS_CARRY_IDX__ 0
#define RTS_REM_IDX__  1
#else
#define RTS_CARRY_IDX__ 1
#define RTS_REM_IDX__ 0
sof's avatar
sof committed
476
477
#endif

478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
typedef union {
    StgInt64 l;
    StgInt32 i[2];
} long_long_u ;

#define mulIntMayOflo(a,b)			\
({                                              \
  StgInt32 r, c;				\
  long_long_u z;				\
  z.l = (StgInt64)a * (StgInt64)b;		\
  r = z.i[RTS_REM_IDX__];			\
  c = z.i[RTS_CARRY_IDX__];			\
  if (c == 0 || c == -1) {			\
    c = ((StgWord)((a^b) ^ r))			\
      >> (BITS_IN (I_) - 1);			\
  }						\
  c;                                            \
})

/* Careful: the carry calculation above is extremely delicate.  Make sure
 * you test it thoroughly after changing it.
 */

#else

503
/* Approximate version when we don't have long arithmetic (on 64-bit archs) */
504

505
506
507
/* If we have n-bit words then we have n-1 bits after accounting for the
 * sign bit, so we can fit the result of multiplying 2 (n-1)/2-bit numbers */
#define HALF_POS_INT  (((I_)1) << ((BITS_IN (I_) - 1) / 2))
508
#define HALF_NEG_INT  (-HALF_POS_INT)
509
510
511
512

#define mulIntMayOflo(a,b)			\
({                                              \
  I_ c; 					\
513
514
  if ((I_)a <= HALF_NEG_INT || a >= HALF_POS_INT    \
      || (I_)b <= HALF_NEG_INT || b >= HALF_POS_INT) {\
515
516
517
518
519
520
521
    c = 1;					\
  } else {					\
    c = 0;					\
  }						\
  c;                                            \
})
#endif
sof's avatar
sof committed
522

523
#endif /* STG_H */