https://github.com/sunxfancy/vscode-llvm

VSCode LLVM Compiler Explorer
https://github.com/sunxfancy/vscode-llvm

Last synced: 4 days ago
JSON representation

VSCode LLVM Compiler Explorer

• Host: GitHub
• URL: https://github.com/sunxfancy/vscode-llvm
• Owner: sunxfancy
• License: mit
• Created: 2022-09-07T07:23:20.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-30T07:15:09.000Z (6 months ago)
• Last Synced: 2024-08-03T01:39:37.940Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.75 MB
• Stars: 227
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VSCode LLVM Compiler Explorer

Download from [VSCode marketplace](https://marketplace.visualstudio.com/items?itemName=XiaofanSun.vscode-llvm).

This is a tool for compiler developers of LLVM. This vscode extension can support exploring LLVM IR and machine IR after each pass. 

## Features

1. Run a clang command and explore preprocessing phase, clang AST building phase, each phase of LLVM passes, and final generated assembly code.

2. Compare difference between IRs before and after running a pass.

3. Support custom clang or modified version.

## How to use

![](./doc/step1.png)

1. Click 'New config' for creating a new configuration

2. Type your command to compile the file

![](./doc/step2.png)

3. (Optional) If you want to focus on one function. You can type the function name in the 'filter function' field. Please note, this function name should be mangle name if it's C++. Then, click the command name to run the command.

4. Now, you can explore the IRs after each pass.

![](./doc/pass-view.png)

## Compare Mode

To debug a pass, you may want to compare a clang command with and without the pass. Or you want to debug a different version of clang with the stable version. This extension can help you to compare the difference between two IRs after each pass.

![](./doc/compare.png)

## Source2Asm Mapping View

Inspired by Compiler Explorer, this extension can highlight the mapping between source code and the assembly code.

![](./doc/highlight.png)

## Run Print Pass to View CallGraph/CFG/DOMTree

There is a list of utility passes available in this plugin. You can run these passes to view the CallGraph, CFG, and DOMTree of an IR file.

When you open an IR file, you can click the 'Print Call Graph' button to generate a callgraph.dot file. Then, you can use the Graphviz plugin to view the callgraph.

Note: You need to have 'opt' tool in your PATH (or specify the path in settings) and installed [Graphviz preview plugin](https://marketplace.visualstudio.com/items?itemName=tintinweb.graphviz-interactive-preview).

![](./doc/callgraph.png)

## Syntax Highlighting

This plugin provides syntax highlighting for Clang AST and assembly language. You may need to install additional LLVM syntax highlighting plugins, there are some options:

- [RReverser.llvm](https://marketplace.visualstudio.com/items?itemName=RReverser.llvm)

- [colejcummins.llvm-syntax-highlighting](https://marketplace.visualstudio.com/items?itemName=colejcummins.llvm-syntax-highlighting)