hlbc

Hashlink bytecode disassembler and analyzer.

This crate is a library, see hlbc-cli for an actual program to use.

Features

• Parse the whole bytecode file or any bytecode element
• Display any bytecode element
• Restore all possible names
• Link elements between them (with manual references for flexibility)
• Link elements with their debug information
• Serialize bytecode back to bytes
• Decompiler to haxe source code for classes and functions
• Commandline interface to use the features of this library (hlbc-cli)

Planned features

• Integrate with the Haxe/Hashlink standard library to restore more names, exclude them from analysis and such
• C API to integrate with other tools
• Text search engine to search for strings and names
• Assemble and inject bytecode or inject haxe source code directly

Changelog

See CHANGELOG.md.

Decompiler

The decompiler is present in the hlbc-decompiler crate and is currently incomplete (and will probably always be). See the wiki for examples of decompilation output.

Wiki

A wiki detailing the specifics of Hashlink bytecode is available here. The wiki also details the inner workings of haxe to hashlink compilation and decompilation.

Macros

There are 98 different bytecode instructions, there is no way I manually write code for it each time. Most of the code for these opcodes is generated through a proc macro (see hlbc-derive). The only time I needed to write 98 different branches was for the formatting used when displaying the instructions (src/fmt.rs).

Alternatives

This library is made in Rust, a C API is in the works which could permit using this lib in many other projects, but for now it is only Rust friendly.

Other alternatives include :

• Tinkering directly with the hashlink source code in C
• Using the in-progress *dashlink* made in Haxe but probably compilable to many other languages.

Notes about using Rust

Rust makes it a joy to develop for the opcodes, with each its own enum variant I can generate most of what I need with a macro or use that incredible match statement to process data the way I want to. But, since the Bytecode structure is a large graph and Rust doesn't like self-references, it is a bit cumbersome to pass the context and call resolve each time I need access to traverse the graph. Further iterations of this crate could make use an arena.