[lttng-modules.git] / include / lttng / kernel-version.h

/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
 *
 * lttng/kernel-version.h
 *
 * Contains helpers to check kernel version conditions.
 *
 * Copyright (C) 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 */

#ifndef _LTTNG_KERNEL_VERSION_H
#define _LTTNG_KERNEL_VERSION_H

#include <linux/version.h>
#include <linux/types.h>
#include <generated/utsrelease.h>

/*
 * The following defines are extracted from the toplevel Linux Makefile and
 * passed on the command line -with '-D'.
 */

#ifndef LTTNG_LINUX_MAJOR
#define LTTNG_LINUX_MAJOR 0
#endif

#ifndef LTTNG_LINUX_MINOR
#define LTTNG_LINUX_MINOR 0
#endif

#ifndef LTTNG_LINUX_PATCH
#define LTTNG_LINUX_PATCH 0
#endif

/*
 * Some stable releases have overflowed the 8bits allocated to the sublevel in
 * the version code. To determine if the current kernel is affected, use the
 * sublevel version from the Makefile. This is currently true for the 4.4.256
 * and 4.9.256 stable releases.
 *
 * When the sublevel has overflowed, use the values from the Makefile instead
 * of LINUX_VERSION_CODE from the kernel headers and allocate 16bits.
 * Otherwise, keep using the version code from the headers to minimise the
 * behavior change and avoid regressions.
 *
 * Cast the result to uint64_t to prevent overflowing when we append distro
 * specific version information.
 */
#if (LTTNG_LINUX_PATCH >= 256)

#define LTTNG_KERNEL_VERSION(a, b, c) \
	((((a) << 24) + ((b) << 16) + (c)) * 1ULL)

#define LTTNG_LINUX_VERSION_CODE \
	LTTNG_KERNEL_VERSION(LTTNG_LINUX_MAJOR, LTTNG_LINUX_MINOR, LTTNG_LINUX_PATCH)

#else

#define LTTNG_KERNEL_VERSION(a, b, c) (KERNEL_VERSION(a, b, c) * 1ULL)
#define LTTNG_LINUX_VERSION_CODE (LINUX_VERSION_CODE * 1ULL)

#endif

/*
 * This macro checks if the kernel version is between the two specified
 * versions (lower limit inclusive, upper limit exclusive).
 */
#define LTTNG_KERNEL_RANGE(a_low, b_low, c_low, a_high, b_high, c_high) \
	(LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(a_low, b_low, c_low) && \
	 LTTNG_LINUX_VERSION_CODE < LTTNG_KERNEL_VERSION(a_high, b_high, c_high))

/* Ubuntu */

#define LTTNG_UBUNTU_KERNEL_VERSION(a, b, c, d) \
	(((LTTNG_KERNEL_VERSION(a, b, c)) << 16) + (d))

#ifdef UTS_UBUNTU_RELEASE_ABI
#define LTTNG_UBUNTU_VERSION_CODE \
	((LTTNG_LINUX_VERSION_CODE << 16) + UTS_UBUNTU_RELEASE_ABI)
#else
#define LTTNG_UBUNTU_VERSION_CODE 	0
#endif

#define LTTNG_UBUNTU_KERNEL_RANGE(a_low, b_low, c_low, d_low, \
		a_high, b_high, c_high, d_high) \
	(LTTNG_UBUNTU_VERSION_CODE >= \
		LTTNG_UBUNTU_KERNEL_VERSION(a_low, b_low, c_low, d_low) && \
		LTTNG_UBUNTU_VERSION_CODE < \
		LTTNG_UBUNTU_KERNEL_VERSION(a_high, b_high, c_high, d_high))

/* Debian */

#define LTTNG_DEBIAN_KERNEL_VERSION(a, b, c, d, e) \
	(((LTTNG_KERNEL_VERSION(a, b, c)) * 10000ULL) + ((d) * 100) + (e))

#ifdef DEBIAN_API_VERSION
#define LTTNG_DEBIAN_VERSION_CODE \
	((LTTNG_LINUX_VERSION_CODE * 10000ULL) + DEBIAN_API_VERSION)
#else
#define LTTNG_DEBIAN_VERSION_CODE	0
#endif

#define LTTNG_DEBIAN_KERNEL_RANGE(a_low, b_low, c_low, d_low, e_low, \
		a_high, b_high, c_high, d_high, e_high) \
	(LTTNG_DEBIAN_VERSION_CODE >= \
		LTTNG_DEBIAN_KERNEL_VERSION(a_low, b_low, c_low, d_low, e_low) && \
		LTTNG_DEBIAN_VERSION_CODE < \
		LTTNG_DEBIAN_KERNEL_VERSION(a_high, b_high, c_high, d_high, e_high))

/* RHEL */

#define LTTNG_RHEL_KERNEL_VERSION(a, b, c, d, e, f) \
	(((LTTNG_KERNEL_VERSION(a, b, c)) * 100000000ULL) + ((d) * 10000) + ((e) * 100) + (f))

#ifdef RHEL_API_VERSION
#define LTTNG_RHEL_VERSION_CODE \
	((LTTNG_LINUX_VERSION_CODE * 100000000ULL) + RHEL_API_VERSION)
#else
#define LTTNG_RHEL_VERSION_CODE		0
#endif

#define LTTNG_RHEL_KERNEL_RANGE(a_low, b_low, c_low, d_low, e_low, f_low, \
		a_high, b_high, c_high, d_high, e_high, f_high) \
	(LTTNG_RHEL_VERSION_CODE >= \
		LTTNG_RHEL_KERNEL_VERSION(a_low, b_low, c_low, d_low, e_low, f_low) && \
		LTTNG_RHEL_VERSION_CODE < \
		LTTNG_RHEL_KERNEL_VERSION(a_high, b_high, c_high, d_high, e_high, f_high))

/* SUSE Linux enterprise */

/*
 * SLE major version codes may be large, eg. 150400, and require more than
 * 32 bits to store. Multiplying `a` by `1ULL` avoids compiler warnings, eg:
 *
 * `warning: result of ‘150400 << 16’ requires 35 bits to represent, but ‘int’ only has 32 bits`
 *
 */
#define LTTNG_SLE_VERSION(a, b, c) \
   ((((a * 1ULL) << 16) + (b << 8) + c) * 1ULL)

#if defined(SLE_API_VERSION_MAJOR) && defined(SLE_API_VERSION_MINOR) && defined(SLE_API_VERSION_PATCH)
#define LTTNG_SLE_VERSION_CODE \
	(LTTNG_SLE_VERSION(SLE_API_VERSION_MAJOR, SLE_API_VERSION_MINOR, SLE_API_VERSION_PATCH))
#else
#define LTTNG_SLE_VERSION_CODE	0
#endif

#define LTTNG_SLE_KERNEL_RANGE(a_low, b_low, c_low, d_low, e_low, f_low, \
		a_high, b_high, c_high, d_high, e_high, f_high) \
	( \
		LTTNG_SLE_VERSION_CODE != 0 && \
		( \
			/* Linux kernel version code exclusive inside range */ \
			(LTTNG_LINUX_VERSION_CODE > LTTNG_KERNEL_VERSION(a_low, b_low, c_low) && \
			LTTNG_LINUX_VERSION_CODE < LTTNG_KERNEL_VERSION(a_high, b_high, c_high)) || \
			\
			/* Linux kernel version code is at lower and upper limit */ \
			(LTTNG_LINUX_VERSION_CODE == LTTNG_KERNEL_VERSION(a_low, b_low, c_low) && \
			LTTNG_LINUX_VERSION_CODE == LTTNG_KERNEL_VERSION(a_high, b_high, c_high) && \
			LTTNG_SLE_VERSION_CODE >= LTTNG_SLE_VERSION(d_low, e_low, f_low) && \
			LTTNG_SLE_VERSION_CODE < LTTNG_SLE_VERSION(d_high, e_high, f_high)) || \
			\
			/* Linux kernel version code is at lower limit */ \
			(LTTNG_LINUX_VERSION_CODE == LTTNG_KERNEL_VERSION(a_low, b_low, c_low) && \
			LTTNG_KERNEL_VERSION(a_low, b_low, c_low) != LTTNG_KERNEL_VERSION(a_high, b_high, c_high) && \
			LTTNG_SLE_VERSION_CODE >= LTTNG_SLE_VERSION(d_low, e_low, f_low)) || \
			\
			/* Linux kernel version code is at upper limit */ \
			(LTTNG_LINUX_VERSION_CODE == LTTNG_KERNEL_VERSION(a_high, b_high, c_high) && \
			LTTNG_KERNEL_VERSION(a_low, b_low, c_low) != LTTNG_KERNEL_VERSION(a_high, b_high, c_high) && \
			LTTNG_SLE_VERSION_CODE < LTTNG_SLE_VERSION(d_high, e_high, f_high)) \
		))

