source: rtems/cpukit/include/rtems/scheduler.h @ 255fe43

Last change on this file since 255fe43 was 255fe43, checked in by Joel Sherrill <joel@…>, on 03/01/22 at 20:40:44

cpukit/: Scripted embedded brains header file clean up

Updates #4625.
  • Property mode set to 100644
File size: 10.6 KB
Line 
1/**
2 * @file
3 *
4 * @brief Scheduler Configuration API
5 */
6
7/*
8 * Copyright (c) 2014, 2018 embedded brains GmbH.  All rights reserved.
9 *
10 * The license and distribution terms for this file may be
11 * found in the file LICENSE in this distribution or at
12 * http://www.rtems.org/license/LICENSE.
13 */
14
15#ifndef _RTEMS_SAPI_SCHEDULER_H
16#define _RTEMS_SAPI_SCHEDULER_H
17
18#include <rtems/score/scheduler.h>
19
20#define SCHEDULER_CONTEXT_NAME( name ) \
21  _Configuration_Scheduler_ ## name
22
23#if defined(RTEMS_SMP)
24  #define SCHEDULER_CONTROL_IS_NON_PREEMPT_MODE_SUPPORTED( value ) \
25    , value
26#else
27  #define SCHEDULER_CONTROL_IS_NON_PREEMPT_MODE_SUPPORTED( value )
28#endif
29
30#if defined(RTEMS_SMP)
31  /* This object doesn't exist and indicates a configuration error */
32  extern const Scheduler_Control RTEMS_SCHEDULER_INVALID_INDEX;
33
34  #define RTEMS_SCHEDULER_ASSIGN_DEFAULT \
35    SCHEDULER_ASSIGN_DEFAULT
36
37  #define RTEMS_SCHEDULER_ASSIGN_PROCESSOR_OPTIONAL \
38    SCHEDULER_ASSIGN_PROCESSOR_OPTIONAL
39
40  #define RTEMS_SCHEDULER_ASSIGN_PROCESSOR_MANDATORY \
41    SCHEDULER_ASSIGN_PROCESSOR_MANDATORY
42
43  #define RTEMS_SCHEDULER_ASSIGN( index, attr ) \
44    { \
45      ( index ) < RTEMS_ARRAY_SIZE( _Scheduler_Table ) ? \
46        &_Scheduler_Table[ ( index ) ] : &RTEMS_SCHEDULER_INVALID_INDEX, \
47      ( attr ) \
48    }
49
50  #define RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER { NULL, 0 }
51#endif
52
53/*
54 * This file should be only included in the context of <rtems/confdefs.h>.
55 * Define the scheduler configuration macros only in case the corresponding
56 * configure symbol is defined.  This is necessary to prevent invalid workspace
57 * size estimates since we have to account for the per-thread scheduler
58 * information.
59 */
60
61#ifdef CONFIGURE_SCHEDULER_CBS
62  #include <rtems/score/schedulercbs.h>
63
64  #define SCHEDULER_CBS_CONTEXT_NAME( name ) \
65    SCHEDULER_CONTEXT_NAME( CBS_ ## name )
66
67  #define RTEMS_SCHEDULER_CBS( name ) \
68    static Scheduler_EDF_Context SCHEDULER_CBS_CONTEXT_NAME( name )
69
70  #define RTEMS_SCHEDULER_TABLE_CBS( name, obj_name ) \
71    { \
72      &SCHEDULER_CBS_CONTEXT_NAME( name ).Base, \
73      SCHEDULER_CBS_ENTRY_POINTS, \
74      SCHEDULER_CBS_MAXIMUM_PRIORITY, \
75      ( obj_name ) \
76      SCHEDULER_CONTROL_IS_NON_PREEMPT_MODE_SUPPORTED( true ) \
77    }
78
79  /* Provided for backward compatibility */
80
81  #define RTEMS_SCHEDULER_CONTEXT_CBS( name ) \
82    RTEMS_SCHEDULER_CBS( name )
83
84  #define RTEMS_SCHEDULER_CONTROL_CBS( name, obj_name ) \
85    RTEMS_SCHEDULER_TABLE_CBS( name, obj_name )
86#endif
87
88#ifdef CONFIGURE_SCHEDULER_EDF
89  #include <rtems/score/scheduleredf.h>
90
91  #define SCHEDULER_EDF_CONTEXT_NAME( name ) \
92    SCHEDULER_CONTEXT_NAME( EDF_ ## name )
93
94  #define RTEMS_SCHEDULER_EDF( name ) \
95    static Scheduler_EDF_Context SCHEDULER_EDF_CONTEXT_NAME( name )
96
97  #define RTEMS_SCHEDULER_TABLE_EDF( name, obj_name ) \
98    { \
99      &SCHEDULER_EDF_CONTEXT_NAME( name ).Base, \
100      SCHEDULER_EDF_ENTRY_POINTS, \
101      SCHEDULER_EDF_MAXIMUM_PRIORITY, \
102      ( obj_name ) \
103      SCHEDULER_CONTROL_IS_NON_PREEMPT_MODE_SUPPORTED( true ) \
104    }
105
106  /* Provided for backward compatibility */
107
108  #define RTEMS_SCHEDULER_CONTEXT_EDF( name ) \
109    RTEMS_SCHEDULER_EDF( name )
110
111  #define RTEMS_SCHEDULER_CONTROL_EDF( name, obj_name ) \
112    RTEMS_SCHEDULER_TABLE_EDF( name, obj_name )
113#endif
114
115#ifdef CONFIGURE_SCHEDULER_EDF_SMP
116  #include <rtems/score/scheduleredfsmp.h>
117
118  #ifndef CONFIGURE_MAXIMUM_PROCESSORS
119    #error "CONFIGURE_MAXIMUM_PROCESSORS must be defined to configure the EDF SMP scheduler"
120  #endif
121
122  #define SCHEDULER_EDF_SMP_CONTEXT_NAME( name ) \
123    SCHEDULER_CONTEXT_NAME( EDF_SMP_ ## name )
124
125  #define RTEMS_SCHEDULER_EDF_SMP( name ) \
126    static struct { \
127      Scheduler_EDF_SMP_Context Base; \
128      Scheduler_EDF_SMP_Ready_queue Ready[ CONFIGURE_MAXIMUM_PROCESSORS + 1 ]; \
129    } SCHEDULER_EDF_SMP_CONTEXT_NAME( name )
130
131  #define RTEMS_SCHEDULER_TABLE_EDF_SMP( name, obj_name ) \
132    { \
133      &SCHEDULER_EDF_SMP_CONTEXT_NAME( name ).Base.Base.Base, \
134      SCHEDULER_EDF_SMP_ENTRY_POINTS, \
135      SCHEDULER_EDF_MAXIMUM_PRIORITY, \
136      ( obj_name ) \
137      SCHEDULER_CONTROL_IS_NON_PREEMPT_MODE_SUPPORTED( false ) \
138    }
139
140  /* Provided for backward compatibility */
141
142  #define RTEMS_SCHEDULER_CONTEXT_EDF_SMP( name, max_cpu_count ) \
143    RTEMS_SCHEDULER_EDF_SMP( name )
144
145  #define RTEMS_SCHEDULER_CONTROL_EDF_SMP( name, obj_name ) \
146    RTEMS_SCHEDULER_TABLE_EDF_SMP( name, obj_name )
147#endif
148
149#ifdef CONFIGURE_SCHEDULER_PRIORITY
150  #include <rtems/score/schedulerpriority.h>
151
152  #define SCHEDULER_PRIORITY_CONTEXT_NAME( name ) \
153    SCHEDULER_CONTEXT_NAME( priority_ ## name )
154
155  #define RTEMS_SCHEDULER_PRIORITY( name, prio_count ) \
156    static struct { \
157      Scheduler_priority_Context Base; \
158      Chain_Control              Ready[ ( prio_count ) ]; \
159    } SCHEDULER_PRIORITY_CONTEXT_NAME( name )
160
161  #define RTEMS_SCHEDULER_TABLE_PRIORITY( name, obj_name ) \
162    { \
163      &SCHEDULER_PRIORITY_CONTEXT_NAME( name ).Base.Base, \
164      SCHEDULER_PRIORITY_ENTRY_POINTS, \
165      RTEMS_ARRAY_SIZE( \
166        SCHEDULER_PRIORITY_CONTEXT_NAME( name ).Ready \
167      ) - 1, \
168      ( obj_name ) \
169      SCHEDULER_CONTROL_IS_NON_PREEMPT_MODE_SUPPORTED( true ) \
170    }
171
172  /* Provided for backward compatibility */
173
174  #define RTEMS_SCHEDULER_CONTEXT_PRIORITY( name, prio_count ) \
175    RTEMS_SCHEDULER_PRIORITY( name, prio_count )
176
177  #define RTEMS_SCHEDULER_CONTROL_PRIORITY( name, obj_name ) \
178    RTEMS_SCHEDULER_TABLE_PRIORITY( name, obj_name )
179#endif
180
181#ifdef CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP
182  #include <rtems/score/schedulerpriorityaffinitysmp.h>
183
184  #define SCHEDULER_PRIORITY_AFFINITY_SMP_CONTEXT_NAME( name ) \
185    SCHEDULER_CONTEXT_NAME( priority_affinity_SMP_ ## name )
186
187  #define RTEMS_SCHEDULER_PRIORITY_AFFINITY_SMP( name, prio_count ) \
188    static struct { \
189      Scheduler_priority_SMP_Context Base; \
190      Chain_Control                  Ready[ ( prio_count ) ]; \
191    } SCHEDULER_PRIORITY_AFFINITY_SMP_CONTEXT_NAME( name )
192
193  #define RTEMS_SCHEDULER_TABLE_PRIORITY_AFFINITY_SMP( name, obj_name ) \
194    { \
195      &SCHEDULER_PRIORITY_AFFINITY_SMP_CONTEXT_NAME( name ).Base.Base.Base, \
196      SCHEDULER_PRIORITY_AFFINITY_SMP_ENTRY_POINTS, \
197      RTEMS_ARRAY_SIZE( \
198        SCHEDULER_PRIORITY_AFFINITY_SMP_CONTEXT_NAME( name ).Ready \
199      ) - 1, \
200      ( obj_name ) \
201      SCHEDULER_CONTROL_IS_NON_PREEMPT_MODE_SUPPORTED( false ) \
202    }
203
204  /* Provided for backward compatibility */
205
206  #define RTEMS_SCHEDULER_CONTEXT_PRIORITY_AFFINITY_SMP( name, prio_count ) \
207    RTEMS_SCHEDULER_PRIORITY_AFFINITY_SMP( name, prio_count )
208
209  #define RTEMS_SCHEDULER_CONTROL_PRIORITY_AFFINITY_SMP( name, obj_name ) \
210    RTEMS_SCHEDULER_TABLE_PRIORITY_AFFINITY_SMP( name, obj_name )
211#endif
212
213#ifdef CONFIGURE_SCHEDULER_PRIORITY_SMP
214  #include <rtems/score/schedulerprioritysmp.h>
215
216  #define SCHEDULER_PRIORITY_SMP_CONTEXT_NAME( name ) \
217    SCHEDULER_CONTEXT_NAME( priority_SMP_ ## name )
218
219  #define RTEMS_SCHEDULER_PRIORITY_SMP( name, prio_count ) \
220    static struct { \
221      Scheduler_priority_SMP_Context Base; \
222      Chain_Control                  Ready[ ( prio_count ) ]; \
223    } SCHEDULER_PRIORITY_SMP_CONTEXT_NAME( name )
224
225  #define RTEMS_SCHEDULER_TABLE_PRIORITY_SMP( name, obj_name ) \
226    { \
227      &SCHEDULER_PRIORITY_SMP_CONTEXT_NAME( name ).Base.Base.Base, \
228      SCHEDULER_PRIORITY_SMP_ENTRY_POINTS, \
229      RTEMS_ARRAY_SIZE( \
230        SCHEDULER_PRIORITY_SMP_CONTEXT_NAME( name ).Ready \
231      ) - 1, \
232      ( obj_name ) \
233      SCHEDULER_CONTROL_IS_NON_PREEMPT_MODE_SUPPORTED( false ) \
234    }
235
236  /* Provided for backward compatibility */
237
238  #define RTEMS_SCHEDULER_CONTEXT_PRIORITY_SMP( name, prio_count ) \
239    RTEMS_SCHEDULER_PRIORITY_SMP( name, prio_count )
240
241  #define RTEMS_SCHEDULER_CONTROL_PRIORITY_SMP( name, obj_name ) \
242    RTEMS_SCHEDULER_TABLE_PRIORITY_SMP( name, obj_name )
243#endif
244
245#ifdef CONFIGURE_SCHEDULER_STRONG_APA
246  #include <rtems/score/schedulerstrongapa.h>
247
248  #ifndef CONFIGURE_MAXIMUM_PROCESSORS
249    #error "CONFIGURE_MAXIMUM_PROCESSORS must be defined to configure the Strong APA scheduler"
250  #endif
251
252  #define SCHEDULER_STRONG_APA_CONTEXT_NAME( name ) \
253    SCHEDULER_CONTEXT_NAME( strong_APA_ ## name )
254
255  #define RTEMS_SCHEDULER_STRONG_APA( name, prio_count ) \
256    static struct { \
257      Scheduler_strong_APA_Context Base; \
258      Scheduler_strong_APA_CPU CPU[ CONFIGURE_MAXIMUM_PROCESSORS ]; \
259    } SCHEDULER_STRONG_APA_CONTEXT_NAME( name )
260
261  #define RTEMS_SCHEDULER_TABLE_STRONG_APA( name, obj_name ) \
262    { \
263      &SCHEDULER_STRONG_APA_CONTEXT_NAME( name ).Base.Base.Base, \
264      SCHEDULER_STRONG_APA_ENTRY_POINTS, \
265      SCHEDULER_STRONG_APA_MAXIMUM_PRIORITY, \
266      ( obj_name ) \
267      SCHEDULER_CONTROL_IS_NON_PREEMPT_MODE_SUPPORTED( false ) \
268    }
269
270  /* Provided for backward compatibility */
271
272  #define RTEMS_SCHEDULER_CONTEXT_STRONG_APA( name, prio_count ) \
273    RTEMS_SCHEDULER_STRONG_APA( name, prio_count )
274
275  #define RTEMS_SCHEDULER_CONTROL_STRONG_APA( name, obj_name ) \
276    RTEMS_SCHEDULER_TABLE_STRONG_APA( name, obj_name )
277#endif
278
279#ifdef CONFIGURE_SCHEDULER_SIMPLE
280  #include <rtems/score/schedulersimple.h>
281
282  #define SCHEDULER_SIMPLE_CONTEXT_NAME( name ) \
283    SCHEDULER_CONTEXT_NAME( simple_ ## name )
284
285  #define RTEMS_SCHEDULER_SIMPLE( name ) \
286    static Scheduler_simple_Context \
287      SCHEDULER_SIMPLE_CONTEXT_NAME( name )
288
289  #define RTEMS_SCHEDULER_TABLE_SIMPLE( name, obj_name ) \
290    { \
291      &SCHEDULER_SIMPLE_CONTEXT_NAME( name ).Base, \
292      SCHEDULER_SIMPLE_ENTRY_POINTS, \
293      SCHEDULER_SIMPLE_MAXIMUM_PRIORITY, \
294      ( obj_name ) \
295      SCHEDULER_CONTROL_IS_NON_PREEMPT_MODE_SUPPORTED( true ) \
296    }
297
298  /* Provided for backward compatibility */
299
300  #define RTEMS_SCHEDULER_CONTEXT_SIMPLE( name ) \
301    RTEMS_SCHEDULER_SIMPLE( name )
302
303  #define RTEMS_SCHEDULER_CONTROL_SIMPLE( name, obj_name ) \
304    RTEMS_SCHEDULER_TABLE_SIMPLE( name, obj_name )
305#endif
306
307#ifdef CONFIGURE_SCHEDULER_SIMPLE_SMP
308  #include <rtems/score/schedulersimplesmp.h>
309
310  #define SCHEDULER_SIMPLE_SMP_CONTEXT_NAME( name ) \
311    SCHEDULER_CONTEXT_NAME( simple_SMP_ ## name )
312
313  #define RTEMS_SCHEDULER_SIMPLE_SMP( name ) \
314    static Scheduler_simple_SMP_Context \
315      SCHEDULER_SIMPLE_SMP_CONTEXT_NAME( name )
316
317  #define RTEMS_SCHEDULER_TABLE_SIMPLE_SMP( name, obj_name ) \
318    { \
319      &SCHEDULER_SIMPLE_SMP_CONTEXT_NAME( name ).Base.Base, \
320      SCHEDULER_SIMPLE_SMP_ENTRY_POINTS, \
321      SCHEDULER_SIMPLE_SMP_MAXIMUM_PRIORITY, \
322      ( obj_name ) \
323      SCHEDULER_CONTROL_IS_NON_PREEMPT_MODE_SUPPORTED( false ) \
324    }
325
326  /* Provided for backward compatibility */
327
328  #define RTEMS_SCHEDULER_CONTEXT_SIMPLE_SMP( name ) \
329    RTEMS_SCHEDULER_SIMPLE_SMP( name )
330
331  #define RTEMS_SCHEDULER_CONTROL_SIMPLE_SMP( name, obj_name ) \
332    RTEMS_SCHEDULER_TABLE_SIMPLE_SMP( name, obj_name )
333#endif
334
335#endif /* _RTEMS_SAPI_SCHEDULER_H */
Note: See TracBrowser for help on using the repository browser.