tc-part-return.c

Go to the documentation of this file.

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

/*
 * Copyright (C) 2020 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.
 */

/*
 * Do not manually edit this file.  It 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 to an RTEMS mailing list or raise a bug report:
 *
 * https://docs.rtems.org/branches/master/user/support/bugs.html
 *
 * For information on updating and regenerating please refer to:
 *
 * https://docs.rtems.org/branches/master/eng/req/howto.html
 */

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

#include <rtems.h>

#include <rtems/test.h>

typedef enum {
  RtemsPartReqReturnBuffer_Pre_Id_Id,
  RtemsPartReqReturnBuffer_Pre_Id_Invalid,
  RtemsPartReqReturnBuffer_Pre_Id_NA
} RtemsPartReqReturnBuffer_Pre_Id;

typedef enum {
  RtemsPartReqReturnBuffer_Pre_InUse_True,
  RtemsPartReqReturnBuffer_Pre_InUse_False,
  RtemsPartReqReturnBuffer_Pre_InUse_NA
} RtemsPartReqReturnBuffer_Pre_InUse;

typedef enum {
  RtemsPartReqReturnBuffer_Post_Status_Ok,
  RtemsPartReqReturnBuffer_Post_Status_InvId,
  RtemsPartReqReturnBuffer_Post_Status_InUse,
  RtemsPartReqReturnBuffer_Post_Status_NA
} RtemsPartReqReturnBuffer_Post_Status;

typedef struct {
  rtems_status_code status;

  rtems_id id;

  rtems_id id_value;

  void *buffer;

  size_t pcs[ 2 ];

  bool in_action_loop;
} RtemsPartReqReturnBuffer_Context;

static RtemsPartReqReturnBuffer_Context
  RtemsPartReqReturnBuffer_Instance;

static const char * const RtemsPartReqReturnBuffer_PreDesc_Id[] = {
  "Id",
  "Invalid",
  "NA"
};

static const char * const RtemsPartReqReturnBuffer_PreDesc_InUse[] = {
  "True",
  "False",
  "NA"
};

static const char * const * const RtemsPartReqReturnBuffer_PreDesc[] = {
  RtemsPartReqReturnBuffer_PreDesc_Id,
  RtemsPartReqReturnBuffer_PreDesc_InUse,
  NULL
};

#define PART_NAME rtems_build_name( 'N', 'A', 'M', 'E' )

#define BUFFER_COUNT 1

#define BUFFER_SIZE ( 2 * sizeof( void * ) )

static RTEMS_ALIGNED( RTEMS_PARTITION_ALIGNMENT ) uint8_t
  buffers[ BUFFER_COUNT ][ BUFFER_SIZE ];

static void RtemsPartReqReturnBuffer_Pre_Id_Prepare(
  RtemsPartReqReturnBuffer_Context *ctx,
  RtemsPartReqReturnBuffer_Pre_Id   state
)
{
  switch ( state ) {
    case RtemsPartReqReturnBuffer_Pre_Id_Id: {
      ctx->id = ctx->id_value;
      break;
    }

    case RtemsPartReqReturnBuffer_Pre_Id_Invalid: {
      ctx->id = 0;
      break;
    }

    case RtemsPartReqReturnBuffer_Pre_Id_NA:
      break;
  }
}

static void RtemsPartReqReturnBuffer_Pre_InUse_Prepare(
  RtemsPartReqReturnBuffer_Context  *ctx,
  RtemsPartReqReturnBuffer_Pre_InUse state
)
{
  rtems_status_code sc;

  switch ( state ) {
    case RtemsPartReqReturnBuffer_Pre_InUse_True: {
      ctx->buffer = NULL;
      sc = rtems_partition_get_buffer( ctx->id_value, &ctx->buffer );
      T_rsc_success( sc );
      T_not_null( ctx->buffer );
      break;
    }

    case RtemsPartReqReturnBuffer_Pre_InUse_False: {
      ctx->buffer = NULL;
      break;
    }

    case RtemsPartReqReturnBuffer_Pre_InUse_NA:
      break;
  }
}

static void RtemsPartReqReturnBuffer_Post_Status_Check(
  RtemsPartReqReturnBuffer_Context    *ctx,
  RtemsPartReqReturnBuffer_Post_Status state
)
{
  rtems_status_code sc;
  rtems_id          id;

  switch ( state ) {
    case RtemsPartReqReturnBuffer_Post_Status_Ok: {
      T_rsc_success( ctx->status );
      ctx->id_value = 0xffffffff;

      id = 0xffffffff;
      sc = rtems_partition_ident( PART_NAME, RTEMS_SEARCH_LOCAL_NODE, &id );
      T_rsc( sc, RTEMS_INVALID_NAME );
      T_eq_u32( id, 0xffffffff );
      break;
    }

    case RtemsPartReqReturnBuffer_Post_Status_InvId: {
      T_rsc( ctx->status, RTEMS_INVALID_ID );

      id = 0xffffffff;
      sc = rtems_partition_ident( PART_NAME, RTEMS_SEARCH_LOCAL_NODE, &id );
      T_rsc_success( sc);
      T_eq_u32( id, ctx->id_value );
      break;
    }

    case RtemsPartReqReturnBuffer_Post_Status_InUse: {
      T_rsc( ctx->status, RTEMS_RESOURCE_IN_USE );

      id = 0xffffffff;
      sc = rtems_partition_ident( PART_NAME, RTEMS_SEARCH_LOCAL_NODE, &id );
      T_rsc_success( sc);
      T_eq_u32( id, ctx->id_value );
      break;
    }

    case RtemsPartReqReturnBuffer_Post_Status_NA:
      break;
  }
}

