Instructions.h

#ifndef INSTRUCTIONS_H
#define INSTRUCTIONS_H

#include "CPUState.h"
// #include "SGPWorld.h"
// #include "Tasks.h"

#include "sgpl/hardware/Cpu.hpp"
#include "sgpl/operations/flow_global/Anchor.hpp"
#include "sgpl/program/Program.hpp"
#include "sgpl/utility/ThreadLocalRandom.hpp"

#include <functional>
#include <map>
#include <mutex>
#include <set>

namespace sgpmode::inst {

// TODO - Implement an instruction library to help manage instruction set?

// NOTE - discuss register value typing (float vs unsigned integer)

/**
 * Macro to easily create an instruction:
 * `INST(MyInstruction, { *a = *b + 2;})`. In the code block, operand registers
 * are visible as `a`, `b`, and `c`, all of type `uint32_t *`. Instructions may
 * also access the `Core &core`, `Instruction &inst`, `Program &program`, and
 * `CPUState &state`.
 */
#define INST(InstName, InstCode)                                               \
  struct InstName {                                                            \
    /* Runtime call path, run when this instruction executes in a program. */  \
    template <typename HW_SPEC_T>                                                   \
    static void run(                                                           \
      sgpl::Core<HW_SPEC_T>& core,                                                  \
      const sgpl::Instruction<HW_SPEC_T>& inst,                                     \
      const sgpl::Program<HW_SPEC_T>& program,                                      \
      CPUState<typename HW_SPEC_T::world_t>& state                                  \
    ) {                                                                        \
      uint32_t& a = *reinterpret_cast<uint32_t*>(&core.registers[inst.args[0]]);  \
      uint32_t& b = *reinterpret_cast<uint32_t*>(&core.registers[inst.args[1]]);  \
      uint32_t& c = *reinterpret_cast<uint32_t*>(&core.registers[inst.args[2]]);  \
      /* avoid "unused variable" warnings */                                   \
      a = a, b = b, c = c;                                                     \
      InstCode                                                                 \
    }                                                                          \
    /* Make all instruction types eqiprobable to mutate in. */                 \
    static size_t prevalence() { return 1; }                                   \
    /* Instruction class name e.g., "Nop" */                                   \
    static std::string name() { return #InstName; }                            \
    /* Metadata for instruction instance, left empty (needed by JSON write). */\
    template<typename Spec>                                                    \
    static auto descriptors(const sgpl::Instruction<Spec>&) {                  \
      return std::map<std::string, std::string>{};                             \
    }                                                                          \
    /* Metadata for instruction instance, left empty (needed by JSON write). */\
    template<typename Spec>                                                    \
    static auto categories(const sgpl::Instruction<Spec>&) {                   \
      return std::set<std::string>{};                                          \
    }                                                                          \
  };

INST(Increment, {
  // core.registers[inst.args[0]] += 1;
  a += 1;
});

INST(Decrement, {
  // core.registers[inst.args[0]] -= 1;
  a -= 1;
});

// Unary shift (>>1 or <<1)
INST(ShiftLeft, { a <<= 1; });
INST(ShiftRight, { a >>= 1; });

INST(Add, { a = b + c; });
INST(Subtract, { a = b - c; });

INST(Nand, {
  a = ~(b & c);
  // a_uint = ~(b_uint & c_uint);
  // const size_t arg0 = inst.args[0];
  // const size_t arg1 = inst.args[1];
  // const size_t arg2 = inst.args[2];
  // // Work with raw bit representation of floats
  // std::transform(
  //   reinterpret_cast<std::byte*>( &core.registers[arg1] ),
  //   reinterpret_cast<std::byte*>( &core.registers[arg1] ) + sizeof( core.registers[b] ),
  //   reinterpret_cast<std::byte*>( &core.registers[arg2] ),
  //   reinterpret_cast<std::byte*>( &core.registers[arg0] ),
  //   [](const std::byte b, const std::byte c){ return ~(b & c); }
  // );
});

INST(Push, {
  // Push value in register a to active stack.
  state.GetStacks().Push(a);
});

INST(Pop, {
  if (auto val = state.GetStacks().Pop()) {
    a = val.value();
  } else {
    a = 0;
  }
});

INST(SwapStack, {
  state.GetStacks().ChangeActive();
});

INST(Swap, { std::swap(a, b); });

INST(Reproduce, {
  const emp::WorldPosition& org_loc = state.GetLocation();
  // Check whether this attempt at reproduction is allowed.
  auto& world_config = state.GetWorld().GetConfig();


  const bool too_soon = (state.IsHost()) ?
    state.GetCPUCyclesSinceRepro() < world_config.HOST_MIN_CYCLES_BEFORE_REPRO() :
    state.GetCPUCyclesSinceRepro() < world_config.SYM_MIN_CYCLES_BEFORE_REPRO();
  const bool invalid_attempt = state.ReproInProgress() || !org_loc.IsValid()
                               || state.ReproAttempt() || too_soon;
  if (invalid_attempt) {
    return;
  }
  state.MarkReproAttempt();
});

INST(IO, {
  // (1) Add output to output buffer
  state.GetOutputBuffer().emplace_back(a);
  // (2) Read next value from input buffer (advancing buffer read ptr)
  a = state.GetInputBuffer().read();
});

// INST(Input, {
//   a = state.GetInputBuffer().read();
// });

// INST(Output, {
//   state.GetOutputBuffer().emplace_back(a);
// });

// NOTE - Discuss whether we want to be using custom jump table vs. using signalgp's
//        module infrastructure.
INST(JumpIfNEq, {
  if (a != b) {
    core.JumpToIndex(state.GetJumpDest(core.GetProgramCounter()));
  }
});

INST(JumpIfLess, {
  if (a < b) {
    core.JumpToIndex(state.GetJumpDest(core.GetProgramCounter()));
  }
});

INST(JumpIfEq, {
  if (a == b) {
    core.JumpToIndex(state.GetJumpDest(core.GetProgramCounter()));
  }
});

// INST(Jump, {
//   core.JumpToIndex(state.GetJumpDest(core.GetProgramCounter()));
// });

// BOOKMARK
// TODO - Donate / Steal instructions
INST(Donate, {
  // This instruction does nothing if executed by a host or if this is a symbiont
  // without a host.
  if (state.IsHost() || !state.HasHost()) {
    return;
  }
  // If we're here, we know that we have a symbiont with a host.
  state.GetWorld().SymDonateToHost(state.GetOrg(), state.GetHost());
});

INST(Steal, {
  // This instruction does nothing if executed by a
  if (state.IsHost() || !state.HasHost()) {
    return;
  }
  state.GetWorld().SymStealFromHost(state.GetOrg(), state.GetHost());
});

// Only active if free living sym mode turned on
INST(Infect, {
  // Check that this is neither a host or a hosted symbiont
  if (state.IsHost() || state.HasHost()) {
    return;
  }
  state.GetWorld().FreeLivingSymDoInfect(state.GetOrg());
});

// only active if ENABLE_TEMP_CHANGING_ENVIRONMENT turned on and static turned off
INST(SenseTask, {
  const size_t env_task_id = state.GetTaskEnvID();
  auto& task_env = state.GetWorld().GetTaskEnv();
  const auto& task_io = task_env.GetIOBank().GetIO(env_task_id);

  // Check loaded value
  if (task_io.IsValidOutput(a)) {
    // Yes, this output is correct.
    // Get all task ids associated with this output value
    const emp::vector<size_t>& task_ids = task_io.GetTaskIDs(a);

    // Give credit for completed tasks
    for (size_t task_id : task_ids) {
      // Is this a host task?
      if (!task_env.IsHostTask(task_id)) continue;
      // Not first task
      const bool not_first_task = state.GetWorld().GetConfig().HOST_ONLY_FIRST_TASK_CREDIT() && state.GetFirstTaskPerformed().Any() && !state.GetFirstTaskPerformed().Get(task_id);
      if (not_first_task) {
        continue;
      }
      // Has this organism already gotten credit with this output on this task?
      if (state.OutputCredited(task_id, a)) continue;
      // Check task requirements
      auto& task_req_info = task_env.GetHostTaskReq(task_id);
      if (!state.GetWorld().CanPerformTask(state, task_req_info)) {
        continue;
      }

      // check task reward or punishment
      b = task_req_info.task_value > 0;
      return;
    }
  }

});

// NOTE - Discuss following old instructions that were unused (and whether we still want them)
/*
INST(Reuptake, {
  uint32_t next;
  AddOrganismPoints(state, *a);
  // Only get resources if the organism has values in their internal environment
  if (state.internal_environment->size() > 0) {
    // Take a resource from back of internal environment vector
    next = state.internal_environment->back();
    // Clear out the selected resource from Internal Environment
    state.internal_environment->pop_back();
    *a = next;
    state.input_buf.push(next);
  } else {
    // Otherwise, reset the register to 0
    *a = 0;
  }
});
*/

} // namespace inst


#endif