using System.Reflection;
using System.Runtime.InteropServices;
using System.Text;
namespace WslcApiDump;
///
/// M1 spike (a), phase 1 (docs/WINDOWS_PORT.md §13): what does Microsoft.WSL.Containers
/// ACTUALLY look like, and where is WslcFacade.cs wrong?
///
/// Everything the Windows container subsystem rests on — items 5, 6 and 7 — was written against
/// documentation, on a machine with no WSL. This program is the cheapest possible way to convert
/// that pile of assumptions into a worklist, and it is written entirely in reflection so that it
/// cannot fail to build no matter how wrong the assumptions turn out to be.
///
/// It never mutates anything unless asked: the default run only reads type metadata. `--probe`
/// additionally calls the two safe statics (`GetVersion`, `GetMissingComponents`). `--session`
/// goes further and creates a real session, then a SECOND one with the same name, to settle
/// whether the compat SDK can re-adopt a running session. Answered on 2.9.4: it cannot. The
/// constructor is lazy and always succeeds; `Start()` is where the service is consulted, and it
/// refuses with `ERROR_ALREADY_EXISTS`. So reattach needs the internal COM interface, which is
/// what D13 assumes (docs/WINDOWS_PORT.md §13.1).
///
/// `--internal` then asks the question D13 itself rests on and nobody has answered: is that
/// internal interface reachable? `wslc.idl` declares no activatable class, so there is no CLSID
/// to name — see . `--internal-call` also calls through it.
///
internal static class Program
{
/// The C#/WinRT PROJECTION assembly. The NuGet package is "Microsoft.WSL.Containers" but
/// the managed assembly it ships is `lib/net8.0-windows10.0.19041.0/wslcsdkcs.dll`, so
/// loading it by package name fails — which is exactly the first thing this tool found.
private const string AssemblyName = "wslcsdkcs";
/// The API namespace. Filtering on it is not tidiness — it is correctness. A C#/WinRT
/// projection also exports `ABI.Microsoft.WSL.Containers.*` marshalling plumbing whose types
/// have the SAME short names (`Session`, `Container`, `ProcessSettings`), and `ABI.` sorts
/// first. Matching assumptions by short name therefore checked every member against the
/// marshalling struct and reported 42 false MISSINGs, with `CreateMarshaler` offered as the
/// nearest name — which is the tell.
private const string ApiNamespace = "Microsoft.WSL.Containers";
private static int Main(string[] args)
{
var probe = args.Contains("--probe") || args.Contains("--session");
var session = args.Contains("--session");
var outPath = ArgValue(args, "--out") ?? "wslc-api-dump.txt";
Assembly assembly;
try
{
assembly = Assembly.Load(new AssemblyName(AssemblyName));
}
catch (Exception e)
{
Console.Error.WriteLine($"could not load {AssemblyName}: {e.Message}");
Console.Error.WriteLine(
"Is the preview NuGet restored? `dotnet restore windows/spikes/WslcApiDump`.");
return 2;
}
var exported = assembly.GetExportedTypes().OrderBy(t => t.FullName, StringComparer.Ordinal).ToArray();
var types = exported.Where(t => t.Namespace == ApiNamespace).ToArray();
Console.WriteLine(
$"{AssemblyName} {assembly.GetName().Version} — {types.Length} types in {ApiNamespace} "
+ $"({exported.Length - types.Length} more are ABI/marshalling plumbing)");
Console.WriteLine();
var report = new StringBuilder();
report.AppendLine($"# {AssemblyName} {assembly.GetName().Version}");
report.AppendLine($"# location: {assembly.Location}");
report.AppendLine();
// The dump defaults to the API namespace for the same reason the checks do; `--all-types`
// includes the ABI plumbing for when the projection itself is what's being debugged.
foreach (var type in args.Contains("--all-types") ? exported : types) DescribeType(type, report);
File.WriteAllText(outPath, report.ToString());
Console.WriteLine($"full API dump → {Path.GetFullPath(outPath)}");
Console.WriteLine();
var missing = CheckAssumptions(types);
// Components are probed BEFORE anything else that touches the service, because that one
// call explains every other failure: nothing installed answers REGDB_E_CLASSNOTREG
// (0x80040154), while an installed-but-too-old WSL answers ERROR_NOT_SUPPORTED
// (0x80070032). Reporting those as unexplained COM errors buries the actual finding.
var componentsMissing = probe ? ProbeStatics(types) : null;
if (session)
{
if (componentsMissing is { Count: > 0 })
{
Console.WriteLine();
Console.WriteLine("skipping --session: the components above are missing, so creating "
+ "a session would only fail the same way. Fix those first.");
}
else
{
ProbeSession(
types, ArgValue(args, "--session-name") ?? "nucleic-spike",
keep: args.Contains("--keep"));
}
}
// Independent of the compat-surface checks above: this asks whether the SERVICE-INTERNAL
// interface can be reached at all, which is what D13's enumeration/reattach/pty arm
// hangs on (docs/WINDOWS_PORT.md §13.2).
if (args.Contains("--internal") || args.Contains("--internal-call"))
InternalComProbe.Run(callThrough: args.Contains("--internal-call"));
Console.WriteLine();
if (componentsMissing is { Count: > 0 })
{
Console.WriteLine($"RESULT: this machine cannot run wslc yet — missing "
+ $"{string.Join(", ", componentsMissing)}.");
foreach (var component in componentsMissing)
Console.WriteLine($" {component}: {Remedy(component)}");
Console.WriteLine(" Then run this again. This is the §8 onboarding condition, "
+ "not a defect.");
}
else if (missing == 0)
{
Console.WriteLine("RESULT: every WslcFacade assumption is present — the package matches "
+ "the surface recorded in docs/WINDOWS_PORT.md §13.1.");
}
else
{
Console.WriteLine($"RESULT: {missing} assumption(s) wrong. The recorded surface is 2.9.3, "
+ "so this means the package MOVED: reconcile §13.1, then fix "
+ "windows/NucleicBroker/Wslc/WslcFacade.cs — and nowhere else (that is what IWslc "
+ "is for).");
}
// Exit 0 either way: a mismatch is this tool's PRODUCT, not its failure. Only a genuinely
// broken run (assembly missing) is non-zero, so a wrapper script can tell them apart.
return 0;
}
// MARK: - Type dump
private static void DescribeType(Type type, StringBuilder report)
{
var kind = type.IsEnum ? "enum"
: type.IsInterface ? "interface"
: type.IsValueType ? "struct"
: "class";
report.AppendLine($"{kind} {type.FullName}"
+ (type.BaseType is { } b && b != typeof(object) ? $" : {b.Name}" : ""));
if (type.IsEnum)
{
foreach (var name in Enum.GetNames(type)) report.AppendLine($" .{name}");
report.AppendLine();
return;
}
// Every member walk is guarded. These are WinRT projection types: a signature can name a
// type from an assembly that is present at build time and not at runtime, and one such
// member must not cost us the other 60 types' worth of report.
Guarded(report, () => {
foreach (var ctor in type.GetConstructors())
report.AppendLine($" .ctor({Parameters(ctor)})");
});
Guarded(report, () => {
foreach (var property in type.GetProperties(Public).OrderBy(p => p.Name, StringComparer.Ordinal))
report.AppendLine(
$" {Short(property.PropertyType)} {property.Name} "
+ $"{{ {(property.CanRead ? "get; " : "")}{(property.CanWrite ? "set; " : "")}}}");
});
Guarded(report, () => {
foreach (var evt in type.GetEvents(Public).OrderBy(e => e.Name, StringComparer.Ordinal))
report.AppendLine($" event {Short(evt.EventHandlerType)} {evt.Name}");
});
Guarded(report, () => {
foreach (var method in type.GetMethods(Public)
.Where(m => !m.IsSpecialName)
.OrderBy(m => m.Name, StringComparer.Ordinal))
report.AppendLine($" {Short(method.ReturnType)} {method.Name}({Parameters(method)})");
});
report.AppendLine();
}
private static void Guarded(StringBuilder report, Action body)
{
try { body(); }
catch (Exception e) { report.AppendLine($" "); }
}
private const BindingFlags Public =
BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static | BindingFlags.DeclaredOnly;
private static string Parameters(MethodBase m) =>
string.Join(", ", m.GetParameters().Select(p => $"{Short(p.ParameterType)} {p.Name}"));
private static string Short(Type? t)
{
if (t is null) return "void";
if (!t.IsGenericType) return t.Name;
var tick = t.Name.IndexOf('`');
var name = tick < 0 ? t.Name : t.Name[..tick];
return $"{name}<{string.Join(", ", t.GetGenericArguments().Select(Short))}>";
}
// MARK: - Assumption check (the actual product)
private static int CheckAssumptions(Type[] types)
{
Console.WriteLine("WslcFacade.cs assumptions:");
Console.WriteLine();
var wrong = 0;
foreach (var group in FacadeAssumptions.All.GroupBy(a => a.Type))
{
var type = types.FirstOrDefault(t => t.Name == group.Key);
if (type is null)
{
// Summarise rather than repeat: if a whole type is renamed or namespaced away,
// one line naming it beats a paragraph per member. The per-member "why" only
// earns its space when the type exists and a single member is wrong.
wrong += group.Count();
Console.WriteLine($" MISSING TYPE {group.Key} "
+ $"({group.Count()} member(s): {string.Join(", ", group.Select(a => a.Member))})");
var near = Nearest(group.Key, types.Select(t => t.Name));
Console.WriteLine(near.Length > 0
? $" nearest types: {string.Join(", ", near)}"
: " no similarly-named type — check the dump file's namespaces");
continue;
}
foreach (var assumption in group)
{
if (assumption.MemberKind is FacadeAssumptions.Kind.Type || Has(type, assumption))
{
Console.WriteLine($" ok {type.Name}.{assumption.Member}");
continue;
}
wrong++;
Console.WriteLine($" MISSING {type.Name}.{assumption.Member} "
+ $"({assumption.MemberKind.ToString().ToLowerInvariant()})");
foreach (var line in Wrap(assumption.Why, 94))
Console.WriteLine($" {line}");
var near = Nearest(assumption.Member, MemberNames(type));
if (near.Length > 0)
Console.WriteLine($" nearest: {string.Join(", ", near)}");
}
}
return wrong;
}
private static bool Has(Type type, FacadeAssumptions.Assumption a) => a.MemberKind switch
{
FacadeAssumptions.Kind.Constructor => type.GetConstructors().Length > 0,
FacadeAssumptions.Kind.EnumValue => type.IsEnum && Enum.GetNames(type).Contains(a.Member),
FacadeAssumptions.Kind.Event => type.GetEvent(a.Member) is not null,
FacadeAssumptions.Kind.Property =>
type.GetProperty(a.Member) is not null || type.GetField(a.Member) is not null,
FacadeAssumptions.Kind.Method => type.GetMethods(Public).Any(m => m.Name == a.Member),
_ => true,
};
private static IEnumerable MemberNames(Type type) =>
type.IsEnum
? Enum.GetNames(type)
: type.GetMembers(Public).Where(m => !m.Name.StartsWith('.')).Select(m => m.Name).Distinct();
/// Cheap "did they just rename it" hint: shared prefix or containment, no edit
/// distance. A three-name shortlist is enough to spot HostGateway vs
/// HostGatewayAddress, which is the realistic failure mode.
/// Hard-wrap so a long rationale can't be mangled into an unreadable fragment by the
/// console. First line is prefixed "why:", continuations are indented under it.
private static IEnumerable Wrap(string text, int width)
{
var words = text.Split(' ', StringSplitOptions.RemoveEmptyEntries);
var line = new StringBuilder("why: ");
var any = false;
foreach (var word in words)
{
if (line.Length + word.Length + 1 > width && any)
{
yield return line.ToString();
line = new StringBuilder(" ");
any = false;
}
if (any) line.Append(' ');
line.Append(word);
any = true;
}
if (any) yield return line.ToString();
}
private static string[] Nearest(string wanted, IEnumerable candidates)
{
var needle = wanted.TrimStart('.');
if (needle.Length == 0) return [];
return candidates
.Where(c => c.Contains(needle, StringComparison.OrdinalIgnoreCase)
|| needle.Contains(c, StringComparison.OrdinalIgnoreCase)
|| SharedPrefix(c, needle) >= 4)
.Distinct()
.Take(3)
.ToArray();
}
private static int SharedPrefix(string a, string b)
{
var n = 0;
while (n < a.Length && n < b.Length && char.ToLowerInvariant(a[n]) == char.ToLowerInvariant(b[n])) n++;
return n;
}
// MARK: - Live probes
/// The two service statics, which only read state and are safe on any machine.
///
/// Names come from the real 2.9.3 surface (`GetVersion`, `GetMissingComponents`) — the
/// documented `GetServiceVersion`/`ComponentFlags` shapes in Microsoft Learn's sample are
/// stale against the shipped package (docs/WINDOWS_PORT.md §13.1).
private static IReadOnlyList? ProbeStatics(Type[] types)
{
Console.WriteLine();
Console.WriteLine("live probe (read-only):");
var service = types.FirstOrDefault(t => t.Name == "WslcService");
if (service is null) { Console.WriteLine(" no WslcService type — skipping"); return null; }
List? componentsMissing = null;
// GetMissingComponents first: it answers from OS feature state and works even when the
// service class isn't registered, so it is the call that EXPLAINS the others.
foreach (var name in new[] { "GetMissingComponents", "GetVersion" })
{
var method = service.GetMethods(Public)
.FirstOrDefault(m => m.IsStatic && m.Name == name && m.GetParameters().Length == 0);
if (method is null)
{
var any = service.GetMethods(Public).Any(m => m.Name == name);
Console.WriteLine($" {name}: {(any ? "present but not static — see the dump" : "absent")}");
continue;
}
try
{
var value = method.Invoke(null, null);
Console.WriteLine($" {name}() = {Render(value)}");
if (name == "GetMissingComponents" && value is System.Collections.IEnumerable list)
{
componentsMissing = list.Cast