Some iso8601 renames/deprecations

cts/cli/regression.dates.exp

@@ -29,32 +29,32 @@ iso8601: Invalid interval specified: 20191077T15/P1M
 =#=#=#= End test: Invalid period - [20191077T15/P1M] - Invalid parameter (2) =#=#=#=
 * Passed: iso8601               - Invalid period - [20191077T15/P1M]
 =#=#=#= Begin test: Invalid period - [2019-10-01T25:00:00Z/P1M] =#=#=#=
-crm_time_parse_sec 	error: 25:00:00Z/P1M is not a valid ISO 8601 time specification because 25 is not a valid hour
+parse_hms 	error: 25:00:00Z/P1M is not a valid ISO 8601 time specification because 25 is not a valid hour
 iso8601: Invalid interval specified: 2019-10-01T25:00:00Z/P1M
 =#=#=#= End test: Invalid period - [2019-10-01T25:00:00Z/P1M] - Invalid parameter (2) =#=#=#=
 * Passed: iso8601               - Invalid period - [2019-10-01T25:00:00Z/P1M]
 =#=#=#= Begin test: Invalid period - [2019-10-01T24:00:01Z/P1M] =#=#=#=
-crm_time_parse_sec 	error: 24:00:01Z/P1M is not a valid ISO 8601 time specification because 24 is not a valid hour
+parse_hms 	error: 24:00:01Z/P1M is not a valid ISO 8601 time specification because 24 is not a valid hour
 iso8601: Invalid interval specified: 2019-10-01T24:00:01Z/P1M
 =#=#=#= End test: Invalid period - [2019-10-01T24:00:01Z/P1M] - Invalid parameter (2) =#=#=#=
 * Passed: iso8601               - Invalid period - [2019-10-01T24:00:01Z/P1M]
 =#=#=#= Begin test: Invalid period - [PT5H/20191001T007000Z] =#=#=#=
-crm_time_parse_sec 	error: 007000Z is not a valid ISO 8601 time specification because 70 is not a valid minute
+parse_hms 	error: 007000Z is not a valid ISO 8601 time specification because 70 is not a valid minute
 iso8601: Invalid interval specified: PT5H/20191001T007000Z
 =#=#=#= End test: Invalid period - [PT5H/20191001T007000Z] - Invalid parameter (2) =#=#=#=
 * Passed: iso8601               - Invalid period - [PT5H/20191001T007000Z]
 =#=#=#= Begin test: Invalid period - [2019-10-01 00:00:80Z/P1M] =#=#=#=
-crm_time_parse_sec 	error: 00:00:80Z/P1M is not a valid ISO 8601 time specification because 80 is not a valid second
+parse_hms 	error: 00:00:80Z/P1M is not a valid ISO 8601 time specification because 80 is not a valid second
 iso8601: Invalid interval specified: 2019-10-01 00:00:80Z/P1M
 =#=#=#= End test: Invalid period - [2019-10-01 00:00:80Z/P1M] - Invalid parameter (2) =#=#=#=
 * Passed: iso8601               - Invalid period - [2019-10-01 00:00:80Z/P1M]
 =#=#=#= Begin test: Invalid period - [2019-10-01 00:00:10 +25:00/P1M] =#=#=#=
-crm_time_parse_sec 	error: 25:00/P1M is not a valid ISO 8601 time specification because 25 is not a valid hour
+parse_hms 	error: 25:00/P1M is not a valid ISO 8601 time specification because 25 is not a valid hour
 iso8601: Invalid interval specified: 2019-10-01 00:00:10 +25:00/P1M
 =#=#=#= End test: Invalid period - [2019-10-01 00:00:10 +25:00/P1M] - Invalid parameter (2) =#=#=#=
 * Passed: iso8601               - Invalid period - [2019-10-01 00:00:10 +25:00/P1M]
 =#=#=#= Begin test: Invalid period - [20191001T000010 -00:61/P1M] =#=#=#=
-crm_time_parse_sec 	error: 00:61/P1M is not a valid ISO 8601 time specification because 61 is not a valid minute
+parse_hms 	error: 00:61/P1M is not a valid ISO 8601 time specification because 61 is not a valid minute
 iso8601: Invalid interval specified: 20191001T000010 -00:61/P1M
 =#=#=#= End test: Invalid period - [20191001T000010 -00:61/P1M] - Invalid parameter (2) =#=#=#=
 * Passed: iso8601               - Invalid period - [20191001T000010 -00:61/P1M]

cts/cts-cli.in

@@ -253,7 +253,7 @@ def sanitize_output(s):
         (r'@crm_feature_set=[0-9.]+, ', r''),
         (r'\(crm_time_parse_duration@.*\.c:[0-9]+\)', r'crm_time_parse_duration'),
         (r'\(crm_time_parse_period@.*\.c:[0-9]+\)', r'crm_time_parse_period'),
