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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package main
import (
"errors"
"fmt"
"go/ast"
"log"
"os"
alib "go.opentelemetry.io/contrib/instrgen/lib"
)
func usage() error {
fmt.Println("\nusage driver --command [path to go project] [package pattern]")
fmt.Println("\tcommand:")
fmt.Println("\t\tinject (injects open telemetry calls into project code)")
fmt.Println("\t\tinject-dump-ir (injects open telemetry calls into project code and intermediate passes)")
fmt.Println("\t\tprune (prune open telemetry calls")
fmt.Println("\t\tdumpcfg (dumps control flow graph)")
fmt.Println("\t\trootfunctions (dumps root functions)")
return nil
}
func makeAnalysis(projectPath string, packagePattern string, debug bool) *alib.PackageAnalysis {
var rootFunctions []alib.FuncDescriptor
interfaces := alib.FindInterfaces(projectPath, packagePattern)
rootFunctions = append(rootFunctions, alib.FindRootFunctions(projectPath, packagePattern, "AutotelEntryPoint")...)
funcDecls := alib.FindFuncDecls(projectPath, packagePattern, interfaces)
backwardCallGraph := alib.BuildCallGraph(projectPath, packagePattern, funcDecls, interfaces)
fmt.Println("\n\tchild parent")
for k, v := range backwardCallGraph {
fmt.Print("\n\t", k)
fmt.Print(" ", v)
}
fmt.Println("")
analysis := &alib.PackageAnalysis{
ProjectPath: projectPath,
PackagePattern: packagePattern,
RootFunctions: rootFunctions,
FuncDecls: funcDecls,
Callgraph: backwardCallGraph,
Interfaces: interfaces,
Debug: debug,
}
return analysis
}
// Prune.
func Prune(projectPath string, packagePattern string, debug bool) ([]*ast.File, error) {
analysis := makeAnalysis(projectPath, packagePattern, debug)
return analysis.Execute(&alib.OtelPruner{}, otelPrunerPassSuffix)
}
func makeCallGraph(projectPath string, packagePattern string) map[alib.FuncDescriptor][]alib.FuncDescriptor {
var funcDecls map[alib.FuncDescriptor]bool
var backwardCallGraph map[alib.FuncDescriptor][]alib.FuncDescriptor
interfaces := alib.FindInterfaces(projectPath, packagePattern)
funcDecls = alib.FindFuncDecls(projectPath, packagePattern, interfaces)
backwardCallGraph = alib.BuildCallGraph(projectPath, packagePattern, funcDecls, interfaces)
return backwardCallGraph
}
func makeRootFunctions(projectPath string, packagePattern string) []alib.FuncDescriptor {
var rootFunctions []alib.FuncDescriptor
rootFunctions = append(rootFunctions, alib.FindRootFunctions(projectPath, packagePattern, "AutotelEntryPoint")...)
return rootFunctions
}
func dumpCallGraph(callGraph map[alib.FuncDescriptor][]alib.FuncDescriptor) {
fmt.Println("\n\tchild parent")
for k, v := range callGraph {
fmt.Print("\n\t", k)
fmt.Print(" ", v)
}
}
func dumpRootFunctions(rootFunctions []alib.FuncDescriptor) {
fmt.Println("rootfunctions:")
for _, fun := range rootFunctions {
fmt.Println("\t" + fun.TypeHash())
}
}
func isDirectory(path string) (bool, error) {
fileInfo, err := os.Stat(path)
if err != nil {
return false, err
}
return fileInfo.IsDir(), err
}
// Parsing algorithm works as follows. It goes through all function
// decls and infer function bodies to find call to AutotelEntryPoint
// A parent function of this call will become root of instrumentation
// Each function call from this place will be instrumented automatically.
func executeCommand(command string, projectPath string, packagePattern string) error {
isDir, err := isDirectory(projectPath)
if !isDir {
_ = usage()
return errors.New("[path to go project] argument must be directory")
}
if err != nil {
return err
}
switch command {
case "--inject":
_, err := Prune(projectPath, packagePattern, false)
if err != nil {
return err
}
analysis := makeAnalysis(projectPath, packagePattern, false)
err = ExecutePasses(analysis)
if err != nil {
return err
}
fmt.Println("\tinstrumentation done")
return nil
case "--inject-dump-ir":
_, err := Prune(projectPath, packagePattern, true)
if err != nil {
return err
}
analysis := makeAnalysis(projectPath, packagePattern, true)
err = ExecutePassesDumpIr(analysis)
if err != nil {
return err
}
fmt.Println("\tinstrumentation done")
return nil
case "--dumpcfg":
backwardCallGraph := makeCallGraph(projectPath, packagePattern)
dumpCallGraph(backwardCallGraph)
return nil
case "--rootfunctions":
rootFunctions := makeRootFunctions(projectPath, packagePattern)
dumpRootFunctions(rootFunctions)
return nil
case "--prune":
_, err := Prune(projectPath, packagePattern, false)
if err != nil {
return err
}
return nil
default:
return errors.New("unknown command")
}
}
func checkArgs(args []string) error {
if len(args) != 4 {
_ = usage()
return errors.New("wrong arguments")
}
return nil
}
func main() {
fmt.Println("autotel compiler")
err := checkArgs(os.Args)
if err != nil {
return
}
err = executeCommand(os.Args[1], os.Args[2], os.Args[3])
if err != nil {
log.Fatal(err)
}
}
|
