summaryrefslogtreecommitdiffstats
path: root/testsuites/validation/tc-score-thread.c
blob: 53b939e3c5bc5a5043f2fa6b92e9056ffb0f3afd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSTestCaseScoreThreadValThread
 */

/*
 * 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.h>
#include <rtems/score/statesimpl.h>
#include <rtems/score/threadimpl.h>

#include "tx-support.h"

#include <rtems/test.h>

/**
 * @defgroup RTEMSTestCaseScoreThreadValThread spec:/score/thread/val/thread
 *
 * @ingroup RTEMSTestSuiteTestsuitesValidationNoClock0
 *
 * @brief Tests general thread behaviour.
 *
 * This test case performs the following actions:
 *
 * - Create an extension set with a thread terminate extension which deletes
 *   the killer task if it is invoked for the worker task.  Create and start
 *   the worker task.  Create and start the killer task.  The killer task
 *   deletes the worker task.
 *
 *   - Check that the killer task was deleted.
 *
 *   - Check that the worker task still exists.
 *
 *   - Check that the life of the worker task is protected and terminating.
 *
 *   - Check that the worker task is waiting for a joining thread.
 *
 *   - Delete the worker task using brute force.
 *
 *   - Clean up all used resources.
 *
 * @{
 */

/**
 * @brief Test context for spec:/score/thread/val/thread test case.
 */
typedef struct {
  /**
   * @brief This member contains the worker task identifier.
   */
  rtems_id worker_id;

  /**
   * @brief This member contains the killer task identifier.
   */
  rtems_id killer_id;
} ScoreThreadValThread_Context;

static ScoreThreadValThread_Context
  ScoreThreadValThread_Instance;

typedef ScoreThreadValThread_Context Context;

static void TaskTerminate( rtems_tcb *executing )
{
  Context *ctx;

  ctx = T_fixture_context();

  if ( ctx->worker_id == executing->Object.id ) {
    DeleteTask( ctx->killer_id );
  }
}

static void WorkerTask( rtems_task_argument arg )
{
  (void) arg;
  SuspendSelf();
}

static void KillerTask( rtems_task_argument arg )
{
  Context *ctx;

  ctx = (Context *) arg;
  DeleteTask( ctx->worker_id );
}

static T_fixture ScoreThreadValThread_Fixture = {
  .setup = NULL,
  .stop = NULL,
  .teardown = NULL,
  .scope = NULL,
  .initial_context = &ScoreThreadValThread_Instance
};

/**
 * @brief Create an extension set with a thread terminate extension which
 *   deletes the killer task if it is invoked for the worker task.  Create and
 *   start the worker task.  Create and start the killer task.  The killer task
 *   deletes the worker task.
 */
static void ScoreThreadValThread_Action_0( ScoreThreadValThread_Context *ctx )
{
  rtems_extensions_table table = {
    .thread_terminate = TaskTerminate
  };
  rtems_status_code sc;
  rtems_id          id;
  rtems_tcb        *worker_tcb;

  sc = rtems_extension_create(
    rtems_build_name( 'T', 'E', 'S', 'T' ),
    &table,
    &id
  );
  T_rsc_success( sc );

  SetSelfPriority( PRIO_NORMAL );
  ctx->worker_id = CreateTask( "WORK", PRIO_HIGH );
  worker_tcb = GetThread( ctx->worker_id );
  StartTask( ctx->worker_id, WorkerTask, NULL );
  ctx->killer_id = CreateTask( "KILL", PRIO_HIGH );
  StartTask( ctx->killer_id, KillerTask, ctx );

  /*
   * Check that the killer task was deleted.
   */
  sc = rtems_event_send( ctx->killer_id, RTEMS_EVENT_0 );
  T_rsc( sc, RTEMS_INVALID_ID );

  /*
   * Check that the worker task still exists.
   */
  sc = rtems_event_send( ctx->worker_id, RTEMS_EVENT_0 );
  T_rsc_success( sc );

  /*
   * Check that the life of the worker task is protected and terminating.
   */
  T_eq_int(
    worker_tcb->Life.state,
    THREAD_LIFE_PROTECTED | THREAD_LIFE_TERMINATING
  );

  /*
   * Check that the worker task is waiting for a joining thread.
   */
  T_eq_u32(
    worker_tcb->current_state,
    STATES_WAITING_FOR_JOIN_AT_EXIT
  );

  /*
   * Delete the worker task using brute force.
   */
  worker_tcb->Life.state = THREAD_LIFE_DETACHED |
    THREAD_LIFE_PROTECTED | THREAD_LIFE_TERMINATING;
  _Thread_Clear_state( worker_tcb, STATES_WAITING_FOR_JOIN_AT_EXIT );

  /*
   * Clean up all used resources.
   */
  KillZombies();
  RestoreRunnerPriority();

  sc = rtems_extension_delete( id );
  T_rsc_success( sc );
}

/**
 * @fn void T_case_body_ScoreThreadValThread( void )
 */
T_TEST_CASE_FIXTURE( ScoreThreadValThread, &ScoreThreadValThread_Fixture )
{
  ScoreThreadValThread_Context *ctx;

  ctx = T_fixture_context();

  ScoreThreadValThread_Action_0( ctx );
}

/** @} */