diff options
author | Matthew Maurer <mmaurer@google.com> | 2021-08-23 20:18:20 +0000 |
---|---|---|
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | 2021-08-23 20:18:20 +0000 |
commit | 1da2742452f0fbbf12f713342b4052d947f8a40e (patch) | |
tree | e7473c8edd34a186db846be446e43d9a9ed732be | |
parent | 1e18c46aef07d765dee79765b09628f2890af34d (diff) | |
parent | 333c830c5efe18c595677831e5fe0a5d3a897089 (diff) | |
download | rustc-demangle-capi-1da2742452f0fbbf12f713342b4052d947f8a40e.tar.gz |
Initial Import: rustc-demangle-capi-0.1.16 am: c21735ee3a am: 1a12e9ce11 am: 333c830c5e
Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/rustc-demangle-capi/+/1798339
Change-Id: I7182398021e8d34a6bd3f8786ea0b504fb4a5d60
-rw-r--r-- | .cargo_vcs_info.json | 5 | ||||
-rw-r--r-- | Cargo.toml | 25 | ||||
-rw-r--r-- | Cargo.toml.orig | 16 | ||||
l--------- | LICENSE | 1 | ||||
-rw-r--r-- | LICENSE-APACHE | 201 | ||||
-rw-r--r-- | LICENSE-MIT | 25 | ||||
-rw-r--r-- | METADATA | 20 | ||||
-rw-r--r-- | MODULE_LICENSE_APACHE2 | 0 | ||||
-rw-r--r-- | OWNERS | 1 | ||||
-rw-r--r-- | include/rustc_demangle.h | 18 | ||||
-rw-r--r-- | src/lib.rs | 160 |
11 files changed, 472 insertions, 0 deletions
diff --git a/.cargo_vcs_info.json b/.cargo_vcs_info.json new file mode 100644 index 0000000..8ef633d --- /dev/null +++ b/.cargo_vcs_info.json @@ -0,0 +1,5 @@ +{ + "git": { + "sha1": "f540792067ab84d0f47164b29d7db5c7ba3b367d" + } +} diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..5828d25 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,25 @@ +# 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 = "rustc-demangle-capi" +version = "0.1.0" +authors = ["Torste Aikio <zokier@gmail.com>"] +description = "C API for the `rustc-demangle` crate\n" +license = "MIT/Apache-2.0" +repository = "https://github.com/alexcrichton/rustc-demangle" + +[lib] +name = "rustc_demangle" +crate-type = ["staticlib", "cdylib"] +[dependencies.rustc-demangle] +version = "0.1.16" diff --git a/Cargo.toml.orig b/Cargo.toml.orig new file mode 100644 index 0000000..a59a768 --- /dev/null +++ b/Cargo.toml.orig @@ -0,0 +1,16 @@ +[package] +name = "rustc-demangle-capi" +version = "0.1.0" +authors = ["Torste Aikio <zokier@gmail.com>"] +description = """ +C API for the `rustc-demangle` crate +""" +license = "MIT/Apache-2.0" +repository = "https://github.com/alexcrichton/rustc-demangle" + +[lib] +name = "rustc_demangle" +crate-type = ["staticlib", "cdylib"] + +[dependencies] +rustc-demangle = { version = "0.1.16", path = "../.." } @@ -0,0 +1 @@ +LICENSE-APACHE
\ No newline at end of file diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + 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. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..39e0ed6 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2014 Alex Crichton + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/METADATA b/METADATA new file mode 100644 index 0000000..62d8c92 --- /dev/null +++ b/METADATA @@ -0,0 +1,20 @@ +name: "rustc-demangle-capi" +description: "C API for the `rustc-demangle` crate" +third_party { + url { + type: HOMEPAGE + value: "https://crates.io/crates/rustc-demangle-capi" + } + url { + type: ARCHIVE + value: "https://static.crates.io/crates/rustc-demangle-capi/rustc-demangle-capi-0.1.0.crate" + } + version: "0.1.0" + # Dual-licensed, using the least restrictive per go/thirdpartylicenses#same. + license_type: NOTICE + last_upgrade_date { + year: 2021 + month: 8 + day: 17 + } +} diff --git a/MODULE_LICENSE_APACHE2 b/MODULE_LICENSE_APACHE2 new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/MODULE_LICENSE_APACHE2 @@ -0,0 +1 @@ +include platform/prebuilts/rust:master:/OWNERS diff --git a/include/rustc_demangle.h b/include/rustc_demangle.h new file mode 100644 index 0000000..61c4aa1 --- /dev/null +++ b/include/rustc_demangle.h @@ -0,0 +1,18 @@ +#ifndef RUST_DEMANGLE_H_ +#define RUST_DEMANGLE_H_ + +#ifdef __cplusplus +extern "C" { +#endif + +// Demangles symbol given in `mangled` argument into `out` buffer +// +// Returns 0 if `mangled` is not Rust symbol or if `out` buffer is too small +// Returns 1 otherwise +int rustc_demangle(const char *mangled, char *out, size_t out_size); + +#ifdef __cplusplus +} +#endif + +#endif // RUSTC_DEMANGLE_H_ diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..51e3103 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,160 @@ +extern crate rustc_demangle; + +use std::io::Write; +use std::os::raw::{c_char, c_int}; + +/// C-style interface for demangling. +/// Demangles symbol given in `mangled` argument into `out` buffer +/// +/// Unsafe as it handles buffers by raw pointers. +/// +/// Returns 0 if `mangled` is not Rust symbol or if `out` buffer is too small +/// Returns 1 otherwise +#[no_mangle] +pub unsafe extern "C" fn rustc_demangle( + mangled: *const c_char, + out: *mut c_char, + out_size: usize, +) -> c_int { + let mangled_str = match std::ffi::CStr::from_ptr(mangled).to_str() { + Ok(s) => s, + Err(_) => return 0, + }; + match rustc_demangle::try_demangle(mangled_str) { + Ok(demangle) => { + let mut out_slice = std::slice::from_raw_parts_mut(out as *mut u8, out_size); + match write!(out_slice, "{:#}\0", demangle) { + Ok(_) => return 1, + Err(_) => return 0, + } + } + Err(_) => return 0, + } +} + +#[cfg(test)] +mod tests { + use std; + use std::os::raw::c_char; + #[test] + fn demangle_c_str_large() { + let mangled = "_ZN4testE\0"; + let mut out_buf: Vec<u8> = vec![42; 8]; + let res = unsafe { + super::rustc_demangle( + mangled.as_ptr() as *const c_char, + out_buf.as_mut_ptr() as *mut c_char, + 8, + ) + }; + assert_eq!(res, 1); + let out_str = std::str::from_utf8(&out_buf[..5]).unwrap(); + assert_eq!(out_str, "test\0"); + } + + #[test] + fn demangle_c_str_exact() { + let mangled = "_ZN4testE\0"; + let mut out_buf: Vec<u8> = vec![42; 8]; + let res = unsafe { + super::rustc_demangle( + mangled.as_ptr() as *const c_char, + out_buf.as_mut_ptr() as *mut c_char, + 5, + ) + }; + assert_eq!(res, 1); + let out_str = std::str::from_utf8(&out_buf).unwrap(); + assert_eq!(out_str, "test\0***"); + } + + #[test] + fn demangle_c_str_small() { + let mangled = "_ZN4testE\0"; + let mut out_buf: Vec<u8> = vec![42; 8]; + let res = unsafe { + super::rustc_demangle( + mangled.as_ptr() as *const c_char, + out_buf.as_mut_ptr() as *mut c_char, + 4, + ) + }; + assert_eq!(res, 0); + let out_str = std::str::from_utf8(&out_buf[4..]).unwrap(); + assert_eq!(out_str, "****"); + } + + #[test] + fn demangle_c_str_smaller() { + let mangled = "_ZN4testE\0"; + let mut out_buf: Vec<u8> = vec![42; 8]; + let res = unsafe { + super::rustc_demangle( + mangled.as_ptr() as *const c_char, + out_buf.as_mut_ptr() as *mut c_char, + 3, + ) + }; + assert_eq!(res, 0); + let out_str = std::str::from_utf8(&out_buf[3..]).unwrap(); + assert_eq!(out_str, "*****"); + } + + #[test] + fn demangle_c_str_zero() { + let mangled = "_ZN4testE\0"; + let mut out_buf: Vec<u8> = vec![42; 8]; + let res = unsafe { + super::rustc_demangle( + mangled.as_ptr() as *const c_char, + out_buf.as_mut_ptr() as *mut c_char, + 0, + ) + }; + assert_eq!(res, 0); + let out_str = std::str::from_utf8(&out_buf).unwrap(); + assert_eq!(out_str, "********"); + } + + #[test] + fn demangle_c_str_not_rust_symbol() { + let mangled = "la la la\0"; + let mut out_buf: Vec<u8> = vec![42; 8]; + let res = unsafe { + super::rustc_demangle( + mangled.as_ptr() as *const c_char, + out_buf.as_mut_ptr() as *mut c_char, + 8, + ) + }; + assert_eq!(res, 0); + } + + #[test] + fn demangle_c_str_null() { + let mangled = "\0"; + let mut out_buf: Vec<u8> = vec![42; 8]; + let res = unsafe { + super::rustc_demangle( + mangled.as_ptr() as *const c_char, + out_buf.as_mut_ptr() as *mut c_char, + 8, + ) + }; + assert_eq!(res, 0); + } + + #[test] + fn demangle_c_str_invalid_utf8() { + let mangled = [116, 101, 115, 116, 165, 0]; + let mut out_buf: Vec<u8> = vec![42; 8]; + let res = unsafe { + super::rustc_demangle( + mangled.as_ptr() as *const c_char, + out_buf.as_mut_ptr() as *mut c_char, + 8, + ) + }; + assert_eq!(res, 0); + } +} |