ConvertCommandHandler.cs

// 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.Tasks;
using Graphs;
using Microsoft.Internal.Common;

namespace Microsoft.Diagnostics.Tools.GCDump
{
    internal static class ConvertCommandHandler
    {
        public static int ConvertFile(FileInfo input, string output, bool verbose)
        {
            if (!input.Exists)
            {
                Console.Error.WriteLine($"File '{input.FullName}' does not exist.");
                return -1;
            }

            output = string.IsNullOrEmpty(output)
                    ? Path.ChangeExtension(input.FullName, "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}'...");

            DotNetHeapInfo heapInfo = new();
            TextWriter log = verbose ? Console.Out : TextWriter.Null;

            MemoryGraph memoryGraph = new(50_000);

            if (!EventPipeDotNetHeapDumper.DumpFromEventPipeFile(input.FullName, memoryGraph, log, heapInfo))
            {
                Console.Error.WriteLine($"Failed to convert '{input.FullName}' to gcdump. The input file may not be a valid nettrace file, or it may not contain GC heap events. Try running with '-v' for more information.");
                return -1;
            }

            try
            {
                memoryGraph.AllowReading();
            }
            catch (ApplicationException ex)
            {
                Console.Error.WriteLine($"Failed to convert '{input.FullName}': {ex.Message} The nettrace file may not contain a complete GC heap dump. Try running with '-v' for more information.");
                return -1;
            }

            GCHeapDump.WriteMemoryGraph(memoryGraph, outputFileInfo.FullName, "dotnet-gcdump");

            return 0;
        }

        public static Command ConvertCommand()
        {
            Command convertCommand = new(
                name: "convert",
                description: "Converts nettrace file into .gcdump file handled by analysis tools. Can only convert from the nettrace format.")
            {
                InputPathArgument,
                OutputPathOption,
                VerboseOption
            };

            convertCommand.SetAction((parseResult, ct) => Task.FromResult(ConvertFile(
                input: parseResult.GetValue(InputPathArgument),
                output: parseResult.GetValue(OutputPathOption) ?? string.Empty,
                verbose: parseResult.GetValue(VerboseOption))));

            return convertCommand;
        }

        private static readonly Argument<FileInfo> InputPathArgument =
            new Argument<FileInfo>("input")
            {
                Description = "Input trace file to be converted.",
                Arity = new ArgumentArity(0, 1)
            }.AcceptExistingOnly();

        private static readonly Option<string> OutputPathOption =
            new("--output", "-o")
            {
                Description = "The path where converted gcdump should be written. Defaults to '<input>.gcdump'",
            };

        private static readonly Option<bool> VerboseOption =
            new("--verbose", "-v")
            {
                Description = "Output the log while converting the gcdump."
            };
    }
}