LLVM.Extra.Storable

Transfer values between Haskell and JIT generated code in a Haskell-compatible format as dictated by the Storable class. E.g. instance Bool may use more than a byte (e.g. Word32). For tuples, you may use the Tuple wrapper from the storable-record package. The Storable instance for Vectors is compatible with arrays, i.e. indices always count upwards irrespective of machine endianess and tuple elements are interleaved.

Basic class

class (Storable a, Value a, Phi (ValueOf a), Undefined (ValueOf a)) => C a where

Methods

load :: Value (Ptr a) -> CodeGenFunction r (ValueOf a)

store :: ValueOf a -> Value (Ptr a) -> CodeGenFunction r ()

Instances

C Int16

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Int16) -> CodeGenFunction r (ValueOf Int16)

store :: ValueOf Int16 -> Value (Ptr Int16) -> CodeGenFunction r ()

C Int32

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Int32) -> CodeGenFunction r (ValueOf Int32)

store :: ValueOf Int32 -> Value (Ptr Int32) -> CodeGenFunction r ()

C Int64

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Int64) -> CodeGenFunction r (ValueOf Int64)

store :: ValueOf Int64 -> Value (Ptr Int64) -> CodeGenFunction r ()

C Int8

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Int8) -> CodeGenFunction r (ValueOf Int8)

store :: ValueOf Int8 -> Value (Ptr Int8) -> CodeGenFunction r ()

C Word16

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Word16) -> CodeGenFunction r (ValueOf Word16)

store :: ValueOf Word16 -> Value (Ptr Word16) -> CodeGenFunction r ()

C Word32

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Word32) -> CodeGenFunction r (ValueOf Word32)

store :: ValueOf Word32 -> Value (Ptr Word32) -> CodeGenFunction r ()

C Word64

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Word64) -> CodeGenFunction r (ValueOf Word64)

store :: ValueOf Word64 -> Value (Ptr Word64) -> CodeGenFunction r ()

C Word8

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Word8) -> CodeGenFunction r (ValueOf Word8)

store :: ValueOf Word8 -> Value (Ptr Word8) -> CodeGenFunction r ()

C Bool8

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Bool8) -> CodeGenFunction r (ValueOf Bool8)

store :: ValueOf Bool8 -> Value (Ptr Bool8) -> CodeGenFunction r ()

C ()

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr ()) -> CodeGenFunction r (ValueOf ())

store :: ValueOf () -> Value (Ptr ()) -> CodeGenFunction r ()

C Bool

Not very efficient implementation because we want to adapt to sizeOf Bool dynamically. Unfortunately, LLVM-9's optimizer does not recognize the instruction pattern. Better use Bool8 for booleans.

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Bool) -> CodeGenFunction r (ValueOf Bool)

store :: ValueOf Bool -> Value (Ptr Bool) -> CodeGenFunction r ()

C Double

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Double) -> CodeGenFunction r (ValueOf Double)

store :: ValueOf Double -> Value (Ptr Double) -> CodeGenFunction r ()

C Float

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Float) -> CodeGenFunction r (ValueOf Float)

store :: ValueOf Float -> Value (Ptr Float) -> CodeGenFunction r ()

C Int

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Int) -> CodeGenFunction r (ValueOf Int)

store :: ValueOf Int -> Value (Ptr Int) -> CodeGenFunction r ()

C Word

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr Word) -> CodeGenFunction r (ValueOf Word)

store :: ValueOf Word -> Value (Ptr Word) -> CodeGenFunction r ()

C a => C (Complex a)

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr (Complex a)) -> CodeGenFunction r (ValueOf (Complex a))

store :: ValueOf (Complex a) -> Value (Ptr (Complex a)) -> CodeGenFunction r ()

Tuple tuple => C (Tuple tuple)

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr (Tuple tuple)) -> CodeGenFunction r (ValueOf (Tuple tuple))

store :: ValueOf (Tuple tuple) -> Value (Ptr (Tuple tuple)) -> CodeGenFunction r ()

(Positive n, Vector a, VectorValue n a, Phi (VectorValueOf n a)) => C (Vector n a)

Defined in LLVM.Extra.Storable.Private

Methods

load :: Value (Ptr (Vector n a)) -> CodeGenFunction r (ValueOf (Vector n a))

store :: ValueOf (Vector n a) -> Value (Ptr (Vector n a)) -> CodeGenFunction r ()

storeNext :: (C a, ValueOf a ~ al, Value (Ptr a) ~ ptr) => al -> ptr -> CodeGenFunction r ptr

modify :: (C a, ValueOf a ~ al) => (al -> CodeGenFunction r al) -> Value (Ptr a) -> CodeGenFunction r ()

Classes for tuples and vectors

class (Storable tuple, Value tuple, Phi (ValueOf tuple), Undefined (ValueOf tuple)) => Tuple tuple where

Methods

