Add explicit flags register representations; SymEval bugfixes.
[dyninst.git] / common / src / dyn_regs.C
1 /*
2  * Copyright (c) 1996-2009 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31
32 #define DYN_DEFINE_REGS
33 #include "dynutil/h/dyn_regs.h"
34
35 #include "external/rose/rose-compat.h"
36
37 namespace Dyninst {
38
39 std::map<signed int, const char *> *Dyninst::MachRegister::names;
40
41 MachRegister::MachRegister() :
42    reg(0)
43
44 }
45
46 MachRegister::MachRegister(signed int r) :
47    reg(r)
48 {
49 }
50  
51 MachRegister::MachRegister(const MachRegister& r) :
52         reg(r.reg)
53 {
54 }
55
56 MachRegister::MachRegister(signed int r, const char *n) :
57    reg(r)
58 {
59    if (!names) {
60       names = new std::map<signed int, const char *>();
61    }
62    (*names)[r] = n;
63 }
64
65 MachRegister::~MachRegister() {
66 }
67
68 MachRegister MachRegister::getBaseRegister() const { 
69    switch (getArchitecture()) {
70       case Arch_x86:
71       case Arch_x86_64:
72         
73           return MachRegister(reg & 0xfffff0ff);
74       case Arch_ppc32:
75       case Arch_ppc64:
76          return *this;
77       case Arch_none:
78          return *this;
79    }
80    return InvalidReg;
81 }
82    
83 Architecture MachRegister::getArchitecture() const { 
84    return (Architecture) (reg & 0xff000000);
85 }
86
87 bool MachRegister::isValid() const {
88    return (reg != InvalidReg.reg);
89 }
90
91 MachRegisterVal MachRegister::getSubRegValue(const MachRegister subreg, 
92                                              MachRegisterVal &orig) const
93 {
94    if (subreg.reg == reg || 
95        getArchitecture() == Arch_ppc32 ||
96        getArchitecture() == Arch_ppc64)
97       return orig;
98
99    assert(subreg.getBaseRegister() == getBaseRegister());
100    switch ((subreg.reg & 0x00000f00) >> 8) {
101       case 0x0: return orig;
102       case 0x1: return (orig & 0xff);
103       case 0x2: return (orig & 0xff00) >> 8;              
104       case 0x3: return (orig & 0xffff);
105       case 0xf: return (orig & 0xffffffff);
106       default: assert(0); return orig;
107    }
108 }
109
110 const char *MachRegister::name() const { 
111    return (*names)[reg];
112 }
113
114 unsigned int MachRegister::size() const {
115    switch (getArchitecture())
116    {
117       case Arch_x86:
118          switch (reg & 0x0000ff00) {
119              case x86::L_REG: //L_REG
120             case x86::H_REG: //H_REG
121                return 1;
122                case x86::W_REG: //W_REG
123                return 2;
124                case x86::FULL: //FULL
125                return 4;
126              case x86::QUAD:
127                 return 8;
128              case x86::OCT:
129                  return 16;
130              case x86::FPDBL:
131                  return 10;
132          case x86::BIT:
133            return 0;
134              default:
135                assert(0);
136          }
137       case Arch_x86_64:
138          switch (reg & 0x0000ff00) {
139              case x86_64::L_REG: //L_REG
140              case x86_64::H_REG: //H_REG
141                 return 1;
142              case x86_64::W_REG: //W_REG
143                 return 2;
144              case x86_64::FULL: //FULL
145                 return 8;
146              case x86_64::D_REG:
147                  return 4;
148              case x86_64::OCT:
149                  return 16;
150              case x86_64::FPDBL:
151                  return 10;
152          case x86_64::BIT:
153            return 0;
154              default:
155                assert(0);
156          }
157       case Arch_ppc32: {
158          int reg_class = reg & 0x00ff0000;
159          if (reg_class == ppc32::FPR || reg_class == ppc32::FSR)
160             return 8;
161          return 4;
162       }
163       case Arch_ppc64:
164          return 8;
165       case Arch_none:
166          return 0;
167    }
168    return 0; //Unreachable, but disable warnings
169 }
170    
171 bool MachRegister::operator<(const MachRegister &a) const { 
172    return (reg < a.reg);
173 }
174  
175 bool MachRegister::operator==(const MachRegister &a) const { 
176    return (reg == a.reg);
177 }
178  
179 MachRegister::operator signed int() const {
180    return reg;
181 }
182
183 signed int MachRegister::val() const {
184    return reg;
185 }
186
187
188 MachRegister MachRegister::getPC(Dyninst::Architecture arch)
189 {
190    switch (arch)
191    {
192       case Arch_x86:
193          return x86::eip;
194       case Arch_x86_64:
195          return x86_64::rip;
196       case Arch_ppc32:
197          return ppc32::pc;
198       case Arch_ppc64:
199          return ppc64::pc;
200       case Arch_none:
201          return InvalidReg;
202    }
203    return InvalidReg;
204 }
205
206 MachRegister MachRegister::getFramePointer(Dyninst::Architecture arch)
207 {
208    switch (arch)
209    {
210       case Arch_x86:
211          return x86::ebp;
212       case Arch_x86_64:
213          return x86_64::rbp;
214       case Arch_ppc32:
215       case Arch_ppc64:
216          return FrameBase;
217       case Arch_none:
218          return InvalidReg;
219    }
220    return InvalidReg;
221 }
222
223 MachRegister MachRegister::getStackPointer(Dyninst::Architecture arch)
224 {
225    switch (arch)
226    {
227       case Arch_x86:
228          return x86::esp;
229       case Arch_x86_64:
230          return x86_64::rsp;
231       case Arch_ppc32:
232          return ppc32::r1;
233       case Arch_ppc64:
234          return ppc64::r1;
235       case Arch_none:
236          return InvalidReg;
237    }
238    return InvalidReg;
239 }
240
241 bool MachRegister::isPC() const
242 {
243    return (*this == x86_64::rip || *this == x86::eip ||
244            *this == ppc32::pc || *this == ppc64::pc);
245 }
246
247 bool MachRegister::isFramePointer() const
248 {
249    return (*this == x86_64::rbp || *this == x86::ebp ||
250            *this == FrameBase);
251 }
252
253 bool MachRegister::isStackPointer() const
254 {
255    return (*this == x86_64::rsp || *this == x86::esp ||
256            *this == ppc32::r1 || *this == ppc64::r1);
257 }
258
259 void MachRegister::getROSERegister(int &c, int &n, int &p)
260 {
261    // Rose: class, number, position
262    // Dyninst: category, base id, subrange
263
264    signed int category = (reg & 0x00ff0000);
265    signed int subrange = (reg & 0x0000ff00);
266    signed int baseID =   (reg & 0x000000ff);
267
268    switch (getArchitecture()) {
269       case Arch_x86:
270       case Arch_x86_64: // 64-bit not supported in ROSE
271          switch (category) {
272             case x86::GPR:
273                c = x86_regclass_gpr;
274                switch (baseID) {
275                   case x86::BASEA:
276                      n = x86_gpr_ax;
277                      break;
278                   case x86::BASEC:
279                      n = x86_gpr_cx;
280                      break;
281                   case x86::BASED:
282                      n = x86_gpr_dx;
283                      break;
284                   case x86::BASEB:
285                      n = x86_gpr_bx;
286                      break;
287                   case x86::BASESP:
288                      n = x86_gpr_sp;
289                      break;
290                   case x86::BASEBP:
291                      n = x86_gpr_bp;
292                      break;
293                   case x86::BASESI:
294                      n = x86_gpr_si;
295                      break;
296                   case x86::BASEDI:
297                      n = x86_gpr_di;
298                      break;
299                   default:
300                      n = 0;
301                      break;
302                }
303                break;
304             case x86::SEG:
305                c = x86_regclass_segment;
306                switch (baseID) {
307                   case 0x0:
308                      n = x86_segreg_ds;
309                      break;
310                   case 0x1:
311                      n = x86_segreg_es;
312                      break;
313                   case 0x2:
314                      n = x86_segreg_fs;
315                      break;
316                   case 0x3:
317                      n = x86_segreg_gs;
318                      break;
319                   case 0x4:
320                      n = x86_segreg_cs;
321                      break;
322                   case 0x5:
323                      n = x86_segreg_ss;
324                      break;
325                   default:
326                      n = 0;
327                      break;
328                }
329                break;
330             case x86::FLAG:
331                c = x86_regclass_flags;
332                switch(baseID) {
333                case x86::CF:
334                  n = x86_flag_cf;
335                  break;
336                case x86::PF:
337                  n = x86_flag_pf;
338                  break;
339                case x86::AF:
340                  n = x86_flag_af;
341                  break;
342                case x86::ZF:
343                  n = x86_flag_zf;
344                  break;
345                case x86::SF:
346                  n = x86_flag_sf;
347                  break;
348                case x86::TF:
349                  n = x86_flag_tf;
350                  break;
351                case x86::IF:
352                  n = x86_flag_if;
353                  break;
354                case x86::DF:
355                  n = x86_flag_df;
356                  break;
357                case x86::OF:
358                  n = x86_flag_of;
359                  break;
360                default:
361                  assert(0);
362                  break;
363                }
364                break;
365             case x86::MISC:
366                c = x86_regclass_unknown;
367                break;
368             case x86::XMM:
369                c = x86_regclass_xmm;
370                n = baseID;
371                break;
372             case x86::MMX:
373                c = x86_regclass_mm;
374                n = baseID;
375                break;
376             case x86::CTL:
377                c = x86_regclass_cr;
378                n = baseID;
379                break;
380             case x86::DBG:
381                c = x86_regclass_dr;
382                n = baseID;
383                break;
384             case x86::TST:
385                c = x86_regclass_unknown;
386                break;
387             case 0:
388                switch (baseID) {
389                   case 0x10:
390                      c = x86_regclass_ip;
391                      n = 0;
392                      break;
393                   default:
394                      c = x86_regclass_unknown;
395                      break;
396                }
397                break;
398          }
399          break;
400       default:
401          c = x86_regclass_unknown;
402          n = 0;
403          break;
404    }
405
406    switch (getArchitecture()) {
407       case Arch_x86:
408       case Arch_x86_64:
409          switch (subrange) {
410             case x86::FULL:
411             case x86::OCT:
412             case x86::FPDBL:
413                p = x86_regpos_all;
414                break;
415             case x86::H_REG:
416                p = x86_regpos_high_byte;
417                break;
418             case x86::L_REG:
419                p = x86_regpos_low_byte;
420                break;
421             case x86::W_REG:
422                p = x86_regpos_word;
423                break;
424             case x86_64::D_REG:
425                p = x86_regpos_dword;
426                break;
427             case x86::BIT:
428                p = x86_regpos_all;
429                break;
430          }
431          break;
432       default:
433         p = x86_regpos_unknown;
434    }
435 }
436
437 }