Fix instrumentation regressions for libc-2.29 on ARM (#653)
[dyninst.git] / dyninstAPI / src / emit-aarch64.C
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 /*
32  * emit-aarch64.C - ARMv8 code generators (emitters)
33  */
34
35 /*
36 #include <assert.h>
37 #include <stdio.h>
38 #include "common/src/Types.h"
39 #include "dyninstAPI/src/codegen.h"
40 #include "dyninstAPI/src/function.h"
41 #include "dyninstAPI/src/inst-x86.h"
42 #include "dyninstAPI/src/debug.h"
43 #include "dyninstAPI/src/ast.h"
44 #include "dyninstAPI/h/BPatch.h"
45 #include "dyninstAPI/h/BPatch_memoryAccess_NP.h"
46
47 #include "dyninstAPI/src/dynProcess.h"
48
49 #include "dyninstAPI/src/binaryEdit.h"
50 #include "dyninstAPI/src/image.h"
51 // get_index...
52 #include "dyninstAPI/src/dynThread.h"
53 #include "ABI.h"
54 #include "liveness.h"
55 #include "RegisterConversion.h"
56 */
57
58 #include "dyninstAPI/src/inst-aarch64.h"
59 #include "dyninstAPI/src/emit-aarch64.h"
60 #include "dyninstAPI/src/registerSpace.h"
61
62 codeBufIndex_t EmitterAARCH64::emitIf(
63         Register expr_reg, Register target, RegControl /*rc*/, codeGen &gen)
64 {
65     instruction insn;
66     insn.clear();
67
68     // compare to 0 and branch
69     // register number, its value is compared to 0.
70     INSN_SET(insn, 0, 4, expr_reg);
71     INSN_SET(insn, 5, 23, (target+4)/4);
72     INSN_SET(insn, 25, 30, 0x1a); // CBZ
73     INSN_SET(insn, 31, 31, 1);
74
75     insnCodeGen::generate(gen,insn);
76
77     // Retval: where the jump is in this sequence
78     codeBufIndex_t retval = gen.getIndex();
79     return retval;
80 }
81
82 void EmitterAARCH64::emitLoadConst(Register dest, Address imm, codeGen &gen)
83 {
84     insnCodeGen::loadImmIntoReg<Address>(gen, dest, imm);
85 }
86
87
88 void EmitterAARCH64::emitLoad(Register dest, Address addr, int size, codeGen &gen)
89 {
90     Register scratch = gen.rs()->getScratchRegister(gen);
91
92     insnCodeGen::loadImmIntoReg<Address>(gen, scratch, addr);
93     insnCodeGen::generateMemAccess(gen, insnCodeGen::Load, dest,
94             scratch, 0, size, insnCodeGen::Post);
95
96     gen.rs()->freeRegister(scratch);
97     gen.markRegDefined(dest);
98 }
99
100
101 void EmitterAARCH64::emitStore(Address addr, Register src, int size, codeGen &gen)
102 {
103     Register scratch = gen.rs()->getScratchRegister(gen);
104
105     insnCodeGen::loadImmIntoReg<Address>(gen, scratch, addr);
106     insnCodeGen::generateMemAccess(gen, insnCodeGen::Store, src,
107             scratch, 0, size, insnCodeGen::Pre);
108
109     gen.rs()->freeRegister(scratch);
110     gen.markRegDefined(src);
111 }
112
113
114 void EmitterAARCH64::emitOp(
115         unsigned opcode, Register dest, Register src1, Register src2, codeGen &gen)
116 {
117     // dest = src1 + src2
118     if( opcode == plusOp )
119         insnCodeGen::generateAddSubShifted(gen, insnCodeGen::Add, 0, 0, src1, src2, dest, true);
120
121     // dest = src1 - src2
122     else if( opcode == minusOp )
123         insnCodeGen::generateAddSubShifted(gen, insnCodeGen::Sub, 0, 0, src2, src1, dest, true);
124     
125     // dest = src1 * src2
126     else if( opcode == timesOp )
127         insnCodeGen::generateMul(gen, src1, src2, dest, true);
128
129     // dest = src1 & src2
130     else if( opcode == andOp )
131         insnCodeGen::generateBitwiseOpShifted(gen, insnCodeGen::And, 0, src1, 0, src2, dest, true);  
132
133     // dest = src1 | src2
134     else if( opcode == orOp )
135         insnCodeGen::generateBitwiseOpShifted(gen, insnCodeGen::Or, 0, src1, 0, src2, dest, true);  
136
137     // dest = src1 ^ src2
138     else if( opcode == xorOp )
139         insnCodeGen::generateBitwiseOpShifted(gen, insnCodeGen::Eor, 0, src1, 0, src2, dest, true);
140
141     else assert(0);
142 }
143
144
145 void EmitterAARCH64::emitRelOp(
146         unsigned opcode, Register dest, Register src1, Register src2, codeGen &gen, bool s)
147 {
148     // CMP is an alias to SUBS;
149     // dest here has src1-src2, which it's not important because the flags are
150     // used for the comparison, not the subtration value.
151     // Besides that dest must contain 1 for true or 0 for false, and the content
152     // of dest is gonna be changed as follow.
153     insnCodeGen::generateAddSubShifted(gen, insnCodeGen::Sub, 0, 0, src2, src1, dest, true);
154
155     // make dest = 1, meaning true
156     insnCodeGen::loadImmIntoReg<Address>(gen, dest, 0x1);
157
158     // insert conditional jump to skip dest=0 in case the comparison resulted true
159     // therefore keeping dest=1
160     insnCodeGen::generateConditionalBranch(gen, 8, opcode, s);
161
162     // make dest = 0, in case it fails the branch
163     insnCodeGen::loadImmIntoReg<Address>(gen, dest, 0x0);
164 }
165
166
167 //#sasha Fix parameters number
168 void EmitterAARCH64::emitGetParam(
169         Register dest, Register param_num,
170         instPoint::Type pt_type, opCode op,
171         bool addr_of, codeGen &gen)
172 {
173     registerSlot *regSlot = NULL;
174     switch (op) {
175         case getParamOp:
176             if(param_num <= 3) {
177                 // param_num is 0..8 - it's a parameter number, not a register
178                 regSlot = (*(gen.rs()))[registerSpace::r0 + param_num];
179                 break;
180
181             } else {
182                 assert(0);
183             }
184             break;
185         default:
186             assert(0);
187             break;
188     } // end of swich(op)
189
190     assert(regSlot);
191     Register reg = regSlot->number;
192
193     //return reg;
194 }
195
196
197 void EmitterAARCH64::emitRelOpImm(
198         unsigned opcode, Register dest, Register src1, RegValue src2imm, codeGen &gen, bool s)
199 {
200     //Register src2 = gen.rs()->allocateRegister(gen, true);
201     Register src2 = gen.rs()->getScratchRegister(gen);
202     emitLoadConst(src2, src2imm, gen);
203
204     // CMP is an alias to SUBS;
205     // dest here has src1-src2, which it's not important because the flags are
206     // used for the comparison, not the subtration value.
207     // Besides that dest must contain 1 for true or 0 for false, and the content
208     // of dest is gonna be changed as follow.
209     insnCodeGen::generateAddSubShifted(gen, insnCodeGen::Sub, 0, 0, src2, src1, dest, true);
210
211     // make dest = 1, meaning true
212     insnCodeGen::loadImmIntoReg<Address>(gen, dest, 0x1);
213
214     // insert conditional jump to skip dest=0 in case the comparison resulted true
215     // therefore keeping dest=1
216     insnCodeGen::generateConditionalBranch(gen, 8, opcode, s);
217
218     // make dest = 0, in case it fails the branch
219     insnCodeGen::loadImmIntoReg<Address>(gen, dest, 0x0);
220
221     gen.rs()->freeRegister(src2);
222     gen.markRegDefined(dest);
223 }
224
225
226 void EmitterAARCH64::emitLoadIndir(Register dest, Register addr_src, int size, codeGen &gen)
227 {
228     insnCodeGen::generateMemAccess(gen, insnCodeGen::Load, dest,
229             addr_src, 0, size, insnCodeGen::Post);
230
231     gen.markRegDefined(dest);
232 }
233 void EmitterAARCH64::emitStoreIndir(Register addr_reg, Register src, int size, codeGen &gen)
234 {
235     insnCodeGen::generateMemAccess(gen, insnCodeGen::Store, src,
236             addr_reg, 0, size, insnCodeGen::Pre);
237
238     gen.markRegDefined(addr_reg);
239 }
240
241 void EmitterAARCH64::emitLoadOrigRegRelative(
242         Register dest, Address offset, Register base, codeGen &gen, bool deref)
243 {
244
245     gen.markRegDefined(dest);
246     Register scratch = gen.rs()->getScratchRegister(gen);
247     assert(scratch);
248     gen.markRegDefined(scratch);
249
250     // either load the address or the contents at that address
251     if(deref)
252     {
253         // load the stored register 'base' into scratch
254         emitLoadOrigRegister(base, scratch, gen);
255         // move offset(%scratch), %dest
256         insnCodeGen::generateMemAccess(gen, insnCodeGen::Load, dest,
257             scratch, offset, /*size==8?true:false*/4, insnCodeGen::Offset);
258     }
259     else
260     {
261         // load the stored register 'base' into dest
262         emitLoadOrigRegister(base, scratch, gen);
263         insnCodeGen::loadImmIntoReg<long int>(gen, dest, offset);
264         insnCodeGen::generateAddSubShifted(gen, insnCodeGen::Add, 0, 0, dest, scratch, dest, true);
265     }
266 }
267
268
269 void EmitterAARCH64::emitLoadOrigRegister(Address register_num, Register destination, codeGen &gen)
270 {
271
272    registerSlot *src = (*gen.rs())[register_num];
273    assert(src);
274    registerSlot *dest = (*gen.rs())[destination];
275    assert(dest);
276
277    if (src->name == "sp") {
278       insnCodeGen::generateAddSubImmediate(gen, insnCodeGen::Add, 0,
279              TRAMP_FRAME_SIZE_64, REG_SP, destination, true);
280
281       return;
282    }
283
284    if (src->spilledState == registerSlot::unspilled)
285    {
286       // not on the stack. Directly move the value
287       insnCodeGen::generateMove(gen, destination, (Register) register_num, true);
288       return;
289    }
290
291
292     int offset = TRAMP_GPR_OFFSET(gen.width());
293     // its on the stack so load it.
294     insnCodeGen::restoreRegister(gen, destination, offset + (register_num * gen.width()),
295             insnCodeGen::Offset);
296 }
297
298