* Copyright (C) 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
+ * Copyright (C) 2007,2008 Øyvind Harboe *
+ * oyvind.harboe@zylin.com *
+ * *
+ * Copyright (C) 2008 by Spencer Oliver *
+ * spen@spen-soft.co.uk *
+ * *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
#include "config.h"
#endif
-#include "replacements.h"
-
#include "server.h"
-
-#include "log.h"
+#include <target/target.h>
+#include "openocd.h"
+#include "tcl_server.h"
#include "telnet_server.h"
-#include "target.h"
-
-#include <command.h>
-#include <string.h>
-#include <stdlib.h>
-#include <errno.h>
-#include <unistd.h>
-#include <sys/types.h>
-#include <fcntl.h>
+
#include <signal.h>
+
#ifndef _WIN32
#include <netinet/tcp.h>
#endif
-service_t *services = NULL;
+
+static struct service *services = NULL;
/* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
static int shutdown_openocd = 0;
-int handle_shutdown_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int add_connection(service_t *service, command_context_t *cmd_ctx)
+/* set when using pipes rather than tcp */
+int server_use_pipes = 0;
+
+static int add_connection(struct service *service, struct command_context *cmd_ctx)
{
- unsigned int address_size;
- connection_t *c, **p;
+ socklen_t address_size;
+ struct connection *c, **p;
int retval;
- int flag=1;
-
- c = malloc(sizeof(connection_t));
+ int flag = 1;
+
+ c = malloc(sizeof(struct connection));
c->fd = -1;
memset(&c->sin, 0, sizeof(c->sin));
c->cmd_ctx = copy_command_context(cmd_ctx);
c->priv = NULL;
c->next = NULL;
- address_size = sizeof(c->sin);
-
- c->fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
-
- /* This increases performance dramatically for e.g. GDB load which
- * does not have a sliding window protocol. */
- retval=setsockopt(c->fd, /* socket affected */
- IPPROTO_TCP, /* set option at TCP level */
- TCP_NODELAY, /* name of option */
- (char *)&flag, /* the cast is historical cruft */
- sizeof(int)); /* length of option value */
-
- LOG_INFO("accepting '%s' connection from %i", service->name, c->sin.sin_port);
- if ((retval = service->new_connection(c)) == ERROR_OK)
+ if (service->type == CONNECTION_TCP)
{
+ address_size = sizeof(c->sin);
+
+ c->fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
+
+ /* This increases performance dramatically for e.g. GDB load which
+ * does not have a sliding window protocol. */
+ retval = setsockopt(c->fd, /* socket affected */
+ IPPROTO_TCP, /* set option at TCP level */
+ TCP_NODELAY, /* name of option */
+ (char *)&flag, /* the cast is historical cruft */
+ sizeof(int)); /* length of option value */
+
+ LOG_INFO("accepting '%s' connection from %i", service->name, c->sin.sin_port);
+ if ((retval = service->new_connection(c)) != ERROR_OK)
+ {
+ close_socket(c->fd);
+ LOG_ERROR("attempted '%s' connection rejected", service->name);
+ free(c);
+ return retval;
+ }
}
- else
+ else if (service->type == CONNECTION_PIPE)
{
- close_socket(c->fd);
- LOG_ERROR("attempted '%s' connection rejected", service->name);
- free(c);
- return retval;
+ c->fd = service->fd;
+
+ /* do not check for new connections again on stdin */
+ service->fd = -1;
+
+ LOG_INFO("accepting '%s' connection from pipe", service->name);
+ if ((retval = service->new_connection(c)) != ERROR_OK)
+ {
+ LOG_ERROR("attempted '%s' connection rejected", service->name);
+ free(c);
+ return retval;
+ }
}
-
+
/* add to the end of linked list */
for (p = &service->connections; *p; p = &(*p)->next);
*p = c;
-
+
service->max_connections--;
-
+
return ERROR_OK;
}
-int remove_connection(service_t *service, connection_t *connection)
+static int remove_connection(struct service *service, struct connection *connection)
{
- connection_t **p = &service->connections;
- connection_t *c;
-
+ struct connection **p = &service->connections;
+ struct connection *c;
+
/* find connection */
- while((c = *p))
- {
+ while ((c = *p))
+ {
if (c->fd == connection->fd)
- {
+ {
service->connection_closed(c);
- close_socket(c->fd);
+ if (service->type == CONNECTION_TCP)
+ close_socket(c->fd);
command_done(c->cmd_ctx);
-
+
/* delete connection */
*p = c->next;
free(c);
-
+
service->max_connections++;
break;
}
-
+
/* redirect p to next list pointer */
- p = &(*p)->next;
+ p = &(*p)->next;
}
-
+
return ERROR_OK;
}
int add_service(char *name, enum connection_type type, unsigned short port, int max_connections, new_connection_handler_t new_connection_handler, input_handler_t input_handler, connection_closed_handler_t connection_closed_handler, void *priv)
{
- service_t *c, **p;
+ struct service *c, **p;
int so_reuseaddr_option = 1;
-
- c = malloc(sizeof(service_t));
-
+
+ c = malloc(sizeof(struct service));
+
c->name = strdup(name);
c->type = type;
c->port = port;
c->connection_closed = connection_closed_handler;
c->priv = priv;
c->next = NULL;
-
- if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
+
+ if (type == CONNECTION_TCP)
{
- LOG_ERROR("error creating socket: %s", strerror(errno));
- exit(-1);
+ if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
+ {
+ LOG_ERROR("error creating socket: %s", strerror(errno));
+ exit(-1);
+ }
+
+ setsockopt(c->fd, SOL_SOCKET, SO_REUSEADDR, (void*)&so_reuseaddr_option, sizeof(int));
+
+ socket_nonblock(c->fd);
+
+ memset(&c->sin, 0, sizeof(c->sin));
+ c->sin.sin_family = AF_INET;
+ c->sin.sin_addr.s_addr = INADDR_ANY;
+ c->sin.sin_port = htons(port);
+
+ if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1)
+ {
+ LOG_ERROR("couldn't bind to socket: %s", strerror(errno));
+ exit(-1);
+ }
+
+#ifndef _WIN32
+ int segsize = 65536;
+ setsockopt(c->fd, IPPROTO_TCP, TCP_MAXSEG, &segsize, sizeof(int));
+#endif
+ int window_size = 128 * 1024;
+
+ /* These setsockopt()s must happen before the listen() */
+
+ setsockopt(c->fd, SOL_SOCKET, SO_SNDBUF,
+ (char *)&window_size, sizeof(window_size));
+ setsockopt(c->fd, SOL_SOCKET, SO_RCVBUF,
+ (char *)&window_size, sizeof(window_size));
+
+ if (listen(c->fd, 1) == -1)
+ {
+ LOG_ERROR("couldn't listen on socket: %s", strerror(errno));
+ exit(-1);
+ }
}
-
- setsockopt(c->fd, SOL_SOCKET, SO_REUSEADDR, (void*)&so_reuseaddr_option, sizeof(int));
-
- socket_nonblock(c->fd);
-
- memset(&c->sin, 0, sizeof(c->sin));
- c->sin.sin_family = AF_INET;
- c->sin.sin_addr.s_addr = INADDR_ANY;
- c->sin.sin_port = htons(port);
-
- if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1)
+ else if (type == CONNECTION_PIPE)
{
- LOG_ERROR("couldn't bind to socket: %s", strerror(errno));
- exit(-1);
- }
-
-#ifndef _WIN32
- int segsize=65536;
- setsockopt(c->fd, IPPROTO_TCP, TCP_MAXSEG, &segsize, sizeof(int));
+ /* use stdin */
+ c->fd = STDIN_FILENO;
+
+#ifdef _WIN32
+ /* for win32 set stdin/stdout to binary mode */
+ if (_setmode(_fileno(stdout), _O_BINARY) < 0)
+ LOG_WARNING("cannot change stdout mode to binary");
+ if (_setmode(_fileno(stdin), _O_BINARY) < 0)
+ LOG_WARNING("cannot change stdin mode to binary");
+ if (_setmode(_fileno(stderr), _O_BINARY) < 0)
+ LOG_WARNING("cannot change stderr mode to binary");
+#else
+ socket_nonblock(c->fd);
#endif
- int window_size = 128 * 1024;
-
- /* These setsockopt()s must happen before the listen() */
-
- setsockopt(c->fd, SOL_SOCKET, SO_SNDBUF,
- (char *)&window_size, sizeof(window_size));
- setsockopt(c->fd, SOL_SOCKET, SO_RCVBUF,
- (char *)&window_size, sizeof(window_size));
-
- if (listen(c->fd, 1) == -1)
+ }
+ else
{
- LOG_ERROR("couldn't listen on socket: %s", strerror(errno));
- exit(-1);
+ LOG_ERROR("unknown connection type: %d", type);
+ exit(1);
}
-
+
/* add to the end of linked list */
for (p = &services; *p; p = &(*p)->next);
*p = c;
-
- return ERROR_OK;
-}
-int remove_service(unsigned short port)
-{
- service_t **p = &services;
- service_t *c;
-
- /* find service */
- while((c = *p))
- {
- if (c->port == port)
- {
- if (c->name)
- free(c->name);
-
- if (c->priv)
- free(c->priv);
-
- /* delete service */
- *p = c->next;
- free(c);
- }
-
- /* redirect p to next list pointer */
- p = &(*p)->next;
- }
-
return ERROR_OK;
}
-int remove_services()
+static int remove_services(void)
{
- service_t *c = services;
+ struct service *c = services;
/* loop service */
- while(c)
+ while (c)
{
- service_t *next = c->next;
+ struct service *next = c->next;
if (c->name)
free(c->name);
}
services = NULL;
-
+
return ERROR_OK;
}
-extern void lockBigLock();
-extern void unlockBigLock();
-
-int server_loop(command_context_t *command_context)
+int server_loop(struct command_context *command_context)
{
- service_t *service;
+ struct service *service;
+
+ bool poll = true;
/* used in select() */
fd_set read_fds;
- struct timeval tv;
int fd_max;
-
+
/* used in accept() */
int retval;
-
+
#ifndef _WIN32
if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
#endif
- // This function is reentrant(workaround for configuration problems)
- static int lockCount=0;
- if (lockCount++==0)
- {
- lockBigLock();
- }
-
- /* do regular tasks after at most 10ms */
- tv.tv_sec = 0;
- tv.tv_usec = 10000;
-
- while(!shutdown_openocd)
+ while (!shutdown_openocd)
{
- /* monitor sockets for acitvity */
+ /* monitor sockets for activity */
fd_max = 0;
FD_ZERO(&read_fds);
if (service->fd > fd_max)
fd_max = service->fd;
}
-
+
if (service->connections)
{
- connection_t *c;
-
+ struct connection *c;
+
for (c = service->connections; c; c = c->next)
{
/* check for activity on the connection */
}
}
}
-
+
#ifndef _WIN32
-#ifndef BUILD_ECOSBOARD
- /* add STDIN to read_fds */
- FD_SET(fileno(stdin), &read_fds);
+#if BUILD_ECOSBOARD == 0
+ if (server_use_pipes == 0)
+ {
+ /* add STDIN to read_fds */
+ FD_SET(fileno(stdin), &read_fds);
+ }
#endif
#endif
- // Only while we're sleeping we'll let others run
- unlockBigLock();
- retval = select(fd_max + 1, &read_fds, NULL, NULL, &tv);
- lockBigLock();
+ struct timeval tv;
+ tv.tv_sec = 0;
+ if (poll)
+ {
+ /* we're just polling this iteration, this is faster on embedded
+ * hosts */
+ tv.tv_usec = 0;
+ retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv);
+ } else
+ {
+ /* Every 100ms */
+ tv.tv_usec = 100000;
+ /* Only while we're sleeping we'll let others run */
+ openocd_sleep_prelude();
+ kept_alive();
+ retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv);
+ openocd_sleep_postlude();
+ }
if (retval == -1)
{
}
#endif
}
-
- target_call_timer_callbacks();
if (retval == 0)
{
- /* do regular tasks after at most 100ms */
- tv.tv_sec = 0;
- tv.tv_usec = 10000;
+ /* We only execute these callbacks when there was nothing to do or we timed out */
+ target_call_timer_callbacks();
+ process_jim_events(command_context);
+
FD_ZERO(&read_fds); /* eCos leaves read_fds unchanged in this case! */
+
+ /* We timed out/there was nothing to do, timeout rather than poll next time */
+ poll = false;
+ } else
+ {
+ /* There was something to do, next time we'll just poll */
+ poll = true;
}
-
+
for (service = services; service; service = service->next)
{
/* handle new connections on listeners */
- if ((service->fd != -1)
- && (FD_ISSET(service->fd, &read_fds)))
+ if ((service->fd != -1)
+ && (FD_ISSET(service->fd, &read_fds)))
{
if (service->max_connections > 0)
{
}
else
{
- struct sockaddr_in sin;
- unsigned int address_size = sizeof(sin);
- int tmp_fd;
- tmp_fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
- close_socket(tmp_fd);
+ if (service->type != CONNECTION_PIPE)
+ {
+ struct sockaddr_in sin;
+ socklen_t address_size = sizeof(sin);
+ int tmp_fd;
+ tmp_fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
+ close_socket(tmp_fd);
+ }
LOG_INFO("rejected '%s' connection, no more connections allowed", service->name);
}
}
-
+
/* handle activity on connections */
if (service->connections)
{
- connection_t *c;
-
+ struct connection *c;
+
for (c = service->connections; c;)
{
if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending)
{
- if (service->input(c) != ERROR_OK)
+ if ((retval = service->input(c)) != ERROR_OK)
{
- connection_t *next = c->next;
+ struct connection *next = c->next;
+ if (service->type == CONNECTION_PIPE)
+ {
+ /* if connection uses a pipe then shutdown openocd on error */
+ shutdown_openocd = 1;
+ }
remove_connection(service, c);
- LOG_INFO("dropped '%s' connection", service->name);
+ LOG_INFO("dropped '%s' connection - error %d", service->name, retval);
c = next;
continue;
}
}
}
}
-
+
#ifndef _WIN32
-#ifndef BUILD_ECOSBOARD
- if (FD_ISSET(fileno(stdin), &read_fds))
+#if BUILD_ECOSBOARD == 0
+ /* check for data on stdin if not using pipes */
+ if (server_use_pipes == 0)
{
- if (getc(stdin) == 'x')
+ if (FD_ISSET(fileno(stdin), &read_fds))
{
- shutdown_openocd = 1;
+ if (getc(stdin) == 'x')
+ {
+ shutdown_openocd = 1;
+ }
}
}
#endif
}
#endif
}
- if (--lockCount==0)
- {
- unlockBigLock();
- }
-
+
return ERROR_OK;
}
#ifdef _WIN32
BOOL WINAPI ControlHandler(DWORD dwCtrlType)
{
- shutdown_openocd = 1;
- return TRUE;
+ shutdown_openocd = 1;
+ return TRUE;
}
void sig_handler(int sig) {
- shutdown_openocd = 1;
+ shutdown_openocd = 1;
}
#endif
-int server_init()
+int server_preinit(void)
{
+ /* this currently only calls WSAStartup on native win32 systems
+ * before any socket operations are performed.
+ * This is an issue if you call init in your config script */
+
#ifdef _WIN32
WORD wVersionRequested;
WSADATA wsaData;
- wVersionRequested = MAKEWORD( 2, 2 );
+ wVersionRequested = MAKEWORD(2, 2);
if (WSAStartup(wVersionRequested, &wsaData) != 0)
{
exit(-1);
}
- SetConsoleCtrlHandler( ControlHandler, TRUE );
+ if (server_use_pipes == 0)
+ {
+ /* register ctrl-c handler */
+ SetConsoleCtrlHandler(ControlHandler, TRUE);
+ }
+ else
+ {
+ /* we are using pipes so ignore ctrl-c */
+ SetConsoleCtrlHandler(NULL, TRUE);
+ }
signal(SIGINT, sig_handler);
signal(SIGTERM, sig_handler);
signal(SIGABRT, sig_handler);
#endif
-
return ERROR_OK;
}
-int server_quit()
+int server_init(struct command_context *cmd_ctx)
+{
+ int ret = tcl_init(cmd_ctx);
+ if (ERROR_OK != ret)
+ return ret;
+
+ return telnet_init("Open On-Chip Debugger");
+}
+
+int server_quit(void)
{
remove_services();
#ifdef _WIN32
WSACleanup();
- SetConsoleCtrlHandler( ControlHandler, FALSE );
+ SetConsoleCtrlHandler(ControlHandler, FALSE);
#endif
return ERROR_OK;
}
-int server_register_commands(command_context_t *context)
+/* tell the server we want to shut down */
+COMMAND_HANDLER(handle_shutdown_command)
{
- register_command(context, NULL, "shutdown", handle_shutdown_command,
- COMMAND_ANY, "shut the server down");
-
+ LOG_USER("shutdown command invoked");
+
+ shutdown_openocd = 1;
+
return ERROR_OK;
}
-/* tell the server we want to shut down */
-int handle_shutdown_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static const struct command_registration server_command_handlers[] = {
+ {
+ .name = "shutdown",
+ .handler = &handle_shutdown_command,
+ .mode = COMMAND_ANY,
+ .help = "shut the server down",
+ },
+ COMMAND_REGISTRATION_DONE
+};
+
+int server_register_commands(struct command_context *cmd_ctx)
{
- shutdown_openocd = 1;
+ int retval = telnet_register_commands(cmd_ctx);
+ if (ERROR_OK != retval)
+ return retval;
- return ERROR_COMMAND_CLOSE_CONNECTION;
-}
+ retval = tcl_register_commands(cmd_ctx);
+ if (ERROR_OK != retval)
+ return retval;
+ return register_commands(cmd_ctx, NULL, server_command_handlers);
+}
+SERVER_PORT_COMMAND()
+{
+ switch (CMD_ARGC) {
+ case 0:
+ command_print(CMD_CTX, "%d", *out);
+ break;
+ case 1:
+ {
+ uint16_t port;
+ COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], port);
+ *out = port;
+ break;
+ }
+ default:
+ return ERROR_INVALID_ARGUMENTS;
+ }
+ return ERROR_OK;
+}
Code Review / openocd.git / blobdiff