Add trace name handling throughout tracectl, ustcomm and ustcmd

[ust.git] / libustcomm / ustcomm.c

/* 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
 */

/* API used by UST components to communicate with each other via sockets. */

#define _GNU_SOURCE
#include <sys/types.h>
#include <signal.h>
#include <errno.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <unistd.h>
#include <poll.h>
#include <sys/epoll.h>
#include <sys/stat.h>

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <execinfo.h>

#include "ustcomm.h"
#include "usterr.h"
#include "share.h"

static int mkdir_p(const char *path, mode_t mode)
{
	const char *path_p;
	char *tmp;

	int retval = 0;
	int result;
	mode_t old_umask;

	tmp = zmalloc(strlen(path) + 1);
	if (tmp == NULL)
		return -1;

	/* skip first / */
	path_p = path+1;

	old_umask = umask(0);
	for(;;) {
		while (*path_p != '/') {
			if(*path_p == 0)
				break;
			++path_p;
		}
		if (*path_p == '/') {
			strncpy(tmp, path, path_p - path);
			tmp[path_p-path] = '\0';
			if (tmp[path_p - path - 1] != '/') {
				result = mkdir(tmp, mode);
				if(result == -1) {
					if (!(errno == EEXIST || errno == EACCES || errno == EROFS)) {
						/* Then this is a real error */
						retval = -1;
						break;
					}
				}
			}
			/* pass / */
			path_p++;
		} else {
			/* last component */
			result = mkdir(path, mode);
			if (result == -1)
				retval = -1;
			break;
		}
	}

	free(tmp);
	umask(old_umask);
	return retval;
}

static struct sockaddr_un * create_sock_addr(const char *name,
					     size_t *sock_addr_size)
{
	struct sockaddr_un * addr;
	size_t alloc_size;

	alloc_size = (size_t) (((struct sockaddr_un *) 0)->sun_path) +
		strlen(name) + 1;

	addr = malloc(alloc_size);
	if (addr < 0) {
		ERR("allocating addr failed");
		return NULL;
	}

	addr->sun_family = AF_UNIX;
	strcpy(addr->sun_path, name);

	*sock_addr_size = alloc_size;

	return addr;
}

struct ustcomm_sock * ustcomm_init_sock(int fd, int epoll_fd,
					struct list_head *list)
{
	struct epoll_event ev;
	struct ustcomm_sock *sock;

	sock = malloc(sizeof(struct ustcomm_sock));
	if (!sock) {
		perror("malloc: couldn't allocate ustcomm_sock");
		return NULL;
	}

	ev.events = EPOLLIN;
	ev.data.ptr = sock;
	sock->fd = fd;

	if (epoll_ctl(epoll_fd, EPOLL_CTL_ADD, sock->fd, &ev) == -1) {
		perror("epoll_ctl: failed to add socket\n");
		free(sock);
		return NULL;
	}

	sock->epoll_fd = epoll_fd;
	if (list) {
		list_add(&sock->list, list);
	} else {
		INIT_LIST_HEAD(&sock->list);
	}

	return sock;
}

void ustcomm_del_sock(struct ustcomm_sock *sock, int keep_in_epoll)
{
	list_del(&sock->list);
	if (!keep_in_epoll) {
		if (epoll_ctl(sock->epoll_fd, EPOLL_CTL_DEL, sock->fd, NULL) == -1) {
			PERROR("epoll_ctl: failed to delete socket");
		}
	}
	close(sock->fd);
	free(sock);
}

struct ustcomm_sock * ustcomm_init_named_socket(const char *name,
						int epoll_fd)
{
	int result;
	int fd;
	size_t sock_addr_size;
	struct sockaddr_un * addr;
	struct ustcomm_sock *sock;

	fd = socket(PF_UNIX, SOCK_STREAM, 0);
	if(fd == -1) {
		PERROR("socket");
		return NULL;
	}

	addr = create_sock_addr(name, &sock_addr_size);
	if (addr == NULL) {
		ERR("allocating addr, UST thread bailing");
		goto close_sock;
	}

	result = access(name, F_OK);
	if(result == 0) {
		/* file exists */
		result = unlink(name);
		if(result == -1) {
			PERROR("unlink of socket file");
			goto free_addr;
		}
		DBG("socket already exists; overwriting");
	}

	result = bind(fd, (struct sockaddr *)addr, sock_addr_size);
	if(result == -1) {
		PERROR("bind");
		goto free_addr;
	}

	result = listen(fd, 1);
	if(result == -1) {
		PERROR("listen");
		goto free_addr;
	}

	sock = ustcomm_init_sock(fd, epoll_fd,
				 NULL);
	if (!sock) {
		ERR("failed to create ustcomm_sock");
		goto free_addr;
	}

	free(addr);

	return sock;

free_addr:
	free(addr);
close_sock:
	close(fd);

	return NULL;
}

