mirror of
https://github.com/chromium/crashpad.git
synced 2025-03-10 06:36:02 +00:00
91cec09d93
To support MINIDUMP_THREAD_NAME_LIST (which uses 64-bit RVAs for the thread name MINIDUMP_STRING), this adds minidump string writing and reading support for the new 64-bit RVA64 and MINIDUMP_LOCATION_DESCRIPTOR64 types. Bug: crashpad:327 Change-Id: Iffefffef358517dfc6deac02051dff9dbb8eb214 Reviewed-on: https://chromium-review.googlesource.com/c/crashpad/crashpad/+/3673779 Reviewed-by: Joshua Peraza <jperaza@chromium.org> Commit-Queue: Ben Hamilton <benhamilton@google.com>
125 lines
4.9 KiB
C++
125 lines
4.9 KiB
C++
// Copyright 2014 The Crashpad Authors. All rights reserved.
|
||
//
|
||
// 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.
|
||
|
||
#ifndef CRASHPAD_MINIDUMP_TEST_MINIDUMP_STRING_WRITER_TEST_UTIL_H_
|
||
#define CRASHPAD_MINIDUMP_TEST_MINIDUMP_STRING_WRITER_TEST_UTIL_H_
|
||
|
||
#include <windows.h>
|
||
#include <dbghelp.h>
|
||
|
||
#include <string>
|
||
|
||
#include "minidump/minidump_extensions.h"
|
||
#include "minidump/test/minidump_writable_test_util.h"
|
||
|
||
#include "gtest/gtest.h"
|
||
|
||
namespace crashpad {
|
||
|
||
struct MinidumpUTF8String;
|
||
|
||
namespace test {
|
||
|
||
//! \brief Returns a MINIDUMP_STRING located within a minidump file’s contents.
|
||
//!
|
||
//! If \a rva points outside of the range of \a file_contents, if the string has
|
||
//! an incorrect length or is not `NUL`-terminated, or if any of the string data
|
||
//! would lie outside of the range of \a file_contents, this function will fail.
|
||
//!
|
||
//! \param[in] file_contents The contents of the minidump file.
|
||
//! \param[in] rva The offset within the minidump file of the desired
|
||
//! MINIDUMP_STRING.
|
||
//!
|
||
//! \return On success, a pointer to the MINIDUMP_STRING in \a file_contents. On
|
||
//! failure, raises a Google Test assertion and returns `nullptr`.
|
||
//!
|
||
//! \sa MinidumpStringAtRVAAsString()
|
||
//! \sa MinidumpUTF8StringAtRVA()
|
||
const MINIDUMP_STRING* MinidumpStringAtRVA(const std::string& file_contents,
|
||
RVA rva);
|
||
|
||
//! \brief 64-bit specialization of MinidumpStringAtRVA.
|
||
const MINIDUMP_STRING* MinidumpStringAtRVA(const std::string& file_contents,
|
||
RVA64 rva);
|
||
|
||
//! \brief Returns a MinidumpUTF8String located within a minidump file’s
|
||
//! contents.
|
||
//!
|
||
//! If \a rva points outside of the range of \a file_contents, if the string has
|
||
//! an incorrect length or is not `NUL`-terminated, or if any of the string data
|
||
//! would lie outside of the range of \a file_contents, this function will fail.
|
||
//!
|
||
//! \param[in] file_contents The contents of the minidump file.
|
||
//! \param[in] rva The offset within the minidump file of the desired
|
||
//! MinidumpUTF8String.
|
||
//!
|
||
//! \return On success, a pointer to the MinidumpUTF8String in \a file_contents.
|
||
//! On failure, raises a Google Test assertion and returns `nullptr`.
|
||
//!
|
||
//! \sa MinidumpUTF8StringAtRVAAsString()
|
||
//! \sa MinidumpStringAtRVA()
|
||
const MinidumpUTF8String* MinidumpUTF8StringAtRVA(
|
||
const std::string& file_contents,
|
||
RVA rva);
|
||
|
||
//! \brief 64-bit specialization of MinidumpUTF8StringAtRVA.
|
||
const MinidumpUTF8String* MinidumpUTF8StringAtRVA(
|
||
const std::string& file_contents,
|
||
RVA64 rva);
|
||
|
||
//! \brief Returns the contents of a MINIDUMP_STRING as a `std::u16string`.
|
||
//!
|
||
//! This function uses MinidumpStringAtRVA() to obtain a MINIDUMP_STRING, and
|
||
//! returns the string data as a `std::u16string`.
|
||
//!
|
||
//! \param[in] file_contents The contents of the minidump file.
|
||
//! \param[in] rva The offset within the minidump file of the desired
|
||
//! MINIDUMP_STRING.
|
||
//!
|
||
//! \return On success, the string read from \a file_writer at offset \a rva. On
|
||
//! failure, raises a Google Test assertion and returns an empty string.
|
||
//!
|
||
//! \sa MinidumpUTF8StringAtRVAAsString()
|
||
std::u16string MinidumpStringAtRVAAsString(const std::string& file_contents,
|
||
RVA rva);
|
||
|
||
//! \brief 64-bit specialization of MinidumpStringAtRVAAsString.
|
||
std::u16string MinidumpStringAtRVAAsString(const std::string& file_contents,
|
||
RVA64 rva);
|
||
|
||
//! \brief Returns the contents of a MinidumpUTF8String as a `std::string`.
|
||
//!
|
||
//! This function uses MinidumpUTF8StringAtRVA() to obtain a MinidumpUTF8String,
|
||
//! and returns the string data as a `std::string`.
|
||
//!
|
||
//! \param[in] file_contents The contents of the minidump file.
|
||
//! \param[in] rva The offset within the minidump file of the desired
|
||
//! MinidumpUTF8String.
|
||
//!
|
||
//! \return On success, the string read from \a file_writer at offset \a rva. On
|
||
//! failure, raises a Google Test assertion and returns an empty string.
|
||
//!
|
||
//! \sa MinidumpStringAtRVAAsString()
|
||
std::string MinidumpUTF8StringAtRVAAsString(const std::string& file_contents,
|
||
RVA rva);
|
||
|
||
//! \brief 64-bit specialization of MinidumpUTF8StringAtRVAAsString.
|
||
std::string MinidumpUTF8StringAtRVAAsString(const std::string& file_contents,
|
||
RVA64 rva);
|
||
|
||
} // namespace test
|
||
} // namespace crashpad
|
||
|
||
#endif // CRASHPAD_MINIDUMP_TEST_MINIDUMP_STRING_WRITER_TEST_UTIL_H_
|