Add comments to provide info about VPP requirements

[govpp.git] / adapter / vppapiclient / stat_client.go

diff --git a/adapter/vppapiclient/stat_client.go b/adapter/vppapiclient/stat_client.go
index 5f3b932..ac47339 100644 (file)
--- a/adapter/vppapiclient/stat_client.go
+++ b/adapter/vppapiclient/stat_client.go
@@ -24,7 +24,7 @@ package vppapiclient
 #include <stdio.h>
 #include <stdint.h>
 #include <arpa/inet.h>
-#include <vpp-api/client/vppapiclient.h>
+#include <vpp-api/client/vppapiclient.h> // VPP has to be installed!
 #include <vpp-api/client/stat_client.h>
 
 static int
@@ -40,7 +40,7 @@ govpp_stat_disconnect()
 }
 
 static uint32_t*
-govpp_stat_segment_ls(uint8_t ** pattern)
+govpp_stat_segment_ls(uint8_t **pattern)
 {
        return stat_segment_ls(pattern);
 }
@@ -135,6 +135,18 @@ govpp_stat_segment_data_get_combined_counter_index_bytes(stat_segment_data_t *da
        return data->combined_counter_vec[index][index2].bytes;
 }
 
+static uint8_t**
+govpp_stat_segment_data_get_name_vector(stat_segment_data_t *data)
+{
+       return data->name_vector; // VPP 19.04 is required!
+}
+
+static char*
+govpp_stat_segment_data_get_name_vector_index(stat_segment_data_t *data, int index)
+{
+       return data->name_vector[index]; // VPP 19.04 is required!
+}
+
 static void
 govpp_stat_segment_data_free(stat_segment_data_t *data)
 {
@@ -149,6 +161,7 @@ govpp_stat_segment_string_vector(uint8_t ** string_vector, char *string)
 */
 import "C"
 import (
+       "errors"
        "fmt"
        "os"
        "unsafe"
@@ -156,26 +169,38 @@ import (
        "git.fd.io/govpp.git/adapter"
 )
 
+var (
+       ErrStatDirBusy  = errors.New("stat dir busy")
+       ErrStatDumpBusy = errors.New("stat dump busy")
+)
+
 var (
        // DefaultStatSocket is the default path for the VPP stat socket file.
        DefaultStatSocket = "/run/vpp/stats.sock"
 )
 
-// StatClient is the default implementation of StatsAPI.
-type StatClient struct {
+// global VPP stats API client, library vppapiclient only supports
+// single connection at a time
+var globalStatClient *statClient
+
+// stubStatClient is the default implementation of StatsAPI.
+type statClient struct {
        socketName string
 }
 
 // NewStatClient returns new VPP stats API client.
-func NewStatClient(socketName string) *StatClient {
-       return &StatClient{
+func NewStatClient(socketName string) adapter.StatsAPI {
+       return &statClient{
                socketName: socketName,
        }
 }
 
-func (c *StatClient) Connect() error {
-       var sockName string
+func (c *statClient) Connect() error {
+       if globalStatClient != nil {
+               return fmt.Errorf("already connected to stats API, disconnect first")
+       }
 
+       var sockName string
        if c.socketName == "" {
                sockName = DefaultStatSocket
        } else {
@@ -187,16 +212,22 @@ func (c *StatClient) Connect() error {
                return fmt.Errorf("connecting to VPP stats API failed (rc=%v)", rc)
        }
 
+       globalStatClient = c
        return nil
 }
 
-func (c *StatClient) Disconnect() error {
+func (c *statClient) Disconnect() error {
+       globalStatClient = nil
+
        C.govpp_stat_disconnect()
        return nil
 }
 
-func (c *StatClient) ListStats(patterns ...string) (stats []string, err error) {
+func (c *statClient) ListStats(patterns ...string) (stats []string, err error) {
        dir := C.govpp_stat_segment_ls(convertStringSlice(patterns))
+       if dir == nil {
+               return nil, ErrStatDirBusy
+       }
        defer C.govpp_stat_segment_vec_free(unsafe.Pointer(dir))
 
        l := C.govpp_stat_segment_vec_len(unsafe.Pointer(dir))
@@ -209,11 +240,17 @@ func (c *StatClient) ListStats(patterns ...string) (stats []string, err error) {
        return stats, nil
 }
 
-func (c *StatClient) DumpStats(patterns ...string) (stats []*adapter.StatEntry, err error) {
+func (c *statClient) DumpStats(patterns ...string) (stats []*adapter.StatEntry, err error) {
        dir := C.govpp_stat_segment_ls(convertStringSlice(patterns))
+       if dir == nil {
+               return nil, ErrStatDirBusy
+       }
        defer C.govpp_stat_segment_vec_free(unsafe.Pointer(dir))
 
        dump := C.govpp_stat_segment_dump(dir)
+       if dump == nil {
+               return nil, ErrStatDumpBusy
+       }
        defer C.govpp_stat_segment_data_free(dump)
 
        l := C.govpp_stat_segment_vec_len(unsafe.Pointer(dump))
@@ -239,8 +276,8 @@ func (c *StatClient) DumpStats(patterns ...string) (stats []*adapter.StatEntry,
                        length := int(C.govpp_stat_segment_vec_len(unsafe.Pointer(C.govpp_stat_segment_data_get_simple_counter(&v))))
                        vector := make([][]adapter.Counter, length)
                        for k := 0; k < length; k++ {
-                               for j := 0; j < int(C.govpp_stat_segment_vec_len(unsafe.Pointer(C.govpp_stat_segment_data_get_simple_counter_index(&v, _Ctype_int(k))))); j++ {
-                                       vector[k] = append(vector[k], adapter.Counter(C.govpp_stat_segment_data_get_simple_counter_index_value(&v, _Ctype_int(k), _Ctype_int(j))))
+                               for j := 0; j < int(C.govpp_stat_segment_vec_len(unsafe.Pointer(C.govpp_stat_segment_data_get_simple_counter_index(&v, C.int(k))))); j++ {
+                                       vector[k] = append(vector[k], adapter.Counter(C.govpp_stat_segment_data_get_simple_counter_index_value(&v, C.int(k), C.int(j))))
                                }
                        }
                        stat.Data = adapter.SimpleCounterStat(vector)
@@ -249,17 +286,30 @@ func (c *StatClient) DumpStats(patterns ...string) (stats []*adapter.StatEntry,
                        length := int(C.govpp_stat_segment_vec_len(unsafe.Pointer(C.govpp_stat_segment_data_get_combined_counter(&v))))
                        vector := make([][]adapter.CombinedCounter, length)
                        for k := 0; k < length; k++ {
-                               for j := 0; j < int(C.govpp_stat_segment_vec_len(unsafe.Pointer(C.govpp_stat_segment_data_get_combined_counter_index(&v, _Ctype_int(k))))); j++ {
+                               for j := 0; j < int(C.govpp_stat_segment_vec_len(unsafe.Pointer(C.govpp_stat_segment_data_get_combined_counter_index(&v, C.int(k))))); j++ {
                                        vector[k] = append(vector[k], adapter.CombinedCounter{
-                                               Packets: adapter.Counter(C.govpp_stat_segment_data_get_combined_counter_index_packets(&v, _Ctype_int(k), _Ctype_int(j))),
-                                               Bytes:   adapter.Counter(C.govpp_stat_segment_data_get_combined_counter_index_bytes(&v, _Ctype_int(k), _Ctype_int(j))),
+                                               Packets: adapter.Counter(C.govpp_stat_segment_data_get_combined_counter_index_packets(&v, C.int(k), C.int(j))),
+                                               Bytes:   adapter.Counter(C.govpp_stat_segment_data_get_combined_counter_index_bytes(&v, C.int(k), C.int(j))),
                                        })
                                }
                        }
                        stat.Data = adapter.CombinedCounterStat(vector)
 
+               case adapter.NameVector:
+                       length := int(C.govpp_stat_segment_vec_len(unsafe.Pointer(C.govpp_stat_segment_data_get_name_vector(&v))))
+                       var vector []adapter.Name
+                       for k := 0; k < length; k++ {
+                               s := C.govpp_stat_segment_data_get_name_vector_index(&v, C.int(k))
+                               var name adapter.Name
+                               if s != nil {
+                                       name = adapter.Name(C.GoString(s))
+                               }
+                               vector = append(vector, name)
+                       }
+                       stat.Data = adapter.NameStat(vector)
+
                default:
-                       fmt.Fprintf(os.Stderr, "invalid stat type: %v (%d)", typ, typ)
+                       fmt.Fprintf(os.Stderr, "invalid stat type: %v (%v)\n", typ, name)
                        continue
 
                }