data_race_test.h

Go to the documentation of this file.

// NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the
// software in any medium, provided that you keep intact this entire notice. You may improve, modify and create
// derivative works of the software or any portion of the software, and you may copy and distribute such modifications
// or works. Modified works should carry a notice stating that you changed the software and should note the date and
// nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the
// source of the software. NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND,
// EXPRESS, IMPLIED, IN FACT OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR
// WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE
// CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS
// THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE. You
// are solely responsible for determining the appropriateness of using and distributing the software and you assume
// all risks associated with its use, including but not limited to the risks and costs of program errors, compliance
// with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of
// operation. This software is not intended to be used in any situation where a failure could cause risk of injury or
// damage to property. The software developed by NIST employees is not subject to copyright protection within the
// United States.
 
#ifndef HEDGEHOG_CX_DATA_RACE_TEST_H_
#define HEDGEHOG_CX_DATA_RACE_TEST_H_
 
#ifdef HH_ENABLE_HH_CX
#include "abstract_test.h"
 
namespace hh_cx {
 
template<tool::HedgehogDynamicGraphForStaticAnalysis GraphType>
class DataRaceTest : public hh_cx::AbstractTest<GraphType> {
 public:
  constexpr DataRaceTest() : AbstractTest<GraphType>("DataRaceTest") {}
 
  constexpr ~DataRaceTest() override = default;
 
  constexpr void test(hh_cx::Graph<GraphType> const *graph) override {
    auto &registeredNodes = graph->registeredNodes();
 
    for (size_t senderId = 0; senderId < registeredNodes.size(); ++senderId) {
      tool::TypesNodesMap map{};
      auto senderNode = graph->node(senderId);
      for (size_t receiverId = 0; receiverId < graph->adjacentNodesTypes(senderNode).size(); ++receiverId) {
        for (auto &type : graph->adjacentNodesTypes(senderNode).at(receiverId)) {
          map.insert(type, graph->node(receiverId));
        }
      }
      for (auto const &type : map.types()) {
        if (map.nodes(type).size() > 1) {
          bool isOutputSafe = true;
          for (auto const &receiverNode : map.nodes(type)) {
            isOutputSafe &= (
                graph->isROLinked(senderNode, receiverNode, type)
                    || graph->isConstLinked(senderNode, receiverNode, type)
            );
          }
          if (!isOutputSafe) {
            if (this->errorMessage().empty()) { this->appendErrorMessage("Possible data races found:\n"); }
            for (auto &receiverNode : map.nodes(type)) {
              this->appendErrorMessage("\t");
              this->appendErrorMessage(senderNode->name());
              this->appendErrorMessage(" -> ");
              this->appendErrorMessage(receiverNode->name());
              this->appendErrorMessage(" (");
              this->appendErrorMessage(type);
              this->appendErrorMessage(")\n");
            }
          }
        }
      }
    }
 
    if (!this->errorMessage().empty()) {
      this->graphValid(false);
    }
  }
};
 
} // hh_cx
#endif //HH_ENABLE_HH_CX
#endif //HEDGEHOG_CX_DATA_RACE_TEST_H_