1c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// Copyright (c) 2014 Google Inc. 2c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// All rights reserved. 3c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// 4c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// Redistribution and use in source and binary forms, with or without 5c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// modification, are permitted provided that the following conditions are 6c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// met: 7c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// 8c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// * Redistributions of source code must retain the above copyright 9c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// notice, this list of conditions and the following disclaimer. 10c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// * Redistributions in binary form must reproduce the above 11c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// copyright notice, this list of conditions and the following disclaimer 12c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// in the documentation and/or other materials provided with the 13c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// distribution. 14c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// * Neither the name of Google Inc. nor the names of its 15c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// contributors may be used to endorse or promote products derived from 16c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// this software without specific prior written permission. 17c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// 18c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 30c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// dump_context.h: A (mini/micro) dump CPU-specific context. 31c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 32c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org#ifndef GOOGLE_BREAKPAD_PROCESSOR_DUMP_CONTEXT_H__ 33c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org#define GOOGLE_BREAKPAD_PROCESSOR_DUMP_CONTEXT_H__ 34c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 35c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org#include "google_breakpad/common/minidump_format.h" 36c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org#include "google_breakpad/processor/dump_object.h" 37c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 38c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.orgnamespace google_breakpad { 39c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 40c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// DumpContext carries a CPU-specific MDRawContext structure, which contains CPU 41c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org// context such as register states. 42c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.orgclass DumpContext : public DumpObject { 43c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org public: 44c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org virtual ~DumpContext(); 45c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 46c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // Returns an MD_CONTEXT_* value such as MD_CONTEXT_X86 or MD_CONTEXT_PPC 47c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // identifying the CPU type that the context was collected from. The 48c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // returned value will identify the CPU only, and will have any other 49c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // MD_CONTEXT_* bits masked out. Returns 0 on failure. 50c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org uint32_t GetContextCPU() const; 51c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 52c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // Return the raw value of |context_flags_| 53c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org uint32_t GetContextFlags() const; 54c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 55c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // Returns raw CPU-specific context data for the named CPU type. If the 56c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // context data does not match the CPU type or does not exist, returns NULL. 57c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org const MDRawContextAMD64* GetContextAMD64() const; 58c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org const MDRawContextARM* GetContextARM() const; 59c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org const MDRawContextARM64* GetContextARM64() const; 60c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org const MDRawContextMIPS* GetContextMIPS() const; 61c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org const MDRawContextPPC* GetContextPPC() const; 62c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org const MDRawContextPPC64* GetContextPPC64() const; 63c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org const MDRawContextSPARC* GetContextSPARC() const; 64c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org const MDRawContextX86* GetContextX86() const; 65c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 66c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // A convenience method to get the instruction pointer out of the 67c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // MDRawContext, since it varies per-CPU architecture. 68c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org bool GetInstructionPointer(uint64_t* ip) const; 69c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 70c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // Print a human-readable representation of the object to stdout. 71c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org void Print(); 72c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 73c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org protected: 74c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org DumpContext(); 75c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 76c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // Sets row CPU-specific context data for the names CPU type. 77c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org void SetContextFlags(uint32_t context_flags); 78c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org void SetContextX86(MDRawContextX86* x86); 79c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org void SetContextPPC(MDRawContextPPC* ppc); 80c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org void SetContextPPC64(MDRawContextPPC64* ppc64); 81c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org void SetContextAMD64(MDRawContextAMD64* amd64); 82c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org void SetContextSPARC(MDRawContextSPARC* ctx_sparc); 83c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org void SetContextARM(MDRawContextARM* arm); 84c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org void SetContextARM64(MDRawContextARM64* arm64); 85c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org void SetContextMIPS(MDRawContextMIPS* ctx_mips); 86c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 87c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // Free the CPU-specific context structure. 88c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org void FreeContext(); 89c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 90c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org private: 91c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // The CPU-specific context structure. 92c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org union { 93c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org MDRawContextBase* base; 94c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org MDRawContextX86* x86; 95c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org MDRawContextPPC* ppc; 96c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org MDRawContextPPC64* ppc64; 97c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org MDRawContextAMD64* amd64; 98c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // on Solaris SPARC, sparc is defined as a numeric constant, 99c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // so variables can NOT be named as sparc 100c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org MDRawContextSPARC* ctx_sparc; 101c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org MDRawContextARM* arm; 102c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org MDRawContextARM64* arm64; 103c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org MDRawContextMIPS* ctx_mips; 104c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org } context_; 105c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 106c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org // Store this separately because of the weirdo AMD64 context 107c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org uint32_t context_flags_; 108c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org}; 109c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 110c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org} // namespace google_breakpad 111c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org 112c5e242b8cd4280db5162e5a3084f2dc9e16e8ffbmmandlis@chromium.org#endif // GOOGLE_BREAKPAD_PROCESSOR_DUMP_CONTEXT_H__ 113