Add MinidumpFileWriter::InitializeFromSnapshot() and its tests

minidump/minidump_file_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,
@@ skipping 12 matching lines @@
 
 #include "base/basictypes.h"
 #include "base/memory/scoped_ptr.h"
 #include "minidump/minidump_extensions.h"
 #include "minidump/minidump_stream_writer.h"
 #include "minidump/minidump_writable.h"
 #include "util/stdlib/pointer_container.h"
 
 namespace crashpad {
 
+class ProcessSnapshot;
+
 //! \brief The root-level object in a minidump file.
 //!
 //! This object writes a MINIDUMP_HEADER and list of MINIDUMP_DIRECTORY entries
 //! to a minidump file.
 class MinidumpFileWriter final : public internal::MinidumpWritable {
  public:
   MinidumpFileWriter();
   ~MinidumpFileWriter() override;
 
+  //! \brief Initializes the MinidumpFileWriter and populates it with
+  //!     appropriate child streams based on \a process_snapshot.
+  //!
+  //! This method will add additional streams to the minidump file as children
+  //! of the MinidumpFileWriter object and as pointees of the top-level
+  //! MINIDUMP_DIRECTORY. To do so, it will obtain other snapshot information
+  //! from \a process_snapshot, such as a SystemSnapshot, lists of
+  //! ThreadSnapshot and ModuleSnapshot objects, and, if available, an
+  //! ExceptionSnapshot.
+  //!
+  //! The streams are added in the order that they are expected to be most
+  //! useful to minidump readers, to improve data locality and minimize seeking.
+  //! The streams are added in this order:
+  //!  - kMinidumpStreamTypeSystemInfo
+  //!  - kMinidumpStreamTypeMiscInfo
+  //!  - kMinidumpStreamTypeThreadList
+  //!  - kMinidumpStreamTypeException (if present)
+  //!  - kMinidumpStreamTypeModuleList
+  //!  - kMinidumpStreamTypeCrashpadInfo (if present)
+  //!  - kMinidumpStreamTypeMemoryList
+  //!
+  //! \param[in] process_snapshot The process snapshot to use as source data.
+  //!
+  //! \note Valid in #kStateMutable. No mutator methods may be called before
+  //!     this method, and it is not normally necessary to call any mutator
+  //!     methods after this method.
+  void InitializeFromSnapshot(const ProcessSnapshot* process_snapshot);
+
   //! \brief Sets MINIDUMP_HEADER::Timestamp.
   //!
   //! \note Valid in #kStateMutable.
   void SetTimestamp(time_t timestamp);
 
   //! \brief Adds a stream to the minidump file and arranges for a
   //!     MINIDUMP_DIRECTORY entry to point to it.
   //!
   //! This object takes ownership of \a stream and becomes its parent in the
   //! overall tree of internal::MinidumpWritable objects.
@@ skipping 31 matching lines @@
 
   // Protects against multiple streams with the same ID being added.
   std::set<MinidumpStreamType> stream_types_;
 
   DISALLOW_COPY_AND_ASSIGN(MinidumpFileWriter);
 };
 
 }  // namespace crashpad
 
 #endif  // CRASHPAD_MINIDUMP_MINIDUMP_WRITER_H_