compat: add experimental tag macro
authorNeil Horman <nhorman@tuxdriver.com>
Mon, 22 Jan 2018 01:48:04 +0000 (20:48 -0500)
committerThomas Monjalon <thomas@monjalon.net>
Mon, 29 Jan 2018 21:44:01 +0000 (22:44 +0100)
The __rte_experimental macro tags a given exported function as being part of
the EXPERIMENTAL api.  Use of this tag will cause any caller of the
function (that isn't removed by dead code elimination) to emit a warning
that the user is making use of an API whos stabilty isn't guaranteed.
It also places the function in the .text.experimental section, which is
used to validate the tag against the corresponding library version map

Signed-off-by: Neil Horman <nhorman@tuxdriver.com>
lib/librte_compat/rte_compat.h

index 41e8032..d6e79f3 100644 (file)
  */
 #endif
 
+#ifndef ALLOW_EXPERIMENTAL_API
+
+#define __rte_experimental \
+__attribute__((deprecated("Symbol is not yet part of stable ABI"), \
+section(".text.experimental")))
+
+#else
+
+#define __rte_experimental \
+__attribute__((section(".text.experimental")))
+
+#endif
 
 #endif /* _RTE_COMPAT_H_ */