GHC.Types.RepType

ghc-lib-parser-9.10.1.20250103: The GHC API, decoupled from GHC versions

Safe Haskell | Ignore
Language | GHC2021

GHC.Types.RepType

Contents

- Code generator views onto Types
- Predicates on types
- Type representation for the code generator
- Unboxed sum representation type
- Is this type known to be data?

Synopsis

- type UnaryType = Type
- type NvUnaryType = Type
- isNvUnaryRep :: [PrimRep] -> Bool
- unwrapType :: Type -> Type
- isZeroBitTy :: HasDebugCallStack => Type -> Bool
- typePrimRep :: HasDebugCallStack => Type -> [PrimRep]
- typePrimRep1 :: HasDebugCallStack => UnaryType -> PrimOrVoidRep
- typePrimRepU :: HasDebugCallStack => NvUnaryType -> PrimRep
- runtimeRepPrimRep :: HasDebugCallStack => SDoc -> RuntimeRepType -> [PrimRep]
- data PrimRep
  - = BoxedRep !(Maybe Levity)
  - | Int8Rep
  - | Int16Rep
  - | Int32Rep
  - | Int64Rep
  - | IntRep
  - | Word8Rep
  - | Word16Rep
  - | Word32Rep
  - | Word64Rep
  - | WordRep
  - | AddrRep
  - | FloatRep
  - | DoubleRep
  - | VecRep Int PrimElemRep
- primRepToRuntimeRep :: PrimRep -> RuntimeRepType
- primRepToType :: PrimRep -> Type
- countFunRepArgs :: Arity -> Type -> RepArity
- countConRepArgs :: DataCon -> RepArity
- dataConRuntimeRepStrictness :: HasDebugCallStack => DataCon -> [StrictnessMark]
- tyConPrimRep :: HasDebugCallStack => TyCon -> [PrimRep]
- runtimeRepPrimRep_maybe :: Type -> Maybe [PrimRep]
- kindPrimRep_maybe :: HasDebugCallStack => Kind -> Maybe [PrimRep]
- typePrimRep_maybe :: Type -> Maybe [PrimRep]
- ubxSumRepType :: [[PrimRep]] -> NonEmpty SlotTy
- layoutUbxSum :: HasDebugCallStack => SortedSlotTys -> [SlotTy] -> [Int]
- repSlotTy :: [PrimRep] -> Maybe SlotTy
- data SlotTy
  - = PtrLiftedSlot
  - | PtrUnliftedSlot
  - | WordSlot
  - | Word64Slot
  - | FloatSlot
  - | DoubleSlot
  - | VecSlot Int PrimElemRep
- slotPrimRep :: SlotTy -> PrimRep
- primRepSlot :: PrimRep -> SlotTy
- mightBeFunTy :: Type -> Bool

# Code generator views onto Types

type UnaryType = Type #

type NvUnaryType = Type #

isNvUnaryRep :: [PrimRep] -> Bool #

unwrapType :: Type -> Type #

Gets rid of the stuff that prevents us from understanding the runtime representation of a type. Including: 1. Casts 2. Newtypes 3. Foralls 4. Synonyms But not type/data families, because we don't have the envs to hand.

# Predicates on types

isZeroBitTy :: HasDebugCallStack => Type -> Bool #

True if the type has zero width.

# Type representation for the code generator

typePrimRep :: HasDebugCallStack => Type -> [PrimRep] #

Discovers the primitive representation of a `Type`. Returns a list of `PrimRep`: it's a list because of the possibility of no runtime representation (void) or multiple (unboxed tuple/sum) See also Note [Getting from RuntimeRep to PrimRep]

typePrimRep1 :: HasDebugCallStack => UnaryType -> PrimOrVoidRep #

Like `typePrimRep`, but assumes that there is at most one `PrimRep` output; an empty list of PrimReps becomes a VoidRep. This assumption holds after unarise, see Note [Post-unarisation invariants]. Before unarise it may or may not hold. See also Note [RuntimeRep and PrimRep] and Note [VoidRep]

