Add --pids and --max-depth to flame command and use Go implementation of stackcollapse-perf to eliminate Perl dependency

Makefile

@@ -58,6 +58,7 @@ endif
 test:
 	@echo "Running unit tests..."
 	go test -v ./...
+	cd tools/stackcollapse-perf && go test -v ./...
 
 .PHONY: update-deps
 update-deps:
@@ -103,6 +104,25 @@ check_lint:
 	go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
 	golangci-lint run
 
+.PHONY: check_vuln
+check_vuln:
+	@echo "Running govulncheck to check for vulnerabilities..."
+	go install golang.org/x/vuln/cmd/govulncheck@latest
+	govulncheck ./...
+
+.PHONY: check_sec
+check_sec:
+	@echo "Running gosec to check for security issues..."
+	go install github.com/securego/gosec/v2/cmd/gosec@latest
+	gosec ./...
+
+.PHONY: check_semgrep
+check_semgrep:
+	@echo "Running semgrep to check for security issues..."
+	@echo "Please install semgrep from https://semgrep.dev/docs/getting-started/installation/ if not already installed."
+	@echo "Running semgrep..."
+	semgrep scan
+
 .PHONY: check_modernize
 check_modernize:
 	@echo "Running go-modernize to check for modernization opportunities..."
@@ -114,7 +134,7 @@ modernize:
 	go run golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@latest -fix -test ./...
 
 .PHONY: check
-check: check_format check_vet check_static check_license check_lint check_modernize
+check: check_format check_vet check_static check_license check_lint check_vuln check_modernize
 
 .PHONY: sweep
 sweep:

THIRD_PARTY_PROGRAMS

@@ -567,29 +567,6 @@ NO WARRANTY
 
 END OF TERMS AND CONDITIONS
 -------------------------------------------------------------
-stackcollapse-perf.pl
-# Copyright 2012 Joyent, Inc.  All rights reserved.
-# Copyright 2012 Brendan Gregg.  All rights reserved.
-#
-# CDDL HEADER START
-#
-# The contents of this file are subject to the terms of the
-# Common Development and Distribution License (the "License").
-# You may not use this file except in compliance with the License.
-#
-# You can obtain a copy of the license at docs/cddl1.txt or
-# http://opensource.org/licenses/CDDL-1.0.
-# See the License for the specific language governing permissions
-# and limitations under the License.
-#
-# When distributing Covered Code, include this CDDL HEADER in each
-# file and include the License file at docs/cddl1.txt.
-# If applicable, add the following below this CDDL HEADER, with the
-# fields enclosed by brackets "[]" replaced with your own identifying
-# information: Portions Copyright [yyyy] [name of copyright owner]
-#
-# CDDL HEADER END
--------------------------------------------------------------
 stress-ng
 Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

cmd/flame/flame.go