static size_t RtemsPartReqReturnBuffer_Scope( void *arg, char *buf, size_t n )
{
  RtemsPartReqReturnBuffer_Context *ctx;

  ctx = arg;

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

  return 0;
}

static T_fixture RtemsPartReqReturnBuffer_Fixture = {
  .setup = NULL,
  .stop = NULL,
  .teardown = NULL,
  .scope = RtemsPartReqReturnBuffer_Scope,
  .initial_context = &RtemsPartReqReturnBuffer_Instance
};

static const uint8_t RtemsPartReqReturnBuffer_TransitionMap[][ 1 ] = {
  {
    RtemsPartReqReturnBuffer_Post_Status_InUse
  }, {
    RtemsPartReqReturnBuffer_Post_Status_Ok
  }, {
    RtemsPartReqReturnBuffer_Post_Status_InvId
  }, {
    RtemsPartReqReturnBuffer_Post_Status_InvId
  }
};

static const struct {
  uint8_t Skip : 1;
  uint8_t Pre_Id_NA : 1;
  uint8_t Pre_InUse_NA : 1;
} RtemsPartReqReturnBuffer_TransitionInfo[] = {
  {
    0, 0, 0
  }, {
    0, 0, 0
  }, {
    0, 0, 0
  }, {
    0, 0, 0
  }
};

static void RtemsPartReqReturnBuffer_Prepare(
  RtemsPartReqReturnBuffer_Context *ctx
)
{
  rtems_status_code sc;

  sc = rtems_partition_create(
    PART_NAME,
    buffers,
    sizeof( buffers ),
    sizeof( buffers[ 0 ] ),
    RTEMS_DEFAULT_ATTRIBUTES,
    &ctx->id_value
  );
  T_rsc_success( sc );
}

static void RtemsPartReqReturnBuffer_Action(
  RtemsPartReqReturnBuffer_Context *ctx
)
{
  ctx->status = rtems_partition_delete( ctx->id );
}

static void RtemsPartReqReturnBuffer_Cleanup(
  RtemsPartReqReturnBuffer_Context *ctx
)
{
  rtems_status_code sc;

  if ( ctx->buffer != NULL ) {
    sc = rtems_partition_return_buffer( ctx->id_value, ctx->buffer );
    T_rsc_success( sc );
  }

  if ( ctx->id_value != 0xffffffff ) {
    sc = rtems_partition_delete( ctx->id_value );
    T_rsc_success( sc );
  }
}

T_TEST_CASE_FIXTURE(
  RtemsPartReqReturnBuffer,
  &RtemsPartReqReturnBuffer_Fixture
)
{
  RtemsPartReqReturnBuffer_Context *ctx;
  size_t index;

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

  for (
    ctx->pcs[ 0 ] = RtemsPartReqReturnBuffer_Pre_Id_Id;
    ctx->pcs[ 0 ] < RtemsPartReqReturnBuffer_Pre_Id_NA;
    ++ctx->pcs[ 0 ]
  ) {
    if ( RtemsPartReqReturnBuffer_TransitionInfo[ index ].Pre_Id_NA ) {
      ctx->pcs[ 0 ] = RtemsPartReqReturnBuffer_Pre_Id_NA;
      index += ( RtemsPartReqReturnBuffer_Pre_Id_NA - 1 )
        * RtemsPartReqReturnBuffer_Pre_InUse_NA;
    }

    for (
      ctx->pcs[ 1 ] = RtemsPartReqReturnBuffer_Pre_InUse_True;
      ctx->pcs[ 1 ] < RtemsPartReqReturnBuffer_Pre_InUse_NA;
      ++ctx->pcs[ 1 ]
    ) {
      if ( RtemsPartReqReturnBuffer_TransitionInfo[ index ].Pre_InUse_NA ) {
        ctx->pcs[ 1 ] = RtemsPartReqReturnBuffer_Pre_InUse_NA;
        index += ( RtemsPartReqReturnBuffer_Pre_InUse_NA - 1 );
      }

      if ( RtemsPartReqReturnBuffer_TransitionInfo[ index ].Skip ) {
        ++index;
        continue;
      }

      RtemsPartReqReturnBuffer_Prepare( ctx );
      RtemsPartReqReturnBuffer_Pre_Id_Prepare( ctx, ctx->pcs[ 0 ] );
      RtemsPartReqReturnBuffer_Pre_InUse_Prepare( ctx, ctx->pcs[ 1 ] );
      RtemsPartReqReturnBuffer_Action( ctx );
      RtemsPartReqReturnBuffer_Post_Status_Check(
        ctx,
        RtemsPartReqReturnBuffer_TransitionMap[ index ][ 0 ]
      );
      RtemsPartReqReturnBuffer_Cleanup( ctx );
      ++index;
    }
  }
}