Allow "tcl_port" to be run after config to simply display the port.
[fw/openocd] / src / server / tcl_server.c
index 2771254da80aa61f17cb378e170d85e0fa901d4b..b62f1a37e2c99e584e61020f9a13dd0d53fc9206 100644 (file)
@@ -1,5 +1,6 @@
 /***************************************************************************
- *   Copyright (C) 2008                                                    *
+ *   Copyright (C) 2010 Ã˜yvind Harboe                                      *
+ *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   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  *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
-#include <stdarg.h>
 #include "tcl_server.h"
 
-#include "../jim.h"
-#include "log.h"
-#include "command.h"
+#define TCL_SERVER_VERSION             "TCL Server 0.1"
+#define TCL_MAX_LINE                   (4096)
 
-#include <stdlib.h>
-#include <unistd.h>
-#include <errno.h>
-#include <string.h>
-#include <ctype.h>
+struct tcl_connection {
+       int tc_linedrop;
+       int tc_lineoffset;
+       char tc_line[TCL_MAX_LINE];
+       int tc_outerror;/* flag an output error */
+};
 
-#define TCL_SERVER_VERSION     "TCL Server 0.1"
-#define TCL_MAX_LINE           (4096)
-
-typedef struct tcl_connection_s {
-       int tc_linedrop;
-       int tc_lineoffset;
-       char tc_line[TCL_MAX_LINE];
-
-       int tc_outerror; /* flag an output error */
-} tcl_connection_t;
-
-extern Jim_Interp *interp;
-static unsigned short tcl_port = 0;
-
-/* commands */
-static int handle_tcl_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static char *tcl_port;
 
 /* handlers */
-static int tcl_new_connection(connection_t *connection);
-static int tcl_input(connection_t *connection);
-static int tcl_output(connection_t *connection, const void *buf, ssize_t len);
-static int tcl_closed(connection_t *connection);
+static int tcl_new_connection(struct connection *connection);
+static int tcl_input(struct connection *connection);
+static int tcl_output(struct connection *connection, const void *buf, ssize_t len);
+static int tcl_closed(struct connection *connection);
 
 /* write data out to a socket.
  *
  * this is a blocking write, so the return value must equal the length, if
  * that is not the case then flag the connection with an output error.
  */
-int tcl_output(connection_t *connection, const void *data, ssize_t len)
+int tcl_output(struct connection *connection, const void *data, ssize_t len)
 {
-       ssize_t wlen;
-       tcl_connection_t *tclc;
+       ssize_t wlen;
+       struct tcl_connection *tclc;
 
-       tclc = connection->priv;
-       if (tclc->tc_outerror)
-               return ERROR_SERVER_REMOTE_CLOSED;
+       tclc = connection->priv;
+       if (tclc->tc_outerror)
+               return ERROR_SERVER_REMOTE_CLOSED;
 
-       wlen = write_socket(connection->fd, data, len);
-       if (wlen == len)
-               return ERROR_OK;
+       wlen = connection_write(connection, data, len);
 
-       LOG_ERROR("error during write: %d != %d", (int)wlen, (int)len);
-       tclc->tc_outerror = 1;
-       return ERROR_SERVER_REMOTE_CLOSED;
-}
+       if (wlen == len)
+               return ERROR_OK;
 
+       LOG_ERROR("error during write: %d != %d", (int)wlen, (int)len);
+       tclc->tc_outerror = 1;
+       return ERROR_SERVER_REMOTE_CLOSED;
+}
 
 /* connections */
-static int tcl_new_connection(connection_t *connection)
+static int tcl_new_connection(struct connection *connection)
 {
-       tcl_connection_t *tclc;
+       struct tcl_connection *tclc;
 
-       tclc = malloc(sizeof(tcl_connection_t));
-       if (tclc == NULL)
-               return ERROR_CONNECTION_REJECTED;
+       tclc = malloc(sizeof(struct tcl_connection));
+       if (tclc == NULL)
+               return ERROR_CONNECTION_REJECTED;
 
-       memset(tclc, 0, sizeof(tcl_connection_t));
-       connection->priv = tclc;
-       return ERROR_OK;
+       memset(tclc, 0, sizeof(struct tcl_connection));
+       connection->priv = tclc;
+       return ERROR_OK;
 }
 
