server/server: Add ability to remove services
[openocd.git] / src / server / server.c
index 8009d408feacac451e0a1b960c1ae0516ef8f7f2..f8273d42d9effd559c03dd4269042bf8e2bf5f87 100644 (file)
 
 static struct service *services;
 
-/* shutdown_openocd == 1: exit the main event loop, and quit the
- * debugger; 2: quit with non-zero return code */
-static int shutdown_openocd;
+enum shutdown_reason {
+       CONTINUE_MAIN_LOOP,                     /* stay in main event loop */
+       SHUTDOWN_REQUESTED,                     /* set by shutdown command; exit the event loop and quit the debugger */
+       SHUTDOWN_WITH_ERROR_CODE,       /* set by shutdown command; quit with non-zero return code */
+       SHUTDOWN_WITH_SIGNAL_CODE       /* set by sig_handler; exec shutdown then exit with signal as return code */
+};
+static enum shutdown_reason shutdown_openocd = CONTINUE_MAIN_LOOP;
 
 /* store received signal to exit application by killing ourselves */
 static int last_signal;
@@ -259,7 +263,7 @@ int add_service(char *name,
                c->sin.sin_family = AF_INET;
 
                if (bindto_name == NULL)
-                       c->sin.sin_addr.s_addr = INADDR_ANY;
+                       c->sin.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
                else {
                        hp = gethostbyname(bindto_name);
                        if (hp == NULL) {
@@ -273,7 +277,7 @@ int add_service(char *name,
                c->sin.sin_port = htons(c->portnumber);
 
                if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1) {
-                       LOG_ERROR("couldn't bind %s to socket: %s", name, strerror(errno));
+                       LOG_ERROR("couldn't bind %s to socket on port %d: %s", name, c->portnumber, strerror(errno));
                        close_socket(c->fd);
                        free_service(c);
                        return ERROR_FAIL;
@@ -298,6 +302,13 @@ int add_service(char *name,
                        free_service(c);
                        return ERROR_FAIL;
                }
+
+               struct sockaddr_in addr_in;
+               addr_in.sin_port = 0;
+               socklen_t addr_in_size = sizeof(addr_in);
+               if (getsockname(c->fd, (struct sockaddr *)&addr_in, &addr_in_size) == 0)
+                       LOG_INFO("Listening on port %hu for %s connections",
+                                ntohs(addr_in.sin_port), name);
        } else if (c->type == CONNECTION_STDINOUT) {
                c->fd = fileno(stdin);
 
@@ -338,6 +349,50 @@ int add_service(char *name,
        return ERROR_OK;
 }
 
+static void remove_connections(struct service *service)
+{
+       struct connection *connection;
+
+       connection = service->connections;
+
+       while (connection) {
+               struct connection *tmp;
+
+               tmp = connection->next;
+               remove_connection(service, connection);
+               connection = tmp;
+       }
+}
+
+int remove_service(const char *name, const char *port)
+{
+       struct service *tmp;
+       struct service *prev;
+
+       prev = services;
+
+       for (tmp = services; tmp; prev = tmp, tmp = tmp->next) {
+               if (!strcmp(tmp->name, name) && !strcmp(tmp->port, port)) {
+                       remove_connections(tmp);
+
+                       if (tmp == services)
+                               services = tmp->next;
+                       else
+                               prev->next = tmp->next;
+
+                       if (tmp->type != CONNECTION_STDINOUT)
+                               close_socket(tmp->fd);
+
+                       free(tmp->priv);
+                       free_service(tmp);
+
+                       return ERROR_OK;
+               }
+       }
+
+       return ERROR_OK;
+}
+
 static int remove_services(void)
 {
        struct service *c = services;
@@ -346,6 +401,8 @@ static int remove_services(void)
        while (c) {
                struct service *next = c->next;
 
+               remove_connections(c);
+
                if (c->name)
                        free(c->name);
 
@@ -389,7 +446,7 @@ int server_loop(struct command_context *command_context)
                LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
 #endif
 
-       while (!shutdown_openocd) {
+       while (shutdown_openocd == CONTINUE_MAIN_LOOP) {
                /* monitor sockets for activity */
                fd_max = 0;
                FD_ZERO(&read_fds);
@@ -481,7 +538,7 @@ int server_loop(struct command_context *command_context)
                for (service = services; service; service = service->next) {
                        /* handle new connections on listeners */
                        if ((service->fd != -1)
-                           && (FD_ISSET(service->fd, &read_fds))) {
+                               && (FD_ISSET(service->fd, &read_fds))) {
                                if (service->max_connections != 0)
                                        add_connection(service, command_context);
                                else {
@@ -513,7 +570,7 @@ int server_loop(struct command_context *command_context)
                                                                        service->type == CONNECTION_STDINOUT) {
                                                                /* if connection uses a pipe then
                                                                 * shutdown openocd on error */
-                                                               shutdown_openocd = 1;
+                                                               shutdown_openocd = SHUTDOWN_REQUESTED;
                                                        }
                                                        remove_connection(service, c);
                                                        LOG_INFO("dropped '%s' connection",
@@ -531,29 +588,48 @@ int server_loop(struct command_context *command_context)
                MSG msg;
                while (PeekMessage(&msg, NULL, 0, 0, PM_REMOVE)) {
                        if (msg.message == WM_QUIT)
-                               shutdown_openocd = 1;
+                               shutdown_openocd = SHUTDOWN_WITH_SIGNAL_CODE;
                }
 #endif
        }
 
-       return shutdown_openocd != 2 ? ERROR_OK : ERROR_FAIL;
+       /* when quit for signal or CTRL-C, run (eventually user implemented) "shutdown" */
+       if (shutdown_openocd == SHUTDOWN_WITH_SIGNAL_CODE)
+               command_run_line(command_context, "shutdown");
+
+       return shutdown_openocd == SHUTDOWN_WITH_ERROR_CODE ? ERROR_FAIL : ERROR_OK;
 }
 
+void sig_handler(int sig)
+{
+       /* store only first signal that hits us */
+       if (shutdown_openocd == CONTINUE_MAIN_LOOP) {
+               shutdown_openocd = SHUTDOWN_WITH_SIGNAL_CODE;
+               last_signal = sig;
+               LOG_DEBUG("Terminating on Signal %d", sig);
+       } else
+               LOG_DEBUG("Ignored extra Signal %d", sig);
+}
+
+
 #ifdef _WIN32
 BOOL WINAPI ControlHandler(DWORD dwCtrlType)
 {
-       shutdown_openocd = 1;
+       shutdown_openocd = SHUTDOWN_WITH_SIGNAL_CODE;
        return TRUE;
 }
-#endif
-
-void sig_handler(int sig)
+#else
+static void sigkey_handler(int sig)
 {
-       /* store only first signal that hits us */
-       if (!last_signal)
-               last_signal = sig;
-       shutdown_openocd = 1;
+       /* ignore keystroke generated signals if not in foreground process group */
+
+       if (tcgetpgrp(STDIN_FILENO) > 0)
+               sig_handler(sig);
+       else
+               LOG_DEBUG("Ignored Signal %d", sig);
 }
+#endif
+
 
 int server_preinit(void)
 {
@@ -576,8 +652,13 @@ int server_preinit(void)
        SetConsoleCtrlHandler(ControlHandler, TRUE);
 
        signal(SIGBREAK, sig_handler);
-#endif
        signal(SIGINT, sig_handler);
+#else
+       signal(SIGHUP, sig_handler);
+       signal(SIGPIPE, sig_handler);
+       signal(SIGQUIT, sigkey_handler);
+       signal(SIGINT, sigkey_handler);
+#endif
        signal(SIGTERM, sig_handler);
        signal(SIGABRT, sig_handler);
 
@@ -617,6 +698,13 @@ int server_quit(void)
        return last_signal;
 }
 
+void server_free(void)
+{
+       tcl_service_free();
+       telnet_service_free();
+       jsp_service_free();
+}
+
 void exit_on_signal(int sig)
 {
 #ifndef _WIN32
@@ -651,11 +739,11 @@ COMMAND_HANDLER(handle_shutdown_command)
 {
        LOG_USER("shutdown command invoked");
 
-       shutdown_openocd = 1;
+       shutdown_openocd = SHUTDOWN_REQUESTED;
 
        if (CMD_ARGC == 1) {
                if (!strcmp(CMD_ARGV[0], "error")) {
-                       shutdown_openocd = 2;
+                       shutdown_openocd = SHUTDOWN_WITH_ERROR_CODE;
                        return ERROR_FAIL;
                }
        }
@@ -712,7 +800,7 @@ static const struct command_registration server_command_handlers[] = {
                .mode = COMMAND_ANY,
                .usage = "[name]",
                .help = "Specify address by name on which to listen for "
-                   "incoming TCP/IP connections",
+                       "incoming TCP/IP connections",
        },
        COMMAND_REGISTRATION_DONE
 };

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)