Repository navigation
Expand file tree
/
Copy pathServiceLifecyclePolicy.cs
More file actions
359 lines (326 loc) · 11 KB
/
Copy pathServiceLifecyclePolicy.cs
File metadata and controls
359 lines (326 loc) · 11 KB
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
namespace ContextMenuMgr.Backend.Hosting;
internal enum BackendServiceStopReason
{
Unknown,
FrontendRequest,
ServiceControlManager,
WindowsShutdown,
StartupFailure,
ForceRepair,
Uninstall,
ExplicitServiceStop,
InstallRepair,
UnexpectedProcessExit
}
internal sealed class BackendStopRequestedEventArgs(BackendServiceStopReason reason) : EventArgs
{
public BackendServiceStopReason Reason { get; } = reason;
public PortableExitCaller? PortableCaller { get; init; }
}
internal sealed class BackendServiceTerminationState
{
// ERROR_EXCEPTION_IN_SERVICE is a concrete SCM-visible failure code and
// does not require a separate service-specific exit code.
internal const int StartupFailureExitCode = 1064;
private readonly Lock _syncRoot = new();
private BackendServiceStopReason _stopReason = BackendServiceStopReason.Unknown;
private int _exitCode;
public BackendServiceStopReason StopReason
{
get
{
lock (_syncRoot)
{
return _stopReason;
}
}
}
public int ExitCode
{
get
{
lock (_syncRoot)
{
return _exitCode;
}
}
}
public void MarkIntentionalStop(BackendServiceStopReason reason)
{
if (reason is BackendServiceStopReason.Unknown
or BackendServiceStopReason.StartupFailure
or BackendServiceStopReason.UnexpectedProcessExit)
{
throw new ArgumentOutOfRangeException(nameof(reason), reason, "An intentional stop requires a concrete non-failure reason.");
}
lock (_syncRoot)
{
if (_stopReason is BackendServiceStopReason.Unknown or BackendServiceStopReason.ServiceControlManager)
{
_stopReason = reason;
_exitCode = 0;
}
}
}
public void MarkServiceControlManagerStop(BackendServiceStopReason markerReason)
{
lock (_syncRoot)
{
if (_stopReason != BackendServiceStopReason.Unknown)
{
return;
}
_stopReason = IsIntentionalReason(markerReason)
? markerReason
: BackendServiceStopReason.ServiceControlManager;
_exitCode = 0;
}
}
public void MarkStartupFailure()
{
lock (_syncRoot)
{
_stopReason = BackendServiceStopReason.StartupFailure;
_exitCode = StartupFailureExitCode;
}
}
public void MarkUnexpectedRunReturn()
{
lock (_syncRoot)
{
if (_stopReason == BackendServiceStopReason.Unknown)
{
_stopReason = BackendServiceStopReason.UnexpectedProcessExit;
_exitCode = StartupFailureExitCode;
}
}
}
private static bool IsIntentionalReason(BackendServiceStopReason reason)
=> reason is BackendServiceStopReason.FrontendRequest
or BackendServiceStopReason.WindowsShutdown
or BackendServiceStopReason.ForceRepair
or BackendServiceStopReason.Uninstall
or BackendServiceStopReason.ExplicitServiceStop
or BackendServiceStopReason.InstallRepair;
}
internal sealed record ServiceCommandResult(bool Success, int ExitCode, string Detail);
internal sealed record ServiceConfigurationSnapshot(
bool Exists,
string ServiceName,
string? ImagePath,
string? ServiceExePath,
int? StartValue,
string ConfiguredStartType,
bool DelayedAutoStart,
bool FailureActionsPresent,
bool FailureActionsMatch,
bool FailureActionsOnNonCrashFailures,
string CurrentStatus,
string SystemDrive,
string ServiceExeDrive)
{
public bool MatchesRequestedStartupMode(string requestedMode) => requestedMode switch
{
"delayed-auto" => StartValue == 2 && DelayedAutoStart,
"auto" => StartValue == 2 && !DelayedAutoStart,
"demand" => StartValue == 3,
_ => false
};
public bool FailureRecoveryConfigured => FailureActionsPresent && FailureActionsMatch && FailureActionsOnNonCrashFailures;
}
internal sealed record ServiceRuntimeConvergenceResult(bool Success, string Code, string Detail);
internal sealed record ServiceAutostartTransitionResult(
bool Success,
string Code,
string Detail,
bool PolicyCommitted,
int Win32Error,
string ActualStartupMode,
string ServiceStatus);
internal static class ServiceAutostartTransition
{
public static ServiceAutostartTransitionResult Execute(
bool enabled,
bool serviceExists,
string requestedStartupMode,
Func<ServiceCommandResult> configureStartupMode,
Func<ServiceConfigurationSnapshot> readConfiguration,
Func<ServiceCommandResult> configureRecovery,
Func<ServiceRuntimeConvergenceResult> convergeRuntime,
Action commitPolicy)
{
if (!serviceExists)
{
if (!enabled)
{
try
{
commitPolicy();
return new ServiceAutostartTransitionResult(
true,
"NOT_INSTALLED",
"Service was not installed; the disabled user policy was committed.",
true,
-1,
"Missing",
"Missing");
}
catch (Exception ex)
{
return new ServiceAutostartTransitionResult(
false,
"AUTOSTART_POLICY_WRITE_FAILED",
ex.Message,
false,
-1,
"Missing",
"Missing");
}
}
return new ServiceAutostartTransitionResult(
false,
"SERVICE_NOT_INSTALLED",
"The backend service is not installed.",
false,
-1,
"Missing",
"Missing");
}
var configurationResult = configureStartupMode();
if (!configurationResult.Success)
{
return new ServiceAutostartTransitionResult(
false,
"SERVICE_STARTUP_CONFIG_FAILED",
configurationResult.Detail,
false,
configurationResult.ExitCode,
"Unverified",
readConfiguration().CurrentStatus);
}
var configuration = readConfiguration();
if (!configuration.MatchesRequestedStartupMode(requestedStartupMode))
{
return new ServiceAutostartTransitionResult(
false,
"SERVICE_STARTUP_CONFIG_MISMATCH",
$"RequestedStartupMode={requestedStartupMode}, ActualStartupMode={configuration.ConfiguredStartType}.",
false,
configurationResult.ExitCode,
configuration.ConfiguredStartType,
configuration.CurrentStatus);
}
if (enabled)
{
var recoveryResult = configureRecovery();
if (!recoveryResult.Success)
{
return new ServiceAutostartTransitionResult(
false,
"SERVICE_RECOVERY_CONFIG_FAILED",
recoveryResult.Detail,
false,
recoveryResult.ExitCode,
configuration.ConfiguredStartType,
configuration.CurrentStatus);
}
configuration = readConfiguration();
if (!configuration.FailureRecoveryConfigured)
{
return new ServiceAutostartTransitionResult(
false,
"SERVICE_RECOVERY_CONFIG_MISMATCH",
"SCM recovery settings could not be verified.",
false,
recoveryResult.ExitCode,
configuration.ConfiguredStartType,
configuration.CurrentStatus);
}
var runtimeResult = convergeRuntime();
if (!runtimeResult.Success)
{
configuration = readConfiguration();
return new ServiceAutostartTransitionResult(
false,
runtimeResult.Code,
runtimeResult.Detail,
false,
configurationResult.ExitCode,
configuration.ConfiguredStartType,
configuration.CurrentStatus);
}
}
try
{
commitPolicy();
}
catch (Exception ex)
{
configuration = readConfiguration();
return new ServiceAutostartTransitionResult(
false,
"AUTOSTART_POLICY_WRITE_FAILED",
ex.Message,
false,
configurationResult.ExitCode,
configuration.ConfiguredStartType,
configuration.CurrentStatus);
}
configuration = readConfiguration();
return new ServiceAutostartTransitionResult(
true,
enabled ? "STARTUP_AUTO" : "STARTUP_MANUAL",
enabled ? configuration.ConfiguredStartType : "Manual",
true,
configurationResult.ExitCode,
configuration.ConfiguredStartType,
configuration.CurrentStatus);
}
}
internal static class ServiceStopReasonMarker
{
private static readonly TimeSpan MarkerLifetime = TimeSpan.FromMinutes(5);
public static void Write(string path, BackendServiceStopReason reason)
{
Directory.CreateDirectory(Path.GetDirectoryName(path) ?? AppContext.BaseDirectory);
File.WriteAllText(path, $"{reason}|{DateTimeOffset.UtcNow:O}");
}
public static BackendServiceStopReason Read(string path)
{
try
{
if (!File.Exists(path))
{
return BackendServiceStopReason.Unknown;
}
var parts = File.ReadAllText(path).Trim().Split('|', 2);
if (parts.Length != 2
|| !Enum.TryParse<BackendServiceStopReason>(parts[0], ignoreCase: true, out var reason)
|| !DateTimeOffset.TryParse(parts[1], System.Globalization.CultureInfo.InvariantCulture, System.Globalization.DateTimeStyles.RoundtripKind, out var createdAtUtc))
{
return BackendServiceStopReason.Unknown;
}
var age = DateTimeOffset.UtcNow - createdAtUtc;
return age >= TimeSpan.Zero && age <= MarkerLifetime
? reason
: BackendServiceStopReason.Unknown;
}
catch
{
return BackendServiceStopReason.Unknown;
}
}
public static void Delete(string path)
{
try
{
if (File.Exists(path))
{
File.Delete(path);
}
}
catch
{
}
}
}