| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
DDC.Core.Salt
Contents
Description
Disciple Core Salt.
This is what happens to C when you leave it out in the sun for too long.
Salt is a fragment of System-F2 that contains just those features that can be easily mapped onto C or LLVM code. It has functions, case expressions and primops, but no partial application, data types, or nested functions. All operations on algebraic data need to have been expanded to primitive store operations.
Salt exposes raw store and control primops, so its possible for functions written directly in Salt to corrupt the heap (if they are wrong).
- profile :: Profile Name
- data Name
- = NameVar !String
- | NameCon !String
- | NameExt !Name !String
- | NameObjTyCon
- | NamePrimTyCon !PrimTyCon
- | NamePrimVal !PrimVal
- data PrimTyCon
- data PrimVal
- = PrimValOp !PrimOp
- | PrimValLit !PrimLit
- pattern NamePrimOp :: PrimOp -> Name
- pattern NamePrimLit :: PrimLit -> Name
- data PrimOp
- data PrimArith
- data PrimCall
- data PrimCast
- data PrimControl
- data PrimStore
- = PrimStoreSize
- | PrimStoreSize2
- | PrimStoreCreate
- | PrimStoreCheck
- | PrimStoreRecover
- | PrimStoreAlloc
- | PrimStoreRead
- | PrimStoreWrite
- | PrimStorePlusAddr
- | PrimStoreMinusAddr
- | PrimStorePeek
- | PrimStorePeekBounded
- | PrimStorePoke
- | PrimStorePokeBounded
- | PrimStorePlusPtr
- | PrimStoreMinusPtr
- | PrimStoreMakePtr
- | PrimStoreTakePtr
- | PrimStoreCastPtr
- primCastPromoteIsValid :: Platform -> PrimTyCon -> PrimTyCon -> Bool
- primCastTruncateIsValid :: Platform -> PrimTyCon -> PrimTyCon -> Bool
- data PrimLit
- = PrimLitVoid
- | PrimLitBool !Bool
- | PrimLitNat !Integer
- | PrimLitInt !Integer
- | PrimLitSize !Integer
- | PrimLitWord !Integer !Int
- | PrimLitFloat !Double !Int
- | PrimLitChar !Char
- | PrimLitTextLit !Text
- | PrimLitTag !Integer
- pattern NameLitVoid :: Name
- pattern NameLitBool :: Bool -> Name
- pattern NameLitNat :: Integer -> Name
- pattern NameLitInt :: Integer -> Name
- pattern NameLitSize :: Integer -> Name
- pattern NameLitWord :: Integer -> Int -> Name
- pattern NameLitFloat :: Double -> Int -> Name
- pattern NameLitTextLit :: Text -> Name
- pattern NameLitTag :: Integer -> Name
- readName :: String -> Maybe Name
- takeNameVar :: Name -> Maybe String
- lexModuleString :: String -> Int -> String -> [Located (Token Name)]
- lexExpString :: String -> Int -> String -> [Located (Token Name)]
- seaOfSaltModule :: Show a => Bool -> Platform -> Module a Name -> Either (Error a) Doc
- data Error a
- = ErrorUndefined { }
- | ErrorBindNone
- | ErrorImportInvalid { }
- | ErrorTypeInvalid { }
- | ErrorNoTopLevelLetrec {
- errorModule :: Module a Name
- | ErrorFunctionInvalid { }
- | ErrorParameterInvalid { }
- | ErrorBodyInvalid { }
- | ErrorBodyMustPassControl { }
- | ErrorStmtInvalid { }
- | ErrorAltInvalid { }
- | ErrorRValueInvalid { }
- | ErrorArgInvalid { }
- | ErrorPrimCallInvalid {
- errorPrimOp :: PrimOp
- errorArgs :: [Exp a Name]
- module DDC.Core.Salt.Exp
Language profile
Names
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 # | |
| Pretty Name Source # | |
| CompoundName Name Source # | |
| NFData Name Source # | |
| FromAnnot (Pat Name) Pat Source # | |
| FromAnnot (WiCon Name) WiCon 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 # | |
| FromAnnot (DaCon Name (Type Name)) (DaCon Name (Type Name)) Source # | |
| type GAnnot Name # | |
| type GBind Name # | |
| type GBound Name # | |
| type GPrim Name # | |
Primitive type constructors.
Constructors
| PrimTyConVoid |
|
| PrimTyConBool |
|
| PrimTyConNat |
|
| PrimTyConInt |
|
| PrimTyConSize |
|
| PrimTyConWord Int |
|
| PrimTyConFloat Int |
|
| PrimTyConVec Int |
|
| PrimTyConAddr |
|
| PrimTyConPtr |
|
| PrimTyConTextLit |
|
| PrimTyConTag |
|
Primitive Values
Primitive values, meaning both operators and literals.
Constructors
| PrimValOp !PrimOp | |
| PrimValLit !PrimLit |
pattern NamePrimOp :: PrimOp -> Name Source #
pattern NamePrimLit :: PrimLit -> Name Source #
Primitive Operators
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. |
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 |
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. |
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. |
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
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 |
| 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. |
primCastPromoteIsValid Source #
Check for a valid promotion primop.
primCastTruncateIsValid Source #
Check for valid truncation primop.
Primitive Literals
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. |
| PrimLitChar !Char | A character literal. |
| PrimLitTextLit !Text | A text literal. |
| PrimLitTag !Integer | A constructor tag literal. |
pattern NameLitVoid :: Name Source #
pattern NameLitBool :: Bool -> Name Source #
pattern NameLitNat :: Integer -> Name Source #
pattern NameLitInt :: Integer -> Name Source #
pattern NameLitSize :: Integer -> Name Source #
pattern NameLitTextLit :: Text -> Name Source #
pattern NameLitTag :: Integer -> Name Source #
Name parsing
takeNameVar :: Name -> Maybe String Source #
Take the string of a non-primitive name. Supports extended names.
Program lexing
Arguments
| :: String | Source file name. |
| -> Int | Starting line number. |
| -> String | String to parse. |
| -> [Located (Token Name)] |
Lex a string to tokens, using primitive names.
Arguments
| :: String | Source file name. |
| -> Int | Starting line number. |
| -> String | String to parse. |
| -> [Located (Token Name)] |
Lex a string to tokens, using primitive names.
Conversion
Arguments
| :: Show a | |
| => Bool | Whether to emit top-level include macros. Emitting makes the code easier to read during testing. |
| -> Platform | Target platform specification |
| -> Module a Name | Module to convert. |
| -> Either (Error a) Doc |
Convert a Disciple Core Salt module to C-source text.
Things that can go wrong when converting a Disciple Core Salt module to C source text.
Constructors
| ErrorUndefined | Variable is not in scope. |
| ErrorBindNone | Binder has BNone form, binds no variable. |
| ErrorImportInvalid | Invalid import. |
Fields | |
| ErrorTypeInvalid | A local variable has an invalid type. |
| ErrorNoTopLevelLetrec | Modules must contain a top-level letrec. |
Fields
| |
| ErrorFunctionInvalid | An invalid function definition. |
| ErrorParameterInvalid | An invalid function parameter. |
| ErrorBodyInvalid | An invalid function body. |
| ErrorBodyMustPassControl | A function body that does not explicitly pass control. |
| ErrorStmtInvalid | An invalid statement. |
| ErrorAltInvalid | An invalid alternative. |
| ErrorRValueInvalid | An invalid RValue. |
| ErrorArgInvalid | An invalid function argument. |
| ErrorPrimCallInvalid | An invalid primitive call |
Fields
| |
Salt expressions
module DDC.Core.Salt.Exp