/* Serial interface for local (hardwired) serial ports on Windows systems
- Copyright (C) 2006, 2007 Free Software Foundation, Inc.
+ Copyright (C) 2006-2015 Free Software Foundation, Inc.
This file is part of GDB.
#include <unistd.h>
#include <sys/types.h>
-#include "gdb_assert.h"
-#include "gdb_string.h"
+#include "command.h"
void _initialize_ser_windows (void);
HANDLE except_event;
};
+/* CancelIo is not available for Windows 95 OS, so we need to use
+ LoadLibrary/GetProcAddress to avoid a startup failure. */
+#define CancelIo dyn_CancelIo
+static BOOL WINAPI (*CancelIo) (HANDLE);
+
/* Open up a real live device for serial I/O. */
static int
struct ser_windows_state *state;
COMMTIMEOUTS timeouts;
- /* Only allow COM ports. */
- if (strncmp (name, "COM", 3) != 0)
- {
- errno = ENOENT;
- return -1;
- }
-
h = CreateFile (name, GENERIC_READ | GENERIC_WRITE, 0, NULL,
OPEN_EXISTING, FILE_FLAG_OVERLAPPED, NULL);
if (h == INVALID_HANDLE_VALUE)
return -1;
}
- scb->fd = _open_osfhandle ((long) h, O_RDWR);
+ scb->fd = _open_osfhandle ((intptr_t) h, O_RDWR);
if (scb->fd < 0)
{
errno = ENOENT;
return -1;
}
- state = xmalloc (sizeof (struct ser_windows_state));
- memset (state, 0, sizeof (struct ser_windows_state));
+ state = XCNEW (struct ser_windows_state);
scb->state = state;
/* Create a manual reset event to watch the input buffer. */
if (GetCommState (h, &state) == 0)
return;
- state.fParity = FALSE;
state.fOutxCtsFlow = FALSE;
state.fOutxDsrFlow = FALSE;
state.fDtrControl = DTR_CONTROL_ENABLE;
state.fNull = FALSE;
state.fAbortOnError = FALSE;
state.ByteSize = 8;
- state.Parity = NOPARITY;
scb->current_timeout = 0;
if (SetCommState (h, &state) == 0)
- warning (_("SetCommState failed\n"));
+ warning (_("SetCommState failed"));
}
static int
return (SetCommState (h, &state) != 0) ? 0 : -1;
}
+/* Implement the "setparity" serial_ops callback. */
+
+static int
+ser_windows_setparity (struct serial *scb, int parity)
+{
+ HANDLE h = (HANDLE) _get_osfhandle (scb->fd);
+ DCB state;
+
+ if (GetCommState (h, &state) == 0)
+ return -1;
+
+ switch (parity)
+ {
+ case GDBPARITY_NONE:
+ state.Parity = NOPARITY;
+ state.fParity = FALSE;
+ break;
+ case GDBPARITY_ODD:
+ state.Parity = ODDPARITY;
+ state.fParity = TRUE;
+ break;
+ case GDBPARITY_EVEN:
+ state.Parity = EVENPARITY;
+ state.fParity = TRUE;
+ break;
+ default:
+ internal_warning (__FILE__, __LINE__,
+ "Incorrect parity value: %d", parity);
+ return -1;
+ }
+
+ return (SetCommState (h, &state) != 0) ? 0 : -1;
+}
+
static int
ser_windows_setbaudrate (struct serial *scb, int rate)
{
{
struct ser_windows_state *state;
- /* Stop any pending selects. */
- CancelIo ((HANDLE) _get_osfhandle (scb->fd));
+ /* Stop any pending selects. On Windows 95 OS, CancelIo function does
+ not exist. In that case, it can be replaced by a call to CloseHandle,
+ but this is not necessary here as we do close the Windows handle
+ by calling close (scb->fd) below. */
+ if (CancelIo)
+ CancelIo ((HANDLE) _get_osfhandle (scb->fd));
state = scb->state;
CloseHandle (state->ov.hEvent);
CloseHandle (state->except_event);
the started state. */
HANDLE start_select;
/* Signaled by the main program to tell the select thread to enter
- the stopped state. */
+ the stopped state. */
HANDLE stop_select;
/* Signaled by the main program to tell the select thread to
exit. */
/* Create a new select thread for SCB executing THREAD_FN. The STATE
will be filled in by this function before return. */
-void
+static void
create_select_thread (thread_fn_type thread_fn,
struct serial *scb,
struct ser_console_state *state)
wait_events[0] = state->stop_select;
wait_events[1] = h;
- event_index = WaitForMultipleObjects (2, wait_events, FALSE, INFINITE);
+ event_index = WaitForMultipleObjects (2, wait_events,
+ FALSE, INFINITE);
if (event_index == WAIT_OBJECT_0
|| WaitForSingleObject (state->stop_select, 0) == WAIT_OBJECT_0)
SetEvent(state->have_stopped);
}
+ return 0;
}
static int
SetEvent (state->have_stopped);
}
+ return 0;
}
static DWORD WINAPI
{
select_thread_wait (state);
- if (SetFilePointer (h, 0, NULL, FILE_CURRENT) == INVALID_SET_FILE_POINTER)
+ if (SetFilePointer (h, 0, NULL, FILE_CURRENT)
+ == INVALID_SET_FILE_POINTER)
SetEvent (state->except_event);
else
SetEvent (state->read_event);
SetEvent (state->have_stopped);
}
+ return 0;
}
static void
return;
}
- state = xmalloc (sizeof (struct ser_console_state));
- memset (state, 0, sizeof (struct ser_console_state));
+ state = XCNEW (struct ser_console_state);
scb->state = state;
if (is_tty)
if (isatty (scb->fd))
{
struct ser_console_ttystate *state;
- state = (struct ser_console_ttystate *) xmalloc (sizeof *state);
+
+ state = XNEW (struct ser_console_ttystate);
state->is_a_tty = 1;
return state;
}
static struct pipe_state *
make_pipe_state (void)
{
- struct pipe_state *ps = XMALLOC (struct pipe_state);
+ struct pipe_state *ps = XCNEW (struct pipe_state);
- memset (ps, 0, sizeof (*ps));
ps->wait.read_event = INVALID_HANDLE_VALUE;
ps->wait.except_event = INVALID_HANDLE_VALUE;
ps->wait.start_select = INVALID_HANDLE_VALUE;
if (ps->input)
fclose (ps->input);
if (ps->pex)
- pex_free (ps->pex);
- /* pex_free closes ps->output. */
+ {
+ pex_free (ps->pex);
+ /* pex_free closes ps->output. */
+ }
+ else if (ps->output)
+ fclose (ps->output);
xfree (ps);
{
struct pipe_state *ps;
FILE *pex_stderr;
+ char **argv;
+ struct cleanup *back_to;
- char **argv = buildargv (name);
- struct cleanup *back_to = make_cleanup_freeargv (argv);
- if (! argv[0] || argv[0][0] == '\0')
- error ("missing child command");
+ if (name == NULL)
+ error_no_arg (_("child command"));
+ argv = gdb_buildargv (name);
+ back_to = make_cleanup_freeargv (argv);
+
+ if (! argv[0] || argv[0][0] == '\0')
+ error (_("missing child command"));
ps = make_pipe_state ();
make_cleanup (cleanup_pipe_state, ps);
all the same information here, plus err_msg provided by
pex_run, so we just raise the error here. */
if (err)
- error ("error starting child process '%s': %s: %s",
+ error (_("error starting child process '%s': %s: %s"),
name, err_msg, safe_strerror (err));
else
- error ("error starting child process '%s': %s",
+ error (_("error starting child process '%s': %s"),
name, err_msg);
}
}
return -1;
}
+static int
+pipe_windows_fdopen (struct serial *scb, int fd)
+{
+ struct pipe_state *ps;
+
+ ps = make_pipe_state ();
+
+ ps->input = fdopen (fd, "r+");
+ if (! ps->input)
+ goto fail;
+
+ ps->output = fdopen (fd, "r+");
+ if (! ps->output)
+ goto fail;
+
+ scb->fd = fd;
+ scb->state = (void *) ps;
+
+ return 0;
+
+ fail:
+ free_pipe_state (ps);
+ return -1;
+}
static void
pipe_windows_close (struct serial *scb)
HANDLE h = (HANDLE) _get_osfhandle (fd);
DWORD numBytes;
BOOL r = PeekNamedPipe (h, NULL, 0, NULL, &numBytes, NULL);
+
if (r == FALSE)
numBytes = 0;
return numBytes;
}
+int
+gdb_pipe (int pdes[2])
+{
+ if (_pipe (pdes, 512, _O_BINARY | _O_NOINHERIT) == -1)
+ return -1;
+ return 0;
+}
+
struct net_windows_state
{
struct ser_console_state base;
HANDLE sock_event;
};
+/* Check whether the socket has any pending data to be read. If so,
+ set the select thread's read event. On error, set the select
+ thread's except event. If any event was set, return true,
+ otherwise return false. */
+
+static int
+net_windows_socket_check_pending (struct serial *scb)
+{
+ struct net_windows_state *state = scb->state;
+ unsigned long available;
+
+ if (ioctlsocket (scb->fd, FIONREAD, &available) != 0)
+ {
+ /* The socket closed, or some other error. */
+ SetEvent (state->base.except_event);
+ return 1;
+ }
+ else if (available > 0)
+ {
+ SetEvent (state->base.read_event);
+ return 1;
+ }
+
+ return 0;
+}
+
static DWORD WINAPI
net_windows_select_thread (void *arg)
{
wait_events[0] = state->base.stop_select;
wait_events[1] = state->sock_event;
- event_index = WaitForMultipleObjects (2, wait_events, FALSE, INFINITE);
-
- if (event_index == WAIT_OBJECT_0
- || WaitForSingleObject (state->base.stop_select, 0) == WAIT_OBJECT_0)
- /* We have been requested to stop. */
- ;
- else if (event_index != WAIT_OBJECT_0 + 1)
- /* Some error has occured. Assume that this is an error
- condition. */
- SetEvent (state->base.except_event);
- else
+ /* Wait for something to happen on the socket. */
+ while (1)
{
+ event_index = WaitForMultipleObjects (2, wait_events, FALSE, INFINITE);
+
+ if (event_index == WAIT_OBJECT_0
+ || WaitForSingleObject (state->base.stop_select, 0) == WAIT_OBJECT_0)
+ {
+ /* We have been requested to stop. */
+ break;
+ }
+
+ if (event_index != WAIT_OBJECT_0 + 1)
+ {
+ /* Some error has occured. Assume that this is an error
+ condition. */
+ SetEvent (state->base.except_event);
+ break;
+ }
+
/* Enumerate the internal network events, and reset the
object that signalled us to catch the next event. */
- WSAEnumNetworkEvents (scb->fd, state->sock_event, &events);
-
- gdb_assert (events.lNetworkEvents & (FD_READ | FD_CLOSE));
-
+ if (WSAEnumNetworkEvents (scb->fd, state->sock_event, &events) != 0)
+ {
+ /* Something went wrong. Maybe the socket is gone. */
+ SetEvent (state->base.except_event);
+ break;
+ }
+
if (events.lNetworkEvents & FD_READ)
- SetEvent (state->base.read_event);
-
+ {
+ if (net_windows_socket_check_pending (scb))
+ break;
+
+ /* Spurious wakeup. That is, the socket's event was
+ signalled before we last called recv. */
+ }
+
if (events.lNetworkEvents & FD_CLOSE)
- SetEvent (state->base.except_event);
+ {
+ SetEvent (state->base.except_event);
+ break;
+ }
}
SetEvent (state->base.have_stopped);
}
+ return 0;
}
static void
*read = state->base.read_event;
*except = state->base.except_event;
- /* Check any pending events. This both avoids starting the thread
- unnecessarily, and handles stray FD_READ events (see below). */
- if (WaitForSingleObject (state->sock_event, 0) == WAIT_OBJECT_0)
- {
- WSANETWORKEVENTS events;
- int any = 0;
-
- /* Enumerate the internal network events, and reset the object that
- signalled us to catch the next event. */
- WSAEnumNetworkEvents (scb->fd, state->sock_event, &events);
-
- /* You'd think that FD_READ or FD_CLOSE would be set here. But,
- sometimes, neither is. I suspect that the FD_READ is set and
- the corresponding event signalled while recv is running, and
- the FD_READ is then lowered when recv consumes all the data,
- but there's no way to un-signal the event. This isn't a
- problem for the call in net_select_thread, since any new
- events after this point will not have been drained by recv.
- It just means that we can't have the obvious assert here. */
-
- /* If there is a read event, it might be still valid, or it might
- not be - it may have been signalled before we last called
- recv. Double-check that there is data. */
- if (events.lNetworkEvents & FD_READ)
- {
- unsigned long available;
-
- if (ioctlsocket (scb->fd, FIONREAD, &available) == 0
- && available > 0)
- {
- SetEvent (state->base.read_event);
- any = 1;
- }
- else
- /* Oops, no data. This call to recv will cause future
- data to retrigger the event, e.g. while we are
- in net_select_thread. */
- recv (scb->fd, NULL, 0, 0);
- }
-
- /* If there's a close event, then record it - it is obviously
- still valid, and it will not be resignalled. */
- if (events.lNetworkEvents & FD_CLOSE)
- {
- SetEvent (state->base.except_event);
- any = 1;
- }
-
- /* If we set either handle, there's no need to wake the thread. */
- if (any)
- return;
- }
-
- start_select_thread (&state->base);
+ /* Check any pending events. Otherwise, start the select
+ thread. */
+ if (!net_windows_socket_check_pending (scb))
+ start_select_thread (&state->base);
}
static void
if (ret != 0)
return ret;
- state = xmalloc (sizeof (struct net_windows_state));
- memset (state, 0, sizeof (struct net_windows_state));
+ state = XCNEW (struct net_windows_state);
scb->state = state;
/* Associate an event with the socket. */
net_close (scb);
}
+/* The serial port driver. */
+
+static const struct serial_ops hardwire_ops =
+{
+ "hardwire",
+ ser_windows_open,
+ ser_windows_close,
+ NULL,
+ ser_base_readchar,
+ ser_base_write,
+ ser_windows_flush_output,
+ ser_windows_flush_input,
+ ser_windows_send_break,
+ ser_windows_raw,
+ /* These are only used for stdin; we do not need them for serial
+ ports, so supply the standard dummies. */
+ ser_base_get_tty_state,
+ ser_base_copy_tty_state,
+ ser_base_set_tty_state,
+ ser_base_print_tty_state,
+ ser_base_noflush_set_tty_state,
+ ser_windows_setbaudrate,
+ ser_windows_setstopbits,
+ ser_windows_setparity,
+ ser_windows_drain_output,
+ ser_base_async,
+ ser_windows_read_prim,
+ ser_windows_write_prim,
+ NULL,
+ ser_windows_wait_handle
+};
+
+/* The dummy serial driver used for terminals. We only provide the
+ TTY-related methods. */
+
+static const struct serial_ops tty_ops =
+{
+ "terminal",
+ NULL,
+ ser_console_close,
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ ser_console_get_tty_state,
+ ser_base_copy_tty_state,
+ ser_base_set_tty_state,
+ ser_base_print_tty_state,
+ ser_base_noflush_set_tty_state,
+ NULL,
+ NULL,
+ NULL,
+ ser_base_drain_output,
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ ser_console_wait_handle,
+ ser_console_done_wait_handle
+};
+
+/* The pipe interface. */
+
+static const struct serial_ops pipe_ops =
+{
+ "pipe",
+ pipe_windows_open,
+ pipe_windows_close,
+ pipe_windows_fdopen,
+ ser_base_readchar,
+ ser_base_write,
+ ser_base_flush_output,
+ ser_base_flush_input,
+ ser_base_send_break,
+ ser_base_raw,
+ ser_base_get_tty_state,
+ ser_base_copy_tty_state,
+ ser_base_set_tty_state,
+ ser_base_print_tty_state,
+ ser_base_noflush_set_tty_state,
+ ser_base_setbaudrate,
+ ser_base_setstopbits,
+ ser_base_setparity,
+ ser_base_drain_output,
+ ser_base_async,
+ pipe_windows_read,
+ pipe_windows_write,
+ pipe_avail,
+ pipe_wait_handle,
+ pipe_done_wait_handle
+};
+
+/* The TCP/UDP socket driver. */
+
+static const struct serial_ops tcp_ops =
+{
+ "tcp",
+ net_windows_open,
+ net_windows_close,
+ NULL,
+ ser_base_readchar,
+ ser_base_write,
+ ser_base_flush_output,
+ ser_base_flush_input,
+ ser_tcp_send_break,
+ ser_base_raw,
+ ser_base_get_tty_state,
+ ser_base_copy_tty_state,
+ ser_base_set_tty_state,
+ ser_base_print_tty_state,
+ ser_base_noflush_set_tty_state,
+ ser_base_setbaudrate,
+ ser_base_setstopbits,
+ ser_base_setparity,
+ ser_base_drain_output,
+ ser_base_async,
+ net_read_prim,
+ net_write_prim,
+ NULL,
+ net_windows_wait_handle,
+ net_windows_done_wait_handle
+};
+
void
_initialize_ser_windows (void)
{
WSADATA wsa_data;
struct serial_ops *ops;
- /* First register the serial port driver. */
+ HMODULE hm = NULL;
- ops = XMALLOC (struct serial_ops);
- memset (ops, 0, sizeof (struct serial_ops));
- ops->name = "hardwire";
- ops->next = 0;
- ops->open = ser_windows_open;
- ops->close = ser_windows_close;
-
- ops->flush_output = ser_windows_flush_output;
- ops->flush_input = ser_windows_flush_input;
- ops->send_break = ser_windows_send_break;
+ /* First find out if kernel32 exports CancelIo function. */
+ hm = LoadLibrary ("kernel32.dll");
+ if (hm)
+ {
+ CancelIo = (void *) GetProcAddress (hm, "CancelIo");
+ FreeLibrary (hm);
+ }
+ else
+ CancelIo = NULL;
- /* These are only used for stdin; we do not need them for serial
- ports, so supply the standard dummies. */
- ops->get_tty_state = ser_base_get_tty_state;
- ops->set_tty_state = ser_base_set_tty_state;
- ops->print_tty_state = ser_base_print_tty_state;
- ops->noflush_set_tty_state = ser_base_noflush_set_tty_state;
-
- ops->go_raw = ser_windows_raw;
- ops->setbaudrate = ser_windows_setbaudrate;
- ops->setstopbits = ser_windows_setstopbits;
- ops->drain_output = ser_windows_drain_output;
- ops->readchar = ser_base_readchar;
- ops->write = ser_base_write;
- ops->async = ser_base_async;
- ops->read_prim = ser_windows_read_prim;
- ops->write_prim = ser_windows_write_prim;
- ops->wait_handle = ser_windows_wait_handle;
-
- serial_add_interface (ops);
-
- /* Next create the dummy serial driver used for terminals. We only
- provide the TTY-related methods. */
-
- ops = XMALLOC (struct serial_ops);
- memset (ops, 0, sizeof (struct serial_ops));
-
- ops->name = "terminal";
- ops->next = 0;
-
- ops->close = ser_console_close;
- ops->get_tty_state = ser_console_get_tty_state;
- ops->set_tty_state = ser_base_set_tty_state;
- ops->print_tty_state = ser_base_print_tty_state;
- ops->noflush_set_tty_state = ser_base_noflush_set_tty_state;
- ops->drain_output = ser_base_drain_output;
- ops->wait_handle = ser_console_wait_handle;
- ops->done_wait_handle = ser_console_done_wait_handle;
-
- serial_add_interface (ops);
-
- /* The pipe interface. */
-
- ops = XMALLOC (struct serial_ops);
- memset (ops, 0, sizeof (struct serial_ops));
- ops->name = "pipe";
- ops->next = 0;
- ops->open = pipe_windows_open;
- ops->close = pipe_windows_close;
- ops->readchar = ser_base_readchar;
- ops->write = ser_base_write;
- ops->flush_output = ser_base_flush_output;
- ops->flush_input = ser_base_flush_input;
- ops->send_break = ser_base_send_break;
- ops->go_raw = ser_base_raw;
- ops->get_tty_state = ser_base_get_tty_state;
- ops->set_tty_state = ser_base_set_tty_state;
- ops->print_tty_state = ser_base_print_tty_state;
- ops->noflush_set_tty_state = ser_base_noflush_set_tty_state;
- ops->setbaudrate = ser_base_setbaudrate;
- ops->setstopbits = ser_base_setstopbits;
- ops->drain_output = ser_base_drain_output;
- ops->async = ser_base_async;
- ops->read_prim = pipe_windows_read;
- ops->write_prim = pipe_windows_write;
- ops->wait_handle = pipe_wait_handle;
- ops->done_wait_handle = pipe_done_wait_handle;
- ops->avail = pipe_avail;
-
- serial_add_interface (ops);
+ serial_add_interface (&hardwire_ops);
+ serial_add_interface (&tty_ops);
+ serial_add_interface (&pipe_ops);
/* If WinSock works, register the TCP/UDP socket driver. */
/* WinSock is unavailable. */
return;
- ops = XMALLOC (struct serial_ops);
- memset (ops, 0, sizeof (struct serial_ops));
- ops->name = "tcp";
- ops->next = 0;
- ops->open = net_windows_open;
- ops->close = net_windows_close;
- ops->readchar = ser_base_readchar;
- ops->write = ser_base_write;
- ops->flush_output = ser_base_flush_output;
- ops->flush_input = ser_base_flush_input;
- ops->send_break = ser_base_send_break;
- ops->go_raw = ser_base_raw;
- ops->get_tty_state = ser_base_get_tty_state;
- ops->set_tty_state = ser_base_set_tty_state;
- ops->print_tty_state = ser_base_print_tty_state;
- ops->noflush_set_tty_state = ser_base_noflush_set_tty_state;
- ops->setbaudrate = ser_base_setbaudrate;
- ops->setstopbits = ser_base_setstopbits;
- ops->drain_output = ser_base_drain_output;
- ops->async = ser_base_async;
- ops->read_prim = net_read_prim;
- ops->write_prim = net_write_prim;
- ops->wait_handle = net_windows_wait_handle;
- ops->done_wait_handle = net_windows_done_wait_handle;
- serial_add_interface (ops);
+ serial_add_interface (&tcp_ops);
}