Add MinidumpSystemInfoWriter and its test

minidump/minidump_system_info_writer.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_MINIDUMP_SYSTEM_INFO_WRITER_H_
+#define CRASHPAD_MINIDUMP_MINIDUMP_SYSTEM_INFO_WRITER_H_
+
+#include <dbghelp.h>
+#include <stdint.h>
+#include <sys/types.h>
+
+#include <string>
+#include <vector>
+
+#include "base/basictypes.h"
+#include "base/memory/scoped_ptr.h"
+#include "minidump/minidump_extensions.h"
+#include "minidump/minidump_stream_writer.h"
+#include "minidump/minidump_string_writer.h"

[Robert Sesek, 2014/08/06 17:35:46]

You could forward-declare this instead.

[Mark Mentovai, 2014/08/06 18:14:03]

rsesek wrote:
I haven’t used any forward declarations except where needed to break up circular
relationships. I’d prefer not to forward-declare.

+#include "minidump/minidump_writable.h"
+#include "util/file/file_writer.h"
+
+namespace crashpad {
+
+//! \brief The writer for a MINIDUMP_SYSTEM_INFO stream in a minidump file.

[Robert Sesek, 2014/08/06 17:35:47]

\ref MINIDUMP_SYSTEM_INFO ?

[Mark Mentovai, 2014/08/06 18:14:03]

rsesek wrote:
Doxygen turns this into a link without a \ref.
http://www.doxygen.org/manual/autolink.html#linkclass.

I put the generated docs at
http://doxygen.crashpad.googlecode.com/git/index.html, although those correspond
to the current master HEAD, not this change.

+class MinidumpSystemInfoWriter final : public internal::MinidumpStreamWriter {
+ public:
+  MinidumpSystemInfoWriter();
+  ~MinidumpSystemInfoWriter();
+
+  //! \brief Sets MINIDUMP_SYSTEM_INFO::ProcessorArchitecture.

[Robert Sesek, 2014/08/06 17:35:47]

Doxygen auto-hyperlinks with the :: right?

[Mark Mentovai, 2014/08/06 18:14:03]

rsesek wrote:
Yup, that’s what this is all about.

+  void SetCPUArchitecture(MinidumpCPUArchitecture processor_architecture) {
+    system_info_.ProcessorArchitecture = processor_architecture;
+  }
+
+  //! \brief Sets MINIDUMP_SYSTEM_INFO::ProcessorLevel and
+  //!     MINIDUMP_SYSTEM_INFO::ProcessorRevision.
+  void SetCPULevelAndRevision(uint16_t processor_level,
+                              uint16_t processor_revision) {
+    system_info_.ProcessorLevel = processor_level;
+    system_info_.ProcessorRevision = processor_revision;
+  }
+
+  //! \brief Sets MINIDUMP_SYSTEM_INFO::NumberOfProcessors.
+  void SetCPUCount(uint8_t number_of_processors) {
+    system_info_.NumberOfProcessors = number_of_processors;
+  }
+
+  //! \brief Sets MINIDUMP_SYSTEM_INFO::PlatformId.
+  void SetOS(MinidumpOS platform_id) { system_info_.PlatformId = platform_id; }
+
+  //! \brief Sets MINIDUMP_SYSTEM_INFO::ProductType.
+  void SetOSType(MinidumpOSType product_type) {
+    system_info_.ProductType = product_type;
+  }
+
+  //! \brief Sets MINIDUMP_SYSTEM_INFO::MajorVersion,
+  //!     MINIDUMP_SYSTEM_INFO::MinorVersion, and
+  //!     MINIDUMP_SYSTEM_INFO::BuildNumber.
+  void SetOSVersion(uint32_t major_version,
+                    uint32_t minor_version,
+                    uint32_t build_number) {
+    system_info_.MajorVersion = major_version;
+    system_info_.MinorVersion = minor_version;
+    system_info_.BuildNumber = build_number;
+  }
+
+  //! \brief Arranges for MINIDUMP_SYSTEM_INFO::CSDVersionRva to point to a
+  //!     MINIDUMP_STRING containing the supplied string.
+  //!
+  //! This method must be called prior to Freeze(). A CSD version is required
+  //! in all MINIDUMP_SYSTEM_INFO streams. An empty string is an acceptable
+  //! value.
+  void SetCSDVersion(const std::string& csd_version);
+
+  //! \brief Sets MINIDUMP_SYSTEM_INFO::SuiteMask.
+  void SetSuiteMask(uint16_t suite_mask) {
+    system_info_.SuiteMask = suite_mask;
+  }
+
+  //! \brief Sets \ref CPU_INFORMATION::VendorId

[Robert Sesek, 2014/08/06 17:35:47]

Why do you \ref here and on line 108, but not above when referencing the
MINIDUMP_SYSTME_INFO fields?

[Mark Mentovai, 2014/08/06 18:14:03]

rsesek wrote:
Doxygen has a bug where it doesn’t see through a type defined in a struct very
well, so it thinks that VendorId needs to be called CPU_INFORMATION::VendorId,
not CPU_INFORMATION::X86CpuInfo::VendorId. The latter is correct.

Because MINIDUMP_SYSTEM_INFO is what this class is concerned with writing, I
wrote the documentation in terms of that struct, which has a CPU_INFORMATION Cpu
field, so the qualified name in the generated documentation is
MINIDUMP_SYSTEM_INFO::Cpu::X86CpuInfo::VendorId.

+  //!     "MINIDUMP_SYSTEM_INFO::Cpu::X86CpuInfoInfo::VendorId".
+  //!
+  //! This is only valid if SetCPUArchitecture() has been used to set the CPU
+  //! architecture to #kMinidumpCPUArchitectureX86 or
+  //! #kMinidumpCPUArchitectureX86Win64.
+  //!
+  //! \param[in] ebx The first 4 bytes of the CPU vendor string, the value
+  //!     reported in `cpuid 0` `ebx`.
+  //! \param[in] edx The middle 4 bytes of the CPU vendor string, the value
+  //!     reported in `cpuid 0` `edx`.
+  //! \param[in] ecx The last 4 bytes of the CPU vendor string, the value
+  //!     reported by `cpuid 0` `ecx`.
+  //!
+  //! \sa SetCPUX86VendorString()
+  void SetCPUX86Vendor(uint32_t ebx, uint32_t edx, uint32_t ecx);
+
+  //! \brief Sets \ref CPU_INFORMATION::VendorId
+  //!     "MINIDUMP_SYSTEM_INFO::Cpu::X86CpuInfoInfo::VendorId".
+  //!
+  //! This is only valid if SetCPUArchitecture() has been used to set the CPU
+  //! architecture to #kMinidumpCPUArchitectureX86 or
+  //! #kMinidumpCPUArchitectureX86Win64.
+  //!
+  //! \param[in] vendor The entire CPU vendor string, which must be exactly 12
+  //!     bytes long.
+  //!
+  //! \sa SetCPUX86Vendor()
+  void SetCPUX86VendorString(const std::string& vendor);
+
+  //! \brief Sets \ref CPU_INFORMATION::VersionInformation
+  //!     "MINIDUMP_SYSTEM_INFO::Cpu::X86CpuInfoInfo::VersionInformation" and
+  //!     \ref CPU_INFORMATION::FeatureInformation
+  //!     "MINIDUMP_SYSTEM_INFO::Cpu::X86CpuInfoInfo::FeatureInformation".
+  //!
+  //! This is only valid if SetCPUArchitecture() has been used to set the CPU
+  //! architecture to #kMinidumpCPUArchitectureX86 or
+  //! #kMinidumpCPUArchitectureX86Win64.
+  void SetCPUX86VersionAndFeatures(uint32_t version, uint32_t features);
+
+  //! \brief Sets \ref CPU_INFORMATION::AMDExtendedCpuFeatures
+  //!     "MINIDUMP_SYSTEM_INFO::Cpu::X86CpuInfoInfo::AMDExtendedCPUFeatures".
+  //!
+  //! This is only valid if SetCPUArchitecture() has been used to set the CPU
+  //! architecture to #kMinidumpCPUArchitectureX86 or
+  //! #kMinidumpCPUArchitectureX86Win64, and if SetCPUX86Vendor() or
+  //! SetCPUX86VendorString() has been used to set the CPU vendor to
+  //! “AuthenticAMD”.
+  void SetCPUX86AMDExtendedFeatures(uint32_t extended_features);
+
+  //! \brief Sets \ref CPU_INFORMATION::ProcessorFeatures
+  //!     "MINIDUMP_SYSTEM_INFO::Cpu::OtherCpuInfoInfo::ProcessorFeatures".
+  //!
+  //! This is only valid if SetCPUArchitecture() has been used to set the CPU
+  //! architecture to an architecture other than #kMinidumpCPUArchitectureX86
+  //! or #kMinidumpCPUArchitectureX86Win64.
+  void SetCPUOtherFeatures(uint64_t features_0, uint64_t features_1);
+
+ protected:
+  // MinidumpWritable:
+  virtual bool Freeze() override;
+  virtual size_t SizeOfObject() override;
+  virtual std::vector<MinidumpWritable*> Children() override;
+  virtual bool WriteObject(FileWriterInterface* file_writer) override;
+
+  // MinidumpStreamWriter:
+  virtual MinidumpStreamType StreamType() const override;
+
+ private:
+  MINIDUMP_SYSTEM_INFO system_info_;
+  scoped_ptr<internal::MinidumpUTF16StringWriter> csd_version_;
+
+  DISALLOW_COPY_AND_ASSIGN(MinidumpSystemInfoWriter);
+};
+
+}  // namespace crashpad
+
+#endif  // CRASHPAD_MINIDUMP_MINIDUMP_SYSTEM_INFO_WRITER_H_