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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
|
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/get-status
post-conditions:
- name: Status
states:
- name: Ok
test-code: |
T_rsc_success( ctx->status );
text: |
The return status of ${../if/get-status:/name} shall be
${../../status/if/successful:/name}
- name: InvAddr
test-code: |
T_rsc( ctx->status, RTEMS_INVALID_ADDRESS );
text: |
The return status of ${../if/get-status:/name} shall be
${../../status/if/invalid-address:/name}.
- name: InvId
test-code: |
T_rsc( ctx->status, RTEMS_INVALID_ID );
text: |
The return status of ${../if/get-status:/name} shall be
${../../status/if/invalid-id:/name}.
- name: NotDef
test-code: |
T_rsc( ctx->status, RTEMS_NOT_DEFINED );
text: |
The return status of ${../if/get-status:/name} shall be
${../../status/if/not-defined:/name}.
test-epilogue: null
test-prologue: null
- name: Owner
states:
- name: OwnerTask
test-code: |
T_eq_u32( ctx->period_status.owner, ctx->task_id );
text: |
The value of the member
${../if/period-status:/definition[0]/default/name} of the object
referenced by the ${../if/get-status:/params[1]/name}
parameter shall be set to the object identifier of the
${../glossary/ownertask:/term} of the period after the return of
the ${../if/get-status:/name} call.
- name: Nop
test-code: |
T_eq_u32( ctx->period_status.owner, initial_owner );
text: |
Objects referenced by the ${../if/get-status:/params[1]/name}
parameter in past call to ${../if/get-status:/name} shall not be
accessed by the ${../if/get-status:/name} call (see also
${../glossary/nop:/term}).
test-epilogue: null
test-prologue: null
- name: State
states:
- name: Inactive
test-code: |
T_eq_int( ctx->period_status.state, RATE_MONOTONIC_INACTIVE );
text: |
The value of the member
${../if/period-status:/definition[1]/default/name} of the object
referenced by the ${../if/get-status:/params[1]/name} parameter
shall be set to ${../if/inactive:/name} after the return of the
${../if/get-status:/name} call. (See also ${../glossary/inactive:/term})
- name: Active
test-code: |
T_eq_int( ctx->period_status.state, RATE_MONOTONIC_ACTIVE );
text: |
The value of the member
${../if/period-status:/definition[1]/default/name} of the object
referenced by the ${../if/get-status:/params[1]/name} parameter
shall be set to ${../if/active:/name} after the return of the
${../if/get-status:/name} call. (See also ${../glossary/active:/term})
- name: Expired
test-code: |
T_eq_int( ctx->period_status.state, RATE_MONOTONIC_EXPIRED );
text: |
The value of the member
${../if/period-status:/definition[1]/default/name} of the object
referenced by the ${../if/get-status:/params[1]/name}
parameter shall be set to ${../if/expired:/name} after the
return of the ${../if/get-status:/name} call.
(See also ${../glossary/expired:/term})
- name: Nop
test-code: |
T_eq_u32( ctx->period_status.state, initial_state );
text: |
Objects referenced by the ${../if/get-status:/params[1]/name}
parameter in past calls to ${../if/get-status:/name} shall not be
accessed by the ${../if/get-status:/name} call (see also
${../glossary/nop:/term}).
test-epilogue: null
test-prologue: null
- name: Elapsed
states:
- name: Time
test-code: |
T_log( T_VERBOSE, "Elapsed: %lld.%ld (expected: %lld.%ld)",
ctx->period_status.since_last_period.tv_sec,
ctx->period_status.since_last_period.tv_nsec,
ctx->elapsed.tv_sec,
ctx->elapsed.tv_nsec
);
T_eq_u64(
ctx->period_status.since_last_period.tv_sec,
ctx->elapsed.tv_sec
);
/* period_status integer arithmetic is plagued by a rounding error. */
T_le_long(
ctx->period_status.since_last_period.tv_nsec,
ctx->elapsed.tv_nsec + 1
);
T_ge_long(
ctx->period_status.since_last_period.tv_nsec,
ctx->elapsed.tv_nsec - 1
);
text: |
The value of the member
${../if/period-status:/definition[2]/default/name} of the object
referenced by the ${../if/get-status:/params[1]/name}
parameter shall be set to the ${../glossary/time:/term}
${../glossary/elapsed:/term}.
- name: Zero
test-code: |
T_eq_u64( ctx->period_status.since_last_period.tv_sec, 0 );
T_eq_long( ctx->period_status.since_last_period.tv_nsec, 0 );
text: |
The value of the member
${../if/period-status:/definition[2]/default/name} of the object
referenced by the ${../if/get-status:/params[1]/name}
parameter shall be set to 0.
- name: Nop
test-code: |
T_eq_u64(
ctx->period_status.since_last_period.tv_sec,
initial_period.tv_sec
);
T_eq_long(
ctx->period_status.since_last_period.tv_nsec,
initial_period.tv_nsec
);
text: |
Objects referenced by the ${../if/get-status:/params[1]/name}
parameter in past calls to ${../if/get-status:/name} shall not be
accessed by the ${../if/get-status:/name} call (see also
${../glossary/nop:/term}).
test-epilogue: null
test-prologue: null
- name: Consumed
states:
- name: CpuTime
test-code: |
T_log( T_VERBOSE, "CPU elapsed: %lld.%ld (expected: %lld.%ld)",
ctx->period_status.executed_since_last_period.tv_sec,
ctx->period_status.executed_since_last_period.tv_nsec,
ctx->consumed.tv_sec,
ctx->consumed.tv_nsec
);
T_eq_u64(
ctx->period_status.executed_since_last_period.tv_sec,
ctx->consumed.tv_sec
);
/* period_status integer arithmetic is plagued by a rounding error. */
T_le_long(
ctx->period_status.executed_since_last_period.tv_nsec,
ctx->consumed.tv_nsec + 1
);
T_ge_long(
ctx->period_status.executed_since_last_period.tv_nsec,
ctx->consumed.tv_nsec - 1
);
text: |
The value of the member
${../if/period-status:/definition[3]/default/name} of the object
referenced by the ${../if/get-status:/params[1]/name}
parameter shall be set to the ${../glossary/cputime:/term}
${../glossary/consumed:/term} by the ${../glossary/ownertask:/term}.
- name: Zero
test-code: |
T_eq_u64( ctx->period_status.executed_since_last_period.tv_sec, 0 );
T_eq_long( ctx->period_status.executed_since_last_period.tv_nsec, 0 );
text: |
The value of the member
${../if/period-status:/definition[2]/default/name} of the object
referenced by the ${../if/get-status:/params[1]/name} parameter
shall be set to 0.
- name: Nop
test-code: |
T_eq_u64(
ctx->period_status.executed_since_last_period.tv_sec,
initial_period.tv_sec
);
T_eq_long(
ctx->period_status.executed_since_last_period.tv_nsec,
initial_period.tv_nsec
);
text: |
Objects referenced by the ${../if/get-status:/params[1]/name}
parameter in past calls to ${../if/get-status:/name} shall not be
accessed by the ${../if/get-status:/name} call (see also
${../glossary/nop:/term}).
test-epilogue: null
test-prologue: null
- name: Postponed
states:
- name: Zero
test-code: |
T_eq_u32( ctx->period_status.postponed_jobs_count, 0 );
text: |
The value of the member
${../if/period-status:/definition[4]/default/name}
of the object referenced by the ${../if/get-status:/params[1]/name}
parameter shall be set to 0 after the return of the
${../if/get-status:/name} call.
- name: One
test-code: |
T_eq_u32( ctx->period_status.postponed_jobs_count, 1 );
text: |
The value of the member
${../if/period-status:/definition[4]/default/name}
of the object referenced by the ${../if/get-status:/params[1]/name}
parameter shall be set to the number of
${../glossary/postponedjob:/plural} (here 1) after the return of
the ${../if/get-status:/name} call.
- name: Several
test-code: |
T_eq_u32(
ctx->period_status.postponed_jobs_count,
ctx->postponed_jobs_count
);
text: |
The value of the member
${../if/period-status:/definition[4]/default/name}
of the object referenced by the ${../if/get-status:/params[1]/name}
parameter shall be set to the number of
${../glossary/postponedjob:/plural} after the return of the
${../if/get-status:/name} call.
- name: Nop
test-code: |
T_eq_u32( ctx->period_status.postponed_jobs_count,
initial_postponed_jobs_count );
text: |
Objects referenced by the ${../if/get-status:/params[1]/name}
parameter in past calls to ${../if/get-status:/name} shall not be
accessed by the ${../if/get-status:/name} call (see also
${../glossary/nop:/term}).
test-epilogue: null
test-prologue: null
pre-conditions:
- name: StatusAddr
states:
- name: Valid
test-code: |
ctx->status_param = &ctx->period_status;
text: |
While the ${../if/get-status:/params[1]/name} parameter references
an object of type ${../if/period-status:/name}.
- name: 'Null'
test-code: |
ctx->status_param = NULL;
text: |
While the ${../if/get-status:/params[1]/name} parameter is
${/c/if/null:/name}.
test-epilogue: null
test-prologue: null
- name: Id
states:
- name: Valid
test-code: |
ctx->id_param = ctx->period_id;
text: |
While the ${../if/get-status:/params[0]/name} parameter is valid.
- name: Invalid
test-code: |
ctx->id_param = RTEMS_ID_NONE;
text: |
While the ${../if/get-status:/params[0]/name} parameter is invalid.
test-epilogue: null
test-prologue: null
- name: CpuUse
states:
- name: Kept
test-code: |
ctx->do_reset = NULL;
text: |
While the CPU usage statistics in not changed.
- name: Reset
test-code: |
ctx->do_reset = rtems_cpu_usage_reset;
text: |
While the ${../../cpuuse/if/reset:/name} directive is called between the
call to ${../if/period:/name} which started the period and
the call to ${../if/get-status:/name}.
test-epilogue: null
test-prologue: null
- name: State
states:
- name: Inactive
test-code: |
/* Nothing to do here as the period is newly created. */
ctx->previous_state = RATE_MONOTONIC_INACTIVE;
text: |
While the ${../if/get-status:/params[0]/name} parameter references an
period object in ${../glossary/inactive:/term}
${../glossary/state:/term}.
- name: Active
test-code: |
rtems_status_code status;
status = rtems_rate_monotonic_period( ctx->period_id, period_length );
T_rsc_success( status );
ctx->previous_state = RATE_MONOTONIC_ACTIVE;
text: |
While the ${../if/get-status:/params[0]/name} parameter references an
period object in ${../glossary/active:/term} ${../glossary/state:/term}.
- name: Expired
test-code: |
rtems_status_code status;
status = rtems_rate_monotonic_period( ctx->period_id, period_length );
T_rsc_success( status );
ctx->previous_state = RATE_MONOTONIC_EXPIRED;
text: |
While the ${../if/get-status:/params[0]/name} parameter references an
period object in ${../glossary/expired:/term}
${../glossary/state:/term}.
test-epilogue: null
test-prologue: null
- name: Elapsed
states:
- name: Time
test-code: |
/* Time elapsed while having a CPU is added below in "CpuTime". */
text: |
While a certain ${../glossary/time:/term} of the
${/glossary/clock-monotonic:/term} has ${../glossary/elapsed:/term}.
test-epilogue: null
test-prologue: null
- name: Consumed
states:
- name: CpuTime
test-code: |
TickTheClock( ctx, elapsed_cpu_ticks );
ctx->consumed.tv_nsec +=
rtems_configuration_get_nanoseconds_per_tick() * elapsed_cpu_ticks;
text: |
While the owner ${/glossary/task:/term} has ${../glossary/consumed:/term}
a certain amount of ${../glossary/cputime:/term}.
test-epilogue: null
test-prologue: null
- name: Postponed
states:
- name: Zero
test-code: |
ctx->postponed_jobs_count = 0;
text: |
While the period is not in ${../glossary/expired:/term}
${../glossary/state:/term}.
- name: One
test-code: |
CreatePostponedJobs( ctx, 1 );
text: |
While there is one ${../glossary/postponedjob:/term}.
- name: Several
test-code: |
CreatePostponedJobs( ctx, 5 );
text: |
While there are two or more ${../glossary/postponedjob:/term}.
test-epilogue: null
test-prologue: null
rationale: null
references: []
requirement-type: functional
skip-reasons:
NotInInactiveState: |
${../glossary/postponedjob:/plural} do not exist in
${../glossary/inactive:/term} ${../glossary/state:/term}.
NeverInExpiredState: |
There must be ${../glossary/postponedjob:/plural} in
${../glossary/expired:/term} ${../glossary/state:/term}.
ResetOnlyWhenActive: |
The directive ${../../cpuuse/if/reset:/name} affects only periods
in ${../glossary/active:/term} or ${../glossary/expired:/term}
${../glossary/state:/term}.
test-action: |
if ( ctx->do_reset != NULL ) {
ctx->do_reset();
}
ctx->status = rtems_rate_monotonic_get_status(
ctx->id_param,
ctx->status_param
);
test-brief: null
test-cleanup: |
T_rsc_success( rtems_rate_monotonic_delete( ctx->period_id ) );
test-context:
- brief: |
This member contains a valid identifier of a period.
description: null
member: |
rtems_id period_id
- brief: |
This member contains the previous timecounter handler to restore.
description: null
member: |
GetTimecountHandler previous_timecounter_handler
- brief: |
This member is used to receive the ${../if/period-status:/name}
from the action.
description: null
member: |
rtems_rate_monotonic_period_status period_status
- brief: |
This member specifies the ${../if/get-status:/params[0]/name} parameter
for the action.
description: null
member: |
rtems_id id_param
- brief: |
This member specifies the ${../if/get-status:/params[1]/name} parameter
for the action.
description: null
member: |
rtems_rate_monotonic_period_status *status_param
- brief: |
This member contains the returned ${/glossary/statuscode:/term}
of the action.
description: null
member: |
rtems_status_code status
- brief: |
This member contains the ${/glossary/task:/term} identifier of the
${../glossary/ownertask:/term}.
description: null
member: |
rtems_id task_id
- brief: |
This member contains the ${../glossary/state:/term}
before the action.
description: null
member: |
rtems_rate_monotonic_period_states previous_state
- brief: |
If the ${../../cpuuse/if/reset:/name} directive should be called
before ${../if/get-status:/name}, this member contains a pointer to it.
description: null
member: |
void (*do_reset)( void )
- brief: |
This member contains the ${/glossary/clock-monotonic:/term}
${../glossary/time:/term} ${../glossary/elapsed:/term}.
description: null
member: |
struct timespec elapsed
- brief: |
This member contains the ${../glossary/cputime:/term}
${../glossary/consumed:/term} by the ${../glossary/ownertask:/term}.
description: null
member: |
struct timespec consumed
- brief: |
This member contains the number of ${../glossary/postponedjob:/plural}.
description: null
member: |
uint32_t postponed_jobs_count
test-context-support: null
test-description: null
test-header: null
test-includes:
- rtems.h
- rtems/cpuuse.h
test-local-includes:
- tx-support.h
test-prepare: |
rtems_status_code status;
status = rtems_rate_monotonic_create(
rtems_build_name( 'R', 'M', 'O', 'N' ),
&ctx->period_id
);
T_rsc_success( status );
ctx->period_status = (rtems_rate_monotonic_period_status) {
.owner = initial_owner,
.state = initial_state,
.since_last_period = initial_period,
.executed_since_last_period = initial_period,
.postponed_jobs_count = initial_postponed_jobs_count
};
ctx->elapsed.tv_sec = 0;
ctx->elapsed.tv_nsec = 0;
ctx->consumed.tv_sec = 0;
ctx->consumed.tv_nsec = 0;
ctx->postponed_jobs_count = 0;
TimecounterTick();
test-setup:
brief: null
code: |
ctx->previous_timecounter_handler = SetGetTimecountHandler( FreezeTime );
ctx->task_id = rtems_task_self();
description: null
test-stop: null
test-support: |
static const rtems_id initial_owner = 0xFFFFFFFF;
static const rtems_rate_monotonic_period_states initial_state =
(rtems_rate_monotonic_period_states) 0xFFFFFFFF;
static const struct timespec initial_period = { 0xFFFFFFFF, 0xFFFFFFFF };
static const uint32_t initial_postponed_jobs_count = 0xFFFFFFFF;
static const rtems_interval period_length = 5;
static const uint32_t elapsed_cpu_ticks = 3;
static uint32_t FreezeTime( void )
{
return GetTimecountCounter() - 1;
}
static void TickTheClock(
RtemsRatemonReqGetStatus_Context *ctx,
uint32_t ticks
)
{
uint32_t i;
for ( i = 0; i < ticks; ++i ) {
TimecounterTick();
}
ctx->elapsed.tv_nsec +=
rtems_configuration_get_nanoseconds_per_tick() * ticks;
}
static void CreatePostponedJobs(
RtemsRatemonReqGetStatus_Context *ctx,
uint32_t jobs_count
)
{
rtems_status_code status;
ctx->postponed_jobs_count = jobs_count;
if ( ctx->previous_state == RATE_MONOTONIC_ACTIVE ) {
jobs_count++;
TickTheClock( ctx, jobs_count * period_length );
status = rtems_rate_monotonic_period( ctx->period_id, period_length );
T_rsc( status, RTEMS_TIMEOUT );
} else {
/* ctx->previous_state == RATE_MONOTONIC_INACTIVE || _EXPIRED */
TickTheClock( ctx, jobs_count * period_length );
}
ctx->consumed.tv_nsec +=
rtems_configuration_get_nanoseconds_per_tick() *
jobs_count * period_length;
}
test-target: testsuites/validation/tc-ratemon-get-status.c
test-teardown:
brief: null
code: |
SetGetTimecountHandler( ctx->previous_timecounter_handler );
description: null
text: ${.:text-template}
transition-map:
- enabled-by: true
post-conditions:
Status: Ok
Owner: OwnerTask
State: Inactive
Elapsed: Zero
Consumed: Zero
Postponed: N/A
pre-conditions:
StatusAddr:
- Valid
Id:
- Valid
CpuUse:
- Kept
State:
- Inactive
Elapsed: N/A
Consumed: N/A
Postponed: N/A
- enabled-by: true
post-conditions:
Status: Ok
Owner: OwnerTask
State:
- specified-by: State
Elapsed: Time
Consumed: CpuTime
Postponed:
- specified-by: Postponed
pre-conditions:
StatusAddr:
- Valid
Id:
- Valid
CpuUse:
- Kept
State:
- Active
- Expired
Elapsed:
- Time
Consumed:
- CpuTime
Postponed: all
- enabled-by: true
post-conditions:
Status: InvAddr
Owner: Nop
State: Nop
Elapsed: Nop
Consumed: Nop
Postponed: Nop
pre-conditions:
StatusAddr:
- 'Null'
Id: all
CpuUse: all
State:
- Inactive
Elapsed: all
Consumed: all
Postponed: N/A
- enabled-by: true
post-conditions:
Status: InvAddr
Owner: Nop
State: Nop
Elapsed: Nop
Consumed: Nop
Postponed: Nop
pre-conditions:
StatusAddr:
- 'Null'
Id: all
CpuUse: all
State:
- Active
- Expired
Elapsed: all
Consumed: all
Postponed: all
- enabled-by: true
post-conditions:
Status: InvId
Owner: Nop
State: Nop
Elapsed: Nop
Consumed: Nop
Postponed: Nop
pre-conditions:
StatusAddr:
- Valid
Id:
- Invalid
CpuUse: all
State:
- Inactive
Elapsed: all
Consumed: all
Postponed: N/A
- enabled-by: true
post-conditions:
Status: InvId
Owner: Nop
State: Nop
Elapsed: Nop
Consumed: Nop
Postponed: Nop
pre-conditions:
StatusAddr:
- Valid
Id:
- Invalid
CpuUse: all
State:
- Active
- Expired
Elapsed: all
Consumed: all
Postponed: all
- enabled-by: true
post-conditions:
Status: NotDef
Owner: OwnerTask
State:
- specified-by: State
Elapsed: Nop
Consumed: Nop
Postponed:
- specified-by: Postponed
pre-conditions:
StatusAddr:
- Valid
Id:
- Valid
CpuUse:
- Reset
State:
- Active
- Expired
Elapsed: all
Consumed: all
Postponed: all
- enabled-by: true
post-conditions: NotInInactiveState
pre-conditions:
StatusAddr: all
Id: all
CpuUse: all
State:
- Inactive
Elapsed: all
Consumed: all
Postponed:
- One
- Several
- enabled-by: true
post-conditions: NeverInExpiredState
pre-conditions:
StatusAddr: all
Id: all
CpuUse: all
State:
- Expired
Elapsed: all
Consumed: all
Postponed:
- Zero
- enabled-by: true
post-conditions: ResetOnlyWhenActive
pre-conditions:
StatusAddr: all
Id: all
CpuUse:
- Reset
State:
- Inactive
Elapsed: all
Consumed: all
Postponed: all
type: requirement
|