[kdbus] KDBUS_ITEM_PAYLOAD_OFF items are (once again) relative to msg header
[platform/upstream/glib.git] / glib / gthread.h
index 3ec378a..3f026f6 100644 (file)
@@ -1,20 +1,18 @@
 /* GLIB - Library of useful routines for C programming
  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
  *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
+ * This library is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * licence, or (at your option) any later version.
  *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.         See the GNU
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  */
 
 /*
  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  */
 
-#if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
-#error "Only <glib.h> can be included directly."
-#endif
-
 #ifndef __G_THREAD_H__
 #define __G_THREAD_H__
 
+#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
+#error "Only <glib.h> can be included directly."
+#endif
+
+#include <glib/gatomic.h>
 #include <glib/gerror.h>
-#include <glib/gutils.h>        /* for G_INLINE_FUNC */
-#include <glib/gatomic.h>       /* for g_atomic_pointer_get */
 
 G_BEGIN_DECLS
 
-/* GLib Thread support
- */
-
-extern GQuark g_thread_error_quark (void);
 #define G_THREAD_ERROR g_thread_error_quark ()
+GLIB_AVAILABLE_IN_ALL
+GQuark g_thread_error_quark (void);
 
 typedef enum
 {
@@ -57,7 +52,7 @@ typedef struct _GRecMutex       GRecMutex;
 typedef struct _GRWLock         GRWLock;
 typedef struct _GCond           GCond;
 typedef struct _GPrivate        GPrivate;
-typedef struct _GStaticPrivate  GStaticPrivate;
+typedef struct _GOnce           GOnce;
 
 union _GMutex
 {
@@ -90,29 +85,12 @@ struct _GRecMutex
 #define G_PRIVATE_INIT(notify) { NULL, (notify), { NULL, NULL } }
 struct _GPrivate
 {
+  /*< private >*/
   gpointer       p;
   GDestroyNotify notify;
   gpointer future[2];
 };
 
-GThread *g_thread_new                    (const gchar  *name,
-                                          GThreadFunc   func,
-                                          gpointer      data,
-                                          gboolean      joinable,
-                                          GError      **error);
-
-GThread *g_thread_new_full               (const gchar  *name,
-                                          GThreadFunc   func,
-                                          gpointer      data,
-                                          gboolean      joinable,
-                                          gsize         stack_size,
-                                          GError      **error);
-
-GThread* g_thread_self                   (void);
-void     g_thread_exit                   (gpointer      retval);
-gpointer g_thread_join                   (GThread      *thread);
-void     g_thread_yield                  (void);
-
 typedef enum
 {
   G_ONCE_STATUS_NOTCALLED,
@@ -120,16 +98,140 @@ typedef enum
   G_ONCE_STATUS_READY
 } GOnceStatus;
 
-typedef struct _GOnce GOnce;
+#define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }
 struct _GOnce
 {
   volatile GOnceStatus status;
   volatile gpointer retval;
 };
 
-#define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }
+#define G_LOCK_NAME(name)             g__ ## name ## _lock
+#define G_LOCK_DEFINE_STATIC(name)    static G_LOCK_DEFINE (name)
+#define G_LOCK_DEFINE(name)           GMutex G_LOCK_NAME (name)
+#define G_LOCK_EXTERN(name)           extern GMutex G_LOCK_NAME (name)
 
-gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg);
+#ifdef G_DEBUG_LOCKS
+#  define G_LOCK(name)                G_STMT_START{             \
+      g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
+             "file %s: line %d (%s): locking: %s ",             \
+             __FILE__,        __LINE__, G_STRFUNC,              \
+             #name);                                            \
+      g_mutex_lock (&G_LOCK_NAME (name));                       \
+   }G_STMT_END
+#  define G_UNLOCK(name)              G_STMT_START{             \
+      g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
+             "file %s: line %d (%s): unlocking: %s ",           \
+             __FILE__,        __LINE__, G_STRFUNC,              \
+             #name);                                            \
+     g_mutex_unlock (&G_LOCK_NAME (name));                      \
+   }G_STMT_END
+#  define G_TRYLOCK(name)                                       \
+      (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                  \
+             "file %s: line %d (%s): try locking: %s ",         \
+             __FILE__,        __LINE__, G_STRFUNC,              \
+             #name), g_mutex_trylock (&G_LOCK_NAME (name)))
+#else  /* !G_DEBUG_LOCKS */
+#  define G_LOCK(name) g_mutex_lock       (&G_LOCK_NAME (name))
+#  define G_UNLOCK(name) g_mutex_unlock   (&G_LOCK_NAME (name))
+#  define G_TRYLOCK(name) g_mutex_trylock (&G_LOCK_NAME (name))
+#endif /* !G_DEBUG_LOCKS */
+
+GLIB_AVAILABLE_IN_2_32
+GThread *       g_thread_ref                    (GThread        *thread);
+GLIB_AVAILABLE_IN_2_32
+void            g_thread_unref                  (GThread        *thread);
+GLIB_AVAILABLE_IN_2_32
+GThread *       g_thread_new                    (const gchar    *name,
+                                                 GThreadFunc     func,
+                                                 gpointer        data);
+GLIB_AVAILABLE_IN_2_32
+GThread *       g_thread_try_new                (const gchar    *name,
+                                                 GThreadFunc     func,
+                                                 gpointer        data,
+                                                 GError        **error);
+GLIB_AVAILABLE_IN_ALL
+GThread *       g_thread_self                   (void);
+GLIB_AVAILABLE_IN_ALL
+void            g_thread_exit                   (gpointer        retval);
+GLIB_AVAILABLE_IN_ALL
+gpointer        g_thread_join                   (GThread        *thread);
+GLIB_AVAILABLE_IN_ALL
+void            g_thread_yield                  (void);
+
+
+GLIB_AVAILABLE_IN_2_32
+void            g_mutex_init                    (GMutex         *mutex);
+GLIB_AVAILABLE_IN_2_32
+void            g_mutex_clear                   (GMutex         *mutex);
+GLIB_AVAILABLE_IN_ALL
+void            g_mutex_lock                    (GMutex         *mutex);
+GLIB_AVAILABLE_IN_ALL
+gboolean        g_mutex_trylock                 (GMutex         *mutex);
+GLIB_AVAILABLE_IN_ALL
+void            g_mutex_unlock                  (GMutex         *mutex);
+
+GLIB_AVAILABLE_IN_2_32
+void            g_rw_lock_init                  (GRWLock        *rw_lock);
+GLIB_AVAILABLE_IN_2_32
+void            g_rw_lock_clear                 (GRWLock        *rw_lock);
+GLIB_AVAILABLE_IN_2_32
+void            g_rw_lock_writer_lock           (GRWLock        *rw_lock);
+GLIB_AVAILABLE_IN_2_32
+gboolean        g_rw_lock_writer_trylock        (GRWLock        *rw_lock);
+GLIB_AVAILABLE_IN_2_32
+void            g_rw_lock_writer_unlock         (GRWLock        *rw_lock);
+GLIB_AVAILABLE_IN_2_32
+void            g_rw_lock_reader_lock           (GRWLock        *rw_lock);
+GLIB_AVAILABLE_IN_2_32
+gboolean        g_rw_lock_reader_trylock        (GRWLock        *rw_lock);
+GLIB_AVAILABLE_IN_2_32
+void            g_rw_lock_reader_unlock         (GRWLock        *rw_lock);
+
+GLIB_AVAILABLE_IN_2_32
+void            g_rec_mutex_init                (GRecMutex      *rec_mutex);
+GLIB_AVAILABLE_IN_2_32
+void            g_rec_mutex_clear               (GRecMutex      *rec_mutex);
+GLIB_AVAILABLE_IN_2_32
+void            g_rec_mutex_lock                (GRecMutex      *rec_mutex);
+GLIB_AVAILABLE_IN_2_32
+gboolean        g_rec_mutex_trylock             (GRecMutex      *rec_mutex);
+GLIB_AVAILABLE_IN_2_32
+void            g_rec_mutex_unlock              (GRecMutex      *rec_mutex);
+
+GLIB_AVAILABLE_IN_2_32
+void            g_cond_init                     (GCond          *cond);
+GLIB_AVAILABLE_IN_2_32
+void            g_cond_clear                    (GCond          *cond);
+GLIB_AVAILABLE_IN_ALL
+void            g_cond_wait                     (GCond          *cond,
+                                                 GMutex         *mutex);
+GLIB_AVAILABLE_IN_ALL
+void            g_cond_signal                   (GCond          *cond);
+GLIB_AVAILABLE_IN_ALL
+void            g_cond_broadcast                (GCond          *cond);
+GLIB_AVAILABLE_IN_2_32
+gboolean        g_cond_wait_until               (GCond          *cond,
+                                                 GMutex         *mutex,
+                                                 gint64          end_time);
+
+GLIB_AVAILABLE_IN_ALL
+gpointer        g_private_get                   (GPrivate       *key);
+GLIB_AVAILABLE_IN_ALL
+void            g_private_set                   (GPrivate       *key,
+                                                 gpointer        value);
+GLIB_AVAILABLE_IN_2_32
+void            g_private_replace               (GPrivate       *key,
+                                                 gpointer        value);
+
+GLIB_AVAILABLE_IN_ALL
+gpointer        g_once_impl                     (GOnce          *once,
+                                                 GThreadFunc     func,
+                                                 gpointer        arg);
+GLIB_AVAILABLE_IN_ALL
+gboolean        g_once_init_enter               (volatile void  *location);
+GLIB_AVAILABLE_IN_ALL
+void            g_once_init_leave               (volatile void  *location,
+                                                 gsize           result);
 
 #ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
 # define g_once(once, func, arg) g_once_impl ((once), (func), (arg))
@@ -140,11 +242,6 @@ gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg);
    g_once_impl ((once), (func), (arg)))
 #endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */
 
