debugging/internal/demangle_rust.h

0001 // Copyright 2024 The Abseil Authors
0002 //
0003 // Licensed under the Apache License, Version 2.0 (the "License");
0004 // you may not use this file except in compliance with the License.
0005 // You may obtain a copy of the License at
0006 //
0007 //     https://www.apache.org/licenses/LICENSE-2.0
0008 //
0009 // Unless required by applicable law or agreed to in writing, software
0010 // distributed under the License is distributed on an "AS IS" BASIS,
0011 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0012 // See the License for the specific language governing permissions and
0013 // limitations under the License.
0014
0015 #ifndef ABSL_DEBUGGING_INTERNAL_DEMANGLE_RUST_H_
0016 #define ABSL_DEBUGGING_INTERNAL_DEMANGLE_RUST_H_
0017
0018 #include <cstddef>
0019
0020 #include "absl/base/config.h"
0021
0022 namespace absl {
0023 ABSL_NAMESPACE_BEGIN
0024 namespace debugging_internal {
0025
0026 // Demangle the Rust encoding `mangled`.  On success, return true and write the
0027 // demangled symbol name to `out`.  Otherwise, return false, leaving unspecified
0028 // contents in `out`.  For example, calling DemangleRustSymbolEncoding with
0029 // `mangled = "_RNvC8my_crate7my_func"` will yield `my_crate::my_func` in `out`,
0030 // provided `out_size` is large enough for that value and its trailing NUL.
0031 //
0032 // DemangleRustSymbolEncoding is async-signal-safe and runs in bounded C++
0033 // call-stack space.  It is suitable for symbolizing stack traces in a signal
0034 // handler.
0035 bool DemangleRustSymbolEncoding(const char* mangled, char* out,
0036                                 size_t out_size);
0037
0038 }  // namespace debugging_internal
0039 ABSL_NAMESPACE_END
0040 }  // namespace absl
0041
0042 #endif  // ABSL_DEBUGGING_INTERNAL_DEMANGLE_RUST_H_