1/*
2 * Copyright (c) 2015-2017, 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 Shufti acceleration: compile code.
31 */
32
33#ifndef SHUFTI_COMPILE_H
34#define SHUFTI_COMPILE_H
35
36#include "ue2common.h"
37#include "util/charreach.h"
38#include "util/flat_containers.h"
39
40#include <utility>
41
42namespace ue2 {
43
44/** \brief Single-byte variant.
45 *
46 * Returns -1 if unable to construct masks, otherwise returns number of bits
47 * used in the mask.
48 *
49 * Note: always able to construct masks for 8 or fewer characters.
50 */
51int shuftiBuildMasks(const CharReach &chars, u8 *lo, u8 *hi);
52
53/** \brief Double-byte variant
54 *
55 * Returns false if we are unable to build the masks (too many buckets required)
56 */
57bool shuftiBuildDoubleMasks(const CharReach &onechar,
58 const flat_set<std::pair<u8, u8>> &twochar,
59 u8 *lo1, u8 *hi1, u8 *lo2, u8 *hi2);
60
61#ifdef DUMP_SUPPORT
62
63/**
64 * \brief Dump code: returns a CharReach with the reach that would match this
65 * shufti.
66 */
67CharReach shufti2cr(const u8 *lo, const u8 *hi);
68
69#endif // DUMP_SUPPORT
70
71} // namespace ue2
72
73#endif // SHUFTI_COMPILE_H
74