cppcheck/cli/cppcheckexecutor.cpp at main · MeeGoIntegration/cppcheck · GitHub

History

696 lines (595 loc) · 23.7 KB

Raw

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

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

* Cppcheck - A tool for static C/C++ code analysis

* 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 "cppcheckexecutor.h"

#include "analyzerinfo.h"

#include "checkersreport.h"

#include "cmdlinelogger.h"

#include "cmdlineparser.h"

#include "color.h"

#include "config.h"

#include "cppcheck.h"

#include "errorlogger.h"

#include "errortypes.h"

#include "filesettings.h"

#include "json.h"

#include "settings.h"

#include "singleexecutor.h"

#include "suppressions.h"

#include "utils.h"

#if defined(HAS_THREADING_MODEL_THREAD)

#include "threadexecutor.h"

#endif

#if defined(HAS_THREADING_MODEL_FORK)

#include "processexecutor.h"

#endif

#include <algorithm>

#include <cassert>

#include <cstdint>

#include <cstdio>

#include <cstdlib> // EXIT_SUCCESS and EXIT_FAILURE

#include <ctime>

#include <fstream>

#include <iostream>

#include <list>

#include <set>

#include <sstream>

#include <unordered_set>

#include <utility>

#include <vector>

#ifdef USE_UNIX_SIGNAL_HANDLING

#include "signalhandler.h"

#endif

#ifdef USE_WINDOWS_SEH

#include "cppcheckexecutorseh.h"

#endif

#ifdef _WIN32

#include <windows.h>

#endif

#if !defined(WIN32) && !defined(__MINGW32__)

#include <sys/wait.h> // WIFEXITED and friends

#endif