loadTuple :: Value (Ptr (Tuple tuple)) -> CodeGenFunction r (ValueOf tuple)

storeTuple :: ValueOf tuple -> Value (Ptr (Tuple tuple)) -> CodeGenFunction r ()

Instances

(C a, C b) => Tuple (a, b)

Defined in LLVM.Extra.Storable.Private

Methods

loadTuple :: Value (Ptr (Tuple (a, b))) -> CodeGenFunction r (ValueOf (a, b))

storeTuple :: ValueOf (a, b) -> Value (Ptr (Tuple (a, b))) -> CodeGenFunction r ()

(C a, C b, C c) => Tuple (a, b, c)

Defined in LLVM.Extra.Storable.Private

Methods

loadTuple :: Value (Ptr (Tuple (a, b, c))) -> CodeGenFunction r (ValueOf (a, b, c))

storeTuple :: ValueOf (a, b, c) -> Value (Ptr (Tuple (a, b, c))) -> CodeGenFunction r ()

class C a => Vector a where

Methods

assembleVector :: Positive n => Proxy a -> Vector n (ValueOf a) -> CodeGenFunction r (VectorValueOf n a)

disassembleVector :: Positive n => Proxy a -> VectorValueOf n a -> CodeGenFunction r (Vector n (ValueOf a))

Instances

Vector Int16

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Int16 -> Vector n (ValueOf Int16) -> CodeGenFunction r (VectorValueOf n Int16)

disassembleVector :: Positive n => Proxy Int16 -> VectorValueOf n Int16 -> CodeGenFunction r (Vector n (ValueOf Int16))

Vector Int32

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Int32 -> Vector n (ValueOf Int32) -> CodeGenFunction r (VectorValueOf n Int32)

disassembleVector :: Positive n => Proxy Int32 -> VectorValueOf n Int32 -> CodeGenFunction r (Vector n (ValueOf Int32))

Vector Int64

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Int64 -> Vector n (ValueOf Int64) -> CodeGenFunction r (VectorValueOf n Int64)

disassembleVector :: Positive n => Proxy Int64 -> VectorValueOf n Int64 -> CodeGenFunction r (Vector n (ValueOf Int64))

Vector Int8

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Int8 -> Vector n (ValueOf Int8) -> CodeGenFunction r (VectorValueOf n Int8)

disassembleVector :: Positive n => Proxy Int8 -> VectorValueOf n Int8 -> CodeGenFunction r (Vector n (ValueOf Int8))

Vector Word16

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Word16 -> Vector n (ValueOf Word16) -> CodeGenFunction r (VectorValueOf n Word16)

disassembleVector :: Positive n => Proxy Word16 -> VectorValueOf n Word16 -> CodeGenFunction r (Vector n (ValueOf Word16))

Vector Word32

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Word32 -> Vector n (ValueOf Word32) -> CodeGenFunction r (VectorValueOf n Word32)

disassembleVector :: Positive n => Proxy Word32 -> VectorValueOf n Word32 -> CodeGenFunction r (Vector n (ValueOf Word32))

Vector Word64

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Word64 -> Vector n (ValueOf Word64) -> CodeGenFunction r (VectorValueOf n Word64)

disassembleVector :: Positive n => Proxy Word64 -> VectorValueOf n Word64 -> CodeGenFunction r (Vector n (ValueOf Word64))

Vector Word8

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Word8 -> Vector n (ValueOf Word8) -> CodeGenFunction r (VectorValueOf n Word8)

disassembleVector :: Positive n => Proxy Word8 -> VectorValueOf n Word8 -> CodeGenFunction r (Vector n (ValueOf Word8))

Vector Bool8

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Bool8 -> Vector n (ValueOf Bool8) -> CodeGenFunction r (VectorValueOf n Bool8)

disassembleVector :: Positive n => Proxy Bool8 -> VectorValueOf n Bool8 -> CodeGenFunction r (Vector n (ValueOf Bool8))

Vector Bool

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Bool -> Vector n (ValueOf Bool) -> CodeGenFunction r (VectorValueOf n Bool)

disassembleVector :: Positive n => Proxy Bool -> VectorValueOf n Bool -> CodeGenFunction r (Vector n (ValueOf Bool))

Vector Double

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Double -> Vector n (ValueOf Double) -> CodeGenFunction r (VectorValueOf n Double)

disassembleVector :: Positive n => Proxy Double -> VectorValueOf n Double -> CodeGenFunction r (Vector n (ValueOf Double))

Vector Float

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Float -> Vector n (ValueOf Float) -> CodeGenFunction r (VectorValueOf n Float)

disassembleVector :: Positive n => Proxy Float -> VectorValueOf n Float -> CodeGenFunction r (Vector n (ValueOf Float))

Vector Int

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Int -> Vector n (ValueOf Int) -> CodeGenFunction r (VectorValueOf n Int)

disassembleVector :: Positive n => Proxy Int -> VectorValueOf n Int -> CodeGenFunction r (Vector n (ValueOf Int))

