Copyright	(c) Galois Inc 2011-2016
License	BSD3
Maintainer	Rob Dockins <rdockins@galois.com>
Stability	provisional
Safe Haskell	Safe-Inferred
Language	Haskell2010

Lang.Crucible.LLVM.DataLayout

Contents

Alignments
Data layout declarations.

Description

Synopsis

data Alignment
noAlignment :: Alignment
padToAlignment :: Bytes -> Alignment -> Bytes
toAlignment :: Bytes -> Maybe Alignment
fromAlignment :: Alignment -> Bytes
exponentToAlignment :: Natural -> Alignment
alignmentToExponent :: Alignment -> Natural
data DataLayout
data EndianForm
- = BigEndian
- | LittleEndian
intLayout :: Lens' DataLayout EndianForm
maxAlignment :: DataLayout -> Alignment
ptrSize :: Lens' DataLayout Bytes
ptrAlign :: Lens' DataLayout Alignment
ptrBitwidth :: DataLayout -> Natural
defaultDataLayout :: DataLayout
parseDataLayout :: DataLayout -> DataLayout
integerAlignment :: DataLayout -> Natural -> Alignment
vectorAlignment :: DataLayout -> Natural -> Alignment
floatAlignment :: DataLayout -> Natural -> Maybe Alignment
aggregateAlignment :: DataLayout -> Alignment
intWidthSize :: Natural -> Bytes

Alignments

data Alignment Source #

An Alignment represents a number of bytes that must be a power of two.

Instances

Instances details

Show Alignment Source #
Instance details Defined in Lang.Crucible.LLVM.DataLayout Methods showsPrec :: Int -> Alignment -> ShowS # show :: Alignment -> String # showList :: [Alignment] -> ShowS #
Eq Alignment Source #
Instance details Defined in Lang.Crucible.LLVM.DataLayout Methods (==) :: Alignment -> Alignment -> Bool # (/=) :: Alignment -> Alignment -> Bool #
Ord Alignment Source #
Instance details Defined in Lang.Crucible.LLVM.DataLayout Methods compare :: Alignment -> Alignment -> Ordering # (<) :: Alignment -> Alignment -> Bool # (<=) :: Alignment -> Alignment -> Bool # (>) :: Alignment -> Alignment -> Bool # (>=) :: Alignment -> Alignment -> Bool # max :: Alignment -> Alignment -> Alignment # min :: Alignment -> Alignment -> Alignment #

noAlignment :: Alignment Source #

1-byte alignment, which is the minimum possible.

padToAlignment :: Bytes -> Alignment -> Bytes Source #

padToAlignment x a returns the smallest value greater than or equal to x that is aligned to a.

toAlignment :: Bytes -> Maybe Alignment Source #

Convert a number of bytes into an alignment, if it is a power of 2.

fromAlignment :: Alignment -> Bytes Source #

Convert an alignment to a number of bytes.

exponentToAlignment :: Natural -> Alignment Source #

Convert an exponent n to an alignment of 2^n bytes.

alignmentToExponent :: Alignment -> Natural Source #

Data layout declarations.

data DataLayout Source #

Parsed data layout

Instances

Instances details

Show DataLayout Source #
Instance details Defined in Lang.Crucible.LLVM.DataLayout Methods showsPrec :: Int -> DataLayout -> ShowS # show :: DataLayout -> String # showList :: [DataLayout] -> ShowS #
Eq DataLayout Source #
Instance details Defined in Lang.Crucible.LLVM.DataLayout Methods (==) :: DataLayout -> DataLayout -> Bool # (/=) :: DataLayout -> DataLayout -> Bool #
Ord DataLayout Source #
Instance details Defined in Lang.Crucible.LLVM.DataLayout Methods compare :: DataLayout -> DataLayout -> Ordering # (<) :: DataLayout -> DataLayout -> Bool # (<=) :: DataLayout -> DataLayout -> Bool # (>) :: DataLayout -> DataLayout -> Bool # (>=) :: DataLayout -> DataLayout -> Bool # max :: DataLayout -> DataLayout -> DataLayout # min :: DataLayout -> DataLayout -> DataLayout #

data EndianForm Source #

Flags byte orientation of target machine.

Constructors

BigEndian
LittleEndian

Instances

Instances details

Show EndianForm Source #
Instance details Defined in Lang.Crucible.LLVM.DataLayout Methods showsPrec :: Int -> EndianForm -> ShowS # show :: EndianForm -> String # showList :: [EndianForm] -> ShowS #
Eq EndianForm Source #
Instance details Defined in Lang.Crucible.LLVM.DataLayout Methods (==) :: EndianForm -> EndianForm -> Bool # (/=) :: EndianForm -> EndianForm -> Bool #
Ord EndianForm Source #
Instance details Defined in Lang.Crucible.LLVM.DataLayout Methods compare :: EndianForm -> EndianForm -> Ordering # (<) :: EndianForm -> EndianForm -> Bool # (<=) :: EndianForm -> EndianForm -> Bool # (>) :: EndianForm -> EndianForm -> Bool # (>=) :: EndianForm -> EndianForm -> Bool # max :: EndianForm -> EndianForm -> EndianForm # min :: EndianForm -> EndianForm -> EndianForm #

intLayout :: Lens' DataLayout EndianForm Source #

maxAlignment :: DataLayout -> Alignment Source #

Maximum alignment for any type (used by malloc).

ptrSize :: Lens' DataLayout Bytes Source #

Size of pointers in bytes.

ptrAlign :: Lens' DataLayout Alignment Source #

ABI pointer alignment in bytes.

ptrBitwidth :: DataLayout -> Natural Source #

defaultDataLayout :: DataLayout Source #

The default data layout if no spec is defined. From the LLVM Language Reference: "When constructing the data layout for a given target, LLVM starts with a default set of specifications which are then (possibly) overridden by the specifications in the datalayout keyword." http://llvm.org/docs/LangRef.html#langref-datalayout

parseDataLayout :: DataLayout -> DataLayout Source #

Create parsed data layout from layout spec AST.

integerAlignment :: DataLayout -> Natural -> Alignment Source #

Get alignment for the integer type of the specified bitwidth, using LLVM's rules for integer types: "If no match is found, and the type sought is an integer type, then the smallest integer type that is larger than the bitwidth of the sought type is used. If none of the specifications are larger than the bitwidth then the largest integer type is used." http://llvm.org/docs/LangRef.html#langref-datalayout

vectorAlignment :: DataLayout -> Natural -> Alignment Source #

Get alignment for a vector type of the specified bitwidth, using LLVM's rules for vector types: "If no match is found, and the type sought is a vector type, then the largest vector type that is smaller than the sought vector type will be used as a fall back." http://llvm.org/docs/LangRef.html#langref-datalayout

floatAlignment :: DataLayout -> Natural -> Maybe Alignment Source #

Get alignment for a float type of the specified bitwidth.

aggregateAlignment :: DataLayout -> Alignment Source #

Get the basic alignment for aggregate types.

intWidthSize :: Natural -> Bytes Source #

The size of an integer of the given bitwidth, in bytes.