1 //===-- DNB.cpp -------------------------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 //  Created by Greg Clayton on 3/23/07.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "DNB.h"
15 #include <inttypes.h>
16 #include <signal.h>
17 #include <stdio.h>
18 #include <stdlib.h>
19 #include <sys/resource.h>
20 #include <sys/stat.h>
21 #include <sys/types.h>
22 #include <sys/wait.h>
23 #include <unistd.h>
24 #include <sys/sysctl.h>
25 #include <map>
26 #include <vector>
27 #include <libproc.h>
28 
29 #if defined (__APPLE__)
30 #include <pthread.h>
31 #include <sched.h>
32 #endif
33 
34 #define TRY_KQUEUE 1
35 
36 #ifdef TRY_KQUEUE
37     #include <sys/event.h>
38     #include <sys/time.h>
39     #ifdef NOTE_EXIT_DETAIL
40         #define USE_KQUEUE
41     #endif
42 #endif
43 
44 #include "MacOSX/MachProcess.h"
45 #include "MacOSX/MachTask.h"
46 #include "MacOSX/Genealogy.h"
47 #include "MacOSX/ThreadInfo.h"
48 #include "CFString.h"
49 #include "DNBLog.h"
50 #include "DNBDataRef.h"
51 #include "DNBThreadResumeActions.h"
52 #include "DNBTimer.h"
53 #include "CFBundle.h"
54 
55 
56 typedef std::shared_ptr<MachProcess> MachProcessSP;
57 typedef std::map<nub_process_t, MachProcessSP> ProcessMap;
58 typedef ProcessMap::iterator ProcessMapIter;
59 typedef ProcessMap::const_iterator ProcessMapConstIter;
60 
61 size_t GetAllInfos (std::vector<struct kinfo_proc>& proc_infos);
62 static size_t GetAllInfosMatchingName (const char *process_name, std::vector<struct kinfo_proc>& matching_proc_infos);
63 
64 //----------------------------------------------------------------------
65 // A Thread safe singleton to get a process map pointer.
66 //
67 // Returns a pointer to the existing process map, or a pointer to a
68 // newly created process map if CAN_CREATE is non-zero.
69 //----------------------------------------------------------------------
70 static ProcessMap*
71 GetProcessMap(bool can_create)
72 {
73     static ProcessMap* g_process_map_ptr = NULL;
74 
75     if (can_create && g_process_map_ptr == NULL)
76     {
77         static pthread_mutex_t g_process_map_mutex = PTHREAD_MUTEX_INITIALIZER;
78         PTHREAD_MUTEX_LOCKER (locker, &g_process_map_mutex);
79         if (g_process_map_ptr == NULL)
80             g_process_map_ptr = new ProcessMap;
81     }
82     return g_process_map_ptr;
83 }
84 
85 //----------------------------------------------------------------------
86 // Add PID to the shared process pointer map.
87 //
88 // Return non-zero value if we succeed in adding the process to the map.
89 // The only time this should fail is if we run out of memory and can't
90 // allocate a ProcessMap.
91 //----------------------------------------------------------------------
92 static nub_bool_t
93 AddProcessToMap (nub_process_t pid, MachProcessSP& procSP)
94 {
95     ProcessMap* process_map = GetProcessMap(true);
96     if (process_map)
97     {
98         process_map->insert(std::make_pair(pid, procSP));
99         return true;
100     }
101     return false;
102 }
103 
104 //----------------------------------------------------------------------
105 // Remove the shared pointer for PID from the process map.
106 //
107 // Returns the number of items removed from the process map.
108 //----------------------------------------------------------------------
109 //static size_t
110 //RemoveProcessFromMap (nub_process_t pid)
111 //{
112 //    ProcessMap* process_map = GetProcessMap(false);
113 //    if (process_map)
114 //    {
115 //        return process_map->erase(pid);
116 //    }
117 //    return 0;
118 //}
119 
120 //----------------------------------------------------------------------
121 // Get the shared pointer for PID from the existing process map.
122 //
123 // Returns true if we successfully find a shared pointer to a
124 // MachProcess object.
125 //----------------------------------------------------------------------
126 static nub_bool_t
127 GetProcessSP (nub_process_t pid, MachProcessSP& procSP)
128 {
129     ProcessMap* process_map = GetProcessMap(false);
130     if (process_map != NULL)
131     {
132         ProcessMapIter pos = process_map->find(pid);
133         if (pos != process_map->end())
134         {
135             procSP = pos->second;
136             return true;
137         }
138     }
139     procSP.reset();
140     return false;
141 }
142 
143 #ifdef USE_KQUEUE
144 void *
145 kqueue_thread (void *arg)
146 {
147     int kq_id = (int) (intptr_t) arg;
148 
149 #if defined (__APPLE__)
150     pthread_setname_np ("kqueue thread");
151 #if defined (__arm__) || defined (__arm64__) || defined (__aarch64__)
152     struct sched_param thread_param;
153     int thread_sched_policy;
154     if (pthread_getschedparam(pthread_self(), &thread_sched_policy, &thread_param) == 0)
155     {
156         thread_param.sched_priority = 47;
157         pthread_setschedparam(pthread_self(), thread_sched_policy, &thread_param);
158     }
159 #endif
160 #endif
161 
162     struct kevent death_event;
163     while (1)
164     {
165         int n_events = kevent (kq_id, NULL, 0, &death_event, 1, NULL);
166         if (n_events == -1)
167         {
168             if (errno == EINTR)
169                 continue;
170             else
171             {
172                 DNBLogError ("kqueue failed with error: (%d): %s", errno, strerror(errno));
173                 return NULL;
174             }
175         }
176         else if (death_event.flags & EV_ERROR)
177         {
178             int error_no = static_cast<int>(death_event.data);
179             const char *error_str = strerror(error_no);
180             if (error_str == NULL)
181                 error_str = "Unknown error";
182             DNBLogError ("Failed to initialize kqueue event: (%d): %s", error_no, error_str );
183             return NULL;
184         }
185         else
186         {
187             int status;
188             const pid_t pid = (pid_t)death_event.ident;
189             const pid_t child_pid = waitpid (pid, &status, 0);
190 
191 
192             bool exited = false;
193             int signal = 0;
194             int exit_status = 0;
195             if (WIFSTOPPED(status))
196             {
197                 signal = WSTOPSIG(status);
198                 DNBLogThreadedIf(LOG_PROCESS, "waitpid (%i) -> STOPPED (signal = %i)", child_pid, signal);
199             }
200             else if (WIFEXITED(status))
201             {
202                 exit_status = WEXITSTATUS(status);
203                 exited = true;
204                 DNBLogThreadedIf(LOG_PROCESS, "waitpid (%i) -> EXITED (status = %i)", child_pid, exit_status);
205             }
206             else if (WIFSIGNALED(status))
207             {
208                 signal = WTERMSIG(status);
209                 if (child_pid == abs(pid))
210                 {
211                     DNBLogThreadedIf(LOG_PROCESS, "waitpid (%i) -> SIGNALED and EXITED (signal = %i)", child_pid, signal);
212                     char exit_info[64];
213                     ::snprintf (exit_info, sizeof(exit_info), "Terminated due to signal %i", signal);
214                     DNBProcessSetExitInfo (child_pid, exit_info);
215                     exited = true;
216                     exit_status = INT8_MAX;
217                 }
218                 else
219                 {
220                     DNBLogThreadedIf(LOG_PROCESS, "waitpid (%i) -> SIGNALED (signal = %i)", child_pid, signal);
221                 }
222             }
223 
224             if (exited)
225             {
226                 if (death_event.data & NOTE_EXIT_MEMORY)
227                     DNBProcessSetExitInfo (child_pid, "Terminated due to memory issue");
228                 else if (death_event.data & NOTE_EXIT_DECRYPTFAIL)
229                     DNBProcessSetExitInfo (child_pid, "Terminated due to decrypt failure");
230                 else if (death_event.data & NOTE_EXIT_CSERROR)
231                     DNBProcessSetExitInfo (child_pid, "Terminated due to code signing error");
232 
233                 DNBLogThreadedIf(LOG_PROCESS, "waitpid_process_thread (): setting exit status for pid = %i to %i", child_pid, exit_status);
234                 DNBProcessSetExitStatus (child_pid, status);
235                 return NULL;
236             }
237         }
238     }
239 }
240 
241 static bool
242 spawn_kqueue_thread (pid_t pid)
243 {
244     pthread_t thread;
245     int kq_id;
246 
247     kq_id = kqueue();
248     if (kq_id == -1)
249     {
250         DNBLogError ("Could not get kqueue for pid = %i.", pid);
251         return false;
252     }
253 
254     struct kevent reg_event;
255 
256     EV_SET(&reg_event, pid, EVFILT_PROC, EV_ADD, NOTE_EXIT|NOTE_EXITSTATUS|NOTE_EXIT_DETAIL, 0, NULL);
257     // Register the event:
258     int result = kevent (kq_id, &reg_event, 1, NULL, 0, NULL);
259     if (result != 0)
260     {
261         DNBLogError ("Failed to register kqueue NOTE_EXIT event for pid %i, error: %d.", pid, result);
262         return false;
263     }
264 
265     int ret = ::pthread_create (&thread, NULL, kqueue_thread, (void *)(intptr_t)kq_id);
266 
267     // pthread_create returns 0 if successful
268     if (ret == 0)
269     {
270         ::pthread_detach (thread);
271         return true;
272     }
273     return false;
274 }
275 #endif // #if USE_KQUEUE
276 
277 static void *
278 waitpid_thread (void *arg)
279 {
280     const pid_t pid = (pid_t)(intptr_t)arg;
281     int status;
282 
283 #if defined (__APPLE__)
284     pthread_setname_np ("waitpid thread");
285 #if defined (__arm__) || defined (__arm64__) || defined (__aarch64__)
286     struct sched_param thread_param;
287     int thread_sched_policy;
288     if (pthread_getschedparam(pthread_self(), &thread_sched_policy, &thread_param) == 0)
289     {
290         thread_param.sched_priority = 47;
291         pthread_setschedparam(pthread_self(), thread_sched_policy, &thread_param);
292     }
293 #endif
294 #endif
295 
296     while (1)
297     {
298         pid_t child_pid = waitpid(pid, &status, 0);
299         DNBLogThreadedIf(LOG_PROCESS, "waitpid_thread (): waitpid (pid = %i, &status, 0) => %i, status = %i, errno = %i", pid, child_pid, status, errno);
300 
301         if (child_pid < 0)
302         {
303             if (errno == EINTR)
304                 continue;
305             break;
306         }
307         else
308         {
309             if (WIFSTOPPED(status))
310             {
311                 continue;
312             }
313             else// if (WIFEXITED(status) || WIFSIGNALED(status))
314             {
315                 DNBLogThreadedIf(LOG_PROCESS, "waitpid_thread (): setting exit status for pid = %i to %i", child_pid, status);
316                 DNBProcessSetExitStatus (child_pid, status);
317                 return NULL;
318             }
319         }
320     }
321 
322     // We should never exit as long as our child process is alive, so if we
323     // do something else went wrong and we should exit...
324     DNBLogThreadedIf(LOG_PROCESS, "waitpid_thread (): main loop exited, setting exit status to an invalid value (-1) for pid %i", pid);
325     DNBProcessSetExitStatus (pid, -1);
326     return NULL;
327 }
328 static bool
329 spawn_waitpid_thread (pid_t pid)
330 {
331 #ifdef USE_KQUEUE
332     bool success = spawn_kqueue_thread (pid);
333     if (success)
334         return true;
335 #endif
336 
337     pthread_t thread;
338     int ret = ::pthread_create (&thread, NULL, waitpid_thread, (void *)(intptr_t)pid);
339     // pthread_create returns 0 if successful
340     if (ret == 0)
341     {
342         ::pthread_detach (thread);
343         return true;
344     }
345     return false;
346 }
347 
348 nub_process_t
349 DNBProcessLaunch (const char *path,
350                   char const *argv[],
351                   const char *envp[],
352                   const char *working_directory, // NULL => don't change, non-NULL => set working directory for inferior to this
353                   const char *stdin_path,
354                   const char *stdout_path,
355                   const char *stderr_path,
356                   bool no_stdio,
357                   nub_launch_flavor_t launch_flavor,
358                   int disable_aslr,
359                   const char *event_data,
360                   char *err_str,
361                   size_t err_len)
362 {
363     DNBLogThreadedIf(LOG_PROCESS, "%s ( path='%s', argv = %p, envp = %p, working_dir=%s, stdin=%s, stdout=%s, stderr=%s, no-stdio=%i, launch_flavor = %u, disable_aslr = %d, err = %p, err_len = %llu) called...",
364                      __FUNCTION__,
365                      path,
366                      argv,
367                      envp,
368                      working_directory,
369                      stdin_path,
370                      stdout_path,
371                      stderr_path,
372                      no_stdio,
373                      launch_flavor,
374                      disable_aslr,
375                      err_str,
376                      (uint64_t)err_len);
377 
378     if (err_str && err_len > 0)
379         err_str[0] = '\0';
380     struct stat path_stat;
381     if (::stat(path, &path_stat) == -1)
382     {
383         char stat_error[256];
384         ::strerror_r (errno, stat_error, sizeof(stat_error));
385         snprintf(err_str, err_len, "%s (%s)", stat_error, path);
386         return INVALID_NUB_PROCESS;
387     }
388 
389     MachProcessSP processSP (new MachProcess);
390     if (processSP.get())
391     {
392         DNBError launch_err;
393         pid_t pid = processSP->LaunchForDebug (path,
394                                                argv,
395                                                envp,
396                                                working_directory,
397                                                stdin_path,
398                                                stdout_path,
399                                                stderr_path,
400                                                no_stdio,
401                                                launch_flavor,
402                                                disable_aslr,
403                                                event_data,
404                                                launch_err);
405         if (err_str)
406         {
407             *err_str = '\0';
408             if (launch_err.Fail())
409             {
410                 const char *launch_err_str = launch_err.AsString();
411                 if (launch_err_str)
412                 {
413                     strncpy(err_str, launch_err_str, err_len-1);
414                     err_str[err_len-1] = '\0';  // Make sure the error string is terminated
415                 }
416             }
417         }
418 
419         DNBLogThreadedIf(LOG_PROCESS, "(DebugNub) new pid is %d...", pid);
420 
421         if (pid != INVALID_NUB_PROCESS)
422         {
423             // Spawn a thread to reap our child inferior process...
424             spawn_waitpid_thread (pid);
425 
426             if (processSP->Task().TaskPortForProcessID (launch_err) == TASK_NULL)
427             {
428                 // We failed to get the task for our process ID which is bad.
429                 // Kill our process otherwise it will be stopped at the entry
430                 // point and get reparented to someone else and never go away.
431                 DNBLog ("Could not get task port for process, sending SIGKILL and exiting.");
432                 kill (SIGKILL, pid);
433 
434                 if (err_str && err_len > 0)
435                 {
436                     if (launch_err.AsString())
437                     {
438                         ::snprintf (err_str, err_len, "failed to get the task for process %i (%s)", pid, launch_err.AsString());
439                     }
440                     else
441                     {
442                         ::snprintf (err_str, err_len, "failed to get the task for process %i", pid);
443                     }
444                 }
445             }
446             else
447             {
448                 bool res = AddProcessToMap(pid, processSP);
449                 assert(res && "Couldn't add process to map!");
450                 return pid;
451             }
452         }
453     }
454     return INVALID_NUB_PROCESS;
455 }
456 
457 nub_process_t
458 DNBProcessAttachByName (const char *name, struct timespec *timeout, char *err_str, size_t err_len)
459 {
460     if (err_str && err_len > 0)
461         err_str[0] = '\0';
462     std::vector<struct kinfo_proc> matching_proc_infos;
463     size_t num_matching_proc_infos = GetAllInfosMatchingName(name, matching_proc_infos);
464     if (num_matching_proc_infos == 0)
465     {
466         DNBLogError ("error: no processes match '%s'\n", name);
467         return INVALID_NUB_PROCESS;
468     }
469     else if (num_matching_proc_infos > 1)
470     {
471         DNBLogError ("error: %llu processes match '%s':\n", (uint64_t)num_matching_proc_infos, name);
472         size_t i;
473         for (i=0; i<num_matching_proc_infos; ++i)
474             DNBLogError ("%6u - %s\n", matching_proc_infos[i].kp_proc.p_pid, matching_proc_infos[i].kp_proc.p_comm);
475         return INVALID_NUB_PROCESS;
476     }
477 
478     return DNBProcessAttach (matching_proc_infos[0].kp_proc.p_pid, timeout, err_str, err_len);
479 }
480 
481 nub_process_t
482 DNBProcessAttach (nub_process_t attach_pid, struct timespec *timeout, char *err_str, size_t err_len)
483 {
484     if (err_str && err_len > 0)
485         err_str[0] = '\0';
486 
487     pid_t pid = INVALID_NUB_PROCESS;
488     MachProcessSP processSP(new MachProcess);
489     if (processSP.get())
490     {
491         DNBLogThreadedIf(LOG_PROCESS, "(DebugNub) attaching to pid %d...", attach_pid);
492         pid = processSP->AttachForDebug (attach_pid, err_str,  err_len);
493 
494         if (pid != INVALID_NUB_PROCESS)
495         {
496             bool res = AddProcessToMap(pid, processSP);
497             assert(res && "Couldn't add process to map!");
498             spawn_waitpid_thread(pid);
499         }
500     }
501 
502     while (pid != INVALID_NUB_PROCESS)
503     {
504         // Wait for process to start up and hit entry point
505         DNBLogThreadedIf (LOG_PROCESS,
506                           "%s DNBProcessWaitForEvent (%4.4x, eEventProcessRunningStateChanged | eEventProcessStoppedStateChanged, true, INFINITE)...",
507                           __FUNCTION__,
508                           pid);
509         nub_event_t set_events = DNBProcessWaitForEvents (pid,
510                                                           eEventProcessRunningStateChanged | eEventProcessStoppedStateChanged,
511                                                           true,
512                                                           timeout);
513 
514         DNBLogThreadedIf (LOG_PROCESS,
515                           "%s DNBProcessWaitForEvent (%4.4x, eEventProcessRunningStateChanged | eEventProcessStoppedStateChanged, true, INFINITE) => 0x%8.8x",
516                           __FUNCTION__,
517                           pid,
518                           set_events);
519 
520         if (set_events == 0)
521         {
522             if (err_str && err_len > 0)
523                 snprintf(err_str, err_len, "operation timed out");
524             pid = INVALID_NUB_PROCESS;
525         }
526         else
527         {
528             if (set_events & (eEventProcessRunningStateChanged | eEventProcessStoppedStateChanged))
529             {
530                 nub_state_t pid_state = DNBProcessGetState (pid);
531                 DNBLogThreadedIf (LOG_PROCESS, "%s process %4.4x state changed (eEventProcessStateChanged): %s",
532                         __FUNCTION__, pid, DNBStateAsString(pid_state));
533 
534                 switch (pid_state)
535                 {
536                     default:
537                     case eStateInvalid:
538                     case eStateUnloaded:
539                     case eStateAttaching:
540                     case eStateLaunching:
541                     case eStateSuspended:
542                         break;  // Ignore
543 
544                     case eStateRunning:
545                     case eStateStepping:
546                         // Still waiting to stop at entry point...
547                         break;
548 
549                     case eStateStopped:
550                     case eStateCrashed:
551                         return pid;
552 
553                     case eStateDetached:
554                     case eStateExited:
555                         if (err_str && err_len > 0)
556                             snprintf(err_str, err_len, "process exited");
557                         return INVALID_NUB_PROCESS;
558                 }
559             }
560 
561             DNBProcessResetEvents(pid, set_events);
562         }
563     }
564 
565     return INVALID_NUB_PROCESS;
566 }
567 
568 size_t
569 GetAllInfos (std::vector<struct kinfo_proc>& proc_infos)
570 {
571     size_t size = 0;
572     int name[] = { CTL_KERN, KERN_PROC, KERN_PROC_ALL };
573     u_int namelen = sizeof(name)/sizeof(int);
574     int err;
575 
576     // Try to find out how many processes are around so we can
577     // size the buffer appropriately.  sysctl's man page specifically suggests
578     // this approach, and says it returns a bit larger size than needed to
579     // handle any new processes created between then and now.
580 
581     err = ::sysctl (name, namelen, NULL, &size, NULL, 0);
582 
583     if ((err < 0) && (err != ENOMEM))
584     {
585         proc_infos.clear();
586         perror("sysctl (mib, miblen, NULL, &num_processes, NULL, 0)");
587         return 0;
588     }
589 
590 
591     // Increase the size of the buffer by a few processes in case more have
592     // been spawned
593     proc_infos.resize (size / sizeof(struct kinfo_proc));
594     size = proc_infos.size() * sizeof(struct kinfo_proc);   // Make sure we don't exceed our resize...
595     err = ::sysctl (name, namelen, &proc_infos[0], &size, NULL, 0);
596     if (err < 0)
597     {
598         proc_infos.clear();
599         return 0;
600     }
601 
602     // Trim down our array to fit what we actually got back
603     proc_infos.resize(size / sizeof(struct kinfo_proc));
604     return proc_infos.size();
605 }
606 
607 static size_t
608 GetAllInfosMatchingName(const char *full_process_name, std::vector<struct kinfo_proc>& matching_proc_infos)
609 {
610 
611     matching_proc_infos.clear();
612     if (full_process_name && full_process_name[0])
613     {
614         // We only get the process name, not the full path, from the proc_info.  So just take the
615         // base name of the process name...
616         const char *process_name;
617         process_name = strrchr (full_process_name, '/');
618         if (process_name == NULL)
619             process_name = full_process_name;
620         else
621             process_name++;
622 
623         const size_t process_name_len = strlen(process_name);
624         std::vector<struct kinfo_proc> proc_infos;
625         const size_t num_proc_infos = GetAllInfos(proc_infos);
626         if (num_proc_infos > 0)
627         {
628             uint32_t i;
629             for (i=0; i<num_proc_infos; i++)
630             {
631                 // Skip zombie processes and processes with unset status
632                 if (proc_infos[i].kp_proc.p_stat == 0 || proc_infos[i].kp_proc.p_stat == SZOMB)
633                     continue;
634 
635                 // Check for process by name. We only check the first MAXCOMLEN
636                 // chars as that is all that kp_proc.p_comm holds.
637 
638                 if (::strncasecmp(process_name, proc_infos[i].kp_proc.p_comm, MAXCOMLEN) == 0)
639                 {
640                     if (process_name_len > MAXCOMLEN)
641                     {
642                         // We found a matching process name whose first MAXCOMLEN
643                         // characters match, but there is more to the name than
644                         // this. We need to get the full process name.  Use proc_pidpath, which will get
645                         // us the full path to the executed process.
646 
647                         char proc_path_buf[PATH_MAX];
648 
649                         int return_val = proc_pidpath (proc_infos[i].kp_proc.p_pid, proc_path_buf, PATH_MAX);
650                         if (return_val > 0)
651                         {
652                             // Okay, now search backwards from that to see if there is a
653                             // slash in the name.  Note, even though we got all the args we don't care
654                             // because the list data is just a bunch of concatenated null terminated strings
655                             // so strrchr will start from the end of argv0.
656 
657                             const char *argv_basename = strrchr(proc_path_buf, '/');
658                             if (argv_basename)
659                             {
660                                 // Skip the '/'
661                                 ++argv_basename;
662                             }
663                             else
664                             {
665                                 // We didn't find a directory delimiter in the process argv[0], just use what was in there
666                                 argv_basename = proc_path_buf;
667                             }
668 
669                             if (argv_basename)
670                             {
671                                 if (::strncasecmp(process_name, argv_basename, PATH_MAX) == 0)
672                                 {
673                                     matching_proc_infos.push_back(proc_infos[i]);
674                                 }
675                             }
676                         }
677                     }
678                     else
679                     {
680                         // We found a matching process, add it to our list
681                         matching_proc_infos.push_back(proc_infos[i]);
682                     }
683                 }
684             }
685         }
686     }
687     // return the newly added matches.
688     return matching_proc_infos.size();
689 }
690 
691 nub_process_t
692 DNBProcessAttachWait (const char *waitfor_process_name,
693                       nub_launch_flavor_t launch_flavor,
694                       bool ignore_existing,
695                       struct timespec *timeout_abstime,
696                       useconds_t waitfor_interval,
697                       char *err_str,
698                       size_t err_len,
699                       DNBShouldCancelCallback should_cancel_callback,
700                       void *callback_data)
701 {
702     DNBError prepare_error;
703     std::vector<struct kinfo_proc> exclude_proc_infos;
704     size_t num_exclude_proc_infos;
705 
706     // If the PrepareForAttach returns a valid token, use  MachProcess to check
707     // for the process, otherwise scan the process table.
708 
709     const void *attach_token = MachProcess::PrepareForAttach (waitfor_process_name, launch_flavor, true, prepare_error);
710 
711     if (prepare_error.Fail())
712     {
713         DNBLogError ("Error in PrepareForAttach: %s", prepare_error.AsString());
714         return INVALID_NUB_PROCESS;
715     }
716 
717     if (attach_token == NULL)
718     {
719         if (ignore_existing)
720             num_exclude_proc_infos = GetAllInfosMatchingName (waitfor_process_name, exclude_proc_infos);
721         else
722             num_exclude_proc_infos = 0;
723     }
724 
725     DNBLogThreadedIf (LOG_PROCESS, "Waiting for '%s' to appear...\n", waitfor_process_name);
726 
727     // Loop and try to find the process by name
728     nub_process_t waitfor_pid = INVALID_NUB_PROCESS;
729 
730     while (waitfor_pid == INVALID_NUB_PROCESS)
731     {
732         if (attach_token != NULL)
733         {
734             nub_process_t pid;
735             pid = MachProcess::CheckForProcess(attach_token);
736             if (pid != INVALID_NUB_PROCESS)
737             {
738                 waitfor_pid = pid;
739                 break;
740             }
741         }
742         else
743         {
744 
745             // Get the current process list, and check for matches that
746             // aren't in our original list. If anyone wants to attach
747             // to an existing process by name, they should do it with
748             // --attach=PROCNAME. Else we will wait for the first matching
749             // process that wasn't in our exclusion list.
750             std::vector<struct kinfo_proc> proc_infos;
751             const size_t num_proc_infos = GetAllInfosMatchingName (waitfor_process_name, proc_infos);
752             for (size_t i=0; i<num_proc_infos; i++)
753             {
754                 nub_process_t curr_pid = proc_infos[i].kp_proc.p_pid;
755                 for (size_t j=0; j<num_exclude_proc_infos; j++)
756                 {
757                     if (curr_pid == exclude_proc_infos[j].kp_proc.p_pid)
758                     {
759                         // This process was in our exclusion list, don't use it.
760                         curr_pid = INVALID_NUB_PROCESS;
761                         break;
762                     }
763                 }
764 
765                 // If we didn't find CURR_PID in our exclusion list, then use it.
766                 if (curr_pid != INVALID_NUB_PROCESS)
767                 {
768                     // We found our process!
769                     waitfor_pid = curr_pid;
770                     break;
771                 }
772             }
773         }
774 
775         // If we haven't found our process yet, check for a timeout
776         // and then sleep for a bit until we poll again.
777         if (waitfor_pid == INVALID_NUB_PROCESS)
778         {
779             if (timeout_abstime != NULL)
780             {
781                 // Check to see if we have a waitfor-duration option that
782                 // has timed out?
783                 if (DNBTimer::TimeOfDayLaterThan(*timeout_abstime))
784                 {
785                     if (err_str && err_len > 0)
786                         snprintf(err_str, err_len, "operation timed out");
787                     DNBLogError ("error: waiting for process '%s' timed out.\n", waitfor_process_name);
788                     return INVALID_NUB_PROCESS;
789                 }
790             }
791 
792             // Call the should cancel callback as well...
793 
794             if (should_cancel_callback != NULL
795                 && should_cancel_callback (callback_data))
796             {
797                 DNBLogThreadedIf (LOG_PROCESS, "DNBProcessAttachWait cancelled by should_cancel callback.");
798                 waitfor_pid = INVALID_NUB_PROCESS;
799                 break;
800             }
801 
802             ::usleep (waitfor_interval);    // Sleep for WAITFOR_INTERVAL, then poll again
803         }
804     }
805 
806     if (waitfor_pid != INVALID_NUB_PROCESS)
807     {
808         DNBLogThreadedIf (LOG_PROCESS, "Attaching to %s with pid %i...\n", waitfor_process_name, waitfor_pid);
809         waitfor_pid = DNBProcessAttach (waitfor_pid, timeout_abstime, err_str, err_len);
810     }
811 
812     bool success = waitfor_pid != INVALID_NUB_PROCESS;
813     MachProcess::CleanupAfterAttach (attach_token, success, prepare_error);
814 
815     return waitfor_pid;
816 }
817 
818 nub_bool_t
819 DNBProcessDetach (nub_process_t pid)
820 {
821     MachProcessSP procSP;
822     if (GetProcessSP (pid, procSP))
823     {
824         const bool remove = true;
825         DNBLogThreaded("Disabling breakpoints and watchpoints, and detaching from %d.", pid);
826         procSP->DisableAllBreakpoints(remove);
827         procSP->DisableAllWatchpoints (remove);
828         return procSP->Detach();
829     }
830     return false;
831 }
832 
833 nub_bool_t
834 DNBProcessKill (nub_process_t pid)
835 {
836     MachProcessSP procSP;
837     if (GetProcessSP (pid, procSP))
838     {
839         return procSP->Kill ();
840     }
841     return false;
842 }
843 
844 nub_bool_t
845 DNBProcessSignal (nub_process_t pid, int signal)
846 {
847     MachProcessSP procSP;
848     if (GetProcessSP (pid, procSP))
849     {
850         return procSP->Signal (signal);
851     }
852     return false;
853 }
854 
855 
856 nub_bool_t
857 DNBProcessInterrupt(nub_process_t pid)
858 {
859     MachProcessSP procSP;
860     if (GetProcessSP (pid, procSP))
861         return procSP->Interrupt();
862     return false;
863 }
864 
865 nub_bool_t
866 DNBProcessSendEvent (nub_process_t pid, const char *event)
867 {
868     MachProcessSP procSP;
869     if (GetProcessSP (pid, procSP))
870     {
871         // FIXME: Do something with the error...
872         DNBError send_error;
873         return procSP->SendEvent (event, send_error);
874     }
875     return false;
876 }
877 
878 
879 nub_bool_t
880 DNBProcessIsAlive (nub_process_t pid)
881 {
882     MachProcessSP procSP;
883     if (GetProcessSP (pid, procSP))
884     {
885         return MachTask::IsValid (procSP->Task().TaskPort());
886     }
887     return eStateInvalid;
888 }
889 
890 //----------------------------------------------------------------------
891 // Process and Thread state information
892 //----------------------------------------------------------------------
893 nub_state_t
894 DNBProcessGetState (nub_process_t pid)
895 {
896     MachProcessSP procSP;
897     if (GetProcessSP (pid, procSP))
898     {
899         return procSP->GetState();
900     }
901     return eStateInvalid;
902 }
903 
904 //----------------------------------------------------------------------
905 // Process and Thread state information
906 //----------------------------------------------------------------------
907 nub_bool_t
908 DNBProcessGetExitStatus (nub_process_t pid, int* status)
909 {
910     MachProcessSP procSP;
911     if (GetProcessSP (pid, procSP))
912     {
913         return procSP->GetExitStatus(status);
914     }
915     return false;
916 }
917 
918 nub_bool_t
919 DNBProcessSetExitStatus (nub_process_t pid, int status)
920 {
921     MachProcessSP procSP;
922     if (GetProcessSP (pid, procSP))
923     {
924         procSP->SetExitStatus(status);
925         return true;
926     }
927     return false;
928 }
929 
930 const char *
931 DNBProcessGetExitInfo (nub_process_t pid)
932 {
933     MachProcessSP procSP;
934     if (GetProcessSP (pid, procSP))
935     {
936         return procSP->GetExitInfo();
937     }
938     return NULL;
939 }
940 
941 nub_bool_t
942 DNBProcessSetExitInfo (nub_process_t pid, const char *info)
943 {
944     MachProcessSP procSP;
945     if (GetProcessSP (pid, procSP))
946     {
947         procSP->SetExitInfo(info);
948         return true;
949     }
950     return false;
951 }
952 
953 const char *
954 DNBThreadGetName (nub_process_t pid, nub_thread_t tid)
955 {
956     MachProcessSP procSP;
957     if (GetProcessSP (pid, procSP))
958         return procSP->ThreadGetName(tid);
959     return NULL;
960 }
961 
962 
963 nub_bool_t
964 DNBThreadGetIdentifierInfo (nub_process_t pid, nub_thread_t tid, thread_identifier_info_data_t *ident_info)
965 {
966     MachProcessSP procSP;
967     if (GetProcessSP (pid, procSP))
968         return procSP->GetThreadList().GetIdentifierInfo(tid, ident_info);
969     return false;
970 }
971 
972 nub_state_t
973 DNBThreadGetState (nub_process_t pid, nub_thread_t tid)
974 {
975     MachProcessSP procSP;
976     if (GetProcessSP (pid, procSP))
977     {
978         return procSP->ThreadGetState(tid);
979     }
980     return eStateInvalid;
981 }
982 
983 const char *
984 DNBStateAsString(nub_state_t state)
985 {
986     switch (state)
987     {
988     case eStateInvalid:     return "Invalid";
989     case eStateUnloaded:    return "Unloaded";
990     case eStateAttaching:   return "Attaching";
991     case eStateLaunching:   return "Launching";
992     case eStateStopped:     return "Stopped";
993     case eStateRunning:     return "Running";
994     case eStateStepping:    return "Stepping";
995     case eStateCrashed:     return "Crashed";
996     case eStateDetached:    return "Detached";
997     case eStateExited:      return "Exited";
998     case eStateSuspended:   return "Suspended";
999     }
1000     return "nub_state_t ???";
1001 }
1002 
1003 Genealogy::ThreadActivitySP
1004 DNBGetGenealogyInfoForThread (nub_process_t pid, nub_thread_t tid, bool &timed_out)
1005 {
1006     Genealogy::ThreadActivitySP thread_activity_sp;
1007     MachProcessSP procSP;
1008     if (GetProcessSP (pid, procSP))
1009         thread_activity_sp = procSP->GetGenealogyInfoForThread (tid, timed_out);
1010     return thread_activity_sp;
1011 }
1012 
1013 Genealogy::ProcessExecutableInfoSP
1014 DNBGetGenealogyImageInfo (nub_process_t pid, size_t idx)
1015 {
1016     Genealogy::ProcessExecutableInfoSP image_info_sp;
1017     MachProcessSP procSP;
1018     if (GetProcessSP (pid, procSP))
1019     {
1020         image_info_sp = procSP->GetGenealogyImageInfo (idx);
1021     }
1022     return image_info_sp;
1023 }
1024 
1025 ThreadInfo::QoS
1026 DNBGetRequestedQoSForThread (nub_process_t pid, nub_thread_t tid, nub_addr_t tsd, uint64_t dti_qos_class_index)
1027 {
1028     MachProcessSP procSP;
1029     if (GetProcessSP (pid, procSP))
1030     {
1031         return procSP->GetRequestedQoS (tid, tsd, dti_qos_class_index);
1032     }
1033     return ThreadInfo::QoS();
1034 }
1035 
1036 nub_addr_t
1037 DNBGetPThreadT (nub_process_t pid, nub_thread_t tid)
1038 {
1039     MachProcessSP procSP;
1040     if (GetProcessSP (pid, procSP))
1041     {
1042         return procSP->GetPThreadT (tid);
1043     }
1044     return INVALID_NUB_ADDRESS;
1045 }
1046 
1047 nub_addr_t
1048 DNBGetDispatchQueueT (nub_process_t pid, nub_thread_t tid)
1049 {
1050     MachProcessSP procSP;
1051     if (GetProcessSP (pid, procSP))
1052     {
1053         return procSP->GetDispatchQueueT (tid);
1054     }
1055     return INVALID_NUB_ADDRESS;
1056 }
1057 
1058 nub_addr_t
1059 DNBGetTSDAddressForThread (nub_process_t pid, nub_thread_t tid, uint64_t plo_pthread_tsd_base_address_offset, uint64_t plo_pthread_tsd_base_offset, uint64_t plo_pthread_tsd_entry_size)
1060 {
1061     MachProcessSP procSP;
1062     if (GetProcessSP (pid, procSP))
1063     {
1064         return procSP->GetTSDAddressForThread (tid, plo_pthread_tsd_base_address_offset, plo_pthread_tsd_base_offset, plo_pthread_tsd_entry_size);
1065     }
1066     return INVALID_NUB_ADDRESS;
1067 }
1068 
1069 
1070 const char *
1071 DNBProcessGetExecutablePath (nub_process_t pid)
1072 {
1073     MachProcessSP procSP;
1074     if (GetProcessSP (pid, procSP))
1075     {
1076         return procSP->Path();
1077     }
1078     return NULL;
1079 }
1080 
1081 nub_size_t
1082 DNBProcessGetArgumentCount (nub_process_t pid)
1083 {
1084     MachProcessSP procSP;
1085     if (GetProcessSP (pid, procSP))
1086     {
1087         return procSP->ArgumentCount();
1088     }
1089     return 0;
1090 }
1091 
1092 const char *
1093 DNBProcessGetArgumentAtIndex (nub_process_t pid, nub_size_t idx)
1094 {
1095     MachProcessSP procSP;
1096     if (GetProcessSP (pid, procSP))
1097     {
1098         return procSP->ArgumentAtIndex (idx);
1099     }
1100     return NULL;
1101 }
1102 
1103 
1104 //----------------------------------------------------------------------
1105 // Execution control
1106 //----------------------------------------------------------------------
1107 nub_bool_t
1108 DNBProcessResume (nub_process_t pid, const DNBThreadResumeAction *actions, size_t num_actions)
1109 {
1110     DNBLogThreadedIf(LOG_PROCESS, "%s(pid = %4.4x)", __FUNCTION__, pid);
1111     MachProcessSP procSP;
1112     if (GetProcessSP (pid, procSP))
1113     {
1114         DNBThreadResumeActions thread_actions (actions, num_actions);
1115 
1116         // Below we add a default thread plan just in case one wasn't
1117         // provided so all threads always know what they were supposed to do
1118         if (thread_actions.IsEmpty())
1119         {
1120             // No thread plans were given, so the default it to run all threads
1121             thread_actions.SetDefaultThreadActionIfNeeded (eStateRunning, 0);
1122         }
1123         else
1124         {
1125             // Some thread plans were given which means anything that wasn't
1126             // specified should remain stopped.
1127             thread_actions.SetDefaultThreadActionIfNeeded (eStateStopped, 0);
1128         }
1129         return procSP->Resume (thread_actions);
1130     }
1131     return false;
1132 }
1133 
1134 nub_bool_t
1135 DNBProcessHalt (nub_process_t pid)
1136 {
1137     DNBLogThreadedIf(LOG_PROCESS, "%s(pid = %4.4x)", __FUNCTION__, pid);
1138     MachProcessSP procSP;
1139     if (GetProcessSP (pid, procSP))
1140         return procSP->Signal (SIGSTOP);
1141     return false;
1142 }
1143 //
1144 //nub_bool_t
1145 //DNBThreadResume (nub_process_t pid, nub_thread_t tid, nub_bool_t step)
1146 //{
1147 //    DNBLogThreadedIf(LOG_THREAD, "%s(pid = %4.4x, tid = %4.4x, step = %u)", __FUNCTION__, pid, tid, (uint32_t)step);
1148 //    MachProcessSP procSP;
1149 //    if (GetProcessSP (pid, procSP))
1150 //    {
1151 //        return procSP->Resume(tid, step, 0);
1152 //    }
1153 //    return false;
1154 //}
1155 //
1156 //nub_bool_t
1157 //DNBThreadResumeWithSignal (nub_process_t pid, nub_thread_t tid, nub_bool_t step, int signal)
1158 //{
1159 //    DNBLogThreadedIf(LOG_THREAD, "%s(pid = %4.4x, tid = %4.4x, step = %u, signal = %i)", __FUNCTION__, pid, tid, (uint32_t)step, signal);
1160 //    MachProcessSP procSP;
1161 //    if (GetProcessSP (pid, procSP))
1162 //    {
1163 //        return procSP->Resume(tid, step, signal);
1164 //    }
1165 //    return false;
1166 //}
1167 
1168 nub_event_t
1169 DNBProcessWaitForEvents (nub_process_t pid, nub_event_t event_mask, bool wait_for_set, struct timespec* timeout)
1170 {
1171     nub_event_t result = 0;
1172     MachProcessSP procSP;
1173     if (GetProcessSP (pid, procSP))
1174     {
1175         if (wait_for_set)
1176             result = procSP->Events().WaitForSetEvents(event_mask, timeout);
1177         else
1178             result = procSP->Events().WaitForEventsToReset(event_mask, timeout);
1179     }
1180     return result;
1181 }
1182 
1183 void
1184 DNBProcessResetEvents (nub_process_t pid, nub_event_t event_mask)
1185 {
1186     MachProcessSP procSP;
1187     if (GetProcessSP (pid, procSP))
1188         procSP->Events().ResetEvents(event_mask);
1189 }
1190 
1191 // Breakpoints
1192 nub_bool_t
1193 DNBBreakpointSet (nub_process_t pid, nub_addr_t addr, nub_size_t size, nub_bool_t hardware)
1194 {
1195     MachProcessSP procSP;
1196     if (GetProcessSP (pid, procSP))
1197         return procSP->CreateBreakpoint(addr, size, hardware) != NULL;
1198     return false;
1199 }
1200 
1201 nub_bool_t
1202 DNBBreakpointClear (nub_process_t pid, nub_addr_t addr)
1203 {
1204     MachProcessSP procSP;
1205     if (GetProcessSP (pid, procSP))
1206         return procSP->DisableBreakpoint(addr, true);
1207     return false; // Failed
1208 }
1209 
1210 
1211 //----------------------------------------------------------------------
1212 // Watchpoints
1213 //----------------------------------------------------------------------
1214 nub_bool_t
1215 DNBWatchpointSet (nub_process_t pid, nub_addr_t addr, nub_size_t size, uint32_t watch_flags, nub_bool_t hardware)
1216 {
1217     MachProcessSP procSP;
1218     if (GetProcessSP (pid, procSP))
1219         return procSP->CreateWatchpoint(addr, size, watch_flags, hardware) != NULL;
1220     return false;
1221 }
1222 
1223 nub_bool_t
1224 DNBWatchpointClear (nub_process_t pid, nub_addr_t addr)
1225 {
1226     MachProcessSP procSP;
1227     if (GetProcessSP (pid, procSP))
1228         return procSP->DisableWatchpoint(addr, true);
1229     return false; // Failed
1230 }
1231 
1232 //----------------------------------------------------------------------
1233 // Return the number of supported hardware watchpoints.
1234 //----------------------------------------------------------------------
1235 uint32_t
1236 DNBWatchpointGetNumSupportedHWP (nub_process_t pid)
1237 {
1238     MachProcessSP procSP;
1239     if (GetProcessSP (pid, procSP))
1240         return procSP->GetNumSupportedHardwareWatchpoints();
1241     return 0;
1242 }
1243 
1244 //----------------------------------------------------------------------
1245 // Read memory in the address space of process PID. This call will take
1246 // care of setting and restoring permissions and breaking up the memory
1247 // read into multiple chunks as required.
1248 //
1249 // RETURNS: number of bytes actually read
1250 //----------------------------------------------------------------------
1251 nub_size_t
1252 DNBProcessMemoryRead (nub_process_t pid, nub_addr_t addr, nub_size_t size, void *buf)
1253 {
1254     MachProcessSP procSP;
1255     if (GetProcessSP (pid, procSP))
1256         return procSP->ReadMemory(addr, size, buf);
1257     return 0;
1258 }
1259 
1260 //----------------------------------------------------------------------
1261 // Write memory to the address space of process PID. This call will take
1262 // care of setting and restoring permissions and breaking up the memory
1263 // write into multiple chunks as required.
1264 //
1265 // RETURNS: number of bytes actually written
1266 //----------------------------------------------------------------------
1267 nub_size_t
1268 DNBProcessMemoryWrite (nub_process_t pid, nub_addr_t addr, nub_size_t size, const void *buf)
1269 {
1270     MachProcessSP procSP;
1271     if (GetProcessSP (pid, procSP))
1272         return procSP->WriteMemory(addr, size, buf);
1273     return 0;
1274 }
1275 
1276 nub_addr_t
1277 DNBProcessMemoryAllocate (nub_process_t pid, nub_size_t size, uint32_t permissions)
1278 {
1279     MachProcessSP procSP;
1280     if (GetProcessSP (pid, procSP))
1281         return procSP->Task().AllocateMemory (size, permissions);
1282     return 0;
1283 }
1284 
1285 nub_bool_t
1286 DNBProcessMemoryDeallocate (nub_process_t pid, nub_addr_t addr)
1287 {
1288     MachProcessSP procSP;
1289     if (GetProcessSP (pid, procSP))
1290         return procSP->Task().DeallocateMemory (addr);
1291     return 0;
1292 }
1293 
1294 //----------------------------------------------------------------------
1295 // Find attributes of the memory region that contains ADDR for process PID,
1296 // if possible, and return a string describing those attributes.
1297 //
1298 // Returns 1 if we could find attributes for this region and OUTBUF can
1299 // be sent to the remote debugger.
1300 //
1301 // Returns 0 if we couldn't find the attributes for a region of memory at
1302 // that address and OUTBUF should not be sent.
1303 //
1304 // Returns -1 if this platform cannot look up information about memory regions
1305 // or if we do not yet have a valid launched process.
1306 //
1307 //----------------------------------------------------------------------
1308 int
1309 DNBProcessMemoryRegionInfo (nub_process_t pid, nub_addr_t addr, DNBRegionInfo *region_info)
1310 {
1311     MachProcessSP procSP;
1312     if (GetProcessSP (pid, procSP))
1313         return procSP->Task().GetMemoryRegionInfo (addr, region_info);
1314 
1315     return -1;
1316 }
1317 
1318 std::string
1319 DNBProcessGetProfileData (nub_process_t pid, DNBProfileDataScanType scanType)
1320 {
1321     MachProcessSP procSP;
1322     if (GetProcessSP (pid, procSP))
1323         return procSP->Task().GetProfileData(scanType);
1324 
1325     return std::string("");
1326 }
1327 
1328 nub_bool_t
1329 DNBProcessSetEnableAsyncProfiling (nub_process_t pid, nub_bool_t enable, uint64_t interval_usec, DNBProfileDataScanType scan_type)
1330 {
1331     MachProcessSP procSP;
1332     if (GetProcessSP (pid, procSP))
1333     {
1334         procSP->SetEnableAsyncProfiling(enable, interval_usec, scan_type);
1335         return true;
1336     }
1337 
1338     return false;
1339 }
1340 
1341 //----------------------------------------------------------------------
1342 // Get the number of threads for the specified process.
1343 //----------------------------------------------------------------------
1344 nub_size_t
1345 DNBProcessGetNumThreads (nub_process_t pid)
1346 {
1347     MachProcessSP procSP;
1348     if (GetProcessSP (pid, procSP))
1349         return procSP->GetNumThreads();
1350     return 0;
1351 }
1352 
1353 //----------------------------------------------------------------------
1354 // Get the thread ID of the current thread.
1355 //----------------------------------------------------------------------
1356 nub_thread_t
1357 DNBProcessGetCurrentThread (nub_process_t pid)
1358 {
1359     MachProcessSP procSP;
1360     if (GetProcessSP (pid, procSP))
1361         return procSP->GetCurrentThread();
1362     return 0;
1363 }
1364 
1365 //----------------------------------------------------------------------
1366 // Get the mach port number of the current thread.
1367 //----------------------------------------------------------------------
1368 nub_thread_t
1369 DNBProcessGetCurrentThreadMachPort (nub_process_t pid)
1370 {
1371     MachProcessSP procSP;
1372     if (GetProcessSP (pid, procSP))
1373         return procSP->GetCurrentThreadMachPort();
1374     return 0;
1375 }
1376 
1377 //----------------------------------------------------------------------
1378 // Change the current thread.
1379 //----------------------------------------------------------------------
1380 nub_thread_t
1381 DNBProcessSetCurrentThread (nub_process_t pid, nub_thread_t tid)
1382 {
1383     MachProcessSP procSP;
1384     if (GetProcessSP (pid, procSP))
1385         return procSP->SetCurrentThread (tid);
1386     return INVALID_NUB_THREAD;
1387 }
1388 
1389 
1390 //----------------------------------------------------------------------
1391 // Dump a string describing a thread's stop reason to the specified file
1392 // handle
1393 //----------------------------------------------------------------------
1394 nub_bool_t
1395 DNBThreadGetStopReason (nub_process_t pid, nub_thread_t tid, struct DNBThreadStopInfo *stop_info)
1396 {
1397     MachProcessSP procSP;
1398     if (GetProcessSP (pid, procSP))
1399         return procSP->GetThreadStoppedReason (tid, stop_info);
1400     return false;
1401 }
1402 
1403 //----------------------------------------------------------------------
1404 // Return string description for the specified thread.
1405 //
1406 // RETURNS: NULL if the thread isn't valid, else a NULL terminated C
1407 // string from a static buffer that must be copied prior to subsequent
1408 // calls.
1409 //----------------------------------------------------------------------
1410 const char *
1411 DNBThreadGetInfo (nub_process_t pid, nub_thread_t tid)
1412 {
1413     MachProcessSP procSP;
1414     if (GetProcessSP (pid, procSP))
1415         return procSP->GetThreadInfo (tid);
1416     return NULL;
1417 }
1418 
1419 //----------------------------------------------------------------------
1420 // Get the thread ID given a thread index.
1421 //----------------------------------------------------------------------
1422 nub_thread_t
1423 DNBProcessGetThreadAtIndex (nub_process_t pid, size_t thread_idx)
1424 {
1425     MachProcessSP procSP;
1426     if (GetProcessSP (pid, procSP))
1427         return procSP->GetThreadAtIndex (thread_idx);
1428     return INVALID_NUB_THREAD;
1429 }
1430 
1431 //----------------------------------------------------------------------
1432 // Do whatever is needed to sync the thread's register state with it's kernel values.
1433 //----------------------------------------------------------------------
1434 nub_bool_t
1435 DNBProcessSyncThreadState (nub_process_t pid, nub_thread_t tid)
1436 {
1437     MachProcessSP procSP;
1438     if (GetProcessSP (pid, procSP))
1439         return procSP->SyncThreadState (tid);
1440     return false;
1441 
1442 }
1443 
1444 nub_addr_t
1445 DNBProcessGetSharedLibraryInfoAddress (nub_process_t pid)
1446 {
1447     MachProcessSP procSP;
1448     DNBError err;
1449     if (GetProcessSP (pid, procSP))
1450         return procSP->Task().GetDYLDAllImageInfosAddress (err);
1451     return INVALID_NUB_ADDRESS;
1452 }
1453 
1454 
1455 nub_bool_t
1456 DNBProcessSharedLibrariesUpdated(nub_process_t pid)
1457 {
1458     MachProcessSP procSP;
1459     if (GetProcessSP (pid, procSP))
1460     {
1461         procSP->SharedLibrariesUpdated ();
1462         return true;
1463     }
1464     return false;
1465 }
1466 
1467 //----------------------------------------------------------------------
1468 // Get the current shared library information for a process. Only return
1469 // the shared libraries that have changed since the last shared library
1470 // state changed event if only_changed is non-zero.
1471 //----------------------------------------------------------------------
1472 nub_size_t
1473 DNBProcessGetSharedLibraryInfo (nub_process_t pid, nub_bool_t only_changed, struct DNBExecutableImageInfo **image_infos)
1474 {
1475     MachProcessSP procSP;
1476     if (GetProcessSP (pid, procSP))
1477         return procSP->CopyImageInfos (image_infos, only_changed);
1478 
1479     // If we have no process, then return NULL for the shared library info
1480     // and zero for shared library count
1481     *image_infos = NULL;
1482     return 0;
1483 }
1484 
1485 //----------------------------------------------------------------------
1486 // Get the register set information for a specific thread.
1487 //----------------------------------------------------------------------
1488 const DNBRegisterSetInfo *
1489 DNBGetRegisterSetInfo (nub_size_t *num_reg_sets)
1490 {
1491     return DNBArchProtocol::GetRegisterSetInfo (num_reg_sets);
1492 }
1493 
1494 
1495 //----------------------------------------------------------------------
1496 // Read a register value by register set and register index.
1497 //----------------------------------------------------------------------
1498 nub_bool_t
1499 DNBThreadGetRegisterValueByID (nub_process_t pid, nub_thread_t tid, uint32_t set, uint32_t reg, DNBRegisterValue *value)
1500 {
1501     MachProcessSP procSP;
1502     ::bzero (value, sizeof(DNBRegisterValue));
1503     if (GetProcessSP (pid, procSP))
1504     {
1505         if (tid != INVALID_NUB_THREAD)
1506             return procSP->GetRegisterValue (tid, set, reg, value);
1507     }
1508     return false;
1509 }
1510 
1511 nub_bool_t
1512 DNBThreadSetRegisterValueByID (nub_process_t pid, nub_thread_t tid, uint32_t set, uint32_t reg, const DNBRegisterValue *value)
1513 {
1514     if (tid != INVALID_NUB_THREAD)
1515     {
1516         MachProcessSP procSP;
1517         if (GetProcessSP (pid, procSP))
1518             return procSP->SetRegisterValue (tid, set, reg, value);
1519     }
1520     return false;
1521 }
1522 
1523 nub_size_t
1524 DNBThreadGetRegisterContext (nub_process_t pid, nub_thread_t tid, void *buf, size_t buf_len)
1525 {
1526     MachProcessSP procSP;
1527     if (GetProcessSP (pid, procSP))
1528     {
1529         if (tid != INVALID_NUB_THREAD)
1530             return procSP->GetThreadList().GetRegisterContext (tid, buf, buf_len);
1531     }
1532     ::bzero (buf, buf_len);
1533     return 0;
1534 
1535 }
1536 
1537 nub_size_t
1538 DNBThreadSetRegisterContext (nub_process_t pid, nub_thread_t tid, const void *buf, size_t buf_len)
1539 {
1540     MachProcessSP procSP;
1541     if (GetProcessSP (pid, procSP))
1542     {
1543         if (tid != INVALID_NUB_THREAD)
1544             return procSP->GetThreadList().SetRegisterContext (tid, buf, buf_len);
1545     }
1546     return 0;
1547 }
1548 
1549 uint32_t
1550 DNBThreadSaveRegisterState (nub_process_t pid, nub_thread_t tid)
1551 {
1552     if (tid != INVALID_NUB_THREAD)
1553     {
1554         MachProcessSP procSP;
1555         if (GetProcessSP (pid, procSP))
1556             return procSP->GetThreadList().SaveRegisterState (tid);
1557     }
1558     return 0;
1559 }
1560 nub_bool_t
1561 DNBThreadRestoreRegisterState (nub_process_t pid, nub_thread_t tid, uint32_t save_id)
1562 {
1563     if (tid != INVALID_NUB_THREAD)
1564     {
1565         MachProcessSP procSP;
1566         if (GetProcessSP (pid, procSP))
1567             return procSP->GetThreadList().RestoreRegisterState (tid, save_id);
1568     }
1569     return false;
1570 }
1571 
1572 
1573 
1574 //----------------------------------------------------------------------
1575 // Read a register value by name.
1576 //----------------------------------------------------------------------
1577 nub_bool_t
1578 DNBThreadGetRegisterValueByName (nub_process_t pid, nub_thread_t tid, uint32_t reg_set, const char *reg_name, DNBRegisterValue *value)
1579 {
1580     MachProcessSP procSP;
1581     ::bzero (value, sizeof(DNBRegisterValue));
1582     if (GetProcessSP (pid, procSP))
1583     {
1584         const struct DNBRegisterSetInfo *set_info;
1585         nub_size_t num_reg_sets = 0;
1586         set_info = DNBGetRegisterSetInfo (&num_reg_sets);
1587         if (set_info)
1588         {
1589             uint32_t set = reg_set;
1590             uint32_t reg;
1591             if (set == REGISTER_SET_ALL)
1592             {
1593                 for (set = 1; set < num_reg_sets; ++set)
1594                 {
1595                     for (reg = 0; reg < set_info[set].num_registers; ++reg)
1596                     {
1597                         if (strcasecmp(reg_name, set_info[set].registers[reg].name) == 0)
1598                             return procSP->GetRegisterValue (tid, set, reg, value);
1599                     }
1600                 }
1601             }
1602             else
1603             {
1604                 for (reg = 0; reg < set_info[set].num_registers; ++reg)
1605                 {
1606                     if (strcasecmp(reg_name, set_info[set].registers[reg].name) == 0)
1607                         return procSP->GetRegisterValue (tid, set, reg, value);
1608                 }
1609             }
1610         }
1611     }
1612     return false;
1613 }
1614 
1615 
1616 //----------------------------------------------------------------------
1617 // Read a register set and register number from the register name.
1618 //----------------------------------------------------------------------
1619 nub_bool_t
1620 DNBGetRegisterInfoByName (const char *reg_name, DNBRegisterInfo* info)
1621 {
1622     const struct DNBRegisterSetInfo *set_info;
1623     nub_size_t num_reg_sets = 0;
1624     set_info = DNBGetRegisterSetInfo (&num_reg_sets);
1625     if (set_info)
1626     {
1627         uint32_t set, reg;
1628         for (set = 1; set < num_reg_sets; ++set)
1629         {
1630             for (reg = 0; reg < set_info[set].num_registers; ++reg)
1631             {
1632                 if (strcasecmp(reg_name, set_info[set].registers[reg].name) == 0)
1633                 {
1634                     *info = set_info[set].registers[reg];
1635                     return true;
1636                 }
1637             }
1638         }
1639 
1640         for (set = 1; set < num_reg_sets; ++set)
1641         {
1642             uint32_t reg;
1643             for (reg = 0; reg < set_info[set].num_registers; ++reg)
1644             {
1645                 if (set_info[set].registers[reg].alt == NULL)
1646                     continue;
1647 
1648                 if (strcasecmp(reg_name, set_info[set].registers[reg].alt) == 0)
1649                 {
1650                     *info = set_info[set].registers[reg];
1651                     return true;
1652                 }
1653             }
1654         }
1655     }
1656 
1657     ::bzero (info, sizeof(DNBRegisterInfo));
1658     return false;
1659 }
1660 
1661 
1662 //----------------------------------------------------------------------
1663 // Set the name to address callback function that this nub can use
1664 // for any name to address lookups that are needed.
1665 //----------------------------------------------------------------------
1666 nub_bool_t
1667 DNBProcessSetNameToAddressCallback (nub_process_t pid, DNBCallbackNameToAddress callback, void *baton)
1668 {
1669     MachProcessSP procSP;
1670     if (GetProcessSP (pid, procSP))
1671     {
1672         procSP->SetNameToAddressCallback (callback, baton);
1673         return true;
1674     }
1675     return false;
1676 }
1677 
1678 
1679 //----------------------------------------------------------------------
1680 // Set the name to address callback function that this nub can use
1681 // for any name to address lookups that are needed.
1682 //----------------------------------------------------------------------
1683 nub_bool_t
1684 DNBProcessSetSharedLibraryInfoCallback (nub_process_t pid, DNBCallbackCopyExecutableImageInfos callback, void  *baton)
1685 {
1686     MachProcessSP procSP;
1687     if (GetProcessSP (pid, procSP))
1688     {
1689         procSP->SetSharedLibraryInfoCallback (callback, baton);
1690         return true;
1691     }
1692     return false;
1693 }
1694 
1695 nub_addr_t
1696 DNBProcessLookupAddress (nub_process_t pid, const char *name, const char *shlib)
1697 {
1698     MachProcessSP procSP;
1699     if (GetProcessSP (pid, procSP))
1700     {
1701         return procSP->LookupSymbol (name, shlib);
1702     }
1703     return INVALID_NUB_ADDRESS;
1704 }
1705 
1706 
1707 nub_size_t
1708 DNBProcessGetAvailableSTDOUT (nub_process_t pid, char *buf, nub_size_t buf_size)
1709 {
1710     MachProcessSP procSP;
1711     if (GetProcessSP (pid, procSP))
1712         return procSP->GetAvailableSTDOUT (buf, buf_size);
1713     return 0;
1714 }
1715 
1716 nub_size_t
1717 DNBProcessGetAvailableSTDERR (nub_process_t pid, char *buf, nub_size_t buf_size)
1718 {
1719     MachProcessSP procSP;
1720     if (GetProcessSP (pid, procSP))
1721         return procSP->GetAvailableSTDERR (buf, buf_size);
1722     return 0;
1723 }
1724 
1725 nub_size_t
1726 DNBProcessGetAvailableProfileData (nub_process_t pid, char *buf, nub_size_t buf_size)
1727 {
1728     MachProcessSP procSP;
1729     if (GetProcessSP (pid, procSP))
1730         return procSP->GetAsyncProfileData (buf, buf_size);
1731     return 0;
1732 }
1733 
1734 nub_size_t
1735 DNBProcessGetStopCount (nub_process_t pid)
1736 {
1737     MachProcessSP procSP;
1738     if (GetProcessSP (pid, procSP))
1739         return procSP->StopCount();
1740     return 0;
1741 }
1742 
1743 uint32_t
1744 DNBProcessGetCPUType (nub_process_t pid)
1745 {
1746     MachProcessSP procSP;
1747     if (GetProcessSP (pid, procSP))
1748         return procSP->GetCPUType ();
1749     return 0;
1750 
1751 }
1752 
1753 nub_bool_t
1754 DNBResolveExecutablePath (const char *path, char *resolved_path, size_t resolved_path_size)
1755 {
1756     if (path == NULL || path[0] == '\0')
1757         return false;
1758 
1759     char max_path[PATH_MAX];
1760     std::string result;
1761     CFString::GlobPath(path, result);
1762 
1763     if (result.empty())
1764         result = path;
1765 
1766     struct stat path_stat;
1767     if (::stat(path, &path_stat) == 0)
1768     {
1769         if ((path_stat.st_mode & S_IFMT) == S_IFDIR)
1770         {
1771             CFBundle bundle (path);
1772             CFReleaser<CFURLRef> url(bundle.CopyExecutableURL ());
1773             if (url.get())
1774             {
1775                 if (::CFURLGetFileSystemRepresentation (url.get(), true, (UInt8*)resolved_path, resolved_path_size))
1776                     return true;
1777             }
1778         }
1779     }
1780 
1781     if (realpath(path, max_path))
1782     {
1783         // Found the path relatively...
1784         ::strncpy(resolved_path, max_path, resolved_path_size);
1785         return strlen(resolved_path) + 1 < resolved_path_size;
1786     }
1787     else
1788     {
1789         // Not a relative path, check the PATH environment variable if the
1790         const char *PATH = getenv("PATH");
1791         if (PATH)
1792         {
1793             const char *curr_path_start = PATH;
1794             const char *curr_path_end;
1795             while (curr_path_start && *curr_path_start)
1796             {
1797                 curr_path_end = strchr(curr_path_start, ':');
1798                 if (curr_path_end == NULL)
1799                 {
1800                     result.assign(curr_path_start);
1801                     curr_path_start = NULL;
1802                 }
1803                 else if (curr_path_end > curr_path_start)
1804                 {
1805                     size_t len = curr_path_end - curr_path_start;
1806                     result.assign(curr_path_start, len);
1807                     curr_path_start += len + 1;
1808                 }
1809                 else
1810                     break;
1811 
1812                 result += '/';
1813                 result += path;
1814                 struct stat s;
1815                 if (stat(result.c_str(), &s) == 0)
1816                 {
1817                     ::strncpy(resolved_path, result.c_str(), resolved_path_size);
1818                     return result.size() + 1 < resolved_path_size;
1819                 }
1820             }
1821         }
1822     }
1823     return false;
1824 }
1825 
1826 
1827 void
1828 DNBInitialize()
1829 {
1830     DNBLogThreadedIf (LOG_PROCESS, "DNBInitialize ()");
1831 #if defined (__i386__) || defined (__x86_64__)
1832     DNBArchImplI386::Initialize();
1833     DNBArchImplX86_64::Initialize();
1834 #elif defined (__arm__) || defined (__arm64__) || defined (__aarch64__)
1835     DNBArchMachARM::Initialize();
1836     DNBArchMachARM64::Initialize();
1837 #endif
1838 }
1839 
1840 void
1841 DNBTerminate()
1842 {
1843 }
1844 
1845 nub_bool_t
1846 DNBSetArchitecture (const char *arch)
1847 {
1848     if (arch && arch[0])
1849     {
1850         if (strcasecmp (arch, "i386") == 0)
1851             return DNBArchProtocol::SetArchitecture (CPU_TYPE_I386);
1852         else if ((strcasecmp (arch, "x86_64") == 0) || (strcasecmp (arch, "x86_64h") == 0))
1853             return DNBArchProtocol::SetArchitecture (CPU_TYPE_X86_64);
1854         else if (strstr (arch, "arm64") == arch || strstr (arch, "armv8") == arch || strstr (arch, "aarch64") == arch)
1855             return DNBArchProtocol::SetArchitecture (CPU_TYPE_ARM64);
1856         else if (strstr (arch, "arm") == arch)
1857             return DNBArchProtocol::SetArchitecture (CPU_TYPE_ARM);
1858     }
1859     return false;
1860 }
1861