verilog/analysis/checkers/forbidden_symbol_rule.cc

// Copyright 2017-2020 The Verible Authors.
//
// 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
//
//      http://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 "verilog/analysis/checkers/forbidden_symbol_rule.h"

#include <map>
#include <set>
#include <string>

#include "absl/strings/str_cat.h"
#include "absl/strings/string_view.h"
#include "common/analysis/citation.h"
#include "common/analysis/lint_rule_status.h"
#include "common/analysis/matcher/bound_symbol_manager.h"
#include "common/analysis/matcher/matcher.h"
#include "common/text/concrete_syntax_leaf.h"
#include "common/text/symbol.h"
#include "common/text/syntax_tree_context.h"
#include "common/text/token_info.h"
#include "common/util/container_util.h"
#include "verilog/analysis/descriptions.h"
#include "verilog/analysis/lint_rule_registry.h"

namespace verilog {
namespace analysis {

using verible::GetVerificationCitation;
using verible::container::FindWithDefault;

// Register ForbiddenSystemTaskFunctionRule
VERILOG_REGISTER_LINT_RULE(ForbiddenSystemTaskFunctionRule);

absl::string_view ForbiddenSystemTaskFunctionRule::Name() {
  return "invalid-system-task-function";
}
const char ForbiddenSystemTaskFunctionRule::kTopic[] =
    "forbidden-system-functions";

std::string ForbiddenSystemTaskFunctionRule::GetDescription(
    DescriptionType description_type) {
  return absl::StrCat(
      "Checks that no forbidden system tasks or functions are used. These "
      "consist of the following functions: ",
      Codify("$psprintf", description_type), ", ",
      Codify("$random", description_type), ", and ",
      Codify("$dist_*", description_type), ". ", "Also non-LRM function ",
      Codify("$srandom", description_type), ". See ",
      GetVerificationCitation(kTopic), ".");
}

// Set of invalid functions and suggested replacements
const std::map<std::string, std::string>&
ForbiddenSystemTaskFunctionRule::InvalidSymbolsMap() {
  static const auto* invalid_symbols = new std::map<std::string, std::string>({
      {"$psprintf", "$sformatf"},
      {"$random", "$urandom"},
      {"$srandom", "process::self().srandom()"},
      // $dist_* functions (LRM 20.15.2)
      {"$dist_chi_square", "$urandom"},
      {"$dist_erlang", "$urandom"},
      {"$dist_exponential", "$urandom"},
      {"$dist_normal", "$urandom"},
      {"$dist_poisson", "$urandom"},
      {"$dist_t", "$urandom"},
      {"$dist_uniform", "$urandom"},
  });
  return *invalid_symbols;
}

void ForbiddenSystemTaskFunctionRule::HandleSymbol(
    const verible::Symbol& symbol, const verible::SyntaxTreeContext& context) {
  verible::matcher::BoundSymbolManager manager;
  if (matcher_.Matches(symbol, &manager)) {
    if (auto leaf = manager.GetAs<verible::SyntaxTreeLeaf>("name")) {
      const auto& ism = InvalidSymbolsMap();
      if (ism.find(std::string(leaf->get().text())) != ism.end()) {
        violations_.insert(
            verible::LintViolation(leaf->get(), FormatReason(*leaf), context));
      }
    }
  }
}

verible::LintRuleStatus ForbiddenSystemTaskFunctionRule::Report() const {
  return verible::LintRuleStatus(violations_, Name(),
                                 GetVerificationCitation(kTopic));
}

std::string ForbiddenSystemTaskFunctionRule::FormatReason(
    const verible::SyntaxTreeLeaf& leaf) const {
  const auto function_name = std::string(leaf.get().text());
  const auto replacement =
      FindWithDefault(InvalidSymbolsMap(), function_name, "");
  auto message = function_name + " is a forbidden system function or task";
  if (!replacement.empty()) {
    message += ", please use " + replacement + " instead";
  }
  return message;
}
}  // namespace analysis
}  // namespace verilog