typePrimRepU :: HasDebugCallStack => NvUnaryType -> PrimRep #

runtimeRepPrimRep :: HasDebugCallStack => SDoc -> RuntimeRepType -> [PrimRep] #

Take a type of kind RuntimeRep and extract the list of `PrimRep` that it encodes. See also Note [Getting from RuntimeRep to PrimRep]. The `[PrimRep]` is the final runtime representation after unarisation.

data PrimRep #

A `PrimRep` is an abstraction of a non-void type. (Use `PrimRepOrVoidRep` if you want void types too.) It contains information that the code generator needs in order to pass arguments, return results, and store values of this type. See also Note [RuntimeRep and PrimRep] in GHC.Types.RepType and Note [VoidRep] in GHC.Types.RepType.

Constructors

BoxedRep !(Maybe Levity) | Boxed, heap value
Int8Rep | Signed, 8-bit value
Int16Rep | Signed, 16-bit value
Int32Rep | Signed, 32-bit value
Int64Rep | Signed, 64 bit value
IntRep | Signed, word-sized value
Word8Rep | Unsigned, 8 bit value
Word16Rep | Unsigned, 16 bit value
Word32Rep | Unsigned, 32 bit value
Word64Rep | Unsigned, 64 bit value
WordRep | Unsigned, word-sized value
AddrRep | A pointer, but not to a Haskell value (use `BoxedRep`)
FloatRep |
DoubleRep |
VecRep Int PrimElemRep | A vector

#### Instances

Instances details

Data PrimRep # |
Instance details Defined in GHC.Core.TyCon Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PrimRep -> c PrimRep # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PrimRep # toConstr :: PrimRep -> Constr # dataTypeOf :: PrimRep -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PrimRep) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PrimRep) # gmapT :: (forall b. Data b => b -> b) -> PrimRep -> PrimRep # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PrimRep -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PrimRep -> r # gmapQ :: (forall d. Data d => d -> u) -> PrimRep -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PrimRep -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PrimRep -> m PrimRep # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PrimRep -> m PrimRep # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PrimRep -> m PrimRep #
Show PrimRep # |
Instance details Defined in GHC.Core.TyCon Methods showsPrec :: Int -> PrimRep -> ShowS # show :: PrimRep -> String # showList :: [PrimRep] -> ShowS #
Binary PrimRep # |
Instance details Defined in GHC.Core.TyCon Methods put_ :: BinHandle -> PrimRep -> IO () # put :: BinHandle -> PrimRep -> IO (Bin PrimRep) # get :: BinHandle -> IO PrimRep #
Outputable PrimRep # |
Instance details Defined in GHC.Core.TyCon Methods ppr :: PrimRep -> SDoc #
Eq PrimRep # |
Instance details Defined in GHC.Core.TyCon Methods (==) :: PrimRep -> PrimRep -> Bool # (/=) :: PrimRep -> PrimRep -> Bool #
Ord PrimRep # |
Instance details Defined in GHC.Core.TyCon Methods compare :: PrimRep -> PrimRep -> Ordering # (<) :: PrimRep -> PrimRep -> Bool # (<=) :: PrimRep -> PrimRep -> Bool # (>) :: PrimRep -> PrimRep -> Bool # (>=) :: PrimRep -> PrimRep -> Bool # max :: PrimRep -> PrimRep -> PrimRep # min :: PrimRep -> PrimRep -> PrimRep #

primRepToRuntimeRep :: PrimRep -> RuntimeRepType #

Convert a `PrimRep` to a `Type` of kind RuntimeRep

primRepToType :: PrimRep -> Type #

Convert a PrimRep back to a Type. Used only in the unariser to give types to fresh Ids. Really, only the type's representation matters. See also Note [RuntimeRep and PrimRep]

