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#ifndef FDR_COMPILE_INTERNAL_H
30#define FDR_COMPILE_INTERNAL_H
31
32#include "ue2common.h"
33#include "hwlm/hwlm_literal.h"
34#include "util/bytecode_ptr.h"
35
36#include <map>
37#include <utility>
38#include <vector>
39
40struct FDRConfirm;
41struct LitInfo;
42
43namespace ue2 {
44
45// a pile of decorative typedefs
46// good for documentation purposes more than anything else
47typedef u32 LiteralIndex;
48typedef u32 SuffixPositionInString; // zero is last byte, counting back
49 // into the string
50typedef u32 BucketIndex;
51typedef u32 SchemeBitIndex;
52typedef u32 PositionInBucket; // zero is 'we are matching right now!",
53 // counting towards future matches
54
55class EngineDescription;
56class FDREngineDescription;
57struct hwlmStreamingControl;
58struct Grey;
59
60bytecode_ptr<u8> setupFullConfs(
61 const std::vector<hwlmLiteral> &lits,
62 const EngineDescription &eng,
63 const std::map<BucketIndex, std::vector<LiteralIndex>> &bucketToLits,
64 bool make_small);
65
66// all suffixes include an implicit max_bucket_width suffix to ensure that
67// we always read a full-scale flood "behind" us in terms of what's in our
68// state; if we don't have a flood that's long enough we won't be in the
69// right state yet to allow blindly advancing
70bytecode_ptr<u8> setupFDRFloodControl(const std::vector<hwlmLiteral> &lits,
71 const EngineDescription &eng,
72 const Grey &grey);
73
74bytecode_ptr<u8>
75fdrBuildTableStreaming(const std::vector<hwlmLiteral> &lits,
76 hwlmStreamingControl &stream_control);
77
78static constexpr u32 HINT_INVALID = 0xffffffff;
79
80// fdr_compile_util.cpp utilities
81size_t maxLen(const std::vector<hwlmLiteral> &lits);
82size_t minLenCount(const std::vector<hwlmLiteral> &lits, size_t *count);
83u32 absdiff(u32 i, u32 j);
84
85} // namespace ue2
86
87#endif
88