summaryrefslogtreecommitdiffstats
path: root/c-user/rate-monotonic/directives.rst
blob: 2e48aacb5ba9947b0600090e272073cb1392155d (plain)
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
.. SPDX-License-Identifier: CC-BY-SA-4.0

.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 2017 Kuan-Hsun Chen
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)

.. This file is part of the RTEMS quality process and was automatically
.. generated.  If you find something that needs to be fixed or
.. worded better please post a report or patch to an RTEMS mailing list
.. or raise a bug report:
..
.. https://www.rtems.org/bugs.html
..
.. For information on updating and regenerating please refer to the How-To
.. section in the Software Requirements Engineering chapter of the
.. RTEMS Software Engineering manual.  The manual is provided as a part of
.. a release.  For development sources please refer to the online
.. documentation at:
..
.. https://docs.rtems.org

.. _RateMonotonicManagerDirectives:

Directives
==========

This section details the directives of the Rate-Monotonic Manager. A subsection
is dedicated to each of this manager's directives and lists the calling
sequence, parameters, description, return values, and notes of the directive.

.. Generated from spec:/rtems/ratemon/if/create

.. raw:: latex

    \clearpage

.. index:: rtems_rate_monotonic_create()
.. index:: create a period

.. _InterfaceRtemsRateMonotonicCreate:

rtems_rate_monotonic_create()
-----------------------------

Creates a period.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_rate_monotonic_create( rtems_name name, rtems_id *id );

.. rubric:: PARAMETERS:

``name``
    This parameter is the object name of the period.

``id``
    This parameter is the pointer to an :c:type:`rtems_id` object.  When the
    directive call is successful, the identifier of the created period will be
    stored in this object.

.. rubric:: DESCRIPTION:

