summaryrefslogtreecommitdiffstats
path: root/c-user/config/scheduler-general.rst
blob: cbdb145d292c58f219b99c60c330a39d8a1df14b (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
.. SPDX-License-Identifier: CC-BY-SA-4.0

.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 2010 Gedare Bloom
.. 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

.. Generated from spec:/acfg/if/group-schedgeneral

General Scheduler Configuration
===============================

This section describes configuration options related to selecting a
scheduling algorithm for an application.  A scheduler configuration is optional
and only necessary in very specific circumstances.  A normal application
configuration does not need any of the configuration options described in this
section.

By default, the :ref:`SchedulerPriority`
algorithm is used in uniprocessor configurations.  In case SMP is enabled and
the configured maximum processors
(:ref:`CONFIGURE_MAXIMUM_PROCESSORS`) is greater
than one, then the
:ref:`SchedulerSMPEDF`
is selected as the default scheduler algorithm.

For the schedulers provided by RTEMS (see :ref:`RTEMSAPIClassicScheduler`), the
configuration is straightforward.  All that is required is to define the
configuration option which specifies which scheduler you want for in your
application.

The pluggable scheduler interface also enables the user to provide their own
scheduling algorithm.  If you choose to do this, you must define multiple
configuration option.

.. Generated from spec:/acfg/if/cbs-max-servers

.. index:: CONFIGURE_CBS_MAXIMUM_SERVERS

.. _CONFIGURE_CBS_MAXIMUM_SERVERS:

CONFIGURE_CBS_MAXIMUM_SERVERS
-----------------------------

CONSTANT:
    ``CONFIGURE_CBS_MAXIMUM_SERVERS``

OPTION TYPE:
    This configuration option is an integer define.

DEFAULT VALUE:
    The default value is :ref:`CONFIGURE_MAXIMUM_TASKS`.

VALUE CONSTRAINTS:
    The value of this configuration option shall satisfy all of the following
    constraints:

    * It shall be greater than or equal to 0.

    * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.

    * It shall be less than or equal to a
      BSP-specific and application-specific value which depends on the size of the
      memory available to the application.

DESCRIPTION:
    The value of this configuration option defines the maximum number Constant
    Bandwidth Servers that can be concurrently active.

NOTES:
    This configuration option is only evaluated if the configuration option
    :ref:`CONFIGURE_SCHEDULER_CBS` is defined.

.. Generated from spec:/acfg/if/max-priority

.. index:: CONFIGURE_MAXIMUM_PRIORITY
.. index:: maximum priority
.. index:: number of priority levels

.. _CONFIGURE_MAXIMUM_PRIORITY:

CONFIGURE_MAXIMUM_PRIORITY
--------------------------

CONSTANT:
    ``CONFIGURE_MAXIMUM_PRIORITY``

OPTION TYPE:
    This configuration option is an integer define.

DEFAULT VALUE:
    The default value is 255.

VALUE CONSTRAINTS:
    The value of this configuration option shall be
    an element of {3, 7, 31, 63, 127, 255}.

DESCRIPTION:
    For the following schedulers

    * :ref:`SchedulerPriority`, which is the default in uniprocessor
      configurations and can be configured through the
      :ref:`CONFIGURE_SCHEDULER_PRIORITY` configuration option,

    * :ref:`SchedulerSMPPriority` which can be configured through the
      :ref:`CONFIGURE_SCHEDULER_PRIORITY_SMP` configuration option, and

    * :ref:`SchedulerSMPPriorityAffinity` which can be configured through the
      :ref:`CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP` configuration option

    this configuration option specifies the maximum numeric priority of any task
    for these schedulers and one less that the number of priority levels for
    these schedulers.  For all other schedulers provided by RTEMS, this
    configuration option has no effect.

NOTES:
    The numerically greatest priority is the logically lowest priority in the
    system and will thus be used by the IDLE task.

    Priority zero is reserved for internal use by RTEMS and is not available to
    applications.

    Reducing the number of priorities through this configuration option reduces
    the amount of memory allocated by the schedulers listed above.  These
    schedulers use a chain control structure per priority and this structure
    consists of three pointers.  On a 32-bit architecture, the allocated memory
    is 12 bytes * (``CONFIGURE_MAXIMUM_PRIORITY`` + 1), e.g. 3072 bytes for 256
    priority levels (default), 48 bytes for 4 priority levels
    (``CONFIGURE_MAXIMUM_PRIORITY == 3``).

    The default value is 255, because RTEMS shall support 256 priority levels to
    be compliant with various standards.  These priorities range from 0 to 255.

.. Generated from spec:/acfg/if/scheduler-assignments

.. index:: CONFIGURE_SCHEDULER_ASSIGNMENTS

.. _CONFIGURE_SCHEDULER_ASSIGNMENTS:

CONFIGURE_SCHEDULER_ASSIGNMENTS
-------------------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_ASSIGNMENTS``

OPTION TYPE:
    This configuration option is an initializer define.

DEFAULT VALUE:
    The default value of this configuration option is computed so that the
    default scheduler is assigned to each configured processor (up to 32).

VALUE CONSTRAINTS:
    The value of this configuration option shall satisfy all of the following
    constraints:

    * It shall be a list of the following
      macros:

      * ``RTEMS_SCHEDULER_ASSIGN( processor_index, attributes )``

      * ``RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER``

    * It shall be a list of exactly
      :ref:`CONFIGURE_MAXIMUM_PROCESSORS` elements.

DESCRIPTION:
    The value of this configuration option is used to initialize the initial
    scheduler to processor assignments.

NOTES:
    This configuration option is only evaluated in SMP configurations.

    This is an advanced configuration option, see
    :ref:`ConfigurationSchedulersClustered`.

.. Generated from spec:/acfg/if/scheduler-cbs

.. index:: CONFIGURE_SCHEDULER_CBS

.. _CONFIGURE_SCHEDULER_CBS:

CONFIGURE_SCHEDULER_CBS
-----------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_CBS``

OPTION TYPE:
    This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:
    If this configuration option is undefined, then the described feature is not
    enabled.

DESCRIPTION:
    In case this configuration option is defined, then
    :ref:`SchedulerCBS`
    algorithm is made available to the application.

NOTES:
    This scheduler configuration option is an advanced configuration option.
    Think twice before you use it.

    In case no explicit :ref:`ConfigurationSchedulersClustered`
    is present, then it is used as the scheduler for exactly one processor.

.. Generated from spec:/acfg/if/scheduler-edf

.. index:: CONFIGURE_SCHEDULER_EDF

.. _CONFIGURE_SCHEDULER_EDF:

CONFIGURE_SCHEDULER_EDF
-----------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_EDF``

OPTION TYPE:
    This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:
    If this configuration option is undefined, then the described feature is not
    enabled.

DESCRIPTION:
    In case this configuration option is defined, then
    :ref:`SchedulerEDF`
    algorithm is made available to the application.

NOTES:
    This scheduler configuration option is an advanced configuration option.
    Think twice before you use it.

    In case no explicit :ref:`ConfigurationSchedulersClustered`
    is present, then it is used as the scheduler for exactly one processor.

.. Generated from spec:/acfg/if/scheduler-edf-smp

.. index:: CONFIGURE_SCHEDULER_EDF_SMP

.. _CONFIGURE_SCHEDULER_EDF_SMP:

CONFIGURE_SCHEDULER_EDF_SMP
---------------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_EDF_SMP``

OPTION TYPE:
    This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:
    If this configuration option is undefined, then the described feature is not
    enabled.

DESCRIPTION:
    In case this configuration option is defined, then
    :ref:`SchedulerSMPEDF`
    algorithm is made available to the application.

NOTES:
    This scheduler configuration option is an advanced configuration option.
    Think twice before you use it.

    This scheduler algorithm is only available when RTEMS is built with SMP
    support enabled.

    In case no explicit :ref:`ConfigurationSchedulersClustered`
    is present, then it is used as the scheduler for up to 32 processors.

    This scheduler algorithm is the default in SMP configurations if
    :ref:`CONFIGURE_MAXIMUM_PROCESSORS` is
    greater than one.

.. Generated from spec:/acfg/if/scheduler-name

.. index:: CONFIGURE_SCHEDULER_NAME

.. _CONFIGURE_SCHEDULER_NAME:

CONFIGURE_SCHEDULER_NAME
------------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_NAME``

OPTION TYPE:
    This configuration option is an integer define.

DEFAULT VALUE:
    The default value is

    * ``"MEDF"`` for the :ref:`SchedulerSMPEDF`,

    * ``"MPA "`` for the :ref:`SchedulerSMPPriorityAffinity`,

    * ``"MPD "`` for the :ref:`SchedulerSMPPriority`,

    * ``"MPS "`` for the :ref:`SchedulerSMPPrioritySimple`,

    * ``"UCBS"`` for the :ref:`SchedulerCBS`,

    * ``"UEDF"`` for the :ref:`SchedulerEDF`,

    * ``"UPD "`` for the :ref:`SchedulerPriority`, and

    * ``"UPS "`` for the :ref:`SchedulerPrioritySimple`.

VALUE CONSTRAINTS:
    The value of this configuration option shall be a valid integer of type
    :c:type:`rtems_name`.

DESCRIPTION:
    The value of this configuration option defines the name of the default
    scheduler.

NOTES:
    This scheduler configuration option is an advanced configuration option.
    Think twice before you use it.

    Schedulers can be identified via :c:func:`rtems_scheduler_ident`.

    Use :c:func:`rtems_build_name` to define the scheduler name.

.. Generated from spec:/acfg/if/scheduler-priority

.. index:: CONFIGURE_SCHEDULER_PRIORITY

.. _CONFIGURE_SCHEDULER_PRIORITY:

CONFIGURE_SCHEDULER_PRIORITY
----------------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_PRIORITY``

OPTION TYPE:
    This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:
    If this configuration option is undefined, then the described feature is not
    enabled.

DESCRIPTION:
    In case this configuration option is defined, then
    :ref:`SchedulerPriority`
    algorithm is made available to the application.

NOTES:
    This scheduler configuration option is an advanced configuration option.
    Think twice before you use it.

    In case no explicit :ref:`ConfigurationSchedulersClustered`
    is present, then it is used as the scheduler for exactly one processor.

    This scheduler algorithm is the default when
    :ref:`CONFIGURE_MAXIMUM_PROCESSORS` is
    exactly one.

    The memory allocated for this scheduler depends on the
    :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.

.. Generated from spec:/acfg/if/scheduler-priority-affinity-smp

.. index:: CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP

.. _CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP:

CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP
-----------------------------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP``

OPTION TYPE:
    This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:
    If this configuration option is undefined, then the described feature is not
    enabled.

DESCRIPTION:
    In case this configuration option is defined, then
    :ref:`SchedulerSMPPriorityAffinity`
    algorithm is made available to the application.

NOTES:
    This scheduler configuration option is an advanced configuration option.
    Think twice before you use it.

    This scheduler algorithm is only available when RTEMS is built with SMP
    support enabled.

    In case no explicit :ref:`ConfigurationSchedulersClustered`
    is present, then it is used as the scheduler for up to 32 processors.

    The memory allocated for this scheduler depends on the
    :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.

.. Generated from spec:/acfg/if/scheduler-priority-smp

.. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP

.. _CONFIGURE_SCHEDULER_PRIORITY_SMP:

CONFIGURE_SCHEDULER_PRIORITY_SMP
--------------------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_PRIORITY_SMP``

OPTION TYPE:
    This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:
    If this configuration option is undefined, then the described feature is not
    enabled.

DESCRIPTION:
    In case this configuration option is defined, then
    :ref:`SchedulerSMPPriority`
    algorithm is made available to the application.

NOTES:
    This scheduler configuration option is an advanced configuration option.
    Think twice before you use it.

    This scheduler algorithm is only available when RTEMS is built with SMP
    support enabled.

    In case no explicit :ref:`ConfigurationSchedulersClustered`
    is present, then it is used as the scheduler for up to 32 processors.

    The memory allocated for this scheduler depends on the
    :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.

.. Generated from spec:/acfg/if/scheduler-simple

.. index:: CONFIGURE_SCHEDULER_SIMPLE

.. _CONFIGURE_SCHEDULER_SIMPLE:

CONFIGURE_SCHEDULER_SIMPLE
--------------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_SIMPLE``

OPTION TYPE:
    This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:
    If this configuration option is undefined, then the described feature is not
    enabled.

DESCRIPTION:
    In case this configuration option is defined, then
    :ref:`SchedulerPrioritySimple`
    algorithm is made available to the application.

NOTES:
    This scheduler configuration option is an advanced configuration option.
    Think twice before you use it.

    In case no explicit :ref:`ConfigurationSchedulersClustered`
    is present, then it is used as the scheduler for exactly one processor.

.. Generated from spec:/acfg/if/scheduler-simple-smp

.. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP

.. _CONFIGURE_SCHEDULER_SIMPLE_SMP:

CONFIGURE_SCHEDULER_SIMPLE_SMP
------------------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_SIMPLE_SMP``

OPTION TYPE:
    This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:
    If this configuration option is undefined, then the described feature is not
    enabled.

DESCRIPTION:
    In case this configuration option is defined, then
    :ref:`SchedulerSMPPrioritySimple`
    algorithm is made available to the application.
    application.

NOTES:
    This scheduler configuration option is an advanced configuration option.
    Think twice before you use it.

    This scheduler algorithm is only available when RTEMS is built with SMP
    support enabled.

    In case no explicit :ref:`ConfigurationSchedulersClustered`
    is present, then it is used as the scheduler for up to 32 processors.

.. Generated from spec:/acfg/if/scheduler-strong-apa

.. index:: CONFIGURE_SCHEDULER_STRONG_APA

.. _CONFIGURE_SCHEDULER_STRONG_APA:

CONFIGURE_SCHEDULER_STRONG_APA
------------------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_STRONG_APA``

OPTION TYPE:
    This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:
    If this configuration option is undefined, then the described feature is not
    enabled.

DESCRIPTION:
    In case this configuration option is defined, then Strong APA algorithm is
    made available to the application.

NOTES:
    This scheduler configuration option is an advanced configuration option.
    Think twice before you use it.

    This scheduler algorithm is only available when RTEMS is built with SMP
    support enabled.

    This scheduler algorithm is not correctly implemented.  Do not use it.

.. Generated from spec:/acfg/if/scheduler-user

.. index:: CONFIGURE_SCHEDULER_USER

.. _CONFIGURE_SCHEDULER_USER:

CONFIGURE_SCHEDULER_USER
------------------------

CONSTANT:
    ``CONFIGURE_SCHEDULER_USER``

OPTION TYPE:
    This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:
    If this configuration option is undefined, then the described feature is not
    enabled.

DESCRIPTION:
    In case this configuration option is defined, then the user shall provide a
    scheduler algorithm to the application.

NOTES:
    This scheduler configuration option is an advanced configuration option.
    Think twice before you use it.

    RTEMS allows the application to provide its own task/thread scheduling
    algorithm. In order to do this, one shall define
    ``CONFIGURE_SCHEDULER_USER`` to indicate the application provides its own
    scheduling algorithm. If ``CONFIGURE_SCHEDULER_USER`` is defined then the
    following additional macros shall be defined:

    * ``CONFIGURE_SCHEDULER`` shall be defined to a static definition of
      the scheduler data structures of the user scheduler.

    * ``CONFIGURE_SCHEDULER_TABLE_ENTRIES`` shall be defined to a scheduler
      table entry initializer for the user scheduler.

    * ``CONFIGURE_SCHEDULER_USER_PER_THREAD`` shall be defined to the type of
      the per-thread information of the user scheduler.

    At this time, the mechanics and requirements for writing a new scheduler
    are evolving and not fully documented.  It is recommended that you look at
    the existing Deterministic Priority Scheduler in
    ``cpukit/score/src/schedulerpriority*.c`` for guidance.  For guidance on
    the configuration macros, please examine ``cpukit/sapi/include/confdefs.h``
    for how these are defined for the Deterministic Priority Scheduler.