[lttng-ust.git] / src / common / compat / pthread.h

/*
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 * Copyright (C) 2016 Raphaël Beamonte <raphael.beamonte@gmail.com>
 * Copyright (C) 2020 Michael Jeanson <mjeanson@efficios.com>
 */

#ifndef _UST_COMMON_COMPAT_PTHREAD_H
#define _UST_COMMON_COMPAT_PTHREAD_H

#include <pthread.h>
#include <errno.h>

#include <lttng/ust-abi.h>

#ifdef __FreeBSD__
#include <pthread_np.h>
#endif

#if defined(HAVE_PTHREAD_SETNAME_NP_WITH_TID)
static inline
int lttng_pthread_setname_np(const char *name)
{
	/*
	 * Some implementations don't error out, replicate this behavior for
	 * consistency.
	 */
	if (strnlen(name, LTTNG_UST_ABI_PROCNAME_LEN) >= LTTNG_UST_ABI_PROCNAME_LEN) {
		return ERANGE;
	}

	return pthread_setname_np(pthread_self(), name);
}
#elif defined(HAVE_PTHREAD_SETNAME_NP_WITHOUT_TID)
static inline
int lttng_pthread_setname_np(const char *name)
{
	return pthread_setname_np(name);
}
#elif defined(HAVE_PTHREAD_SET_NAME_NP_WITH_TID)

static inline
int lttng_pthread_setname_np(const char *name)
{
	/* Replicate pthread_setname_np's behavior */
	if (strnlen(name, LTTNG_UST_ABI_PROCNAME_LEN) >= LTTNG_UST_ABI_PROCNAME_LEN) {
		return ERANGE;
	}

	pthread_set_name_np(pthread_self(), name);
	return 0;
}
#elif defined(__linux__)

/* Fallback on prtctl on Linux */
#include <sys/prctl.h>

static inline
int lttng_pthread_setname_np(const char *name)
{
	/* Replicate pthread_setname_np's behavior */
	if (strnlen(name, LTTNG_UST_ABI_PROCNAME_LEN) >= LTTNG_UST_ABI_PROCNAME_LEN) {
		return ERANGE;
	}
	return prctl(PR_SET_NAME, name, 0, 0, 0);
}
#else
#error "Please add pthread set name support for your OS."
#endif


#if defined(HAVE_PTHREAD_GETNAME_NP_WITH_TID)
static inline
int lttng_pthread_getname_np(char *name, size_t len)
{
	return pthread_getname_np(pthread_self(), name, len);
}
#elif defined(HAVE_PTHREAD_GETNAME_NP_WITHOUT_TID)
static inline
int lttng_pthread_getname_np(char *name, size_t len)
{
	return pthread_getname_np(name, len);
}
#elif defined(HAVE_PTHREAD_GET_NAME_NP_WITH_TID)

static inline
int lttng_pthread_getname_np(char *name, size_t len)
{
	pthread_get_name_np(pthread_self(), name, len);
	return 0;
}
#elif defined(__linux__)

/* Fallback on prtctl on Linux */
#include <sys/prctl.h>

static inline
int lttng_pthread_getname_np(char *name, size_t len)
{
	return prctl(PR_GET_NAME, name, 0, 0, 0);
}

#else
#error "Please add pthread get name support for your OS."
#endif

#endif /* _UST_COMMON_COMPAT_PTHREAD_H */
Commit	Line	Data
	1	/*
	2	* SPDX-License-Identifier: LGPL-2.1-only
	3	*
	4	* Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	5	* Copyright (C) 2016 Raphaël Beamonte <raphael.beamonte@gmail.com>
	6	* Copyright (C) 2020 Michael Jeanson <mjeanson@efficios.com>
	7	*/
	8
	9	#ifndef _UST_COMMON_COMPAT_PTHREAD_H
	10	#define _UST_COMMON_COMPAT_PTHREAD_H
	11
	12	#include <pthread.h>
	13	#include <errno.h>
	14
	15	#include <lttng/ust-abi.h>
	16
	17	#ifdef __FreeBSD__
	18	#include <pthread_np.h>
	19	#endif
	20
	21	#if defined(HAVE_PTHREAD_SETNAME_NP_WITH_TID)
	22	static inline
	23	int lttng_pthread_setname_np(const char *name)
	24	{
	25	/*
	26	* Some implementations don't error out, replicate this behavior for
	27	* consistency.
	28	*/
	29	if (strnlen(name, LTTNG_UST_ABI_PROCNAME_LEN) >= LTTNG_UST_ABI_PROCNAME_LEN) {
	30	return ERANGE;
	31	}
	32
	33	return pthread_setname_np(pthread_self(), name);
	34	}
	35	#elif defined(HAVE_PTHREAD_SETNAME_NP_WITHOUT_TID)
	36	static inline
	37	int lttng_pthread_setname_np(const char *name)
	38	{
	39	return pthread_setname_np(name);
	40	}
	41	#elif defined(HAVE_PTHREAD_SET_NAME_NP_WITH_TID)
	42
	43	static inline
	44	int lttng_pthread_setname_np(const char *name)
	45	{
	46	/* Replicate pthread_setname_np's behavior */
	47	if (strnlen(name, LTTNG_UST_ABI_PROCNAME_LEN) >= LTTNG_UST_ABI_PROCNAME_LEN) {
	48	return ERANGE;
	49	}
	50
	51	pthread_set_name_np(pthread_self(), name);
	52	return 0;
	53	}
	54	#elif defined(__linux__)
	55
	56	/* Fallback on prtctl on Linux */
	57	#include <sys/prctl.h>
	58
	59	static inline
	60	int lttng_pthread_setname_np(const char *name)
	61	{
	62	/* Replicate pthread_setname_np's behavior */
	63	if (strnlen(name, LTTNG_UST_ABI_PROCNAME_LEN) >= LTTNG_UST_ABI_PROCNAME_LEN) {
	64	return ERANGE;
	65	}
	66	return prctl(PR_SET_NAME, name, 0, 0, 0);
	67	}
	68	#else
	69	#error "Please add pthread set name support for your OS."
	70	#endif
	71
	72
	73	#if defined(HAVE_PTHREAD_GETNAME_NP_WITH_TID)
	74	static inline
	75	int lttng_pthread_getname_np(char *name, size_t len)
	76	{
	77	return pthread_getname_np(pthread_self(), name, len);
	78	}
	79	#elif defined(HAVE_PTHREAD_GETNAME_NP_WITHOUT_TID)
	80	static inline
	81	int lttng_pthread_getname_np(char *name, size_t len)
	82	{
	83	return pthread_getname_np(name, len);
	84	}
	85	#elif defined(HAVE_PTHREAD_GET_NAME_NP_WITH_TID)
	86
	87	static inline
	88	int lttng_pthread_getname_np(char *name, size_t len)
	89	{
	90	pthread_get_name_np(pthread_self(), name, len);
	91	return 0;
	92	}
	93	#elif defined(__linux__)
	94
	95	/* Fallback on prtctl on Linux */
	96	#include <sys/prctl.h>
	97
	98	static inline
	99	int lttng_pthread_getname_np(char *name, size_t len)
	100	{
	101	return prctl(PR_GET_NAME, name, 0, 0, 0);
	102	}
	103
	104	#else
	105	#error "Please add pthread get name support for your OS."
	106	#endif
	107
	108	#endif /* _UST_COMMON_COMPAT_PTHREAD_H */