seqaid: Dynamic strictness control, including space leak repair

[ bsd3, compiler-plugin, library, program ] [ Propose Tags ]

Seqaid is a GHC plugin for non-invasive auto-instrumentation of dynamic strictness (and parallelism) control, shortly to include optimisation for automated space leak relief using minimal strictification. [The optimiser is still in development however.]

Refer to the seqaid homepage for more information.


[Skip to Readme]
Versions [faq] 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.1.6.0, 0.1.7.0, 0.2.0.0, 0.2.1.0, 0.2.1.1, 0.3.0.0, 0.3.0.1, 0.4.0.0
Dependencies array, base (<5), Cabal, containers, deepseq-bounded, directory, generics-sop, ghc (>=7.4), hashable, hashtables, modulespection, mtl, process, regex-base, regex-pcre, syb, template-haskell, temporary, th-expand-syns [details]
License BSD-3-Clause
Author Andrew G. Seniuk
Maintainer Andrew Seniuk <rasfar@gmail.com>
Category Compiler Plugin
Home page http://www.fremissant.net/seqaid
Bug tracker Andrew Seniuk <rasfar@gmail.com>
Uploaded by AndrewSeniuk at Fri Dec 19 12:49:38 UTC 2014
Distributions NixOS:0.4.0.0
Executables seqaidpp, seqaid
Downloads 6146 total (428 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Flags

NameDescriptionDefaultType
try_inject_noinline_on_requested_binds

If we can prevent inling of injected binds (without requiring user edits), that would probably be a good trade off in terms of lost optimiser oppportunities in exchange for assurance that the bind won't be inlined. This didn't work, and is a poor solution anyway.

DisabledAutomatic
seqable_only

Like NFDATAN_ONLY, but for newer Seqable module.

DisabledAutomatic
th_type_in_types_ann

Actually this is just preparatory, haven't gone down this road far yet. (We would like a TH.Type to Type.Type conversion function in the GHC API. Then we'd just send the list of Type.Type for direct use by the Core-plugin downstream).

DisabledAutomatic
seqaidpp_types

Rather than choose types to seqinj for based on the types of the top-level binds, use seqaidpp to parse the types from seqaid.config. This stays on perpetually, finally, and could be removed soon.

EnabledAutomatic
infer_top_level_types

If True, then TH/modulespection will be used as it has been, to blanket-inject all top-level functions (at least, those not explicitly or implicitly excluded). Now, if False, only RHS's with result types in the "types" list for the module (in seqaid.config) will be wrapped (again, at least those not explicitly or implicitly excluded).

DisabledAutomatic
demo_mode

This is the only working mode in the first release. (And it only works when tested on the "leaky" package.) The switch exists to exclude hashable/hashtables deps (and subdeps) from the first release, while I can continue to work on this aspect in the development head.

EnabledAutomatic
dbg_seqaid

When set, every call to seqaidDispatch emits a line of info.

EnabledAutomatic
no_top_level_seqinj_dummies

If have to inject a class and instance anyway to evade DCE, no need for the old top-level seqinj_ declarations (we hope...).

DisabledAutomatic
nfdatan_only

To simplify debugging.

DisabledAutomatic
show_type

Include Typeable instance for (show . typeOf) in seqaidDispatch

EnabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for seqaid-0.1.1

[back to package description]
  ----------------------------------------------------------

  Seqaid : Space Leak Diagnostic and Remedial Tool

  Andrew Seniuk
  rasfar@gmail.com
  2014

  ----------------------------------------------------------

  The easiest way to get started with seqaid is

     cabal install seqaid
     seqaid demo

  This will create a fresh directory, populate
  it with the <leaky> test project, and configure,
  build and run it with seqaid instrumentation.
  Consult the leaky.cabal, README, and leaky.hs files
  in that directory for additional information.
  (The README explains the console output.)

  ----------------------------------------------------------

  To instrument your own project ("myapp" for didactic purposes),
  typically the following steps suffice:

    1. cabal install seqaid, of course.

    2. Add the following (at the appropriate level of indentation)
       to your myapp.cabal file:

         default-extensions:  TemplateHaskell
         ghc-options:         -fplugin=Seqaid.Plugin
         ghc-options:         -F -pgmF seqaidpp
         ghc-options:         -with-rtsopts=-T

    3. Create a seqaid.config file in the project dir.
       The preprocessor will parse this, and control
       the extent of the instrumentation harness.

       There is no mechanism yet for real blanket
       instrumentation: You must name at least
       the modules you want instrumented, and the
       types you're interested in.  All binds in
       a module will be covered however.

       Looking at the seqaid.config file for leaky:

         package    leaky
         module     Main
           binds    duty
             types  Types.TA
         instances  Types.TA, Types.TB, Types.TC

       is this was changed to

         package    leaky
         module     Main
         types      Types.TA
         instances  Types.TA, Types.TB, Types.TC

       then all binds in module Main will be instrumented at
       all subexpressions having type Types.TA.

       The instances line names types you need to be able
       to force through.  If you get missing instance errors
       when you build, then you probably need to add those
       types to this list.

  ----------------------------------------------------------

  When the preprocessor runs, it will parse the configuration
  from seqaid.config, and perform the requisite insertions and
  substitutions behind the scenes.

    NOTE: This will never ever edit your source files directly!
    GHC takes care of running the preprocessor (-F option) on
    its own temporary files, in the natural course of the
    compilation pipeline.

  ----------------------------------------------------------

  The other project inseparable from this is <deepseq-bounded>.

  More specific information resides in
   - the <seqaid>, <leaky> and <deepseq-bounded> homepages
   - the Haddock API docs for <seqaid> and <deepseq-bounded>
   - haskell-cafe thread(s): <>
   - reddit thread(s): <>

  And to a lesser extent, sporadic bits of information can also
  be found in files in the source distribution
   - the project README and .cabal files
   - comments in the source files [tend to obsolescence]

  Subsequent versions will hopefully be more cohesive.

  ----------------------------------------------------------