new.cpp

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.
 */
 
/*
 * [Partly inspired from the LLVM libcxx sources].
 * Copyright (c) 2009-2013 by the contributors listed in
 * 'LLVM libcxx Credits.txt'. See 'LLVM libcxx License.txt' for details.
 *
 * References are to ISO/IEC 14882:2011(E) Third edition (2011-09-01)
 */
 
#if defined(OS_USE_OS_APP_CONFIG_H)
#include <cmsis-plus/os-app-config.h>
#endif
 
#include <cmsis-plus/rtos/os.h>
#include <cmsis-plus/estd/memory_resource>
 
// ----------------------------------------------------------------------------
 
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif
 
// ----------------------------------------------------------------------------
 
using namespace os;
 
// ----------------------------------------------------------------------------
 
namespace
{
  std::new_handler new_handler_;
} // namespace
 
namespace std
{
  // Constant to be used as parameter to differentiate
  // the `noexcept` functions.
  const nothrow_t nothrow = nothrow_t{};
 
  new_handler
  set_new_handler (new_handler handler) noexcept
  {
    trace::printf ("std::%s(%p) \n", __func__, handler);
 
    new_handler prev_handler;
 
    prev_handler = new_handler_;
    new_handler_ = handler;
 
    return prev_handler;
  }
 
  new_handler
  get_new_handler () noexcept
  {
    return new_handler_;
  }
 
} /* namespace std */
 
// ----------------------------------------------------------------------------
 
// error: end of file with unbalanced grouping commands
/*
 * @name Standard operators
 * @{
 */
 
void* __attribute__ ((weak)) operator new (std::size_t bytes)
{
  assert (!rtos::interrupts::in_handler_mode ());
  if (bytes == 0)
    {
      bytes = 1;
    }
 
  // ----- Begin of critical section ------------------------------------------
  rtos::scheduler::critical_section scs;
 
  while (true)
    {
      void* mem = estd::pmr::get_default_resource ()->allocate (bytes);
 
      if (mem != nullptr)
        {
#if defined(OS_TRACE_LIBCPP_OPERATOR_NEW)
          trace::printf ("::%s(%d)=%p\n", __func__, bytes, mem);
#endif
          return mem;
        }
 
      // If allocate() fails and there is a new_handler,
      // call it to try free up memory.
      if (new_handler_)
        {
          new_handler_ ();
        }
      else
        {
          estd::__throw_bad_alloc ();
        }
    }
 
  // ----- End of critical section --------------------------------------------
}
 
void* __attribute__ ((weak)) operator new (std::size_t bytes,
                                           const std::nothrow_t
                                           & nothrow
                                           __attribute__ ((unused))) noexcept
{
  assert (!rtos::interrupts::in_handler_mode ());
 
  if (bytes == 0)
    {
      bytes = 1;
    }
 
  // ----- Begin of critical section ------------------------------------------
  rtos::scheduler::critical_section scs;
 
  while (true)
    {
      void* mem = estd::pmr::get_default_resource ()->allocate (bytes);
 
      if (mem != nullptr)
        {
#if defined(OS_TRACE_LIBCPP_OPERATOR_NEW)
          trace::printf ("::%s(%d)=%p\n", __func__, bytes, mem);
#endif
          return mem;
        }
 
      // If allocate() fails and there is a new_handler,
      // call it to try free up memory.
      if (new_handler_)
        {
          new_handler_ ();
        }
      else
        {
          break; // return nullptr
        }
    }
 
  // ----- End of critical section --------------------------------------------
 
  return nullptr;
}
 
// error: Ignoring @brief command inside argument documentation
/*
 * @ingroup cmsis-plus-rtos-memres
 * @brief Allocate space for an array of new object instances.
 * @param bytes Number of bytes to allocate.
 * @return Pointer to allocated object.
 *
 * @details
 * The allocation function (3.7.4.1) called by the array form of a
 * new-expression (5.3.4) to allocate size bytes of storage suitably
 * aligned to represent any array object of that size or smaller.
 *
 * @note A C++ program may define a function with this function signature
 * that displaces the default version defined by the C++ standard library.
 *
 * @warning Cannot be invoked from Interrupt Service Routines.
 */
