thread_id.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_ID_HPP_
#define FOEDUS_THREAD_THREAD_ID_HPP_
#include <stdint.h>

#include "foedus/cxx11.hpp"

namespace foedus {
namespace thread {
typedef uint8_t ThreadGroupId;

#ifndef DISABLE_CXX11_IN_PUBLIC_HEADERS
CXX11_STATIC_ASSERT (sizeof(ThreadGroupId) == 1, "Max NUMA node count must be 1 byte");
#endif  // DISABLE_CXX11_IN_PUBLIC_HEADERS

const ThreadGroupId kMaxThreadGroupId = 0xFF;

typedef uint8_t ThreadLocalOrdinal;

#ifndef DISABLE_CXX11_IN_PUBLIC_HEADERS
CXX11_STATIC_ASSERT (sizeof(ThreadLocalOrdinal) == 1, "Max core-per-node must be 1 byte");
#endif  // DISABLE_CXX11_IN_PUBLIC_HEADERS

const ThreadLocalOrdinal kMaxThreadLocalOrdinal = 0xFF;

typedef uint16_t ThreadId;

#ifndef DISABLE_CXX11_IN_PUBLIC_HEADERS
CXX11_STATIC_ASSERT (sizeof(ThreadId) == 2, "Max thread count must be 2 bytes");
#endif  // DISABLE_CXX11_IN_PUBLIC_HEADERS

typedef uint16_t ThreadGlobalOrdinal;

const ThreadId kMaxThreadId = 0xFFFF;

typedef uint64_t ThreadTicket;

inline ThreadId compose_thread_id(ThreadGroupId node, ThreadLocalOrdinal local_core) {
  return (node << 8) | local_core;
}

inline ThreadGroupId decompose_numa_node(ThreadId global_id) {
  return (global_id >> 8) & 0xFF;
}

inline ThreadLocalOrdinal decompose_numa_local_ordinal(ThreadId global_id) {
  return global_id & 0xFF;
}

inline ThreadGlobalOrdinal to_global_ordinal(ThreadId thread_id, uint8_t threads_per_nodes) {
  return decompose_numa_node(thread_id) * threads_per_nodes
    + decompose_numa_local_ordinal(thread_id);
}

typedef int64_t TimeoutMicrosec;

enum ThreadPolicy {
  kScheduleOther = 0,
  kScheduleFifo = 1,
  kScheduleRr = 2,
  kScheduleBatch = 3,
  kScheduleIdle = 5,
  // no SCHED_DEADLINE. Too new (linux 3.14~).
};
enum ThreadPriority {
  kPriorityIdle = 0,
  kPriorityLowest = 1,
  kPriorityDefault = 50,
  kPriorityHighest = 99,
};

enum ThreadStatus {
  kNotInitialized = 0,
  kWaitingForTask,
  kWaitingForExecution,
  kRunningTask,
  kWaitingForClientRelease,
  kWaitingForTerminate,
  kTerminated,
};

}  // namespace thread
}  // namespace foedus
#endif  // FOEDUS_THREAD_THREAD_ID_HPP_