Vector Word

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy Word -> Vector n (ValueOf Word) -> CodeGenFunction r (VectorValueOf n Word)

disassembleVector :: Positive n => Proxy Word -> VectorValueOf n Word -> CodeGenFunction r (Vector n (ValueOf Word))

(Tuple tuple, TupleVector tuple) => Vector (Tuple tuple)

Defined in LLVM.Extra.Storable.Private

Methods

assembleVector :: Positive n => Proxy (Tuple tuple) -> Vector n (ValueOf (Tuple tuple)) -> CodeGenFunction r (VectorValueOf n (Tuple tuple))

disassembleVector :: Positive n => Proxy (Tuple tuple) -> VectorValueOf n (Tuple tuple) -> CodeGenFunction r (Vector n (ValueOf (Tuple tuple)))

class TupleVector a where

Methods

deinterleave :: Positive n => Proxy a -> Vector n (ValueOf a) -> CodeGenFunction r (VectorValueOf n a)

interleave :: Positive n => Proxy a -> VectorValueOf n a -> CodeGenFunction r (Vector n (ValueOf a))

Instances

(Vector a, Vector b) => TupleVector (a, b)

Defined in LLVM.Extra.Storable.Private

Methods

deinterleave :: Positive n => Proxy (a, b) -> Vector n (ValueOf (a, b)) -> CodeGenFunction r (VectorValueOf n (a, b))

interleave :: Positive n => Proxy (a, b) -> VectorValueOf n (a, b) -> CodeGenFunction r (Vector n (ValueOf (a, b)))

(Vector a, Vector b, Vector c) => TupleVector (a, b, c)

Defined in LLVM.Extra.Storable.Private

Methods

deinterleave :: Positive n => Proxy (a, b, c) -> Vector n (ValueOf (a, b, c)) -> CodeGenFunction r (VectorValueOf n (a, b, c))

interleave :: Positive n => Proxy (a, b, c) -> VectorValueOf n (a, b, c) -> CodeGenFunction r (Vector n (ValueOf (a, b, c)))

Standard method implementations

loadNewtype :: (C a, ValueOf a ~ al) => (a -> wrapped) -> (al -> wrappedl) -> Value (Ptr wrapped) -> CodeGenFunction r wrappedl

storeNewtype :: (C a, ValueOf a ~ al) => (a -> wrapped) -> (wrappedl -> al) -> wrappedl -> Value (Ptr wrapped) -> CodeGenFunction r ()

loadTraversable :: (Repeat f, Traversable f, C a, ValueOf a ~ al) => Value (Ptr (f a)) -> CodeGenFunction r (f al)

loadApplicative :: (Applicative f, Traversable f, C a, ValueOf a ~ al) => Value (Ptr (f a)) -> CodeGenFunction r (f al)

storeFoldable :: (Foldable f, C a, ValueOf a ~ al) => f al -> Value (Ptr (f a)) -> CodeGenFunction r ()

Pointer handling

advancePtr :: (Storable a, Value (Ptr a) ~ ptr) => Value Int -> ptr -> CodeGenFunction r ptr

incrementPtr :: (Storable a, Value (Ptr a) ~ ptr) => ptr -> CodeGenFunction r ptr

decrementPtr :: (Storable a, Value (Ptr a) ~ ptr) => ptr -> CodeGenFunction r ptr

Loops over Storable arrays

arrayLoop :: (Phi s, Num i, IsConst i, IsInteger i, CmpRet i, IsPrimitive i, Storable a, Value (Ptr a) ~ ptrA) => Value i -> ptrA -> s -> (ptrA -> s -> CodeGenFunction r s) -> CodeGenFunction r s

arrayLoop2 :: (Phi s, Num i, IsConst i, IsInteger i, CmpRet i, IsPrimitive i, Storable a, Value (Ptr a) ~ ptrA, Storable b, Value (Ptr b) ~ ptrB) => Value i -> ptrA -> ptrB -> s -> (ptrA -> ptrB -> s -> CodeGenFunction r s) -> CodeGenFunction r s

arrayLoopMaybeCont :: (Phi s, Undefined s, Num i, IsConst i, IsInteger i, CmpRet i, IsPrimitive i, Storable a, Value (Ptr a) ~ ptrA, T (ptrA, s) ~ z) => Value i -> ptrA -> s -> (ptrA -> s -> T r z s) -> CodeGenFunction r (Value i, T s)

arrayLoopMaybeCont2 :: (Phi s, Undefined s, Num i, IsConst i, IsInteger i, CmpRet i, IsPrimitive i, Storable a, Value (Ptr a) ~ ptrA, Storable b, Value (Ptr b) ~ ptrB, T (ptrA, (ptrB, s)) ~ z) => Value i -> ptrA -> ptrB -> s -> (ptrA -> ptrB -> s -> T r z s) -> CodeGenFunction r (Value i, T s)