1/*
2 * Copyright (C) 2014, 2016 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. 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 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#if ENABLE(FTL_JIT)
29
30#include "FTLAbbreviatedTypes.h"
31#include "FTLWeight.h"
32
33namespace JSC { namespace FTL {
34
35class WeightedTarget {
36public:
37 WeightedTarget()
38 : m_target(nullptr)
39 {
40 }
41
42 WeightedTarget(LBasicBlock target, Weight weight)
43 : m_target(target)
44 , m_weight(weight)
45 {
46 }
47
48 WeightedTarget(LBasicBlock target, float weight)
49 : m_target(target)
50 , m_weight(weight)
51 {
52 }
53
54 LBasicBlock target() const { return m_target; }
55 Weight weight() const { return m_weight; }
56
57 B3::FrequentedBlock frequentedBlock() const
58 {
59 return B3::FrequentedBlock(target(), weight().frequencyClass());
60 }
61
62private:
63 LBasicBlock m_target;
64 Weight m_weight;
65};
66
67// Helpers for creating weighted targets for statically known (or unknown) branch
68// profiles.
69
70inline WeightedTarget usually(LBasicBlock block)
71{
72 return WeightedTarget(block, 1);
73}
74
75inline WeightedTarget rarely(LBasicBlock block)
76{
77 return WeightedTarget(block, 0);
78}
79
80// Currently in B3 this is the equivalent of "usually", but we like to make the distinction in
81// case we ever make B3 support proper branch weights. We used to do that in LLVM.
82inline WeightedTarget unsure(LBasicBlock block)
83{
84 return WeightedTarget(block, Weight());
85}
86
87} } // namespace JSC::FTL
88
89#endif // ENABLE(FTL_JIT)
90