MachDeps.h 3.95 KB
Newer Older
1 2
/* -----------------------------------------------------------------------------
 *
3
 * (c) The University of Glasgow 2002
4
 *
5
 * Definitions that characterise machine specific properties of basic
6
 * types (C & Haskell) of a target platform.
7
 *
8
 * NB: Keep in sync with HsFFI.h and StgTypes.h.
9
 * NB: THIS FILE IS INCLUDED IN HASKELL SOURCE!
10 11
 *
 * To understand the structure of the RTS headers, see the wiki:
12
 *   http://ghc.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
13
 *
14 15
 * ---------------------------------------------------------------------------*/

16
#pragma once
17

18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
/* Don't allow stage1 (cross-)compiler embed assumptions about target
 * platform. When ghc-stage1 is being built by ghc-stage0 is should not
 * refer to target defines. A few past examples:
 *  - https://ghc.haskell.org/trac/ghc/ticket/13491
 *  - https://phabricator.haskell.org/D3122
 *  - https://phabricator.haskell.org/D3405
 *
 * In those cases code change assumed target defines like SIZEOF_HSINT
 * are applied to host platform, not target platform.
 *
 * So what should be used instead in STAGE=1?
 *
 * To get host's equivalent of SIZEOF_HSINT you can use Bits instances:
 *    Data.Bits.finiteBitSize (0 :: Int)
 *
 * To get target's values it is preferred to use runtime target
 * configuration from 'targetPlatform :: DynFlags -> Platform'
 * record. A few wrappers are already defined and used throughout GHC:
 *    wORD_SIZE :: DynFlags -> Int
 *    wORD_SIZE dflags = pc_WORD_SIZE (sPlatformConstants (settings dflags))
 *
 * Hence we hide these macros from -DSTAGE=1
 */
#if !defined(STAGE) || STAGE >= 2

43
/* Sizes of C types come from here... */
44
#include "ghcautoconf.h"
45

46 47 48 49 50 51 52 53
/* Sizes of Haskell types follow.  These sizes correspond to:
 *   - the number of bytes in the primitive type (eg. Int#)
 *   - the number of bytes in the external representation (eg. HsInt)
 *   - the scale offset used by writeFooOffAddr#
 *
 * In the heap, the type may take up more space: eg. SIZEOF_INT8 == 1,
 * but it takes up SIZEOF_HSWORD (4 or 8) bytes in the heap.
 */
apt's avatar
apt committed
54

55 56 57 58 59 60
#define SIZEOF_HSCHAR           SIZEOF_WORD32
#define ALIGNMENT_HSCHAR        ALIGNMENT_WORD32

#define SIZEOF_HSINT            SIZEOF_VOID_P
#define ALIGNMENT_HSINT         ALIGNMENT_VOID_P

dterei's avatar
dterei committed
61 62
#define SIZEOF_HSWORD           SIZEOF_VOID_P
#define ALIGNMENT_HSWORD        ALIGNMENT_VOID_P
63

dterei's avatar
dterei committed
64 65
#define SIZEOF_HSDOUBLE         SIZEOF_DOUBLE
#define ALIGNMENT_HSDOUBLE      ALIGNMENT_DOUBLE
66

dterei's avatar
dterei committed
67 68
#define SIZEOF_HSFLOAT          SIZEOF_FLOAT
#define ALIGNMENT_HSFLOAT       ALIGNMENT_FLOAT
69 70 71 72 73 74 75 76 77

#define SIZEOF_HSPTR            SIZEOF_VOID_P
#define ALIGNMENT_HSPTR         ALIGNMENT_VOID_P

#define SIZEOF_HSFUNPTR         SIZEOF_VOID_P
#define ALIGNMENT_HSFUNPTR      ALIGNMENT_VOID_P

#define SIZEOF_HSSTABLEPTR      SIZEOF_VOID_P
#define ALIGNMENT_HSSTABLEPTR   ALIGNMENT_VOID_P
78

79 80
#define SIZEOF_INT8             SIZEOF_INT8_T
#define ALIGNMENT_INT8          ALIGNMENT_INT8_T
81

82 83
#define SIZEOF_WORD8            SIZEOF_UINT8_T
#define ALIGNMENT_WORD8         ALIGNMENT_UINT8_T
84

85 86
#define SIZEOF_INT16            SIZEOF_INT16_T
#define ALIGNMENT_INT16         ALIGNMENT_INT16_T
87

88 89
#define SIZEOF_WORD16           SIZEOF_UINT16_T
#define ALIGNMENT_WORD16        ALIGNMENT_UINT16_T
90

91 92
#define SIZEOF_INT32            SIZEOF_INT32_T
#define ALIGNMENT_INT32         ALIGNMENT_INT32_T
93

94 95
#define SIZEOF_WORD32           SIZEOF_UINT32_T
#define ALIGNMENT_WORD32        ALIGNMENT_UINT32_T
96

97 98 99 100 101
#define SIZEOF_INT64            SIZEOF_INT64_T
#define ALIGNMENT_INT64         ALIGNMENT_INT64_T

#define SIZEOF_WORD64           SIZEOF_UINT64_T
#define ALIGNMENT_WORD64        ALIGNMENT_UINT64_T
102

Ben Gamari's avatar
Ben Gamari committed
103
#if !defined(WORD_SIZE_IN_BITS)
104 105
#if SIZEOF_HSWORD == 4
#define WORD_SIZE_IN_BITS       32
Austin Seipp's avatar
Austin Seipp committed
106
#define WORD_SIZE_IN_BITS_FLOAT 32.0
107
#else
108
#define WORD_SIZE_IN_BITS       64
Austin Seipp's avatar
Austin Seipp committed
109
#define WORD_SIZE_IN_BITS_FLOAT 64.0
110
#endif
111
#endif
112

Ben Gamari's avatar
Ben Gamari committed
113
#if !defined(TAG_BITS)
Simon Marlow's avatar
Simon Marlow committed
114 115
#if SIZEOF_HSWORD == 4
#define TAG_BITS                2
116
#else
Simon Marlow's avatar
Simon Marlow committed
117 118 119 120 121 122
#define TAG_BITS                3
#endif
#endif

#define TAG_MASK ((1 << TAG_BITS) - 1)

123
#endif /* !defined(STAGE) || STAGE >= 2 */