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 SOM ("Start of Match") analysis.
31 */
32
33#ifndef NG_SOM_H
34#define NG_SOM_H
35
36#include "som/som.h"
37#include "ue2common.h"
38
39namespace ue2 {
40
41class ExpressionInfo;
42class NG;
43class NGHolder;
44class ReportManager;
45struct Grey;
46
47enum sombe_rv {
48 SOMBE_FAIL,
49 SOMBE_HANDLED_INTERNAL,
50 SOMBE_HANDLED_ALL
51};
52
53/** \brief Perform SOM analysis on the given graph.
54 *
55 * This function will replace report IDs and mutate the graph, then return
56 * SOMBE_HANDLED_INTERNAL if SOM can be established and the full graph still
57 * needs to be handled (rose, etc).
58 *
59 * Returns SOMBE_HANDLED_ALL if everything has been done and the pattern has
60 * been handled in all its glory.
61 *
62 * Returns SOMBE_FAIL and does not mutate the graph if SOM cannot be
63 * established.
64 *
65 * May throw a "Pattern too large" exception if prefixes of the
66 * pattern are too large to compile.
67 */
68sombe_rv doSom(NG &ng, NGHolder &h, const ExpressionInfo &expr, u32 comp_id,
69 som_type som);
70
71/** Returns SOMBE_FAIL (and the original graph) if SOM cannot be established.
72 * May also throw pattern too large if prefixes of the pattern are too large to
73 * compile. */
74sombe_rv doSomWithHaig(NG &ng, NGHolder &h, const ExpressionInfo &expr,
75 u32 comp_id, som_type som);
76
77void makeReportsSomPass(ReportManager &rm, NGHolder &g);
78
79} // namespace ue2
80
81#endif // NG_SOM_H
82