summaryrefslogtreecommitdiffhomepage
path: root/dev/kernel/KernelKit/CoreProcessScheduler.h
blob: 6cb17261797b7543bb75c76be530b14ee97cc8a7 (plain)
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
/* -------------------------------------------

  Copyright (C) 2024-2025, Amlal El Mahrouss, all rights reserved.

------------------------------------------- */

#pragma once

#include <NewKit/Defines.h>
#include <NewKit/ErrorOr.h>

#define kSchedMinMicroTime (AffinityKind::kStandard)
#define kSchedInvalidPID (-1)
#define kSchedProcessLimitPerTeam (32U)
#define kSchedTeamCount (256U)

#define kSchedMaxMemoryLimit gib_cast(128) /* max physical memory limit */
#define kSchedMaxStackSz (kib_cast(8))     /* maximum stack size */

#define kSchedNameLen (128U)

namespace Kernel {
class USER_PROCESS;
class KERNEL_TASK;
class KernelTaskScheduler;
class UserProcessScheduler;
class UserProcessTeam;

template <typename T>
struct PROCESS_HEAP_TREE;

template <typename T>
struct PROCESS_FILE_TREE;

enum {
  kInvalidTreeKind = 0U,
  kRedTreeKind     = 100U,
  kBlackTreeKind   = 101U,
  kTreeKindCount   = 2U,
};

template <typename T>
struct PROCESS_HEAP_TREE {
  static constexpr auto kPtr = true;
  static constexpr auto kFD  = false;

  T     Entry{nullptr};
  SizeT EntrySize{0UL};
  SizeT EntryPad{0UL};

  UInt32 Color{kBlackTreeKind};

  struct PROCESS_HEAP_TREE<T>* Parent {
    nullptr
  };
  struct PROCESS_HEAP_TREE<T>* Child {
    nullptr
  };

  struct PROCESS_HEAP_TREE<T>* Prev {
    nullptr
  };
  struct PROCESS_HEAP_TREE<T>* Next {
    nullptr
  };
};

template <typename T>
struct PROCESS_FILE_TREE {
  static constexpr auto kPtr = false;
  static constexpr auto kFD  = true;

  T     Entry{nullptr};
  SizeT EntrySize{0UL};
  SizeT EntryPad{0UL};

  UInt32 Color{kBlackTreeKind};

  struct PROCESS_FILE_TREE<T>* Parent {
    nullptr
  };
  struct PROCESS_FILE_TREE<T>* Child {
    nullptr
  };

  struct PROCESS_FILE_TREE<T>* Prev {
    nullptr
  };
  struct PROCESS_FILE_TREE<T>* Next {
    nullptr
  };
};

/***********************************************************************************/
/// @brief Subsystem enum type.
/***********************************************************************************/

enum class ProcessSubsystem : Int32 {
  kProcessSubsystemSecurity = 100,
  kProcessSubsystemUser,
  kProcessSubsystemService,
  kProcessSubsystemDriver,
  kProcessSubsystemInvalid = 0xFFFFFFF,
  kProcessSubsystemCount   = 4,
};

typedef UInt64 PTime;

/***********************************************************************************/
//! @brief Local Process identifier.
/***********************************************************************************/
typedef Int64 ProcessID;

/***********************************************************************************/
//! @brief Local Process status enum.
/***********************************************************************************/
enum class ProcessStatusKind : Int32 {
  kInvalid  = 0,
  kStarting = 100,
  kRunning,
  kKilled,
  kFrozen,
  kFinished,
  kCount = 6,
};

/***********************************************************************************/
//! @brief Affinity is the amount of nano-seconds this process is going to run.
/***********************************************************************************/
enum class AffinityKind : Int32 {
  kRealTime     = 50,
  kVeryHigh     = 150,
  kHigh         = 200,
  kStandard     = 1000,
  kLowUsage     = 1500,
  kVeryLowUsage = 2000,
};

/***********************************************************************************/
//! Operators for AffinityKind
/***********************************************************************************/

inline bool operator<(AffinityKind lhs, AffinityKind rhs) {
  Int32 lhs_int = static_cast<Int>(lhs);
  Int32 rhs_int = static_cast<Int>(rhs);

  return lhs_int < rhs_int;
}

inline bool operator>(AffinityKind lhs, AffinityKind rhs) {
  Int32 lhs_int = static_cast<Int>(lhs);
  Int32 rhs_int = static_cast<Int>(rhs);

  return lhs_int > rhs_int;
}

inline bool operator<=(AffinityKind lhs, AffinityKind rhs) {
  Int32 lhs_int = static_cast<Int>(lhs);
  Int32 rhs_int = static_cast<Int>(rhs);

  return lhs_int <= rhs_int;
}

inline bool operator>=(AffinityKind lhs, AffinityKind rhs) {
  Int32 lhs_int = static_cast<Int>(lhs);
  Int32 rhs_int = static_cast<Int>(rhs);

  return lhs_int >= rhs_int;
}

using ProcessTime = UInt64;
using PID         = Int64;

/***********************************************************************************/
/// @note For User manager, tells where we run the code.
/***********************************************************************************/
enum class ProcessLevelRing : Int32 {
  kRingStdUser   = 1,
  kRingSuperUser = 2,
  kRingGuestUser = 5,
  kRingCount     = 5,
};

/***********************************************************************************/
/// @brief Helper type to describe a code image.
/***********************************************************************************/
using ImagePtr = VoidPtr;

/***********************************************************************************/
/// @brief Helper class to contain a process's image and blob.
/***********************************************************************************/
struct PROCESS_IMAGE final {
  explicit PROCESS_IMAGE() = default;

 private:
  friend USER_PROCESS;
  friend KERNEL_TASK;

  friend class UserProcessScheduler;

  ImagePtr fCode;
  ImagePtr fBlob;

 public:
  Bool HasCode() const { return this->fCode != nullptr; }

  Bool HasImage() const { return this->fBlob != nullptr; }

  ErrorOr<ImagePtr> Leak() {
    if (this->fCode) {
      return ErrorOr<ImagePtr>{this->fCode};
    }

    return ErrorOr<ImagePtr>{kErrorInvalidData};
  }

  ErrorOr<ImagePtr> LeakBlob() {
    if (this->fBlob) {
      return ErrorOr<ImagePtr>{this->fBlob};
    }

    return ErrorOr<ImagePtr>{kErrorInvalidData};
  }
};
}  // namespace Kernel