Coverage Report

Created: 2020-09-19 12:23

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/Frontend/HeaderIncludeGen.cpp
Line
Count
Source (jump to first uncovered line)
1
//===-- HeaderIncludeGen.cpp - Generate Header Includes -------------------===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
9
#include "clang/Frontend/DependencyOutputOptions.h"
10
#include "clang/Frontend/Utils.h"
11
#include "clang/Basic/SourceManager.h"
12
#include "clang/Frontend/FrontendDiagnostic.h"
13
#include "clang/Lex/Preprocessor.h"
14
#include "llvm/ADT/SmallString.h"
15
#include "llvm/Support/raw_ostream.h"
16
using namespace clang;
17
18
namespace {
19
class HeaderIncludesCallback : public PPCallbacks {
20
  SourceManager &SM;
21
  raw_ostream *OutputFile;
22
  const DependencyOutputOptions &DepOpts;
23
  unsigned CurrentIncludeDepth;
24
  bool HasProcessedPredefines;
25
  bool OwnsOutputFile;
26
  bool ShowAllHeaders;
27
  bool ShowDepth;
28
  bool MSStyle;
29
30
public:
31
  HeaderIncludesCallback(const Preprocessor *PP, bool ShowAllHeaders_,
32
                         raw_ostream *OutputFile_,
33
                         const DependencyOutputOptions &DepOpts,
34
                         bool OwnsOutputFile_, bool ShowDepth_, bool MSStyle_)
35
      : SM(PP->getSourceManager()), OutputFile(OutputFile_), DepOpts(DepOpts),
36
        CurrentIncludeDepth(0), HasProcessedPredefines(false),
37
        OwnsOutputFile(OwnsOutputFile_), ShowAllHeaders(ShowAllHeaders_),
38
19
        ShowDepth(ShowDepth_), MSStyle(MSStyle_) {}
39
40
5
  ~HeaderIncludesCallback() override {
41
5
    if (OwnsOutputFile)
42
0
      delete OutputFile;
43
5
  }
44
45
  void FileChanged(SourceLocation Loc, FileChangeReason Reason,
46
                   SrcMgr::CharacteristicKind FileType,
47
                   FileID PrevFID) override;
48
};
49
}
50
51
static void PrintHeaderInfo(raw_ostream *OutputFile, StringRef Filename,
52
                            bool ShowDepth, unsigned CurrentIncludeDepth,
53
34
                            bool MSStyle) {
54
  // Write to a temporary string to avoid unnecessary flushing on errs().
55
34
  SmallString<512> Pathname(Filename);
56
34
  if (!MSStyle)
57
11
    Lexer::Stringify(Pathname);
58
34
59
34
  SmallString<256> Msg;
60
34
  if (MSStyle)
61
23
    Msg += "Note: including file:";
62
34
63
34
  if (ShowDepth) {
64
    // The main source file is at depth 1, so skip one dot.
65
70
    for (unsigned i = 1; i != CurrentIncludeDepth; 
++i39
)
66
39
      Msg += MSStyle ? 
' '29
:
'.'10
;
67
31
68
31
    if (!MSStyle)
69
8
      Msg += ' ';
70
31
  }
71
34
  Msg += Pathname;
72
34
  Msg += '\n';
73
34
74
34
  *OutputFile << Msg;
75
34
  OutputFile->flush();
76
34
}
77
78
void clang::AttachHeaderIncludeGen(Preprocessor &PP,
79
                                   const DependencyOutputOptions &DepOpts,
80
                                   bool ShowAllHeaders, StringRef OutputPath,
81
19
                                   bool ShowDepth, bool MSStyle) {
82
19
  raw_ostream *OutputFile = &llvm::errs();
83
19
  bool OwnsOutputFile = false;
84
19
85
  // Choose output stream, when printing in cl.exe /showIncludes style.
86
19
  if (MSStyle) {
87
10
    switch (DepOpts.ShowIncludesDest) {
88
0
    default:
89
0
      llvm_unreachable("Invalid destination for /showIncludes output!");
90
1
    case ShowIncludesDestination::Stderr:
91
1
      OutputFile = &llvm::errs();
92
1
      break;
93
9
    case ShowIncludesDestination::Stdout:
94
9
      OutputFile = &llvm::outs();
95
9
      break;
96
19
    }
97
19
  }
98
19
99
  // Open the output file, if used.
100
19
  if (!OutputPath.empty()) {
101
0
    std::error_code EC;
102
0
    llvm::raw_fd_ostream *OS = new llvm::raw_fd_ostream(
103
0
        OutputPath.str(), EC,
104
0
        llvm::sys::fs::OF_Append | llvm::sys::fs::OF_Text);
105
0
    if (EC) {
106
0
      PP.getDiagnostics().Report(clang::diag::warn_fe_cc_print_header_failure)
107
0
          << EC.message();
108
0
      delete OS;
109
0
    } else {
110
0
      OS->SetUnbuffered();
111
0
      OutputFile = OS;
112
0
      OwnsOutputFile = true;
113
0
    }
114
0
  }
115
19
116
  // Print header info for extra headers, pretending they were discovered by
117
  // the regular preprocessor. The primary use case is to support proper
118
  // generation of Make / Ninja file dependencies for implicit includes, such
119
  // as sanitizer blacklists. It's only important for cl.exe compatibility,
120
  // the GNU way to generate rules is -M / -MM / -MD / -MMD.
121
19
  for (const auto &Header : DepOpts.ExtraDeps)
122
1
    PrintHeaderInfo(OutputFile, Header, ShowDepth, 2, MSStyle);
123
19
  PP.addPPCallbacks(std::make_unique<HeaderIncludesCallback>(
124
19
      &PP, ShowAllHeaders, OutputFile, DepOpts, OwnsOutputFile, ShowDepth,
125
19
      MSStyle));
126
19
}
127
128
void HeaderIncludesCallback::FileChanged(SourceLocation Loc,
129
                                         FileChangeReason Reason,
130
                                         SrcMgr::CharacteristicKind NewFileType,
131
178
                                         FileID PrevFID) {
132
  // Unless we are exiting a #include, make sure to skip ahead to the line the
133
  // #include directive was at.
134
178
  PresumedLoc UserLoc = SM.getPresumedLoc(Loc);
135
178
  if (UserLoc.isInvalid())
136
0
    return;
137
178
138
  // Adjust the current include depth.
139
178
  if (Reason == PPCallbacks::EnterFile) {
140
92
    ++CurrentIncludeDepth;
141
86
  } else if (Reason == PPCallbacks::ExitFile) {
142
71
    if (CurrentIncludeDepth)
143
71
      --CurrentIncludeDepth;
144
71
145
    // We track when we are done with the predefines by watching for the first
146
    // place where we drop back to a nesting depth of 1.
147
71
    if (CurrentIncludeDepth == 1 && 
!HasProcessedPredefines38
) {
148
17
      if (!DepOpts.ShowIncludesPretendHeader.empty()) {
149
0
        PrintHeaderInfo(OutputFile, DepOpts.ShowIncludesPretendHeader,
150
0
                        ShowDepth, 2, MSStyle);
151
0
      }
152
17
      HasProcessedPredefines = true;
153
17
    }
154
71
155
71
    return;
156
71
  } else
157
15
    return;
158
92
159
  // Show the header if we are (a) past the predefines, or (b) showing all
160
  // headers and in the predefines at a depth past the initial file and command
161
  // line buffers.
162
92
  bool ShowHeader = (HasProcessedPredefines ||
163
66
                     (ShowAllHeaders && 
CurrentIncludeDepth > 255
));
164
92
  unsigned IncludeDepth = CurrentIncludeDepth;
165
92
  if (!HasProcessedPredefines)
166
66
    --IncludeDepth; // Ignore indent from <built-in>.
167
26
  else if (!DepOpts.ShowIncludesPretendHeader.empty())
168
0
    ++IncludeDepth; // Pretend inclusion by ShowIncludesPretendHeader.
169
92
170
92
  if (!DepOpts.IncludeSystemHeaders && 
isSystem(NewFileType)27
)
171
4
    ShowHeader = false;
172
92
173
  // Dump the header include information we are past the predefines buffer or
174
  // are showing all headers and this isn't the magic implicit <command line>
175
  // header.
176
  // FIXME: Identify headers in a more robust way than comparing their name to
177
  // "<command line>" and "<built-in>" in a bunch of places.
178
92
  if (ShowHeader && 
Reason == PPCallbacks::EnterFile45
&&
179
45
      UserLoc.getFilename() != StringRef("<command line>")) {
180
33
    PrintHeaderInfo(OutputFile, UserLoc.getFilename(), ShowDepth, IncludeDepth,
181
33
                    MSStyle);
182
33
  }
183
92
}