[lttng-ust.git] / liblttng-ust / lttng-context-vuid.c

/*
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (C) 2009-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 * Copyright (C) 2019 Michael Jeanson <mjeanson@efficios.com>
 *
 * LTTng UST namespaced real user ID context.
 */

#define _LGPL_SOURCE
#include <limits.h>
#include <stddef.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <lttng/ust-events.h>
#include <lttng/ust-tracer.h>
#include <lttng/ringbuffer-context.h>

#include "context-internal.h"
#include "creds.h"


/*
 * At the kernel level, user IDs and group IDs are a per-thread attribute.
 * However, POSIX requires that all threads in a process share the same
 * credentials. The NPTL threading implementation handles the POSIX
 * requirements by providing wrapper functions for the various system calls
 * that change process UIDs and GIDs. These wrapper functions (including those
 * for setreuid() and setregid()) employ a signal-based technique to ensure
 * that when one thread changes credentials, all of the other threads in the
 * process also change their credentials.
 */

/*
 * We cache the result to ensure we don't trigger a system call for
 * each event. User / group IDs are global to the process.
 */
static uid_t cached_vuid = INVALID_UID;

static
uid_t get_vuid(void)
{
	uid_t vuid;

	vuid = CMM_LOAD_SHARED(cached_vuid);

	if (caa_unlikely(vuid == INVALID_UID)) {
		vuid = getuid();
		CMM_STORE_SHARED(cached_vuid, vuid);
	}

	return vuid;
}

/*
 * The vuid can change on setuid, setreuid and setresuid.
 */
void lttng_context_vuid_reset(void)
{
	CMM_STORE_SHARED(cached_vuid, INVALID_UID);
}

static
size_t vuid_get_size(struct lttng_ust_ctx_field *field, size_t offset)
{
	size_t size = 0;

	size += lttng_ust_lib_ring_buffer_align(offset, lttng_ust_rb_alignof(uid_t));
	size += sizeof(uid_t);
	return size;
}

static
void vuid_record(struct lttng_ust_ctx_field *field,
		 struct lttng_ust_lib_ring_buffer_ctx *ctx,
		 struct lttng_ust_channel_buffer *chan)
{
	uid_t vuid;

	vuid = get_vuid();
	chan->ops->event_write(ctx, &vuid, sizeof(vuid), lttng_ust_rb_alignof(vuid));
}

static
void vuid_get_value(struct lttng_ust_ctx_field *field,
		struct lttng_ust_ctx_value *value)
{
	value->u.s64 = get_vuid();
}

