assert-pre-internal.h: add BT_ASSERT_PRE_VALID_INDEX()

[babeltrace.git] / include / babeltrace / assert-pre-internal.h

diff --git a/include/babeltrace/assert-pre-internal.h b/include/babeltrace/assert-pre-internal.h
index 38f93a2e959c133503120ab97ca4ae243e514b72..e56d90ecc387b6e75854a357f5f095df42166d3c 100644 (file)
--- a/include/babeltrace/assert-pre-internal.h
+++ b/include/babeltrace/assert-pre-internal.h
@@ -117,4 +117,12 @@
        BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name,  \
                ##__VA_ARGS__)
 
+/*
+ * Developer mode: asserts that a given index is less than a given size.
+ */
+#define BT_ASSERT_PRE_VALID_INDEX(_index, _length)                     \
+       BT_ASSERT_PRE((_index) < (_length),                             \
+               "Index is out of bounds: index=%" PRIu64 ", "           \
+               "count=%" PRIu64, (uint64_t) (_index), (uint64_t) (_length))
+
 #endif /* BABELTRACE_ASSERT_PRE_INTERNAL_H */