// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. using System; using System.CommandLine; using System.IO; using System.Threading; using System.Threading.Tasks; using Graphs; using Microsoft.Diagnostics.NETCore.Client; using Microsoft.Internal.Common; using Microsoft.Internal.Common.Utils; namespace Microsoft.Diagnostics.Tools.GCDump { internal static class CollectCommandHandler { /// /// Collects a gcdump from a currently running process. /// /// The cancellation token /// /// The process to collect the gcdump from. /// The output path for the collected gcdump. /// The timeout for the collected gcdump. /// Enable verbose logging. /// The process name to collect the gcdump from. /// The diagnostic IPC channel to collect the gcdump from. /// The dsrouter command to use for collecting the gcdump. /// private static async Task Collect(CancellationToken ct, int processId, string output, int timeout, bool verbose, string name, string diagnosticPort, string dsrouter) { try { CommandUtils.ResolveProcessForAttach(processId, name, diagnosticPort, dsrouter, out int resolvedProcessId); processId = resolvedProcessId; if (!string.IsNullOrEmpty(diagnosticPort)) { IpcEndpointConfig config = IpcEndpointConfig.Parse(diagnosticPort); if (!config.IsConnectConfig) { Console.Error.WriteLine("--diagnostic-port is only supporting connect mode."); return -1; } processId = 0; } output = string.IsNullOrEmpty(output) ? $"{DateTime.Now:yyyyMMdd\\_HHmmss}_{processId}.gcdump" : output; FileInfo outputFileInfo = new(output); if (outputFileInfo.Exists) { outputFileInfo.Delete(); } if (string.IsNullOrEmpty(outputFileInfo.Extension) || outputFileInfo.Extension != ".gcdump") { outputFileInfo = new FileInfo(outputFileInfo.FullName + ".gcdump"); } Console.Out.WriteLine($"Writing gcdump to '{outputFileInfo.FullName}'..."); Task dumpTask = Task.Run(() => { if (TryCollectMemoryGraph(ct, processId, diagnosticPort, timeout, verbose, out MemoryGraph memoryGraph)) { GCHeapDump.WriteMemoryGraph(memoryGraph, outputFileInfo.FullName, "dotnet-gcdump"); return true; } return false; }); bool fDumpSuccess = await dumpTask.ConfigureAwait(false); if (fDumpSuccess) { outputFileInfo.Refresh(); Console.Out.WriteLine($"\tFinished writing {outputFileInfo.Length} bytes."); return 0; } else if (ct.IsCancellationRequested) { Console.Out.WriteLine("\tCancelled."); return -1; } else { Console.Out.WriteLine("\tFailed to collect gcdump. Try running with '-v' for more information."); return -1; } } catch (DiagnosticToolException dte) { Console.Error.WriteLine($"[ERROR] {dte.Message}"); return -1; } catch (FormatException fe) { Console.Error.WriteLine($"--diagnostic-port argument error: {fe.Message}"); return -1; } catch (Exception ex) { Console.Error.WriteLine($"[ERROR] {ex}"); return -1; } finally { DsRouterProcessLauncher.Launcher.Cleanup(); } } internal static bool TryCollectMemoryGraph(CancellationToken ct, int processId, string diagnosticPort, int timeout, bool verbose, out MemoryGraph memoryGraph) { DotNetHeapInfo heapInfo = new(); TextWriter log = verbose ? Console.Out : TextWriter.Null; memoryGraph = new MemoryGraph(50_000); if (!EventPipeDotNetHeapDumper.DumpFromEventPipe(ct, processId, diagnosticPort, memoryGraph, log, timeout, heapInfo)) { return false; } memoryGraph.AllowReading(); return true; } public static Command CollectCommand() { Command collectCommand = new( name: "collect", description: "Collects a diagnostic trace from a currently running process") { ProcessIdOption, OutputPathOption, VerboseOption, TimeoutOption, NameOption, DiagnosticPortOption, DsRouterOption }; collectCommand.SetAction(static (parseResult, ct) => Collect(ct, processId: parseResult.GetValue(ProcessIdOption), output: parseResult.GetValue(OutputPathOption) ?? string.Empty, timeout: parseResult.GetValue(TimeoutOption), verbose: parseResult.GetValue(VerboseOption), name: parseResult.GetValue(NameOption), diagnosticPort: parseResult.GetValue(DiagnosticPortOption) ?? string.Empty, dsrouter: parseResult.GetValue(DsRouterOption) ?? string.Empty)); return collectCommand; } private static readonly Option ProcessIdOption = new("--process-id", "-p") { Description = "The process id to collect the gcdump from." }; private static readonly Option NameOption = new("--name", "-n") { Description = "The name of the process to collect the gcdump from." }; private static readonly Option OutputPathOption = new("--output", "-o") { Description = @"The path where collected gcdumps should be written. Defaults to '.\YYYYMMDD_HHMMSS_.gcdump' where YYYYMMDD is Year/Month/Day and HHMMSS is Hour/Minute/Second. Otherwise, it is the full path and file name of the dump." }; private static readonly Option VerboseOption = new("--verbose", "-v") { Description = "Output the log while collecting the gcdump." }; public static int DefaultTimeout = 30; private static readonly Option TimeoutOption = new("--timeout", "-t") { Description = $"Give up on collecting the gcdump if it takes longer than this many seconds. The default value is {DefaultTimeout}s.", DefaultValueFactory = _ => DefaultTimeout, }; private static readonly Option DiagnosticPortOption = new("--diagnostic-port", "--dport") { Description = "The path to a diagnostic port to collect the dump from." }; private static readonly Option DsRouterOption = new("--dsrouter") { Description = "The dsrouter command to use for collecting the gcdump. If specified, the --process-id, --name, or --diagnostic-port options cannot be used." }; } }