-static int tcl_input(connection_t *connection)
+static int tcl_input(struct connection *connection)
 {
-       int retval;
-       int i;
-       ssize_t rlen;
-       const char *result;
-       int reslen;
-       tcl_connection_t *tclc;
-       char in[256];
-
-       rlen = read_socket(connection->fd, &in, sizeof(in));
-       if (rlen <= 0) {
-               if (rlen < 0)
-                       LOG_ERROR("error during read: %s", strerror(errno));
-               return ERROR_SERVER_REMOTE_CLOSED;
-       }
-
-       tclc = connection->priv;
-       if (tclc == NULL)
-               return ERROR_CONNECTION_REJECTED;
-
-       /* push as much data into the line as possible */
-       for (i = 0; i < rlen; i++)
-       {
-               if (!isprint(in[i]) && !isspace(in[i]))
-               {
-                       /* drop this line */
-                       tclc->tc_linedrop = 1;
-                       continue;
-               }
-
-               /* buffer the data */
-               tclc->tc_line[tclc->tc_lineoffset] = in[i];
-               if (tclc->tc_lineoffset < TCL_MAX_LINE)
-                       tclc->tc_lineoffset++;
-               else
-                       tclc->tc_linedrop = 1;
-
-               if (in[i] != '\n')
-                       continue;
-
-               /* process the line */
-               if (tclc->tc_linedrop) {
+       Jim_Interp *interp = (Jim_Interp *)connection->cmd_ctx->interp;
+       int retval;
+       int i;
+       ssize_t rlen;
+       const char *result;
+       int reslen;
+       struct tcl_connection *tclc;
+       unsigned char in[256];
+
+       rlen = connection_read(connection, &in, sizeof(in));
+       if (rlen <= 0) {
+               if (rlen < 0)
+                       LOG_ERROR("error during read: %s", strerror(errno));
+               return ERROR_SERVER_REMOTE_CLOSED;
+       }
+
+       tclc = connection->priv;
+       if (tclc == NULL)
+               return ERROR_CONNECTION_REJECTED;
+
+       /* push as much data into the line as possible */
+       for (i = 0; i < rlen; i++) {
+               /* buffer the data */
+               tclc->tc_line[tclc->tc_lineoffset] = in[i];
+               if (tclc->tc_lineoffset < TCL_MAX_LINE)
+                       tclc->tc_lineoffset++;
+               else
+                       tclc->tc_linedrop = 1;
+
+               /* ctrl-z is end of command. When testing from telnet, just
+                * press ctrl-z a couple of times first to put telnet into the
+                * mode where it will send 0x1a in response to pressing ctrl-z
+                */
+               if (in[i] != '\x1a')
+                       continue;
+
+               /* process the line */
+               if (tclc->tc_linedrop) {
 #define ESTR "line too long\n"
-                       retval = tcl_output(connection, ESTR, sizeof(ESTR));
-                       if (retval != ERROR_OK)
-                               return retval;
+                       retval = tcl_output(connection, ESTR, sizeof(ESTR));
+                       if (retval != ERROR_OK)
+                               return retval;
 #undef ESTR
-               } else {
-                       tclc->tc_line[tclc->tc_lineoffset-1] = '\0';
-                       retval = Jim_Eval(interp, tclc->tc_line);
-                       result = Jim_GetString(Jim_GetResult(interp), &reslen);
-                       retval = tcl_output(connection, result, reslen);
-                       if (retval != ERROR_OK)
-                               return retval;
-                       if (memchr(result, '\n', reslen) == NULL)
-                               tcl_output(connection, "\n", 1);
-               }
-               tclc->tc_lineoffset = 0;
-               tclc->tc_linedrop = 0;
-       }
-
-       return ERROR_OK;
+               } else {
+                       tclc->tc_line[tclc->tc_lineoffset-1] = '\0';
+                       LOG_DEBUG("Executing script:\n %s", tclc->tc_line);
+                       retval = Jim_Eval_Named(interp, tclc->tc_line, "remote:connection", 1);
+                       result = Jim_GetString(Jim_GetResult(interp), &reslen);
+                       LOG_DEBUG("Result: %d\n %s", retval, result);
+                       retval = tcl_output(connection, result, reslen);
+                       if (retval != ERROR_OK)
+                               return retval;
+                       /* Always output ctrl-d as end of line to allow multiline results */
+                       tcl_output(connection, "\x1a", 1);
+               }
+
+               tclc->tc_lineoffset = 0;
+               tclc->tc_linedrop = 0;
+       }
+
+       return ERROR_OK;
 }
 
-static int tcl_closed(connection_t *connection)
+static int tcl_closed(struct connection *connection)
 {
-       /* cleanup connection context */
-       if (connection->priv) {
-               free(connection->priv);
-               connection->priv = NULL;
-       }
-       return ERROR_OK;
+       /* cleanup connection context */
+       if (connection->priv) {
+               free(connection->priv);
+               connection->priv = NULL;
+       }
+       return ERROR_OK;
 }
 
 int tcl_init(void)
 {
-       int retval;
-
-       if (tcl_port == 0)
-       {
-               LOG_WARNING("no tcl port specified, using default port 6666");
-               tcl_port = 6666;
-       }
-
-       retval = add_service("tcl", CONNECTION_TCL, tcl_port, 1, tcl_new_connection, tcl_input, tcl_closed, NULL);
-       return retval;
+       if (strcmp(tcl_port, "disabled") == 0) {
+               LOG_INFO("tcl server disabled");
+               return ERROR_OK;
+       }
+
+       return add_service("tcl", tcl_port, 1,
+               &tcl_new_connection, &tcl_input,
+               &tcl_closed, NULL);
 }
 
-
-int tcl_register_commands(command_context_t *cmd_ctx)
+COMMAND_HANDLER(handle_tcl_port_command)
 {
-       register_command(cmd_ctx, NULL, "tcl_port", handle_tcl_port_command, COMMAND_CONFIG, "");
-       return ERROR_OK;
+       return CALL_COMMAND_HANDLER(server_pipe_command, &tcl_port);
 }
 
-static int handle_tcl_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static const struct command_registration tcl_command_handlers[] = {
+       {
+               .name = "tcl_port",
+               .handler = handle_tcl_port_command,
+               .mode = COMMAND_ANY,
+               .help = "Specify port on which to listen "
+                       "for incoming Tcl syntax.  "
+                       "Read help on 'gdb_port'.",
+               .usage = "[port_num]",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+int tcl_register_commands(struct command_context *cmd_ctx)
 {
-       if (argc == 1) {
-               tcl_port = strtoul(args[0], NULL, 0);
-       }
-       return ERROR_OK;
+       tcl_port = strdup("6666");
+       return register_commands(cmd_ctx, NULL, tcl_command_handlers);
 }