X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fserver%2Ftcl_server.c;h=30d55cbc348304e94ae03358f3af676d3d177153;hp=b5ca3c965a958a7081a96564aa9b8f4e125b215c;hb=b48d1f66378fac886d5bc32d7302da48c89d8a75;hpb=164cb6d04eb582207575c4b8f42c8d1eb4aa2480 diff --git a/src/server/tcl_server.c b/src/server/tcl_server.c index b5ca3c965a..30d55cbc34 100644 --- a/src/server/tcl_server.c +++ b/src/server/tcl_server.c @@ -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 * @@ -23,43 +24,40 @@ #include "tcl_server.h" +#define TCL_SERVER_VERSION "TCL Server 0.1" +#define TCL_MAX_LINE (4096) -#define TCL_SERVER_VERSION "TCL Server 0.1" -#define TCL_MAX_LINE (4096) - -typedef struct tcl_connection_s { +struct tcl_connection { int tc_linedrop; int tc_lineoffset; char tc_line[TCL_MAX_LINE]; - int tc_outerror; /* flag an output error */ -} tcl_connection_t; - -static unsigned short tcl_port = 0; + int tc_outerror;/* flag an output error */ +}; -/* commands */ -static int handle_tcl_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); +static const 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; + struct tcl_connection *tclc; tclc = connection->priv; if (tclc->tc_outerror) return ERROR_SERVER_REMOTE_CLOSED; - wlen = write_socket(connection->fd, data, len); + wlen = connection_write(connection, data, len); + if (wlen == len) return ERROR_OK; @@ -69,30 +67,31 @@ int tcl_output(connection_t *connection, const void *data, ssize_t len) } /* 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)); + tclc = malloc(sizeof(struct tcl_connection)); if (tclc == NULL) return ERROR_CONNECTION_REJECTED; - memset(tclc, 0, sizeof(tcl_connection_t)); + 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) { + Jim_Interp *interp = (Jim_Interp *)connection->cmd_ctx->interp; int retval; int i; ssize_t rlen; const char *result; int reslen; - tcl_connection_t *tclc; - char in[256]; + struct tcl_connection *tclc; + unsigned char in[256]; - rlen = read_socket(connection->fd, &in, sizeof(in)); + rlen = connection_read(connection, &in, sizeof(in)); if (rlen <= 0) { if (rlen < 0) LOG_ERROR("error during read: %s", strerror(errno)); @@ -104,15 +103,7 @@ static int tcl_input(connection_t *connection) 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; - } - + for (i = 0; i < rlen; i++) { /* buffer the data */ tclc->tc_line[tclc->tc_lineoffset] = in[i]; if (tclc->tc_lineoffset < TCL_MAX_LINE) @@ -120,7 +111,11 @@ static int tcl_input(connection_t *connection) else tclc->tc_linedrop = 1; - if (in[i] != '\n') + /* 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 */ @@ -130,18 +125,20 @@ static int tcl_input(connection_t *connection) if (retval != ERROR_OK) return retval; #undef ESTR - } - else { + } else { tclc->tc_line[tclc->tc_lineoffset-1] = '\0'; - retval = Jim_Eval_Named(interp, tclc->tc_line, "remote:connection",1); + LOG_DEBUG("Executing script:\n %s", tclc->tc_line); + retval = Jim_Eval_Named(interp, tclc->tc_line, "remote:connection", 1); + LOG_DEBUG("Result: %d\n %s", retval, + Jim_GetString(Jim_GetResult(interp), &reslen)); 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); + /* 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; } @@ -149,7 +146,7 @@ static int tcl_input(connection_t *connection) return ERROR_OK; } -static int tcl_closed(connection_t *connection) +static int tcl_closed(struct connection *connection) { /* cleanup connection context */ if (connection->priv) { @@ -161,28 +158,36 @@ static int tcl_closed(connection_t *connection) int tcl_init(void) { - int retval; - - if (tcl_port == 0) - { - LOG_WARNING("no tcl port specified, using default port 6666"); - tcl_port = 6666; + if (strcmp(tcl_port, "disabled") == 0) { + LOG_INFO("tcl server disabled"); + return ERROR_OK; } - retval = add_service("tcl", CONNECTION_TCP, tcl_port, 1, tcl_new_connection, tcl_input, tcl_closed, NULL); - return retval; + 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, "port on which to listen for incoming TCL syntax"); - 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_CONFIG, + .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); }