crashpad/minidump/minidump_exception_writer.h
Mark Mentovai 0a4ea0b52d minidump: Change the ownership model.
All minidump objects now own their all of their children, rather than
having them maintain weak pointers and requiring callers to maintain
ownership.

The only weak object in the entire tree now is the “extra memory” added
to a MinidumpMemoryListWriter by its AddExtraMemory() method. Extra
memory aliases objects owned elsewhere in the tree, typically by a
MinidumpThreadWriter as stack memory. Non-“extra” memory added to a
MinidumpMemoryListWriter by its AddMemory() method is strongly owned.

Many objects are now deleted through base pointers, and in those cases,
the base classes now have public virtual destructors. The ultimate base,
MinidumpWritable, is still protected to guard against direct
instantiation and deletion, and thus its destructor does not need to be
virtual.

This updates mini_chromium to eeb3b6a4f020 specifically for that
revision, which includes necessary updates to scoped_ptr. It also picks
up:

eeb3b6a4f020 Update base/move.h and base/memory/scoped_ptr.h to match
67ad2efafaba More porting to Windows
be27a006421e AUTHORS: Fix link post-git migration flag day.
05f5b1503230 Add codereview.settings to mini_chromium.
a32c2b199811 Beginnings of Windows support in mini_chromium

TEST=minidump_test
R=rsesek@chromium.org

Review URL: https://codereview.chromium.org/674153002
2014-10-27 15:01:39 -04:00

107 lines
3.6 KiB
C++

// 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_EXCEPTION_WRITER_H_
#define CRASHPAD_MINIDUMP_MINIDUMP_EXCEPTION_WRITER_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"
namespace crashpad {
class MinidumpContextWriter;
//! \brief The writer for a MINIDUMP_EXCEPTION_STREAM stream in a minidump file.
class MinidumpExceptionWriter final : public internal::MinidumpStreamWriter {
public:
MinidumpExceptionWriter();
~MinidumpExceptionWriter() override;
//! \brief Arranges for MINIDUMP_EXCEPTION_STREAM::ThreadContext to point to
//! the CPU context to be written by \a context.
//!
//! A context is required in all MINIDUMP_EXCEPTION_STREAM 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_EXCEPTION_STREAM::ThreadId.
void SetThreadID(uint32_t thread_id) { exception_.ThreadId = thread_id; }
//! \brief Sets MINIDUMP_EXCEPTION::ExceptionCode.
void SetExceptionCode(uint32_t exception_code) {
exception_.ExceptionRecord.ExceptionCode = exception_code;
}
//! \brief Sets MINIDUMP_EXCEPTION::ExceptionFlags.
void SetExceptionFlags(uint32_t exception_flags) {
exception_.ExceptionRecord.ExceptionFlags = exception_flags;
}
//! \brief Sets MINIDUMP_EXCEPTION::ExceptionRecord.
void SetExceptionRecord(uint64_t exception_record) {
exception_.ExceptionRecord.ExceptionRecord = exception_record;
}
//! \brief Sets MINIDUMP_EXCEPTION::ExceptionAddress.
void SetExceptionAddress(uint64_t exception_address) {
exception_.ExceptionRecord.ExceptionAddress = exception_address;
}
//! \brief Sets MINIDUMP_EXCEPTION::ExceptionInformation and
//! MINIDUMP_EXCEPTION::NumberParameters.
//!
//! MINIDUMP_EXCEPTION::NumberParameters is set to the number of elements in
//! \a exception_information. The elements of
//! MINIDUMP_EXCEPTION::ExceptionInformation are set to the elements of \a
//! exception_information. Unused elements in
//! MINIDUMP_EXCEPTION::ExceptionInformation are set to `0`.
//!
//! \a exception_information must have no more than
//! #EXCEPTION_MAXIMUM_PARAMETERS elements.
//!
//! \note Valid in #kStateMutable.
void SetExceptionInformation(
const std::vector<uint64_t>& exception_information);
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:
MINIDUMP_EXCEPTION_STREAM exception_;
scoped_ptr<MinidumpContextWriter> context_;
DISALLOW_COPY_AND_ASSIGN(MinidumpExceptionWriter);
};
} // namespace crashpad
#endif // CRASHPAD_MINIDUMP_MINIDUMP_EXCEPTION_WRITER_H_