thread.hpp

Go to the documentation of this file.

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Christian Schulte <schulte@gecode.dev>
 *
 *  Copyright:
 *     Christian Schulte, 2009
 *
 *  Bugfixes provided by:
 *     David Rijsman <david.rijsman@quintiq.com>
 *
 *  This file is part of Gecode, the generic constraint
 *  development environment:
 *     http://www.gecode.dev
 *
 *  Permission is hereby granted, free of charge, to any person obtaining
 *  a copy of this software and associated documentation files (the
 *  "Software"), to deal in the Software without restriction, including
 *  without limitation the rights to use, copy, modify, merge, publish,
 *  distribute, sublicense, and/or sell copies of the Software, and to
 *  permit persons to whom the Software is furnished to do so, subject to
 *  the following conditions:
 *
 *  The above copyright notice and this permission notice shall be
 *  included in all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
 
#include <cstddef>
#include <atomic>
 
#ifdef GECODE_HAS_THREADS
#include <thread>
#include <mutex>
#include <condition_variable>
 
#ifdef GECODE_USE_OSX_UNFAIR_MUTEX
#include <os/lock.h>
#include <libkern/OSAtomic.h>
#endif
 
#endif

 
namespace Gecode { namespace Support {

  class Mutex {
  private:
#ifdef GECODE_HAS_THREADS
#ifndef GECODE_USE_OSX_UNFAIR_MUTEX
    std::mutex m;
#else
    os_unfair_lock l;
#endif
#endif
  public:
    Mutex(void);
    void acquire(void);
    bool tryacquire(void);
    void release(void);
    static void* operator new(size_t s);
    static void  operator delete(void* p);
  private:
    Mutex(const Mutex&) {}
    void operator=(const Mutex&) {}
  };

  class Lock {
  private:
    Mutex& m;
  public:
    Lock(Mutex& m0);
    ~Lock(void);
  private:
    Lock(const Lock& l) : m(l.m) {}
    void operator=(const Lock&) {}
  };

  class Event {
  private:
#ifdef GECODE_HAS_THREADS
    std::mutex m;
    std::condition_variable c;
#endif
    bool s;
  public:
    Event(void);
    void signal(void);
    void wait(void);
  private:
    Event(const Event&) {}
    void operator=(const Event&) {}
  };

  class Terminator {
  public:
    virtual ~Terminator() {}
    virtual void terminated(void) = 0;
  };

  class Runnable {
  private:
    bool d;
  public:
    Runnable(bool d=true);
    void todelete(bool d);
    bool todelete(void) const;
    virtual Terminator* terminator(void) const { return nullptr; }
    virtual void run(void) = 0;
    virtual ~Runnable(void) {}
    static void* operator new(size_t s);
    static void  operator delete(void* p);
  };

  class Thread {
  public:
    class Run {
    public:
      Run* n;
      std::atomic<Runnable*> r;
      Event e;
      GECODE_SUPPORT_EXPORT Run(Runnable* r);
      GECODE_SUPPORT_EXPORT void exec(void);
      void run(Runnable* r);
      static void* operator new(size_t s);
      static void  operator delete(void* p);
    };

    GECODE_SUPPORT_EXPORT static Mutex* m(void);
    GECODE_SUPPORT_EXPORT static Run* idle;
  public:
    static void run(Runnable* r);
    static void sleep(unsigned int ms);
    static unsigned int npu(void);
    GECODE_SUPPORT_EXPORT static void acquireGlobalMutex(Mutex* m);
    GECODE_SUPPORT_EXPORT static void releaseGlobalMutex(Mutex* m);
  private:
    Thread(const Thread&) {}
    void operator=(const Thread&) {}
  };
 
}}
 
// STATISTICS: support-any