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: data structures.
31 */
32
33#ifndef FDR_INTERNAL_H
34#define FDR_INTERNAL_H
35
36#include "ue2common.h"
37#include "hwlm/hwlm.h" // for hwlm_group_t, HWLMCallback
38
39struct hs_scratch;
40
41typedef enum {
42 NOT_CAUTIOUS, //!< not near a boundary (quantify?)
43 VECTORING //!< potentially vectoring
44} CautionReason;
45
46/** \brief number of different ids that can be triggered by floods of any given
47 * character. */
48#define FDR_FLOOD_MAX_IDS 16
49
50struct FDRFlood {
51 hwlm_group_t allGroups; //!< all the groups or'd together
52 u32 suffix;
53
54 /** \brief 0 to FDR_FLOOD_MAX_IDS-1 ids that are generated once per char on
55 * a flood.
56 * If larger we won't handle this through the flood path at all. */
57 u16 idCount;
58
59 u32 ids[FDR_FLOOD_MAX_IDS]; //!< the ids
60 hwlm_group_t groups[FDR_FLOOD_MAX_IDS]; //!< group ids to go with string ids
61};
62
63/** \brief FDR structure.
64 *
65 * 1. struct as-is
66 * 2. primary matching table
67 * 3. confirm stuff
68 */
69struct FDR {
70 u32 engineID;
71 u32 size;
72 u32 maxStringLen;
73 u32 numStrings;
74 u32 confOffset;
75 u32 floodOffset;
76 u8 stride; /* stride - how frequently the data is consulted by the first
77 * stage matcher */
78 u8 domain; /* number of bits used to index into main FDR table. This value
79 * is used only of debugging/asserts. */
80 u16 domainMask; /* pre-computed domain mask */
81 u32 tabSize; /* pre-computed hashtable size in bytes */
82 m128 start; /* initial start state to use at offset 0. The state has been
83 * set up based on the min length of buckets to reduce the need
84 * for pointless confirms. */
85};
86
87/** \brief FDR runtime arguments.
88 *
89 * This structure handles read-only things that are passed extensively around
90 * the FDR run-time functions. They are set by the API, passed by value into
91 * the main function, then a pointer is passed around to all the various
92 * sub-functions (confirm & flood). */
93struct FDR_Runtime_Args {
94 const u8 *buf;
95 size_t len;
96 const u8 *buf_history;
97 size_t len_history;
98 size_t start_offset;
99 HWLMCallback cb;
100 struct hs_scratch *scratch;
101 const u8 *firstFloodDetect;
102 const u64a histBytes;
103};
104
105#endif
106