-/* initialize-once guards, keyed by location */
-gboolean        g_once_init_enter       (volatile void *location);
-void            g_once_init_leave       (volatile void *location,
-                                         gsize          result);
-
 #ifdef __GNUC__
 # define g_once_init_enter(location) \
   (G_GNUC_EXTENSION ({                                               \
@@ -166,79 +263,8 @@ void            g_once_init_leave       (volatile void *location,
   (g_once_init_leave((location), (gsize) (result)))
 #endif
 
-#define G_LOCK_NAME(name)               g__ ## name ## _lock
-#define G_LOCK_DEFINE_STATIC(name)    static G_LOCK_DEFINE (name)
-#define G_LOCK_DEFINE(name)           GMutex G_LOCK_NAME (name)
-#define G_LOCK_EXTERN(name)           extern GMutex G_LOCK_NAME (name)
-
-#ifdef G_DEBUG_LOCKS
-#  define G_LOCK(name)                G_STMT_START{             \
-      g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
-             "file %s: line %d (%s): locking: %s ",             \
-             __FILE__,        __LINE__, G_STRFUNC,              \
-             #name);                                            \
-      g_mutex_lock (&G_LOCK_NAME (name));                       \
-   }G_STMT_END
-#  define G_UNLOCK(name)              G_STMT_START{             \
-      g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
-             "file %s: line %d (%s): unlocking: %s ",           \
-             __FILE__,        __LINE__, G_STRFUNC,              \
-             #name);                                            \
-     g_mutex_unlock (&G_LOCK_NAME (name));                      \
-   }G_STMT_END
-#  define G_TRYLOCK(name)                                       \
-      (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                  \
-             "file %s: line %d (%s): try locking: %s ",         \
-             __FILE__,        __LINE__, G_STRFUNC,              \
-             #name), g_mutex_trylock (&G_LOCK_NAME (name)))
-#else  /* !G_DEBUG_LOCKS */
-#  define G_LOCK(name) g_mutex_lock       (&G_LOCK_NAME (name))
-#  define G_UNLOCK(name) g_mutex_unlock   (&G_LOCK_NAME (name))
-#  define G_TRYLOCK(name) g_mutex_trylock (&G_LOCK_NAME (name))
-#endif /* !G_DEBUG_LOCKS */
-
-
-void                    g_mutex_init                                    (GMutex         *mutex);
-void                    g_mutex_clear                                   (GMutex         *mutex);
-
-void                    g_mutex_lock                                    (GMutex         *mutex);
-void                    g_mutex_unlock                                  (GMutex         *mutex);
-gboolean                g_mutex_trylock                                 (GMutex         *mutex);
-
-void                    g_rw_lock_init                                  (GRWLock        *rw_lock);
-void                    g_rw_lock_clear                                 (GRWLock        *rw_lock);
-void                    g_rw_lock_writer_lock                           (GRWLock        *rw_lock);
-gboolean                g_rw_lock_writer_trylock                        (GRWLock        *rw_lock);
-void                    g_rw_lock_writer_unlock                         (GRWLock        *rw_lock);
-void                    g_rw_lock_reader_lock                           (GRWLock        *rw_lock);
-gboolean                g_rw_lock_reader_trylock                        (GRWLock        *rw_lock);
-void                    g_rw_lock_reader_unlock                         (GRWLock        *rw_lock);
-
-void                    g_rec_mutex_init                                (GRecMutex      *rec_mutex);
-void                    g_rec_mutex_clear                               (GRecMutex      *rec_mutex);
-void                    g_rec_mutex_lock                                (GRecMutex      *rec_mutex);
-gboolean                g_rec_mutex_trylock                             (GRecMutex      *rec_mutex);
-void                    g_rec_mutex_unlock                              (GRecMutex      *rec_mutex);
-
-void                    g_cond_init                                     (GCond          *cond);
-void                    g_cond_clear                                    (GCond          *cond);
-
-void                    g_cond_wait                                     (GCond          *cond,
-                                                                         GMutex         *mutex);
-void                    g_cond_signal                                   (GCond          *cond);
-void                    g_cond_broadcast                                (GCond          *cond);
-gboolean                g_cond_timed_wait                               (GCond          *cond,
-                                                                         GMutex         *mutex,
-                                                                         GTimeVal       *timeval);
-gboolean                g_cond_timedwait                                (GCond          *cond,
-                                                                         GMutex         *mutex,
-                                                                         gint64          abs_time);
-
-gpointer                g_private_get                                   (GPrivate       *key);
-void                    g_private_set                                   (GPrivate       *key,
-                                                                         gpointer        value);
-void                    g_private_replace                               (GPrivate       *key,
-                                                                         gpointer        value);
+GLIB_AVAILABLE_IN_2_36
+guint          g_get_num_processors (void);
 
 G_END_DECLS