Convert struct target_ops to C++
[external/binutils.git] / gdb / i386-darwin-nat.c
1 /* Darwin support for GDB, the GNU debugger.
2    Copyright (C) 1997-2018 Free Software Foundation, Inc.
3
4    Contributed by Apple Computer, Inc.
5
6    This file is part of GDB.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
20
21 #include "defs.h"
22 #include "frame.h"
23 #include "inferior.h"
24 #include "target.h"
25 #include "symfile.h"
26 #include "symtab.h"
27 #include "objfiles.h"
28 #include "gdbcmd.h"
29 #include "regcache.h"
30 #include "i386-tdep.h"
31 #include "i387-tdep.h"
32 #include "gdbarch.h"
33 #include "arch-utils.h"
34 #include "gdbcore.h"
35
36 #include "x86-nat.h"
37 #include "darwin-nat.h"
38 #include "i386-darwin-tdep.h"
39
40 #ifdef BFD64
41 #include "amd64-nat.h"
42 #include "amd64-tdep.h"
43 #include "amd64-darwin-tdep.h"
44 #endif
45
46 struct i386_darwin_nat_target final : public x86_nat_target<darwin_nat_target>
47 {
48   /* Add our register access methods.  */
49   void fetch_registers (struct regcache *, int) override;
50   void store_registers (struct regcache *, int) override;
51 };
52
53 static struct i386_darwin_nat_target darwin_target;
54
55 /* Read register values from the inferior process.
56    If REGNO is -1, do this for all registers.
57    Otherwise, REGNO specifies which register (so we can save time).  */
58
59 void
60 i386_darwin_nat_target::fetch_registers (struct regcache *regcache, int regno)
61 {
62   thread_t current_thread = ptid_get_tid (regcache_get_ptid (regcache));
63   int fetched = 0;
64   struct gdbarch *gdbarch = regcache->arch ();
65
66 #ifdef BFD64
67   if (gdbarch_ptr_bit (gdbarch) == 64)
68     {
69       if (regno == -1 || amd64_native_gregset_supplies_p (gdbarch, regno))
70         {
71           x86_thread_state_t gp_regs;
72           unsigned int gp_count = x86_THREAD_STATE_COUNT;
73           kern_return_t ret;
74
75           ret = thread_get_state
76             (current_thread, x86_THREAD_STATE, (thread_state_t) & gp_regs,
77              &gp_count);
78           if (ret != KERN_SUCCESS)
79             {
80               printf_unfiltered (_("Error calling thread_get_state for "
81                                    "GP registers for thread 0x%lx\n"),
82                                  (unsigned long) current_thread);
83               MACH_CHECK_ERROR (ret);
84             }
85
86           /* Some kernels don't sanitize the values.  */
87           gp_regs.uts.ts64.__fs &= 0xffff;
88           gp_regs.uts.ts64.__gs &= 0xffff;
89
90           amd64_supply_native_gregset (regcache, &gp_regs.uts, -1);
91           fetched++;
92         }
93
94       if (regno == -1 || !amd64_native_gregset_supplies_p (gdbarch, regno))
95         {
96           x86_float_state_t fp_regs;
97           unsigned int fp_count = x86_FLOAT_STATE_COUNT;
98           kern_return_t ret;
99
100           ret = thread_get_state
101             (current_thread, x86_FLOAT_STATE, (thread_state_t) & fp_regs,
102              &fp_count);
103           if (ret != KERN_SUCCESS)
104             {
105               printf_unfiltered (_("Error calling thread_get_state for "
106                                    "float registers for thread 0x%lx\n"),
107                                  (unsigned long) current_thread);
108               MACH_CHECK_ERROR (ret);
109             }
110           amd64_supply_fxsave (regcache, -1, &fp_regs.ufs.fs64.__fpu_fcw);
111           fetched++;
112         }
113     }
114   else
115 #endif
116     {
117       if (regno == -1 || regno < I386_NUM_GREGS)
118         {
119           x86_thread_state32_t gp_regs;
120           unsigned int gp_count = x86_THREAD_STATE32_COUNT;
121           kern_return_t ret;
122           int i;
123
124           ret = thread_get_state
125             (current_thread, x86_THREAD_STATE32, (thread_state_t) &gp_regs,
126              &gp_count);
127           if (ret != KERN_SUCCESS)
128             {
129               printf_unfiltered (_("Error calling thread_get_state for "
130                                    "GP registers for thread 0x%lx\n"),
131                                  (unsigned long) current_thread);
132               MACH_CHECK_ERROR (ret);
133             }
134           for (i = 0; i < I386_NUM_GREGS; i++)
135             regcache_raw_supply
136               (regcache, i,
137                (char *)&gp_regs + i386_darwin_thread_state_reg_offset[i]);
138
139           fetched++;
140         }
141
142       if (regno == -1
143           || (regno >= I386_ST0_REGNUM && regno < I386_SSE_NUM_REGS))
144         {
145           x86_float_state32_t fp_regs;
146           unsigned int fp_count = x86_FLOAT_STATE32_COUNT;
147           kern_return_t ret;
148
149           ret = thread_get_state
150             (current_thread, x86_FLOAT_STATE32, (thread_state_t) &fp_regs,
151              &fp_count);
152           if (ret != KERN_SUCCESS)
153             {
154               printf_unfiltered (_("Error calling thread_get_state for "
155                                    "float registers for thread 0x%lx\n"),
156                                  (unsigned long) current_thread);
157               MACH_CHECK_ERROR (ret);
158             }
159           i387_supply_fxsave (regcache, -1, &fp_regs.__fpu_fcw);
160           fetched++;
161         }
162     }
163
164   if (! fetched)
165     {
166       warning (_("unknown register %d"), regno);
167       regcache_raw_supply (regcache, regno, NULL);
168     }
169 }
170
171 /* Store our register values back into the inferior.
172    If REGNO is -1, do this for all registers.
173    Otherwise, REGNO specifies which register (so we can save time).  */
174
175 void
176 i386_darwin_nat_target::store_registers (struct regcache *regcache,
177                                          int regno)
178 {
179   thread_t current_thread = ptid_get_tid (regcache_get_ptid (regcache));
180   struct gdbarch *gdbarch = regcache->arch ();
181
182 #ifdef BFD64
183   if (gdbarch_ptr_bit (gdbarch) == 64)
184     {
185       if (regno == -1 || amd64_native_gregset_supplies_p (gdbarch, regno))
186         {
187           x86_thread_state_t gp_regs;
188           kern_return_t ret;
189           unsigned int gp_count = x86_THREAD_STATE_COUNT;
190
191           ret = thread_get_state
192             (current_thread, x86_THREAD_STATE, (thread_state_t) &gp_regs,
193              &gp_count);
194           MACH_CHECK_ERROR (ret);
195           gdb_assert (gp_regs.tsh.flavor == x86_THREAD_STATE64);
196           gdb_assert (gp_regs.tsh.count == x86_THREAD_STATE64_COUNT);
197
198           amd64_collect_native_gregset (regcache, &gp_regs.uts, regno);
199
200           /* Some kernels don't sanitize the values.  */
201           gp_regs.uts.ts64.__fs &= 0xffff;
202           gp_regs.uts.ts64.__gs &= 0xffff;
203
204           ret = thread_set_state (current_thread, x86_THREAD_STATE,
205                                   (thread_state_t) &gp_regs,
206                                   x86_THREAD_STATE_COUNT);
207           MACH_CHECK_ERROR (ret);
208         }
209
210       if (regno == -1 || !amd64_native_gregset_supplies_p (gdbarch, regno))
211         {
212           x86_float_state_t fp_regs;
213           kern_return_t ret;
214           unsigned int fp_count = x86_FLOAT_STATE_COUNT;
215
216           ret = thread_get_state
217             (current_thread, x86_FLOAT_STATE, (thread_state_t) & fp_regs,
218              &fp_count);
219           MACH_CHECK_ERROR (ret);
220           gdb_assert (fp_regs.fsh.flavor == x86_FLOAT_STATE64);
221           gdb_assert (fp_regs.fsh.count == x86_FLOAT_STATE64_COUNT);
222
223           amd64_collect_fxsave (regcache, regno, &fp_regs.ufs.fs64.__fpu_fcw);
224
225           ret = thread_set_state (current_thread, x86_FLOAT_STATE,
226                                   (thread_state_t) & fp_regs,
227                                   x86_FLOAT_STATE_COUNT);
228           MACH_CHECK_ERROR (ret);
229         }
230     }
231   else
232 #endif
233     {
234       if (regno == -1 || regno < I386_NUM_GREGS)
235         {
236           x86_thread_state32_t gp_regs;
237           kern_return_t ret;
238           unsigned int gp_count = x86_THREAD_STATE32_COUNT;
239           int i;
240
241           ret = thread_get_state
242             (current_thread, x86_THREAD_STATE32, (thread_state_t) &gp_regs,
243              &gp_count);
244           MACH_CHECK_ERROR (ret);
245
246           for (i = 0; i < I386_NUM_GREGS; i++)
247             if (regno == -1 || regno == i)
248               regcache_raw_collect
249                 (regcache, i,
250                  (char *)&gp_regs + i386_darwin_thread_state_reg_offset[i]);
251
252           ret = thread_set_state (current_thread, x86_THREAD_STATE32,
253                                   (thread_state_t) &gp_regs,
254                                   x86_THREAD_STATE32_COUNT);
255           MACH_CHECK_ERROR (ret);
256         }
257
258       if (regno == -1
259           || (regno >= I386_ST0_REGNUM && regno < I386_SSE_NUM_REGS))
260         {
261           x86_float_state32_t fp_regs;
262           unsigned int fp_count = x86_FLOAT_STATE32_COUNT;
263           kern_return_t ret;
264
265           ret = thread_get_state
266             (current_thread, x86_FLOAT_STATE32, (thread_state_t) & fp_regs,
267              &fp_count);
268           MACH_CHECK_ERROR (ret);
269
270           i387_collect_fxsave (regcache, regno, &fp_regs.__fpu_fcw);
271
272           ret = thread_set_state (current_thread, x86_FLOAT_STATE32,
273                                   (thread_state_t) &fp_regs,
274                                   x86_FLOAT_STATE32_COUNT);
275           MACH_CHECK_ERROR (ret);
276         }
277     }
278 }
279
280 /* Support for debug registers, boosted mostly from i386-linux-nat.c.  */
281
282 static void
283 i386_darwin_dr_set (int regnum, CORE_ADDR value)
284 {
285   int current_pid;
286   thread_t current_thread;
287   x86_debug_state_t dr_regs;
288   kern_return_t ret;
289   unsigned int dr_count;
290
291   gdb_assert (regnum >= 0 && regnum <= DR_CONTROL);
292
293   current_thread = ptid_get_tid (inferior_ptid);
294
295   dr_regs.dsh.flavor = x86_DEBUG_STATE;
296   dr_regs.dsh.count = x86_DEBUG_STATE_COUNT;
297   dr_count = x86_DEBUG_STATE_COUNT;
298   ret = thread_get_state (current_thread, x86_DEBUG_STATE,
299                           (thread_state_t) &dr_regs, &dr_count);
300   MACH_CHECK_ERROR (ret);
301
302   switch (dr_regs.dsh.flavor)
303     {
304     case x86_DEBUG_STATE32:
305       switch (regnum)
306         {
307         case 0:
308           dr_regs.uds.ds32.__dr0 = value;
309           break;
310         case 1:
311           dr_regs.uds.ds32.__dr1 = value;
312           break;
313         case 2:
314           dr_regs.uds.ds32.__dr2 = value;
315           break;
316         case 3:
317           dr_regs.uds.ds32.__dr3 = value;
318           break;
319         case 4:
320           dr_regs.uds.ds32.__dr4 = value;
321           break;
322         case 5:
323           dr_regs.uds.ds32.__dr5 = value;
324           break;
325         case 6:
326           dr_regs.uds.ds32.__dr6 = value;
327           break;
328         case 7:
329           dr_regs.uds.ds32.__dr7 = value;
330           break;
331         }
332       break;
333 #ifdef BFD64
334     case x86_DEBUG_STATE64:
335       switch (regnum)
336         {
337         case 0:
338           dr_regs.uds.ds64.__dr0 = value;
339           break;
340         case 1:
341           dr_regs.uds.ds64.__dr1 = value;
342           break;
343         case 2:
344           dr_regs.uds.ds64.__dr2 = value;
345           break;
346         case 3:
347           dr_regs.uds.ds64.__dr3 = value;
348           break;
349         case 4:
350           dr_regs.uds.ds64.__dr4 = value;
351           break;
352         case 5:
353           dr_regs.uds.ds64.__dr5 = value;
354           break;
355         case 6:
356           dr_regs.uds.ds64.__dr6 = value;
357           break;
358         case 7:
359           dr_regs.uds.ds64.__dr7 = value;
360           break;
361         }
362       break;
363 #endif
364     }
365
366   ret = thread_set_state (current_thread, dr_regs.dsh.flavor,
367                           (thread_state_t) &dr_regs.uds, dr_count);
368
369   MACH_CHECK_ERROR (ret);
370 }
371
372 static CORE_ADDR
373 i386_darwin_dr_get (int regnum)
374 {
375   thread_t current_thread;
376   x86_debug_state_t dr_regs;
377   kern_return_t ret;
378   unsigned int dr_count;
379
380   gdb_assert (regnum >= 0 && regnum <= DR_CONTROL);
381
382   current_thread = ptid_get_tid (inferior_ptid);
383
384   dr_regs.dsh.flavor = x86_DEBUG_STATE;
385   dr_regs.dsh.count = x86_DEBUG_STATE_COUNT;
386   dr_count = x86_DEBUG_STATE_COUNT;
387   ret = thread_get_state (current_thread, x86_DEBUG_STATE,
388                           (thread_state_t) &dr_regs, &dr_count);
389   MACH_CHECK_ERROR (ret);
390
391   switch (dr_regs.dsh.flavor)
392     {
393     case x86_DEBUG_STATE32:
394       switch (regnum)
395         {
396         case 0:
397           return dr_regs.uds.ds32.__dr0;
398         case 1:
399           return dr_regs.uds.ds32.__dr1;
400         case 2:
401           return dr_regs.uds.ds32.__dr2;
402         case 3:
403           return dr_regs.uds.ds32.__dr3;
404         case 4:
405           return dr_regs.uds.ds32.__dr4;
406         case 5:
407           return dr_regs.uds.ds32.__dr5;
408         case 6:
409           return dr_regs.uds.ds32.__dr6;
410         case 7:
411           return dr_regs.uds.ds32.__dr7;
412         default:
413           return -1;
414         }
415       break;
416 #ifdef BFD64
417     case x86_DEBUG_STATE64:
418       switch (regnum)
419         {
420         case 0:
421           return dr_regs.uds.ds64.__dr0;
422         case 1:
423           return dr_regs.uds.ds64.__dr1;
424         case 2:
425           return dr_regs.uds.ds64.__dr2;
426         case 3:
427           return dr_regs.uds.ds64.__dr3;
428         case 4:
429           return dr_regs.uds.ds64.__dr4;
430         case 5:
431           return dr_regs.uds.ds64.__dr5;
432         case 6:
433           return dr_regs.uds.ds64.__dr6;
434         case 7:
435           return dr_regs.uds.ds64.__dr7;
436         default:
437           return -1;
438         }
439       break;
440 #endif
441     default:
442       return -1;
443     }
444 }
445
446 static void
447 i386_darwin_dr_set_control (unsigned long control)
448 {
449   i386_darwin_dr_set (DR_CONTROL, control);
450 }
451
452 static void
453 i386_darwin_dr_set_addr (int regnum, CORE_ADDR addr)
454 {
455   gdb_assert (regnum >= 0 && regnum <= DR_LASTADDR - DR_FIRSTADDR);
456
457   i386_darwin_dr_set (DR_FIRSTADDR + regnum, addr);
458 }
459
460 static CORE_ADDR
461 i386_darwin_dr_get_addr (int regnum)
462 {
463   return i386_darwin_dr_get (regnum);
464 }
465
466 static unsigned long
467 i386_darwin_dr_get_status (void)
468 {
469   return i386_darwin_dr_get (DR_STATUS);
470 }
471
472 static unsigned long
473 i386_darwin_dr_get_control (void)
474 {
475   return i386_darwin_dr_get (DR_CONTROL);
476 }
477
478 void
479 darwin_check_osabi (darwin_inferior *inf, thread_t thread)
480 {
481   if (gdbarch_osabi (target_gdbarch ()) == GDB_OSABI_UNKNOWN)
482     {
483       /* Attaching to a process.  Let's figure out what kind it is.  */
484       x86_thread_state_t gp_regs;
485       struct gdbarch_info info;
486       unsigned int gp_count = x86_THREAD_STATE_COUNT;
487       kern_return_t ret;
488
489       ret = thread_get_state (thread, x86_THREAD_STATE,
490                               (thread_state_t) &gp_regs, &gp_count);
491       if (ret != KERN_SUCCESS)
492         {
493           MACH_CHECK_ERROR (ret);
494           return;
495         }
496
497       gdbarch_info_init (&info);
498       gdbarch_info_fill (&info);
499       info.byte_order = gdbarch_byte_order (target_gdbarch ());
500       info.osabi = GDB_OSABI_DARWIN;
501       if (gp_regs.tsh.flavor == x86_THREAD_STATE64)
502         info.bfd_arch_info = bfd_lookup_arch (bfd_arch_i386,
503                                               bfd_mach_x86_64);
504       else
505         info.bfd_arch_info = bfd_lookup_arch (bfd_arch_i386,
506                                               bfd_mach_i386_i386);
507       gdbarch_update_p (info);
508     }
509 }
510
511 #define X86_EFLAGS_T 0x100UL
512
513 /* Returning from a signal trampoline is done by calling a
514    special system call (sigreturn).  This system call
515    restores the registers that were saved when the signal was
516    raised, including %eflags/%rflags.  That means that single-stepping
517    won't work.  Instead, we'll have to modify the signal context
518    that's about to be restored, and set the trace flag there.  */
519
520 static int
521 i386_darwin_sstep_at_sigreturn (x86_thread_state_t *regs)
522 {
523   enum bfd_endian byte_order = gdbarch_byte_order (target_gdbarch ());
524   static const gdb_byte darwin_syscall[] = { 0xcd, 0x80 }; /* int 0x80 */
525   gdb_byte buf[sizeof (darwin_syscall)];
526
527   /* Check if PC is at a sigreturn system call.  */
528   if (target_read_memory (regs->uts.ts32.__eip, buf, sizeof (buf)) == 0
529       && memcmp (buf, darwin_syscall, sizeof (darwin_syscall)) == 0
530       && regs->uts.ts32.__eax == 0xb8 /* SYS_sigreturn */)
531     {
532       ULONGEST uctx_addr;
533       ULONGEST mctx_addr;
534       ULONGEST flags_addr;
535       unsigned int eflags;
536
537       uctx_addr = read_memory_unsigned_integer
538                     (regs->uts.ts32.__esp + 4, 4, byte_order);
539       mctx_addr = read_memory_unsigned_integer
540                     (uctx_addr + 28, 4, byte_order);
541
542       flags_addr = mctx_addr + 12 + 9 * 4;
543       read_memory (flags_addr, (gdb_byte *) &eflags, 4);
544       eflags |= X86_EFLAGS_T;
545       write_memory (flags_addr, (gdb_byte *) &eflags, 4);
546
547       return 1;
548     }
549   return 0;
550 }
551
552 #ifdef BFD64
553 static int
554 amd64_darwin_sstep_at_sigreturn (x86_thread_state_t *regs)
555 {
556   enum bfd_endian byte_order = gdbarch_byte_order (target_gdbarch ());
557   static const gdb_byte darwin_syscall[] = { 0x0f, 0x05 }; /* syscall */
558   gdb_byte buf[sizeof (darwin_syscall)];
559
560   /* Check if PC is at a sigreturn system call.  */
561   if (target_read_memory (regs->uts.ts64.__rip, buf, sizeof (buf)) == 0
562       && memcmp (buf, darwin_syscall, sizeof (darwin_syscall)) == 0
563       && (regs->uts.ts64.__rax & 0xffffffff) == 0x20000b8 /* SYS_sigreturn */)
564     {
565       ULONGEST mctx_addr;
566       ULONGEST flags_addr;
567       unsigned int rflags;
568
569       mctx_addr = read_memory_unsigned_integer
570                     (regs->uts.ts64.__rdi + 48, 8, byte_order);
571       flags_addr = mctx_addr + 16 + 17 * 8;
572
573       /* AMD64 is little endian.  */
574       read_memory (flags_addr, (gdb_byte *) &rflags, 4);
575       rflags |= X86_EFLAGS_T;
576       write_memory (flags_addr, (gdb_byte *) &rflags, 4);
577
578       return 1;
579     }
580   return 0;
581 }
582 #endif
583
584 void
585 darwin_set_sstep (thread_t thread, int enable)
586 {
587   x86_thread_state_t regs;
588   unsigned int count = x86_THREAD_STATE_COUNT;
589   kern_return_t kret;
590
591   kret = thread_get_state (thread, x86_THREAD_STATE,
592                            (thread_state_t) &regs, &count);
593   if (kret != KERN_SUCCESS)
594     {
595       printf_unfiltered (_("darwin_set_sstep: error %x, thread=%x\n"),
596                          kret, thread);
597       return;
598     }
599
600   switch (regs.tsh.flavor)
601     {
602     case x86_THREAD_STATE32:
603       {
604         __uint32_t bit = enable ? X86_EFLAGS_T : 0;
605
606         if (enable && i386_darwin_sstep_at_sigreturn (&regs))
607           return;
608         if ((regs.uts.ts32.__eflags & X86_EFLAGS_T) == bit)
609           return;
610         regs.uts.ts32.__eflags
611           = (regs.uts.ts32.__eflags & ~X86_EFLAGS_T) | bit;
612         kret = thread_set_state (thread, x86_THREAD_STATE,
613                                  (thread_state_t) &regs, count);
614         MACH_CHECK_ERROR (kret);
615       }
616       break;
617 #ifdef BFD64
618     case x86_THREAD_STATE64:
619       {
620         __uint64_t bit = enable ? X86_EFLAGS_T : 0;
621
622         if (enable && amd64_darwin_sstep_at_sigreturn (&regs))
623           return;
624         if ((regs.uts.ts64.__rflags & X86_EFLAGS_T) == bit)
625           return;
626         regs.uts.ts64.__rflags
627           = (regs.uts.ts64.__rflags & ~X86_EFLAGS_T) | bit;
628         kret = thread_set_state (thread, x86_THREAD_STATE,
629                                  (thread_state_t) &regs, count);
630         MACH_CHECK_ERROR (kret);
631       }
632       break;
633 #endif
634     default:
635       error (_("darwin_set_sstep: unknown flavour: %d"), regs.tsh.flavor);
636     }
637 }
638
639 void
640 _initialize_i386_darwin_nat (void)
641 {
642 #ifdef BFD64
643   amd64_native_gregset64_reg_offset = amd64_darwin_thread_state_reg_offset;
644   amd64_native_gregset64_num_regs = amd64_darwin_thread_state_num_regs;
645   amd64_native_gregset32_reg_offset = i386_darwin_thread_state_reg_offset;
646   amd64_native_gregset32_num_regs = i386_darwin_thread_state_num_regs;
647 #endif
648
649   x86_dr_low.set_control = i386_darwin_dr_set_control;
650   x86_dr_low.set_addr = i386_darwin_dr_set_addr;
651   x86_dr_low.get_addr = i386_darwin_dr_get_addr;
652   x86_dr_low.get_status = i386_darwin_dr_get_status;
653   x86_dr_low.get_control = i386_darwin_dr_get_control;
654
655   /* Let's assume that the kernel is 64 bits iff the executable is.  */
656 #ifdef __x86_64__
657   x86_set_debug_register_length (8);
658 #else
659   x86_set_debug_register_length (4);
660 #endif
661
662   add_target (&darwin_target);
663 }