aboutsummaryrefslogtreecommitdiff
path: root/deps/uber-graph/g-ring.c
blob: dc35635d7063df72f16c58721abc14d1b80c8b20 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/* g-ring.c
 *
 * Copyright (C) 2010 Christian Hergert <chris@dronelabs.com>
 *
 * This file 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.1 of the License, or (at your option) any later version.
 * 
 * This file 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 General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <string.h>

#include "g-ring.h"

#ifndef g_malloc0_n
#define g_malloc0_n(x,y) g_malloc0(x * y)
#endif

#define get_element(r,i) ((r)->data + ((r)->elt_size * i))

typedef struct _GRingImpl GRingImpl;

struct _GRingImpl
{
	guint8          *data;      /* Pointer to real data. */
	guint            len;       /* Length of data allocation. */
	guint            pos;       /* Position in ring. */
	guint            elt_size;  /* Size of each element. */
	gboolean         looped;    /* Have we wrapped around at least once. */
	GDestroyNotify   destroy;   /* Destroy element callback. */
	volatile gint    ref_count; /* Reference count. */
};

/**
 * g_ring_sized_new:
 * @element_size: (in): The size per element.
 * @reserved_size: (in): The number of elements to allocate.
 * @element_destroy: (in): Notification called when removing an element.
 *
 * Creates a new instance of #GRing with the given number of elements.
 *
 * Returns: A new #GRing.
 * Side effects: None.
 */
GRing*
g_ring_sized_new (guint          element_size,
                  guint          reserved_size,
                  GDestroyNotify element_destroy)
{
	GRingImpl *ring_impl;

	ring_impl = g_slice_new0(GRingImpl);
	ring_impl->elt_size = element_size;
	ring_impl->len = reserved_size;
	ring_impl->data = g_malloc0_n(reserved_size, element_size);
	ring_impl->destroy = element_destroy;
	ring_impl->ref_count = 1;

	return (GRing *)ring_impl;
}

/**
 * g_ring_append_vals:
 * @ring: (in): A #GRing.
 * @data: (in): A pointer to the array of values.
 * @len: (in): The number of values.
 *
 * Appends @len values located at @data.
 *
 * Returns: None.
 * Side effects: None.
 */
void
g_ring_append_vals (GRing         *ring,
                    gconstpointer  data,
                    guint          len)
{
	GRingImpl *ring_impl = (GRingImpl *)ring;
	gpointer idx;
	gint x;
	gint i;

	g_return_if_fail(ring_impl != NULL);

	for (i = 0; i < len; i++) {
		x = ring->pos - i;
		x = (x >= 0) ? x : ring->len + x;
		idx = ring->data + (ring_impl->elt_size * x);
		if (ring_impl->destroy && ring_impl->looped == TRUE) {
			ring_impl->destroy(idx);
		}
		memcpy(idx, data, ring_impl->elt_size);
		ring->pos++;
		if (ring->pos >= ring->len) {
			ring_impl->looped = TRUE;
		}
		ring->pos %= ring->len;
		data += ring_impl->elt_size;
	}
}

/**
 * g_ring_foreach:
 * @ring: (in): A #GRing.
 * @func: (in): A #GFunc to call for each element.
 * @user_data: (in): user data for @func.
 *
 * Calls @func for every item in the #GRing starting from the most recently
 * inserted element to the least recently inserted.
 *
 * Returns: None.
 * Side effects: None.
 */
void
g_ring_foreach (GRing    *ring,
                GFunc     func,
                gpointer  user_data)
{
	GRingImpl *ring_impl = (GRingImpl *)ring;
	gint i;

	g_return_if_fail(ring_impl != NULL);
	g_return_if_fail(func != NULL);

	for (i = ring_impl->pos - 1; i >= 0; i--) {
		func(get_element(ring_impl, i), user_data);
	}
	for (i = ring->len - 1; i >= ring_impl->pos; i--) {
		func(get_element(ring_impl, i), user_data);
	}
}

/**
 * g_ring_destroy:
 * @ring: (in): A #GRing.
 *
 * Cleans up after a #GRing that is no longer in use.
 *
 * Returns: None.
 * Side effects: None.
 */
void
g_ring_destroy (GRing *ring)
{
	GRingImpl *ring_impl = (GRingImpl *)ring;

	g_return_if_fail(ring != NULL);
	g_return_if_fail(ring_impl->ref_count == 0);

	g_free(ring_impl->data);
	g_slice_free(GRingImpl, ring_impl);
}

/**
 * g_ring_ref:
 * @ring: (in): A #GRing.
 *
 * Atomically increments the reference count of @ring by one.
 *
 * Returns: The @ring pointer.
 * Side effects: None.
 */
GRing*
g_ring_ref (GRing *ring)
{
	GRingImpl *ring_impl = (GRingImpl *)ring;

	g_return_val_if_fail(ring != NULL, NULL);
	g_return_val_if_fail(ring_impl->ref_count > 0, NULL);

	g_atomic_int_inc(&ring_impl->ref_count);
	return ring;
}

/**
 * g_ring_unref:
 * @ring: (in): A #GRing.
 *
 * Atomically decrements the reference count of @ring by one.  When the
 * reference count reaches zero, the structure is freed.
 *
 * Returns: None.
 * Side effects: None.
 */
void
g_ring_unref (GRing *ring)
{
	GRingImpl *ring_impl = (GRingImpl *)ring;

	g_return_if_fail(ring != NULL);
	g_return_if_fail(ring_impl->ref_count > 0);

	if (g_atomic_int_dec_and_test(&ring_impl->ref_count)) {
		g_ring_destroy(ring);
	}
}

/**
 * g_ring_get_type:
 *
 * Retrieves the #GType identifier for #GRing.
 *
 * Returns: The #GType for #GRing.
 * Side effects: The type is registered on first call.
 */
GType
g_ring_get_type (void)
{
	static gsize initialized = FALSE;
	static GType type_id = 0;

	if (g_once_init_enter(&initialized)) {
		type_id = g_boxed_type_register_static("GRing",
		                                       (GBoxedCopyFunc)g_ring_ref,
		                                       (GBoxedFreeFunc)g_ring_unref);
		g_once_init_leave(&initialized, TRUE);
	}
	return type_id;
}