void ustcomm_del_named_sock(struct ustcomm_sock *sock,
			    int keep_socket_file)
{
	int result, fd;
	struct stat st;
	struct sockaddr dummy;
	struct sockaddr_un *sockaddr = NULL;
	int alloc_size;

	fd = sock->fd;

	if(!keep_socket_file) {

		/* Get the socket name */
		alloc_size = sizeof(dummy);
		if (getsockname(fd, &dummy, (socklen_t *)&alloc_size) < 0) {
			PERROR("getsockname failed");
			goto del_sock;
		}

		sockaddr = zmalloc(alloc_size);
		if (!sockaddr) {
			ERR("failed to allocate sockaddr");
			goto del_sock;
		}

		if (getsockname(fd, sockaddr, (socklen_t *)&alloc_size) < 0) {
			PERROR("getsockname failed");
			goto free_sockaddr;
		}

		/* Destroy socket */
		result = stat(sockaddr->sun_path, &st);
		if(result < 0) {
			PERROR("stat (%s)", sockaddr->sun_path);
			goto free_sockaddr;
		}

		/* Paranoid check before deleting. */
		result = S_ISSOCK(st.st_mode);
		if(!result) {
			ERR("The socket we are about to delete is not a socket.");
			goto free_sockaddr;
		}

		result = unlink(sockaddr->sun_path);
		if(result < 0) {
			PERROR("unlink");
		}
	}

free_sockaddr:
	free(sockaddr);

del_sock:
	ustcomm_del_sock(sock, keep_socket_file);
}

int ustcomm_recv_alloc(int sock,
		       struct ustcomm_header *header,
		       char **data) {
	int result;
	struct ustcomm_header peek_header;
	struct iovec iov[2];
	struct msghdr msg;

	/* Just to make the caller fail hard */
	*data = NULL;

	result = recv(sock, &peek_header, sizeof(peek_header),
		      MSG_PEEK | MSG_WAITALL);
	if (result <= 0) {
		if(errno == ECONNRESET) {
			return 0;
		} else if (errno == EINTR) {
			return -1;
		} else if (result < 0) {
			PERROR("recv");
			return -1;
		}
		return 0;
	}

	memset(&msg, 0, sizeof(msg));

	iov[0].iov_base = (char *)header;
	iov[0].iov_len = sizeof(struct ustcomm_header);

	msg.msg_iov = iov;
	msg.msg_iovlen = 1;

	if (peek_header.size) {
		*data = zmalloc(peek_header.size);
		if (!*data) {
			return -ENOMEM;
		}

		iov[1].iov_base = *data;
		iov[1].iov_len = peek_header.size;

		msg.msg_iovlen++;
	}

	result = recvmsg(sock, &msg, MSG_WAITALL);
	if (result < 0) {
		free(*data);
		PERROR("recvmsg failed");
	}

	return result;
}

/* returns 1 to indicate a message was received
 * returns 0 to indicate no message was received (end of stream)
 * returns -1 to indicate an error
 */
