jak-project/decompiler/ObjectFile/LinkedObjectFile.cpp

/*!
 * @file LinkedObjectFile.cpp
 * An object file's data with linking information included.
 */

#include "LinkedObjectFile.h"

#include <algorithm>
#include <cstring>
#include <numeric>

#include "common/goos/PrettyPrinter.h"
#include "common/log/log.h"
#include "common/util/Assert.h"

#include "decompiler/Disasm/InstructionDecode.h"
#include "decompiler/config.h"

#include "fmt/core.h"
#include "third-party/json.hpp"

namespace decompiler {
/*!
 * Set the number of segments in this object file.
 * This can only be done once, and must be done before adding any words.
 */
void LinkedObjectFile::set_segment_count(int n_segs) {
  ASSERT(segments == 0);
  segments = n_segs;
  words_by_seg.resize(n_segs);
  label_per_seg_by_offset.resize(n_segs);
  offset_of_data_zone_by_seg.resize(n_segs);
  functions_by_seg.resize(n_segs);
}

/*!
 * Add a single word to the given segment.
 */
void LinkedObjectFile::push_back_word_to_segment(uint32_t word, int segment) {
  words_by_seg.at(segment).emplace_back(word);
}

/*!
 * Get a label ID for a label which points to the given offset in the given segment.
 * Will return an existing label if one exists.
 */
int LinkedObjectFile::get_label_id_for(int seg, int offset) {
  auto kv = label_per_seg_by_offset.at(seg).find(offset);
  if (kv == label_per_seg_by_offset.at(seg).end()) {
    // create a new label
    int id = labels.size();
    DecompilerLabel label;
    label.target_segment = seg;
    label.offset = offset;
    label.name = "L" + std::to_string(id);
    label_per_seg_by_offset.at(seg)[offset] = id;
    labels.push_back(label);
    return id;
  } else {
    // return an existing label
    auto& label = labels.at(kv->second);
    ASSERT(label.offset == offset);
    ASSERT(label.target_segment == seg);
    return kv->second;
  }
}

/*!
 * Get the ID of the label which points to the given offset in the given segment.
 * Returns -1 if there is no label.
 */
int LinkedObjectFile::get_label_at(int seg, int offset) const {
  auto kv = label_per_seg_by_offset.at(seg).find(offset);
  if (kv == label_per_seg_by_offset.at(seg).end()) {
    return -1;
  }

  return kv->second;
}

/*!
 * Does this label point to code? Can point to the middle of a function, or the start of a function.
 */
bool LinkedObjectFile::label_points_to_code(int label_id) const {
  auto& label = labels.at(label_id);
  auto data_start = int(offset_of_data_zone_by_seg.at(label.target_segment)) * 4;
  return label.offset < data_start;
}

/*!
 * Get the function starting at this label, or error if there is none.
 */
Function& LinkedObjectFile::get_function_at_label(int label_id) {
  auto& label = labels.at(label_id);
  for (auto& func : functions_by_seg.at(label.target_segment)) {
    // + 4 to skip past type tag to the first word, which is were the label points.
    if (func.start_word * 4 + 4 == label.offset) {
      return func;
    }
  }

  ASSERT(false);
  return functions_by_seg.front().front();  // to avoid error
}

/*!
 * Get the function starting at this label, or nullptr if there is none.
 */
Function* LinkedObjectFile::try_get_function_at_label(int label_id) {
  const auto& label = labels.at(label_id);
  return try_get_function_at_label(label);
}

Function* LinkedObjectFile::try_get_function_at_label(const DecompilerLabel& label) {
  for (auto& func : functions_by_seg.at(label.target_segment)) {
    // + 4 to skip past type tag to the first word, which is where the label points.
    if (func.start_word * 4 + 4 == label.offset) {
      return &func;
    }
  }
  return nullptr;
}

const Function* LinkedObjectFile::try_get_function_at_label(int label_id) const {
  const auto& label = labels.at(label_id);
  return try_get_function_at_label(label);
}

const Function* LinkedObjectFile::try_get_function_at_label(const DecompilerLabel& label) const {
  for (auto& func : functions_by_seg.at(label.target_segment)) {
    // + 4 to skip past type tag to the first word, which is where the label points.
    if (func.start_word * 4 + 4 == label.offset) {
      return &func;
    }
  }
  return nullptr;
}

/*!
 * Get the name of the label.
 */
std::string LinkedObjectFile::get_label_name(int label_id) const {
  return labels.at(label_id).name;
}

/*!
 * Add link information that a word is a pointer to another word.
 */
bool LinkedObjectFile::pointer_link_word(int source_segment,
                                         int source_offset,
                                         int dest_segment,
                                         int dest_offset) {
  ASSERT((source_offset % 4) == 0);

  auto& word = words_by_seg.at(source_segment).at(source_offset / 4);
  ASSERT(word.kind() == LinkedWord::PLAIN_DATA);

  if (dest_offset / 4 > (int)words_by_seg.at(dest_segment).size()) {
    //    printf("HACK bad link ignored src %d, %d vs %d!\n", source_offset, dest_offset / 4,
    //           int(words_by_seg.at(dest_segment).size()));
    return false;
  }
  ASSERT(dest_offset / 4 <= (int)words_by_seg.at(dest_segment).size());

  word.set_to_pointer(LinkedWord::PTR, get_label_id_for(dest_segment, dest_offset));
  return true;
}

/*!
 * Add link information that a word is linked to a symbol/type/empty list.
 */
void LinkedObjectFile::symbol_link_word(int source_segment,
                                        int source_offset,
                                        const char* name,
                                        LinkedWord::Kind kind) {
  ASSERT((source_offset % 4) == 0);
  auto& word = words_by_seg.at(source_segment).at(source_offset / 4);
  //  ASSERT(word.kind == LinkedWord::PLAIN_DATA);
  if (word.kind() != LinkedWord::PLAIN_DATA) {
    printf("bad symbol link word\n");
  }
  if (kind == LinkedWord::EMPTY_PTR) {
    word.set_to_empty_ptr();
  } else {
    word.set_to_symbol(kind, name);
  }
}

/*!
 * Add link information that a word's lower 16 bits are the offset of the given symbol relative to
 * the symbol table register.
 */
void LinkedObjectFile::symbol_link_offset(int source_segment,
                                          int source_offset,
                                          const char* name,
                                          bool subtract_one) {
  ASSERT((source_offset % 4) == 0);
  auto& word = words_by_seg.at(source_segment).at(source_offset / 4);
  ASSERT(word.kind() == LinkedWord::PLAIN_DATA);
  word.set_to_symbol(subtract_one ? LinkedWord::SYM_VAL_OFFSET : LinkedWord::SYM_OFFSET, name);
}

/*!
 * Add link information that a lui/ori pair will load a pointer.
 */
void LinkedObjectFile::pointer_link_split_word(int source_segment,
                                               int source_hi_offset,
                                               int source_lo_offset,
                                               int dest_segment,
                                               int dest_offset) {
  ASSERT((source_hi_offset % 4) == 0);
  ASSERT((source_lo_offset % 4) == 0);

  auto& hi_word = words_by_seg.at(source_segment).at(source_hi_offset / 4);
  auto& lo_word = words_by_seg.at(source_segment).at(source_lo_offset / 4);

  //  ASSERT(dest_offset / 4 <= (int)words_by_seg.at(dest_segment).size());
  ASSERT(hi_word.kind() == LinkedWord::PLAIN_DATA);
  ASSERT(lo_word.kind() == LinkedWord::PLAIN_DATA);

  hi_word.set_to_pointer(LinkedWord::HI_PTR, get_label_id_for(dest_segment, dest_offset));
  lo_word.set_to_pointer(LinkedWord::LO_PTR, hi_word.label_id());
}

/*!
 * Rename the labels so they are named L1, L2, ..., in the order of the addresses that they refer
 * to. Will clear any custom label names.
 */
uint32_t LinkedObjectFile::set_ordered_label_names() {
  std::vector<int> indices(labels.size());
  std::iota(indices.begin(), indices.end(), 0);

  std::sort(indices.begin(), indices.end(), [&](int a, int b) {
    auto& la = labels.at(a);
    auto& lb = labels.at(b);
    if (la.target_segment == lb.target_segment) {
      return la.offset < lb.offset;
    }
    return la.target_segment < lb.target_segment;
  });

  for (size_t i = 0; i < indices.size(); i++) {
    auto& label = labels.at(indices[i]);
    label.name = "L" + std::to_string(i + 1);
  }

  return labels.size();
}

static const char* segment_names[] = {"main segment", "debug segment", "top-level segment"};

/*!
 * Print all the words, with link information and labels.
 */
std::string LinkedObjectFile::print_words() {
  std::string result;

  ASSERT(segments <= 3);
  for (int seg = segments; seg-- > 0;) {
    // segment header
    result += ";------------------------------------------\n;  ";
    result += segment_names[seg];
    result += "\n;------------------------------------------\n";

    // print each word in the segment
    for (size_t i = 0; i < words_by_seg.at(seg).size(); i++) {
      for (int j = 0; j < 4; j++) {
        auto label_id = get_label_at(seg, i * 4 + j);
        if (label_id != -1) {
          result += labels.at(label_id).name + ":";
          if (j != 0) {
            result += " (offset " + std::to_string(j) + ")";
          }
          result += "\n";
        }
      }

      auto& word = words_by_seg[seg][i];
      append_word_to_string(result, word);

      if (word.kind() == LinkedWord::TYPE_PTR && word.symbol_name() == "string") {
        result += "; " + get_goal_string(seg, i) + "\n";
      }
    }
  }

  return result;
}

/*!
 * Add a word's printed representation to the end of a string. Internal helper for print_words.
 */
void LinkedObjectFile::append_word_to_string(std::string& dest, const LinkedWord& word) const {
  char buff[128];

  switch (word.kind()) {
    case LinkedWord::PLAIN_DATA:
      sprintf(buff, "    .word 0x%x\n", word.data);
      break;
    case LinkedWord::PTR:
      sprintf(buff, "    .word %s\n", labels.at(word.label_id()).name.c_str());
      break;
    case LinkedWord::SYM_PTR:
      sprintf(buff, "    .symbol %s\n", word.symbol_name().c_str());
      break;
    case LinkedWord::TYPE_PTR:
      sprintf(buff, "    .type %s\n", word.symbol_name().c_str());
      break;
    case LinkedWord::EMPTY_PTR:
      sprintf(buff, "    .empty-list\n");  // ?
      break;
    case LinkedWord::HI_PTR:
      sprintf(buff, "    .ptr-hi 0x%x %s\n", word.data >> 16,
              labels.at(word.label_id()).name.c_str());
      break;
    case LinkedWord::LO_PTR:
      sprintf(buff, "    .ptr-lo 0x%x %s\n", word.data >> 16,
              labels.at(word.label_id()).name.c_str());
      break;
    case LinkedWord::SYM_OFFSET:
      sprintf(buff, "    .sym-off 0x%x %s\n", word.data >> 16, word.symbol_name().c_str());
      break;
    case LinkedWord::SYM_VAL_OFFSET:
      sprintf(buff, "    .sym-val-off 0x%x %s\n", word.data >> 16, word.symbol_name().c_str());
      break;
    default:
      throw std::runtime_error("nyi");
  }

  dest += buff;
}

/*!
 * For each segment, determine where the data area starts.  Before the data area is the code area.
 */
void LinkedObjectFile::find_code() {
  if (segments == 1) {
    // single segment object files should never have any code.
    auto& seg = words_by_seg.front();
    for (auto& word : seg) {
      if (word.kind() == LinkedWord::TYPE_PTR) {
        ASSERT(word.symbol_name() != "function");
      }
    }
    offset_of_data_zone_by_seg.at(0) = 0;
    stats.data_bytes = words_by_seg.front().size() * 4;
    stats.code_bytes = 0;

  } else if (segments == 3) {
    // V3 object files will have all the functions, then all the static data.  So to find the
    // divider, we look for the last "function" tag, then find the last jr $ra instruction after
    // that (plus one for delay slot) and assume that after that is data.  Additionally, we check to
    // make sure that there are no "function" type tags in the data section, although this is
    // redundant.
    for (int i = 0; i < segments; i++) {
      // try to find the last reference to "function":
      bool found_function = false;
      size_t function_loc = -1;
      for (size_t j = words_by_seg.at(i).size(); j-- > 0;) {
        auto& word = words_by_seg.at(i).at(j);
        if (word.kind() == LinkedWord::TYPE_PTR && word.symbol_name() == "function") {
          function_loc = j;
          found_function = true;
          break;
        }
      }

      if (found_function) {
        // look forward until we find "jr ra"
        const uint32_t jr_ra = 0x3e00008;
        bool found_jr_ra = false;
        size_t jr_ra_loc = -1;

        for (size_t j = function_loc; j < words_by_seg.at(i).size(); j++) {
          auto& word = words_by_seg.at(i).at(j);
          if (word.kind() == LinkedWord::PLAIN_DATA && word.data == jr_ra) {
            found_jr_ra = true;
            jr_ra_loc = j;
          }
        }

        ASSERT(found_jr_ra);
        ASSERT(jr_ra_loc + 1 < words_by_seg.at(i).size());
        offset_of_data_zone_by_seg.at(i) = jr_ra_loc + 2;

      } else {
        // no functions
        offset_of_data_zone_by_seg.at(i) = 0;
      }

      // add label for debug purposes
      if (offset_of_data_zone_by_seg.at(i) < words_by_seg.at(i).size()) {
        auto data_label_id = get_label_id_for(i, 4 * (offset_of_data_zone_by_seg.at(i)));
        labels.at(data_label_id).name = "L-data-start";
      }

      // verify there are no functions after the data section starts
      for (size_t j = offset_of_data_zone_by_seg.at(i); j < words_by_seg.at(i).size(); j++) {
        auto& word = words_by_seg.at(i).at(j);
        if (word.kind() == LinkedWord::TYPE_PTR && word.symbol_name() == "function") {
          ASSERT(false);
        }
      }

      // sizes:
      stats.data_bytes += 4 * (words_by_seg.at(i).size() - offset_of_data_zone_by_seg.at(i)) * 4;
      stats.code_bytes += 4 * offset_of_data_zone_by_seg.at(i);
    }
  } else {
    // for files which we couldn't extract link data yet, they will have 0 segments and its ok.
    ASSERT(segments == 0);
  }
}

/*!
 * Find all the functions in each segment.
 */
void LinkedObjectFile::find_functions(GameVersion version) {
  if (segments == 1) {
    // it's a v2 file, shouldn't have any functions
    ASSERT(offset_of_data_zone_by_seg.at(0) == 0);
  } else {
    // we assume functions don't have any data in between them, so we use the "function" type tag to
    // mark the end of the previous function and the start of the next.  This means that some
    // functions will have a few 0x0 words after then for padding (GOAL functions are aligned), but
    // this is something that the disassembler should handle.
    for (int seg = 0; seg < segments; seg++) {
      // start at the end and work backward...
      int function_end = offset_of_data_zone_by_seg.at(seg);
      while (function_end > 0) {
        // back up until we find function type tag
        int function_tag_loc = function_end;
        bool found_function_tag_loc = false;
        for (; function_tag_loc-- > 0;) {
          auto& word = words_by_seg.at(seg).at(function_tag_loc);
          if (word.kind() == LinkedWord::TYPE_PTR && word.symbol_name() == "function") {
            found_function_tag_loc = true;
            break;
          }
        }

        // mark this as a function, and try again from the current function start
        ASSERT(found_function_tag_loc);
        stats.function_count++;
        functions_by_seg.at(seg).emplace_back(function_tag_loc, function_end, version);
        function_end = function_tag_loc;
      }

      std::reverse(functions_by_seg.at(seg).begin(), functions_by_seg.at(seg).end());
    }
  }
}

/*!
 * Run the disassembler on all functions.
 */
void LinkedObjectFile::disassemble_functions() {
  for (int seg = 0; seg < segments; seg++) {
    for (auto& function : functions_by_seg.at(seg)) {
      for (auto word = function.start_word; word < function.end_word; word++) {
        // decode!
        function.instructions.push_back(
            decode_instruction(words_by_seg.at(seg).at(word), *this, seg, word));
        if (function.instructions.back().is_valid()) {
          stats.decoded_ops++;
        } else {
          lg::error("Failed to decode op: 0x{:08x}", words_by_seg.at(seg).at(word).data);
        }
      }
    }
  }
}

/*!
 * Analyze disassembly for use of the FP register, and add labels for fp-relative data access
 */
void LinkedObjectFile::process_fp_relative_links() {
  for (int seg = 0; seg < segments; seg++) {
    for (auto& function : functions_by_seg.at(seg)) {
      for (size_t instr_idx = 0; instr_idx < function.instructions.size(); instr_idx++) {
        // we possibly need to look at three instructions
        auto& instr = function.instructions[instr_idx];
        auto* prev_instr = (instr_idx > 0) ? &function.instructions[instr_idx - 1] : nullptr;
        auto* pprev_instr = (instr_idx > 1) ? &function.instructions[instr_idx - 2] : nullptr;

        // ignore storing FP onto the stack
        if ((instr.kind == InstructionKind::SD || instr.kind == InstructionKind::SQ) &&
            instr.get_src(0).get_reg() == Register(Reg::GPR, Reg::FP)) {
          continue;
        }

        // HACKs
        if (instr.kind == InstructionKind::PEXTLW) {
          continue;
        }

        // search over instruction sources
        for (int i = 0; i < instr.n_src; i++) {
          auto& src = instr.src[i];
          if (src.kind == InstructionAtom::REGISTER     // must be reg
              && src.get_reg().get_kind() == Reg::GPR   // gpr
              && src.get_reg().get_gpr() == Reg::FP) {  // fp reg.

            stats.n_fp_reg_use++;

            // offset of fp at this instruction.
            int current_fp = 4 * (function.start_word + 1);
            function.uses_fp_register = true;

            switch (instr.kind) {
              // fp-relative load
              case InstructionKind::LW:
              case InstructionKind::LWC1:
              case InstructionKind::LD:
              // generate pointer to fp-relative data
              case InstructionKind::DADDIU: {
                auto& atom = instr.get_imm_src();
                atom.set_label(get_label_id_for(seg, current_fp + atom.get_imm()));
                stats.n_fp_reg_use_resolved++;
              } break;

              // in the case that addiu doesn't have enough range (+/- 2^15), GOAL has two
              // strategies: 1). use ori + daddu (ori doesn't sign extend, so this lets us go +2^16,
              // -0) 2). use lui + ori + daddu (can reach anywhere in the address space) It seems
              // that addu is used to get pointers to floating point values and daddu is used in
              // other cases. Also, the position of the fp register is swapped between the two.
              case InstructionKind::DADDU:
              case InstructionKind::ADDU: {
                ASSERT(prev_instr);
                if (prev_instr->kind == InstructionKind::ORI) {
                  ASSERT(prev_instr->kind == InstructionKind::ORI);
                  int offset_reg_src_id = instr.kind == InstructionKind::DADDU ? 0 : 1;
                  auto offset_reg = instr.get_src(offset_reg_src_id).get_reg();
                  ASSERT(offset_reg == prev_instr->get_dst(0).get_reg());
                  ASSERT(offset_reg == prev_instr->get_src(0).get_reg());
                  auto& atom = prev_instr->get_imm_src();
                  int additional_offset = 0;
                  if (pprev_instr && pprev_instr->kind == InstructionKind::LUI) {
                    ASSERT(pprev_instr->get_dst(0).get_reg() == offset_reg);
                    additional_offset = (1 << 16) * pprev_instr->get_imm_src().get_imm();
                    pprev_instr->get_imm_src().set_label(
                        get_label_id_for(seg, current_fp + atom.get_imm() + additional_offset));
                  }
                  atom.set_label(
                      get_label_id_for(seg, current_fp + atom.get_imm() + additional_offset));
                  stats.n_fp_reg_use_resolved++;
                } else if (prev_instr->kind == InstructionKind::DADDIU) {
                  /*
                   * Jak 2 has a new use of fp to access elements of a static array that looks like
                   * this:
                   *     (set! v1 (* idx stride))
                   *     daddiu v1, v1, 8128
                   *     daddu v1, v1, fp
                   */
                  auto val_plus_off_reg = prev_instr->get_dst(0).get_reg();

                  // it's possible that this isn't always the case, but works for all of jak 2
                  ASSERT(val_plus_off_reg == prev_instr->get_src(0).get_reg());
                  ASSERT(val_plus_off_reg == instr.get_src(0).get_reg());
                  ASSERT(val_plus_off_reg == instr.get_dst(0).get_reg());
                  auto& atom = prev_instr->get_imm_src();
                  atom.set_label(get_label_id_for(seg, current_fp + atom.get_imm()));

                  stats.n_fp_reg_use_resolved++;
                } else {
                  lg::error("Failed to process fp relative links for (d)addu preceded by: {}",
                            prev_instr->to_string(labels));
                  return;
                }

              } break;

              default:
                ASSERT_MSG(false,
                           fmt::format("unknown fp using op: {}", instr.to_string(labels).c_str()));
            }
          }
        }
      }
    }
  }
}

std::string LinkedObjectFile::print_function_disassembly(Function& func,
                                                         int seg,
                                                         bool write_hex,
                                                         const std::string& extra_name) {
  std::string result;
  result += ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n";
  result += "; .function " + func.name() + " " + extra_name + "\n";
  result += ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n";
  result += func.prologue.to_string(2) + "\n";
  if (func.warnings.has_warnings()) {
    result += ";; Warnings:\n" + func.warnings.get_warning_text(true) + "\n";
  }

  // print each instruction in the function.
  bool in_delay_slot = false;

  for (int i = 1; i < func.end_word - func.start_word; i++) {
    auto label_id = get_label_at(seg, (func.start_word + i) * 4);
    if (label_id != -1) {
      result += labels.at(label_id).name + ":\n";
    }

    for (int j = 1; j < 4; j++) {
      //          ASSERT(get_label_at(seg, (func.start_word + i)*4 + j) == -1);
      if (get_label_at(seg, (func.start_word + i) * 4 + j) != -1) {
        result += "BAD OFFSET LABEL: ";
        result += labels.at(get_label_at(seg, (func.start_word + i) * 4 + j)).name + "\n";
        ASSERT(false);
      }
    }

    auto& instr = func.instructions.at(i);
    std::string line = "    " + instr.to_string(labels);

    if (write_hex) {
      if (line.length() < 60) {
        line.append(60 - line.length(), ' ');
      }
      result += line;
      result += " ;;";
      auto& word = words_by_seg[seg].at(func.start_word + i);
      append_word_to_string(result, word);
    } else {
      result += line;
      result += '\n';
    }

    if (in_delay_slot) {
      result += "\n";
      in_delay_slot = false;
    }

    if (gOpcodeInfo[(int)instr.kind].has_delay_slot) {
      in_delay_slot = true;
    }
  }
  result += "\n";
  //
  //      int bid = 0;
  //      for(auto& bblock : func.basic_blocks) {
  //        result += "BLOCK " + std::to_string(bid++)+ "\n";
  //        for(int i = bblock.start_word; i < bblock.end_word; i++) {
  //          if(i >= 0 && i < func.instructions.size()) {
  //            result += func.instructions.at(i).to_string(*this) + "\n";
  //          } else {
  //            result += "BAD BBLOCK INSTR ID " + std::to_string(i);
  //          }
  //        }
  //      }

  // hack
  if (func.cfg && !func.cfg->is_fully_resolved()) {
    result += func.cfg->to_dot();
    result += "\n";
  }
  if (func.cfg) {
    result += func.cfg->to_form_string() + "\n";

    // To debug block stuff.
    /*
    int bid = 0;
    for(auto& block : func.basic_blocks) {
      in_delay_slot = false;
      result += "B" + std::to_string(bid++) + "\n";
      for(auto i = block.start_word; i < block.end_word; i++) {
        auto label_id = get_label_at(seg, (func.start_word + i) * 4);
        if (label_id != -1) {
          result += labels.at(label_id).name + ":\n";
        }
        auto& instr = func.instructions.at(i);
        result += "    " + instr.to_string(*this) + "\n";
        if (in_delay_slot) {
          result += "\n";
          in_delay_slot = false;
        }

        if (gOpcodeInfo[(int)instr.kind].has_delay_slot) {
          in_delay_slot = true;
        }
      }
    }
     */
  }

  result += "\n\n\n";
  return result;
}

std::string LinkedObjectFile::print_asm_function_disassembly(const std::string& my_name) {
  std::string result;
  for (int seg = segments; seg-- > 0;) {
    bool got_in_seg = false;
    for (auto& func : functions_by_seg.at(seg)) {
      if (func.suspected_asm) {
        if (!got_in_seg) {
          result += ";------------------------------------------\n;  ";
          result += segment_names[seg];
          result += " of " + my_name;
          result += "\n;------------------------------------------\n\n";
          got_in_seg = true;
        }
        result += print_function_disassembly(func, seg, false, my_name);
      }
    }
  }

  return result;
}

/*!
 * Print disassembled functions and data segments.
 */
std::string LinkedObjectFile::print_disassembly(bool write_hex) {
  std::string result;

  ASSERT(segments <= 3);
  for (int seg = segments; seg-- > 0;) {
    // segment header
    result += ";------------------------------------------\n;  ";
    result += segment_names[seg];
    result += "\n;------------------------------------------\n\n";

    // functions
    for (auto& func : functions_by_seg.at(seg)) {
      result += print_function_disassembly(func, seg, write_hex, "");
    }

    // print data
    for (size_t i = offset_of_data_zone_by_seg.at(seg); i < words_by_seg.at(seg).size(); i++) {
      for (int j = 0; j < 4; j++) {
        auto label_id = get_label_at(seg, i * 4 + j);
        if (label_id != -1) {
          result += labels.at(label_id).name + ":";
          if (j != 0) {
            result += " (offset " + std::to_string(j) + ")";
          }
          result += "\n";
        }
      }

      auto& word = words_by_seg[seg][i];
      append_word_to_string(result, word);

      if (word.kind() == LinkedWord::TYPE_PTR && word.symbol_name() == "string") {
        result += "; " + get_goal_string(seg, i) + "\n";
      }
    }
  }

  return result;
}

/*!
 * Hacky way to get a GOAL string object
 */
std::string LinkedObjectFile::get_goal_string(int seg, int word_idx, bool with_quotes) const {
  std::string result;
  if (with_quotes) {
    result += "\"";
  }
  // next should be the size
  if (word_idx + 1 >= int(words_by_seg[seg].size())) {
    return "invalid string!\n";
  }
  const LinkedWord& size_word = words_by_seg[seg].at(word_idx + 1);
  if (size_word.kind() != LinkedWord::PLAIN_DATA) {
    // sometimes an array of string pointer triggers this!
    return "invalid string!\n";
  }

  //  result += "(size " + std::to_string(size_word.data) + "): ";
  // now characters...
  for (size_t i = 0; i < size_word.data; i++) {
    int word_offset = word_idx + 2 + (i / 4);
    int byte_offset = i % 4;
    auto& word = words_by_seg[seg].at(word_offset);
    if (word.kind() != LinkedWord::PLAIN_DATA) {
      return "invalid string! (check me!)\n";
    }
    char cword[4];
    memcpy(cword, &word.data, 4);
    result += cword[byte_offset];
    if (result.back() == 0) {
      return "invalid string! (check me!)";
    }
  }
  if (with_quotes) {
    result += "\"";
  }
  return result;
}

/*!
 * Return true if the object file contains any functions at all.
 */
bool LinkedObjectFile::has_any_functions() {
  for (auto& fv : functions_by_seg) {
    if (!fv.empty())
      return true;
  }
  return false;
}

/*!
 * Print all scripts in this file.
 */
std::string LinkedObjectFile::print_scripts() {
  std::string result;
  for (int seg = 0; seg < segments; seg++) {
    std::vector<bool> already_printed(words_by_seg[seg].size(), false);

    // the linked list layout algorithm of GOAL puts the first pair first.
    // so we want to go in forward order to catch the beginning correctly
    for (size_t word_idx = 0; word_idx < words_by_seg[seg].size(); word_idx++) {
      // don't print parts of scripts we've already seen
      // (note that scripts could share contents, which is supported, this is just for starting
      // off a script print)
      if (already_printed[word_idx])
        continue;

      // check for linked list by looking for anything that accesses this as a pair (offset of 2)
      auto label_id = get_label_at(seg, 4 * word_idx + 2);
      if (label_id != -1) {
        auto& label = labels.at(label_id);
        if ((label.offset & 7) == 2) {
          // result += to_form_script(seg, word_idx, already_printed)->toStringPretty(0, 100) +
          // "\n";
          result += pretty_print::to_string(to_form_script(seg, word_idx, &already_printed)) + "\n";
        }
      }
    }
  }
  return result;
}

/*!
 * Is the object pointed to the empty list?
 */
bool LinkedObjectFile::is_empty_list(int seg, int byte_idx) const {
  ASSERT((byte_idx % 4) == 0);
  auto& word = words_by_seg.at(seg).at(byte_idx / 4);
  return word.kind() == LinkedWord::EMPTY_PTR;
}

/*!
 * Convert a linked list to a Form for easy printing.
 * Note : this takes the address of the car of the pair. which is perhaps a bit confusing
 * (in GOAL, this would be (&-> obj car))
 */
goos::Object LinkedObjectFile::to_form_script(int seg,
                                              int word_idx,
                                              std::vector<bool>* seen) const {
  // the object to currently print. to start off, create pair from the car address we've been given.
  int goal_print_obj = word_idx * 4 + 2;

  // resulting form. we can't have a totally empty list (as an empty list looks like a symbol,
  // so it wouldn't be flagged), so it's safe to make this a pair.
  auto result =
      goos::PairObject::make_new(goos::Object::make_empty_list(), goos::Object::make_empty_list());

  // the current pair to fill out.
  auto fill = result;

  // loop until we run out of things to add
  for (;;) {
    // check the thing to print is a pair.
    if ((goal_print_obj & 7) == 2) {
      // first convert the car (again, with (&-> obj car))
      fill.as_pair()->car = to_form_script_object(seg, goal_print_obj - 2, seen);
      if (seen) {
        seen->at(goal_print_obj / 4) = true;
      }

      auto cdr_addr = goal_print_obj + 2;

      if (is_empty_list(seg, cdr_addr)) {
        // the list has ended!
        fill.as_pair()->cdr = goos::Object::make_empty_list();
        return result;
      } else {
        // cdr object should be aligned.
        ASSERT((cdr_addr % 4) == 0);
        auto& cdr_word = words_by_seg.at(seg).at(cdr_addr / 4);
        // check for proper list
        if (cdr_word.kind() == LinkedWord::PTR &&
            (labels.at(cdr_word.label_id()).offset & 7) == 2) {
          // yes, proper list. add another pair and link it in to the list.
          goal_print_obj = labels.at(cdr_word.label_id()).offset;
          fill.as_pair()->cdr = goos::PairObject::make_new(goos::Object::make_empty_list(),
                                                           goos::Object::make_empty_list());
          fill = fill.as_pair()->cdr;
        } else {
          // improper list, put the last thing in and end
          fill.as_pair()->cdr = to_form_script_object(seg, cdr_addr, seen);
          return result;
        }
      }
    } else {
      // improper list, should be impossible to get here because of earlier checks
      ASSERT(false);
    }
  }

  return result;
}

/*!
 * Is the thing pointed to a string?
 */
bool LinkedObjectFile::is_string(int seg, int byte_idx) const {
  if (byte_idx % 4) {
    return false;  // must be aligned pointer.
  }
  int type_tag_ptr = byte_idx - 4;
  // must fit in segment
  if (type_tag_ptr < 0 || size_t(type_tag_ptr) >= words_by_seg.at(seg).size() * 4) {
    return false;
  }
  int type_word_idx = type_tag_ptr / 4;
  auto& type_word = words_by_seg.at(seg).at(type_word_idx);
  if (type_word.kind() == LinkedWord::TYPE_PTR && type_word.symbol_name() == "string") {
    // could be a string basic
    // check if we're not right after a zero-length string array.
    if (type_word_idx >= 3) {
      auto& arr_type_word = words_by_seg.at(seg).at(type_word_idx - 3);
      auto& arr_len_word = words_by_seg.at(seg).at(type_word_idx - 2);
      auto& arr_alen_word = words_by_seg.at(seg).at(type_word_idx - 1);
      if (arr_type_word.kind() == LinkedWord::TYPE_PTR && arr_type_word.symbol_name() == "array" &&
          arr_len_word.kind() == LinkedWord::PLAIN_DATA && arr_len_word.data == 0 &&
          arr_alen_word.kind() == LinkedWord::PLAIN_DATA && arr_alen_word.data == 0) {
        return false;
      }
    }
    // seems good.
    return true;
  }
  return false;
}

/*!
 * Convert a (pointer object) to some nice representation.
 */
goos::Object LinkedObjectFile::to_form_script_object(int seg,
                                                     int byte_idx,
                                                     std::vector<bool>* seen) const {
  goos::Object result;

  switch (byte_idx & 7) {
    case 0:
    case 4: {
      auto& word = words_by_seg.at(seg).at(byte_idx / 4);
      if (word.kind() == LinkedWord::SYM_PTR) {
        // .symbol xxxx
        result = pretty_print::to_symbol(word.symbol_name());
      } else if (word.kind() == LinkedWord::PLAIN_DATA) {
        // .word xxxxx
        result = pretty_print::to_symbol(std::to_string(word.data));
      } else if (word.kind() == LinkedWord::PTR) {
        // might be a sub-list, or some other random pointer
        auto offset = labels.at(word.label_id()).offset;
        if ((offset & 7) == 2) {
          // list!
          result = to_form_script(seg, offset / 4, seen);
        } else {
          if (is_string(seg, offset)) {
            result = pretty_print::to_symbol(get_goal_string(seg, offset / 4 - 1));
          } else {
            // some random pointer, just print the label.
            result = pretty_print::to_symbol(labels.at(word.label_id()).name);
          }
        }
      } else if (word.kind() == LinkedWord::EMPTY_PTR) {
        result = goos::Object::make_empty_list();
      } else {
        std::string debug;
        append_word_to_string(debug, word);
        ASSERT_MSG(false, fmt::format("don't know how to print {}", debug.c_str()));
      }
    } break;

    case 2:  // bad, a pair snuck through.
    default:
      // pointers should be aligned!
      ASSERT_MSG(false, fmt::format("align {}", byte_idx & 7));
  }

  return result;
}

u32 LinkedObjectFile::read_data_word(const DecompilerLabel& label) {
  ASSERT(0 == (label.offset % 4));
  auto& word = words_by_seg.at(label.target_segment).at(label.offset / 4);
  ASSERT(word.kind() == LinkedWord::Kind::PLAIN_DATA);
  return word.data;
}

std::string LinkedObjectFile::get_goal_string_by_label(const DecompilerLabel& label) const {
  ASSERT(0 == (label.offset % 4));
  return get_goal_string(label.target_segment, (label.offset / 4) - 1, false);
}

const DecompilerLabel& LinkedObjectFile::get_label_by_name(const std::string& name) const {
  for (auto& label : labels) {
    if (label.name == name) {
      return label;
    }
  }
  throw std::runtime_error("Cannot find label " + name);
}
}  // namespace decompiler