1/*
2 * Copyright (c) 2015-2019, 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 Rose runtime: program interpreter.
32 */
33
34#ifndef PROGRAM_RUNTIME_H
35#define PROGRAM_RUNTIME_H
36
37#include "hwlm/hwlm.h" // for hwlmcb_rv_t
38#include "rose.h"
39#include "scratch.h"
40#include "ue2common.h"
41
42/*
43 * Program context flags, which control the behaviour of some instructions at
44 * based on runtime contexts (whether the program is triggered by the anchored
45 * matcher, engine catchup, etc).
46 */
47
48#define ROSE_PROG_FLAG_IN_ANCHORED 1
49#define ROSE_PROG_FLAG_IN_CATCHUP 2
50#define ROSE_PROG_FLAG_FROM_MPV 4
51#define ROSE_PROG_FLAG_SKIP_MPV_CATCHUP 8
52
53hwlmcb_rv_t roseRunProgram(const struct RoseEngine *t,
54 struct hs_scratch *scratch, u32 programOffset,
55 u64a som, u64a end, u8 prog_flags);
56
57hwlmcb_rv_t roseRunProgram_l(const struct RoseEngine *t,
58 struct hs_scratch *scratch, u32 programOffset,
59 u64a som, u64a end, u8 prog_flags);
60
61#endif // PROGRAM_RUNTIME_H
62