os.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
 * Copyright (c) 2016-2025 Liviu Ionescu. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software
 * for any purpose is hereby granted, under the terms of the MIT license.
 *
 * If a copy of the license was not distributed with this file, it can
 * be obtained from https://opensource.org/licenses/mit.
 */
 
/*
 * 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)
 
#if defined(OS_USE_OS_APP_CONFIG_H)
#include <cmsis-plus/os-app-config.h>
#endif
 
#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>
 
// ----------------------------------------------------------------------------
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif
 
// ----------------------------------------------------------------------------
 
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) */
 
    } /* namespace interrupts */
 
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Waggregate-return"
#endif
 
    // ------------------------------------------------------------------------
    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)...);
    }
 
#pragma GCC diagnostic pop
 
  } /* namespace rtos */
} /* namespace os */
 
#pragma GCC diagnostic pop
 
// ----------------------------------------------------------------------------
 
#endif /* __cplusplus */
 
#include <cmsis-plus/rtos/os-c-api.h>
 
// ----------------------------------------------------------------------------
 
#endif /* CMSIS_PLUS_RTOS_OS_H_ */