include/lttng/kernel-version.h

   1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
   2  *
   3  * lttng/kernel-version.h
   4  *
   5  * Contains helpers to check kernel version conditions.
   6  *
   7  * Copyright (C) 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   8  */
   9
  10 #ifndef _LTTNG_KERNEL_VERSION_H
  11 #define _LTTNG_KERNEL_VERSION_H
  12
  13 #include <linux/version.h>
  14 #include <linux/types.h>
  15 #include <generated/utsrelease.h>
  16
  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.
  44  *
  45  * Cast the result to uint64_t to prevent overflowing when we append distro
  46  * specific version information.
  47  */
  48 #if (LTTNG_LINUX_PATCH >= 256)
  49
  50 #define LTTNG_KERNEL_VERSION(a, b, c) \
  51         ((((a) << 24) + ((b) << 16) + (c)) * 1ULL)
  52
  53 #define LTTNG_LINUX_VERSION_CODE \
  54         LTTNG_KERNEL_VERSION(LTTNG_LINUX_MAJOR, LTTNG_LINUX_MINOR, LTTNG_LINUX_PATCH)
  55
  56 #else
  57
  58 #define LTTNG_KERNEL_VERSION(a, b, c) (KERNEL_VERSION(a, b, c) * 1ULL)
  59 #define LTTNG_LINUX_VERSION_CODE (LINUX_VERSION_CODE * 1ULL)
  60
  61 #endif
  62
  63 /*
  64  * This macro checks if the kernel version is between the two specified
  65  * versions (lower limit inclusive, upper limit exclusive).
  66  */
  67 #define LTTNG_KERNEL_RANGE(a_low, b_low, c_low, a_high, b_high, c_high) \
  68         (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(a_low, b_low, c_low) && \
  69          LTTNG_LINUX_VERSION_CODE < LTTNG_KERNEL_VERSION(a_high, b_high, c_high))
  70
  71 /* Ubuntu */
  72
  73 #define LTTNG_UBUNTU_KERNEL_VERSION(a, b, c, d) \
  74         (((LTTNG_KERNEL_VERSION(a, b, c)) << 16) + (d))
  75
  76 #ifdef UTS_UBUNTU_RELEASE_ABI
  77 #define LTTNG_UBUNTU_VERSION_CODE \
  78         ((LTTNG_LINUX_VERSION_CODE << 16) + UTS_UBUNTU_RELEASE_ABI)
  79 #else
  80 #define LTTNG_UBUNTU_VERSION_CODE       0
  81 #endif
  82
  83 #define LTTNG_UBUNTU_KERNEL_RANGE(a_low, b_low, c_low, d_low, \
  84                 a_high, b_high, c_high, d_high) \
  85         (LTTNG_UBUNTU_VERSION_CODE >= \
  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
  90 /* Debian */
  91
  92 #define LTTNG_DEBIAN_KERNEL_VERSION(a, b, c, d, e) \
  93         (((LTTNG_KERNEL_VERSION(a, b, c)) * 10000ULL) + ((d) * 100) + (e))
  94
  95 #ifdef DEBIAN_API_VERSION
  96 #define LTTNG_DEBIAN_VERSION_CODE \
  97         ((LTTNG_LINUX_VERSION_CODE * 10000ULL) + DEBIAN_API_VERSION)
  98 #else
  99 #define LTTNG_DEBIAN_VERSION_CODE       0
 100 #endif
 101
 102 #define LTTNG_DEBIAN_KERNEL_RANGE(a_low, b_low, c_low, d_low, e_low, \
 103                 a_high, b_high, c_high, d_high, e_high) \
 104         (LTTNG_DEBIAN_VERSION_CODE >= \
 105                 LTTNG_DEBIAN_KERNEL_VERSION(a_low, b_low, c_low, d_low, e_low) && \
 106                 LTTNG_DEBIAN_VERSION_CODE < \
 107                 LTTNG_DEBIAN_KERNEL_VERSION(a_high, b_high, c_high, d_high, e_high))
 108
 109 /* RHEL */
 110
 111 #define LTTNG_RHEL_KERNEL_VERSION(a, b, c, d, e, f) \
 112         (((LTTNG_KERNEL_VERSION(a, b, c)) * 100000000ULL) + ((d) * 10000) + ((e) * 100) + (f))
 113
 114 #ifdef RHEL_API_VERSION
 115 #define LTTNG_RHEL_VERSION_CODE \
 116         ((LTTNG_LINUX_VERSION_CODE * 100000000ULL) + RHEL_API_VERSION)
 117 #else
 118 #define LTTNG_RHEL_VERSION_CODE         0
 119 #endif
 120
 121 #define LTTNG_RHEL_KERNEL_RANGE(a_low, b_low, c_low, d_low, e_low, f_low, \
 122                 a_high, b_high, c_high, d_high, e_high, f_high) \
 123         (LTTNG_RHEL_VERSION_CODE >= \
 124                 LTTNG_RHEL_KERNEL_VERSION(a_low, b_low, c_low, d_low, e_low, f_low) && \
 125                 LTTNG_RHEL_VERSION_CODE < \
 126                 LTTNG_RHEL_KERNEL_VERSION(a_high, b_high, c_high, d_high, e_high, f_high))
 127
 128 /* SUSE Linux enterprise */
 129
 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)
 139
 140 #if defined(SLE_API_VERSION_MAJOR) && defined(SLE_API_VERSION_MINOR) && defined(SLE_API_VERSION_PATCH)
 141 #define LTTNG_SLE_VERSION_CODE \
 142         (LTTNG_SLE_VERSION(SLE_API_VERSION_MAJOR, SLE_API_VERSION_MINOR, SLE_API_VERSION_PATCH))
 143 #else
 144 #define LTTNG_SLE_VERSION_CODE  0
 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) \
 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                 ))
 172
 173 /* Fedora */
 174
 175 #define LTTNG_FEDORA_KERNEL_VERSION(a, b, c, d) \
 176         (((LTTNG_KERNEL_VERSION(a, b, c)) * 10000ULL) + (d))
 177
 178 #ifdef FEDORA_REVISION_VERSION
 179 #define LTTNG_FEDORA_VERSION_CODE \
 180         ((LTTNG_LINUX_VERSION_CODE * 10000ULL) + FEDORA_REVISION_VERSION)
 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
 192 /* RT patch */
 193
 194 #define LTTNG_RT_KERNEL_VERSION(a, b, c, d) \
 195         (((LTTNG_KERNEL_VERSION(a, b, c)) << 16) + (d))
 196
 197 #ifdef RT_PATCH_VERSION
 198 #define LTTNG_RT_VERSION_CODE \
 199         ((LTTNG_LINUX_VERSION_CODE << 16) + RT_PATCH_VERSION)
 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
 211 #endif /* _LTTNG_KERNEL_VERSION_H */