server: Add port number to socket bind error
[openocd.git] / src / server / server.c
index 73d8b5b652c97636055d72243574fc61e70d72ef..517d62a79452d5c7ca5ae7cc7dccdf22f8fa9891 100644 (file)
@@ -19,9 +19,7 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   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.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 
 #include <signal.h>
 
+#ifdef HAVE_NETDB_H
+#include <netdb.h>
+#endif
+
 #ifndef _WIN32
 #include <netinet/tcp.h>
 #endif
 
 static struct service *services;
 
-/* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
+/* shutdown_openocd == 1: exit the main event loop, and quit the
+ * debugger; 2: quit with non-zero return code */
 static int shutdown_openocd;
 
 /* store received signal to exit application by killing ourselves */
@@ -53,6 +56,9 @@ static int last_signal;
 /* set the polling period to 100ms */
 static int polling_period = 100;
 
+/* address by name on which to listen for incoming TCP/IP connections */
+static char *bindto_name;
+
 static int add_connection(struct service *service, struct command_context *cmd_ctx)
 {
        socklen_t address_size;
@@ -126,7 +132,9 @@ static int add_connection(struct service *service, struct command_context *cmd_c
                free(out_file);
                if (c->fd_out == -1) {
                        LOG_ERROR("could not open %s", service->port);
-                       exit(1);
+                       command_done(c->cmd_ctx);
+                       free(c);
+                       return ERROR_FAIL;
                }
 
                LOG_INFO("accepting '%s' connection from pipe %s", service->name, service->port);
@@ -144,7 +152,8 @@ static int add_connection(struct service *service, struct command_context *cmd_c
                ;
        *p = c;
 
-       service->max_connections--;
+       if (service->max_connections != CONNECTION_LIMIT_UNLIMITED)
+               service->max_connections--;
 
        return ERROR_OK;
 }
@@ -171,7 +180,9 @@ static int remove_connection(struct service *service, struct connection *connect
                        *p = c->next;
                        free(c);
 
-                       service->max_connections++;
+                       if (service->max_connections != CONNECTION_LIMIT_UNLIMITED)
+                               service->max_connections++;
+
                        break;
                }
 
@@ -182,7 +193,13 @@ static int remove_connection(struct service *service, struct connection *connect
        return ERROR_OK;
 }
 
-/* FIX! make service return error instead of invoking exit() */
+static void free_service(struct service *c)
+{
+       free(c->name);
+       free(c->port);
+       free(c);
+}
+
 int add_service(char *name,
        const char *port,
        int max_connections,
@@ -192,6 +209,7 @@ int add_service(char *name,
        void *priv)
 {
        struct service *c, **p;
+       struct hostent *hp;
        int so_reuseaddr_option = 1;
 
        c = malloc(sizeof(struct service));
@@ -225,7 +243,8 @@ int add_service(char *name,
                c->fd = socket(AF_INET, SOCK_STREAM, 0);
                if (c->fd == -1) {
                        LOG_ERROR("error creating socket: %s", strerror(errno));
-                       exit(-1);
+                       free_service(c);
+                       return ERROR_FAIL;
                }
 
                setsockopt(c->fd,
@@ -238,12 +257,26 @@ int add_service(char *name,
 
                memset(&c->sin, 0, sizeof(c->sin));
                c->sin.sin_family = AF_INET;
-               c->sin.sin_addr.s_addr = INADDR_ANY;
+
+               if (bindto_name == NULL)
+                       c->sin.sin_addr.s_addr = INADDR_ANY;
+               else {
+                       hp = gethostbyname(bindto_name);
+                       if (hp == NULL) {
+                               LOG_ERROR("couldn't resolve bindto address: %s", bindto_name);
+                               close_socket(c->fd);
+                               free_service(c);
+                               return ERROR_FAIL;
+                       }
+                       memcpy(&c->sin.sin_addr, hp->h_addr_list[0], hp->h_length);
+               }
                c->sin.sin_port = htons(c->portnumber);
 
                if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1) {
-                       LOG_ERROR("couldn't bind to socket: %s", strerror(errno));
-                       exit(-1);
+                       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;
                }
 
 #ifndef _WIN32
@@ -261,7 +294,9 @@ int add_service(char *name,
 
                if (listen(c->fd, 1) == -1) {
                        LOG_ERROR("couldn't listen on socket: %s", strerror(errno));
-                       exit(-1);
+                       close_socket(c->fd);
+                       free_service(c);
+                       return ERROR_FAIL;
                }
        } else if (c->type == CONNECTION_STDINOUT) {
                c->fd = fileno(stdin);
@@ -282,13 +317,15 @@ int add_service(char *name,
                /* we currenty do not support named pipes under win32
                 * so exit openocd for now */
                LOG_ERROR("Named pipes currently not supported under this os");
-               exit(1);
+               free_service(c);
+               return ERROR_FAIL;
 #else
                /* Pipe we're reading from */
                c->fd = open(c->port, O_RDONLY | O_NONBLOCK);
                if (c->fd == -1) {
                        LOG_ERROR("could not open %s", c->port);
-                       exit(1);
+                       free_service(c);
+                       return ERROR_FAIL;
                }
 #endif
        }
@@ -405,7 +442,7 @@ int server_loop(struct command_context *command_context)
                                FD_ZERO(&read_fds);
                        else {
                                LOG_ERROR("error during select: %s", strerror(errno));
-                               exit(-1);
+                               return ERROR_FAIL;
                        }
 #else
 
@@ -413,7 +450,7 @@ int server_loop(struct command_context *command_context)
                                FD_ZERO(&read_fds);
                        else {
                                LOG_ERROR("error during select: %s", strerror(errno));
-                               exit(-1);
+                               return ERROR_FAIL;
                        }
 #endif
                }
@@ -445,7 +482,7 @@ int server_loop(struct command_context *command_context)
                        /* handle new connections on listeners */
                        if ((service->fd != -1)
                            && (FD_ISSET(service->fd, &read_fds))) {
-                               if (service->max_connections > 0)
+                               if (service->max_connections != 0)
                                        add_connection(service, command_context);
                                else {
                                        if (service->type == CONNECTION_TCP) {
@@ -499,7 +536,7 @@ int server_loop(struct command_context *command_context)
 #endif
        }
 
-       return ERROR_OK;
+       return shutdown_openocd != 2 ? ERROR_OK : ERROR_FAIL;
 }
 
 #ifdef _WIN32
@@ -532,7 +569,7 @@ int server_preinit(void)
 
        if (WSAStartup(wVersionRequested, &wsaData) != 0) {
                LOG_ERROR("Failed to Open Winsock");
-               exit(-1);
+               return ERROR_FAIL;
        }
 
        /* register ctrl-c handler */
@@ -550,10 +587,18 @@ int server_preinit(void)
 int server_init(struct command_context *cmd_ctx)
 {
        int ret = tcl_init();
-       if (ERROR_OK != ret)
+
+       if (ret != ERROR_OK)
+               return ret;
+
+       ret = telnet_init("Open On-Chip Debugger");
+
+       if (ret != ERROR_OK) {
+               remove_services();
                return ret;
+       }
 
-       return telnet_init("Open On-Chip Debugger");
+       return ERROR_OK;
 }
 
 int server_quit(void)
@@ -608,6 +653,13 @@ COMMAND_HANDLER(handle_shutdown_command)
 
        shutdown_openocd = 1;
 
+       if (CMD_ARGC == 1) {
+               if (!strcmp(CMD_ARGV[0], "error")) {
+                       shutdown_openocd = 2;
+                       return ERROR_FAIL;
+               }
+       }
+
        return ERROR_COMMAND_CLOSE_CONNECTION;
 }
 
@@ -623,6 +675,22 @@ COMMAND_HANDLER(handle_poll_period_command)
        return ERROR_OK;
 }
 
+COMMAND_HANDLER(handle_bindto_command)
+{
+       switch (CMD_ARGC) {
+               case 0:
+                       command_print(CMD_CTX, "bindto name: %s", bindto_name);
+                       break;
+               case 1:
+                       free(bindto_name);
+                       bindto_name = strdup(CMD_ARGV[0]);
+                       break;
+               default:
+                       return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+       return ERROR_OK;
+}
+
 static const struct command_registration server_command_handlers[] = {
        {
                .name = "shutdown",
@@ -638,6 +706,14 @@ static const struct command_registration server_command_handlers[] = {
                .usage = "",
                .help = "set the servers polling period",
        },
+       {
+               .name = "bindto",
+               .handler = &handle_bindto_command,
+               .mode = COMMAND_ANY,
+               .usage = "[name]",
+               .help = "Specify address by name on which to listen for "
+                   "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)