12dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek//===- ListWarnings.h - diagtool tool for printing warning flags ----------===// 22dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek// 32dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek// The LLVM Compiler Infrastructure 42dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek// 52dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek// This file is distributed under the University of Illinois Open Source 62dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek// License. See LICENSE.TXT for details. 72dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek// 82dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek//===----------------------------------------------------------------------===// 92dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek// 102dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek// This file provides a diagtool tool that displays warning flags for 112dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek// diagnostics. 122dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek// 132dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek//===----------------------------------------------------------------------===// 142dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 152dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek#include "DiagTool.h" 160832f82f763185767d63ae4bf05021c5630c155fJordan Rose#include "DiagnosticNames.h" 17ceb15656fbab9ee1da319afa4934b8f6a5964758David Blaikie#include "clang/AST/ASTDiagnostic.h" 186c44886ed05d7804bfd7b80857b81fd3477079f6David Blaikie#include "clang/Basic/AllDiagnostics.h" 19f59edb96b2d0bfe612b732f19519ab84bb995bd4Chandler Carruth#include "clang/Basic/Diagnostic.h" 20f59edb96b2d0bfe612b732f19519ab84bb995bd4Chandler Carruth#include "llvm/ADT/StringMap.h" 21f59edb96b2d0bfe612b732f19519ab84bb995bd4Chandler Carruth#include "llvm/Support/Format.h" 222dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 232dc651dfd4a4497c39b862e060200d6d58f5c4ecTed KremenekDEF_DIAGTOOL("list-warnings", 242dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek "List warnings and their corresponding flags", 252dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek ListWarnings) 262dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 272dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenekusing namespace clang; 28e7427636767501903cfa51ccecafa7a4795a23c2Jordan Roseusing namespace diagtool; 292dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 30ceb15656fbab9ee1da319afa4934b8f6a5964758David Blaikienamespace { 312dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenekstruct Entry { 322dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek llvm::StringRef DiagName; 332dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek llvm::StringRef Flag; 342dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 352dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek Entry(llvm::StringRef diagN, llvm::StringRef flag) 362dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek : DiagName(diagN), Flag(flag) {} 372dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 382dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek bool operator<(const Entry &x) const { return DiagName < x.DiagName; } 392dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek}; 402dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek} 412dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 422dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenekstatic void printEntries(std::vector<Entry> &entries, llvm::raw_ostream &out) { 432dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek for (std::vector<Entry>::iterator it = entries.begin(), ei = entries.end(); 442dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek it != ei; ++it) { 452dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek out << " " << it->DiagName; 462dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek if (!it->Flag.empty()) 472dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek out << " [-W" << it->Flag << "]"; 482dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek out << '\n'; 492dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek } 502dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek} 512dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 522dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenekint ListWarnings::run(unsigned int argc, char **argv, llvm::raw_ostream &out) { 5383f06e8223291cd8dabe94d0cbfd0553121d5a44Nick Lewycky std::vector<Entry> Flagged, Unflagged; 542dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek llvm::StringMap<std::vector<unsigned> > flagHistogram; 552dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 56e7427636767501903cfa51ccecafa7a4795a23c2Jordan Rose ArrayRef<DiagnosticRecord> AllDiagnostics = getBuiltinDiagnosticsByName(); 57e7427636767501903cfa51ccecafa7a4795a23c2Jordan Rose 58e7427636767501903cfa51ccecafa7a4795a23c2Jordan Rose for (ArrayRef<DiagnosticRecord>::iterator di = AllDiagnostics.begin(), 59e7427636767501903cfa51ccecafa7a4795a23c2Jordan Rose de = AllDiagnostics.end(); 60e7427636767501903cfa51ccecafa7a4795a23c2Jordan Rose di != de; ++di) { 61ceb15656fbab9ee1da319afa4934b8f6a5964758David Blaikie unsigned diagID = di->DiagID; 622dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 632dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek if (DiagnosticIDs::isBuiltinNote(diagID)) 642dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek continue; 652dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 662dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek if (!DiagnosticIDs::isBuiltinWarningOrExtension(diagID)) 672dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek continue; 682dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 69ceb15656fbab9ee1da319afa4934b8f6a5964758David Blaikie Entry entry(di->getName(), 702dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek DiagnosticIDs::getWarningOptionForDiag(diagID)); 712dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 722dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek if (entry.Flag.empty()) 732dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek Unflagged.push_back(entry); 742dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek else { 752dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek Flagged.push_back(entry); 76176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines flagHistogram[entry.Flag].push_back(diagID); 772dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek } 782dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek } 792dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 802dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek out << "Warnings with flags (" << Flagged.size() << "):\n"; 812dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek printEntries(Flagged, out); 822dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 832dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek out << "Warnings without flags (" << Unflagged.size() << "):\n"; 842dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek printEntries(Unflagged, out); 852dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 862dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek out << "\nSTATISTICS:\n\n"; 872dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 882dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek double percentFlagged = ((double) Flagged.size()) 892dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek / (Flagged.size() + Unflagged.size()) * 100.0; 902dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 912dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek out << " Percentage of warnings with flags: " 922dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek << llvm::format("%.4g",percentFlagged) << "%\n"; 932dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 942dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek out << " Number of unique flags: " 952dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek << flagHistogram.size() << '\n'; 962dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 972dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek double avgDiagsPerFlag = (double) Flagged.size() / flagHistogram.size(); 982dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek out << " Average number of diagnostics per flag: " 992dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek << llvm::format("%.4g", avgDiagsPerFlag) << '\n'; 100176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines 101a437b84765d6b98d57f2789435ad641f1dd61474Ted Kremenek out << " Number in -Wpedantic (not covered by other -W flags): " 102176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines << flagHistogram["pedantic"].size() << '\n'; 103176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines 1042dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek out << '\n'; 1052dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 1062dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek return 0; 1072dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek} 1082dc651dfd4a4497c39b862e060200d6d58f5c4ecTed Kremenek 109