int ustcomm_recv_fd(int sock,
		    struct ustcomm_header *header,
		    char *data, int *fd)
{
	int result;
	struct ustcomm_header peek_header;
	struct iovec iov[2];
	struct msghdr msg;
	struct cmsghdr *cmsg;
	char buf[CMSG_SPACE(sizeof(int))];

	result = recv(sock, &peek_header, sizeof(peek_header),
		      MSG_PEEK | MSG_WAITALL);
	if (result <= 0) {
		if(errno == ECONNRESET) {
			return 0;
		} else if (errno == EINTR) {
			return -1;
		} else if (result < 0) {
			PERROR("recv");
			return -1;
		}
		return 0;
	}

	memset(&msg, 0, sizeof(msg));

	iov[0].iov_base = (char *)header;
	iov[0].iov_len = sizeof(struct ustcomm_header);

	msg.msg_iov = iov;
	msg.msg_iovlen = 1;

	if (peek_header.size && data) {
		if (peek_header.size < 0 ||
		    peek_header.size > USTCOMM_DATA_SIZE) {
			ERR("big peek header! %d", peek_header.size);
			return 0;
		}

		iov[1].iov_base = data;
		iov[1].iov_len = peek_header.size;

		msg.msg_iovlen++;
	}

	if (fd && peek_header.fd_included) {
		msg.msg_control = buf;
		msg.msg_controllen = sizeof(buf);
	}

	result = recvmsg(sock, &msg, MSG_WAITALL);
	if (result <= 0) {
		if (result < 0) {
			PERROR("recvmsg failed");
		}
		return result;
	}

	if (fd && peek_header.fd_included) {
		cmsg = CMSG_FIRSTHDR(&msg);
		result = 0;
		while (cmsg != NULL) {
			if (cmsg->cmsg_level == SOL_SOCKET
			    && cmsg->cmsg_type  == SCM_RIGHTS) {
				*fd = *(int *) CMSG_DATA(cmsg);
				result = 1;
				break;
			}
			cmsg = CMSG_NXTHDR(&msg, cmsg);
		}
		if (!result) {
			ERR("Failed to receive file descriptor\n");
		}
	}

	return 1;
}

int ustcomm_recv(int sock,
		 struct ustcomm_header *header,
		 char *data)
{
	return ustcomm_recv_fd(sock, header, data, NULL);
}


int ustcomm_send_fd(int sock,
		    const struct ustcomm_header *header,
		    const char *data,
		    int *fd)
{
	struct iovec iov[2];
	struct msghdr msg;
	int result;
	struct cmsghdr *cmsg;
	char buf[CMSG_SPACE(sizeof(int))];

	memset(&msg, 0, sizeof(msg));

	iov[0].iov_base = (char *)header;
	iov[0].iov_len = sizeof(struct ustcomm_header);

	msg.msg_iov = iov;
	msg.msg_iovlen = 1;

	if (header->size && data) {
		iov[1].iov_base = (char *)data;
		iov[1].iov_len = header->size;

		msg.msg_iovlen++;

	}

	if (fd && header->fd_included) {
		msg.msg_control = buf;
		msg.msg_controllen = sizeof(buf);
		cmsg = CMSG_FIRSTHDR(&msg);
		cmsg->cmsg_level = SOL_SOCKET;
		cmsg->cmsg_type = SCM_RIGHTS;
		cmsg->cmsg_len = CMSG_LEN(sizeof(int));
		*(int *) CMSG_DATA(cmsg) = *fd;
		msg.msg_controllen = cmsg->cmsg_len;
	}

	result = sendmsg(sock, &msg, MSG_NOSIGNAL);
	if (result < 0 && errno != EPIPE) {
		PERROR("sendmsg failed");
	}
	return result;
}

int ustcomm_send(int sock,
		 const struct ustcomm_header *header,
		 const char *data)
{
	return ustcomm_send_fd(sock, header, data, NULL);
}

int ustcomm_req(int sock,
		const struct ustcomm_header *req_header,
		const char *req_data,
		struct ustcomm_header *res_header,
		char *res_data)
{
	int result;

	result = ustcomm_send(sock, req_header, req_data);
	if ( result <= 0) {
		return result;
	}

	return ustcomm_recv(sock, res_header, res_data);
}

/* Return value:
 *  0: success
 * -1: error
 */

int ustcomm_connect_path(const char *name, int *connection_fd)
{
	int result, fd;
	size_t sock_addr_size;
	struct sockaddr_un *addr;

	fd = socket(PF_UNIX, SOCK_STREAM, 0);
	if(fd == -1) {
		PERROR("socket");
		return -1;
	}

	addr = create_sock_addr(name, &sock_addr_size);
	if (addr == NULL) {
		ERR("allocating addr failed");
		goto close_sock;
	}

	result = connect(fd, (struct sockaddr *)addr, sock_addr_size);
	if(result == -1) {
		PERROR("connect (path=%s)", name);
		goto free_sock_addr;
	}

	*connection_fd = fd;

	free(addr);

	return 0;

free_sock_addr:
	free(addr);
close_sock:
	close(fd);

	return -1;
}


