1/*
2 * Copyright (c) 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/** \file
30 * \brief Inline functions for manipulating logical combinations.
31 */
32
33#ifndef LOGICAL_H
34#define LOGICAL_H
35
36#include "ue2common.h"
37
38/** Index meaning a given logical key is invalid. */
39#define INVALID_LKEY (~(u32)0)
40#define INVALID_CKEY INVALID_LKEY
41
42/** Logical operation type, the priority is from high to low. */
43enum LogicalOpType {
44 LOGICAL_OP_NOT,
45 LOGICAL_OP_AND,
46 LOGICAL_OP_OR,
47 LAST_LOGICAL_OP = LOGICAL_OP_OR //!< Sentinel.
48};
49
50#define UNKNOWN_OP (~(u32)0)
51
52/** Logical Operation is consist of 4 parts. */
53struct LogicalOp {
54 u32 id; //!< logical operator/operation id
55 u32 op; //!< LogicalOpType
56 u32 lo; //!< left operand
57 u32 ro; //!< right operand
58};
59
60/** Each logical combination has its info:
61 * It occupies a region in LogicalOp vector.
62 * It has an exhaustion key for single-match mode. */
63struct CombInfo {
64 u32 id;
65 u32 ekey; //!< exhaustion key
66 u32 start; //!< ckey of logical operation to start calculating
67 u32 result; //!< ckey of logical operation to give final result
68 u64a min_offset;
69 u64a max_offset;
70};
71
72/** Temporarily use to seperate operations' id from reports' lkey
73 * when building logicalTree in shunting yard algorithm,
74 * operations' id will be finally renumbered following reports' lkey. */
75#define LOGICAL_OP_BIT 0x80000000UL
76
77#endif
78