Bump GDB's version number to 15.0.91.DATE-git.
[binutils-gdb.git] / gdb / darwin-nat.c
blobc70cd44bb7fb5a131b4b84256dc5efdfc2d1c421
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 "extract-store-integer.h"
22 #include "top.h"
23 #include "inferior.h"
24 #include "target.h"
25 #include "symfile.h"
26 #include "symtab.h"
27 #include "objfiles.h"
28 #include "cli/cli-cmds.h"
29 #include "gdbcore.h"
30 #include "gdbthread.h"
31 #include "regcache.h"
32 #include "event-top.h"
33 #include "inf-loop.h"
34 #include <sys/stat.h>
35 #include "inf-child.h"
36 #include "value.h"
37 #include "arch-utils.h"
38 #include "bfd.h"
39 #include "bfd/mach-o.h"
40 #include "gdbarch.h"
42 #include <copyfile.h>
43 #include <sys/ptrace.h>
44 #include <sys/signal.h>
45 #include <setjmp.h>
46 #include <sys/types.h>
47 #include <unistd.h>
48 #include <signal.h>
49 #include <ctype.h>
50 #include <sys/sysctl.h>
51 #include <sys/proc.h>
52 #include <libproc.h>
53 #include <sys/syscall.h>
54 #include <spawn.h>
56 #include <mach/mach_error.h>
57 #include <mach/mach_vm.h>
58 #include <mach/mach_init.h>
59 #include <mach/vm_map.h>
60 #include <mach/task.h>
61 #include <mach/mach_port.h>
62 #include <mach/thread_act.h>
63 #include <mach/port.h>
65 #include "darwin-nat.h"
66 #include "filenames.h"
67 #include "gdbsupport/filestuff.h"
68 #include "gdbsupport/gdb_unlinker.h"
69 #include "gdbsupport/pathstuff.h"
70 #include "gdbsupport/scoped_fd.h"
71 #include "nat/fork-inferior.h"
73 /* Quick overview.
74 Darwin kernel is Mach + BSD derived kernel. Note that they share the
75 same memory space and are linked together (ie there is no micro-kernel).
77 Although ptrace(2) is available on Darwin, it is not complete. We have
78 to use Mach calls to read and write memory and to modify registers. We
79 also use Mach to get inferior faults. As we cannot use select(2) or
80 signals with Mach port (the Mach communication channel), signals are
81 reported to gdb as an exception. Furthermore we detect death of the
82 inferior through a Mach notification message. This way we only wait
83 on Mach ports.
85 Some Mach documentation is available for Apple xnu source package or
86 from the web. */
89 #define PTRACE(CMD, PID, ADDR, SIG) \
90 darwin_ptrace(#CMD, CMD, (PID), (ADDR), (SIG))
92 static void darwin_ptrace_me (void);
94 static void darwin_encode_reply (mig_reply_error_t *reply,
95 mach_msg_header_t *hdr, integer_t code);
97 static void darwin_setup_request_notification (struct inferior *inf);
98 static void darwin_deallocate_exception_ports (darwin_inferior *inf);
99 static void darwin_setup_exceptions (struct inferior *inf);
100 static void darwin_deallocate_threads (struct inferior *inf);
102 /* Task identifier of gdb. */
103 static task_t gdb_task;
105 /* A copy of mach_host_self (). */
106 mach_port_t darwin_host_self;
108 /* Exception port. */
109 mach_port_t darwin_ex_port;
111 /* Port set, to wait for answer on all ports. */
112 mach_port_t darwin_port_set;
114 /* Page size. */
115 static vm_size_t mach_page_size;
117 /* If Set, catch all mach exceptions (before they are converted to signals
118 by the kernel). */
119 static bool enable_mach_exceptions;
121 /* Inferior that should report a fake stop event. */
122 static struct inferior *darwin_inf_fake_stop;
124 /* If non-NULL, the shell we actually invoke. See maybe_cache_shell
125 for details. */
126 static const char *copied_shell;
128 #define PAGE_TRUNC(x) ((x) & ~(mach_page_size - 1))
129 #define PAGE_ROUND(x) PAGE_TRUNC((x) + mach_page_size - 1)
131 /* This controls output of inferior debugging. */
132 static unsigned int darwin_debug_flag = 0;
134 /* Create a __TEXT __info_plist section in the executable so that gdb could
135 be signed. This is required to get an authorization for task_for_pid.
137 Once gdb is built, you must codesign it with any system-trusted signing
138 authority. See taskgated(8) for details. */
139 static const unsigned char info_plist[]
140 __attribute__ ((section ("__TEXT,__info_plist"),used)) =
141 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
142 "<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\""
143 " \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
144 "<plist version=\"1.0\">\n"
145 "<dict>\n"
146 " <key>CFBundleIdentifier</key>\n"
147 " <string>org.gnu.gdb</string>\n"
148 " <key>CFBundleName</key>\n"
149 " <string>gdb</string>\n"
150 " <key>CFBundleVersion</key>\n"
151 " <string>1.0</string>\n"
152 " <key>SecTaskAccess</key>\n"
153 " <array>\n"
154 " <string>allowed</string>\n"
155 " <string>debug</string>\n"
156 " </array>\n"
157 "</dict>\n"
158 "</plist>\n";
160 static void inferior_debug (int level, const char *fmt, ...)
161 ATTRIBUTE_PRINTF (2, 3);
163 static void
164 inferior_debug (int level, const char *fmt, ...)
166 va_list ap;
168 if (darwin_debug_flag < level)
169 return;
171 va_start (ap, fmt);
172 gdb_printf (gdb_stdlog, _("[%d inferior]: "), getpid ());
173 gdb_vprintf (gdb_stdlog, fmt, ap);
174 va_end (ap);
177 void
178 mach_check_error (kern_return_t ret, const char *file,
179 unsigned int line, const char *func)
181 if (ret == KERN_SUCCESS)
182 return;
183 if (func == NULL)
184 func = _("[UNKNOWN]");
186 warning (_("Mach error at \"%s:%u\" in function \"%s\": %s (0x%lx)"),
187 file, line, func, mach_error_string (ret), (unsigned long) ret);
190 static const char *
191 unparse_exception_type (unsigned int i)
193 static char unknown_exception_buf[32];
195 switch (i)
197 case EXC_BAD_ACCESS:
198 return "EXC_BAD_ACCESS";
199 case EXC_BAD_INSTRUCTION:
200 return "EXC_BAD_INSTRUCTION";
201 case EXC_ARITHMETIC:
202 return "EXC_ARITHMETIC";
203 case EXC_EMULATION:
204 return "EXC_EMULATION";
205 case EXC_SOFTWARE:
206 return "EXC_SOFTWARE";
207 case EXC_BREAKPOINT:
208 return "EXC_BREAKPOINT";
209 case EXC_SYSCALL:
210 return "EXC_SYSCALL";
211 case EXC_MACH_SYSCALL:
212 return "EXC_MACH_SYSCALL";
213 case EXC_RPC_ALERT:
214 return "EXC_RPC_ALERT";
215 case EXC_CRASH:
216 return "EXC_CRASH";
217 default:
218 snprintf (unknown_exception_buf, 32, _("unknown (%d)"), i);
219 return unknown_exception_buf;
223 /* Set errno to zero, and then call ptrace with the given arguments.
224 If inferior debugging traces are on, then also print a debug
225 trace.
227 The returned value is the same as the value returned by ptrace,
228 except in the case where that value is -1 but errno is zero.
229 This case is documented to be a non-error situation, so we
230 return zero in that case. */
232 static int
233 darwin_ptrace (const char *name,
234 int request, int pid, caddr_t arg3, int arg4)
236 int ret;
238 errno = 0;
239 ret = ptrace (request, pid, arg3, arg4);
240 if (ret == -1 && errno == 0)
241 ret = 0;
243 inferior_debug (4, _("ptrace (%s, %d, 0x%lx, %d): %d (%s)\n"),
244 name, pid, (unsigned long) arg3, arg4, ret,
245 (ret != 0) ? safe_strerror (errno) : _("no error"));
246 return ret;
249 static int
250 cmp_thread_t (const void *l, const void *r)
252 thread_t tl = *(const thread_t *)l;
253 thread_t tr = *(const thread_t *)r;
254 return (int)(tl - tr);
257 void
258 darwin_nat_target::check_new_threads (inferior *inf)
260 kern_return_t kret;
261 thread_array_t thread_list;
262 unsigned int new_nbr;
263 unsigned int old_nbr;
264 unsigned int new_ix, old_ix;
265 darwin_inferior *darwin_inf = get_darwin_inferior (inf);
266 std::vector<darwin_thread_t *> new_thread_vec;
268 if (darwin_inf == nullptr)
269 return;
271 /* Get list of threads. */
272 kret = task_threads (darwin_inf->task, &thread_list, &new_nbr);
273 MACH_CHECK_ERROR (kret);
274 if (kret != KERN_SUCCESS)
275 return;
277 /* Sort the list. */
278 if (new_nbr > 1)
279 qsort (thread_list, new_nbr, sizeof (thread_t), cmp_thread_t);
281 old_nbr = darwin_inf->threads.size ();
283 /* Quick check for no changes. */
284 if (old_nbr == new_nbr)
286 size_t i;
288 for (i = 0; i < new_nbr; i++)
289 if (thread_list[i] != darwin_inf->threads[i]->gdb_port)
290 break;
291 if (i == new_nbr)
293 /* Deallocate ports. */
294 for (i = 0; i < new_nbr; i++)
296 kret = mach_port_deallocate (mach_task_self (), thread_list[i]);
297 MACH_CHECK_ERROR (kret);
300 /* Deallocate the buffer. */
301 kret = vm_deallocate (gdb_task, (vm_address_t) thread_list,
302 new_nbr * sizeof (int));
303 MACH_CHECK_ERROR (kret);
305 return;
309 /* Full handling: detect new threads, remove dead threads. */
311 new_thread_vec.reserve (new_nbr);
313 for (new_ix = 0, old_ix = 0; new_ix < new_nbr || old_ix < old_nbr;)
315 thread_t new_id = (new_ix < new_nbr) ? thread_list[new_ix] : THREAD_NULL;
316 darwin_thread_t *old
317 = (old_ix < old_nbr) ? darwin_inf->threads[old_ix] : NULL;
318 thread_t old_id = old != NULL ? old->gdb_port : THREAD_NULL;
320 inferior_debug
321 (12, _(" new_ix:%d/%d, old_ix:%d/%d, new_id:0x%x old_id:0x%x\n"),
322 new_ix, new_nbr, old_ix, old_nbr, new_id, old_id);
324 if (old_id == new_id)
326 /* Thread still exist. */
327 new_thread_vec.push_back (old);
328 new_ix++;
329 old_ix++;
331 /* Deallocate the port. */
332 kret = mach_port_deallocate (gdb_task, new_id);
333 MACH_CHECK_ERROR (kret);
335 continue;
337 if (new_ix < new_nbr && new_id == MACH_PORT_DEAD)
339 /* Ignore dead ports.
340 In some weird cases, we might get dead ports. They should
341 correspond to dead thread so they could safely be ignored. */
342 new_ix++;
343 continue;
345 if (new_ix < new_nbr && (old_ix == old_nbr || new_id < old_id))
347 /* A thread was created. */
348 darwin_thread_info *pti = new darwin_thread_info;
350 pti->gdb_port = new_id;
351 pti->msg_state = DARWIN_RUNNING;
353 /* Add the new thread. */
354 add_thread_with_info (this, ptid_t (inf->pid, 0, new_id),
355 private_thread_info_up (pti));
356 new_thread_vec.push_back (pti);
357 new_ix++;
358 continue;
360 if (old_ix < old_nbr && (new_ix == new_nbr || new_id > old_id))
362 /* A thread was removed. */
363 struct thread_info *thr
364 = this->find_thread (ptid_t (inf->pid, 0, old_id));
365 delete_thread (thr);
366 kret = mach_port_deallocate (gdb_task, old_id);
367 MACH_CHECK_ERROR (kret);
368 old_ix++;
369 continue;
371 gdb_assert_not_reached ("unexpected thread case");
374 darwin_inf->threads = std::move (new_thread_vec);
376 /* Deallocate the buffer. */
377 kret = vm_deallocate (gdb_task, (vm_address_t) thread_list,
378 new_nbr * sizeof (int));
379 MACH_CHECK_ERROR (kret);
382 /* Return an inferior by task port. */
383 static struct inferior *
384 darwin_find_inferior_by_task (task_t port)
386 for (inferior *inf : all_inferiors ())
388 darwin_inferior *priv = get_darwin_inferior (inf);
390 if (priv != nullptr && priv->task == port)
391 return inf;
393 return nullptr;
396 /* Return an inferior by pid port. */
397 static struct inferior *
398 darwin_find_inferior_by_pid (int pid)
400 for (inferior *inf : all_inferiors ())
402 if (inf->pid == pid)
403 return inf;
405 return nullptr;
408 /* Return a thread by port. */
409 static darwin_thread_t *
410 darwin_find_thread (struct inferior *inf, thread_t thread)
412 darwin_inferior *priv = get_darwin_inferior (inf);
414 if (priv != nullptr)
415 for (darwin_thread_t *t : priv->threads)
417 if (t->gdb_port == thread)
418 return t;
421 return NULL;
424 /* Suspend (ie stop) an inferior at Mach level. */
426 static void
427 darwin_suspend_inferior (struct inferior *inf)
429 darwin_inferior *priv = get_darwin_inferior (inf);
431 if (priv != nullptr && !priv->suspended)
433 kern_return_t kret;
435 kret = task_suspend (priv->task);
436 MACH_CHECK_ERROR (kret);
438 priv->suspended = 1;
442 /* Resume an inferior at Mach level. */
444 static void
445 darwin_resume_inferior (struct inferior *inf)
447 darwin_inferior *priv = get_darwin_inferior (inf);
449 if (priv != nullptr && priv->suspended)
451 kern_return_t kret;
453 kret = task_resume (priv->task);
454 MACH_CHECK_ERROR (kret);
456 priv->suspended = 0;
460 static void
461 darwin_dump_message (mach_msg_header_t *hdr, int disp_body)
463 gdb_printf (gdb_stdlog,
464 _("message header:\n"));
465 gdb_printf (gdb_stdlog,
466 _(" bits: 0x%x\n"), hdr->msgh_bits);
467 gdb_printf (gdb_stdlog,
468 _(" size: 0x%x\n"), hdr->msgh_size);
469 gdb_printf (gdb_stdlog,
470 _(" remote-port: 0x%x\n"), hdr->msgh_remote_port);
471 gdb_printf (gdb_stdlog,
472 _(" local-port: 0x%x\n"), hdr->msgh_local_port);
473 gdb_printf (gdb_stdlog,
474 _(" reserved: 0x%x\n"), hdr->msgh_reserved);
475 gdb_printf (gdb_stdlog,
476 _(" id: 0x%x\n"), hdr->msgh_id);
478 if (disp_body)
480 const unsigned char *data;
481 const unsigned int *ldata;
482 int size;
483 int i;
485 data = (unsigned char *)(hdr + 1);
486 size = hdr->msgh_size - sizeof (mach_msg_header_t);
488 if (hdr->msgh_bits & MACH_MSGH_BITS_COMPLEX)
490 mach_msg_body_t *bod = (mach_msg_body_t*)data;
491 mach_msg_port_descriptor_t *desc =
492 (mach_msg_port_descriptor_t *)(bod + 1);
493 int k;
494 NDR_record_t *ndr;
495 gdb_printf (gdb_stdlog,
496 _("body: descriptor_count=%u\n"),
497 bod->msgh_descriptor_count);
498 data += sizeof (mach_msg_body_t);
499 size -= sizeof (mach_msg_body_t);
500 for (k = 0; k < bod->msgh_descriptor_count; k++)
501 switch (desc[k].type)
503 case MACH_MSG_PORT_DESCRIPTOR:
504 gdb_printf
505 (gdb_stdlog,
506 _(" descr %d: type=%u (port) name=0x%x, dispo=%d\n"),
507 k, desc[k].type, desc[k].name, desc[k].disposition);
508 break;
509 default:
510 gdb_printf (gdb_stdlog,
511 _(" descr %d: type=%u\n"),
512 k, desc[k].type);
513 break;
515 data += bod->msgh_descriptor_count
516 * sizeof (mach_msg_port_descriptor_t);
517 size -= bod->msgh_descriptor_count
518 * sizeof (mach_msg_port_descriptor_t);
519 ndr = (NDR_record_t *)(desc + bod->msgh_descriptor_count);
520 gdb_printf
521 (gdb_stdlog,
522 _("NDR: mig=%02x if=%02x encod=%02x "
523 "int=%02x char=%02x float=%02x\n"),
524 ndr->mig_vers, ndr->if_vers, ndr->mig_encoding,
525 ndr->int_rep, ndr->char_rep, ndr->float_rep);
526 data += sizeof (NDR_record_t);
527 size -= sizeof (NDR_record_t);
530 gdb_printf (gdb_stdlog, _(" data:"));
531 ldata = (const unsigned int *)data;
532 for (i = 0; i < size / sizeof (unsigned int); i++)
533 gdb_printf (gdb_stdlog, " %08x", ldata[i]);
534 gdb_printf (gdb_stdlog, _("\n"));
538 /* Adjust inferior data when a new task was created. */
540 static struct inferior *
541 darwin_find_new_inferior (task_t task_port, thread_t thread_port)
543 int task_pid;
544 struct inferior *inf;
545 kern_return_t kret;
546 mach_port_t prev;
548 /* Find the corresponding pid. */
549 kret = pid_for_task (task_port, &task_pid);
550 if (kret != KERN_SUCCESS)
552 MACH_CHECK_ERROR (kret);
553 return NULL;
556 /* Find the inferior for this pid. */
557 inf = darwin_find_inferior_by_pid (task_pid);
558 if (inf == NULL)
559 return NULL;
561 darwin_inferior *priv = get_darwin_inferior (inf);
563 /* Deallocate saved exception ports. */
564 darwin_deallocate_exception_ports (priv);
566 /* No need to remove dead_name notification, but still... */
567 kret = mach_port_request_notification (gdb_task, priv->task,
568 MACH_NOTIFY_DEAD_NAME, 0,
569 MACH_PORT_NULL,
570 MACH_MSG_TYPE_MAKE_SEND_ONCE,
571 &prev);
572 if (kret != KERN_INVALID_ARGUMENT)
573 MACH_CHECK_ERROR (kret);
575 /* Replace old task port. */
576 kret = mach_port_deallocate (gdb_task, priv->task);
577 MACH_CHECK_ERROR (kret);
578 priv->task = task_port;
580 darwin_setup_request_notification (inf);
581 darwin_setup_exceptions (inf);
583 return inf;
586 /* Check data representation. */
588 static int
589 darwin_check_message_ndr (NDR_record_t *ndr)
591 if (ndr->mig_vers != NDR_PROTOCOL_2_0
592 || ndr->if_vers != NDR_PROTOCOL_2_0
593 || ndr->mig_encoding != NDR_record.mig_encoding
594 || ndr->int_rep != NDR_record.int_rep
595 || ndr->char_rep != NDR_record.char_rep
596 || ndr->float_rep != NDR_record.float_rep)
597 return -1;
598 return 0;
601 /* Decode an exception message. */
604 darwin_nat_target::decode_exception_message (mach_msg_header_t *hdr,
605 inferior **pinf,
606 darwin_thread_t **pthread)
608 mach_msg_body_t *bod = (mach_msg_body_t*)(hdr + 1);
609 mach_msg_port_descriptor_t *desc = (mach_msg_port_descriptor_t *)(bod + 1);
610 NDR_record_t *ndr;
611 integer_t *data;
612 struct inferior *inf;
613 darwin_thread_t *thread;
614 task_t task_port;
615 thread_t thread_port;
616 kern_return_t kret;
617 int i;
619 /* Check message destination. */
620 if (hdr->msgh_local_port != darwin_ex_port)
621 return -1;
623 /* Check message header. */
624 if (!(hdr->msgh_bits & MACH_MSGH_BITS_COMPLEX))
625 return -1;
627 /* Check descriptors. */
628 if (hdr->msgh_size < (sizeof (*hdr) + sizeof (*bod) + 2 * sizeof (*desc)
629 + sizeof (*ndr) + 2 * sizeof (integer_t))
630 || bod->msgh_descriptor_count != 2
631 || desc[0].type != MACH_MSG_PORT_DESCRIPTOR
632 || desc[0].disposition != MACH_MSG_TYPE_MOVE_SEND
633 || desc[1].type != MACH_MSG_PORT_DESCRIPTOR
634 || desc[1].disposition != MACH_MSG_TYPE_MOVE_SEND)
635 return -1;
637 /* Check data representation. */
638 ndr = (NDR_record_t *)(desc + 2);
639 if (darwin_check_message_ndr (ndr) != 0)
640 return -1;
642 /* Ok, the hard work. */
643 data = (integer_t *)(ndr + 1);
645 task_port = desc[1].name;
646 thread_port = desc[0].name;
648 /* Find process by port. */
649 inf = darwin_find_inferior_by_task (task_port);
650 *pinf = inf;
652 if (inf == NULL && data[0] == EXC_SOFTWARE && data[1] == 2
653 && data[2] == EXC_SOFT_SIGNAL && data[3] == SIGTRAP)
655 /* Not a known inferior, but a sigtrap. This happens on darwin 16.1.0,
656 as a new Mach task is created when a process exec. */
657 inf = darwin_find_new_inferior (task_port, thread_port);
658 *pinf = inf;
660 if (inf == NULL)
662 /* Deallocate task_port, unless it was saved. */
663 kret = mach_port_deallocate (mach_task_self (), task_port);
664 MACH_CHECK_ERROR (kret);
667 else
669 /* We got new rights to the task, get rid of it. Do not get rid of
670 thread right, as we will need it to find the thread. */
671 kret = mach_port_deallocate (mach_task_self (), task_port);
672 MACH_CHECK_ERROR (kret);
675 if (inf == NULL)
677 /* Not a known inferior. This could happen if the child fork, as
678 the created process will inherit its exception port.
679 FIXME: should the exception port be restored ? */
680 mig_reply_error_t reply;
682 inferior_debug
683 (4, _("darwin_decode_exception_message: unknown task 0x%x\n"),
684 task_port);
686 /* Free thread port (we don't know it). */
687 kret = mach_port_deallocate (mach_task_self (), thread_port);
688 MACH_CHECK_ERROR (kret);
690 darwin_encode_reply (&reply, hdr, KERN_SUCCESS);
692 kret = mach_msg (&reply.Head, MACH_SEND_MSG | MACH_SEND_INTERRUPT,
693 reply.Head.msgh_size, 0,
694 MACH_PORT_NULL, MACH_MSG_TIMEOUT_NONE,
695 MACH_PORT_NULL);
696 MACH_CHECK_ERROR (kret);
698 return 0;
701 /* Find thread by port. */
702 /* Check for new threads. Do it early so that the port in the exception
703 message can be deallocated. */
704 check_new_threads (inf);
706 /* Free the thread port (as gdb knows the thread, it has already has a right
707 for it, so this just decrement a reference counter). */
708 kret = mach_port_deallocate (mach_task_self (), thread_port);
709 MACH_CHECK_ERROR (kret);
711 thread = darwin_find_thread (inf, thread_port);
712 if (thread == NULL)
713 return -1;
714 *pthread = thread;
716 /* The thread should be running. However we have observed cases where a
717 thread got a SIGTTIN message after being stopped. */
718 gdb_assert (thread->msg_state != DARWIN_MESSAGE);
720 /* Finish decoding. */
721 thread->event.header = *hdr;
722 thread->event.thread_port = thread_port;
723 thread->event.task_port = task_port;
724 thread->event.ex_type = data[0];
725 thread->event.data_count = data[1];
727 if (hdr->msgh_size < (sizeof (*hdr) + sizeof (*bod) + 2 * sizeof (*desc)
728 + sizeof (*ndr) + 2 * sizeof (integer_t)
729 + data[1] * sizeof (integer_t)))
730 return -1;
731 for (i = 0; i < data[1]; i++)
732 thread->event.ex_data[i] = data[2 + i];
734 thread->msg_state = DARWIN_MESSAGE;
736 return 0;
739 /* Decode dead_name notify message. */
741 static int
742 darwin_decode_notify_message (mach_msg_header_t *hdr, struct inferior **pinf)
744 NDR_record_t *ndr = (NDR_record_t *)(hdr + 1);
745 integer_t *data = (integer_t *)(ndr + 1);
746 struct inferior *inf;
747 task_t task_port;
749 /* Check message header. */
750 if (hdr->msgh_bits & MACH_MSGH_BITS_COMPLEX)
751 return -1;
753 /* Check descriptors. */
754 if (hdr->msgh_size < (sizeof (*hdr) + sizeof (*ndr) + sizeof (integer_t)))
755 return -2;
757 /* Check data representation. */
758 if (darwin_check_message_ndr (ndr) != 0)
759 return -3;
761 task_port = data[0];
763 /* Find process by port. */
764 inf = darwin_find_inferior_by_task (task_port);
765 *pinf = inf;
767 /* Check message destination. */
768 if (inf != NULL)
770 darwin_inferior *priv = get_darwin_inferior (inf);
771 if (hdr->msgh_local_port != priv->notify_port)
772 return -4;
775 return 0;
778 static void
779 darwin_encode_reply (mig_reply_error_t *reply, mach_msg_header_t *hdr,
780 integer_t code)
782 mach_msg_header_t *rh = &reply->Head;
784 rh->msgh_bits = MACH_MSGH_BITS (MACH_MSGH_BITS_REMOTE (hdr->msgh_bits), 0);
785 rh->msgh_remote_port = hdr->msgh_remote_port;
786 rh->msgh_size = (mach_msg_size_t) sizeof (mig_reply_error_t);
787 rh->msgh_local_port = MACH_PORT_NULL;
788 rh->msgh_id = hdr->msgh_id + 100;
790 reply->NDR = NDR_record;
791 reply->RetCode = code;
794 static void
795 darwin_send_reply (struct inferior *inf, darwin_thread_t *thread)
797 kern_return_t kret;
798 mig_reply_error_t reply;
799 darwin_inferior *priv = get_darwin_inferior (inf);
801 darwin_encode_reply (&reply, &thread->event.header, KERN_SUCCESS);
803 kret = mach_msg (&reply.Head, MACH_SEND_MSG | MACH_SEND_INTERRUPT,
804 reply.Head.msgh_size, 0,
805 MACH_PORT_NULL, MACH_MSG_TIMEOUT_NONE,
806 MACH_PORT_NULL);
807 MACH_CHECK_ERROR (kret);
809 priv->pending_messages--;
812 /* Wrapper around the __pthread_kill syscall. We use this instead of the
813 pthread_kill function to be able to send a signal to any kind of thread,
814 including GCD threads. */
816 static int
817 darwin_pthread_kill (darwin_thread_t *thread, int nsignal)
819 DIAGNOSTIC_PUSH;
820 DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS;
821 int res = syscall (SYS___pthread_kill, thread->gdb_port, nsignal);
822 DIAGNOSTIC_POP;
823 return res;
826 static void
827 darwin_resume_thread (struct inferior *inf, darwin_thread_t *thread,
828 int step, int nsignal)
830 inferior_debug
831 (3, _("darwin_resume_thread: state=%d, thread=0x%x, step=%d nsignal=%d\n"),
832 thread->msg_state, thread->gdb_port, step, nsignal);
834 switch (thread->msg_state)
836 case DARWIN_MESSAGE:
837 if (thread->event.ex_type == EXC_SOFTWARE
838 && thread->event.ex_data[0] == EXC_SOFT_SIGNAL)
840 /* Either deliver a new signal or cancel the signal received. */
841 int res = PTRACE (PT_THUPDATE, inf->pid,
842 (caddr_t) (uintptr_t) thread->gdb_port, nsignal);
843 if (res < 0)
844 inferior_debug (1, _("ptrace THUP: res=%d\n"), res);
846 else if (nsignal)
848 /* Note: ptrace is allowed only if the process is stopped.
849 Directly send the signal to the thread. */
850 int res = darwin_pthread_kill (thread, nsignal);
851 inferior_debug (4, _("darwin_resume_thread: kill 0x%x %d: %d\n"),
852 thread->gdb_port, nsignal, res);
853 thread->signaled = 1;
856 /* Set or reset single step. */
857 inferior_debug (4, _("darwin_set_sstep (thread=0x%x, enable=%d)\n"),
858 thread->gdb_port, step);
859 darwin_set_sstep (thread->gdb_port, step);
860 thread->single_step = step;
862 darwin_send_reply (inf, thread);
863 thread->msg_state = DARWIN_RUNNING;
864 break;
866 case DARWIN_RUNNING:
867 break;
869 case DARWIN_STOPPED:
870 kern_return_t kret = thread_resume (thread->gdb_port);
871 MACH_CHECK_ERROR (kret);
873 thread->msg_state = DARWIN_RUNNING;
874 break;
878 /* Resume all threads of the inferior. */
880 static void
881 darwin_resume_inferior_threads (struct inferior *inf, int step, int nsignal)
883 darwin_inferior *priv = get_darwin_inferior (inf);
885 if (priv != nullptr)
886 for (darwin_thread_t *thread : priv->threads)
887 darwin_resume_thread (inf, thread, step, nsignal);
890 /* Suspend all threads of INF. */
892 static void
893 darwin_suspend_inferior_threads (struct inferior *inf)
895 darwin_inferior *priv = get_darwin_inferior (inf);
897 for (darwin_thread_t *thread : priv->threads)
899 switch (thread->msg_state)
901 case DARWIN_STOPPED:
902 case DARWIN_MESSAGE:
903 break;
904 case DARWIN_RUNNING:
906 kern_return_t kret = thread_suspend (thread->gdb_port);
907 MACH_CHECK_ERROR (kret);
908 thread->msg_state = DARWIN_STOPPED;
909 break;
915 void
916 darwin_nat_target::resume (ptid_t ptid, int step, enum gdb_signal signal)
918 int nsignal;
920 inferior_debug
921 (2, _("darwin_resume: ptid=%s, step=%d, signal=%d\n"),
922 ptid.to_string ().c_str (), step, signal);
924 if (signal == GDB_SIGNAL_0)
925 nsignal = 0;
926 else
927 nsignal = gdb_signal_to_host (signal);
929 /* Don't try to single step all threads. */
930 if (step)
931 ptid = inferior_ptid;
933 /* minus_one_ptid is RESUME_ALL. */
934 if (ptid == minus_one_ptid)
936 /* Resume threads. */
937 for (inferior *inf : all_inferiors ())
938 darwin_resume_inferior_threads (inf, step, nsignal);
940 /* Resume tasks. */
941 for (inferior *inf : all_inferiors ())
942 darwin_resume_inferior (inf);
944 else
946 inferior *inf = find_inferior_ptid (this, ptid);
947 long tid = ptid.tid ();
949 /* Stop the inferior (should be useless). */
950 darwin_suspend_inferior (inf);
952 if (tid == 0)
953 darwin_resume_inferior_threads (inf, step, nsignal);
954 else
956 darwin_thread_t *thread;
958 /* Suspend threads of the task. */
959 darwin_suspend_inferior_threads (inf);
961 /* Resume the selected thread. */
962 thread = darwin_find_thread (inf, tid);
963 gdb_assert (thread);
964 darwin_resume_thread (inf, thread, step, nsignal);
967 /* Resume the task. */
968 darwin_resume_inferior (inf);
972 ptid_t
973 darwin_nat_target::decode_message (mach_msg_header_t *hdr,
974 darwin_thread_t **pthread,
975 inferior **pinf,
976 target_waitstatus *status)
978 darwin_thread_t *thread;
979 struct inferior *inf;
981 /* Exception message. 2401 == 0x961 is exc. */
982 if (hdr->msgh_id == 2401)
984 int res;
986 /* Decode message. */
987 res = decode_exception_message (hdr, &inf, &thread);
989 if (res < 0)
991 /* Should not happen... */
992 warning (_("darwin_wait: ill-formatted message (id=0x%x)\n"),
993 hdr->msgh_id);
994 /* FIXME: send a failure reply? */
995 status->set_ignore ();
996 return minus_one_ptid;
998 if (inf == NULL)
1000 status->set_ignore ();
1001 return minus_one_ptid;
1003 *pinf = inf;
1004 *pthread = thread;
1006 darwin_inferior *priv = get_darwin_inferior (inf);
1008 priv->pending_messages++;
1010 thread->msg_state = DARWIN_MESSAGE;
1012 inferior_debug (4, _("darwin_wait: thread=0x%x, got %s\n"),
1013 thread->gdb_port,
1014 unparse_exception_type (thread->event.ex_type));
1016 switch (thread->event.ex_type)
1018 case EXC_BAD_ACCESS:
1019 status->set_stopped (GDB_EXC_BAD_ACCESS);
1020 break;
1021 case EXC_BAD_INSTRUCTION:
1022 status->set_stopped (GDB_EXC_BAD_INSTRUCTION);
1023 break;
1024 case EXC_ARITHMETIC:
1025 status->set_stopped (GDB_EXC_ARITHMETIC);
1026 break;
1027 case EXC_EMULATION:
1028 status->set_stopped (GDB_EXC_EMULATION);
1029 break;
1030 case EXC_SOFTWARE:
1031 if (thread->event.ex_data[0] == EXC_SOFT_SIGNAL)
1033 status->set_stopped
1034 (gdb_signal_from_host (thread->event.ex_data[1]));
1035 inferior_debug (5, _(" (signal %d: %s)\n"),
1036 thread->event.ex_data[1],
1037 gdb_signal_to_name (status->sig ()));
1039 /* If the thread is stopped because it has received a signal
1040 that gdb has just sent, continue. */
1041 if (thread->signaled)
1043 thread->signaled = 0;
1044 darwin_send_reply (inf, thread);
1045 thread->msg_state = DARWIN_RUNNING;
1046 status->set_ignore ();
1049 else
1050 status->set_stopped (GDB_EXC_SOFTWARE);
1051 break;
1052 case EXC_BREAKPOINT:
1053 /* Many internal GDB routines expect breakpoints to be reported
1054 as GDB_SIGNAL_TRAP, and will report GDB_EXC_BREAKPOINT
1055 as a spurious signal. */
1056 status->set_stopped (GDB_SIGNAL_TRAP);
1057 break;
1058 default:
1059 status->set_stopped (GDB_SIGNAL_UNKNOWN);
1060 break;
1063 return ptid_t (inf->pid, 0, thread->gdb_port);
1065 else if (hdr->msgh_id == 0x48)
1067 /* MACH_NOTIFY_DEAD_NAME: notification for exit *or* WIFSTOPPED. */
1068 int res;
1070 res = darwin_decode_notify_message (hdr, &inf);
1072 if (res < 0)
1074 /* Should not happen... */
1075 warning
1076 (_("darwin_wait: ill-formatted message (id=0x%x, res=%d)\n"),
1077 hdr->msgh_id, res);
1080 *pinf = NULL;
1081 *pthread = NULL;
1083 if (res < 0 || inf == NULL)
1085 status->set_ignore ();
1086 return minus_one_ptid;
1089 if (inf != NULL)
1091 darwin_inferior *priv = get_darwin_inferior (inf);
1093 if (!priv->no_ptrace)
1095 pid_t res_pid;
1096 int wstatus;
1098 res_pid = wait4 (inf->pid, &wstatus, 0, NULL);
1099 if (res_pid < 0 || res_pid != inf->pid)
1101 warning (_("wait4: res=%d: %s\n"),
1102 res_pid, safe_strerror (errno));
1103 status->set_ignore ();
1104 return minus_one_ptid;
1106 if (WIFEXITED (wstatus))
1108 status->set_exited (WEXITSTATUS (wstatus));
1109 inferior_debug (4, _("darwin_wait: pid=%d exit, status=0x%x\n"),
1110 res_pid, wstatus);
1112 else if (WIFSTOPPED (wstatus))
1114 /* Ignore stopped state, it will be handled by the next
1115 exception. */
1116 status->set_ignore ();
1117 inferior_debug (4, _("darwin_wait: pid %d received WIFSTOPPED\n"),
1118 res_pid);
1119 return minus_one_ptid;
1121 else if (WIFSIGNALED (wstatus))
1123 status->set_signalled
1124 (gdb_signal_from_host (WTERMSIG (wstatus)));
1125 inferior_debug (4, _("darwin_wait: pid=%d received signal %d\n"),
1126 res_pid, status->sig());
1128 else
1130 status->set_ignore ();
1131 warning (_("Unexpected wait status after MACH_NOTIFY_DEAD_NAME "
1132 "notification: 0x%x"), wstatus);
1133 return minus_one_ptid;
1136 return ptid_t (inf->pid);
1138 else
1140 inferior_debug (4, _("darwin_wait: pid=%d\n"), inf->pid);
1141 status->set_exited (0 /* Don't know. */);
1142 return ptid_t (inf->pid, 0, 0);
1147 /* Unknown message. */
1148 warning (_("darwin: got unknown message, id: 0x%x"), hdr->msgh_id);
1149 status->set_ignore ();
1150 return minus_one_ptid;
1154 darwin_nat_target::cancel_breakpoint (inferior *inf, ptid_t ptid)
1156 /* Arrange for a breakpoint to be hit again later. We will handle
1157 the current event, eventually we will resume this thread, and this
1158 breakpoint will trap again.
1160 If we do not do this, then we run the risk that the user will
1161 delete or disable the breakpoint, but the thread will have already
1162 tripped on it. */
1164 struct regcache *regcache = get_thread_regcache (this, ptid);
1165 struct gdbarch *gdbarch = regcache->arch ();
1166 CORE_ADDR pc;
1168 pc = regcache_read_pc (regcache) - gdbarch_decr_pc_after_break (gdbarch);
1169 if (breakpoint_inserted_here_p (inf->aspace.get (), pc))
1171 inferior_debug (4, "cancel_breakpoint for thread 0x%lx\n",
1172 (unsigned long) ptid.tid ());
1174 /* Back up the PC if necessary. */
1175 if (gdbarch_decr_pc_after_break (gdbarch))
1176 regcache_write_pc (regcache, pc);
1178 return 1;
1180 return 0;
1183 ptid_t
1184 darwin_nat_target::wait_1 (ptid_t ptid, struct target_waitstatus *status)
1186 kern_return_t kret;
1187 union
1189 mach_msg_header_t hdr;
1190 char data[0x100];
1191 } msgin;
1192 mach_msg_header_t *hdr = &msgin.hdr;
1193 ptid_t res;
1194 darwin_thread_t *thread;
1196 inferior_debug
1197 (2, _("darwin_wait: waiting for a message ptid=%s\n"),
1198 ptid.to_string ().c_str ());
1200 /* Handle fake stop events at first. */
1201 if (darwin_inf_fake_stop != NULL)
1203 inferior *inf = darwin_inf_fake_stop;
1204 darwin_inf_fake_stop = NULL;
1206 darwin_inferior *priv = get_darwin_inferior (inf);
1208 status->set_stopped (GDB_SIGNAL_TRAP);
1209 thread = priv->threads[0];
1210 thread->msg_state = DARWIN_STOPPED;
1211 return ptid_t (inf->pid, 0, thread->gdb_port);
1216 /* set_sigint_trap (); */
1218 /* Wait for a message. */
1219 kret = mach_msg (&msgin.hdr, MACH_RCV_MSG | MACH_RCV_INTERRUPT, 0,
1220 sizeof (msgin.data), darwin_port_set, 0, MACH_PORT_NULL);
1222 /* clear_sigint_trap (); */
1224 if (kret == MACH_RCV_INTERRUPTED)
1226 status->set_ignore ();
1227 return minus_one_ptid;
1230 if (kret != MACH_MSG_SUCCESS)
1232 inferior_debug (5, _("mach_msg: ret=0x%x\n"), kret);
1233 status->set_spurious ();
1234 return minus_one_ptid;
1237 /* Debug: display message. */
1238 if (darwin_debug_flag > 10)
1239 darwin_dump_message (hdr, darwin_debug_flag > 11);
1241 inferior *inf;
1242 res = decode_message (hdr, &thread, &inf, status);
1243 if (res == minus_one_ptid)
1244 continue;
1246 /* Early return in case an inferior has exited. */
1247 if (inf == NULL)
1248 return res;
1250 while (status->kind () == TARGET_WAITKIND_IGNORE);
1252 /* Stop all tasks. */
1253 for (inferior *inf : all_inferiors (this))
1255 darwin_suspend_inferior (inf);
1256 check_new_threads (inf);
1259 /* Read pending messages. */
1260 while (1)
1262 struct target_waitstatus status2;
1263 ptid_t ptid2;
1265 kret = mach_msg (&msgin.hdr,
1266 MACH_RCV_MSG | MACH_RCV_TIMEOUT, 0,
1267 sizeof (msgin.data), darwin_port_set, 1, MACH_PORT_NULL);
1269 if (kret == MACH_RCV_TIMED_OUT)
1270 break;
1271 if (kret != MACH_MSG_SUCCESS)
1273 inferior_debug
1274 (5, _("darwin_wait: mach_msg(pending) ret=0x%x\n"), kret);
1275 break;
1278 /* Debug: display message. */
1279 if (darwin_debug_flag > 10)
1280 darwin_dump_message (hdr, darwin_debug_flag > 11);
1282 inferior *inf;
1283 ptid2 = decode_message (hdr, &thread, &inf, &status2);
1285 if (inf != NULL && thread != NULL
1286 && thread->event.ex_type == EXC_BREAKPOINT)
1288 if (thread->single_step
1289 || cancel_breakpoint (inf,
1290 ptid_t (inf->pid, 0, thread->gdb_port)))
1292 gdb_assert (thread->msg_state == DARWIN_MESSAGE);
1293 darwin_send_reply (inf, thread);
1294 thread->msg_state = DARWIN_RUNNING;
1296 else
1297 inferior_debug
1298 (3, _("darwin_wait: thread 0x%x hit a non-gdb breakpoint\n"),
1299 thread->gdb_port);
1301 else
1302 inferior_debug (3, _("darwin_wait: unhandled pending message\n"));
1304 return res;
1307 ptid_t
1308 darwin_nat_target::wait (ptid_t ptid, struct target_waitstatus *status,
1309 target_wait_flags options)
1311 return wait_1 (ptid, status);
1314 void
1315 darwin_nat_target::interrupt ()
1317 struct inferior *inf = current_inferior ();
1318 darwin_inferior *priv = get_darwin_inferior (inf);
1320 /* FIXME: handle in no_ptrace mode. */
1321 gdb_assert (!priv->no_ptrace);
1322 ::kill (inf->pid, SIGINT);
1325 /* Deallocate threads port and vector. */
1327 static void
1328 darwin_deallocate_threads (struct inferior *inf)
1330 darwin_inferior *priv = get_darwin_inferior (inf);
1332 for (darwin_thread_t *t : priv->threads)
1334 kern_return_t kret = mach_port_deallocate (gdb_task, t->gdb_port);
1335 MACH_CHECK_ERROR (kret);
1338 priv->threads.clear ();
1341 void
1342 darwin_nat_target::mourn_inferior ()
1344 struct inferior *inf = current_inferior ();
1345 darwin_inferior *priv = get_darwin_inferior (inf);
1346 kern_return_t kret;
1347 mach_port_t prev;
1349 /* Deallocate threads. */
1350 darwin_deallocate_threads (inf);
1352 /* Remove notify_port from darwin_port_set. */
1353 kret = mach_port_move_member (gdb_task,
1354 priv->notify_port, MACH_PORT_NULL);
1355 MACH_CHECK_ERROR (kret);
1357 /* Remove task port dead_name notification. */
1358 kret = mach_port_request_notification (gdb_task, priv->task,
1359 MACH_NOTIFY_DEAD_NAME, 0,
1360 MACH_PORT_NULL,
1361 MACH_MSG_TYPE_MAKE_SEND_ONCE,
1362 &prev);
1363 /* This can fail if the task is dead. */
1364 inferior_debug (4, "task=0x%x, prev=0x%x, notify_port=0x%x\n",
1365 priv->task, prev, priv->notify_port);
1367 if (kret == KERN_SUCCESS)
1369 kret = mach_port_deallocate (gdb_task, prev);
1370 MACH_CHECK_ERROR (kret);
1373 /* Destroy notify_port. */
1374 kret = mach_port_destroy (gdb_task, priv->notify_port);
1375 MACH_CHECK_ERROR (kret);
1377 /* Deallocate saved exception ports. */
1378 darwin_deallocate_exception_ports (priv);
1380 /* Deallocate task port. */
1381 kret = mach_port_deallocate (gdb_task, priv->task);
1382 MACH_CHECK_ERROR (kret);
1384 inf->priv = NULL;
1386 inf_child_target::mourn_inferior ();
1389 static void
1390 darwin_reply_to_all_pending_messages (struct inferior *inf)
1392 darwin_inferior *priv = get_darwin_inferior (inf);
1394 for (darwin_thread_t *t : priv->threads)
1396 if (t->msg_state == DARWIN_MESSAGE)
1397 darwin_resume_thread (inf, t, 0, 0);
1401 void
1402 darwin_nat_target::stop_inferior (inferior *inf)
1404 struct target_waitstatus wstatus;
1405 ptid_t ptid;
1406 int res;
1407 darwin_inferior *priv = get_darwin_inferior (inf);
1409 gdb_assert (inf != NULL);
1411 darwin_suspend_inferior (inf);
1413 darwin_reply_to_all_pending_messages (inf);
1415 if (priv->no_ptrace)
1416 return;
1418 res = ::kill (inf->pid, SIGSTOP);
1419 if (res != 0)
1420 warning (_("cannot kill: %s"), safe_strerror (errno));
1422 /* Wait until the process is really stopped. */
1423 while (1)
1425 ptid = wait_1 (ptid_t (inf->pid), &wstatus);
1426 if (wstatus.kind () == TARGET_WAITKIND_STOPPED
1427 && wstatus.sig () == GDB_SIGNAL_STOP)
1428 break;
1432 static kern_return_t
1433 darwin_save_exception_ports (darwin_inferior *inf)
1435 kern_return_t kret;
1437 inf->exception_info.count =
1438 sizeof (inf->exception_info.ports) / sizeof (inf->exception_info.ports[0]);
1440 kret = task_get_exception_ports
1441 (inf->task, EXC_MASK_ALL, inf->exception_info.masks,
1442 &inf->exception_info.count, inf->exception_info.ports,
1443 inf->exception_info.behaviors, inf->exception_info.flavors);
1444 return kret;
1447 static kern_return_t
1448 darwin_restore_exception_ports (darwin_inferior *inf)
1450 int i;
1451 kern_return_t kret;
1453 for (i = 0; i < inf->exception_info.count; i++)
1455 kret = task_set_exception_ports
1456 (inf->task, inf->exception_info.masks[i], inf->exception_info.ports[i],
1457 inf->exception_info.behaviors[i], inf->exception_info.flavors[i]);
1458 if (kret != KERN_SUCCESS)
1459 return kret;
1462 return KERN_SUCCESS;
1465 /* Deallocate saved exception ports. */
1467 static void
1468 darwin_deallocate_exception_ports (darwin_inferior *inf)
1470 int i;
1471 kern_return_t kret;
1473 for (i = 0; i < inf->exception_info.count; i++)
1475 kret = mach_port_deallocate (gdb_task, inf->exception_info.ports[i]);
1476 MACH_CHECK_ERROR (kret);
1478 inf->exception_info.count = 0;
1481 static void
1482 darwin_setup_exceptions (struct inferior *inf)
1484 darwin_inferior *priv = get_darwin_inferior (inf);
1485 kern_return_t kret;
1486 exception_mask_t mask;
1488 kret = darwin_save_exception_ports (priv);
1489 if (kret != KERN_SUCCESS)
1490 error (_("Unable to save exception ports, task_get_exception_ports"
1491 "returned: %d"),
1492 kret);
1494 /* Set exception port. */
1495 if (enable_mach_exceptions)
1496 mask = EXC_MASK_ALL;
1497 else
1498 mask = EXC_MASK_SOFTWARE | EXC_MASK_BREAKPOINT;
1499 kret = task_set_exception_ports (priv->task, mask, darwin_ex_port,
1500 EXCEPTION_DEFAULT, THREAD_STATE_NONE);
1501 if (kret != KERN_SUCCESS)
1502 error (_("Unable to set exception ports, task_set_exception_ports"
1503 "returned: %d"),
1504 kret);
1507 void
1508 darwin_nat_target::kill ()
1510 struct inferior *inf = current_inferior ();
1511 darwin_inferior *priv = get_darwin_inferior (inf);
1512 struct target_waitstatus wstatus;
1513 ptid_t ptid;
1514 kern_return_t kret;
1515 int res;
1517 if (inferior_ptid == null_ptid)
1518 return;
1520 gdb_assert (inf != NULL);
1522 kret = darwin_restore_exception_ports (priv);
1523 MACH_CHECK_ERROR (kret);
1525 darwin_reply_to_all_pending_messages (inf);
1527 res = ::kill (inf->pid, 9);
1529 if (res == 0)
1531 /* On MacOS version Sierra, the darwin_restore_exception_ports call
1532 does not work as expected.
1533 When the kill function is called, the SIGKILL signal is received
1534 by gdb whereas it should have been received by the kernel since
1535 the exception ports have been restored.
1536 This behavior is not the expected one thus gdb does not reply to
1537 the received SIGKILL message. This situation leads to a "busy"
1538 resource from the kernel point of view and the inferior is never
1539 released, causing it to remain as a zombie process, even after
1540 GDB exits.
1541 To work around this, we mark all the threads of the inferior as
1542 signaled thus darwin_decode_message function knows that the kill
1543 signal was sent by gdb and will take the appropriate action
1544 (cancel signal and reply to the signal message). */
1545 for (darwin_thread_t *thread : priv->threads)
1546 thread->signaled = 1;
1548 darwin_resume_inferior (inf);
1550 ptid = wait_1 (ptid_t (inf->pid), &wstatus);
1552 else if (errno != ESRCH)
1553 warning (_("Failed to kill inferior: kill (%d, 9) returned [%s]"),
1554 inf->pid, safe_strerror (errno));
1556 target_mourn_inferior (ptid_t (inf->pid));
1559 static void
1560 darwin_setup_request_notification (struct inferior *inf)
1562 darwin_inferior *priv = get_darwin_inferior (inf);
1563 kern_return_t kret;
1564 mach_port_t prev_not;
1566 kret = mach_port_request_notification (gdb_task, priv->task,
1567 MACH_NOTIFY_DEAD_NAME, 0,
1568 priv->notify_port,
1569 MACH_MSG_TYPE_MAKE_SEND_ONCE,
1570 &prev_not);
1571 if (kret != KERN_SUCCESS)
1572 error (_("Termination notification request failed, "
1573 "mach_port_request_notification\n"
1574 "returned: %d"),
1575 kret);
1576 if (prev_not != MACH_PORT_NULL)
1578 /* This is unexpected, as there should not be any previously
1579 registered notification request. But this is not a fatal
1580 issue, so just emit a warning. */
1581 warning (_("\
1582 A task termination request was registered before the debugger registered\n\
1583 its own. This is unexpected, but should otherwise not have any actual\n\
1584 impact on the debugging session."));
1588 static void
1589 darwin_attach_pid (struct inferior *inf)
1591 kern_return_t kret;
1593 darwin_inferior *priv = new darwin_inferior;
1594 inf->priv.reset (priv);
1598 kret = task_for_pid (gdb_task, inf->pid, &priv->task);
1599 if (kret != KERN_SUCCESS)
1601 int status;
1603 if (!inf->attach_flag)
1605 kill (inf->pid, 9);
1606 waitpid (inf->pid, &status, 0);
1609 error
1610 (_("Unable to find Mach task port for process-id %d: %s (0x%lx).\n"
1611 " (please check gdb is codesigned - see taskgated(8))"),
1612 inf->pid, mach_error_string (kret), (unsigned long) kret);
1615 inferior_debug (2, _("inferior task: 0x%x, pid: %d\n"),
1616 priv->task, inf->pid);
1618 if (darwin_ex_port == MACH_PORT_NULL)
1620 /* Create a port to get exceptions. */
1621 kret = mach_port_allocate (gdb_task, MACH_PORT_RIGHT_RECEIVE,
1622 &darwin_ex_port);
1623 if (kret != KERN_SUCCESS)
1624 error (_("Unable to create exception port, mach_port_allocate "
1625 "returned: %d"),
1626 kret);
1628 kret = mach_port_insert_right (gdb_task, darwin_ex_port,
1629 darwin_ex_port,
1630 MACH_MSG_TYPE_MAKE_SEND);
1631 if (kret != KERN_SUCCESS)
1632 error (_("Unable to create exception port, mach_port_insert_right "
1633 "returned: %d"),
1634 kret);
1636 /* Create a port set and put ex_port in it. */
1637 kret = mach_port_allocate (gdb_task, MACH_PORT_RIGHT_PORT_SET,
1638 &darwin_port_set);
1639 if (kret != KERN_SUCCESS)
1640 error (_("Unable to create port set, mach_port_allocate "
1641 "returned: %d"),
1642 kret);
1644 kret = mach_port_move_member (gdb_task, darwin_ex_port,
1645 darwin_port_set);
1646 if (kret != KERN_SUCCESS)
1647 error (_("Unable to move exception port into new port set, "
1648 "mach_port_move_member\n"
1649 "returned: %d"),
1650 kret);
1653 /* Create a port to be notified when the child task terminates. */
1654 kret = mach_port_allocate (gdb_task, MACH_PORT_RIGHT_RECEIVE,
1655 &priv->notify_port);
1656 if (kret != KERN_SUCCESS)
1657 error (_("Unable to create notification port, mach_port_allocate "
1658 "returned: %d"),
1659 kret);
1661 kret = mach_port_move_member (gdb_task,
1662 priv->notify_port, darwin_port_set);
1663 if (kret != KERN_SUCCESS)
1664 error (_("Unable to move notification port into new port set, "
1665 "mach_port_move_member\n"
1666 "returned: %d"),
1667 kret);
1669 darwin_setup_request_notification (inf);
1671 darwin_setup_exceptions (inf);
1673 catch (const gdb_exception &ex)
1675 exit_inferior (inf);
1676 switch_to_no_thread ();
1678 throw;
1681 target_ops *darwin_ops = get_native_target ();
1682 if (!inf->target_is_pushed (darwin_ops))
1683 inf->push_target (darwin_ops);
1686 /* Get the thread_info object corresponding to this darwin_thread_info. */
1688 static struct thread_info *
1689 thread_info_from_private_thread_info (darwin_thread_info *pti)
1691 for (struct thread_info *it : all_threads ())
1693 darwin_thread_info *iter_pti = get_darwin_thread_info (it);
1695 if (iter_pti->gdb_port == pti->gdb_port)
1696 return it;
1699 gdb_assert_not_reached ("did not find gdb thread for darwin thread");
1702 void
1703 darwin_nat_target::init_thread_list (inferior *inf)
1705 check_new_threads (inf);
1707 darwin_inferior *priv = get_darwin_inferior (inf);
1709 gdb_assert (!priv->threads.empty ());
1711 darwin_thread_info *first_pti = priv->threads.front ();
1712 struct thread_info *first_thread
1713 = thread_info_from_private_thread_info (first_pti);
1715 switch_to_thread (first_thread);
1718 /* The child must synchronize with gdb: gdb must set the exception port
1719 before the child call PTRACE_SIGEXC. We use a pipe to achieve this.
1720 FIXME: is there a lighter way ? */
1721 static int ptrace_fds[2];
1723 static void
1724 darwin_ptrace_me (void)
1726 int res;
1727 char c;
1729 /* Close write end point. */
1730 if (close (ptrace_fds[1]) < 0)
1731 trace_start_error_with_name ("close");
1733 /* Wait until gdb is ready. */
1734 res = read (ptrace_fds[0], &c, 1);
1735 if (res != 0)
1736 trace_start_error (_("unable to read from pipe, read returned: %d"), res);
1738 if (close (ptrace_fds[0]) < 0)
1739 trace_start_error_with_name ("close");
1741 /* Get rid of privileges. */
1742 if (setegid (getgid ()) < 0)
1743 trace_start_error_with_name ("setegid");
1745 /* Set TRACEME. */
1746 if (PTRACE (PT_TRACE_ME, 0, 0, 0) < 0)
1747 trace_start_error_with_name ("PTRACE");
1749 /* Redirect signals to exception port. */
1750 if (PTRACE (PT_SIGEXC, 0, 0, 0) < 0)
1751 trace_start_error_with_name ("PTRACE");
1754 /* Dummy function to be sure fork_inferior uses fork(2) and not vfork(2). */
1755 static void
1756 darwin_pre_ptrace (void)
1758 if (pipe (ptrace_fds) != 0)
1760 ptrace_fds[0] = -1;
1761 ptrace_fds[1] = -1;
1762 error (_("unable to create a pipe: %s"), safe_strerror (errno));
1765 mark_fd_no_cloexec (ptrace_fds[0]);
1766 mark_fd_no_cloexec (ptrace_fds[1]);
1769 void
1770 darwin_nat_target::ptrace_him (int pid)
1772 struct inferior *inf = current_inferior ();
1774 darwin_attach_pid (inf);
1776 /* Let's the child run. */
1777 ::close (ptrace_fds[0]);
1778 ::close (ptrace_fds[1]);
1780 unmark_fd_no_cloexec (ptrace_fds[0]);
1781 unmark_fd_no_cloexec (ptrace_fds[1]);
1783 init_thread_list (inf);
1785 gdb_startup_inferior (pid, START_INFERIOR_TRAPS_EXPECTED);
1788 static void
1789 darwin_execvp (const char *file, char * const argv[], char * const env[])
1791 posix_spawnattr_t attr;
1792 short ps_flags = 0;
1793 int res;
1795 res = posix_spawnattr_init (&attr);
1796 if (res != 0)
1798 gdb_printf
1799 (gdb_stderr, "Cannot initialize attribute for posix_spawn\n");
1800 return;
1803 /* Do like execve: replace the image. */
1804 ps_flags = POSIX_SPAWN_SETEXEC;
1806 /* Disable ASLR. The constant doesn't look to be available outside the
1807 kernel include files. */
1808 #ifndef _POSIX_SPAWN_DISABLE_ASLR
1809 #define _POSIX_SPAWN_DISABLE_ASLR 0x0100
1810 #endif
1811 ps_flags |= _POSIX_SPAWN_DISABLE_ASLR;
1812 res = posix_spawnattr_setflags (&attr, ps_flags);
1813 if (res != 0)
1815 gdb_printf (gdb_stderr, "Cannot set posix_spawn flags\n");
1816 return;
1819 posix_spawnp (NULL, argv[0], NULL, &attr, argv, env);
1822 /* Read kernel version, and return TRUE if this host may have System
1823 Integrity Protection (Sierra or later). */
1825 static bool
1826 may_have_sip ()
1828 char str[16];
1829 size_t sz = sizeof (str);
1830 int ret;
1832 ret = sysctlbyname ("kern.osrelease", str, &sz, NULL, 0);
1833 if (ret == 0 && sz < sizeof (str))
1835 unsigned long ver = strtoul (str, NULL, 10);
1836 if (ver >= 16)
1837 return true;
1839 return false;
1842 /* A helper for maybe_cache_shell. This copies the shell to the
1843 cache. It will throw an exception on any failure. */
1845 static void
1846 copy_shell_to_cache (const char *shell, const std::string &new_name)
1848 scoped_fd from_fd = gdb_open_cloexec (shell, O_RDONLY, 0);
1849 if (from_fd.get () < 0)
1850 error (_("Could not open shell (%s) for reading: %s"),
1851 shell, safe_strerror (errno));
1853 std::string new_dir = ldirname (new_name.c_str ());
1854 if (!mkdir_recursive (new_dir.c_str ()))
1855 error (_("Could not make cache directory \"%s\": %s"),
1856 new_dir.c_str (), safe_strerror (errno));
1858 gdb::char_vector temp_name = make_temp_filename (new_name);
1859 scoped_fd to_fd = gdb_mkostemp_cloexec (&temp_name[0]);
1860 gdb::unlinker unlink_file_on_error (temp_name.data ());
1862 if (to_fd.get () < 0)
1863 error (_("Could not open temporary file \"%s\" for writing: %s"),
1864 temp_name.data (), safe_strerror (errno));
1866 if (fcopyfile (from_fd.get (), to_fd.get (), nullptr,
1867 COPYFILE_STAT | COPYFILE_DATA) != 0)
1868 error (_("Could not copy shell to cache as \"%s\": %s"),
1869 temp_name.data (), safe_strerror (errno));
1871 /* Be sure that the caching is atomic so that we don't get bad
1872 results from multiple copies of gdb running at the same time. */
1873 if (rename (temp_name.data (), new_name.c_str ()) != 0)
1874 error (_("Could not rename shell cache file to \"%s\": %s"),
1875 new_name.c_str (), safe_strerror (errno));
1877 unlink_file_on_error.keep ();
1880 /* If $SHELL is restricted, try to cache a copy. Starting with El
1881 Capitan, macOS introduced System Integrity Protection. Among other
1882 things, this prevents certain executables from being ptrace'd. In
1883 particular, executables in /bin, like most shells, are affected.
1884 To work around this, while preserving command-line glob expansion
1885 and redirections, gdb will cache a copy of the shell. Return true
1886 if all is well -- either the shell is not subject to SIP or it has
1887 been successfully cached. Returns false if something failed. */
1889 static bool
1890 maybe_cache_shell ()
1892 /* SF_RESTRICTED is defined in sys/stat.h and lets us determine if a
1893 given file is subject to SIP. */
1894 #ifdef SF_RESTRICTED
1896 /* If a check fails we want to revert -- maybe the user deleted the
1897 cache while gdb was running, or something like that. */
1898 copied_shell = nullptr;
1900 const char *shell = get_shell ();
1901 if (!IS_ABSOLUTE_PATH (shell))
1903 warning (_("This version of macOS has System Integrity Protection.\n\
1904 Normally gdb would try to work around this by caching a copy of your shell,\n\
1905 but because your shell (%s) is not an absolute path, this is being skipped."),
1906 shell);
1907 return false;
1910 struct stat sb;
1911 if (stat (shell, &sb) < 0)
1913 warning (_("This version of macOS has System Integrity Protection.\n\
1914 Normally gdb would try to work around this by caching a copy of your shell,\n\
1915 but because gdb could not stat your shell (%s), this is being skipped.\n\
1916 The error was: %s"),
1917 shell, safe_strerror (errno));
1918 return false;
1921 if ((sb.st_flags & SF_RESTRICTED) == 0)
1922 return true;
1924 /* Put the copy somewhere like ~/Library/Caches/gdb/bin/sh. */
1925 std::string new_name = get_standard_cache_dir ();
1926 /* There's no need to insert a directory separator here, because
1927 SHELL is known to be absolute. */
1928 new_name.append (shell);
1930 /* Maybe it was cached by some earlier gdb. */
1931 if (stat (new_name.c_str (), &sb) != 0 || !S_ISREG (sb.st_mode))
1935 copy_shell_to_cache (shell, new_name);
1937 catch (const gdb_exception_error &ex)
1939 warning (_("This version of macOS has System Integrity Protection.\n\
1940 Because `startup-with-shell' is enabled, gdb tried to work around SIP by\n\
1941 caching a copy of your shell. However, this failed:\n\
1942 %s\n\
1943 If you correct the problem, gdb will automatically try again the next time\n\
1944 you \"run\". To prevent these attempts, you can use:\n\
1945 set startup-with-shell off"),
1946 ex.what ());
1947 return false;
1950 gdb_printf (_("Note: this version of macOS has System Integrity Protection.\n\
1951 Because `startup-with-shell' is enabled, gdb has worked around this by\n\
1952 caching a copy of your shell. The shell used by \"run\" is now:\n\
1953 %s\n"),
1954 new_name.c_str ());
1957 /* We need to make sure that the new name has the correct lifetime. */
1958 static std::string saved_shell = std::move (new_name);
1959 copied_shell = saved_shell.c_str ();
1961 #endif /* SF_RESTRICTED */
1963 return true;
1966 void
1967 darwin_nat_target::create_inferior (const char *exec_file,
1968 const std::string &allargs,
1969 char **env, int from_tty)
1971 std::optional<scoped_restore_tmpl<bool>> restore_startup_with_shell;
1972 darwin_nat_target *the_target = this;
1974 if (startup_with_shell && may_have_sip ())
1976 if (!maybe_cache_shell ())
1978 warning (_("startup-with-shell is now temporarily disabled"));
1979 restore_startup_with_shell.emplace (&startup_with_shell, 0);
1983 /* Do the hard work. */
1984 fork_inferior (exec_file, allargs, env, darwin_ptrace_me,
1985 [the_target] (int pid)
1987 the_target->ptrace_him (pid);
1989 darwin_pre_ptrace, copied_shell,
1990 darwin_execvp);
1994 /* Set things up such that the next call to darwin_wait will immediately
1995 return a fake stop event for inferior INF.
1997 This assumes that the inferior's thread list has been initialized,
1998 as it will suspend the inferior's first thread. */
2000 static void
2001 darwin_setup_fake_stop_event (struct inferior *inf)
2003 darwin_inferior *priv = get_darwin_inferior (inf);
2004 darwin_thread_t *thread;
2005 kern_return_t kret;
2007 gdb_assert (darwin_inf_fake_stop == NULL);
2008 darwin_inf_fake_stop = inf;
2010 /* When detecting a fake pending stop event, darwin_wait returns
2011 an event saying that the first thread is in a DARWIN_STOPPED
2012 state. To make that accurate, we need to suspend that thread
2013 as well. Otherwise, we'll try resuming it when resuming the
2014 inferior, and get a warning because the thread's suspend count
2015 is already zero, making the resume request useless. */
2016 thread = priv->threads[0];
2017 kret = thread_suspend (thread->gdb_port);
2018 MACH_CHECK_ERROR (kret);
2021 /* Attach to process PID, then initialize for debugging it
2022 and wait for the trace-trap that results from attaching. */
2023 void
2024 darwin_nat_target::attach (const char *args, int from_tty)
2026 pid_t pid;
2027 struct inferior *inf;
2029 pid = parse_pid_to_attach (args);
2031 if (pid == getpid ()) /* Trying to masturbate? */
2032 error (_("I refuse to debug myself!"));
2034 target_announce_attach (from_tty, pid);
2036 if (pid == 0 || ::kill (pid, 0) < 0)
2037 error (_("Can't attach to process %d: %s (%d)"),
2038 pid, safe_strerror (errno), errno);
2040 inf = current_inferior ();
2041 inferior_appeared (inf, pid);
2042 inf->attach_flag = true;
2044 darwin_attach_pid (inf);
2046 darwin_suspend_inferior (inf);
2048 init_thread_list (inf);
2050 darwin_inferior *priv = get_darwin_inferior (inf);
2052 darwin_check_osabi (priv, inferior_ptid.tid ());
2054 darwin_setup_fake_stop_event (inf);
2056 priv->no_ptrace = 1;
2059 /* Take a program previously attached to and detaches it.
2060 The program resumes execution and will no longer stop
2061 on signals, etc. We'd better not have left any breakpoints
2062 in the program or it'll die when it hits one. For this
2063 to work, it may be necessary for the process to have been
2064 previously attached. It *might* work if the program was
2065 started via fork. */
2067 void
2068 darwin_nat_target::detach (inferior *inf, int from_tty)
2070 darwin_inferior *priv = get_darwin_inferior (inf);
2071 kern_return_t kret;
2072 int res;
2074 /* Display message. */
2075 target_announce_detach (from_tty);
2077 /* If ptrace() is in use, stop the process. */
2078 if (!priv->no_ptrace)
2079 stop_inferior (inf);
2081 kret = darwin_restore_exception_ports (priv);
2082 MACH_CHECK_ERROR (kret);
2084 if (!priv->no_ptrace)
2086 res = PTRACE (PT_DETACH, inf->pid, 0, 0);
2087 if (res != 0)
2088 warning (_("Unable to detach from process-id %d: %s (%d)"),
2089 inf->pid, safe_strerror (errno), errno);
2092 darwin_reply_to_all_pending_messages (inf);
2094 /* When using ptrace, we have just performed a PT_DETACH, which
2095 resumes the inferior. On the other hand, when we are not using
2096 ptrace, we need to resume its execution ourselves. */
2097 if (priv->no_ptrace)
2098 darwin_resume_inferior (inf);
2100 mourn_inferior ();
2103 std::string
2104 darwin_nat_target::pid_to_str (ptid_t ptid)
2106 long tid = ptid.tid ();
2108 if (tid != 0)
2109 return string_printf (_("Thread 0x%lx of process %u"),
2110 tid, ptid.pid ());
2112 return normal_pid_to_str (ptid);
2115 bool
2116 darwin_nat_target::thread_alive (ptid_t ptid)
2118 return true;
2121 /* If RDADDR is not NULL, read inferior task's LEN bytes from ADDR and
2122 copy it to RDADDR in gdb's address space.
2123 If WRADDR is not NULL, write gdb's LEN bytes from WRADDR and copy it
2124 to ADDR in inferior task's address space.
2125 Return 0 on failure; number of bytes read / written otherwise. */
2127 static int
2128 darwin_read_write_inferior (task_t task, CORE_ADDR addr,
2129 gdb_byte *rdaddr, const gdb_byte *wraddr,
2130 ULONGEST length)
2132 kern_return_t kret;
2133 mach_vm_size_t res_length = 0;
2135 inferior_debug (8, _("darwin_read_write_inferior(task=0x%x, %s, len=%s)\n"),
2136 task, core_addr_to_string (addr), pulongest (length));
2138 /* First read. */
2139 if (rdaddr != NULL)
2141 mach_vm_size_t count;
2143 /* According to target.h(to_xfer_partial), one and only one may be
2144 non-null. */
2145 gdb_assert (wraddr == NULL);
2147 kret = mach_vm_read_overwrite (task, addr, length,
2148 (mach_vm_address_t) rdaddr, &count);
2149 if (kret != KERN_SUCCESS)
2151 inferior_debug
2152 (1, _("darwin_read_write_inferior: mach_vm_read failed at %s: %s"),
2153 core_addr_to_string (addr), mach_error_string (kret));
2154 return 0;
2156 return count;
2159 /* See above. */
2160 gdb_assert (wraddr != NULL);
2162 while (length != 0)
2164 mach_vm_address_t offset = addr & (mach_page_size - 1);
2165 mach_vm_address_t region_address = (mach_vm_address_t) (addr - offset);
2166 mach_vm_size_t aligned_length =
2167 (mach_vm_size_t) PAGE_ROUND (offset + length);
2168 vm_region_submap_short_info_data_64_t info;
2169 mach_msg_type_number_t count = VM_REGION_SUBMAP_SHORT_INFO_COUNT_64;
2170 natural_t region_depth = 1000;
2171 mach_vm_address_t region_start = region_address;
2172 mach_vm_size_t region_length;
2173 mach_vm_size_t write_length;
2175 /* Read page protection. */
2176 kret = mach_vm_region_recurse
2177 (task, &region_start, &region_length, &region_depth,
2178 (vm_region_recurse_info_t) &info, &count);
2180 if (kret != KERN_SUCCESS)
2182 inferior_debug (1, _("darwin_read_write_inferior: "
2183 "mach_vm_region_recurse failed at %s: %s\n"),
2184 core_addr_to_string (region_address),
2185 mach_error_string (kret));
2186 return res_length;
2189 inferior_debug
2190 (9, _("darwin_read_write_inferior: "
2191 "mach_vm_region_recurse addr=%s, start=%s, len=%s\n"),
2192 core_addr_to_string (region_address),
2193 core_addr_to_string (region_start),
2194 core_addr_to_string (region_length));
2196 /* Check for holes in memory. */
2197 if (region_start > region_address)
2199 warning (_("No memory at %s (vs %s+0x%x). Nothing written"),
2200 core_addr_to_string (region_address),
2201 core_addr_to_string (region_start),
2202 (unsigned)region_length);
2203 return res_length;
2206 /* Adjust the length. */
2207 region_length -= (region_address - region_start);
2208 if (region_length > aligned_length)
2209 region_length = aligned_length;
2211 /* Make the pages RW. */
2212 if (!(info.protection & VM_PROT_WRITE))
2214 vm_prot_t prot = VM_PROT_READ | VM_PROT_WRITE;
2216 kret = mach_vm_protect (task, region_address, region_length,
2217 FALSE, prot);
2218 if (kret != KERN_SUCCESS)
2220 prot |= VM_PROT_COPY;
2221 kret = mach_vm_protect (task, region_address, region_length,
2222 FALSE, prot);
2224 if (kret != KERN_SUCCESS)
2226 warning (_("darwin_read_write_inferior: "
2227 "mach_vm_protect failed at %s "
2228 "(len=0x%lx, prot=0x%x): %s"),
2229 core_addr_to_string (region_address),
2230 (unsigned long) region_length, (unsigned) prot,
2231 mach_error_string (kret));
2232 return res_length;
2236 if (offset + length > region_length)
2237 write_length = region_length - offset;
2238 else
2239 write_length = length;
2241 /* Write. */
2242 kret = mach_vm_write (task, addr, (vm_offset_t) wraddr, write_length);
2243 if (kret != KERN_SUCCESS)
2245 warning (_("darwin_read_write_inferior: mach_vm_write failed: %s"),
2246 mach_error_string (kret));
2247 return res_length;
2250 /* Restore page rights. */
2251 if (!(info.protection & VM_PROT_WRITE))
2253 kret = mach_vm_protect (task, region_address, region_length,
2254 FALSE, info.protection);
2255 if (kret != KERN_SUCCESS)
2257 warning (_("darwin_read_write_inferior: "
2258 "mach_vm_protect restore failed at %s "
2259 "(len=0x%lx): %s"),
2260 core_addr_to_string (region_address),
2261 (unsigned long) region_length,
2262 mach_error_string (kret));
2266 addr += write_length;
2267 wraddr += write_length;
2268 res_length += write_length;
2269 length -= write_length;
2272 return res_length;
2275 /* Read LENGTH bytes at offset ADDR of task_dyld_info for TASK, and copy them
2276 to RDADDR (in big endian).
2277 Return 0 on failure; number of bytes read / written otherwise. */
2279 #ifdef TASK_DYLD_INFO_COUNT
2280 /* This is not available in Darwin 9. */
2281 static enum target_xfer_status
2282 darwin_read_dyld_info (task_t task, CORE_ADDR addr, gdb_byte *rdaddr,
2283 ULONGEST length, ULONGEST *xfered_len)
2285 struct task_dyld_info task_dyld_info;
2286 mach_msg_type_number_t count = TASK_DYLD_INFO_COUNT;
2287 kern_return_t kret;
2289 if (addr != 0 || length > sizeof (mach_vm_address_t))
2290 return TARGET_XFER_EOF;
2292 kret = task_info (task, TASK_DYLD_INFO,
2293 (task_info_t) &task_dyld_info, &count);
2294 MACH_CHECK_ERROR (kret);
2295 if (kret != KERN_SUCCESS)
2296 return TARGET_XFER_E_IO;
2298 store_unsigned_integer (rdaddr, length, BFD_ENDIAN_BIG,
2299 task_dyld_info.all_image_info_addr);
2300 *xfered_len = (ULONGEST) length;
2301 return TARGET_XFER_OK;
2303 #endif
2307 enum target_xfer_status
2308 darwin_nat_target::xfer_partial (enum target_object object, const char *annex,
2309 gdb_byte *readbuf, const gdb_byte *writebuf,
2310 ULONGEST offset, ULONGEST len,
2311 ULONGEST *xfered_len)
2313 struct inferior *inf = current_inferior ();
2314 darwin_inferior *priv = get_darwin_inferior (inf);
2316 inferior_debug
2317 (8, _("darwin_xfer_partial(%s, %s, rbuf=%s, wbuf=%s) pid=%u\n"),
2318 core_addr_to_string (offset), pulongest (len),
2319 host_address_to_string (readbuf), host_address_to_string (writebuf),
2320 inf->pid);
2322 switch (object)
2324 case TARGET_OBJECT_MEMORY:
2326 int l = darwin_read_write_inferior (priv->task, offset,
2327 readbuf, writebuf, len);
2329 if (l == 0)
2330 return TARGET_XFER_EOF;
2331 else
2333 gdb_assert (l > 0);
2334 *xfered_len = (ULONGEST) l;
2335 return TARGET_XFER_OK;
2338 #ifdef TASK_DYLD_INFO_COUNT
2339 case TARGET_OBJECT_DARWIN_DYLD_INFO:
2340 if (writebuf != NULL || readbuf == NULL)
2342 /* Support only read. */
2343 return TARGET_XFER_E_IO;
2345 return darwin_read_dyld_info (priv->task, offset, readbuf, len,
2346 xfered_len);
2347 #endif
2348 default:
2349 return TARGET_XFER_E_IO;
2354 static void
2355 set_enable_mach_exceptions (const char *args, int from_tty,
2356 struct cmd_list_element *c)
2358 if (inferior_ptid != null_ptid)
2360 struct inferior *inf = current_inferior ();
2361 darwin_inferior *priv = get_darwin_inferior (inf);
2362 exception_mask_t mask;
2363 kern_return_t kret;
2365 if (enable_mach_exceptions)
2366 mask = EXC_MASK_ALL;
2367 else
2369 darwin_restore_exception_ports (priv);
2370 mask = EXC_MASK_SOFTWARE | EXC_MASK_BREAKPOINT;
2372 kret = task_set_exception_ports (priv->task, mask, darwin_ex_port,
2373 EXCEPTION_DEFAULT, THREAD_STATE_NONE);
2374 MACH_CHECK_ERROR (kret);
2378 const char *
2379 darwin_nat_target::pid_to_exec_file (int pid)
2381 static char path[PATH_MAX];
2382 int res;
2384 res = proc_pidinfo (pid, PROC_PIDPATHINFO, 0, path, PATH_MAX);
2385 if (res >= 0)
2386 return path;
2387 else
2388 return NULL;
2391 ptid_t
2392 darwin_nat_target::get_ada_task_ptid (long lwp, ULONGEST thread)
2394 struct inferior *inf = current_inferior ();
2395 darwin_inferior *priv = get_darwin_inferior (inf);
2396 kern_return_t kret;
2397 mach_port_name_array_t names;
2398 mach_msg_type_number_t names_count;
2399 mach_port_type_array_t types;
2400 mach_msg_type_number_t types_count;
2401 long res = 0;
2403 /* First linear search. */
2404 for (darwin_thread_t *t : priv->threads)
2406 if (t->inf_port == lwp)
2407 return ptid_t (inferior_ptid.pid (), 0, t->gdb_port);
2410 /* Maybe the port was never extract. Do it now. */
2412 /* First get inferior port names. */
2413 kret = mach_port_names (priv->task, &names, &names_count, &types,
2414 &types_count);
2415 MACH_CHECK_ERROR (kret);
2416 if (kret != KERN_SUCCESS)
2417 return null_ptid;
2419 /* For each name, copy the right in the gdb space and then compare with
2420 our view of the inferior threads. We don't forget to deallocate the
2421 right. */
2422 for (int i = 0; i < names_count; i++)
2424 mach_port_t local_name;
2425 mach_msg_type_name_t local_type;
2427 /* We just need to know the corresponding name in gdb name space.
2428 So extract and deallocate the right. */
2429 kret = mach_port_extract_right (priv->task, names[i],
2430 MACH_MSG_TYPE_COPY_SEND,
2431 &local_name, &local_type);
2432 if (kret != KERN_SUCCESS)
2433 continue;
2434 mach_port_deallocate (gdb_task, local_name);
2436 for (darwin_thread_t *t : priv->threads)
2438 if (t->gdb_port == local_name)
2440 t->inf_port = names[i];
2441 if (names[i] == lwp)
2442 res = t->gdb_port;
2447 vm_deallocate (gdb_task, (vm_address_t) names,
2448 names_count * sizeof (mach_port_t));
2450 if (res)
2451 return ptid_t (current_inferior ()->pid, 0, res);
2452 else
2453 return null_ptid;
2456 bool
2457 darwin_nat_target::supports_multi_process ()
2459 return true;
2462 void _initialize_darwin_nat ();
2463 void
2464 _initialize_darwin_nat ()
2466 kern_return_t kret;
2468 gdb_task = mach_task_self ();
2469 darwin_host_self = mach_host_self ();
2471 /* Read page size. */
2472 kret = host_page_size (darwin_host_self, &mach_page_size);
2473 if (kret != KERN_SUCCESS)
2475 mach_page_size = 0x1000;
2476 MACH_CHECK_ERROR (kret);
2479 inferior_debug (2, _("GDB task: 0x%lx, pid: %d\n"),
2480 (unsigned long) mach_task_self (), getpid ());
2482 add_setshow_zuinteger_cmd ("darwin", class_obscure,
2483 &darwin_debug_flag, _("\
2484 Set if printing inferior communication debugging statements."), _("\
2485 Show if printing inferior communication debugging statements."), NULL,
2486 NULL, NULL,
2487 &setdebuglist, &showdebuglist);
2489 add_setshow_boolean_cmd ("mach-exceptions", class_support,
2490 &enable_mach_exceptions, _("\
2491 Set if mach exceptions are caught."), _("\
2492 Show if mach exceptions are caught."), _("\
2493 When this mode is on, all low level exceptions are reported before being\n\
2494 reported by the kernel."),
2495 &set_enable_mach_exceptions, NULL,
2496 &setlist, &showlist);