2010-05-16 Michael Snyder <msnyder@vmware.com>
[external/binutils.git] / gdb / ser-pipe.c
1 /* Serial interface for a pipe to a separate program
2    Copyright (C) 1999, 2000, 2001, 2007, 2008, 2009, 2010
3    Free Software Foundation, Inc.
4
5    Contributed by Cygnus Solutions.
6
7    This file is part of GDB.
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
21
22 #include "defs.h"
23 #include "serial.h"
24 #include "ser-base.h"
25 #include "ser-unix.h"
26
27 #include "gdb_vfork.h"
28
29 #include <sys/types.h>
30 #include <sys/socket.h>
31 #include <sys/time.h>
32 #include <fcntl.h>
33 #include "gdb_string.h"
34
35 #include <signal.h>
36
37 static int pipe_open (struct serial *scb, const char *name);
38 static void pipe_close (struct serial *scb);
39
40 extern void _initialize_ser_pipe (void);
41
42 struct pipe_state
43   {
44     int pid;
45   };
46
47 /* Open up a raw pipe */
48
49 static int
50 pipe_open (struct serial *scb, const char *name)
51 {
52 #if !HAVE_SOCKETPAIR
53   return -1;
54 #else
55   struct pipe_state *state;
56   /* This chunk: */
57   /* Copyright (c) 1988, 1993
58    *      The Regents of the University of California.  All rights reserved.
59    *
60    * This code is derived from software written by Ken Arnold and
61    * published in UNIX Review, Vol. 6, No. 8.
62    */
63   int pdes[2];
64   int err_pdes[2];
65   int pid;
66
67   if (socketpair (AF_UNIX, SOCK_STREAM, 0, pdes) < 0)
68     return -1;
69   if (socketpair (AF_UNIX, SOCK_STREAM, 0, err_pdes) < 0)
70     {
71       close (pdes[0]);
72       close (pdes[1]);
73       return -1;
74     }
75
76   /* Create the child process to run the command in.  Note that the
77      apparent call to vfork() below *might* actually be a call to
78      fork() due to the fact that autoconf will ``#define vfork fork''
79      on certain platforms.  */
80   pid = vfork ();
81   
82   /* Error. */
83   if (pid == -1)
84     {
85       close (pdes[0]);
86       close (pdes[1]);
87       close (err_pdes[0]);
88       close (err_pdes[1]);
89       return -1;
90     }
91
92   if (fcntl (err_pdes[0], F_SETFL, O_NONBLOCK) == -1)
93     {
94       close (err_pdes[0]);
95       close (err_pdes[1]);
96       err_pdes[0] = err_pdes[1] = -1;
97     }
98
99   /* Child. */
100   if (pid == 0)
101     {
102       /* re-wire pdes[1] to stdin/stdout */
103       close (pdes[0]);
104       if (pdes[1] != STDOUT_FILENO)
105         {
106           dup2 (pdes[1], STDOUT_FILENO);
107           close (pdes[1]);
108         }
109       dup2 (STDOUT_FILENO, STDIN_FILENO);
110
111       if (err_pdes[0] != -1)
112         {
113           close (err_pdes[0]);
114           dup2 (err_pdes[1], STDERR_FILENO);
115           close (err_pdes[1]);
116         }
117 #if 0
118       /* close any stray FD's - FIXME - how? */
119       /* POSIX.2 B.3.2.2 "popen() shall ensure that any streams
120          from previous popen() calls that remain open in the 
121          parent process are closed in the new child process. */
122       for (old = pidlist; old; old = old->next)
123         close (fileno (old->fp));       /* don't allow a flush */
124 #endif
125       execl ("/bin/sh", "sh", "-c", name, (char *) 0);
126       _exit (127);
127     }
128
129   /* Parent. */
130   close (pdes[1]);
131   if (err_pdes[1] != -1)
132     close (err_pdes[1]);
133   /* :end chunk */
134   state = XMALLOC (struct pipe_state);
135   state->pid = pid;
136   scb->fd = pdes[0];
137   scb->error_fd = err_pdes[0];
138   scb->state = state;
139
140   /* If we don't do this, GDB simply exits when the remote side dies.  */
141   signal (SIGPIPE, SIG_IGN);
142   return 0;
143 #endif
144 }
145
146 static void
147 pipe_close (struct serial *scb)
148 {
149   struct pipe_state *state = scb->state;
150
151   if (state != NULL)
152     {
153       int pid = state->pid;
154       close (scb->fd);
155       scb->fd = -1;
156       if (scb->error_fd != -1)
157         close (scb->error_fd);
158       scb->error_fd = -1;
159       xfree (state);
160       scb->state = NULL;
161       kill (pid, SIGTERM);
162       /* Might be useful to check that the child does die,
163          and while we're waiting for it to die print any remaining
164          stderr output.  */
165     }
166 }
167
168 void
169 _initialize_ser_pipe (void)
170 {
171   struct serial_ops *ops = XMALLOC (struct serial_ops);
172
173   memset (ops, 0, sizeof (struct serial_ops));
174   ops->name = "pipe";
175   ops->next = 0;
176   ops->open = pipe_open;
177   ops->close = pipe_close;
178   ops->readchar = ser_base_readchar;
179   ops->write = ser_base_write;
180   ops->flush_output = ser_base_flush_output;
181   ops->flush_input = ser_base_flush_input;
182   ops->send_break = ser_base_send_break;
183   ops->go_raw = ser_base_raw;
184   ops->get_tty_state = ser_base_get_tty_state;
185   ops->set_tty_state = ser_base_set_tty_state;
186   ops->print_tty_state = ser_base_print_tty_state;
187   ops->noflush_set_tty_state = ser_base_noflush_set_tty_state;
188   ops->setbaudrate = ser_base_setbaudrate;
189   ops->setstopbits = ser_base_setstopbits;
190   ops->drain_output = ser_base_drain_output;
191   ops->async = ser_base_async;
192   ops->read_prim = ser_unix_read_prim;
193   ops->write_prim = ser_unix_write_prim;
194   serial_add_interface (ops);
195 }