LXR qemu/include/glib-compat.h

   1/*
   2 * GLIB Compatibility Functions
   3 *
   4 * Copyright IBM, Corp. 2013
   5 *
   6 * Authors:
   7 *  Anthony Liguori   <aliguori@us.ibm.com>
   8 *  Michael Tokarev   <mjt@tls.msk.ru>
   9 *  Paolo Bonzini     <pbonzini@redhat.com>
  10 *
  11 * This work is licensed under the terms of the GNU GPL, version 2 or later.
  12 * See the COPYING file in the top-level directory.
  13 *
  14 */
  15
  16#ifndef QEMU_GLIB_COMPAT_H
  17#define QEMU_GLIB_COMPAT_H
  18
  19/* Ask for warnings for anything that was marked deprecated in
  20 * the defined version, or before. It is a candidate for rewrite.
  21 */
  22#define GLIB_VERSION_MIN_REQUIRED GLIB_VERSION_2_40
  23
  24/* Ask for warnings if code tries to use function that did not
  25 * exist in the defined version. These risk breaking builds
  26 */
  27#define GLIB_VERSION_MAX_ALLOWED GLIB_VERSION_2_40
  28
  29#pragma GCC diagnostic push
  30#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
  31
  32#include <glib.h>
  33
  34/*
  35 * Note that because of the GLIB_VERSION_MAX_ALLOWED constant above, allowing
  36 * use of functions from newer GLib via this compat header needs a little
  37 * trickery to prevent warnings being emitted.
  38 *
  39 * Consider a function from newer glib-X.Y that we want to use
  40 *
  41 *    int g_foo(const char *wibble)
  42 *
  43 * We must define a static inline function with the same signature that does
  44 * what we need, but with a "_qemu" suffix e.g.
  45 *
  46 * static inline void g_foo_qemu(const char *wibble)
  47 * {
  48 *     #if GLIB_CHECK_VERSION(X, Y, 0)
  49 *        g_foo(wibble)
  50 *     #else
  51 *        g_something_equivalent_in_older_glib(wibble);
  52 *     #endif
  53 * }
  54 *
  55 * The #pragma at the top of this file turns off -Wdeprecated-declarations,
  56 * ensuring this wrapper function impl doesn't trigger the compiler warning
  57 * about using too new glib APIs. Finally we can do
  58 *
  59 *   #define g_foo(a) g_foo_qemu(a)
  60 *
  61 * So now the code elsewhere in QEMU, which *does* have the
  62 * -Wdeprecated-declarations warning active, can call g_foo(...) as normal,
  63 * without generating warnings.
  64 */
  65
  66static inline gboolean g_strv_contains_qemu(const gchar *const *strv,
  67                                            const gchar *str)
  68{
  69#if GLIB_CHECK_VERSION(2, 44, 0)
  70    return g_strv_contains(strv, str);
  71#else
  72    g_return_val_if_fail(strv != NULL, FALSE);
  73    g_return_val_if_fail(str != NULL, FALSE);
  74
  75    for (; *strv != NULL; strv++) {
  76        if (g_str_equal(str, *strv)) {
  77            return TRUE;
  78        }
  79    }
  80
  81    return FALSE;
  82#endif
  83}
  84#define g_strv_contains(a, b) g_strv_contains_qemu(a, b)
  85
  86#if defined(_WIN32) && !GLIB_CHECK_VERSION(2, 50, 0)
  87/*
  88 * g_poll has a problem on Windows when using
  89 * timeouts < 10ms, so use wrapper.
  90 */
  91#define g_poll(fds, nfds, timeout) g_poll_fixed(fds, nfds, timeout)
  92gint g_poll_fixed(GPollFD *fds, guint nfds, gint timeout);
  93#endif
  94
  95
  96#ifndef g_assert_cmpmem
  97#define g_assert_cmpmem(m1, l1, m2, l2)                                        \
  98    do {                                                                       \
  99        gconstpointer __m1 = m1, __m2 = m2;                                    \
 100        int __l1 = l1, __l2 = l2;                                              \
 101        if (__l1 != __l2) {                                                    \
 102            g_assertion_message_cmpnum(                                        \
 103                G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC,                   \
 104                #l1 " (len(" #m1 ")) == " #l2 " (len(" #m2 "))", __l1, "==",   \
 105                __l2, 'i');                                                    \
 106        } else if (memcmp(__m1, __m2, __l1) != 0) {                            \
 107            g_assertion_message(G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC,   \
 108                                "assertion failed (" #m1 " == " #m2 ")");      \
 109        }                                                                      \
 110    } while (0)
 111#endif
 112
 113#pragma GCC diagnostic pop
 114
 115#endif
 116