cppcheck/cli/processexecutor.cpp at main · cppcheck-opensource/cppcheck · GitHub

History

523 lines (459 loc) · 19.6 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

* 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/>.

#if defined(__CYGWIN__)

#define _BSD_SOURCE // required to have getloadavg()

#endif

#include "processexecutor.h"

#ifdef HAS_THREADING_MODEL_FORK

#include "cppcheck.h"

#include "errorlogger.h"

#include "errortypes.h"

#include "filesettings.h"

#include "settings.h"

#include "suppressions.h"

#include "timer.h"

#include "utils.h"

#include <algorithm>

#include <numeric>

#include <cassert>

#include <cerrno>

#include <chrono>

#include <csignal>

#include <cstdint>

#include <cstdlib>

#include <cstring>

#include <iostream>

#include <list>

#include <map>

#include <memory>

#include <sstream>

#include <sys/select.h>

#include <sys/types.h>

#include <sys/wait.h>

#include <unistd.h>

#include <utility>

#include <fcntl.h>

#ifdef __SVR4 // Solaris

#include <sys/loadavg.h>

#endif

#if defined(__linux__)

#include <sys/prctl.h>

#endif

enum class Color : std::uint8_t;

// NOLINTNEXTLINE(misc-unused-using-decls) - required for FD_ZERO

using std::memset;

ProcessExecutor::ProcessExecutor(const std::list<FileWithDetails> &files, const std::list<FileSettings>& fileSettings, const Settings &settings, Suppressions &suppressions, ErrorLogger &errorLogger, TimerResults* timerResults, CppCheck::ExecuteCmdFn executeCommand)

: Executor(files, fileSettings, settings, suppressions, errorLogger, timerResults)

, mExecuteCommand(std::move(executeCommand))

{

assert(mSettings.jobs > 1);

}

