mpact/sim/decoder/instruction_encoding.cc

// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include "mpact/sim/decoder/instruction_encoding.h"

#include <cstdint>
#include <string>

#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "absl/strings/str_cat.h"
#include "mpact/sim/decoder/bin_format_visitor.h"
#include "mpact/sim/decoder/format.h"

namespace mpact {
namespace sim {
namespace decoder {
namespace bin_format {

InstructionEncoding::InstructionEncoding(std::string name, Format *format)
    : name_(name), format_(format) {
  if (format) format_name_ = format->name();
}

// Custom copy constructor.
InstructionEncoding::InstructionEncoding(const InstructionEncoding &encoding)
    : name_(encoding.name_),
      format_name_(encoding.format_name_),
      format_(encoding.format_),
      mask_set_(encoding.mask_set_),
      mask_(encoding.mask_),
      other_mask_(encoding.other_mask_),
      extracted_mask_(encoding.extracted_mask_),
      value_(encoding.value_) {
  // Copy construct each of the constraints.
  for (auto *constraint : encoding.equal_constraints_) {
    equal_constraints_.push_back(new Constraint(*constraint));
  }
  for (auto *constraint : encoding.equal_extracted_constraints_) {
    equal_extracted_constraints_.push_back(new Constraint(*constraint));
  }
  for (auto *constraint : encoding.other_constraints_) {
    other_constraints_.push_back(new Constraint(*constraint));
  }
}

absl::StatusOr<Constraint *> InstructionEncoding::CreateConstraint(
    ConstraintType type, std::string lhs_name, std::string rhs_name) {
  Constraint constraint;
  constraint.type = type;
  // Check if the field name is indeed a field.
  auto *lhs_field = format_->GetField(lhs_name);
  if (lhs_field != nullptr) {
    if (lhs_field->width >= 64) {
      return absl::OutOfRangeError(absl::StrCat(
          "Field '", lhs_field->name,
          "' is too wide to create constraint - ust be <= 64 bits"));
    }
    constraint.field = lhs_field;
  } else {
    // If not a field, is it an overlay?
    auto *lhs_overlay = format_->GetOverlay(lhs_name);
    if (lhs_overlay == nullptr) {
      // If neither, it's an error.
      return absl::NotFoundError(absl::StrCat(
          "Format '", format_->name(),
          "' does not contain a field or overlay named ", lhs_name));
    }
    constraint.overlay = lhs_overlay;
  }
  // Check if the field name is indeed a field.
  auto *rhs_field = format_->GetField(rhs_name);
  if (rhs_field != nullptr) {
    if (rhs_field->width >= 64) {
      return absl::OutOfRangeError(absl::StrCat(
          "Field '", rhs_field->name,
          "' is too wide to create constraint - ust be <= 64 bits"));
    }
    constraint.rhs_field = rhs_field;
  } else {
    // If not a field, is it an overlay?
    auto *rhs_overlay = format_->GetOverlay(rhs_name);
    if (rhs_overlay == nullptr) {
      // If neither, it's an error.
      return absl::NotFoundError(absl::StrCat(
          "Format '", format_->name(),
          "' does not contain a field or overlay named ", rhs_name));
    }
    constraint.rhs_overlay = rhs_overlay;
  }
  Constraint *result = new Constraint(constraint);
  return result;
}

absl::StatusOr<Constraint *> InstructionEncoding::CreateConstraint(
    ConstraintType type, std::string field_name, int64_t value) {
  // Check if the field name is indeed a field.
  auto *field = format_->GetField(field_name);
  if (field != nullptr) {
    if (field->width >= 64) {
      return absl::OutOfRangeError(absl::StrCat(
          "Field '", field->name,
          "' is too wide to create constraint - ust be <= 64 bits"));
    }
    bool is_signed = field->is_signed;
    if (!is_signed) {
      if ((value < 0) || (value >= (1ULL << field->width))) {
        return absl::OutOfRangeError(absl::StrCat(
            "Constraint value (", value, ") out of range for unsigned field '",
            field_name, "'"));
      }
    } else {  // Field is signed.
      // Only eq and ne constraints are allowed on signed fields.
      if (type != ConstraintType::kEq && type != ConstraintType::kNe) {
        return absl::InvalidArgumentError(
            absl::StrCat("Only eq and ne constraints allowed on signed field: ",
                         field_name));
      }
      // Check that the value is in range.
      if (value < 0) {
        int64_t min_value = -(1 << (field->width - 1));
        if (value < min_value) {
          return absl::OutOfRangeError(absl::StrCat(
              "Constraint value (", value, ") out of range for signed field '",
              field_name, "'"));
        }
      } else {
        if (value >= (1 << (field->width - 1))) {
          return absl::OutOfRangeError(absl::StrCat(
              "Constraint value (", value, ") out of range for signed field '",
              field_name, "'"));
        }
      }
    }
    value &= (1 << field->width) - 1;
    auto *constraint = new Constraint();
    constraint->type = type;
    constraint->field = field;
    constraint->value = value;
    return constraint;
  }
  // If not a field, is it an overlay?
  auto *overlay = format_->GetOverlay(field_name);
  if (overlay == nullptr) {
    // If neither, it's an error.
    return absl::NotFoundError(absl::StrCat(
        "Format '", format_->name(),
        "' does not contain a field or overlay named ", field_name));
  }
  int width = overlay->computed_width();
  bool is_signed = overlay->is_signed();
  if (!is_signed) {
    if ((value >= (1 << width)) || (value < 0)) {
      return absl::OutOfRangeError(absl::StrCat(
          "Constraint value exceeds field width for field '", field_name, "'"));
    }
  } else {
    if (type != ConstraintType::kEq && type != ConstraintType::kNe) {
      return absl::InvalidArgumentError(
          absl::StrCat("Only eq and ne constraints allowed on signed overlay: ",
                       field_name));
    }  // Check that the value is in range.
    if (value < 0) {
      int64_t min_value = -(1 << (width - 1));
      if (value < min_value) {
        return absl::OutOfRangeError(absl::StrCat(
            "Constraint value (", value, ") out of range for signed overlay '",
            field_name, "'"));
      }
      value = value & ((1 << width) - 1);
    } else {
      if (value >= (1 << (width - 1))) {
        return absl::OutOfRangeError(absl::StrCat(
            "Constraint value (", value, ") out of range for signed overlay '",
            field_name, "'"));
      }
    }
  }
  value &= (1 << width) - 1;
  auto *constraint = new Constraint();
  constraint->type = type;
  constraint->overlay = overlay;
  constraint->value = value;

  return constraint;
}

InstructionEncoding::~InstructionEncoding() {
  for (auto *constraint : equal_constraints_) {
    delete constraint;
  }
  equal_constraints_.clear();
  for (auto *constraint : equal_extracted_constraints_) {
    delete constraint;
  }
  equal_extracted_constraints_.clear();
  for (auto *constraint : other_constraints_) {
    delete constraint;
  }
  other_constraints_.clear();
}

absl::Status InstructionEncoding::AddEqualConstraint(std::string field_name,
                                                     int64_t value) {
  // Invalidate the computed masks and values when a new constraint is added.
  mask_set_ = false;
  auto res = CreateConstraint(ConstraintType::kEq, field_name, value);
  if (!res.ok()) return res.status();
  auto *constraint = res.value();
  if ((constraint->overlay != nullptr) &&
      constraint->overlay->must_be_extracted()) {
    // If the value is not 100% based on extracted bits (i.e., it is an
    // overlay that has constant bits concatenated, then the value cannot be
    // compared directly against a masked value of the instruction, but have
    // to use an extractor for the overlay first.
    equal_extracted_constraints_.push_back(constraint);
  } else {
    equal_constraints_.push_back(constraint);
  }
  return absl::OkStatus();
}

absl::Status InstructionEncoding::AddOtherConstraint(ConstraintType type,
                                                     std::string field_name,
                                                     int64_t value) {
  auto res = CreateConstraint(type, field_name, value);
  if (!res.ok()) return res.status();
  auto *constraint = res.value();
  other_constraints_.push_back(constraint);
  return absl::OkStatus();
}

absl::Status InstructionEncoding::AddOtherConstraint(
    ConstraintType type, const std::string &lhs_name,
    const std::string &rhs_name) {
  auto res = CreateConstraint(type, lhs_name, rhs_name);
  if (!res.ok()) return res.status();
  auto *constraint = res.value();
  other_constraints_.push_back(constraint);
  return absl::OkStatus();
}

absl::Status InstructionEncoding::ComputeMaskAndValue() {
  // First consider equal constraints.
  mask_ = 0;
  for (auto *constraint : equal_constraints_) {
    uint64_t mask = 0;
    uint64_t value = 0;
    if (constraint->field != nullptr) {
      int width = constraint->field->width;
      mask = (1LLU << width) - 1;
      int shift = constraint->field->low;
      mask <<= shift;
      value = constraint->value << shift;
    } else {
      auto res = constraint->overlay->GetBitField(constraint->value);
      if (!res.ok()) return res.status();
      value = res.value();
      mask = constraint->overlay->mask();
    }
    value_ |= mask & value;
    mask_ |= mask;
  }
  // The overlays with bit constant concatenations.
  extracted_mask_ = 0;
  for (auto *constraint : equal_extracted_constraints_) {
    uint64_t mask = 0;
    if (constraint->field != nullptr) {
      int width = constraint->field->width;
      mask = (1LLU << width) - 1;
      int shift = constraint->field->low;
      mask <<= shift;
    } else {
      mask = constraint->overlay->mask();
    }
    extracted_mask_ |= mask;
  }
  // Other constraints.
  other_mask_ = 0;
  for (auto *constraint : other_constraints_) {
    uint64_t mask = 0;
    if (constraint->field != nullptr) {
      int width = constraint->field->width;
      mask = (1LLU << width) - 1;
      int shift = constraint->field->low;
      mask <<= shift;
    } else {
      mask = constraint->overlay->mask();
    }
    other_mask_ |= mask;
    // If the rhs is a field or overlay, add to the mask.
    if (constraint->rhs_field != nullptr) {
      int width = constraint->rhs_field->width;
      mask &= (1LLU << width) - 1;
      int shift = constraint->rhs_field->low;
      mask <<= shift;
      other_mask_ |= mask;
    } else if (constraint->rhs_overlay != nullptr) {
      mask &= constraint->rhs_overlay->mask();
      other_mask_ |= mask;
    }
  }
  mask_set_ = true;
  return absl::OkStatus();
}

uint64_t InstructionEncoding::GetMask() {
  if (!mask_set_) {
    auto result = ComputeMaskAndValue();
    if (!result.ok()) {
      format_->encoding_info()->error_listener()->semanticError(
          nullptr, "Internal Error in GetMask()");
    }
  }
  return mask_;
}

uint64_t InstructionEncoding::GetCombinedMask() {
  if (!mask_set_) {
    auto result = ComputeMaskAndValue();
    if (!result.ok()) {
      format_->encoding_info()->error_listener()->semanticError(
          nullptr, "Internal Error in GetCombinedMask()");
    }
  }
  return mask_ | extracted_mask_ | other_mask_;
}

uint64_t InstructionEncoding::GetValue() {
  if (!mask_set_) {
    auto result = ComputeMaskAndValue();
    if (!result.ok()) {
      format_->encoding_info()->error_listener()->semanticError(
          nullptr, "Internal Error in GetValue()");
    }
  }
  return value_;
}

}  // namespace bin_format
}  // namespace decoder
}  // namespace sim
}  // namespace mpact