Automatic date update in version.in
[binutils-gdb.git] / gdb / darwin-nat.c
blob0c5b54b40a3beb7ebc5adb9bfe1890cf0ea68ba8
1 /* Darwin support for GDB, the GNU debugger.
2 Copyright (C) 2008-2024 Free Software Foundation, Inc.
4 Contributed by AdaCore.
6 This file is part of GDB.
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.
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.
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/>. */
21 #include "top.h"
22 #include "inferior.h"
23 #include "target.h"
24 #include "symfile.h"
25 #include "symtab.h"
26 #include "objfiles.h"
27 #include "gdbcmd.h"
28 #include "gdbcore.h"
29 #include "gdbthread.h"
30 #include "regcache.h"
31 #include "event-top.h"
32 #include "inf-loop.h"
33 #include <sys/stat.h>
34 #include "inf-child.h"
35 #include "value.h"
36 #include "arch-utils.h"
37 #include "bfd.h"
38 #include "bfd/mach-o.h"
39 #include "gdbarch.h"
41 #include <copyfile.h>
42 #include <sys/ptrace.h>
43 #include <sys/signal.h>
44 #include <setjmp.h>
45 #include <sys/types.h>
46 #include <unistd.h>
47 #include <signal.h>
48 #include <ctype.h>
49 #include <sys/sysctl.h>
50 #include <sys/proc.h>
51 #include <libproc.h>
52 #include <sys/syscall.h>
53 #include <spawn.h>
55 #include <mach/mach_error.h>
56 #include <mach/mach_vm.h>
57 #include <mach/mach_init.h>
58 #include <mach/vm_map.h>
59 #include <mach/task.h>
60 #include <mach/mach_port.h>
61 #include <mach/thread_act.h>
62 #include <mach/port.h>
64 #include "darwin-nat.h"
65 #include "filenames.h"
66 #include "gdbsupport/filestuff.h"
67 #include "gdbsupport/gdb_unlinker.h"
68 #include "gdbsupport/pathstuff.h"
69 #include "gdbsupport/scoped_fd.h"
70 #include "nat/fork-inferior.h"
72 /* Quick overview.
73 Darwin kernel is Mach + BSD derived kernel. Note that they share the
74 same memory space and are linked together (ie there is no micro-kernel).
76 Although ptrace(2) is available on Darwin, it is not complete. We have
77 to use Mach calls to read and write memory and to modify registers. We
78 also use Mach to get inferior faults. As we cannot use select(2) or
79 signals with Mach port (the Mach communication channel), signals are
80 reported to gdb as an exception. Furthermore we detect death of the
81 inferior through a Mach notification message. This way we only wait
82 on Mach ports.
84 Some Mach documentation is available for Apple xnu source package or
85 from the web. */
88 #define PTRACE(CMD, PID, ADDR, SIG) \
89 darwin_ptrace(#CMD, CMD, (PID), (ADDR), (SIG))
91 static void darwin_ptrace_me (void);
93 static void darwin_encode_reply (mig_reply_error_t *reply,
94 mach_msg_header_t *hdr, integer_t code);
96 static void darwin_setup_request_notification (struct inferior *inf);
97 static void darwin_deallocate_exception_ports (darwin_inferior *inf);
98 static void darwin_setup_exceptions (struct inferior *inf);
99 static void darwin_deallocate_threads (struct inferior *inf);
101 /* Task identifier of gdb. */
102 static task_t gdb_task;
104 /* A copy of mach_host_self (). */
105 mach_port_t darwin_host_self;
107 /* Exception port. */
108 mach_port_t darwin_ex_port;
110 /* Port set, to wait for answer on all ports. */
111 mach_port_t darwin_port_set;
113 /* Page size. */
114 static vm_size_t mach_page_size;
116 /* If Set, catch all mach exceptions (before they are converted to signals
117 by the kernel). */
118 static bool enable_mach_exceptions;
120 /* Inferior that should report a fake stop event. */
121 static struct inferior *darwin_inf_fake_stop;
123 /* If non-NULL, the shell we actually invoke. See maybe_cache_shell
124 for details. */
125 static const char *copied_shell;
127 #define PAGE_TRUNC(x) ((x) & ~(mach_page_size - 1))
128 #define PAGE_ROUND(x) PAGE_TRUNC((x) + mach_page_size - 1)
130 /* This controls output of inferior debugging. */
131 static unsigned int darwin_debug_flag = 0;
133 /* Create a __TEXT __info_plist section in the executable so that gdb could
134 be signed. This is required to get an authorization for task_for_pid.
136 Once gdb is built, you must codesign it with any system-trusted signing
137 authority. See taskgated(8) for details. */
138 static const unsigned char info_plist[]
139 __attribute__ ((section ("__TEXT,__info_plist"),used)) =
140 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
141 "<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\""
142 " \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
143 "<plist version=\"1.0\">\n"
144 "<dict>\n"
145 " <key>CFBundleIdentifier</key>\n"
146 " <string>org.gnu.gdb</string>\n"
147 " <key>CFBundleName</key>\n"
148 " <string>gdb</string>\n"
149 " <key>CFBundleVersion</key>\n"
150 " <string>1.0</string>\n"
151 " <key>SecTaskAccess</key>\n"
152 " <array>\n"
153 " <string>allowed</string>\n"
154 " <string>debug</string>\n"
155 " </array>\n"
156 "</dict>\n"
157 "</plist>\n";
159 static void inferior_debug (int level, const char *fmt, ...)
160 ATTRIBUTE_PRINTF (2, 3);
162 static void
163 inferior_debug (int level, const char *fmt, ...)
165 va_list ap;
167 if (darwin_debug_flag < level)
168 return;
170 va_start (ap, fmt);
171 gdb_printf (gdb_stdlog, _("[%d inferior]: "), getpid ());
172 gdb_vprintf (gdb_stdlog, fmt, ap);
173 va_end (ap);
176 void
177 mach_check_error (kern_return_t ret, const char *file,
178 unsigned int line, const char *func)
180 if (ret == KERN_SUCCESS)
181 return;
182 if (func == NULL)
183 func = _("[UNKNOWN]");
185 warning (_("Mach error at \"%s:%u\" in function \"%s\": %s (0x%lx)"),
186 file, line, func, mach_error_string (ret), (unsigned long) ret);
189 static const char *
190 unparse_exception_type (unsigned int i)
192 static char unknown_exception_buf[32];
194 switch (i)
196 case EXC_BAD_ACCESS:
197 return "EXC_BAD_ACCESS";
198 case EXC_BAD_INSTRUCTION:
199 return "EXC_BAD_INSTRUCTION";
200 case EXC_ARITHMETIC:
201 return "EXC_ARITHMETIC";
202 case EXC_EMULATION:
203 return "EXC_EMULATION";
204 case EXC_SOFTWARE:
205 return "EXC_SOFTWARE";
206 case EXC_BREAKPOINT:
207 return "EXC_BREAKPOINT";
208 case EXC_SYSCALL:
209 return "EXC_SYSCALL";
210 case EXC_MACH_SYSCALL:
211 return "EXC_MACH_SYSCALL";
212 case EXC_RPC_ALERT:
213 return "EXC_RPC_ALERT";
214 case EXC_CRASH:
215 return "EXC_CRASH";
216 default:
217 snprintf (unknown_exception_buf, 32, _("unknown (%d)"), i);
218 return unknown_exception_buf;
222 /* Set errno to zero, and then call ptrace with the given arguments.
223 If inferior debugging traces are on, then also print a debug
224 trace.
226 The returned value is the same as the value returned by ptrace,
227 except in the case where that value is -1 but errno is zero.
228 This case is documented to be a non-error situation, so we
229 return zero in that case. */
231 static int
232 darwin_ptrace (const char *name,
233 int request, int pid, caddr_t arg3, int arg4)
235 int ret;
237 errno = 0;
238 ret = ptrace (request, pid, arg3, arg4);
239 if (ret == -1 && errno == 0)
240 ret = 0;
242 inferior_debug (4, _("ptrace (%s, %d, 0x%lx, %d): %d (%s)\n"),
243 name, pid, (unsigned long) arg3, arg4, ret,
244 (ret != 0) ? safe_strerror (errno) : _("no error"));
245 return ret;
248 static int
249 cmp_thread_t (const void *l, const void *r)
251 thread_t tl = *(const thread_t *)l;
252 thread_t tr = *(const thread_t *)r;
253 return (int)(tl - tr);
256 void
257 darwin_nat_target::check_new_threads (inferior *inf)
259 kern_return_t kret;
260 thread_array_t thread_list;
261 unsigned int new_nbr;
262 unsigned int old_nbr;
263 unsigned int new_ix, old_ix;
264 darwin_inferior *darwin_inf = get_darwin_inferior (inf);
265 std::vector<darwin_thread_t *> new_thread_vec;
267 if (darwin_inf == nullptr)
268 return;
270 /* Get list of threads. */
271 kret = task_threads (darwin_inf->task, &thread_list, &new_nbr);
272 MACH_CHECK_ERROR (kret);
273 if (kret != KERN_SUCCESS)
274 return;
276 /* Sort the list. */
277 if (new_nbr > 1)
278 qsort (thread_list, new_nbr, sizeof (thread_t), cmp_thread_t);
280 old_nbr = darwin_inf->threads.size ();
282 /* Quick check for no changes. */
283 if (old_nbr == new_nbr)
285 size_t i;
287 for (i = 0; i < new_nbr; i++)
288 if (thread_list[i] != darwin_inf->threads[i]->gdb_port)
289 break;
290 if (i == new_nbr)
292 /* Deallocate ports. */
293 for (i = 0; i < new_nbr; i++)
295 kret = mach_port_deallocate (mach_task_self (), thread_list[i]);
296 MACH_CHECK_ERROR (kret);
299 /* Deallocate the buffer. */
300 kret = vm_deallocate (gdb_task, (vm_address_t) thread_list,
301 new_nbr * sizeof (int));
302 MACH_CHECK_ERROR (kret);
304 return;
308 /* Full handling: detect new threads, remove dead threads. */
310 new_thread_vec.reserve (new_nbr);
312 for (new_ix = 0, old_ix = 0; new_ix < new_nbr || old_ix < old_nbr;)
314 thread_t new_id = (new_ix < new_nbr) ? thread_list[new_ix] : THREAD_NULL;
315 darwin_thread_t *old
316 = (old_ix < old_nbr) ? darwin_inf->threads[old_ix] : NULL;
317 thread_t old_id = old != NULL ? old->gdb_port : THREAD_NULL;
319 inferior_debug
320 (12, _(" new_ix:%d/%d, old_ix:%d/%d, new_id:0x%x old_id:0x%x\n"),
321 new_ix, new_nbr, old_ix, old_nbr, new_id, old_id);
323 if (old_id == new_id)
325 /* Thread still exist. */
326 new_thread_vec.push_back (old);
327 new_ix++;
328 old_ix++;
330 /* Deallocate the port. */
331 kret = mach_port_deallocate (gdb_task, new_id);
332 MACH_CHECK_ERROR (kret);
334 continue;
336 if (new_ix < new_nbr && new_id == MACH_PORT_DEAD)
338 /* Ignore dead ports.
339 In some weird cases, we might get dead ports. They should
340 correspond to dead thread so they could safely be ignored. */
341 new_ix++;
342 continue;
344 if (new_ix < new_nbr && (old_ix == old_nbr || new_id < old_id))
346 /* A thread was created. */
347 darwin_thread_info *pti = new darwin_thread_info;
349 pti->gdb_port = new_id;
350 pti->msg_state = DARWIN_RUNNING;
352 /* Add the new thread. */
353 add_thread_with_info (this, ptid_t (inf->pid, 0, new_id),
354 private_thread_info_up (pti));
355 new_thread_vec.push_back (pti);
356 new_ix++;
357 continue;
359 if (old_ix < old_nbr && (new_ix == new_nbr || new_id > old_id))
361 /* A thread was removed. */
362 struct thread_info *thr
363 = this->find_thread (ptid_t (inf->pid, 0, old_id));
364 delete_thread (thr);
365 kret = mach_port_deallocate (gdb_task, old_id);
366 MACH_CHECK_ERROR (kret);
367 old_ix++;
368 continue;
370 gdb_assert_not_reached ("unexpected thread case");
373 darwin_inf->threads = std::move (new_thread_vec);
375 /* Deallocate the buffer. */
376 kret = vm_deallocate (gdb_task, (vm_address_t) thread_list,
377 new_nbr * sizeof (int));
378 MACH_CHECK_ERROR (kret);
381 /* Return an inferior by task port. */
382 static struct inferior *
383 darwin_find_inferior_by_task (task_t port)
385 for (inferior *inf : all_inferiors ())
387 darwin_inferior *priv = get_darwin_inferior (inf);
389 if (priv != nullptr && priv->task == port)
390 return inf;
392 return nullptr;
395 /* Return an inferior by pid port. */
396 static struct inferior *
397 darwin_find_inferior_by_pid (int pid)
399 for (inferior *inf : all_inferiors ())
401 if (inf->pid == pid)
402 return inf;
404 return nullptr;
407 /* Return a thread by port. */
408 static darwin_thread_t *
409 darwin_find_thread (struct inferior *inf, thread_t thread)
411 darwin_inferior *priv = get_darwin_inferior (inf);
413 if (priv != nullptr)
414 for (darwin_thread_t *t : priv->threads)
416 if (t->gdb_port == thread)
417 return t;
420 return NULL;
423 /* Suspend (ie stop) an inferior at Mach level. */
425 static void
426 darwin_suspend_inferior (struct inferior *inf)
428 darwin_inferior *priv = get_darwin_inferior (inf);
430 if (priv != nullptr && !priv->suspended)
432 kern_return_t kret;
434 kret = task_suspend (priv->task);
435 MACH_CHECK_ERROR (kret);
437 priv->suspended = 1;
441 /* Resume an inferior at Mach level. */
443 static void
444 darwin_resume_inferior (struct inferior *inf)
446 darwin_inferior *priv = get_darwin_inferior (inf);
448 if (priv != nullptr && priv->suspended)
450 kern_return_t kret;
452 kret = task_resume (priv->task);
453 MACH_CHECK_ERROR (kret);
455 priv->suspended = 0;
459 static void
460 darwin_dump_message (mach_msg_header_t *hdr, int disp_body)
462 gdb_printf (gdb_stdlog,
463 _("message header:\n"));
464 gdb_printf (gdb_stdlog,
465 _(" bits: 0x%x\n"), hdr->msgh_bits);
466 gdb_printf (gdb_stdlog,
467 _(" size: 0x%x\n"), hdr->msgh_size);
468 gdb_printf (gdb_stdlog,
469 _(" remote-port: 0x%x\n"), hdr->msgh_remote_port);
470 gdb_printf (gdb_stdlog,
471 _(" local-port: 0x%x\n"), hdr->msgh_local_port);
472 gdb_printf (gdb_stdlog,
473 _(" reserved: 0x%x\n"), hdr->msgh_reserved);
474 gdb_printf (gdb_stdlog,
475 _(" id: 0x%x\n"), hdr->msgh_id);
477 if (disp_body)
479 const unsigned char *data;
480 const unsigned int *ldata;
481 int size;
482 int i;
484 data = (unsigned char *)(hdr + 1);
485 size = hdr->msgh_size - sizeof (mach_msg_header_t);
487 if (hdr->msgh_bits & MACH_MSGH_BITS_COMPLEX)
489 mach_msg_body_t *bod = (mach_msg_body_t*)data;
490 mach_msg_port_descriptor_t *desc =
491 (mach_msg_port_descriptor_t *)(bod + 1);
492 int k;
493 NDR_record_t *ndr;
494 gdb_printf (gdb_stdlog,
495 _("body: descriptor_count=%u\n"),
496 bod->msgh_descriptor_count);
497 data += sizeof (mach_msg_body_t);
498 size -= sizeof (mach_msg_body_t);
499 for (k = 0; k < bod->msgh_descriptor_count; k++)
500 switch (desc[k].type)
502 case MACH_MSG_PORT_DESCRIPTOR:
503 gdb_printf
504 (gdb_stdlog,
505 _(" descr %d: type=%u (port) name=0x%x, dispo=%d\n"),
506 k, desc[k].type, desc[k].name, desc[k].disposition);
507 break;
508 default:
509 gdb_printf (gdb_stdlog,
510 _(" descr %d: type=%u\n"),
511 k, desc[k].type);
512 break;
514 data += bod->msgh_descriptor_count
515 * sizeof (mach_msg_port_descriptor_t);
516 size -= bod->msgh_descriptor_count
517 * sizeof (mach_msg_port_descriptor_t);
518 ndr = (NDR_record_t *)(desc + bod->msgh_descriptor_count);
519 gdb_printf
520 (gdb_stdlog,
521 _("NDR: mig=%02x if=%02x encod=%02x "
522 "int=%02x char=%02x float=%02x\n"),
523 ndr->mig_vers, ndr->if_vers, ndr->mig_encoding,
524 ndr->int_rep, ndr->char_rep, ndr->float_rep);
525 data += sizeof (NDR_record_t);
526 size -= sizeof (NDR_record_t);
529 gdb_printf (gdb_stdlog, _(" data:"));
530 ldata = (const unsigned int *)data;
531 for (i = 0; i < size / sizeof (unsigned int); i++)
532 gdb_printf (gdb_stdlog, " %08x", ldata[i]);
533 gdb_printf (gdb_stdlog, _("\n"));
537 /* Adjust inferior data when a new task was created. */
539 static struct inferior *
540 darwin_find_new_inferior (task_t task_port, thread_t thread_port)
542 int task_pid;
543 struct inferior *inf;
544 kern_return_t kret;
545 mach_port_t prev;
547 /* Find the corresponding pid. */
548 kret = pid_for_task (task_port, &task_pid);
549 if (kret != KERN_SUCCESS)
551 MACH_CHECK_ERROR (kret);
552 return NULL;
555 /* Find the inferior for this pid. */
556 inf = darwin_find_inferior_by_pid (task_pid);
557 if (inf == NULL)
558 return NULL;
560 darwin_inferior *priv = get_darwin_inferior (inf);
562 /* Deallocate saved exception ports. */
563 darwin_deallocate_exception_ports (priv);
565 /* No need to remove dead_name notification, but still... */
566 kret = mach_port_request_notification (gdb_task, priv->task,
567 MACH_NOTIFY_DEAD_NAME, 0,
568 MACH_PORT_NULL,
569 MACH_MSG_TYPE_MAKE_SEND_ONCE,
570 &prev);
571 if (kret != KERN_INVALID_ARGUMENT)
572 MACH_CHECK_ERROR (kret);
574 /* Replace old task port. */
575 kret = mach_port_deallocate (gdb_task, priv->task);
576 MACH_CHECK_ERROR (kret);
577 priv->task = task_port;
579 darwin_setup_request_notification (inf);
580 darwin_setup_exceptions (inf);
582 return inf;
585 /* Check data representation. */
587 static int
588 darwin_check_message_ndr (NDR_record_t *ndr)
590 if (ndr->mig_vers != NDR_PROTOCOL_2_0
591 || ndr->if_vers != NDR_PROTOCOL_2_0
592 || ndr->mig_encoding != NDR_record.mig_encoding
593 || ndr->int_rep != NDR_record.int_rep
594 || ndr->char_rep != NDR_record.char_rep
595 || ndr->float_rep != NDR_record.float_rep)
596 return -1;
597 return 0;
600 /* Decode an exception message. */
603 darwin_nat_target::decode_exception_message (mach_msg_header_t *hdr,
604 inferior **pinf,
605 darwin_thread_t **pthread)
607 mach_msg_body_t *bod = (mach_msg_body_t*)(hdr + 1);
608 mach_msg_port_descriptor_t *desc = (mach_msg_port_descriptor_t *)(bod + 1);
609 NDR_record_t *ndr;
610 integer_t *data;
611 struct inferior *inf;
612 darwin_thread_t *thread;
613 task_t task_port;
614 thread_t thread_port;
615 kern_return_t kret;
616 int i;
618 /* Check message destination. */
619 if (hdr->msgh_local_port != darwin_ex_port)
620 return -1;
622 /* Check message header. */
623 if (!(hdr->msgh_bits & MACH_MSGH_BITS_COMPLEX))
624 return -1;
626 /* Check descriptors. */
627 if (hdr->msgh_size < (sizeof (*hdr) + sizeof (*bod) + 2 * sizeof (*desc)
628 + sizeof (*ndr) + 2 * sizeof (integer_t))
629 || bod->msgh_descriptor_count != 2
630 || desc[0].type != MACH_MSG_PORT_DESCRIPTOR
631 || desc[0].disposition != MACH_MSG_TYPE_MOVE_SEND
632 || desc[1].type != MACH_MSG_PORT_DESCRIPTOR
633 || desc[1].disposition != MACH_MSG_TYPE_MOVE_SEND)
634 return -1;
636 /* Check data representation. */
637 ndr = (NDR_record_t *)(desc + 2);
638 if (darwin_check_message_ndr (ndr) != 0)
639 return -1;
641 /* Ok, the hard work. */
642 data = (integer_t *)(ndr + 1);
644 task_port = desc[1].name;
645 thread_port = desc[0].name;
647 /* Find process by port. */
648 inf = darwin_find_inferior_by_task (task_port);
649 *pinf = inf;
651 if (inf == NULL && data[0] == EXC_SOFTWARE && data[1] == 2
652 && data[2] == EXC_SOFT_SIGNAL && data[3] == SIGTRAP)
654 /* Not a known inferior, but a sigtrap. This happens on darwin 16.1.0,
655 as a new Mach task is created when a process exec. */
656 inf = darwin_find_new_inferior (task_port, thread_port);
657 *pinf = inf;
659 if (inf == NULL)
661 /* Deallocate task_port, unless it was saved. */
662 kret = mach_port_deallocate (mach_task_self (), task_port);
663 MACH_CHECK_ERROR (kret);
666 else
668 /* We got new rights to the task, get rid of it. Do not get rid of
669 thread right, as we will need it to find the thread. */
670 kret = mach_port_deallocate (mach_task_self (), task_port);
671 MACH_CHECK_ERROR (kret);
674 if (inf == NULL)
676 /* Not a known inferior. This could happen if the child fork, as
677 the created process will inherit its exception port.
678 FIXME: should the exception port be restored ? */
679 mig_reply_error_t reply;
681 inferior_debug
682 (4, _("darwin_decode_exception_message: unknown task 0x%x\n"),
683 task_port);
685 /* Free thread port (we don't know it). */
686 kret = mach_port_deallocate (mach_task_self (), thread_port);
687 MACH_CHECK_ERROR (kret);
689 darwin_encode_reply (&reply, hdr, KERN_SUCCESS);
691 kret = mach_msg (&reply.Head, MACH_SEND_MSG | MACH_SEND_INTERRUPT,
692 reply.Head.msgh_size, 0,
693 MACH_PORT_NULL, MACH_MSG_TIMEOUT_NONE,
694 MACH_PORT_NULL);
695 MACH_CHECK_ERROR (kret);
697 return 0;
700 /* Find thread by port. */
701 /* Check for new threads. Do it early so that the port in the exception
702 message can be deallocated. */
703 check_new_threads (inf);
705 /* Free the thread port (as gdb knows the thread, it has already has a right
706 for it, so this just decrement a reference counter). */
707 kret = mach_port_deallocate (mach_task_self (), thread_port);
708 MACH_CHECK_ERROR (kret);
710 thread = darwin_find_thread (inf, thread_port);
711 if (thread == NULL)
712 return -1;
713 *pthread = thread;
715 /* The thread should be running. However we have observed cases where a
716 thread got a SIGTTIN message after being stopped. */
717 gdb_assert (thread->msg_state != DARWIN_MESSAGE);
719 /* Finish decoding. */
720 thread->event.header = *hdr;
721 thread->event.thread_port = thread_port;
722 thread->event.task_port = task_port;
723 thread->event.ex_type = data[0];
724 thread->event.data_count = data[1];
726 if (hdr->msgh_size < (sizeof (*hdr) + sizeof (*bod) + 2 * sizeof (*desc)
727 + sizeof (*ndr) + 2 * sizeof (integer_t)
728 + data[1] * sizeof (integer_t)))
729 return -1;
730 for (i = 0; i < data[1]; i++)
731 thread->event.ex_data[i] = data[2 + i];
733 thread->msg_state = DARWIN_MESSAGE;
735 return 0;
738 /* Decode dead_name notify message. */
740 static int
741 darwin_decode_notify_message (mach_msg_header_t *hdr, struct inferior **pinf)
743 NDR_record_t *ndr = (NDR_record_t *)(hdr + 1);
744 integer_t *data = (integer_t *)(ndr + 1);
745 struct inferior *inf;
746 task_t task_port;
748 /* Check message header. */
749 if (hdr->msgh_bits & MACH_MSGH_BITS_COMPLEX)
750 return -1;
752 /* Check descriptors. */
753 if (hdr->msgh_size < (sizeof (*hdr) + sizeof (*ndr) + sizeof (integer_t)))
754 return -2;
756 /* Check data representation. */
757 if (darwin_check_message_ndr (ndr) != 0)
758 return -3;
760 task_port = data[0];
762 /* Find process by port. */
763 inf = darwin_find_inferior_by_task (task_port);
764 *pinf = inf;
766 /* Check message destination. */
767 if (inf != NULL)
769 darwin_inferior *priv = get_darwin_inferior (inf);
770 if (hdr->msgh_local_port != priv->notify_port)
771 return -4;
774 return 0;
777 static void
778 darwin_encode_reply (mig_reply_error_t *reply, mach_msg_header_t *hdr,
779 integer_t code)
781 mach_msg_header_t *rh = &reply->Head;
783 rh->msgh_bits = MACH_MSGH_BITS (MACH_MSGH_BITS_REMOTE (hdr->msgh_bits), 0);
784 rh->msgh_remote_port = hdr->msgh_remote_port;
785 rh->msgh_size = (mach_msg_size_t) sizeof (mig_reply_error_t);
786 rh->msgh_local_port = MACH_PORT_NULL;
787 rh->msgh_id = hdr->msgh_id + 100;
789 reply->NDR = NDR_record;
790 reply->RetCode = code;
793 static void
794 darwin_send_reply (struct inferior *inf, darwin_thread_t *thread)
796 kern_return_t kret;
797 mig_reply_error_t reply;
798 darwin_inferior *priv = get_darwin_inferior (inf);
800 darwin_encode_reply (&reply, &thread->event.header, KERN_SUCCESS);
802 kret = mach_msg (&reply.Head, MACH_SEND_MSG | MACH_SEND_INTERRUPT,
803 reply.Head.msgh_size, 0,
804 MACH_PORT_NULL, MACH_MSG_TIMEOUT_NONE,
805 MACH_PORT_NULL);
806 MACH_CHECK_ERROR (kret);
808 priv->pending_messages--;
811 /* Wrapper around the __pthread_kill syscall. We use this instead of the
812 pthread_kill function to be able to send a signal to any kind of thread,
813 including GCD threads. */
815 static int
816 darwin_pthread_kill (darwin_thread_t *thread, int nsignal)
818 DIAGNOSTIC_PUSH;
819 DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS;
820 int res = syscall (SYS___pthread_kill, thread->gdb_port, nsignal);
821 DIAGNOSTIC_POP;
822 return res;
825 static void
826 darwin_resume_thread (struct inferior *inf, darwin_thread_t *thread,
827 int step, int nsignal)
829 inferior_debug
830 (3, _("darwin_resume_thread: state=%d, thread=0x%x, step=%d nsignal=%d\n"),
831 thread->msg_state, thread->gdb_port, step, nsignal);
833 switch (thread->msg_state)
835 case DARWIN_MESSAGE:
836 if (thread->event.ex_type == EXC_SOFTWARE
837 && thread->event.ex_data[0] == EXC_SOFT_SIGNAL)
839 /* Either deliver a new signal or cancel the signal received. */
840 int res = PTRACE (PT_THUPDATE, inf->pid,
841 (caddr_t) (uintptr_t) thread->gdb_port, nsignal);
842 if (res < 0)
843 inferior_debug (1, _("ptrace THUP: res=%d\n"), res);
845 else if (nsignal)
847 /* Note: ptrace is allowed only if the process is stopped.
848 Directly send the signal to the thread. */
849 int res = darwin_pthread_kill (thread, nsignal);
850 inferior_debug (4, _("darwin_resume_thread: kill 0x%x %d: %d\n"),
851 thread->gdb_port, nsignal, res);
852 thread->signaled = 1;
855 /* Set or reset single step. */
856 inferior_debug (4, _("darwin_set_sstep (thread=0x%x, enable=%d)\n"),
857 thread->gdb_port, step);
858 darwin_set_sstep (thread->gdb_port, step);
859 thread->single_step = step;
861 darwin_send_reply (inf, thread);
862 thread->msg_state = DARWIN_RUNNING;
863 break;
865 case DARWIN_RUNNING:
866 break;
868 case DARWIN_STOPPED:
869 kern_return_t kret = thread_resume (thread->gdb_port);
870 MACH_CHECK_ERROR (kret);
872 thread->msg_state = DARWIN_RUNNING;
873 break;
877 /* Resume all threads of the inferior. */
879 static void
880 darwin_resume_inferior_threads (struct inferior *inf, int step, int nsignal)
882 darwin_inferior *priv = get_darwin_inferior (inf);
884 if (priv != nullptr)
885 for (darwin_thread_t *thread : priv->threads)
886 darwin_resume_thread (inf, thread, step, nsignal);
889 /* Suspend all threads of INF. */
891 static void
892 darwin_suspend_inferior_threads (struct inferior *inf)
894 darwin_inferior *priv = get_darwin_inferior (inf);
896 for (darwin_thread_t *thread : priv->threads)
898 switch (thread->msg_state)
900 case DARWIN_STOPPED:
901 case DARWIN_MESSAGE:
902 break;
903 case DARWIN_RUNNING:
905 kern_return_t kret = thread_suspend (thread->gdb_port);
906 MACH_CHECK_ERROR (kret);
907 thread->msg_state = DARWIN_STOPPED;
908 break;
914 void
915 darwin_nat_target::resume (ptid_t ptid, int step, enum gdb_signal signal)
917 int nsignal;
919 inferior_debug
920 (2, _("darwin_resume: ptid=%s, step=%d, signal=%d\n"),
921 ptid.to_string ().c_str (), step, signal);
923 if (signal == GDB_SIGNAL_0)
924 nsignal = 0;
925 else
926 nsignal = gdb_signal_to_host (signal);
928 /* Don't try to single step all threads. */
929 if (step)
930 ptid = inferior_ptid;
932 /* minus_one_ptid is RESUME_ALL. */
933 if (ptid == minus_one_ptid)
935 /* Resume threads. */
936 for (inferior *inf : all_inferiors ())
937 darwin_resume_inferior_threads (inf, step, nsignal);
939 /* Resume tasks. */
940 for (inferior *inf : all_inferiors ())
941 darwin_resume_inferior (inf);
943 else
945 inferior *inf = find_inferior_ptid (this, ptid);
946 long tid = ptid.tid ();
948 /* Stop the inferior (should be useless). */
949 darwin_suspend_inferior (inf);
951 if (tid == 0)
952 darwin_resume_inferior_threads (inf, step, nsignal);
953 else
955 darwin_thread_t *thread;
957 /* Suspend threads of the task. */
958 darwin_suspend_inferior_threads (inf);
960 /* Resume the selected thread. */
961 thread = darwin_find_thread (inf, tid);
962 gdb_assert (thread);
963 darwin_resume_thread (inf, thread, step, nsignal);
966 /* Resume the task. */
967 darwin_resume_inferior (inf);
971 ptid_t
972 darwin_nat_target::decode_message (mach_msg_header_t *hdr,
973 darwin_thread_t **pthread,
974 inferior **pinf,
975 target_waitstatus *status)
977 darwin_thread_t *thread;
978 struct inferior *inf;
980 /* Exception message. 2401 == 0x961 is exc. */
981 if (hdr->msgh_id == 2401)
983 int res;
985 /* Decode message. */
986 res = decode_exception_message (hdr, &inf, &thread);
988 if (res < 0)
990 /* Should not happen... */
991 warning (_("darwin_wait: ill-formatted message (id=0x%x)\n"),
992 hdr->msgh_id);
993 /* FIXME: send a failure reply? */
994 status->set_ignore ();
995 return minus_one_ptid;
997 if (inf == NULL)
999 status->set_ignore ();
1000 return minus_one_ptid;
1002 *pinf = inf;
1003 *pthread = thread;
1005 darwin_inferior *priv = get_darwin_inferior (inf);
1007 priv->pending_messages++;
1009 thread->msg_state = DARWIN_MESSAGE;
1011 inferior_debug (4, _("darwin_wait: thread=0x%x, got %s\n"),
1012 thread->gdb_port,
1013 unparse_exception_type (thread->event.ex_type));
1015 switch (thread->event.ex_type)
1017 case EXC_BAD_ACCESS:
1018 status->set_stopped (GDB_EXC_BAD_ACCESS);
1019 break;
1020 case EXC_BAD_INSTRUCTION:
1021 status->set_stopped (GDB_EXC_BAD_INSTRUCTION);
1022 break;
1023 case EXC_ARITHMETIC:
1024 status->set_stopped (GDB_EXC_ARITHMETIC);
1025 break;
1026 case EXC_EMULATION:
1027 status->set_stopped (GDB_EXC_EMULATION);
1028 break;
1029 case EXC_SOFTWARE:
1030 if (thread->event.ex_data[0] == EXC_SOFT_SIGNAL)
1032 status->set_stopped
1033 (gdb_signal_from_host (thread->event.ex_data[1]));
1034 inferior_debug (5, _(" (signal %d: %s)\n"),
1035 thread->event.ex_data[1],
1036 gdb_signal_to_name (status->sig ()));
1038 /* If the thread is stopped because it has received a signal
1039 that gdb has just sent, continue. */
1040 if (thread->signaled)
1042 thread->signaled = 0;
1043 darwin_send_reply (inf, thread);
1044 thread->msg_state = DARWIN_RUNNING;
1045 status->set_ignore ();
1048 else
1049 status->set_stopped (GDB_EXC_SOFTWARE);
1050 break;
1051 case EXC_BREAKPOINT:
1052 /* Many internal GDB routines expect breakpoints to be reported
1053 as GDB_SIGNAL_TRAP, and will report GDB_EXC_BREAKPOINT
1054 as a spurious signal. */
1055 status->set_stopped (GDB_SIGNAL_TRAP);
1056 break;
1057 default:
1058 status->set_stopped (GDB_SIGNAL_UNKNOWN);
1059 break;
1062 return ptid_t (inf->pid, 0, thread->gdb_port);
1064 else if (hdr->msgh_id == 0x48)
1066 /* MACH_NOTIFY_DEAD_NAME: notification for exit *or* WIFSTOPPED. */
1067 int res;
1069 res = darwin_decode_notify_message (hdr, &inf);
1071 if (res < 0)
1073 /* Should not happen... */
1074 warning
1075 (_("darwin_wait: ill-formatted message (id=0x%x, res=%d)\n"),
1076 hdr->msgh_id, res);
1079 *pinf = NULL;
1080 *pthread = NULL;
1082 if (res < 0 || inf == NULL)
1084 status->set_ignore ();
1085 return minus_one_ptid;
1088 if (inf != NULL)
1090 darwin_inferior *priv = get_darwin_inferior (inf);
1092 if (!priv->no_ptrace)
1094 pid_t res_pid;
1095 int wstatus;
1097 res_pid = wait4 (inf->pid, &wstatus, 0, NULL);
1098 if (res_pid < 0 || res_pid != inf->pid)
1100 warning (_("wait4: res=%d: %s\n"),
1101 res_pid, safe_strerror (errno));
1102 status->set_ignore ();
1103 return minus_one_ptid;
1105 if (WIFEXITED (wstatus))
1107 status->set_exited (WEXITSTATUS (wstatus));
1108 inferior_debug (4, _("darwin_wait: pid=%d exit, status=0x%x\n"),
1109 res_pid, wstatus);
1111 else if (WIFSTOPPED (wstatus))
1113 /* Ignore stopped state, it will be handled by the next
1114 exception. */
1115 status->set_ignore ();
1116 inferior_debug (4, _("darwin_wait: pid %d received WIFSTOPPED\n"),
1117 res_pid);
1118 return minus_one_ptid;
1120 else if (WIFSIGNALED (wstatus))
1122 status->set_signalled
1123 (gdb_signal_from_host (WTERMSIG (wstatus)));
1124 inferior_debug (4, _("darwin_wait: pid=%d received signal %d\n"),
1125 res_pid, status->sig());
1127 else
1129 status->set_ignore ();
1130 warning (_("Unexpected wait status after MACH_NOTIFY_DEAD_NAME "
1131 "notification: 0x%x"), wstatus);
1132 return minus_one_ptid;
1135 return ptid_t (inf->pid);
1137 else
1139 inferior_debug (4, _("darwin_wait: pid=%d\n"), inf->pid);
1140 status->set_exited (0 /* Don't know. */);
1141 return ptid_t (inf->pid, 0, 0);
1146 /* Unknown message. */
1147 warning (_("darwin: got unknown message, id: 0x%x"), hdr->msgh_id);
1148 status->set_ignore ();
1149 return minus_one_ptid;
1153 darwin_nat_target::cancel_breakpoint (inferior *inf, ptid_t ptid)
1155 /* Arrange for a breakpoint to be hit again later. We will handle
1156 the current event, eventually we will resume this thread, and this
1157 breakpoint will trap again.
1159 If we do not do this, then we run the risk that the user will
1160 delete or disable the breakpoint, but the thread will have already
1161 tripped on it. */
1163 struct regcache *regcache = get_thread_regcache (this, ptid);
1164 struct gdbarch *gdbarch = regcache->arch ();
1165 CORE_ADDR pc;
1167 pc = regcache_read_pc (regcache) - gdbarch_decr_pc_after_break (gdbarch);
1168 if (breakpoint_inserted_here_p (inf->aspace.get (), pc))
1170 inferior_debug (4, "cancel_breakpoint for thread 0x%lx\n",
1171 (unsigned long) ptid.tid ());
1173 /* Back up the PC if necessary. */
1174 if (gdbarch_decr_pc_after_break (gdbarch))
1175 regcache_write_pc (regcache, pc);
1177 return 1;
1179 return 0;
1182 ptid_t
1183 darwin_nat_target::wait_1 (ptid_t ptid, struct target_waitstatus *status)
1185 kern_return_t kret;
1186 union
1188 mach_msg_header_t hdr;
1189 char data[0x100];
1190 } msgin;
1191 mach_msg_header_t *hdr = &msgin.hdr;
1192 ptid_t res;
1193 darwin_thread_t *thread;
1195 inferior_debug
1196 (2, _("darwin_wait: waiting for a message ptid=%s\n"),
1197 ptid.to_string ().c_str ());
1199 /* Handle fake stop events at first. */
1200 if (darwin_inf_fake_stop != NULL)
1202 inferior *inf = darwin_inf_fake_stop;
1203 darwin_inf_fake_stop = NULL;
1205 darwin_inferior *priv = get_darwin_inferior (inf);
1207 status->set_stopped (GDB_SIGNAL_TRAP);
1208 thread = priv->threads[0];
1209 thread->msg_state = DARWIN_STOPPED;
1210 return ptid_t (inf->pid, 0, thread->gdb_port);
1215 /* set_sigint_trap (); */
1217 /* Wait for a message. */
1218 kret = mach_msg (&msgin.hdr, MACH_RCV_MSG | MACH_RCV_INTERRUPT, 0,
1219 sizeof (msgin.data), darwin_port_set, 0, MACH_PORT_NULL);
1221 /* clear_sigint_trap (); */
1223 if (kret == MACH_RCV_INTERRUPTED)
1225 status->set_ignore ();
1226 return minus_one_ptid;
1229 if (kret != MACH_MSG_SUCCESS)
1231 inferior_debug (5, _("mach_msg: ret=0x%x\n"), kret);
1232 status->set_spurious ();
1233 return minus_one_ptid;
1236 /* Debug: display message. */
1237 if (darwin_debug_flag > 10)
1238 darwin_dump_message (hdr, darwin_debug_flag > 11);
1240 inferior *inf;
1241 res = decode_message (hdr, &thread, &inf, status);
1242 if (res == minus_one_ptid)
1243 continue;
1245 /* Early return in case an inferior has exited. */
1246 if (inf == NULL)
1247 return res;
1249 while (status->kind () == TARGET_WAITKIND_IGNORE);
1251 /* Stop all tasks. */
1252 for (inferior *inf : all_inferiors (this))
1254 darwin_suspend_inferior (inf);
1255 check_new_threads (inf);
1258 /* Read pending messages. */
1259 while (1)
1261 struct target_waitstatus status2;
1262 ptid_t ptid2;
1264 kret = mach_msg (&msgin.hdr,
1265 MACH_RCV_MSG | MACH_RCV_TIMEOUT, 0,
1266 sizeof (msgin.data), darwin_port_set, 1, MACH_PORT_NULL);
1268 if (kret == MACH_RCV_TIMED_OUT)
1269 break;
1270 if (kret != MACH_MSG_SUCCESS)
1272 inferior_debug
1273 (5, _("darwin_wait: mach_msg(pending) ret=0x%x\n"), kret);
1274 break;
1277 /* Debug: display message. */
1278 if (darwin_debug_flag > 10)
1279 darwin_dump_message (hdr, darwin_debug_flag > 11);
1281 inferior *inf;
1282 ptid2 = decode_message (hdr, &thread, &inf, &status2);
1284 if (inf != NULL && thread != NULL
1285 && thread->event.ex_type == EXC_BREAKPOINT)
1287 if (thread->single_step
1288 || cancel_breakpoint (inf,
1289 ptid_t (inf->pid, 0, thread->gdb_port)))
1291 gdb_assert (thread->msg_state == DARWIN_MESSAGE);
1292 darwin_send_reply (inf, thread);
1293 thread->msg_state = DARWIN_RUNNING;
1295 else
1296 inferior_debug
1297 (3, _("darwin_wait: thread 0x%x hit a non-gdb breakpoint\n"),
1298 thread->gdb_port);
1300 else
1301 inferior_debug (3, _("darwin_wait: unhandled pending message\n"));
1303 return res;
1306 ptid_t
1307 darwin_nat_target::wait (ptid_t ptid, struct target_waitstatus *status,
1308 target_wait_flags options)
1310 return wait_1 (ptid, status);
1313 void
1314 darwin_nat_target::interrupt ()
1316 struct inferior *inf = current_inferior ();
1317 darwin_inferior *priv = get_darwin_inferior (inf);
1319 /* FIXME: handle in no_ptrace mode. */
1320 gdb_assert (!priv->no_ptrace);
1321 ::kill (inf->pid, SIGINT);
1324 /* Deallocate threads port and vector. */
1326 static void
1327 darwin_deallocate_threads (struct inferior *inf)
1329 darwin_inferior *priv = get_darwin_inferior (inf);
1331 for (darwin_thread_t *t : priv->threads)
1333 kern_return_t kret = mach_port_deallocate (gdb_task, t->gdb_port);
1334 MACH_CHECK_ERROR (kret);
1337 priv->threads.clear ();
1340 void
1341 darwin_nat_target::mourn_inferior ()
1343 struct inferior *inf = current_inferior ();
1344 darwin_inferior *priv = get_darwin_inferior (inf);
1345 kern_return_t kret;
1346 mach_port_t prev;
1348 /* Deallocate threads. */
1349 darwin_deallocate_threads (inf);
1351 /* Remove notify_port from darwin_port_set. */
1352 kret = mach_port_move_member (gdb_task,
1353 priv->notify_port, MACH_PORT_NULL);
1354 MACH_CHECK_ERROR (kret);
1356 /* Remove task port dead_name notification. */
1357 kret = mach_port_request_notification (gdb_task, priv->task,
1358 MACH_NOTIFY_DEAD_NAME, 0,
1359 MACH_PORT_NULL,
1360 MACH_MSG_TYPE_MAKE_SEND_ONCE,
1361 &prev);
1362 /* This can fail if the task is dead. */
1363 inferior_debug (4, "task=0x%x, prev=0x%x, notify_port=0x%x\n",
1364 priv->task, prev, priv->notify_port);
1366 if (kret == KERN_SUCCESS)
1368 kret = mach_port_deallocate (gdb_task, prev);
1369 MACH_CHECK_ERROR (kret);
1372 /* Destroy notify_port. */
1373 kret = mach_port_destroy (gdb_task, priv->notify_port);
1374 MACH_CHECK_ERROR (kret);
1376 /* Deallocate saved exception ports. */
1377 darwin_deallocate_exception_ports (priv);
1379 /* Deallocate task port. */
1380 kret = mach_port_deallocate (gdb_task, priv->task);
1381 MACH_CHECK_ERROR (kret);
1383 inf->priv = NULL;
1385 inf_child_target::mourn_inferior ();
1388 static void
1389 darwin_reply_to_all_pending_messages (struct inferior *inf)
1391 darwin_inferior *priv = get_darwin_inferior (inf);
1393 for (darwin_thread_t *t : priv->threads)
1395 if (t->msg_state == DARWIN_MESSAGE)
1396 darwin_resume_thread (inf, t, 0, 0);
1400 void
1401 darwin_nat_target::stop_inferior (inferior *inf)
1403 struct target_waitstatus wstatus;
1404 ptid_t ptid;
1405 int res;
1406 darwin_inferior *priv = get_darwin_inferior (inf);
1408 gdb_assert (inf != NULL);
1410 darwin_suspend_inferior (inf);
1412 darwin_reply_to_all_pending_messages (inf);
1414 if (priv->no_ptrace)
1415 return;
1417 res = ::kill (inf->pid, SIGSTOP);
1418 if (res != 0)
1419 warning (_("cannot kill: %s"), safe_strerror (errno));
1421 /* Wait until the process is really stopped. */
1422 while (1)
1424 ptid = wait_1 (ptid_t (inf->pid), &wstatus);
1425 if (wstatus.kind () == TARGET_WAITKIND_STOPPED
1426 && wstatus.sig () == GDB_SIGNAL_STOP)
1427 break;
1431 static kern_return_t
1432 darwin_save_exception_ports (darwin_inferior *inf)
1434 kern_return_t kret;
1436 inf->exception_info.count =
1437 sizeof (inf->exception_info.ports) / sizeof (inf->exception_info.ports[0]);
1439 kret = task_get_exception_ports
1440 (inf->task, EXC_MASK_ALL, inf->exception_info.masks,
1441 &inf->exception_info.count, inf->exception_info.ports,
1442 inf->exception_info.behaviors, inf->exception_info.flavors);
1443 return kret;
1446 static kern_return_t
1447 darwin_restore_exception_ports (darwin_inferior *inf)
1449 int i;
1450 kern_return_t kret;
1452 for (i = 0; i < inf->exception_info.count; i++)
1454 kret = task_set_exception_ports
1455 (inf->task, inf->exception_info.masks[i], inf->exception_info.ports[i],
1456 inf->exception_info.behaviors[i], inf->exception_info.flavors[i]);
1457 if (kret != KERN_SUCCESS)
1458 return kret;
1461 return KERN_SUCCESS;
1464 /* Deallocate saved exception ports. */
1466 static void
1467 darwin_deallocate_exception_ports (darwin_inferior *inf)
1469 int i;
1470 kern_return_t kret;
1472 for (i = 0; i < inf->exception_info.count; i++)
1474 kret = mach_port_deallocate (gdb_task, inf->exception_info.ports[i]);
1475 MACH_CHECK_ERROR (kret);
1477 inf->exception_info.count = 0;
1480 static void
1481 darwin_setup_exceptions (struct inferior *inf)
1483 darwin_inferior *priv = get_darwin_inferior (inf);
1484 kern_return_t kret;
1485 exception_mask_t mask;
1487 kret = darwin_save_exception_ports (priv);
1488 if (kret != KERN_SUCCESS)
1489 error (_("Unable to save exception ports, task_get_exception_ports"
1490 "returned: %d"),
1491 kret);
1493 /* Set exception port. */
1494 if (enable_mach_exceptions)
1495 mask = EXC_MASK_ALL;
1496 else
1497 mask = EXC_MASK_SOFTWARE | EXC_MASK_BREAKPOINT;
1498 kret = task_set_exception_ports (priv->task, mask, darwin_ex_port,
1499 EXCEPTION_DEFAULT, THREAD_STATE_NONE);
1500 if (kret != KERN_SUCCESS)
1501 error (_("Unable to set exception ports, task_set_exception_ports"
1502 "returned: %d"),
1503 kret);
1506 void
1507 darwin_nat_target::kill ()
1509 struct inferior *inf = current_inferior ();
1510 darwin_inferior *priv = get_darwin_inferior (inf);
1511 struct target_waitstatus wstatus;
1512 ptid_t ptid;
1513 kern_return_t kret;
1514 int res;
1516 if (inferior_ptid == null_ptid)
1517 return;
1519 gdb_assert (inf != NULL);
1521 kret = darwin_restore_exception_ports (priv);
1522 MACH_CHECK_ERROR (kret);
1524 darwin_reply_to_all_pending_messages (inf);
1526 res = ::kill (inf->pid, 9);
1528 if (res == 0)
1530 /* On MacOS version Sierra, the darwin_restore_exception_ports call
1531 does not work as expected.
1532 When the kill function is called, the SIGKILL signal is received
1533 by gdb whereas it should have been received by the kernel since
1534 the exception ports have been restored.
1535 This behavior is not the expected one thus gdb does not reply to
1536 the received SIGKILL message. This situation leads to a "busy"
1537 resource from the kernel point of view and the inferior is never
1538 released, causing it to remain as a zombie process, even after
1539 GDB exits.
1540 To work around this, we mark all the threads of the inferior as
1541 signaled thus darwin_decode_message function knows that the kill
1542 signal was sent by gdb and will take the appropriate action
1543 (cancel signal and reply to the signal message). */
1544 for (darwin_thread_t *thread : priv->threads)
1545 thread->signaled = 1;
1547 darwin_resume_inferior (inf);
1549 ptid = wait_1 (ptid_t (inf->pid), &wstatus);
1551 else if (errno != ESRCH)
1552 warning (_("Failed to kill inferior: kill (%d, 9) returned [%s]"),
1553 inf->pid, safe_strerror (errno));
1555 target_mourn_inferior (ptid_t (inf->pid));
1558 static void
1559 darwin_setup_request_notification (struct inferior *inf)
1561 darwin_inferior *priv = get_darwin_inferior (inf);
1562 kern_return_t kret;
1563 mach_port_t prev_not;
1565 kret = mach_port_request_notification (gdb_task, priv->task,
1566 MACH_NOTIFY_DEAD_NAME, 0,
1567 priv->notify_port,
1568 MACH_MSG_TYPE_MAKE_SEND_ONCE,
1569 &prev_not);
1570 if (kret != KERN_SUCCESS)
1571 error (_("Termination notification request failed, "
1572 "mach_port_request_notification\n"
1573 "returned: %d"),
1574 kret);
1575 if (prev_not != MACH_PORT_NULL)
1577 /* This is unexpected, as there should not be any previously
1578 registered notification request. But this is not a fatal
1579 issue, so just emit a warning. */
1580 warning (_("\
1581 A task termination request was registered before the debugger registered\n\
1582 its own. This is unexpected, but should otherwise not have any actual\n\
1583 impact on the debugging session."));
1587 static void
1588 darwin_attach_pid (struct inferior *inf)
1590 kern_return_t kret;
1592 darwin_inferior *priv = new darwin_inferior;
1593 inf->priv.reset (priv);
1597 kret = task_for_pid (gdb_task, inf->pid, &priv->task);
1598 if (kret != KERN_SUCCESS)
1600 int status;
1602 if (!inf->attach_flag)
1604 kill (inf->pid, 9);
1605 waitpid (inf->pid, &status, 0);
1608 error
1609 (_("Unable to find Mach task port for process-id %d: %s (0x%lx).\n"
1610 " (please check gdb is codesigned - see taskgated(8))"),
1611 inf->pid, mach_error_string (kret), (unsigned long) kret);
1614 inferior_debug (2, _("inferior task: 0x%x, pid: %d\n"),
1615 priv->task, inf->pid);
1617 if (darwin_ex_port == MACH_PORT_NULL)
1619 /* Create a port to get exceptions. */
1620 kret = mach_port_allocate (gdb_task, MACH_PORT_RIGHT_RECEIVE,
1621 &darwin_ex_port);
1622 if (kret != KERN_SUCCESS)
1623 error (_("Unable to create exception port, mach_port_allocate "
1624 "returned: %d"),
1625 kret);
1627 kret = mach_port_insert_right (gdb_task, darwin_ex_port,
1628 darwin_ex_port,
1629 MACH_MSG_TYPE_MAKE_SEND);
1630 if (kret != KERN_SUCCESS)
1631 error (_("Unable to create exception port, mach_port_insert_right "
1632 "returned: %d"),
1633 kret);
1635 /* Create a port set and put ex_port in it. */
1636 kret = mach_port_allocate (gdb_task, MACH_PORT_RIGHT_PORT_SET,
1637 &darwin_port_set);
1638 if (kret != KERN_SUCCESS)
1639 error (_("Unable to create port set, mach_port_allocate "
1640 "returned: %d"),
1641 kret);
1643 kret = mach_port_move_member (gdb_task, darwin_ex_port,
1644 darwin_port_set);
1645 if (kret != KERN_SUCCESS)
1646 error (_("Unable to move exception port into new port set, "
1647 "mach_port_move_member\n"
1648 "returned: %d"),
1649 kret);
1652 /* Create a port to be notified when the child task terminates. */
1653 kret = mach_port_allocate (gdb_task, MACH_PORT_RIGHT_RECEIVE,
1654 &priv->notify_port);
1655 if (kret != KERN_SUCCESS)
1656 error (_("Unable to create notification port, mach_port_allocate "
1657 "returned: %d"),
1658 kret);
1660 kret = mach_port_move_member (gdb_task,
1661 priv->notify_port, darwin_port_set);
1662 if (kret != KERN_SUCCESS)
1663 error (_("Unable to move notification port into new port set, "
1664 "mach_port_move_member\n"
1665 "returned: %d"),
1666 kret);
1668 darwin_setup_request_notification (inf);
1670 darwin_setup_exceptions (inf);
1672 catch (const gdb_exception &ex)
1674 exit_inferior (inf);
1675 switch_to_no_thread ();
1677 throw;
1680 target_ops *darwin_ops = get_native_target ();
1681 if (!inf->target_is_pushed (darwin_ops))
1682 inf->push_target (darwin_ops);
1685 /* Get the thread_info object corresponding to this darwin_thread_info. */
1687 static struct thread_info *
1688 thread_info_from_private_thread_info (darwin_thread_info *pti)
1690 for (struct thread_info *it : all_threads ())
1692 darwin_thread_info *iter_pti = get_darwin_thread_info (it);
1694 if (iter_pti->gdb_port == pti->gdb_port)
1695 return it;
1698 gdb_assert_not_reached ("did not find gdb thread for darwin thread");
1701 void
1702 darwin_nat_target::init_thread_list (inferior *inf)
1704 check_new_threads (inf);
1706 darwin_inferior *priv = get_darwin_inferior (inf);
1708 gdb_assert (!priv->threads.empty ());
1710 darwin_thread_info *first_pti = priv->threads.front ();
1711 struct thread_info *first_thread
1712 = thread_info_from_private_thread_info (first_pti);
1714 switch_to_thread (first_thread);
1717 /* The child must synchronize with gdb: gdb must set the exception port
1718 before the child call PTRACE_SIGEXC. We use a pipe to achieve this.
1719 FIXME: is there a lighter way ? */
1720 static int ptrace_fds[2];
1722 static void
1723 darwin_ptrace_me (void)
1725 int res;
1726 char c;
1728 /* Close write end point. */
1729 if (close (ptrace_fds[1]) < 0)
1730 trace_start_error_with_name ("close");
1732 /* Wait until gdb is ready. */
1733 res = read (ptrace_fds[0], &c, 1);
1734 if (res != 0)
1735 trace_start_error (_("unable to read from pipe, read returned: %d"), res);
1737 if (close (ptrace_fds[0]) < 0)
1738 trace_start_error_with_name ("close");
1740 /* Get rid of privileges. */
1741 if (setegid (getgid ()) < 0)
1742 trace_start_error_with_name ("setegid");
1744 /* Set TRACEME. */
1745 if (PTRACE (PT_TRACE_ME, 0, 0, 0) < 0)
1746 trace_start_error_with_name ("PTRACE");
1748 /* Redirect signals to exception port. */
1749 if (PTRACE (PT_SIGEXC, 0, 0, 0) < 0)
1750 trace_start_error_with_name ("PTRACE");
1753 /* Dummy function to be sure fork_inferior uses fork(2) and not vfork(2). */
1754 static void
1755 darwin_pre_ptrace (void)
1757 if (pipe (ptrace_fds) != 0)
1759 ptrace_fds[0] = -1;
1760 ptrace_fds[1] = -1;
1761 error (_("unable to create a pipe: %s"), safe_strerror (errno));
1764 mark_fd_no_cloexec (ptrace_fds[0]);
1765 mark_fd_no_cloexec (ptrace_fds[1]);
1768 void
1769 darwin_nat_target::ptrace_him (int pid)
1771 struct inferior *inf = current_inferior ();
1773 darwin_attach_pid (inf);
1775 /* Let's the child run. */
1776 ::close (ptrace_fds[0]);
1777 ::close (ptrace_fds[1]);
1779 unmark_fd_no_cloexec (ptrace_fds[0]);
1780 unmark_fd_no_cloexec (ptrace_fds[1]);
1782 init_thread_list (inf);
1784 gdb_startup_inferior (pid, START_INFERIOR_TRAPS_EXPECTED);
1787 static void
1788 darwin_execvp (const char *file, char * const argv[], char * const env[])
1790 posix_spawnattr_t attr;
1791 short ps_flags = 0;
1792 int res;
1794 res = posix_spawnattr_init (&attr);
1795 if (res != 0)
1797 gdb_printf
1798 (gdb_stderr, "Cannot initialize attribute for posix_spawn\n");
1799 return;
1802 /* Do like execve: replace the image. */
1803 ps_flags = POSIX_SPAWN_SETEXEC;
1805 /* Disable ASLR. The constant doesn't look to be available outside the
1806 kernel include files. */
1807 #ifndef _POSIX_SPAWN_DISABLE_ASLR
1808 #define _POSIX_SPAWN_DISABLE_ASLR 0x0100
1809 #endif
1810 ps_flags |= _POSIX_SPAWN_DISABLE_ASLR;
1811 res = posix_spawnattr_setflags (&attr, ps_flags);
1812 if (res != 0)
1814 gdb_printf (gdb_stderr, "Cannot set posix_spawn flags\n");
1815 return;
1818 posix_spawnp (NULL, argv[0], NULL, &attr, argv, env);
1821 /* Read kernel version, and return TRUE if this host may have System
1822 Integrity Protection (Sierra or later). */
1824 static bool
1825 may_have_sip ()
1827 char str[16];
1828 size_t sz = sizeof (str);
1829 int ret;
1831 ret = sysctlbyname ("kern.osrelease", str, &sz, NULL, 0);
1832 if (ret == 0 && sz < sizeof (str))
1834 unsigned long ver = strtoul (str, NULL, 10);
1835 if (ver >= 16)
1836 return true;
1838 return false;
1841 /* A helper for maybe_cache_shell. This copies the shell to the
1842 cache. It will throw an exception on any failure. */
1844 static void
1845 copy_shell_to_cache (const char *shell, const std::string &new_name)
1847 scoped_fd from_fd = gdb_open_cloexec (shell, O_RDONLY, 0);
1848 if (from_fd.get () < 0)
1849 error (_("Could not open shell (%s) for reading: %s"),
1850 shell, safe_strerror (errno));
1852 std::string new_dir = ldirname (new_name.c_str ());
1853 if (!mkdir_recursive (new_dir.c_str ()))
1854 error (_("Could not make cache directory \"%s\": %s"),
1855 new_dir.c_str (), safe_strerror (errno));
1857 gdb::char_vector temp_name = make_temp_filename (new_name);
1858 scoped_fd to_fd = gdb_mkostemp_cloexec (&temp_name[0]);
1859 gdb::unlinker unlink_file_on_error (temp_name.data ());
1861 if (to_fd.get () < 0)
1862 error (_("Could not open temporary file \"%s\" for writing: %s"),
1863 temp_name.data (), safe_strerror (errno));
1865 if (fcopyfile (from_fd.get (), to_fd.get (), nullptr,
1866 COPYFILE_STAT | COPYFILE_DATA) != 0)
1867 error (_("Could not copy shell to cache as \"%s\": %s"),
1868 temp_name.data (), safe_strerror (errno));
1870 /* Be sure that the caching is atomic so that we don't get bad
1871 results from multiple copies of gdb running at the same time. */
1872 if (rename (temp_name.data (), new_name.c_str ()) != 0)
1873 error (_("Could not rename shell cache file to \"%s\": %s"),
1874 new_name.c_str (), safe_strerror (errno));
1876 unlink_file_on_error.keep ();
1879 /* If $SHELL is restricted, try to cache a copy. Starting with El
1880 Capitan, macOS introduced System Integrity Protection. Among other
1881 things, this prevents certain executables from being ptrace'd. In
1882 particular, executables in /bin, like most shells, are affected.
1883 To work around this, while preserving command-line glob expansion
1884 and redirections, gdb will cache a copy of the shell. Return true
1885 if all is well -- either the shell is not subject to SIP or it has
1886 been successfully cached. Returns false if something failed. */
1888 static bool
1889 maybe_cache_shell ()
1891 /* SF_RESTRICTED is defined in sys/stat.h and lets us determine if a
1892 given file is subject to SIP. */
1893 #ifdef SF_RESTRICTED
1895 /* If a check fails we want to revert -- maybe the user deleted the
1896 cache while gdb was running, or something like that. */
1897 copied_shell = nullptr;
1899 const char *shell = get_shell ();
1900 if (!IS_ABSOLUTE_PATH (shell))
1902 warning (_("This version of macOS has System Integrity Protection.\n\
1903 Normally gdb would try to work around this by caching a copy of your shell,\n\
1904 but because your shell (%s) is not an absolute path, this is being skipped."),
1905 shell);
1906 return false;
1909 struct stat sb;
1910 if (stat (shell, &sb) < 0)
1912 warning (_("This version of macOS has System Integrity Protection.\n\
1913 Normally gdb would try to work around this by caching a copy of your shell,\n\
1914 but because gdb could not stat your shell (%s), this is being skipped.\n\
1915 The error was: %s"),
1916 shell, safe_strerror (errno));
1917 return false;
1920 if ((sb.st_flags & SF_RESTRICTED) == 0)
1921 return true;
1923 /* Put the copy somewhere like ~/Library/Caches/gdb/bin/sh. */
1924 std::string new_name = get_standard_cache_dir ();
1925 /* There's no need to insert a directory separator here, because
1926 SHELL is known to be absolute. */
1927 new_name.append (shell);
1929 /* Maybe it was cached by some earlier gdb. */
1930 if (stat (new_name.c_str (), &sb) != 0 || !S_ISREG (sb.st_mode))
1934 copy_shell_to_cache (shell, new_name);
1936 catch (const gdb_exception_error &ex)
1938 warning (_("This version of macOS has System Integrity Protection.\n\
1939 Because `startup-with-shell' is enabled, gdb tried to work around SIP by\n\
1940 caching a copy of your shell. However, this failed:\n\
1941 %s\n\
1942 If you correct the problem, gdb will automatically try again the next time\n\
1943 you \"run\". To prevent these attempts, you can use:\n\
1944 set startup-with-shell off"),
1945 ex.what ());
1946 return false;
1949 gdb_printf (_("Note: this version of macOS has System Integrity Protection.\n\
1950 Because `startup-with-shell' is enabled, gdb has worked around this by\n\
1951 caching a copy of your shell. The shell used by \"run\" is now:\n\
1952 %s\n"),
1953 new_name.c_str ());
1956 /* We need to make sure that the new name has the correct lifetime. */
1957 static std::string saved_shell = std::move (new_name);
1958 copied_shell = saved_shell.c_str ();
1960 #endif /* SF_RESTRICTED */
1962 return true;
1965 void
1966 darwin_nat_target::create_inferior (const char *exec_file,
1967 const std::string &allargs,
1968 char **env, int from_tty)
1970 std::optional<scoped_restore_tmpl<bool>> restore_startup_with_shell;
1971 darwin_nat_target *the_target = this;
1973 if (startup_with_shell && may_have_sip ())
1975 if (!maybe_cache_shell ())
1977 warning (_("startup-with-shell is now temporarily disabled"));
1978 restore_startup_with_shell.emplace (&startup_with_shell, 0);
1982 /* Do the hard work. */
1983 fork_inferior (exec_file, allargs, env, darwin_ptrace_me,
1984 [the_target] (int pid)
1986 the_target->ptrace_him (pid);
1988 darwin_pre_ptrace, copied_shell,
1989 darwin_execvp);
1993 /* Set things up such that the next call to darwin_wait will immediately
1994 return a fake stop event for inferior INF.
1996 This assumes that the inferior's thread list has been initialized,
1997 as it will suspend the inferior's first thread. */
1999 static void
2000 darwin_setup_fake_stop_event (struct inferior *inf)
2002 darwin_inferior *priv = get_darwin_inferior (inf);
2003 darwin_thread_t *thread;
2004 kern_return_t kret;
2006 gdb_assert (darwin_inf_fake_stop == NULL);
2007 darwin_inf_fake_stop = inf;
2009 /* When detecting a fake pending stop event, darwin_wait returns
2010 an event saying that the first thread is in a DARWIN_STOPPED
2011 state. To make that accurate, we need to suspend that thread
2012 as well. Otherwise, we'll try resuming it when resuming the
2013 inferior, and get a warning because the thread's suspend count
2014 is already zero, making the resume request useless. */
2015 thread = priv->threads[0];
2016 kret = thread_suspend (thread->gdb_port);
2017 MACH_CHECK_ERROR (kret);
2020 /* Attach to process PID, then initialize for debugging it
2021 and wait for the trace-trap that results from attaching. */
2022 void
2023 darwin_nat_target::attach (const char *args, int from_tty)
2025 pid_t pid;
2026 struct inferior *inf;
2028 pid = parse_pid_to_attach (args);
2030 if (pid == getpid ()) /* Trying to masturbate? */
2031 error (_("I refuse to debug myself!"));
2033 target_announce_attach (from_tty, pid);
2035 if (pid == 0 || ::kill (pid, 0) < 0)
2036 error (_("Can't attach to process %d: %s (%d)"),
2037 pid, safe_strerror (errno), errno);
2039 inf = current_inferior ();
2040 inferior_appeared (inf, pid);
2041 inf->attach_flag = true;
2043 darwin_attach_pid (inf);
2045 darwin_suspend_inferior (inf);
2047 init_thread_list (inf);
2049 darwin_inferior *priv = get_darwin_inferior (inf);
2051 darwin_check_osabi (priv, inferior_ptid.tid ());
2053 darwin_setup_fake_stop_event (inf);
2055 priv->no_ptrace = 1;
2058 /* Take a program previously attached to and detaches it.
2059 The program resumes execution and will no longer stop
2060 on signals, etc. We'd better not have left any breakpoints
2061 in the program or it'll die when it hits one. For this
2062 to work, it may be necessary for the process to have been
2063 previously attached. It *might* work if the program was
2064 started via fork. */
2066 void
2067 darwin_nat_target::detach (inferior *inf, int from_tty)
2069 darwin_inferior *priv = get_darwin_inferior (inf);
2070 kern_return_t kret;
2071 int res;
2073 /* Display message. */
2074 target_announce_detach (from_tty);
2076 /* If ptrace() is in use, stop the process. */
2077 if (!priv->no_ptrace)
2078 stop_inferior (inf);
2080 kret = darwin_restore_exception_ports (priv);
2081 MACH_CHECK_ERROR (kret);
2083 if (!priv->no_ptrace)
2085 res = PTRACE (PT_DETACH, inf->pid, 0, 0);
2086 if (res != 0)
2087 warning (_("Unable to detach from process-id %d: %s (%d)"),
2088 inf->pid, safe_strerror (errno), errno);
2091 darwin_reply_to_all_pending_messages (inf);
2093 /* When using ptrace, we have just performed a PT_DETACH, which
2094 resumes the inferior. On the other hand, when we are not using
2095 ptrace, we need to resume its execution ourselves. */
2096 if (priv->no_ptrace)
2097 darwin_resume_inferior (inf);
2099 mourn_inferior ();
2102 std::string
2103 darwin_nat_target::pid_to_str (ptid_t ptid)
2105 long tid = ptid.tid ();
2107 if (tid != 0)
2108 return string_printf (_("Thread 0x%lx of process %u"),
2109 tid, ptid.pid ());
2111 return normal_pid_to_str (ptid);
2114 bool
2115 darwin_nat_target::thread_alive (ptid_t ptid)
2117 return true;
2120 /* If RDADDR is not NULL, read inferior task's LEN bytes from ADDR and
2121 copy it to RDADDR in gdb's address space.
2122 If WRADDR is not NULL, write gdb's LEN bytes from WRADDR and copy it
2123 to ADDR in inferior task's address space.
2124 Return 0 on failure; number of bytes read / written otherwise. */
2126 static int
2127 darwin_read_write_inferior (task_t task, CORE_ADDR addr,
2128 gdb_byte *rdaddr, const gdb_byte *wraddr,
2129 ULONGEST length)
2131 kern_return_t kret;
2132 mach_vm_size_t res_length = 0;
2134 inferior_debug (8, _("darwin_read_write_inferior(task=0x%x, %s, len=%s)\n"),
2135 task, core_addr_to_string (addr), pulongest (length));
2137 /* First read. */
2138 if (rdaddr != NULL)
2140 mach_vm_size_t count;
2142 /* According to target.h(to_xfer_partial), one and only one may be
2143 non-null. */
2144 gdb_assert (wraddr == NULL);
2146 kret = mach_vm_read_overwrite (task, addr, length,
2147 (mach_vm_address_t) rdaddr, &count);
2148 if (kret != KERN_SUCCESS)
2150 inferior_debug
2151 (1, _("darwin_read_write_inferior: mach_vm_read failed at %s: %s"),
2152 core_addr_to_string (addr), mach_error_string (kret));
2153 return 0;
2155 return count;
2158 /* See above. */
2159 gdb_assert (wraddr != NULL);
2161 while (length != 0)
2163 mach_vm_address_t offset = addr & (mach_page_size - 1);
2164 mach_vm_address_t region_address = (mach_vm_address_t) (addr - offset);
2165 mach_vm_size_t aligned_length =
2166 (mach_vm_size_t) PAGE_ROUND (offset + length);
2167 vm_region_submap_short_info_data_64_t info;
2168 mach_msg_type_number_t count = VM_REGION_SUBMAP_SHORT_INFO_COUNT_64;
2169 natural_t region_depth = 1000;
2170 mach_vm_address_t region_start = region_address;
2171 mach_vm_size_t region_length;
2172 mach_vm_size_t write_length;
2174 /* Read page protection. */
2175 kret = mach_vm_region_recurse
2176 (task, &region_start, &region_length, &region_depth,
2177 (vm_region_recurse_info_t) &info, &count);
2179 if (kret != KERN_SUCCESS)
2181 inferior_debug (1, _("darwin_read_write_inferior: "
2182 "mach_vm_region_recurse failed at %s: %s\n"),
2183 core_addr_to_string (region_address),
2184 mach_error_string (kret));
2185 return res_length;
2188 inferior_debug
2189 (9, _("darwin_read_write_inferior: "
2190 "mach_vm_region_recurse addr=%s, start=%s, len=%s\n"),
2191 core_addr_to_string (region_address),
2192 core_addr_to_string (region_start),
2193 core_addr_to_string (region_length));
2195 /* Check for holes in memory. */
2196 if (region_start > region_address)
2198 warning (_("No memory at %s (vs %s+0x%x). Nothing written"),
2199 core_addr_to_string (region_address),
2200 core_addr_to_string (region_start),
2201 (unsigned)region_length);
2202 return res_length;
2205 /* Adjust the length. */
2206 region_length -= (region_address - region_start);
2207 if (region_length > aligned_length)
2208 region_length = aligned_length;
2210 /* Make the pages RW. */
2211 if (!(info.protection & VM_PROT_WRITE))
2213 vm_prot_t prot = VM_PROT_READ | VM_PROT_WRITE;
2215 kret = mach_vm_protect (task, region_address, region_length,
2216 FALSE, prot);
2217 if (kret != KERN_SUCCESS)
2219 prot |= VM_PROT_COPY;
2220 kret = mach_vm_protect (task, region_address, region_length,
2221 FALSE, prot);
2223 if (kret != KERN_SUCCESS)
2225 warning (_("darwin_read_write_inferior: "
2226 "mach_vm_protect failed at %s "
2227 "(len=0x%lx, prot=0x%x): %s"),
2228 core_addr_to_string (region_address),
2229 (unsigned long) region_length, (unsigned) prot,
2230 mach_error_string (kret));
2231 return res_length;
2235 if (offset + length > region_length)
2236 write_length = region_length - offset;
2237 else
2238 write_length = length;
2240 /* Write. */
2241 kret = mach_vm_write (task, addr, (vm_offset_t) wraddr, write_length);
2242 if (kret != KERN_SUCCESS)
2244 warning (_("darwin_read_write_inferior: mach_vm_write failed: %s"),
2245 mach_error_string (kret));
2246 return res_length;
2249 /* Restore page rights. */
2250 if (!(info.protection & VM_PROT_WRITE))
2252 kret = mach_vm_protect (task, region_address, region_length,
2253 FALSE, info.protection);
2254 if (kret != KERN_SUCCESS)
2256 warning (_("darwin_read_write_inferior: "
2257 "mach_vm_protect restore failed at %s "
2258 "(len=0x%lx): %s"),
2259 core_addr_to_string (region_address),
2260 (unsigned long) region_length,
2261 mach_error_string (kret));
2265 addr += write_length;
2266 wraddr += write_length;
2267 res_length += write_length;
2268 length -= write_length;
2271 return res_length;
2274 /* Read LENGTH bytes at offset ADDR of task_dyld_info for TASK, and copy them
2275 to RDADDR (in big endian).
2276 Return 0 on failure; number of bytes read / written otherwise. */
2278 #ifdef TASK_DYLD_INFO_COUNT
2279 /* This is not available in Darwin 9. */
2280 static enum target_xfer_status
2281 darwin_read_dyld_info (task_t task, CORE_ADDR addr, gdb_byte *rdaddr,
2282 ULONGEST length, ULONGEST *xfered_len)
2284 struct task_dyld_info task_dyld_info;
2285 mach_msg_type_number_t count = TASK_DYLD_INFO_COUNT;
2286 kern_return_t kret;
2288 if (addr != 0 || length > sizeof (mach_vm_address_t))
2289 return TARGET_XFER_EOF;
2291 kret = task_info (task, TASK_DYLD_INFO,
2292 (task_info_t) &task_dyld_info, &count);
2293 MACH_CHECK_ERROR (kret);
2294 if (kret != KERN_SUCCESS)
2295 return TARGET_XFER_E_IO;
2297 store_unsigned_integer (rdaddr, length, BFD_ENDIAN_BIG,
2298 task_dyld_info.all_image_info_addr);
2299 *xfered_len = (ULONGEST) length;
2300 return TARGET_XFER_OK;
2302 #endif
2306 enum target_xfer_status
2307 darwin_nat_target::xfer_partial (enum target_object object, const char *annex,
2308 gdb_byte *readbuf, const gdb_byte *writebuf,
2309 ULONGEST offset, ULONGEST len,
2310 ULONGEST *xfered_len)
2312 struct inferior *inf = current_inferior ();
2313 darwin_inferior *priv = get_darwin_inferior (inf);
2315 inferior_debug
2316 (8, _("darwin_xfer_partial(%s, %s, rbuf=%s, wbuf=%s) pid=%u\n"),
2317 core_addr_to_string (offset), pulongest (len),
2318 host_address_to_string (readbuf), host_address_to_string (writebuf),
2319 inf->pid);
2321 switch (object)
2323 case TARGET_OBJECT_MEMORY:
2325 int l = darwin_read_write_inferior (priv->task, offset,
2326 readbuf, writebuf, len);
2328 if (l == 0)
2329 return TARGET_XFER_EOF;
2330 else
2332 gdb_assert (l > 0);
2333 *xfered_len = (ULONGEST) l;
2334 return TARGET_XFER_OK;
2337 #ifdef TASK_DYLD_INFO_COUNT
2338 case TARGET_OBJECT_DARWIN_DYLD_INFO:
2339 if (writebuf != NULL || readbuf == NULL)
2341 /* Support only read. */
2342 return TARGET_XFER_E_IO;
2344 return darwin_read_dyld_info (priv->task, offset, readbuf, len,
2345 xfered_len);
2346 #endif
2347 default:
2348 return TARGET_XFER_E_IO;
2353 static void
2354 set_enable_mach_exceptions (const char *args, int from_tty,
2355 struct cmd_list_element *c)
2357 if (inferior_ptid != null_ptid)
2359 struct inferior *inf = current_inferior ();
2360 darwin_inferior *priv = get_darwin_inferior (inf);
2361 exception_mask_t mask;
2362 kern_return_t kret;
2364 if (enable_mach_exceptions)
2365 mask = EXC_MASK_ALL;
2366 else
2368 darwin_restore_exception_ports (priv);
2369 mask = EXC_MASK_SOFTWARE | EXC_MASK_BREAKPOINT;
2371 kret = task_set_exception_ports (priv->task, mask, darwin_ex_port,
2372 EXCEPTION_DEFAULT, THREAD_STATE_NONE);
2373 MACH_CHECK_ERROR (kret);
2377 const char *
2378 darwin_nat_target::pid_to_exec_file (int pid)
2380 static char path[PATH_MAX];
2381 int res;
2383 res = proc_pidinfo (pid, PROC_PIDPATHINFO, 0, path, PATH_MAX);
2384 if (res >= 0)
2385 return path;
2386 else
2387 return NULL;
2390 ptid_t
2391 darwin_nat_target::get_ada_task_ptid (long lwp, ULONGEST thread)
2393 struct inferior *inf = current_inferior ();
2394 darwin_inferior *priv = get_darwin_inferior (inf);
2395 kern_return_t kret;
2396 mach_port_name_array_t names;
2397 mach_msg_type_number_t names_count;
2398 mach_port_type_array_t types;
2399 mach_msg_type_number_t types_count;
2400 long res = 0;
2402 /* First linear search. */
2403 for (darwin_thread_t *t : priv->threads)
2405 if (t->inf_port == lwp)
2406 return ptid_t (inferior_ptid.pid (), 0, t->gdb_port);
2409 /* Maybe the port was never extract. Do it now. */
2411 /* First get inferior port names. */
2412 kret = mach_port_names (priv->task, &names, &names_count, &types,
2413 &types_count);
2414 MACH_CHECK_ERROR (kret);
2415 if (kret != KERN_SUCCESS)
2416 return null_ptid;
2418 /* For each name, copy the right in the gdb space and then compare with
2419 our view of the inferior threads. We don't forget to deallocate the
2420 right. */
2421 for (int i = 0; i < names_count; i++)
2423 mach_port_t local_name;
2424 mach_msg_type_name_t local_type;
2426 /* We just need to know the corresponding name in gdb name space.
2427 So extract and deallocate the right. */
2428 kret = mach_port_extract_right (priv->task, names[i],
2429 MACH_MSG_TYPE_COPY_SEND,
2430 &local_name, &local_type);
2431 if (kret != KERN_SUCCESS)
2432 continue;
2433 mach_port_deallocate (gdb_task, local_name);
2435 for (darwin_thread_t *t : priv->threads)
2437 if (t->gdb_port == local_name)
2439 t->inf_port = names[i];
2440 if (names[i] == lwp)
2441 res = t->gdb_port;
2446 vm_deallocate (gdb_task, (vm_address_t) names,
2447 names_count * sizeof (mach_port_t));
2449 if (res)
2450 return ptid_t (current_inferior ()->pid, 0, res);
2451 else
2452 return null_ptid;
2455 bool
2456 darwin_nat_target::supports_multi_process ()
2458 return true;
2461 void _initialize_darwin_nat ();
2462 void
2463 _initialize_darwin_nat ()
2465 kern_return_t kret;
2467 gdb_task = mach_task_self ();
2468 darwin_host_self = mach_host_self ();
2470 /* Read page size. */
2471 kret = host_page_size (darwin_host_self, &mach_page_size);
2472 if (kret != KERN_SUCCESS)
2474 mach_page_size = 0x1000;
2475 MACH_CHECK_ERROR (kret);
2478 inferior_debug (2, _("GDB task: 0x%lx, pid: %d\n"),
2479 (unsigned long) mach_task_self (), getpid ());
2481 add_setshow_zuinteger_cmd ("darwin", class_obscure,
2482 &darwin_debug_flag, _("\
2483 Set if printing inferior communication debugging statements."), _("\
2484 Show if printing inferior communication debugging statements."), NULL,
2485 NULL, NULL,
2486 &setdebuglist, &showdebuglist);
2488 add_setshow_boolean_cmd ("mach-exceptions", class_support,
2489 &enable_mach_exceptions, _("\
2490 Set if mach exceptions are caught."), _("\
2491 Show if mach exceptions are caught."), _("\
2492 When this mode is on, all low level exceptions are reported before being\n\
2493 reported by the kernel."),
2494 &set_enable_mach_exceptions, NULL,
2495 &setlist, &showlist);