[lttng-tools.git] / include / lttng / constant.h

/*
 * Copyright (C) 2014 David Goulet <dgoulet@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#ifndef LTTNG_CONSTANT_H
#define LTTNG_CONSTANT_H

#ifndef LTTNG_DEPRECATED
#if defined(__GNUC__) && ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 5) || __GNUC__ >= 5)
#define LTTNG_DEPRECATED(msg) __attribute__((deprecated(msg)))
#else
#define LTTNG_DEPRECATED(msg) __attribute__((deprecated))
#endif /* defined __GNUC__ */
#endif /* LTTNG_DEPRECATED */

#include <limits.h>
/*
 * Necessary to include the fixed width type limits on glibc versions older
 * than 2.18 when building with a C++ compiler.
 */
#ifndef __STDC_LIMIT_MACROS
#define __STDC_LIMIT_MACROS
#include <stdint.h>
#undef __STDC_LIMIT_MACROS
#else /* #ifndef __STDC_LIMIT_MACROS */
#include <stdint.h>
#endif /* #else #ifndef __STDC_LIMIT_MACROS */
#include <sys/types.h>

/*
 * Event symbol length. Copied from LTTng kernel ABI.
 */

/*!
@brief
    Maximum symbol length.

@ingroup api_gen
*/
#define LTTNG_SYMBOL_NAME_LEN 256

/*
 * PROC(5) mentions that PID_MAX_LIMIT may not exceed 2^22 on 64-bit HW.
 * We prefer to use 32-bits for simplicity's sake.
 */
#define LTTNG_MAX_PID	  INT32_MAX
#define LTTNG_MAX_PID_STR "2147483647"

/*!
@brief
    Maximum name length.

@ingroup api_gen
*/
#define LTTNG_NAME_MAX 255

/*
 * POSIX guarantees that a host name will not exceed 255 characters.
 * Moreover, RFC 1035 limits the length of a fully qualified domain name (FQDN)
 * to 255 characters.
 *
 * 256 is used to include a trailing NULL character.
 */
#define LTTNG_HOST_NAME_MAX 256

#define LTTNG_PATH_MAX 4096

#endif /* LTTNG_CONSTANT_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2014 David Goulet <dgoulet@efficios.com>
	3	*
	4	* SPDX-License-Identifier: LGPL-2.1-only
	5	*
	6	*/
	7
	8	#ifndef LTTNG_CONSTANT_H
	9	#define LTTNG_CONSTANT_H
	10
	11	#ifndef LTTNG_DEPRECATED
	12	#if defined(__GNUC__) && ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 5) \|\| __GNUC__ >= 5)
	13	#define LTTNG_DEPRECATED(msg) __attribute__((deprecated(msg)))
	14	#else
	15	#define LTTNG_DEPRECATED(msg) __attribute__((deprecated))
	16	#endif /* defined __GNUC__ */
	17	#endif /* LTTNG_DEPRECATED */
	18
	19	#include <limits.h>
	20	/*
	21	* Necessary to include the fixed width type limits on glibc versions older
	22	* than 2.18 when building with a C++ compiler.
	23	*/
	24	#ifndef __STDC_LIMIT_MACROS
	25	#define __STDC_LIMIT_MACROS
	26	#include <stdint.h>
	27	#undef __STDC_LIMIT_MACROS
	28	#else /* #ifndef __STDC_LIMIT_MACROS */
	29	#include <stdint.h>
	30	#endif /* #else #ifndef __STDC_LIMIT_MACROS */
	31	#include <sys/types.h>
	32
	33	/*
	34	* Event symbol length. Copied from LTTng kernel ABI.
	35	*/
	36
	37	/*!
	38	@brief
	39	Maximum symbol length.
	40
	41	@ingroup api_gen
	42	*/
	43	#define LTTNG_SYMBOL_NAME_LEN 256
	44
	45	/*
	46	* PROC(5) mentions that PID_MAX_LIMIT may not exceed 2^22 on 64-bit HW.
	47	* We prefer to use 32-bits for simplicity's sake.
	48	*/
	49	#define LTTNG_MAX_PID INT32_MAX
	50	#define LTTNG_MAX_PID_STR "2147483647"
	51
	52	/*!
	53	@brief
	54	Maximum name length.
	55
	56	@ingroup api_gen
	57	*/
	58	#define LTTNG_NAME_MAX 255
	59
	60	/*
	61	* POSIX guarantees that a host name will not exceed 255 characters.
	62	* Moreover, RFC 1035 limits the length of a fully qualified domain name (FQDN)
	63	* to 255 characters.
	64	*
	65	* 256 is used to include a trailing NULL character.
	66	*/
	67	#define LTTNG_HOST_NAME_MAX 256
	68
	69	#define LTTNG_PATH_MAX 4096
	70
	71	#endif /* LTTNG_CONSTANT_H */