1/*
2 * Copyright (c) 2015-2018, 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 ROSE_H
30#define ROSE_H
31
32#include "ue2common.h"
33
34struct RoseEngine;
35struct hs_scratch;
36
37// Initialise state space for engine use.
38void roseInitState(const struct RoseEngine *t, char *state);
39
40/* assumes core_info in scratch has been init to point to data */
41void roseBlockExec(const struct RoseEngine *t, struct hs_scratch *scratch);
42
43/* assumes core_info in scratch has been init to point to data */
44void roseStreamExec(const struct RoseEngine *t, struct hs_scratch *scratch);
45
46void roseStreamEodExec(const struct RoseEngine *t, u64a offset,
47 struct hs_scratch *scratch);
48
49hwlmcb_rv_t roseCallback(size_t end, u32 id, struct hs_scratch *scratch);
50
51int roseReportAdaptor(u64a start, u64a end, ReportID id, void *context);
52
53int roseRunBoundaryProgram(const struct RoseEngine *rose, u32 program,
54 u64a stream_offset, struct hs_scratch *scratch);
55
56int roseRunFlushCombProgram(const struct RoseEngine *rose,
57 struct hs_scratch *scratch, u64a end);
58
59#endif // ROSE_H
60