build: Define DBUS_INT64_MODIFIER, analogous to G_GINT64_MODIFIER

Using PRId64, etc. to print dbus_int64_t or dbus_uint64_t is not 100%
portable. On platforms where both long and long long are 64-bit (such as
Linux and macOS), we will prefer to define dbus_int64_t as long.
If the operating system has chosen to define int64_t as long long,
which is apparently the case on macOS, then the compiler can warn that
we are passing a long argument to PRId64, which is "lld" and therefore
expects a long long argument (even though that ends up with the same
bit-pattern being used).

We can't necessarily just use int64_t and uint64_t directly, even if all
our supported platforms have them available now, because swapping
dbus_int64_t between long and long long might change C++ name mangling,
causing ABI breaks in third-party libraries if they define C++ functions
that take a dbus_int64_t argument.

Signed-off-by: Simon McVittie <smcv@collabora.com>

diff --git a/bus/containers.c b/bus/containers.c
index 8abeca1f40d54ad300ab9acf3cb2882cf5878dd1..1a95a4a59d07cdd1c5be586e32b7e2c7b7afbd50 100644 (file)
--- a/bus/containers.c
+++ b/bus/containers.c
@@ -414,10 +414,8 @@ bus_container_instance_new (BusContext *context,
       goto fail;
     }
 
-  /* We assume PRIu64 exists on all Unix platforms: it's ISO C99, and the
-   * only non-C99 platform we support is MSVC on Windows. */
   if (!_dbus_string_append_printf (&path,
-                                   "/org/freedesktop/DBus/Containers1/c%" PRIu64,
+                                   "/org/freedesktop/DBus/Containers1/c%" DBUS_INT64_MODIFIER "u",
                                    containers->next_container_id++))
     {
       BUS_SET_OOM (error);

diff --git a/cmake/ConfigureChecks.cmake b/cmake/ConfigureChecks.cmake
index 45136cc33bbc1dc43260765354a1f09d89bfdbd8..98f27db7179d255feed0df576f99f73019052960 100644 (file)
--- a/cmake/ConfigureChecks.cmake
+++ b/cmake/ConfigureChecks.cmake
@@ -181,22 +181,31 @@ if(SIZEOF_INT EQUAL 8)
     set(DBUS_INT64_TYPE "int")
     set(DBUS_INT64_CONSTANT  "(val)")
     set(DBUS_UINT64_CONSTANT "(val##U)")
+    set(DBUS_INT64_MODIFIER  "")
 elseif(SIZEOF_LONG EQUAL 8)
     set(DBUS_INT64_TYPE "long")
     set(DBUS_INT64_CONSTANT  "(val##L)")
     set(DBUS_UINT64_CONSTANT "(val##UL)")
+    set(DBUS_INT64_MODIFIER  "l")
 elseif(SIZEOF_LONG_LONG EQUAL 8)
     set(DBUS_INT64_TYPE "long long")
     set(DBUS_INT64_CONSTANT  "(val##LL)")
     set(DBUS_UINT64_CONSTANT "(val##ULL)")
+    set(DBUS_INT64_MODIFIER  "ll")
 elseif(SIZEOF___INT64 EQUAL 8)
     set(DBUS_INT64_TYPE "__int64")
     set(DBUS_INT64_CONSTANT  "(val##i64)")
     set(DBUS_UINT64_CONSTANT "(val##ui64)")
+    set(DBUS_INT64_MODIFIER  "I64")
 else(SIZEOF_INT EQUAL 8)
     message(FATAL_ERROR "Could not find a 64-bit integer type")
 endif()
 
+# MSVCRT.dll printf() doesn't support %lld
+if(WIN32 AND NOT CYGWIN)
+    set(DBUS_INT64_MODIFIER  "I64")
+endif()
+
 # DBUS_INT32_TYPE
 if(SIZEOF_INT EQUAL 4)
     set(DBUS_INT32_TYPE "int")

diff --git a/configure.ac b/configure.ac
index 91bd898cabe5323a46905fa7a814aab7e2cb5d9a..6d4f3081018130bc0aa6481cda870db293911f33 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -448,24 +448,31 @@ $ac_cv_sizeof_int)
   dbusint64=int
   dbusint64_constant='(val)'
   dbusuint64_constant='(val)'
