1753f127fSDimitry Andric //===- DebugSupport.cpp -----------------------------------------*- C++ -*-===// 2753f127fSDimitry Andric // 3753f127fSDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4753f127fSDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 5753f127fSDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6753f127fSDimitry Andric // 7753f127fSDimitry Andric //===----------------------------------------------------------------------===// 8753f127fSDimitry Andric // 9753f127fSDimitry Andric // This file defines functions which generate more readable forms of data 10753f127fSDimitry Andric // structures used in the dataflow analyses, for debugging purposes. 11753f127fSDimitry Andric // 12753f127fSDimitry Andric //===----------------------------------------------------------------------===// 13753f127fSDimitry Andric 14753f127fSDimitry Andric #include <utility> 15753f127fSDimitry Andric 16753f127fSDimitry Andric #include "clang/Analysis/FlowSensitive/DebugSupport.h" 17753f127fSDimitry Andric #include "clang/Analysis/FlowSensitive/Solver.h" 18753f127fSDimitry Andric #include "clang/Analysis/FlowSensitive/Value.h" 19bdd1243dSDimitry Andric #include "llvm/ADT/StringRef.h" 20753f127fSDimitry Andric #include "llvm/Support/ErrorHandling.h" 21753f127fSDimitry Andric 22753f127fSDimitry Andric namespace clang { 23753f127fSDimitry Andric namespace dataflow { 24753f127fSDimitry Andric 25bdd1243dSDimitry Andric llvm::StringRef debugString(Value::Kind Kind) { 26bdd1243dSDimitry Andric switch (Kind) { 27bdd1243dSDimitry Andric case Value::Kind::Integer: 28bdd1243dSDimitry Andric return "Integer"; 29bdd1243dSDimitry Andric case Value::Kind::Pointer: 30bdd1243dSDimitry Andric return "Pointer"; 31bdd1243dSDimitry Andric case Value::Kind::AtomicBool: 32bdd1243dSDimitry Andric return "AtomicBool"; 33bdd1243dSDimitry Andric case Value::Kind::TopBool: 34bdd1243dSDimitry Andric return "TopBool"; 35*06c3fb27SDimitry Andric case Value::Kind::FormulaBool: 36*06c3fb27SDimitry Andric return "FormulaBool"; 37bdd1243dSDimitry Andric } 38bdd1243dSDimitry Andric llvm_unreachable("Unhandled value kind"); 39bdd1243dSDimitry Andric } 40bdd1243dSDimitry Andric 41*06c3fb27SDimitry Andric llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, 42*06c3fb27SDimitry Andric Solver::Result::Assignment Assignment) { 43fcaf7f86SDimitry Andric switch (Assignment) { 44fcaf7f86SDimitry Andric case Solver::Result::Assignment::AssignedFalse: 45*06c3fb27SDimitry Andric return OS << "False"; 46fcaf7f86SDimitry Andric case Solver::Result::Assignment::AssignedTrue: 47*06c3fb27SDimitry Andric return OS << "True"; 48fcaf7f86SDimitry Andric } 49fcaf7f86SDimitry Andric llvm_unreachable("Booleans can only be assigned true/false"); 50fcaf7f86SDimitry Andric } 51fcaf7f86SDimitry Andric 52bdd1243dSDimitry Andric llvm::StringRef debugString(Solver::Result::Status Status) { 53fcaf7f86SDimitry Andric switch (Status) { 54fcaf7f86SDimitry Andric case Solver::Result::Status::Satisfiable: 55fcaf7f86SDimitry Andric return "Satisfiable"; 56fcaf7f86SDimitry Andric case Solver::Result::Status::Unsatisfiable: 57fcaf7f86SDimitry Andric return "Unsatisfiable"; 58fcaf7f86SDimitry Andric case Solver::Result::Status::TimedOut: 59fcaf7f86SDimitry Andric return "TimedOut"; 60fcaf7f86SDimitry Andric } 61fcaf7f86SDimitry Andric llvm_unreachable("Unhandled SAT check result status"); 62fcaf7f86SDimitry Andric } 63fcaf7f86SDimitry Andric 64*06c3fb27SDimitry Andric llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, const Solver::Result &R) { 65*06c3fb27SDimitry Andric OS << debugString(R.getStatus()) << "\n"; 66*06c3fb27SDimitry Andric if (auto Solution = R.getSolution()) { 67*06c3fb27SDimitry Andric std::vector<std::pair<Atom, Solver::Result::Assignment>> Sorted = { 68*06c3fb27SDimitry Andric Solution->begin(), Solution->end()}; 69*06c3fb27SDimitry Andric llvm::sort(Sorted); 70*06c3fb27SDimitry Andric for (const auto &Entry : Sorted) 71*06c3fb27SDimitry Andric OS << Entry.first << " = " << Entry.second << "\n"; 72753f127fSDimitry Andric } 73*06c3fb27SDimitry Andric return OS; 74753f127fSDimitry Andric } 75753f127fSDimitry Andric 76753f127fSDimitry Andric } // namespace dataflow 77753f127fSDimitry Andric } // namespace clang 78