/* Copyright (c) 2019-2023 Advanced Micro Devices, Inc.

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE. */

#ifndef AMD_DBGAPI_DISPLACED_STEPPING_H
#define AMD_DBGAPI_DISPLACED_STEPPING_H 1

#include "agent.h"
#include "amd-dbgapi.h"
#include "architecture.h"
#include "handle_object.h"
#include "queue.h"

#include <cstddef>

namespace amd::dbgapi
{

class process_t;

/* AMD Debugger API Displaced Stepping.  */

class displaced_stepping_t
  : public detail::handle_object<amd_dbgapi_displaced_stepping_id_t>
{
private:
  size_t m_reference_count{ 0 };

  instruction_t const m_original_instruction;
  amd_dbgapi_global_address_t const m_from;
  std::optional<compute_queue_t::displaced_instruction_ptr_t> m_to;

  queue_t &m_queue;

public:
  displaced_stepping_t (
    amd_dbgapi_displaced_stepping_id_t displaced_stepping_id, queue_t &queue,
    instruction_t original_instruction, amd_dbgapi_global_address_t from,
    std::optional<compute_queue_t::displaced_instruction_ptr_t> to);

  ~displaced_stepping_t ();

  const instruction_t &original_instruction () const
  {
    return m_original_instruction;
  }

  /* The original pc where this displaced instruction was copied from.  */
  amd_dbgapi_global_address_t from () const { return m_from; }

  /* The address where this instruction is to be single-stepped.  If the
     original instruction cannot be executed displaced, and instead must be
     simulated, return std::nullopt.  */
  std::optional<amd_dbgapi_global_address_t> to () const
  {
    return m_to ? std::make_optional (m_to->get ()) : std::nullopt;
  }

  /* Used by waves to indicate if using the displaced stepping buffer.  Uses
     reference counting to free the buffer when no waves using it.  */
  static void retain (displaced_stepping_t *displaced_stepping);
  static void release (displaced_stepping_t *displaced_stepping);

  void get_info (amd_dbgapi_displaced_stepping_info_t query, size_t value_size,
                 void *value) const;

  queue_t &queue () const { return m_queue; }
  const agent_t &agent () const { return queue ().agent (); }
  process_t &process () const { return agent ().process (); }
  const architecture_t &architecture () const
  {
    return queue ().architecture ();
  }
};

} /* namespace amd::dbgapi */

#endif /* AMD_DBGAPI_DISPLACED_STEPPING_H */
