Safe Haskell	None
Language	Haskell98

DDC.Core.Salt.Name

Contents

Primitive Type Constructors
Primitive Values
Primitive Operators
Primitive Arithmetic
Primitive Calls
Primitive Casts
Primitive Control
Primitive Store
Primitive Vector
Primitive Literals
Name Parsing

Description

Names used in the Disciple Core Salt language profile.

Synopsis

Documentation

data Name Source

Names of things used in Disciple Core Salt.

Constructors

NameVar !String	A type or value variable.
NameCon !String	Constructor names.
NameExt !Name !String	An extended name.
NameObjTyCon	The abstract heap object type constructor.
NamePrimTyCon !PrimTyCon	A primitive type constructor.
NamePrimVal !PrimVal	A primitive value.

Instances

Eq Name Source
Ord Name Source
Show Name Source
CompoundName Name Source
Pretty Name Source
NFData Name Source
FromAnnot (Pat Name) Pat Source
FromAnnot (WiCon Name) WiCon Source
FromAnnot (DaCon Name) (DaCon Name) Source
FromAnnot (Bind Name) (Bind Name) Source
FromAnnot (Bound Name) (Bound Name) Source
FromAnnot (Type Name) (Type Name) Source
FromAnnot (Exp a Name) Exp Source
FromAnnot (Lets a Name) Lets Source
FromAnnot (Alt a Name) Alt Source
FromAnnot (Cast a Name) Cast Source
FromAnnot (Witness a Name) Witness Source
type GAnnot Name = ()
type GBind Name = Bind Name
type GBound Name = Bound Name
type GPrim Name = PrimOp

Primitive Type Constructors

data PrimTyCon Source

Primitive type constructors.

Constructors

PrimTyConVoid	`Void#` the Void type has no values.
PrimTyConBool	`Bool#` unboxed booleans.
PrimTyConNat	`Nat#` natural numbers. Enough precision to count every object in the heap, but NOT necessearily enough precision to count every byte of memory.
PrimTyConInt	`Int#` signed integers. Enough precision to count every object in the heap, but NOT necessearily enough precision to count every byte of memory. If N is the total number of objects that can exist in the heap, then the range of `Int#` is at least (-N .. +N) inclusive.
PrimTyConSize	`Size#` unsigned sizes. Enough precision to count every addressable bytes of memory.
PrimTyConWord Int	`WordN#` machine words of the given width.
PrimTyConFloat Int	`FloatN#` floating point numbers of the given width.
PrimTyConVec Int	`VecN#` a packed vector of N values. This is intended to have kind (Data -> Data), so we use concrete vector types like `Vec4`.
PrimTyConAddr	`Addr#` a relative or absolute machine address. Enough precision to count every byte of memory. Unlike pointers below, an absolute `Addr#` need not refer to memory owned by the current process.
PrimTyConPtr	`Ptr#` like `Addr#`, but with a region and element type annotation. In particular, a value of a type like (Ptr) must be at least 4-byte aligned and point to memory owned by the current process.
PrimTyConTextLit	`TextLit#` type of a text literal, which is represented as a pointer to the literal data in static memory.
PrimTyConTag	`Tag#` data constructor tags. Enough precision to count every possible alternative of an enumerated type.

Instances

Eq PrimTyCon Source
Ord PrimTyCon Source
Show PrimTyCon Source
Pretty PrimTyCon Source
NFData PrimTyCon Source

pprPrimTyConStem :: PrimTyCon -> Doc Source

Pretty print a primitive type constructor, without the '#' suffix.

readPrimTyCon :: String -> Maybe PrimTyCon Source

Read a primitive type constructor.

Words are limited to 8, 16, 32, or 64 bits.

Floats are limited to 32 or 64 bits.

readPrimTyConStem :: String -> Maybe PrimTyCon Source

Read a primitive type constructor, without the '#' suffix.

primTyConIsIntegral :: PrimTyCon -> Bool Source

Integral constructors are the ones that we can reasonably convert from integers of the same size.

These are Bool#, Nat#, Int#, Size, WordN# and Tag#.

primTyConIsFloating :: PrimTyCon -> Bool Source

Floating point types.

These are FloatN#.

primTyConIsUnsigned :: PrimTyCon -> Bool Source

Unsigned types.

These are Bool# Nat# Size# WordN Tag.

primTyConIsSigned :: PrimTyCon -> Bool Source

Signed integral constructors.

This is just Int.