+  dbusint64_modifier=""
   ;;
 $ac_cv_sizeof_long)
   dbusint64=long
   dbusint64_constant='(val##L)'
   dbusuint64_constant='(val##UL)'
+  dbusint64_modifier="l"
   ;;
 $ac_cv_sizeof_long_long)
   dbusint64='long long'
   dbusint64_constant='(val##LL)'
   dbusuint64_constant='(val##ULL)'
+  dbusint64_modifier="ll"
   ;;
 $ac_cv_sizeof___int64)
   dbusint64=__int64
   dbusint64_constant='(val##i64)'
   dbusuint64_constant='(val##ui64)'
+  dbusint64_modifier="I64"
   ;;
 esac
 
+# MSVCRT.dll printf() doesn't support %lld
+AS_IF([test "$dbus_win" = yes], [dbusint64_modifier="I64"])
+
 AS_IF(
   [test -z "$dbusint64"],
   [AC_MSG_RESULT([not found])
@@ -480,12 +487,14 @@ Please report a bug here with details of your platform and compiler:
         DBUS_INT64_TYPE="$dbusint64"
         DBUS_INT64_CONSTANT="$dbusint64_constant"
         DBUS_UINT64_CONSTANT="$dbusuint64_constant"
+        DBUS_INT64_MODIFIER="$dbusint64_modifier"
         AC_MSG_RESULT($DBUS_INT64_TYPE)
   ])
 
 AC_SUBST(DBUS_INT64_TYPE)
 AC_SUBST(DBUS_INT64_CONSTANT)
 AC_SUBST(DBUS_UINT64_CONSTANT)
+AC_SUBST(DBUS_INT64_MODIFIER)
 
 ### see what 32-bit int is called
 AC_MSG_CHECKING([32-bit integer type])

diff --git a/dbus/dbus-arch-deps.h.in b/dbus/dbus-arch-deps.h.in
index dfc3589e7bbb0b304d7629d3dfb6e0e225856564..2dc5894537a382d06f70cecb615773d735dd994f 100644 (file)
--- a/dbus/dbus-arch-deps.h.in
+++ b/dbus/dbus-arch-deps.h.in
@@ -35,6 +35,7 @@ DBUS_BEGIN_DECLS
 #define DBUS_HAVE_INT64 1
 _DBUS_GNUC_EXTENSION typedef @DBUS_INT64_TYPE@ dbus_int64_t;
 _DBUS_GNUC_EXTENSION typedef unsigned @DBUS_INT64_TYPE@ dbus_uint64_t;
+#define DBUS_INT64_MODIFIER "@DBUS_INT64_MODIFIER@"
 
 #define DBUS_INT64_CONSTANT(val)  (_DBUS_GNUC_EXTENSION @DBUS_INT64_CONSTANT@)
 #define DBUS_UINT64_CONSTANT(val) (_DBUS_GNUC_EXTENSION @DBUS_UINT64_CONSTANT@)

diff --git a/dbus/dbus-marshal-basic.c b/dbus/dbus-marshal-basic.c
index ab080d0e8b7dc3048599485d3c2b1ab36bfeb889..097aaf6a9a20eb155aae0592ebafd424e8213eb2 100644 (file)
--- a/dbus/dbus-marshal-basic.c
+++ b/dbus/dbus-marshal-basic.c
@@ -30,10 +30,6 @@
 
 #include <string.h>
 
-#if !defined(PRIx64) && defined(DBUS_WIN)
-#define PRIx64 "I64x"
-#endif
-
 #if defined(__GNUC__) && (__GNUC__ >= 4)
 # define _DBUS_ASSERT_ALIGNMENT(type, op, val) \
   _DBUS_STATIC_ASSERT (__extension__ __alignof__ (type) op val)
