1/*
2 * Copyright (C) 2015 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(B3_JIT)
29
30#include "B3FrequencyClass.h"
31#include <wtf/PrintStream.h>
32
33namespace JSC { namespace B3 {
34
35// A frequented block is a tuple of BasicBlock* and FrequencyClass. It's usually used as a
36// successor edge.
37
38template<typename BasicBlock>
39class GenericFrequentedBlock {
40public:
41 GenericFrequentedBlock(
42 BasicBlock* block = nullptr, FrequencyClass frequency = FrequencyClass::Normal)
43 : m_block(block)
44 , m_frequency(frequency)
45 {
46 }
47
48 bool operator==(const GenericFrequentedBlock& other) const
49 {
50 return m_block == other.m_block
51 && m_frequency == other.m_frequency;
52 }
53
54 bool operator!=(const GenericFrequentedBlock& other) const
55 {
56 return !(*this == other);
57 }
58
59 explicit operator bool() const
60 {
61 return *this != GenericFrequentedBlock();
62 }
63
64 BasicBlock* block() const { return m_block; }
65 BasicBlock*& block() { return m_block; }
66 FrequencyClass frequency() const { return m_frequency; }
67 FrequencyClass& frequency() { return m_frequency; }
68
69 bool isRare() const { return frequency() == FrequencyClass::Rare; }
70
71 void dump(PrintStream& out) const
72 {
73 if (frequency() != FrequencyClass::Normal)
74 out.print(frequency(), ":");
75 out.print(pointerDump(m_block));
76 }
77
78private:
79 BasicBlock* m_block;
80 FrequencyClass m_frequency;
81};
82
83} } // namespace JSC::B3
84
85#endif // ENABLE(B3_JIT)
86