Move docs inline, and improve wording. (#372598, Behdad Esfahbod)
[glib.git] / glib / gatomic.h
blobfefe2affcf580a465d22d2c99ca568505fb2f8e9
1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * g_atomic_*: atomic operations.
5 * Copyright (C) 2003 Sebastian Wilhelmi
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
25 * file for a list of people on the GLib Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GLib at ftp://ftp.gtk.org/pub/gtk/.
30 #ifndef __G_ATOMIC_H__
31 #define __G_ATOMIC_H__
33 #include <glib/gtypes.h>
35 G_BEGIN_DECLS
37 gint g_atomic_int_exchange_and_add (volatile gint *atomic,
38 gint val);
39 void g_atomic_int_add (volatile gint *atomic,
40 gint val);
41 gboolean g_atomic_int_compare_and_exchange (volatile gint *atomic,
42 gint oldval,
43 gint newval);
44 gboolean g_atomic_pointer_compare_and_exchange (volatile gpointer *atomic,
45 gpointer oldval,
46 gpointer newval);
48 gint g_atomic_int_get (volatile gint *atomic);
49 void g_atomic_int_set (volatile gint *atomic,
50 gint newval);
51 gpointer g_atomic_pointer_get (volatile gpointer *atomic);
52 void g_atomic_pointer_set (volatile gpointer *atomic,
53 gpointer newval);
55 #ifndef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
56 # define g_atomic_int_get(atomic) (*(atomic))
57 # define g_atomic_int_set(atomic, newval) ((void) (*(atomic) = (newval)))
58 # define g_atomic_pointer_get(atomic) (*(atomic))
59 # define g_atomic_pointer_set(atomic, newval) ((void) (*(atomic) = (newval)))
60 #endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */
62 #define g_atomic_int_inc(atomic) (g_atomic_int_add ((atomic), 1))
63 #define g_atomic_int_dec_and_test(atomic) \
64 (g_atomic_int_exchange_and_add ((atomic), -1) == 1)
66 G_END_DECLS
68 #endif /* __G_ATOMIC_H__ */