Automatic date update in version.in
[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 = regcache->ptid ().tid ();
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               (i, (char *) &gp_regs + i386_darwin_thread_state_reg_offset[i]);
137
138           fetched++;
139         }
140
141       if (regno == -1
142           || (regno >= I386_ST0_REGNUM && regno < I386_SSE_NUM_REGS))
143         {
144           x86_float_state32_t fp_regs;
145           unsigned int fp_count = x86_FLOAT_STATE32_COUNT;
146           kern_return_t ret;
147
148           ret = thread_get_state
149             (current_thread, x86_FLOAT_STATE32, (thread_state_t) &fp_regs,
150              &fp_count);
151           if (ret != KERN_SUCCESS)
152             {
153               printf_unfiltered (_("Error calling thread_get_state for "
154                                    "float registers for thread 0x%lx\n"),
155                                  (unsigned long) current_thread);
156               MACH_CHECK_ERROR (ret);
157             }
158           i387_supply_fxsave (regcache, -1, &fp_regs.__fpu_fcw);
159           fetched++;
160         }
161     }
162
163   if (! fetched)
164     {
165       warning (_("unknown register %d"), regno);
166       regcache->raw_supply (regno, NULL);
167     }
168 }
169
170 /* Store our register values back into the inferior.
171    If REGNO is -1, do this for all registers.
172    Otherwise, REGNO specifies which register (so we can save time).  */
173
174 void
175 i386_darwin_nat_target::store_registers (struct regcache *regcache,
176                                          int regno)
177 {
178   thread_t current_thread = regcache->ptid ().tid ();
179   struct gdbarch *gdbarch = regcache->arch ();
180
181 #ifdef BFD64
182   if (gdbarch_ptr_bit (gdbarch) == 64)
183     {
184       if (regno == -1 || amd64_native_gregset_supplies_p (gdbarch, regno))
185         {
186           x86_thread_state_t gp_regs;
187           kern_return_t ret;
188           unsigned int gp_count = x86_THREAD_STATE_COUNT;
189
190           ret = thread_get_state
191             (current_thread, x86_THREAD_STATE, (thread_state_t) &gp_regs,
192              &gp_count);
193           MACH_CHECK_ERROR (ret);
194           gdb_assert (gp_regs.tsh.flavor == x86_THREAD_STATE64);
195           gdb_assert (gp_regs.tsh.count == x86_THREAD_STATE64_COUNT);
196
197           amd64_collect_native_gregset (regcache, &gp_regs.uts, regno);
198
199           /* Some kernels don't sanitize the values.  */
200           gp_regs.uts.ts64.__fs &= 0xffff;
201           gp_regs.uts.ts64.__gs &= 0xffff;
202
203           ret = thread_set_state (current_thread, x86_THREAD_STATE,
204                                   (thread_state_t) &gp_regs,
205                                   x86_THREAD_STATE_COUNT);
206           MACH_CHECK_ERROR (ret);
207         }
208
209       if (regno == -1 || !amd64_native_gregset_supplies_p (gdbarch, regno))
210         {
211           x86_float_state_t fp_regs;
212           kern_return_t ret;
213           unsigned int fp_count = x86_FLOAT_STATE_COUNT;
214
215           ret = thread_get_state
216             (current_thread, x86_FLOAT_STATE, (thread_state_t) & fp_regs,
217              &fp_count);
218           MACH_CHECK_ERROR (ret);
219           gdb_assert (fp_regs.fsh.flavor == x86_FLOAT_STATE64);
220           gdb_assert (fp_regs.fsh.count == x86_FLOAT_STATE64_COUNT);
221
222           amd64_collect_fxsave (regcache, regno, &fp_regs.ufs.fs64.__fpu_fcw);
223
224           ret = thread_set_state (current_thread, x86_FLOAT_STATE,
225                                   (thread_state_t) & fp_regs,
226                                   x86_FLOAT_STATE_COUNT);
227           MACH_CHECK_ERROR (ret);
228         }
229     }
230   else
231 #endif
232     {
233       if (regno == -1 || regno < I386_NUM_GREGS)
234         {
235           x86_thread_state32_t gp_regs;
236           kern_return_t ret;
237           unsigned int gp_count = x86_THREAD_STATE32_COUNT;
238           int i;
239
240           ret = thread_get_state
241             (current_thread, x86_THREAD_STATE32, (thread_state_t) &gp_regs,
242              &gp_count);
243           MACH_CHECK_ERROR (ret);
244
245           for (i = 0; i < I386_NUM_GREGS; i++)
246             if (regno == -1 || regno == i)
247               regcache->raw_collect
248                 (i, (char *) &gp_regs + i386_darwin_thread_state_reg_offset[i]);
249
250           ret = thread_set_state (current_thread, x86_THREAD_STATE32,
251                                   (thread_state_t) &gp_regs,
252                                   x86_THREAD_STATE32_COUNT);
253           MACH_CHECK_ERROR (ret);
254         }
255
256       if (regno == -1
257           || (regno >= I386_ST0_REGNUM && regno < I386_SSE_NUM_REGS))
258         {
259           x86_float_state32_t fp_regs;
260           unsigned int fp_count = x86_FLOAT_STATE32_COUNT;
261           kern_return_t ret;
262
263           ret = thread_get_state
264             (current_thread, x86_FLOAT_STATE32, (thread_state_t) & fp_regs,
265              &fp_count);
266           MACH_CHECK_ERROR (ret);
267
268           i387_collect_fxsave (regcache, regno, &fp_regs.__fpu_fcw);
269
270           ret = thread_set_state (current_thread, x86_FLOAT_STATE32,
271                                   (thread_state_t) &fp_regs,
272                                   x86_FLOAT_STATE32_COUNT);
273           MACH_CHECK_ERROR (ret);
274         }
275     }
276 }
277
278 /* Support for debug registers, boosted mostly from i386-linux-nat.c.  */
279
280 static void
281 i386_darwin_dr_set (int regnum, CORE_ADDR value)
282 {
283   int current_pid;
284   thread_t current_thread;
285   x86_debug_state_t dr_regs;
286   kern_return_t ret;
287   unsigned int dr_count;
288
289   gdb_assert (regnum >= 0 && regnum <= DR_CONTROL);
290
291   current_thread = inferior_ptid.tid ();
292
293   dr_regs.dsh.flavor = x86_DEBUG_STATE;
294   dr_regs.dsh.count = x86_DEBUG_STATE_COUNT;
295   dr_count = x86_DEBUG_STATE_COUNT;
296   ret = thread_get_state (current_thread, x86_DEBUG_STATE,
297                           (thread_state_t) &dr_regs, &dr_count);
298   MACH_CHECK_ERROR (ret);
299
300   switch (dr_regs.dsh.flavor)
301     {
302     case x86_DEBUG_STATE32:
303       switch (regnum)
304         {
305         case 0:
306           dr_regs.uds.ds32.__dr0 = value;
307           break;
308         case 1:
309           dr_regs.uds.ds32.__dr1 = value;
310           break;
311         case 2:
312           dr_regs.uds.ds32.__dr2 = value;
313           break;
314         case 3:
315           dr_regs.uds.ds32.__dr3 = value;
316           break;
317         case 4:
318           dr_regs.uds.ds32.__dr4 = value;
319           break;
320         case 5:
321           dr_regs.uds.ds32.__dr5 = value;
322           break;
323         case 6:
324           dr_regs.uds.ds32.__dr6 = value;
325           break;
326         case 7:
327           dr_regs.uds.ds32.__dr7 = value;
328           break;
329         }
330       break;
331 #ifdef BFD64
332     case x86_DEBUG_STATE64:
333       switch (regnum)
334         {
335         case 0:
336           dr_regs.uds.ds64.__dr0 = value;
337           break;
338         case 1:
339           dr_regs.uds.ds64.__dr1 = value;
340           break;
341         case 2:
342           dr_regs.uds.ds64.__dr2 = value;
343           break;
344         case 3:
345           dr_regs.uds.ds64.__dr3 = value;
346           break;
347         case 4:
348           dr_regs.uds.ds64.__dr4 = value;
349           break;
350         case 5:
351           dr_regs.uds.ds64.__dr5 = value;
352           break;
353         case 6:
354           dr_regs.uds.ds64.__dr6 = value;
355           break;
356         case 7:
357           dr_regs.uds.ds64.__dr7 = value;
358           break;
359         }
360       break;
361 #endif
362     }
363
364   ret = thread_set_state (current_thread, dr_regs.dsh.flavor,
365                           (thread_state_t) &dr_regs.uds, dr_count);
366
367   MACH_CHECK_ERROR (ret);
368 }
369
370 static CORE_ADDR
371 i386_darwin_dr_get (int regnum)
372 {
373   thread_t current_thread;
374   x86_debug_state_t dr_regs;
375   kern_return_t ret;
376   unsigned int dr_count;
377
378   gdb_assert (regnum >= 0 && regnum <= DR_CONTROL);
379
380   current_thread = inferior_ptid.tid ();
381
382   dr_regs.dsh.flavor = x86_DEBUG_STATE;
383   dr_regs.dsh.count = x86_DEBUG_STATE_COUNT;
384   dr_count = x86_DEBUG_STATE_COUNT;
385   ret = thread_get_state (current_thread, x86_DEBUG_STATE,
386                           (thread_state_t) &dr_regs, &dr_count);
387   MACH_CHECK_ERROR (ret);
388
389   switch (dr_regs.dsh.flavor)
390     {
391     case x86_DEBUG_STATE32:
392       switch (regnum)
393         {
394         case 0:
395           return dr_regs.uds.ds32.__dr0;
396         case 1:
397           return dr_regs.uds.ds32.__dr1;
398         case 2:
399           return dr_regs.uds.ds32.__dr2;
400         case 3:
401           return dr_regs.uds.ds32.__dr3;
402         case 4:
403           return dr_regs.uds.ds32.__dr4;
404         case 5:
405           return dr_regs.uds.ds32.__dr5;
406         case 6:
407           return dr_regs.uds.ds32.__dr6;
408         case 7:
409           return dr_regs.uds.ds32.__dr7;
410         default:
411           return -1;
412         }
413       break;
414 #ifdef BFD64
415     case x86_DEBUG_STATE64:
416       switch (regnum)
417         {
418         case 0:
419           return dr_regs.uds.ds64.__dr0;
420         case 1:
421           return dr_regs.uds.ds64.__dr1;
422         case 2:
423           return dr_regs.uds.ds64.__dr2;
424         case 3:
425           return dr_regs.uds.ds64.__dr3;
426         case 4:
427           return dr_regs.uds.ds64.__dr4;
428         case 5:
429           return dr_regs.uds.ds64.__dr5;
430         case 6:
431           return dr_regs.uds.ds64.__dr6;
432         case 7:
433           return dr_regs.uds.ds64.__dr7;
434         default:
435           return -1;
436         }
437       break;
438 #endif
439     default:
440       return -1;
441     }
442 }
443
444 static void
445 i386_darwin_dr_set_control (unsigned long control)
446 {
447   i386_darwin_dr_set (DR_CONTROL, control);
448 }
449
450 static void
451 i386_darwin_dr_set_addr (int regnum, CORE_ADDR addr)
452 {
453   gdb_assert (regnum >= 0 && regnum <= DR_LASTADDR - DR_FIRSTADDR);
454
455   i386_darwin_dr_set (DR_FIRSTADDR + regnum, addr);
456 }
457
458 static CORE_ADDR
459 i386_darwin_dr_get_addr (int regnum)
460 {
461   return i386_darwin_dr_get (regnum);
462 }
463
464 static unsigned long
465 i386_darwin_dr_get_status (void)
466 {
467   return i386_darwin_dr_get (DR_STATUS);
468 }
469
470 static unsigned long
471 i386_darwin_dr_get_control (void)
472 {
473   return i386_darwin_dr_get (DR_CONTROL);
474 }
475
476 void
477 darwin_check_osabi (darwin_inferior *inf, thread_t thread)
478 {
479   if (gdbarch_osabi (target_gdbarch ()) == GDB_OSABI_UNKNOWN)
480     {
481       /* Attaching to a process.  Let's figure out what kind it is.  */
482       x86_thread_state_t gp_regs;
483       struct gdbarch_info info;
484       unsigned int gp_count = x86_THREAD_STATE_COUNT;
485       kern_return_t ret;
486
487       ret = thread_get_state (thread, x86_THREAD_STATE,
488                               (thread_state_t) &gp_regs, &gp_count);
489       if (ret != KERN_SUCCESS)
490         {
491           MACH_CHECK_ERROR (ret);
492           return;
493         }
494
495       gdbarch_info_init (&info);
496       gdbarch_info_fill (&info);
497       info.byte_order = gdbarch_byte_order (target_gdbarch ());
498       info.osabi = GDB_OSABI_DARWIN;
499       if (gp_regs.tsh.flavor == x86_THREAD_STATE64)
500         info.bfd_arch_info = bfd_lookup_arch (bfd_arch_i386,
501                                               bfd_mach_x86_64);
502       else
503         info.bfd_arch_info = bfd_lookup_arch (bfd_arch_i386,
504                                               bfd_mach_i386_i386);
505       gdbarch_update_p (info);
506     }
507 }
508
509 #define X86_EFLAGS_T 0x100UL
510
511 /* Returning from a signal trampoline is done by calling a
512    special system call (sigreturn).  This system call
513    restores the registers that were saved when the signal was
514    raised, including %eflags/%rflags.  That means that single-stepping
515    won't work.  Instead, we'll have to modify the signal context
516    that's about to be restored, and set the trace flag there.  */
517
518 static int
519 i386_darwin_sstep_at_sigreturn (x86_thread_state_t *regs)
520 {
521   enum bfd_endian byte_order = gdbarch_byte_order (target_gdbarch ());
522   static const gdb_byte darwin_syscall[] = { 0xcd, 0x80 }; /* int 0x80 */
523   gdb_byte buf[sizeof (darwin_syscall)];
524
525   /* Check if PC is at a sigreturn system call.  */
526   if (target_read_memory (regs->uts.ts32.__eip, buf, sizeof (buf)) == 0
527       && memcmp (buf, darwin_syscall, sizeof (darwin_syscall)) == 0
528       && regs->uts.ts32.__eax == 0xb8 /* SYS_sigreturn */)
529     {
530       ULONGEST uctx_addr;
531       ULONGEST mctx_addr;
532       ULONGEST flags_addr;
533       unsigned int eflags;
534
535       uctx_addr = read_memory_unsigned_integer
536                     (regs->uts.ts32.__esp + 4, 4, byte_order);
537       mctx_addr = read_memory_unsigned_integer
538                     (uctx_addr + 28, 4, byte_order);
539
540       flags_addr = mctx_addr + 12 + 9 * 4;
541       read_memory (flags_addr, (gdb_byte *) &eflags, 4);
542       eflags |= X86_EFLAGS_T;
543       write_memory (flags_addr, (gdb_byte *) &eflags, 4);
544
545       return 1;
546     }
547   return 0;
548 }
549
550 #ifdef BFD64
551 static int
552 amd64_darwin_sstep_at_sigreturn (x86_thread_state_t *regs)
553 {
554   enum bfd_endian byte_order = gdbarch_byte_order (target_gdbarch ());
555   static const gdb_byte darwin_syscall[] = { 0x0f, 0x05 }; /* syscall */
556   gdb_byte buf[sizeof (darwin_syscall)];
557
558   /* Check if PC is at a sigreturn system call.  */
559   if (target_read_memory (regs->uts.ts64.__rip, buf, sizeof (buf)) == 0
560       && memcmp (buf, darwin_syscall, sizeof (darwin_syscall)) == 0
561       && (regs->uts.ts64.__rax & 0xffffffff) == 0x20000b8 /* SYS_sigreturn */)
562     {
563       ULONGEST mctx_addr;
564       ULONGEST flags_addr;
565       unsigned int rflags;
566
567       mctx_addr = read_memory_unsigned_integer
568                     (regs->uts.ts64.__rdi + 48, 8, byte_order);
569       flags_addr = mctx_addr + 16 + 17 * 8;
570
571       /* AMD64 is little endian.  */
572       read_memory (flags_addr, (gdb_byte *) &rflags, 4);
573       rflags |= X86_EFLAGS_T;
574       write_memory (flags_addr, (gdb_byte *) &rflags, 4);
575
576       return 1;
577     }
578   return 0;
579 }
580 #endif
581
582 void
583 darwin_set_sstep (thread_t thread, int enable)
584 {
585   x86_thread_state_t regs;
586   unsigned int count = x86_THREAD_STATE_COUNT;
587   kern_return_t kret;
588
589   kret = thread_get_state (thread, x86_THREAD_STATE,
590                            (thread_state_t) &regs, &count);
591   if (kret != KERN_SUCCESS)
592     {
593       printf_unfiltered (_("darwin_set_sstep: error %x, thread=%x\n"),
594                          kret, thread);
595       return;
596     }
597
598   switch (regs.tsh.flavor)
599     {
600     case x86_THREAD_STATE32:
601       {
602         __uint32_t bit = enable ? X86_EFLAGS_T : 0;
603
604         if (enable && i386_darwin_sstep_at_sigreturn (&regs))
605           return;
606         if ((regs.uts.ts32.__eflags & X86_EFLAGS_T) == bit)
607           return;
608         regs.uts.ts32.__eflags
609           = (regs.uts.ts32.__eflags & ~X86_EFLAGS_T) | bit;
610         kret = thread_set_state (thread, x86_THREAD_STATE,
611                                  (thread_state_t) &regs, count);
612         MACH_CHECK_ERROR (kret);
613       }
614       break;
615 #ifdef BFD64
616     case x86_THREAD_STATE64:
617       {
618         __uint64_t bit = enable ? X86_EFLAGS_T : 0;
619
620         if (enable && amd64_darwin_sstep_at_sigreturn (&regs))
621           return;
622         if ((regs.uts.ts64.__rflags & X86_EFLAGS_T) == bit)
623           return;
624         regs.uts.ts64.__rflags
625           = (regs.uts.ts64.__rflags & ~X86_EFLAGS_T) | bit;
626         kret = thread_set_state (thread, x86_THREAD_STATE,
627                                  (thread_state_t) &regs, count);
628         MACH_CHECK_ERROR (kret);
629       }
630       break;
631 #endif
632     default:
633       error (_("darwin_set_sstep: unknown flavour: %d"), regs.tsh.flavor);
634     }
635 }
636
637 void
638 _initialize_i386_darwin_nat (void)
639 {
640 #ifdef BFD64
641   amd64_native_gregset64_reg_offset = amd64_darwin_thread_state_reg_offset;
642   amd64_native_gregset64_num_regs = amd64_darwin_thread_state_num_regs;
643   amd64_native_gregset32_reg_offset = i386_darwin_thread_state_reg_offset;
644   amd64_native_gregset32_num_regs = i386_darwin_thread_state_num_regs;
645 #endif
646
647   x86_dr_low.set_control = i386_darwin_dr_set_control;
648   x86_dr_low.set_addr = i386_darwin_dr_set_addr;
649   x86_dr_low.get_addr = i386_darwin_dr_get_addr;
650   x86_dr_low.get_status = i386_darwin_dr_get_status;
651   x86_dr_low.get_control = i386_darwin_dr_get_control;
652
653   /* Let's assume that the kernel is 64 bits iff the executable is.  */
654 #ifdef __x86_64__
655   x86_set_debug_register_length (8);
656 #else
657   x86_set_debug_register_length (4);
658 #endif
659
660   add_inf_child_target (&darwin_target);
661 }