summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/score/scheduleruniimpl.h
blob: faa719ce45dad5a3f4c676b850374896a2275a3c (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
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSScoreScheduler
 *
 * @brief This header file provides interfaces of the supporting the
 *   implementation of uniprocessor schedulers.
 */

/*
 *  Copyright (C) 2010 Gedare Bloom.
 *  Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
 *  Copyright (C) 2014, 2022 embedded brains GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTEMS_SCORE_SCHEDULERUNIIMPL_H
#define _RTEMS_SCORE_SCHEDULERUNIIMPL_H

#include <rtems/score/schedulerimpl.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @addtogroup RTEMSScoreScheduler
 *
 * @{
 */

/**
 * @brief Updates the heir thread of the processor.
 *
 * @param[in, out] heir is the current heir thread.
 * @param[in, out] new_heir is the new heir thread.
 */
RTEMS_INLINE_ROUTINE void _Scheduler_uniprocessor_Update_heir(
  Thread_Control *heir,
  Thread_Control *new_heir
)
{
  _Assert( heir != new_heir );
#if defined(RTEMS_SMP)
  /*
   * We need this state only for _Thread_Get_CPU_time_used_locked().  Cannot
   * use _Scheduler_Thread_change_state() since THREAD_SCHEDULER_BLOCKED to
   * THREAD_SCHEDULER_BLOCKED state changes are illegal for the real SMP
   * schedulers.
   */
  heir->Scheduler.state = THREAD_SCHEDULER_BLOCKED;
  new_heir->Scheduler.state = THREAD_SCHEDULER_SCHEDULED;
#endif
  _Thread_Update_CPU_time_used( heir, _Thread_Get_CPU( heir ) );
  _Thread_Heir = new_heir;
  _Thread_Dispatch_necessary = true;
}

/**
 * @brief Updates the heir thread of the processor if the current heir is
 *   not equal to the new heir thread.
 *
 * The update takes place even if the current heir thread is not preemptible.
 *
 * @param[in, out] new_heir is the new heir thread.
 */
RTEMS_INLINE_ROUTINE void _Scheduler_uniprocessor_Update_heir_if_necessary(
  Thread_Control *new_heir
)
{
  Thread_Control *heir = _Thread_Heir;

  if ( heir != new_heir ) {
    _Scheduler_uniprocessor_Update_heir( heir, new_heir );
  }
}

/**
 * @brief Updates the heir thread of the processor if the current heir thread
 *   is preemptible.
 *
 * @param[in, out] heir is the current heir thread.
 * @param[in, out] new_heir is the new heir thread.
 */
RTEMS_INLINE_ROUTINE void _Scheduler_uniprocessor_Update_heir_if_preemptible(
  Thread_Control *heir,
  Thread_Control *new_heir
)
{
  if ( heir != new_heir && heir->is_preemptible ) {
    _Scheduler_uniprocessor_Update_heir( heir, new_heir );
  }
}

/**
 * @brief Blocks the thread.
 *
 * @param scheduler is the scheduler.
 * @param the_thread is the thread to block.
 * @param node is the scheduler node of the thread.
 * @param extract is the handler to extract the thread.
 * @param get_highest_ready is the handler to get the highest ready thread.
 */
RTEMS_INLINE_ROUTINE void _Scheduler_uniprocessor_Block(
  const Scheduler_Control *scheduler,
  Thread_Control          *the_thread,
  Scheduler_Node          *node,
  void                  ( *extract )(
                             const Scheduler_Control *,
                             Thread_Control *,
                             Scheduler_Node *
                        ),
  Thread_Control       *( *get_highest_ready )( const Scheduler_Control * )
)
{
  ( *extract )( scheduler, the_thread, node );

  /* TODO: flash critical section? */

  if ( _Thread_Is_heir( the_thread ) ) {
    Thread_Control *highest_ready;

    highest_ready = ( *get_highest_ready )( scheduler );
    _Scheduler_uniprocessor_Update_heir( _Thread_Heir, highest_ready );
  }
}

/**
 * @brief Schedule the unblocked thread if it is the highest ready thread.
 *
 * @param scheduler is the scheduler.
 * @param the_thread is the thread.
 * @param priority is the priority of the thread.
 */
RTEMS_INLINE_ROUTINE void _Scheduler_uniprocessor_Unblock(
  const Scheduler_Control *scheduler,
  Thread_Control          *the_thread,
  Priority_Control         priority
)
{
  Thread_Control *heir;

  heir = _Thread_Heir;

  /*
   * If the thread is more important than the heir, then we have a new heir.
   * This may or may not result in a context switch.  If the current heir
   * thread is preemptible, then we need to do a context switch.
   */
  if ( priority < _Thread_Get_priority( heir ) ) {
    _Scheduler_uniprocessor_Update_heir_if_preemptible( heir, the_thread );
  }
}

/**
 * @brief Schedules the highest ready thread if the current heir thread of the
 * processor is preemptible.
 *
 * @param scheduler is the scheduler.
 * @param get_highest_ready is the handler to get the highest ready thread.
 */
RTEMS_INLINE_ROUTINE void _Scheduler_uniprocessor_Schedule(
  const Scheduler_Control *scheduler,
  Thread_Control       *( *get_highest_ready )( const Scheduler_Control * )
)
{
  Thread_Control *highest_ready;

  highest_ready = ( *get_highest_ready )( scheduler );
  _Scheduler_uniprocessor_Update_heir_if_preemptible(
    _Thread_Heir,
    highest_ready
  );
}

/**
 * @brief Yields to the highest ready thread.
 *
 * @param scheduler is the scheduler.
 * @param get_highest_ready is the handler to get the highest ready thread.
 */
RTEMS_INLINE_ROUTINE void _Scheduler_uniprocessor_Yield(
  const Scheduler_Control *scheduler,
  Thread_Control       *( *get_highest_ready )( const Scheduler_Control * )
)
{
  Thread_Control *highest_ready;

  highest_ready = ( *get_highest_ready )( scheduler );
  _Scheduler_uniprocessor_Update_heir_if_necessary( highest_ready );
}

/** @} */

#ifdef __cplusplus
}
#endif

#endif /* _RTEMS_SCORE_SCHEDULERUNIIMPL_H */