summaryrefslogtreecommitdiffstats
path: root/spec/rtems/sem/req/obtain.yml
blob: 62cee1b14f33b473aade7ac6c408c8a7c6978f10 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
functional-type: action
links:
- role: interface-function
  uid: ../if/obtain
post-conditions:
- name: Action
  states:
  - name: InvId
    test-code: |
      sc = rtems_semaphore_obtain( 0xffffffff, RTEMS_WAIT, RTEMS_NO_TIMEOUT );
      T_rsc( sc, RTEMS_INVALID_ID );
    text: |
      The return status of ${../if/obtain:/name} shall be
      ${../../status/if/invalid-id:/name}.
  - name: SemSeizeTry
    test-code: |
      ctx->tq_sem_ctx.get_count = TQSemGetCountClassic;
      ctx->tq_sem_ctx.set_count = TQSemSetCountClassic;
      ${/score/sem/req/seize-try:/test-run}( &ctx->tq_sem_ctx );
    text: |
      The calling task shall try to seize the semaphore as specified by
      ${/score/sem/req/seize-try}.
  - name: SemSeizeWait
    test-code: |
      ctx->tq_sem_ctx.get_count = TQSemGetCountClassic;
      ctx->tq_sem_ctx.set_count = TQSemSetCountClassic;
      ${/score/sem/req/seize-wait:/test-run}( &ctx->tq_sem_ctx );
    text: |
      The calling task shall wait to seize the semaphore as specified by
      ${/score/sem/req/seize-wait}.
  test-epilogue: null
  test-prologue: |
    rtems_status_code sc;
pre-conditions:
- name: Class
  states:
  - name: Counting
    test-code: |
      ctx->attribute_set |= RTEMS_COUNTING_SEMAPHORE;
    text: |
      While the semaphore object is a counting semaphore.
  - name: Simple
    test-code: |
      ctx->attribute_set |= RTEMS_SIMPLE_BINARY_SEMAPHORE;
    text: |
      While the semaphore object is a simple binary 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
- name: Id
  states:
  - name: Valid
    test-code: |
      /* Nothing to prepare */
    text: |
      While the ${../if/obtain:/params[0]/name} parameter is associated with
      the semaphore.
  - name: Invalid
    test-code: |
      /* Nothing to prepare */
    text: |
      While the ${../if/obtain:/params[0]/name} parameter is not associated
      with a semaphore.
  test-epilogue: null
  test-prologue: null
- name: Wait
  states:
  - name: 'No'
    test-code: |
      ctx->tq_ctx.wait = TQ_NO_WAIT;
    text: |
      While the ${../if/obtain:/params[1]/name} parameter indicates the
      ${../../option/if/no-wait} option.
  - name: Timeout
    test-code: |
      ctx->tq_ctx.wait = TQ_WAIT_TICKS;
    text: |
      While the ${../if/obtain:/params[1]/name} parameter indicates the
      ${../../option/if/wait:/name} option, while the
      ${../if/obtain:/params[2]/name} parameter is not equal to
      ${../../type/if/no-timeout:/name}.
  - name: Forever
    test-code: |
      ctx->tq_ctx.wait = TQ_WAIT_FOREVER;
    text: |
      While the ${../if/obtain:/params[1]/name} parameter indicates the
      ${../../option/if/wait:/name} option, while the
      ${../if/obtain:/params[2]/name} parameter is equal to
      ${../../type/if/no-timeout:/name}.
  test-epilogue: null
  test-prologue: null
rationale: null
references: []
requirement-type: functional
skip-reasons: {}
test-action: |
  rtems_status_code sc;

  sc = rtems_semaphore_create(
    NAME,
    1,
    ctx->attribute_set,
    PRIO_ULTRA_HIGH,
    &ctx->tq_ctx.thread_queue_id
  );
  T_rsc_success( sc );
test-brief: null
test-cleanup:
  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: |
    union {
      TQContext tq_ctx;
      TQSemContext tq_sem_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:
- tx-support.h
- tr-sem-seize-try.h
- tr-sem-seize-wait.h
- tx-thread-queue.h
test-prepare: null
test-setup:
  brief: null
  code: |
    memset( ctx, 0, sizeof( *ctx ) );
    ctx->tq_ctx.enqueue = TQEnqueueClassicSem;
    ctx->tq_ctx.dequeue_one = TQDequeueClassicSem;
    ctx->tq_ctx.dequeue_all = TQDequeueClassicSem;
    ctx->tq_ctx.convert_status = TQConvertStatusClassic;
    TQInitialize( &ctx->tq_ctx );
  description: null
test-stop: null
test-support: |
  #define NAME rtems_build_name( 'T', 'E', 'S', 'T' )

  typedef RtemsSemReqObtain_Context Context;
test-target: testsuites/validation/tc-sem-obtain.c
test-teardown:
  brief: null
  code: |
    TQDestroy( &ctx->tq_ctx );
  description: null
text: ${.:text-template}
transition-map:
- enabled-by: true
  post-conditions:
    Action: InvId
  pre-conditions:
    Class: all
    Discipline: all
    Id:
    - Invalid
    Wait: all
- enabled-by: true
  post-conditions:
    Action: SemSeizeTry
  pre-conditions:
    Class: all
    Discipline: all
    Id:
    - Valid
    Wait:
    - 'No'
- enabled-by: true
  post-conditions:
    Action: SemSeizeWait
  pre-conditions:
    Class: all
    Discipline: all
    Id:
    - Valid
    Wait:
    - Timeout
    - Forever
type: requirement