/* Fedora */

#define LTTNG_FEDORA_KERNEL_VERSION(a, b, c, d) \
        (((LTTNG_KERNEL_VERSION(a, b, c)) * 10000ULL) + (d))

#ifdef FEDORA_REVISION_VERSION
#define LTTNG_FEDORA_VERSION_CODE \
        ((LTTNG_LINUX_VERSION_CODE * 10000ULL) + FEDORA_REVISION_VERSION)
#else
#define LTTNG_FEDORA_VERSION_CODE         0
#endif

#define LTTNG_FEDORA_KERNEL_RANGE(a_low, b_low, c_low, d_low, \
                a_high, b_high, c_high, d_high) \
        (LTTNG_FEDORA_VERSION_CODE >= \
                LTTNG_FEDORA_KERNEL_VERSION(a_low, b_low, c_low, d_low) && \
                LTTNG_FEDORA_VERSION_CODE < \
                LTTNG_FEDORA_KERNEL_VERSION(a_high, b_high, c_high, d_high))

/* RT patch */

#define LTTNG_RT_KERNEL_VERSION(a, b, c, d) \
	(((LTTNG_KERNEL_VERSION(a, b, c)) << 16) + (d))

#ifdef RT_PATCH_VERSION
#define LTTNG_RT_VERSION_CODE \
	((LTTNG_LINUX_VERSION_CODE << 16) + RT_PATCH_VERSION)
#else
#define LTTNG_RT_VERSION_CODE 	0
#endif

#define LTTNG_RT_KERNEL_RANGE(a_low, b_low, c_low, d_low, \
		a_high, b_high, c_high, d_high) \
	(LTTNG_RT_VERSION_CODE >= \
		LTTNG_RT_KERNEL_VERSION(a_low, b_low, c_low, d_low) && \
		LTTNG_RT_VERSION_CODE < \
		LTTNG_RT_KERNEL_VERSION(a_high, b_high, c_high, d_high))

#endif /* _LTTNG_KERNEL_VERSION_H */
Commit	Line	Data
b7cdc182	1	/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
9f36eaed	2	*
2df37e95	3	* lttng/kernel-version.h
5fa38800	4	*
7b25fa17	5	* Contains helpers to check kernel version conditions.
5fa38800 MD	6	*
5fa38800 MD	7	* Copyright (C) 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5fa38800 MD	8	*/
5fa38800 MD	9
9f36eaed MJ	10	#ifndef _LTTNG_KERNEL_VERSION_H
	11	#define _LTTNG_KERNEL_VERSION_H
	12
5fa38800	13	#include <linux/version.h>
db34449e	14	#include <linux/types.h>
9f61c55f	15	#include <generated/utsrelease.h>
5fa38800	16
7b25fa17 MJ	17	/*
	18	* The following defines are extracted from the toplevel Linux Makefile and
	19	* passed on the command line -with '-D'.
	20	*/
	21
	22	#ifndef LTTNG_LINUX_MAJOR
	23	#define LTTNG_LINUX_MAJOR 0
	24	#endif
	25
	26	#ifndef LTTNG_LINUX_MINOR
	27	#define LTTNG_LINUX_MINOR 0
	28	#endif
	29
	30	#ifndef LTTNG_LINUX_PATCH
	31	#define LTTNG_LINUX_PATCH 0
	32	#endif
	33
	34	/*
	35	* Some stable releases have overflowed the 8bits allocated to the sublevel in
	36	* the version code. To determine if the current kernel is affected, use the
	37	* sublevel version from the Makefile. This is currently true for the 4.4.256
	38	* and 4.9.256 stable releases.
	39	*
	40	* When the sublevel has overflowed, use the values from the Makefile instead
	41	* of LINUX_VERSION_CODE from the kernel headers and allocate 16bits.
	42	* Otherwise, keep using the version code from the headers to minimise the
	43	* behavior change and avoid regressions.
db34449e MJ	44	*
	45	* Cast the result to uint64_t to prevent overflowing when we append distro
	46	* specific version information.
7b25fa17 MJ	47	*/
	48	#if (LTTNG_LINUX_PATCH >= 256)
	49
	50	#define LTTNG_KERNEL_VERSION(a, b, c) \
