summaryrefslogtreecommitdiffstats
path: root/c-user/scheduling-concepts/directives.rst
blob: b1c485f494e0c5c72a033e964b43bc8d4cf2c109 (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
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
.. SPDX-License-Identifier: CC-BY-SA-4.0

.. Copyright (C) 2013, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2017 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

.. _SchedulerManagerDirectives:

Directives
==========

This section details the directives of the Scheduler 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/scheduler/if/ident

.. raw:: latex

    \clearpage

.. index:: rtems_scheduler_ident()

.. _InterfaceRtemsSchedulerIdent:

rtems_scheduler_ident()
-----------------------

Identifies a scheduler by the object name.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_scheduler_ident( rtems_name name, rtems_id *id );

.. rubric:: PARAMETERS:

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

``id``
    This parameter is the pointer to an object identifier variable.  When the
    directive call is successful, the identifier of the scheduler will be
    stored in this variable.

.. rubric:: DESCRIPTION:

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

.. rubric:: RETURN VALUES:

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

:c:macro:`RTEMS_INVALID_NAME`
    There was no scheduler associated with the name.

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

.. rubric:: NOTES:

The scheduler name is determined by the scheduler configuration.

The scheduler identifier is used with other scheduler related directives to
access the scheduler.

.. 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/scheduler/if/ident-by-processor

.. raw:: latex

    \clearpage

.. index:: rtems_scheduler_ident_by_processor()

.. _InterfaceRtemsSchedulerIdentByProcessor:

rtems_scheduler_ident_by_processor()
------------------------------------

Identifies a scheduler by the processor index.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_scheduler_ident_by_processor(
      uint32_t  cpu_index,
      rtems_id *id
    );

.. rubric:: PARAMETERS:

``cpu_index``
    This parameter is the processor index to identify the scheduler.

``id``
    This parameter is the pointer to an object identifier variable.  When the
    directive call is successful, the identifier of the scheduler will be
    stored in this variable.

.. 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 processor index was invalid.

:c:macro:`RTEMS_INCORRECT_STATE`
    The processor index was valid, however, the corresponding processor was not
    owned by a scheduler.

.. 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/scheduler/if/ident-by-processor-set

.. raw:: latex

    \clearpage

.. index:: rtems_scheduler_ident_by_processor_set()

.. _InterfaceRtemsSchedulerIdentByProcessorSet:

rtems_scheduler_ident_by_processor_set()
----------------------------------------

Identifies a scheduler by the processor set.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_scheduler_ident_by_processor_set(
      size_t           cpusetsize,
      const cpu_set_t *cpuset,
      rtems_id        *id
    );

.. rubric:: PARAMETERS:

``cpusetsize``
    This parameter is the size of the referenced processor set variable in
    bytes.  This value shall be positive.

``cpuset``
    This parameter is the pointer to a processor set variable.  The referenced
    processor set will be used to identify the scheduler.

``id``
    This parameter is the pointer to an object identifier variable.  When the
    directive call is successful, the identifier of the scheduler will be
    stored in this variable.

.. rubric:: DESCRIPTION:

The scheduler is selected according to the highest numbered online processor in
the specified processor set.

.. 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_SIZE`
    The processor set size was invalid.

:c:macro:`RTEMS_INVALID_NAME`
    The processor set contained no online processor.

:c:macro:`RTEMS_INCORRECT_STATE`
    The processor set was valid, however, the highest numbered online processor
    in the processor set was not owned by a scheduler.

.. 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/scheduler/if/get-maximum-priority

.. raw:: latex

    \clearpage

.. index:: rtems_scheduler_get_maximum_priority()

.. _InterfaceRtemsSchedulerGetMaximumPriority:

rtems_scheduler_get_maximum_priority()
--------------------------------------

Gets the maximum task priority of the scheduler.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_scheduler_get_maximum_priority(
      rtems_id             scheduler_id,
      rtems_task_priority *priority
    );

.. rubric:: PARAMETERS:

``scheduler_id``
    This parameter is the scheduler identifier.

``priority``
    This parameter is the pointer to a task priority variable.  The maximum
    priority of the scheduler will be stored in this variable, if the operation
    is successful.

.. rubric:: RETURN VALUES:

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

:c:macro:`RTEMS_INVALID_ID`
    There was no scheduler associated with the identifier specified by
    ``scheduler_id``.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``priority`` 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 any runtime context.

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

.. Generated from spec:/rtems/scheduler/if/map-priority-to-posix

.. raw:: latex

    \clearpage

.. index:: rtems_scheduler_map_priority_to_posix()

.. _InterfaceRtemsSchedulerMapPriorityToPosix:

rtems_scheduler_map_priority_to_posix()
---------------------------------------

Maps a Classic API task priority to the corresponding POSIX thread priority.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_scheduler_map_priority_to_posix(
      rtems_id            scheduler_id,
      rtems_task_priority priority,
      int                *posix_priority
    );

.. rubric:: PARAMETERS:

``scheduler_id``
    This parameter is the scheduler identifier.

``priority``
    This parameter is the Classic API task priority to map.

``posix_priority``
    This parameter is the pointer to a POSIX thread priority variable.  When
    the directive call is successful, the POSIX thread priority value
    corresponding to the specified Classic API task priority value will be
    stored in this variable.

.. rubric:: RETURN VALUES:

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

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

:c:macro:`RTEMS_INVALID_ID`
    There was no scheduler associated with the identifier specified by
    ``scheduler_id``.

:c:macro:`RTEMS_INVALID_PRIORITY`
    The Classic API task priority was invalid.

.. 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/scheduler/if/map-priority-from-posix

.. raw:: latex

    \clearpage

.. index:: rtems_scheduler_map_priority_from_posix()

.. _InterfaceRtemsSchedulerMapPriorityFromPosix:

rtems_scheduler_map_priority_from_posix()
-----------------------------------------

Maps a POSIX thread priority to the corresponding Classic API task priority.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_scheduler_map_priority_from_posix(
      rtems_id             scheduler_id,
      int                  posix_priority,
      rtems_task_priority *priority
    );

.. rubric:: PARAMETERS:

``scheduler_id``
    This parameter is the scheduler identifier.

``posix_priority``
    This parameter is the POSIX thread priority to map.

``priority``
    This parameter is the pointer to a Classic API task priority variable.
    When the directive call is successful, the Classic API task priority value
    corresponding to the specified POSIX thread priority value will be stored
    in this variable.

.. rubric:: RETURN VALUES:

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

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

:c:macro:`RTEMS_INVALID_ID`
    There was no scheduler associated with the identifier specified by
    ``scheduler_id``.

:c:macro:`RTEMS_INVALID_PRIORITY`
    The POSIX thread priority was invalid.

.. 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/scheduler/if/get-processor

.. raw:: latex

    \clearpage

.. index:: rtems_scheduler_get_processor()

.. _InterfaceRtemsSchedulerGetProcessor:

rtems_scheduler_get_processor()
-------------------------------

Returns the index of the current processor.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    uint32_t rtems_scheduler_get_processor( void );

.. rubric:: DESCRIPTION:

Where the system was built with SMP support disabled, this directive evaluates
to a compile time constant of zero.

Where the system was built with SMP support enabled, this directive returns the
index of the current processor.  The set of processor indices is the range of
integers starting with zero up to
:ref:`InterfaceRtemsSchedulerGetProcessorMaximum` minus one.

.. rubric:: RETURN VALUES:

Returns the index of the current processor.

.. rubric:: NOTES:

Outside of sections with disabled thread dispatching the current processor
index may change after every instruction since the thread may migrate from one
processor to another.  Sections with disabled interrupts are sections with
thread dispatching disabled.

.. 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/scheduler/if/get-processor-maximum

.. raw:: latex

    \clearpage

.. index:: rtems_scheduler_get_processor_maximum()

.. _InterfaceRtemsSchedulerGetProcessorMaximum:

rtems_scheduler_get_processor_maximum()
---------------------------------------

Returns the processor maximum supported by the system.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    uint32_t rtems_scheduler_get_processor_maximum( void );

.. rubric:: DESCRIPTION:

Where the system was built with SMP support disabled, this directive evaluates
to a compile time constant of one.

Where the system was built with SMP support enabled, this directive returns the
minimum of the processors (physically or virtually) available at the
:term:`target` and the configured processor maximum (see
:ref:`CONFIGURE_MAXIMUM_PROCESSORS`).  Not all processors in the range from
processor index zero to the last processor index (which is the processor
maximum minus one) may be configured to be used by a scheduler or may be online
(online processors have a scheduler assigned).

.. rubric:: RETURN VALUES:

Returns the processor maximum supported by the system.

.. 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/scheduler/if/get-processor-set

.. raw:: latex

    \clearpage

.. index:: rtems_scheduler_get_processor_set()

.. _InterfaceRtemsSchedulerGetProcessorSet:

rtems_scheduler_get_processor_set()
-----------------------------------

Gets the set of processors owned by the scheduler.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_scheduler_get_processor_set(
      rtems_id   scheduler_id,
      size_t     cpusetsize,
      cpu_set_t *cpuset
    );

.. rubric:: PARAMETERS:

``scheduler_id``
    This parameter is the scheduler identifier.

``cpusetsize``
    This parameter is the size of the referenced processor set variable in
    bytes.

``cpuset``
    This parameter is the pointer to a processor set variable.  When the
    directive call is successful, the processor set of the scheduler will be
    stored in this variable.  A set bit in the processor set means that the
    corresponding processor is owned by the scheduler, otherwise the bit is
    cleared.

.. rubric:: RETURN VALUES:

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

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

:c:macro:`RTEMS_INVALID_ID`
    There was no scheduler associated with the identifier specified by
    ``scheduler_id``.

:c:macro:`RTEMS_INVALID_NUMBER`
    The provided processor set was too small for the set of processors owned by
    the scheduler.

.. 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/scheduler/if/add-processor

.. raw:: latex

    \clearpage

.. index:: rtems_scheduler_add_processor()

.. _InterfaceRtemsSchedulerAddProcessor:

rtems_scheduler_add_processor()
-------------------------------

Adds the processor to the set of processors owned by the scheduler.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_scheduler_add_processor(
      rtems_id scheduler_id,
      uint32_t cpu_index
    );

.. rubric:: PARAMETERS:

``scheduler_id``
    This parameter is the scheduler identifier.

``cpu_index``
    This parameter is the index of the processor to add.

.. rubric:: DESCRIPTION:

This directive adds the processor specified by the ``cpu_index`` to the
scheduler specified by ``scheduler_id``.

.. rubric:: RETURN VALUES:

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

:c:macro:`RTEMS_INVALID_ID`
    There was no scheduler associated with the identifier specified by
    ``scheduler_id``.

:c:macro:`RTEMS_NOT_CONFIGURED`
    The processor was not configured to be used by the application.

:c:macro:`RTEMS_INCORRECT_STATE`
    The processor was configured to be used by the application, however, it was
    not online.

:c:macro:`RTEMS_RESOURCE_IN_USE`
    The processor was already assigned to a scheduler.

.. 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.

.. Generated from spec:/rtems/scheduler/if/remove-processor

.. raw:: latex

    \clearpage

.. index:: rtems_scheduler_remove_processor()

.. _InterfaceRtemsSchedulerRemoveProcessor:

rtems_scheduler_remove_processor()
----------------------------------

Removes the processor from the set of processors owned by the scheduler.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_scheduler_remove_processor(
      rtems_id scheduler_id,
      uint32_t cpu_index
    );

.. rubric:: PARAMETERS:

``scheduler_id``
    This parameter is the scheduler identifier.

``cpu_index``
    This parameter is the index of the processor to remove.

.. rubric:: DESCRIPTION:

This directive removes the processor specified by the ``cpu_index`` from the
scheduler specified by ``scheduler_id``.

.. rubric:: RETURN VALUES:

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

:c:macro:`RTEMS_INVALID_ID`
    There was no scheduler associated with the identifier specified by
    ``scheduler_id``.

:c:macro:`RTEMS_INVALID_NUMBER`
    The processor was not owned by the scheduler.

:c:macro:`RTEMS_RESOURCE_IN_USE`
    The set of processors owned by the scheduler would have been empty after
    the processor removal and there was at least one non-idle task that used
    this scheduler as its :term:`home scheduler`.

.. rubric:: NOTES:

Removing a processor from a scheduler is a complex operation that involves all
tasks of the system.

.. 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.