forked from apache/nuttx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsched.h
279 lines (193 loc) · 8.75 KB
/
sched.h
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
/********************************************************************************
* include/sched.h
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
********************************************************************************/
#ifndef __INCLUDE_SCHED_H
#define __INCLUDE_SCHED_H
/********************************************************************************
* Included Files
********************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <stdint.h>
#include <stdbool.h>
#include <strings.h>
#include <time.h>
/********************************************************************************
* Pre-processor Definitions
********************************************************************************/
/* Task Management Definitions **************************************************/
/* POSIX-like scheduling policies */
#define SCHED_NORMAL 0 /* Alias to SCHED_OTHER */
#define SCHED_OTHER 0 /* Map to SCHED_FIFO or SCHED_RR */
#define SCHED_FIFO 1 /* FIFO priority scheduling policy */
#define SCHED_RR 2 /* Round robin scheduling policy */
#define SCHED_SPORADIC 3 /* Sporadic scheduling policy */
/* Maximum number of SCHED_SPORADIC replenishments */
#define SS_REPL_MAX CONFIG_SCHED_SPORADIC_MAXREPL
/* Cancellation definitions *****************************************************/
/* Cancellation states used by task_setcancelstate() */
#define TASK_CANCEL_ENABLE (0)
#define TASK_CANCEL_DISABLE (1)
/* Cancellation types used by task_setcanceltype() */
#define TASK_CANCEL_DEFERRED (0)
#define TASK_CANCEL_ASYNCHRONOUS (1)
/* Pthread definitions **********************************************************/
#define PTHREAD_KEYS_MAX CONFIG_TLS_NELEM
/* CPU affinity mask helpers ****************************************************/
/* These are not standard but are defined for Linux compatibility */
#ifdef CONFIG_SMP
/* void CPU_ZERO(FAR cpu_set_t *set); */
# define CPU_ZERO(s) do { *(s) = 0; } while (0)
/* void CPU_SET(int cpu, FAR cpu_set_t *set); */
# define CPU_SET(c,s) do { *(s) |= (1 << (c)); } while (0)
/* void CPU_CLR(int cpu, FAR cpu_set_t *set); */
# define CPU_CLR(c,s) do { *(s) &= ~(1 << (c)); } while (0)
/* int CPU_ISSET(int cpu, FAR const cpu_set_t *set); */
# define CPU_ISSET(c,s) ((*(s) & (1 << (c))) != 0)
/* int CPU_COUNT(FAR const cpu_set_t *set); */
# define CPU_COUNT(s) popcountl(*s)
/* void CPU_AND(FAR cpu_set_t *destset, FAR const cpu_set_t *srcset1,
* FAR const cpu_set_t *srcset2);
*/
# define CPU_AND(d,s1,s2) do { *(d) = *(s1) & *(s2); } while (0)
/* void CPU_OR(FAR cpu_set_t *destset, FAR const cpu_set_t *srcset1,
* FAR const cpu_set_t *srcset2);
*/
# define CPU_OR(d,s1,s2) do { *(d) = *(s1) | *(s2); } while (0)
/* void CPU_XOR(FAR cpu_set_t *destset, FAR const cpu_set_t *srcset1,
* FAR const cpu_set_t *srcset2);
*/
# define CPU_XOR(d,s1,s2) do { *(d) = *(s1) ^ *(s2); } while (0)
/* int CPU_EQUAL(FAR const cpu_set_t *set1, FAR const cpu_set_t *set2); */
# define CPU_EQUAL(s1,s2) (*(s2) == *(s2))
/* REVISIT: Variably sized CPU sets are not supported */
/* FAR cpu_set_t *CPU_ALLOC(int num_cpus); */
# define CPU_ALLOC(n) (FAR cpu_set_t *)malloc(sizeof(cpu_set_t));
/* void CPU_FREE(cpu_set_t *set); */
# define CPU_FREE(s) free(s)
/* size_t CPU_ALLOC_SIZE(int num_cpus); */
# define CPU_ALLOC_SIZE(n) sizeof(cpu_set_t)
/* void CPU_ZERO_S(size_t setsize, FAR cpu_set_t *set); */
# define CPU_ZERO_S(n,s) CPU_ZERO_S(s)
/* void CPU_SET_S(int cpu, size_t setsize, FAR cpu_set_t *set); */
# define CPU_SET_S(c,n,s) CPU_SET(c,s)
/* void CPU_CLR_S(int cpu, size_t setsize, FAR cpu_set_t *set); */
# define CPU_CLR_S(c,n,s) CPU_CLR(c,s)
/* int CPU_ISSET_S(int cpu, size_t setsize, FAR const cpu_set_t *set); */
# define CPU_ISSET_S(c,n,s) CPU_ISSET(c,s)
/* int CPU_COUNT_S(size_t setsize, FAR const cpu_set_t *set); */
# define CPU_COUNT_S(n,s) CPU_COUNT(s)
/* void CPU_AND_S(size_t setsize, FAR cpu_set_t *destset,
* FAR const cpu_set_t *srcset1,
* FAR const cpu_set_t *srcset2);
*/
# define CPU_AND_S(n,d,s1,s2) CPU_AND(d,s1,s2)
/* void CPU_OR_S(size_t setsize, FAR cpu_set_t *destset,
* FAR const cpu_set_t *srcset1,
* FAR const cpu_set_t *srcset2);
*/
# define CPU_OR_S(n,d,s1,s2) CPU_OR(d,s1,s2)
/* void CPU_XOR_S(size_t setsize, FAR cpu_set_t *destset,
* FAR const cpu_set_t *srcset1,
* FAR const cpu_set_t *srcset2);
*/
# define CPU_XOR_S(n,d,s1,s2) CPU_XOR(d,s1,s2)
/* int CPU_EQUAL_S(size_t setsize, FAR const cpu_set_t *set1,
* FAR const cpu_set_t *set2);
*/
# define CPU_EQUAL_S(n,s1,s2) CPU_EQUAL(s1,s2)
#endif /* CONFIG_SMP */
/********************************************************************************
* Public Type Definitions
********************************************************************************/
/* This is the POSIX-like scheduling parameter structure */
struct sched_param
{
int sched_priority; /* Base thread priority */
#ifdef CONFIG_SCHED_SPORADIC
int sched_ss_low_priority; /* Low scheduling priority for sporadic
* server */
struct timespec sched_ss_repl_period; /* Replenishment period for sporadic
* server. */
struct timespec sched_ss_init_budget; /* Initial budget for sporadic server */
int sched_ss_max_repl; /* Maximum pending replenishments for
* sporadic server. */
#endif
};
/********************************************************************************
* Public Data
********************************************************************************/
#ifndef __ASSEMBLY__
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/********************************************************************************
* Public Function Prototypes
********************************************************************************/
/* Task Control Interfaces (non-standard) */
#ifndef CONFIG_BUILD_KERNEL
int task_create(FAR const char *name, int priority, int stack_size,
main_t entry, FAR char * const argv[]);
int task_create_with_stack(FAR const char *name, int priority,
FAR void *stack_addr, int stack_size,
main_t entry, FAR char * const argv[]);
#endif
int task_delete(pid_t pid);
int task_restart(pid_t pid);
int task_setcancelstate(int state, FAR int *oldstate);
int task_setcanceltype(int type, FAR int *oldtype);
void task_testcancel(void);
/* Task Scheduling Interfaces (based on POSIX APIs) */
int sched_setparam(pid_t pid, FAR const struct sched_param *param);
int sched_getparam(pid_t pid, FAR struct sched_param *param);
int sched_setscheduler(pid_t pid, int policy,
FAR const struct sched_param *param);
int sched_getscheduler(pid_t pid);
int sched_yield(void);
int sched_get_priority_max(int policy);
int sched_get_priority_min(int policy);
int sched_rr_get_interval(pid_t pid, FAR struct timespec *interval);
#ifdef CONFIG_SMP
/* Task affinity */
int sched_setaffinity(pid_t pid, size_t cpusetsize,
FAR const cpu_set_t *mask);
int sched_getaffinity(pid_t pid, size_t cpusetsize, FAR cpu_set_t *mask);
int sched_cpucount(FAR const cpu_set_t *set);
int sched_getcpu(void);
#endif /* CONFIG_SMP */
/* Task Switching Interfaces (non-standard) */
int sched_lock(void);
int sched_unlock(void);
int sched_lockcount(void);
/* Queries */
bool sched_idletask(void);
/* Task Backtrace */
int sched_backtrace(pid_t tid, FAR void **buffer, int size, int skip);
void sched_dumpstack(pid_t tid);
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* __ASSEMBLY__ */
#endif /* __INCLUDE_SCHED_H */