db34449e	51	((((a) << 24) + ((b) << 16) + (c)) * 1ULL)
7b25fa17 MJ	52
	53	#define LTTNG_LINUX_VERSION_CODE \
	54	LTTNG_KERNEL_VERSION(LTTNG_LINUX_MAJOR, LTTNG_LINUX_MINOR, LTTNG_LINUX_PATCH)
	55
	56	#else
	57
db34449e MJ	58	#define LTTNG_KERNEL_VERSION(a, b, c) (KERNEL_VERSION(a, b, c) * 1ULL)
db34449e MJ	59	#define LTTNG_LINUX_VERSION_CODE (LINUX_VERSION_CODE * 1ULL)
7b25fa17 MJ	60
	61	#endif
	62
5fa38800 MD	63	/*
5fa38800 MD	64	* This macro checks if the kernel version is between the two specified
144bbfd5	65	* versions (lower limit inclusive, upper limit exclusive).
5fa38800 MD	66	*/
5fa38800 MD	67	#define LTTNG_KERNEL_RANGE(a_low, b_low, c_low, a_high, b_high, c_high) \
5f4c791e MJ	68	(LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(a_low, b_low, c_low) && \
5f4c791e MJ	69	LTTNG_LINUX_VERSION_CODE < LTTNG_KERNEL_VERSION(a_high, b_high, c_high))
5fa38800	70
c94ac1ac MJ	71	/* Ubuntu */
c94ac1ac MJ	72
3e5941df	73	#define LTTNG_UBUNTU_KERNEL_VERSION(a, b, c, d) \
af590311	74	(((LTTNG_KERNEL_VERSION(a, b, c)) << 16) + (d))
3e5941df	75
05732a66	76	#ifdef UTS_UBUNTU_RELEASE_ABI
3e5941df	77	#define LTTNG_UBUNTU_VERSION_CODE \
af590311	78	((LTTNG_LINUX_VERSION_CODE << 16) + UTS_UBUNTU_RELEASE_ABI)
05732a66 MD	79	#else
	80	#define LTTNG_UBUNTU_VERSION_CODE 0
	81	#endif
3e5941df JD	82
	83	#define LTTNG_UBUNTU_KERNEL_RANGE(a_low, b_low, c_low, d_low, \
	84	a_high, b_high, c_high, d_high) \
05732a66	85	(LTTNG_UBUNTU_VERSION_CODE >= \
3e5941df JD	86	LTTNG_UBUNTU_KERNEL_VERSION(a_low, b_low, c_low, d_low) && \
	87	LTTNG_UBUNTU_VERSION_CODE < \
	88	LTTNG_UBUNTU_KERNEL_VERSION(a_high, b_high, c_high, d_high))
	89
c94ac1ac MJ	90	/* Debian */
c94ac1ac MJ	91
1c56bda8 MJ	92	#define LTTNG_DEBIAN_KERNEL_VERSION(a, b, c, d, e) \
1c56bda8 MJ	93	(((LTTNG_KERNEL_VERSION(a, b, c)) * 10000ULL) + ((d) * 100) + (e))
72e6c528	94
05732a66	95	#ifdef DEBIAN_API_VERSION
72e6c528	96	#define LTTNG_DEBIAN_VERSION_CODE \
1c56bda8	97	((LTTNG_LINUX_VERSION_CODE * 10000ULL) + DEBIAN_API_VERSION)
05732a66 MD	98	#else
	99	#define LTTNG_DEBIAN_VERSION_CODE 0
	100	#endif
