On Mar 7, 2015, at 12:28 AM, Kenneth Adam Miller wrote: > So, I want to use CMU's BAP to do some internal processing for a task that I have been assigned. One of the pertinent parts is transforming assembler representations of CPU instructions into the BAP Intermediate Language, or BIL. BAP is more about disassembling. So it can easily lift binary string into the BIL. But if you have assembly you need to compile it into machine code first. So, you need to find assembler. (For example, you can use `llvm-mc` from llvm toolkit) > It's kind of difficult, because there's only so much documentation that is really anything more than just the MLI interface and the OCaml Doc generated stuff. I have a lot of questions about how to proceed, but before I begin eliciting the problem and all, let me explain about how I got where I am. Yes, unfortunately that’s true. First off all BAP is currently under active development. Next, there is no properly working doc generator for OCaml right now, that will handle complex project containing many modules and sub libraries. I’m looking at odoc with a great hope. > > You can install BAP through opam, but you don't get the documentation I don't think. So, > > git clone github.com/BinaryAnalysisPlatform/bap/ > > and then just follow the instructions on how to build it, it's not hard at all, I got it going on Ubuntu 14.04. The only thing I ran into was an error on a llvm dependency, which required that I edit the opam file so that I do "--with-llvm-version=3.4" on the configure command line as an option. After that everything ran smoothly. Actually when you install BAP with opam you will have the documentation installed also. It is automatically installed at `~/.opam/???/doc/bap`. You can query the path to the documentation with the following command: opam config var gap:doc Moreover, we provide a compiled API documentation on github pages. I will update the main site with the link. Also, you may find this [1] page interesting. [1]: https://github.com/BinaryAnalysisPlatform/bap/wiki/Build-tips-and-tricks > Once you run bapbuild and make and all that…. You don’t need to run bapbuild at all, this is not a tool to build BAP, this is a tool to build applications and plugins that use BAP. > Opening up the index file at _build/bap.docdir/index.html, you can see that the documentation starts off with a note about using Bap.Std as everything else is interface files. What confused me is the seeming repetition of the documentation that is generated. It seems that some of the documentation on some of the very same pages is duplicated for certain sections. Why does it do so much duplication? Thats how ocamldoc works. Actually, the auto generated documentation is of very low quality. I personally suggest you to setup your Emacs environment, with merlin and everything else. Then you can navigate through the project using `C-c C-l` (jump to definition). Look here [2] for instructions about how to configure Emacs [2]: https://github.com/BinaryAnalysisPlatform/bap/wiki/Emacs > > First, using the toplevel I tried to construct a BIL set of statements. But the way the code works, you actually have to compose a disassembler that is specific to your architecture (x32/64 and ARM vs Intel or whatever). You then have to construct memory, and from that memory construct an Insn type, which is meant to be the canonical, cross disassembler type representation of an instruction. I can see how module use makes for great reusability of code. Problem is, the type definitions that the toplevel reports (baptop) and those of which are reported in the documentation seem to differ often. TL;DR here, I tried to get as close to the front page mention of how to use module Disasm, which meant Disasm.insn_at_mem function, but I had a hard time navigating the modules to create what I wanted. It seems like each one thing depends on some other portion of the library, and at one point I hit a dead end. The documentation mentions the same functions being exposed copiously, but that's when the type definitions wouldn't match up or something. I’m not sure that I understand you correctly. If you have just bytes, the use function `disassemble` that accepts memory and arch. You can use `Memory.create` to make memory, and `Bigstring.of_string` to create a bigstring of string/ > Lastly, and ultimately even more confusing is that of bap_mc.ml, which I saw as my second easiest avenue for usage of the BAP library. I saw bap_mc.ml line 55 as my chance; > > https://github.com/BinaryAnalysisPlatform/bap/blob/master/src/bap_mc/bap_mc.ml#L55 > > If I just were to modify it so that it, instead of watering down the string constructed, were to just pipe the insn object to a BIL constructor, and then use the sexp_of_bil transformer, then I could just drop it from there to be printed or converted to string and then printed. > > Naturally, I tried with several different module's bil constructor. But most notably I think that the Std bil constructor blew up, so here's what I replaced that line with: Oh, please, don’t use bap_mc as an example, as it is very low level. It is intended for debugging the underlying disassembly and uses very low-level interface, with lots of hard to understand phantom types. Please, try to stay with convenient Disasm module.