This directive creates a period which resides on the local node.  The period
has the user-defined object name specified in ``name`` The assigned object
identifier is returned in ``id``.  This identifier is used to access the period
with other rate monotonic related directives.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_NAME`
    The ``name`` parameter was invalid.

:c:macro:`RTEMS_TOO_MANY`
    There was no inactive object available to create a period.  The number of
    periods available to the application is configured through the
    :ref:`CONFIGURE_MAXIMUM_PERIODS` application configuration option.

.. rubric:: NOTES:

The calling task is registered as the owner of the created period.  Some
directives can be only used by this task for the created period.

For control and maintenance of the period, RTEMS allocates a :term:`PCB` from
the local PCB free pool and initializes it.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

* The number of periods available to the application is configured through the
  :ref:`CONFIGURE_MAXIMUM_PERIODS` application configuration option.

* Where the object class corresponding to the directive is configured to use
  unlimited objects, the directive may allocate memory from the RTEMS
  Workspace.

.. Generated from spec:/rtems/ratemon/if/ident

.. raw:: latex

    \clearpage

.. index:: rtems_rate_monotonic_ident()

.. _InterfaceRtemsRateMonotonicIdent:

rtems_rate_monotonic_ident()
----------------------------

Identifies a period by the object name.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_rate_monotonic_ident( rtems_name name, rtems_id *id );

.. rubric:: PARAMETERS:

``name``
    This parameter is the object name to look up.

``id``
    This parameter is the pointer to an :c:type:`rtems_id` object.  When the
    directive call is successful, the object identifier of an object with the
    specified name will be stored in this object.

.. rubric:: DESCRIPTION:

This directive obtains a period identifier associated with the period name
specified in ``name``.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``id`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_NAME`
    The ``name`` parameter was 0.

:c:macro:`RTEMS_INVALID_NAME`
    There was no object with the specified name on the local node.

.. rubric:: NOTES:

If the period name is not unique, then the period identifier will match the
first period with that name in the search order.  However, this period
identifier is not guaranteed to correspond to the desired period.

The objects are searched from lowest to the highest index.  Only the local node
is searched.

The period identifier is used with other rate monotonic related directives to
access the period.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/ratemon/if/cancel

.. raw:: latex

    \clearpage

.. index:: rtems_rate_monotonic_cancel()
.. index:: cancel a period

.. _InterfaceRtemsRateMonotonicCancel:

rtems_rate_monotonic_cancel()
-----------------------------

Cancels the period.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_rate_monotonic_cancel( rtems_id id );

.. rubric:: PARAMETERS:

``id``
    This parameter is the rate monotonic period identifier.

.. rubric:: DESCRIPTION:

This directive cancels the rate monotonic period specified by ``id``.  This
period may be reinitiated by the next invocation of
:ref:`InterfaceRtemsRateMonotonicPeriod`.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no rate monotonic period associated with the identifier specified
    by ``id``.

:c:macro:`RTEMS_NOT_OWNER_OF_RESOURCE`
    The rate monotonic period was not created by the calling task.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

* The directive may be used exclusively by the task which created the
  associated object.

.. Generated from spec:/rtems/ratemon/if/delete

.. raw:: latex

    \clearpage

.. index:: rtems_rate_monotonic_delete()
.. index:: delete a period

.. _InterfaceRtemsRateMonotonicDelete:

rtems_rate_monotonic_delete()
-----------------------------

Deletes the period.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_rate_monotonic_delete( rtems_id id );

.. rubric:: PARAMETERS:

``id``
    This parameter is the period identifier.

.. rubric:: DESCRIPTION:

This directive deletes the period specified by ``id``.  If the period is
running, it is automatically canceled.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no period associated with the identifier specified by ``id``.

.. rubric:: NOTES:

The :term:`PCB` for the deleted period is reclaimed by RTEMS.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

* The calling task does not have to be the task that created the object.  Any
  local task that knows the object identifier can delete the object.

* Where the object class corresponding to the directive is configured to use
  unlimited objects, the directive may free memory to the RTEMS Workspace.

.. Generated from spec:/rtems/ratemon/if/period

.. raw:: latex

    \clearpage

.. index:: rtems_rate_monotonic_period()
.. index:: conclude current period
.. index:: start current period
.. index:: period initiation

.. _InterfaceRtemsRateMonotonicPeriod:

rtems_rate_monotonic_period()
-----------------------------

Concludes the current period and start the next period, or gets the period
status.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_rate_monotonic_period(
      rtems_id       id,
      rtems_interval length
    );

.. rubric:: PARAMETERS:

``id``
    This parameter is the rate monotonic period identifier.

``length``
    This parameter is the period length in :term:`clock ticks <clock tick>` or
    :c:macro:`RTEMS_PERIOD_STATUS` to get the period status.

.. rubric:: DESCRIPTION:

This directive initiates the rate monotonic period specified by ``id``  with a
length of period ticks specified by ``length``.  If the period is running, then
the calling task will block for the remainder of the period before reinitiating
the period with the specified period length.  If the period was not running
(either expired or never initiated), the period is immediately initiated and
the directive returns immediately.  If the period has expired, the postponed
job will be released immediately and the following calls of this directive will
release postponed jobs until there is no more deadline miss.

If invoked with a period length of :c:macro:`RTEMS_PERIOD_STATUS` ticks, the
current state of the period will be returned.  The directive status indicates
the current state of the period.  This does not alter the state or period
length of the period.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no rate monotonic period associated with the identifier specified
    by ``id``.

:c:macro:`RTEMS_NOT_OWNER_OF_RESOURCE`
    The rate monotonic period was not created by the calling task.

:c:macro:`RTEMS_NOT_DEFINED`
    The rate monotonic period has never been initiated (only possible when the
    ``length`` parameter was equal to :c:macro:`RTEMS_PERIOD_STATUS`).

:c:macro:`RTEMS_TIMEOUT`
    The rate monotonic period has expired.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive may be used exclusively by the task which created the
  associated object.

.. Generated from spec:/rtems/ratemon/if/get-status

.. raw:: latex

    \clearpage

.. index:: rtems_rate_monotonic_get_status()
.. index:: get status of period
.. index:: obtain status of period

.. _InterfaceRtemsRateMonotonicGetStatus:

rtems_rate_monotonic_get_status()
---------------------------------

Gets the detailed status of the period.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_rate_monotonic_get_status(
      rtems_id                            id,
      rtems_rate_monotonic_period_status *status
    );

.. rubric:: PARAMETERS:

``id``
    This parameter is the rate monotonic period identifier.

``status``
    This parameter is the pointer to an
    :c:type:`rtems_rate_monotonic_period_status` object.  When the directive
    call is successful, the detailed period status will be stored in this
    object.

.. rubric:: DESCRIPTION:

This directive returns the detailed status of the rate monotonic period
specified by ``id``.  The detailed status of the period will be returned in the
members of the period status object referenced by ``status``:

* The ``owner`` member is set to the identifier of the owner task of the
  period.

* The ``state`` member is set to the current state of the period.

* The ``postponed_jobs_count`` member is set to the count of jobs which are not
  released yet.

* If the current state of the period is :c:macro:`RATE_MONOTONIC_INACTIVE`, the
  ``since_last_period`` and ``executed_since_last_period`` members will be set
  to zero.  Otherwise, both members will contain time information since the
  last successful invocation of the :ref:`InterfaceRtemsRateMonotonicPeriod`
  directive by the owner task.  More specifically, the ``since_last_period``
  member will be set to the time elapsed since the last successful invocation.
  The ``executed_since_last_period`` member will be set to the processor time
  consumed by the owner task since the last successful invocation.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no rate monotonic period associated with the identifier specified
    by ``id``.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``status`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_NOT_DEFINED`
    There was no status available due to a reset of the processor time usage of
    the owner task of the period.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive may be called from within interrupt context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/ratemon/if/get-statistics

.. raw:: latex

    \clearpage

.. index:: rtems_rate_monotonic_get_statistics()
.. index:: get statistics of period
.. index:: obtain statistics of period

.. _InterfaceRtemsRateMonotonicGetStatistics:

rtems_rate_monotonic_get_statistics()
-------------------------------------

Gets the statistics of the period.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_rate_monotonic_get_statistics(
      rtems_id                                id,
      rtems_rate_monotonic_period_statistics *status
    );

.. rubric:: PARAMETERS:

``id``
    This parameter is the rate monotonic period identifier.

``status``
    This parameter is the pointer to an
    :c:type:`rtems_rate_monotonic_period_statistics` object.  When the
    directive call is successful, the period statistics will be stored in this
    object.

.. rubric:: DESCRIPTION:

This directive returns the statistics of the rate monotonic period specified by
``id``.  The statistics of the period will be returned in the members of the
period statistics object referenced by ``status``:

* The ``count`` member is set to the number of periods executed.

* The ``missed_count`` member is set to the number of periods missed.

* The ``min_cpu_time`` member is set to the least amount of processor time used
  in the period.

* The ``max_cpu_time`` member is set to the highest amount of processor time
  used in the period.

* The ``total_cpu_time`` member is set to the total amount of processor time
  used in the period.

* The ``min_wall_time`` member is set to the least amount of
  :term:`CLOCK_MONOTONIC` time used in the period.

* The ``max_wall_time`` member is set to the highest amount of
  :term:`CLOCK_MONOTONIC` time used in the period.

* The ``total_wall_time`` member is set to the total amount of
  :term:`CLOCK_MONOTONIC` time used in the period.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no rate monotonic period associated with the identifier specified
    by ``id``.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``status`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive may be called from within interrupt context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/ratemon/if/reset-statistics

