File: log_limiter.h

package info (click to toggle)
libreswan 5.2-2.3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 81,644 kB
  • sloc: ansic: 129,988; sh: 32,018; xml: 20,646; python: 10,303; makefile: 3,022; javascript: 1,506; sed: 574; yacc: 511; perl: 264; awk: 52
file content (56 lines) | stat: -rw-r--r-- 1,533 bytes parent folder | download | duplicates (2)
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
/* log limiter, for libreswan's pluto
 *
 * Copyright (C) 2022 Andrew Cagney
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <https://www.gnu.org/licenses/gpl2.txt>.
 *
 * This program 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 General Public License
 * for more details.
 */

#ifndef LOG_LIMITER_H
#define LOG_LIMITER_H

#include "lswcdefs.h"
#include "lset.h"

struct msg_digest;
struct logger;

/*
 * rate limited logging
 */

enum log_limiter {
	MD_LOG_LIMITER,
	UNSECURED_LOG_LIMITER,
	CERTIFICATE_LOG_LIMITER,
	MSG_ERRQUEUE_LOG_LIMITER,
	PAYLOAD_ERRORS_LOG_LIMITER,
#define LOG_LIMITER_ROOF (PAYLOAD_ERRORS_LOG_LIMITER+1)
};

/*
 * Returns non-LEMPTY RC_FLAGS (either RC_LOG, or DEBUG_STREAM) when
 * the message should be logged.  For instance:
 *
 *    lset_t rc_flags = log_limiter_rc_flags(logger, MD_LOG_LIMITER);
 *    if (rc_flags != LEMPTY) {
 *        llog(rc_flags, logger, "a log-limited message");
 *    }
 *
 */

lset_t log_limiter_rc_flags(struct logger *logger, enum log_limiter limiter);

void limited_llog(struct logger *logger, enum log_limiter limiter,
		  const char *format, ...) PRINTF_LIKE(3);

void init_log_limiter(struct logger *logger);

#endif