1/*
2 * Copyright (c) 2015-2017, Intel Corporation
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * * Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Intel Corporation nor the names of its contributors
13 * may be used to endorse or promote products derived from this software
14 * without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** \file
30 * \brief FDR literal matcher: runtime API.
31 */
32
33#ifndef FDR_H
34#define FDR_H
35
36#include "ue2common.h"
37#include "hwlm/hwlm.h"
38
39// C linkage in the API
40#ifdef __cplusplus
41extern "C" {
42#endif
43
44struct FDR;
45struct hs_scratch;
46
47/**
48 * \brief Block-mode scan.
49 *
50 * \param fdr FDR matcher engine.
51 * \param buf Buffer to scan.
52 * \param len Length of buffer to scan.
53 * \param start First offset in buf at which a match may start.
54 * \param cb Callback to call when a match is found.
55 * \param scratch Scratch supplied to callback on match.
56 * \param groups Initial groups mask.
57 */
58hwlm_error_t fdrExec(const struct FDR *fdr, const u8 *buf, size_t len,
59 size_t start, HWLMCallback cb, struct hs_scratch *scratch,
60 hwlm_group_t groups);
61
62/**
63 * \brief Streaming-mode scan.
64 *
65 * \param fdr FDR matcher engine.
66 * \param hbuf History buffer.
67 * \param hlen Length of history buffer (hbuf).
68 * \param buf Buffer to scan.
69 * \param len Length of buffer to scan (buf).
70 * \param start First offset in buf at which a match may start.
71 * \param cb Callback to call when a match is found.
72 * \param scratch Scratch supplied to callback on match.
73 * \param groups Initial groups mask.
74 */
75hwlm_error_t fdrExecStreaming(const struct FDR *fdr, const u8 *hbuf,
76 size_t hlen, const u8 *buf, size_t len,
77 size_t start, HWLMCallback cb,
78 struct hs_scratch *scratch,
79 hwlm_group_t groups);
80
81#ifdef __cplusplus
82}
83#endif // __cplusplus
84
85#endif // FDR_H
86