primTyConWidth :: Platform -> PrimTyCon -> Maybe Integer Source

Get the representation width of a primitive type constructor, in bits. This is how much space it takes up in an object payload.

Bools are representable with a single bit, but we unpack them into a whole word.

The constructors Void and VecN# and String have no width.

Primitive Values

data PrimVal Source

Primitive values, meaning both operators and literals.

Constructors

PrimValOp !PrimOp
PrimValLit !PrimLit

Instances

Eq PrimVal Source
Ord PrimVal Source
Show PrimVal Source
Pretty PrimVal Source
NFData PrimVal Source

readPrimVal :: String -> Maybe PrimVal Source

Read a primitive value.

pattern NamePrimOp :: PrimOp -> Name Source

pattern NamePrimLit :: PrimLit -> Name Source

Primitive Operators

data PrimOp Source

Primitive operators implemented directly by the machine or runtime system.

Constructors

PrimArith !PrimArith	Arithmetic, logic, comparison and bit-wise operators.
PrimCast !PrimCast	Casting between numeric types.
PrimStore !PrimStore	Raw store access.
PrimCall !PrimCall	Special function calling conventions.
PrimControl !PrimControl	Non-functional control flow.

Instances

Eq PrimOp Source
Ord PrimOp Source
Show PrimOp Source
Pretty PrimOp Source
NFData PrimOp Source

readPrimOp :: String -> Maybe PrimOp Source

Read a primitive operator.

Primitive Arithmetic

data PrimArith Source

Primitive arithmetic, logic, and comparison opretors. We expect the backend/machine to be able to implement these directly.

For the Shift Right operator, the type that it is used at determines whether it is an arithmetic (with sign-extension) or logical (no sign-extension) shift.

Constructors

PrimArithNeg	Negation
PrimArithAdd	Addition
PrimArithSub	Subtraction
PrimArithMul	Multiplication
PrimArithDiv	Division
PrimArithMod	Modulus
PrimArithRem	Remainder
PrimArithEq	Equality
PrimArithNeq	Negated Equality
PrimArithGt	Greater Than
PrimArithGe	Greater Than or Equal
PrimArithLt	Less Than
PrimArithLe	Less Than or Equal
PrimArithAnd	Boolean And
PrimArithOr	Boolean Or
PrimArithShl	Shift Left
PrimArithShr	Shift Right
PrimArithBAnd	Bit-wise And
PrimArithBOr	Bit-wise Or
PrimArithBXOr	Bit-wise eXclusive Or

Instances

Eq PrimArith Source
Ord PrimArith Source
Show PrimArith Source
Pretty PrimArith Source
NFData PrimArith Source

readPrimArith :: String -> Maybe PrimArith Source

Read a primitive operator.

Primitive Calls

data PrimCall Source

Primitive ways of invoking a function, where control flow returns back to the caller.

Constructors

PrimCallStd Int	Perform a standard function call where the address is not statically known. All the arguments are boxed heap objects.
PrimCallTail Int	Tailcall a statically known functions, where the arguments can be boxed or unboxed.

Instances

Eq PrimCall Source
Ord PrimCall Source
Show PrimCall Source
Pretty PrimCall Source
NFData PrimCall Source

readPrimCall :: String -> Maybe PrimCall Source

Primitive Casts

data PrimCast Source

Primitive cast between two types.

The exact set of available casts is determined by the target platform. For example, you can only promote a Nat# to a Word32# on a 32-bit system. On a 64-bit system the Nat# type is 64-bits wide, so casting it to a Word32# would be a truncation.

Constructors

PrimCastConvert	Convert a value to a new representation with the same precision.
PrimCastPromote	Promote a value to one of similar or larger width, without loss of precision.
PrimCastTruncate	Truncate a value to a new width, possibly losing precision.

Instances

Eq PrimCast Source
Ord PrimCast Source
Show PrimCast Source
Pretty PrimCast Source
NFData PrimCast Source

readPrimCast :: String -> Maybe PrimCast Source

primCastPromoteIsValid Source

Arguments

:: Platform	Target platform.
-> PrimTyCon	Source type.
-> PrimTyCon	Destination type.
-> Bool

Check for a valid promotion primop.

primCastTruncateIsValid Source

Arguments

:: Platform	Target platform.
-> PrimTyCon	Source type.
-> PrimTyCon	Destination type.
-> Bool

Check for valid truncation primop.

Primitive Control

data PrimControl Source