-        (r'\(crm_time_parse_sec@.*\.c:[0-9]+\)', r'crm_time_parse_sec'),
+        (r'\(parse_hms@.*\.c:[0-9]+\)', r'parse_hms'),
         (re.escape(cts_cli_data), r'CTS_CLI_DATA'),
         (r' default="[^"]*"', r' default=""'),
         (r' end="[0-9][-+: 0-9]*Z*"', r' end=""'),

include/crm/common/Makefile.am

@@ -23,6 +23,7 @@ header_HEADERS = acl.h 			\
 		 ipc_pacemakerd.h 	\
 		 ipc_schedulerd.h 	\
 		 iso8601.h 		\
+		 iso8601_compat.h 	\
 		 logging.h 		\
 		 logging_compat.h 	\
 		 mainloop.h 		\

include/crm/common/acl.h

@@ -30,12 +30,12 @@ bool xml_acl_filtered_copy(const char *user, xmlNode* acl_source, xmlNode *xml,
 
 bool pcmk_acl_required(const char *user);
 
-#if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
-#include <crm/common/acl_compat.h>
-#endif  // !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
-
 #ifdef __cplusplus
 }
 #endif
 
+#if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
+#include <crm/common/acl_compat.h>
+#endif  // !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
+
 #endif // PCMK__CRM_COMMON_ACL__H

include/crm/common/iso8601.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2005-2024 the Pacemaker project contributors
+ * Copyright 2005-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -29,6 +29,12 @@ extern "C" {
  * See https://en.wikipedia.org/wiki/ISO_8601
  */
 
+/*!
+ * \brief An opaque date and time object
+ *
+ * \note Negative years are treated inconsistently and should not be relied
+ *       upon.
+ */
 typedef struct crm_time_s crm_time_t;
 
 typedef struct crm_time_period_s {
@@ -57,13 +63,6 @@ void crm_time_free(crm_time_t * dt);
 bool crm_time_is_defined(const crm_time_t *t);
 char *crm_time_as_string(const crm_time_t *dt, int flags);
 
-#define crm_time_log(level, prefix, dt, flags)  \
-    crm_time_log_alias(level, __FILE__, __func__, __LINE__, prefix, dt, flags)
-
-void crm_time_log_alias(int log_level, const char *file, const char *function,
-                        int line, const char *prefix,
-                        const crm_time_t *date_time, int flags);
-
 #define crm_time_log_date          0x001
 #define crm_time_log_timeofday     0x002
 #define crm_time_log_with_timezone 0x004
@@ -85,22 +84,16 @@ int crm_time_compare(const crm_time_t *a, const crm_time_t *b);
 
 int crm_time_get_timeofday(const crm_time_t *dt, uint32_t *h, uint32_t *m,
                            uint32_t *s);
-int crm_time_get_timezone(const crm_time_t *dt, uint32_t *h, uint32_t *m);
 int crm_time_get_gregorian(const crm_time_t *dt, uint32_t *y, uint32_t *m,
                            uint32_t *d);
 int crm_time_get_ordinal(const crm_time_t *dt, uint32_t *y, uint32_t *d);
-int crm_time_get_isoweek(const crm_time_t *dt, uint32_t *y, uint32_t *w,
-                         uint32_t * d);
 
 /* Time in seconds since 0000-01-01 00:00:00Z */
 long long crm_time_get_seconds(const crm_time_t *dt);
 
 /* Time in seconds since 1970-01-01 00:00:00Z */
 long long crm_time_get_seconds_since_epoch(const crm_time_t *dt);
 
-void crm_time_set(crm_time_t *target, const crm_time_t *source);
-void crm_time_set_timet(crm_time_t *target, const time_t *source);
-
 /* Returns a new time object */
 crm_time_t *pcmk_copy_time(const crm_time_t *source);
 crm_time_t *crm_time_add(const crm_time_t *dt, const crm_time_t *value);
@@ -115,16 +108,12 @@ void crm_time_add_weeks(crm_time_t * dt, int value);
 void crm_time_add_months(crm_time_t * dt, int value);
 void crm_time_add_years(crm_time_t * dt, int value);
 
-/* Useful helper functions */
-int crm_time_january1_weekday(int year);
-int crm_time_weeks_in_year(int year);
-int crm_time_days_in_month(int month, int year);
-
-bool crm_time_leapyear(int year);
-bool crm_time_check(const crm_time_t *dt);
-
 #ifdef __cplusplus
 }
 #endif
 
+#if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
+#include <crm/common/iso8601_compat.h>
+#endif
+
 #endif

include/crm/common/iso8601_compat.h

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2004-2025 the Pacemaker project contributors
+ *
+ * The version control history for this file may have further details.
+ *
+ * This source code is licensed under the GNU Lesser General Public License
+ * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
+ */
+
+#ifndef PCMK__CRM_COMMON_ISO8601_COMPAT__H
+#define PCMK__CRM_COMMON_ISO8601_COMPAT__H
+
+#include <stdbool.h>
+#include <stdint.h>             // uint32_t
+#include <time.h>               // time_t
+
+#include <crm/common/iso8601.h> // crm_time_t
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * \file
+ * \brief Deprecated Pacemaker time API
+ * \ingroup core
+ * \deprecated Do not include this header directly. The time APIs in this
+ *             header, and the header itself, will be removed in a future
+ *             release.
+ */
+
+//! \deprecated Do not use
+bool crm_time_leapyear(int year);
+
+//! \deprecated Do not use
+int crm_time_days_in_month(int month, int year);
+
+//! \deprecated Do not use
+int crm_time_get_timezone(const crm_time_t *dt, uint32_t *h, uint32_t *m);
+
+//! \deprecated Do not use
+int crm_time_weeks_in_year(int year);
+
+//! \deprecated Do not use
+int crm_time_january1_weekday(int year);
+
+//! \deprecated Do not use
+void crm_time_set(crm_time_t *target, const crm_time_t *source);
+
+//! \deprecated Do not use
+bool crm_time_check(const crm_time_t *dt);
+
+//! \deprecated Do not use
+void crm_time_set_timet(crm_time_t *target, const time_t *source_sec);
+
+//! \deprecated Do not use
+int crm_time_get_isoweek(const crm_time_t *dt, uint32_t *y, uint32_t *w,
+                         uint32_t *d);
+
+//! \deprecated Do not use
+#define crm_time_log(level, prefix, dt, flags)  \
+    crm_time_log_alias(level, __FILE__, __func__, __LINE__, prefix, dt, flags)
+
+//! \deprecated Do not use
+void crm_time_log_alias(int log_level, const char *file, const char *function,
+                        int line, const char *prefix,
+                        const crm_time_t *date_time, int flags);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // PCMK__CRM_COMMON_ISO8601_COMPAT__H

include/crm/common/iso8601_internal.h

@@ -10,21 +10,32 @@
 #ifndef PCMK__CRM_COMMON_ISO8601_INTERNAL__H
 #define PCMK__CRM_COMMON_ISO8601_INTERNAL__H
 
-#include <glib.h>
-#include <time.h>
-#include <sys/time.h>
 #include <ctype.h>
+#include <stdint.h>             // uint8_t, uint32_t
+#include <sys/time.h>
+#include <time.h>
+
+#include <glib.h>
 #include <crm/common/iso8601.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+void pcmk__time_get_ywd(const crm_time_t *dt, uint32_t *y, uint32_t *w,
+                        uint32_t *d);
 char *pcmk__time_format_hr(const char *format, const crm_time_t *dt, int usec);
 char *pcmk__epoch2str(const time_t *source, uint32_t flags);
 char *pcmk__timespec2str(const struct timespec *ts, uint32_t flags);
 const char *pcmk__readable_interval(guint interval_ms);
