gdb/ser-tcp.c

   1 /* Serial interface for raw TCP connections on Un*x like systems.
   2
   3    Copyright 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2001, 2005
   4    Free Software Foundation, Inc.
   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 "serial.h"
  25 #include "ser-base.h"
  26 #include "ser-unix.h"
  27
  28 #include <sys/types.h>
  29
  30 #ifdef HAVE_SYS_FILIO_H
  31 #include <sys/filio.h>  /* For FIONBIO. */
  32 #endif
  33 #ifdef HAVE_SYS_IOCTL_H
  34 #include <sys/ioctl.h>  /* For FIONBIO. */
  35 #endif
  36
  37 #include <sys/time.h>
  38
  39 #ifdef USE_WIN32API
  40 #include <winsock2.h>
  41 #define ETIMEDOUT WSAETIMEDOUT
  42 #define close(fd) closesocket (fd)
  43 #define ioctl ioctlsocket
  44 #else
  45 #include <netinet/in.h>
  46 #include <arpa/inet.h>
  47 #include <netdb.h>
  48 #include <sys/socket.h>
  49 #include <netinet/tcp.h>
  50 #endif
  51
  52 #include <signal.h>
  53 #include "gdb_string.h"
  54
  55 #ifndef HAVE_SOCKLEN_T
  56 typedef int socklen_t;
  57 #endif
  58
  59 static int net_open (struct serial *scb, const char *name);
  60 static void net_close (struct serial *scb);
  61 void _initialize_ser_tcp (void);
  62
  63 /* seconds to wait for connect */
  64 #define TIMEOUT 15
  65 /* how many times per second to poll deprecated_ui_loop_hook */
  66 #define POLL_INTERVAL 2
  67
  68 /* Open a tcp socket */
  69
  70 static int
  71 net_open (struct serial *scb, const char *name)
  72 {
  73   char *port_str, hostname[100];
  74   int n, port, tmp;
  75   int use_udp;
  76   struct hostent *hostent;
  77   struct sockaddr_in sockaddr;
  78 #ifdef USE_WIN32API
  79   u_long ioarg;
  80 #else
  81   int ioarg;
  82 #endif
  83
  84   use_udp = 0;
  85   if (strncmp (name, "udp:", 4) == 0)
  86     {
  87       use_udp = 1;
  88       name = name + 4;
  89     }
  90   else if (strncmp (name, "tcp:", 4) == 0)
  91     name = name + 4;
  92
  93   port_str = strchr (name, ':');
  94
  95   if (!port_str)
  96     error (_("net_open: No colon in host name!"));         /* Shouldn't ever happen */
  97
  98   tmp = min (port_str - name, (int) sizeof hostname - 1);
  99   strncpy (hostname, name, tmp);        /* Don't want colon */
 100   hostname[tmp] = '\000';       /* Tie off host name */
 101   port = atoi (port_str + 1);
 102
 103   /* default hostname is localhost */
 104   if (!hostname[0])
 105     strcpy (hostname, "localhost");
 106
 107   hostent = gethostbyname (hostname);
 108   if (!hostent)
 109     {
 110       fprintf_unfiltered (gdb_stderr, "%s: unknown host\n", hostname);
 111       errno = ENOENT;
 112       return -1;
 113     }
 114
 115   if (use_udp)
 116     scb->fd = socket (PF_INET, SOCK_DGRAM, 0);
 117   else
 118     scb->fd = socket (PF_INET, SOCK_STREAM, 0);
 119
 120   if (scb->fd < 0)
 121     return -1;
 122
 123   sockaddr.sin_family = PF_INET;
 124   sockaddr.sin_port = htons (port);
 125   memcpy (&sockaddr.sin_addr.s_addr, hostent->h_addr,
 126           sizeof (struct in_addr));
 127
 128   /* set socket nonblocking */
 129   ioarg = 1;
 130   ioctl (scb->fd, FIONBIO, &ioarg);
 131
 132   /* Use Non-blocking connect.  connect() will return 0 if connected already. */
 133   n = connect (scb->fd, (struct sockaddr *) &sockaddr, sizeof (sockaddr));
 134
 135   if (n < 0
 136 #ifdef USE_WIN32API
 137       /* Under Windows, calling "connect" with a non-blocking socket
 138          results in WSAEWOULDBLOCK, not WSAEINPROGRESS.  */
 139       && WSAGetLastError() != WSAEWOULDBLOCK
 140 #else
 141       && errno != EINPROGRESS
 142 #endif
 143       )
 144     {
 145 #ifdef USE_WIN32API
 146       errno = WSAGetLastError();
 147 #endif
 148       net_close (scb);
 149       return -1;
 150     }
 151
 152   if (n)
 153     {
 154       /* looks like we need to wait for the connect */
 155       struct timeval t;
 156       fd_set rset, wset;
 157       int polls = 0;
 158       FD_ZERO (&rset);
 159
 160       do
 161         {
 162           /* While we wait for the connect to complete,
 163              poll the UI so it can update or the user can
 164              interrupt.  */
 165           if (deprecated_ui_loop_hook)
 166             {
 167               if (deprecated_ui_loop_hook (0))
 168                 {
 169                   errno = EINTR;
 170                   net_close (scb);
 171                   return -1;
 172                 }
 173             }
 174
 175           FD_SET (scb->fd, &rset);
 176           wset = rset;
 177           t.tv_sec = 0;
 178           t.tv_usec = 1000000 / POLL_INTERVAL;
 179
 180           n = select (scb->fd + 1, &rset, &wset, NULL, &t);
 181           polls++;
 182         }
 183       while (n == 0 && polls <= TIMEOUT * POLL_INTERVAL);
 184       if (n < 0 || polls > TIMEOUT * POLL_INTERVAL)
 185         {
 186           if (polls > TIMEOUT * POLL_INTERVAL)
 187             errno = ETIMEDOUT;
 188           net_close (scb);
 189           return -1;
 190         }
 191     }
 192
 193   /* Got something.  Is it an error? */
 194   {
 195     int res, err;
 196     socklen_t len;
 197     len = sizeof(err);
 198     /* On Windows, the fourth parameter to getsockopt is a "char *";
 199        on UNIX systems it is generally "void *".  The cast to "void *"
 200        is OK everywhere, since in C "void *" can be implicitly
 201        converted to any pointer type.  */
 202     res = getsockopt (scb->fd, SOL_SOCKET, SO_ERROR, (void *) &err, &len);
 203     if (res < 0 || err)
 204       {
 205         if (err)
 206           errno = err;
 207         net_close (scb);
 208         return -1;
 209       }
 210   }
 211
 212   /* turn off nonblocking */
 213   ioarg = 0;
 214   ioctl (scb->fd, FIONBIO, &ioarg);
 215
 216   if (use_udp == 0)
 217     {
 218       /* Disable Nagle algorithm. Needed in some cases. */
 219       tmp = 1;
 220       setsockopt (scb->fd, IPPROTO_TCP, TCP_NODELAY,
 221                   (char *)&tmp, sizeof (tmp));
 222     }
 223
 224 #ifdef SIGPIPE
 225   /* If we don't do this, then GDB simply exits
 226      when the remote side dies.  */
 227   signal (SIGPIPE, SIG_IGN);
 228 #endif
 229
 230   return 0;
 231 }
 232
 233 static void
 234 net_close (struct serial *scb)
 235 {
 236   if (scb->fd < 0)
 237     return;
 238
 239   close (scb->fd);
 240   scb->fd = -1;
 241 }
 242
 243 static int
 244 net_read_prim (struct serial *scb, size_t count)
 245 {
 246   return recv (scb->fd, scb->buf, count, 0);
 247 }
 248
 249 static int
 250 net_write_prim (struct serial *scb, const void *buf, size_t count)
 251 {
 252   return send (scb->fd, buf, count, 0);
 253 }
 254
 255 void
 256 _initialize_ser_tcp (void)
 257 {
 258   struct serial_ops *ops;
 259 #ifdef USE_WIN32API
 260   WSADATA wsa_data;
 261   if (WSAStartup (MAKEWORD (1, 0), &wsa_data) != 0)
 262     /* WinSock is unavailable.  */
 263     return;
 264 #endif
 265   ops = XMALLOC (struct serial_ops);
 266   memset (ops, 0, sizeof (struct serial_ops));
 267   ops->name = "tcp";
 268   ops->next = 0;
 269   ops->open = net_open;
 270   ops->close = net_close;
 271   ops->readchar = ser_base_readchar;
 272   ops->write = ser_base_write;
 273   ops->flush_output = ser_base_flush_output;
 274   ops->flush_input = ser_base_flush_input;
 275   ops->send_break = ser_base_send_break;
 276   ops->go_raw = ser_base_raw;
 277   ops->get_tty_state = ser_base_get_tty_state;
 278   ops->set_tty_state = ser_base_set_tty_state;
 279   ops->print_tty_state = ser_base_print_tty_state;
 280   ops->noflush_set_tty_state = ser_base_noflush_set_tty_state;
 281   ops->setbaudrate = ser_base_setbaudrate;
 282   ops->setstopbits = ser_base_setstopbits;
 283   ops->drain_output = ser_base_drain_output;
 284   ops->async = ser_base_async;
 285   ops->read_prim = net_read_prim;
 286   ops->write_prim = net_write_prim;
 287   serial_add_interface (ops);
 288 }