From e25261a90222de75781726a93ab809c660208afd Mon Sep 17 00:00:00 2001
From: Tavian Barnes <tavianator@tavianator.com>
Date: Thu, 9 Nov 2023 15:16:04 -0500
Subject: config: Add (de)allocator attributes

---
 src/config.h | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

(limited to 'src/config.h')

diff --git a/src/config.h b/src/config.h
index b95abaa..db62ef8 100644
--- a/src/config.h
+++ b/src/config.h
@@ -184,6 +184,17 @@
 #  define fallthru ((void)0)
 #endif
 
+/**
+ * Warn if a value is unused.
+ */
+#if __has_c_attribute(nodiscard)
+#  define attr_nodiscard [[nodiscard]]
+#elif __has_attribute(nodiscard)
+#  define attr_nodiscard __attribute__((nodiscard))
+#else
+#  define attr_nodiscard
+#endif
+
 /**
  * Hint to avoid inlining a function.
  */
@@ -211,6 +222,44 @@
 #  define attr_format(fmt, args)
 #endif
 
+/**
+ * Annotates allocator-like functions.
+ */
+#if __has_attribute(malloc)
+#  if __clang__
+#    define attr_malloc(...) attr_nodiscard __attribute__((malloc))
+#  else
+#    define attr_malloc(...) attr_nodiscard __attribute__((malloc(__VA_ARGS__)))
+#  endif
+#else
+#  define attr_malloc(...) attr_nodiscard
+#endif
+
+/**
+ * Specifies that a function returns allocations with a given alignment.
+ */
+#if __has_attribute(alloc_align)
+#  define attr_alloc_align(param) __attribute__((alloc_align(param)))
+#else
+#  define attr_alloc_align(param)
+#endif
+
+/**
+ * Specifies that a function returns allocations with a given size.
+ */
+#if __has_attribute(alloc_size)
+#  define attr_alloc_size(...) __attribute__((alloc_size(__VA_ARGS__)))
+#else
+#  define attr_alloc_size(...)
+#endif
+
+/**
+ * Shorthand for attr_alloc_align() and attr_alloc_size().
+ */
+#define attr_aligned_alloc(align, ...) \
+	attr_alloc_align(align) \
+	attr_alloc_size(__VA_ARGS__)
+
 /**
  * Check if function multiversioning via GNU indirect functions (ifunc) is supported.
  */
-- 
cgit v1.2.3