os0thread-create.h

Go to the documentation of this file.

/*****************************************************************************
 
Copyright (c) 1995, 2026, Oracle and/or its affiliates.
 
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License, version 2.0, as published by the
Free Software Foundation.
 
This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation.  The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.
 
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, version 2.0,
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.,
51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
 
*****************************************************************************/
 
/** @file include/os0thread-create.h
 The interface to the threading wrapper
 
 Created 2016-May-17 Sunny Bains
 *******************************************************/
 
#ifndef os0thread_create_h
#define os0thread_create_h
 
#include <my_thread.h>
 
#include "univ.i"
 
#include "os0thread.h"
#include "sql/sql_class.h"
#include "sql_thd_internal_api.h"
#include "sync0debug.h"
 
#include <atomic>
#include <functional>
 
#ifdef HAVE_ASAN
#include <sanitizer/asan_interface.h>
#endif
 
/** Maximum number of threads inside InnoDB */
extern uint32_t srv_max_n_threads;
 
/** Number of threads active. */
extern std::atomic_int os_thread_count;
 
/** Initializes OS thread management data structures. */
inline void os_thread_open() { /* No op */
}
 
/** Check if there are threads active.
@return true if the thread count > 0. */
inline bool os_thread_any_active() {
  return os_thread_count.load(std::memory_order_relaxed) > 0;
}
 
/** Frees OS thread management data structures. */
inline void os_thread_close() {
  if (os_thread_any_active()) {
    ib::warn(ER_IB_MSG_1274, os_thread_count.load(std::memory_order_relaxed));
  }
}
 
/** Register with MySQL infrastructure. */
class MySQL_thread {
 public:
#ifdef UNIV_PFS_THREAD
  /** Constructor for the Runnable object.
  @param[in]    pfs_key         Performance schema key
  @param[in]    pfs_seqnum      Performance schema sequence number */
  explicit MySQL_thread(mysql_pfs_key_t pfs_key, PSI_thread_seqnum pfs_seqnum)
      : m_pfs_key(pfs_key), m_pfs_seqnum(pfs_seqnum) {}
#else
  /** Constructor for the Runnable object.
  @param[in]    pfs_key         Performance schema key (ignored)
  @param[in]    pfs_seqnum      Performance schema sequence number */
  explicit MySQL_thread(mysql_pfs_key_t, PSI_thread_seqnum) {}
#endif /* UNIV_PFS_THREAD */
 
 protected:
  /** Register the thread with the server */
  void preamble() {
    const bool ret = my_thread_init();
    ut_a(!ret);
 
#if defined(UNIV_PFS_THREAD) && !defined(UNIV_HOTBACKUP)
    if (m_pfs_key.m_value != PFS_NOT_INSTRUMENTED.m_value) {
      auto &value = m_pfs_key.m_value;
      auto psi = PSI_THREAD_CALL(new_thread)(value, m_pfs_seqnum, this, 0);
 
      PSI_THREAD_CALL(set_thread_os_id)(psi);
      PSI_THREAD_CALL(set_thread)(psi);
    }
#endif /* UNIV_PFS_THREAD && !UNIV_HOTBACKUP */
  }
 
  /** Deregister the thread */
  void epilogue() {
    my_thread_end();
 
#if defined(UNIV_PFS_THREAD) && !defined(UNIV_HOTBACKUP)
    if (m_pfs_key.m_value != PFS_NOT_INSTRUMENTED.m_value) {
      PSI_THREAD_CALL(delete_current_thread)();
    }
#endif /* UNIV_PFS_THREAD && !UNIV_HOTBACKUP */
  }
 
  /** @return a THD instance. */
  THD *create_mysql_thd() noexcept {
#ifdef UNIV_PFS_THREAD
    return create_thd(false, true, true, m_pfs_key.m_value, m_pfs_seqnum);
#else
    return create_thd(false, true, true, 0, 0);
#endif /* UNIV_PFS_THREAD */
  }
 
  /** Destroy a THD instance.
  @param[in,out] thd            Instance to destroy. */
  void destroy_mysql_thd(THD *thd) noexcept { destroy_thd(thd); }
 
 protected:
#ifdef UNIV_PFS_THREAD
  /** Performance schema key */
  const mysql_pfs_key_t m_pfs_key;
 
  /** Performance schema sequence number */
  PSI_thread_seqnum m_pfs_seqnum;
#endif /* UNIV_PFS_THREAD */
};
 
/** Execute in the context of a non detached MySQL thread. */
class Runnable : public MySQL_thread {
 public:
  /** Constructor for the Runnable object.
  @param[in]    pfs_key         Performance schema key
  @param[in]    pfs_seqnum      Performance schema sequence number */
  explicit Runnable(mysql_pfs_key_t pfs_key, PSI_thread_seqnum pfs_seqnum)
      : MySQL_thread(pfs_key, pfs_seqnum) {
    MySQL_thread::preamble();
  }
 
