summaryrefslogtreecommitdiffstats
path: root/spec/rtems/userext/req/create.yml
blob: bfac495e722813f099fc13b7ff20acd54608c2fa (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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
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/create
post-conditions:
- name: Status
  states:
  - name: Ok
    test-code: |
      T_rsc_success( ctx->status );
    text: |
      The return status of ${../if/create:/name} shall be
      ${../../status/if/successful:/name}.
  - name: InvName
    test-code: |
      T_rsc( ctx->status, RTEMS_INVALID_NAME );
    text: |
      The return status of ${../if/create:/name} shall be
      ${../../status/if/invalid-name:/name}.
  - name: InvAddr
    test-code: |
      T_rsc( ctx->status, RTEMS_INVALID_ADDRESS );
    text: |
      The return status of ${../if/create:/name} shall be
      ${../../status/if/invalid-address:/name}.
  - name: TooMany
    test-code: |
      T_rsc( ctx->status, RTEMS_TOO_MANY );
    text: |
      The return status of ${../if/create:/name} shall be
      ${../../status/if/too-many:/name}.
  test-epilogue: null
  test-prologue: null
- name: Name
  states:
  - name: Valid
    test-code: |
      id = 0;
      sc = rtems_extension_ident( NAME, &id );
      T_rsc_success( sc );
      T_eq_u32( id, ctx->id_value );
    text: |
      The unique object name shall identify the extension set created by the
      ${../if/create:/name} call.
  - name: Invalid
    test-code: |
      sc = rtems_extension_ident( NAME, &id );
      T_rsc( sc, RTEMS_INVALID_NAME );
    text: |
      The unique object name shall not identify an extension set.
  test-epilogue: null
  test-prologue: |
    rtems_status_code sc;
    rtems_id          id;
- name: IdVar
  states:
  - name: Set
    test-code: |
      T_eq_ptr( ctx->id, &ctx->id_value );
      T_ne_u32( ctx->id_value, INVALID_ID );
    text: |
      The value of the object referenced by the ${../if/create:/params[1]/name}
      parameter shall be set to the object identifier of the created extension
      set after the return of the ${../if/create:/name} call.
  - name: Nop
    test-code: |
      T_eq_u32( ctx->id_value, INVALID_ID );
    text: |
      Objects referenced by the ${../if/create:/params[1]/name} parameter in
      past calls to ${../if/create:/name} shall not be accessed by the
      ${../if/create:/name} call.
  test-epilogue: null
  test-prologue: null
pre-conditions:
- name: Name
  states:
  - name: Valid
    test-code: |
      ctx->name = NAME;
    text: |
      While the ${../if/create:/params[0]/name} parameter is valid.
  - name: Invalid
    test-code: |
      ctx->name = 0;
    text: |
      While the ${../if/create:/params[0]/name} parameter is invalid.
  test-epilogue: null
  test-prologue: null
- name: Id
  states:
  - name: Valid
    test-code: |
      ctx->id = &ctx->id_value;
    text: |
      While the ${../if/create:/params[2]/name} parameter references an object
      of type ${../../type/if/id:/name}.
  - name: 'Null'
    test-code: |
      ctx->id = NULL;
    text: |
      While the ${../if/create:/params[2]/name} parameter is
      ${/c/if/null:/name}.
  test-epilogue: null
  test-prologue: null
- name: Table
  states:
  - name: TdSw
    test-code: |
      ctx->table = &ctx->table_variable;
      ctx->table_variable.thread_switch = ThreadSwitch;
    text: |
      While the ${../if/create:/params[1]/name} parameter references an object
      of type ${../if/table:/name}, while all extensions except the thread
      switch extension of the referenced object are set to ${/c/if/null:/name}
      or the address of a corresponding extension, while the thread switch
      extension of the referenced object is set to the address of a thread
      switch extension.
  - name: NoTdSw
    test-code: |
      ctx->table = &ctx->table_variable;
      ctx->table_variable.thread_switch = NULL;
    text: |
      While the ${../if/create:/params[1]/name} parameter references an object
      of type ${../../type/if/id:/name}, while all extensions except the thread
      switch extension of the referenced object are set to ${/c/if/null:/name}
      or the address of a corresponding extension, while the thread switch
      extension of the referenced object is set to ${/c/if/null:/name}.
  - name: 'Null'
    test-code: |
      ctx->table = NULL;
    text: |
      While the ${../if/create:/params[1]/name} parameter is
      ${/c/if/null:/name}.
  test-epilogue: null
  test-prologue: null
- name: Free
  states:
  - name: 'Yes'
    test-code: |
      /* Nothing to do */
    text: |
      While the system has at least one inactive extension set object
      available.
  - name: 'No'
    test-code: |
      ctx->seized_objects = T_seize_objects( Create, NULL );
    text: |
      While the system has no inactive extension set object available.
  test-epilogue: null
  test-prologue: null
rationale: null
references: []
requirement-type: functional
skip-reasons: {}
test-action: |
  ctx->status = rtems_extension_create( ctx->name, ctx->table, ctx->id );
test-brief: null
test-cleanup: |
  if ( ctx->id_value != INVALID_ID ) {
    rtems_status_code sc;

    sc = rtems_extension_delete( ctx->id_value );
    T_rsc_success( sc );

    ctx->id_value = INVALID_ID;
  }

  T_surrender_objects( &ctx->seized_objects, rtems_extension_delete );
test-context:
- brief: null
  description: null
  member: |
    void *seized_objects
- brief: null
  description: null
  member: |
    rtems_extensions_table table_variable;
- brief: null
  description: null
  member: |
    rtems_id id_value
- brief: null
  description: null
  member: |
    rtems_name name
- brief: null
  description: null
  member: |
    rtems_extensions_table *table;
- brief: null
  description: null
  member: |
    rtems_id *id
- brief: null
  description: null
  member: |
    rtems_status_code status
test-context-support: null
test-description: null
test-header: null
test-includes:
- rtems.h
- string.h
test-local-includes:
- tx-support.h
test-prepare: null
test-setup:
  brief: null
  code: |
    memset( ctx, 0, sizeof( *ctx ) );
    ctx->id_value = INVALID_ID;
  description: null
test-stop: null
test-support: |
  #define NAME rtems_build_name( 'T', 'E', 'S', 'T' )

  static rtems_status_code Create( void *arg, uint32_t *id )
  {
    static const rtems_extensions_table table;

    return rtems_extension_create(
      rtems_build_name( 'S', 'I', 'Z', 'E' ),
      &table,
      id
    );
  }

  static void ThreadSwitch( rtems_tcb *executing,  rtems_tcb *heir)
  {
    (void) executing;
    (void) heir;
  }
test-target: testsuites/validation/tc-userext-create.c
test-teardown: null
text: ${.:text-template}
transition-map:
- enabled-by: true
  post-conditions:
    Status: InvName
    Name: Invalid
    IdVar: Nop
  pre-conditions:
    Name:
    - Invalid
    Table: all
    Id: all
    Free: all
- enabled-by: true
  post-conditions:
    Status: InvAddr
    Name: Invalid
    IdVar: Nop
  pre-conditions:
    Name:
    - Valid
    Table:
    - 'Null'
    Id: all
    Free: all
- enabled-by: true
  post-conditions:
    Status: InvAddr
    Name: Invalid
    IdVar: Nop
  pre-conditions:
    Name:
    - Valid
    Table:
    - TdSw
    - NoTdSw
    Id:
    - 'Null'
    Free: all
- enabled-by: true
  post-conditions:
    Status: TooMany
    Name: Invalid
    IdVar: Nop
  pre-conditions:
    Name:
    - Valid
    Table:
    - TdSw
    - NoTdSw
    Id:
    - Valid
    Free:
    - 'No'
- enabled-by: true
  post-conditions:
    Status: Ok
    Name: Valid
    IdVar: Set
  pre-conditions:
    Name:
    - Valid
    Table:
    - TdSw
    - NoTdSw
    Id:
    - Valid
    Free:
    - 'Yes'
type: requirement