summaryrefslogtreecommitdiffstats
path: root/client/go/script-utils/startcbinary/common_env.go
blob: 44157b5d5a6cd1dde3a860d7c6ca8ee23485d4af (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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
// Author: arnej

package startcbinary

import (
	"os"
	"strings"

	"github.com/vespa-engine/vespa/client/go/trace"
	"github.com/vespa-engine/vespa/client/go/vespa"
)

const (
	ENV_LD_PRELOAD                   = "LD_PRELOAD"
	ENV_STD_THREAD_PREVENT_TRY_CATCH = "STD_THREAD_PREVENT_TRY_CATCH"
	ENV_GLIBCXX_FORCE_NEW            = "GLIBCXX_FORCE_NEW"
	ENV_JAVA_HOME                    = "JAVA_HOME"

	ENV_VESPA_AFFINITY_CPU_SOCKET    = "VESPA_AFFINITY_CPU_SOCKET"
	ENV_VESPA_LOAD_CODE_AS_HUGEPAGES = "VESPA_LOAD_CODE_AS_HUGEPAGES"
	ENV_VESPA_MALLOC_HUGEPAGES       = "VESPA_MALLOC_HUGEPAGES"
	ENV_VESPA_MALLOC_MADVISE_LIMIT   = "VESPA_MALLOC_MADVISE_LIMIT"
	ENV_VESPA_NO_NUMACTL             = "VESPA_NO_NUMACTL"
	ENV_VESPA_TIMER_HZ               = "VESPA_TIMER_HZ"
	ENV_VESPA_USER                   = "VESPA_USER"
	ENV_VESPA_USE_HUGEPAGES          = "VESPA_USE_HUGEPAGES"
	ENV_VESPA_USE_HUGEPAGES_LIST     = "VESPA_USE_HUGEPAGES_LIST"
	ENV_VESPA_USE_MADVISE_LIST       = "VESPA_USE_MADVISE_LIST"
	ENV_VESPA_USE_NO_VESPAMALLOC     = "VESPA_USE_NO_VESPAMALLOC"
	ENV_VESPA_USE_VALGRIND           = "VESPA_USE_VALGRIND"
	ENV_VESPA_USE_VESPAMALLOC        = "VESPA_USE_VESPAMALLOC"
	ENV_VESPA_USE_VESPAMALLOC_D      = "VESPA_USE_VESPAMALLOC_D"
	ENV_VESPA_USE_VESPAMALLOC_DST    = "VESPA_USE_VESPAMALLOC_DST"
	ENV_VESPA_VALGRIND_OPT           = "VESPA_VALGRIND_OPT"

	// backwards compatibility variables:
	ENV_HUGEPAGES_LIST      = "HUGEPAGES_LIST"
	ENV_MADVISE_LIST        = "MADVISE_LIST"
	ENV_NO_VESPAMALLOC_LIST = "NO_VESPAMALLOC_LIST"
	ENV_PATH                = "PATH"
	ENV_ROOT                = "ROOT"
	ENV_VESPAMALLOCDST_LIST = "VESPAMALLOCDST_LIST"
	ENV_VESPAMALLOCD_LIST   = "VESPAMALLOCD_LIST"
	ENV_VESPAMALLOC_LIST    = "VESPAMALLOCD_LIST"
)

func (spec *ProgSpec) considerFallback(varName, varValue string) {
	if spec.getenv(varName) == "" && varValue != "" {
		spec.setenv(varName, varValue)
	}
}

func (spec *ProgSpec) considerEnvFallback(targetVar, fallbackVar string) {
	spec.considerFallback(targetVar, spec.getenv(fallbackVar))
}

func (spec *ProgSpec) configureCommonEnv() {
	os.Unsetenv(ENV_LD_PRELOAD)
	spec.setenv(ENV_STD_THREAD_PREVENT_TRY_CATCH, "true")
	spec.setenv(ENV_GLIBCXX_FORCE_NEW, "1")
	// fallback from old env.vars:
	spec.considerEnvFallback(ENV_VESPA_USE_HUGEPAGES_LIST, ENV_HUGEPAGES_LIST)
	spec.considerEnvFallback(ENV_VESPA_USE_MADVISE_LIST, ENV_MADVISE_LIST)
	spec.considerEnvFallback(ENV_VESPA_USE_VESPAMALLOC, ENV_VESPAMALLOC_LIST)
	spec.considerEnvFallback(ENV_VESPA_USE_VESPAMALLOC_D, ENV_VESPAMALLOCD_LIST)
	spec.considerEnvFallback(ENV_VESPA_USE_VESPAMALLOC_DST, ENV_VESPAMALLOCDST_LIST)
	spec.considerEnvFallback(ENV_VESPA_USE_NO_VESPAMALLOC, ENV_NO_VESPAMALLOC_LIST)
	// other fallbacks:
	spec.considerFallback(ENV_ROOT, vespa.FindHome())
	spec.considerFallback(ENV_VESPA_USER, vespa.FindVespaUser())
	spec.considerFallback(ENV_VESPA_USE_HUGEPAGES_LIST, "all")
	spec.considerFallback(ENV_VESPA_USE_VESPAMALLOC, "all")
	spec.considerFallback(ENV_VESPA_USE_NO_VESPAMALLOC, strings.Join([]string{
		"vespa-rpc-invoke",
		"vespa-get-config",
		"vespa-sentinel-cmd",
		"vespa-route",
		"vespa-proton-cmd",
		"vespa-configproxy-cmd",
		"vespa-config-status",
	}, " "))

}

func (spec *ProgSpec) configureHugePages() {
	if spec.matchesListEnv(ENV_VESPA_USE_HUGEPAGES_LIST) {
		spec.setenv(ENV_VESPA_USE_HUGEPAGES, "yes")
	}
}

func (spec *ProgSpec) configureUseMadvise() {
	limit := spec.valueFromListEnv(ENV_VESPA_USE_MADVISE_LIST)
	if limit != "" {
		trace.Trace("shall use madvise with limit", limit, "as set in", ENV_VESPA_USE_MADVISE_LIST)
		spec.setenv(ENV_VESPA_MALLOC_MADVISE_LIMIT, limit)
		return
	}
}

func (spec *ProgSpec) configurePath() {
	// Prefer newer gdb and pstack:
	spec.prependPath("/opt/rh/gcc-toolset-11/root/usr/bin")
	// Maven is needed for tester applications:
	spec.prependPath(vespa.FindHome() + "/local/maven/bin")
	spec.prependPath(vespa.FindHome() + "/bin64")
	spec.prependPath(vespa.FindHome() + "/bin")
	// how to find the "java" program?
	// should be available in $VESPA_HOME/bin or JAVA_HOME
	if javaHome := spec.getenv(ENV_JAVA_HOME); javaHome != "" {
		spec.prependPath(javaHome + "/bin")
	}
}