2 * Copyright (C) 2009 Apple Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #ifndef CodeLocation_h
27 #define CodeLocation_h
29 #include "MacroAssemblerCodeRef.h"
35 class CodeLocationInstruction;
36 class CodeLocationLabel;
37 class CodeLocationJump;
38 class CodeLocationCall;
39 class CodeLocationNearCall;
40 class CodeLocationDataLabelCompact;
41 class CodeLocationDataLabel32;
42 class CodeLocationDataLabelPtr;
44 // The CodeLocation* types are all pretty much do-nothing wrappers around
45 // CodePtr (or MacroAssemblerCodePtr, to give it its full name). These
46 // classes only exist to provide type-safety when linking and patching code.
48 // The one new piece of functionallity introduced by these classes is the
49 // ability to create (or put another way, to re-discover) another CodeLocation
50 // at an offset from one you already know. When patching code to optimize it
51 // we often want to patch a number of instructions that are short, fixed
52 // offsets apart. To reduce memory overhead we will only retain a pointer to
53 // one of the instructions, and we will use the *AtOffset methods provided by
54 // CodeLocationCommon to find the other points in the code to modify.
55 class CodeLocationCommon : public MacroAssemblerCodePtr {
57 CodeLocationInstruction instructionAtOffset(int offset);
58 CodeLocationLabel labelAtOffset(int offset);
59 CodeLocationJump jumpAtOffset(int offset);
60 CodeLocationCall callAtOffset(int offset);
61 CodeLocationNearCall nearCallAtOffset(int offset);
62 CodeLocationDataLabelPtr dataLabelPtrAtOffset(int offset);
63 CodeLocationDataLabel32 dataLabel32AtOffset(int offset);
64 CodeLocationDataLabelCompact dataLabelCompactAtOffset(int offset);
71 CodeLocationCommon(MacroAssemblerCodePtr location)
72 : MacroAssemblerCodePtr(location)
77 class CodeLocationInstruction : public CodeLocationCommon {
79 CodeLocationInstruction() {}
80 explicit CodeLocationInstruction(MacroAssemblerCodePtr location)
81 : CodeLocationCommon(location) {}
82 explicit CodeLocationInstruction(void* location)
83 : CodeLocationCommon(MacroAssemblerCodePtr(location)) {}
86 class CodeLocationLabel : public CodeLocationCommon {
88 CodeLocationLabel() {}
89 explicit CodeLocationLabel(MacroAssemblerCodePtr location)
90 : CodeLocationCommon(location) {}
91 explicit CodeLocationLabel(void* location)
92 : CodeLocationCommon(MacroAssemblerCodePtr(location)) {}
95 class CodeLocationJump : public CodeLocationCommon {
98 explicit CodeLocationJump(MacroAssemblerCodePtr location)
99 : CodeLocationCommon(location) {}
100 explicit CodeLocationJump(void* location)
101 : CodeLocationCommon(MacroAssemblerCodePtr(location)) {}
104 class CodeLocationCall : public CodeLocationCommon {
106 CodeLocationCall() {}
107 explicit CodeLocationCall(MacroAssemblerCodePtr location)
108 : CodeLocationCommon(location) {}
109 explicit CodeLocationCall(void* location)
110 : CodeLocationCommon(MacroAssemblerCodePtr(location)) {}
113 class CodeLocationNearCall : public CodeLocationCommon {
115 CodeLocationNearCall() {}
116 explicit CodeLocationNearCall(MacroAssemblerCodePtr location)
117 : CodeLocationCommon(location) {}
118 explicit CodeLocationNearCall(void* location)
119 : CodeLocationCommon(MacroAssemblerCodePtr(location)) {}
122 class CodeLocationDataLabel32 : public CodeLocationCommon {
124 CodeLocationDataLabel32() {}
125 explicit CodeLocationDataLabel32(MacroAssemblerCodePtr location)
126 : CodeLocationCommon(location) {}
127 explicit CodeLocationDataLabel32(void* location)
128 : CodeLocationCommon(MacroAssemblerCodePtr(location)) {}
131 class CodeLocationDataLabelCompact : public CodeLocationCommon {
133 CodeLocationDataLabelCompact() { }
134 explicit CodeLocationDataLabelCompact(MacroAssemblerCodePtr location)
135 : CodeLocationCommon(location) { }
136 explicit CodeLocationDataLabelCompact(void* location)
137 : CodeLocationCommon(MacroAssemblerCodePtr(location)) { }
140 class CodeLocationDataLabelPtr : public CodeLocationCommon {
142 CodeLocationDataLabelPtr() {}
143 explicit CodeLocationDataLabelPtr(MacroAssemblerCodePtr location)
144 : CodeLocationCommon(location) {}
145 explicit CodeLocationDataLabelPtr(void* location)
146 : CodeLocationCommon(MacroAssemblerCodePtr(location)) {}
149 inline CodeLocationInstruction CodeLocationCommon::instructionAtOffset(int offset)
151 ASSERT_VALID_CODE_OFFSET(offset);
152 return CodeLocationInstruction(reinterpret_cast<char*>(dataLocation()) + offset);
155 inline CodeLocationLabel CodeLocationCommon::labelAtOffset(int offset)
157 ASSERT_VALID_CODE_OFFSET(offset);
158 return CodeLocationLabel(reinterpret_cast<char*>(dataLocation()) + offset);
161 inline CodeLocationJump CodeLocationCommon::jumpAtOffset(int offset)
163 ASSERT_VALID_CODE_OFFSET(offset);
164 return CodeLocationJump(reinterpret_cast<char*>(dataLocation()) + offset);
167 inline CodeLocationCall CodeLocationCommon::callAtOffset(int offset)
169 ASSERT_VALID_CODE_OFFSET(offset);
170 return CodeLocationCall(reinterpret_cast<char*>(dataLocation()) + offset);
173 inline CodeLocationNearCall CodeLocationCommon::nearCallAtOffset(int offset)
175 ASSERT_VALID_CODE_OFFSET(offset);
176 return CodeLocationNearCall(reinterpret_cast<char*>(dataLocation()) + offset);
179 inline CodeLocationDataLabelPtr CodeLocationCommon::dataLabelPtrAtOffset(int offset)
181 ASSERT_VALID_CODE_OFFSET(offset);
182 return CodeLocationDataLabelPtr(reinterpret_cast<char*>(dataLocation()) + offset);
185 inline CodeLocationDataLabel32 CodeLocationCommon::dataLabel32AtOffset(int offset)
187 ASSERT_VALID_CODE_OFFSET(offset);
188 return CodeLocationDataLabel32(reinterpret_cast<char*>(dataLocation()) + offset);
191 inline CodeLocationDataLabelCompact CodeLocationCommon::dataLabelCompactAtOffset(int offset)
193 ASSERT_VALID_CODE_OFFSET(offset);
194 return CodeLocationDataLabelCompact(reinterpret_cast<char*>(dataLocation()) + offset);
199 #endif // ENABLE(ASSEMBLER)
201 #endif // CodeLocation_h