Primitive non-returning control flow.

Constructors

PrimControlFail	Ungraceful failure -- just abort the program. This is called on internal errors in the runtime system. There is no further debugging info provided, so you'll need to look at the stack trace to debug it.
PrimControlReturn	Return from the enclosing function with the given value.

Instances

Eq PrimControl Source
Ord PrimControl Source
Show PrimControl Source
Pretty PrimControl Source
NFData PrimControl Source

readPrimControl :: String -> Maybe PrimControl Source

Primitive Store

data PrimStore Source

Raw access to the store.

Constructors

PrimStoreSize	Number of bytes needed to store a value of a primitive type.
PrimStoreSize2	Log2 of number of bytes need to store a value of a primitive type.
PrimStoreCreate	Create a heap of the given size. This must be called before `alloc#` below, and has global side effect. Calling it twice in the same program is undefined.
PrimStoreCheck	Check whether there are at least this many bytes still available on the heap.
PrimStoreRecover	Force a garbage collection to recover at least this many bytes.
PrimStoreAlloc	Allocate some space on the heap. There must be enough space available, else undefined.
PrimStoreRead	Read a value from the store at the given address and offset.
PrimStoreWrite	Write a value to the store at the given address and offset.
PrimStorePlusAddr	Add an offset in bytes to an address.
PrimStoreMinusAddr	Subtract an offset in bytes from an address.
PrimStorePeek	Read a value from a pointer plus offset.
PrimStorePeekBounded	Read a value from a pointer plus offset, with an integrated bounds check.
PrimStorePoke	Write a value to a pointer plus given offset.
PrimStorePokeBounded	Write a value to a pointer plus offset, with an integrated bounds check.
PrimStorePlusPtr	Add an offset in bytes to a pointer.
PrimStoreMinusPtr	Subtract an offset in bytes from a pointer.
PrimStoreMakePtr	Convert an raw address to a pointer.
PrimStoreTakePtr	Convert a pointer to a raw address.
PrimStoreCastPtr	Cast between pointer types.

Instances

Eq PrimStore Source
Ord PrimStore Source
Show PrimStore Source
Pretty PrimStore Source
NFData PrimStore Source

readPrimStore :: String -> Maybe PrimStore Source

Primitive Vector

data PrimVec Source

Primitive fixed-length SIMD vector operators.

Constructors

PrimVecNeg	Negate elements of a vector.
Fields primVecMulti :: Int
PrimVecAdd	Add elements of a vector.
Fields primVecMulti :: Int
PrimVecSub	Subtract elements of a vector.
Fields primVecMulti :: Int
PrimVecMul	Multiply elements of a vector.
Fields primVecMulti :: Int
PrimVecDiv	Divide elements of a vector.
Fields primVecMulti :: Int
PrimVecRep	Replicate a scalar into a vector.
Fields primVecMulti :: Int
PrimVecPack	Pack multiple scalars into a vector
Fields primVecMulti :: Int
PrimVecProj	Extract a single element from a vector.
Fields primVecMulti :: Int primVecIndex :: Int
PrimVecGather	Read multiple elements from memory.
Fields primVecMulti :: Int
PrimVecScatter	Write multiple elements to memory.
Fields primVecMulti :: Int

Instances

Eq PrimVec Source
Ord PrimVec Source
Show PrimVec Source
Pretty PrimVec Source
NFData PrimVec Source

readPrimVec :: String -> Maybe PrimVec Source

Read a primitive vector operator.

multiOfPrimVec :: PrimVec -> Maybe Int Source

Yield the multiplicity of a vector operator.

liftPrimArithToVec :: Int -> PrimArith -> Maybe PrimVec Source

Yield the PrimVector that corresponds to a PrimArith of the given multiplicity, if any.

lowerPrimVecToArith :: PrimVec -> Maybe PrimArith Source

Yield the PrimArith that corresponds to a PrimVector, if any.

Primitive Literals

data PrimLit Source

Primitive literals.

Constructors

PrimLitVoid	The void literal.
PrimLitBool !Bool	A boolean literal.
PrimLitNat !Integer	A natural number literal.
PrimLitInt !Integer	An integer number literal.
PrimLitSize !Integer	A size literal.
PrimLitWord !Integer !Int	A word literal, of the given width.
PrimLitFloat !Double !Int	A floating point literal, of the given width.
PrimLitTextLit !Text	A text literal.
PrimLitTag !Integer	A constructor tag literal.