gdb/fork-child.c

   1 /* Fork a Unix child process, and set up to debug it, for GDB.
   2    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000,
   3    2001 Free Software Foundation, Inc.
   4    Contributed by Cygnus Support.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 59 Temple Place - Suite 330,
  21    Boston, MA 02111-1307, USA.  */
  22
  23 #include "defs.h"
  24 #include "gdb_string.h"
  25 #include "frame.h"              /* required by inferior.h */
  26 #include "inferior.h"
  27 #include "target.h"
  28 #include "gdb_wait.h"
  29 #include "gdb_vfork.h"
  30 #include "gdbcore.h"
  31 #include "terminal.h"
  32 #include "gdbthread.h"
  33 #include "command.h" /* for dont_repeat () */
  34
  35 #include <signal.h>
  36
  37 /* This just gets used as a default if we can't find SHELL */
  38 #ifndef SHELL_FILE
  39 #define SHELL_FILE "/bin/sh"
  40 #endif
  41
  42 extern char **environ;
  43
  44 /* This function breaks up an argument string into an argument
  45  * vector suitable for passing to execvp().
  46  * E.g., on "run a b c d" this routine would get as input
  47  * the string "a b c d", and as output it would fill in argv with
  48  * the four arguments "a", "b", "c", "d".
  49  */
  50 static void
  51 breakup_args (char *scratch, char **argv)
  52 {
  53   char *cp = scratch;
  54
  55   for (;;)
  56     {
  57
  58       /* Scan past leading separators */
  59       while (*cp == ' ' || *cp == '\t' || *cp == '\n')
  60         {
  61           cp++;
  62         }
  63
  64       /* Break if at end of string */
  65       if (*cp == '\0')
  66         break;
  67
  68       /* Take an arg */
  69       *argv++ = cp;
  70
  71       /* Scan for next arg separator */
  72       cp = strchr (cp, ' ');
  73       if (cp == NULL)
  74         cp = strchr (cp, '\t');
  75       if (cp == NULL)
  76         cp = strchr (cp, '\n');
  77
  78       /* No separators => end of string => break */
  79       if (cp == NULL)
  80         break;
  81
  82       /* Replace the separator with a terminator */
  83       *cp++ = '\0';
  84     }
  85
  86   /* execv requires a null-terminated arg vector */
  87   *argv = NULL;
  88
  89 }
  90
  91
  92 /* Start an inferior Unix child process and sets inferior_ptid to its pid.
  93    EXEC_FILE is the file to run.
  94    ALLARGS is a string containing the arguments to the program.
  95    ENV is the environment vector to pass.  SHELL_FILE is the shell file,
  96    or NULL if we should pick one.  Errors reported with error().  */
  97
  98 /* This function is NOT-REENTRANT.  Some of the variables have been
  99    made static to ensure that they survive the vfork() call.  */
 100
 101 void
 102 fork_inferior (char *exec_file_arg, char *allargs, char **env,
 103                void (*traceme_fun) (void), void (*init_trace_fun) (int),
 104                void (*pre_trace_fun) (void), char *shell_file_arg)
 105 {
 106   int pid;
 107   char *shell_command;
 108   static char default_shell_file[] = SHELL_FILE;
 109   int len;
 110   /* Set debug_fork then attach to the child while it sleeps, to debug. */
 111   static int debug_fork = 0;
 112   /* This is set to the result of setpgrp, which if vforked, will be visible
 113      to you in the parent process.  It's only used by humans for debugging.  */
 114   static int debug_setpgrp = 657473;
 115   static char *shell_file;
 116   static char *exec_file;
 117   char **save_our_env;
 118   int shell = 0;
 119   static char **argv;
 120
 121   /* If no exec file handed to us, get it from the exec-file command -- with
 122      a good, common error message if none is specified.  */
 123   exec_file = exec_file_arg;
 124   if (exec_file == 0)
 125     exec_file = get_exec_file (1);
 126
 127   /* STARTUP_WITH_SHELL is defined in inferior.h.
 128    * If 0, we'll just do a fork/exec, no shell, so don't
 129    * bother figuring out what shell.
 130    */
 131   shell_file = shell_file_arg;
 132   if (STARTUP_WITH_SHELL)
 133     {
 134       /* Figure out what shell to start up the user program under. */
 135       if (shell_file == NULL)
 136         shell_file = getenv ("SHELL");
 137       if (shell_file == NULL)
 138         shell_file = default_shell_file;
 139       shell = 1;
 140     }
 141
 142   /* Multiplying the length of exec_file by 4 is to account for the fact
 143      that it may expand when quoted; it is a worst-case number based on
 144      every character being '.  */
 145   len = 5 + 4 * strlen (exec_file) + 1 + strlen (allargs) + 1 + /*slop */ 12;
 146   /* If desired, concat something onto the front of ALLARGS.
 147      SHELL_COMMAND is the result.  */
 148 #ifdef SHELL_COMMAND_CONCAT
 149   shell_command = (char *) alloca (strlen (SHELL_COMMAND_CONCAT) + len);
 150   strcpy (shell_command, SHELL_COMMAND_CONCAT);
 151 #else
 152   shell_command = (char *) alloca (len);
 153   shell_command[0] = '\0';
 154 #endif
 155
 156   if (!shell)
 157     {
 158       /* We're going to call execvp. Create argv */
 159       /* Largest case: every other character is a separate arg */
 160       argv = (char **) xmalloc (((strlen (allargs) + 1) / (unsigned) 2 + 2) * sizeof (*argv));
 161       argv[0] = exec_file;
 162       breakup_args (allargs, &argv[1]);
 163
 164     }
 165   else
 166     {
 167
 168       /* We're going to call a shell */
 169
 170       /* Now add exec_file, quoting as necessary.  */
 171
 172       char *p;
 173       int need_to_quote;
 174
 175       strcat (shell_command, "exec ");
 176
 177       /* Quoting in this style is said to work with all shells.  But csh
 178          on IRIX 4.0.1 can't deal with it.  So we only quote it if we need
 179          to.  */
 180       p = exec_file;
 181       while (1)
 182         {
 183           switch (*p)
 184             {
 185             case '\'':
 186             case '!':
 187             case '"':
 188             case '(':
 189             case ')':
 190             case '$':
 191             case '&':
 192             case ';':
 193             case '<':
 194             case '>':
 195             case ' ':
 196             case '\n':
 197             case '\t':
 198               need_to_quote = 1;
 199               goto end_scan;
 200
 201             case '\0':
 202               need_to_quote = 0;
 203               goto end_scan;
 204
 205             default:
 206               break;
 207             }
 208           ++p;
 209         }
 210     end_scan:
 211       if (need_to_quote)
 212         {
 213           strcat (shell_command, "'");
 214           for (p = exec_file; *p != '\0'; ++p)
 215             {
 216               if (*p == '\'')
 217                 strcat (shell_command, "'\\''");
 218               else if (*p == '!')
 219                 strcat (shell_command, "\\!");
 220               else
 221                 strncat (shell_command, p, 1);
 222             }
 223           strcat (shell_command, "'");
 224         }
 225       else
 226         strcat (shell_command, exec_file);
 227
 228       strcat (shell_command, " ");
 229       strcat (shell_command, allargs);
 230
 231     }
 232
 233   /* exec is said to fail if the executable is open.  */
 234   close_exec_file ();
 235
 236   /* Retain a copy of our environment variables, since the child will
 237      replace the value of  environ  and if we're vforked, we have to
 238      restore it.  */
 239   save_our_env = environ;
 240
 241   /* Tell the terminal handling subsystem what tty we plan to run on;
 242      it will just record the information for later.  */
 243
 244   new_tty_prefork (inferior_io_terminal);
 245
 246   /* It is generally good practice to flush any possible pending stdio
 247      output prior to doing a fork, to avoid the possibility of both the
 248      parent and child flushing the same data after the fork. */
 249
 250   gdb_flush (gdb_stdout);
 251   gdb_flush (gdb_stderr);
 252
 253   /* If there's any initialization of the target layers that must happen
 254      to prepare to handle the child we're about fork, do it now...
 255    */
 256   if (pre_trace_fun != NULL)
 257     (*pre_trace_fun) ();
 258
 259   /* Create the child process.  Note that the apparent call to vfork()
 260      below *might* actually be a call to fork() due to the fact that
 261      autoconf will ``#define vfork fork'' on certain platforms.  */
 262   if (debug_fork)
 263     pid = fork ();
 264   else
 265     pid = vfork ();
 266
 267   if (pid < 0)
 268     perror_with_name ("vfork");
 269
 270   if (pid == 0)
 271     {
 272       if (debug_fork)
 273         sleep (debug_fork);
 274
 275       /* Run inferior in a separate process group.  */
 276       debug_setpgrp = gdb_setpgid ();
 277       if (debug_setpgrp == -1)
 278         perror ("setpgrp failed in child");
 279
 280       /* Ask the tty subsystem to switch to the one we specified earlier
 281          (or to share the current terminal, if none was specified).  */
 282
 283       new_tty ();
 284
 285       /* Changing the signal handlers for the inferior after
 286          a vfork can also change them for the superior, so we don't mess
 287          with signals here.  See comments in
 288          initialize_signals for how we get the right signal handlers
 289          for the inferior.  */
 290
 291       /* "Trace me, Dr. Memory!" */
 292       (*traceme_fun) ();
 293       /* The call above set this process (the "child") as debuggable
 294        * by the original gdb process (the "parent").  Since processes
 295        * (unlike people) can have only one parent, if you are
 296        * debugging gdb itself (and your debugger is thus _already_ the
 297        * controller/parent for this child),  code from here on out
 298        * is undebuggable.  Indeed, you probably got an error message
 299        * saying "not parent".  Sorry--you'll have to use print statements!
 300        */
 301
 302       /* There is no execlpe call, so we have to set the environment
 303          for our child in the global variable.  If we've vforked, this
 304          clobbers the parent, but environ is restored a few lines down
 305          in the parent.  By the way, yes we do need to look down the
 306          path to find $SHELL.  Rich Pixley says so, and I agree.  */
 307       environ = env;
 308
 309       /* If we decided above to start up with a shell,
 310        * we exec the shell,
 311        * "-c" says to interpret the next arg as a shell command
 312        * to execute, and this command is "exec <target-program> <args>".
 313        * "-f" means "fast startup" to the c-shell, which means
 314        * don't do .cshrc file. Doing .cshrc may cause fork/exec
 315        * events which will confuse debugger start-up code.
 316        */
 317       if (shell)
 318         {
 319           execlp (shell_file, shell_file, "-c", shell_command, (char *) 0);
 320
 321           /* If we get here, it's an error */
 322           fprintf_unfiltered (gdb_stderr, "Cannot exec %s: %s.\n", shell_file,
 323                               safe_strerror (errno));
 324           gdb_flush (gdb_stderr);
 325           _exit (0177);
 326         }
 327       else
 328         {
 329           /* Otherwise, we directly exec the target program with execvp. */
 330           int i;
 331           char *errstring;
 332
 333           execvp (exec_file, argv);
 334
 335           /* If we get here, it's an error */
 336           errstring = safe_strerror (errno);
 337           fprintf_unfiltered (gdb_stderr, "Cannot exec %s ", exec_file);
 338
 339           i = 1;
 340           while (argv[i] != NULL)
 341             {
 342               if (i != 1)
 343                 fprintf_unfiltered (gdb_stderr, " ");
 344               fprintf_unfiltered (gdb_stderr, "%s", argv[i]);
 345               i++;
 346             }
 347           fprintf_unfiltered (gdb_stderr, ".\n");
 348           /* This extra info seems to be useless
 349              fprintf_unfiltered (gdb_stderr, "Got error %s.\n", errstring);
 350            */
 351           gdb_flush (gdb_stderr);
 352           _exit (0177);
 353         }
 354     }
 355
 356   /* Restore our environment in case a vforked child clob'd it.  */
 357   environ = save_our_env;
 358
 359   init_thread_list ();
 360
 361   inferior_ptid = pid_to_ptid (pid);    /* Needed for wait_for_inferior stuff below */
 362
 363   /* Now that we have a child process, make it our target, and
 364      initialize anything target-vector-specific that needs initializing.  */
 365
 366   (*init_trace_fun) (pid);
 367
 368   /* We are now in the child process of interest, having exec'd the
 369      correct program, and are poised at the first instruction of the
 370      new program.  */
 371
 372   /* Allow target dependent code to play with the new process.  This might be
 373      used to have target-specific code initialize a variable in the new process
 374      prior to executing the first instruction.  */
 375   TARGET_CREATE_INFERIOR_HOOK (pid);
 376
 377 #ifdef SOLIB_CREATE_INFERIOR_HOOK
 378   SOLIB_CREATE_INFERIOR_HOOK (pid);
 379 #endif
 380 }
 381
 382 /* An inferior Unix process CHILD_PID has been created by a call to
 383    fork() (or variants like vfork).  It is presently stopped, and waiting
 384    to be resumed.  clone_and_follow_inferior will fork the debugger,
 385    and that clone will "follow" (attach to) CHILD_PID.  The original copy
 386    of the debugger will not touch CHILD_PID again.
 387
 388    Also, the original debugger will set FOLLOWED_CHILD FALSE, while the
 389    clone will set it TRUE.
 390  */
 391 void
 392 clone_and_follow_inferior (int child_pid, int *followed_child)
 393 {
 394   int debugger_pid;
 395   int status;
 396   char pid_spelling[100];       /* Arbitrary but sufficient length. */
 397
 398   /* This semaphore is used to coordinate the two debuggers' handoff
 399      of CHILD_PID.  The original debugger will detach from CHILD_PID,
 400      and then the clone debugger will attach to it.  (It must be done
 401      this way because on some targets, only one process at a time can
 402      trace another.  Thus, the original debugger must relinquish its
 403      tracing rights before the clone can pick them up.)
 404    */
 405 #define SEM_TALK (1)
 406 #define SEM_LISTEN (0)
 407   int handoff_semaphore[2];     /* Original "talks" to [1], clone "listens" to [0] */
 408   int talk_value = 99;
 409   int listen_value;
 410
 411   /* Set debug_fork then attach to the child while it sleeps, to debug. */
 412   static int debug_fork = 0;
 413
 414   /* It is generally good practice to flush any possible pending stdio
 415      output prior to doing a fork, to avoid the possibility of both the
 416      parent and child flushing the same data after the fork. */
 417
 418   gdb_flush (gdb_stdout);
 419   gdb_flush (gdb_stderr);
 420
 421   /* Open the semaphore pipes.
 422    */
 423   status = pipe (handoff_semaphore);
 424   if (status < 0)
 425     error ("error getting pipe for handoff semaphore");
 426
 427   /* Clone the debugger.  Note that the apparent call to vfork()
 428      below *might* actually be a call to fork() due to the fact that
 429      autoconf will ``#define vfork fork'' on certain platforms.  */
 430   if (debug_fork)
 431     debugger_pid = fork ();
 432   else
 433     debugger_pid = vfork ();
 434
 435   if (debugger_pid < 0)
 436     perror_with_name ("fork");
 437
 438   /* Are we the original debugger?  If so, we must relinquish all claims
 439      to CHILD_PID. */
 440   if (debugger_pid != 0)
 441     {
 442       char signal_spelling[100];        /* Arbitrary but sufficient length */
 443
 444       /* Detach from CHILD_PID.  Deliver a "stop" signal when we do, though,
 445          so that it remains stopped until the clone debugger can attach
 446          to it.
 447        */
 448       detach_breakpoints (child_pid);
 449
 450       sprintf (signal_spelling, "%d", target_signal_to_host (TARGET_SIGNAL_STOP));
 451       target_require_detach (child_pid, signal_spelling, 1);
 452
 453       /* Notify the clone debugger that it should attach to CHILD_PID. */
 454       write (handoff_semaphore[SEM_TALK], &talk_value, sizeof (talk_value));
 455
 456       *followed_child = 0;
 457     }
 458
 459   /* We're the child. */
 460   else
 461     {
 462       if (debug_fork)
 463         sleep (debug_fork);
 464
 465       /* The child (i.e., the cloned debugger) must now attach to
 466          CHILD_PID.  inferior_ptid is presently set to the parent process
 467          of the fork, while CHILD_PID should be the child process of the
 468          fork.
 469
 470          Wait until the original debugger relinquishes control of CHILD_PID,
 471          though.
 472        */
 473       read (handoff_semaphore[SEM_LISTEN], &listen_value, sizeof (listen_value));
 474
 475       /* Note that we DON'T want to actually detach from inferior_ptid,
 476          because that would allow it to run free.  The original
 477          debugger wants to retain control of the process.  So, we
 478          just reset inferior_ptid to CHILD_PID, and then ensure that all
 479          breakpoints are really set in CHILD_PID.
 480        */
 481       target_mourn_inferior ();
 482
 483       /* Ask the tty subsystem to switch to the one we specified earlier
 484          (or to share the current terminal, if none was specified).  */
 485
 486       new_tty ();
 487
 488       dont_repeat ();
 489       sprintf (pid_spelling, "%d", child_pid);
 490       target_require_attach (pid_spelling, 1);
 491
 492       /* Perform any necessary cleanup, after attachment.  (This form
 493          of attaching can behave differently on some targets than the
 494          standard method, where a process formerly not under debugger
 495          control was suddenly attached to..)
 496        */
 497       target_post_follow_inferior_by_clone ();
 498
 499       *followed_child = 1;
 500     }
 501
 502   /* Discard the handoff sempahore. */
 503   (void) close (handoff_semaphore[SEM_LISTEN]);
 504   (void) close (handoff_semaphore[SEM_TALK]);
 505 }
 506
 507 /* Accept NTRAPS traps from the inferior.  */
 508
 509 void
 510 startup_inferior (int ntraps)
 511 {
 512   int pending_execs = ntraps;
 513   int terminal_initted;
 514
 515   /* The process was started by the fork that created it,
 516      but it will have stopped one instruction after execing the shell.
 517      Here we must get it up to actual execution of the real program.  */
 518
 519   clear_proceed_status ();
 520
 521   init_wait_for_inferior ();
 522
 523   terminal_initted = 0;
 524
 525   if (STARTUP_WITH_SHELL)
 526     inferior_ignoring_startup_exec_events = ntraps;
 527   else
 528     inferior_ignoring_startup_exec_events = 0;
 529   inferior_ignoring_leading_exec_events =
 530     target_reported_exec_events_per_exec_call () - 1;
 531
 532 #ifdef STARTUP_INFERIOR
 533   STARTUP_INFERIOR (pending_execs);
 534 #else
 535   while (1)
 536     {
 537       stop_soon_quietly = 1;    /* Make wait_for_inferior be quiet */
 538       wait_for_inferior ();
 539       if (stop_signal != TARGET_SIGNAL_TRAP)
 540         {
 541           /* Let shell child handle its own signals in its own way */
 542           /* FIXME, what if child has exit()ed?  Must exit loop somehow */
 543           resume (0, stop_signal);
 544         }
 545       else
 546         {
 547           /* We handle SIGTRAP, however; it means child did an exec.  */
 548           if (!terminal_initted)
 549             {
 550               /* Now that the child has exec'd we know it has already set its
 551                  process group.  On POSIX systems, tcsetpgrp will fail with
 552                  EPERM if we try it before the child's setpgid.  */
 553
 554               /* Set up the "saved terminal modes" of the inferior
 555                  based on what modes we are starting it with.  */
 556               target_terminal_init ();
 557
 558               /* Install inferior's terminal modes.  */
 559               target_terminal_inferior ();
 560
 561               terminal_initted = 1;
 562             }
 563
 564           pending_execs = pending_execs - 1;
 565           if (0 == pending_execs)
 566             break;
 567
 568           resume (0, TARGET_SIGNAL_0);  /* Just make it go on */
 569         }
 570     }
 571 #endif /* STARTUP_INFERIOR */
 572   stop_soon_quietly = 0;
 573 }