/* Open a connection to a traceable app.
 *
 * Return value:
 *  0: success
 * -1: error
 */

int ustcomm_connect_app(pid_t pid, int *app_fd)
{
	int result;
	int retval = 0;
	char *name;

	result = asprintf(&name, "%s/%d", SOCK_DIR, pid);
	if (result < 0) {
		ERR("failed to allocate socket name");
		return -1;
	}

	result = ustcomm_connect_path(name, app_fd);
	if (result < 0) {
		ERR("failed to connect to app");
		retval = -1;
	}

	free(name);

	return retval;
}

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 */
		int result;

		/* mkdir mode to 0777 */
		result = mkdir_p(dir, S_IRWXU | S_IRWXG | S_IRWXO);
		if(result != 0) {
			ERR("executing in recursive creation of directory %s", dir);
			return -1;
		}
	}

	return 0;
}

char * ustcomm_print_data(char *data_field, int field_size,
			  int *offset, const char *format, ...)
{
	va_list args;
	int count, limit;
	char *ptr = USTCOMM_POISON_PTR;

	limit = field_size - *offset;
	va_start(args, format);
	count = vsnprintf(&data_field[*offset], limit, format, args);
	va_end(args);

	if (count < limit && count > -1) {
		ptr = NULL + *offset;
		*offset = *offset + count + 1;
	}

	return ptr;
}

char * ustcomm_restore_ptr(char *ptr, char *data_field, int data_field_size)
{
	if ((unsigned long)ptr > data_field_size ||
	    ptr == USTCOMM_POISON_PTR) {
		return NULL;
	}

	return data_field + (long)ptr;
}

int ustcomm_pack_trace_info(struct ustcomm_header *header,
			    struct ustcomm_trace_info *trace_inf,
			    const char *trace)
{
	int offset = 0;

	trace_inf->trace = ustcomm_print_data(trace_inf->data,
					      sizeof(trace_inf->data),
					      &offset,
					      trace);

	if (trace_inf->trace == USTCOMM_POISON_PTR) {
		return -ENOMEM;
	}

	header->size = COMPUTE_MSG_SIZE(trace_inf, offset);

	return 0;
}


int ustcomm_unpack_trace_info(struct ustcomm_trace_info *trace_inf)
{
	trace_inf->trace = ustcomm_restore_ptr(trace_inf->trace,
					       trace_inf->data,
					       sizeof(trace_inf->data));
	if (!trace_inf->trace) {
		return -EINVAL;
	}

	return 0;
}

int ustcomm_pack_channel_info(struct ustcomm_header *header,
			      struct ustcomm_channel_info *ch_inf,
			      const char *trace,
			      const char *channel)
{
	int offset = 0;

	ch_inf->trace = ustcomm_print_data(ch_inf->data,
					   sizeof(ch_inf->data),
					   &offset,
					   trace);

	if (ch_inf->trace == USTCOMM_POISON_PTR) {
		return -ENOMEM;
	}

	ch_inf->channel = ustcomm_print_data(ch_inf->data,
					     sizeof(ch_inf->data),
					     &offset,
					     channel);

	if (ch_inf->channel == USTCOMM_POISON_PTR) {
		return -ENOMEM;
	}

	header->size = COMPUTE_MSG_SIZE(ch_inf, offset);

	return 0;
}


int ustcomm_unpack_channel_info(struct ustcomm_channel_info *ch_inf)
{
	ch_inf->trace = ustcomm_restore_ptr(ch_inf->trace,
					    ch_inf->data,
					    sizeof(ch_inf->data));
	if (!ch_inf->trace) {
		return -EINVAL;
	}

	ch_inf->channel = ustcomm_restore_ptr(ch_inf->channel,
					      ch_inf->data,
					      sizeof(ch_inf->data));
	if (!ch_inf->channel) {
		return -EINVAL;
	}

	return 0;
}

