core/stats.go

   1 package core
   2
   3 import (
   4         "path"
   5         "strings"
   6         "sync/atomic"
   7         "time"
   8
   9         "git.fd.io/govpp.git/adapter"
  10         "git.fd.io/govpp.git/api"
  11 )
  12
  13 var (
  14         RetryUpdateCount = 10
  15         RetryUpdateDelay = time.Millisecond * 10
  16 )
  17
  18 const (
  19         SystemStatsPrefix               = "/sys/"
  20         SystemStats_VectorRate          = SystemStatsPrefix + "vector_rate"
  21         SystemStats_NumWorkerThreads    = SystemStatsPrefix + "num_worker_threads"
  22         SystemStats_VectorRatePerWorker = SystemStatsPrefix + "vector_rate_per_worker"
  23         SystemStats_InputRate           = SystemStatsPrefix + "input_rate"
  24         SystemStats_LastUpdate          = SystemStatsPrefix + "last_update"
  25         SystemStats_LastStatsClear      = SystemStatsPrefix + "last_stats_clear"
  26         SystemStats_Heartbeat           = SystemStatsPrefix + "heartbeat"
  27
  28         NodeStatsPrefix    = "/sys/node/"
  29         NodeStats_Names    = NodeStatsPrefix + "names"
  30         NodeStats_Clocks   = NodeStatsPrefix + "clocks"
  31         NodeStats_Vectors  = NodeStatsPrefix + "vectors"
  32         NodeStats_Calls    = NodeStatsPrefix + "calls"
  33         NodeStats_Suspends = NodeStatsPrefix + "suspends"
  34
  35         BufferStatsPrefix     = "/buffer-pools/"
  36         BufferStats_Cached    = "cached"
  37         BufferStats_Used      = "used"
  38         BufferStats_Available = "available"
  39
  40         CounterStatsPrefix = "/err/"
  41
  42         InterfaceStatsPrefix         = "/if/"
  43         InterfaceStats_Names         = InterfaceStatsPrefix + "names"
  44         InterfaceStats_Drops         = InterfaceStatsPrefix + "drops"
  45         InterfaceStats_Punt          = InterfaceStatsPrefix + "punt"
  46         InterfaceStats_IP4           = InterfaceStatsPrefix + "ip4"
  47         InterfaceStats_IP6           = InterfaceStatsPrefix + "ip6"
  48         InterfaceStats_RxNoBuf       = InterfaceStatsPrefix + "rx-no-buf"
  49         InterfaceStats_RxMiss        = InterfaceStatsPrefix + "rx-miss"
  50         InterfaceStats_RxError       = InterfaceStatsPrefix + "rx-error"
  51         InterfaceStats_TxError       = InterfaceStatsPrefix + "tx-error"
  52         InterfaceStats_Mpls          = InterfaceStatsPrefix + "mpls"
  53         InterfaceStats_Rx            = InterfaceStatsPrefix + "rx"
  54         InterfaceStats_RxUnicast     = InterfaceStatsPrefix + "rx-unicast"
  55         InterfaceStats_RxMulticast   = InterfaceStatsPrefix + "rx-multicast"
  56         InterfaceStats_RxBroadcast   = InterfaceStatsPrefix + "rx-broadcast"
  57         InterfaceStats_Tx            = InterfaceStatsPrefix + "tx"
  58         InterfaceStats_TxUnicast     = InterfaceStatsPrefix + "tx-unicast"
  59         InterfaceStats_TxUnicastMiss = InterfaceStatsPrefix + "tx-unicast-miss"
  60         InterfaceStats_TxMulticast   = InterfaceStatsPrefix + "tx-multicast"
  61         InterfaceStats_TxBroadcast   = InterfaceStatsPrefix + "tx-broadcast"
  62
  63         // TODO: network stats
  64         NetworkStatsPrefix     = "/net/"
  65         NetworkStats_RouteTo   = NetworkStatsPrefix + "route/to"
  66         NetworkStats_RouteVia  = NetworkStatsPrefix + "route/via"
  67         NetworkStats_MRoute    = NetworkStatsPrefix + "mroute"
  68         NetworkStats_Adjacency = NetworkStatsPrefix + "adjacency"
  69         NetworkStats_Punt      = NetworkStatsPrefix + "punt"
  70 )
  71
  72 type StatsConnection struct {
  73         statsClient adapter.StatsAPI
  74
  75         // connected is true if the adapter is connected to VPP
  76         connected uint32
  77
  78         errorStatsData *adapter.StatDir
  79         nodeStatsData  *adapter.StatDir
  80         ifaceStatsData *adapter.StatDir
  81         sysStatsData   *adapter.StatDir
  82         bufStatsData   *adapter.StatDir
  83 }
  84
  85 func newStatsConnection(stats adapter.StatsAPI) *StatsConnection {
  86         return &StatsConnection{
  87                 statsClient: stats,
  88         }
  89 }
  90
  91 // Connect connects to Stats API using specified adapter and returns a connection handle.
  92 // This call blocks until it is either connected, or an error occurs.
  93 // Only one connection attempt will be performed.
  94 func ConnectStats(stats adapter.StatsAPI) (*StatsConnection, error) {
  95         c := newStatsConnection(stats)
  96
  97         if err := c.connectClient(); err != nil {
  98                 return nil, err
  99         }
 100
 101         return c, nil
 102 }
 103
 104 func (c *StatsConnection) connectClient() error {
 105         log.Debug("Connecting to stats..")
 106
 107         if err := c.statsClient.Connect(); err != nil {
 108                 return err
 109         }
 110
 111         log.Debugf("Connected to stats.")
 112
 113         // store connected state
 114         atomic.StoreUint32(&c.connected, 1)
 115
 116         return nil
 117 }
 118
 119 // Disconnect disconnects from Stats API and releases all connection-related resources.
 120 func (c *StatsConnection) Disconnect() {
 121         if c == nil {
 122                 return
 123         }
 124         if c.statsClient != nil {
 125                 c.disconnectClient()
 126         }
 127 }
 128
 129 func (c *StatsConnection) disconnectClient() {
 130         if atomic.CompareAndSwapUint32(&c.connected, 1, 0) {
 131                 if err := c.statsClient.Disconnect(); err != nil {
 132                         log.Debugf("disconnecting stats client failed: %v", err)
 133                 }
 134         }
 135 }
 136
 137 func (c *StatsConnection) updateStats(statDir **adapter.StatDir, patterns ...string) error {
 138         if statDir == nil {
 139                 panic("statDir must not nil")
 140         }
 141         try := func() error {
 142                 if (*statDir) == nil {
 143                         dir, err := c.statsClient.PrepareDir(patterns...)
 144                         if err != nil {
 145                                 log.Debugln("preparing dir failed:", err)
 146                                 return err
 147                         }
 148                         *statDir = dir
 149                 } else {
 150                         if err := c.statsClient.UpdateDir(*statDir); err != nil {
 151                                 log.Debugln("updating dir failed:", err)
 152                                 *statDir = nil
 153                                 return err
 154                         }
 155                 }
 156
 157                 return nil
 158         }
 159         var err error
 160         for r := 0; r < RetryUpdateCount; r++ {
 161                 if err = try(); err == nil {
 162                         if r > 0 {
 163                                 log.Debugf("retry successfull (r=%d)", r)
 164                         }
 165                         return nil
 166                 } else if err == adapter.ErrStatsDirStale || err == adapter.ErrStatsDataBusy {
 167                         // retrying
 168                         if r > 1 {
 169                                 log.Debugf("sleeping for %v before next try", RetryUpdateDelay)
 170                                 time.Sleep(RetryUpdateDelay)
 171                         }
 172                 } else {
 173                         // error is not retryable
 174                         break
 175                 }
 176         }
 177         return err
 178 }
 179
 180 // UpdateSystemStats retrieves VPP system stats.
 181 func (c *StatsConnection) GetSystemStats(sysStats *api.SystemStats) (err error) {
 182         if err := c.updateStats(&c.sysStatsData, SystemStatsPrefix); err != nil {
 183                 return err
 184         }
 185
 186         for _, stat := range c.sysStatsData.Entries {
 187                 var val uint64
 188                 if s, ok := stat.Data.(adapter.ScalarStat); ok {
 189                         val = uint64(s)
 190                 }
 191                 switch string(stat.Name) {
 192                 case SystemStats_VectorRate:
 193                         sysStats.VectorRate = val
 194                 case SystemStats_NumWorkerThreads:
 195                         sysStats.NumWorkerThreads = val
 196                 case SystemStats_VectorRatePerWorker:
 197                         var vals []uint64
 198                         if ss, ok := stat.Data.(adapter.SimpleCounterStat); ok {
 199                                 vals = make([]uint64, len(ss))
 200                                 for w := range ss {
 201                                         vals[w] = uint64(ss[w][0])
 202                                 }
 203                         }
 204                         sysStats.VectorRatePerWorker = vals
 205                 case SystemStats_InputRate:
 206                         sysStats.InputRate = val
 207                 case SystemStats_LastUpdate:
 208                         sysStats.LastUpdate = val
 209                 case SystemStats_LastStatsClear:
 210                         sysStats.LastStatsClear = val
 211                 case SystemStats_Heartbeat:
 212                         sysStats.Heartbeat = val
 213                 }
 214         }
 215
 216         return nil
 217 }
 218
 219 // GetErrorStats retrieves VPP error stats.
 220 func (c *StatsConnection) GetErrorStats(errorStats *api.ErrorStats) (err error) {
 221         if err := c.updateStats(&c.errorStatsData, CounterStatsPrefix); err != nil {
 222                 return err
 223         }
 224
 225         if errorStats.Errors == nil || len(errorStats.Errors) != len(c.errorStatsData.Entries) {
 226                 errorStats.Errors = make([]api.ErrorCounter, len(c.errorStatsData.Entries))
 227                 for i := 0; i < len(c.errorStatsData.Entries); i++ {
 228                         errorStats.Errors[i].CounterName = string(c.errorStatsData.Entries[i].Name)
 229                 }
 230         }
 231
 232         for i, stat := range c.errorStatsData.Entries {
 233                 if stat.Type != adapter.ErrorIndex {
 234                         continue
 235                 }
 236                 if errStat, ok := stat.Data.(adapter.ErrorStat); ok {
 237                         errorStats.Errors[i].Value = uint64(errStat)
 238                 }
 239         }
 240
 241         return nil
 242 }
 243
 244 func (c *StatsConnection) GetNodeStats(nodeStats *api.NodeStats) (err error) {
 245         if err := c.updateStats(&c.nodeStatsData, NodeStatsPrefix); err != nil {
 246                 return err
 247         }
 248
 249         prepNodes := func(l int) {
 250                 if nodeStats.Nodes == nil || len(nodeStats.Nodes) != l {
 251                         nodeStats.Nodes = make([]api.NodeCounters, l)
 252                         for i := 0; i < l; i++ {
 253                                 nodeStats.Nodes[i].NodeIndex = uint32(i)
 254                         }
 255                 }
 256         }
 257         perNode := func(stat adapter.StatEntry, fn func(*api.NodeCounters, uint64)) {
 258                 if s, ok := stat.Data.(adapter.SimpleCounterStat); ok {
 259                         prepNodes(len(s[0]))
 260                         for i := range nodeStats.Nodes {
 261                                 val := adapter.ReduceSimpleCounterStatIndex(s, i)
 262                                 fn(&nodeStats.Nodes[i], val)
 263                         }
 264                 }
 265         }
 266
 267         for _, stat := range c.nodeStatsData.Entries {
 268                 switch string(stat.Name) {
 269                 case NodeStats_Names:
 270                         if stat, ok := stat.Data.(adapter.NameStat); ok {
 271                                 prepNodes(len(stat))
 272                                 for i, nc := range nodeStats.Nodes {
 273                                         if nc.NodeName != string(stat[i]) {
 274                                                 nc.NodeName = string(stat[i])
 275                                                 nodeStats.Nodes[i] = nc
 276                                         }
 277                                 }
 278                         }
 279                 case NodeStats_Clocks:
 280                         perNode(stat, func(node *api.NodeCounters, val uint64) {
 281                                 node.Clocks = val
 282                         })
 283                 case NodeStats_Vectors:
 284                         perNode(stat, func(node *api.NodeCounters, val uint64) {
 285                                 node.Vectors = val
 286                         })
 287                 case NodeStats_Calls:
 288                         perNode(stat, func(node *api.NodeCounters, val uint64) {
 289                                 node.Calls = val
 290                         })
 291                 case NodeStats_Suspends:
 292                         perNode(stat, func(node *api.NodeCounters, val uint64) {
 293                                 node.Suspends = val
 294                         })
 295                 }
 296         }
 297
 298         return nil
 299 }
 300
 301 // GetInterfaceStats retrieves VPP per interface stats.
 302 func (c *StatsConnection) GetInterfaceStats(ifaceStats *api.InterfaceStats) (err error) {
 303         if err := c.updateStats(&c.ifaceStatsData, InterfaceStatsPrefix); err != nil {
 304                 return err
 305         }
 306
 307         prep := func(l int) {
 308                 if ifaceStats.Interfaces == nil || len(ifaceStats.Interfaces) != l {
 309                         ifaceStats.Interfaces = make([]api.InterfaceCounters, l)
 310                         for i := 0; i < l; i++ {
 311                                 ifaceStats.Interfaces[i].InterfaceIndex = uint32(i)
 312                         }
 313                 }
 314         }
 315         perNode := func(stat adapter.StatEntry, fn func(*api.InterfaceCounters, uint64)) {
 316                 if s, ok := stat.Data.(adapter.SimpleCounterStat); ok {
 317                         prep(len(s[0]))
 318                         for i := range ifaceStats.Interfaces {
 319                                 val := adapter.ReduceSimpleCounterStatIndex(s, i)
 320                                 fn(&ifaceStats.Interfaces[i], val)
 321                         }
 322                 }
 323         }
 324         perNodeComb := func(stat adapter.StatEntry, fn func(*api.InterfaceCounters, [2]uint64)) {
 325                 if s, ok := stat.Data.(adapter.CombinedCounterStat); ok {
 326                         prep(len(s[0]))
 327                         for i := range ifaceStats.Interfaces {
 328                                 val := adapter.ReduceCombinedCounterStatIndex(s, i)
 329                                 fn(&ifaceStats.Interfaces[i], val)
 330                         }
 331                 }
 332         }
 333
 334         for _, stat := range c.ifaceStatsData.Entries {
 335                 switch string(stat.Name) {
 336                 case InterfaceStats_Names:
 337                         if stat, ok := stat.Data.(adapter.NameStat); ok {
 338                                 prep(len(stat))
 339                                 for i, nc := range ifaceStats.Interfaces {
 340                                         if nc.InterfaceName != string(stat[i]) {
 341                                                 nc.InterfaceName = string(stat[i])
 342                                                 ifaceStats.Interfaces[i] = nc
 343                                         }
 344                                 }
 345                         }
 346                 case InterfaceStats_Drops:
 347                         perNode(stat, func(iface *api.InterfaceCounters, val uint64) {
 348                                 iface.Drops = val
 349                         })
 350                 case InterfaceStats_Punt:
 351                         perNode(stat, func(iface *api.InterfaceCounters, val uint64) {
 352                                 iface.Punts = val
 353                         })
 354                 case InterfaceStats_IP4:
 355                         perNode(stat, func(iface *api.InterfaceCounters, val uint64) {
 356                                 iface.IP4 = val
 357                         })
 358                 case InterfaceStats_IP6:
 359                         perNode(stat, func(iface *api.InterfaceCounters, val uint64) {
 360                                 iface.IP6 = val
 361                         })
 362                 case InterfaceStats_RxNoBuf:
 363                         perNode(stat, func(iface *api.InterfaceCounters, val uint64) {
 364                                 iface.RxNoBuf = val
 365                         })
 366                 case InterfaceStats_RxMiss:
 367                         perNode(stat, func(iface *api.InterfaceCounters, val uint64) {
 368                                 iface.RxMiss = val
 369                         })
 370                 case InterfaceStats_RxError:
 371                         perNode(stat, func(iface *api.InterfaceCounters, val uint64) {
 372                                 iface.RxErrors = val
 373                         })
 374                 case InterfaceStats_TxError:
 375                         perNode(stat, func(iface *api.InterfaceCounters, val uint64) {
 376                                 iface.TxErrors = val
 377                         })
 378                 case InterfaceStats_Mpls:
 379                         perNode(stat, func(iface *api.InterfaceCounters, val uint64) {
 380                                 iface.Mpls = val
 381                         })
 382                 case InterfaceStats_Rx:
 383                         perNodeComb(stat, func(iface *api.InterfaceCounters, val [2]uint64) {
 384                                 iface.Rx.Packets = val[0]
 385                                 iface.Rx.Bytes = val[1]
 386                         })
 387                 case InterfaceStats_RxUnicast:
 388                         perNodeComb(stat, func(iface *api.InterfaceCounters, val [2]uint64) {
 389                                 iface.RxUnicast.Packets = val[0]
 390                                 iface.RxUnicast.Bytes = val[1]
 391                         })
 392                 case InterfaceStats_RxMulticast:
 393                         perNodeComb(stat, func(iface *api.InterfaceCounters, val [2]uint64) {
 394                                 iface.RxMulticast.Packets = val[0]
 395                                 iface.RxMulticast.Bytes = val[1]
 396                         })
 397                 case InterfaceStats_RxBroadcast:
 398                         perNodeComb(stat, func(iface *api.InterfaceCounters, val [2]uint64) {
 399                                 iface.RxBroadcast.Packets = val[0]
 400                                 iface.RxBroadcast.Bytes = val[1]
 401                         })
 402                 case InterfaceStats_Tx:
 403                         perNodeComb(stat, func(iface *api.InterfaceCounters, val [2]uint64) {
 404                                 iface.Tx.Packets = val[0]
 405                                 iface.Tx.Bytes = val[1]
 406                         })
 407                 case InterfaceStats_TxUnicastMiss:
 408                         // tx-unicast-miss was a spelling mistake in older versions
 409                         //
 410                         fallthrough
 411                 case InterfaceStats_TxUnicast:
 412                         perNodeComb(stat, func(iface *api.InterfaceCounters, val [2]uint64) {
 413                                 iface.TxUnicast.Packets = val[0]
 414                                 iface.TxUnicast.Bytes = val[1]
 415                         })
 416                 case InterfaceStats_TxMulticast:
 417                         perNodeComb(stat, func(iface *api.InterfaceCounters, val [2]uint64) {
 418                                 iface.TxMulticast.Packets = val[0]
 419                                 iface.TxMulticast.Bytes = val[1]
 420                         })
 421                 case InterfaceStats_TxBroadcast:
 422                         perNodeComb(stat, func(iface *api.InterfaceCounters, val [2]uint64) {
 423                                 iface.TxBroadcast.Packets = val[0]
 424                                 iface.TxBroadcast.Bytes = val[1]
 425                         })
 426                 }
 427         }
 428
 429         return nil
 430 }
 431
 432 // GetBufferStats retrieves VPP buffer pools stats.
 433 func (c *StatsConnection) GetBufferStats(bufStats *api.BufferStats) (err error) {
 434         if err := c.updateStats(&c.bufStatsData, BufferStatsPrefix); err != nil {
 435                 return err
 436         }
 437
 438         if bufStats.Buffer == nil {
 439                 bufStats.Buffer = make(map[string]api.BufferPool)
 440         }
 441
 442         for _, stat := range c.bufStatsData.Entries {
 443                 d, f := path.Split(string(stat.Name))
 444                 d = strings.TrimSuffix(d, "/")
 445
 446                 name := strings.TrimPrefix(d, BufferStatsPrefix)
 447                 b, ok := bufStats.Buffer[name]
 448                 if !ok {
 449                         b.PoolName = name
 450                 }
 451
 452                 var val float64
 453                 s, ok := stat.Data.(adapter.ScalarStat)
 454                 if ok {
 455                         val = float64(s)
 456                 }
 457                 switch f {
 458                 case BufferStats_Cached:
 459                         b.Cached = val
 460                 case BufferStats_Used:
 461                         b.Used = val
 462                 case BufferStats_Available:
 463                         b.Available = val
 464                 }
 465
 466                 bufStats.Buffer[name] = b
 467         }
 468
 469         return nil
 470 }