stackimpl.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 *  COPYRIGHT (c) 1989-2006.
 *  On-Line Applications Research Corporation (OAR).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef _RTEMS_SCORE_STACKIMPL_H
#define _RTEMS_SCORE_STACKIMPL_H
 
#include <rtems/score/stack.h>
#include <rtems/score/context.h>
#include <rtems/score/tls.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
static inline void _Stack_Initialize (
  Stack_Control *the_stack,
  void          *starting_address,
  size_t         size
)
{
  the_stack->area = starting_address;
  the_stack->size = size;
}
 
static inline uint32_t _Stack_Minimum (void)
{
  return rtems_minimum_stack_size;
}
 
static inline bool _Stack_Is_enough(
  size_t size,
  bool   is_fp
)
{
  size_t minimum;
 
  minimum = _TLS_Get_allocation_size();
  minimum += _Stack_Minimum();
 
#if ( CPU_HARDWARE_FP == TRUE ) || ( CPU_SOFTWARE_FP == TRUE )
  if ( is_fp ) {
    minimum += CONTEXT_FP_SIZE;
  }
#endif
 
  return ( size >= minimum );
}
 
static inline size_t _Stack_Ensure_minimum (
  size_t size
)
{
  if ( size >= _Stack_Minimum() )
    return size;
  return _Stack_Minimum();
}
 
static inline size_t _Stack_Extend_size(
  size_t stack_size,
  bool   is_fp
)
{
  size_t extra_size;
  size_t allocator_overhead;
 
  extra_size = _TLS_Get_allocation_size();
 
#if ( CPU_HARDWARE_FP == TRUE ) || ( CPU_SOFTWARE_FP == TRUE )
  if ( is_fp ) {
    /* This addition cannot overflow since the TLS size cannot be that large */
    extra_size += CONTEXT_FP_SIZE;
  }
#else
  (void) is_fp;
#endif
 
  /*
   * In order to make sure that a user-provided stack size is the minimum which
   * can be allocated for the stack, we have to align it up to the next stack
   * boundary.
   */
  extra_size += CPU_STACK_ALIGNMENT - 1;
 
  /*
   * If the heap allocator does not meet the stack alignment requirement, then
   * we have to do the stack alignment manually in _Thread_Initialize() and
   * need to allocate extra space for this.
   */
  allocator_overhead = CPU_STACK_ALIGNMENT - CPU_HEAP_ALIGNMENT;
 
  if ( stack_size > SIZE_MAX - extra_size - allocator_overhead ) {
    /*
     * In case of an unsigned integer overflow, saturate at the maximum value.
     */
    return SIZE_MAX;
  }
 
  stack_size += extra_size;
  stack_size = RTEMS_ALIGN_DOWN( stack_size, CPU_STACK_ALIGNMENT );
 
  return stack_size + allocator_overhead;
}
 
void *_Stack_Allocate( size_t stack_size );
 
void _Stack_Free( void *stack_area );
 
#ifdef __cplusplus
}
#endif
 
#endif
/* end of include file */