-crm_time_t *pcmk__copy_timet(time_t source);
+crm_time_t *pcmk__copy_timet(time_t source_sec);
+
+void pcmk__time_log_as(const char *file, const char *function, int line,
+                       uint8_t level, const char *prefix, const crm_time_t *dt,
+                       uint32_t flags);
+
+#define pcmk__time_log(level, prefix, dt, flags)    \
+    pcmk__time_log_as(__FILE__, __func__, __LINE__, level, prefix, dt, flags);
 
 // A date/time or duration
 struct crm_time_s {

include/crm/common/strings.h

@@ -24,12 +24,12 @@ extern "C" {
 
 int pcmk_parse_interval_spec(const char *input, guint *result_ms);
 
-#if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
-#include <crm/common/strings_compat.h>
-#endif
-
 #ifdef __cplusplus
 }
 #endif
 
+#if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
+#include <crm/common/strings_compat.h>
+#endif
+
 #endif // PCMK__CRM_COMMON_STRINGS__H

include/crm/common/xml_io.h

@@ -20,12 +20,12 @@ extern "C" {
  * \ingroup core
  */
 
-#if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
-#include <crm/common/xml_io_compat.h>
-#endif
-
 #ifdef __cplusplus
 }
 #endif
 
+#if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
+#include <crm/common/xml_io_compat.h>
+#endif
+
 #endif  // PCMK__CRM_COMMON_XML_IO__H

lib/common/fuzzers/iso8601_fuzzer.c

@@ -24,7 +24,7 @@ LLVMFuzzerTestOneInput(const uint8_t *data, size_t size)
     crm_time_period_t *period = NULL;
 
     struct timespec tv = { 0, };
-    crm_time_t now = { 0, };
+    crm_time_t *now = NULL;
     char *result = NULL;
 
     // Ensure we have enough data.
@@ -38,9 +38,10 @@ LLVMFuzzerTestOneInput(const uint8_t *data, size_t size)
     crm_time_free_period(period);
 
     qb_util_timespec_from_epoch_get(&tv);
-    crm_time_set_timet(&now, &(tv.tv_sec));
-    result = pcmk__time_format_hr(ns, &now,
+    now = pcmk__copy_timet(tv.tv_sec);
+    result = pcmk__time_format_hr(ns, now,
                                   (int) (tv.tv_nsec / QB_TIME_NS_IN_USEC));
+    crm_time_free(now);
     free(result);
 
     free(ns);