1/*
2 * Copyright (c) 2015-2016, 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 Rose runtime types (callbacks, etc).
31 */
32
33#ifndef ROSE_TYPES_H
34#define ROSE_TYPES_H
35
36#include "ue2common.h"
37
38struct hs_scratch;
39
40/**
41 * \brief Continue without checking for exhaustion.
42 *
43 * \ref RoseCallback return value indicating that execution should continue and
44 * that it is not necessary to check if all reports have been exhausted.
45 */
46#define ROSE_CONTINUE_MATCHING_NO_EXHAUST 2
47
48/**
49 * \brief The type for a Rose callback.
50 *
51 * \return
52 * - \ref MO_HALT_MATCHING if matching should terminate;
53 * - \ref MO_CONTINUE_MATCHING if matching should continue;
54 * - \ref ROSE_CONTINUE_MATCHING_NO_EXHAUST if matching should continue and no
55 * exhaustion is possible.
56 */
57typedef int (*RoseCallback)(u64a offset, ReportID id,
58 struct hs_scratch *scratch);
59
60/**
61 * \brief The type for a Rose callback which also tracks start of match.
62 *
63 * Behaves just like \ref RoseCallback except that it is provided with both a
64 * start and an end offset.
65 *
66 * \see RoseCallback
67 */
68typedef int (*RoseCallbackSom)(u64a from_offset, u64a to_offset, ReportID id,
69 struct hs_scratch *scratch);
70
71#endif
72