.. raw:: latex

    \clearpage

.. index:: rtems_rate_monotonic_reset_statistics()
.. index:: reset statistics of period

.. _InterfaceRtemsRateMonotonicResetStatistics:

rtems_rate_monotonic_reset_statistics()
---------------------------------------

Resets the statistics of the period.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_rate_monotonic_reset_statistics( rtems_id id );

.. rubric:: PARAMETERS:

``id``
    This parameter is the rate monotonic period identifier.

.. rubric:: DESCRIPTION:

This directive resets the statistics of the rate monotonic period specified by
``id``.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no rate monotonic period associated with the identifier specified
    by ``id``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive may be called from within interrupt context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/ratemon/if/reset-all-statistics

.. raw:: latex

    \clearpage

.. index:: rtems_rate_monotonic_reset_all_statistics()
.. index:: reset statistics of all periods

.. _InterfaceRtemsRateMonotonicResetAllStatistics:

rtems_rate_monotonic_reset_all_statistics()
-------------------------------------------

Resets the statistics of all periods.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    void rtems_rate_monotonic_reset_all_statistics( void );

.. rubric:: DESCRIPTION:

This directive resets the statistics information associated with all rate
monotonic period instances.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/ratemon/if/report-statistics

.. raw:: latex

    \clearpage

.. index:: rtems_rate_monotonic_report_statistics()
.. index:: print period statistics report
.. index:: period statistics report

.. _InterfaceRtemsRateMonotonicReportStatistics:

rtems_rate_monotonic_report_statistics()
----------------------------------------

Reports the period statistics using the :ref:`InterfacePrintk` printer.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    void rtems_rate_monotonic_report_statistics( void );

.. rubric:: DESCRIPTION:

This directive prints a report on all active periods which have executed at
least one period using the :ref:`InterfacePrintk` printer.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/ratemon/if/report-statistics-with-plugin

.. raw:: latex

    \clearpage

.. index:: rtems_rate_monotonic_report_statistics_with_plugin()
.. index:: print period statistics report
.. index:: period statistics report

.. _InterfaceRtemsRateMonotonicReportStatisticsWithPlugin:

rtems_rate_monotonic_report_statistics_with_plugin()
----------------------------------------------------

Reports the period statistics using the printer plugin.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    void rtems_rate_monotonic_report_statistics_with_plugin(
      const struct rtems_printer *printer
    );

.. rubric:: PARAMETERS:

``printer``
    This parameter is the printer plugin to output the report.

.. rubric:: DESCRIPTION:

This directive prints a report on all active periods which have executed at
least one period using the printer plugin specified by ``printer``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.