Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1005)

Unified Diff: third_party/crashpad/crashpad/minidump/minidump_thread_writer.h

Issue 1505213004: Copy Crashpad into the Chrome tree instead of importing it via DEPS (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Address review comments, update README.chromium Created 5 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: third_party/crashpad/crashpad/minidump/minidump_thread_writer.h
diff --git a/third_party/crashpad/crashpad/minidump/minidump_thread_writer.h b/third_party/crashpad/crashpad/minidump/minidump_thread_writer.h
new file mode 100644
index 0000000000000000000000000000000000000000..f8b7d20106de795a8e4ff0dc61cfcea8494e4f20
--- /dev/null
+++ b/third_party/crashpad/crashpad/minidump/minidump_thread_writer.h
@@ -0,0 +1,214 @@
+// 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_THREAD_WRITER_H_
+#define CRASHPAD_MINIDUMP_MINIDUMP_THREAD_WRITER_H_
+
+#include <windows.h>
+#include <dbghelp.h>
+#include <stdint.h>
+
+#include <vector>
+
+#include "base/basictypes.h"
+#include "base/memory/scoped_ptr.h"
+#include "minidump/minidump_stream_writer.h"
+#include "minidump/minidump_thread_id_map.h"
+#include "minidump/minidump_writable.h"
+#include "util/stdlib/pointer_container.h"
+
+namespace crashpad {
+
+class MinidumpContextWriter;
+class MinidumpMemoryListWriter;
+class MinidumpMemoryWriter;
+class ThreadSnapshot;
+
+//! \brief The writer for a MINIDUMP_THREAD object in a minidump file.
+//!
+//! Because MINIDUMP_THREAD objects only appear as elements of
+//! MINIDUMP_THREAD_LIST objects, this class does not write any data on its own.
+//! It makes its MINIDUMP_THREAD data available to its MinidumpThreadListWriter
+//! parent, which writes it as part of a MINIDUMP_THREAD_LIST.
+class MinidumpThreadWriter final : public internal::MinidumpWritable {
+ public:
+ MinidumpThreadWriter();
+ ~MinidumpThreadWriter() override;
+
+ //! \brief Initializes the MINIDUMP_THREAD based on \a thread_snapshot.
+ //!
+ //! \param[in] thread_snapshot The thread snapshot to use as source data.
+ //! \param[in] thread_id_map A MinidumpThreadIDMap to be consulted to
+ //! determine the 32-bit minidump thread ID to use for \a thread_snapshot.
+ //!
+ //! \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 ThreadSnapshot* thread_snapshot,
+ const MinidumpThreadIDMap* thread_id_map);
+
+ //! \brief Returns a MINIDUMP_THREAD referencing this object’s data.
+ //!
+ //! This method is expected to be called by a MinidumpThreadListWriter in
+ //! order to obtain a MINIDUMP_THREAD to include in its list.
+ //!
+ //! \note Valid in #kStateWritable.
+ const MINIDUMP_THREAD* MinidumpThread() const;
+
+ //! \brief Returns a MinidumpMemoryWriter that will write the memory region
+ //! corresponding to this object’s stack.
+ //!
+ //! If the thread does not have a stack, or its stack could not be determined,
+ //! this will return `nullptr`.
+ //!
+ //! This method is provided so that MinidumpThreadListWriter can obtain thread
+ //! stack memory regions for the purposes of adding them to a
+ //! MinidumpMemoryListWriter (configured by calling
+ //! MinidumpThreadListWriter::SetMemoryListWriter()) by calling
+ //! MinidumpMemoryListWriter::AddExtraMemory().
+ //!
+ //! \note Valid in any state.
+ MinidumpMemoryWriter* Stack() const { return stack_.get(); }
+
+ //! \brief Arranges for MINIDUMP_THREAD::Stack to point to the MINIDUMP_MEMORY
+ //! object to be written by \a stack.
+ //!
+ //! This object takes ownership of \a stack and becomes its parent in the
+ //! overall tree of internal::MinidumpWritable objects.
+ //!
+ //! \note Valid in #kStateMutable.
+ void SetStack(scoped_ptr<MinidumpMemoryWriter> stack);
+
+ //! \brief Arranges for MINIDUMP_THREAD::ThreadContext to point to the CPU
+ //! context to be written by \a context.
+ //!
+ //! A context is required in all MINIDUMP_THREAD objects.
+ //!
+ //! This object takes ownership of \a context and becomes its parent in the
+ //! overall tree of internal::MinidumpWritable objects.
+ //!
+ //! \note Valid in #kStateMutable.
+ void SetContext(scoped_ptr<MinidumpContextWriter> context);
+
+ //! \brief Sets MINIDUMP_THREAD::ThreadId.
+ void SetThreadID(uint32_t thread_id) { thread_.ThreadId = thread_id; }
+
+ //! \brief Sets MINIDUMP_THREAD::SuspendCount.
+ void SetSuspendCount(uint32_t suspend_count) {
+ thread_.SuspendCount = suspend_count;
+ }
+
+ //! \brief Sets MINIDUMP_THREAD::PriorityClass.
+ void SetPriorityClass(uint32_t priority_class) {
+ thread_.PriorityClass = priority_class;
+ }
+
+ //! \brief Sets MINIDUMP_THREAD::Priority.
+ void SetPriority(uint32_t priority) { thread_.Priority = priority; }
+
+ //! \brief Sets MINIDUMP_THREAD::Teb.
+ void SetTEB(uint64_t teb) { thread_.Teb = teb; }
+
+ protected:
+ // MinidumpWritable:
+ bool Freeze() override;
+ size_t SizeOfObject() override;
+ std::vector<MinidumpWritable*> Children() override;
+ bool WriteObject(FileWriterInterface* file_writer) override;
+
+ private:
+ MINIDUMP_THREAD thread_;
+ scoped_ptr<MinidumpMemoryWriter> stack_;
+ scoped_ptr<MinidumpContextWriter> context_;
+
+ DISALLOW_COPY_AND_ASSIGN(MinidumpThreadWriter);
+};
+
+//! \brief The writer for a MINIDUMP_THREAD_LIST stream in a minidump file,
+//! containing a list of MINIDUMP_THREAD objects.
+class MinidumpThreadListWriter final : public internal::MinidumpStreamWriter {
+ public:
+ MinidumpThreadListWriter();
+ ~MinidumpThreadListWriter() override;
+
+ //! \brief Adds an initialized MINIDUMP_THREAD for each thread in \a
+ //! thread_snapshots to the MINIDUMP_THREAD_LIST.
+ //!
+ //! \param[in] thread_snapshots The thread snapshots to use as source data.
+ //! \param[out] thread_id_map A MinidumpThreadIDMap to be built by this
+ //! method. This map must be empty when this method is called.
+ //!
+ //! \note Valid in #kStateMutable. AddThread() may not be called before this
+ //! method, and it is not normally necessary to call AddThread() after
+ //! this method.
+ void InitializeFromSnapshot(
+ const std::vector<const ThreadSnapshot*>& thread_snapshots,
+ MinidumpThreadIDMap* thread_id_map);
+
+ //! \brief Sets the MinidumpMemoryListWriter that each thread’s stack memory
+ //! region should be added to as extra memory.
+ //!
+ //! Each MINIDUMP_THREAD object can contain a reference to a
+ //! MinidumpMemoryWriter object that contains a snapshot of its stack memory.
+ //! In the overall tree of internal::MinidumpWritable objects, these
+ //! MinidumpMemoryWriter objects are considered children of their
+ //! MINIDUMP_THREAD, and are referenced by a MINIDUMP_MEMORY_DESCRIPTOR
+ //! contained in the MINIDUMP_THREAD. It is also possible for the same memory
+ //! regions to have MINIDUMP_MEMORY_DESCRIPTOR objects present in a
+ //! MINIDUMP_MEMORY_LIST stream. This is accomplished by calling this method,
+ //! which informs a MinidumpThreadListWriter that it should call
+ //! MinidumpMemoryListWriter::AddExtraMemory() for each extant thread stack
+ //! while the thread is being added in AddThread(). When this is done, the
+ //! MinidumpMemoryListWriter will contain a MINIDUMP_MEMORY_DESCRIPTOR
+ //! pointing to the thread’s stack memory in its MINIDUMP_MEMORY_LIST. Note
+ //! that the actual contents of the memory is only written once, as a child of
+ //! the MinidumpThreadWriter. The MINIDUMP_MEMORY_DESCRIPTOR objects in both
+ //! the MINIDUMP_THREAD and MINIDUMP_MEMORY_LIST will point to the same copy
+ //! of the memory’s contents.
+ //!
+ //! \note This method must be called before AddThread() is called. Threads
+ //! added by AddThread() prior to this method being called will not have
+ //! their stacks added to \a memory_list_writer as extra memory.
+ //! \note Valid in #kStateMutable.
+ void SetMemoryListWriter(MinidumpMemoryListWriter* memory_list_writer);
+
+ //! \brief Adds a MinidumpThreadWriter to the MINIDUMP_THREAD_LIST.
+ //!
+ //! This object takes ownership of \a thread and becomes its parent in the
+ //! overall tree of internal::MinidumpWritable objects.
+ //!
+ //! \note Valid in #kStateMutable.
+ void AddThread(scoped_ptr<MinidumpThreadWriter> thread);
+
+ protected:
+ // MinidumpWritable:
+ bool Freeze() override;
+ size_t SizeOfObject() override;
+ std::vector<MinidumpWritable*> Children() override;
+ bool WriteObject(FileWriterInterface* file_writer) override;
+
+ // MinidumpStreamWriter:
+ MinidumpStreamType StreamType() const override;
+
+ private:
+ PointerVector<MinidumpThreadWriter> threads_;
+ MinidumpMemoryListWriter* memory_list_writer_; // weak
+ MINIDUMP_THREAD_LIST thread_list_base_;
+
+ DISALLOW_COPY_AND_ASSIGN(MinidumpThreadListWriter);
+};
+
+} // namespace crashpad
+
+#endif // CRASHPAD_MINIDUMP_MINIDUMP_THREAD_WRITER_H_

Powered by Google App Engine
This is Rietveld 408576698