include/clang-tidy/ClangTidyProfiling.h

0001 //===--- ClangTidyProfiling.h - clang-tidy ----------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLANGTIDYPROFILING_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLANGTIDYPROFILING_H
0011
0012 #include "llvm/ADT/StringMap.h"
0013 #include "llvm/Support/Chrono.h"
0014 #include "llvm/Support/Timer.h"
0015 #include <optional>
0016 #include <string>
0017
0018 namespace llvm {
0019 class raw_ostream;
0020 } // namespace llvm
0021
0022 namespace clang::tidy {
0023
0024 class ClangTidyProfiling {
0025 public:
0026   struct StorageParams {
0027     llvm::sys::TimePoint<> Timestamp;
0028     std::string SourceFilename;
0029     std::string StoreFilename;
0030
0031     StorageParams() = default;
0032
0033     StorageParams(llvm::StringRef ProfilePrefix, llvm::StringRef SourceFile);
0034   };
0035
0036 private:
0037   std::optional<StorageParams> Storage;
0038
0039   void printUserFriendlyTable(llvm::raw_ostream &OS, llvm::TimerGroup &TG);
0040   void printAsJSON(llvm::raw_ostream &OS, llvm::TimerGroup &TG);
0041   void storeProfileData(llvm::TimerGroup &TG);
0042
0043 public:
0044   llvm::StringMap<llvm::TimeRecord> Records;
0045
0046   ClangTidyProfiling() = default;
0047
0048   ClangTidyProfiling(std::optional<StorageParams> Storage);
0049
0050   ~ClangTidyProfiling();
0051 };
0052
0053 } // namespace clang::tidy
0054
0055 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLANGTIDYPROFILING_H