libustcomm: change char * to const char * where relevant
[ust.git] / libustcomm / ustcomm.c
index 2773b1a0a4fc7c299a95e3a6897a993c5eefbb60..fd5e360e343a7e495330115d060396bdf4179365 100644 (file)
@@ -1,3 +1,20 @@
+/* Copyright (C) 2009  Pierre-Marc Fournier
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
 #define _GNU_SOURCE
 #include <sys/types.h>
 #include <signal.h>
@@ -6,6 +23,7 @@
 #include <sys/un.h>
 #include <unistd.h>
 #include <poll.h>
+#include <sys/stat.h>
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <execinfo.h>
 
 #include "ustcomm.h"
-#include "localerr.h"
+#include "usterr.h"
 
 #define UNIX_PATH_MAX 108
-#define SOCK_DIR "/tmp/socks"
-#define UST_SIGNAL SIGIO
 
 #define MSG_MAX 1000
 
 //     backtrace_symbols_fd(buffer, result, STDERR_FILENO);
 //}
 
-static void signal_process(pid_t pid)
+char *strdup_malloc(const char *s)
 {
-       int result;
+       char *retval;
 
-       result = kill(pid, UST_SIGNAL);
-       if(result == -1) {
-               PERROR("kill");
-               return;
-       }
+       if(s == NULL)
+               return NULL;
+
+       retval = (char *) malloc(strlen(s)+1);
+
+       strcpy(retval, s);
 
-       sleep(1);
+       return retval;
 }
 
-int send_message_path(const char *path, const char *msg, char **reply, int signalpid)
+static int signal_process(pid_t pid)
+{
+       return 0;
+}
+
+int pid_is_online(pid_t pid) {
+       return 1;
+}
+
+static int send_message_fd(int fd, const char *msg)
 {
-       int fd;
        int result;
-       struct sockaddr_un addr;
 
-       result = fd = socket(PF_UNIX, SOCK_STREAM, 0);
+       result = send(fd, msg, strlen(msg), MSG_NOSIGNAL);
        if(result == -1) {
-               PERROR("socket");
+               PERROR("send");
                return -1;
        }
+       else if(result == 0) {
+               return 0;
+       }
 
-       addr.sun_family = AF_UNIX;
+       return 1;
+}
+
+/* Called by an app to ask the consumer daemon to connect to it. */
+
+int ustcomm_request_consumer(pid_t pid, const char *channel)
+{
+       char path[UNIX_PATH_MAX];
+       int result;
+       char *msg=NULL;
+       int retval = 0;
+       struct ustcomm_connection conn;
+       char *explicit_daemon_socket_path;
+
+       explicit_daemon_socket_path = getenv("UST_DAEMON_SOCKET");
+       if(explicit_daemon_socket_path) {
+               /* user specified explicitly a socket path */
+               result = snprintf(path, UNIX_PATH_MAX, "%s", explicit_daemon_socket_path);
+       }
+       else {
+               /* just use the default path */
+               result = snprintf(path, UNIX_PATH_MAX, "%s/ustd", SOCK_DIR);
+       }
 
-       result = snprintf(addr.sun_path, UNIX_PATH_MAX, "%s", path);
        if(result >= UNIX_PATH_MAX) {
                ERR("string overflow allocating socket name");
                return -1;
        }
 
-       if(signalpid >= 0)
-               signal_process(signalpid);
+       asprintf(&msg, "collect %d %s", pid, channel); 
 
-       result = connect(fd, (struct sockaddr *)&addr, sizeof(addr));
+       /* don't signal it because it's the daemon */
+       result = ustcomm_connect_path(path, &conn, -1);
        if(result == -1) {
-               PERROR("connect");
-               return -1;
+               WARN("ustcomm_connect_path failed");
+               retval = -1;
+               goto del_string;
        }
 
-       result = send(fd, msg, strlen(msg), 0);
+       result = ustcomm_send_request(&conn, msg, NULL);
        if(result == -1) {
-               PERROR("send");
-               return -1;
+               WARN("ustcomm_send_request failed");
+               retval = -1;
+               goto disconnect;
        }
 
-       if(!reply)
-               return 0;
-
-       *reply = (char *) malloc(MSG_MAX+1);
-       result = recvfrom(fd, *reply, MSG_MAX, 0, NULL, NULL);
-       if(result == -1) {
-               PERROR("recvfrom");
-               return -1;
-       }
-       
-       (*reply)[result] = '\0';
+       disconnect:
+       ustcomm_disconnect(&conn);
+       del_string:
+       free(msg);
 
-       return 0;
+       return retval;
 }
 
