minidump: stronger checking for MinidumpWritableAtRVA<>()

minidump/test/minidump_writable_test_util.h

 // 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_WRITABLE_TEST_UTIL_H_
 #define CRASHPAD_MINIDUMP_TEST_MINIDUMP_WRITABLE_TEST_UTIL_H_
 
 #include <dbghelp.h>
 #include <stdint.h>
 
 #include <string>
 
 #include "gtest/gtest.h"
 #include "minidump/minidump_extensions.h"
 
 namespace crashpad {
 namespace test {
 
 //! \brief Returns an untyped minidump object located within a minidump file’s
-//!     contents, where the offset of the object is known.
-//!
-//! \param[in] file_contents The contents of the minidump file.
-//! \param[in] rva The offset within the minidump file of the desired object.
-//!
-//! \return If \a rva is within the range of \a file_contents, returns a pointer
-//!     into \a file_contents at offset \a rva. Otherwise, raises a gtest
-//!     assertion failure and returns `nullptr`.
-//!
-//! Do not call this function. Use the typed version, MinidumpWritableAtRVA<>(),
-//! or another type-specific function.
-//!
-//! \sa MinidumpWritableAtLocationDescriptorInternal()
-const void* MinidumpWritableAtRVAInternal(const std::string& file_contents,
-                                          RVA rva);
-
-//! \brief Returns an untyped minidump object located within a minidump file’s
 //!     contents, where the offset and size of the object are known.
 //!
 //! \param[in] file_contents The contents of the minidump file.
 //! \param[in] location A MINIDUMP_LOCATION_DESCRIPTOR giving the offset within
 //!     the minidump file of the desired object, as well as its size.
 //! \param[in] expected_size The expected size of the object. If \a
 //!     allow_oversized_data is `true`, \a expected_size is treated as the
 //!     minimum size of \a location, but it is permitted to be larger. If \a
 //!     allow_oversized_data is `false`, the size of \a location must match
 //!     \a expected_size exactly.
 //! \param[in] allow_oversized_data Controls whether \a expected_size is a
 //!     minimum limit (`true`) or an exact match is required (`false`).
 //!
 //! \return If the size of \a location is agrees with \a expected_size, and if
 //!     \a location is within the range of \a file_contents, returns a pointer
 //!     into \a file_contents at offset \a rva. Otherwise, raises a gtest
 //!     assertion failure and returns `nullptr`.
 //!
 //! Do not call this function. Use the typed version,
 //! MinidumpWritableAtLocationDescriptor<>(), or another type-specific function.
-//!
-//! \sa MinidumpWritableAtRVAInternal()
 const void* MinidumpWritableAtLocationDescriptorInternal(
     const std::string& file_contents,
     const MINIDUMP_LOCATION_DESCRIPTOR& location,
     size_t expected_size,
     bool allow_oversized_data);
 
 //! \brief A traits class defining whether a minidump object type is required to
 //!     appear only as a fixed-size object or if it is variable-sized.
 //!
 //! Variable-sized data is data referenced by a MINIDUMP_LOCATION_DESCRIPTOR
@@ skipping 34 matching lines @@
 MINIDUMP_ALLOW_OVERSIZED_DATA(MinidumpModuleCodeViewRecordPDB70);
 MINIDUMP_ALLOW_OVERSIZED_DATA(MinidumpUTF8String);
 
 // minidump_file_writer_test accesses its variable-sized test streams via a
 // uint8_t*.
 MINIDUMP_ALLOW_OVERSIZED_DATA(uint8_t);
 
 #undef MINIDUMP_ALLOW_OVERSIZED_DATA
 
 //! \brief Returns a typed minidump object located within a minidump file’s
-//!     contents, where the offset of the object is known.
-//!
-//! \param[in] file_contents The contents of the minidump file.
-//! \param[in] rva The offset within the minidump file of the desired object.
-//!
-//! \return If \a rva is within the range of \a file_contents, returns a pointer
-//!     into \a file_contents at offset \a rva. Otherwise, raises a gtest
-//!     assertion failure and returns `nullptr`.
-//!
-//! \sa MinidumpWritableAtLocationDescriptor<>()
-template <typename T>
-const T* MinidumpWritableAtRVA(const std::string& file_contents, RVA rva) {
-  return reinterpret_cast<const T*>(
-      MinidumpWritableAtRVAInternal(file_contents, rva));
-}
-
-//! \brief Returns a typed minidump object located within a minidump file’s
 //!     contents, where the offset and size of the object are known.
 //!
 //! This function is similar to MinidumpWritableAtLocationDescriptor<>() and is
 //! used to implement that function. It exists independently so that template
 //! specializations are able to call this function, which provides the default
 //! implementation.
 //!
 //! Do not call this function directly. Use
 //! MinidumpWritableAtLocationDescriptor<>() instead.
 template <typename T>
@@ skipping 84 matching lines @@
 MinidumpWritableAtLocationDescriptor<MinidumpModuleCodeViewRecordPDB70>(
     const std::string& file_contents,
     const MINIDUMP_LOCATION_DESCRIPTOR& location);
 
 template <>
 const MinidumpSimpleStringDictionary*
 MinidumpWritableAtLocationDescriptor<MinidumpSimpleStringDictionary>(
     const std::string& file_contents,
     const MINIDUMP_LOCATION_DESCRIPTOR& location);
 
+//! \brief Returns a typed minidump object located within a minidump file’s
+//!     contents, where the offset of the object is known.
+//!
+//! \param[in] file_contents The contents of the minidump file.
+//! \param[in] rva The offset within the minidump file of the desired object.
+//!
+//! \return If \a rva plus the size of an object of type \a T is within the
+//!     range of \a file_contents, returns a pointer into \a file_contents at
+//!     offset \a rva. Otherwise, raises a gtest assertion failure and returns
+//!     `nullptr`.
+//!
+//! \sa MinidumpWritableAtLocationDescriptor<>()
+template <typename T>
+const T* MinidumpWritableAtRVA(const std::string& file_contents, RVA rva) {
+  MINIDUMP_LOCATION_DESCRIPTOR location;
+  location.DataSize = sizeof(T);
+  location.Rva = rva;
+  return MinidumpWritableAtLocationDescriptor<T>(file_contents, location);
+}
+
 }  // namespace test
 }  // namespace crashpad
 
 #endif  // CRASHPAD_MINIDUMP_TEST_MINIDUMP_WRITABLE_TEST_UTIL_H_