tc-task-ident.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 "tr-object-ident.h"

#include <rtems/test.h>

typedef enum {
  RtemsTaskReqIdent_Pre_Pre_Self,
  RtemsTaskReqIdent_Pre_Pre_Generic,
  RtemsTaskReqIdent_Pre_Pre_NA
} RtemsTaskReqIdent_Pre_Pre;

typedef enum {
  RtemsTaskReqIdent_Post_Post_OkAndSelfId,
  RtemsTaskReqIdent_Post_Post_Generic,
  RtemsTaskReqIdent_Post_Post_NA
} RtemsTaskReqIdent_Post_Post;

typedef struct {
  rtems_status_code status;

  rtems_id *id;

  rtems_id id_value;

  rtems_id id_local_object;

  size_t pcs[ 1 ];

  bool in_action_loop;
} RtemsTaskReqIdent_Context;

static RtemsTaskReqIdent_Context
  RtemsTaskReqIdent_Instance;

static const char * const RtemsTaskReqIdent_PreDesc_Pre[] = {
  "Self",
  "Generic",
  "NA"
};

static const char * const * const RtemsTaskReqIdent_PreDesc[] = {
  RtemsTaskReqIdent_PreDesc_Pre,
  NULL
};

static rtems_status_code ClassicTaskIdentAction(
  rtems_name name,
  uint32_t   node,
  rtems_id  *id
)
{
  return rtems_task_ident( name, node, id );
}

#define TASK_ATTRIBUTES RTEMS_DEFAULT_ATTRIBUTES

#define MAX_TLS_SIZE RTEMS_ALIGN_UP( 64, RTEMS_TASK_STORAGE_ALIGNMENT )

RTEMS_ALIGNED( RTEMS_TASK_STORAGE_ALIGNMENT )
static char ClassicTaskIdentStorage[
  RTEMS_TASK_STORAGE_SIZE(
    MAX_TLS_SIZE + RTEMS_MINIMUM_STACK_SIZE,
    TASK_ATTRIBUTES
  )
];

static const rtems_task_config ClassicTaskIdentConfig = {
  .name = ClassicObjectIdentName,
  .initial_priority = 1,
  .storage_area = ClassicTaskIdentStorage,
  .storage_size = sizeof( ClassicTaskIdentStorage ),
  .maximum_thread_local_storage_size = MAX_TLS_SIZE,
  .initial_modes = RTEMS_DEFAULT_MODES,
  .attributes = TASK_ATTRIBUTES
};

static void RtemsTaskReqIdent_Pre_Pre_Prepare(
  RtemsTaskReqIdent_Context *ctx,
  RtemsTaskReqIdent_Pre_Pre  state
)
{
  switch ( state ) {
    case RtemsTaskReqIdent_Pre_Pre_Self: {
      ctx->id_value = 0xffffffff;
      ctx->id = &ctx->id_value;
      break;
    }

    case RtemsTaskReqIdent_Pre_Pre_Generic: {
      ctx->id = NULL;
      /* Preparation performed by RtemsReqIdent_Run() */
      break;
    }

    case RtemsTaskReqIdent_Pre_Pre_NA:
      break;
  }
}

static void RtemsTaskReqIdent_Post_Post_Check(
  RtemsTaskReqIdent_Context  *ctx,
  RtemsTaskReqIdent_Post_Post state
)
{
  switch ( state ) {
    case RtemsTaskReqIdent_Post_Post_OkAndSelfId: {
      T_rsc(ctx->status, RTEMS_SUCCESSFUL);
      T_eq_ptr(ctx->id, &ctx->id_value);
      T_eq_u32(ctx->id_value, rtems_task_self());
      break;
    }

    case RtemsTaskReqIdent_Post_Post_Generic: {
      /* Checks performed by RtemsReqIdent_Run() */
      break;
    }

    case RtemsTaskReqIdent_Post_Post_NA:
      break;
  }
}

static void RtemsTaskReqIdent_Setup( RtemsTaskReqIdent_Context *ctx )
{
  rtems_status_code sc;

  sc = rtems_task_construct(
    &ClassicTaskIdentConfig,
    &ctx->id_local_object
  );
  T_assert_rsc_success( sc );
}

static void RtemsTaskReqIdent_Setup_Wrap( void *arg )
{
  RtemsTaskReqIdent_Context *ctx;

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

static void RtemsTaskReqIdent_Teardown( RtemsTaskReqIdent_Context *ctx )
{
  if ( ctx->id_local_object != 0 ) {
    rtems_status_code sc;

    sc = rtems_task_delete( ctx->id_local_object );
    T_rsc_success( sc );
  }
}

static void RtemsTaskReqIdent_Teardown_Wrap( void *arg )
{
  RtemsTaskReqIdent_Context *ctx;

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

static size_t RtemsTaskReqIdent_Scope( void *arg, char *buf, size_t n )
{
  RtemsTaskReqIdent_Context *ctx;

  ctx = arg;

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

  return 0;
}

static T_fixture RtemsTaskReqIdent_Fixture = {
  .setup = RtemsTaskReqIdent_Setup_Wrap,
  .stop = NULL,
  .teardown = RtemsTaskReqIdent_Teardown_Wrap,
  .scope = RtemsTaskReqIdent_Scope,
  .initial_context = &RtemsTaskReqIdent_Instance
};

static const uint8_t RtemsTaskReqIdent_TransitionMap[][ 1 ] = {
  {
    RtemsTaskReqIdent_Post_Post_OkAndSelfId
  }, {
    RtemsTaskReqIdent_Post_Post_Generic
  }
};

static const struct {
  uint8_t Skip : 1;
  uint8_t Pre_Pre_NA : 1;
} RtemsTaskReqIdent_TransitionInfo[] = {
  {
    0, 0
  }, {
    0, 0
  }
};

static void RtemsTaskReqIdent_Action( RtemsTaskReqIdent_Context *ctx )
{
  if ( ctx->id != NULL ) {
    ctx->status = rtems_task_ident( RTEMS_SELF, 0xdeadbeef, ctx->id );
  } else {
    RtemsReqIdent_Run(
      ctx->id_local_object,
      ClassicTaskIdentAction
    );
  }
}

T_TEST_CASE_FIXTURE( RtemsTaskReqIdent, &RtemsTaskReqIdent_Fixture )
{
  RtemsTaskReqIdent_Context *ctx;
  size_t index;

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

  for (
    ctx->pcs[ 0 ] = RtemsTaskReqIdent_Pre_Pre_Self;
    ctx->pcs[ 0 ] < RtemsTaskReqIdent_Pre_Pre_NA;
    ++ctx->pcs[ 0 ]
  ) {
    if ( RtemsTaskReqIdent_TransitionInfo[ index ].Pre_Pre_NA ) {
      ctx->pcs[ 0 ] = RtemsTaskReqIdent_Pre_Pre_NA;
      index += ( RtemsTaskReqIdent_Pre_Pre_NA - 1 );
    }

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

    RtemsTaskReqIdent_Pre_Pre_Prepare( ctx, ctx->pcs[ 0 ] );
    RtemsTaskReqIdent_Action( ctx );
    RtemsTaskReqIdent_Post_Post_Check(
      ctx,
      RtemsTaskReqIdent_TransitionMap[ index ][ 0 ]
    );
    ++index;
  }
}