https://github.com/yuao/metallibraryexplorer

Parse and disassemble .metallib files in browser
https://github.com/yuao/metallibraryexplorer

disassembler llvm metal metallib reverse-engineering swift wasm webassembly

Last synced: 4 months ago
JSON representation

Parse and disassemble .metallib files in browser

• Host: GitHub
• URL: https://github.com/yuao/metallibraryexplorer
• Owner: YuAo
• License: mit
• Created: 2022-04-17T16:45:35.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-07-24T11:04:57.000Z (over 1 year ago)
• Last Synced: 2024-07-30T19:27:57.222Z (6 months ago)
• Topics: disassembler, llvm, metal, metallib, reverse-engineering, swift, wasm, webassembly
• Language: JavaScript
• Homepage: https://yuao.github.io/MetalLibraryExplorer
• Size: 1.45 MB
• Stars: 24
• Watchers: 4
• Forks: 4
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MetalLibraryExplorer

[![Build](https://github.com/YuAo/MetalLibraryExplorer/actions/workflows/build.yml/badge.svg)](https://github.com/YuAo/MetalLibraryExplorer/actions/workflows/build.yml)

[![Deploy](https://github.com/YuAo/MetalLibraryExplorer/actions/workflows/deploy.yml/badge.svg)](https://github.com/YuAo/MetalLibraryExplorer/actions/workflows/deploy.yml)

Parse and disassemble .metallib files in browser. https://yuao.github.io/MetalLibraryExplorer

**This is a [WebAssembly](https://webassembly.org/) port of [MetalLibraryArchive](https://github.com/YuAo/MetalLibraryArchive). In order to use this tool your browser must [support WebAssembly](https://caniuse.com/wasm).**

## Features

- Inspect `.metallib` files. Get information about library type, target platform, Metal functions, etc.

- Disassemble Metal function bitcode.

- Download Metal bitcode and assembly as a zip archive.

## Technologies

### Metal Library Archive Parser

The parser uses a WebAssembly version of the [MetalLibraryArchive](https://github.com/YuAo/MetalLibraryArchive) core library, built with [SwiftWasm](https://github.com/swiftwasm/swift).

[wasmer-js](https://github.com/wasmerio/wasmer-js) is used as WASI polyfill. ~~However due to [wasmer/issues/2792](https://github.com/wasmerio/wasmer/issues/2792), the parser has to run in a Web Worker.~~

`wasm-strip` from [WABT](https://github.com/WebAssembly/wabt) and `wasm-opt` from [binaryen](https://github.com/WebAssembly/binaryen) are used mainly to reduce the `.wasm` binary size.

### LLVM Disassembler

[llvm-dis](https://llvm.org/docs/CommandGuide/llvm-dis.html) is used to convert the Metal bitcode into human-readable LLVM assembly language. This is also compiled to WebAssembly using [this workflow](https://github.com/YuAo/llvm-wasm/blob/master/.github/workflows/build-llvm-dis.yml).

### User Interface

The UI is built with [React](https://reactjs.org/) and [tailwindcss](https://tailwindcss.com/)

### Zip Archive & File Download

[JSZip](https://stuk.github.io/jszip/) & [FileSaver](https://github.com/eligrey/FileSaver.js/)

## Building

To build this library you will need to have installed in your system:

- [Node.js](https://nodejs.org/)

- [WABT](https://github.com/WebAssembly/wabt)

- [binaryen](https://github.com/WebAssembly/binaryen)

- [SwiftWasm](https://swiftwasm.org/)

### Build

```shell

npm install

npm run build

```

### Develop

```shell

npm install

npm run start

```

## More About `.metallib` Files

See [MetalLibraryArchive](https://github.com/YuAo/MetalLibraryArchive).