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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
// Copyright (c) 2019 Cisco and/or its affiliates.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package statsclient is pure Go implementation of VPP stats API client.
package statsclient
import (
"bytes"
"fmt"
"os"
"regexp"
"unsafe"
logger "github.com/sirupsen/logrus"
"git.fd.io/govpp.git/adapter"
)
const (
// DefaultSocketName is default VPP stats socket file path.
DefaultSocketName = adapter.DefaultStatsSocket
)
const socketMissing = `
------------------------------------------------------------
VPP stats socket file %s is missing!
- is VPP running with stats segment enabled?
- is the correct socket name configured?
To enable it add following section to your VPP config:
statseg {
default
}
------------------------------------------------------------
`
var (
// Debug is global variable that determines debug mode
Debug = os.Getenv("DEBUG_GOVPP_STATS") != ""
// Log is global logger
Log = logger.New()
)
// init initializes global logger, which logs debug level messages to stdout.
func init() {
Log.Out = os.Stdout
if Debug {
Log.Level = logger.DebugLevel
Log.Debug("govpp/statsclient: enabled debug mode")
}
}
// StatsClient is the pure Go implementation for VPP stats API.
type StatsClient struct {
sockAddr string
currentEpoch int64
statSegment
}
// NewStatsClient returns new VPP stats API client.
func NewStatsClient(sockAddr string) *StatsClient {
if sockAddr == "" {
sockAddr = DefaultSocketName
}
return &StatsClient{
sockAddr: sockAddr,
}
}
func (c *StatsClient) Connect() error {
// check if socket exists
if _, err := os.Stat(c.sockAddr); os.IsNotExist(err) {
fmt.Fprintf(os.Stderr, socketMissing, c.sockAddr)
return fmt.Errorf("stats socket file %s does not exist", c.sockAddr)
} else if err != nil {
return fmt.Errorf("stats socket error: %v", err)
}
if err := c.statSegment.connect(c.sockAddr); err != nil {
return err
}
ver := c.readVersion()
Log.Debugf("stat segment version: %v", ver)
if err := checkVersion(ver); err != nil {
return err
}
return nil
}
func (c *StatsClient) Disconnect() error {
if err := c.statSegment.disconnect(); err != nil {
return err
}
return nil
}
func (c *StatsClient) ListStats(patterns ...string) (statNames []string, err error) {
sa := c.accessStart()
if sa == nil {
return nil, fmt.Errorf("access failed")
}
dirOffset, _, _ := c.readOffsets()
Log.Debugf("dirOffset: %v", dirOffset)
vecLen := vectorLen(unsafe.Pointer(&c.sharedHeader[dirOffset]))
Log.Debugf("vecLen: %v", vecLen)
Log.Debugf("unsafe.Sizeof(statSegDirectoryEntry{}): %v", unsafe.Sizeof(statSegDirectoryEntry{}))
for i := uint64(0); i < vecLen; i++ {
offset := uintptr(i) * unsafe.Sizeof(statSegDirectoryEntry{})
dirEntry := (*statSegDirectoryEntry)(add(unsafe.Pointer(&c.sharedHeader[dirOffset]), offset))
nul := bytes.IndexByte(dirEntry.name[:], '\x00')
if nul < 0 {
Log.Debugf("no zero byte found for: %q", dirEntry.name[:])
continue
}
name := string(dirEntry.name[:nul])
if name == "" {
Log.Debugf("entry with empty name found (%d)", i)
continue
}
Log.Debugf(" %80q (type: %v, data: %d, offset: %d) ", name, dirEntry.directoryType, dirEntry.unionData, dirEntry.offsetVector)
if nameMatches(name, patterns) {
statNames = append(statNames, name)
}
// TODO: copy the listed entries elsewhere
}
if !c.accessEnd(sa) {
return nil, adapter.ErrStatDirBusy
}
c.currentEpoch = sa.epoch
return statNames, nil
}
func (c *StatsClient) DumpStats(patterns ...string) (entries []*adapter.StatEntry, err error) {
epoch, _ := c.readEpoch()
if c.currentEpoch > 0 && c.currentEpoch != epoch { // TODO: do list stats before dump
return nil, fmt.Errorf("old data")
}
sa := c.accessStart()
if sa == nil {
return nil, fmt.Errorf("access failed")
}
dirOffset, _, _ := c.readOffsets()
vecLen := vectorLen(unsafe.Pointer(&c.sharedHeader[dirOffset]))
for i := uint64(0); i < vecLen; i++ {
offset := uintptr(i) * unsafe.Sizeof(statSegDirectoryEntry{})
dirEntry := (*statSegDirectoryEntry)(add(unsafe.Pointer(&c.sharedHeader[dirOffset]), offset))
nul := bytes.IndexByte(dirEntry.name[:], '\x00')
if nul < 0 {
Log.Debugf("no zero byte found for: %q", dirEntry.name[:])
continue
}
name := string(dirEntry.name[:nul])
if name == "" {
Log.Debugf("entry with empty name found (%d)", i)
continue
}
Log.Debugf(" - %s (type: %v, data: %v, offset: %v) ", name, dirEntry.directoryType, dirEntry.unionData, dirEntry.offsetVector)
entry := adapter.StatEntry{
Name: name,
Type: adapter.StatType(dirEntry.directoryType),
Data: c.copyData(dirEntry),
}
Log.Debugf("\tentry data: %+v %#v (%T)", entry.Data, entry.Data, entry.Data)
if nameMatches(entry.Name, patterns) {
entries = append(entries, &entry)
}
}
if !c.accessEnd(sa) {
return nil, adapter.ErrStatDumpBusy
}
return entries, nil
}
func nameMatches(name string, patterns []string) bool {
if len(patterns) == 0 {
return true
}
for _, pattern := range patterns {
matched, err := regexp.MatchString(pattern, name)
if err == nil && matched {
return true
}
}
return false
}
|
