Merge pull request #76 from AlexsanderHamir/refactors

Refactors

Author: AlexsanderHamir

cli/helpers.go

@@ -13,6 +13,7 @@ import (
 	"github.com/AlexsanderHamir/prof/engine/collector"
 
 	"github.com/AlexsanderHamir/prof/engine/tools/benchstats"
+	"github.com/AlexsanderHamir/prof/engine/tools/qcachegrind"
 	"github.com/AlexsanderHamir/prof/engine/tracker"
 	"github.com/AlexsanderHamir/prof/internal"
 	"github.com/spf13/cobra"
@@ -40,8 +41,10 @@ const (
 	minTagsForComparison = 2
 
 	// 3 occurrences requires a const
-	base    = "base"
-	current = "current"
+	baseTagFlag    = "base"
+	currentTagFlag = "current"
+	benchNameFlag  = "bench-name"
+	tagFlag        = "tag"
 )
 
 // CreateRootCmd creates and returns the root cobra command.
@@ -69,30 +72,53 @@ func createToolsCmd() *cobra.Command {
 	}
 
 	cmd.AddCommand(createBenchStatCmd())
+	cmd.AddCommand(createQCacheGrindCmd())
+
+	return cmd
+}
+
+func createQCacheGrindCmd() *cobra.Command {
+	profilesFlag := "profiles"
+	shortExplanation := "runs benchstat on txt collected data."
+
+	cmd := &cobra.Command{
+		Use:     "qcachegrind",
+		Short:   shortExplanation,
+		Example: "prof  tools qcachegrind --tag `current` --profiles `cpu` --bench-name `BenchmarkGenPool`",
+		RunE: func(_ *cobra.Command, _ []string) error {
+			return qcachegrind.RunQcacheGrind(tag, benchmarkName, profiles[0])
+		},
+	}
+
+	cmd.Flags().StringVar(&benchmarkName, benchNameFlag, "", "Name of the benchmark")
+	cmd.Flags().StringSliceVar(&profiles, profilesFlag, []string{}, `Profiles to use (e.g., "cpu,memory,mutex")`)
+	cmd.Flags().StringVar(&tag, tagFlag, "", "The tag is used to organize the results")
+
+	_ = cmd.MarkFlagRequired(benchNameFlag)
+	_ = cmd.MarkFlagRequired(profilesFlag)
+	_ = cmd.MarkFlagRequired(tagFlag)
 
 	return cmd
 }
 
 func createBenchStatCmd() *cobra.Command {
-	baseTagFlag := base
-	currentFlag := current
-	benchNameFlag := "bench-name"
 	shortExplanation := "runs benchstat on txt collected data."
 
 	cmd := &cobra.Command{
-		Use:   "benchstat",
-		Short: shortExplanation,
+		Use:     "benchstat",
+		Short:   shortExplanation,
+		Example: "prof tools benchstat --base `baseline` --current `current` --bench-name `BenchmarkGenPool`",
 		RunE: func(_ *cobra.Command, _ []string) error {
 			return benchstats.RunBenchStats(Baseline, Current, benchmarkName)
 		},
 	}
 
 	cmd.Flags().StringVar(&Baseline, baseTagFlag, "", "Name of the baseline tag")
-	cmd.Flags().StringVar(&Current, currentFlag, "", "Name of the current tag")
+	cmd.Flags().StringVar(&Current, currentTagFlag, "", "Name of the current tag")
 	cmd.Flags().StringVar(&benchmarkName, benchNameFlag, "", "Name of the benchmark")
 
 	_ = cmd.MarkFlagRequired(baseTagFlag)
-	_ = cmd.MarkFlagRequired(currentFlag)
+	_ = cmd.MarkFlagRequired(currentTagFlag)
 	_ = cmd.MarkFlagRequired(benchNameFlag)
 
 	return cmd
@@ -109,7 +135,6 @@ func createProfManual() *cobra.Command {
 		},
 	}
 
-	tagFlag := "tag"
 	manualCmd.Flags().StringVar(&tag, tagFlag, "", "The tag is used to organize the results")
 	_ = manualCmd.MarkFlagRequired(tagFlag)
 
