| Index: third_party/crashpad/crashpad/minidump/minidump_file_writer.h
|
| diff --git a/third_party/crashpad/crashpad/minidump/minidump_file_writer.h b/third_party/crashpad/crashpad/minidump/minidump_file_writer.h
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..8b738b649009172feedd66068632980b52fb7882
|
| --- /dev/null
|
| +++ b/third_party/crashpad/crashpad/minidump/minidump_file_writer.h
|
| @@ -0,0 +1,124 @@
|
| +// 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_FILE_WRITER_H_
|
| +#define CRASHPAD_MINIDUMP_MINIDUMP_FILE_WRITER_H_
|
| +
|
| +#include <windows.h>
|
| +#include <dbghelp.h>
|
| +#include <sys/types.h>
|
| +
|
| +#include <set>
|
| +#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_writable.h"
|
| +#include "util/file/file_io.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.
|
| + //!
|
| + //! At most one object of each stream type (as obtained from
|
| + //! internal::MinidumpStreamWriter::StreamType()) may be added to a
|
| + //! MinidumpFileWriter object. It is an error to attempt to add multiple
|
| + //! streams with the same stream type.
|
| + //!
|
| + //! \note Valid in #kStateMutable.
|
| + void AddStream(scoped_ptr<internal::MinidumpStreamWriter> stream);
|
| +
|
| + // MinidumpWritable:
|
| +
|
| + //! \copydoc internal::MinidumpWritable::WriteEverything()
|
| + //!
|
| + //! This method does not initially write the final value for
|
| + //! MINIDUMP_HEADER::Signature. After all child objects have been written, it
|
| + //! rewinds to the beginning of the file and writes the correct value for this
|
| + //! field. This prevents incompletely-written minidump files from being
|
| + //! mistaken for valid ones.
|
| + bool WriteEverything(FileWriterInterface* file_writer) override;
|
| +
|
| + protected:
|
| + // MinidumpWritable:
|
| + bool Freeze() override;
|
| + size_t SizeOfObject() override;
|
| + std::vector<MinidumpWritable*> Children() override;
|
| + bool WillWriteAtOffsetImpl(FileOffset offset) override;
|
| + bool WriteObject(FileWriterInterface* file_writer) override;
|
| +
|
| + private:
|
| + MINIDUMP_HEADER header_;
|
| + PointerVector<internal::MinidumpStreamWriter> streams_;
|
| +
|
| + // 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_
|
|
|