1/*
2 * Copyright (c) 2006-2007 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, 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 the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Gabe Black
29 *          Steve Reinhardt
30 */
31
32#ifndef __ARCH_SPARC_INSTS_BRANCH_HH__
33#define __ARCH_SPARC_INSTS_BRANCH_HH__
34
35#include "arch/sparc/insts/static_inst.hh"
36
37////////////////////////////////////////////////////////////////////
38//
39// Branch instructions
40//
41
42namespace SparcISA
43{
44
45/**
46 * Base class for branch operations.
47 */
48class Branch : public SparcStaticInst
49{
50  protected:
51    using SparcStaticInst::SparcStaticInst;
52
53    std::string generateDisassembly(
54            Addr pc, const SymbolTable *symtab) const override;
55};
56
57/**
58 * Base class for branch operations with an immediate displacement.
59 */
60class BranchDisp : public Branch
61{
62  protected:
63    BranchDisp(const char *mnem, ExtMachInst _machInst, OpClass __opClass,
64               int32_t _disp) :
65        Branch(mnem, _machInst, __opClass), disp(_disp)
66    {}
67
68    std::string generateDisassembly(
69            Addr pc, const SymbolTable *symtab) const override;
70
71    int32_t disp;
72};
73
74/**
75 * Base class for branches with n bit displacements.
76 */
77template<int bits>
78class BranchNBits : public BranchDisp
79{
80  protected:
81    // Constructor
82    BranchNBits(const char *mnem, ExtMachInst _machInst, OpClass __opClass) :
83        BranchDisp(mnem, _machInst, __opClass,
84                   sext<bits + 2>((_machInst & mask(bits)) << 2))
85    {}
86};
87
88/**
89 * Base class for 16bit split displacements.
90 */
91class BranchSplit : public BranchDisp
92{
93  protected:
94    // Constructor
95    BranchSplit(const char *mnem, ExtMachInst _machInst, OpClass __opClass) :
96        BranchDisp(mnem, _machInst, __opClass,
97                   sext<18>((bits(_machInst, 21, 20) << 16) |
98                            (bits(_machInst, 13, 0) << 2)))
99    {}
100};
101
102/**
103 * Base class for branches that use an immediate and a register to
104 * compute their displacements.
105 */
106class BranchImm13 : public Branch
107{
108  protected:
109    // Constructor
110    BranchImm13(const char *mnem, ExtMachInst _machInst, OpClass __opClass) :
111        Branch(mnem, _machInst, __opClass),
112        imm(sext<13>(bits(_machInst, 12, 0)))
113    {}
114
115    std::string generateDisassembly(
116            Addr pc, const SymbolTable *symtab) const override;
117
118    int32_t imm;
119};
120
121}
122
123#endif // __ARCH_SPARC_INSTS_BRANCH_HH__
124