[lttng-tools.git] / src / bin / lttng-sessiond / jul-thread.c

/*
 * Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, version 2 only, as
 * published by the Free Software Foundation.
 *
 * This program 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 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.
 */

#define _GNU_SOURCE
#include <assert.h>

#include <common/common.h>
#include <common/sessiond-comm/sessiond-comm.h>
#include <common/uri.h>
#include <common/utils.h>

#include "fd-limit.h"
#include "jul-thread.h"
#include "lttng-sessiond.h"
#include "session.h"
#include "utils.h"

/*
 * Note that there is not port here. It's set after this URI is parsed so we
 * can let the user define a custom one. However, localhost is ALWAYS the
 * default listening address.
 */
static const char *default_reg_uri = "tcp://localhost";

/*
 * Update JUL application using the given socket. This is done just after
 * registration was successful.
 *
 * This is a quite heavy call in terms of locking since the session list lock
 * AND session lock are acquired.
 */
static void update_jul_app(int sock)
{
	struct ltt_session *session, *stmp;
	struct ltt_session_list *list;

	list = session_get_list();
	assert(list);

	session_lock_list();
	cds_list_for_each_entry_safe(session, stmp, &list->head, list) {
		session_lock(session);
		if (session->ust_session) {
			jul_update(&session->ust_session->domain_jul, sock);
		}
		session_unlock(session);
	}
	session_unlock_list();
}

/*
 * Destroy a JUL application by socket.
 */
static void destroy_jul_app(int sock)
{
	struct jul_app *app;

	assert(sock >= 0);

	/*
	 * Not finding an application is a very important error that should NEVER
	 * happen. The hash table deletion is ONLY done through this call even on
	 * thread cleanup.
	 */
	rcu_read_lock();
	app = jul_find_app_by_sock(sock);
	assert(app);
	rcu_read_unlock();

	/* RCU read side lock is taken in this function call. */
	jul_delete_app(app);

	/* The application is freed in a RCU call but the socket is closed here. */
	jul_destroy_app(app);
}

/*
 * Cleanup remaining JUL apps in the hash table. This should only be called in
 * the exit path of the thread.
 */
static void clean_jul_apps_ht(void)
{
	struct lttng_ht_node_ulong *node;
	struct lttng_ht_iter iter;

	DBG3("[jul-thread] Cleaning JUL apps ht");

	rcu_read_lock();
	cds_lfht_for_each_entry(jul_apps_ht_by_sock->ht, &iter.iter, node, node) {
		struct jul_app *app;

		app = caa_container_of(node, struct jul_app, node);
		destroy_jul_app(app->sock->fd);
	}
	rcu_read_unlock();
}

/*
 * Create and init socket from uri.
 */
static struct lttcomm_sock *init_tcp_socket(void)
{
	int ret;
	struct lttng_uri *uri = NULL;
	struct lttcomm_sock *sock = NULL;

	/*
	 * This should never fail since the URI is hardcoded and the port is set
	 * before this thread is launched.
	 */
	ret = uri_parse(default_reg_uri, &uri);
	assert(ret);
	assert(jul_tcp_port);
	uri->port = jul_tcp_port;

	sock = lttcomm_alloc_sock_from_uri(uri);
	uri_free(uri);
	if (sock == NULL) {
		ERR("[jul-thread] JUL allocating TCP socket");
		goto error;
	}

	ret = lttcomm_create_sock(sock);
	if (ret < 0) {
		goto error;
	}

	ret = sock->ops->bind(sock);
	if (ret < 0) {
		WARN("An other session daemon is using this JUL port. JUL support "
				"will be deactivated not interfering with the tracing.");
		goto error;
	}

	ret = sock->ops->listen(sock, -1);
	if (ret < 0) {
		goto error;
	}

	DBG("[jul-thread] Listening on TCP port %u and socket %d", jul_tcp_port,
			sock->fd);

	return sock;

error:
	if (sock) {
		lttcomm_destroy_sock(sock);
	}
	return NULL;
}

/*
 * Close and destroy the given TCP socket.
 */
static void destroy_tcp_socket(struct lttcomm_sock *sock)
{
	assert(sock);

	DBG3("[jul-thread] Destroy TCP socket on port %u", jul_tcp_port);

	/* This will return gracefully if fd is invalid. */
	sock->ops->close(sock);
	lttcomm_destroy_sock(sock);
}

/*
 * Handle a new JUL registration using the reg socket. After that, a new JUL
 * application is added to the global hash table and attach to an UST app
 * object. If r_app is not NULL, the created app is set to the pointer.
 *
 * Return the new FD created upon accept() on success or else a negative errno
 * value.
 */
