| | | 1 | | using System.Collections.Concurrent; |
| | | 2 | | using System.Management.Automation.Runspaces; |
| | | 3 | | using Kestrun.Hosting; |
| | | 4 | | using Serilog.Events; |
| | | 5 | | |
| | | 6 | | namespace Kestrun.Scripting; |
| | | 7 | | |
| | | 8 | | /// <summary> |
| | | 9 | | /// Manages a pool of PowerShell runspaces for efficient reuse and resource control. |
| | | 10 | | /// </summary> |
| | | 11 | | public sealed class KestrunRunspacePoolManager : IDisposable |
| | | 12 | | { |
| | 163 | 13 | | private readonly ConcurrentBag<Runspace> _stash = []; |
| | | 14 | | private readonly InitialSessionState _iss; |
| | | 15 | | private int _count; // total live runspaces |
| | | 16 | | private bool _disposed; |
| | | 17 | | |
| | | 18 | | /// <summary> |
| | | 19 | | /// Track all runspaces ever created (for cleanup) |
| | | 20 | | /// </summary> |
| | | 21 | | private readonly ConcurrentDictionary<Runspace, byte> _all; |
| | | 22 | | |
| | | 23 | | /// <summary> |
| | | 24 | | /// KestrunHost is needed for logging, config, etc. |
| | | 25 | | /// </summary> |
| | 2651 | 26 | | public KestrunHost Host { get; private set; } |
| | | 27 | | |
| | | 28 | | /// <summary> |
| | | 29 | | /// Gets the minimum number of runspaces maintained in the pool. |
| | | 30 | | /// </summary> |
| | 2 | 31 | | public int MinRunspaces { get; } |
| | | 32 | | /// <summary> |
| | | 33 | | /// Gets the maximum number of runspaces allowed in the pool. |
| | | 34 | | /// </summary> |
| | 107 | 35 | | public int MaxRunspaces { get; } |
| | | 36 | | |
| | | 37 | | /// <summary> |
| | | 38 | | /// Path to the OpenAPI class definitions to be injected into each runspace. |
| | | 39 | | /// </summary> |
| | 253 | 40 | | public string? OpenApiClassesPath { get; init; } |
| | | 41 | | |
| | | 42 | | /// <summary> |
| | | 43 | | /// Thread‑affinity strategy for *future* runspaces. |
| | | 44 | | /// Default is <see cref="PSThreadOptions.ReuseThread"/>. |
| | | 45 | | /// </summary> |
| | 676 | 46 | | public PSThreadOptions ThreadOptions { get; set; } = PSThreadOptions.ReuseThread; |
| | | 47 | | |
| | | 48 | | // ───────────────── constructor ────────────────────────── |
| | | 49 | | /// <summary> |
| | | 50 | | /// Initializes a new instance of the <see cref="KestrunRunspacePoolManager"/> class with the specified minimum and |
| | | 51 | | /// </summary> |
| | | 52 | | /// <param name="host">The Kestrun host instance.</param> |
| | | 53 | | /// <param name="minRunspaces">The minimum number of runspaces to maintain in the pool.</param> |
| | | 54 | | /// <param name="maxRunspaces">The maximum number of runspaces allowed in the pool.</param> |
| | | 55 | | /// <param name="initialSessionState">The initial session state for each runspace (optional).</param> |
| | | 56 | | /// <param name="threadOptions">The thread affinity strategy for runspaces (optional).</param> |
| | | 57 | | /// <param name="openApiClassesPath">The file path to the OpenAPI class definitions to be injected into each runspac |
| | 163 | 58 | | public KestrunRunspacePoolManager( |
| | 163 | 59 | | KestrunHost host, |
| | 163 | 60 | | int minRunspaces, |
| | 163 | 61 | | int maxRunspaces, |
| | 163 | 62 | | InitialSessionState? initialSessionState = null, |
| | 163 | 63 | | PSThreadOptions threadOptions = PSThreadOptions.ReuseThread, |
| | 163 | 64 | | string? openApiClassesPath = null) |
| | | 65 | | { |
| | 163 | 66 | | if (host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 67 | | { |
| | 111 | 68 | | host.Logger.Debug("Initializing RunspacePoolManager: Min={Min}, Max={Max}", minRunspaces, maxRunspaces); |
| | | 69 | | } |
| | | 70 | | |
| | 162 | 71 | | ArgumentOutOfRangeException.ThrowIfNegative(minRunspaces); |
| | 161 | 72 | | ArgumentNullException.ThrowIfNull(host); |
| | 161 | 73 | | ArgumentOutOfRangeException.ThrowIfNegative(maxRunspaces); |
| | | 74 | | // sanity check |
| | 160 | 75 | | if (maxRunspaces < 1 || maxRunspaces < minRunspaces) |
| | | 76 | | { |
| | 2 | 77 | | throw new ArgumentOutOfRangeException(nameof(maxRunspaces)); |
| | | 78 | | } |
| | 158 | 79 | | _all = new(); |
| | 158 | 80 | | Host = host; |
| | 158 | 81 | | MinRunspaces = minRunspaces; |
| | 158 | 82 | | MaxRunspaces = maxRunspaces; |
| | 158 | 83 | | _iss = initialSessionState ?? InitialSessionState.CreateDefault(); |
| | 158 | 84 | | ThreadOptions = threadOptions; |
| | | 85 | | |
| | | 86 | | // warm the stash |
| | 622 | 87 | | for (var i = 0; i < minRunspaces; i++) |
| | | 88 | | { |
| | 153 | 89 | | _stash.Add(CreateRunspace()); |
| | | 90 | | } |
| | | 91 | | |
| | 158 | 92 | | _count = minRunspaces; |
| | | 93 | | |
| | | 94 | | // Store OpenAPI classes |
| | 158 | 95 | | OpenApiClassesPath = openApiClassesPath; |
| | 158 | 96 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 97 | | { |
| | 107 | 98 | | Host.Logger.Debug("Warm-started pool with {Count} runspaces", _count); |
| | | 99 | | } |
| | 158 | 100 | | } |
| | | 101 | | |
| | | 102 | | // ───────────────── public API ──────────────────────────── |
| | | 103 | | /// <summary>Borrow a runspace (creates one if under the cap).</summary> |
| | | 104 | | public Runspace Acquire() |
| | | 105 | | { |
| | 69 | 106 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 107 | | { |
| | 63 | 108 | | Host.Logger.Debug("Acquiring runspace from pool: CurrentCount={Count}, Max={Max}", _count, MaxRunspaces); |
| | | 109 | | } |
| | | 110 | | |
| | 69 | 111 | | ObjectDisposedException.ThrowIf(_disposed, nameof(KestrunRunspacePoolManager)); |
| | | 112 | | |
| | 67 | 113 | | if (_stash.TryTake(out var rs)) |
| | | 114 | | { |
| | 43 | 115 | | if (rs.RunspaceStateInfo.State != RunspaceState.Opened) |
| | | 116 | | { |
| | 0 | 117 | | Host.Logger.Warning("Runspace from stash is not opened: {State}. Discarding and acquiring a new one.", r |
| | | 118 | | // If the runspace is not open, we cannot use it. |
| | | 119 | | // Discard and try again |
| | 0 | 120 | | var removed = _all.TryRemove(rs, out _); |
| | 0 | 121 | | rs.Dispose(); |
| | 0 | 122 | | if (removed) |
| | | 123 | | { |
| | 0 | 124 | | _ = Interlocked.Decrement(ref _count); |
| | | 125 | | } |
| | 0 | 126 | | return Acquire(); |
| | | 127 | | } |
| | 43 | 128 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 129 | | { |
| | 38 | 130 | | Host.Logger.Debug("Reusing runspace from stash: StashCount={Count}", _stash.Count); |
| | | 131 | | } |
| | | 132 | | |
| | 43 | 133 | | return rs; |
| | | 134 | | } |
| | | 135 | | // Need a new one?—but only if we haven’t reached max. |
| | 24 | 136 | | if (Interlocked.Increment(ref _count) <= MaxRunspaces) |
| | | 137 | | { |
| | 23 | 138 | | Host.Logger.Debug("Creating new runspace: TotalCount={Count}", _count); |
| | | 139 | | try |
| | | 140 | | { |
| | 23 | 141 | | return CreateRunspace(); |
| | | 142 | | } |
| | 0 | 143 | | catch |
| | | 144 | | { |
| | 0 | 145 | | _ = Interlocked.Decrement(ref _count); |
| | 0 | 146 | | throw; |
| | | 147 | | } |
| | | 148 | | } |
| | | 149 | | // Overshot: roll back and complain. |
| | 1 | 150 | | _ = Interlocked.Decrement(ref _count); |
| | | 151 | | |
| | 1 | 152 | | Host.Logger.Warning("Runspace limit reached: Max={Max}", MaxRunspaces); |
| | 1 | 153 | | throw new InvalidOperationException("Run-space limit reached."); |
| | 23 | 154 | | } |
| | | 155 | | |
| | | 156 | | /// <summary> |
| | | 157 | | /// Asynchronously acquires a runspace from the pool, creating a new one if under the cap, or waits until one become |
| | | 158 | | /// </summary> |
| | | 159 | | /// <param name="cancellationToken">A cancellation token to observe while waiting for a runspace.</param> |
| | | 160 | | /// <returns>A task that represents the asynchronous operation, containing the acquired <see cref="Runspace"/>.</ret |
| | | 161 | | public async Task<Runspace> AcquireAsync(CancellationToken cancellationToken = default) |
| | | 162 | | { |
| | 8 | 163 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 164 | | { |
| | 8 | 165 | | Host.Logger.Debug("Acquiring runspace (async) from pool: CurrentCount={Count}, Max={Max}", _count, MaxRunspa |
| | | 166 | | } |
| | | 167 | | |
| | 3 | 168 | | while (true) |
| | | 169 | | { |
| | 11 | 170 | | ObjectDisposedException.ThrowIf(_disposed, nameof(KestrunRunspacePoolManager)); |
| | | 171 | | |
| | 10 | 172 | | if (_stash.TryTake(out var rs)) |
| | | 173 | | { |
| | 5 | 174 | | if (rs.RunspaceStateInfo.State != RunspaceState.Opened) |
| | | 175 | | { |
| | 0 | 176 | | Host.Logger.Warning("Runspace from stash is not opened: {State}. Discarding and continuing wait.", r |
| | 0 | 177 | | var removed = _all.TryRemove(rs, out _); |
| | 0 | 178 | | rs.Dispose(); |
| | 0 | 179 | | if (removed) |
| | | 180 | | { |
| | 0 | 181 | | _ = Interlocked.Decrement(ref _count); |
| | | 182 | | } |
| | 0 | 183 | | continue; |
| | | 184 | | } |
| | 5 | 185 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 186 | | { |
| | 5 | 187 | | Host.Logger.Debug("Reusing runspace from stash (async): StashCount={Count}", _stash.Count); |
| | | 188 | | } |
| | | 189 | | |
| | 5 | 190 | | return rs; |
| | | 191 | | } |
| | | 192 | | // Need a new one?—but only if we haven’t reached max. |
| | 5 | 193 | | if (Interlocked.Increment(ref _count) <= MaxRunspaces) |
| | | 194 | | { |
| | 1 | 195 | | Host.Logger.Debug("Creating new runspace (async): TotalCount={Count}", _count); |
| | | 196 | | try |
| | | 197 | | { |
| | | 198 | | // Runspace creation is synchronous, but we can offload to thread pool |
| | 1 | 199 | | return await Task.Run(CreateRunspace, cancellationToken).ConfigureAwait(false); |
| | | 200 | | } |
| | 1 | 201 | | catch |
| | | 202 | | { |
| | 1 | 203 | | _ = Interlocked.Decrement(ref _count); |
| | 1 | 204 | | throw; |
| | | 205 | | } |
| | | 206 | | } |
| | | 207 | | // Overshot: roll back and try again. |
| | 4 | 208 | | _ = Interlocked.Decrement(ref _count); |
| | | 209 | | |
| | | 210 | | // Wait for a runspace to be returned |
| | 4 | 211 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 212 | | { |
| | 4 | 213 | | Host.Logger.Debug("Waiting for runspace to become available (async)"); |
| | | 214 | | } |
| | | 215 | | |
| | | 216 | | // Use a short delay to poll for availability |
| | 4 | 217 | | await Task.Delay(50, cancellationToken).ConfigureAwait(false); |
| | | 218 | | } |
| | 5 | 219 | | } |
| | | 220 | | |
| | | 221 | | /// <summary> |
| | | 222 | | /// Returns a runspace to the pool for reuse, or disposes it if the pool has been disposed. |
| | | 223 | | /// </summary> |
| | | 224 | | /// <param name="rs">The <see cref="Runspace"/> to return to the pool.</param> |
| | | 225 | | public void Release(Runspace rs) |
| | | 226 | | { |
| | 67 | 227 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 228 | | { |
| | 61 | 229 | | Host.Logger.Debug("Release() called: Disposed={Disposed}", _disposed); |
| | | 230 | | } |
| | | 231 | | |
| | 67 | 232 | | if (_disposed) |
| | | 233 | | { |
| | 1 | 234 | | Host.Logger.Warning("Pool disposed; disposing returned runspace"); |
| | 1 | 235 | | rs.Dispose(); |
| | 1 | 236 | | return; |
| | | 237 | | } |
| | | 238 | | |
| | | 239 | | try |
| | | 240 | | { |
| | | 241 | | // Put the genie back in the bottle: variables, funcs, modules… |
| | | 242 | | // This returns the runspace to the InitialSessionState baseline. |
| | 66 | 243 | | rs.ResetRunspaceState(); |
| | 66 | 244 | | } |
| | 0 | 245 | | catch (Exception ex) |
| | | 246 | | { |
| | 0 | 247 | | Host.Logger.Warning(ex, "ResetRunspaceState failed; disposing runspace instead"); |
| | 0 | 248 | | try { rs.Close(); } |
| | 0 | 249 | | catch (Exception closeEx) { Host.Logger.Verbose(exception: closeEx, messageTemplate: "Failed to close runspa |
| | 0 | 250 | | rs.Dispose(); |
| | 0 | 251 | | _ = Interlocked.Decrement(ref _count); |
| | 0 | 252 | | return; |
| | | 253 | | } |
| | 66 | 254 | | _stash.Add(rs); |
| | 66 | 255 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 256 | | { |
| | 60 | 257 | | Host.Logger.Debug("Runspace returned to stash: StashCount={Count}", _stash.Count); |
| | | 258 | | } |
| | | 259 | | // Note: we do not decrement _count here, as the pool size is fixed. |
| | | 260 | | // The pool will keep the runspace open for reuse. |
| | 66 | 261 | | } |
| | | 262 | | |
| | | 263 | | // ───────────────── helpers ─────────────────────────────── |
| | | 264 | | /// <summary> |
| | | 265 | | /// Creates a new PowerShell runspace with the configured initial session state and thread options. |
| | | 266 | | /// </summary> |
| | | 267 | | /// <returns>A new <see cref="Runspace"/> instance.</returns> |
| | | 268 | | private Runspace CreateRunspace() |
| | | 269 | | { |
| | 176 | 270 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 271 | | { |
| | 124 | 272 | | Host.Logger.Debug("CreateRunspace() - creating new runspace"); |
| | | 273 | | } |
| | | 274 | | |
| | 176 | 275 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 276 | | { |
| | 124 | 277 | | Host.Logger.Debug("Creating new runspace with InitialSessionState"); |
| | | 278 | | } |
| | | 279 | | // Important: clone per runspace |
| | 176 | 280 | | var iss = _iss.Clone(); |
| | 176 | 281 | | var rs = RunspaceFactory.CreateRunspace(iss); |
| | | 282 | | |
| | | 283 | | // Apply the chosen thread‑affinity strategy **before** opening. |
| | 176 | 284 | | rs.ThreadOptions = ThreadOptions; |
| | 176 | 285 | | rs.ApartmentState = ApartmentState.MTA; // always MTA |
| | 176 | 286 | | rs.Open(); |
| | | 287 | | |
| | 176 | 288 | | Host.Logger.Information("Opened new Runspace with ThreadOptions={ThreadOptions}", ThreadOptions); |
| | 176 | 289 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 290 | | { |
| | 124 | 291 | | Host.Logger.Debug("New runspace created: {Runspace}", rs); |
| | | 292 | | } |
| | | 293 | | |
| | 176 | 294 | | _ = _all.TryAdd(rs, 0); |
| | 176 | 295 | | return rs; |
| | | 296 | | } |
| | | 297 | | |
| | | 298 | | // ───────────────── cleanup ─────────────────────────────── |
| | | 299 | | /// <summary> |
| | | 300 | | /// Disposes the runspace pool manager and all pooled runspaces. |
| | | 301 | | /// </summary> |
| | | 302 | | public void Dispose() |
| | | 303 | | { |
| | 109 | 304 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 305 | | { |
| | 62 | 306 | | Host.Logger.Debug("Disposing KestrunRunspacePoolManager: Disposed={Disposed}", _disposed); |
| | | 307 | | } |
| | | 308 | | |
| | 109 | 309 | | if (_disposed) |
| | | 310 | | { |
| | 20 | 311 | | return; |
| | | 312 | | } |
| | | 313 | | |
| | 89 | 314 | | if (!string.IsNullOrWhiteSpace(OpenApiClassesPath)) |
| | | 315 | | { |
| | | 316 | | try |
| | | 317 | | { |
| | 2 | 318 | | File.Delete(OpenApiClassesPath); |
| | 0 | 319 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 320 | | { |
| | 0 | 321 | | Host.Logger.Debug("Deleted temporary OpenAPI classes script: {Path}", OpenApiClassesPath); |
| | | 322 | | } |
| | 0 | 323 | | } |
| | 2 | 324 | | catch (Exception ex) |
| | | 325 | | { |
| | 2 | 326 | | Host.Logger.Warning(ex, "Failed to delete temporary OpenAPI classes script: {Path}", OpenApiClassesPath) |
| | 2 | 327 | | } |
| | | 328 | | } |
| | 89 | 329 | | _disposed = true; |
| | | 330 | | |
| | 89 | 331 | | Host.Logger.Information("Disposing RunspacePoolManager and all pooled runspaces"); |
| | | 332 | | |
| | | 333 | | // Drain the stash |
| | 193 | 334 | | while (_stash.TryTake(out var rs)) |
| | | 335 | | { |
| | 104 | 336 | | if (Host.Logger.IsEnabled(LogEventLevel.Debug)) |
| | | 337 | | { |
| | 73 | 338 | | Host.Logger.Debug("Disposing runspace: {Runspace}", rs); |
| | | 339 | | } |
| | 208 | 340 | | try { rs.ResetRunspaceState(); } catch (Exception ex) { Host.Logger.Verbose(exception: ex, messageTemplate: |
| | 208 | 341 | | try { rs.Close(); } catch (Exception ex) { Host.Logger.Verbose(exception: ex, messageTemplate: "Failed to cl |
| | 104 | 342 | | rs.Dispose(); |
| | 104 | 343 | | _ = _all.TryRemove(rs, out _); |
| | 104 | 344 | | _ = Interlocked.Decrement(ref _count); |
| | 104 | 345 | | } |
| | | 346 | | |
| | | 347 | | // Anything still checked out? Close them too. |
| | 184 | 348 | | foreach (var kv in _all.Keys) |
| | | 349 | | { |
| | 6 | 350 | | try { kv.ResetRunspaceState(); } catch (Exception ex) { Host.Logger.Verbose(exception: ex, messageTemplate: |
| | 6 | 351 | | try { kv.Close(); } catch (Exception ex) { Host.Logger.Verbose(exception: ex, messageTemplate: "Failed to cl |
| | 3 | 352 | | kv.Dispose(); |
| | 3 | 353 | | _ = _all.TryRemove(kv, out _); |
| | 3 | 354 | | _ = Interlocked.Decrement(ref _count); |
| | | 355 | | } |
| | 89 | 356 | | Host.Logger.Information("RunspacePoolManager disposed"); |
| | 89 | 357 | | } |
| | | 358 | | } |