123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282 |
- /*
- * Copyright 2005 - 2016 Zarafa and its licensors
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * 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 Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
- */
- #include <chrono>
- #include <condition_variable>
- #include <utility>
- #include <kopano/platform.h>
- #include <kopano/ECThreadPool.h>
- #include <kopano/lockhelper.hpp>
- #include <algorithm>
- #include <sys/time.h> /* gettimeofday */
- namespace KC {
- /**
- * Construct an ECThreadPool instance.
- * @param[in] ulThreadCount The amount of worker hreads to create.
- */
- ECThreadPool::ECThreadPool(unsigned ulThreadCount)
- {
- setThreadCount(ulThreadCount);
- }
- /**
- * Destruct an ECThreadPool instance. This blocks until all worker
- * threads have exited.
- */
- ECThreadPool::~ECThreadPool()
- {
- setThreadCount(0, true);
- }
- /**
- * Dispatch a task object on the threadpool instance.
- * @param[in] lpTask The task object to dispatch.
- * @param[in] bTakeOwnership Boolean parameter specifying wether the threadpool
- * should take ownership of the task object, and thus
- * is responsible for deleting the object when done.
- * @returns true if the task was successfully queued, false otherwise.
- */
- bool ECThreadPool::dispatch(ECTask *lpTask, bool bTakeOwnership)
- {
- STaskInfo sTaskInfo = {lpTask, bTakeOwnership, {0, 0}};
-
- gettimeofday(&sTaskInfo.tvQueueTime, NULL);
-
- ulock_normal locker(m_hMutex);
- m_listTasks.push_back(std::move(sTaskInfo));
- m_hCondition.notify_one();
- joinTerminated(locker);
- return true;
- }
- /**
- * Set the amount of worker threads for the threadpool.
- * @param[in] ulThreadCount The amount of required worker threads.
- * @param[in] bWait If the requested amount of worker threads is less
- * than the current amount, this method will wait until
- * the extra threads have exited if this argument is true.
- */
- void ECThreadPool::setThreadCount(unsigned ulThreadCount, bool bWait)
- {
- ulock_normal locker(m_hMutex);
-
- if (ulThreadCount == threadCount() - 1) {
- ++m_ulTermReq;
- m_hCondition.notify_one();
- }
-
- else if (ulThreadCount < threadCount()) {
- m_ulTermReq += (threadCount() - ulThreadCount);
- m_hCondition.notify_all();
- }
- else {
- unsigned ulThreadsToAdd = ulThreadCount - threadCount();
-
- if (ulThreadsToAdd <= m_ulTermReq)
- m_ulTermReq -= ulThreadsToAdd;
-
- else {
- ulThreadsToAdd -= m_ulTermReq;
- m_ulTermReq = 0;
-
- for (unsigned i = 0; i < ulThreadsToAdd; ++i) {
- pthread_t hThread;
-
- pthread_create(&hThread, NULL, &threadFunc, this);
- set_thread_name(hThread, "ECThreadPool");
- m_setThreads.insert(hThread);
- }
- }
- }
-
- while (bWait && m_setThreads.size() > ulThreadCount) {
- m_hCondTerminated.wait(locker);
- joinTerminated(locker);
- }
- assert(threadCount() == ulThreadCount);
- joinTerminated(locker);
- }
- /**
- * Get the next task from the queue (or terminate thread).
- * This method normally pops the next task object from the queue. However when
- * the number of worker threads needs to be decreased this method will remove the
- * calling thread from the set of available worker threads and return false to
- * inform the caller that it should exit.
- *
- * @param[out] lpsTaskInfo A STaskInfo struct containing the task to be executed.
- * @retval true The next task was successfully obtained.
- * @retval false The thread was requested to exit.
- */
- bool ECThreadPool::getNextTask(STaskInfo *lpsTaskInfo, ulock_normal &locker)
- {
- assert(locker.owns_lock());
- assert(lpsTaskInfo != NULL);
- bool bTerminate = false;
- while ((bTerminate = (m_ulTermReq > 0)) == false && m_listTasks.empty())
- m_hCondition.wait(locker);
-
- if (bTerminate) {
- auto iThread = std::find_if(m_setThreads.cbegin(), m_setThreads.cend(), &isCurrentThread);
- assert(iThread != m_setThreads.cend());
- m_setTerminated.insert(*iThread);
- m_setThreads.erase(iThread);
- --m_ulTermReq;
- m_hCondTerminated.notify_one();
- return false;
- }
-
- *lpsTaskInfo = m_listTasks.front();
- m_listTasks.pop_front();
- return true;
- }
- /**
- * Call pthread_join on all terminated threads for cleanup.
- */
- void ECThreadPool::joinTerminated(ulock_normal &locker)
- {
- assert(locker.owns_lock());
- for (auto thr : m_setTerminated)
- pthread_join(thr, NULL);
-
- m_setTerminated.clear();
- }
- /**
- * Check if the calling thread equals the passed thread handle.
- * @param[in] hThread The thread handle to compare with.
- * @retval true when matched, false otherwise.
- */
- inline bool ECThreadPool::isCurrentThread(const pthread_t &hThread)
- {
- return pthread_equal(hThread, pthread_self()) != 0;
- }
- /**
- * The main loop of the worker threads.
- * @param[in] lpVoid Pointer to the owning ECThreadPool object cast to a void pointer.
- * @returns NULL
- */
- void* ECThreadPool::threadFunc(void *lpVoid)
- {
- auto lpPool = static_cast<ECThreadPool *>(lpVoid);
-
- while (true) {
- STaskInfo sTaskInfo = {NULL, false};
- bool bResult = false;
-
- ulock_normal locker(lpPool->m_hMutex);
- bResult = lpPool->getNextTask(&sTaskInfo, locker);
- locker.unlock();
- if (!bResult)
- break;
-
- assert(sTaskInfo.lpTask != NULL);
- sTaskInfo.lpTask->execute();
- if (sTaskInfo.bDelete)
- delete sTaskInfo.lpTask;
- lpPool->m_hCondTaskDone.notify_one();
- }
-
- return NULL;
- }
- /**
- * Execute an ECTask instance, just calls the run() method of the derived class.
- */
- void ECTask::execute()
- {
- run();
- }
- /**
- * Construct an ECWaitableTask object.
- */
- ECWaitableTask::ECWaitableTask()
- : m_state(Idle)
- {
- }
- /**
- * Destruct an ECWaitableTask object.
- */
- ECWaitableTask::~ECWaitableTask()
- {
- wait(WAIT_INFINITE, Idle|Done);
- }
- /**
- * Execute an ECWaitableTask object.
- * This calls ECTask::execute and makes sure any blocking threads will be notified when done.
- */
- void ECWaitableTask::execute()
- {
- ulock_normal big(m_hMutex);
- m_state = Running;
- m_hCondition.notify_all();
- big.unlock();
- ECTask::execute();
-
- big.lock();
- m_state = Done;
- m_hCondition.notify_all();
- big.unlock();
- }
- /**
- * Wait for an ECWaitableTask instance to finish.
- * @param[in] timeout Timeout in ms to wait for the task to finish. Pass 0 don't block at all or WAIT_INFINITE to block indefinitely.
- * @param[in] waitMask Mask of the combined states for which this function will wait. Default is Done, causing this function to wait
- * until the task is executed. The destructor for instance used Idle|Done, causing this function to only wait when
- * the task is currently running.
- * @retval true if the task state matches any state in waitMask, false otherwise.
- */
- bool ECWaitableTask::wait(unsigned timeout, unsigned waitMask) const
- {
- bool bResult = false;
- ulock_normal locker(m_hMutex);
-
- switch (timeout) {
- case 0:
- bResult = ((m_state & waitMask) != 0);
- break;
-
- case WAIT_INFINITE:
- m_hCondition.wait(locker, [&](void) { return m_state & waitMask; });
- bResult = true;
- break;
-
- default:
- while (!(m_state & waitMask))
- if (m_hCondition.wait_for(locker, std::chrono::milliseconds(timeout)) ==
- std::cv_status::timeout)
- break;
- bResult = ((m_state & waitMask) != 0);
- break;
- }
- return bResult;
- }
- } /* namespace */
|