static int handle_registration(struct lttcomm_sock *reg_sock,
		struct jul_app **r_app)
{
	int ret;
	pid_t pid;
	ssize_t size;
	struct jul_app *app;
	struct jul_register_msg msg;
	struct lttcomm_sock *new_sock;

	assert(reg_sock);

	new_sock = reg_sock->ops->accept(reg_sock);
	if (!new_sock) {
		ret = -ENOTCONN;
		goto error;
	}

	size = new_sock->ops->recvmsg(new_sock, &msg, sizeof(msg), 0);
	if (size < sizeof(msg)) {
		ret = -errno;
		goto error_socket;
	}
	pid = be32toh(msg.pid);

	DBG2("[jul-thread] New registration for pid %d on socket %d", pid,
			new_sock->fd);

	app = jul_create_app(pid, new_sock);
	if (!app) {
		ret = -ENOMEM;
		goto error_socket;
	}

	/*
	 * Add before assigning the socket value to the UST app so it can be found
	 * concurrently.
	 */
	jul_add_app(app);

	/*
	 * We don't need to attach the JUL app to the app. If we ever do
	 * so, we should consider both registration order of JUL before
	 * app and app before JUL.
	 */

	if (r_app) {
		*r_app = app;
	}

	return new_sock->fd;

error_socket:
	new_sock->ops->close(new_sock);
	lttcomm_destroy_sock(new_sock);
error:
	return ret;
}

/*
 * This thread manage application notify communication.
 */
void *jul_thread_manage_registration(void *data)
{
	int i, ret, pollfd;
	uint32_t revents, nb_fd;
	struct lttng_poll_event events;
	struct lttcomm_sock *reg_sock;

	DBG("[jul-thread] Manage JUL application registration.");

	rcu_register_thread();
	rcu_thread_online();

	/* JUL initialization call MUST be called before starting the thread. */
	assert(jul_apps_ht_by_sock);

	/* Create pollset with size 2, quit pipe and socket. */
	ret = sessiond_set_thread_pollset(&events, 2);
	if (ret < 0) {
		goto error_poll_create;
	}

	reg_sock = init_tcp_socket();
	if (!reg_sock) {
		goto error_tcp_socket;
	}

	/* Add create valid TCP socket to poll set. */
	ret = lttng_poll_add(&events, reg_sock->fd,
			LPOLLIN | LPOLLERR | LPOLLHUP | LPOLLRDHUP);
	if (ret < 0) {
		goto error;
	}

	while (1) {
		DBG3("[jul-thread] Manage JUL polling on %d fds",
				LTTNG_POLL_GETNB(&events));

		/* Inifinite blocking call, waiting for transmission */
restart:
		ret = lttng_poll_wait(&events, -1);
		if (ret < 0) {
			/*
			 * Restart interrupted system call.
			 */
			if (errno == EINTR) {
				goto restart;
			}
			goto error;
		}
		nb_fd = ret;
		DBG3("[jul-thread] %d fd ready", nb_fd);

		for (i = 0; i < nb_fd; i++) {
			/* Fetch once the poll data */
			revents = LTTNG_POLL_GETEV(&events, i);
			pollfd = LTTNG_POLL_GETFD(&events, i);

			/* Thread quit pipe has been closed. Killing thread. */
			ret = sessiond_check_thread_quit_pipe(pollfd, revents);
			if (ret) {
				goto exit;
			}

			/*
			 * Check first if this is a POLLERR since POLLIN is also included
			 * in an error value thus checking first.
			 */
			if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
				/* Removing from the poll set */
				ret = lttng_poll_del(&events, pollfd);
				if (ret < 0) {
					goto error;
				}

				destroy_jul_app(pollfd);
			} else if (revents & (LPOLLIN)) {
				int new_fd;
				struct jul_app *app = NULL;

				/* Pollin event of JUL app socket should NEVER happen. */
				assert(pollfd == reg_sock->fd);

				new_fd = handle_registration(reg_sock, &app);
				if (new_fd < 0) {
					WARN("[jul-thread] JUL registration failed. Ignoring.");
					/* Somehow the communication failed. Just continue. */
					continue;
				}
				/* Should not have a NULL app on success. */
				assert(app);

				/* Only add poll error event to only detect shutdown. */
				ret = lttng_poll_add(&events, new_fd,
						LPOLLERR | LPOLLHUP | LPOLLRDHUP);
				if (ret < 0) {
					destroy_jul_app(new_fd);
					continue;
				}

				/* Update newly registered app. */
				update_jul_app(new_fd);

				/* On failure, the poll will detect it and clean it up. */
				(void) jul_send_registration_done(app);
			} else {
				ERR("Unknown poll events %u for sock %d", revents, pollfd);
				continue;
			}
		}
	}

