path: root/testsuites/validation/tc-mem-rtems-calloc.c

/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSTestCaseRtemsMallocReqCalloc
 */

/*
 * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 *
 * 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.
 */

/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <rtems/malloc.h>

#include "tx-support.h"

#include <rtems/test.h>

/**
 * @defgroup RTEMSTestCaseRtemsMallocReqCalloc spec:/rtems/malloc/req/calloc
 *
 * @ingroup RTEMSTestSuiteTestsuitesValidation0
 *
 * @{
 */

typedef enum {
  RtemsMallocReqCalloc_Pre_ElementCount_Huge,
  RtemsMallocReqCalloc_Pre_ElementCount_Zero,
  RtemsMallocReqCalloc_Pre_ElementCount_Valid,
  RtemsMallocReqCalloc_Pre_ElementCount_NA
} RtemsMallocReqCalloc_Pre_ElementCount;

typedef enum {
  RtemsMallocReqCalloc_Pre_ElementSize_Huge,
  RtemsMallocReqCalloc_Pre_ElementSize_Zero,
  RtemsMallocReqCalloc_Pre_ElementSize_Valid,
  RtemsMallocReqCalloc_Pre_ElementSize_NA
} RtemsMallocReqCalloc_Pre_ElementSize;

typedef enum {
  RtemsMallocReqCalloc_Post_Status_Null,
  RtemsMallocReqCalloc_Post_Status_AreaBegin,
  RtemsMallocReqCalloc_Post_Status_NA
} RtemsMallocReqCalloc_Post_Status;

typedef enum {
  RtemsMallocReqCalloc_Post_Alignment_Valid,
  RtemsMallocReqCalloc_Post_Alignment_NA
} RtemsMallocReqCalloc_Post_Alignment;

typedef enum {
  RtemsMallocReqCalloc_Post_Size_Valid,
  RtemsMallocReqCalloc_Post_Size_NA
} RtemsMallocReqCalloc_Post_Size;

typedef enum {
  RtemsMallocReqCalloc_Post_Content_Zero,
  RtemsMallocReqCalloc_Post_Content_NA
} RtemsMallocReqCalloc_Post_Content;

/**
 * @brief Test context for spec:/rtems/malloc/req/calloc test case.
 */
typedef struct {
  /**
   * @brief This member provides a memory support context.
   */
  MemoryContext mem_ctx;;

  /**
   * @brief This member contains the return value of the rtems_calloc call.
   */
  void *ptr;

  /**
   * @brief This member specifies if the ``nelem`` parameter value.
   */
  size_t nelem;

  /**
   * @brief This member specifies if the ``elsize`` parameter value.
   */
  size_t elsize;

  /**
   * @brief This member defines the pre-condition states for the next action.
   */
  size_t pcs[ 2 ];

  /**
   * @brief This member indicates if the test action loop is currently
   *   executed.
   */
  bool in_action_loop;
} RtemsMallocReqCalloc_Context;

static RtemsMallocReqCalloc_Context
  RtemsMallocReqCalloc_Instance;

static const char * const RtemsMallocReqCalloc_PreDesc_ElementCount[] = {
  "Huge",
  "Zero",
  "Valid",
  "NA"
};

static const char * const RtemsMallocReqCalloc_PreDesc_ElementSize[] = {
  "Huge",
  "Zero",
  "Valid",
  "NA"
};

static const char * const * const RtemsMallocReqCalloc_PreDesc[] = {
  RtemsMallocReqCalloc_PreDesc_ElementCount,
  RtemsMallocReqCalloc_PreDesc_ElementSize,
  NULL
};

static void RtemsMallocReqCalloc_Pre_ElementCount_Prepare(
  RtemsMallocReqCalloc_Context         *ctx,
  RtemsMallocReqCalloc_Pre_ElementCount state
)
{
  switch ( state ) {
    case RtemsMallocReqCalloc_Pre_ElementCount_Huge: {
      /*
       * While the ``nelem`` parameter is not equal to zero, while the
       * ``nelem`` parameter is too large to allocate a memory area with the
       * specified size.
       */
      ctx->nelem = SIZE_MAX;
      break;
    }

    case RtemsMallocReqCalloc_Pre_ElementCount_Zero: {
      /*
       * While the ``nelem`` parameter is equal to zero.
       */
      ctx->nelem = 0;
      break;
    }

    case RtemsMallocReqCalloc_Pre_ElementCount_Valid: {
      /*
       * While the ``nelem`` parameter is not equal to zero, while the
       * ``nelem`` parameter is small enough to allocate a memory area with the
       * specified size.
       */
      ctx->nelem = 1;
      break;
    }

    case RtemsMallocReqCalloc_Pre_ElementCount_NA:
      break;
  }
}

