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
|
/* ========================================
Copyright (C) 2024-2025, Amlal El Mahrouss, licensed under the Apache 2.0 license.
======================================== */
#ifndef INC_PROCESS_SCHEDULER_H
#define INC_PROCESS_SCHEDULER_H
/// @file UserProcessScheduler.h
/// @brief User Process Scheduler header file.
/// @author Amlal El Mahrouss (amlal@nekernel.org)
#include <ArchKit/ArchKit.h>
#include <KernelKit/CoreProcessScheduler.h>
#include <KernelKit/LockDelegate.h>
#include <KernelKit/UserMgr.h>
#include <NeKit/MutableArray.h>
////////////////////////////////////////////////////
// Last revision date is: Fri Mar 28 2025 //
////////////////////////////////////////////////////
namespace Kernel {
//! @brief Forward declarations.
class IDylibObject;
class UserProcessScheduler;
class UserProcessHelper;
/***********************************************************************************/
/// @name UserProcess
/// @brief UserProcess class, holds information about the running process/thread.
/***********************************************************************************/
class UserProcess final NE_VETTABLE {
public:
explicit UserProcess();
~UserProcess();
auto DoVet() const { return *this; }
public:
NE_COPY_DEFAULT(UserProcess)
public:
Char Name[kSchedNameLen] = {"UserProcess"};
ProcessSubsystem SubSystem{ProcessSubsystem::kProcessSubsystemUser};
User* Owner{nullptr};
HAL::StackFramePtr StackFrame{nullptr};
AffinityKind Affinity{AffinityKind::kStandard};
ProcessStatusKind Status{ProcessStatusKind::kKilled};
UInt8 StackReserve[kSchedMaxStackSz];
ProcessImage Image{};
SizeT StackSize{kSchedMaxStackSz};
IDylibObject* DylibDelegate{nullptr};
SizeT MemoryCursor{0UL};
SizeT MemoryLimit{kSchedMaxMemoryLimit};
SizeT UsedMemory{0UL};
struct USER_PROCESS_SIGNAL final {
UIntPtr SignalArg{0};
ProcessStatusKind Status{ProcessStatusKind::kKilled};
UIntPtr SignalID{0};
};
USER_PROCESS_SIGNAL Signal;
ProcessFileTree<VoidPtr>* FileTree{nullptr};
ProcessHeapTree<VoidPtr>* HeapTree{nullptr};
UserProcessTeam* ParentTeam;
VoidPtr VMRegister{0UL};
enum {
kInvalidExecutableKind,
kExecutableKind,
kExecutableDylibKind,
kExecutableKindCount,
};
ProcessTime PTime{0}; //! @brief Process allocated tine.
ProcessTime RTime{0}; //! @brief Process run time.
ProcessTime UTime{0}; //! #brief Process used time.
ProcessID ProcessId{kSchedInvalidPID};
Int32 Kind{kExecutableKind};
public:
/***********************************************************************************/
//! @brief boolean operator, check status.
/***********************************************************************************/
explicit operator bool();
/***********************************************************************************/
///! @brief Crashes the app, exits with code ~0.
/***********************************************************************************/
Void Crash();
/***********************************************************************************/
///! @brief Spawns a dynamic library handle if dylib.
/***********************************************************************************/
Bool InitDylib();
/***********************************************************************************/
///! @brief Exits the app.
/***********************************************************************************/
Void Exit(const Int32& exit_code = 0);
/***********************************************************************************/
///! @brief TLS allocate.
///! @param sz size of data structure.
///! @param pad_amount amount to add after pointer.
///! @return A wrapped pointer, or error code.
/***********************************************************************************/
ErrorOr<VoidPtr> New(SizeT sz, SizeT pad_amount = 0);
/***********************************************************************************/
///! @brief TLS free.
///! @param ptr the pointer to free.
///! @param sz the size of it.
/***********************************************************************************/
template <typename T>
Boolean Delete(ErrorOr<T*> ptr);
/***********************************************************************************/
///! @brief Wakes up thread.
/***********************************************************************************/
Void Wake(Bool wakeup = false);
public:
/***********************************************************************************/
//! @brief Gets the local exit code.
/***********************************************************************************/
KPCError& GetExitCode();
/***********************************************************************************/
///! @brief Get the process's name
///! @example 'C Runtime Library'
/***********************************************************************************/
const Char* GetName();
/***********************************************************************************/
//! @brief return local error code of process.
//! @return Int32 local error code.
/***********************************************************************************/
KPCError& GetLocalCode();
const User* GetOwner();
const ProcessStatusKind& GetStatus();
const AffinityKind& GetAffinity();
private:
KPCError LastExitCode{0};
KPCError LocalCode{0};
friend UserProcessScheduler;
friend UserProcessHelper;
};
typedef Array<UserProcess, kSchedProcessLimitPerTeam> UserProcessArray;
typedef Ref<UserProcess> UserProcessRef;
/// \brief Processs Team (contains multiple processes inside it.)
/// Equivalent to a process batch
class UserProcessTeam final {
public:
explicit UserProcessTeam();
~UserProcessTeam() = default;
NE_COPY_DEFAULT(UserProcessTeam)
Array<UserProcess, kSchedProcessLimitPerTeam>& AsArray();
Ref<UserProcess>& AsRef();
ProcessID& Id();
public:
UserProcessArray mProcessList;
UserProcessRef mCurrentProcess;
ProcessID mTeamId{0};
ProcessID mProcessCur{0};
};
/***********************************************************************************/
/// @brief UserProcess scheduler class.
/// The main class which you call to schedule user processes.
/***********************************************************************************/
class UserProcessScheduler final : public ISchedulable {
friend class UserProcessHelper;
public:
explicit UserProcessScheduler() = default;
~UserProcessScheduler() override = default;
NE_COPY_DELETE(UserProcessScheduler)
NE_MOVE_DELETE(UserProcessScheduler)
public:
explicit operator bool();
bool operator!();
public:
UserProcessTeam& TheCurrentTeam();
BOOL SwitchTeam(UserProcessTeam& team);
public:
ProcessID Spawn(const Char* name, VoidPtr code, VoidPtr image);
Void Remove(ProcessID process_id);
Bool IsUser() override;
Bool IsKernel() override;
Bool HasMP() override;
public:
UserProcessRef& TheCurrentProcess();
SizeT Run();
public:
STATIC UserProcessScheduler& The();
private:
UserProcessTeam mTeam{};
};
/***********************************************************************************/
/**
* \brief UserProcess helper class, which contains needed utilities for the scheduler.
*/
/***********************************************************************************/
class UserProcessHelper final {
public:
STATIC Bool Switch(HAL::StackFramePtr frame_ptr, ProcessID new_pid);
STATIC Bool CanBeScheduled(const UserProcess& process);
STATIC ErrorOr<ProcessID> TheCurrentPID();
STATIC SizeT StartScheduling();
};
} // namespace Kernel
#include <KernelKit/ThreadLocalStorage.h>
#include <KernelKit/UserProcessScheduler.inl>
////////////////////////////////////////////////////
// END
////////////////////////////////////////////////////
#endif /* ifndef INC_PROCESS_SCHEDULER_H */
|
