gem5  v21.2.1.1
syscall_abi.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2019 Google, Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met: redistributions of source code must retain the above copyright
7  * notice, this list of conditions and the following disclaimer;
8  * redistributions in binary form must reproduce the above copyright
9  * notice, this list of conditions and the following disclaimer in the
10  * documentation and/or other materials provided with the distribution;
11  * neither the name of the copyright holders nor the names of its
12  * contributors may be used to endorse or promote products derived from
13  * this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef __SIM_SYSCALL_ABI_HH__
29 #define __SIM_SYSCALL_ABI_HH__
30 
31 #include "base/bitfield.hh"
32 #include "base/types.hh"
33 #include "cpu/thread_context.hh"
34 #include "sim/guest_abi.hh"
35 #include "sim/syscall_return.hh"
36 
37 namespace gem5
38 {
39 
40 class SyscallDesc;
41 
43 {
44  using State = int;
45 };
46 
48 {
49  using UintPtr = uint64_t;
50 };
51 
53 {
54  using UintPtr = uint32_t;
55 
56  // Is this argument too big for a single register?
57  template <typename T, typename Enabled=void>
58  struct IsWide : public std::false_type {};
59 
60  template <typename T>
61  struct IsWide<T, std::enable_if_t<(sizeof(T) > sizeof(UintPtr))>> :
62  public std::true_type
63  {};
64 
65  template <typename T>
66  static constexpr bool IsWideV = IsWide<T>::value;
67 
68  // Read two registers and merge them into one value.
69  static uint64_t
70  mergeRegs(ThreadContext *tc, RegIndex low_idx, RegIndex high_idx)
71  {
72  RegVal low = tc->readIntReg(low_idx);
73  RegVal high = tc->readIntReg(high_idx);
74  return insertBits(low, 63, 32, high);
75  }
76 };
77 
78 GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi);
79 namespace guest_abi
80 {
81 
82 // For 64 bit systems, return syscall args directly.
83 template <typename ABI, typename Arg>
84 struct Argument<ABI, Arg,
85  typename std::enable_if_t<
86  std::is_base_of_v<GenericSyscallABI64, ABI> &&
87  std::is_integral_v<Arg>>>
88 {
89  static Arg
90  get(ThreadContext *tc, typename ABI::State &state)
91  {
92  panic_if(state >= ABI::ArgumentRegs.size(),
93  "Ran out of syscall argument registers.");
94  return tc->readIntReg(ABI::ArgumentRegs[state++]);
95  }
96 };
97 
98 // For 32 bit systems, return small enough syscall args directly. Large
99 // arguments aren't handled generically.
100 template <typename ABI, typename Arg>
101 struct Argument<ABI, Arg,
102  typename std::enable_if_t<std::is_integral_v<Arg> &&
103  !ABI::template IsWideV<Arg>>>
104 {
105  static Arg
106  get(ThreadContext *tc, typename ABI::State &state)
107  {
108  panic_if(state >= ABI::ArgumentRegs.size(),
109  "Ran out of syscall argument registers.");
110  return bits(tc->readIntReg(ABI::ArgumentRegs[state++]), 31, 0);
111  }
112 };
113 
114 } // namespace guest_abi
115 } // namespace gem5
116 
117 #endif // __SIM_SYSCALL_ABI_HH__
gem5::GenericSyscallABI32::mergeRegs
static uint64_t mergeRegs(ThreadContext *tc, RegIndex low_idx, RegIndex high_idx)
Definition: syscall_abi.hh:70
gem5::RegVal
uint64_t RegVal
Definition: types.hh:173
gem5::RiscvISA::ArgumentRegs
const std::vector< int > ArgumentRegs
Definition: int.hh:67
gem5::GenericSyscallABI::State
int State
Definition: syscall_abi.hh:44
gem5::GenericSyscallABI32::IsWide
Definition: syscall_abi.hh:58
gem5::guest_abi::Argument< ABI, Arg, typename std::enable_if_t< std::is_integral_v< Arg > &&!ABI::template IsWideV< Arg > > >::get
static Arg get(ThreadContext *tc, typename ABI::State &state)
Definition: syscall_abi.hh:106
gem5::GenericSyscallABI64
Definition: syscall_abi.hh:47
gem5::GenericSyscallABI32::IsWideV
static constexpr bool IsWideV
Definition: syscall_abi.hh:66
gem5::GenericSyscallABI64::UintPtr
uint64_t UintPtr
Definition: syscall_abi.hh:49
gem5::high
high
Definition: intmath.hh:176
syscall_return.hh
gem5::GenericSyscallABI32::UintPtr
uint32_t UintPtr
Definition: syscall_abi.hh:54
bitfield.hh
gem5::ThreadContext
ThreadContext is the external interface to all thread state for anything outside of the CPU.
Definition: thread_context.hh:94
gem5::insertBits
constexpr T insertBits(T val, unsigned first, unsigned last, B bit_val)
Returns val with bits first to last set to the LSBs of bit_val.
Definition: bitfield.hh:166
gem5::bits
constexpr T bits(T val, unsigned first, unsigned last)
Extract the bitfield from position 'first' to 'last' (inclusive) from 'val' and right justify it.
Definition: bitfield.hh:76
gem5::guest_abi::Argument< ABI, Arg, typename std::enable_if_t< std::is_base_of_v< GenericSyscallABI64, ABI > &&std::is_integral_v< Arg > > >::get
static Arg get(ThreadContext *tc, typename ABI::State &state)
Definition: syscall_abi.hh:90
gem5::ThreadContext::readIntReg
virtual RegVal readIntReg(RegIndex reg_idx) const =0
gem5::GEM5_DEPRECATED_NAMESPACE
GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi)
gem5::GenericSyscallABI32
Definition: syscall_abi.hh:52
gem5::GenericSyscallABI
Definition: syscall_abi.hh:42
panic_if
#define panic_if(cond,...)
Conditional panic macro that checks the supplied condition and only panics if the condition is true a...
Definition: logging.hh:204
std
Overload hash function for BasicBlockRange type.
Definition: types.hh:111
types.hh
guest_abi.hh
gem5::guest_abi::Argument
Definition: definition.hh:99
gem5::RegIndex
uint16_t RegIndex
Definition: types.hh:176
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: tlb.cc:60
thread_context.hh

Generated on Wed May 4 2022 12:14:03 for gem5 by doxygen 1.8.17