//===-- ABIMacOSX_arm.h ----------------------------------------*- C++ -*-===//

//

// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

// See https://llvm.org/LICENSE.txt for license information.

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

//

//===----------------------------------------------------------------------===//

#ifndef LLDB_SOURCE_PLUGINS_ABI_ARM_ABIMACOSX_ARM_H

#define LLDB_SOURCE_PLUGINS_ABI_ARM_ABIMACOSX_ARM_H

#include "lldb/Target/ABI.h"

#include "lldb/lldb-private.h"

class ABIMacOSX_arm : public lldb_private::RegInfoBasedABI {

public:

  ~ABIMacOSX_arm() override = default;

  size_t GetRedZoneSize() const override;

  bool PrepareTrivialCall(lldb_private::Thread &thread, lldb::addr_t sp,

                          lldb::addr_t func_addr, lldb::addr_t returnAddress,

                          llvm::ArrayRef<lldb::addr_t> args) const override;

  bool GetArgumentValues(lldb_private::Thread &thread,

                         lldb_private::ValueList &values) const override;

  lldb_private::Status

  SetReturnValueObject(lldb::StackFrameSP &frame_sp,

                       lldb::ValueObjectSP &new_value) override;

  bool

  CreateFunctionEntryUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override;

  bool CreateDefaultUnwindPlan(lldb_private::UnwindPlan &unwind_plan) override;

  bool RegisterIsVolatile(const lldb_private::RegisterInfo *reg_info) override;

  bool CallFrameAddressIsValid(lldb::addr_t cfa) override {

    // Make sure the stack call frame addresses are 4 byte aligned

    if (cfa & (4ull - 1ull))

      return false; // Not 4 byte aligned

    if (cfa == 0)

      return false; // Zero is not a valid stack address

    return true;

  }

  bool CodeAddressIsValid(lldb::addr_t pc) override {

    // Just make sure the address is a valid 32 bit address. Bit zero

    // might be set due to Thumb function calls, so don't enforce 2 byte

    // alignment

    return pc <= UINT32_MAX;

  }

  lldb::addr_t FixCodeAddress(lldb::addr_t pc) override {

    // ARM uses bit zero to signify a code address is thumb, so we must

    // strip bit zero in any code addresses.

    return pc & ~(lldb::addr_t)1;

  }

  const lldb_private::RegisterInfo *

  GetRegisterInfoArray(uint32_t &count) override;

  bool IsArmv7kProcess() const;

  // Static Functions

  static void Initialize();

  static void Terminate();

  static lldb::ABISP CreateInstance(lldb::ProcessSP process_sp, const lldb_private::ArchSpec &arch);

  static llvm::StringRef GetPluginNameStatic() { return "macosx-arm"; }

  // PluginInterface protocol

  llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }

protected:

  lldb::ValueObjectSP

  GetReturnValueObjectImpl(lldb_private::Thread &thread,

                           lldb_private::CompilerType &ast_type) const override;

private:

  using lldb_private::RegInfoBasedABI::RegInfoBasedABI; // Call CreateInstance instead.

};

#endif // LLDB_SOURCE_PLUGINS_ABI_ARM_ABIMACOSX_ARM_H