@@ -1397,7 +1393,7 @@ _dbus_verbose_bytes (const unsigned char *data,
           if (i > 7 &&
               _DBUS_ALIGN_ADDRESS (&data[i], 8) == &data[i])
             {
-              _dbus_verbose (" u64: 0x%" PRIx64,
+              _dbus_verbose (" u64: 0x%" DBUS_INT64_MODIFIER "x",
                              *(dbus_uint64_t*)&data[i-8]);
               _dbus_verbose (" dbl: %g",
                              *(double*)&data[i-8]);

diff --git a/dbus/dbus-types.h b/dbus/dbus-types.h
index 85f603ae1de14a9d34699f54e4108c1dfb5fcef9..b953b5805515782bc9ebf59156bff3def468f1d5 100644 (file)
--- a/dbus/dbus-types.h
+++ b/dbus/dbus-types.h
@@ -114,6 +114,27 @@ typedef dbus_uint32_t  dbus_bool_t;
  * giving a literal such as "325145246765ULL"
  */
 
+/**
+ * @def DBUS_INT64_MODIFIER
+ *
+ * A string literal for a length modifier that is appropriate to print
+ * the #dbus_int64_t and #dbus_uint64_t types.
+ * For example, it might be an empty string, "l", "ll", or "I64".
+ *
+ * This modifier needs to be concatenated with a literal "%" and a
+ * conversion specifier that can print signed or unsigned integers,
+ * for example:
+ *
+ * @code
+ * dbus_int64_t i = -123;
+ * dbus_uint64_t u = 456;
+ *
+ * printf ("signed: %" DBUS_INT64_MODIFIER "d\n", i);
+ * printf ("unsigned decimal: %" DBUS_INT64_MODIFIER "u\n", u);
+ * printf ("unsigned hex: 0x%" DBUS_INT64_MODIFIER "x\n", x);
+ * @endcode
+ */
+
 /**
  * An 8-byte struct you could use to access int64 without having
  * int64 support. Use #dbus_int64_t or #dbus_uint64_t instead.

diff --git a/test/Makefile.am b/test/Makefile.am
index b539524ce23ba608de871c41c07c522acaa2df16..d013dd875a56fa05785012fc1e51fc73a6108ede 100644 (file)
--- a/test/Makefile.am
+++ b/test/Makefile.am
@@ -140,7 +140,7 @@ test_assertions_SOURCES = internals/assertions.c
 test_assertions_LDADD = libdbus-testutils.la $(GLIB_LIBS)
 
 test_printf_SOURCES = internals/printf.c
-test_printf_LDADD = $(top_builddir)/dbus/libdbus-internal.la
+test_printf_LDADD = libdbus-testutils.la
 
 test_refs_SOURCES = internals/refs.c
 test_refs_LDADD = libdbus-testutils.la $(GLIB_LIBS)

diff --git a/test/internals/dbus-marshal-recursive-util.c b/test/internals/dbus-marshal-recursive-util.c
index f81efffae8c63272a1fd76f825b53f752d2c825d..0727225a348062053b915cc139e59c8a7bce3a91 100644 (file)
--- a/test/internals/dbus-marshal-recursive-util.c
+++ b/test/internals/dbus-marshal-recursive-util.c
@@ -34,10 +34,6 @@
 #include <dbus/dbus-test-tap.h>
 #include <string.h>
 
-#if !defined(PRIx64) && defined(DBUS_WIN)
-#define PRIx64 "I64x"
-#endif
-
 /** turn this on to get deluged in TypeWriter verbose spam */
 #define RECURSIVE_MARSHAL_WRITE_TRACE 0
 
@@ -2629,7 +2625,9 @@ double_read_value (TestTypeNode   *node,
   expected = double_from_seed (seed);
 
   if (!_DBUS_DOUBLES_BITWISE_EQUAL (v, expected))
-    _dbus_test_fatal ("Expected double %g got %g\n bits = 0x%" PRIx64 " vs.\n bits = 0x%" PRIx64,
+    _dbus_test_fatal ("Expected double %g got %g\n"
+                      " bits = 0x%" DBUS_INT64_MODIFIER "x vs.\n"
+                      " bits = 0x%" DBUS_INT64_MODIFIER "x",
                       expected, v,
                       *(dbus_uint64_t*)(char*)&expected,
                       *(dbus_uint64_t*)(char*)&v);

diff --git a/test/internals/printf.c b/test/internals/printf.c
index 1160b2ae9c27d989b187a3ff62ce9477f0ee0d8a..3f6b0f96b743d9b8b35d0b8d372cdccb94f917ee 100644 (file)
--- a/test/internals/printf.c
+++ b/test/internals/printf.c
@@ -66,6 +66,34 @@ do_test (int minimum,
 #define X_TIMES_512  X_TIMES_256 X_TIMES_256
 #define X_TIMES_1024 X_TIMES_512 X_TIMES_512
 
+static void
+print64 (void)
+{
+  dbus_int64_t i = -123;
+  dbus_uint64_t u = 456;
+  DBusString buf = _DBUS_STRING_INIT_INVALID;
+  const char expected[] = "i=-123;u=456;x=1c8";
+
+  if (!_dbus_string_init (&buf))
+    _dbus_test_fatal ("out of memory");
+
+  if (!_dbus_string_append_printf (&buf,
+                                   "i=%" DBUS_INT64_MODIFIER "d;"
+                                   "u=%" DBUS_INT64_MODIFIER "u;"
+                                   "x=%" DBUS_INT64_MODIFIER "x",
+                                   i, u, u))
+    _dbus_test_fatal ("out of memory");
+
+  if (_dbus_string_get_length (&buf) != (int) strlen (expected) ||
+      strcmp (_dbus_string_get_const_data (&buf), expected) != 0)
+    _dbus_test_fatal ("expected: \"%s\", got: %d chars \"%s\"",
+                      expected,
+                      _dbus_string_get_length (&buf),
+                      _dbus_string_get_const_data (&buf));
+
+  _dbus_string_free (&buf);
+}
+
 /* This test outputs TAP syntax: http://testanything.org/ */
 int
 main (int argc,
@@ -101,6 +129,9 @@ main (int argc,
     }
   printf ("ok %d\n", ++test_num);
 
+  print64 ();
+  printf ("ok %d\n", ++test_num);
+
   /* Tell the TAP driver that we have done all the tests we plan to do.
    * This is how it can distinguish between an unexpected exit and
    * successful completion. */

diff --git a/tools/dbus-print-message.c b/tools/dbus-print-message.c
index 2ce7f68b6fd4c48fef06dccf4885e6af15bb4a7e..22ee6824475cb1179e769da7497a289fcf5de880 100644 (file)
--- a/tools/dbus-print-message.c
+++ b/tools/dbus-print-message.c
@@ -43,15 +43,6 @@
 #include <inttypes.h>
 #endif
 
-#if defined(DBUS_WIN)
-#if !defined(PRId64)
-#define PRId64 "I64d"
-#endif
-#if !defined(PRIu64)
-#define PRIu64 "I64u"
-#endif
-#endif
-
 #ifndef HAVE_SOCKLEN_T
 #define socklen_t int
 #endif
@@ -401,7 +392,7 @@ print_iter (DBusMessageIter *iter, dbus_bool_t literal, int depth)
           {
             dbus_int64_t val;
             dbus_message_iter_get_basic (iter, &val);
-            printf ("int64 %" PRId64 "\n", val);
+            printf ("int64 %" DBUS_INT64_MODIFIER "d\n", val);
             break;
           }
 
@@ -409,7 +400,7 @@ print_iter (DBusMessageIter *iter, dbus_bool_t literal, int depth)
           {
             dbus_uint64_t val;
             dbus_message_iter_get_basic (iter, &val);
-            printf ("uint64 %" PRIu64 "\n", val);
+            printf ("uint64 %" DBUS_INT64_MODIFIER "u\n", val);
             break;
           }