forked from syslog-ng/syslog-ng
-
Notifications
You must be signed in to change notification settings - Fork 0
/
driver.c
413 lines (349 loc) · 12 KB
/
driver.c
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
/*
* Copyright (c) 2002-2012 Balabit
* Copyright (c) 1998-2012 Balázs Scheidler
*
* 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.1 of the License, 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
* 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* As an additional exemption you are allowed to compile & link against the
* OpenSSL libraries as published by the OpenSSL project. See the file
* COPYING for details.
*
*/
#include "driver.h"
#include "logqueue-fifo.h"
#include "afinter.h"
#include "cfg-tree.h"
#include "messages.h"
#include <string.h>
/* LogDriverPlugin */
void
log_driver_plugin_free_method(LogDriverPlugin *self)
{
g_free(self);
}
void
log_driver_plugin_init_instance(LogDriverPlugin *self, const gchar *name)
{
self->name = name;
self->free_fn = log_driver_plugin_free_method;
}
/* LogDriver */
gboolean
log_driver_add_plugin(LogDriver *self, LogDriverPlugin *plugin)
{
g_assert(plugin->name);
if (log_driver_lookup_plugin(self, plugin->name))
{
msg_error("Another instance of this plugin is registered in this driver, unable to register plugin again",
evt_tag_str("driver", self->id),
evt_tag_str("plugin", plugin->name));
return FALSE;
}
self->plugins = g_list_append(self->plugins, plugin);
return TRUE;
}
LogDriverPlugin *
log_driver_lookup_plugin(LogDriver *self, const gchar *plugin_name)
{
for (GList *l = self->plugins; l; l = l->next)
{
LogDriverPlugin *plugin = (LogDriverPlugin *) l->data;
if (strcmp(plugin->name, plugin_name) == 0)
return plugin;
}
return NULL;
}
static gboolean
log_driver_pre_init_method(LogPipe *s)
{
LogDriver *self = (LogDriver *) s;
gboolean success = TRUE;
GList *l;
for (l = self->plugins; l; l = l->next)
{
if (!log_driver_plugin_attach((LogDriverPlugin *) l->data, self))
success = FALSE;
}
return success;
}
static void
log_driver_post_deinit_method(LogPipe *s)
{
LogDriver *self = (LogDriver *) s;
GList *l;
for (l = self->plugins; l; l = l->next)
{
log_driver_plugin_detach((LogDriverPlugin *) l->data, self);
}
}
gboolean
log_driver_init_method(LogPipe *s)
{
return TRUE;
}
gboolean
log_driver_deinit_method(LogPipe *s)
{
return TRUE;
}
/* NOTE: intentionally static, as only cDriver or LogDestDriver will derive from LogDriver */
static void
log_driver_free(LogPipe *s)
{
LogDriver *self = (LogDriver *) s;
GList *l;
for (l = self->plugins; l; l = l->next)
{
log_driver_plugin_free((LogDriverPlugin *) l->data);
}
if (self->plugins)
{
g_list_free(self->plugins);
}
if (self->group)
g_free(self->group);
if (self->id)
g_free(self->id);
log_pipe_free_method(s);
}
/* NOTE: intentionally static, as only LogSrcDriver or LogDestDriver will derive from LogDriver */
static void
log_driver_init_instance(LogDriver *self, GlobalConfig *cfg)
{
log_pipe_init_instance(&self->super, cfg);
self->super.flags |= PIF_CONFIG_RELATED;
self->super.free_fn = log_driver_free;
self->super.pre_init = log_driver_pre_init_method;
self->super.init = log_driver_init_method;
self->super.deinit = log_driver_deinit_method;
self->super.post_deinit = log_driver_post_deinit_method;
}
/* LogSrcDriver */
static gboolean
log_src_driver_pre_init_method(LogPipe *s)
{
LogSrcDriver *self = (LogSrcDriver *) s;
GlobalConfig *cfg = log_pipe_get_config(&self->super.super);
if (!self->super.group)
{
self->super.group = cfg_tree_get_rule_name(&cfg->tree, ENC_SOURCE, s->expr_node);
self->group_len = strlen(self->super.group);
self->super.id = cfg_tree_get_child_id(&cfg->tree, ENC_SOURCE, s->expr_node);
}
return log_driver_pre_init_method(s);
}
gboolean
log_src_driver_init_method(LogPipe *s)
{
LogSrcDriver *self = (LogSrcDriver *) s;
if (!log_driver_init_method(s))
return FALSE;
stats_lock();
StatsClusterKey sc_key;
stats_cluster_logpipe_key_legacy_set(&sc_key, SCS_SOURCE | SCS_GROUP, self->super.group, NULL );
stats_register_counter(0, &sc_key, SC_TYPE_PROCESSED,
&self->super.processed_group_messages);
stats_cluster_logpipe_key_legacy_set(&sc_key, SCS_CENTER, NULL, "received" );
stats_register_counter(0, &sc_key, SC_TYPE_PROCESSED, &self->received_global_messages);
stats_unlock();
return TRUE;
}
gboolean
log_src_driver_deinit_method(LogPipe *s)
{
LogSrcDriver *self = (LogSrcDriver *) s;
if (!log_driver_deinit_method(s))
return FALSE;
stats_lock();
StatsClusterKey sc_key;
stats_cluster_logpipe_key_legacy_set(&sc_key, SCS_SOURCE | SCS_GROUP, self->super.group, NULL );
stats_unregister_counter(&sc_key, SC_TYPE_PROCESSED,
&self->super.processed_group_messages);
stats_cluster_logpipe_key_legacy_set(&sc_key, SCS_CENTER, NULL, "received" );
stats_unregister_counter(&sc_key, SC_TYPE_PROCESSED, &self->received_global_messages);
stats_unlock();
return TRUE;
}
void
log_src_driver_queue_method(LogPipe *s, LogMessage *msg, const LogPathOptions *path_options)
{
LogSrcDriver *self = (LogSrcDriver *) s;
GlobalConfig *cfg = log_pipe_get_config(s);
/* $SOURCE */
if (msg->flags & LF_LOCAL)
afinter_postpone_mark(cfg->mark_freq);
log_msg_set_value(msg, LM_V_SOURCE, self->super.group, self->group_len);
stats_counter_inc(self->super.processed_group_messages);
stats_counter_inc(self->received_global_messages);
log_pipe_forward_msg(s, msg, path_options);
}
void
log_src_driver_init_instance(LogSrcDriver *self, GlobalConfig *cfg)
{
log_driver_init_instance(&self->super, cfg);
self->super.super.pre_init = log_src_driver_pre_init_method;
self->super.super.init = log_src_driver_init_method;
self->super.super.deinit = log_src_driver_deinit_method;
self->super.super.queue = log_src_driver_queue_method;
self->super.super.flags |= PIF_SOURCE;
}
void
log_src_driver_free(LogPipe *s)
{
log_driver_free(s);
}
/* LogDestDriver */
static LogQueue *
_create_memory_queue(LogDestDriver *self, const gchar *persist_name, gint stats_level,
const StatsClusterKeyBuilder *driver_sck_builder, StatsClusterKeyBuilder *queue_sck_builder)
{
GlobalConfig *cfg = log_pipe_get_config(&self->super.super);
gint log_fifo_size = self->log_fifo_size < 0 ? cfg->log_fifo_size : self->log_fifo_size;
if (cfg_is_config_version_older(cfg, VERSION_VALUE_3_22))
{
msg_warning_once("WARNING: log-fifo-size() works differently starting with " VERSION_3_22 " to avoid dropping "
"flow-controlled messages when log-fifo-size() is misconfigured. From now on, log-fifo-size() "
"only affects messages that are not flow-controlled. (Flow-controlled log paths have the "
"flags(flow-control) option set.) To enable the new behaviour, update the @version string in "
"your configuration and consider lowering the value of log-fifo-size().");
return log_queue_fifo_legacy_new(log_fifo_size, persist_name, stats_level, driver_sck_builder, queue_sck_builder);
}
return log_queue_fifo_new(log_fifo_size, persist_name, stats_level, driver_sck_builder, queue_sck_builder);
}
/* returns a reference */
static LogQueue *
log_dest_driver_acquire_memory_queue(LogDestDriver *self, const gchar *persist_name, gint stats_level,
const StatsClusterKeyBuilder *driver_sck_builder,
StatsClusterKeyBuilder *queue_sck_builder)
{
GlobalConfig *cfg = log_pipe_get_config(&self->super.super);
LogQueue *queue = NULL;
if (persist_name)
queue = cfg_persist_config_fetch(cfg, persist_name);
if (queue && !log_queue_has_type(queue, log_queue_fifo_get_type()))
{
log_queue_unref(queue);
queue = NULL;
}
if (!queue)
{
queue = _create_memory_queue(self, persist_name, stats_level, driver_sck_builder, queue_sck_builder);
log_queue_set_throttle(queue, self->throttle);
}
return queue;
}
/* consumes the reference in @q */
static void
log_dest_driver_release_queue_method(LogDestDriver *self, LogQueue *q)
{
GlobalConfig *cfg = log_pipe_get_config(&self->super.super);
/* we only save the LogQueue instance if it contains data */
if (q->persist_name && log_queue_keep_on_reload(q) > 0)
{
cfg_persist_config_add(cfg, q->persist_name, q, (GDestroyNotify) log_queue_unref);
}
else
{
log_queue_unref(q);
}
}
void
log_dest_driver_queue_method(LogPipe *s, LogMessage *msg, const LogPathOptions *path_options)
{
LogDestDriver *self = (LogDestDriver *) s;
stats_counter_inc(self->super.processed_group_messages);
stats_counter_inc(self->queued_global_messages);
log_pipe_forward_msg(s, msg, path_options);
}
static gboolean
log_dest_driver_pre_init_method(LogPipe *s)
{
LogDestDriver *self = (LogDestDriver *) s;
GlobalConfig *cfg = log_pipe_get_config(&self->super.super);
if (!self->super.group)
{
self->super.group = cfg_tree_get_rule_name(&cfg->tree, ENC_DESTINATION, s->expr_node);
self->super.id = cfg_tree_get_child_id(&cfg->tree, ENC_DESTINATION, s->expr_node);
}
return log_driver_pre_init_method(s);
}
gboolean
log_dest_driver_init_method(LogPipe *s)
{
LogDestDriver *self = (LogDestDriver *) s;
if (!log_driver_init_method(s))
return FALSE;
stats_lock();
StatsClusterKey sc_key;
stats_cluster_logpipe_key_legacy_set(&sc_key, SCS_DESTINATION | SCS_GROUP, self->super.group, NULL );
stats_register_counter(0, &sc_key, SC_TYPE_PROCESSED,
&self->super.processed_group_messages);
stats_cluster_logpipe_key_legacy_set(&sc_key, SCS_CENTER, NULL, "queued" );
stats_register_counter(0, &sc_key, SC_TYPE_PROCESSED, &self->queued_global_messages);
stats_unlock();
return TRUE;
}
gboolean
log_dest_driver_deinit_method(LogPipe *s)
{
LogDestDriver *self = (LogDestDriver *) s;
GList *l, *l_next;
for (l = self->queues; l; l = l_next)
{
LogQueue *q = (LogQueue *) l->data;
/* the GList struct will be freed by log_dest_driver_release_queue */
l_next = l->next;
/* we have to pass a reference to log_dest_driver_release_queue(),
* which automatically frees the ref on the list too */
log_dest_driver_release_queue(self, log_queue_ref(q));
}
g_assert(self->queues == NULL);
stats_lock();
StatsClusterKey sc_key;
stats_cluster_logpipe_key_legacy_set(&sc_key, SCS_DESTINATION | SCS_GROUP, self->super.group, NULL );
stats_unregister_counter(&sc_key, SC_TYPE_PROCESSED,
&self->super.processed_group_messages);
stats_cluster_logpipe_key_legacy_set(&sc_key, SCS_CENTER, NULL, "queued" );
stats_unregister_counter(&sc_key, SC_TYPE_PROCESSED, &self->queued_global_messages);
stats_unlock();
if (!log_driver_deinit_method(s))
return FALSE;
return TRUE;
}
void
log_dest_driver_init_instance(LogDestDriver *self, GlobalConfig *cfg)
{
log_driver_init_instance(&self->super, cfg);
self->super.super.pre_init = log_dest_driver_pre_init_method;
self->super.super.init = log_dest_driver_init_method;
self->super.super.deinit = log_dest_driver_deinit_method;
self->super.super.queue = log_dest_driver_queue_method;
self->acquire_queue = log_dest_driver_acquire_memory_queue;
self->release_queue = log_dest_driver_release_queue_method;
self->log_fifo_size = -1;
self->throttle = 0;
}
void
log_dest_driver_free(LogPipe *s)
{
LogDestDriver *self = (LogDestDriver *) s;
GList *l;
for (l = self->queues; l; l = l->next)
{
log_queue_unref((LogQueue *) l->data);
}
g_list_free(self->queues);
log_driver_free(s);
}