exit:
	/* Whatever happens, try to delete it and exit. */
	(void) lttng_poll_del(&events, reg_sock->fd);
error:
	destroy_tcp_socket(reg_sock);
error_tcp_socket:
	lttng_poll_clean(&events);
error_poll_create:
	DBG("[jul-thread] is cleaning up and stopping.");

	if (jul_apps_ht_by_sock) {
		clean_jul_apps_ht();
		lttng_ht_destroy(jul_apps_ht_by_sock);
	}

	rcu_thread_offline();
	rcu_unregister_thread();
	return NULL;
}
Commit	Line	Data
4d076222 DG	1	/*
	2	* Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU General Public License, version 2 only, as
	6	* published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	11	* more details.
	12	*
	13	* You should have received a copy of the GNU General Public License along with
	14	* this program; if not, write to the Free Software Foundation, Inc., 51
	15	* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	16	*/
	17
	18	#define _GNU_SOURCE
	19	#include <assert.h>
	20
	21	#include <common/common.h>
	22	#include <common/sessiond-comm/sessiond-comm.h>
	23	#include <common/uri.h>
	24	#include <common/utils.h>
	25
	26	#include "fd-limit.h"
	27	#include "jul-thread.h"
	28	#include "lttng-sessiond.h"
f20baf8e DG	29	#include "session.h"
f20baf8e DG	30	#include "utils.h"
4d076222 DG	31
	32	/*
	33	* Note that there is not port here. It's set after this URI is parsed so we
	34	* can let the user define a custom one. However, localhost is ALWAYS the
	35	* default listening address.
	36	*/
	37	static const char *default_reg_uri = "tcp://localhost";
	38
f20baf8e DG	39	/*
	40	* Update JUL application using the given socket. This is done just after
	41	* registration was successful.
	42	*
	43	* This is a quite heavy call in terms of locking since the session list lock
	44	* AND session lock are acquired.
	45	*/
	46	static void update_jul_app(int sock)
	47	{
	48	struct ltt_session session, stmp;
	49	struct ltt_session_list *list;
	50
	51	list = session_get_list();
	52	assert(list);
	53
	54	session_lock_list();
	55	cds_list_for_each_entry_safe(session, stmp, &list->head, list) {
	56	session_lock(session);
	57	if (session->ust_session) {
	58	jul_update(&session->ust_session->domain_jul, sock);
	59	}
	60	session_unlock(session);
	61	}
	62	session_unlock_list();
	63	}
	64
	65	/*
	66	* Destroy a JUL application by socket.
	67	*/
	68	static void destroy_jul_app(int sock)
	69	{
	70	struct jul_app *app;
	71
	72	assert(sock >= 0);
	73
	74	/*
	75	* Not finding an application is a very important error that should NEVER
	76	* happen. The hash table deletion is ONLY done through this call even on
	77	* thread cleanup.
	78	*/
	79	rcu_read_lock();
	80	app = jul_find_app_by_sock(sock);
	81	assert(app);
	82	rcu_read_unlock();
	83
	84	/* RCU read side lock is taken in this function call. */
	85	jul_delete_app(app);
	86
	87	/* The application is freed in a RCU call but the socket is closed here. */
	88	jul_destroy_app(app);
	89	}
	90
	91	/*
	92	* Cleanup remaining JUL apps in the hash table. This should only be called in
	93	* the exit path of the thread.
	94	*/
	95	static void clean_jul_apps_ht(void)
	96	{
	97	struct lttng_ht_node_ulong *node;
	98	struct lttng_ht_iter iter;
	99
	100	DBG3("[jul-thread] Cleaning JUL apps ht");
	101
	102	rcu_read_lock();
103	cds_lfht_for_each_entry(jul_apps_ht_by_sock->ht, &iter.iter, node, node) {
104	struct jul_app *app;
105
106	app = caa_container_of(node, struct jul_app, node);
107	destroy_jul_app(app->sock->fd);
108	}
109	rcu_read_unlock();
110	}
111
4d076222 DG	112	/*
	113	* Create and init socket from uri.
	114	*/
	115	static struct lttcomm_sock *init_tcp_socket(void)
	116	{
	117	int ret;
	118	struct lttng_uri *uri = NULL;
	119	struct lttcomm_sock *sock = NULL;
	120
	121	/*
	122	* This should never fail since the URI is hardcoded and the port is set
	123	* before this thread is launched.
	124	*/
	125	ret = uri_parse(default_reg_uri, &uri);
	126	assert(ret);
	127	assert(jul_tcp_port);
	128	uri->port = jul_tcp_port;
	129
	130	sock = lttcomm_alloc_sock_from_uri(uri);
	131	uri_free(uri);
	132	if (sock == NULL) {
	133	ERR("[jul-thread] JUL allocating TCP socket");
	134	goto error;
	135	}
	136
	137	ret = lttcomm_create_sock(sock);
	138	if (ret < 0) {
	139	goto error;
	140	}
	141
	142	ret = sock->ops->bind(sock);
	143	if (ret < 0) {
5b06ad8b DG	144	WARN("An other session daemon is using this JUL port. JUL support "
5b06ad8b DG	145	"will be deactivated not interfering with the tracing.");
4d076222 DG	146	goto error;
	147	}
	148
	149	ret = sock->ops->listen(sock, -1);
	150	if (ret < 0) {
	151	goto error;
	152	}
	153
	154	DBG("[jul-thread] Listening on TCP port %u and socket %d", jul_tcp_port,
	155	sock->fd);
	156
	157	return sock;
	158
	159	error:
	160	if (sock) {
	161	lttcomm_destroy_sock(sock);
	162	}
	163	return NULL;
	164	}
	165
	166	/*
	167	* Close and destroy the given TCP socket.
	168	*/
	169	static void destroy_tcp_socket(struct lttcomm_sock *sock)
	170	{
	171	assert(sock);
	172
	173	DBG3("[jul-thread] Destroy TCP socket on port %u", jul_tcp_port);
	174
	175	/* This will return gracefully if fd is invalid. */
	176	sock->ops->close(sock);
	177	lttcomm_destroy_sock(sock);
	178	}
	179
