MinidumpLocationDescriptorListWriter

minidump/minidump_extensions.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,
@@ skipping 278 matching lines @@
 
   //! \brief The path or file name of the `.pdb` file associated with the
   //!     module.
   //!
   //! This is a NUL-terminated string. On Windows, it will be encoded in the
   //! code page of the system that linked the module. On other operating
   //! systems, UTF-8 may be used.
   uint8_t pdb_name[1];
 };
 
+//! \brief A list of MINIDUMP_LOCATION_DESCRIPTOR objects.
+struct __attribute__((packed, aligned(4))) MinidumpLocationDescriptorList {
+  //! \brief The number of children present in the #children array.
+  uint32_t count;
+
+  //! \brief Pointers to other structures in the minidump file.
+  MINIDUMP_LOCATION_DESCRIPTOR children[0];
+};
+
 //! \brief A key-value pair.
 struct __attribute__((packed, aligned(4))) MinidumpSimpleStringDictionaryEntry {
   //! \brief ::RVA of a MinidumpUTF8String containing the key of a key-value
   //!     pair.
   RVA key;
 
   //! \brief ::RVA of a MinidumpUTF8String containing the value of a key-value
   //!     pair.
   RVA value;
 };
@@ skipping 14 matching lines @@
 //! minidump file must contain a module list stream
 //! (::kMinidumpStreamTypeModuleList) in order for this structure to appear.
 //!
 //! This structure is versioned. When changing this structure, leave the
 //! existing structure intact so that earlier parsers will be able to understand
 //! the fields they are aware of, and make additions at the end of the
 //! structure. Revise #kVersion and document each field’s validity based on
 //! #version, so that newer parsers will be able to determine whether the added
 //! fields are valid or not.
 //!
-//! \sa MinidumpModuleCrashpadInfoList
+//! \sa #MinidumpModuleCrashpadInfoList
 struct __attribute__((packed, aligned(4))) MinidumpModuleCrashpadInfo {
   //! \brief The structure’s currently-defined version number.
   //!
   //! \sa version
   static const uint32_t kVersion = 1;
 
   //! \brief The structure’s version number.
   //!
   //! Readers can use this field to determine which other fields in the
   //! structure are valid. Upon encountering a value greater than #kVersion, a
@@ skipping 18 matching lines @@
   //! This field is present when #version is at least `1`.
   MINIDUMP_LOCATION_DESCRIPTOR simple_annotations;
 };
 
 //! \brief Additional Crashpad-specific information about modules carried within
 //!     a minidump file.
 //!
 //! This structure augments the information provided by
 //! MINIDUMP_MODULE_LIST. The minidump file must contain a module list stream
 //! (::kMinidumpStreamTypeModuleList) in order for this structure to appear.
-struct __attribute__((packed, aligned(4))) MinidumpModuleCrashpadInfoList {
-  //! \brief The number of modules present in the #modules array.
-  //!
-  //! This may be less than the value of MINIDUMP_MODULE_LIST::NumberOfModules
-  //! because not every MINIDUMP_MODULE structure carried within the minidump
-  //! file will necessarily have Crashpad-specific information provided by a
-  //! MinidumpModuleCrashpadInfo structure.
-  uint32_t count;
-
-  //! \brief Pointers to MinidumpModuleCrashpadInfo structures.
-  //!
-  //! These are referenced indirectly through MINIDUMP_LOCATION_DESCRIPTOR
-  //! pointers to allow for future growth of the MinidumpModuleCrashpadInfo
-  //! structure.
-  MINIDUMP_LOCATION_DESCRIPTOR modules[0];
-};
+//!
+//! MinidumpModuleCrashpadInfoList::count may be less than the value of
+//! MINIDUMP_MODULE_LIST::NumberOfModules because not every MINIDUMP_MODULE
+//! structure carried within the minidump file will necessarily have
+//! Crashpad-specific information provided by a MinidumpModuleCrashpadInfo
+//! structure.
+//!
+//! MinidumpModuleCrashpadInfoList::children references
+//! MinidumpModuleCrashpadInfo children indirectly through
+//! MINIDUMP_LOCATION_DESCRIPTOR pointers to allow for future growth of the
+//! MinidumpModuleCrashpadInfo structure.
+using MinidumpModuleCrashpadInfoList = MinidumpLocationDescriptorList;
 
 //! \brief Additional Crashpad-specific information carried within a minidump
 //!     file.
 //!
 //! This structure is versioned. When changing this structure, leave the
 //! existing structure intact so that earlier parsers will be able to understand
 //! the fields they are aware of, and make additions at the end of the
 //! structure. Revise #kVersion and document each field’s validity based on
 //! #version, so that newer parsers will be able to determine whether the added
 //! fields are valid or not.
 struct __attribute__((packed, aligned(4))) MinidumpCrashpadInfo {
   //! \brief The structure’s currently-defined version number.
   //!
   //! \sa version
   static const uint32_t kVersion = 1;
 
   //! \brief The structure’s version number.
   //!
   //! Readers can use this field to determine which other fields in the
   //! structure are valid. Upon encountering a value greater than #kVersion, a
   //! reader should assume that the structure’s layout is compatible with the
   //! structure defined as having value #kVersion.
   //!
   //! Writers may produce values less than #kVersion in this field if there is
   //! no need for any fields present in later versions.
   uint32_t version;
 
-  //! \brief A pointer to a MinidumpModuleCrashpadInfoList structure.
+  //! \brief A pointer to a #MinidumpModuleCrashpadInfoList structure.
   //!
   //! This field is present when #version is at least `1`.
   MINIDUMP_LOCATION_DESCRIPTOR module_list;
 };
 
 }  // namespace crashpad
 
 #endif  // CRASHPAD_MINIDUMP_MINIDUMP_EXTENSIONS_H_