summaryrefslogtreecommitdiffstats
path: root/spec/rtems/sem/req/timeout.yml
blob: fa2d92504a2a49f33f0327bf99b72572afc58f5e (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
enabled-by: true
functional-type: action
links:
- role: interface-function
  uid: ../if/obtain
- role: function-implementation
  uid: /score/tq/req/timeout
- role: function-implementation
  uid: /score/tq/req/timeout-mrsp
- role: function-implementation
  uid: /score/tq/req/timeout-priority-inherit
post-conditions:
- name: Action
  states:
  - name: Timeout
    test-code: |
      ctx->tq_ctx.wait = TQ_WAIT_TIMED;
      ${/score/tq/req/timeout:/test-run}( &ctx->tq_ctx );
    text: |
      The semaphore obtain timeout actions shall be done as specified by
      ${/score/tq/req/timeout:/spec}.
  - name: TimeoutMrsP
    test-code: |
      ctx->tq_ctx.wait = TQ_WAIT_TIMED;
      ${/score/tq/req/timeout-mrsp:/test-run}( &ctx->tq_ctx );
    text: |
      The semaphore obtain timeout actions shall be done as specified by
      ${/score/tq/req/timeout-mrsp:/spec}.
  - name: TimeoutPriorityInherit
    test-code: |
      ctx->tq_ctx.wait = TQ_WAIT_FOREVER;
      ${/score/tq/req/timeout-priority-inherit:/test-run}( &ctx->tq_ctx );
    text: |
      The semaphore obtain timeout actions shall be done as specified by
      ${/score/tq/req/timeout-priority-inherit:/spec}.
  test-epilogue: null
  test-prologue: null
pre-conditions:
- name: Class
  states:
  - name: Counting
    test-code: |
      ctx->attribute_set |= RTEMS_COUNTING_SEMAPHORE;
      ctx->tq_ctx.enqueue_variant = TQ_ENQUEUE_BLOCKS;
    text: |
      While the semaphore object is a counting semaphore.
  - name: Simple
    test-code: |
      ctx->attribute_set |= RTEMS_SIMPLE_BINARY_SEMAPHORE;
      ctx->tq_ctx.enqueue_variant = TQ_ENQUEUE_BLOCKS;
    text: |
      While the semaphore object is a simple binary semaphore.
  - name: Binary
    test-code: |
      ctx->attribute_set |= RTEMS_BINARY_SEMAPHORE;
      ctx->tq_ctx.enqueue_variant = TQ_ENQUEUE_BLOCKS;
    text: |
      While the semaphore object is a binary semaphore.
  - name: PrioCeiling
    test-code: |
      ctx->attribute_set |= RTEMS_BINARY_SEMAPHORE | RTEMS_PRIORITY_CEILING;
      ctx->tq_ctx.enqueue_variant = TQ_ENQUEUE_BLOCKS;
    text: |
      While the semaphore object is a priority ceiling semaphore.
  - name: PrioInherit
    test-code: |
      ctx->attribute_set |= RTEMS_BINARY_SEMAPHORE | RTEMS_INHERIT_PRIORITY;
      ctx->tq_ctx.enqueue_variant = TQ_ENQUEUE_BLOCKS;
    text: |
      While the semaphore object is a priority inheritance semaphore.
  - name: MrsP
    test-code: |
      ctx->attribute_set |= RTEMS_BINARY_SEMAPHORE |
        RTEMS_MULTIPROCESSOR_RESOURCE_SHARING;
      ctx->tq_ctx.enqueue_variant = TQ_ENQUEUE_STICKY;
    text: |
      While the semaphore object is a MrsP semaphore.
  test-epilogue: null
  test-prologue: null
- name: Discipline
  states:
  - name: FIFO
    test-code: |
      ctx->attribute_set |= RTEMS_FIFO;
      ctx->tq_ctx.discipline = TQ_FIFO;
    text: |
      While the semaphore uses the FIFO task wait queue discipline.
  - name: Priority
    test-code: |
      ctx->attribute_set |= RTEMS_PRIORITY;
      ctx->tq_ctx.discipline = TQ_PRIORITY;
    text: |
      While the semaphore uses the priority task wait queue discipline.
  test-epilogue: null
  test-prologue: null
rationale: null
references: []
requirement-type: functional
skip-reasons:
  NeedsPriorityDiscipline: |
    Binary semaphores with a locking protocol are required to use the priority
    task wait queue discipline.
  NoMrsP: |
    Where the system is build with SMP support disabled, the MrsP locking
    protocol is not available.
test-action: |
  rtems_status_code sc;

  sc = rtems_semaphore_create(
    OBJECT_NAME,
    1,
    ctx->attribute_set,
    PRIO_HIGH,
    &ctx->tq_ctx.thread_queue_id
  );
  T_rsc_success( sc );
test-brief: null
test-cleanup:
  if ( ctx->tq_ctx.thread_queue_id != 0 ) {
    rtems_status_code sc;

    sc = rtems_semaphore_delete( ctx->tq_ctx.thread_queue_id );
    T_rsc_success( sc );
  }
test-context:
- brief: |
    This member contains the thread queue test context.
  description: null
  member: |
    TQContext tq_ctx;
- brief: |
    This member specifies if the attribute set of the semaphore.
  description: null
  member: |
    rtems_attribute attribute_set
test-context-support: null
test-description: null
test-header: null
test-includes:
- rtems.h
- string.h
test-local-includes:
- tr-tq-timeout.h
- tr-tq-timeout-mrsp.h
- tr-tq-timeout-priority-inherit.h
- tx-thread-queue.h
- tx-support.h
test-prepare: |
  ctx->attribute_set = RTEMS_DEFAULT_ATTRIBUTES;
  ctx->tq_ctx.thread_queue_id = 0;
test-setup:
  brief: null
  code: |
    memset( ctx, 0, sizeof( *ctx ) );
    ctx->tq_ctx.enqueue_prepare = TQEnqueuePrepareDefault;
    ctx->tq_ctx.enqueue_done = TQEnqueueDoneDefault;
    ctx->tq_ctx.enqueue = TQEnqueueClassicSem;
    ctx->tq_ctx.surrender = TQSurrenderClassicSem;
    ctx->tq_ctx.convert_status = TQConvertStatusClassic;
    TQInitialize( &ctx->tq_ctx );
  description: null
test-stop: null
test-support: null
test-target: testsuites/validation/tc-sem-timeout.c
test-teardown:
  brief: null
  code: |
    TQDestroy( &ctx->tq_ctx );
  description: null
text: |
  When a semaphore obtain timeout happens.
transition-map:
- enabled-by: true
  post-conditions:
    Action:
    - if:
        pre-conditions:
          Class: MrsP
      then: TimeoutMrsP
    - if:
        pre-conditions:
          Class: PrioInherit
      then: TimeoutPriorityInherit
    - else: Timeout
  pre-conditions:
    Class: all
    Discipline: all
- enabled-by: true
  post-conditions: NeedsPriorityDiscipline
  pre-conditions:
    Class:
    - PrioCeiling
    - PrioInherit
    - MrsP
    Discipline:
    - FIFO
- enabled-by:
    not: RTEMS_SMP
  post-conditions: NoMrsP
  pre-conditions:
    Class:
    - MrsP
    Discipline:
    - Priority
type: requirement