-/* pid: the pid of the trace process that must receive the msg
-   msg: pointer to a null-terminated message to send
-   reply: location where to put the null-terminated string of the reply;
-         it must be free'd after usage
+/* returns 1 to indicate a message was received
+ * returns 0 to indicate no message was received (cannot happen)
+ * returns -1 to indicate an error
  */
 
-int send_message(pid_t pid, const char *msg, char **reply)
+static int recv_message_fd(int fd, char **msg, struct ustcomm_source *src)
 {
        int result;
-       char path[UNIX_PATH_MAX];
 
-       result = snprintf(path, UNIX_PATH_MAX, "%s/%d", SOCK_DIR, pid);
-       if(result >= UNIX_PATH_MAX) {
-               fprintf(stderr, "string overflow allocating socket name");
+       *msg = (char *) malloc(MSG_MAX+1);
+
+       result = recv(fd, *msg, MSG_MAX, 0);
+       if(result == -1) {
+               PERROR("recv");
                return -1;
        }
 
-       send_message_path(path, msg, reply, pid);
+       (*msg)[result] = '\0';
+       
+       DBG("ustcomm_app_recv_message: result is %d, message is %s", result, (*msg));
 
-       return 0;
-}
+       if(src)
+               src->fd = fd;
 
-/* Called by an app to ask the consumer daemon to connect to it. */
+       return 1;
+}
 
-int ustcomm_request_consumer(pid_t pid, const char *channel)
+int ustcomm_send_reply(struct ustcomm_server *server, char *msg, struct ustcomm_source *src)
 {
-       char path[UNIX_PATH_MAX];
        int result;
-       char *msg;
 
-       result = snprintf(path, UNIX_PATH_MAX, "%s/ustd", SOCK_DIR);
-       if(result >= UNIX_PATH_MAX) {
-               fprintf(stderr, "string overflow allocating socket name");
+       result = send_message_fd(src->fd, msg);
+       if(result < 0) {
+               ERR("error in send_message_fd");
                return -1;
        }
 
-       asprintf(&msg, "collect %d %s", pid, channel); 
-
-       send_message_path(path, msg, NULL, -1);
-       free(msg);
-
        return 0;
-}
+} 
 
