aboutsummaryrefslogtreecommitdiffstats
path: root/client/go/internal/admin/prog/valgrind.go
blob: b949102d6bd3b28643eeb1164ed9d36c673e622e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
// Author: arnej

package prog

import (
	"fmt"
	"os"
	"strings"

	"github.com/vespa-engine/vespa/client/go/internal/admin/envvars"
	"github.com/vespa-engine/vespa/client/go/internal/admin/trace"
	"github.com/vespa-engine/vespa/client/go/internal/util"
	"github.com/vespa-engine/vespa/client/go/internal/vespa"
)

const (
	VALGRIND_PROG = "valgrind"
)

func (p *Spec) ConfigureValgrind() {
	p.shouldUseValgrind = false
	p.shouldUseCallgrind = false
	if p.MatchesListEnv(envvars.VESPA_USE_VALGRIND) {
		trace.Trace("using valgrind as", p.Program, "has basename in", envvars.VESPA_USE_VALGRIND)
		backticks := util.BackTicksWithStderr
		out, err := backticks.Run(VALGRIND_PROG, "--help")
		if err != nil {
			trace.Trace("trial run of valgrind fails:", err, "=>", out)
			return
		}
		if opts := p.Getenv(envvars.VESPA_VALGRIND_OPT); strings.Contains(opts, "callgrind") {
			p.shouldUseCallgrind = true
		}
		p.shouldUseValgrind = true
	}
}

func (p *Spec) valgrindOptions() []string {
	env := p.Getenv(envvars.VESPA_VALGRIND_OPT)
	if env != "" {
		return strings.Fields(env)
	}
	result := []string{
		"--num-callers=32",
		"--run-libc-freeres=yes",
		"--track-origins=yes",
		"--freelist-vol=1000000000",
		"--leak-check=full",
		"--show-reachable=yes",
	}
	result = addValgrindSuppression(result, "etc/vespa/valgrind-suppressions.txt")
	result = addValgrindSuppression(result, "etc/vespa/suppressions.txt")
	return result
}

func addValgrindSuppression(r []string, fn string) []string {
	existsOk, fileName := vespa.HasFileUnderVespaHome(fn)
	if existsOk {
		r = append(r, fmt.Sprintf("--suppressions=%s", fileName))
	}
	return r
}

func (p *Spec) valgrindLogOption() string {
	return fmt.Sprintf("--log-file=%s/var/tmp/valgrind.%s.log.%d", vespa.FindHome(), p.BaseName, os.Getpid())
}

func (p *Spec) prependValgrind(args []string) []string {
	result := make([]string, 0, 15+len(args))
	result = append(result, VALGRIND_PROG)
	for _, arg := range p.valgrindOptions() {
		result = append(result, arg)
	}
	result = append(result, p.valgrindLogOption())
	for _, arg := range args {
		result = append(result, arg)
	}
	return result
}