source: rtems-central/spec/req/rtems/tasks/ident.yml @ f0d6862

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
functional-type: action
links:
- role: interface-function
  uid: /if/rtems/tasks/ident
post-conditions:
- name: Post
  states:
  - name: OkAndSelfId
    test-code: |
      T_rsc(ctx->status, RTEMS_SUCCESSFUL);
      T_eq_ptr(ctx->id, &ctx->id_value);
      T_eq_u32(ctx->id_value, rtems_task_self());
    text: |
      The status shall be RTEMS_SUCCESSFUL.  The value of the object identifier
      referenced by the id parameter shall be the identifier of the executing
      thread.
  - name: Generic
    test-code: |
      /* Checks performed by ${../ident:/test-run}() */
    text: |
      The post-condition status shall be specified by ${../ident}.
  test-epilogue: null
  test-prologue: null
pre-conditions:
- name: Pre
  states:
  - name: Self
    test-code: |
      ctx->id_value = 0xffffffff;
      ctx->id = &ctx->id_value;
    text: |
      The name parameter shall be RTEMS_SELF.
  - name: Generic
    test-code: |
      ctx->id = NULL;
      /* Preparation performed by ${../ident:/test-run}() */
    text: |
      The pre-condition status shall be specified by ${../ident}.
  test-epilogue: null
  test-prologue: null
requirement-type: functional
test-action: |
  if ( ctx->id != NULL ) {
    ctx->status = rtems_task_ident( RTEMS_SELF, 0xdeadbeef, ctx->id );
  } else {
    ${../ident:/test-run}(
      ctx->id_local_object,
      ClassicTaskIdentAction
    );
  }
test-brief: null
test-context:
- brief: null
  description: null
  member: rtems_status_code status
- brief: null
  description: null
  member: rtems_id *id
- brief: null
  description: null
  member: rtems_id id_value
- brief: null
  description: null
  member: rtems_id id_local_object
test-description: null
test-header: null
test-includes: []
test-local-includes:
- support-object-ident.h
test-name: Classic Task Ident
test-setup:
  brief: null
  code: |
    static char task_storage[ RTEMS_MINIMUM_STACK_SIZE ];
    static const rtems_task_config task_config = {
      .name = ClassicObjectIdentName,
      .initial_priority = 1,
      .stack_area = task_storage,
      .stack_size = sizeof( task_storage ),
      .initial_modes = RTEMS_DEFAULT_MODES,
      .attribute_set = RTEMS_DEFAULT_ATTRIBUTES
    };
    rtems_status_code sc;

    sc = rtems_task_build( &task_config, &ctx->id_local_object );
    T_assert_rsc_success( sc );
  description: null
test-stop: null
test-support: |
  static rtems_status_code ClassicTaskIdentAction(
    rtems_name name,
    uint32_t   node,
    rtems_id  *id
  )
  {
    return rtems_task_ident( name, node, id );
  }
test-target: testsuites/validation/tc-task-ident.c
test-teardown: null
transition-map:
- enabled-by: true
  post-conditions:
    Post: OkAndSelfId
  pre-conditions:
    Pre:
    - Self
- enabled-by: true
  post-conditions:
    Post: Generic
  pre-conditions:
    Pre:
    - Generic
rationale: null
references: []
text: ${.:text-template}
type: requirement