1 /* Copyright 2013 Google Inc.
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
29 
30 /* minidump_format.h: A cross-platform reimplementation of minidump-related
31  * portions of DbgHelp.h from the Windows Platform SDK.
32  *
33  * (This is C99 source, please don't corrupt it with C++.)
34  *
35  * This file contains the necessary definitions to read minidump files
36  * produced on ARM.  These files may be read on any platform provided
37  * that the alignments of these structures on the processing system are
38  * identical to the alignments of these structures on the producing system.
39  * For this reason, precise-sized types are used.  The structures defined
40  * by this file have been laid out to minimize alignment problems by
41  * ensuring that all members are aligned on their natural boundaries.
42  * In some cases, tail-padding may be significant when different ABIs specify
43  * different tail-padding behaviors.  To avoid problems when reading or
44  * writing affected structures, MD_*_SIZE macros are provided where needed,
45  * containing the useful size of the structures without padding.
46  *
47  * Structures that are defined by Microsoft to contain a zero-length array
48  * are instead defined here to contain an array with one element, as
49  * zero-length arrays are forbidden by standard C and C++.  In these cases,
50  * *_minsize constants are provided to be used in place of sizeof.  For a
51  * cleaner interface to these sizes when using C++, see minidump_size.h.
52  *
53  * These structures are also sufficient to populate minidump files.
54  *
55  * Because precise data type sizes are crucial for this implementation to
56  * function properly and portably, a set of primitive types with known sizes
57  * are used as the basis of each structure defined by this file.
58  *
59  * Author: Colin Blundell
60  */
61 
62 /*
63  * ARM64 support
64  */
65 
66 #ifndef GOOGLE_BREAKPAD_COMMON_MINIDUMP_CPU_ARM64_H__
67 #define GOOGLE_BREAKPAD_COMMON_MINIDUMP_CPU_ARM64_H__
68 
69 #define MD_FLOATINGSAVEAREA_ARM64_FPR_COUNT 32
70 
71 typedef struct {
72   uint32_t       fpsr;      /* FPU status register */
73   uint32_t       fpcr;      /* FPU control register */
74 
75   /* 32 128-bit floating point registers, d0 .. d31. */
76   uint128_struct regs[MD_FLOATINGSAVEAREA_ARM64_FPR_COUNT];
77 } MDFloatingSaveAreaARM64;
78 
79 #define MD_CONTEXT_ARM64_GPR_COUNT 33
80 
81 /* Use the same 32-bit alignment when accessing this structure from 64-bit code
82  * as is used natively in 32-bit code. */
83 #pragma pack(push, 4)
84 
85 typedef struct {
86   /* The next field determines the layout of the structure, and which parts
87    * of it are populated
88    */
89   uint64_t      context_flags;
90 
91   /* 33 64-bit integer registers, x0 .. x31 + the PC
92    * Note the following fixed uses:
93    *   x29 is the frame pointer
94    *   x30 is the link register
95    *   x31 is the stack pointer
96    *   The PC is effectively x32.
97    */
98   uint64_t     iregs[MD_CONTEXT_ARM64_GPR_COUNT];
99 
100   /* CPSR (flags, basically): 32 bits:
101         bit 31 - N (negative)
102         bit 30 - Z (zero)
103         bit 29 - C (carry)
104         bit 28 - V (overflow)
105         bit 27 - Q (saturation flag, sticky)
106      All other fields -- ignore */
107   uint32_t    cpsr;
108 
109   /* The next field is included with MD_CONTEXT64_ARM_FLOATING_POINT */
110   MDFloatingSaveAreaARM64 float_save;
111 
112 } MDRawContextARM64;
113 
114 #pragma pack(pop)
115 
116 /* Indices into iregs for registers with a dedicated or conventional
117  * purpose.
118  */
119 enum MDARM64RegisterNumbers {
120   MD_CONTEXT_ARM64_REG_FP     = 29,
121   MD_CONTEXT_ARM64_REG_LR     = 30,
122   MD_CONTEXT_ARM64_REG_SP     = 31,
123   MD_CONTEXT_ARM64_REG_PC     = 32
124 };
125 
126 /* For (MDRawContextARM64).context_flags.  These values indicate the type of
127  * context stored in the structure. MD_CONTEXT_ARM64 is Breakpad-defined.
128  * This value was chosen to avoid likely conflicts with MD_CONTEXT_*
129  * for other CPUs. */
130 #define MD_CONTEXT_ARM64                   0x80000000
131 #define MD_CONTEXT_ARM64_INTEGER           (MD_CONTEXT_ARM64 | 0x00000002)
132 #define MD_CONTEXT_ARM64_FLOATING_POINT    (MD_CONTEXT_ARM64 | 0x00000004)
133 
134 #define MD_CONTEXT_ARM64_FULL              (MD_CONTEXT_ARM64_INTEGER | \
135                                           MD_CONTEXT_ARM64_FLOATING_POINT)
136 
137 #define MD_CONTEXT_ARM64_ALL               (MD_CONTEXT_ARM64_INTEGER | \
138                                           MD_CONTEXT_ARM64_FLOATING_POINT)
139 
140 #endif  /* GOOGLE_BREAKPAD_COMMON_MINIDUMP_CPU_ARM64_H__ */
141