xref: /aosp_15_r20/external/google-breakpad/src/google_breakpad/common/minidump_cpu_ppc64.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 /* Copyright 2008 Google LLC
2  *
3  * Redistribution and use in source and binary forms, with or without
4  * modification, are permitted provided that the following conditions are
5  * met:
6  *
7  *     * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above
10  * copyright notice, this list of conditions and the following disclaimer
11  * in the documentation and/or other materials provided with the
12  * distribution.
13  *     * Neither the name of Google LLC nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
28 
29 /* minidump_format.h: A cross-platform reimplementation of minidump-related
30  * portions of DbgHelp.h from the Windows Platform SDK.
31  *
32  * (This is C99 source, please don't corrupt it with C++.)
33  *
34  * This file contains the necessary definitions to read minidump files
35  * produced on ppc64.  These files may be read on any platform provided
36  * that the alignments of these structures on the processing system are
37  * identical to the alignments of these structures on the producing system.
38  * For this reason, precise-sized types are used.  The structures defined
39  * by this file have been laid out to minimize alignment problems by ensuring
40  * ensuring that all members are aligned on their natural boundaries.  In
41  * In some cases, tail-padding may be significant when different ABIs specify
42  * different tail-padding behaviors.  To avoid problems when reading or
43  * writing affected structures, MD_*_SIZE macros are provided where needed,
44  * containing the useful size of the structures without padding.
45  *
46  * Structures that are defined by Microsoft to contain a zero-length array
47  * are instead defined here to contain an array with one element, as
48  * zero-length arrays are forbidden by standard C and C++.  In these cases,
49  * *_minsize constants are provided to be used in place of sizeof.  For a
50  * cleaner interface to these sizes when using C++, see minidump_size.h.
51  *
52  * These structures are also sufficient to populate minidump files.
53  *
54  * These definitions may be extended to support handling minidump files
55  * for other CPUs and other operating systems.
56  *
57  * Because precise data type sizes are crucial for this implementation to
58  * function properly and portably in terms of interoperability with minidumps
59  * produced by DbgHelp on Windows, a set of primitive types with known sizes
60  * are used as the basis of each structure defined by this file.  DbgHelp
61  * on Windows is assumed to be the reference implementation; this file
62  * seeks to provide a cross-platform compatible implementation.  To avoid
63  * collisions with the types and values defined and used by DbgHelp in the
64  * event that this implementation is used on Windows, each type and value
65  * defined here is given a new name, beginning with "MD".  Names of the
66  * equivalent types and values in the Windows Platform SDK are given in
67  * comments.
68  *
69  * Author: Neal Sidhwaney */
70 
71 
72 /*
73  * Breakpad minidump extension for PPC64 support.  Based on Darwin/Mac OS X'
74  * mach/ppc/_types.h
75  */
76 
77 #ifndef GOOGLE_BREAKPAD_COMMON_MINIDUMP_CPU_PPC64_H__
78 #define GOOGLE_BREAKPAD_COMMON_MINIDUMP_CPU_PPC64_H__
79 
80 #include "minidump_cpu_ppc.h"
81 
82 // these types are the same in ppc64 & ppc
83 typedef MDFloatingSaveAreaPPC MDFloatingSaveAreaPPC64;
84 typedef MDVectorSaveAreaPPC MDVectorSaveAreaPPC64;
85 
86 #define MD_CONTEXT_PPC64_GPR_COUNT MD_CONTEXT_PPC_GPR_COUNT
87 
88 typedef struct {
89   /* context_flags is not present in ppc_thread_state, but it aids
90    * identification of MDRawContextPPC among other raw context types,
91    * and it guarantees alignment when we get to float_save. */
92   uint64_t              context_flags;
93 
94   uint64_t              srr0;    /* Machine status save/restore: stores pc
95                                   * (instruction) */
96   uint64_t              srr1;    /* Machine status save/restore: stores msr
97                                   * (ps, program/machine state) */
98   /* ppc_thread_state contains 32 fields, r0 .. r31.  Here, an array is
99    * used for brevity. */
100   uint64_t              gpr[MD_CONTEXT_PPC64_GPR_COUNT];
101   uint64_t              cr;      /* Condition */
102   uint64_t              xer;     /* Integer (fiXed-point) exception */
103   uint64_t              lr;      /* Link */
104   uint64_t              ctr;     /* Count */
105   uint64_t              vrsave;  /* Vector save */
106 
107   /* float_save and vector_save aren't present in ppc_thread_state, but
108    * are represented in separate structures that still define a thread's
109    * context. */
110   MDFloatingSaveAreaPPC float_save;
111   MDVectorSaveAreaPPC   vector_save;
112 } MDRawContextPPC64;  /* Based on ppc_thread_state */
113 
114 /* Indices into gpr for registers with a dedicated or conventional purpose. */
115 enum MDPPC64RegisterNumbers {
116   MD_CONTEXT_PPC64_REG_SP = 1
117 };
118 
119 /* For (MDRawContextPPC).context_flags.  These values indicate the type of
120  * context stored in the structure.  MD_CONTEXT_PPC is Breakpad-defined.  Its
121  * value was chosen to avoid likely conflicts with MD_CONTEXT_* for other
122  * CPUs. */
123 #define MD_CONTEXT_PPC64                0x01000000
124 #define MD_CONTEXT_PPC64_BASE           (MD_CONTEXT_PPC64 | 0x00000001)
125 #define MD_CONTEXT_PPC64_FLOATING_POINT (MD_CONTEXT_PPC64 | 0x00000008)
126 #define MD_CONTEXT_PPC64_VECTOR         (MD_CONTEXT_PPC64 | 0x00000020)
127 
128 #define MD_CONTEXT_PPC64_FULL           MD_CONTEXT_PPC64_BASE
129 #define MD_CONTEXT_PPC64_ALL            (MD_CONTEXT_PPC64_FULL | \
130                                          MD_CONTEXT_PPC64_FLOATING_POINT | \
131                                          MD_CONTEXT_PPC64_VECTOR)
132 
133 #endif /* GOOGLE_BREAKPAD_COMMON_MINIDUMP_CPU_PPC64_H__ */
134