os.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.
 */

/*
 * The initial µOS++ RTOS API was inspired by CMSIS RTOS API v1.x,
 * Copyright (c) 2013 ARM LIMITED.
 */

/*
 * TODO:
 * - make Thread virtual, to allow create_hook/delete_hook functionality
 * - make most classes virtual, to allow post_hook functionality
 * - event timestamps: add derived classes that capture the event timestamp
 * - add object type in base class
 * - add Wait_list in base class
 *
 * Notes:
 * - the try_wait(), try_flags_wait() names are probably not very inspired,
 * but at least they are consistent in POSIX.
 */

#ifndef CMSIS_PLUS_RTOS_OS_H_
#define CMSIS_PLUS_RTOS_OS_H_

// ----------------------------------------------------------------------------

#if defined(__cplusplus)

#include <cmsis-plus/rtos/os-decls.h>

#include <cmsis-plus/rtos/os-sched.h>

// Includes a reference to critical sections.
#include <cmsis-plus/rtos/os-memory.h>

#include <cmsis-plus/rtos/os-thread.h>
#include <cmsis-plus/rtos/os-clocks.h>
#include <cmsis-plus/rtos/os-timer.h>
#include <cmsis-plus/rtos/os-mutex.h>
#include <cmsis-plus/rtos/os-condvar.h>
#include <cmsis-plus/rtos/os-semaphore.h>
#include <cmsis-plus/rtos/os-mempool.h>
#include <cmsis-plus/rtos/os-mqueue.h>
#include <cmsis-plus/rtos/os-evflags.h>

#include <cmsis-plus/rtos/os-hooks.h>

// More or less at the end, when all other definitions are available.
#include <cmsis-plus/rtos/os-inlines.h>
#include <cmsis-plus/rtos/port/os-inlines.h>

namespace os
{
  namespace rtos
  {
    namespace scheduler
    {
      extern thread::threads_list top_threads_list_;

      thread::threads_list&
      children_threads (thread* th);

    } /* namespace scheduler */

    // ------------------------------------------------------------------------

    namespace interrupts
    {
#if defined(OS_HAS_INTERRUPTS_STACK) || defined(__DOXYGEN__)

      class thread::stack*
      stack (void);

#else
#endif /* defined(OS_HAS_INTERRUPTS_STACK) */

      ;
    // Avoid formatter bug.
    } /* namespace interrupts */

    // ------------------------------------------------------------------------
    template<typename T, typename ... Args>
      inline typename std::enable_if<!std::is_array<T>::value,
          std::shared_ptr<T> >::type
      make_shared (Args&&... args)
      {
        // -Wno-psabi to disble the ABI warning.
        typedef typename std::remove_const<T>::type T_nc;
        return std::allocate_shared<T> (memory::allocator<T_nc> (),
                                        std::forward<Args>(args)...);
      }

  } /* namespace rtos */
} /* namespace os */

#endif /* __cplusplus */

// ----------------------------------------------------------------------------

#endif /* CMSIS_PLUS_RTOS_OS_H_ */