1
0
Fork 0
arangodb/lib/Basics/Thread.cpp

348 lines
10 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// @brief Thread
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2014 ArangoDB GmbH, Cologne, Germany
/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
/// http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Dr. Frank Celler
/// @author Achim Brandt
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
/// @author Copyright 2008-2013, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
#include "Thread.h"
#ifdef _WIN32
#include "Basics/win-utils.h"
#endif
#include <errno.h>
#include <signal.h>
#include "Basics/ConditionLocker.h"
#include "Basics/Exceptions.h"
#include "Basics/logging.h"
using namespace triagens::basics;
// -----------------------------------------------------------------------------
// --SECTION-- static private methods
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief static started with access to the private variables
////////////////////////////////////////////////////////////////////////////////
void Thread::startThread (void* arg) {
Thread * ptr = static_cast<Thread*>(arg);
ptr->runMe();
ptr->cleanup();
}
// -----------------------------------------------------------------------------
// --SECTION-- static public methods
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief returns the process id
////////////////////////////////////////////////////////////////////////////////
TRI_pid_t Thread::currentProcessId () {
return TRI_CurrentProcessId();
}
////////////////////////////////////////////////////////////////////////////////
/// @brief returns the thread process id
////////////////////////////////////////////////////////////////////////////////
TRI_pid_t Thread::currentThreadProcessId () {
return TRI_CurrentThreadProcessId();
}
////////////////////////////////////////////////////////////////////////////////
/// @brief returns the thread id
////////////////////////////////////////////////////////////////////////////////
TRI_tid_t Thread::currentThreadId () {
return TRI_CurrentThreadId();
}
// -----------------------------------------------------------------------------
// --SECTION-- constructors and destructors
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief constructs a thread
////////////////////////////////////////////////////////////////////////////////
Thread::Thread (std::string const& name)
: _name(name),
_asynchronousCancelation(false),
_thread(),
_threadId(),
_finishedCondition(nullptr),
_started(0),
_running(0),
_joined(0),
_affinity(-1) {
TRI_InitThread(&_thread);
}
////////////////////////////////////////////////////////////////////////////////
/// @brief deletes the thread
////////////////////////////////////////////////////////////////////////////////
Thread::~Thread () {
if (_running != 0) {
if (! isSilent()) {
LOG_WARNING("forcefully shutting down thread '%s'", _name.c_str());
}
int res = TRI_StopThread(&_thread);
if (res != TRI_ERROR_NO_ERROR) {
errno = res;
TRI_set_errno(TRI_ERROR_SYS_ERROR);
LOG_WARNING("unable to stop thread '%s': %s", _name.c_str(), TRI_last_error());
}
}
if (! _joined) {
int res = TRI_DetachThread(&_thread);
// ignore threads that already died
if (res != 0 && res != ESRCH) {
errno = res;
TRI_set_errno(TRI_ERROR_SYS_ERROR);
LOG_WARNING("unable to detach thread '%s': %s", _name.c_str(), TRI_last_error());
}
}
}
// -----------------------------------------------------------------------------
// --SECTION-- public methods
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief whether or not the thread is chatty on shutdown
////////////////////////////////////////////////////////////////////////////////
bool Thread::isSilent () {
return false;
}
////////////////////////////////////////////////////////////////////////////////
/// @brief getter for running
////////////////////////////////////////////////////////////////////////////////
bool Thread::isRunning () {
return _running != 0;
}
////////////////////////////////////////////////////////////////////////////////
/// @brief returns a thread identifier
////////////////////////////////////////////////////////////////////////////////
TRI_tid_t Thread::threadId () {
return _threadId;
}
////////////////////////////////////////////////////////////////////////////////
/// @brief starts the thread
////////////////////////////////////////////////////////////////////////////////
bool Thread::start (ConditionVariable * finishedCondition) {
_finishedCondition = finishedCondition;
if (_started != 0) {
LOG_FATAL_AND_EXIT("called started on an already started thread");
}
_started = 1;
std::string text = "[" + _name + "]";
bool ok = TRI_StartThread(&_thread, &_threadId, text.c_str(), &startThread, this);
if (! ok) {
LOG_ERROR("could not start thread '%s': %s", _name.c_str(), strerror(errno));
}
if (0 <= _affinity) {
TRI_SetProcessorAffinity(&_thread, (size_t) _affinity);
}
return ok;
}
////////////////////////////////////////////////////////////////////////////////
/// @brief stops the thread
////////////////////////////////////////////////////////////////////////////////
int Thread::stop () {
if (_running != 0) {
LOG_TRACE("trying to cancel (aka stop) the thread '%s'", _name.c_str());
return TRI_StopThread(&_thread);
}
return TRI_ERROR_NO_ERROR;
}
////////////////////////////////////////////////////////////////////////////////
/// @brief joins the thread
////////////////////////////////////////////////////////////////////////////////
int Thread::join () {
int res = TRI_ERROR_NO_ERROR;
if (! _joined) {
res = TRI_JoinThread(&_thread);
if (res == TRI_ERROR_NO_ERROR) {
_joined = 1;
}
}
return res;
}
////////////////////////////////////////////////////////////////////////////////
/// @brief stops and joins the thread
////////////////////////////////////////////////////////////////////////////////
int Thread::shutdown () {
size_t const MAX_TRIES = 10;
size_t const WAIT = 10000;
for (size_t i = 0; i < MAX_TRIES; ++i) {
if (_running == 0) {
break;
}
usleep(WAIT);
}
if (_running != 0) {
int res = TRI_StopThread(&_thread);
if (res != TRI_ERROR_NO_ERROR) {
errno = res;
TRI_set_errno(TRI_ERROR_SYS_ERROR);
LOG_WARNING("unable to stop thread '%s': %s",
_name.c_str(),
TRI_last_error());
}
}
return this->join();
}
////////////////////////////////////////////////////////////////////////////////
/// @brief sets the process affinity
////////////////////////////////////////////////////////////////////////////////
void Thread::setProcessorAffinity (size_t c) {
_affinity = (int) c;
}
// -----------------------------------------------------------------------------
// --SECTION-- protected methods
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief allows asynchronous cancelation
////////////////////////////////////////////////////////////////////////////////
void Thread::allowAsynchronousCancelation () {
if (_started) {
if (_running) {
if (TRI_IsSelfThread(&_thread)) {
LOG_DEBUG("set asynchronous cancelation for thread '%s'", _name.c_str());
TRI_AllowCancelation();
}
else {
LOG_ERROR("cannot change cancelation type of an already running thread from the outside");
}
}
else {
LOG_WARNING("thread has already stopped, it is useless to change the cancelation type");
}
}
else {
_asynchronousCancelation = true;
}
}
// -----------------------------------------------------------------------------
// --SECTION-- private methods
// -----------------------------------------------------------------------------
void Thread::runMe () {
if (_asynchronousCancelation) {
LOG_DEBUG("set asynchronous cancelation for thread '%s'", _name.c_str());
TRI_AllowCancelation();
}
_running = 1;
try {
run();
}
catch (Exception const& ex) {
LOG_ERROR("exception caught in thread '%s': %s", _name.c_str(), ex.what());
TRI_FlushLogging();
throw;
}
catch (std::exception const& ex) {
LOG_ERROR("exception caught in thread '%s': %s", _name.c_str(), ex.what());
TRI_FlushLogging();
throw;
}
catch (...) {
_running = 0;
if (! isSilent()) {
LOG_ERROR("exception caught in thread '%s'", _name.c_str());
TRI_FlushLogging();
}
throw;
}
_running = 0;
if (_finishedCondition != nullptr) {
CONDITION_LOCKER(locker, *_finishedCondition);
locker.broadcast();
}
}
// -----------------------------------------------------------------------------
// --SECTION-- END-OF-FILE
// -----------------------------------------------------------------------------
// Local Variables:
// mode: outline-minor
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
// End: