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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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   _dbus_string_init (&uuid);
  80   if (!_dbus_get_local_machine_uuid_encoded (&uuid) ||
  81       !_dbus_string_steal_data (&uuid, &s))
  82     {
  83       _dbus_string_free (&uuid);
  84       return FALSE;
  85     }
  86   else
  87     {
  88       _dbus_string_free (&uuid);
  89       return s;
  90     }
  91
  92 }
  93
  94 /**
  95  * @def DBUS_MAJOR_VERSION
  96  *
  97  * The COMPILE TIME major version of libdbus, that is, the "X" in "X.Y.Z",
  98  * as an integer literal. Consider carefully whether to use this or the
  99  * runtime version from dbus_get_version().
 100  */
 101
 102 /**
 103  * @def DBUS_MINOR_VERSION
 104  *
 105  * The COMPILE TIME minor version of libdbus, that is, the "Y" in "X.Y.Z",
 106  * as an integer literal. Consider carefully whether to use this or the
 107  * runtime version from dbus_get_version().
 108  */
 109
 110 /**
 111  * @def DBUS_MICRO_VERSION
 112  *
 113  * The COMPILE TIME micro version of libdbus, that is, the "Z" in "X.Y.Z",
 114  * as an integer literal. Consider carefully whether to use this or the
 115  * runtime version from dbus_get_version().
 116  */
 117
 118 /**
 119  * @def DBUS_VERSION
 120  *
 121  * The COMPILE TIME version of libdbus, as a single integer that has 0 in the most
 122  * significant byte, the major version in the next most significant byte,
 123  * the minor version in the third most significant, and the micro version in the
 124  * least significant byte. This means two DBUS_VERSION can be compared to see
 125  * which is higher.
 126  *
 127  * Consider carefully whether to use this or the runtime version from
 128  * dbus_get_version().
 129  */
 130
 131 /**
 132  * @def DBUS_VERSION_STRING
 133  *
 134  * The COMPILE TIME version of libdbus, as a string "X.Y.Z".
 135  *
 136  * Consider carefully whether to use this or the runtime version from
 137  * dbus_get_version().
 138  */
 139
 140 /**
 141  * Gets the DYNAMICALLY LINKED version of libdbus. Alternatively, there
 142  * are macros #DBUS_MAJOR_VERSION, #DBUS_MINOR_VERSION, #DBUS_MICRO_VERSION,
 143  * and #DBUS_VERSION which allow you to test the VERSION YOU ARE COMPILED AGAINST.
 144  * In other words, you can get either the runtime or the compile-time version.
 145  * Think carefully about which of these you want in a given case.
 146  *
 147  * The libdbus full version number is "MAJOR.MINOR.MICRO" where the
 148  * MINOR changes if API is added, and the MICRO changes with each
 149  * release of a MAJOR.MINOR series.  The MINOR is an odd number for
 150  * development releases and an even number for stable releases.
 151  *
 152  * @param major_version_p pointer to return the major version, or #NULL
 153  * @param minor_version_p pointer to return the minor version, or #NULL
 154  * @param micro_version_p pointer to return the micro version, or #NULL
 155  *
 156  */
 157 void
 158 dbus_get_version (int *major_version_p,
 159                   int *minor_version_p,
 160                   int *micro_version_p)
 161 {
 162   if (major_version_p)
 163     *major_version_p = DBUS_MAJOR_VERSION;
 164   if (minor_version_p)
 165     *minor_version_p = DBUS_MINOR_VERSION;
 166   if (micro_version_p)
 167     *micro_version_p = DBUS_MICRO_VERSION;
 168 }
 169
 170
 171 /** @} */ /* End of public API */
 172
 173 #ifdef DBUS_BUILD_TESTS
 174
 175 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 176
 177 #include "dbus-test.h"
 178 #include <stdlib.h>
 179
 180
 181 dbus_bool_t
 182 _dbus_misc_test (void)
 183 {
 184   int major, minor, micro;
 185   DBusString str;
 186
 187   /* make sure we don't crash on NULL */
 188   dbus_get_version (NULL, NULL, NULL);
 189
 190   /* Now verify that all the compile-time version stuff
 191    * is right and matches the runtime. These tests
 192    * are mostly intended to catch various kinds of
 193    * typo (mixing up major and minor, that sort of thing).
 194    */
 195   dbus_get_version (&major, &minor, &micro);
 196
 197   _dbus_assert (major == DBUS_MAJOR_VERSION);
 198   _dbus_assert (minor == DBUS_MINOR_VERSION);
 199   _dbus_assert (micro == DBUS_MICRO_VERSION);
 200
 201 #define MAKE_VERSION(x, y, z) (((x) << 16) | ((y) << 8) | (z))
 202
 203   /* check that MAKE_VERSION works and produces the intended ordering */
 204   _dbus_assert (MAKE_VERSION (1, 0, 0) > MAKE_VERSION (0, 0, 0));
 205   _dbus_assert (MAKE_VERSION (1, 1, 0) > MAKE_VERSION (1, 0, 0));
 206   _dbus_assert (MAKE_VERSION (1, 1, 1) > MAKE_VERSION (1, 1, 0));
 207
 208   _dbus_assert (MAKE_VERSION (2, 0, 0) > MAKE_VERSION (1, 1, 1));
 209   _dbus_assert (MAKE_VERSION (2, 1, 0) > MAKE_VERSION (1, 1, 1));
 210   _dbus_assert (MAKE_VERSION (2, 1, 1) > MAKE_VERSION (1, 1, 1));
 211
 212   /* check DBUS_VERSION */
 213   _dbus_assert (MAKE_VERSION (major, minor, micro) == DBUS_VERSION);
 214
 215   /* check that ordering works with DBUS_VERSION */
 216   _dbus_assert (MAKE_VERSION (major - 1, minor, micro) < DBUS_VERSION);
 217   _dbus_assert (MAKE_VERSION (major, minor - 1, micro) < DBUS_VERSION);
 218   _dbus_assert (MAKE_VERSION (major, minor, micro - 1) < DBUS_VERSION);
 219
 220   _dbus_assert (MAKE_VERSION (major + 1, minor, micro) > DBUS_VERSION);
 221   _dbus_assert (MAKE_VERSION (major, minor + 1, micro) > DBUS_VERSION);
 222   _dbus_assert (MAKE_VERSION (major, minor, micro + 1) > DBUS_VERSION);
 223
 224   /* Check DBUS_VERSION_STRING */
 225
 226   if (!_dbus_string_init (&str))
 227     _dbus_assert_not_reached ("no memory");
 228
 229   if (!(_dbus_string_append_int (&str, major) &&
 230         _dbus_string_append_byte (&str, '.') &&
 231         _dbus_string_append_int (&str, minor) &&
 232         _dbus_string_append_byte (&str, '.') &&
 233         _dbus_string_append_int (&str, micro)))
 234     _dbus_assert_not_reached ("no memory");
 235
 236   _dbus_assert (_dbus_string_equal_c_str (&str, DBUS_VERSION_STRING));
 237
 238   _dbus_string_free (&str);
 239
 240   return TRUE;
 241 }
 242
 243 #endif /* !DOXYGEN_SHOULD_SKIP_THIS */
 244
 245 #endif