1/*
2 * Copyright (c) 2016-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/**
30 * \file
31 * \brief Tamarama: container engine for exclusive engines, compiler code.
32 */
33
34#ifndef NFA_TAMARAMACOMPILE_H
35#define NFA_TAMARAMACOMPILE_H
36
37#include "ue2common.h"
38#include "util/bytecode_ptr.h"
39
40#include <map>
41#include <set>
42#include <vector>
43
44struct NFA;
45
46namespace ue2 {
47
48/**
49 * \brief A TamaProto that contains top remapping and reports info.
50 */
51struct TamaProto {
52 void add(const NFA *n, const u32 id, const u32 top,
53 const std::map<std::pair<const NFA *, u32>, u32> &out_top_remap);
54 /** Top remapping between <vertex id, top value> and
55 ** remapped top value. */
56 std::map<std::pair<u32, u32>, u32> top_remap;
57
58 /** All the reports in subengines */
59 std::set<ReportID> reports;
60};
61
62/**
63 * \brief Construction info for a Tamarama engine:
64 * contains at least two subengines.
65 *
66 * A TamaInfo is converted into a single NFA, with each top triggering a
67 * subengine. A TamaInfo can contain at most TamaInfo::max_occupancy
68 * subengines.
69 */
70struct TamaInfo {
71 static constexpr size_t max_occupancy = 65536; // arbitrary limit
72
73 /** \brief Add a new subengine. */
74 void add(NFA *sub, const std::set<u32> &top);
75
76 /** \brief All the subengines */
77 std::vector<NFA *> subengines;
78
79 /** \brief Tops of subengines */
80 std::vector<std::set<u32>> tops;
81};
82
83std::set<ReportID> all_reports(const TamaProto &proto);
84
85/**
86 * Take in a collection of exclusive subengines and produces a tamarama, also
87 * returns via out_top_remap, a mapping indicating how tops in the subengines in
88 * relate to the tamarama's tops.
89 */
90bytecode_ptr<NFA>
91buildTamarama(const TamaInfo &tamaInfo, const u32 queue,
92 std::map<std::pair<const NFA *, u32>, u32> &out_top_remap);
93
94} // namespace ue2
95
96#endif // NFA_TAMARAMACOMPILE_H
97