macaw/symbolic/macaw-symbolic.cabal
Tristan Ravitch cc85cfe657 Clean up and document the macaw-symbolic API
This cleanup consolidates the interface to macaw symbolic into two (and a half)
modules:

 - Data.Macaw.Symbolic for clients who just need to symbolically simulate
   machine code
 - Data.Macaw.Symbolic.Backend for clients that need to implement new
   architectures
 - Data.Macaw.Symbolic.Memory provides a reusable example implementation of
   machine pointer to LLVM memory model pointer mapping

Most functions are now documented and are grouped by use case.  There are two
worked (compiling) examples in the haddocks that show how to translate Macaw
into Crucible and then symbolically simulate the results (including setting up
all aspects of Crucible).  The examples are included in the symbolic/examples
directory and can be loaded with GHCi to type check them.

The Data.Macaw.Symbolic.Memory module still needs a worked example.

There were very few changes to actual code as part of this overhaul, but there
are a few places where complicated functions were hidden behind newtypes, as
users never need to construct the values themselves (e.g., MacawArchEvalFn and
MacawSymbolicArchFunctions).  There was also a slight consolidation of
constraint synonyms to reduce duplication.  All callers will have to be updated.

There is also now a README for macaw-symbolic that explains its purpose and
includes pointers to the new haddocks.

This commit also fixes up the (minor) breakage in the macaw-x86-symbolic
implementation from the API changes.
2019-01-10 18:20:54 -08:00

40 lines
763 B
Plaintext

name: macaw-symbolic
version: 0.0.1
author: Galois, Inc.
maintainer: jhendrix@galois.com
build-type: Simple
cabal-version: >= 1.9.2
license: BSD3
license-file: LICENSE
library
build-depends:
base >= 4,
ansi-wl-pprint,
containers,
IntervalMap >= 0.6 && < 0.7,
crucible >= 0.4,
crucible-llvm,
lens,
macaw-base,
mtl,
parameterized-utils,
text,
vector,
bytestring,
what4 >= 0.4.0
hs-source-dirs: src
exposed-modules:
Data.Macaw.Symbolic
Data.Macaw.Symbolic.Backend
Data.Macaw.Symbolic.Memory
other-modules:
Data.Macaw.Symbolic.CrucGen
Data.Macaw.Symbolic.PersistentState
Data.Macaw.Symbolic.MemOps
ghc-options: -Wall -Wcompat
ghc-prof-options: -O2 -fprof-auto-top