xref: /freebsd-src/contrib/llvm-project/lldb/source/Plugins/ABI/ARM/ABIMacOSX_arm.h (revision 5f757f3ff9144b609b3c433dfd370cc6bdc191ad)
15ffd83dbSDimitry Andric //===-- ABIMacOSX_arm.h ----------------------------------------*- C++ -*-===//
25ffd83dbSDimitry Andric //
35ffd83dbSDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
45ffd83dbSDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
55ffd83dbSDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
65ffd83dbSDimitry Andric //
75ffd83dbSDimitry Andric //===----------------------------------------------------------------------===//
85ffd83dbSDimitry Andric 
95ffd83dbSDimitry Andric #ifndef LLDB_SOURCE_PLUGINS_ABI_ARM_ABIMACOSX_ARM_H
105ffd83dbSDimitry Andric #define LLDB_SOURCE_PLUGINS_ABI_ARM_ABIMACOSX_ARM_H
115ffd83dbSDimitry Andric 
125ffd83dbSDimitry Andric #include "lldb/Target/ABI.h"
135ffd83dbSDimitry Andric #include "lldb/lldb-private.h"
145ffd83dbSDimitry Andric 
155ffd83dbSDimitry Andric class ABIMacOSX_arm : public lldb_private::RegInfoBasedABI {
165ffd83dbSDimitry Andric public:
175ffd83dbSDimitry Andric   ~ABIMacOSX_arm() override = default;
185ffd83dbSDimitry Andric 
195ffd83dbSDimitry Andric   size_t GetRedZoneSize() const override;
205ffd83dbSDimitry Andric 
215ffd83dbSDimitry Andric   bool PrepareTrivialCall(lldb_private::Thread &thread, lldb::addr_t sp,
225ffd83dbSDimitry Andric                           lldb::addr_t func_addr, lldb::addr_t returnAddress,
235ffd83dbSDimitry Andric                           llvm::ArrayRef<lldb::addr_t> args) const override;
245ffd83dbSDimitry Andric 
255ffd83dbSDimitry Andric   bool GetArgumentValues(lldb_private::Thread &thread,
265ffd83dbSDimitry Andric                          lldb_private::ValueList &values) const override;
275ffd83dbSDimitry Andric 
285ffd83dbSDimitry Andric   lldb_private::Status
295ffd83dbSDimitry Andric   SetReturnValueObject(lldb::StackFrameSP &frame_sp,
305ffd83dbSDimitry Andric                        lldb::ValueObjectSP &new_value) override;
315ffd83dbSDimitry Andric 
325ffd83dbSDimitry Andric   bool
335ffd83dbSDimitry Andric   CreateFunctionEntryUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override;
345ffd83dbSDimitry Andric 
355ffd83dbSDimitry Andric   bool CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override;
365ffd83dbSDimitry Andric 
375ffd83dbSDimitry Andric   bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override;
385ffd83dbSDimitry Andric 
CallFrameAddressIsValid(lldb::addr_t cfa)395ffd83dbSDimitry Andric   bool CallFrameAddressIsValid(lldb::addr_t cfa) override {
40*5f757f3fSDimitry Andric     // Make sure the stack call frame addresses are 4 byte aligned
415ffd83dbSDimitry Andric     if (cfa & (4ull - 1ull))
425ffd83dbSDimitry Andric       return false; // Not 4 byte aligned
435ffd83dbSDimitry Andric     if (cfa == 0)
445ffd83dbSDimitry Andric       return false; // Zero is not a valid stack address
455ffd83dbSDimitry Andric     return true;
465ffd83dbSDimitry Andric   }
475ffd83dbSDimitry Andric 
CodeAddressIsValid(lldb::addr_t pc)485ffd83dbSDimitry Andric   bool CodeAddressIsValid(lldb::addr_t pc) override {
495ffd83dbSDimitry Andric     // Just make sure the address is a valid 32 bit address. Bit zero
505ffd83dbSDimitry Andric     // might be set due to Thumb function calls, so don't enforce 2 byte
515ffd83dbSDimitry Andric     // alignment
525ffd83dbSDimitry Andric     return pc <= UINT32_MAX;
535ffd83dbSDimitry Andric   }
545ffd83dbSDimitry Andric 
FixCodeAddress(lldb::addr_t pc)555ffd83dbSDimitry Andric   lldb::addr_t FixCodeAddress(lldb::addr_t pc) override {
565ffd83dbSDimitry Andric     // ARM uses bit zero to signify a code address is thumb, so we must
575ffd83dbSDimitry Andric     // strip bit zero in any code addresses.
585ffd83dbSDimitry Andric     return pc & ~(lldb::addr_t)1;
595ffd83dbSDimitry Andric   }
605ffd83dbSDimitry Andric 
615ffd83dbSDimitry Andric   const lldb_private::RegisterInfo *
625ffd83dbSDimitry Andric   GetRegisterInfoArray(uint32_t &count) override;
635ffd83dbSDimitry Andric 
645ffd83dbSDimitry Andric   bool IsArmv7kProcess() const;
655ffd83dbSDimitry Andric 
665ffd83dbSDimitry Andric   // Static Functions
675ffd83dbSDimitry Andric 
685ffd83dbSDimitry Andric   static void Initialize();
695ffd83dbSDimitry Andric 
705ffd83dbSDimitry Andric   static void Terminate();
715ffd83dbSDimitry Andric 
725ffd83dbSDimitry Andric   static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch);
735ffd83dbSDimitry Andric 
GetPluginNameStatic()74349cc55cSDimitry Andric   static llvm::StringRef GetPluginNameStatic() { return "macosx-arm"; }
755ffd83dbSDimitry Andric 
765ffd83dbSDimitry Andric   // PluginInterface protocol
775ffd83dbSDimitry Andric 
GetPluginName()78349cc55cSDimitry Andric   llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
795ffd83dbSDimitry Andric 
805ffd83dbSDimitry Andric protected:
815ffd83dbSDimitry Andric   lldb::ValueObjectSP
825ffd83dbSDimitry Andric   GetReturnValueObjectImpl(lldb_private::Thread &thread,
835ffd83dbSDimitry Andric                            lldb_private::CompilerType &ast_type) const override;
845ffd83dbSDimitry Andric 
855ffd83dbSDimitry Andric private:
865ffd83dbSDimitry Andric   using lldb_private::RegInfoBasedABI::RegInfoBasedABI; // Call CreateInstance instead.
875ffd83dbSDimitry Andric };
885ffd83dbSDimitry Andric 
895ffd83dbSDimitry Andric #endif // LLDB_SOURCE_PLUGINS_ABI_ARM_ABIMACOSX_ARM_H
90