1 //===-- ABISysV_s390x.h -----------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLDB_SOURCE_PLUGINS_ABI_SYSTEMZ_ABISYSV_S390X_H
10 #define LLDB_SOURCE_PLUGINS_ABI_SYSTEMZ_ABISYSV_S390X_H
11 
12 #include "lldb/Target/ABI.h"
13 #include "lldb/lldb-private.h"
14 
15 class ABISysV_s390x : public lldb_private::RegInfoBasedABI {
16 public:
17   ~ABISysV_s390x() override = default;
18 
19   size_t GetRedZoneSize() const override;
20 
21   bool PrepareTrivialCall(lldb_private::Thread &thread, lldb::addr_t sp,
22                           lldb::addr_t functionAddress,
23                           lldb::addr_t returnAddress,
24                           llvm::ArrayRef<lldb::addr_t> args) const override;
25 
26   bool GetArgumentValues(lldb_private::Thread &thread,
27                          lldb_private::ValueList &values) const override;
28 
29   lldb_private::Status
30   SetReturnValueObject(lldb::StackFrameSP &frame_sp,
31                        lldb::ValueObjectSP &new_value) override;
32 
33   lldb::ValueObjectSP
34   GetReturnValueObjectImpl(lldb_private::Thread &thread,
35                            lldb_private::CompilerType &type) const override;
36 
37   bool
38   CreateFunctionEntryUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override;
39 
40   bool CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override;
41 
42   bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override;
43 
44   bool GetFallbackRegisterLocation(
45       const lldb_private::RegisterInfo *reg_info,
46       lldb_private::UnwindPlan::Row::RegisterLocation &unwind_regloc) override;
47 
48   bool CallFrameAddressIsValid(lldb::addr_t cfa) override {
49     // Make sure the stack call frame addresses are 8 byte aligned
50     if (cfa & (8ull - 1ull))
51       return false; // Not 8 byte aligned
52     if (cfa == 0)
53       return false; // Zero is not a valid stack address
54     return true;
55   }
56 
57   bool CodeAddressIsValid(lldb::addr_t pc) override {
58     // Code addressed must be 2 byte aligned
59     return (pc & 1ull) == 0;
60   }
61 
62   const lldb_private::RegisterInfo *
63   GetRegisterInfoArray(uint32_t &count) override;
64 
65   // Static Functions
66 
67   static void Initialize();
68 
69   static void Terminate();
70 
71   static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch);
72 
73   static llvm::StringRef GetPluginNameStatic() { return "sysv-s390x"; }
74 
75   // PluginInterface protocol
76 
77   llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
78 
79 protected:
80   void CreateRegisterMapIfNeeded();
81 
82   lldb::ValueObjectSP
83   GetReturnValueObjectSimple(lldb_private::Thread &thread,
84                              lldb_private::CompilerType &ast_type) const;
85 
86   bool RegisterIsCalleeSaved(const lldb_private::RegisterInfo *reg_info);
87 
88 private:
89   using lldb_private::RegInfoBasedABI::RegInfoBasedABI; // Call CreateInstance instead.
90 };
91 
92 #endif // LLDB_SOURCE_PLUGINS_ABI_SYSTEMZ_ABISYSV_S390X_H
93