X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=libustctl%2Flibustctl.c;fp=libustctl%2Flibustctl.c;h=9c4ced26482299b35b227b747c575dc899b91acb;hb=2298f3297443ba26f761e272c45456ed857071bc;hp=0000000000000000000000000000000000000000;hpb=eb78cc5f9e75f620e9037708874f88b0a17e4ed8;p=ust.git

diff --git a/libustctl/libustctl.c b/libustctl/libustctl.c
new file mode 100644
index 0000000..9c4ced2
--- /dev/null
+++ b/libustctl/libustctl.c
@@ -0,0 +1,671 @@
+/* Copyright (C) 2009  Pierre-Marc Fournier, Philippe Proulx-Barrette
+ *
+ * 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 <stdio.h>
+#include <unistd.h>
+#include <getopt.h>
+#include <stdlib.h>
+#include <fcntl.h>
+#include <string.h>
+#include <dirent.h>
+
+#include "ustcomm.h"
+#include "ust/ustctl.h"
+#include "usterr.h"
+
+static int do_cmd(const pid_t pid,
+		  const struct ustcomm_header *req_header,
+		  const char *req_data,
+		  struct ustcomm_header *res_header,
+		  char **res_data)
+{
+	int app_fd, result, saved_errno = 0;
+	char *recv_buf;
+
+	if (ustcomm_connect_app(pid, &app_fd)) {
+		ERR("could not connect to PID %u", (unsigned int) pid);
+		errno = ENOTCONN;
+		return -1;
+	}
+
+	recv_buf = zmalloc(USTCOMM_BUFFER_SIZE);
+	if (!recv_buf) {
+		saved_errno = ENOMEM;
+		goto close_app_fd;
+	}
+
+	result = ustcomm_req(app_fd, req_header, req_data, res_header, recv_buf);
+	if (result > 0) {
+		saved_errno = -res_header->result;
+		if (res_header->size == 0 || saved_errno > 0) {
+			free(recv_buf);
+		} else {
+			if (res_data) {
+				*res_data = recv_buf;
+			} else {
+				free(recv_buf);
+			}
+		}
+	} else {
+		ERR("ustcomm req failed");
+		if (result == 0) {
+			saved_errno = ENOTCONN;
+		} else {
+			saved_errno = -result;
+		}
+		free(recv_buf);
+	}
+
+close_app_fd:
+	close(app_fd);
+
+	errno = saved_errno;
+
+	if (errno) {
+		return -1;
+	}
+
+	return 0;
+}
+
+pid_t *ustctl_get_online_pids(void)
+{
+	struct dirent *dirent;
+	DIR *dir;
+	unsigned int ret_size = 1 * sizeof(pid_t), i = 0;
+
+	dir = opendir(SOCK_DIR);
+	if (!dir) {
+		return NULL;
+	}
+
+	pid_t *ret = (pid_t *) malloc(ret_size);
+
+	while ((dirent = readdir(dir))) {
+		if (!strcmp(dirent->d_name, ".") ||
+		    !strcmp(dirent->d_name, "..")) {
+
+			continue;
+		}
+
+		if (dirent->d_type != DT_DIR &&
+		    !!strcmp(dirent->d_name, "ust-consumer")) {
+
+			sscanf(dirent->d_name, "%u", (unsigned int *) &ret[i]);
+			/* FIXME: Here we previously called pid_is_online, which
+			 * always returned 1, now I replaced it with just 1.
+			 * We need to figure out an intelligent way of solving
+			 * this, maybe connect-disconnect.
+			 */
+			if (1) {
+				ret_size += sizeof(pid_t);
+				ret = (pid_t *) realloc(ret, ret_size);
+				++i;
+			}
+		}
+	}
+
+	ret[i] = 0; /* Array end */
+
+	if (ret[0] == 0) {
+		/* No PID at all */
+		free(ret);
+		return NULL;
+	}
+
+	closedir(dir);
+	return ret;
+}
+
+/**
+ * Sets marker state (USTCTL_MS_ON or USTCTL_MS_OFF).
+ *
+ * @param mn	Marker name
+ * @param state	Marker's new state
+ * @param pid	Traced process ID
+ * @return	0 if successful, or errors {USTCTL_ERR_GEN, USTCTL_ERR_ARG}
+ */
+int ustctl_set_marker_state(const char *trace, const char *channel,
+			    const char *marker, int state, pid_t pid)
+{
+	struct ustcomm_header req_header, res_header;
+	struct ustcomm_marker_info marker_inf;
+	int result;
+
+	result = ustcomm_pack_marker_info(&req_header,
+					  &marker_inf,
+					  trace,
+					  channel,
+					  marker);
+	if (result < 0) {
+		errno = -result;
+		return -1;
+	}
+
+	req_header.command = state ? ENABLE_MARKER : DISABLE_MARKER;
+
+	return do_cmd(pid, &req_header, (char *)&marker_inf,
+		      &res_header, NULL);
+}
+
+/**
+ * Set subbuffer size.
+ *
+ * @param channel_size	Channel name and size
+ * @param pid		Traced process ID
+ * @return		0 if successful, or error
+ */
+int ustctl_set_subbuf_size(const char *trace, const char *channel,
+			   unsigned int subbuf_size, pid_t pid)
+{
+	struct ustcomm_header req_header, res_header;
+	struct ustcomm_channel_info ch_inf;
+	int result;
+
+	result = ustcomm_pack_channel_info(&req_header,
+					   &ch_inf,
+					   trace,
+					   channel);
+	if (result < 0) {
+		errno = -result;
+		return -1;
+	}
+
+	req_header.command = SET_SUBBUF_SIZE;
+	ch_inf.subbuf_size = subbuf_size;
+
+	return do_cmd(pid, &req_header, (char *)&ch_inf,
+		      &res_header, NULL);
+}
+
+/**
+ * Set subbuffer num.
+ *
+ * @param channel_num	Channel name and num
+ * @param pid		Traced process ID
+ * @return		0 if successful, or error
+ */
+int ustctl_set_subbuf_num(const char *trace, const char *channel,
+			  unsigned int num, pid_t pid)
+{
+	struct ustcomm_header req_header, res_header;
+	struct ustcomm_channel_info ch_inf;
+	int result;
+
+	result = ustcomm_pack_channel_info(&req_header,
+					   &ch_inf,
+					   trace,
+					   channel);
+	if (result < 0) {
+		errno = -result;
+		return -1;
+	}
+
+	req_header.command = SET_SUBBUF_NUM;
+	ch_inf.subbuf_num = num;
+
+	return do_cmd(pid, &req_header, (char *)&ch_inf,
+		      &res_header, NULL);
+
+}
+
+static int ustctl_get_subbuf_num_size(const char *trace, const char *channel,
+				      pid_t pid, int *num, int *size)
+{
+	struct ustcomm_header req_header, res_header;
+	struct ustcomm_channel_info ch_inf, *ch_inf_res;
+	int result;
+
+
+	result = ustcomm_pack_channel_info(&req_header,
+					   &ch_inf,
+					   trace,
+					   channel);
+	if (result < 0) {
+		errno = -result;
+		return -1;
+	}
+
+	req_header.command = GET_SUBBUF_NUM_SIZE;
+
+	result = do_cmd(pid, &req_header, (char *)&ch_inf,
+			&res_header, (char **)&ch_inf_res);
+	if (result < 0) {
+		return -1;
+	}
+
+	*num = ch_inf_res->subbuf_num;
+	*size = ch_inf_res->subbuf_size;
+
+	free(ch_inf_res);
+
+	return 0;
+}
+
+/**
+ * Get subbuffer num.
+ *
+ * @param channel	Channel name
+ * @param pid		Traced process ID
+ * @return		subbuf cnf if successful, or error
+ */
+int ustctl_get_subbuf_num(const char *trace, const char *channel, pid_t pid)
+{
+	int num, size, result;
+
+	result = ustctl_get_subbuf_num_size(trace, channel, pid,
+					    &num, &size);
+	if (result < 0) {
+		errno = -result;
+		return -1;
+	}
+
+	return num;
+}
+
+/**
+ * Get subbuffer size.
+ *
+ * @param channel	Channel name
+ * @param pid		Traced process ID
+ * @return		subbuf size if successful, or error
+ */
+int ustctl_get_subbuf_size(const char *trace, const char *channel, pid_t pid)
+{
+	int num, size, result;
+
+	result = ustctl_get_subbuf_num_size(trace, channel, pid,
+					    &num, &size);
+	if (result < 0) {
+		errno = -result;
+		return -1;
+	}
+
+	return size;
+}
+
+
+static int do_trace_cmd(const char *trace, pid_t pid, int command)
+{
+	struct ustcomm_header req_header, res_header;
+	struct ustcomm_single_field trace_inf;
+	int result;
+
+	result = ustcomm_pack_single_field(&req_header,
+					   &trace_inf,
+					   trace);
+	if (result < 0) {
+		errno = -result;
+		return -1;
+	}
+
+	req_header.command = command;
+
+	return do_cmd(pid, &req_header, (char *)&trace_inf, &res_header, NULL);
+}
+
+/**
+ * Destroys an UST trace according to a PID.
+ *
+ * @param pid	Traced process ID
+ * @return	0 if successful, or error USTCTL_ERR_GEN
+ */
+int ustctl_destroy_trace(const char *trace, pid_t pid)
+{
+	return do_trace_cmd(trace, pid, DESTROY_TRACE);
+}
+
+/**
+ * Starts an UST trace (and setups it) according to a PID.
+ *
+ * @param pid	Traced process ID
+ * @return	0 if successful, or error USTCTL_ERR_GEN
+ */
+int ustctl_setup_and_start(const char *trace, pid_t pid)
+{
+	return do_trace_cmd(trace, pid, START);
+}
+
+/**
+ * Creates an UST trace according to a PID.
+ *
+ * @param pid	Traced process ID
+ * @return	0 if successful, or error USTCTL_ERR_GEN
+ */
+int ustctl_create_trace(const char *trace, pid_t pid)
+{
+	return do_trace_cmd(trace, pid, CREATE_TRACE);
+}
+
+/**
+ * Starts an UST trace according to a PID.
+ *
+ * @param pid	Traced process ID
+ * @return	0 if successful, or error USTCTL_ERR_GEN
+ */
+int ustctl_start_trace(const char *trace, pid_t pid)
+{
+	return do_trace_cmd(trace, pid, START_TRACE);
+}
+
+/**
+ * Alloc an UST trace according to a PID.
+ *
+ * @param pid	Traced process ID
+ * @return	0 if successful, or error USTCTL_ERR_GEN
+ */
+int ustctl_alloc_trace(const char *trace, pid_t pid)
+{
+	return do_trace_cmd(trace, pid, ALLOC_TRACE);
+}
+
+/**
+ * Stops an UST trace according to a PID.
+ *
+ * @param pid	Traced process ID
+ * @return	0 if successful, or error USTCTL_ERR_GEN
+ */
+int ustctl_stop_trace(const char *trace, pid_t pid)
+{
+	return do_trace_cmd(trace, pid, STOP_TRACE);
+}
+
+/**
+ * Counts newlines ('\n') in a string.
+ *
+ * @param str	String to search in
+ * @return	Total newlines count
+ */
+unsigned int ustctl_count_nl(const char *str)
+{
+	unsigned int i = 0, tot = 0;
+
+	while (str[i] != '\0') {
+		if (str[i] == '\n') {
+			++tot;
+		}
+		++i;
+	}
+
+	return tot;
+}
+
+/**
+ * Frees a CMSF array.
+ *
+ * @param cmsf	CMSF array to free
+ * @return	0 if successful, or error USTCTL_ERR_ARG
+ */
+int ustctl_free_cmsf(struct marker_status *cmsf)
+{
+	if (cmsf == NULL) {
+		return USTCTL_ERR_ARG;
+	}
+
+	unsigned int i = 0;
+	while (cmsf[i].channel != NULL) {
+		free(cmsf[i].channel);
+		free(cmsf[i].marker);
+		free(cmsf[i].fs);
+		++i;
+	}
+	free(cmsf);
+
+	return 0;
+}
+
+/**
+ * Gets channel/marker/state/format string for a given PID.
+ *
+ * @param cmsf	Pointer to CMSF array to be filled (callee allocates, caller
+ *		frees with `ustctl_free_cmsf')
+ * @param pid	Targeted PID
+ * @return	0 if successful, or -1 on error
+ */
+int ustctl_get_cmsf(struct marker_status **cmsf, const pid_t pid)
+{
+	struct ustcomm_header req_header, res_header;
+	char *big_str = NULL;
+	int result, app_fd;
+	struct marker_status *tmp_cmsf = NULL;
+	unsigned int i = 0, cmsf_ind = 0;
+
+	if (cmsf == NULL) {
+		return -1;
+	}
+
+	if (ustcomm_connect_app(pid, &app_fd)) {
+		ERR("could not connect to PID %u", (unsigned int) pid);
+		return -1;
+	}
+
+	req_header.command = LIST_MARKERS;
+	req_header.size = 0;
+
+	result = ustcomm_send(app_fd, &req_header, NULL);
+	if (result <= 0) {
+		PERROR("error while requesting markers list for process %d", pid);
+		return -1;
+	}
+
+	result = ustcomm_recv_alloc(app_fd, &res_header, &big_str);
+	if (result <= 0) {
+		ERR("error while receiving markers list");
+		return -1;
+	}
+
+	close(app_fd);
+
+	tmp_cmsf = (struct marker_status *) zmalloc(sizeof(struct marker_status) *
+						    (ustctl_count_nl(big_str) + 1));
+	if (tmp_cmsf == NULL) {
+		ERR("Failed to allocate CMSF array");
+		return -1;
+	}
+
+	/* Parse received reply string (format: "[chan]/[mark] [st] [fs]"): */
+	while (big_str[i] != '\0') {
+		char state;
+
+		sscanf(big_str + i, "marker: %a[^/]/%a[^ ] %c %a[^\n]",
+		       &tmp_cmsf[cmsf_ind].channel,
+		       &tmp_cmsf[cmsf_ind].marker,
+		       &state,
+		       &tmp_cmsf[cmsf_ind].fs);
+		tmp_cmsf[cmsf_ind].state = (state == USTCTL_MS_CHR_ON ?
+					    USTCTL_MS_ON : USTCTL_MS_OFF); /* Marker state */
+
+		while (big_str[i] != '\n') {
+			++i; /* Go to next '\n' */
+		}
+		++i; /* Skip current pointed '\n' */
+		++cmsf_ind;
+	}
+	tmp_cmsf[cmsf_ind].channel = NULL;
+	tmp_cmsf[cmsf_ind].marker = NULL;
+	tmp_cmsf[cmsf_ind].fs = NULL;
+
+	*cmsf = tmp_cmsf;
+
+	free(big_str);
+	return 0;
+}
+
+
+/**
+ * Frees a TES array.
+ *
+ * @param tes	TES array to free
+ * @return	0 if successful, or error USTCTL_ERR_ARG
+ */
+int ustctl_free_tes(struct trace_event_status *tes)
+{
+	if (tes == NULL) {
+		return USTCTL_ERR_ARG;
+	}
+
+	unsigned int i = 0;
+	while (tes[i].name != NULL) {
+		free(tes[i].name);
+		++i;
+	}
+	free(tes);
+
+	return 0;
+}
+
+/**
+ * Gets trace_events string for a given PID.
+ *
+ * @param tes	Pointer to TES array to be filled (callee allocates, caller
+ *		frees with `ustctl_free_tes')
+ * @param pid	Targeted PID
+ * @return	0 if successful, or -1 on error
+ */
+int ustctl_get_tes(struct trace_event_status **tes,
+		   const pid_t pid)
+{
+	struct ustcomm_header req_header, res_header;
+	char *big_str = NULL;
+	int result, app_fd;
+	struct trace_event_status *tmp_tes = NULL;
+	unsigned int i = 0, tes_ind = 0;
+
+	if (tes == NULL) {
+		return -1;
+	}
+
+	if (ustcomm_connect_app(pid, &app_fd)) {
+		ERR("could not connect to PID %u", (unsigned int) pid);
+		return -1;
+	}
+
+	req_header.command = LIST_TRACE_EVENTS;
+	req_header.size = 0;
+
+	result = ustcomm_send(app_fd, &req_header, NULL);
+	if (result != 1) {
+		ERR("error while requesting trace_event list");
+		return -1;
+	}
+
+	result = ustcomm_recv_alloc(app_fd, &res_header, &big_str);
+	if (result != 1) {
+		ERR("error while receiving markers list");
+		return -1;
+	}
+
+	close(app_fd);
+
+	tmp_tes = (struct trace_event_status *)
+		zmalloc(sizeof(struct trace_event_status) *
+			(ustctl_count_nl(big_str) + 1));
+	if (tmp_tes == NULL) {
+		ERR("Failed to allocate TES array");
+		return -1;
+	}
+
+	/* Parse received reply string (format: "[name]"): */
+	while (big_str[i] != '\0') {
+		sscanf(big_str + i, "trace_event: %a[^\n]",
+		       &tmp_tes[tes_ind].name);
+		while (big_str[i] != '\n') {
+			++i; /* Go to next '\n' */
+		}
+		++i; /* Skip current pointed '\n' */
+		++tes_ind;
+	}
+	tmp_tes[tes_ind].name = NULL;
+
+	*tes = tmp_tes;
+
+	free(big_str);
+	return 0;
+}
+
+/**
+ * Set socket path
+ *
+ * @param sock_path	Socket path
+ * @param pid		Traced process ID
+ * @return		0 if successful, or error
+ */
+int ustctl_set_sock_path(const char *sock_path, pid_t pid)
+{
+	int result;
+	struct ustcomm_header req_header, res_header;
+	struct ustcomm_single_field sock_path_msg;
+
+	result = ustcomm_pack_single_field(&req_header,
+					   &sock_path_msg,
+					   sock_path);
+	if (result < 0) {
+		errno = -result;
+		return -1;
+	}
+
+	req_header.command = SET_SOCK_PATH;
+
+	return do_cmd(pid, &req_header, (char *)&sock_path_msg,
+		      &res_header, NULL);
+}
+
+/**
+ * Get socket path
+ *
+ * @param sock_path	Pointer to where the socket path will be returned
+ * @param pid		Traced process ID
+ * @return		0 if successful, or error
+ */
+int ustctl_get_sock_path(char **sock_path, pid_t pid)
+{
+	int result;
+	struct ustcomm_header req_header, res_header;
+	struct ustcomm_single_field *sock_path_msg;
+
+	req_header.command = GET_SOCK_PATH;
+	req_header.size = 0;
+
+	result = do_cmd(pid, &req_header, NULL, &res_header,
+			(char **)&sock_path_msg);
+	if (result < 0) {
+		return -1;
+	}
+
+	result = ustcomm_unpack_single_field(sock_path_msg);
+	if (result < 0) {
+		return result;
+	}
+
+	*sock_path = strdup(sock_path_msg->field);
+
+	free(sock_path_msg);
+
+	return 0;
+}
+
+int ustctl_force_switch(pid_t pid)
+{
+	struct ustcomm_header req_header, res_header;
+
+	req_header.command = FORCE_SUBBUF_SWITCH;
+	req_header.size = 0;
+
+	return do_cmd(pid, &req_header, NULL, &res_header, NULL);
+}
+