2009-02-19 23:21:18 +01:00
|
|
|
/*
|
|
|
|
* Cppcheck - A tool for static C/C++ code analysis
|
2022-02-05 11:45:17 +01:00
|
|
|
* Copyright (C) 2007-2022 Cppcheck team.
|
2009-02-19 23:21:18 +01:00
|
|
|
*
|
|
|
|
* 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
|
2009-09-27 17:08:31 +02:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2009-02-19 23:21:18 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef THREADEXECUTOR_H
|
|
|
|
#define THREADEXECUTOR_H
|
|
|
|
|
2021-07-08 21:21:35 +02:00
|
|
|
#include "color.h"
|
2020-04-13 13:44:48 +02:00
|
|
|
#include "config.h"
|
2009-02-19 23:21:18 +01:00
|
|
|
#include "errorlogger.h"
|
|
|
|
|
2017-05-27 04:33:47 +02:00
|
|
|
#include <cstddef>
|
|
|
|
#include <list>
|
|
|
|
#include <map>
|
|
|
|
#include <string>
|
|
|
|
|
2021-01-09 20:32:38 +01:00
|
|
|
#if ((defined(__GNUC__) || defined(__sun)) && !defined(__MINGW32__) && !defined(__CYGWIN__)) || defined(__CPPCHECK__)
|
2011-03-04 23:27:29 +01:00
|
|
|
#define THREADING_MODEL_FORK
|
2012-12-12 19:09:37 +01:00
|
|
|
#elif defined(_WIN32)
|
|
|
|
#define THREADING_MODEL_WIN
|
2020-04-13 13:44:48 +02:00
|
|
|
#include "importproject.h"
|
2021-12-15 19:47:27 +01:00
|
|
|
#include <mutex>
|
2022-01-18 22:02:25 +01:00
|
|
|
#else
|
|
|
|
#error "No threading moodel defined"
|
2011-03-04 23:27:29 +01:00
|
|
|
#endif
|
|
|
|
|
2012-04-26 15:29:39 +02:00
|
|
|
class Settings;
|
|
|
|
|
2011-02-01 07:33:02 +01:00
|
|
|
/// @addtogroup CLI
|
|
|
|
/// @{
|
|
|
|
|
2009-02-19 23:21:18 +01:00
|
|
|
/**
|
|
|
|
* This class will take a list of filenames and settings and check then
|
|
|
|
* all files using threads.
|
|
|
|
*/
|
2011-10-13 20:53:06 +02:00
|
|
|
class ThreadExecutor : public ErrorLogger {
|
2009-02-19 23:21:18 +01:00
|
|
|
public:
|
2017-04-01 09:31:27 +02:00
|
|
|
ThreadExecutor(const std::map<std::string, std::size_t> &files, Settings &settings, ErrorLogger &errorLogger);
|
2019-07-15 18:45:06 +02:00
|
|
|
ThreadExecutor(const ThreadExecutor &) = delete;
|
2019-09-20 21:57:16 +02:00
|
|
|
~ThreadExecutor() OVERRIDE;
|
2019-07-15 18:45:06 +02:00
|
|
|
void operator=(const ThreadExecutor &) = delete;
|
2009-02-19 23:21:18 +01:00
|
|
|
unsigned int check();
|
2012-12-12 19:09:37 +01:00
|
|
|
|
2021-07-08 21:21:35 +02:00
|
|
|
void reportOut(const std::string &outmsg, Color c) OVERRIDE;
|
2020-05-23 07:16:49 +02:00
|
|
|
void reportErr(const ErrorMessage &msg) OVERRIDE;
|
|
|
|
void reportInfo(const ErrorMessage &msg) OVERRIDE;
|
2020-01-18 07:25:39 +01:00
|
|
|
void bughuntingReport(const std::string &str) OVERRIDE;
|
2011-04-27 22:27:02 +02:00
|
|
|
|
2010-06-14 22:18:09 +02:00
|
|
|
/**
|
|
|
|
* @brief Add content to a file, to be used in unit testing.
|
|
|
|
*
|
|
|
|
* @param path File name (used as a key to link with real file).
|
|
|
|
* @param content If the file would be a real file, this should be
|
|
|
|
* the content of the file.
|
|
|
|
*/
|
|
|
|
void addFileContent(const std::string &path, const std::string &content);
|
2009-02-19 23:21:18 +01:00
|
|
|
|
2009-02-20 20:40:42 +01:00
|
|
|
private:
|
2022-01-18 22:02:25 +01:00
|
|
|
enum class MessageType {REPORT_ERROR, REPORT_INFO};
|
|
|
|
|
2019-07-15 18:45:06 +02:00
|
|
|
const std::map<std::string, std::size_t> &mFiles;
|
|
|
|
Settings &mSettings;
|
|
|
|
ErrorLogger &mErrorLogger;
|
|
|
|
unsigned int mFileCount;
|
2009-02-20 20:40:42 +01:00
|
|
|
|
2022-01-18 22:02:25 +01:00
|
|
|
void report(const ErrorMessage &msg, MessageType msgType);
|
|
|
|
|
2012-12-12 19:09:37 +01:00
|
|
|
#if defined(THREADING_MODEL_FORK)
|
2012-02-19 17:22:59 +01:00
|
|
|
|
2010-06-14 22:18:09 +02:00
|
|
|
/** @brief Key is file name, and value is the content of the file */
|
2019-07-15 18:45:06 +02:00
|
|
|
std::map<std::string, std::string> mFileContents;
|
2009-02-20 20:40:42 +01:00
|
|
|
private:
|
2019-12-27 19:05:10 +01:00
|
|
|
enum PipeSignal {REPORT_OUT='1',REPORT_ERROR='2', REPORT_INFO='3', REPORT_VERIFICATION='4', CHILD_END='5'};
|
2012-01-03 21:21:17 +01:00
|
|
|
|
2010-07-07 14:42:39 +02:00
|
|
|
/**
|
|
|
|
* Read from the pipe, parse and handle what ever is in there.
|
|
|
|
*@return -1 in case of error
|
|
|
|
* 0 if there is nothing in the pipe to be read
|
|
|
|
* 1 if we did read something
|
|
|
|
*/
|
2011-03-05 04:43:22 +01:00
|
|
|
int handleRead(int rpipe, unsigned int &result);
|
2012-01-03 21:21:17 +01:00
|
|
|
void writeToPipe(PipeSignal type, const std::string &data);
|
2011-03-05 04:43:22 +01:00
|
|
|
/**
|
|
|
|
* Write end of status pipe, different for each child.
|
|
|
|
* Not used in master process.
|
|
|
|
*/
|
2019-07-15 18:45:06 +02:00
|
|
|
std::list<std::string> mErrorList;
|
|
|
|
int mWpipe;
|
2012-01-03 21:21:17 +01:00
|
|
|
|
2014-03-25 18:35:59 +01:00
|
|
|
/**
|
|
|
|
* @brief Check load average condition
|
2018-02-04 20:53:43 +01:00
|
|
|
* @param nchildren - count of currently ran children
|
2014-03-25 18:35:59 +01:00
|
|
|
* @return true - if new process can be started
|
|
|
|
*/
|
2014-10-01 19:33:02 +02:00
|
|
|
bool checkLoadAverage(size_t nchildren);
|
2014-03-25 18:35:59 +01:00
|
|
|
|
2020-12-03 18:06:18 +01:00
|
|
|
/**
|
|
|
|
* @brief Reports internal errors related to child processes
|
|
|
|
* @param msg The error message
|
|
|
|
*/
|
|
|
|
void reportInternalChildErr(const std::string &childname, const std::string &msg);
|
|
|
|
|
2012-12-12 19:09:37 +01:00
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* @return true if support for threads exist.
|
|
|
|
*/
|
2014-11-20 14:20:09 +01:00
|
|
|
static bool isEnabled() {
|
2012-12-12 19:09:37 +01:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
#elif defined(THREADING_MODEL_WIN)
|
|
|
|
|
|
|
|
private:
|
2019-07-15 18:45:06 +02:00
|
|
|
std::map<std::string, std::string> mFileContents;
|
|
|
|
std::map<std::string, std::size_t>::const_iterator mItNextFile;
|
|
|
|
std::list<ImportProject::FileSettings>::const_iterator mItNextFileSettings;
|
|
|
|
std::size_t mProcessedFiles;
|
|
|
|
std::size_t mTotalFiles;
|
|
|
|
std::size_t mProcessedSize;
|
|
|
|
std::size_t mTotalFileSize;
|
2021-08-24 20:39:43 +02:00
|
|
|
std::mutex mFileSync;
|
2012-12-12 19:09:37 +01:00
|
|
|
|
2019-07-15 18:45:06 +02:00
|
|
|
std::list<std::string> mErrorList;
|
2021-08-24 20:39:43 +02:00
|
|
|
std::mutex mErrorSync;
|
2012-12-12 19:09:37 +01:00
|
|
|
|
2021-08-24 20:39:43 +02:00
|
|
|
std::mutex mReportSync;
|
2012-12-12 19:09:37 +01:00
|
|
|
|
2021-08-24 20:39:43 +02:00
|
|
|
static unsigned __stdcall threadProc(ThreadExecutor *threadExecutor);
|
2012-12-12 19:09:37 +01:00
|
|
|
|
2009-02-20 20:40:42 +01:00
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* @return true if support for threads exist.
|
|
|
|
*/
|
2014-11-20 14:20:09 +01:00
|
|
|
static bool isEnabled() {
|
2009-02-20 20:40:42 +01:00
|
|
|
return true;
|
|
|
|
}
|
2009-02-19 23:21:18 +01:00
|
|
|
#else
|
|
|
|
public:
|
2009-02-20 20:40:42 +01:00
|
|
|
/**
|
|
|
|
* @return true if support for threads exist.
|
|
|
|
*/
|
2014-11-20 14:20:09 +01:00
|
|
|
static bool isEnabled() {
|
2009-02-20 20:40:42 +01:00
|
|
|
return false;
|
2009-02-19 23:21:18 +01:00
|
|
|
}
|
|
|
|
#endif
|
|
|
|
};
|
|
|
|
|
2011-02-01 07:33:02 +01:00
|
|
|
/// @}
|
|
|
|
|
2009-02-19 23:21:18 +01:00
|
|
|
#endif // THREADEXECUTOR_H
|