f20baf8e DG	180	/*
	181	* Handle a new JUL registration using the reg socket. After that, a new JUL
	182	* application is added to the global hash table and attach to an UST app
1b500e7a	183	* object. If r_app is not NULL, the created app is set to the pointer.
f20baf8e DG	184	*
	185	* Return the new FD created upon accept() on success or else a negative errno
	186	* value.
	187	*/
1b500e7a DG	188	static int handle_registration(struct lttcomm_sock *reg_sock,
1b500e7a DG	189	struct jul_app **r_app)
f20baf8e DG	190	{
	191	int ret;
	192	pid_t pid;
	193	ssize_t size;
	194	struct jul_app *app;
	195	struct jul_register_msg msg;
	196	struct lttcomm_sock *new_sock;
	197
	198	assert(reg_sock);
	199
	200	new_sock = reg_sock->ops->accept(reg_sock);
	201	if (!new_sock) {
	202	ret = -ENOTCONN;
	203	goto error;
	204	}
	205
	206	size = new_sock->ops->recvmsg(new_sock, &msg, sizeof(msg), 0);
	207	if (size < sizeof(msg)) {
	208	ret = -errno;
	209	goto error_socket;
	210	}
	211	pid = be32toh(msg.pid);
	212
	213	DBG2("[jul-thread] New registration for pid %d on socket %d", pid,
	214	new_sock->fd);
	215
	216	app = jul_create_app(pid, new_sock);
	217	if (!app) {
	218	ret = -ENOMEM;
	219	goto error_socket;
	220	}
	221
	222	/*
	223	* Add before assigning the socket value to the UST app so it can be found
	224	* concurrently.
	225	*/
	226	jul_add_app(app);
	227
	228	/*
6c509840 MD	229	* We don't need to attach the JUL app to the app. If we ever do
	230	* so, we should consider both registration order of JUL before
	231	* app and app before JUL.
f20baf8e	232	*/
f20baf8e	233
1b500e7a DG	234	if (r_app) {
	235	*r_app = app;
	236	}
	237
f20baf8e DG	238	return new_sock->fd;
	239
	240	error_socket:
	241	new_sock->ops->close(new_sock);
	242	lttcomm_destroy_sock(new_sock);
	243	error:
	244	return ret;
	245	}
	246
