Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gnzlbg/cargo-asm
cargo subcommand showing the assembly or llvm-ir generated for Rust code
https://github.com/gnzlbg/cargo-asm
cargo-subcommand
Last synced: 30 days ago
JSON representation
cargo subcommand showing the assembly or llvm-ir generated for Rust code
- Host: GitHub
- URL: https://github.com/gnzlbg/cargo-asm
- Owner: gnzlbg
- License: other
- Created: 2018-02-13T19:38:49.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-26T19:01:08.000Z (9 months ago)
- Last Synced: 2024-09-17T14:33:56.258Z (about 2 months ago)
- Topics: cargo-subcommand
- Language: Rust
- Homepage: https://github.com/gnzlbg/cargo-asm
- Size: 358 KB
- Stars: 1,171
- Watchers: 16
- Forks: 36
- Open Issues: 56
-
Metadata Files:
- Readme: readme.md
- License: license-apache.md
Awesome Lists containing this project
README
# cargo-asm
[![crates.io version][crate-shield]][crate] [![Travis build status][travis-shield]][travis] [![Appveyor build status][appveyor-shield]][appveyor] [![License][license-shield]][license]
> A [`cargo`] subcommand that displays the assembly or llvm-ir generated for Rust source code.
# Install
```
cargo install cargo-asm
```
# Example
To view the assembly of the function `double_n` in the module `bar` of the crate
[`lib_crate`] annotated with its corresponding Rust code, go to the crate's root
directory
```
git clone [email protected]:gnzlbg/cargo-asm.git
cd cargo-asm/cargo-asm-test/lib_crate
```
and type:
```
cargo asm lib_crate::bar::double_n --rust
```
which outputs:
(note: the source-code mapping information emitted by rustc after optimizations is
sometimes far from perfect, like in this case. Take it with a grain of salt.)
To view the LLVM IR type
```
cargo llvm-ir lib_crate::bar::double_n
```
# Features
* Platform support:
* OS: Linux, Windows, and MacOSX.
* Rust: nightly and stable.
* Architectures: x86, x86_64, arm, aarch64, powerpc, mips, sparc.
* Displaying:
* Assembly in Intel or AT&T syntax.
* Corresponding Rust source code alongside assembly.
* JSON AST for further processing.
* LLVM-IR.
* Querying:
* functions, for example: `foo`:
```
cargo asm crate::path::to::foo
```
* inherent method, for example: `foo` of a type `Foo` (that is, `Foo::foo`):
```
cargo asm crate::path::to::Foo::foo
```
* trait method implementations, for example: `bar` of the trait `Bar` for the type `Foo`:
```
cargo asm "::bar"
```
* generic functions, methods, ...
To search for a function named `foo` in some path, one can just type `cargo asm
foo`. The command will return a list of all similarly named functions
independently of the path.
# License
This project is licensed under either of
* Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
# Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this project by you, as defined in the Apache-2.0 license,
shall be dual licensed as above, without any additional terms or conditions.
[`cargo`]: https://crates.io/
[travis-shield]: https://img.shields.io/travis/gnzlbg/cargo-asm.svg?style=flat-square
[travis]: https://travis-ci.org/gnzlbg/cargo-asm
[appveyor-shield]: https://img.shields.io/appveyor/ci/gnzlbg/cargo-asm.svg?style=flat-square
[appveyor]: https://ci.appveyor.com/project/gnzlbg/cargo-asm/branch/master
[license-shield]: https://img.shields.io/badge/License-MIT%2FApache2.0-green.svg?style=flat-square
[license]: https://github.com/gnzlbg/cargo-asm/blob/master/license.md
[crate-shield]: https://img.shields.io/crates/v/cargo-asm.svg?style=flat-square
[crate]: https://crates.io/crates/cargo-asm
[`lib_crate`]: https://github.com/gnzlbg/cargo-asm/tree/master/cargo-asm-test/lib_crate