void* __attribute__ ((weak)) operator new[] (std::size_t bytes)
{
  return ::operator new (bytes);
}
 
// error: Ignoring @brief command inside argument documentation
/*
 * @ingroup cmsis-plus-rtos-memres
 * @brief Allocate space for an array of new object instances (nothrow).
 * @param bytes Number of bytes to allocate.
 * @param nothrow (unused)
 * @return Pointer to allocated object.
 *
 * @details
 * Same as new[](size), except that it is called by
 * a C++ program that prefers a null
 * pointer result as an error indication, instead of a `bad_alloc` exception.
 *
 * @note A C++ program may define a function with this function signature
 * that displaces the default version defined by the C++ standard library.
 *
 * @warning Cannot be invoked from Interrupt Service Routines.
 */
void* __attribute__ ((weak)) operator new[] (std::size_t bytes,
                                             const std::nothrow_t
                                             & nothrow
                                             __attribute__ ((unused))) noexcept
{
  return ::operator new (bytes, std::nothrow);
}
 
// ----------------------------------------------------------------------------
 
void __attribute__ ((weak)) operator delete (void* ptr) noexcept
{
#if defined(OS_TRACE_LIBCPP_OPERATOR_NEW)
  trace::printf ("::%s(%p)\n", __func__, ptr);
#endif
 
  assert (!rtos::interrupts::in_handler_mode ());
 
  if (ptr)
    {
      // ----- Begin of critical section --------------------------------------
      rtos::scheduler::critical_section scs;
 
      // The unknown size is passed as 0.
      estd::pmr::get_default_resource ()->deallocate (ptr, 0);
      // ----- End of critical section ----------------------------------------
    }
}
 
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wc++14-compat"
#pragma GCC diagnostic ignored "-Wredundant-decls"
#endif
 
void
operator delete (void* ptr, std::size_t bytes) noexcept;
 
void __attribute__ ((weak)) operator delete (void* ptr,
                                             std::size_t bytes) noexcept
{
#if defined(OS_TRACE_LIBCPP_OPERATOR_NEW)
  trace::printf ("::%s(%p,%u)\n", __func__, ptr, bytes);
#endif
 
  assert (!rtos::interrupts::in_handler_mode ());
 
  if (ptr)
    {
      // ----- Begin of critical section --------------------------------------
      rtos::scheduler::critical_section scs;
 
      estd::pmr::get_default_resource ()->deallocate (ptr, bytes);
      // ----- End of critical section ----------------------------------------
    }
}
 
#pragma GCC diagnostic pop
 
void __attribute__ ((weak)) operator delete (void* ptr, const std::nothrow_t
                                             & nothrow
                                             __attribute__ ((unused))) noexcept
{
#if defined(OS_TRACE_LIBCPP_OPERATOR_NEW)
  trace::printf ("::%s(%p)\n", __func__, ptr);
#endif
 
  assert (!rtos::interrupts::in_handler_mode ());
 
  if (ptr)
    {
      // ----- Begin of critical section --------------------------------------
      rtos::scheduler::critical_section scs;
 
      estd::pmr::get_default_resource ()->deallocate (ptr, 0);
      // ----- End of critical section ----------------------------------------
    }
}
 
void __attribute__ ((weak)) operator delete[] (void* ptr) noexcept
{
  ::operator delete (ptr);
}
 
#pragma GCC diagnostic push
#if defined(__clang__)
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wc++14-compat"
#pragma GCC diagnostic ignored "-Wredundant-decls"
#endif
 
void
operator delete[] (void* ptr, std::size_t bytes) noexcept;
 
void __attribute__ ((weak)) operator delete[] (void* ptr,
                                               std::size_t bytes) noexcept
{
  ::operator delete (ptr, bytes);
}
 
#pragma GCC diagnostic pop
 
void __attribute__ ((weak)) operator delete[] (void* ptr, const std::nothrow_t
                                               & nothrow) noexcept
{
  ::operator delete (ptr, nothrow);
}
 
// error: end of file with unbalanced grouping commands
/*
 * @}
 */
 
// ----------------------------------------------------------------------------