// 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"
- "net"
"os"
"regexp"
- "sync/atomic"
- "syscall"
- "time"
- "unsafe"
- "github.com/ftrvxmtrx/fd"
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.Out = os.Stdout
if Debug {
Log.Level = logger.DebugLevel
- Log.Debug("enabled debug mode")
+ Log.Debug("govpp/statsclient: enabled debug mode")
+ }
+}
+
+func debugf(f string, a ...interface{}) {
+ if Debug {
+ Log.Debugf(f, a...)
}
}
+// implements StatsAPI
+var _ adapter.StatsAPI = (*StatsClient)(nil)
+
// StatsClient is the pure Go implementation for VPP stats API.
type StatsClient struct {
sockAddr string
- currentEpoch int64
- sharedHeader []byte
- directoryVector uintptr
- memorySize int
+ statSegment
}
// NewStatsClient returns new VPP stats API client.
-func NewStatsClient(socketName string) *StatsClient {
+func NewStatsClient(sockAddr string) *StatsClient {
+ if sockAddr == "" {
+ sockAddr = DefaultSocketName
+ }
return &StatsClient{
- sockAddr: socketName,
+ sockAddr: sockAddr,
}
}
func (c *StatsClient) Connect() error {
- var sockName string
- if c.sockAddr == "" {
- sockName = adapter.DefaultStatsSocket
- } else {
- sockName = c.sockAddr
- }
-
- if _, err := os.Stat(sockName); err != nil {
- if os.IsNotExist(err) {
- return fmt.Errorf("stats socket file %q does not exists, ensure that VPP is running with `statseg { ... }` section in config", sockName)
- }
- return fmt.Errorf("stats socket file error: %v", err)
+ // 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.statSegmentConnect(sockName); err != nil {
+ if err := c.statSegment.connect(c.sockAddr); err != nil {
return err
}
return nil
}
-const statshmFilename = "statshm"
-
-func (c *StatsClient) statSegmentConnect(sockName string) error {
- addr := &net.UnixAddr{
- Net: "unixpacket",
- Name: sockName,
+func (c *StatsClient) Disconnect() error {
+ if err := c.statSegment.disconnect(); err != nil {
+ return err
}
+ return nil
+}
- Log.Debugf("connecting to: %v", addr)
+func (c *StatsClient) ListStats(patterns ...string) (names []string, err error) {
+ sa := c.accessStart()
+ if sa.epoch == 0 {
+ return nil, adapter.ErrStatsAccessFailed
+ }
- conn, err := net.DialUnix(addr.Net, nil, addr)
+ indexes, err := c.listIndexes(patterns...)
if err != nil {
- Log.Warnf("connecting to socket %s failed: %s", addr, err)
- return err
+ return nil, err
}
- defer func() {
- if err := conn.Close(); err != nil {
- Log.Warnf("closing socket failed: %v", err)
- }
- }()
- Log.Debugf("connected to socket: %v", addr)
+ dirVector := c.getStatDirVector()
+ vecLen := uint32(vectorLen(dirVector))
- files, err := fd.Get(conn, 1, []string{statshmFilename})
- if err != nil {
- return fmt.Errorf("getting file descriptor over socket failed: %v", err)
- } else if len(files) == 0 {
- return fmt.Errorf("no files received over socket")
- }
- defer func() {
- for _, f := range files {
- if err := f.Close(); err != nil {
- Log.Warnf("closing file %s failed: %v", f.Name(), err)
- }
+ for _, index := range indexes {
+ if index >= vecLen {
+ return nil, fmt.Errorf("stat entry index %d out of dir vector len (%d)", index, vecLen)
}
- }()
- Log.Debugf("received %d files over socket", len(files))
-
- f := files[0]
+ dirEntry := c.getStatDirIndex(dirVector, index)
+ var name []byte
+ for n := 0; n < len(dirEntry.name); n++ {
+ if dirEntry.name[n] == 0 {
+ name = dirEntry.name[:n]
+ break
+ }
+ }
+ names = append(names, string(name))
+ }
- info, err := f.Stat()
- if err != nil {
- return err
+ if !c.accessEnd(&sa) {
+ return nil, adapter.ErrStatsDataBusy
}
- size := int(info.Size())
+ return names, nil
+}
- Log.Debugf("fd: name=%v size=%v", info.Name(), size)
+func (c *StatsClient) DumpStats(patterns ...string) (entries []adapter.StatEntry, err error) {
+ sa := c.accessStart()
+ if sa.epoch == 0 {
+ return nil, adapter.ErrStatsAccessFailed
+ }
- data, err := syscall.Mmap(int(f.Fd()), 0, size, syscall.PROT_READ, syscall.MAP_SHARED)
+ indexes, err := c.listIndexes(patterns...)
if err != nil {
- Log.Warnf("mapping shared memory failed: %v", err)
- return fmt.Errorf("mapping shared memory failed: %v", err)
+ return nil, err
+ }
+ if entries, err = c.dumpEntries(indexes); err != nil {
+ return nil, err
}
- Log.Debugf("successfuly mapped shared memory")
-
- c.sharedHeader = data
- c.memorySize = size
+ if !c.accessEnd(&sa) {
+ return nil, adapter.ErrStatsDataBusy
+ }
- return nil
+ return entries, nil
}
-func (c *StatsClient) Disconnect() error {
- err := syscall.Munmap(c.sharedHeader)
+func (c *StatsClient) PrepareDir(patterns ...string) (*adapter.StatDir, error) {
+ dir := new(adapter.StatDir)
+
+ sa := c.accessStart()
+ if sa.epoch == 0 {
+ return nil, adapter.ErrStatsAccessFailed
+ }
+
+ indexes, err := c.listIndexes(patterns...)
+ if err != nil {
+ return nil, err
+ }
+ dir.Indexes = indexes
+
+ entries, err := c.dumpEntries(indexes)
if err != nil {
- Log.Warnf("unmapping shared memory failed: %v", err)
- return fmt.Errorf("unmapping shared memory failed: %v", err)
+ return nil, err
}
+ dir.Entries = entries
- Log.Debugf("successfuly unmapped shared memory")
+ if !c.accessEnd(&sa) {
+ return nil, adapter.ErrStatsDataBusy
+ }
+ dir.Epoch = sa.epoch
- return nil
+ return dir, 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
- }
+func (c *StatsClient) UpdateDir(dir *adapter.StatDir) (err error) {
+ epoch, _ := c.getEpoch()
+ if dir.Epoch != epoch {
+ return adapter.ErrStatsDirStale
}
- return false
-}
-func (c *StatsClient) ListStats(patterns ...string) (statNames []string, err error) {
sa := c.accessStart()
- if sa == nil {
- return nil, fmt.Errorf("access failed")
+ if sa.epoch == 0 {
+ return adapter.ErrStatsAccessFailed
}
- dirOffset, _, _ := c.readOffsets()
- Log.Debugf("dirOffset: %v", dirOffset)
+ dirVector := c.getStatDirVector()
- vecLen := vectorLen(unsafe.Pointer(&c.sharedHeader[dirOffset]))
- Log.Debugf("vecLen: %v", vecLen)
- Log.Debugf("unsafe.Sizeof(statSegDirectoryEntry{}): %v", unsafe.Sizeof(statSegDirectoryEntry{}))
+ for i, index := range dir.Indexes {
+ dirEntry := c.getStatDirIndex(dirVector, index)
- 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.Warnf("no zero byte found for: %q", dirEntry.name[:])
+ var name []byte
+ for n := 0; n < len(dirEntry.name); n++ {
+ if dirEntry.name[n] == 0 {
+ name = dirEntry.name[:n]
+ break
+ }
+ }
+ if len(name) == 0 {
continue
}
- name := string(dirEntry.name[:nul])
-
- Log.Debugf(" %80q (type: %v, data: %d, offset: %d) ", name, dirEntry.directoryType, dirEntry.unionData, dirEntry.offsetVector)
- if nameMatches(name, patterns) {
- statNames = append(statNames, name)
+ entry := &dir.Entries[i]
+ if !bytes.Equal(name, entry.Name) {
+ continue
+ }
+ if adapter.StatType(dirEntry.directoryType) != entry.Type {
+ continue
+ }
+ if entry.Data == nil {
+ continue
+ }
+ if err := c.updateEntryData(dirEntry, &entry.Data); err != nil {
+ return fmt.Errorf("updating stat data for entry %s failed: %v", name, err)
}
- // TODO: copy the listed entries elsewhere
}
- if !c.accessEnd(sa) {
- return nil, adapter.ErrStatDirBusy
+ if !c.accessEnd(&sa) {
+ return adapter.ErrStatsDataBusy
}
- c.currentEpoch = sa.epoch
-
- return statNames, nil
+ return 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")
+// listIndexes lists indexes for all stat entries that match any of the regex patterns.
+func (c *StatsClient) listIndexes(patterns ...string) (indexes []uint32, err error) {
+ if len(patterns) == 0 {
+ return c.listIndexesFunc(nil)
}
-
- 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))
-
- entry := c.copyData(dirEntry)
- if nameMatches(entry.Name, patterns) {
- entries = append(entries, &entry)
+ var regexes = make([]*regexp.Regexp, len(patterns))
+ for i, pattern := range patterns {
+ r, err := regexp.Compile(pattern)
+ if err != nil {
+ return nil, fmt.Errorf("compiling regexp failed: %v", err)
}
+ regexes[i] = r
}
-
- if !c.accessEnd(sa) {
- return nil, adapter.ErrStatDumpBusy
+ nameMatches := func(name []byte) bool {
+ for _, r := range regexes {
+ if r.Match(name) {
+ return true
+ }
+ }
+ return false
}
-
- return entries, nil
+ return c.listIndexesFunc(nameMatches)
}
-func (c *StatsClient) copyData(dirEntry *statSegDirectoryEntry) (statEntry adapter.StatEntry) {
- name := dirEntry.name[:]
- if nul := bytes.IndexByte(name, '\x00'); nul < 0 {
- Log.Warnf("no zero byte found for: %q", dirEntry.name[:])
- } else {
- name = dirEntry.name[:nul]
+func (c *StatsClient) listIndexesFunc(f func(name []byte) bool) (indexes []uint32, err error) {
+ if f == nil {
+ // there is around ~3157 stats, so to avoid too many allocations
+ // we set capacity to 3200 when listing all stats
+ indexes = make([]uint32, 0, 3200)
}
- statEntry.Name = string(name)
- statEntry.Type = adapter.StatType(dirEntry.directoryType)
-
- Log.Debugf(" - %s (type: %v, data: %v, offset: %v) ", statEntry.Name, statEntry.Type, dirEntry.unionData, dirEntry.offsetVector)
+ dirVector := c.getStatDirVector()
+ vecLen := uint32(vectorLen(dirVector))
- switch statEntry.Type {
- case adapter.ScalarIndex:
- statEntry.Data = adapter.ScalarStat(dirEntry.unionData)
-
- case adapter.ErrorIndex:
- _, errOffset, _ := c.readOffsets()
- offsetVector := unsafe.Pointer(&c.sharedHeader[errOffset])
- vecLen := vectorLen(offsetVector)
-
- var errData adapter.Counter
- for i := uint64(0); i < vecLen; i++ {
- cb := *(*uint64)(add(offsetVector, uintptr(i)*unsafe.Sizeof(uint64(0))))
- offset := uintptr(cb) + uintptr(dirEntry.unionData)*unsafe.Sizeof(adapter.Counter(0))
- val := *(*adapter.Counter)(add(unsafe.Pointer(&c.sharedHeader[0]), offset))
- errData += val
- }
- statEntry.Data = adapter.ErrorStat(errData)
-
- case adapter.SimpleCounterVector:
- if dirEntry.unionData == 0 {
- Log.Debugf("\toffset is not valid")
- break
- } else if dirEntry.unionData >= uint64(len(c.sharedHeader)) {
- Log.Debugf("\toffset out of range")
- break
- }
-
- simpleCounter := unsafe.Pointer(&c.sharedHeader[dirEntry.unionData]) // offset
- vecLen := vectorLen(simpleCounter)
- offsetVector := add(unsafe.Pointer(&c.sharedHeader[0]), uintptr(dirEntry.offsetVector))
-
- data := make([][]adapter.Counter, vecLen)
- for i := uint64(0); i < vecLen; i++ {
- cb := *(*uint64)(add(offsetVector, uintptr(i)*unsafe.Sizeof(uint64(0))))
- counterVec := unsafe.Pointer(&c.sharedHeader[uintptr(cb)])
- vecLen2 := vectorLen(counterVec)
- for j := uint64(0); j < vecLen2; j++ {
- offset := uintptr(j) * unsafe.Sizeof(adapter.Counter(0))
- val := *(*adapter.Counter)(add(counterVec, offset))
- data[i] = append(data[i], val)
- }
- }
- statEntry.Data = adapter.SimpleCounterStat(data)
-
- case adapter.CombinedCounterVector:
- if dirEntry.unionData == 0 {
- Log.Debugf("\toffset is not valid")
- break
- } else if dirEntry.unionData >= uint64(len(c.sharedHeader)) {
- Log.Debugf("\toffset out of range")
- break
- }
-
- combinedCounter := unsafe.Pointer(&c.sharedHeader[dirEntry.unionData]) // offset
- vecLen := vectorLen(combinedCounter)
- offsetVector := add(unsafe.Pointer(&c.sharedHeader[0]), uintptr(dirEntry.offsetVector))
-
- data := make([][]adapter.CombinedCounter, vecLen)
- for i := uint64(0); i < vecLen; i++ {
- cb := *(*uint64)(add(offsetVector, uintptr(i)*unsafe.Sizeof(uint64(0))))
- counterVec := unsafe.Pointer(&c.sharedHeader[uintptr(cb)])
- vecLen2 := vectorLen(counterVec)
- for j := uint64(0); j < vecLen2; j++ {
- offset := uintptr(j) * unsafe.Sizeof(adapter.CombinedCounter{})
- val := *(*adapter.CombinedCounter)(add(counterVec, offset))
- data[i] = append(data[i], val)
- }
- }
- statEntry.Data = adapter.CombinedCounterStat(data)
-
- case adapter.NameVector:
- if dirEntry.unionData == 0 {
- Log.Debugf("\toffset is not valid")
- break
- } else if dirEntry.unionData >= uint64(len(c.sharedHeader)) {
- Log.Debugf("\toffset out of range")
- break
- }
+ for i := uint32(0); i < vecLen; i++ {
+ dirEntry := c.getStatDirIndex(dirVector, i)
- nameVector := unsafe.Pointer(&c.sharedHeader[dirEntry.unionData]) // offset
- vecLen := vectorLen(nameVector)
- offsetVector := add(unsafe.Pointer(&c.sharedHeader[0]), uintptr(dirEntry.offsetVector))
-
- data := make([]adapter.Name, vecLen)
- for i := uint64(0); i < vecLen; i++ {
- cb := *(*uint64)(add(offsetVector, uintptr(i)*unsafe.Sizeof(uint64(0))))
- nameVec := unsafe.Pointer(&c.sharedHeader[uintptr(cb)])
- vecLen2 := vectorLen(nameVec)
-
- var nameStr []byte
- for j := uint64(0); j < vecLen2; j++ {
- offset := uintptr(j) * unsafe.Sizeof(byte(0))
- val := *(*byte)(add(nameVec, offset))
- if val > 0 {
- nameStr = append(nameStr, val)
+ if f != nil {
+ var name []byte
+ for n := 0; n < len(dirEntry.name); n++ {
+ if dirEntry.name[n] == 0 {
+ name = dirEntry.name[:n]
+ break
}
}
- data[i] = adapter.Name(nameStr)
+ if len(name) == 0 || !f(name) {
+ continue
+ }
}
- statEntry.Data = adapter.NameStat(data)
-
- default:
- Log.Warnf("Unknown type %d for stat entry: %s", statEntry.Type, statEntry.Name)
+ indexes = append(indexes, i)
}
- Log.Debugf("\tentry data: %#v", statEntry.Data)
-
- return statEntry
+ return indexes, nil
}
-type statDirectoryType int32
+func (c *StatsClient) dumpEntries(indexes []uint32) (entries []adapter.StatEntry, err error) {
+ dirVector := c.getStatDirVector()
+ dirLen := uint32(vectorLen(dirVector))
-func (t statDirectoryType) String() string {
- return adapter.StatType(t).String()
-}
-
-type statSegDirectoryEntry struct {
- directoryType statDirectoryType
- // unionData can represent: offset, index or value
- unionData uint64
- offsetVector uint64
- name [128]byte
-}
+ debugf("dumping entres for %d indexes", len(indexes))
-type statSegSharedHeader struct {
- version uint64
- epoch int64
- inProgress int64
- directoryOffset int64
- errorOffset int64
- statsOffset int64
-}
-
-func (c *StatsClient) readVersion() uint64 {
- header := *(*statSegSharedHeader)(unsafe.Pointer(&c.sharedHeader[0]))
- version := atomic.LoadUint64(&header.version)
- return version
-}
-
-func (c *StatsClient) readEpoch() (int64, bool) {
- header := *(*statSegSharedHeader)(unsafe.Pointer(&c.sharedHeader[0]))
- epoch := atomic.LoadInt64(&header.epoch)
- inprog := atomic.LoadInt64(&header.inProgress)
- return epoch, inprog != 0
-}
+ entries = make([]adapter.StatEntry, 0, len(indexes))
+ for _, index := range indexes {
+ if index >= dirLen {
+ return nil, fmt.Errorf("stat entry index %d out of dir vector length (%d)", index, dirLen)
+ }
-func (c *StatsClient) readOffsets() (dir, err, stat int64) {
- header := *(*statSegSharedHeader)(unsafe.Pointer(&c.sharedHeader[0]))
- dirOffset := atomic.LoadInt64(&header.directoryOffset)
- errOffset := atomic.LoadInt64(&header.errorOffset)
- statOffset := atomic.LoadInt64(&header.statsOffset)
- return dirOffset, errOffset, statOffset
-}
+ dirEntry := c.getStatDirIndex(dirVector, index)
-type statSegAccess struct {
- epoch int64
-}
+ var name []byte
+ for n := 0; n < len(dirEntry.name); n++ {
+ if dirEntry.name[n] == 0 {
+ name = dirEntry.name[:n]
+ break
+ }
+ }
-var maxWaitInProgress = 1 * time.Second
+ if Debug {
+ debugf(" - %3d. dir: %q type: %v offset: %d union: %d", index, name,
+ adapter.StatType(dirEntry.directoryType), dirEntry.offsetVector, dirEntry.unionData)
+ }
-func (c *StatsClient) accessStart() *statSegAccess {
- epoch, inprog := c.readEpoch()
- t := time.Now()
- for inprog {
- if time.Since(t) > maxWaitInProgress {
- return nil
+ if len(name) == 0 {
+ continue
}
- epoch, inprog = c.readEpoch()
- }
- return &statSegAccess{
- epoch: epoch,
- }
-}
-func (c *StatsClient) accessEnd(acc *statSegAccess) bool {
- epoch, inprog := c.readEpoch()
- if acc.epoch != epoch || inprog {
- return false
+ entry := adapter.StatEntry{
+ Name: append([]byte(nil), name...),
+ Type: adapter.StatType(dirEntry.directoryType),
+ Data: c.copyEntryData(dirEntry),
+ }
+ entries = append(entries, entry)
}
- return true
-}
-
-type vecHeader struct {
- length uint64
- vectorData [0]uint8
-}
-func vectorLen(v unsafe.Pointer) uint64 {
- vec := *(*vecHeader)(unsafe.Pointer(uintptr(v) - unsafe.Sizeof(uintptr(0))))
- return vec.length
-}
-
-//go:nosplit
-func add(p unsafe.Pointer, x uintptr) unsafe.Pointer {
- return unsafe.Pointer(uintptr(p) + x)
+ return entries, nil
}
Code Review / govpp.git / blobdiff