static void RtemsMallocReqCalloc_Pre_ElementSize_Prepare(
  RtemsMallocReqCalloc_Context        *ctx,
  RtemsMallocReqCalloc_Pre_ElementSize state
)
{
  switch ( state ) {
    case RtemsMallocReqCalloc_Pre_ElementSize_Huge: {
      /*
       * While the ``elsize`` parameter is not equal to zero, while the
       * ``elsize`` parameter is too large to allocate a memory area with the
       * specified size.
       */
      ctx->elsize = SIZE_MAX;
      break;
    }

    case RtemsMallocReqCalloc_Pre_ElementSize_Zero: {
      /*
       * While the ``elsize`` parameter is equal to zero.
       */
      ctx->elsize = 0;
      break;
    }

    case RtemsMallocReqCalloc_Pre_ElementSize_Valid: {
      /*
       * While the ``elsize`` parameter is not equal to zero, while the
       * ``elsize`` parameter is small enough to allocate a memory area with
       * the specified size.
       */
      ctx->elsize = sizeof( uint64_t );
      break;
    }

    case RtemsMallocReqCalloc_Pre_ElementSize_NA:
      break;
  }
}

static void RtemsMallocReqCalloc_Post_Status_Check(
  RtemsMallocReqCalloc_Context    *ctx,
  RtemsMallocReqCalloc_Post_Status state
)
{
  switch ( state ) {
    case RtemsMallocReqCalloc_Post_Status_Null: {
      /*
       * The return value of rtems_calloc shall be equal to NULL.
       */
      T_null( ctx->ptr );
      break;
    }

    case RtemsMallocReqCalloc_Post_Status_AreaBegin: {
      /*
       * The return value of rtems_calloc shall be equal to the begin address
       * of the allocated memory area.
       */
      T_not_null( ctx->ptr );
      break;
    }

    case RtemsMallocReqCalloc_Post_Status_NA:
      break;
  }
}

static void RtemsMallocReqCalloc_Post_Alignment_Check(
  RtemsMallocReqCalloc_Context       *ctx,
  RtemsMallocReqCalloc_Post_Alignment state
)
{
  switch ( state ) {
    case RtemsMallocReqCalloc_Post_Alignment_Valid: {
      /*
       * The begin address of the allocated memory area shall be an integral
       * multiple of the heap alignment of the target architecture.
       */
      T_eq_uptr( (uintptr_t) ctx->ptr % CPU_HEAP_ALIGNMENT, 0 );
      break;
    }

    case RtemsMallocReqCalloc_Post_Alignment_NA:
      break;
  }
}

static void RtemsMallocReqCalloc_Post_Size_Check(
  RtemsMallocReqCalloc_Context  *ctx,
  RtemsMallocReqCalloc_Post_Size state
)
{
  void     *ptr;
  uintptr_t a;
  uintptr_t b;
  uintptr_t size;

  switch ( state ) {
    case RtemsMallocReqCalloc_Post_Size_Valid: {
      /*
       * The size of the allocated memory area shall greater than or equal to
       * the product of the ``nelem`` and ``elsize`` parameters.
       */
      /* Assume that the next allocation is done from adjacent memory */
      ptr = ctx->ptr;
      ctx->ptr = rtems_calloc( ctx->nelem, ctx->elsize );
      T_not_null( ptr );
      a = (uintptr_t) ptr;
      b = (uintptr_t) ctx->ptr;
      size = a < b ? b - a : a - b;
      T_ge_uptr( size, ctx->nelem * ctx->elsize );
      break;
    }

    case RtemsMallocReqCalloc_Post_Size_NA:
      break;
  }
}

static void RtemsMallocReqCalloc_Post_Content_Check(
  RtemsMallocReqCalloc_Context     *ctx,
  RtemsMallocReqCalloc_Post_Content state
)
{
  switch ( state ) {
    case RtemsMallocReqCalloc_Post_Content_Zero: {
      /*
       * The content of the allocated memory area shall be cleared to zero.
       */
      T_eq_u64( *(uint64_t *) ctx->ptr, 0 );
      break;
    }

    case RtemsMallocReqCalloc_Post_Content_NA:
      break;
  }
}

static void RtemsMallocReqCalloc_Setup( RtemsMallocReqCalloc_Context *ctx )
{
  MemorySave( &ctx->mem_ctx );
}

static void RtemsMallocReqCalloc_Setup_Wrap( void *arg )
{
  RtemsMallocReqCalloc_Context *ctx;

  ctx = arg;
  ctx->in_action_loop = false;
  RtemsMallocReqCalloc_Setup( ctx );
}