-static int recv_message_fd(int fd, char **msg, struct ustcomm_source *src)
-{
-       int result;
+/* Called after a fork. */
 
-       *msg = (char *) malloc(MSG_MAX+1);
+int ustcomm_close_all_connections(struct ustcomm_server *server)
+{
+       struct ustcomm_connection *conn;
+       struct ustcomm_connection *deletable_conn = NULL;
 
-       result = recv(fd, *msg, MSG_MAX, 0);
-       if(result == -1) {
-               PERROR("recvfrom");
-               return -1;
+       list_for_each_entry(conn, &server->connections, list) {
+               free(deletable_conn);
+               deletable_conn = conn;
+               close(conn->fd);
+               list_del(&conn->list);
        }
 
-       (*msg)[result] = '\0';
-       
-       DBG("ustcomm_app_recv_message: result is %d, message is %s", result, (*msg));
-
        return 0;
 }
 
-int ustcomm_ustd_recv_message(struct ustcomm_ustd *ustd, char **msg, struct ustcomm_source *src)
+/* @timeout: max blocking time in milliseconds, -1 means infinity
+ *
+ * returns 1 to indicate a message was received
+ * returns 0 to indicate no message was received
+ * returns -1 to indicate an error
+ */
+
+int ustcomm_recv_message(struct ustcomm_server *server, char **msg, struct ustcomm_source *src, int timeout)
 {
        struct pollfd *fds;
        struct ustcomm_connection *conn;
@@ -172,7 +216,7 @@ int ustcomm_ustd_recv_message(struct ustcomm_ustd *ustd, char **msg, struct ustc
                int idx = 0;
                int n_fds = 1;
 
-               list_for_each_entry(conn, &ustd->connections, list) {
+               list_for_each_entry(conn, &server->connections, list) {
                        n_fds++;
                }
 
@@ -183,27 +227,31 @@ int ustcomm_ustd_recv_message(struct ustcomm_ustd *ustd, char **msg, struct ustc
                }
 
                /* special idx 0 is for listening socket */
-               fds[idx].fd = ustd->listen_fd;
+               fds[idx].fd = server->listen_fd;
                fds[idx].events = POLLIN;
                idx++;
 
-               list_for_each_entry(conn, &ustd->connections, list) {
+               list_for_each_entry(conn, &server->connections, list) {
                        fds[idx].fd = conn->fd;
                        fds[idx].events = POLLIN;
                        idx++;
                }
 
-               result = poll(fds, n_fds, -1);
+               while((result = poll(fds, n_fds, timeout)) == -1 && errno == EINTR)
+                       /* nothing */;
                if(result == -1) {
                        PERROR("poll");
                        return -1;
                }
 
+               if(result == 0)
+                       return 0;
+
                if(fds[0].revents) {
                        struct ustcomm_connection *newconn;
                        int newfd;
 
-                       result = newfd = accept(ustd->listen_fd, NULL, NULL);
+                       result = newfd = accept(server->listen_fd, NULL, NULL);
                        if(result == -1) {
                                PERROR("accept");
                                return -1;
@@ -217,7 +265,7 @@ int ustcomm_ustd_recv_message(struct ustcomm_ustd *ustd, char **msg, struct ustc
 
                        newconn->fd = newfd;
 
-                       list_add(&newconn->list, &ustd->connections);
+                       list_add(&newconn->list, &server->connections);
                }
 
                for(idx=1; idx<n_fds; idx++) {
@@ -227,7 +275,7 @@ int ustcomm_ustd_recv_message(struct ustcomm_ustd *ustd, char **msg, struct ustc
                                        /* connection finished */
                                        close(fds[idx].fd);
 
-                                       list_for_each_entry(conn, &ustd->connections, list) {
+                                       list_for_each_entry(conn, &server->connections, list) {
                                                if(conn->fd == fds[idx].fd) {
                                                        list_del(&conn->list);
                                                        break;
@@ -248,12 +296,37 @@ free_fds_return:
        return retval;
 }
 
-int ustcomm_app_recv_message(struct ustcomm_app *app, char **msg, struct ustcomm_source *src)
+int ustcomm_ustd_recv_message(struct ustcomm_ustd *ustd, char **msg, struct ustcomm_source *src, int timeout)
 {
-       return ustcomm_ustd_recv_message((struct ustcomm_ustd *)app, msg, src);
+       return ustcomm_recv_message(&ustd->server, msg, src, timeout);
 }
 
-static int init_named_socket(char *name, char **path_out)
+int ustcomm_app_recv_message(struct ustcomm_app *app, char **msg, struct ustcomm_source *src, int timeout)
+{
+       return ustcomm_recv_message(&app->server, msg, src, timeout);
+}
+
+/* This removes src from the list of active connections of app.
+ */
+
+int ustcomm_app_detach_client(struct ustcomm_app *app, struct ustcomm_source *src)
+{
+       struct ustcomm_server *server = (struct ustcomm_server *)app;
+       struct ustcomm_connection *conn;
+
+       list_for_each_entry(conn, &server->connections, list) {
+               if(conn->fd == src->fd) {
+                       list_del(&conn->list);
+                       goto found;
+               }
+       }
+
+       return -1;
+found:
+       return src->fd;
+}
+
+static int init_named_socket(const char *name, char **path_out)
 {
        int result;
        int fd;
@@ -295,8 +368,7 @@ static int init_named_socket(char *name, char **path_out)
        }
 
        if(path_out) {
-               *path_out = "";
-               *path_out = strdupa(addr.sun_path);
+               *path_out = strdup(addr.sun_path);
        }
 
        return fd;
@@ -307,52 +379,166 @@ static int init_named_socket(char *name, char **path_out)
        return -1;
 }
 
-int ustcomm_init_app(pid_t pid, struct ustcomm_app *handle)
+/*
+ * Return value:
+ *   0: Success, but no reply because recv() returned 0
+ *   1: Success
+ *   -1: Error
+ *
+ * On error, the error message is printed, except on
+ * ECONNRESET, which is normal when the application dies.
+ */
+
+int ustcomm_send_request(struct ustcomm_connection *conn, const char *req, char **reply)
 {
        int result;
-       char *name;
 
-       result = asprintf(&name, "%s/%d", SOCK_DIR, (int)pid);
+       result = send(conn->fd, req, strlen(req), MSG_NOSIGNAL);
+       if(result == -1) {
+               if(errno != EPIPE)
+                       PERROR("send");
+               return -1;
+       }
+
+       if(!reply)
+               return 1;
+
+       *reply = (char *) malloc(MSG_MAX+1);
+       result = recv(conn->fd, *reply, MSG_MAX, 0);
+       if(result == -1) {
+               if(errno != ECONNRESET)
+                       PERROR("recv");
+               return -1;
+       }
+       else if(result == 0) {
+               return 0;
+       }
+       
+       (*reply)[result] = '\0';
+
+       return 1;
+}
+
+int ustcomm_connect_path(const char *path, struct ustcomm_connection *conn, pid_t signalpid)
+{
+       int fd;
+       int result;
+       struct sockaddr_un addr;
+
+       result = fd = socket(PF_UNIX, SOCK_STREAM, 0);
+       if(result == -1) {
+               PERROR("socket");
+               return -1;
+       }
+
+       addr.sun_family = AF_UNIX;
+
+       result = snprintf(addr.sun_path, UNIX_PATH_MAX, "%s", path);
        if(result >= UNIX_PATH_MAX) {
                ERR("string overflow allocating socket name");
                return -1;
        }
 
-       handle->listen_fd = init_named_socket(name, &(handle->socketpath));
-       if(handle->listen_fd < 0) {
-               ERR("error initializing named socket");
-               goto free_name;
+       if(signalpid >= 0) {
+               result = signal_process(signalpid);
+               if(result == -1) {
+                       ERR("could not signal process");
+                       return -1;
+               }
+       }
+
+       result = connect(fd, (struct sockaddr *)&addr, sizeof(addr));
+       if(result == -1) {
+               PERROR("connect");
+               return -1;
        }
-       free(name);
 
-       INIT_LIST_HEAD(&handle->connections);
+       conn->fd = fd;
 
        return 0;
+}
 
-free_name:
-       free(name);
-       return -1;
+int ustcomm_disconnect(struct ustcomm_connection *conn)
+{
+       return close(conn->fd);
 }
 
-int ustcomm_init_ustd(struct ustcomm_ustd *handle)
+int ustcomm_connect_app(pid_t pid, struct ustcomm_connection *conn)
+{
+       int result;
+       char path[UNIX_PATH_MAX];
+
+
+       result = snprintf(path, UNIX_PATH_MAX, "%s/%d", SOCK_DIR, pid);
+       if(result >= UNIX_PATH_MAX) {
+               ERR("string overflow allocating socket name");
+               return -1;
+       }
+
+       return ustcomm_connect_path(path, conn, pid);
+}
+
+static int ensure_dir_exists(const char *dir)
+{
+       struct stat st;
+       int result;
+
+       if(!strcmp(dir, ""))
+               return -1;
+
+       result = stat(dir, &st);
+       if(result == -1 && errno != ENOENT) {
+               return -1;
+       }
+       else if(result == -1) {
+               /* ENOENT */
+               char buf[200];
+               int result;
+
+               result = snprintf(buf, sizeof(buf), "mkdir -p \"%s\"", dir);
+               if(result >= sizeof(buf)) {
+                       ERR("snprintf buffer overflow");
+                       return -1;
+               }
+               result = system(buf);
+               if(result != 0) {
+                       ERR("executing command %s", buf);
+                       return -1;
+               }
+       }
+
+       return 0;
+}
+
+/* Called by an application to initialize its server so daemons can
+ * connect to it.
+ */
+
+int ustcomm_init_app(pid_t pid, struct ustcomm_app *handle)
 {
        int result;
        char *name;
 
-       result = asprintf(&name, "%s/%s", SOCK_DIR, "ustd");
+       result = asprintf(&name, "%s/%d", SOCK_DIR, (int)pid);
        if(result >= UNIX_PATH_MAX) {
                ERR("string overflow allocating socket name");
                return -1;
        }
 
-       handle->listen_fd = init_named_socket(name, &handle->socketpath);
-       if(handle->listen_fd < 0) {
-               ERR("error initializing named socket");
+       result = ensure_dir_exists(SOCK_DIR);
+       if(result == -1) {
+               ERR("Unable to create socket directory %s", SOCK_DIR);
+               return -1;
+       }
+
+       handle->server.listen_fd = init_named_socket(name, &(handle->server.socketpath));
+       if(handle->server.listen_fd < 0) {
+               ERR("Error initializing named socket (%s). Check that directory exists and that it is writable.", name);
                goto free_name;
        }
        free(name);
 
-       INIT_LIST_HEAD(&handle->connections);
+       INIT_LIST_HEAD(&handle->server.connections);
 
        return 0;
 
@@ -361,7 +547,72 @@ free_name:
        return -1;
 }
 
-static char *find_tok(char *str)
+/* Used by the daemon to initialize its server so applications
+ * can connect to it.
+ */
+
+int ustcomm_init_ustd(struct ustcomm_ustd *handle, const char *sock_path)
+{
+       char *name;
+       int retval = 0;
+
+       if(sock_path) {
+               asprintf(&name, "%s", sock_path);
+       }
+       else {
+               int result;
+
+               /* Only check if socket dir exists if we are using the default directory */
+               result = ensure_dir_exists(SOCK_DIR);
+               if(result == -1) {
+                       ERR("Unable to create socket directory %s", SOCK_DIR);
+                       return -1;
+               }
+
+               asprintf(&name, "%s/%s", SOCK_DIR, "ustd");
+       }
+
+       handle->server.listen_fd = init_named_socket(name, &handle->server.socketpath);
+       if(handle->server.listen_fd < 0) {
+               ERR("error initializing named socket at %s", name);
+               retval = -1;
+               goto free_name;
+       }
+
+       INIT_LIST_HEAD(&handle->server.connections);
+
+free_name:
+       free(name);
+
+       return retval;
+}
+
+void ustcomm_fini_app(struct ustcomm_app *handle)
+{
+       int result;
+       struct stat st;
+
+       /* Destroy socket */
+       result = stat(handle->server.socketpath, &st);
+       if(result == -1) {
+               PERROR("stat (%s)", handle->server.socketpath);
+               return;
+       }
+
+       /* Paranoid check before deleting. */
+       result = S_ISSOCK(st.st_mode);
+       if(!result) {
+               ERR("The socket we are about to delete is not a socket.");
+               return;
+       }
+
+       result = unlink(handle->server.socketpath);
+       if(result == -1) {
+               PERROR("unlink");
+       }
+}
+
+static const char *find_tok(const char *str)
 {
        while(*str == ' ') {
                str++;
@@ -373,7 +624,7 @@ static char *find_tok(char *str)
        return str;
 }
 
-static char *find_sep(char *str)
+static const char *find_sep(const char *str)
 {
        while(*str != ' ') {
                str++;
@@ -385,11 +636,11 @@ static char *find_sep(char *str)
        return str;
 }
 
-int nth_token_is(char *str, char *token, int tok_no)
+int nth_token_is(const char *str, const char *token, int tok_no)
 {
        int i;
-       char *start;
-       char *end;
+       const char *start;
+       const char *end;
 
        for(i=0; i<=tok_no; i++) {
                str = find_tok(str);
@@ -414,12 +665,12 @@ int nth_token_is(char *str, char *token, int tok_no)
        return 1;
 }
 
-char *nth_token(char *str, int tok_no)
+char *nth_token(const char *str, int tok_no)
 {
        static char *retval = NULL;
        int i;
-       char *start;
-       char *end;
+       const char *start;
+       const char *end;
 
        for(i=0; i<=tok_no; i++) {
                str = find_tok(str);
This page took 0.030489 seconds and 4 git commands to generate.