72e6c528	101
1c56bda8 MJ	102	#define LTTNG_DEBIAN_KERNEL_RANGE(a_low, b_low, c_low, d_low, e_low, \
1c56bda8 MJ	103	a_high, b_high, c_high, d_high, e_high) \
05732a66	104	(LTTNG_DEBIAN_VERSION_CODE >= \
1c56bda8	105	LTTNG_DEBIAN_KERNEL_VERSION(a_low, b_low, c_low, d_low, e_low) && \
72e6c528	106	LTTNG_DEBIAN_VERSION_CODE < \
1c56bda8	107	LTTNG_DEBIAN_KERNEL_VERSION(a_high, b_high, c_high, d_high, e_high))
72e6c528	108
c94ac1ac	109	/* RHEL */
f30ae671	110
5f4c791e	111	#define LTTNG_RHEL_KERNEL_VERSION(a, b, c, d, e, f) \
aec7897f	112	(((LTTNG_KERNEL_VERSION(a, b, c)) * 100000000ULL) + ((d) * 10000) + ((e) * 100) + (f))
5f4c791e	113
c94ac1ac	114	#ifdef RHEL_API_VERSION
f30ae671	115	#define LTTNG_RHEL_VERSION_CODE \
aec7897f	116	((LTTNG_LINUX_VERSION_CODE * 100000000ULL) + RHEL_API_VERSION)
f30ae671 MD	117	#else
	118	#define LTTNG_RHEL_VERSION_CODE 0
	119	#endif
	120
c94ac1ac MJ	121	#define LTTNG_RHEL_KERNEL_RANGE(a_low, b_low, c_low, d_low, e_low, f_low, \
c94ac1ac MJ	122	a_high, b_high, c_high, d_high, e_high, f_high) \
f30ae671	123	(LTTNG_RHEL_VERSION_CODE >= \
c94ac1ac	124	LTTNG_RHEL_KERNEL_VERSION(a_low, b_low, c_low, d_low, e_low, f_low) && \
f30ae671	125	LTTNG_RHEL_VERSION_CODE < \
c94ac1ac MJ	126	LTTNG_RHEL_KERNEL_VERSION(a_high, b_high, c_high, d_high, e_high, f_high))
c94ac1ac MJ	127
ce66b486 MJ	128	/* SUSE Linux enterprise */
ce66b486 MJ	129
5e45490c KS	130	/*
	131	* SLE major version codes may be large, eg. 150400, and require more than
	132	* 32 bits to store. Multiplying `a` by `1ULL` avoids compiler warnings, eg:
	133	*
	134	* `warning: result of ‘150400 << 16’ requires 35 bits to represent, but ‘int’ only has 32 bits`
	135	*
	136	*/
	137	#define LTTNG_SLE_VERSION(a, b, c) \
	138	((((a * 1ULL) << 16) + (b << 8) + c) * 1ULL)
ce66b486	139
5e45490c	140	#if defined(SLE_API_VERSION_MAJOR) && defined(SLE_API_VERSION_MINOR) && defined(SLE_API_VERSION_PATCH)
ce66b486	141	#define LTTNG_SLE_VERSION_CODE \
5e45490c	142	(LTTNG_SLE_VERSION(SLE_API_VERSION_MAJOR, SLE_API_VERSION_MINOR, SLE_API_VERSION_PATCH))
ce66b486	143	#else
5e45490c	144	#define LTTNG_SLE_VERSION_CODE 0
ce66b486 MJ	145	#endif
	146
	147	#define LTTNG_SLE_KERNEL_RANGE(a_low, b_low, c_low, d_low, e_low, f_low, \
	148	a_high, b_high, c_high, d_high, e_high, f_high) \