int ustcomm_pack_buffer_info(struct ustcomm_header *header,
			     struct ustcomm_buffer_info *buf_inf,
			     const char *trace,
			     const char *channel,
			     int channel_cpu)
{
	int offset = 0;

	buf_inf->trace = ustcomm_print_data(buf_inf->data,
					    sizeof(buf_inf->data),
					    &offset,
					    trace);

	if (buf_inf->trace == USTCOMM_POISON_PTR) {
		return -ENOMEM;
	}

	buf_inf->channel = ustcomm_print_data(buf_inf->data,
					      sizeof(buf_inf->data),
					      &offset,
					      channel);

	if (buf_inf->channel == USTCOMM_POISON_PTR) {
		return -ENOMEM;
	}

	buf_inf->ch_cpu = channel_cpu;

	header->size = COMPUTE_MSG_SIZE(buf_inf, offset);

	return 0;
}


int ustcomm_unpack_buffer_info(struct ustcomm_buffer_info *buf_inf)
{
	buf_inf->trace = ustcomm_restore_ptr(buf_inf->trace,
					     buf_inf->data,
					     sizeof(buf_inf->data));
	if (!buf_inf->trace) {
		return -EINVAL;
	}

	buf_inf->channel = ustcomm_restore_ptr(buf_inf->channel,
					       buf_inf->data,
					       sizeof(buf_inf->data));
	if (!buf_inf->channel) {
		return -EINVAL;
	}

	return 0;
}

int ustcomm_pack_marker_info(struct ustcomm_header *header,
			     struct ustcomm_marker_info *marker_inf,
			     const char *trace,
			     const char *channel,
			     const char *marker)
{
	int offset = 0;

	marker_inf->trace = ustcomm_print_data(marker_inf->data,
					       sizeof(marker_inf->data),
					       &offset,
					       trace);

	if (marker_inf->trace == USTCOMM_POISON_PTR) {
		return -ENOMEM;
	}


	marker_inf->channel = ustcomm_print_data(marker_inf->data,
						 sizeof(marker_inf->data),
						 &offset,
						 channel);

	if (marker_inf->channel == USTCOMM_POISON_PTR) {
		return -ENOMEM;
	}


	marker_inf->marker = ustcomm_print_data(marker_inf->data,
						 sizeof(marker_inf->data),
						 &offset,
						 marker);

	if (marker_inf->marker == USTCOMM_POISON_PTR) {
		return -ENOMEM;
	}

	header->size = COMPUTE_MSG_SIZE(marker_inf, offset);

	return 0;
}

int ustcomm_unpack_marker_info(struct ustcomm_marker_info *marker_inf)
{
	marker_inf->trace = ustcomm_restore_ptr(marker_inf->trace,
						marker_inf->data,
						sizeof(marker_inf->data));
	if (!marker_inf->trace) {
		return -EINVAL;
	}

	marker_inf->channel = ustcomm_restore_ptr(marker_inf->channel,
						  marker_inf->data,
						  sizeof(marker_inf->data));
	if (!marker_inf->channel) {
		return -EINVAL;
	}

	marker_inf->marker = ustcomm_restore_ptr(marker_inf->marker,
						 marker_inf->data,
						 sizeof(marker_inf->data));
	if (!marker_inf->marker) {
		return -EINVAL;
	}

	return 0;
}

int ustcomm_pack_sock_path(struct ustcomm_header *header,
			   struct ustcomm_sock_path *sock_path_inf,
			   const char *socket_path)
{
	int offset = 0;

	sock_path_inf->sock_path =
		ustcomm_print_data(sock_path_inf->data,
				   sizeof(sock_path_inf->data),
				   &offset,
				   socket_path);

	if (sock_path_inf->sock_path == USTCOMM_POISON_PTR) {
		return -ENOMEM;
	}

	header->size = COMPUTE_MSG_SIZE(sock_path_inf, offset);

	return 0;
}

int ustcomm_unpack_sock_path(struct ustcomm_sock_path *sock_path_inf)
{
	sock_path_inf->sock_path =
		ustcomm_restore_ptr(sock_path_inf->sock_path,
				    sock_path_inf->data,
				    sizeof(sock_path_inf->data));
	if (!sock_path_inf->sock_path) {
		return -EINVAL;
	}

	return 0;
}