frames-2.0

This is a new version of the frames protocol, that is
extended with a new frame - metaframe.

This version also provides:

- a total rewrite of the frame reader, instead of the old
  buggy and slow trace container. Frame reader understands
  both versions 1.0 and 2.0. The new frame reader is typesafe,
  as it doesn't use any Obj.magic. Also the reader is able to
  work with pipes, and can start processing data on the very first
  byte.

- new library BFD, that includes architecture and machine
  specifications.

Author: ivg

.gitignore

@@ -26,3 +26,4 @@ META
 /frames.ml
 /myocamlbuild.ml
 /setup.ml
+/setup.ml

.merlin

@@ -5,18 +5,12 @@ EXT ounit
 FLG -short-paths
 FLG -w -4-33-40-41-42-43-34-44
 
-PKG camlzip
 PKG core_kernel
-PKG fileutils
-PKG jsonm
-PKG ocamlbuild
-PKG ocamlgraph
 PKG uuidm
 PKG bap
+PKG bap-traces
 PKG uri
-PKG sexplib
 PKG cmdliner
 
 B _build
 B _build/plugin
-

LICENSE

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2014 Carnegie Mellon University
+Copyright (c) 2016 Carnegie Mellon University
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
 the Software without restriction, including without limitation the rights to

README.md

@@ -6,3 +6,25 @@
 - A BAP plugin `frame` that provides `frames` format reader for the `bap-plugins` library
 - A playground `test/tracedump` to inspect the traces
 
+# Build and install
+
+## From sources 
+```
+  oasis setup
+  ./configure --prefix=`opam config var prefix`
+  make 
+  make install
+```
+
+## From opam
+
+1. Add our opam repository if you don't have one
+
+   ```
+   opam repository add bap git://github.com/BinaryAnalysisPlatform/opam-repository.git
+   ```
+2. install 
+
+   ```
+   opam install bap-frames
+   ```

_oasis

@@ -1,29 +1,32 @@
 OASISFormat: 0.4
 Name:        bap-frames
-Version:     0.1
+Version:     1.0.0-alpha
 Synopsis:    data format for execution traces
 Authors:     BAP Team
 License:     MIT
 Plugins:     META (0.4)
-BuildTools:  ocamlbuild, bapbuild
+BuildTools:  ocamlbuild
+
+Library bfd
+  Path:            lib/bfd
+  Modules:         Bfd
+  FindlibName:     bfd
+  CompiledObject:  best
+  BuildDepends:    ppx_deriving.std
+
 
 Library "bap-frames"
-  Path:            .
-  Modules:         Trace_container, Frame_piqi, Frame_piqi_ext, Arch_bfd
-  BuildDepends:    core_kernel, piqirun.pb, piqirun.ext, piqilib, ppx_jane
-  DataFiles:       *.piqi
+  Path:            lib/frames
+  Modules:         Frame_events, Frame_piqi, Frame_reader
+  FindlibName:     bap-frames
+  BuildTools:      piqi
+  BuildDepends:    bap, bap-traces, bfd, core_kernel, piqirun.pb, ppx_jane, ppx_deriving.std
+  CompiledObject:  best
+  DataFiles:       ../../*.piqi
 
 Library "bap-plugin-frames"
   Path:            plugin
   FindlibName:     bap-plugin-frames
   Modules:         Frame_trace_plugin
-  InternalModules: Frame_events
   BuildDepends:    bap, bap-frames, bap-traces
-  XMETADescription: read traces in frames format
-
-Executable tracedump
-  Path:           test
-  MainIs:         tracedump.ml
-  CompiledObject: best
-  Install:        false
-  BuildDepends:   bap, bap-frames, bap-plugin-frames, cmdliner
+  XMETADescription: read traces in frames format

_tags

@@ -1,5 +1,5 @@
 # OASIS_START
-# DO NOT EDIT (digest: 20d045e1058268e74375bb77116b7fd0)
+# DO NOT EDIT (digest: 2af87a2cce103ee0987cdf9582dfc68f)
 # Ignore VCS directories, you can use the same kind of rule outside
 # OASIS_START/STOP if you want to exclude directories that contains
 # useless stuff for the build process
@@ -14,42 +14,26 @@ true: annot, bin_annot
 ".git": not_hygienic
 "_darcs": -traverse
 "_darcs": not_hygienic
+# Library bfd
+"lib/bfd/bfd.cmxs": use_bfd
+<lib/bfd/*.ml{,i,y}>: pkg_ppx_deriving.std
 # Library bap-frames
-"bap-frames.cmxs": use_bap-frames
-<*.ml{,i,y}>: pkg_core_kernel
-<*.ml{,i,y}>: pkg_piqilib
-<*.ml{,i,y}>: pkg_piqirun.ext
-<*.ml{,i,y}>: pkg_piqirun.pb
-<*.ml{,i,y}>: pkg_ppx_jane
+"lib/frames/bap-frames.cmxs": use_bap-frames
+<lib/frames/*.ml{,i,y}>: pkg_bap
+<lib/frames/*.ml{,i,y}>: pkg_bap-traces
+<lib/frames/*.ml{,i,y}>: pkg_core_kernel
+<lib/frames/*.ml{,i,y}>: pkg_piqirun.pb
+<lib/frames/*.ml{,i,y}>: pkg_ppx_deriving.std
+<lib/frames/*.ml{,i,y}>: pkg_ppx_jane
+<lib/frames/*.ml{,i,y}>: use_bfd
 # Library bap-plugin-frames
 "plugin/bap-plugin-frames.cmxs": use_bap-plugin-frames
 <plugin/*.ml{,i,y}>: pkg_bap
 <plugin/*.ml{,i,y}>: pkg_bap-traces
 <plugin/*.ml{,i,y}>: pkg_core_kernel
-<plugin/*.ml{,i,y}>: pkg_piqilib
-<plugin/*.ml{,i,y}>: pkg_piqirun.ext
 <plugin/*.ml{,i,y}>: pkg_piqirun.pb
+<plugin/*.ml{,i,y}>: pkg_ppx_deriving.std
 <plugin/*.ml{,i,y}>: pkg_ppx_jane
 <plugin/*.ml{,i,y}>: use_bap-frames
-# Executable tracedump
-<test/tracedump.{native,byte}>: pkg_bap
-<test/tracedump.{native,byte}>: pkg_bap-traces
-<test/tracedump.{native,byte}>: pkg_cmdliner
-<test/tracedump.{native,byte}>: pkg_core_kernel
-<test/tracedump.{native,byte}>: pkg_piqilib
-<test/tracedump.{native,byte}>: pkg_piqirun.ext
-<test/tracedump.{native,byte}>: pkg_piqirun.pb
-<test/tracedump.{native,byte}>: pkg_ppx_jane
-<test/tracedump.{native,byte}>: use_bap-frames
-<test/tracedump.{native,byte}>: use_bap-plugin-frames
-<test/*.ml{,i,y}>: pkg_bap
-<test/*.ml{,i,y}>: pkg_bap-traces
-<test/*.ml{,i,y}>: pkg_cmdliner
-<test/*.ml{,i,y}>: pkg_core_kernel
-<test/*.ml{,i,y}>: pkg_piqilib
-<test/*.ml{,i,y}>: pkg_piqirun.ext
-<test/*.ml{,i,y}>: pkg_piqirun.pb
-<test/*.ml{,i,y}>: pkg_ppx_jane
-<test/*.ml{,i,y}>: use_bap-frames
-<test/*.ml{,i,y}>: use_bap-plugin-frames
+<plugin/*.ml{,i,y}>: use_bfd
 # OASIS_STOP