@@ -119,7 +144,6 @@ func createProfManual() *cobra.Command {
 func createProfAuto() *cobra.Command {
 	benchFlag := "benchmarks"
 	profileFlag := "profiles"
-	tagFlag := "tag"
 	countFlag := "count"
 	example := fmt.Sprintf(`prof %s --%s "BenchmarkGenPool" --%s "cpu,memory" --%s 10 --%s "tag1"`, internal.AUTOCMD, benchFlag, profileFlag, countFlag, tagFlag)
 
@@ -159,14 +183,11 @@ func createTrackCmd() *cobra.Command {
 }
 
 func createTrackAutoCmd() *cobra.Command {
-	baseTagFlag := "base"
-	currentFlag := "current"
-	benchNameFlag := "bench-name"
 	profileTypeFlag := "profile-type"
 	outputFormatFlag := "output-format"
 	failFlag := "fail-on-regression"
 	thresholdFlag := "regression-threshold"
-	example := fmt.Sprintf(`prof track auto --%s "tag1" --%s "tag2" --%s "cpu" --%s "BenchmarkGenPool" --%s "summary"`, baseTagFlag, currentFlag, profileTypeFlag, benchNameFlag, outputFormatFlag)
+	example := fmt.Sprintf(`prof track auto --%s "tag1" --%s "tag2" --%s "cpu" --%s "BenchmarkGenPool" --%s "summary"`, baseTagFlag, currentTagFlag, profileTypeFlag, benchNameFlag, outputFormatFlag)
 	longExplanation := fmt.Sprintf("This command only works if the %s command was used to collect and organize the benchmark and profile data, as it expects a specific directory structure generated by that process.", internal.AUTOCMD)
 	shortExplanation := "If prof auto was used to collect the data, track auto can be used to analyze it, you just have to pass the tag name."
 
@@ -190,28 +211,26 @@ func createTrackAutoCmd() *cobra.Command {
 	}
 
 	cmd.Flags().StringVar(&Baseline, baseTagFlag, "", "Name of the baseline tag")
-	cmd.Flags().StringVar(&Current, currentFlag, "", "Name of the current tag")
+	cmd.Flags().StringVar(&Current, currentTagFlag, "", "Name of the current tag")
 	cmd.Flags().StringVar(&benchmarkName, benchNameFlag, "", "Name of the benchmark")
 	cmd.Flags().StringVar(&profileType, profileTypeFlag, "", "Profile type (cpu, memory, mutex, block)")
 	cmd.Flags().StringVar(&outputFormat, outputFormatFlag, "detailed", `Output format: "summary" or "detailed"`)
 	cmd.Flags().BoolVar(&failOnRegression, failFlag, false, "Exit with non-zero code if regression exceeds threshold")
 	cmd.Flags().Float64Var(&regressionThreshold, thresholdFlag, 0.0, "Fail when worst flat regression exceeds this percent (e.g., 5.0)")
 
 	_ = cmd.MarkFlagRequired(baseTagFlag)
-	_ = cmd.MarkFlagRequired(currentFlag)
+	_ = cmd.MarkFlagRequired(currentTagFlag)
 	_ = cmd.MarkFlagRequired(benchNameFlag)
 	_ = cmd.MarkFlagRequired(profileTypeFlag)
 
 	return cmd
 }
 
 func createTrackManualCmd() *cobra.Command {
-	baseFlag := "base"
-	currentFlag := "current"
 	outputFormatFlag := "output-format"
 	failFlag := "fail-on-regression"
 	thresholdFlag := "regression-threshold"
-	example := fmt.Sprintf(`prof track %s --%s "path/to/profile_file.txt" --%s  "path/to/profile_file.txt"  --%s "summary"`, internal.TrackManualCMD, baseFlag, currentFlag, outputFormatFlag)
+	example := fmt.Sprintf(`prof track %s --%s "path/to/profile_file.txt" --%s  "path/to/profile_file.txt"  --%s "summary"`, internal.TrackManualCMD, baseTagFlag, currentTagFlag, outputFormatFlag)
 
 	cmd := &cobra.Command{
 		Use:   internal.TrackManualCMD,
@@ -232,14 +251,14 @@ func createTrackManualCmd() *cobra.Command {
 		Example: example,
 	}
 
-	cmd.Flags().StringVar(&Baseline, baseFlag, "", "Name of the baseline tag")
-	cmd.Flags().StringVar(&Current, currentFlag, "", "Name of the current tag")
+	cmd.Flags().StringVar(&Baseline, baseTagFlag, "", "Name of the baseline tag")
+	cmd.Flags().StringVar(&Current, currentTagFlag, "", "Name of the current tag")
 	cmd.Flags().StringVar(&outputFormat, outputFormatFlag, "", "Output format choice choice")
 	cmd.Flags().BoolVar(&failOnRegression, failFlag, false, "Exit with non-zero code if regression exceeds threshold")
 	cmd.Flags().Float64Var(&regressionThreshold, thresholdFlag, 0.0, "Fail when worst flat regression exceeds this percent (e.g., 5.0)")
 
-	_ = cmd.MarkFlagRequired(baseFlag)
-	_ = cmd.MarkFlagRequired(currentFlag)
+	_ = cmd.MarkFlagRequired(baseTagFlag)
+	_ = cmd.MarkFlagRequired(currentTagFlag)
 	_ = cmd.MarkFlagRequired(outputFormatFlag)
 
 	return cmd

engine/tools/benchstats/helpers.go

@@ -0,0 +1,75 @@
+package qcachegrind
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+
+	"github.com/AlexsanderHamir/prof/internal"
+)
+
+// go tool pprof -callgrind {benchmarkName}_{profileName}.out > {benchmarkName}_{profileName}.callgrind
+// qcachegrind profile.callgrind
+
+func RunQcacheGrind(tag, benchName, profileName string) error {
+	// 1. find the binary file given the parameters of the function, it will be located under bench/tag/bin/benchName/{benchmarkName}_{profileName}.out
+	binaryFilePath := filepath.Join(internal.MainDirOutput, tag, internal.ProfileBinDir, benchName, fmt.Sprintf("%s_%s.out", benchName, profileName))
+
+	if _, err := os.Stat(binaryFilePath); os.IsNotExist(err) {
+		return fmt.Errorf("binary file not found: %s", binaryFilePath)
+	}
+
+	// 2. Create a callgrind file out of the binary by running the following command (EXAMPLE):
+	// 	   a. go tool pprof -callgrind {benchmarkName}_{profileName}.out > {benchmarkName}_{profileName}.callgrind
+	//     b. save the command under tools/qcachegrind/{benchmarkName}_results.callgrind
+
+	// Create the output directory for qcachegrind results
+	outputDir := filepath.Join(internal.MainDirOutput, internal.ToolDir, "qcachegrind")
+	if err := os.MkdirAll(outputDir, internal.PermDir); err != nil {
+		return fmt.Errorf("failed to create output directory: %w", err)
+	}
+
+	// Generate the callgrind file
+	callgrindOutputPath := filepath.Join(outputDir, fmt.Sprintf("%s_%s.callgrind", benchName, profileName))
+
+	cmd := exec.Command("go", "tool", "pprof", "-callgrind", binaryFilePath)
+	outputFile, err := os.Create(callgrindOutputPath)
+	if err != nil {
+		return fmt.Errorf("failed to create callgrind output file: %w", err)
+	}
+	defer outputFile.Close()
+
+	cmd.Stdout = outputFile
+	cmd.Stderr = os.Stderr
+
+	if err = cmd.Run(); err != nil {
+		return fmt.Errorf("failed to generate callgrind file: %w", err)
+	}
+
+	fmt.Printf("Generated callgrind file: %s\n", callgrindOutputPath)
+
+	// 3. Use the output to call qcachegrind profile.callgrind and launch it for the user to analyze.
+
+	// Check if qcachegrind is installed
+	if _, err = exec.LookPath("qcachegrind"); err != nil {
+		return errors.New("qcachegrind command not found. Please install it first: sudo apt-get install qcachegrind (Ubuntu/Debian) or brew install qcachegrind (macOS)")
+	}
+
+	// Launch qcachegrind with the generated callgrind file
+	launchCmd := exec.Command("qcachegrind", callgrindOutputPath)
+	launchCmd.Stdout = os.Stdout
+	launchCmd.Stderr = os.Stderr
+
+	fmt.Printf("Launching qcachegrind with file: %s\n", callgrindOutputPath)
+
+	// Run qcachegrind in the background so the user can interact with it
+	if err = launchCmd.Start(); err != nil {
+		return fmt.Errorf("failed to launch qcachegrind: %w", err)
+	}
+
+	fmt.Println("qcachegrind launched successfully. You can now analyze the profile data.")
+
+	return nil
+}