aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/hyperscan/src/fdr/fdr_confirm.h
blob: 61c23e936b7fd1eeb298520f806104cd4ac36418 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/* 
 * Copyright (c) 2015-2019, Intel Corporation
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met: 
 * 
 *  * Redistributions of source code must retain the above copyright notice, 
 *    this list of conditions and the following disclaimer. 
 *  * Redistributions in binary form must reproduce the above copyright 
 *    notice, this list of conditions and the following disclaimer in the 
 *    documentation and/or other materials provided with the distribution. 
 *  * Neither the name of Intel Corporation nor the names of its contributors 
 *    may be used to endorse or promote products derived from this software 
 *    without specific prior written permission. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE. 
 */ 
 
#ifndef FDR_CONFIRM_H 
#define FDR_CONFIRM_H 
 
#include "ue2common.h" 
#include "hwlm/hwlm.h" 
 
static really_inline 
u32 mul_hash_64(u64a lv, u64a andmsk, u64a mult, u32 nBits) { 
    return ((lv & andmsk) * mult) >> (sizeof(u64a)*8 - nBits); 
} 
 
// data structures 
// TODO: fix this hard-coding 
#define CONF_TYPE u64a 
#define CONF_HASH_CALL mul_hash_64 
 
/**
 * \brief Flag indicating this literal doesn't need to be delivered more than
 * once, used in LitInfo::flags.
 */
#define FDR_LIT_FLAG_NOREPEAT   1
 
/** 
 * \brief Structure describing a literal, linked to by FDRConfirm. 
 * 
 * This structure is followed in memory by a variable-sized string prefix, for
 * strings that are longer than CONF_TYPE.
 */ 
struct LitInfo { 
    CONF_TYPE v; 
    CONF_TYPE msk; 
    hwlm_group_t groups; 
    u32 id; // literal ID as passed in 
    u8 size;
    u8 flags; //!< bitfield of flags from FDR_LIT_FLAG_* above.
    u8 next; 
}; 
 
#define FDRC_FLAG_NO_CONFIRM 1 
#define FDRC_FLAG_NOREPEAT   2
 
/** 
 * \brief FDR confirm header. 
 * 
 * This structure is followed in memory by: 
 * 
 * -# lit index mapping (array of u32) 
 * -# list of LitInfo structures 
 */ 
struct FDRConfirm { 
    CONF_TYPE andmsk; 
    CONF_TYPE mult; 
    u32 nBits;
    hwlm_group_t groups; 
}; 
 
static really_inline 
const u32 *getConfirmLitIndex(const struct FDRConfirm *fdrc) { 
    const u8 *base = (const u8 *)fdrc; 
    const u32 *litIndex = 
        (const u32 *)(base + ROUNDUP_N(sizeof(*fdrc), alignof(u32))); 
    assert(ISALIGNED(litIndex)); 
    return litIndex; 
} 
 
#endif // FDR_CONFIRM_H