X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=adapter%2Fstatsclient%2Fstatsclient.go;h=947027592435cf8e66ae5a2ef488a2740353c062;hb=4da29d1fb32a77dd299e84a9ed3a11ddcaa31a3b;hp=d4e5a56f02dc80ece1f8585e085dc94d12acd272;hpb=809b69ea4a90455445c34bbad7d8e5fea5cf3462;p=govpp.git

diff --git a/adapter/statsclient/statsclient.go b/adapter/statsclient/statsclient.go
index d4e5a56..9470275 100644
--- a/adapter/statsclient/statsclient.go
+++ b/adapter/statsclient/statsclient.go
@@ -18,9 +18,14 @@ package statsclient
 import (
 	"bytes"
 	"fmt"
+	"net"
 	"os"
 	"regexp"
+	"syscall"
+	"time"
 
+	"github.com/fsnotify/fsnotify"
+	"github.com/ftrvxmtrx/fd"
 	logger "github.com/sirupsen/logrus"
 
 	"git.fd.io/govpp.git/adapter"
@@ -31,20 +36,6 @@ const (
 	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") != ""
@@ -73,172 +64,391 @@ var _ adapter.StatsAPI = (*StatsClient)(nil)
 
 // StatsClient is the pure Go implementation for VPP stats API.
 type StatsClient struct {
-	sockAddr string
+	socketPath string
+
+	headerData  []byte
+	isConnected bool
+
+	// to quit socket monitor
+	done chan struct{}
 
 	statSegment
 }
 
-// NewStatsClient returns new VPP stats API client.
-func NewStatsClient(sockAddr string) *StatsClient {
-	if sockAddr == "" {
-		sockAddr = DefaultSocketName
+// NewStatsClient returns a new StatsClient using socket.
+// If socket is empty string DefaultSocketName is used.
+func NewStatsClient(socket string) *StatsClient {
+	if socket == "" {
+		socket = DefaultSocketName
 	}
 	return &StatsClient{
-		sockAddr: sockAddr,
+		socketPath: socket,
 	}
 }
 
-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)
+// Connect to validated VPP stats socket and start monitoring
+// socket file changes
+func (sc *StatsClient) Connect() (err error) {
+	if sc.isConnected {
+		return fmt.Errorf("already connected")
 	}
-
-	if err := c.statSegment.connect(c.sockAddr); err != nil {
+	if err := sc.checkSocketValid(); err != nil {
 		return err
 	}
-
+	sc.done = make(chan struct{})
+	if sc.statSegment, err = sc.connect(); err != nil {
+		return err
+	}
+	sc.monitorSocket()
+	sc.isConnected = true
 	return nil
 }
 
-func (c *StatsClient) Disconnect() error {
-	if err := c.statSegment.disconnect(); err != nil {
-		return err
+// Disconnect from the socket, unmap shared memory and terminate
+// socket monitor
+func (sc *StatsClient) Disconnect() error {
+	if !sc.isConnected {
+		return nil // not connected
 	}
-	return nil
+	sc.isConnected = false
+	close(sc.done)
+	return sc.disconnect()
 }
 
-func (c *StatsClient) ListStats(patterns ...string) (names []string, err error) {
-	sa := c.accessStart()
-	if sa.epoch == 0 {
+func (sc *StatsClient) ListStats(patterns ...string) ([]string, error) {
+	accessEpoch := sc.accessStart()
+	if accessEpoch == 0 {
 		return nil, adapter.ErrStatsAccessFailed
 	}
 
-	indexes, err := c.listIndexes(patterns...)
+	indexes, err := sc.listIndexes(patterns...)
 	if err != nil {
 		return nil, err
 	}
+
+	dirVector := sc.GetDirectoryVector()
+	if dirVector == nil {
+		return nil, fmt.Errorf("failed to list stats: %v", err)
+	}
+	vecLen := *(*uint32)(vectorLen(dirVector))
+
+	var names []string
 	for _, index := range indexes {
-		name, err := c.entryName(index)
-		if err != nil {
-			return nil, err
+		if index >= vecLen {
+			return nil, fmt.Errorf("stat entry index %d out of dir vector len (%d)", index, vecLen)
 		}
-		names = append(names, name)
+		_, dirName, _ := sc.GetStatDirOnIndex(dirVector, index)
+		names = append(names, string(dirName))
 	}
 
-	if !c.accessEnd(&sa) {
+	if !sc.accessEnd(accessEpoch) {
 		return nil, adapter.ErrStatsDataBusy
 	}
 
 	return names, nil
 }
 
-func (c *StatsClient) DumpStats(patterns ...string) (entries []adapter.StatEntry, err error) {
-	sa := c.accessStart()
-	if sa.epoch == 0 {
+func (sc *StatsClient) DumpStats(patterns ...string) (entries []adapter.StatEntry, err error) {
+	accessEpoch := sc.accessStart()
+	if accessEpoch == 0 {
 		return nil, adapter.ErrStatsAccessFailed
 	}
 
-	dir, err := c.listIndexes(patterns...)
+	indexes, err := sc.listIndexes(patterns...)
 	if err != nil {
 		return nil, err
 	}
-	if entries, err = c.dumpEntries(dir); err != nil {
+
+	dirVector := sc.GetDirectoryVector()
+	if dirVector == nil {
 		return nil, err
 	}
+	dirLen := *(*uint32)(vectorLen(dirVector))
 
-	if !c.accessEnd(&sa) {
+	debugf("dumping entries for %d indexes", len(indexes))
+
+	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)
+		}
+		dirPtr, dirName, dirType := sc.GetStatDirOnIndex(dirVector, index)
+		if len(dirName) == 0 {
+			continue
+		}
+		entry := adapter.StatEntry{
+			Name: append([]byte(nil), dirName...),
+			Type: adapter.StatType(dirType),
+			Data: sc.CopyEntryData(dirPtr),
+		}
+		entries = append(entries, entry)
+	}
+
+	if !sc.accessEnd(accessEpoch) {
 		return nil, adapter.ErrStatsDataBusy
 	}
 
 	return entries, nil
 }
 
-func (c *StatsClient) PrepareDir(patterns ...string) (*adapter.StatDir, error) {
+func (sc *StatsClient) PrepareDir(patterns ...string) (*adapter.StatDir, error) {
 	dir := new(adapter.StatDir)
 
-	sa := c.accessStart()
-	if sa.epoch == 0 {
+	accessEpoch := sc.accessStart()
+	if accessEpoch == 0 {
 		return nil, adapter.ErrStatsAccessFailed
 	}
 
-	indexes, err := c.listIndexes(patterns...)
+	indexes, err := sc.listIndexes(patterns...)
 	if err != nil {
 		return nil, err
 	}
 	dir.Indexes = indexes
 
-	entries, err := c.dumpEntries(indexes)
-	if err != nil {
+	dirVector := sc.GetDirectoryVector()
+	if dirVector == nil {
 		return nil, err
 	}
+	dirLen := *(*uint32)(vectorLen(dirVector))
+
+	debugf("dumping entries for %d indexes", len(indexes))
+
+	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)
+		}
+		dirPtr, dirName, dirType := sc.GetStatDirOnIndex(dirVector, index)
+		if len(dirName) == 0 {
+			continue
+		}
+		entry := adapter.StatEntry{
+			Name: append([]byte(nil), dirName...),
+			Type: adapter.StatType(dirType),
+			Data: sc.CopyEntryData(dirPtr),
+		}
+		entries = append(entries, entry)
+	}
 	dir.Entries = entries
 
-	if !c.accessEnd(&sa) {
+	if !sc.accessEnd(accessEpoch) {
 		return nil, adapter.ErrStatsDataBusy
 	}
-	dir.Epoch = sa.epoch
+	dir.Epoch = accessEpoch
 
 	return dir, nil
 }
 
-func (c *StatsClient) UpdateDir(dir *adapter.StatDir) (err error) {
-	epoch, _ := c.getEpoch()
+// UpdateDir refreshes directory data for all counters
+func (sc *StatsClient) UpdateDir(dir *adapter.StatDir) (err error) {
+	epoch, _ := sc.GetEpoch()
 	if dir.Epoch != epoch {
 		return adapter.ErrStatsDirStale
 	}
 
-	sa := c.accessStart()
-	if sa.epoch == 0 {
+	accessEpoch := sc.accessStart()
+	if accessEpoch == 0 {
 		return adapter.ErrStatsAccessFailed
 	}
 
-	dirVector := c.getStatDirVector()
-
+	dirVector := sc.GetDirectoryVector()
+	if dirVector == nil {
+		return err
+	}
 	for i, index := range dir.Indexes {
-		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
-			}
-		}
-		if len(name) == 0 {
+		statSegDir, dirName, dirType := sc.GetStatDirOnIndex(dirVector, index)
+		if len(dirName) == 0 {
 			continue
 		}
-
 		entry := &dir.Entries[i]
-		if !bytes.Equal(name, entry.Name) {
+		if !bytes.Equal(dirName, entry.Name) {
 			continue
 		}
-		if adapter.StatType(dirEntry.directoryType) != entry.Type {
+		if adapter.StatType(dirType) != 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)
+		if err := sc.UpdateEntryData(statSegDir, &entry.Data); err != nil {
+			return fmt.Errorf("updating stat data for entry %s failed: %v", dirName, err)
 		}
+	}
+	if !sc.accessEnd(accessEpoch) {
+		return adapter.ErrStatsDataBusy
+	}
+
+	return nil
+}
 
+func (sc *StatsClient) checkSocketValid() error {
+	if _, err := os.Stat(sc.socketPath); os.IsNotExist(err) {
+		return fmt.Errorf("stats socket file %s does not exist", sc.socketPath)
+	} else if err != nil {
+		return fmt.Errorf("stats socket error: %v", err)
 	}
+	return nil
+}
 
-	if !c.accessEnd(&sa) {
-		return adapter.ErrStatsDataBusy
+// connect to the socket and map it into the memory. According to the
+// header version info, an appropriate segment handler is returned
+func (sc *StatsClient) connect() (ss statSegment, err error) {
+	addr := net.UnixAddr{
+		Net:  "unixpacket",
+		Name: sc.socketPath,
 	}
+	Log.Debugf("connecting to: %v", addr)
 
+	conn, err := net.DialUnix(addr.Net, nil, &addr)
+	if err != nil {
+		Log.Warnf("connecting to socket %s failed: %s", addr, err)
+		return nil, err
+	}
+	defer func() {
+		if err := conn.Close(); err != nil {
+			Log.Warnf("closing socket failed: %v", err)
+		}
+	}()
+	Log.Debugf("connected to socket")
+
+	files, err := fd.Get(conn, 1, nil)
+	if err != nil {
+		return nil, fmt.Errorf("getting file descriptor over socket failed: %v", err)
+	}
+	if len(files) == 0 {
+		return nil, fmt.Errorf("no files received over socket")
+	}
+
+	file := files[0]
+	defer func() {
+		if err := file.Close(); err != nil {
+			Log.Warnf("closing file failed: %v", err)
+		}
+	}()
+
+	info, err := file.Stat()
+	if err != nil {
+		return nil, err
+	}
+	size := info.Size()
+
+	sc.headerData, err = syscall.Mmap(int(file.Fd()), 0, int(size), syscall.PROT_READ, syscall.MAP_SHARED)
+	if err != nil {
+		Log.Debugf("mapping shared memory failed: %v", err)
+		return nil, fmt.Errorf("mapping shared memory failed: %v", err)
+	}
+	Log.Debugf("successfully mmapped shared memory segment (size: %v) %v", size, len(sc.headerData))
+
+	version := getVersion(sc.headerData)
+	switch version {
+	case 1:
+		ss = newStatSegmentV1(sc.headerData, size)
+	case 2:
+		ss = newStatSegmentV2(sc.headerData, size)
+	default:
+		return nil, fmt.Errorf("stat segment version is not supported: %v (min: %v, max: %v)",
+			version, minVersion, maxVersion)
+	}
+
+	return ss, nil
+}
+
+// reconnect disconnects from the socket, re-validates it and
+// connects again
+func (sc *StatsClient) reconnect() (err error) {
+	if err = sc.disconnect(); err != nil {
+		return fmt.Errorf("error disconnecting socket: %v", err)
+	}
+	if err = sc.checkSocketValid(); err != nil {
+		return fmt.Errorf("error validating socket: %v", err)
+	}
+	if sc.statSegment, err = sc.connect(); err != nil {
+		return fmt.Errorf("error connecting socket: %v", err)
+	}
+	return nil
+}
+
+// disconnect unmaps socket data from the memory and resets the header
+func (sc *StatsClient) disconnect() error {
+	if sc.headerData == nil {
+		return nil
+	}
+	if err := syscall.Munmap(sc.headerData); err != nil {
+		Log.Debugf("unmapping shared memory failed: %v", err)
+		return fmt.Errorf("unmapping shared memory failed: %v", err)
+	}
+	sc.headerData = nil
+
+	Log.Debugf("successfully unmapped shared memory")
 	return nil
 }
 
+func (sc *StatsClient) monitorSocket() {
+	watcher, err := fsnotify.NewWatcher()
+	if err != nil {
+		Log.Errorf("error starting socket monitor: %v", err)
+		return
+	}
+
+	go func() {
+		for {
+			select {
+			case event := <-watcher.Events:
+				if event.Op == fsnotify.Remove {
+					if err := sc.reconnect(); err != nil {
+						Log.Errorf("error occurred during socket reconnect: %v", err)
+					}
+					// path must be re-added to the watcher
+					if err = watcher.Add(sc.socketPath); err != nil {
+						Log.Errorf("failed to add socket address to the watcher: %v", err)
+					}
+				}
+			case err := <-watcher.Errors:
+				Log.Errorf("socket monitor delivered error event: %v", err)
+			case <-sc.done:
+				err := watcher.Close()
+				Log.Debugf("socket monitor closed (error: %v)", err)
+				return
+			}
+		}
+	}()
+
+	if err := watcher.Add(sc.socketPath); err != nil {
+		Log.Errorf("failed to add socket address to the watcher: %v", err)
+	}
+}
+
+// Starts monitoring 'inProgress' field. Returns stats segment
+// access epoch when completed, or zero value if not finished
+// within MaxWaitInProgress
+func (sc *StatsClient) accessStart() (epoch int64) {
+	t := time.Now()
+
+	epoch, inProg := sc.GetEpoch()
+	for inProg {
+		if time.Since(t) > MaxWaitInProgress {
+			return int64(0)
+		}
+		time.Sleep(CheckDelayInProgress)
+		epoch, inProg = sc.GetEpoch()
+	}
+	return epoch
+}
+
+// AccessEnd returns true if stats data reading was finished, false
+// otherwise
+func (sc *StatsClient) accessEnd(accessEpoch int64) bool {
+	epoch, inProgress := sc.GetEpoch()
+	if accessEpoch != epoch || inProgress {
+		return false
+	}
+	return true
+}
+
 // listIndexes lists indexes for all stat entries that match any of the regex patterns.
-func (c *StatsClient) listIndexes(patterns ...string) (indexes []uint32, err error) {
+func (sc *StatsClient) listIndexes(patterns ...string) (indexes []uint32, err error) {
 	if len(patterns) == 0 {
-		return c.listIndexesFunc(nil)
+		return sc.listIndexesFunc(nil)
 	}
 	var regexes = make([]*regexp.Regexp, len(patterns))
 	for i, pattern := range patterns {
@@ -256,31 +466,28 @@ func (c *StatsClient) listIndexes(patterns ...string) (indexes []uint32, err err
 		}
 		return false
 	}
-	return c.listIndexesFunc(nameMatches)
+	return sc.listIndexesFunc(nameMatches)
 }
 
-func (c *StatsClient) listIndexesFunc(f func(name []byte) bool) (indexes []uint32, err error) {
+// listIndexesFunc lists stats indexes. The optional function
+// argument filters returned values or returns all if empty
+func (sc *StatsClient) listIndexesFunc(f func(name []byte) bool) (indexes []uint32, err error) {
 	if f == nil {
-		// there is around ~3150 stats, so to avoid too many allocations
+		// 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)
 	}
 
-	dirVector := c.getStatDirVector()
-	vecLen := uint32(vectorLen(dirVector))
+	dirVector := sc.GetDirectoryVector()
+	if dirVector == nil {
+		return nil, err
+	}
+	vecLen := *(*uint32)(vectorLen(dirVector))
 
 	for i := uint32(0); i < vecLen; i++ {
-		dirEntry := c.getStatDirIndex(dirVector, i)
-
+		_, dirName, _ := sc.GetStatDirOnIndex(dirVector, i)
 		if f != nil {
-			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 || !f(name) {
+			if len(dirName) == 0 || !f(dirName) {
 				continue
 			}
 		}
@@ -289,54 +496,3 @@ func (c *StatsClient) listIndexesFunc(f func(name []byte) bool) (indexes []uint3
 
 	return indexes, nil
 }
-
-func (c *StatsClient) entryName(index uint32) (string, error) {
-	dirVector := c.getStatDirVector()
-	vecLen := uint32(vectorLen(dirVector))
-
-	if index >= vecLen {
-		return "", fmt.Errorf("stat entry index %d out of range (%d)", index, vecLen)
-	}
-
-	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
-		}
-	}
-
-	return string(name), nil
-}
-
-func (c *StatsClient) dumpEntries(indexes []uint32) (entries []adapter.StatEntry, err error) {
-	entries = make([]adapter.StatEntry, 0, len(indexes))
-
-	dirVector := c.getStatDirVector()
-
-	for _, index := range indexes {
-		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
-			}
-		}
-		if len(name) == 0 {
-			continue
-		}
-
-		entry := adapter.StatEntry{
-			Name: append([]byte(nil), name...),
-			Type: adapter.StatType(dirEntry.directoryType),
-			Data: c.copyEntryData(dirEntry),
-		}
-		entries = append(entries, entry)
-	}
-
-	return entries, nil
-}