  /** Create and configure the current THD for this Runnable.
  @param[in] caller_thd         Source session context to copy, or nullptr. */
  dberr_t setup_thd(const THD *caller_thd = nullptr) noexcept {
    ut_ad(m_thd == nullptr);
 
    m_thd = create_current_thd(caller_thd);
    return m_thd == nullptr ? DB_OUT_OF_MEMORY : DB_SUCCESS;
  }
 
  /** Destroy the current THD and deregister the MySQL thread. */
  ~Runnable() noexcept {
    if (m_thd != nullptr) {
      destroy_current_thd(m_thd);
    }
 
    MySQL_thread::epilogue();
  }
 
  /** Method to execute the callable
  @param[in]    f               Callable object
  @param[in]    args            Variable number of args to F
  @retval f return value. */
  template <typename F, typename... Args>
  dberr_t operator()(F &&f, Args &&...args) {
    return std::invoke(std::forward<F>(f), std::forward<Args>(args)...);
  }
 
 private:
  /** Create and configure the THD used by this DDL worker invocation. */
  THD *create_current_thd(const THD *caller_thd) noexcept {
    ut_ad(current_thd == nullptr);
 
    auto thd = create_mysql_thd();
    if (thd == nullptr) {
      return nullptr;
    }
 
    ut_ad_eq(current_thd, thd);
 
    if (caller_thd != nullptr) {
#ifdef HAVE_ASAN
      ASAN_POISON_MEMORY_REGION((void *)&thd->variables,
                                sizeof(thd->variables));
      ASAN_UNPOISON_MEMORY_REGION((void *)&thd->variables.sql_mode,
                                  sizeof(thd->variables.sql_mode));
#endif
      thd->variables.sql_mode = caller_thd->variables.sql_mode;
      ut_d(Sync_point::clone_from(caller_thd);)
    }
 
    return thd;
  }
 
  /** Destroy a THD created by create_current_thd(). */
  void destroy_current_thd(THD *thd) noexcept {
    ut_ad_eq(current_thd, thd);
 
#ifdef HAVE_ASAN
    ASAN_UNPOISON_MEMORY_REGION((void *)&thd->variables,
                                sizeof(thd->variables));
#endif
    ut_d(Sync_point::erase(thd));
    destroy_mysql_thd(thd);
 
    ut_ad(current_thd == nullptr);
  }
 
  THD *m_thd{nullptr};
};
 
/** Wrapper for a callable, it will count the number of registered
Runnable instances and will register the thread executing the callable
with the PFS and the Server threading infrastructure. */
class Detached_thread : public MySQL_thread {
 public:
  /** Constructor for the detached thread.
  @param[in]    pfs_key         Performance schema key
  @param[in]    pfs_seqnum      Performance schema sequence number */
  explicit Detached_thread(mysql_pfs_key_t pfs_key,
                           PSI_thread_seqnum pfs_seqnum)
      : MySQL_thread(pfs_key, pfs_seqnum) {
    init();
  }
 
  /** Method to execute the callable
  @param[in]    f               Callable object
  @param[in]    args            Variable number of args to F */
  template <typename F, typename... Args>
  void operator()(F &&f, Args &&...args) {
    while (m_thread.state() == IB_thread::State::NOT_STARTED) {
      UT_RELAX_CPU();
    }
 
    ut_a(m_thread.state() == IB_thread::State::ALLOWED_TO_START);
 
    preamble();
 
    m_thread.set_state(IB_thread::State::STARTED);
 
    std::invoke(std::forward<F>(f), std::forward<Args>(args)...);
 
    epilogue();
 
    m_thread.set_state(IB_thread::State::STOPPED);
  }
 
  /** @return thread handle. */
  IB_thread thread() const { return (m_thread); }
 
 private:
  /** Initializes the m_shared_future, uses the m_promise's get_future,
  which cannot be used since then, according to its documentation. */
  void init() { m_thread.init(m_promise); }
 
  /** Register the thread with the server */
  void preamble() {
    MySQL_thread::preamble();
 
    std::atomic_thread_fence(std::memory_order_release);
 
    auto old = os_thread_count.fetch_add(1, std::memory_order_relaxed);
 
    ut_a(old <= static_cast<int>(srv_max_n_threads) - 1);
  }
 
  /** Deregister the thread */
  void epilogue() {
    m_promise.set_value();
 
    std::atomic_thread_fence(std::memory_order_release);
 
    auto old = os_thread_count.fetch_sub(1, std::memory_order_relaxed);
 
    ut_a(old > 0);
 
    MySQL_thread::epilogue();
  }
 
 private:
  /** Future object which keeps the ref counter >= 1 at least
  as long as the Detached_thread is not-destroyed. */
  mutable IB_thread m_thread;
 
