rustfilt-0.2.1/.gitignore010066400017500001750000000000121271540400600135710ustar0000000000000000target *~ rustfilt-0.2.1/.travis.yml010064400017500001750000000003101310434574100137140ustar0000000000000000language: rust cache: cargo rust: - stable - beta - nightly script: - cargo build --verbose - RUST_BACKTRACE=1 cargo test --verbose sudo: false matrix: allow_failures: - rust: nightly rustfilt-0.2.1/Cargo.toml.orig010064400017500001750000000011301353777666600145230ustar0000000000000000[package] name = "rustfilt" description = "Demangle Rust symbol names" homepage = "https://github.com/luser/rustfilt" repository = "https://github.com/luser/rustfilt" version = "0.2.1" authors = ["Ted Mielczarek ", "Nicholas Schlabach "] readme = "README.md" license = "Apache-2.0" [dependencies] rustc-demangle = "^0.1.4" lazy_static = "^1" regex = "^1" [dependencies.clap] version = "^2.21.1" # Exclude all optional features except wrap_help default-features = false features = ["wrap_help"] [profile.release] # Reduces binary size by 21% lto = true rustfilt-0.2.1/Cargo.toml0000644000000021150000000000000107440ustar00# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies # # If you believe there's an error in this file please file an # issue against the rust-lang/cargo repository. If you're # editing this file be aware that the upstream Cargo.toml # will likely look very different (and much more reasonable) [package] name = "rustfilt" version = "0.2.1" authors = ["Ted Mielczarek ", "Nicholas Schlabach "] description = "Demangle Rust symbol names" homepage = "https://github.com/luser/rustfilt" readme = "README.md" license = "Apache-2.0" repository = "https://github.com/luser/rustfilt" [profile.release] lto = true [dependencies.clap] version = "^2.21.1" features = ["wrap_help"] default-features = false [dependencies.lazy_static] version = "^1" [dependencies.regex] version = "^1" [dependencies.rustc-demangle] version = "^0.1.4" rustfilt-0.2.1/LICENSE010066400017500001750000000251371271540377100126350ustar0000000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. rustfilt-0.2.1/README.md010064400017500001750000000016651310434604000130710ustar0000000000000000[![Build Status](https://travis-ci.org/luser/rustfilt.svg?branch=master)](https://travis-ci.org/luser/rustfilt) [![Crates.io](https://img.shields.io/crates/v/rustfilt.svg)](https://crates.io/crates/rustfilt) Demangle Rust symbol names using [rustc-demangle](https://github.com/alexcrichton/rustc-demangle). `rustfilt` works similarly to `c++filt`, in that it accepts mangled symbol names as command line arguments, and if none are provided it accepts mangled symbols from stdin. Demangled symbols are written to stdout. ## Installation ````bash cargo install rustfilt ```` ## Usage To demangle a file, simply run: ````bash rustfilt -i mangled.txt -o demangled.txt ```` Rustfilt can also accept data from stdin, and pipe to stdout: ```` curl http://example.com/mangled-symbols.txt | rustfilt | less ```` By default, rustfilt strips the generated 'hashes' from the mangled names. If these need to be kept, simply pass the `-h` option to rustfilt. rustfilt-0.2.1/src/main.rs010064400017500001750000000164401353777657600137270ustar0000000000000000// Copyright 2016 Mozilla // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #[macro_use] extern crate clap; #[macro_use] extern crate lazy_static; extern crate regex; extern crate rustc_demangle; use rustc_demangle::demangle; use regex::{Regex, Captures}; use std::borrow::Cow; use std::fs::File; use std::io::{self, BufRead, BufReader, BufWriter, Write, stdin, stdout, stderr}; use std::path::{Path, PathBuf}; use std::str::FromStr; use std::process::exit; mod tests; lazy_static! { // NOTE: Use [[:alnum::]] instead of \w to only match ASCII word characters, not unicode static ref MANGLED_NAME_PATTERN: Regex = Regex::new(r"_(ZN|R)[\$\._[:alnum:]]*").unwrap(); } #[inline] // Except for the nested functions (which don't count), this is a very small function pub fn demangle_line(line: &str, include_hash: bool) -> Cow { MANGLED_NAME_PATTERN.replace_all(line, |captures: &Captures| { let demangled = demangle(&captures[0]); if include_hash { demangled.to_string() } else { // Use alternate formatting to exclude the hash from the result format!("{:#}", demangled) } }) } fn demangle_stream(input: &mut R, output: &mut W, include_hash: bool) -> io::Result<()> { // NOTE: this is actually more efficient than lines(), since it re-uses the buffer let mut buf = String::new(); while input.read_line(&mut buf)? > 0 { { // NOTE: This includes the line-ending, and leaves it untouched let demangled_line = demangle_line(&buf, include_hash); if cfg!(debug_assertions) && buf.ends_with('\n') { let line_ending = if buf.ends_with("\r\n") { "\r\n" } else { "\n" }; debug_assert!(demangled_line.ends_with(line_ending), "Demangled line has incorrect line ending"); } output.write_all(demangled_line.as_bytes())?; } buf.clear(); // Reset the buffer's position, without freeing it's underlying memory } Ok(()) // Successfully hit EOF } enum InputType { Stdin, File(PathBuf) } impl InputType { fn demangle(&self, output: OutputType, include_hash: bool) -> io::Result<()> { // NOTE: This has to be seperated into two functions for generics match *self { InputType::Stdin => { let stdin = stdin(); let mut lock = stdin.lock(); output.write_demangled(&mut lock, include_hash) }, InputType::File(ref path) => output.write_demangled(&mut BufReader::new(File::open(path)?), include_hash) } } fn validate(file: String) -> Result<(), String> { file.parse::().map(|_| ()) } } impl FromStr for InputType { type Err = String; fn from_str(file: &str) -> Result { if file == "-" { Ok(InputType::Stdin) } else { let path = Path::new(&file); if !path.is_file() { if !path.exists() { Err(format!("{} doesn't exist", file)) } else { Err(format!("{} isn't a file", file)) } } else { Ok(InputType::File(PathBuf::from(path))) } } } } enum OutputType { Stdout, File(PathBuf) } impl OutputType { #[inline] // It's only used twice fn write_demangled(&self, input: &mut I, include_hash: bool) -> io::Result<()> { match *self { OutputType::Stdout => { let stdout = stdout(); let mut lock = stdout.lock(); demangle_stream(input, &mut lock, include_hash) }, OutputType::File(ref path) => { let file = File::create(path)?; let mut buf = BufWriter::new(&file); demangle_stream(input, &mut buf, include_hash) } } } fn write_demangled_names>(&self, names: &[S], include_hash: bool) -> io::Result<()> { #[inline] // It's only used twice ;) fn demangle_names_to, O: io::Write>(names: &[S], output: &mut O, include_hash: bool) -> io::Result<()> { for name in names { let demangled = demangle(name.as_ref()); if include_hash { writeln!(output, "{}", demangled)? } else { writeln!(output, "{:#}", demangled)? }; } Ok(()) } match *self { OutputType::Stdout => { let stdout = stdout(); let mut lock = stdout.lock(); demangle_names_to(names, &mut lock, include_hash) }, OutputType::File(ref path) => { let file = File::create(path)?; let mut buf = BufWriter::new(&file); demangle_names_to(names, &mut buf, include_hash) } } } fn validate(file: String) -> Result<(), String> { file.parse::().map(|_| ()) } } impl FromStr for OutputType { type Err = String; fn from_str(file: &str) -> Result { if file == "-" { Ok(OutputType::Stdout) } else { let path = Path::new(&file); if path.exists() { Err(format!("{} already exists", file)) } else { Ok(OutputType::File(PathBuf::from(path))) } } } } fn main() { let args: clap::ArgMatches = clap_app!(rust_demangle => (version: crate_version!()) (author: crate_authors!()) (about: "Demangles names generated by the rust compiler") (@arg INCLUDE_HASH: --include-hash --hash "Include the hashes in the demangled names") (@arg INPUT: --input -i [FILE] default_value("-") {InputType::validate} "The input file to replace the mangled names in, or '-' for stdin") (@arg OUTPUT: --output -o [FILE] default_value("-") {OutputType::validate} "The output file to emit the demangled names to, or '-' for stdout") (@arg NAMES: ... [NAME] conflicts_with[INPUT] "The list of names to demangle") ).get_matches(); let include_hash = args.is_present("INCLUDE_HASH"); let output = value_t!(args, "OUTPUT", OutputType).unwrap(); if let Some(names) = args.values_of("NAMES") { output.write_demangled_names(&names.collect::>(), include_hash).unwrap_or_else(|e| { writeln!(stderr(), "Unable to demangle names: {}", e).unwrap(); exit(1); }) } else { let input = value_t!(args, "INPUT", InputType).unwrap(); input.demangle(output, include_hash).unwrap_or_else(|e| { writeln!(stderr(), "Unable to demangle input: {}", e).unwrap(); exit(1); }) } } rustfilt-0.2.1/src/tests.rs010064400017500001750000000075041353777657600141460ustar0000000000000000#![cfg(test)] ///! Tests demangle_line, based upon the assumption rustc_demangle works properly use rustc_demangle::demangle; use super::demangle_line; use super::demangle_stream; static MANGLED_NAMES: &'static [&'static str] = &[ "_ZN55_$LT$$RF$$u27$a$u20$T$u20$as$u20$core..fmt..Display$GT$3fmt17h510ed05e72307174E", "_ZN7example4main17h0db00b8b32acffd5E", "_ZN3std2io5stdio6_print17he48522be5b0a80d9E", "_ZN3foo17h05af221e174051e9E", "_ZN3foo20h05af221e174051e9abcE", "_ZN3foo5h05afE", "_ZN109_$LT$core..str..pattern..CharSearcher$LT$$u27$a$GT$$u20$as$u20$core..str..pattern..Searcher$LT$$u27$a$GT$$GT$10next_match17h9c8d80a58da7cd74E", "_ZN84_$LT$core..iter..Map$LT$I$C$$u20$F$GT$$u20$as$u20$core..iter..iterator..Iterator$GT$4next17h98ea4751a6975428E", "_ZN51_$LT$serde_json..read..IteratorRead$LT$Iter$GT$$GT$15parse_str_bytes17h8199b7867f1a334fE", "_ZN3std11collections4hash3map11RandomState3new4KEYS7__getit5__KEY17h1bc0dbd302b9f01bE", // RFC2603 v0 mangled names "_RNvNtNtCs1234_7mycrate3foo3bar3baz", "_RNvNvMCs1234_7mycrateINtCs1234_7mycrate3FoopE3bar4QUUX", "_RNvNvXCs1234_7mycrateINtCs1234_7mycrate3FoopENtNtC3std5clone5Clone5clone4QUUX", "_RNvNvCs1234_7mycrate4QUUX3FOO", ]; #[test] fn ignores_text() { for text in &["boom de yada\tboom de yada\n", "bananas are fun for everyone"] { assert_eq!(demangle_line(text, false), *text); assert_eq!(demangle_line(text, true), *text); } } #[test] fn standalone_demangles() { for name in MANGLED_NAMES { assert_eq!(demangle_line(name, true).as_ref(), &demangle(name).to_string()); } } #[test] fn not_noop_demangles() { for name in MANGLED_NAMES { assert_ne!(demangle_line(name, false).as_ref(), *name); } } #[test] fn standalone_demangles_nohash() { for name in MANGLED_NAMES { assert_eq!(demangle_line(name, false).as_ref(), &format!("{:#}", demangle(name))); } } fn test_embedded_line_demangle(line_demangler: F1, demangler: F2) where F1: Fn(&str) -> String, F2: Fn(&str) -> String { for name in MANGLED_NAMES { macro_rules! test_context { ($context:expr) => (assert_eq!(line_demangler(&format!($context, name)), format!($context, demangler(name)))) } // x86 ASM test_context!(" lea rax, [rip + {}]"); test_context!(" call {}@PLT"); // perf script --no-demangle test_context!(" 1a680e {} (/home/user/git/steven-rust/target/debug/steven)"); test_context!(" 20039f {} (/home/user/git/steven-rust/target/debug/steven)"); test_context!(" 1dade8 {} (/home/user/git/steven-rust/target/debug/steven)"); // Random unicode symbols test_context!("J∆ƒƒ∆Ǥ{}∆ʓ∆ɲI∆ɳ"); // https://xkcd.com/1638/ test_context!(r#"cat out.txt | grep -o "\\\[[(].*\\\[{}\])][^)\]]*$""#); test_context!(r"\\\\\\\\{}\\\\\\\\"); // Backslash to end all other text (twice) } } #[test] fn embedded_demangle() { test_embedded_line_demangle(|line| demangle_line(line, false).into_owned(), |name| format!("{:#}", demangle(name))); } #[test] fn embedded_demangle_nohash() { test_embedded_line_demangle(|line| demangle_line(line, true).into_owned(), |name| demangle(name).to_string()); } #[test] fn stream_without_newlines() { let tab_mangled = MANGLED_NAMES.join("\t"); let mut stream_demangled: Vec = vec![]; demangle_stream(&mut tab_mangled.as_bytes(), &mut stream_demangled, true).unwrap(); let split_demangled: Vec<_> = stream_demangled.split(|&b| b == b'\t').collect(); assert_eq!(MANGLED_NAMES.len(), split_demangled.len()); for (mangled, demangled) in MANGLED_NAMES.iter().zip(split_demangled) { assert_eq!(demangled, demangle(mangled).to_string().as_bytes()); } } rustfilt-0.2.1/.cargo_vcs_info.json0000644000000001120000000000000127410ustar00{ "git": { "sha1": "e85d78d563ad1794818d1f20a0e856a05417bcac" } }