dbus/dbus-misc.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-misc.c  A few assorted public functions that don't fit elsewhere
   3  *
   4  * Copyright (C) 2006 Red Hat, Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23
  24 #include <config.h>
  25 #include "dbus-misc.h"
  26 #include "dbus-internals.h"
  27 #include "dbus-string.h"
  28
  29 /**
  30  * @defgroup DBusMisc Miscellaneous
  31  * @ingroup  DBus
  32  * @brief Miscellaneous API that doesn't cleanly fit anywhere else
  33  *
  34  * @{
  35  */
  36
  37 /**
  38  * Obtains the machine UUID of the machine this process is running on.
  39  *
  40  * The returned string must be freed with dbus_free().
  41  *
  42  * This UUID is guaranteed to remain the same until the next reboot
  43  * (unless the sysadmin foolishly changes it and screws themselves).
  44  * It will usually remain the same across reboots also, but hardware
  45  * configuration changes or rebuilding the machine could break that.
  46  *
  47  * The idea is that two processes with the same machine ID should be
  48  * able to use shared memory, UNIX domain sockets, process IDs, and other
  49  * features of the OS that require both processes to be running
  50  * on the same OS kernel instance.
  51  *
  52  * The machine ID can also be used to create unique per-machine
  53  * instances. For example, you could use it in bus names or
  54  * X selection names.
  55  *
  56  * The machine ID is preferred over the machine hostname, because
  57  * the hostname is frequently set to "localhost.localdomain" and
  58  * may also change at runtime.
  59  *
  60  * You can get the machine ID of a remote application by invoking the
  61  * method GetMachineId from interface org.freedesktop.DBus.Peer.
  62  *
  63  * If the remote application has the same machine ID as the one
  64  * returned by this function, then the remote application is on the
  65  * same machine as your application.
  66  *
  67  * The UUID is not a UUID in the sense of RFC4122; the details
  68  * are explained in the D-Bus specification.
  69  *
  70  * @returns a 32-byte-long hex-encoded UUID string, or #NULL if insufficient memory
  71  */
  72 char*
  73 dbus_get_local_machine_id (void)
  74 {
  75   DBusString uuid;
  76   char *s;
  77
  78   s = NULL;
  79
  80   if (!_dbus_string_init (&uuid))
  81     return NULL;
  82
  83   /* The documentation says dbus_get_local_machine_id() only fails on OOM;
  84    * this can actually also fail if the D-Bus installation is faulty
  85    * (no UUID) *and* reading a new random UUID fails, but we have no way
  86    * to report that */
  87   if (!_dbus_get_local_machine_uuid_encoded (&uuid, NULL) ||
  88       !_dbus_string_steal_data (&uuid, &s))
  89     {
  90       _dbus_string_free (&uuid);
  91       return NULL;
  92     }
  93   else
  94     {
  95       _dbus_string_free (&uuid);
  96       return s;
  97     }
  98
  99 }
 100
 101 /**
 102  * @def DBUS_MAJOR_VERSION
 103  *
 104  * The COMPILE TIME major version of libdbus, that is, the "X" in "X.Y.Z",
 105  * as an integer literal. Consider carefully whether to use this or the
 106  * runtime version from dbus_get_version().
 107  */
 108
 109 /**
 110  * @def DBUS_MINOR_VERSION
 111  *
 112  * The COMPILE TIME minor version of libdbus, that is, the "Y" in "X.Y.Z",
 113  * as an integer literal. Consider carefully whether to use this or the
 114  * runtime version from dbus_get_version().
 115  */
 116
 117 /**
 118  * @def DBUS_MICRO_VERSION
 119  *
 120  * The COMPILE TIME micro version of libdbus, that is, the "Z" in "X.Y.Z",
 121  * as an integer literal. Consider carefully whether to use this or the
 122  * runtime version from dbus_get_version().
 123  */
 124
 125 /**
 126  * @def DBUS_VERSION
 127  *
 128  * The COMPILE TIME version of libdbus, as a single integer that has 0 in the most
 129  * significant byte, the major version in the next most significant byte,
 130  * the minor version in the third most significant, and the micro version in the
 131  * least significant byte. This means two DBUS_VERSION can be compared to see
 132  * which is higher.
 133  *
 134  * Consider carefully whether to use this or the runtime version from
 135  * dbus_get_version().
 136  */
 137
 138 /**
 139  * @def DBUS_VERSION_STRING
 140  *
 141  * The COMPILE TIME version of libdbus, as a string "X.Y.Z".
 142  *
 143  * Consider carefully whether to use this or the runtime version from
 144  * dbus_get_version().
 145  */
 146
 147 /**
 148  * Gets the DYNAMICALLY LINKED version of libdbus. Alternatively, there
 149  * are macros #DBUS_MAJOR_VERSION, #DBUS_MINOR_VERSION, #DBUS_MICRO_VERSION,
 150  * and #DBUS_VERSION which allow you to test the VERSION YOU ARE COMPILED AGAINST.
 151  * In other words, you can get either the runtime or the compile-time version.
 152  * Think carefully about which of these you want in a given case.
 153  *
 154  * The libdbus full version number is "MAJOR.MINOR.MICRO" where the
 155  * MINOR changes if API is added, and the MICRO changes with each
 156  * release of a MAJOR.MINOR series.  The MINOR is an odd number for
 157  * development releases and an even number for stable releases.
 158  *
 159  * @param major_version_p pointer to return the major version, or #NULL
 160  * @param minor_version_p pointer to return the minor version, or #NULL
 161  * @param micro_version_p pointer to return the micro version, or #NULL
 162  *
 163  */
 164 void
 165 dbus_get_version (int *major_version_p,
 166                   int *minor_version_p,
 167                   int *micro_version_p)
 168 {
 169   if (major_version_p)
 170     *major_version_p = DBUS_MAJOR_VERSION;
 171   if (minor_version_p)
 172     *minor_version_p = DBUS_MINOR_VERSION;
 173   if (micro_version_p)
 174     *micro_version_p = DBUS_MICRO_VERSION;
 175 }
 176
 177
 178 /** @} */ /* End of public API */
 179
 180 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
 181
 182 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 183
 184 #include "dbus-test.h"
 185 #include <stdlib.h>
 186
 187
 188 dbus_bool_t
 189 _dbus_misc_test (void)
 190 {
 191   int major, minor, micro;
 192   DBusString str;
 193
 194   /* make sure we don't crash on NULL */
 195   dbus_get_version (NULL, NULL, NULL);
 196
 197   /* Now verify that all the compile-time version stuff
 198    * is right and matches the runtime. These tests
 199    * are mostly intended to catch various kinds of
 200    * typo (mixing up major and minor, that sort of thing).
 201    */
 202   dbus_get_version (&major, &minor, &micro);
 203
 204   _dbus_assert (major == DBUS_MAJOR_VERSION);
 205   _dbus_assert (minor == DBUS_MINOR_VERSION);
 206   _dbus_assert (micro == DBUS_MICRO_VERSION);
 207
 208 #define MAKE_VERSION(x, y, z) (((x) << 16) | ((y) << 8) | (z))
 209
 210   /* check that MAKE_VERSION works and produces the intended ordering */
 211   _dbus_assert (MAKE_VERSION (1, 0, 0) > MAKE_VERSION (0, 0, 0));
 212   _dbus_assert (MAKE_VERSION (1, 1, 0) > MAKE_VERSION (1, 0, 0));
 213   _dbus_assert (MAKE_VERSION (1, 1, 1) > MAKE_VERSION (1, 1, 0));
 214
 215   _dbus_assert (MAKE_VERSION (2, 0, 0) > MAKE_VERSION (1, 1, 1));
 216   _dbus_assert (MAKE_VERSION (2, 1, 0) > MAKE_VERSION (1, 1, 1));
 217   _dbus_assert (MAKE_VERSION (2, 1, 1) > MAKE_VERSION (1, 1, 1));
 218
 219   /* check DBUS_VERSION */
 220   _dbus_assert (MAKE_VERSION (major, minor, micro) == DBUS_VERSION);
 221
 222   /* check that ordering works with DBUS_VERSION */
 223   _dbus_assert (MAKE_VERSION (major - 1, minor, micro) < DBUS_VERSION);
 224   _dbus_assert (MAKE_VERSION (major, minor - 1, micro) < DBUS_VERSION);
 225   _dbus_assert (MAKE_VERSION (major, minor, micro - 1) < DBUS_VERSION);
 226
 227   _dbus_assert (MAKE_VERSION (major + 1, minor, micro) > DBUS_VERSION);
 228   _dbus_assert (MAKE_VERSION (major, minor + 1, micro) > DBUS_VERSION);
 229   _dbus_assert (MAKE_VERSION (major, minor, micro + 1) > DBUS_VERSION);
 230
 231   /* Check DBUS_VERSION_STRING */
 232
 233   if (!_dbus_string_init (&str))
 234     _dbus_assert_not_reached ("no memory");
 235
 236   if (!(_dbus_string_append_int (&str, major) &&
 237         _dbus_string_append_byte (&str, '.') &&
 238         _dbus_string_append_int (&str, minor) &&
 239         _dbus_string_append_byte (&str, '.') &&
 240         _dbus_string_append_int (&str, micro)))
 241     _dbus_assert_not_reached ("no memory");
 242
 243   _dbus_assert (_dbus_string_equal_c_str (&str, DBUS_VERSION_STRING));
 244
 245   _dbus_string_free (&str);
 246
 247   return TRUE;
 248 }
 249
 250 #endif /* !DOXYGEN_SHOULD_SKIP_THIS */
 251
 252 #endif