5e45490c KS	149	( \
	150	LTTNG_SLE_VERSION_CODE != 0 && \
	151	( \
	152	/* Linux kernel version code exclusive inside range */ \
	153	(LTTNG_LINUX_VERSION_CODE > LTTNG_KERNEL_VERSION(a_low, b_low, c_low) && \
	154	LTTNG_LINUX_VERSION_CODE < LTTNG_KERNEL_VERSION(a_high, b_high, c_high)) \|\| \
	155	\
	156	/* Linux kernel version code is at lower and upper limit */ \
	157	(LTTNG_LINUX_VERSION_CODE == LTTNG_KERNEL_VERSION(a_low, b_low, c_low) && \
	158	LTTNG_LINUX_VERSION_CODE == LTTNG_KERNEL_VERSION(a_high, b_high, c_high) && \
	159	LTTNG_SLE_VERSION_CODE >= LTTNG_SLE_VERSION(d_low, e_low, f_low) && \
	160	LTTNG_SLE_VERSION_CODE < LTTNG_SLE_VERSION(d_high, e_high, f_high)) \|\| \
	161	\
	162	/* Linux kernel version code is at lower limit */ \
	163	(LTTNG_LINUX_VERSION_CODE == LTTNG_KERNEL_VERSION(a_low, b_low, c_low) && \
	164	LTTNG_KERNEL_VERSION(a_low, b_low, c_low) != LTTNG_KERNEL_VERSION(a_high, b_high, c_high) && \
	165	LTTNG_SLE_VERSION_CODE >= LTTNG_SLE_VERSION(d_low, e_low, f_low)) \|\| \
	166	\
	167	/* Linux kernel version code is at upper limit */ \
	168	(LTTNG_LINUX_VERSION_CODE == LTTNG_KERNEL_VERSION(a_high, b_high, c_high) && \
	169	LTTNG_KERNEL_VERSION(a_low, b_low, c_low) != LTTNG_KERNEL_VERSION(a_high, b_high, c_high) && \
	170	LTTNG_SLE_VERSION_CODE < LTTNG_SLE_VERSION(d_high, e_high, f_high)) \
	171	))
ce66b486	172
e4838da1 LG	173	/* Fedora */
	174
	175	#define LTTNG_FEDORA_KERNEL_VERSION(a, b, c, d) \
5f4c791e	176	(((LTTNG_KERNEL_VERSION(a, b, c)) * 10000ULL) + (d))
e4838da1 LG	177
	178	#ifdef FEDORA_REVISION_VERSION
	179	#define LTTNG_FEDORA_VERSION_CODE \
5f4c791e	180	((LTTNG_LINUX_VERSION_CODE * 10000ULL) + FEDORA_REVISION_VERSION)
e4838da1 LG	181	#else
	182	#define LTTNG_FEDORA_VERSION_CODE 0
	183	#endif
	184
	185	#define LTTNG_FEDORA_KERNEL_RANGE(a_low, b_low, c_low, d_low, \
	186	a_high, b_high, c_high, d_high) \
	187	(LTTNG_FEDORA_VERSION_CODE >= \
	188	LTTNG_FEDORA_KERNEL_VERSION(a_low, b_low, c_low, d_low) && \
	189	LTTNG_FEDORA_VERSION_CODE < \
	190	LTTNG_FEDORA_KERNEL_VERSION(a_high, b_high, c_high, d_high))
	191
c94ac1ac	192	/* RT patch */
f30ae671	193
b4c8e4d3	194	#define LTTNG_RT_KERNEL_VERSION(a, b, c, d) \
b737968d	195	(((LTTNG_KERNEL_VERSION(a, b, c)) << 16) + (d))
b4c8e4d3 MJ	196
	197	#ifdef RT_PATCH_VERSION
	198	#define LTTNG_RT_VERSION_CODE \
b737968d	199	((LTTNG_LINUX_VERSION_CODE << 16) + RT_PATCH_VERSION)
b4c8e4d3 MJ	200	#else
	201	#define LTTNG_RT_VERSION_CODE 0
	202	#endif
	203
	204	#define LTTNG_RT_KERNEL_RANGE(a_low, b_low, c_low, d_low, \
	205	a_high, b_high, c_high, d_high) \
	206	(LTTNG_RT_VERSION_CODE >= \
	207	LTTNG_RT_KERNEL_VERSION(a_low, b_low, c_low, d_low) && \
	208	LTTNG_RT_VERSION_CODE < \
	209	LTTNG_RT_KERNEL_VERSION(a_high, b_high, c_high, d_high))
	210
5fa38800	211	#endif /* _LTTNG_KERNEL_VERSION_H */