thread_pool.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2015, Hewlett-Packard Development Company, LP.
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * HP designates this particular file as subject to the "Classpath" exception
 * as provided by HP in the LICENSE.txt file that accompanied this code.
 */
#ifndef FOEDUS_THREAD_THREAD_POOL_HPP_
#define FOEDUS_THREAD_THREAD_POOL_HPP_
#include <stdint.h>

#include <iosfwd>

#include "foedus/cxx11.hpp"
#include "foedus/fwd.hpp"
#include "foedus/initializable.hpp"
#include "foedus/proc/proc_id.hpp"
#include "foedus/thread/fwd.hpp"
#include "foedus/thread/impersonate_session.hpp"

namespace foedus {
namespace thread {

class ThreadPool CXX11_FINAL : public virtual Initializable {
 public:
  ThreadPool() CXX11_FUNC_DELETE;
  explicit ThreadPool(Engine *engine);
  ~ThreadPool();
  ErrorStack  initialize() CXX11_OVERRIDE;
  bool        is_initialized() const CXX11_OVERRIDE;
  ErrorStack  uninitialize() CXX11_OVERRIDE;

  bool impersonate(
    const proc::ProcName& proc_name,
    const void* task_input,
    uint64_t task_input_size,
    ImpersonateSession *session);

  ErrorStack impersonate_synchronous(
    const proc::ProcName& proc_name,
    const void* task_input = CXX11_NULLPTR,
    uint64_t task_input_size = 0) {
    ImpersonateSession session;
    if (!impersonate(proc_name, task_input, task_input_size, &session)) {
      return ERROR_STACK(kErrorCodeThrNoThreadAvailable);
    }
    return session.get_result();
  }

  bool impersonate_on_numa_node(
    ThreadGroupId node,
    const proc::ProcName& proc_name,
    const void* task_input,
    uint64_t task_input_size,
    ImpersonateSession *session);

  ErrorStack impersonate_on_numa_node_synchronous(
    ThreadGroupId node,
    const proc::ProcName& proc_name,
    const void* task_input = CXX11_NULLPTR,
    uint64_t task_input_size = 0) {
    ImpersonateSession session;
    if (!impersonate_on_numa_node(node, proc_name, task_input, task_input_size, &session)) {
      return ERROR_STACK(kErrorCodeThrNoThreadAvailable);
    }
    return session.get_result();
  }

  bool impersonate_on_numa_core(
    ThreadId core,
    const proc::ProcName& proc_name,
    const void* task_input,
    uint64_t task_input_size,
    ImpersonateSession *session);

  ErrorStack impersonate_on_numa_core_synchronous(
    ThreadId core,
    const proc::ProcName& proc_name,
    const void* task_input = CXX11_NULLPTR,
    uint64_t task_input_size = 0) {
    ImpersonateSession session;
    if (!impersonate_on_numa_core(core, proc_name, task_input, task_input_size, &session)) {
      return ERROR_STACK(kErrorCodeThrNoThreadAvailable);
    }
    return session.get_result();
  }

  ThreadPoolPimpl*    get_pimpl() const { return pimpl_; }

  ThreadGroupRef*     get_group_ref(ThreadGroupId numa_node);
  ThreadRef*          get_thread_ref(ThreadId id);

  friend  std::ostream& operator<<(std::ostream& o, const ThreadPool& v);

 private:
  ThreadPoolPimpl*    pimpl_;
};
}  // namespace thread
}  // namespace foedus
#endif  // FOEDUS_THREAD_THREAD_POOL_HPP_