thread-cpp.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ distribution.
 *   (https://github.com/micro-os-plus)
 * Copyright (c) 2016 Liviu Ionescu.
 *
 * 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.
 */
 
// ============================================================================
// This file is for internal use in µOS++ and should not be included
// in applications.
 
thread::thread (thread&& t) noexcept
{
  swap (t);
}
 
thread&
thread::operator= (thread&& t) noexcept
{
  if (joinable ())
    {
      os::trace::printf ("%s() @%p attempt to assign a running thread\n",
                         __func__, this);
      std::abort (); // in ISO it is std::terminate()
    }
  swap (t);
  return *this;
}
 
void
thread::delete_system_thread (void)
{
  if (id_ != id ())
    {
      void* args = id_.native_thread_->function_args ();
      if (args != nullptr && function_object_deleter_ != nullptr)
        {
          // Manually delete the function object used to store arguments.
          function_object_deleter_ (args);
        }
 
      // Manually delete the system thread.
      delete id_.native_thread_;
    }
}
 
thread::~thread ()
{
  os::trace::printf ("%s() @%p\n", __func__, this);
  if (joinable ())
    {
      os::trace::printf ("%s() @%p attempt to destruct a running thread\n",
                         __func__, this);
      std::abort (); // in ISO it is std::terminate()
    }
 
  delete_system_thread ();
}
 
// ------------------------------------------------------------------------
 
void
thread::swap (thread& t) noexcept
{
  std::swap (id_, t.id_);
  std::swap (function_object_deleter_, t.function_object_deleter_);
}
 
bool
thread::joinable () const noexcept
{
  return !(id_ == thread::id ());
}
 
void
thread::join ()
{
  os::trace::printf ("%s() @%p\n", __func__, this);
 
  delete_system_thread ();
 
  id_ = id ();
  os::trace::printf ("%s() @%p joined\n", __func__, this);
}
 
void
thread::detach ()
{
  os::trace::printf ("%s() @%p\n", __func__, this);
  if (id_ != id ())
    {
      id_.native_thread_->detach ();
    }
 
  // The detached thread will continue to run, but we'll not have
  // access to it from here, not even to delete it.
  // TODO: arrange to delete it at exit()?
 
  id_ = id ();
  os::trace::printf ("%s() @%p detached\n", __func__, this);
}
 
// ==========================================================================