icl_core_thread/ThreadImplLxrt35.cpp

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#include "ThreadImplLxrt35.h"

#include <icl_core/internal_raw_debug.h>
#include <icl_core/os_lxrt.h>

#include "Thread.h"
#include "Logging.h"

#define DEFAULT_STACK_SIZE 0x4000

namespace icl_core {
namespace thread {

ThreadImplLxrt35::ThreadImplLxrt35(Thread *thread, const icl_core::String& description,
                                   icl_core::ThreadPriority priority)
  : m_thread_id(0),
    m_thread(thread),
    m_priority(priority),
    m_description(description),
    m_rt_task(NULL),
    m_rt_start_sync(NULL)
{ }

ThreadImplLxrt35::~ThreadImplLxrt35()
{
  // Ensure that the thread is really destroyed.
  join();

  if (m_rt_start_sync == NULL)
  {
    // Nothing to be done here.
  }
  else
  {
    pthread_barrier_destroy_rt(m_rt_start_sync);
    delete m_rt_start_sync;
    m_rt_start_sync = NULL;
  }
}

void ThreadImplLxrt35::cancel()
{
  if (m_thread_id == 0)
  {
    // Nothing to be done here. The thread has already been destroyed.
  }
  else
  {
    pthread_cancel_rt(m_thread_id);
    pthread_join_rt(m_thread_id, NULL);
    m_thread_id = 0;
    m_rt_task = NULL;
  }
}

bool ThreadImplLxrt35::isHardRealtime() const
{
  return m_priority < 0;
}

bool ThreadImplLxrt35::executesHardRealtime() const
{
  return os::isThisHRT();
}

void ThreadImplLxrt35::join()
{
  if (m_thread_id == 0)
  {
    // Nothing to be done here. The thread has already been destroyed.
  }
  else
  {
    pthread_join_rt(m_thread_id, NULL);
    m_thread_id = 0;
    m_rt_task = NULL;
  }
}

icl_core::ThreadPriority ThreadImplLxrt35::priority() const
{
  return m_priority;
}

bool ThreadImplLxrt35::setHardRealtime(bool hard_realtime)
{
  if (hard_realtime && !os::isThisHRT())
  {
    rt_make_hard_real_time();
    return os::isThisHRT();
  }
  else if (!hard_realtime && os::isThisHRT())
  {
    rt_make_soft_real_time();
    return !os::isThisHRT();
  }
  else
  {
    return false;
  }
}

bool ThreadImplLxrt35::setPriority(icl_core::ThreadPriority /*priority*/)
{
  // TODO: Make this work!
  /*
    if (m_rt_task != NULL) {
    int ret = rt_change_prio(m_rt_task, abs(priority));
    if (ret == 0) {
    m_priority = priority;

    if (priority > 0 && IsHardRealtimeThread()) {
    rt_make_soft_real_time();
    } else if (priority < 0 && !IsHardRealtimeThread()) {
    rt_make_hard_real_time();
    }

    return true;
    }
    }
  */

  return false;
}

bool ThreadImplLxrt35::start()
{
  m_rt_start_sync = new (std::nothrow) pthread_barrier_t;
  if (m_rt_start_sync == NULL)
  {
    // We cannot proceed, if this happens!
  }
  else
  {
    pthread_barrier_init_rt(m_rt_start_sync, NULL, 2);

    if (pthread_create(&m_thread_id, NULL, ThreadImplLxrt35::runThread, this))
    {
      m_thread_id = 0;
      m_rt_task = NULL;

      pthread_barrier_destroy_rt(m_rt_start_sync);
      delete m_rt_start_sync;
      m_rt_start_sync = NULL;
    }
    else
    {
      pthread_barrier_wait_rt(m_rt_start_sync);
    }
  }

  return m_thread_id != 0;
}

icl_core::ThreadId ThreadImplLxrt35::threadId() const
{
  return ::icl_core::ThreadId(m_thread_id);
}

void *ThreadImplLxrt35::runThread(void *arg)
{
  ThreadImplLxrt35 *self = static_cast<ThreadImplLxrt35*>(arg);

  if (self->m_rt_start_sync == NULL)
  {
    // Technically, this can never happen because this condition is
    // already checked in the Start() function. But who knows!
    PRINTF("ERROR: NULL thread start barrier!\n");
  }
  else
  {
    self->m_rt_task = rt_task_init(getpid() + pthread_self_rt(), abs(self->m_priority),
                                   DEFAULT_STACK_SIZE, 0);
    if (self->m_rt_task == NULL)
    {
      PRINTF("ERROR: Cannot initialize LXRT task %lu!\n", self->m_thread_id);
      PRINTF("       Probably another thread with the same name already exists.\n");

      // Let the thread, which started us, continue!
      pthread_barrier_wait_rt(self->m_rt_start_sync);
    }
    else
    {
      if (self->m_priority < 0)
      {
        rt_make_hard_real_time();
        if (!rt_is_hard_real_time(rt_buddy()))
        {
          PRINTF("ERROR: Setting thread %lu to hard real-time failed!\n", self->m_thread_id);
        }
        else
        {
          // Everything worked as expected, so no message here.
        }
      }
      else
      {
        // This is a soft realtime thread, so nothing additional has
        // to be done here.
      }

      pthread_barrier_wait_rt(self->m_rt_start_sync);

      self->m_thread->runThread();

      // Remark: It does not hurt to call this in a soft realtime
      // thread, so just skip the hard realtime test.
      rt_make_soft_real_time();
    }
  }

  return NULL;
}

}
}