int lttng_add_vuid_to_ctx(struct lttng_ust_ctx **ctx)
{
	struct lttng_ust_ctx_field *field;
	struct lttng_ust_type_common *type;
	int ret;

	type = lttng_ust_create_type_integer(sizeof(uid_t) * CHAR_BIT,
			lttng_ust_rb_alignof(uid_t) * CHAR_BIT,
			lttng_ust_is_signed_type(uid_t),
			BYTE_ORDER, 10);
	if (!type)
		return -ENOMEM;
	field = lttng_append_context(ctx);
	if (!field) {
		ret = -ENOMEM;
		goto error_context;
	}
	if (lttng_find_context(*ctx, "vuid")) {
		ret = -EEXIST;
		goto error_find_context;
	}
	field->event_field->name = strdup("vuid");
	if (!field->event_field->name) {
		ret = -ENOMEM;
		goto error_name;
	}
	field->event_field->type = type;
	field->get_size = vuid_get_size;
	field->record = vuid_record;
	field->get_value = vuid_get_value;
	lttng_context_update(*ctx);
	return 0;

error_name:
error_find_context:
	lttng_remove_context_field(ctx, field);
error_context:
	lttng_ust_destroy_type(type);
	return ret;
}
Commit	Line	Data
	1	/*
	2	* SPDX-License-Identifier: LGPL-2.1-only
	3	*
	4	* Copyright (C) 2009-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	5	* Copyright (C) 2019 Michael Jeanson <mjeanson@efficios.com>
	6	*
	7	* LTTng UST namespaced real user ID context.
	8	*/
	9
	10	#define _LGPL_SOURCE
	11	#include <limits.h>
	12	#include <stddef.h>
	13	#include <sys/types.h>
	14	#include <sys/stat.h>
	15	#include <unistd.h>
	16	#include <lttng/ust-events.h>
	17	#include <lttng/ust-tracer.h>
	18	#include <lttng/ringbuffer-context.h>
	19
	20	#include "context-internal.h"
	21	#include "creds.h"
	22
	23
	24	/*
	25	* At the kernel level, user IDs and group IDs are a per-thread attribute.
	26	* However, POSIX requires that all threads in a process share the same
	27	* credentials. The NPTL threading implementation handles the POSIX
	28	* requirements by providing wrapper functions for the various system calls
	29	* that change process UIDs and GIDs. These wrapper functions (including those
	30	* for setreuid() and setregid()) employ a signal-based technique to ensure
	31	* that when one thread changes credentials, all of the other threads in the
	32	* process also change their credentials.
	33	*/
	34
	35	/*
	36	* We cache the result to ensure we don't trigger a system call for
	37	* each event. User / group IDs are global to the process.
	38	*/
	39	static uid_t cached_vuid = INVALID_UID;
	40
	41	static
	42	uid_t get_vuid(void)
	43	{
	44	uid_t vuid;
	45
	46	vuid = CMM_LOAD_SHARED(cached_vuid);
	47
	48	if (caa_unlikely(vuid == INVALID_UID)) {
	49	vuid = getuid();
	50	CMM_STORE_SHARED(cached_vuid, vuid);
	51	}
	52
	53	return vuid;
	54	}
	55
	56	/*
	57	* The vuid can change on setuid, setreuid and setresuid.
	58	*/
	59	void lttng_context_vuid_reset(void)
	60	{
	61	CMM_STORE_SHARED(cached_vuid, INVALID_UID);
	62	}
	63
	64	static
	65	size_t vuid_get_size(struct lttng_ust_ctx_field *field, size_t offset)
	66	{
	67	size_t size = 0;
	68
	69	size += lttng_ust_lib_ring_buffer_align(offset, lttng_ust_rb_alignof(uid_t));
	70	size += sizeof(uid_t);
	71	return size;
	72	}
	73
	74	static
	75	void vuid_record(struct lttng_ust_ctx_field *field,
	76	struct lttng_ust_lib_ring_buffer_ctx *ctx,
	77	struct lttng_ust_channel_buffer *chan)
	78	{
	79	uid_t vuid;
	80
	81	vuid = get_vuid();
	82	chan->ops->event_write(ctx, &vuid, sizeof(vuid), lttng_ust_rb_alignof(vuid));
	83	}
	84
	85	static
	86	void vuid_get_value(struct lttng_ust_ctx_field *field,
	87	struct lttng_ust_ctx_value *value)
	88	{
	89	value->u.s64 = get_vuid();
	90	}
	91
	92	int lttng_add_vuid_to_ctx(struct lttng_ust_ctx **ctx)
	93	{
	94	struct lttng_ust_ctx_field *field;
	95	struct lttng_ust_type_common *type;
	96	int ret;
	97
	98	type = lttng_ust_create_type_integer(sizeof(uid_t) * CHAR_BIT,
	99	lttng_ust_rb_alignof(uid_t) * CHAR_BIT,
	100	lttng_ust_is_signed_type(uid_t),
	101	BYTE_ORDER, 10);
	102	if (!type)
	103	return -ENOMEM;
	104	field = lttng_append_context(ctx);
	105	if (!field) {
	106	ret = -ENOMEM;
	107	goto error_context;
	108	}
	109	if (lttng_find_context(*ctx, "vuid")) {
	110	ret = -EEXIST;
	111	goto error_find_context;
	112	}
	113	field->event_field->name = strdup("vuid");
	114	if (!field->event_field->name) {
	115	ret = -ENOMEM;
	116	goto error_name;
	117	}
	118	field->event_field->type = type;
	119	field->get_size = vuid_get_size;
	120	field->record = vuid_record;
	121	field->get_value = vuid_get_value;
	122	lttng_context_update(*ctx);
	123	return 0;
	124
	125	error_name:
	126	error_find_context:
	127	lttng_remove_context_field(ctx, field);
	128	error_context:
	129	lttng_ust_destroy_type(type);
	130	return ret;
	131	}