summaryrefslogtreecommitdiffstats
path: root/spec/rtems/scheduler/req/ident-by-processor.yml
blob: c3d94db43e01941baba791da26f395573384bee7 (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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
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/ident-by-processor
post-conditions:
- name: Status
  states:
  - name: Ok
    test-code: |
      T_rsc_success( ctx->status );
    text: |
      The return status of ${../if/ident-by-processor:/name} shall be
      ${../../status/if/successful:/name}.
  - name: InvAddr
    test-code: |
      T_rsc( ctx->status, RTEMS_INVALID_ADDRESS );
    text: |
      The return status of ${../if/ident-by-processor:/name} shall be
      ${../../status/if/invalid-address:/name}.
  - name: InvName
    test-code: |
      T_rsc( ctx->status, RTEMS_INVALID_NAME );
    text: |
      The return status of ${../if/ident-by-processor:/name} shall be
      ${../../status/if/invalid-name:/name}.
  - name: IncStat
    test-code: |
      T_rsc( ctx->status, RTEMS_INCORRECT_STATE );
    text: |
      The return status of ${../if/ident-by-processor:/name} shall be
      ${../../status/if/invalid-name:/name}.
  test-epilogue: null
  test-prologue: null
- name: IdVar
  states:
  - name: Set
    test-code: |
      T_eq_ptr( ctx->id, &ctx->id_value );
      T_eq_u32( ctx->id_value, 0x0f010001 );
    text: |
      The value of the object referenced by the
      ${../if/ident-by-processor:/params[1]/name} parameter shall be set to the
      identifier of the scheduler which owned the processor specified by the
      ${../if/ident-by-processor:/params[0]/name} parameter at some point
      during the call after the return of the ${../if/ident-by-processor:/name}
      call.
  - name: Nop
    test-code: |
      T_eq_u32( ctx->id_value, INVALID_ID );
    text: |
      Objects referenced by the ${../if/ident-by-processor:/params[1]/name} parameter in
      past calls to ${../if/ident-by-processor:/name} shall not be accessed by the
      ${../if/ident-by-processor:/name} call.
  test-epilogue: null
  test-prologue: null
pre-conditions:
- name: CPUOwnedByScheduler
  states:
  - name: 'Yes'
    test-code: |
      ctx->cpu_has_scheduler = true;
    text: |
      While the processor specified by the
      ${../if/ident-by-processor:/params[0]/name} parameter is owned by a
      scheduler.
  - name: 'No'
    test-code: |
      ctx->cpu_has_scheduler = false;
    text: |
      While the processor specified by the
      ${../if/ident-by-processor:/params[0]/name} parameter is not owned by a
      scheduler.
  test-epilogue: null
  test-prologue: null
- name: CPUIndex
  states:
  - name: Invalid
    test-code: |
      ctx->cpu_index = rtems_scheduler_get_processor_maximum();
    text: |
      While the ${../if/ident-by-processor:/params[0]/name} parameter greater
      than or equal to the processor maximum.
  - name: Valid
    test-code: |
      if ( ctx->cpu_has_scheduler ) {
        ctx->cpu_index = 0;
      } else {
        ctx->cpu_index = 1;
      }
    text: |
      While the ${../if/ident-by-processor:/params[0]/name} parameter less than
      the processor maximum.
  test-epilogue: null
  test-prologue: null
- name: Id
  states:
  - name: Valid
    test-code: |
      ctx->id_value = INVALID_ID;
      ctx->id = &ctx->id_value;
    text: |
      While the ${../if/ident-by-processor:/params[1]/name} parameter references an object
      of type ${../../type/if/id:/name}.
  - name: 'Null'
    test-code: |
      ctx->id = NULL;
    text: |
      While the ${../if/ident-by-processor:/params[1]/name} parameter is equal to
      ${/c/if/null:/name}.
  test-epilogue: null
  test-prologue: null
rationale: null
references: []
requirement-type: functional
skip-reasons:
  NoSecondCPU: |
    Where the system is build with SMP support disabled, the system has exactly
    one processor available and this processor is always owned by a scheduler.
test-action: |
  #if defined(RTEMS_SMP)
  rtems_status_code sc;

  if ( !ctx->cpu_has_scheduler ) {
    sc = rtems_scheduler_remove_processor( ctx->second_scheduler_id, 1 );
    T_rsc_success( sc );
  }
  #endif

  ctx->status = rtems_scheduler_ident_by_processor( ctx->cpu_index, ctx->id );

  #if defined(RTEMS_SMP)
  if ( !ctx->cpu_has_scheduler ) {
    sc = rtems_scheduler_add_processor( ctx->second_scheduler_id, 1 );
    T_rsc_success( sc );
  }
  #endif
test-brief: null
test-cleanup: null
test-context:
- brief: |
    This member contains the identifier of a second scheduler.
  description: null
  member: |
    rtems_id second_scheduler_id
- brief: |
    This member provides the object referenced by the
    ${../if/ident-by-processor:/params[1]/name} parameter.
  description: null
  member: |
    rtems_id id_value
- brief: |
    If this member is true, then the processor specified by the
    ${../if/ident-by-processor:/params[0]/name} parameter shall be owned by a
    scheduler.
  description: null
  member: |
    bool cpu_has_scheduler
- brief: |
    This member contains the return value of the ${../if/ident-by-processor:/name} call.
  description: null
  member: |
    rtems_status_code status
- brief: |
    This member specifies if the ${../if/ident-by-processor:/params[0]/name} parameter
    value.
  description: null
  member: |
    uint32_t cpu_index
- brief: |
    This member specifies if the ${../if/ident-by-processor:/params[1]/name} parameter
    value.
  description: null
  member: |
    rtems_id *id
test-context-support: null
test-description: null
test-header: null
test-includes:
- rtems.h
test-local-includes:
- ts-config.h
- tx-support.h
test-prepare: |
  ctx->id_value = INVALID_ID;
test-setup:
  brief: null
  code: |
    #if defined(RTEMS_SMP)
    rtems_status_code sc;

    sc = rtems_scheduler_ident(
      TEST_SCHEDULER_B_NAME,
      &ctx->second_scheduler_id
    );
    T_rsc_success( sc );
    #else
    ctx->second_scheduler_id = INVALID_ID;
    #endif
  description: null
test-stop: null
test-support: null
test-target: testsuites/validation/tc-scheduler-ident-by-processor.c
test-teardown: null
text: ${.:text-template}
transition-map:
- enabled-by: true
  post-conditions:
    Status: Ok
    IdVar: Set
  pre-conditions:
    CPUOwnedByScheduler:
    - 'Yes'
    CPUIndex:
    - Valid
    Id:
    - Valid
- enabled-by: true
  post-conditions:
    Status: InvAddr
    IdVar: Nop
  pre-conditions:
    CPUOwnedByScheduler:
    - 'Yes'
    CPUIndex:
    - Valid
    Id:
    - 'Null'
- enabled-by: true
  post-conditions:
    Status: InvAddr
    IdVar: Nop
  pre-conditions:
    CPUOwnedByScheduler: N/A
    CPUIndex:
    - Invalid
    Id:
    - 'Null'
- enabled-by: true
  post-conditions:
    Status: InvName
    IdVar: Nop
  pre-conditions:
    CPUOwnedByScheduler: N/A
    CPUIndex:
    - Invalid
    Id:
    - Valid
- enabled-by: true
  post-conditions: NoSecondCPU
  pre-conditions:
    CPUOwnedByScheduler:
    - 'No'
    CPUIndex:
    - Valid
    Id: all
- enabled-by: RTEMS_SMP
  post-conditions:
    Status: InvAddr
    IdVar: Nop
  pre-conditions:
    CPUOwnedByScheduler:
    - 'No'
    CPUIndex:
    - Valid
    Id:
    - 'Null'
- enabled-by: RTEMS_SMP
  post-conditions:
    Status: IncStat
    IdVar: Nop
  pre-conditions:
    CPUOwnedByScheduler:
    - 'No'
    CPUIndex:
    - Valid
    Id:
    - Valid
type: requirement