namespace {

class SarifReport {

public:

void addFinding(ErrorMessage msg) {

mFindings.push_back(std::move(msg));

}

picojson::array serializeRules() const {

picojson::array ret;

std::set<std::string> ruleIds;

for (const auto& finding : mFindings) {

// github only supports findings with locations

if (finding.callStack.empty())

continue;

if (ruleIds.insert(finding.id).second) {

picojson::object rule;

rule["id"] = picojson::value(finding.id);

// rule.shortDescription.text

picojson::object shortDescription;

shortDescription["text"] = picojson::value(finding.shortMessage());

rule["shortDescription"] = picojson::value(shortDescription);

// rule.fullDescription.text

picojson::object fullDescription;

fullDescription["text"] = picojson::value(finding.verboseMessage());

rule["fullDescription"] = picojson::value(fullDescription);

// rule.help.text

picojson::object help;

help["text"] = picojson::value(finding.verboseMessage()); // FIXME provide proper help text

rule["help"] = picojson::value(help);

// rule.properties.precision, rule.properties.problem.severity

picojson::object properties;

properties["precision"] = picojson::value(sarifPrecision(finding));

double securitySeverity = 0;

if (finding.severity == Severity::error && !ErrorLogger::isCriticalErrorId(finding.id))

securitySeverity = 9.9; // We see undefined behavior

//else if (finding.severity == Severity::warning)

// securitySeverity = 5.1; // We see potential undefined behavior

if (securitySeverity > 0.5) {

properties["security-severity"] = picojson::value(securitySeverity);

const picojson::array tags{picojson::value("security")};

properties["tags"] = picojson::value(tags);

}

rule["properties"] = picojson::value(properties);

ret.emplace_back(rule);

}

return ret;

}

static picojson::array serializeLocations(const ErrorMessage& finding) {

picojson::array ret;

for (const auto& location : finding.callStack) {

picojson::object physicalLocation;

picojson::object artifactLocation;

artifactLocation["uri"] = picojson::value(location.getfile(false));

physicalLocation["artifactLocation"] = picojson::value(artifactLocation);

picojson::object region;

region["startLine"] = picojson::value(static_cast<int64_t>(location.line));

region["startColumn"] = picojson::value(static_cast<int64_t>(location.column));

region["endLine"] = region["startLine"];

region["endColumn"] = region["startColumn"];

physicalLocation["region"] = picojson::value(region);

picojson::object loc;

loc["physicalLocation"] = picojson::value(physicalLocation);

ret.emplace_back(loc);

}

return ret;

}

picojson::array serializeResults() const {

picojson::array results;

for (const auto& finding : mFindings) {

// github only supports findings with locations

if (finding.callStack.empty())

continue;

picojson::object res;

res["level"] = picojson::value(sarifSeverity(finding));

res["locations"] = picojson::value(serializeLocations(finding));

picojson::object message;

message["text"] = picojson::value(finding.shortMessage());

res["message"] = picojson::value(message);

res["ruleId"] = picojson::value(finding.id);

results.emplace_back(res);

}

return results;

}

picojson::value serializeRuns(const std::string& productName, const std::string& version) const {

picojson::object driver;

driver["name"] = picojson::value(productName);

driver["semanticVersion"] = picojson::value(version);

driver["informationUri"] = picojson::value("https://cppcheck.sourceforge.io");

driver["rules"] = picojson::value(serializeRules());

picojson::object tool;

tool["driver"] = picojson::value(driver);

picojson::object run;

run["tool"] = picojson::value(tool);

run["results"] = picojson::value(serializeResults());

picojson::array runs{picojson::value(run)};

return picojson::value(runs);

}

std::string serialize(std::string productName) const {

const auto nameAndVersion = Settings::getNameAndVersion(productName);

productName = nameAndVersion.first.empty() ? "Cppcheck" : nameAndVersion.first;

std::string version = nameAndVersion.first.empty() ? CppCheck::version() : nameAndVersion.second;

if (version.find(' ') != std::string::npos)

version.erase(version.find(' '), std::string::npos);

picojson::object doc;

doc["version"] = picojson::value("2.1.0");

doc["$schema"] = picojson::value("https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json");

doc["runs"] = serializeRuns(productName, version);

return picojson::value(doc).serialize(true);

}

private:

static std::string sarifSeverity(const ErrorMessage& errmsg) {

if (ErrorLogger::isCriticalErrorId(errmsg.id))

return "error";

switch (errmsg.severity) {

case Severity::error:

case Severity::warning:

case Severity::style:

case Severity::portability:

case Severity::performance:

return "warning";

case Severity::information:

case Severity::internal:

case Severity::debug:

case Severity::none:

return "note";

}

return "note";

}

static std::string sarifPrecision(const ErrorMessage& errmsg) {

if (errmsg.certainty == Certainty::inconclusive)

return "medium";

return "high";

}

std::vector<ErrorMessage> mFindings;

};

class CmdLineLoggerStd : public CmdLineLogger

{

public:

CmdLineLoggerStd() = default;

void printMessage(const std::string &message) override

{

printRaw("cppcheck: " + message);

}

void printError(const std::string &message) override

{

printMessage("error: " + message);

}

void printRaw(const std::string &message) override

{

std::cout << message << std::endl;

}

};

class StdLogger : public ErrorLogger

{

public:

explicit StdLogger(const Settings& settings)

: mSettings(settings)

{

if (!mSettings.outputFile.empty()) {

mErrorOutput = new std::ofstream(settings.outputFile);

}

~StdLogger() override {

if (mSettings.outputFormat == Settings::OutputFormat::sarif) {

reportErr(mSarifReport.serialize(mSettings.cppcheckCfgProductName));

}

delete mErrorOutput;

}

StdLogger(const StdLogger&) = delete;

StdLogger& operator=(const SingleExecutor &) = delete;

void resetLatestProgressOutputTime() {

mLatestProgressOutputTime = std::time(nullptr);

}

/**

* Helper function to print out errors. Appends a line change.

* @param errmsg String printed to error stream

void reportErr(const std::string &errmsg);

/**

* @brief Write the checkers report

void writeCheckersReport();

bool hasCriticalErrors() const {

return !mCriticalErrors.empty();

}

const std::string& getCtuInfo() const {

return mCtuInfo;

}

private:

/**

* Information about progress is directed here. This should be

* called by the CppCheck class only.

* @param outmsg Progress message e.g. "Checking main.cpp..."

void reportOut(const std::string &outmsg, Color c = Color::Reset) override;

/** xml output of errors */

void reportErr(const ErrorMessage &msg) override;

void reportProgress(const std::string &filename, const char stage[], std::size_t value) override;

/**

* Pointer to current settings; set while check() is running for reportError().

const Settings& mSettings;

/**

* Used to filter out duplicate error messages.

// TODO: store hashes instead of the full messages

std::unordered_set<std::string> mShownErrors;

/**

* Report progress time

std::time_t mLatestProgressOutputTime{};

/**

* Error output

std::ofstream* mErrorOutput{};

/**

* Checkers that has been executed

std::set<std::string> mActiveCheckers;

/**

* List of critical errors

std::string mCriticalErrors;

/**

* CTU information

std::string mCtuInfo;

/**

* SARIF report generator

SarifReport mSarifReport;

};

}

int CppCheckExecutor::check(int argc, const char* const argv[])

{

Settings settings;

CmdLineLoggerStd logger;

CmdLineParser parser(logger, settings, settings.supprs);

if (!parser.fillSettingsFromArgs(argc, argv)) {

return EXIT_FAILURE;

}

if (Settings::terminated()) {

return EXIT_SUCCESS;

}

settings.loadSummaries();

mFiles = parser.getFiles();

mFileSettings = parser.getFileSettings();

settings.setMisraRuleTexts(executeCommand);

const int ret = check_wrapper(settings);

return ret;

}

int CppCheckExecutor::check_wrapper(const Settings& settings)

{

#ifdef USE_WINDOWS_SEH

if (settings.exceptionHandling)

return check_wrapper_seh(*this, &CppCheckExecutor::check_internal, settings);

#elif defined(USE_UNIX_SIGNAL_HANDLING)

if (settings.exceptionHandling)

register_signal_handler(settings.exceptionOutput);

#endif

return check_internal(settings);

}

bool CppCheckExecutor::reportSuppressions(const Settings &settings, const SuppressionList& suppressions, bool unusedFunctionCheckEnabled, const std::list<FileWithDetails> &files, const std::list<FileSettings>& fileSettings, ErrorLogger& errorLogger) {

const auto& suppr = suppressions.getSuppressions();

if (std::any_of(suppr.begin(), suppr.end(), [](const SuppressionList::Suppression& s) {

return s.errorId == "unmatchedSuppression" && s.fileName.empty() && s.lineNumber == SuppressionList::Suppression::NO_LINE;

}))

return false;

bool err = false;

if (settings.useSingleJob()) {

// the two inputs may only be used exclusively

assert(!(!files.empty() && !fileSettings.empty()));

for (std::list<FileWithDetails>::const_iterator i = files.cbegin(); i != files.cend(); ++i) {

err |= SuppressionList::reportUnmatchedSuppressions(

suppressions.getUnmatchedLocalSuppressions(*i, unusedFunctionCheckEnabled), errorLogger);

}

for (std::list<FileSettings>::const_iterator i = fileSettings.cbegin(); i != fileSettings.cend(); ++i) {

err |= SuppressionList::reportUnmatchedSuppressions(

suppressions.getUnmatchedLocalSuppressions(i->file, unusedFunctionCheckEnabled), errorLogger);

}

err |= SuppressionList::reportUnmatchedSuppressions(suppressions.getUnmatchedGlobalSuppressions(unusedFunctionCheckEnabled), errorLogger);

return err;

}

* That is a method which gets called from check_wrapper

* */

int CppCheckExecutor::check_internal(const Settings& settings) const

{

StdLogger stdLogger(settings);

if (settings.reportProgress >= 0)

stdLogger.resetLatestProgressOutputTime();

if (settings.xml) {

stdLogger.reportErr(ErrorMessage::getXMLHeader(settings.cppcheckCfgProductName, settings.xml_version));

}

if (!settings.buildDir.empty()) {

std::list<std::string> fileNames;

for (std::list<FileWithDetails>::const_iterator i = mFiles.cbegin(); i != mFiles.cend(); ++i)

fileNames.emplace_back(i->path());

AnalyzerInformation::writeFilesTxt(settings.buildDir, fileNames, settings.userDefines, mFileSettings);

}

if (!settings.checkersReportFilename.empty())

std::remove(settings.checkersReportFilename.c_str());

CppCheck cppcheck(stdLogger, true, executeCommand);

cppcheck.settings() = settings; // this is a copy

auto& suppressions = cppcheck.settings().supprs.nomsg;

unsigned int returnValue = 0;

if (settings.useSingleJob()) {

// Single process

SingleExecutor executor(cppcheck, mFiles, mFileSettings, settings, suppressions, stdLogger);

returnValue = executor.check();

} else {

#if defined(HAS_THREADING_MODEL_THREAD)

if (settings.executor == Settings::ExecutorType::Thread) {

ThreadExecutor executor(mFiles, mFileSettings, settings, suppressions, stdLogger, CppCheckExecutor::executeCommand);

returnValue = executor.check();

}

#endif

#if defined(HAS_THREADING_MODEL_FORK)

if (settings.executor == Settings::ExecutorType::Process) {

ProcessExecutor executor(mFiles, mFileSettings, settings, suppressions, stdLogger, CppCheckExecutor::executeCommand);

returnValue = executor.check();

}

#endif

}

returnValue |= cppcheck.analyseWholeProgram(settings.buildDir, mFiles, mFileSettings, stdLogger.getCtuInfo());

if (settings.severity.isEnabled(Severity::information) || settings.checkConfiguration) {

const bool err = reportSuppressions(settings, suppressions, settings.checks.isEnabled(Checks::unusedFunction), mFiles, mFileSettings, stdLogger);

if (err && returnValue == 0)

returnValue = settings.exitCode;

}

if (!settings.checkConfiguration) {

cppcheck.tooManyConfigsError(emptyString,0U);

}

stdLogger.writeCheckersReport();

if (settings.xml) {

stdLogger.reportErr(ErrorMessage::getXMLFooter(settings.xml_version));

}

if (settings.safety && stdLogger.hasCriticalErrors())

return EXIT_FAILURE;

if (returnValue)

return settings.exitCode;

return EXIT_SUCCESS;

}

void StdLogger::writeCheckersReport()

{

const bool summary = mSettings.safety || mSettings.severity.isEnabled(Severity::information);

const bool xmlReport = mSettings.xml && mSettings.xml_version == 3;

const bool textReport = !mSettings.checkersReportFilename.empty();

if (!summary && !xmlReport && !textReport)

return;

CheckersReport checkersReport(mSettings, mActiveCheckers);

const auto& suppressions = mSettings.supprs.nomsg.getSuppressions();

const bool summarySuppressed = std::any_of(suppressions.cbegin(), suppressions.cend(), [](const SuppressionList::Suppression& s) {

return s.errorId == "checkersReport";

});

if (summary && !summarySuppressed) {

ErrorMessage msg;

msg.severity = Severity::information;

msg.id = "checkersReport";

const int activeCheckers = checkersReport.getActiveCheckersCount();

const int totalCheckers = checkersReport.getAllCheckersCount();

std::string what;

if (mCriticalErrors.empty())

what = std::to_string(activeCheckers) + "/" + std::to_string(totalCheckers);

else

what = "There was critical errors";

if (!xmlReport && !textReport)

what += " (use --checkers-report=<filename> to see details)";

msg.setmsg("Active checkers: " + what);

reportErr(msg);

}

if (textReport) {

std::ofstream fout(mSettings.checkersReportFilename);

if (fout.is_open())

fout << checkersReport.getReport(mCriticalErrors);

}

if (xmlReport) {

reportErr(" </errors>\n");

reportErr(checkersReport.getXmlReport(mCriticalErrors));

}

#ifdef _WIN32

// fix trac ticket #439 'Cppcheck reports wrong filename for filenames containing 8-bit ASCII'

static inline std::string ansiToOEM(const std::string &msg, bool doConvert)

{

if (doConvert) {

const unsigned msglength = msg.length();

// convert ANSI strings to OEM strings in two steps

std::vector<WCHAR> wcContainer(msglength);

std::string result(msglength, '\0');

// ansi code page characters to wide characters

MultiByteToWideChar(CP_ACP, 0, msg.data(), msglength, wcContainer.data(), msglength);

// wide characters to oem codepage characters

WideCharToMultiByte(CP_OEMCP, 0, wcContainer.data(), msglength, &result[0], msglength, nullptr, nullptr);

return result; // hope for return value optimization

}

return msg;

}

#else

// no performance regression on non-windows systems

#define ansiToOEM(msg, doConvert) (msg)

#endif

void StdLogger::reportErr(const std::string &errmsg)

{

if (mErrorOutput)

*mErrorOutput << errmsg << std::endl;

else {

std::cerr << ansiToOEM(errmsg, !mSettings.xml) << std::endl;

}

void StdLogger::reportOut(const std::string &outmsg, Color c)

{

if (c == Color::Reset)

std::cout << ansiToOEM(outmsg, true) << std::endl;

else

std::cout << c << ansiToOEM(outmsg, true) << Color::Reset << std::endl;

}

// TODO: remove filename parameter?

void StdLogger::reportProgress(const std::string &filename, const char stage[], const std::size_t value)

{

(void)filename;

if (!mLatestProgressOutputTime)

return;

// Report progress messages every x seconds

const std::time_t currentTime = std::time(nullptr);

if (currentTime >= (mLatestProgressOutputTime + mSettings.reportProgress))

{

mLatestProgressOutputTime = currentTime;

// format a progress message

std::ostringstream ostr;

ostr << "progress: "

<< stage

<< ' ' << value << '%';

// Report progress message

reportOut(ostr.str());

}

void StdLogger::reportErr(const ErrorMessage &msg)

{

if (msg.severity == Severity::internal && (msg.id == "logChecker" || endsWith(msg.id, "-logChecker"))) {

const std::string& checker = msg.shortMessage();

mActiveCheckers.emplace(checker);

return;

}

if (msg.severity == Severity::internal && msg.id == "ctuinfo") {

mCtuInfo += msg.shortMessage() + "\n";

return;

}

if (ErrorLogger::isCriticalErrorId(msg.id) && mCriticalErrors.find(msg.id) == std::string::npos) {

if (!mCriticalErrors.empty())

mCriticalErrors += ", ";

mCriticalErrors += msg.id;

if (msg.severity == Severity::internal)

mCriticalErrors += " (suppressed)";

}

if (msg.severity == Severity::internal)

return;

// TODO: we generate a different message here then we log below

// TODO: there should be no need for verbose and default messages here

// Alert only about unique errors

if (!mShownErrors.insert(msg.toString(mSettings.verbose)).second)

return;

if (mSettings.outputFormat == Settings::OutputFormat::sarif)

mSarifReport.addFinding(msg);

else if (mSettings.xml)

reportErr(msg.toXML());

else

reportErr(msg.toString(mSettings.verbose, mSettings.templateFormat, mSettings.templateLocation));

}

/**

* Execute a shell command and read the output from it. Returns true if command terminated successfully.

// cppcheck-suppress passedByValueCallback - used as callback so we need to preserve the signature

// NOLINTNEXTLINE(performance-unnecessary-value-param) - used as callback so we need to preserve the signature

int CppCheckExecutor::executeCommand(std::string exe, std::vector<std::string> args, std::string redirect, std::string &output_)

{

output_.clear();

#ifdef _WIN32

// Extra quoutes are needed in windows if filename has space

if (exe.find(" ") != std::string::npos)

exe = "\"" + exe + "\"";

#endif

std::string joinedArgs;

for (const std::string &arg : args) {

if (!joinedArgs.empty())

joinedArgs += " ";

if (arg.find(' ') != std::string::npos)

joinedArgs += '"' + arg + '"';

else

joinedArgs += arg;

}

const std::string cmd = exe + " " + joinedArgs + " " + redirect;

#ifdef _WIN32

FILE* p = _popen(cmd.c_str(), "r");

#else

FILE *p = popen(cmd.c_str(), "r");

#endif

//std::cout << "invoking command '" << cmd << "'" << std::endl;

if (!p) {

// TODO: how to provide to caller?

//const int err = errno;

//std::cout << "popen() errno " << std::to_string(err) << std::endl;

return -1;

}

char buffer[1024];

while (fgets(buffer, sizeof(buffer), p) != nullptr)

output_ += buffer;

#ifdef _WIN32

const int res = _pclose(p);

#else

const int res = pclose(p);

#endif

if (res == -1) { // error occurred

// TODO: how to provide to caller?

//const int err = errno;

//std::cout << "pclose() errno " << std::to_string(err) << std::endl;

return res;

}

#if !defined(WIN32) && !defined(__MINGW32__)

if (WIFEXITED(res)) {

return WEXITSTATUS(res);

}

if (WIFSIGNALED(res)) {

return WTERMSIG(res);

}

#endif

return res;

}

cppcheck/cli/cppcheckexecutor.cpp at main · MeeGoIntegration/cppcheck · GitHub

Uh oh!

Expand file tree

Breadcrumbs

cppcheckexecutor.cpp

Latest commit

History

Breadcrumbs

cppcheckexecutor.cpp

File metadata and controls