tests: time_units: check for overflow in z_tmcvt intermediate

Prior to #41602, due to the ordering of operations (first mul,
then div), an intermediate value would overflow, resulting in
a time non-linearity.

This test ensures that time rolls-over properly.

Signed-off-by: Chris Friedt <[email protected]>
(cherry picked from commit 74c9c0e)

Author: Chris Friedt

tests/unit/time_units/CMakeLists.txt

@@ -0,0 +1,6 @@
+# Copyright 2022 Meta
+# SPDX-License-Identifier: Apache-2.0
+
+project(time_units)
+set(SOURCES main.c overflow.c)
+find_package(ZephyrUnittest REQUIRED HINTS $ENV{ZEPHYR_BASE})

tests/unit/time_units/main.c

@@ -0,0 +1,15 @@
+/*
+ * Copyright 2022 Meta
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <ztest.h>
+
+extern void test_z_tmcvt_for_overflow(void);
+
+void test_main(void)
+{
+	ztest_test_suite(test_time_units, ztest_unit_test(test_z_tmcvt_for_overflow));
+	ztest_run_test_suite(test_time_units);
+}

tests/unit/time_units/overflow.c

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2022 Meta
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <inttypes.h>
+#include <limits.h>
+#include <stdbool.h>
+#include <stdint.h>
+
+#include <ztest.h>
+#include <sys/time_units.h>
+
+/**
+ * @brief Test @ref z_tmcvt for robustness against intermediate value overflow.
+ *
+ * With input
+ * ```
+ * [t0, t1, t2] = [
+ *   UINT64_MAX / to_hz - 1,
+ *   UINT64_MAX / to_hz,
+ *   UINT64_MAX / to_hz + 1,
+ * ]
+ * ```
+ *
+ * passed through @ref z_tmcvt, we expect a linear sequence:
+ * ```
+ * [
+ *   562949953369140,
+ *   562949953399658,
+ *   562949953430175,
+ * ]
+ * ```
+ *
+ * If an overflow occurs, we see something like the following:
+ * ```
+ * [
+ *   562949953369140,
+ *   562949953399658,
+ *   8863,
+ * ]
+ * ```
+ */
+void test_z_tmcvt_for_overflow(void)
+{
+	const uint32_t from_hz = 32768UL;
+	const uint32_t to_hz = 1000000000UL;
+
+	zassert_equal(562949953369140ULL,
+		      z_tmcvt(UINT64_MAX / to_hz - 1, from_hz, to_hz, true, false, false, false),
+			  NULL);
+	zassert_equal(562949953399658ULL,
+		      z_tmcvt(UINT64_MAX / to_hz, from_hz, to_hz, true, false, false, false),
+			  NULL);
+	zassert_equal(562949953430175ULL,
+		      z_tmcvt(UINT64_MAX / to_hz + 1, from_hz, to_hz, true, false, false, false),
+			  NULL);
+}

tests/unit/time_units/prj.conf

@@ -0,0 +1 @@
+CONFIG_ZTEST=y

tests/unit/time_units/testcase.yaml

@@ -0,0 +1,5 @@
+common:
+  tags: time_units
+  type: unit
+tests:
+  utilities.time_units.z_tmcvt: {}