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 NFA graph state squashing analysis.
31 */
32#ifndef NG_SQUASH_H
33#define NG_SQUASH_H
34
35#include "ng_holder.h"
36#include "som/som.h"
37#include "ue2common.h"
38
39#include <unordered_map>
40#include <boost/dynamic_bitset.hpp>
41
42namespace ue2 {
43
44class NGHolder;
45class ReportManager;
46
47/**
48 * Dynamically-sized bitset, as an NFA can have an arbitrary number of states.
49 */
50using NFAStateSet = boost::dynamic_bitset<>;
51
52/**
53 * Populates the squash mask for each vertex (i.e. the set of states to be left
54 * on during squashing).
55 *
56 * The NFAStateSet in the output map is indexed by vertex_index.
57 */
58std::unordered_map<NFAVertex, NFAStateSet>
59findSquashers(const NGHolder &g, som_type som = SOM_NONE);
60
61/** Filters out squash states intended only for use in DFA construction. */
62void filterSquashers(const NGHolder &g,
63 std::unordered_map<NFAVertex, NFAStateSet> &squash);
64
65/** Populates squash masks for states that can be switched off by highlander
66 * (single match) reporters. */
67std::unordered_map<NFAVertex, NFAStateSet>
68findHighlanderSquashers(const NGHolder &g, const ReportManager &rm);
69
70} // namespace ue2
71
72#endif // NG_SQUASH_H
73