static void RtemsMallocReqCalloc_Teardown( RtemsMallocReqCalloc_Context *ctx )
{
  MemoryRestore( &ctx->mem_ctx );
}

static void RtemsMallocReqCalloc_Teardown_Wrap( void *arg )
{
  RtemsMallocReqCalloc_Context *ctx;

  ctx = arg;
  ctx->in_action_loop = false;
  RtemsMallocReqCalloc_Teardown( ctx );
}

static void RtemsMallocReqCalloc_Action( RtemsMallocReqCalloc_Context *ctx )
{
  ctx->ptr = rtems_calloc( ctx->nelem, ctx->elsize );
}

typedef struct {
  uint8_t Skip : 1;
  uint8_t Pre_ElementCount_NA : 1;
  uint8_t Pre_ElementSize_NA : 1;
  uint8_t Post_Status : 2;
  uint8_t Post_Alignment : 1;
  uint8_t Post_Size : 1;
  uint8_t Post_Content : 1;
} RtemsMallocReqCalloc_Entry;

static const RtemsMallocReqCalloc_Entry
RtemsMallocReqCalloc_Entries[] = {
  { 0, 0, 0, RtemsMallocReqCalloc_Post_Status_Null,
    RtemsMallocReqCalloc_Post_Alignment_Valid,
    RtemsMallocReqCalloc_Post_Size_NA, RtemsMallocReqCalloc_Post_Content_NA },
  { 0, 0, 0, RtemsMallocReqCalloc_Post_Status_AreaBegin,
    RtemsMallocReqCalloc_Post_Alignment_Valid,
    RtemsMallocReqCalloc_Post_Size_Valid,
    RtemsMallocReqCalloc_Post_Content_Zero }
};

static const uint8_t
RtemsMallocReqCalloc_Map[] = {
  0, 0, 0, 0, 0, 0, 0, 0, 1
};

static size_t RtemsMallocReqCalloc_Scope( void *arg, char *buf, size_t n )
{
  RtemsMallocReqCalloc_Context *ctx;

  ctx = arg;

  if ( ctx->in_action_loop ) {
    return T_get_scope( RtemsMallocReqCalloc_PreDesc, buf, n, ctx->pcs );
  }

  return 0;
}

static T_fixture RtemsMallocReqCalloc_Fixture = {
  .setup = RtemsMallocReqCalloc_Setup_Wrap,
  .stop = NULL,
  .teardown = RtemsMallocReqCalloc_Teardown_Wrap,
  .scope = RtemsMallocReqCalloc_Scope,
  .initial_context = &RtemsMallocReqCalloc_Instance
};

static inline RtemsMallocReqCalloc_Entry RtemsMallocReqCalloc_GetEntry(
  size_t index
)
{
  return RtemsMallocReqCalloc_Entries[
    RtemsMallocReqCalloc_Map[ index ]
  ];
}

/**
 * @fn void T_case_body_RtemsMallocReqCalloc( void )
 */
T_TEST_CASE_FIXTURE( RtemsMallocReqCalloc, &RtemsMallocReqCalloc_Fixture )
{
  RtemsMallocReqCalloc_Context *ctx;
  size_t index;

  ctx = T_fixture_context();
  ctx->in_action_loop = true;
  index = 0;

  for (
    ctx->pcs[ 0 ] = RtemsMallocReqCalloc_Pre_ElementCount_Huge;
    ctx->pcs[ 0 ] < RtemsMallocReqCalloc_Pre_ElementCount_NA;
    ++ctx->pcs[ 0 ]
  ) {
    for (
      ctx->pcs[ 1 ] = RtemsMallocReqCalloc_Pre_ElementSize_Huge;
      ctx->pcs[ 1 ] < RtemsMallocReqCalloc_Pre_ElementSize_NA;
      ++ctx->pcs[ 1 ]
    ) {
      RtemsMallocReqCalloc_Entry entry;

      entry = RtemsMallocReqCalloc_GetEntry( index );
      ++index;

      RtemsMallocReqCalloc_Pre_ElementCount_Prepare( ctx, ctx->pcs[ 0 ] );
      RtemsMallocReqCalloc_Pre_ElementSize_Prepare( ctx, ctx->pcs[ 1 ] );
      RtemsMallocReqCalloc_Action( ctx );
      RtemsMallocReqCalloc_Post_Status_Check( ctx, entry.Post_Status );
      RtemsMallocReqCalloc_Post_Alignment_Check( ctx, entry.Post_Alignment );
      RtemsMallocReqCalloc_Post_Size_Check( ctx, entry.Post_Size );
      RtemsMallocReqCalloc_Post_Content_Check( ctx, entry.Post_Content );
    }
  }
}

/** @} */