include/lttng/ust-api-compat.h

   1 // SPDX-FileCopyrightText: 2021 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   2 //
   3 // SPDX-License-Identifier: MIT
   4
   5 /*
   6  * LTTng-UST API compatibility header
   7  */
   8
   9 #ifndef _LTTNG_UST_API_COMPAT_H
  10 #define _LTTNG_UST_API_COMPAT_H
  11
  12 /*
  13  * The compat API version controls backward API compatibility at the
  14  * source-code level.
  15  *
  16  * In order to disable compatibility API for a range of API versions, define
  17  * LTTNG_UST_COMPAT_API_VERSION to the oldest API version for which to provide
  18  * compatibility.
  19  *
  20  * If LTTNG_UST_COMPAT_API_VERSION is undefined, API compatibility for
  21  * all API versions is provided.
  22  * If LTTNG_UST_COMPAT_API_VERSION is defined to N, API compatibility
  23  * for versions N or higher is provided, thus not defining compatibility macros
  24  * for versions lower than N.
  25  */
  26
  27 #ifndef LTTNG_UST_COMPAT_API_VERSION
  28 #define LTTNG_UST_COMPAT_API_VERSION 0
  29 #endif
  30
  31 #define LTTNG_UST_COMPAT_API(major)     \
  32         (LTTNG_UST_COMPAT_API_VERSION <= (major))
  33
  34 #endif /* _LTTNG_UST_API_COMPAT_H */