blob: 624b7b0693c1ba30fa5e2982d5e4f3d2b0a03b57 (
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
|
/*
* Copyright 2023 Vsevolod Stakhov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "config.h"
#ifndef RSPAMD_HYPERSCAN_TOOLS_H
#define RSPAMD_HYPERSCAN_TOOLS_H
#ifdef WITH_HYPERSCAN
#include "hs.h"
G_BEGIN_DECLS
/**
* Opaque structure that represents hyperscan (maybe shared/cached database)
*/
typedef struct rspamd_hyperscan_s rspamd_hyperscan_t;
/**
* Maybe load or mmap shared a hyperscan from a file
* @param filename
* @return cached database if available
*/
rspamd_hyperscan_t *rspamd_hyperscan_maybe_load(const char *filename, goffset offset);
/**
* Creates a wrapper for a raw hs db. Ownership is transferred to the enclosing object returned
* @param filename
* @return
*/
rspamd_hyperscan_t *rspamd_hyperscan_from_raw_db(hs_database_t *db, const char *fname);
/**
* Get the internal database
* @param db
* @return
*/
hs_database_t *rspamd_hyperscan_get_database(rspamd_hyperscan_t *db);
/**
* Free the database
* @param db
*/
void rspamd_hyperscan_free(rspamd_hyperscan_t *db, bool invalid);
/**
* Notice a known hyperscan file (e.g. externally serialized)
* @param fname
*/
void rspamd_hyperscan_notice_known(const char *fname);
/**
* Notice that hyperscan files are all loaded (e.g. in the main process), so we can cleanup old files on termination
*/
void rspamd_hyperscan_notice_loaded(void);
/**
* Cleans up old files. This method should be called on config free (in the main process)
*/
void rspamd_hyperscan_cleanup_maybe(void);
G_END_DECLS
#endif
#endif
|