countFunRepArgs :: Arity -> Type -> RepArity #

Count the arity of a function post-unarisation, including zero-width arguments.

The post-unarisation arity may be larger than the arity of the original function type. See Note [Unarisation].

countConRepArgs :: DataCon -> RepArity #

dataConRuntimeRepStrictness :: HasDebugCallStack => DataCon -> [StrictnessMark] #

Give the demands on the arguments of a Core constructor application (Con dc args) at runtime. Assumes the constructor is not levity polymorphic. For example unboxed tuples won't work.

tyConPrimRep :: HasDebugCallStack => TyCon -> [PrimRep] #

Find the runtime representation of a `TyCon`. Defined here to avoid module loops. Returns a list of the register shapes necessary. See also Note [Getting from RuntimeRep to PrimRep]

runtimeRepPrimRep_maybe :: Type -> Maybe [PrimRep] #

Take a type of kind RuntimeRep and extract the list of `PrimRep` that it encodes. See also Note [Getting from RuntimeRep to PrimRep]. The `[PrimRep]` is the final runtime representation after unarisation.

Returns `Nothing` if rep can't be determined. Eg. levity polymorphic types.

kindPrimRep_maybe :: HasDebugCallStack => Kind -> Maybe [PrimRep] #

Take a kind (of shape `TYPE rr` or `CONSTRAINT rr`) and produce the `PrimRep`s of values of types of this kind. See also Note [Getting from RuntimeRep to PrimRep] Returns Nothing if rep can't be determined. Eg. levity polymorphic types.

typePrimRep_maybe :: Type -> Maybe [PrimRep] #

Discovers the primitive representation of a `Type`. Returns a list of `PrimRep`: it's a list because of the possibility of no runtime representation (void) or multiple (unboxed tuple/sum) See also Note [Getting from RuntimeRep to PrimRep] Returns Nothing if rep can't be determined. Eg. levity polymorphic types.

# Unboxed sum representation type

ubxSumRepType :: [[PrimRep]] -> NonEmpty SlotTy #

Given the arguments of a sum type constructor application, return the unboxed sum rep type.

E.g.

(# Int# | Maybe Int | (# Int#, Float# #) #)

We call `ubxSumRepType [ [IntRep], [LiftedRep], [IntRep, FloatRep] ]`, which returns [WordSlot, PtrSlot, WordSlot, FloatSlot]

INVARIANT: Result slots are sorted (via Ord SlotTy), except that at the head of the list we have the slot for the tag.

layoutUbxSum :: HasDebugCallStack => SortedSlotTys -> [SlotTy] -> [Int] #

repSlotTy :: [PrimRep] -> Maybe SlotTy #

data SlotTy #

Constructors

PtrLiftedSlot |
PtrUnliftedSlot |
WordSlot |
Word64Slot |
FloatSlot |
DoubleSlot |
VecSlot Int PrimElemRep |

#### Instances

Instances details

Outputable SlotTy # |
Instance details Defined in GHC.Types.RepType Methods ppr :: SlotTy -> SDoc #
Eq SlotTy # |
Instance details Defined in GHC.Types.RepType Methods (==) :: SlotTy -> SlotTy -> Bool # (/=) :: SlotTy -> SlotTy -> Bool #
Ord SlotTy # |
Instance details Defined in GHC.Types.RepType Methods compare :: SlotTy -> SlotTy -> Ordering # (<) :: SlotTy -> SlotTy -> Bool # (<=) :: SlotTy -> SlotTy -> Bool # (>) :: SlotTy -> SlotTy -> Bool # (>=) :: SlotTy -> SlotTy -> Bool # max :: SlotTy -> SlotTy -> SlotTy # min :: SlotTy -> SlotTy -> SlotTy #

slotPrimRep :: SlotTy -> PrimRep #

primRepSlot :: PrimRep -> SlotTy #

# Is this type known to be data?

mightBeFunTy :: Type -> Bool #