Repository navigation
Expand file tree
/
Copy pathanalyzerinfo.cpp
More file actions
385 lines (322 loc) · 13.9 KB
/
Copy pathanalyzerinfo.cpp
File metadata and controls
385 lines (322 loc) · 13.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2026 Cppcheck team.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "analyzerinfo.h"
#include "errorlogger.h"
#include "filesettings.h"
#include "path.h"
#include <array>
#include <cstring>
#include <exception>
#include <iostream>
#include <map>
#include <sstream>
#include <stdexcept>
#include <utility>
#include "xml.h"
AnalyzerInformation::~AnalyzerInformation()
{
close();
}
static std::string getFilename(const std::string &fullpath)
{
std::string::size_type pos1 = fullpath.find_last_of("/\\");
pos1 = (pos1 == std::string::npos) ? 0U : (pos1 + 1U);
std::string::size_type pos2 = fullpath.rfind('.');
if (pos2 < pos1)
pos2 = std::string::npos;
if (pos2 != std::string::npos)
pos2 = pos2 - pos1;
return fullpath.substr(pos1,pos2);
}
void AnalyzerInformation::writeFilesTxt(const std::string &buildDir, const std::list<std::string> &sourcefiles, const std::list<FileSettings> &fileSettings)
{
const std::string filesTxt(buildDir + "/files.txt");
std::ofstream fout(filesTxt);
fout << getFilesTxt(sourcefiles, fileSettings);
}
void AnalyzerInformation::writeIncludes(const std::set<std::string> &files)
{
if (!files.empty() && mOutputStream.is_open()) {
mOutputStream << " <includes>\n";
for (const std::string &file : files) {
mOutputStream << " <filename>" << file << "</filename>\n";
}
mOutputStream << " </includes>\n";
}
}
std::set<std::string> AnalyzerInformation::getIncludes(const std::string &buildDir, const std::string &sourcefile, const std::string &cfg, std::size_t fsFileId) const
{
if (mOutputStream.is_open())
throw std::runtime_error("analyzer information file is already open");
std::set<std::string> files;
if (buildDir.empty() || sourcefile.empty())
return files;
const std::string analyzerInfoFile = AnalyzerInformation::getAnalyzerInfoFile(buildDir, sourcefile, cfg, fsFileId);
tinyxml2::XMLDocument analyzerInfoDoc;
if (analyzerInfoDoc.LoadFile(analyzerInfoFile.c_str()) != tinyxml2::XML_SUCCESS)
return files;
const tinyxml2::XMLElement *const rootNode = analyzerInfoDoc.FirstChildElement();
if (rootNode == nullptr)
return files;
if (strcmp(rootNode->Name(), "analyzerinfo") != 0)
return files;
const tinyxml2::XMLElement *includesNode = nullptr;
for (const tinyxml2::XMLElement *e = rootNode->FirstChildElement(); e; e = e->NextSiblingElement()) {
if (strcmp(e->Name(), "includes") == 0) {
includesNode = e;
break;
}
}
if (includesNode == nullptr)
return files;
for (const tinyxml2::XMLElement *e = includesNode->FirstChildElement(); e; e = e->NextSiblingElement()) {
if (strcmp(e->Name(), "filename") != 0)
continue;
files.insert(e->GetText());
}
return files;
}
void AnalyzerInformation::writeHash(std::size_t hash)
{
if (mOutputStream.is_open()) {
mOutputStream << " <hash>" << hash << "</hash>\n";
}
}
std::string AnalyzerInformation::getFilesTxt(const std::list<std::string> &sourcefiles, const std::list<FileSettings> &fileSettings) {
std::ostringstream ret;
std::map<std::string, unsigned int> fileCount;
for (const std::string &f : sourcefiles) {
const std::string afile = getFilename(f);
ret << afile << ".a" << (++fileCount[afile]) << sep << sep << sep << Path::simplifyPath(f) << '\n';
}
for (const FileSettings &fs : fileSettings) {
const std::string afile = getFilename(fs.filename());
const std::string id = fs.file.fsFileId() > 0 ? std::to_string(fs.file.fsFileId()) : "";
ret << afile << ".a" << (++fileCount[afile]) << sep << fs.cfg << sep << id << sep << Path::simplifyPath(fs.filename()) << std::endl;
}
return ret.str();
}
void AnalyzerInformation::close()
{
if (mOutputStream.is_open()) {
mOutputStream << "</analyzerinfo>\n";
mOutputStream.close();
}
}
std::string AnalyzerInformation::skipAnalysis(const tinyxml2::XMLDocument &analyzerInfoDoc, std::size_t hash, std::list<ErrorMessage> &errors)
{
const tinyxml2::XMLElement * const rootNode = analyzerInfoDoc.FirstChildElement();
if (rootNode == nullptr)
return "no root node found";
if (strcmp(rootNode->Name(), "analyzerinfo") != 0)
return "unexpected root node";
const tinyxml2::XMLElement *hashNode = nullptr;
for (const tinyxml2::XMLElement *e = rootNode->FirstChildElement(); e; e = e->NextSiblingElement()) {
if (strcmp(e->Name(), "hash") == 0) {
hashNode = e;
break;
}
}
if (!hashNode)
return "no 'hash' node found";
if (hashNode->GetText() != std::to_string(hash))
return "hash mismatch";
for (const tinyxml2::XMLElement *e = rootNode->FirstChildElement(); e; e = e->NextSiblingElement()) {
if (std::strcmp(e->Name(), "error") != 0)
continue;
// TODO: discarding results on internalError doesn't make sense since that won't fix itself
// Check for invalid license error or internal error, in which case we should retry analysis
static const std::array<const char*, 3> s_ids{
"premium-invalidLicense",
"premium-internalError",
"internalError"
};
for (const auto* id : s_ids)
{
// cppcheck-suppress useStlAlgorithm
if (e->Attribute("id", id)) {
errors.clear();
return std::string("'") + id + "' encountered";
}
}
errors.emplace_back(e);
}
return "";
}
std::string AnalyzerInformation::getAnalyzerInfoFileFromFilesTxt(std::istream& filesTxt, const std::string &sourcefile, const std::string &cfg, size_t fsFileId)
{
const std::string simplifiedSourcefile = Path::simplifyPath(sourcefile);
std::string line;
while (std::getline(filesTxt,line)) {
AnalyzerInformation::Info filesTxtInfo;
if (!filesTxtInfo.parse(line))
continue; // TODO: report error?
if (filesTxtInfo.sourceFile == simplifiedSourcefile && filesTxtInfo.cfg == cfg && filesTxtInfo.fsFileId == fsFileId)
return filesTxtInfo.afile;
}
return "";
}
std::string AnalyzerInformation::getAnalyzerInfoFile(const std::string &buildDir, const std::string &sourcefile, const std::string &cfg, std::size_t fsFileId)
{
std::ifstream fin(Path::join(buildDir, "files.txt"));
if (fin.is_open()) {
const std::string& ret = getAnalyzerInfoFileFromFilesTxt(fin, sourcefile, cfg, fsFileId);
if (!ret.empty())
return Path::join(buildDir, ret);
}
const std::string::size_type pos = sourcefile.rfind('/');
std::string filename;
if (pos == std::string::npos)
filename = sourcefile;
else
filename = sourcefile.substr(pos + 1);
// TODO: is this correct? the above code will return files ending in '.aN'. Also does not consider the ID
return Path::join(buildDir, std::move(filename)) + ".analyzerinfo";
}
bool AnalyzerInformation::analyzeFile(const std::string &buildDir, const std::string &sourcefile, const std::string &cfg, std::size_t fsFileId, std::size_t hash, std::list<ErrorMessage> &errors, bool debug)
{
if (mOutputStream.is_open())
throw std::runtime_error("analyzer information file is already open");
if (buildDir.empty() || sourcefile.empty())
return true;
const std::string analyzerInfoFile = AnalyzerInformation::getAnalyzerInfoFile(buildDir,sourcefile,cfg,fsFileId);
{
tinyxml2::XMLDocument analyzerInfoDoc;
const tinyxml2::XMLError xmlError = analyzerInfoDoc.LoadFile(analyzerInfoFile.c_str());
if (xmlError == tinyxml2::XML_SUCCESS) {
const std::string err = skipAnalysis(analyzerInfoDoc, hash, errors);
if (err.empty()) {
if (debug)
std::cout << "skipping analysis - loaded " << errors.size() << " cached finding(s) from '" << analyzerInfoFile << "' for '" << sourcefile << "'" << std::endl;
return false;
}
if (debug) {
std::cout << "discarding cached result from '" << analyzerInfoFile << "' for '" << sourcefile << "' - " << err << std::endl;
}
}
else if (xmlError != tinyxml2::XML_ERROR_FILE_NOT_FOUND) {
if (debug)
std::cout << "discarding cached result - failed to load '" << analyzerInfoFile << "' for '" << sourcefile << "' (" << tinyxml2::XMLDocument::ErrorIDToName(xmlError) << ")" << std::endl;
}
else if (debug)
std::cout << "no cached result '" << analyzerInfoFile << "' for '" << sourcefile << "' found" << std::endl;
}
mOutputStream.open(analyzerInfoFile);
if (!mOutputStream.is_open())
throw std::runtime_error("failed to open '" + analyzerInfoFile + "'");
mOutputStream << "<?xml version=\"1.0\"?>\n";
mOutputStream << "<analyzerinfo>\n";
return true;
}
void AnalyzerInformation::reportErr(const ErrorMessage &msg)
{
if (mOutputStream.is_open())
mOutputStream << msg.toXML() << '\n';
}
void AnalyzerInformation::setFileInfo(const std::string &check, const std::string &fileInfo)
{
if (mOutputStream.is_open() && !fileInfo.empty())
mOutputStream << " <FileInfo check=\"" << check << "\">\n" << fileInfo << " </FileInfo>\n";
}
// TODO: report detailed errors?
bool AnalyzerInformation::Info::parse(const std::string& filesTxtLine) {
const std::string::size_type sep1 = filesTxtLine.find(sep);
if (sep1 == std::string::npos)
return false;
const std::string::size_type sep2 = filesTxtLine.find(sep, sep1+1);
if (sep2 == std::string::npos)
return false;
const std::string::size_type sep3 = filesTxtLine.find(sep, sep2+1);
if (sep3 == std::string::npos)
return false;
if (sep3 == sep2 + 1)
fsFileId = 0;
else {
try {
fsFileId = std::stoi(filesTxtLine.substr(sep2+1, sep3-sep2-1));
} catch (const std::exception&) {
return false;
}
}
afile = filesTxtLine.substr(0, sep1);
cfg = filesTxtLine.substr(sep1+1, sep2-sep1-1);
sourceFile = filesTxtLine.substr(sep3+1);
return true;
}
std::string AnalyzerInformation::processFilesTxt(const std::string& buildDir, const std::function<void(const char* checkattr, const tinyxml2::XMLElement* e, const Info& filesTxtInfo)>& handler, bool debug)
{
const std::string filesTxt(buildDir + "/files.txt");
std::ifstream fin(filesTxt.c_str());
std::string filesTxtLine;
while (std::getline(fin, filesTxtLine)) {
AnalyzerInformation::Info filesTxtInfo;
if (!filesTxtInfo.parse(filesTxtLine))
return "failed to parse '" + filesTxtLine + "' from '" + filesTxt + "'";
if (filesTxtInfo.afile.empty())
return "empty afile from '" + filesTxt + "'";
const std::string xmlfile = buildDir + '/' + filesTxtInfo.afile;
tinyxml2::XMLDocument doc;
const tinyxml2::XMLError error = doc.LoadFile(xmlfile.c_str());
if (error == tinyxml2::XML_ERROR_FILE_NOT_FOUND) {
/* FIXME: this can currently not be reported as an error because:
* - --clang does not generate any analyzer information - see #14456
* - markup files might not generate analyzer information
* - files with preprocessor errors might not generate analyzer information
*/
if (debug)
std::cout << "'" + xmlfile + "' from '" + filesTxt + "' not found";
continue;
}
if (error != tinyxml2::XML_SUCCESS)
return "failed to load '" + xmlfile + "' from '" + filesTxt + "'";
const tinyxml2::XMLElement * const rootNode = doc.FirstChildElement();
if (rootNode == nullptr)
return "no root node found in '" + xmlfile + "' from '" + filesTxt + "'";
if (strcmp(rootNode->Name(), "analyzerinfo") != 0)
return "unexpected root node in '" + xmlfile + "' from '" + filesTxt + "'";
for (const tinyxml2::XMLElement *e = rootNode->FirstChildElement(); e; e = e->NextSiblingElement()) {
if (std::strcmp(e->Name(), "FileInfo") != 0)
continue;
const char *checkattr = e->Attribute("check");
if (checkattr == nullptr) {
if (debug)
std::cout << "'check' attribute missing in 'FileInfo' in '" << xmlfile << "' from '" << filesTxt + "'";
continue;
}
handler(checkattr, e, filesTxtInfo);
}
}
// TODO: error on empty file?
return "";
}
void AnalyzerInformation::reopen(const std::string &buildDir, const std::string &sourcefile, const std::string &cfg, std::size_t fsFileId)
{
if (buildDir.empty() || sourcefile.empty())
return;
const std::string analyzerInfoFile = AnalyzerInformation::getAnalyzerInfoFile(buildDir,sourcefile,cfg,fsFileId);
std::ifstream ifs(analyzerInfoFile);
if (!ifs.is_open())
return;
std::ostringstream iss;
iss << ifs.rdbuf();
ifs.close();
std::string content = iss.str();
content.resize(content.find("</analyzerinfo>"));
mOutputStream.open(analyzerInfoFile, std::ios::trunc);
mOutputStream << content;
}