  /** Promise which is set when task is done. */
  std::promise<void> m_promise;
};
 
/** Check if thread is stopped
@param[in]      thread Thread handle.
@return true if the thread has started, finished tasks and stopped. */
inline bool thread_is_stopped(const IB_thread &thread) {
  return thread.state() == IB_thread::State::STOPPED;
}
 
/** Check if thread is active
@param[in]      thread Thread handle.
@return true if the thread is active. */
inline bool thread_is_active(const IB_thread &thread) {
  switch (thread.state()) {
    case IB_thread::State::NOT_STARTED:
      /* Not yet started. */
      return false;
 
    case IB_thread::State::ALLOWED_TO_START:
      /* Thread "thread" is already active, but start() has not been called.
      Note that when start() is called, the thread's routine may decide to
      check if it is active or trigger other thread to do similar check
      regarding "thread". That could happen faster than thread's state
      is advanced from ALLOWED_TO_START to STARTED. Therefore we must
      already consider such thread as "active". */
      return true;
 
    case IB_thread::State::STARTED:
      /* Note, that potentially the thread might be doing its cleanup after
      it has already ended its task. We still consider it active, until the
      cleanup is finished. */
      return true;
 
    case IB_thread::State::STOPPED:
      /* Ended its task and became marked as STOPPED (cleanup finished) */
      return false;
 
    case IB_thread::State::INVALID:
    default:
      /* The thread object has not been assigned yet. */
      return false;
  }
 
  /* Note that similar goal was achieved by the usage of shared_future:
  return (shared_future.valid() && shared_future.wait_for(std::chrono::seconds(
                                       0)) != std::future_status::ready);
  However this resulted in longer execution of mtr tests (63minutes ->
  75minutes). You could try `mtr --mem collations.esperanto` (cmake
  WITH_DEBUG=1) */
}
 
/** Create a detached non-started thread. After thread is created, you should
assign the received object to any of variables/fields which you later could
access to check thread's state. You are allowed to either move or copy that
object (any number of copies is allowed). After assigning you are allowed to
start the thread by calling start() on any of those objects.
@param[in]      pfs_key   Performance schema thread key
@param[in]      pfs_seqnum  Performance schema thread sequence number
@param[in]      f         Callable instance
@param[in]      args      Zero or more args
@return Object which allows to start the created thread, monitor its state and
        wait until the thread is finished. */
template <typename F, typename... Args>
IB_thread create_detached_thread(mysql_pfs_key_t pfs_key,
                                 PSI_thread_seqnum pfs_seqnum, F &&f,
                                 Args &&...args) {
  Detached_thread detached_thread{pfs_key, pfs_seqnum};
  auto thread = detached_thread.thread();
 
  std::thread t(std::move(detached_thread), f, args...);
  t.detach();
 
  /* Thread t is doing busy waiting until the state is changed
  from NOT_STARTED to ALLOWED_TO_START. That will happen when
  thread.start() will be called. */
  ut_a(thread.state() == IB_thread::State::NOT_STARTED);
 
  return thread;
}
 
#ifdef UNIV_PFS_THREAD
#define os_thread_create(...) create_detached_thread(__VA_ARGS__)
#else
#define os_thread_create(k, s, ...) create_detached_thread(0, 0, __VA_ARGS__)
#endif /* UNIV_PFS_THREAD */
 
/** Parallel for loop over a container.
@param[in]      pfs_key  Performance schema thread key
@param[in]      c        Container to iterate over in parallel
@param[in]      n        Number of threads to create
@param[in]      f        Callable instance
@param[in]      args     Zero or more args */
template <typename Container, typename F, typename... Args>
void par_for(mysql_pfs_key_t pfs_key, const Container &c, size_t n, F &&f,
             Args &&...args) {
  if (c.empty()) {
    return;
  }
 
  size_t slice = (n > 0) ? c.size() / n : 0;
 
  using Workers = std::vector<IB_thread>;
 
  Workers workers;
 
  workers.reserve(n);
 
  for (size_t i = 0; i < n; ++i) {
    auto b = c.begin() + (i * slice);
    auto e = b + slice;
 
    auto worker = os_thread_create(pfs_key, i, f, b, e, i, args...);
    worker.start();
 
    workers.push_back(std::move(worker));
  }
 
  f(c.begin() + (n * slice), c.end(), n, args...);
 
  for (auto &worker : workers) {
    worker.join();
  }
}
 
#if defined(UNIV_PFS_THREAD) && !defined(UNIV_HOTBACKUP)
#define par_for(...) par_for(__VA_ARGS__)
#else
#define par_for(k, ...) par_for(0, __VA_ARGS__)
#endif /* UNIV_PFS_THREAD */
 
#endif /* !os0thread_create_h */