1 /* Copyright (c) 2009, 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: Julian Seward
60  */
61 
62 /*
63  * ARM support
64  */
65 
66 #ifndef GOOGLE_BREAKPAD_COMMON_MINIDUMP_CPU_ARM_H__
67 #define GOOGLE_BREAKPAD_COMMON_MINIDUMP_CPU_ARM_H__
68 
69 #define MD_FLOATINGSAVEAREA_ARM_FPR_COUNT 32
70 #define MD_FLOATINGSAVEAREA_ARM_FPEXTRA_COUNT 8
71 
72 /*
73  * Note that these structures *do not* map directly to the CONTEXT
74  * structure defined in WinNT.h in the Windows Mobile SDK. That structure
75  * does not accomodate VFPv3, and I'm unsure if it was ever used in the
76  * wild anyway, as Windows CE only seems to produce "cedumps" which
77  * are not exactly minidumps.
78  */
79 typedef struct {
80   uint64_t      fpscr;      /* FPU status register */
81 
82   /* 32 64-bit floating point registers, d0 .. d31. */
83   uint64_t      regs[MD_FLOATINGSAVEAREA_ARM_FPR_COUNT];
84 
85   /* Miscellaneous control words */
86   uint32_t     extra[MD_FLOATINGSAVEAREA_ARM_FPEXTRA_COUNT];
87 } MDFloatingSaveAreaARM;
88 
89 #define MD_CONTEXT_ARM_GPR_COUNT 16
90 
91 typedef struct {
92   /* The next field determines the layout of the structure, and which parts
93    * of it are populated
94    */
95   uint32_t      context_flags;
96 
97   /* 16 32-bit integer registers, r0 .. r15
98    * Note the following fixed uses:
99    *   r13 is the stack pointer
100    *   r14 is the link register
101    *   r15 is the program counter
102    */
103   uint32_t     iregs[MD_CONTEXT_ARM_GPR_COUNT];
104 
105   /* CPSR (flags, basically): 32 bits:
106         bit 31 - N (negative)
107         bit 30 - Z (zero)
108         bit 29 - C (carry)
109         bit 28 - V (overflow)
110         bit 27 - Q (saturation flag, sticky)
111      All other fields -- ignore */
112   uint32_t    cpsr;
113 
114   /* The next field is included with MD_CONTEXT_ARM_FLOATING_POINT */
115   MDFloatingSaveAreaARM float_save;
116 
117 } MDRawContextARM;
118 
119 /* Indices into iregs for registers with a dedicated or conventional
120  * purpose.
121  */
122 enum MDARMRegisterNumbers {
123   MD_CONTEXT_ARM_REG_IOS_FP = 7,
124   MD_CONTEXT_ARM_REG_FP     = 11,
125   MD_CONTEXT_ARM_REG_SP     = 13,
126   MD_CONTEXT_ARM_REG_LR     = 14,
127   MD_CONTEXT_ARM_REG_PC     = 15
128 };
129 
130 /* For (MDRawContextARM).context_flags.  These values indicate the type of
131  * context stored in the structure. */
132 /* CONTEXT_ARM from the Windows CE 5.0 SDK. This value isn't correct
133  * because this bit can be used for flags. Presumably this value was
134  * never actually used in minidumps, but only in "CEDumps" which
135  * are a whole parallel minidump file format for Windows CE.
136  * Therefore, Breakpad defines its own value for ARM CPUs.
137  */
138 #define MD_CONTEXT_ARM_OLD               0x00000040
139 /* This value was chosen to avoid likely conflicts with MD_CONTEXT_*
140  * for other CPUs. */
141 #define MD_CONTEXT_ARM                   0x40000000
142 #define MD_CONTEXT_ARM_INTEGER           (MD_CONTEXT_ARM | 0x00000002)
143 #define MD_CONTEXT_ARM_FLOATING_POINT    (MD_CONTEXT_ARM | 0x00000004)
144 
145 #define MD_CONTEXT_ARM_FULL              (MD_CONTEXT_ARM_INTEGER | \
146                                           MD_CONTEXT_ARM_FLOATING_POINT)
147 
148 #define MD_CONTEXT_ARM_ALL               (MD_CONTEXT_ARM_INTEGER | \
149                                           MD_CONTEXT_ARM_FLOATING_POINT)
150 
151 #endif  /* GOOGLE_BREAKPAD_COMMON_MINIDUMP_CPU_ARM_H__ */
152