4d076222 DG	247	/*
	248	* This thread manage application notify communication.
	249	*/
	250	void jul_thread_manage_registration(void data)
	251	{
	252	int i, ret, pollfd;
	253	uint32_t revents, nb_fd;
	254	struct lttng_poll_event events;
	255	struct lttcomm_sock *reg_sock;
	256
	257	DBG("[jul-thread] Manage JUL application registration.");
	258
	259	rcu_register_thread();
	260	rcu_thread_online();
	261
f20baf8e DG	262	/* JUL initialization call MUST be called before starting the thread. */
	263	assert(jul_apps_ht_by_sock);
	264
4d076222 DG	265	/* Create pollset with size 2, quit pipe and socket. */
	266	ret = sessiond_set_thread_pollset(&events, 2);
	267	if (ret < 0) {
	268	goto error_poll_create;
	269	}
	270
	271	reg_sock = init_tcp_socket();
	272	if (!reg_sock) {
	273	goto error_tcp_socket;
	274	}
	275
	276	/* Add create valid TCP socket to poll set. */
	277	ret = lttng_poll_add(&events, reg_sock->fd,
	278	LPOLLIN \| LPOLLERR \| LPOLLHUP \| LPOLLRDHUP);
	279	if (ret < 0) {
	280	goto error;
	281	}
	282
	283	while (1) {
	284	DBG3("[jul-thread] Manage JUL polling on %d fds",
	285	LTTNG_POLL_GETNB(&events));
	286
	287	/* Inifinite blocking call, waiting for transmission */
	288	restart:
	289	ret = lttng_poll_wait(&events, -1);
	290	if (ret < 0) {
	291	/*
	292	* Restart interrupted system call.
	293	*/
	294	if (errno == EINTR) {
	295	goto restart;
	296	}
	297	goto error;
	298	}
	299	nb_fd = ret;
f20baf8e	300	DBG3("[jul-thread] %d fd ready", nb_fd);
4d076222 DG	301
	302	for (i = 0; i < nb_fd; i++) {
	303	/* Fetch once the poll data */
	304	revents = LTTNG_POLL_GETEV(&events, i);
	305	pollfd = LTTNG_POLL_GETFD(&events, i);
	306
	307	/* Thread quit pipe has been closed. Killing thread. */
	308	ret = sessiond_check_thread_quit_pipe(pollfd, revents);
	309	if (ret) {
	310	goto exit;
	311	}
	312
	313	/*
	314	* Check first if this is a POLLERR since POLLIN is also included
	315	* in an error value thus checking first.
	316	*/
	317	if (revents & (LPOLLERR \| LPOLLHUP \| LPOLLRDHUP)) {
	318	/* Removing from the poll set */
	319	ret = lttng_poll_del(&events, pollfd);
	320	if (ret < 0) {
	321	goto error;
	322	}
	323
f20baf8e DG	324	destroy_jul_app(pollfd);
	325	} else if (revents & (LPOLLIN)) {
	326	int new_fd;
1b500e7a	327	struct jul_app *app = NULL;
f20baf8e DG	328
	329	/* Pollin event of JUL app socket should NEVER happen. */
	330	assert(pollfd == reg_sock->fd);
	331
1b500e7a	332	new_fd = handle_registration(reg_sock, &app);
f20baf8e DG	333	if (new_fd < 0) {
	334	WARN("[jul-thread] JUL registration failed. Ignoring.");
	335	/* Somehow the communication failed. Just continue. */
	336	continue;
	337	}
1b500e7a DG	338	/* Should not have a NULL app on success. */
1b500e7a DG	339	assert(app);
f20baf8e DG	340
	341	/* Only add poll error event to only detect shutdown. */
	342	ret = lttng_poll_add(&events, new_fd,
	343	LPOLLERR \| LPOLLHUP \| LPOLLRDHUP);
	344	if (ret < 0) {
	345	destroy_jul_app(new_fd);
	346	continue;
	347	}
	348
	349	/* Update newly registered app. */
	350	update_jul_app(new_fd);
1b500e7a DG	351
	352	/* On failure, the poll will detect it and clean it up. */
	353	(void) jul_send_registration_done(app);
4d076222 DG	354	} else {
	355	ERR("Unknown poll events %u for sock %d", revents, pollfd);
	356	continue;
	357	}
	358	}
	359	}
	360
	361	exit:
f20baf8e DG	362	/* Whatever happens, try to delete it and exit. */
f20baf8e DG	363	(void) lttng_poll_del(&events, reg_sock->fd);
4d076222 DG	364	error:
	365	destroy_tcp_socket(reg_sock);
	366	error_tcp_socket:
	367	lttng_poll_clean(&events);
	368	error_poll_create:
	369	DBG("[jul-thread] is cleaning up and stopping.");
	370
f20baf8e DG	371	if (jul_apps_ht_by_sock) {
	372	clean_jul_apps_ht();
	373	lttng_ht_destroy(jul_apps_ht_by_sock);
	374	}
	375
4d076222 DG	376	rcu_thread_offline();
	377	rcu_unregister_thread();
	378	return NULL;
	379	}