summaryrefslogtreecommitdiffstats
path: root/src/libserver/events.c
blob: 9b8ad078dc24aad92e22cbef53449b39b99e5a1c (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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
/*
 * Copyright (c) 2009-2012, Vsevolod Stakhov
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *	 * Redistributions of source code must retain the above copyright
 *	   notice, this list of conditions and the following disclaimer.
 *	 * Redistributions in binary form must reproduce the above copyright
 *	   notice, this list of conditions and the following disclaimer in the
 *	   documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY AUTHOR ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL AUTHOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "config.h"
#include "main.h"
#include "events.h"

static gboolean
rspamd_event_equal (gconstpointer a, gconstpointer b)
{
	const struct rspamd_async_event *ev1 = a, *ev2 = b;

	if (ev1->fin == ev2->fin) {
		return ev1->user_data == ev2->user_data;
	}

	return FALSE;
}

static guint
rspamd_event_hash (gconstpointer a)
{
	const struct rspamd_async_event *ev = a;

	return GPOINTER_TO_UINT (ev->user_data);
}

#if ((GLIB_MAJOR_VERSION == 2) && (GLIB_MINOR_VERSION <= 30))
static void
event_mutex_free (gpointer data)
{
	GMutex *mtx = data;

	g_mutex_free (mtx);
}

static void
event_cond_free (gpointer data)
{
	GCond *cond = data;

	g_cond_free (cond);
}
#endif

struct rspamd_async_session *
new_async_session (rspamd_mempool_t * pool, session_finalizer_t fin,
	event_finalizer_t restore, event_finalizer_t cleanup, void *user_data)
{
	struct rspamd_async_session *new;

	new = rspamd_mempool_alloc (pool, sizeof (struct rspamd_async_session));
	new->pool = pool;
	new->fin = fin;
	new->restore = restore;
	new->cleanup = cleanup;
	new->user_data = user_data;
	new->wanna_die = FALSE;
	new->events = g_hash_table_new (rspamd_event_hash, rspamd_event_equal);
#if ((GLIB_MAJOR_VERSION == 2) && (GLIB_MINOR_VERSION <= 30))
	new->mtx = g_mutex_new ();
	new->cond = g_cond_new ();
	rspamd_mempool_add_destructor (pool,
		(rspamd_mempool_destruct_t) event_mutex_free,
		new->mtx);
	rspamd_mempool_add_destructor (pool,
		(rspamd_mempool_destruct_t) event_cond_free,
		new->cond);
#else
	new->mtx = rspamd_mempool_alloc (pool, sizeof (GMutex));
	g_mutex_init (new->mtx);
	new->cond = rspamd_mempool_alloc (pool, sizeof (GCond));
	g_cond_init (new->cond);
	rspamd_mempool_add_destructor (pool,
		(rspamd_mempool_destruct_t) g_mutex_clear,
		new->mtx);
	rspamd_mempool_add_destructor (pool,
		(rspamd_mempool_destruct_t) g_cond_clear,
		new->cond);
#endif
	new->threads = 0;

	rspamd_mempool_add_destructor (pool,
		(rspamd_mempool_destruct_t) g_hash_table_destroy,
		new->events);

	return new;
}

void
register_async_event (struct rspamd_async_session *session,
	event_finalizer_t fin,
	void *user_data,
	GQuark subsystem)
{
	struct rspamd_async_event *new;

	if (session == NULL) {
		msg_info ("session is NULL");
		return;
	}

	g_mutex_lock (session->mtx);
	new = rspamd_mempool_alloc (session->pool,
			sizeof (struct rspamd_async_event));
	new->fin = fin;
	new->user_data = user_data;
	new->subsystem = subsystem;

	g_hash_table_insert (session->events, new, new);

	msg_debug ("added event: %p, pending %d events, subsystem: %s",
		user_data,
		g_hash_table_size (session->events),
		g_quark_to_string (subsystem));

	g_mutex_unlock (session->mtx);
}

void
remove_normal_event (struct rspamd_async_session *session,
	event_finalizer_t fin,
	void *ud)
{
	struct rspamd_async_event search_ev, *found_ev;

	if (session == NULL) {
		msg_info ("session is NULL");
		return;
	}

	g_mutex_lock (session->mtx);
	/* Search for event */
	search_ev.fin = fin;
	search_ev.user_data = ud;
	if ((found_ev =
		g_hash_table_lookup (session->events, &search_ev)) != NULL) {
		g_hash_table_remove (session->events, found_ev);
		msg_debug ("removed event: %p, subsystem: %s, pending %d events", ud,
			g_quark_to_string (found_ev->subsystem),
			g_hash_table_size (session->events));
		/* Remove event */
		fin (ud);
	}
	g_mutex_unlock (session->mtx);

	check_session_pending (session);
}

static gboolean
rspamd_session_destroy (gpointer k, gpointer v, gpointer unused)
{
	struct rspamd_async_event *ev = v;

	/* Call event's finalizer */
	msg_debug ("removed event on destroy: %p, subsystem: %s", ev->user_data,
		g_quark_to_string (ev->subsystem));

	if (ev->fin != NULL) {
		ev->fin (ev->user_data);
	}

	return TRUE;
}

gboolean
destroy_session (struct rspamd_async_session *session)
{
	if (session == NULL) {
		msg_info ("session is NULL");
		return FALSE;
	}

	g_mutex_lock (session->mtx);
	if (session->threads > 0) {
		/* Wait for conditional variable to finish processing */
		g_mutex_unlock (session->mtx);
		g_cond_wait (session->cond, session->mtx);
	}

	session->wanna_die = TRUE;

	g_hash_table_foreach_remove (session->events,
		rspamd_session_destroy,
		session);

	/* Mutex can be destroyed here */
	g_mutex_unlock (session->mtx);

	if (session->cleanup != NULL) {
		session->cleanup (session->user_data);
	}
	return TRUE;
}

gboolean
check_session_pending (struct rspamd_async_session *session)
{
	g_mutex_lock (session->mtx);
	if (session->wanna_die && g_hash_table_size (session->events) == 0) {
		session->wanna_die = FALSE;
		if (session->threads > 0) {
			/* Wait for conditional variable to finish processing */
			g_cond_wait (session->cond, session->mtx);
		}
		if (session->fin != NULL) {
			g_mutex_unlock (session->mtx);
			if (!session->fin (session->user_data)) {
				/* Session finished incompletely, perform restoration */
				if (session->restore != NULL) {
					session->restore (session->user_data);
					/* Call pending once more */
					return check_session_pending (session);
				}
				return TRUE;
			}
			else {
				return FALSE;
			}
		}
		g_mutex_unlock (session->mtx);
		return FALSE;
	}
	g_mutex_unlock (session->mtx);
	return TRUE;
}


/**
 * Add new async thread to session
 * @param session session object
 */
void
register_async_thread (struct rspamd_async_session *session)
{
	g_atomic_int_inc (&session->threads);
	msg_debug ("added thread: pending %d thread", session->threads);
}

/**
 * Remove async thread from session and check whether session can be terminated
 * @param session session object
 */
void
remove_async_thread (struct rspamd_async_session *session)
{
	if (g_atomic_int_dec_and_test (&session->threads)) {
		/* Signal if there are any sessions waiting */
		g_mutex_lock (session->mtx);
		g_cond_signal (session->cond);
		g_mutex_unlock (session->mtx);
	}
	msg_debug ("removed thread: pending %d thread", session->threads);
}