namespace {

class PipeWriter : public ErrorLogger {

public:

enum PipeSignal : std::uint8_t {REPORT_OUT='1',REPORT_ERROR='2',REPORT_SUPPR_INLINE='3',REPORT_SUPPR='4',CHILD_END='5',REPORT_METRIC='6',REPORT_TIMER='7'};

explicit PipeWriter(int pipe, bool debug) : mWpipe(pipe), mDebug(debug) {}

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

writeToPipe(REPORT_OUT, static_cast<char>(c) + outmsg);

}

void reportErr(const ErrorMessage &msg) override {

writeToPipe(REPORT_ERROR, msg.serialize());

}

void writeSuppr(const SuppressionList &supprs) const {

for (const auto& suppr : supprs.getSuppressions())

{

if (suppr.isInline)

writeToPipe(REPORT_SUPPR_INLINE, suppressionToString(suppr));

else if (suppr.checked)

writeToPipe(REPORT_SUPPR, suppressionToString(suppr));

}

void reportMetric(const std::string &metric) override {

writeToPipe(REPORT_METRIC, metric);

}

void writeTimer(const TimerResults* timerResults) const {

if (!timerResults)

return;

for (const auto& entry : timerResults->getResults())

{

for (const auto& d : entry.second) {

writeToPipe(REPORT_TIMER, entry.first + ";" + std::to_string(d.count()));

}

void writeEnd(const std::string& str) const {

writeToPipe(CHILD_END, str);

}

private:

static std::string suppressionToString(const SuppressionList::Suppression &suppr)

{

std::string suppr_str = suppr.toString();

suppr_str += ";";

suppr_str += std::to_string(suppr.column);

suppr_str += ";";

suppr_str += suppr.checked ? "1" : "0";

suppr_str += ";";

suppr_str += suppr.matched ? "1" : "0";

suppr_str += ";";

suppr_str += suppr.extraComment;

return suppr_str;

}

// TODO: how to log file name in error?

void writeToPipeInternal(PipeSignal type, const void* data, std::size_t to_write) const

{

const ssize_t bytes_written = write(mWpipe, data, to_write);

if (bytes_written <= 0) {

const int err = errno;

std::cerr << "#### ThreadExecutor::writeToPipeInternal() error for type " << static_cast<unsigned char>(type) << ": " << std::strerror(err) << std::endl;

std::exit(EXIT_FAILURE);

}

// TODO: write until everything is written

if (bytes_written != to_write) {

std::cerr << "#### ThreadExecutor::writeToPipeInternal() error for type " << static_cast<unsigned char>(type) << ": insufficient data written (expected: " << to_write << " / got: " << bytes_written << ")" << std::endl;

std::exit(EXIT_FAILURE);

}

void writeToPipe(PipeSignal type, const std::string &data) const

{

if (mDebug)

std::cout << "writeToPipe - " << static_cast<char>(type) << " - " << data << std::endl;

{

const auto t = static_cast<char>(type);

writeToPipeInternal(type, &t, 1);

}

const auto len = static_cast<unsigned int>(data.length());

{

static constexpr std::size_t l_size = sizeof(unsigned int);

writeToPipeInternal(type, &len, l_size);

}

if (len > 0) // TODO: unexpected - write a warning?

writeToPipeInternal(type, data.c_str(), len);

}

const int mWpipe;

const bool mDebug;

};

}

bool ProcessExecutor::handleRead(int rpipe, unsigned int &result, const std::string& filename)

{

std::size_t bytes_to_read;

ssize_t bytes_read;

char type = 0;

bytes_to_read = sizeof(char);

bytes_read = read(rpipe, &type, bytes_to_read);

if (bytes_read <= 0) {

if (errno == EAGAIN)

return true;

// TODO: log details about failure

// need to increment so a missing pipe (i.e. premature exit of forked process) results in an error exitcode

++result;

return false;

}

if (bytes_read != bytes_to_read) {

std::cerr << "#### ThreadExecutor::handleRead(" << filename << ") error (type): insufficient data read (expected: " << bytes_to_read << " / got: " << bytes_read << ")" << std::endl;

std::exit(EXIT_FAILURE);

}

if (type != PipeWriter::REPORT_OUT &&

type != PipeWriter::REPORT_ERROR &&

type != PipeWriter::REPORT_SUPPR_INLINE &&

type != PipeWriter::REPORT_SUPPR &&

type != PipeWriter::CHILD_END &&

type != PipeWriter::REPORT_METRIC &&

type != PipeWriter::REPORT_TIMER) {

std::cerr << "#### ThreadExecutor::handleRead(" << filename << ") invalid type " << int(type) << std::endl;

std::exit(EXIT_FAILURE);

}

unsigned int len = 0;

bytes_to_read = sizeof(len);

bytes_read = read(rpipe, &len, bytes_to_read);

if (bytes_read <= 0) {

const int err = errno;

std::cerr << "#### ThreadExecutor::handleRead(" << filename << ") error (len) for type " << int(type) << ": " << std::strerror(err) << std::endl;

std::exit(EXIT_FAILURE);

}

if (bytes_read != bytes_to_read) {

std::cerr << "#### ThreadExecutor::handleRead(" << filename << ") error (len) for type" << int(type) << ": insufficient data read (expected: " << bytes_to_read << " / got: " << bytes_read << ")" << std::endl;

std::exit(EXIT_FAILURE);

}

std::string buf(len, '\0');

if (len > 0) { // TODO: unexpected - write a warning?

char *data_start = &buf[0];

bytes_to_read = len;

do {

bytes_read = read(rpipe, data_start, bytes_to_read);

if (bytes_read <= 0) {

const int err = errno;

std::cerr << "#### ThreadExecutor::handleRead(" << filename << ") error (buf) for type" << int(type) << ": " << std::strerror(err) << std::endl;

std::exit(EXIT_FAILURE);

}

bytes_to_read -= bytes_read;

data_start += bytes_read;

} while (bytes_to_read != 0);

}

if (mSettings.debugipc)

std::cout << "handleRead - " << type << " - " << buf << std::endl;

bool res = true;

if (type == PipeWriter::REPORT_OUT) {

// the first character is the color

const auto c = static_cast<Color>(buf[0]);

// TODO: avoid string copy

mErrorLogger.reportOut(buf.substr(1), c);

} else if (type == PipeWriter::REPORT_ERROR) {

ErrorMessage msg;

try {

msg.deserialize(buf);

} catch (const InternalError& e) {

std::cerr << "#### ThreadExecutor::handleRead(" << filename << ") internal error: " << e.errorMessage << std::endl;

std::exit(EXIT_FAILURE);

}

if (hasToLog(msg))

mErrorLogger.reportErr(msg);

} else if (type == PipeWriter::REPORT_SUPPR_INLINE || type == PipeWriter::REPORT_SUPPR) {

if (!buf.empty()) {

// TODO: avoid string splitting

auto parts = splitString(buf, ';');

if (parts.size() < 5)

{

// TODO: make this non-fatal

std::cerr << "#### ThreadExecutor::handleRead(" << filename << ") adding of inline suppression failed - insufficient data" << std::endl;

std::exit(EXIT_FAILURE);

}

auto suppr = SuppressionList::parseLine(parts[0]);

suppr.isInline = (type == PipeWriter::REPORT_SUPPR_INLINE);

suppr.column = strToInt<int>(parts[1]);

suppr.checked = parts[2] == "1";

suppr.matched = parts[3] == "1";

suppr.extraComment = parts[4];

for (std::size_t i = 5; i < parts.size(); i++) {

suppr.extraComment += ";" + parts[i];

}

const std::string err = mSuppressions.nomsg.addSuppression(suppr);

if (!err.empty()) {

// TODO: only update state if it doesn't exist - otherwise propagate error

mSuppressions.nomsg.updateSuppressionState(suppr); // TODO: check result

// TODO: make this non-fatal

//std::cerr << "#### ThreadExecutor::handleRead(" << filename << ") adding of inline suppression failed - " << err << std::endl;

//std::exit(EXIT_FAILURE);

}

} else if (type == PipeWriter::CHILD_END) {

result += std::stoi(buf);

res = false;

} else if (type == PipeWriter::REPORT_METRIC) {

mErrorLogger.reportMetric(buf);

} else if (type == PipeWriter::REPORT_TIMER) {

if (!mTimerResults) {

// TODO: make this non-fatal

std::cerr << "#### ThreadExecutor::handleRead(" << filename << ") received timer results when no timer is enabled" << std::endl;

std::exit(EXIT_FAILURE);

}

const auto parts = splitString(buf, ';');

if (parts.size() < 2)

{

// TODO: make this non-fatal

std::cerr << "#### ThreadExecutor::handleRead(" << filename << ") adding of timer result failed - insufficient data" << std::endl;

std::exit(EXIT_FAILURE);

}

mTimerResults->addResults(parts[0], std::chrono::milliseconds{strToInt<long>(parts[1])});

}

return res;

}

bool ProcessExecutor::checkLoadAverage(size_t nchildren)

{

#if defined(__QNX__) || defined(__HAIKU__) || defined(_AIX) // getloadavg() is unsupported on Qnx, Haiku, AIX.

(void)nchildren;

return true;

#else

if (!nchildren || !mSettings.loadAverage) {

return true;

}

double sample(0);

if (getloadavg(&sample, 1) != 1) {

// disable load average checking on getloadavg error

return true;

}

if (sample < mSettings.loadAverage) {

return true;

}

return false;

#endif

}

unsigned int ProcessExecutor::check()

{

unsigned int fileCount = 0;

unsigned int result = 0;

const std::size_t totalfilesize = std::accumulate(mFiles.cbegin(), mFiles.cend(), std::size_t(0), [](std::size_t v, const FileWithDetails& p) {

return v + p.size();

});

// pass unmodified suppressions to forked process so we only transfer back the actual changes done by the fork

// and do not see the changes which have already been transferred back

Suppressions supprs;

supprs.nomsg.addSuppressions(mSuppressions.nomsg.getSuppressions());

supprs.nofail.addSuppressions(mSuppressions.nofail.getSuppressions());

std::list<int> rpipes;

std::map<pid_t, std::string> childFile;

std::map<int, std::string> pipeFile;

std::size_t processedsize = 0;

auto iFile = mFiles.cbegin();

auto iFileSettings = mFileSettings.cbegin();

for (;;) {

// Start a new child

const size_t nchildren = childFile.size();

if ((iFile != mFiles.cend() || iFileSettings != mFileSettings.cend()) && nchildren < mSettings.jobs && checkLoadAverage(nchildren)) {

int pipes[2];

if (pipe(pipes) == -1) {

std::cerr << "#### ThreadExecutor::check, pipe() failed: "<< std::strerror(errno) << std::endl;

std::exit(EXIT_FAILURE);

}

const int flags = fcntl(pipes[0], F_GETFL, 0);

if (flags < 0) {

std::cerr << "#### ThreadExecutor::check, fcntl(F_GETFL) failed: "<< std::strerror(errno) << std::endl;

std::exit(EXIT_FAILURE);

}

if (fcntl(pipes[0], F_SETFL, flags) < 0) {

std::cerr << "#### ThreadExecutor::check, fcntl(F_SETFL) failed: "<< std::strerror(errno) << std::endl;

std::exit(EXIT_FAILURE);

}

const pid_t pid = fork();

if (pid < 0) {

// Error

std::cerr << "#### ThreadExecutor::check, Failed to create child process: "<< std::strerror(errno) << std::endl;

std::exit(EXIT_FAILURE);

} else if (pid == 0) {

#if defined(__linux__)

prctl(PR_SET_PDEATHSIG, SIGHUP);

#endif

close(pipes[0]);

// create a separate result object so we do not get the results which have already been transferred back

std::unique_ptr<TimerResults> timerResults;

if (mTimerResults)

timerResults.reset(new TimerResults);

PipeWriter pipewriter(pipes[1], mSettings.debugipc);

CppCheck fileChecker(mSettings, supprs, pipewriter, timerResults.get(), false, mExecuteCommand);

unsigned int resultOfCheck = 0;

if (iFileSettings != mFileSettings.end()) {

resultOfCheck = fileChecker.check(*iFileSettings);

} else {

// Read file from a file

resultOfCheck = fileChecker.check(*iFile);

}

pipewriter.writeSuppr(supprs.nomsg);

pipewriter.writeTimer(timerResults.get());

pipewriter.writeEnd(std::to_string(resultOfCheck));

std::exit(EXIT_SUCCESS);

}

close(pipes[1]);

rpipes.push_back(pipes[0]);

if (iFileSettings != mFileSettings.end()) {

childFile[pid] = iFileSettings->filename() + ' ' + iFileSettings->cfg;

pipeFile[pipes[0]] = iFileSettings->filename() + ' ' + iFileSettings->cfg;

++iFileSettings;

} else {

childFile[pid] = iFile->path();

pipeFile[pipes[0]] = iFile->path();

++iFile;

}

if (!rpipes.empty()) {

fd_set rfds;

FD_ZERO(&rfds);

for (auto rp = rpipes.cbegin(); rp != rpipes.cend(); ++rp)

FD_SET(*rp, &rfds);

timeval tv; // for every second polling of load average condition

tv.tv_sec = 1;

tv.tv_usec = 0;

const int r = select(*std::max_element(rpipes.cbegin(), rpipes.cend()) + 1, &rfds, nullptr, nullptr, &tv);

if (r > 0) {

auto rp = rpipes.cbegin();

while (rp != rpipes.cend()) {

if (FD_ISSET(*rp, &rfds)) {

std::string name;

const auto p = utils::as_const(pipeFile).find(*rp);

if (p != pipeFile.cend()) {

name = p->second;

}

const bool readRes = handleRead(*rp, result, name);

if (!readRes) {

std::size_t size = 0;

if (p != pipeFile.cend()) {

pipeFile.erase(p);

const auto fs = std::find_if(mFiles.cbegin(), mFiles.cend(), [&name](const FileWithDetails& entry) {

return entry.path() == name;

});

if (fs != mFiles.end()) {

size = fs->size();

}

fileCount++;

processedsize += size;

if (!mSettings.quiet)

Executor::reportStatus(fileCount, mFiles.size() + mFileSettings.size(), processedsize, totalfilesize);

close(*rp);

rp = rpipes.erase(rp);

} else

++rp;

} else

++rp;

}

if (!childFile.empty()) {

int stat = 0;

const pid_t child = waitpid(0, &stat, WNOHANG);

if (child > 0) {

std::string childname;

const auto c = utils::as_const(childFile).find(child);

if (c != childFile.cend()) {

childname = c->second;

childFile.erase(c);

}

if (WIFEXITED(stat)) {

const int exitstatus = WEXITSTATUS(stat);

if (exitstatus != EXIT_SUCCESS) {

std::ostringstream oss;

oss << "Child process exited with " << exitstatus;

reportInternalChildErr(childname, oss.str());

}

} else if (WIFSIGNALED(stat)) {

std::ostringstream oss;

oss << "Child process crashed with signal " << WTERMSIG(stat);

reportInternalChildErr(childname, oss.str());

}

if (iFile == mFiles.end() && iFileSettings == mFileSettings.end() && rpipes.empty() && childFile.empty()) {

// All done

break;

}

// TODO: we need to get the timing information from the subprocess

return result;

}

void ProcessExecutor::reportInternalChildErr(const std::string &childname, const std::string &msg)

{

std::list<ErrorMessage::FileLocation> locations;

locations.emplace_back(childname, 0, 0);

const ErrorMessage errmsg(std::move(locations),

"",

Severity::error,

"Internal error: " + msg,

"cppcheckError",

Certainty::normal);

if (hasToLog(errmsg))

mErrorLogger.reportErr(errmsg);

}

#endif // HAS_THREADING_MODEL_FORK

cppcheck/cli/processexecutor.cpp at main · cppcheck-opensource/cppcheck · GitHub

Uh oh!

Expand file tree

Breadcrumbs

processexecutor.cpp

Latest commit

History

Breadcrumbs

processexecutor.cpp

File metadata and controls