@@ -9,6 +9,7 @@ import (
 	"os"
 	"perfspect/internal/common"
 	"perfspect/internal/report"
+	"perfspect/internal/util"
 	"slices"
 	"strconv"
 	"strings"
@@ -40,24 +41,27 @@ var Cmd = &cobra.Command{
 var (
 	flagDuration        int
 	flagFrequency       int
-	flagPid             int
+	flagPids            []int
 	flagNoSystemSummary bool
+	flagMaxDepth        int
 )
 
 const (
 	flagDurationName        = "duration"
 	flagFrequencyName       = "frequency"
-	flagPidName             = "pid"
+	flagPidsName            = "pids"
 	flagNoSystemSummaryName = "no-summary"
+	flagMaxDepthName        = "max-depth"
 )
 
 func init() {
 	Cmd.Flags().StringVar(&common.FlagInput, common.FlagInputName, "", "")
 	Cmd.Flags().StringSliceVar(&common.FlagFormat, common.FlagFormatName, []string{report.FormatAll}, "")
 	Cmd.Flags().IntVar(&flagDuration, flagDurationName, 30, "")
 	Cmd.Flags().IntVar(&flagFrequency, flagFrequencyName, 11, "")
-	Cmd.Flags().IntVar(&flagPid, flagPidName, 0, "")
+	Cmd.Flags().IntSliceVar(&flagPids, flagPidsName, nil, "")
 	Cmd.Flags().BoolVar(&flagNoSystemSummary, flagNoSystemSummaryName, false, "")
+	Cmd.Flags().IntVar(&flagMaxDepth, flagMaxDepthName, 0, "")
 
 	common.AddTargetFlags(Cmd)
 
@@ -101,13 +105,17 @@ func getFlagGroups() []common.FlagGroup {
 			Help: "number of samples taken per second",
 		},
 		{
-			Name: flagPidName,
-			Help: "pid to collect data from. If not specified, all pids will be collected",
+			Name: flagPidsName,
+			Help: "comma separated list of PIDs. If not specified, all PIDs will be collected",
 		},
 		{
 			Name: common.FlagFormatName,
 			Help: fmt.Sprintf("choose output format(s) from: %s", strings.Join(append([]string{report.FormatAll}, report.FormatHtml, report.FormatTxt, report.FormatJson), ", ")),
 		},
+		{
+			Name: flagMaxDepthName,
+			Help: "maximum render depth of call stack in flamegraph (0 = no limit)",
+		},
 		{
 			Name: flagNoSystemSummaryName,
 			Help: "do not include system summary table in report",
@@ -159,8 +167,15 @@ func validateFlags(cmd *cobra.Command, args []string) error {
 		fmt.Fprintf(os.Stderr, "Error: %v\n", err)
 		return err
 	}
-	if flagPid < 0 {
-		err := fmt.Errorf("pid must be greater than or equal to 0")
+	for _, pid := range flagPids {
+		if pid < 0 {
+			err := fmt.Errorf("PID must be greater than or equal to 0")
+			fmt.Fprintf(os.Stderr, "Error: %v\n", err)
+			return err
+		}
+	}
+	if flagMaxDepth < 0 {
+		err := fmt.Errorf("max depth must be greater than or equal to 0")
 		fmt.Fprintf(os.Stderr, "Error: %v\n", err)
 		return err
 	}
@@ -177,14 +192,15 @@ func runCmd(cmd *cobra.Command, args []string) error {
 	if !flagNoSystemSummary {
 		tableNames = append(tableNames, report.BriefSysSummaryTableName)
 	}
-	tableNames = append(tableNames, report.CodePathFrequencyTableName)
+	tableNames = append(tableNames, report.CallStackFrequencyTableName)
 	reportingCommand := common.ReportingCommand{
 		Cmd:            cmd,
 		ReportNamePost: "flame",
 		ScriptParams: map[string]string{
 			"Frequency": strconv.Itoa(flagFrequency),
 			"Duration":  strconv.Itoa(flagDuration),
-			"PID":       strconv.Itoa(flagPid),
+			"PIDs":      strings.Join(util.IntSliceToStringSlice(flagPids), ","),
+			"MaxDepth":  strconv.Itoa(flagMaxDepth),
 		},
 		TableNames: tableNames,
 	}

internal/report/render_html.go

@@ -1284,7 +1284,7 @@ func gaudiTelemetryTableHTMLRenderer(tableValues TableValues, targetName string)
 	return out
 }
 
-func codePathFrequencyTableHTMLRenderer(tableValues TableValues, targetName string) string {
+func callStackFrequencyTableHTMLRenderer(tableValues TableValues, targetName string) string {
 	out := `<style>
 
 /* Custom page header */
@@ -1308,8 +1308,8 @@ func codePathFrequencyTableHTMLRenderer(tableValues TableValues, targetName stri
 }
 </style>
 `
-	out += renderFlameGraph("System", tableValues, "System Paths")
-	out += renderFlameGraph("Java", tableValues, "Java Paths")
+	out += renderFlameGraph("Native", tableValues, "Native Stacks")
+	out += renderFlameGraph("Java", tableValues, "Java Stacks")
 	return out
 }
 

internal/report/render_html_flamegraph.go

@@ -8,8 +8,9 @@ import (
 	"bytes"
 	"encoding/json"
 	"fmt"
-	"log"
+	"log/slog"
 	"math/rand/v2" // nosemgrep
+	"slices"
 	"strconv"
 	"strings"
 	texttemplate "text/template" // nosemgrep
@@ -81,11 +82,6 @@ type flameGraphTemplateStruct struct {
 // Folded data conversion adapted from https://github.com/spiermar/burn
 // Copyright © 2017 Martin Spier <spiermar@gmail.com>
 // Apache License, Version 2.0
-func reverse(strings []string) {
-	for i, j := 0, len(strings)-1; i < j; i, j = i+1, j-1 {
-		strings[i], strings[j] = strings[j], strings[i]
-	}
-}
 
 type Node struct {
 	Name     string
@@ -123,24 +119,24 @@ func (n *Node) MarshalJSON() ([]byte, error) {
 	})
 }
 
-var maxStackDepth = 50
-
-func convertFoldedToJSON(folded string) (out string, err error) {
+func convertFoldedToJSON(folded string, maxStackDepth int) (out string, err error) {
 	rootNode := Node{Name: "root", Value: 0, Children: make(map[string]*Node)}
 	scanner := bufio.NewScanner(strings.NewReader(folded))
 	for scanner.Scan() {
 		line := scanner.Text()
-		sep := strings.LastIndex(line, " ")
-		s := line[:sep]
-		v := line[sep+1:]
-		stack := strings.Split(s, ";")
-		reverse(stack)
-		if len(stack) > maxStackDepth {
-			log.Printf("Trimming call stack depth from %d to %d", len(stack), maxStackDepth)
-			stack = stack[:maxStackDepth]
+		sep := strings.LastIndex(line, " ") // space separates the call stack from the count
+		callstack := line[:sep]
+		count := line[sep+1:]
+		stack := strings.Split(callstack, ";") // semicolon separates the functions in the call stack
+		slices.Reverse(stack)
+		if maxStackDepth > 0 {
+			if len(stack) > maxStackDepth {
+				slog.Info("Trimming call stack depth", slog.Int("stack length", len(stack)), slog.Int("max depth", maxStackDepth))
+				stack = stack[:maxStackDepth]
+			}
 		}
 		var i int
-		i, err = strconv.Atoi(v)
+		i, err = strconv.Atoi(count)
 		if err != nil {
 			return
 		}
@@ -152,9 +148,21 @@ func convertFoldedToJSON(folded string) (out string, err error) {
 }
 
 func renderFlameGraph(header string, tableValues TableValues, field string) (out string) {
+	maxDepthFieldIndex, err := getFieldIndex("Maximum Render Depth", tableValues)
+	if err != nil {
+		slog.Error("didn't find expected field (Maximum Render Depth) in table", slog.String("error", err.Error()))
+		return
+	}
+	maxDepth := tableValues.Fields[maxDepthFieldIndex].Values[0]
+	maxStackDepth, err := strconv.Atoi(strings.TrimSpace(maxDepth))
+	if err != nil {
+		slog.Error("failed to convert maximum stack depth", slog.String("error", err.Error()))
+		return
+	}
 	fieldIdx, err := getFieldIndex(field, tableValues)
 	if err != nil {
-		log.Panicf("didn't find expected field (%s) in table: %v", field, err)
+		slog.Error("didn't find expected field in table", slog.String("field", field), slog.String("error", err.Error()))
+		return
 	}
 	folded := tableValues.Fields[fieldIdx].Values[0]
 	if folded == "" {
@@ -166,10 +174,10 @@ func renderFlameGraph(header string, tableValues TableValues, field string) (out
 		out += msg
 		return
 	}
-	jsonStacks, err := convertFoldedToJSON(folded)
+	jsonStacks, err := convertFoldedToJSON(folded, maxStackDepth)
 	if err != nil {
-		log.Printf("failed to convert folded data: %v", err)
-		out += "Error."
+		slog.Error("failed to convert folded data", slog.String("error", err.Error()))
+		out = ""
 		return
 	}
 	fg := texttemplate.Must(texttemplate.New("flameGraphTemplate").Parse(flameGraphTemplate))
@@ -180,8 +188,8 @@ func renderFlameGraph(header string, tableValues TableValues, field string) (out
 		Header: header,
 	})
 	if err != nil {
-		log.Printf("failed to render flame graph template: %v", err)
-		out += "Error."
+		slog.Error("failed to render flame graph template", slog.String("error", err.Error()))
+		out = ""
 		return
 	}
 	out += buf.String()

internal/report/table_defs.go

@@ -129,7 +129,7 @@ const (
 	// config  table names
 	ConfigurationTableName = "Configuration"
 	// flamegraph table names
-	CodePathFrequencyTableName = "Code Path Frequency"
+	CallStackFrequencyTableName = "Call Stack Frequency"
 	// lock table names
 	KernelLockAnalysisTableName = "Kernel Lock Analysis"
 	// common table names
@@ -742,15 +742,14 @@ var tableDefinitions = map[string]TableDefinition{
 	//
 	// flamegraph tables
 	//
-	CodePathFrequencyTableName: {
-		Name:      CodePathFrequencyTableName,
-		MenuLabel: CodePathFrequencyTableName,
+	CallStackFrequencyTableName: {
+		Name:      CallStackFrequencyTableName,
+		MenuLabel: CallStackFrequencyTableName,
 		ScriptNames: []string{
-			script.ProfileJavaScriptName,
-			script.ProfileSystemScriptName,
+			script.CollapsedCallStacksScriptName,
 		},
-		FieldsFunc:            codePathFrequencyTableValues,
-		HTMLTableRendererFunc: codePathFrequencyTableHTMLRenderer},
+		FieldsFunc:            callStackFrequencyTableValues,
+		HTMLTableRendererFunc: callStackFrequencyTableHTMLRenderer},
 	//
 	// kernel lock analysis tables
 	//
@@ -2382,10 +2381,11 @@ func gaudiTelemetryTableValues(outputs map[string]script.ScriptOutput) []Field {
 	return fields
 }
 
-func codePathFrequencyTableValues(outputs map[string]script.ScriptOutput) []Field {
+func callStackFrequencyTableValues(outputs map[string]script.ScriptOutput) []Field {
 	fields := []Field{
-		{Name: "System Paths", Values: []string{systemFoldedFromOutput(outputs)}},
-		{Name: "Java Paths", Values: []string{javaFoldedFromOutput(outputs)}},
+		{Name: "Native Stacks", Values: []string{nativeFoldedFromOutput(outputs)}},
+		{Name: "Java Stacks", Values: []string{javaFoldedFromOutput(outputs)}},
+		{Name: "Maximum Render Depth", Values: []string{maxRenderDepthFromOutput(outputs)}},
 	}
 	return fields
 }