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#ifndef ENGINE_DESCRIPTION_H
30#define ENGINE_DESCRIPTION_H
31
32#include "ue2common.h"
33#include "util/target_info.h"
34
35namespace ue2 {
36
37class EngineDescription {
38 u32 id;
39 target_t code_target; // the target that we built this code for
40 u32 numBuckets;
41
42public:
43 EngineDescription(u32 id_in, const target_t &code_target_in,
44 u32 numBuckets_in)
45 : id(id_in), code_target(code_target_in), numBuckets(numBuckets_in) {}
46
47 virtual ~EngineDescription();
48
49 u32 getID() const { return id; }
50 u32 getNumBuckets() const { return numBuckets; }
51
52 bool isValidOnTarget(const target_t &target_in) const;
53 virtual u32 getDefaultFloodSuffixLength() const = 0;
54};
55
56/** Returns a target given a CPU feature set value. */
57target_t targetByArchFeatures(u64a cpu_features);
58
59} // namespace ue2
60
61#endif
62