-
Notifications
You must be signed in to change notification settings - Fork 3
/
symbol_table.go
158 lines (137 loc) · 4.15 KB
/
symbol_table.go
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
package instrumentor
import (
"bufio"
"fmt"
"os"
"strings"
)
// SymbolTable is the serialization of the
// edges that the instrumentor finds and
// instruments.
type SymbolTable struct {
Path string
writer symbolTableWriter
executable string
}
type SymbolTablePosition struct {
Path string
Function string
StartLine int
StartColumn int
EndLine int
EndColumn int
Edge int
}
// CreateSymbolTableFile opens an Antithesis-standard .symbols.tsv file on disk.
func CreateSymbolTableFile(symbolTablePath, instrumentedModule string) (symbolTable *SymbolTable, err error) {
var w *fileSymbolTableWriter
if w, err = createFileSymbolTableWriter(symbolTablePath); err != nil {
return
}
// There can be an error if the file has been moved!
executable, _ := os.Executable()
symbolTable = &SymbolTable{
Path: symbolTablePath,
writer: w,
executable: executable,
}
if err = symbolTable.writeHeader(instrumentedModule); err != nil {
symbolTable = nil
}
return
}
// CreateInMemorySymbolTable creates an in memory symbol table for testing.
func CreateInMemorySymbolTable(symbolTablePath, instrumentedModule string) *SymbolTable {
w := createInMemorySymbolTableWriter()
symbolTable := &SymbolTable{Path: symbolTablePath, writer: w, executable: "goinstrumentor"}
symbolTable.writeHeader(instrumentedModule)
return symbolTable
}
// WriteHeader writes the Antithesis-standard symbol table header.
func (t *SymbolTable) writeHeader(module string) error {
if err := t.writer.WriteLine("# language = Go"); err != nil {
return err
}
if err := t.writer.WriteLine("# instrumentor = " + t.executable); err != nil {
return err
}
if err := t.writer.WriteLine("# module = " + module); err != nil {
return err
}
return t.writer.WriteLine("file\tfunction\tbegin_line\tbegin_column\tend_line\tend_column\taddress")
}
// WritePosition describes a callback to the Antithesis instrumentation.
func (t *SymbolTable) WritePosition(p SymbolTablePosition) error {
line := fmt.Sprintf("%s\t%s\t%d\t%d\t%d\t%d\t%d", p.Path, p.Function, p.StartLine, p.StartColumn, p.EndLine, p.EndColumn, p.Edge)
return t.writer.WriteLine(line)
}
// Close closes the underlying file resources.
func (t *SymbolTable) Close() error {
return t.writer.Close()
}
func (t *SymbolTable) String() string {
return t.writer.String()
}
// --------------------------------------------------------------------------------
// symbolTableWriter
// --------------------------------------------------------------------------------
type symbolTableWriter interface {
WriteLine(s string) error
Close() error
String() string
}
type fileSymbolTableWriter struct {
f *os.File
writer *bufio.Writer
}
type inMemorySymbolTableWriter struct {
writer strings.Builder
}
// --------------------------------------------------------------------------------
// fileSymbolTableWriter
// --------------------------------------------------------------------------------
func createFileSymbolTableWriter(name string) (symWriter *fileSymbolTableWriter, err error) {
var f *os.File
if f, err = os.Create(name); err != nil {
return
}
symWriter = &fileSymbolTableWriter{
f: f,
writer: bufio.NewWriter(f),
}
return
}
func (w *fileSymbolTableWriter) WriteLine(s string) error {
_, err := w.writer.WriteString(s + "\n")
if err != nil {
return err
}
return w.writer.Flush()
}
func (w *fileSymbolTableWriter) Close() error {
err := w.writer.Flush()
if err != nil {
return err
}
return w.f.Close()
}
func (fileSymbolTableWriter) String() string {
// logger.Fatalf("fileSymbolTableWriter does not support String method")
return ""
}
// --------------------------------------------------------------------------------
// inMemorySymbolTableWriter
// --------------------------------------------------------------------------------
func createInMemorySymbolTableWriter() symbolTableWriter {
return &inMemorySymbolTableWriter{}
}
func (w *inMemorySymbolTableWriter) WriteLine(s string) error {
_, err := w.writer.WriteString(s + "\n")
return err
}
func (w *inMemorySymbolTableWriter) Close() error {
return nil
}
func (w *inMemorySymbolTableWriter) String() string {
return w.writer.String()
}