22 Commits

Author SHA1 Message Date
Pim van Pelt
06a1f4401d Release 1.2.3-1 2025-11-23 11:07:02 +01:00
Pim van Pelt
b450e02b8d Filter interface data from stats segment by known vpp_iface; this avoids an issue in VPP where deleted interfaces remain in the stats segment 2025-11-23 11:05:05 +01:00
Pim van Pelt
5e36d5c926 Release 1.2.2-1 2025-11-23 10:36:13 +01:00
Pim van Pelt
16bebb0ece Simplify the ifmib integration, stop using reflection, and move to counter updates
Update tests.
2025-11-23 10:31:23 +01:00
Pim van Pelt
cdc8765a9e Cut release 1.2.1-1 2025-11-22 06:26:55 +01:00
Pim van Pelt
9596e16887 A few cosmetic changes in session handling 2025-11-22 06:18:01 +01:00
Pim van Pelt
4935f5a8ef Refactor code: clear old OIDs in the Session before updating them 2025-11-22 06:17:23 +01:00
Pim van Pelt
b6d2e3b629 Upgrade go-agentx to v0.3.0, containing my ordering fix 2025-11-21 10:08:23 +01:00
Pim van Pelt
a0d5c61643 Remove redundant constructor, h/t sergio 2025-11-15 22:42:04 +01:00
Pim van Pelt
27c7a5bcae Cut 1.1.6-1 release 2025-11-08 01:40:57 +01:00
Pim van Pelt
9e9103c184 Remove fork of go-agentx because upstream was fixed 2025-11-08 01:36:05 +01:00
Pim van Pelt
b358cc2443 Bump dh from 13.11 to 13.24 2025-11-08 01:32:28 +01:00
Pim van Pelt
ead795674c lint fix: staticcheck and null derefs 2025-07-03 07:13:42 +02:00
Pim van Pelt
dce4750b0f Bump version v1.1.5-1 2025-07-02 23:16:20 +02:00
Pim van Pelt
d65e055710 Fix test 2025-07-02 22:31:23 +02:00
Pim van Pelt
8ed14834f5 tighten up logging 2025-06-24 07:51:37 +02:00
Pim van Pelt
3401c96112 Make statsmanager and interfacemanager independent. Add reconnect logic for EventMonitoring 2025-06-24 07:36:10 +02:00
Pim van Pelt
1889934a9c Release 1.1.4-1 2025-06-24 07:06:09 +02:00
Pim van Pelt
e93156324d Add tests 2025-06-24 07:03:34 +02:00
Pim van Pelt
bdaa2e366b Refactor vpp.go to have the connection mgmt and vpp_*.go to have one Manager each 2025-06-24 07:00:52 +02:00
Pim van Pelt
96b9dd501d Update paths 2025-06-24 06:40:40 +02:00
Pim van Pelt
70cb134dcf Add a note about stats-collect-rx and stats-collect-tx 2025-06-24 06:37:30 +02:00
65 changed files with 1581 additions and 3068 deletions

81
debian/changelog vendored
View File

@@ -1,3 +1,84 @@
govpp-snmp-agentx (1.2.3-1) bookworm; urgency=medium
* Fix VPP stats filtering to exclude deleted interfaces
* Add interface manager integration to stats manager
* Filter out stale interface statistics from deleted interfaces
* Improve stats reliability by cross-referencing with current interface list
-- Pim van Pelt <pim@ipng.ch> Sat, 23 Nov 2024 00:00:00 +0000
govpp-snmp-agentx (1.2.2-1) bookworm; urgency=medium
* Simplify ifmib integration by removing reflection usage
* Move to direct counter updates for improved performance
* Refactor interface tracking with simplified state management
* Remove dependency on reflection for handler manipulation
* Fix test suite to match refactored ifmib implementation
-- Pim van Pelt <pim@ipng.ch> Sat, 23 Nov 2024 00:00:00 +0000
govpp-snmp-agentx (1.2.1-1) bookworm; urgency=medium
* Fix OID visibility bug after go-agentx 0.3.0 upgrade
* Use reflection to clear handler contents instead of creating new handlers
* Simplify AgentX session creation and registration logic
* Add proper session cleanup method (Close())
* Improve error handling in AgentX interactions
* Code cleanup and maintainability improvements
-- Pim van Pelt <pim@ipng.ch> Fri, 22 Nov 2024 00:00:00 +0000
govpp-snmp-agentx (1.2.0-1) bookworm; urgency=medium
* Update go-agentx dependency from 0.2.1 to 0.3.0 to fix compilation issues
* Adapt to breaking changes in go-agentx Session API (now requires nameOID, name, handler)
* Update Client configuration to use dial options (WithTimeout, WithReconnectInterval)
* Remove access to unexported Session.Handler field (API change)
* NOTE: This version fixes compilation broken in 1.1.6-1 and 1.1.7-1
-- Pim van Pelt <pim@ipng.ch> Wed, 20 Nov 2024 00:00:00 +0000
govpp-snmp-agentx (1.1.7-1) bookworm; urgency=critical
* Refactor VPPClient constructor to use idiomatic Go patterns
* Remove redundant NewVPPClient() constructor function
* Update all code to use direct struct initialization (&VPPClient{})
* Improve code maintainability and follow Go best practices
* WARNING: This version is BROKEN due to go-agentx 0.2.1 incompatibility
-- Pim van Pelt <pim@ipng.ch> Fri, 15 Nov 2024 00:00:00 +0000
govpp-snmp-agentx (1.1.6-1) bookworm; urgency=critical
* Replace forked go-agentx dependency with upstream github.com/posteo/go-agentx
* Remove local src/go-agentx/ directory and use official upstream package
* Upgrade to go-agentx v0.2.1 from official GitHub repository
* Improve dependency management and reduce maintenance overhead
* WARNING: This version is BROKEN due to go-agentx 0.2.1 incompatibility
-- Pim van Pelt <pim@ipng.ch> Fri, 08 Nov 2024 00:00:00 +0000
govpp-snmp-agentx (1.1.5-1) bookworm; urgency=medium
* Implement automatic interface deletion handling in IF-MIB
* Simplify interface event processing by removing separate delete callbacks
* Remove unused functions and clean up codebase (RemoveInterface, rebuildMIB)
* Improve interface state synchronization between VPP and SNMP MIB
* Automatically detect and remove deleted interfaces during updates
-- Pim van Pelt <pim@ipng.ch> Wed, 02 Jul 2025 00:00:00 +0000
govpp-snmp-agentx (1.1.4-1) bookworm; urgency=medium
* Major VPP module refactoring with improved separation of concerns
* Replace legacy global functions with structured VPPClient, InterfaceManager, and StatsManager
* Fix stats polling timing bug - now properly respects vppstats.period setting
* Add comprehensive test suite with 64.6% code coverage
* Improve connection management and error handling
* Remove legacy compatibility functions for cleaner API
-- Pim van Pelt <pim@ipng.ch> Mon, 24 Jun 2025 01:00:00 +0000
govpp-snmp-agentx (1.1.3-1) bookworm; urgency=medium
* Use fallback packet counters when VPP unicast stats are unavailable

View File

@@ -1,9 +1,9 @@
# Automatically added by dh_installsystemd/13.11.4
# Automatically added by dh_installsystemd/13.24.2
if [ "$1" = remove ] && [ -d /run/systemd/system ] ; then
systemctl --system daemon-reload >/dev/null || true
fi
# End automatically added section
# Automatically added by dh_installsystemd/13.11.4
# Automatically added by dh_installsystemd/13.24.2
if [ "$1" = "purge" ]; then
if [ -x "/usr/bin/deb-systemd-helper" ]; then
deb-systemd-helper purge 'govpp-snmp-agentx.service' >/dev/null || true

View File

@@ -17,7 +17,7 @@ VPP Stats Socket → VPP Stats Client → Interface MIB → AgentX → SNMPd
The application consists of four main components:
1. **VPP Stats Client** (`src/vppstats/`): Connects to VPP stats socket and retrieves interface counters
1. **VPP Stats Client** (`src/vpp/`): Connects to VPP stats socket and retrieves interface counters
2. **Interface MIB** (`src/ifmib/`): Maps VPP statistics to SNMP IF-MIB structure
3. **AgentX Client** (`src/agentx/`): Handles AgentX protocol connection and MIB registration
4. **Main Application** (`src/main.go`): Orchestrates the components and handles configuration
@@ -188,6 +188,32 @@ snmpget -v2c -c public localhost 1.3.6.1.2.1.31.1.1.1.6.2000
- Stats socket accessible at `/var/run/vpp/stats.sock` (or custom path)
- Application must have read permissions on the stats socket
### VPP Packet Counter Configuration
For accurate unicast, multicast, and broadcast packet counters, VPP requires specific feature arc configurations:
#### Receive Packet Counters
To enable detailed RX packet counters (RxUnicast, RxMulticast, RxBroadcast), configure:
```
set interface feature <interface> stats-collect-rx arc device-input
```
#### Transmit Packet Counters
To enable detailed TX packet counters (TxUnicast, TxMulticast, TxBroadcast), configure:
```
set interface feature <interface> stats-collect-tx arc interface-output
```
#### Fallback Behavior
If these features are not enabled, the detailed packet counters will be zero. The SNMP agent automatically falls back to using the total packet counters (Rx.Packets and Tx.Packets) for unicast packet reporting to maintain SNMP compatibility.
**Example Configuration:**
```bash
# Enable detailed packet counters for GigabitEthernet0/8/0
vppctl set interface feature GigabitEthernet0/8/0 stats-collect-rx arc device-input
vppctl set interface feature GigabitEthernet0/8/0 stats-collect-tx arc interface-output
```
### SNMP Requirements
- SNMP master agent running (net-snmp's snmpd)
@@ -314,9 +340,3 @@ upstream PR is merged.
3. Make your changes
4. Add tests if applicable
5. Submit a pull request
## Version History
- **v1.0.0**: Initial release with IF-MIB support
- **v1.1.0**: Added configurable interface index offset
- **v1.2.0**: Added Unix socket support for AgentX

View File

@@ -20,29 +20,27 @@ var (
// StartAgentXRoutine initializes the AgentX client and registers the interface MIB
func StartAgentXRoutine(interfaceMIB *ifmib.InterfaceMIB) error {
var network, address string
// Determine network type based on address format
network := "tcp"
if strings.HasPrefix(*AgentXAddr, "/") {
network = "unix"
address = *AgentXAddr
} else {
network = "tcp"
address = *AgentXAddr
}
logger.Debugf("Connecting to AgentX at %s://%s", network, address)
logger.Debugf("Connecting to AgentX at %s://%s", network, *AgentXAddr)
client, err := agentx.Dial(network, address)
client, err := agentx.Dial(network, *AgentXAddr,
agentx.WithTimeout(1*time.Minute),
agentx.WithReconnectInterval(1*time.Second),
)
if err != nil {
return err
}
client.Timeout = 1 * time.Minute
client.ReconnectInterval = 1 * time.Second
// Register the interface MIB with the AgentX client
if err := interfaceMIB.RegisterWithClient(client); err != nil {
return err
}
logger.Printf("Successfully registered with AgentX at %s://%s", network, address)
logger.Printf("Successfully registered with AgentX at %s://%s", network, *AgentXAddr)
return nil
}

View File

@@ -1,4 +0,0 @@
agentx
Makefile
*.txt
vendor

View File

@@ -1,12 +0,0 @@
# This is the official list of agentx authors for copyright purposes.
# This file is distinct from the CONTRIBUTORS files.
# See the latter for an explanation.
# Names should be added to this file as
# Name or Organization <email address>
# The email address is not required for organizations.
# Please keep the list sorted.
Philipp Brüll <pb@simia.tech>
Posteo e.K. <opensource@posteo.de>

View File

@@ -1,191 +0,0 @@
All files in this repository are licensed as follows. If you contribute
to this repository, it is assumed that you license your contribution
under the same license unless you state otherwise.
All files Copyright (C) 2015 Canonical Ltd. unless otherwise specified in the file.
This software is licensed under the LGPLv3, included below.
As a special exception to the GNU Lesser General Public License version 3
("LGPL3"), the copyright holders of this Library give you permission to
convey to a third party a Combined Work that links statically or dynamically
to this Library without providing any Minimal Corresponding Source or
Minimal Application Code as set out in 4d or providing the installation
information set out in section 4e, provided that you comply with the other
provisions of LGPL3 and provided that you meet, for the Application the
terms and conditions of the license(s) which apply to the Application.
Except as stated in this special exception, the provisions of LGPL3 will
continue to comply in full to this Library. If you modify this Library, you
may apply this exception to your version of this Library, but you are not
obliged to do so. If you do not wish to do so, delete this exception
statement from your version. This exception does not (and cannot) modify any
license terms which apply to the Application, with which you must still
comply.
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.

View File

@@ -1,110 +0,0 @@
# AgentX
[![Documentation](https://godoc.org/github.com/posteo/go-agentx?status.svg)](http://godoc.org/github.com/posteo/go-agentx)
A library with a pure Go implementation of the [AgentX-Protocol](http://tools.ietf.org/html/rfc2741). The library is not yet feature-complete, but should be far enough to used in a production environment.
The AgentX-Protocol can be used to extend a snmp-daemon such that it dispatches the requests to an OID-subtree to your Go application. Those requests are than handled by this library and can be replied with metrics about your applications state.
## State
The library implements all variable types (Integer, OctetString, Null, ObjectIdentifier, IPAddress, Counter32, Gauge32, TimeTicks, Opaque, Counter64, NoSuchObject, NoSuchInstance, EndOfMIBView), but only some of the requests (Get, GetNext, GetBulk). Set-requests and Traps are not implemented yet.
## Helper
In order to provided metrics, your have to implement the `agentx.Handler` interface. For convenience, you can use the `agentx.ListHandler` implementation, which takes a list of OIDs and values and serves them if requested. An example is listed below.
## Example
```go
package main
import (
"log"
"net"
"time"
"github.com/posteo/go-agentx"
"github.com/posteo/go-agentx/pdu"
"github.com/posteo/go-agentx/value"
)
func main() {
client, err := agentx.Dial("tcp", "localhost:705")
if err != nil {
log.Fatalf(err)
}
client.Timeout = 1 * time.Minute
client.ReconnectInterval = 1 * time.Second
session, err := client.Session()
if err != nil {
log.Fatalf(err)
}
listHandler := &agentx.ListHandler{}
item := listHandler.Add("1.3.6.1.4.1.45995.3.1")
item.Type = pdu.VariableTypeInteger
item.Value = int32(-123)
item = listHandler.Add("1.3.6.1.4.1.45995.3.2")
item.Type = pdu.VariableTypeOctetString
item.Value = "echo test"
item = listHandler.Add("1.3.6.1.4.1.45995.3.3")
item.Type = pdu.VariableTypeNull
item.Value = nil
item = listHandler.Add("1.3.6.1.4.1.45995.3.4")
item.Type = pdu.VariableTypeObjectIdentifier
item.Value = "1.3.6.1.4.1.45995.1.5"
item = listHandler.Add("1.3.6.1.4.1.45995.3.5")
item.Type = pdu.VariableTypeIPAddress
item.Value = net.IP{10, 10, 10, 10}
item = listHandler.Add("1.3.6.1.4.1.45995.3.6")
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(123)
item = listHandler.Add("1.3.6.1.4.1.45995.3.7")
item.Type = pdu.VariableTypeGauge32
item.Value = uint32(123)
item = listHandler.Add("1.3.6.1.4.1.45995.3.8")
item.Type = pdu.VariableTypeTimeTicks
item.Value = 123 * time.Second
item = listHandler.Add("1.3.6.1.4.1.45995.3.9")
item.Type = pdu.VariableTypeOpaque
item.Value = []byte{1, 2, 3}
item = listHandler.Add("1.3.6.1.4.1.45995.3.10")
item.Type = pdu.VariableTypeCounter64
item.Value = uint64(12345678901234567890)
session.Handler = listHandler
if err := session.Register(127, value.MustParseOID("1.3.6.1.4.1.45995.3")); err != nil {
log.Fatalf(err)
}
for {
time.Sleep(100 * time.Millisecond)
}
}
```
## Connection lost
If the connection to the snmp-daemon is lost, the client tries to reconnect. Therefor the property `ReconnectInterval` has be set. It specifies a duration that is waited before a re-connect is tried.
If the client has open session or registrations, the client try to re-establish both on a successful re-connect.
## Project
The implementation was provided by [simia.tech (haftungsbeschränkt)](https://simia.tech).
## License
The project is licensed under LGPL 3.0 (see LICENSE file).

View File

@@ -1,217 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package agentx
import (
"bufio"
"fmt"
"io"
"log"
"net"
"strings"
"time"
"github.com/posteo/go-agentx/pdu"
"github.com/posteo/go-agentx/value"
)
// Client defines an agentx client.
type Client struct {
Timeout time.Duration
ReconnectInterval time.Duration
NameOID value.OID
Name string
network string
address string
conn net.Conn
requestChan chan *request
sessions map[uint32]*Session
}
// Dial connects to the provided agentX endpoint.
func Dial(network, address string) (*Client, error) {
conn, err := net.Dial(network, address)
if err != nil {
return nil, fmt.Errorf("dial %s %s: %w", network, address, err)
}
c := &Client{
network: network,
address: address,
conn: conn,
requestChan: make(chan *request),
sessions: make(map[uint32]*Session),
}
tx := c.runTransmitter()
rx := c.runReceiver()
c.runDispatcher(tx, rx)
return c, nil
}
// Close tears down the client.
func (c *Client) Close() error {
if err := c.conn.Close(); err != nil {
return fmt.Errorf("close connection: %w", err)
}
return nil
}
// Session sets up a new session.
func (c *Client) Session() (*Session, error) {
s := &Session{
client: c,
timeout: c.Timeout,
}
if err := s.open(c.NameOID, c.Name); err != nil {
return nil, err
}
c.sessions[s.ID()] = s
return s, nil
}
func (c *Client) runTransmitter() chan *pdu.HeaderPacket {
tx := make(chan *pdu.HeaderPacket)
go func() {
for headerPacket := range tx {
headerPacketBytes, err := headerPacket.MarshalBinary()
if err != nil {
log.Printf("marshal error: %v", err)
continue
}
writer := bufio.NewWriter(c.conn)
if _, err := writer.Write(headerPacketBytes); err != nil {
log.Printf("write error: %v", err)
continue
}
if err := writer.Flush(); err != nil {
log.Printf("flush error: %v", err)
continue
}
}
}()
return tx
}
func (c *Client) runReceiver() chan *pdu.HeaderPacket {
rx := make(chan *pdu.HeaderPacket)
go func() {
mainLoop:
for {
reader := bufio.NewReader(c.conn)
headerBytes := make([]byte, pdu.HeaderSize)
if _, err := reader.Read(headerBytes); err != nil {
if opErr, ok := err.(*net.OpError); ok && strings.HasSuffix(opErr.Error(), "use of closed network connection") {
return
}
if err == io.EOF {
log.Printf("lost connection - try to re-connect ...")
reopenLoop:
for {
time.Sleep(c.ReconnectInterval)
conn, err := net.Dial(c.network, c.address)
if err != nil {
log.Printf("try to reconnect: %v", err)
continue reopenLoop
}
c.conn = conn
go func() {
for _, session := range c.sessions {
delete(c.sessions, session.ID())
if err := session.reopen(); err != nil {
log.Printf("error during reopen session: %v", err)
return
}
c.sessions[session.ID()] = session
log.Printf("successful re-connected")
}
}()
continue mainLoop
}
}
panic(err)
}
header := &pdu.Header{}
if err := header.UnmarshalBinary(headerBytes); err != nil {
panic(err)
}
var packet pdu.Packet
switch header.Type {
case pdu.TypeResponse:
packet = &pdu.Response{}
case pdu.TypeGet:
packet = &pdu.Get{}
case pdu.TypeGetNext:
packet = &pdu.GetNext{}
default:
log.Printf("unhandled packet of type %s", header.Type)
}
packetBytes := make([]byte, header.PayloadLength)
if _, err := reader.Read(packetBytes); err != nil {
panic(err)
}
if err := packet.UnmarshalBinary(packetBytes); err != nil {
panic(err)
}
rx <- &pdu.HeaderPacket{Header: header, Packet: packet}
}
}()
return rx
}
func (c *Client) runDispatcher(tx, rx chan *pdu.HeaderPacket) {
go func() {
currentPacketID := uint32(0)
responseChans := make(map[uint32]chan *pdu.HeaderPacket)
for {
select {
case request := <-c.requestChan:
// log.Printf(">: %v", request)
request.headerPacket.Header.PacketID = currentPacketID
responseChans[currentPacketID] = request.responseChan
currentPacketID++
tx <- request.headerPacket
case headerPacket := <-rx:
// log.Printf("<: %v", headerPacket)
packetID := headerPacket.Header.PacketID
responseChan, ok := responseChans[packetID]
if ok {
responseChan <- headerPacket
delete(responseChans, packetID)
} else {
session, ok := c.sessions[headerPacket.Header.SessionID]
if ok {
tx <- session.handle(headerPacket)
} else {
log.Printf("got without session: %v", headerPacket)
}
}
}
}
}()
}
func (c *Client) request(hp *pdu.HeaderPacket) *pdu.HeaderPacket {
responseChan := make(chan *pdu.HeaderPacket)
request := &request{
headerPacket: hp,
responseChan: responseChan,
}
c.requestChan <- request
headerPacket := <-responseChan
return headerPacket
}

View File

@@ -1,52 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package agentx_test
import (
"io"
"log"
"os"
"os/exec"
"testing"
"time"
"github.com/stretchr/testify/require"
"github.com/posteo/go-agentx"
"github.com/posteo/go-agentx/value"
)
type environment struct {
client *agentx.Client
tearDown func()
}
func setUpTestEnvironment(tb testing.TB) *environment {
cmd := exec.Command("snmpd", "-Lo", "-f", "-c", "snmpd.conf")
stdout, err := cmd.StdoutPipe()
require.NoError(tb, err)
go func() {
io.Copy(os.Stdout, stdout)
}()
log.Printf("run: %s", cmd)
require.NoError(tb, cmd.Start())
time.Sleep(500 * time.Millisecond)
client, err := agentx.Dial("tcp", "127.0.0.1:30705")
require.NoError(tb, err)
client.Timeout = 60 * time.Second
client.NameOID = value.MustParseOID("1.3.6.1.4.1.45995")
client.Name = "test client"
return &environment{
client: client,
tearDown: func() {
require.NoError(tb, client.Close())
require.NoError(tb, cmd.Process.Kill())
},
}
}

View File

@@ -1,5 +0,0 @@
module github.com/posteo/go-agentx
go 1.13
require github.com/stretchr/testify v1.6.1

View File

@@ -1,12 +0,0 @@
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

View File

@@ -1,17 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package agentx
import (
"github.com/posteo/go-agentx/pdu"
"github.com/posteo/go-agentx/value"
)
// Handler defines an interface for a handler of events that
// might occure during a session.
type Handler interface {
Get(value.OID) (value.OID, pdu.VariableType, interface{}, error)
GetNext(value.OID, bool, value.OID) (value.OID, pdu.VariableType, interface{}, error)
}

View File

@@ -1,31 +0,0 @@
package agentx_test
import (
"fmt"
"os/exec"
"strings"
"testing"
"github.com/stretchr/testify/require"
)
func SNMPGet(tb testing.TB, oid string) string {
cmd := exec.Command("snmpget", "-v2c", "-cpublic", "-On", "127.0.0.1:30161", oid)
output, err := cmd.CombinedOutput()
require.NoError(tb, err)
return strings.TrimSpace(string(output))
}
func SNMPGetNext(tb testing.TB, oid string) string {
cmd := exec.Command("snmpgetnext", "-v2c", "-cpublic", "-On", "127.0.0.1:30161", oid)
output, err := cmd.CombinedOutput()
require.NoError(tb, err)
return strings.TrimSpace(string(output))
}
func SNMPGetBulk(tb testing.TB, oid string, nonRepeaters, maxRepetitions int) string {
cmd := exec.Command("snmpbulkget", "-v2c", "-cpublic", "-On", fmt.Sprintf("-Cn%d", nonRepeaters), fmt.Sprintf("-Cr%d", maxRepetitions), "127.0.0.1:30161", oid)
output, err := cmd.CombinedOutput()
require.NoError(tb, err)
return strings.TrimSpace(string(output))
}

View File

@@ -1,66 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package agentx
import (
"github.com/posteo/go-agentx/pdu"
"github.com/posteo/go-agentx/value"
)
// ListHandler is a helper that takes a list of oids and implements
// a default behaviour for that list.
type ListHandler struct {
oids []value.OID
items map[string]*ListItem
}
// Add adds a list item for the provided oid and returns it.
func (l *ListHandler) Add(oid string) *ListItem {
if l.items == nil {
l.items = make(map[string]*ListItem)
}
parsedOID := value.MustParseOID(oid)
l.oids = append(l.oids, parsedOID)
value.SortOIDs(l.oids)
item := &ListItem{}
l.items[oid] = item
return item
}
// Get tries to find the provided oid and returns the corresponding value.
func (l *ListHandler) Get(oid value.OID) (value.OID, pdu.VariableType, interface{}, error) {
if l.items == nil {
return nil, pdu.VariableTypeNoSuchObject, nil, nil
}
item, ok := l.items[oid.String()]
if ok {
return oid, item.Type, item.Value, nil
}
return nil, pdu.VariableTypeNoSuchObject, nil, nil
}
// GetNext tries to find the value that follows the provided oid and returns it.
func (l *ListHandler) GetNext(from value.OID, includeFrom bool, to value.OID) (value.OID, pdu.VariableType, interface{}, error) {
if l.items == nil {
return nil, pdu.VariableTypeNoSuchObject, nil, nil
}
for _, oid := range l.oids {
if oidWithin(oid, from, includeFrom, to) {
return l.Get(oid)
}
}
return nil, pdu.VariableTypeNoSuchObject, nil, nil
}
func oidWithin(oid value.OID, from value.OID, includeFrom bool, to value.OID) bool {
fromCompare := value.CompareOIDs(from, oid)
toCompare := value.CompareOIDs(to, oid)
return (fromCompare == -1 || (fromCompare == 0 && includeFrom)) && (toCompare == 1)
}

View File

@@ -1,63 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package agentx_test
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/posteo/go-agentx"
"github.com/posteo/go-agentx/pdu"
"github.com/posteo/go-agentx/value"
)
func TestListHandler(t *testing.T) {
e := setUpTestEnvironment(t)
defer e.tearDown()
session, err := e.client.Session()
require.NoError(t, err)
defer session.Close()
lh := &agentx.ListHandler{}
i := lh.Add("1.3.6.1.4.1.45995.3.1")
i.Type = pdu.VariableTypeOctetString
i.Value = "test"
session.Handler = lh
baseOID := value.MustParseOID("1.3.6.1.4.1.45995")
require.NoError(t, session.Register(127, baseOID))
defer session.Unregister(127, baseOID)
t.Run("Get", func(t *testing.T) {
assert.Equal(t,
".1.3.6.1.4.1.45995.3.1 = STRING: \"test\"",
SNMPGet(t, "1.3.6.1.4.1.45995.3.1"))
assert.Equal(t,
".1.3.6.1.4.1.45995.3.2 = No Such Object available on this agent at this OID",
SNMPGet(t, "1.3.6.1.4.1.45995.3.2"))
})
t.Run("GetNext", func(t *testing.T) {
assert.Equal(t,
".1.3.6.1.4.1.45995.3.1 = STRING: \"test\"",
SNMPGetNext(t, "1.3.6.1.4.1.45995.3.0"))
assert.Equal(t,
".1.3.6.1.4.1.45995.3.1 = STRING: \"test\"",
SNMPGetNext(t, "1.3.6.1.4.1.45995.3"))
})
t.Run("GetBulk", func(t *testing.T) {
assert.Equal(t,
".1.3.6.1.4.1.45995.3.1 = STRING: \"test\"",
SNMPGetBulk(t, "1.3.6.1.4.1.45995.3.0", 0, 1))
})
}

View File

@@ -1,13 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package agentx
import "github.com/posteo/go-agentx/pdu"
// ListItem defines an item of the list handler.
type ListItem struct {
Type pdu.VariableType
Value interface{}
}

View File

@@ -1,33 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package marshaler
import (
"encoding"
)
// Multi defines a binary marshaler that marshals all child marshalers
// and concatinate the results.
type Multi []encoding.BinaryMarshaler
// NewMulti returns a new instance of MultiBinaryMarshaler.
func NewMulti(marshalers ...encoding.BinaryMarshaler) Multi {
return Multi(marshalers)
}
// MarshalBinary marshals all the binary marshalers and concatinates the results.
func (m Multi) MarshalBinary() ([]byte, error) {
result := []byte{}
for _, marshaler := range m {
data, err := marshaler.MarshalBinary()
if err != nil {
return nil, err
}
result = append(result, data...)
}
return result, nil
}

View File

@@ -1,29 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
// AllocateIndex defiens the pdu allocate index packet.
type AllocateIndex struct {
Variables Variables
}
// Type returns the pdu packet type.
func (ai *AllocateIndex) Type() Type {
return TypeIndexAllocate
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (ai *AllocateIndex) MarshalBinary() ([]byte, error) {
data, err := ai.Variables.MarshalBinary()
if err != nil {
return nil, err
}
return data, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (ai *AllocateIndex) UnmarshalBinary(data []byte) error {
return nil
}

View File

@@ -1,26 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
// Close defines the pdu close packet.
type Close struct {
Reason Reason
}
// Type returns the pdu packet type.
func (c *Close) Type() Type {
return TypeClose
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (c *Close) MarshalBinary() ([]byte, error) {
return []byte{byte(c.Reason), 0x00, 0x00, 0x00}, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (c *Close) UnmarshalBinary(data []byte) error {
c.Reason = Reason(data[0])
return nil
}

View File

@@ -1,29 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
// DeallocateIndex defiens the pdu deallocate index packet.
type DeallocateIndex struct {
Variables Variables
}
// Type returns the pdu packet type.
func (di *DeallocateIndex) Type() Type {
return TypeIndexDeallocate
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (di *DeallocateIndex) MarshalBinary() ([]byte, error) {
data, err := di.Variables.MarshalBinary()
if err != nil {
return nil, err
}
return data, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (di *DeallocateIndex) UnmarshalBinary(data []byte) error {
return nil
}

View File

@@ -1,62 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import "fmt"
// The various pdu packet errors.
const (
ErrorNone Error = 0
ErrorOpenFailed Error = 256
ErrorNotOpen Error = 257
ErrorIndexWrongType Error = 258
ErrorIndexAlreadyAllocated Error = 259
ErrorIndexNoneAvailable Error = 260
ErrorIndexNotAllocated Error = 261
ErrorUnsupportedContext Error = 262
ErrorDuplicateRegistration Error = 263
ErrorUnknownRegistration Error = 264
ErrorUnknownAgentCaps Error = 265
ErrorParse Error = 266
ErrorRequestDenied Error = 267
ErrorProcessing Error = 268
)
// Error defines a pdu packet error.
type Error uint16
func (e Error) String() string {
switch e {
case ErrorNone:
return "ErrorNone"
case ErrorOpenFailed:
return "ErrorOpenFailed"
case ErrorNotOpen:
return "ErrorNotOpen"
case ErrorIndexWrongType:
return "ErrorIndexWrongType"
case ErrorIndexAlreadyAllocated:
return "ErrorIndexAlreadyAllocated"
case ErrorIndexNoneAvailable:
return "ErrorIndexNoneAvailable"
case ErrorIndexNotAllocated:
return "ErrorIndexNotAllocated"
case ErrorUnsupportedContext:
return "ErrorUnsupportedContext"
case ErrorDuplicateRegistration:
return "ErrorDuplicateRegistration"
case ErrorUnknownRegistration:
return "ErrorUnknownRegistration"
case ErrorUnknownAgentCaps:
return "ErrorUnknownAgentCaps"
case ErrorParse:
return "ErrorParse"
case ErrorRequestDenied:
return "ErrorRequestDenied"
case ErrorProcessing:
return "ErrorProcessing"
}
return fmt.Sprintf("ErrorUnknown (%d)", e)
}

View File

@@ -1,45 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"fmt"
"strings"
)
// The various pdu packet flags.
const (
FlagInstanceRegistration Flags = 1 << 0
FlagNewIndex Flags = 1 << 1
FlagAnyIndex Flags = 1 << 2
FlagNonDefaultContext Flags = 1 << 3
FlagNetworkByteOrder Flags = 1 << 4
)
// Flags defines pdu packet flags.
type Flags byte
func (f Flags) String() string {
result := []string{}
if f&FlagInstanceRegistration != 0 {
result = append(result, "FlagInstanceRegistration")
}
if f&FlagNewIndex != 0 {
result = append(result, "FlagNewIndex")
}
if f&FlagAnyIndex != 0 {
result = append(result, "FlagAnyIndex")
}
if f&FlagNonDefaultContext != 0 {
result = append(result, "FlagNonDefaultContext")
}
if f&FlagNetworkByteOrder != 0 {
result = append(result, "FlagNetworkByteOrder")
}
if len(result) == 0 {
return "(FlagNone)"
}
return fmt.Sprintf("(%s)", strings.Join(result, " | "))
}

View File

@@ -1,40 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import "github.com/posteo/go-agentx/value"
// Get defines the pdu get packet.
type Get struct {
SearchRange Range
}
// GetOID returns the oid.
func (g *Get) GetOID() value.OID {
return g.SearchRange.From.GetIdentifier()
}
// SetOID sets the provided oid.
func (g *Get) SetOID(oid value.OID) {
g.SearchRange.From.SetIdentifier(oid)
}
// Type returns the pdu packet type.
func (g *Get) Type() Type {
return TypeGet
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (g *Get) MarshalBinary() ([]byte, error) {
return []byte{}, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (g *Get) UnmarshalBinary(data []byte) error {
if err := g.SearchRange.UnmarshalBinary(data); err != nil {
return err
}
return nil
}

View File

@@ -1,28 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
// GetNext defines the pdu get next packet.
type GetNext struct {
SearchRanges Ranges
}
// Type returns the pdu packet type.
func (g *GetNext) Type() Type {
return TypeGetNext
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (g *GetNext) MarshalBinary() ([]byte, error) {
return []byte{}, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (g *GetNext) UnmarshalBinary(data []byte) error {
if err := g.SearchRanges.UnmarshalBinary(data); err != nil {
return err
}
return nil
}

View File

@@ -1,61 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"bytes"
"encoding/binary"
"fmt"
)
const (
// HeaderSize defines the total size of a header packet.
HeaderSize = 20
)
// Header defines a pdu packet header
type Header struct {
Version byte
Type Type
Flags Flags
SessionID uint32
TransactionID uint32
PacketID uint32
PayloadLength uint32
}
// MarshalBinary returns the pdu header as a slice of bytes.
func (h *Header) MarshalBinary() ([]byte, error) {
buffer := bytes.NewBuffer([]byte{h.Version, byte(h.Type), byte(h.Flags), 0x00})
binary.Write(buffer, binary.LittleEndian, h.SessionID)
binary.Write(buffer, binary.LittleEndian, h.TransactionID)
binary.Write(buffer, binary.LittleEndian, h.PacketID)
binary.Write(buffer, binary.LittleEndian, h.PayloadLength)
return buffer.Bytes(), nil
}
// UnmarshalBinary sets the header structure from the provided slice of bytes.
func (h *Header) UnmarshalBinary(data []byte) error {
if len(data) < HeaderSize {
return fmt.Errorf("not enough bytes (%d) to unmarshal the header (%d)", len(data), HeaderSize)
}
h.Version, h.Type, h.Flags = data[0], Type(data[1]), Flags(data[2])
buffer := bytes.NewBuffer(data[4:])
binary.Read(buffer, binary.LittleEndian, &h.SessionID)
binary.Read(buffer, binary.LittleEndian, &h.TransactionID)
binary.Read(buffer, binary.LittleEndian, &h.PacketID)
binary.Read(buffer, binary.LittleEndian, &h.PayloadLength)
return nil
}
func (h *Header) String() string {
return "(header " + h.Type.String() + ")"
}

View File

@@ -1,38 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"fmt"
)
// HeaderPacket defines a container structure for a header and a packet.
type HeaderPacket struct {
Header *Header
Packet Packet
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (hp *HeaderPacket) MarshalBinary() ([]byte, error) {
payloadBytes, err := hp.Packet.MarshalBinary()
if err != nil {
return nil, err
}
hp.Header.Version = 1
hp.Header.Type = hp.Packet.Type()
hp.Header.PayloadLength = uint32(len(payloadBytes))
result, err := hp.Header.MarshalBinary()
if err != nil {
return nil, err
}
return append(result, payloadBytes...), nil
}
func (hp *HeaderPacket) String() string {
return fmt.Sprintf("[head %v, body %v]", hp.Header, hp.Packet)
}

View File

@@ -1,96 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"bytes"
"encoding/binary"
"github.com/posteo/go-agentx/value"
)
// ObjectIdentifier defines the pdu object identifier packet.
type ObjectIdentifier struct {
Prefix uint8
Include byte
Subidentifiers []uint32
}
// SetInclude sets the include field.
func (o *ObjectIdentifier) SetInclude(value bool) {
if value {
o.Include = 0x01
} else {
o.Include = 0x00
}
}
// GetInclude returns true if the include field ist set, false otherwise.
func (o *ObjectIdentifier) GetInclude() bool {
if o.Include == 0x00 {
return false
}
return true
}
// SetIdentifier set the subidentifiers by the provided oid string.
func (o *ObjectIdentifier) SetIdentifier(oid value.OID) {
o.Subidentifiers = make([]uint32, 0)
if len(oid) > 4 && oid[0] == 1 && oid[1] == 3 && oid[2] == 6 && oid[3] == 1 {
o.Subidentifiers = append(o.Subidentifiers, uint32(1), uint32(3), uint32(6), uint32(1), uint32(oid[4]))
oid = oid[5:]
}
o.Subidentifiers = append(o.Subidentifiers, oid...)
}
// GetIdentifier returns the identifier as an oid string.
func (o *ObjectIdentifier) GetIdentifier() value.OID {
var oid value.OID
if o.Prefix != 0 {
oid = append(oid, 1, 3, 6, 1, uint32(o.Prefix))
}
return append(oid, o.Subidentifiers...)
}
// ByteSize returns the number of bytes, the binding would need in the encoded version.
func (o *ObjectIdentifier) ByteSize() int {
return 4 + len(o.Subidentifiers)*4
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (o *ObjectIdentifier) MarshalBinary() ([]byte, error) {
buffer := bytes.NewBuffer([]byte{byte(len(o.Subidentifiers)), o.Prefix, o.Include, 0x00})
for _, subidentifier := range o.Subidentifiers {
binary.Write(buffer, binary.LittleEndian, &subidentifier)
}
return buffer.Bytes(), nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (o *ObjectIdentifier) UnmarshalBinary(data []byte) error {
count := data[0]
o.Prefix = data[1]
o.Include = data[2]
o.Subidentifiers = make([]uint32, 0)
buffer := bytes.NewBuffer(data[4:])
for index := byte(0); index < count; index++ {
var subidentifier uint32
if err := binary.Read(buffer, binary.LittleEndian, &subidentifier); err != nil {
return err
}
o.Subidentifiers = append(o.Subidentifiers, subidentifier)
}
return nil
}
func (o ObjectIdentifier) String() string {
return o.GetIdentifier().String()
}

View File

@@ -1,43 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"bytes"
"encoding/binary"
)
// OctetString defines the pdu description packet.
type OctetString struct {
Text string
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (o *OctetString) MarshalBinary() ([]byte, error) {
buffer := &bytes.Buffer{}
binary.Write(buffer, binary.LittleEndian, uint32(len(o.Text)))
buffer.WriteString(o.Text)
for buffer.Len()%4 > 0 {
buffer.WriteByte(0x00)
}
return buffer.Bytes(), nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (o *OctetString) UnmarshalBinary(data []byte) error {
buffer := bytes.NewBuffer(data)
length := uint32(0)
if err := binary.Read(buffer, binary.LittleEndian, &length); err != nil {
return err
}
o.Text = string(data[4 : 4+length])
return nil
}

View File

@@ -1,38 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"github.com/posteo/go-agentx/marshaler"
)
// Open defines a pdu open packet.
type Open struct {
Timeout Timeout
ID ObjectIdentifier
Description OctetString
}
// Type returns the pdu packet type.
func (o *Open) Type() Type {
return TypeOpen
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (o *Open) MarshalBinary() ([]byte, error) {
combined := marshaler.NewMulti(&o.Timeout, &o.ID, &o.Description)
combinedBytes, err := combined.MarshalBinary()
if err != nil {
return nil, err
}
return combinedBytes, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (o *Open) UnmarshalBinary(data []byte) error {
return nil
}

View File

@@ -1,14 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import "encoding"
// Packet defines a general interface for a pdu packet.
type Packet interface {
TypeOwner
encoding.BinaryMarshaler
encoding.BinaryUnmarshaler
}

View File

@@ -1,53 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"fmt"
)
// Range defines the pdu search range packet.
type Range struct {
From ObjectIdentifier
To ObjectIdentifier
}
// ByteSize returns the number of bytes, the binding would need in the encoded version.
func (r *Range) ByteSize() int {
return r.From.ByteSize() + r.To.ByteSize()
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (r *Range) MarshalBinary() ([]byte, error) {
r.To.SetInclude(false)
return []byte{}, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (r *Range) UnmarshalBinary(data []byte) error {
if err := r.From.UnmarshalBinary(data); err != nil {
return err
}
if err := r.To.UnmarshalBinary(data[r.From.ByteSize():]); err != nil {
return err
}
return nil
}
func (r Range) String() string {
result := ""
if r.From.GetInclude() {
result += "["
} else {
result += "("
}
result += fmt.Sprintf("%v, %v", r.From, r.To)
if r.To.GetInclude() {
result += "]"
} else {
result += ")"
}
return result
}

View File

@@ -1,27 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
// Ranges defines the pdu search range list packet.
type Ranges []Range
// MarshalBinary returns the pdu packet as a slice of bytes.
func (r *Ranges) MarshalBinary() ([]byte, error) {
return []byte{}, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (r *Ranges) UnmarshalBinary(data []byte) error {
*r = make([]Range, 0)
for offset := 0; offset < len(data); {
rng := Range{}
if err := rng.UnmarshalBinary(data[offset:]); err != nil {
return err
}
*r = append(*r, rng)
offset += rng.ByteSize()
}
return nil
}

View File

@@ -1,38 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import "fmt"
// The various pdu packet reasons.
const (
ReasonOther Reason = 1
ReasonParseError Reason = 2
ReasonProtocolError Reason = 3
ReasonTimeouts Reason = 4
ReasonShutdown Reason = 5
ReasonByManager Reason = 6
)
// Reason defines a reason.
type Reason byte
func (r Reason) String() string {
switch r {
case ReasonOther:
return "ReasonOther"
case ReasonParseError:
return "ReasonParseError"
case ReasonProtocolError:
return "ReasonProtocolError"
case ReasonTimeouts:
return "ReasonTimeouts"
case ReasonShutdown:
return "ReasonShutdown"
case ReasonByManager:
return "ReasonByManager"
}
return fmt.Sprintf("ReasonUnknown (%d)", r)
}

View File

@@ -1,37 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"github.com/posteo/go-agentx/marshaler"
)
// Register defines the pdu register packet.
type Register struct {
Timeout Timeout
Subtree ObjectIdentifier
}
// Type returns the pdu packet type.
func (r *Register) Type() Type {
return TypeRegister
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (r *Register) MarshalBinary() ([]byte, error) {
combined := marshaler.NewMulti(&r.Timeout, &r.Subtree)
combinedBytes, err := combined.MarshalBinary()
if err != nil {
return nil, err
}
return combinedBytes, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (r *Register) UnmarshalBinary(data []byte) error {
return nil
}

View File

@@ -1,68 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"bytes"
"encoding/binary"
"time"
)
// Response defines the pdu response packet.
type Response struct {
UpTime time.Duration
Error Error
Index uint16
Variables Variables
}
// Type returns the pdu packet type.
func (r *Response) Type() Type {
return TypeResponse
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (r *Response) MarshalBinary() ([]byte, error) {
buffer := &bytes.Buffer{}
upTime := uint32(r.UpTime.Seconds() / 100)
binary.Write(buffer, binary.LittleEndian, &upTime)
binary.Write(buffer, binary.LittleEndian, &r.Error)
binary.Write(buffer, binary.LittleEndian, &r.Index)
vBytes, err := r.Variables.MarshalBinary()
if err != nil {
return nil, err
}
buffer.Write(vBytes)
return buffer.Bytes(), nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (r *Response) UnmarshalBinary(data []byte) error {
buffer := bytes.NewBuffer(data)
upTime := uint32(0)
if err := binary.Read(buffer, binary.LittleEndian, &upTime); err != nil {
return err
}
r.UpTime = time.Second * time.Duration(upTime*100)
if err := binary.Read(buffer, binary.LittleEndian, &r.Error); err != nil {
return err
}
if err := binary.Read(buffer, binary.LittleEndian, &r.Index); err != nil {
return err
}
if err := r.Variables.UnmarshalBinary(data[8:]); err != nil {
return err
}
return nil
}
func (r *Response) String() string {
return "(response " + r.Variables.String() + ")"
}

View File

@@ -1,29 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import "time"
// Timeout defines the pdu timeout packet.
type Timeout struct {
Duration time.Duration
Priority byte
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (t *Timeout) MarshalBinary() ([]byte, error) {
return []byte{byte(t.Duration.Seconds()), t.Priority, 0x00, 0x00}, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (t *Timeout) UnmarshalBinary(data []byte) error {
t.Duration = time.Duration(data[0]) * time.Second
t.Priority = data[1]
return nil
}
func (t Timeout) String() string {
return t.Duration.String()
}

View File

@@ -1,77 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
// The various pdu packet types.
const (
TypeOpen Type = 1
TypeClose Type = 2
TypeRegister Type = 3
TypeUnregister Type = 4
TypeGet Type = 5
TypeGetNext Type = 6
TypeGetBulk Type = 7
TypeTestSet Type = 8
TypeCommitSet Type = 9
TypeUndoSet Type = 10
TypeCleanupSet Type = 11
TypeNotify Type = 12
TypePing Type = 13
TypeIndexAllocate Type = 14
TypeIndexDeallocate Type = 15
TypeAddAgentCaps Type = 16
TypeRemoveAgentCaps Type = 17
TypeResponse Type = 18
)
// Type defines the pdu packet type.
type Type byte
// TypeOwner defines the interface for an object that provides a type.
type TypeOwner interface {
Type() Type
}
func (t Type) String() string {
switch t {
case TypeOpen:
return "TypeOpen"
case TypeClose:
return "TypeClose"
case TypeRegister:
return "TypeRegister"
case TypeUnregister:
return "TypeUnregister"
case TypeGet:
return "TypeGet"
case TypeGetNext:
return "TypeGetNext"
case TypeGetBulk:
return "TypeGetBulk"
case TypeTestSet:
return "TypeTestSet"
case TypeCommitSet:
return "TypeCommitSet"
case TypeUndoSet:
return "TypeUndoSet"
case TypeCleanupSet:
return "TypeCleanupSet"
case TypeNotify:
return "TypeNotify"
case TypePing:
return "TypePing"
case TypeIndexAllocate:
return "TypeIndexAllocate"
case TypeIndexDeallocate:
return "TypeIndexDeallocate"
case TypeAddAgentCaps:
return "TypeAddAgentCaps"
case TypeRemoveAgentCaps:
return "TypeRemoveAgentCaps"
case TypeResponse:
return "TypeResponse"
}
return "TypeUnknown"
}

View File

@@ -1,37 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"github.com/posteo/go-agentx/marshaler"
)
// Unregister defines the pdu unregister packet.
type Unregister struct {
Timeout Timeout
Subtree ObjectIdentifier
}
// Type returns the pdu packet type.
func (u *Unregister) Type() Type {
return TypeUnregister
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (u *Unregister) MarshalBinary() ([]byte, error) {
combined := marshaler.NewMulti(&u.Timeout, &u.Subtree)
combinedBytes, err := combined.MarshalBinary()
if err != nil {
return nil, err
}
return combinedBytes, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (u *Unregister) UnmarshalBinary(data []byte) error {
return nil
}

View File

@@ -1,185 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"bytes"
"encoding/binary"
"fmt"
"net"
"time"
"github.com/posteo/go-agentx/value"
)
// Variable defines the pdu varbind packet.
type Variable struct {
Type VariableType
Name ObjectIdentifier
Value interface{}
}
// Set sets the variable.
func (v *Variable) Set(oid value.OID, t VariableType, value interface{}) {
v.Name.SetIdentifier(oid)
v.Type = t
v.Value = value
}
// ByteSize returns the number of bytes, the binding would need in the encoded version.
func (v *Variable) ByteSize() int {
bytes, err := v.MarshalBinary()
if err != nil {
panic(err)
}
return len(bytes)
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (v *Variable) MarshalBinary() ([]byte, error) {
buffer := &bytes.Buffer{}
binary.Write(buffer, binary.LittleEndian, &v.Type)
buffer.WriteByte(0x00)
buffer.WriteByte(0x00)
nameBytes, err := v.Name.MarshalBinary()
if err != nil {
return nil, err
}
buffer.Write(nameBytes)
switch v.Type {
case VariableTypeInteger:
value := v.Value.(int32)
binary.Write(buffer, binary.LittleEndian, &value)
case VariableTypeOctetString:
octetString := &OctetString{Text: v.Value.(string)}
octetStringBytes, err := octetString.MarshalBinary()
if err != nil {
return nil, err
}
buffer.Write(octetStringBytes)
case VariableTypeNull, VariableTypeNoSuchObject, VariableTypeNoSuchInstance, VariableTypeEndOfMIBView:
break
case VariableTypeObjectIdentifier:
targetOID, err := value.ParseOID(v.Value.(string))
if err != nil {
return nil, err
}
oi := &ObjectIdentifier{}
oi.SetIdentifier(targetOID)
oiBytes, err := oi.MarshalBinary()
if err != nil {
return nil, err
}
buffer.Write(oiBytes)
case VariableTypeIPAddress:
ip := v.Value.(net.IP)
octetString := &OctetString{Text: string(ip)}
octetStringBytes, err := octetString.MarshalBinary()
if err != nil {
return nil, err
}
buffer.Write(octetStringBytes)
case VariableTypeCounter32, VariableTypeGauge32:
value := v.Value.(uint32)
binary.Write(buffer, binary.LittleEndian, &value)
case VariableTypeTimeTicks:
value := uint32(v.Value.(time.Duration).Seconds() * 100)
binary.Write(buffer, binary.LittleEndian, &value)
case VariableTypeOpaque:
octetString := &OctetString{Text: string(v.Value.([]byte))}
octetStringBytes, err := octetString.MarshalBinary()
if err != nil {
return nil, err
}
buffer.Write(octetStringBytes)
case VariableTypeCounter64:
value := v.Value.(uint64)
binary.Write(buffer, binary.LittleEndian, &value)
default:
return nil, fmt.Errorf("unhandled variable type %s", v.Type)
}
return buffer.Bytes(), nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (v *Variable) UnmarshalBinary(data []byte) error {
buffer := bytes.NewBuffer(data)
if err := binary.Read(buffer, binary.LittleEndian, &v.Type); err != nil {
return err
}
offset := 4
if err := v.Name.UnmarshalBinary(data[offset:]); err != nil {
return err
}
offset += v.Name.ByteSize()
switch v.Type {
case VariableTypeInteger:
value := int32(0)
if err := binary.Read(buffer, binary.LittleEndian, &value); err != nil {
return err
}
v.Value = value
case VariableTypeOctetString:
octetString := &OctetString{}
if err := octetString.UnmarshalBinary(data[offset:]); err != nil {
return err
}
v.Value = octetString.Text
case VariableTypeNull, VariableTypeNoSuchObject, VariableTypeNoSuchInstance, VariableTypeEndOfMIBView:
v.Value = nil
case VariableTypeObjectIdentifier:
oid := &ObjectIdentifier{}
if err := oid.UnmarshalBinary(data[offset:]); err != nil {
return err
}
v.Value = oid.GetIdentifier()
case VariableTypeIPAddress:
octetString := &OctetString{}
if err := octetString.UnmarshalBinary(data[offset:]); err != nil {
return err
}
v.Value = net.IP(octetString.Text)
case VariableTypeCounter32, VariableTypeGauge32:
value := uint32(0)
if err := binary.Read(buffer, binary.LittleEndian, &value); err != nil {
return err
}
v.Value = value
case VariableTypeTimeTicks:
value := uint32(0)
if err := binary.Read(buffer, binary.LittleEndian, &value); err != nil {
return err
}
v.Value = time.Duration(value) * time.Second / 100
case VariableTypeOpaque:
octetString := &OctetString{}
if err := octetString.UnmarshalBinary(data[offset:]); err != nil {
return err
}
v.Value = []byte(octetString.Text)
case VariableTypeCounter64:
value := uint64(0)
if err := binary.Read(buffer, binary.LittleEndian, &value); err != nil {
return err
}
v.Value = value
default:
return fmt.Errorf("unhandled variable type %s", v.Type)
}
return nil
}
func (v *Variable) String() string {
return fmt.Sprintf("(variable %s = %v)", v.Type, v.Value)
}

View File

@@ -1,59 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import "fmt"
// The various variable types.
const (
VariableTypeInteger VariableType = 2
VariableTypeOctetString VariableType = 4
VariableTypeNull VariableType = 5
VariableTypeObjectIdentifier VariableType = 6
VariableTypeIPAddress VariableType = 64
VariableTypeCounter32 VariableType = 65
VariableTypeGauge32 VariableType = 66
VariableTypeTimeTicks VariableType = 67
VariableTypeOpaque VariableType = 68
VariableTypeCounter64 VariableType = 70
VariableTypeNoSuchObject VariableType = 128
VariableTypeNoSuchInstance VariableType = 129
VariableTypeEndOfMIBView VariableType = 130
)
// VariableType defines the type of a variable.
type VariableType uint16
func (v VariableType) String() string {
switch v {
case VariableTypeInteger:
return "VariableTypeInteger"
case VariableTypeOctetString:
return "VariableTypeOctetString"
case VariableTypeNull:
return "VariableTypeNull"
case VariableTypeObjectIdentifier:
return "VariableTypeObjectIdentifier"
case VariableTypeIPAddress:
return "VariableTypeIPAddress"
case VariableTypeCounter32:
return "VariableTypeCounter32"
case VariableTypeGauge32:
return "VariableTypeGauge32"
case VariableTypeTimeTicks:
return "VariableTypeTimeTicks"
case VariableTypeOpaque:
return "VariableTypeOpaque"
case VariableTypeCounter64:
return "VariableTypeCounter64"
case VariableTypeNoSuchObject:
return "VariableTypeNoSuchObject"
case VariableTypeNoSuchInstance:
return "VariableTypeNoSuchInstance"
case VariableTypeEndOfMIBView:
return "VariableTypeEndOfMIBView"
}
return fmt.Sprintf("VariableTypeUnknown (%d)", v)
}

View File

@@ -1,56 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package pdu
import (
"strings"
"github.com/posteo/go-agentx/value"
)
// Variables defines a list of variable bindings.
type Variables []Variable
// Add adds the provided variable.
func (v *Variables) Add(oid value.OID, t VariableType, value interface{}) {
variable := Variable{}
variable.Set(oid, t, value)
*v = append(*v, variable)
}
// MarshalBinary returns the pdu packet as a slice of bytes.
func (v *Variables) MarshalBinary() ([]byte, error) {
result := []byte{}
for _, variable := range *v {
data, err := variable.MarshalBinary()
if err != nil {
return nil, err
}
result = append(result, data...)
}
return result, nil
}
// UnmarshalBinary sets the packet structure from the provided slice of bytes.
func (v *Variables) UnmarshalBinary(data []byte) error {
*v = make([]Variable, 0)
for offset := 0; offset < len(data); {
variable := Variable{}
if err := variable.UnmarshalBinary(data[offset:]); err != nil {
return err
}
*v = append(*v, variable)
offset += variable.ByteSize()
}
return nil
}
func (v Variables) String() string {
parts := make([]string, len(v))
for index, va := range v {
parts[index] = va.String()
}
return "[variables " + strings.Join(parts, ", ") + "]"
}

View File

@@ -1,16 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package agentx
import "github.com/posteo/go-agentx/pdu"
type request struct {
headerPacket *pdu.HeaderPacket
responseChan chan *pdu.HeaderPacket
}
func (r *request) String() string {
return "(request " + r.headerPacket.String() + ")"
}

View File

@@ -1,185 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package agentx
import (
"errors"
"fmt"
"log"
"time"
"github.com/posteo/go-agentx/pdu"
"github.com/posteo/go-agentx/value"
)
// Session defines an agentx session.
type Session struct {
Handler Handler
client *Client
sessionID uint32
timeout time.Duration
openRequestPacket *pdu.HeaderPacket
registerRequestPacket *pdu.HeaderPacket
}
// ID returns the session id.
func (s *Session) ID() uint32 {
return s.sessionID
}
// Register registers the client under the provided rootID with the provided priority
// on the master agent.
func (s *Session) Register(priority byte, baseOID value.OID) error {
if s.registerRequestPacket != nil {
return fmt.Errorf("session is already registered")
}
requestPacket := &pdu.Register{}
requestPacket.Timeout.Duration = s.timeout
requestPacket.Timeout.Priority = priority
requestPacket.Subtree.SetIdentifier(baseOID)
request := &pdu.HeaderPacket{Header: &pdu.Header{Type: pdu.TypeRegister}, Packet: requestPacket}
response := s.request(request)
if err := checkError(response); err != nil {
return err
}
s.registerRequestPacket = request
return nil
}
// Unregister removes the registration for the provided subtree.
func (s *Session) Unregister(priority byte, baseOID value.OID) error {
if s.registerRequestPacket == nil {
return fmt.Errorf("session is not registered")
}
requestPacket := &pdu.Unregister{}
requestPacket.Timeout.Duration = s.timeout
requestPacket.Timeout.Priority = priority
requestPacket.Subtree.SetIdentifier(baseOID)
request := &pdu.HeaderPacket{Header: &pdu.Header{}, Packet: requestPacket}
response := s.request(request)
if err := checkError(response); err != nil {
return err
}
s.registerRequestPacket = nil
return nil
}
// Close tears down the session with the master agent.
func (s *Session) Close() error {
requestPacket := &pdu.Close{Reason: pdu.ReasonShutdown}
response := s.request(&pdu.HeaderPacket{Header: &pdu.Header{}, Packet: requestPacket})
if err := checkError(response); err != nil {
return err
}
return nil
}
func (s *Session) open(nameOID value.OID, name string) error {
requestPacket := &pdu.Open{}
requestPacket.Timeout.Duration = s.timeout
requestPacket.ID.SetIdentifier(nameOID)
requestPacket.Description.Text = name
request := &pdu.HeaderPacket{Header: &pdu.Header{Type: pdu.TypeOpen}, Packet: requestPacket}
response := s.request(request)
if err := checkError(response); err != nil {
return err
}
s.sessionID = response.Header.SessionID
s.openRequestPacket = request
return nil
}
func (s *Session) reopen() error {
if s.openRequestPacket != nil {
response := s.request(s.openRequestPacket)
if err := checkError(response); err != nil {
return err
}
s.sessionID = response.Header.SessionID
}
if s.registerRequestPacket != nil {
response := s.request(s.registerRequestPacket)
if err := checkError(response); err != nil {
return err
}
}
return nil
}
func (s *Session) request(hp *pdu.HeaderPacket) *pdu.HeaderPacket {
hp.Header.SessionID = s.sessionID
return s.client.request(hp)
}
func (s *Session) handle(request *pdu.HeaderPacket) *pdu.HeaderPacket {
responseHeader := &pdu.Header{}
responseHeader.SessionID = request.Header.SessionID
responseHeader.TransactionID = request.Header.TransactionID
responseHeader.PacketID = request.Header.PacketID
responsePacket := &pdu.Response{}
switch requestPacket := request.Packet.(type) {
case *pdu.Get:
if s.Handler == nil {
log.Printf("warning: no handler for session specified")
responsePacket.Variables.Add(requestPacket.GetOID(), pdu.VariableTypeNull, nil)
} else {
oid, t, v, err := s.Handler.Get(requestPacket.GetOID())
if err != nil {
log.Printf("error while handling packet: %v", err)
responsePacket.Error = pdu.ErrorProcessing
}
if oid == nil {
responsePacket.Variables.Add(requestPacket.GetOID(), pdu.VariableTypeNoSuchObject, nil)
} else {
responsePacket.Variables.Add(oid, t, v)
}
}
case *pdu.GetNext:
if s.Handler == nil {
log.Printf("warning: no handler for session specified")
} else {
for _, sr := range requestPacket.SearchRanges {
oid, t, v, err := s.Handler.GetNext(sr.From.GetIdentifier(), (sr.From.Include == 1), sr.To.GetIdentifier())
if err != nil {
log.Printf("error while handling packet: %v", err)
responsePacket.Error = pdu.ErrorProcessing
}
if oid == nil {
responsePacket.Variables.Add(sr.From.GetIdentifier(), pdu.VariableTypeEndOfMIBView, nil)
} else {
responsePacket.Variables.Add(oid, t, v)
}
}
}
default:
log.Printf("cannot handle unrequested packet: %v", request)
responsePacket.Error = pdu.ErrorProcessing
}
return &pdu.HeaderPacket{Header: responseHeader, Packet: responsePacket}
}
func checkError(hp *pdu.HeaderPacket) error {
response, ok := hp.Packet.(*pdu.Response)
if !ok {
return nil
}
if response.Error == pdu.ErrorNone {
return nil
}
return errors.New(response.Error.String())
}

View File

@@ -1,48 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package agentx_test
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/posteo/go-agentx/value"
)
func TestSession(t *testing.T) {
e := setUpTestEnvironment(t)
defer e.tearDown()
t.Run("Open", func(t *testing.T) {
session, err := e.client.Session()
require.NoError(t, err)
defer session.Close()
assert.NotEqual(t, 0, session.ID())
})
t.Run("Close", func(t *testing.T) {
session, err := e.client.Session()
require.NoError(t, err)
require.NoError(t, session.Close())
})
t.Run("Register", func(t *testing.T) {
session, err := e.client.Session()
require.NoError(t, err)
defer session.Close()
baseOID := value.MustParseOID("1.3.6.1.4.1.45995")
require.NoError(t,
session.Register(127, baseOID))
require.NoError(t,
session.Unregister(127, baseOID))
})
}

View File

@@ -1,7 +0,0 @@
{ pkgs ? import <nixpkgs> {} }:
pkgs.mkShell {
name = "dev-environment";
buildInputs = [
pkgs.net-snmp
];
}

View File

@@ -1,7 +0,0 @@
agentaddress udp:127.0.0.1:30161
rocommunity public
master agentx
agentXSocket tcp:127.0.0.1:30705

View File

@@ -1,103 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package value
import (
"fmt"
"sort"
"strconv"
"strings"
)
// OID defines an OID.
type OID []uint32
// ParseOID parses the provided string and returns a valid oid. If one of the
// subidentifers canot be parsed to an uint32, the function will panic.
func ParseOID(text string) (OID, error) {
var result OID
parts := strings.Split(text, ".")
for _, part := range parts {
subidentifier, err := strconv.ParseUint(part, 10, 32)
if err != nil {
return nil, fmt.Errorf("parse uint [%s]: %w", part, err)
}
result = append(result, uint32(subidentifier))
}
return result, nil
}
// MustParseOID works like ParseOID expect it panics on a parsing error.
func MustParseOID(text string) OID {
result, err := ParseOID(text)
if err != nil {
panic(err)
}
return result
}
// First returns the first n subidentifiers as a new oid.
func (o OID) First(count int) OID {
return o[:count]
}
// CommonPrefix compares the oid with the provided one and
// returns a new oid containing all matching prefix subidentifiers.
func (o OID) CommonPrefix(other OID) OID {
matchCount := 0
for index, subidentifier := range o {
if index >= len(other) || subidentifier != other[index] {
break
}
matchCount++
}
return o[:matchCount]
}
// CompareOIDs returns an integer comparing two OIDs lexicographically.
// The result will be 0 if oid1 == oid2, -1 if oid1 < oid2, +1 if oid1 > oid2.
func CompareOIDs(oid1, oid2 OID) int {
if oid2 != nil {
oid1Length := len(oid1)
oid2Length := len(oid2)
for i := 0; i < oid1Length && i < oid2Length; i++ {
if oid1[i] < oid2[i] {
return -1
}
if oid1[i] > oid2[i] {
return 1
}
}
if oid1Length == oid2Length {
return 0
} else if oid1Length < oid2Length {
return -1
} else {
return 1
}
}
return 1
}
// SortOIDs performs sorting of the OID list.
func SortOIDs(oids []OID) {
sort.Slice(oids, func(i, j int) bool {
return CompareOIDs(oids[i], oids[j]) == -1
})
}
func (o OID) String() string {
var parts []string
for _, subidentifier := range o {
parts = append(parts, fmt.Sprintf("%d", subidentifier))
}
return strings.Join(parts, ".")
}

View File

@@ -1,70 +0,0 @@
// Copyright 2018 The agentx authors
// Licensed under the LGPLv3 with static-linking exception.
// See LICENCE file for details.
package value_test
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/posteo/go-agentx/value"
)
func TestCommonPrefix(t *testing.T) {
oid := value.MustParseOID("1.3.6.1.2")
result := oid.CommonPrefix(value.MustParseOID("1.3.6.1.4"))
assert.Equal(t, value.MustParseOID("1.3.6.1"), result)
}
func TestCompareOIDs_Less(t *testing.T) {
oid1 := value.OID{1, 3, 6, 1, 2}
oid2 := value.OID{1, 3, 6, 1, 4}
// oid1 < oid2
expected := -1
assert.Equal(t, expected, value.CompareOIDs(oid1, oid2))
}
func TestCompareOIDs_Greater(t *testing.T) {
oid1 := value.OID{1, 3, 6, 1, 2}
oid2 := value.OID{1, 3, 6, 1, 4}
// oid2 > oid1
expected := 1
assert.Equal(t, expected, value.CompareOIDs(oid2, oid1))
}
func TestCompareOIDs_Equals(t *testing.T) {
oid1 := value.OID{1, 3, 6, 1, 4}
oid2 := value.OID{1, 3, 6, 1, 4}
// oid1 == oid2
expected := 0
assert.Equal(t, expected, value.CompareOIDs(oid1, oid2))
}
func TestCompareOIDs_NilValue(t *testing.T) {
oid1 := value.OID{1, 3, 6, 1, 4}
var oid2 value.OID
// oid2 is nil, thus oid1 is greater
expected := 1
assert.Equal(t, expected, value.CompareOIDs(oid1, oid2))
}
func TestSortOIDs(t *testing.T) {
var oidList []value.OID
oid1 := value.OID{1, 3, 6, 1}
oid2 := value.OID{1, 3, 6, 5, 7}
oid3 := value.OID{1, 3, 6, 1, 12}
oid4 := value.OID{1, 3, 6, 5}
oidList = append(oidList, oid1, oid2, oid3, oid4)
value.SortOIDs(oidList)
var expect []value.OID
expect = append(expect, oid1, oid3, oid4, oid2)
assert.Equal(t, expect, oidList)
}

View File

@@ -3,7 +3,7 @@ module govpp-snmp-agentx
go 1.23.8
require (
github.com/posteo/go-agentx v0.2.1
github.com/posteo/go-agentx v0.3.0
go.fd.io/govpp v0.12.0
gopkg.in/yaml.v3 v3.0.1
)
@@ -16,5 +16,3 @@ require (
github.com/sirupsen/logrus v1.9.3 // indirect
golang.org/x/sys v0.31.0 // indirect
)
replace github.com/posteo/go-agentx => ./go-agentx

View File

@@ -18,10 +18,11 @@ github.com/onsi/gomega v1.37.0 h1:CdEG8g0S133B4OswTDC/5XPSzE1OeP29QOioj2PID2Y=
github.com/onsi/gomega v1.37.0/go.mod h1:8D9+Txp43QWKhM24yyOBEdpkzN8FvJyAwecBgsU4KU0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/posteo/go-agentx v0.3.0 h1:Mqu0qzPHxbyZF3+fKwN2vjW49t6TPPgivjjplcuouNw=
github.com/posteo/go-agentx v0.3.0/go.mod h1:YCWL7bzLlpSNeU9vnfEg1pdlllDs1v2mz+pRcg21CUg=
github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
go.fd.io/govpp v0.12.0 h1:5HnMzsKHSFdxglsFyEhR0g+CzncWiLYXG2NDYgNUrnE=

View File

@@ -18,55 +18,11 @@ import (
"govpp-snmp-agentx/vpp"
)
// IF-MIB OID bases:
// ifEntry (classic): 1.3.6.1.2.1.2.2.1
// ifXTable (extended): 1.3.6.1.2.1.31.1.1.1
// ifEntry (1.3.6.1.2.1.2.2.1) - Classic Interface Table:
// ifIndex .1 - Integer32
// ifDescr .2 - DisplayString
// ifType .3 - IANAifType
// ifMtu .4 - Integer32
// ifSpeed .5 - Gauge32
// ifPhysAddress .6 - PhysAddress
// ifAdminStatus .7 - INTEGER
// ifOperStatus .8 - INTEGER
// ifLastChange .9 - TimeTicks
// ifInOctets .10 - Counter32
// ifInUcastPkts .11 - Counter32
// ifInNUcastPkts .12 - Counter32
// ifInDiscards .13 - Counter32
// ifInErrors .14 - Counter32
// ifInUnknownProtos .15 - Counter32
// ifOutOctets .16 - Counter32
// ifOutUcastPkts .17 - Counter32
// ifOutNUcastPkts .18 - Counter32
// ifOutDiscards .19 - Counter32
// ifOutErrors .20 - Counter32
// ifOutQLen .21 - Gauge32
// ifSpecific .22 - OBJECT IDENTIFIER
// ifXTable (1.3.6.1.2.1.31.1.1.1) - Extended Interface Table:
// ifName .1 - DisplayString
// ifInMulticastPkts .2 - Counter32
// ifInBroadcastPkts .3 - Counter32
// ifOutMulticastPkts .4 - Counter32
// ifOutBroadcastPkts .5 - Counter32
// ifHCInOctets .6 - Counter64
// ifHCInUcastPkts .7 - Counter64
// ifHCInMulticastPkts .8 - Counter64
// ifHCInBroadcastPkts .9 - Counter64
// ifHCOutOctets .10 - Counter64
// ifHCOutUcastPkts .11 - Counter64
// ifHCOutMulticastPkts .12 - Counter64
// ifHCOutBroadcastPkts .13 - Counter64
// ifHighSpeed .15 - Gauge32 (interface speed in Mbps)
// ifAlias .18 - DisplayString
// IF-MIB OID bases
const ifEntryOID = "1.3.6.1.2.1.2.2.1"
const ifXTableOID = "1.3.6.1.2.1.31.1.1.1"
// VPP Config YAML structures
// VPP Config structures
type VPPConfig struct {
Interfaces map[string]VPPInterface `yaml:"interfaces"`
Loopbacks map[string]VPPInterface `yaml:"loopbacks"`
@@ -79,38 +35,42 @@ type VPPInterface struct {
type InterfaceMIB struct {
mutex sync.RWMutex
handler *agentx.ListHandler
client *agentx.Client
ifEntrySession *agentx.Session
ifXTableSession *agentx.Session
stats map[uint32]*api.InterfaceCounters // indexed by interface index
descriptions map[string]string // interface name -> description mapping
interfaceDetails map[uint32]*vpp.InterfaceDetails // indexed by interface index
// Simple approach: track interface set and rebuild when it changes
currentInterfaces map[uint32]bool
descriptions map[string]string
interfaceDetails map[uint32]*vpp.InterfaceDetails
// Counter items - direct references for fast updates
counterItems map[string]*agentx.ListItem
}
func NewInterfaceMIB() *InterfaceMIB {
return &InterfaceMIB{
handler: &agentx.ListHandler{},
stats: make(map[uint32]*api.InterfaceCounters),
currentInterfaces: make(map[uint32]bool),
descriptions: make(map[string]string),
interfaceDetails: make(map[uint32]*vpp.InterfaceDetails),
counterItems: make(map[string]*agentx.ListItem),
}
}
func (m *InterfaceMIB) GetHandler() *agentx.ListHandler {
return m.handler
// Always create a new handler - this is the key simplification
return &agentx.ListHandler{}
}
func (m *InterfaceMIB) LoadVPPConfig(configPath string) error {
m.mutex.Lock()
defer m.mutex.Unlock()
// Read YAML file
data, err := os.ReadFile(configPath)
if err != nil {
return fmt.Errorf("failed to read VPP config file: %v", err)
}
// Parse YAML
var config VPPConfig
if err := yaml.Unmarshal(data, &config); err != nil {
return fmt.Errorf("failed to parse VPP config YAML: %v", err)
@@ -120,24 +80,18 @@ func (m *InterfaceMIB) LoadVPPConfig(configPath string) error {
for ifName, ifConfig := range config.Interfaces {
if ifConfig.Description != "" {
m.descriptions[ifName] = ifConfig.Description
logger.Debugf("Loaded description for interface %s: %s", ifName, ifConfig.Description)
}
// Process sub-interfaces
for subID, subConfig := range ifConfig.SubInterfaces {
if subConfig.Description != "" {
subIfName := fmt.Sprintf("%s.%s", ifName, subID)
m.descriptions[subIfName] = subConfig.Description
logger.Debugf("Loaded description for sub-interface %s: %s", subIfName, subConfig.Description)
}
}
}
// Extract loopback descriptions
for ifName, ifConfig := range config.Loopbacks {
if ifConfig.Description != "" {
m.descriptions[ifName] = ifConfig.Description
logger.Debugf("Loaded description for loopback %s: %s", ifName, ifConfig.Description)
}
}
@@ -149,306 +103,225 @@ func (m *InterfaceMIB) UpdateInterfaceDetails(details []vpp.InterfaceDetails) {
m.mutex.Lock()
defer m.mutex.Unlock()
logger.Debugf("Updating interface details for %d interfaces", len(details))
// Update interface details map
for _, detail := range details {
m.interfaceDetails[uint32(detail.SwIfIndex)] = &detail
logger.Debugf("Updated details for interface %d (%s): MAC=%x, Speed=%d",
detail.SwIfIndex, detail.InterfaceName, detail.MacAddress, detail.Speed)
}
logger.Debugf("Interface details updated for %d interfaces", len(details))
logger.Debugf("Updated interface details for %d interfaces", len(details))
}
func (m *InterfaceMIB) UpdateStats(interfaceStats *api.InterfaceStats) {
m.mutex.Lock()
defer m.mutex.Unlock()
logger.Debugf("Updating IF-MIB with %d interfaces", len(interfaceStats.Interfaces))
// Clear existing entries
m.handler = &agentx.ListHandler{}
m.stats = make(map[uint32]*api.InterfaceCounters)
// Add new entries
// Check if interface set changed
newInterfaces := make(map[uint32]bool)
for _, iface := range interfaceStats.Interfaces {
logger.Debugf("Processing interface %d (%s)", iface.InterfaceIndex, iface.InterfaceName)
m.stats[iface.InterfaceIndex] = &iface
m.addInterfaceToMIB(&iface)
newInterfaces[iface.InterfaceIndex] = true
}
// Update both sessions with the new handler
if m.ifEntrySession != nil {
m.ifEntrySession.Handler = m.handler
// Simple comparison - rebuild if different
needsRebuild := len(newInterfaces) != len(m.currentInterfaces)
if !needsRebuild {
for idx := range newInterfaces {
if !m.currentInterfaces[idx] {
needsRebuild = true
break
}
}
if m.ifXTableSession != nil {
m.ifXTableSession.Handler = m.handler
logger.Printf("Updated session handlers with new IF-MIB data")
}
logger.Debugf("IF-MIB now contains %d interfaces", len(m.stats))
if needsRebuild {
logger.Debugf("Interface set changed, rebuilding MIB")
if err := m.rebuildMIB(interfaceStats.Interfaces); err != nil {
logger.Printf("Failed to rebuild MIB: %v", err)
return
}
m.currentInterfaces = newInterfaces
} else {
// Fast path: just update counters
logger.Debugf("Updating counters for %d interfaces", len(interfaceStats.Interfaces))
for _, iface := range interfaceStats.Interfaces {
m.updateCounterValues(&iface)
}
}
logger.Printf("Updated IF-MIB data for %d interfaces", len(interfaceStats.Interfaces))
}
func (m *InterfaceMIB) addInterfaceToMIB(iface *api.InterfaceCounters) {
func (m *InterfaceMIB) rebuildMIB(interfaces []api.InterfaceCounters) error {
// If no client is available (e.g., during testing), just track interfaces
if m.client == nil {
logger.Debugf("No AgentX client available, only tracking interface set")
return nil
}
// Close old sessions
if m.ifEntrySession != nil {
m.ifEntrySession.Close()
m.ifEntrySession = nil
}
if m.ifXTableSession != nil {
m.ifXTableSession.Close()
m.ifXTableSession = nil
}
// Create fresh handler
handler := &agentx.ListHandler{}
m.counterItems = make(map[string]*agentx.ListItem)
// Build all MIB entries
for _, iface := range interfaces {
m.addInterfaceToHandler(handler, &iface)
}
// Register new sessions
ifEntrySession, err := m.client.Session(value.MustParseOID(ifEntryOID), "ifEntry", handler)
if err != nil {
return fmt.Errorf("failed to create ifEntry session: %v", err)
}
err = ifEntrySession.Register(127, value.MustParseOID(ifEntryOID))
if err != nil {
ifEntrySession.Close()
return fmt.Errorf("failed to register ifEntry: %v", err)
}
ifXTableSession, err := m.client.Session(value.MustParseOID(ifXTableOID), "ifXTable", handler)
if err != nil {
ifEntrySession.Close()
return fmt.Errorf("failed to create ifXTable session: %v", err)
}
err = ifXTableSession.Register(127, value.MustParseOID(ifXTableOID))
if err != nil {
ifEntrySession.Close()
ifXTableSession.Close()
return fmt.Errorf("failed to register ifXTable: %v", err)
}
m.ifEntrySession = ifEntrySession
m.ifXTableSession = ifXTableSession
logger.Debugf("Successfully rebuilt MIB with %d interfaces", len(interfaces))
return nil
}
func (m *InterfaceMIB) addInterfaceToHandler(handler *agentx.ListHandler, iface *api.InterfaceCounters) {
idx := int(iface.InterfaceIndex) + *vpp.IfIndexOffset
details := m.interfaceDetails[iface.InterfaceIndex]
// Add ifEntry (classic interface table) entries
m.addIfEntry(iface, idx)
// Add static fields (these don't change frequently)
m.addStaticFields(handler, iface, idx, details)
// Add ifXTable (extended interface table) entries
m.addIfXTable(iface, idx)
// Add counter fields and store references for fast updates
m.addCounterFields(handler, iface, idx)
logger.Debugf("Added interface %d (%s) to IF-MIB with SNMP index %d", iface.InterfaceIndex, iface.InterfaceName, idx)
}
func (m *InterfaceMIB) addIfEntry(iface *api.InterfaceCounters, idx int) {
func (m *InterfaceMIB) addStaticFields(handler *agentx.ListHandler, iface *api.InterfaceCounters, idx int, details *vpp.InterfaceDetails) {
var item *agentx.ListItem
// Get interface details if available
details := m.interfaceDetails[iface.InterfaceIndex]
// ifIndex (.1)
item = m.handler.Add(fmt.Sprintf("%s.1.%d", ifEntryOID, idx))
item = handler.Add(fmt.Sprintf("%s.1.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeInteger
item.Value = int32(idx)
// ifDescr (.2)
item = m.handler.Add(fmt.Sprintf("%s.2.%d", ifEntryOID, idx))
item = handler.Add(fmt.Sprintf("%s.2.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeOctetString
item.Value = iface.InterfaceName
// ifType (.3) - Using ethernetCsmacd(6) as default
item = m.handler.Add(fmt.Sprintf("%s.3.%d", ifEntryOID, idx))
item = handler.Add(fmt.Sprintf("%s.3.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeInteger
item.Value = int32(6)
// ifMtu (.4) - Use real MTU if available, otherwise default to 1500
// ifMtu (.4)
mtu := int32(1500)
if details != nil {
mtu = int32(details.MTU)
}
item = m.handler.Add(fmt.Sprintf("%s.4.%d", ifEntryOID, idx))
item = handler.Add(fmt.Sprintf("%s.4.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeInteger
item.Value = mtu
// ifSpeed (.5) - Only populate for speeds <= 2.5Gbps (legacy field limitation)
// ifSpeed (.5) - Only for speeds <= 2.5Gbps
if details != nil && details.Speed > 0 && details.Speed <= 2500000000 {
// Use real speed for interfaces <= 2.5Gbps
item = m.handler.Add(fmt.Sprintf("%s.5.%d", ifEntryOID, idx))
item = handler.Add(fmt.Sprintf("%s.5.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeGauge32
item.Value = uint32(details.Speed)
} else if details == nil || details.Speed == 0 {
// Default to 1Gbps when speed is unknown
item = m.handler.Add(fmt.Sprintf("%s.5.%d", ifEntryOID, idx))
item = handler.Add(fmt.Sprintf("%s.5.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeGauge32
item.Value = uint32(1000000000)
}
// For speeds > 2.5Gbps, don't populate ifSpeed field at all
// ifPhysAddress (.6) - Use real MAC address if available
// ifPhysAddress (.6)
macAddr := ""
if details != nil && len(details.MacAddress) > 0 {
macAddr = string(details.MacAddress)
}
item = m.handler.Add(fmt.Sprintf("%s.6.%d", ifEntryOID, idx))
item = handler.Add(fmt.Sprintf("%s.6.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeOctetString
item.Value = macAddr
// ifAdminStatus (.7) - Use real admin status if available
adminStatus := int32(1) // default up
if details != nil {
if details.AdminStatus {
adminStatus = 1 // up
} else {
adminStatus = 2 // down
// ifAdminStatus (.7)
adminStatus := int32(1)
if details != nil && !details.AdminStatus {
adminStatus = 2
}
}
item = m.handler.Add(fmt.Sprintf("%s.7.%d", ifEntryOID, idx))
item = handler.Add(fmt.Sprintf("%s.7.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeInteger
item.Value = adminStatus
// ifOperStatus (.8) - Use real operational status if available
operStatus := int32(1) // default up
if details != nil {
if details.OperStatus {
operStatus = 1 // up
} else {
operStatus = 2 // down
// ifOperStatus (.8)
operStatus := int32(1)
if details != nil && !details.OperStatus {
operStatus = 2
}
}
item = m.handler.Add(fmt.Sprintf("%s.8.%d", ifEntryOID, idx))
item = handler.Add(fmt.Sprintf("%s.8.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeInteger
item.Value = operStatus
// ifLastChange (.9) - 0 (unknown)
item = m.handler.Add(fmt.Sprintf("%s.9.%d", ifEntryOID, idx))
// ifLastChange (.9)
item = handler.Add(fmt.Sprintf("%s.9.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeTimeTicks
item.Value = 0 * time.Second
// ifInOctets (.10)
item = m.handler.Add(fmt.Sprintf("%s.10.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(iface.Rx.Bytes)
// ifInUcastPkts (.11)
item = m.handler.Add(fmt.Sprintf("%s.11.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeCounter32
// iface.Rx*cast.Packets is only set if "set interface feature X stats-collect-rx arc device-input" is configured
if iface.RxUnicast.Packets == 0 {
item.Value = uint32(iface.Rx.Packets)
} else {
item.Value = uint32(iface.RxUnicast.Packets)
}
// ifInNUcastPkts (.12) - multicast + broadcast
item = m.handler.Add(fmt.Sprintf("%s.12.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(iface.RxMulticast.Packets + iface.RxBroadcast.Packets)
// ifInDiscards (.13) - using drops
item = m.handler.Add(fmt.Sprintf("%s.13.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(iface.Drops)
// ifInErrors (.14)
item = m.handler.Add(fmt.Sprintf("%s.14.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(iface.RxErrors)
// ifInUnknownProtos (.15) - 0 (not available)
item = m.handler.Add(fmt.Sprintf("%s.15.%d", ifEntryOID, idx))
// ifInUnknownProtos (.15)
item = handler.Add(fmt.Sprintf("%s.15.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(0)
// ifOutOctets (.16)
item = m.handler.Add(fmt.Sprintf("%s.16.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(iface.Tx.Bytes)
// ifOutUcastPkts (.17)
item = m.handler.Add(fmt.Sprintf("%s.17.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeCounter32
// iface.Tx*cast.Packets is only set if "set interface feature X stats-collect-tx arc interface-output" is configured
if iface.TxUnicast.Packets == 0 {
item.Value = uint32(iface.Tx.Packets)
} else {
item.Value = uint32(iface.TxUnicast.Packets)
}
// ifOutNUcastPkts (.18) - multicast + broadcast
item = m.handler.Add(fmt.Sprintf("%s.18.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(iface.TxMulticast.Packets + iface.TxBroadcast.Packets)
// ifOutDiscards (.19) - 0 (not available)
item = m.handler.Add(fmt.Sprintf("%s.19.%d", ifEntryOID, idx))
// ifOutDiscards (.19)
item = handler.Add(fmt.Sprintf("%s.19.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(0)
// ifOutErrors (.20)
item = m.handler.Add(fmt.Sprintf("%s.20.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(iface.TxErrors)
// ifOutQLen (.21) - 0 (not available)
item = m.handler.Add(fmt.Sprintf("%s.21.%d", ifEntryOID, idx))
// ifOutQLen (.21)
item = handler.Add(fmt.Sprintf("%s.21.%d", ifEntryOID, idx))
item.Type = pdu.VariableTypeGauge32
item.Value = uint32(0)
// ifSpecific (.22) - Skip this field as it's optional and causing issues
}
func (m *InterfaceMIB) addIfXTable(iface *api.InterfaceCounters, idx int) {
var item *agentx.ListItem
// ifXTable static fields
// ifName (.1)
item = m.handler.Add(fmt.Sprintf("%s.1.%d", ifXTableOID, idx))
item = handler.Add(fmt.Sprintf("%s.1.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeOctetString
item.Value = iface.InterfaceName
// ifInMulticastPkts (.2)
item = m.handler.Add(fmt.Sprintf("%s.2.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(iface.RxMulticast.Packets)
// ifInBroadcastPkts (.3)
item = m.handler.Add(fmt.Sprintf("%s.3.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(iface.RxBroadcast.Packets)
// ifOutMulticastPkts (.4)
item = m.handler.Add(fmt.Sprintf("%s.4.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(iface.TxMulticast.Packets)
// ifOutBroadcastPkts (.5)
item = m.handler.Add(fmt.Sprintf("%s.5.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter32
item.Value = uint32(iface.TxBroadcast.Packets)
// ifHCInOctets (.6)
item = m.handler.Add(fmt.Sprintf("%s.6.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter64
item.Value = iface.Rx.Bytes
// ifHCInUcastPkts (.7)
item = m.handler.Add(fmt.Sprintf("%s.7.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter64
if iface.RxUnicast.Packets == 0 {
item.Value = iface.Rx.Packets
} else {
item.Value = iface.RxUnicast.Packets
}
// ifHCInMulticastPkts (.8)
item = m.handler.Add(fmt.Sprintf("%s.8.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter64
item.Value = iface.RxMulticast.Packets
// ifHCInBroadcastPkts (.9)
item = m.handler.Add(fmt.Sprintf("%s.9.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter64
item.Value = iface.RxBroadcast.Packets
// ifHCOutOctets (.10)
item = m.handler.Add(fmt.Sprintf("%s.10.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter64
item.Value = iface.Tx.Bytes
// ifHCOutUcastPkts (.11)
item = m.handler.Add(fmt.Sprintf("%s.11.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter64
if iface.TxUnicast.Packets == 0 {
item.Value = iface.Tx.Packets
} else {
item.Value = iface.TxUnicast.Packets
}
// ifHCOutMulticastPkts (.12)
item = m.handler.Add(fmt.Sprintf("%s.12.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter64
item.Value = iface.TxMulticast.Packets
// ifHCOutBroadcastPkts (.13)
item = m.handler.Add(fmt.Sprintf("%s.13.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeCounter64
item.Value = iface.TxBroadcast.Packets
// ifHighSpeed (.15) - Interface speed in Megabits per second
details := m.interfaceDetails[iface.InterfaceIndex]
speedMbps := uint32(1000) // default 1 Gbps = 1000 Mbps
// ifHighSpeed (.15)
speedMbps := uint32(1000)
if details != nil && details.Speed > 0 {
speedMbps = uint32(details.Speed / 1000000) // Convert bps to Mbps
speedMbps = uint32(details.Speed / 1000000)
}
item = m.handler.Add(fmt.Sprintf("%s.15.%d", ifXTableOID, idx))
item = handler.Add(fmt.Sprintf("%s.15.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeGauge32
item.Value = speedMbps
// ifAlias (.18) - Interface description/alias
item = m.handler.Add(fmt.Sprintf("%s.18.%d", ifXTableOID, idx))
// ifAlias (.18)
item = handler.Add(fmt.Sprintf("%s.18.%d", ifXTableOID, idx))
item.Type = pdu.VariableTypeOctetString
// Use description from VPP config if available, otherwise use interface name
if desc, exists := m.descriptions[iface.InterfaceName]; exists {
item.Value = desc
} else {
@@ -456,41 +329,157 @@ func (m *InterfaceMIB) addIfXTable(iface *api.InterfaceCounters, idx int) {
}
}
func (m *InterfaceMIB) addCounterFields(handler *agentx.ListHandler, iface *api.InterfaceCounters, idx int) {
ifIdx := iface.InterfaceIndex
// ifEntry counters
counters := []struct {
oid string
key string
typ pdu.VariableType
}{
{fmt.Sprintf("%s.10.%d", ifEntryOID, idx), "ifInOctets", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.11.%d", ifEntryOID, idx), "ifInUcastPkts", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.12.%d", ifEntryOID, idx), "ifInNUcastPkts", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.13.%d", ifEntryOID, idx), "ifInDiscards", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.14.%d", ifEntryOID, idx), "ifInErrors", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.16.%d", ifEntryOID, idx), "ifOutOctets", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.17.%d", ifEntryOID, idx), "ifOutUcastPkts", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.18.%d", ifEntryOID, idx), "ifOutNUcastPkts", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.20.%d", ifEntryOID, idx), "ifOutErrors", pdu.VariableTypeCounter32},
// ifXTable counters
{fmt.Sprintf("%s.2.%d", ifXTableOID, idx), "ifInMulticastPkts", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.3.%d", ifXTableOID, idx), "ifInBroadcastPkts", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.4.%d", ifXTableOID, idx), "ifOutMulticastPkts", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.5.%d", ifXTableOID, idx), "ifOutBroadcastPkts", pdu.VariableTypeCounter32},
{fmt.Sprintf("%s.6.%d", ifXTableOID, idx), "ifHCInOctets", pdu.VariableTypeCounter64},
{fmt.Sprintf("%s.7.%d", ifXTableOID, idx), "ifHCInUcastPkts", pdu.VariableTypeCounter64},
{fmt.Sprintf("%s.8.%d", ifXTableOID, idx), "ifHCInMulticastPkts", pdu.VariableTypeCounter64},
{fmt.Sprintf("%s.9.%d", ifXTableOID, idx), "ifHCInBroadcastPkts", pdu.VariableTypeCounter64},
{fmt.Sprintf("%s.10.%d", ifXTableOID, idx), "ifHCOutOctets", pdu.VariableTypeCounter64},
{fmt.Sprintf("%s.11.%d", ifXTableOID, idx), "ifHCOutUcastPkts", pdu.VariableTypeCounter64},
{fmt.Sprintf("%s.12.%d", ifXTableOID, idx), "ifHCOutMulticastPkts", pdu.VariableTypeCounter64},
{fmt.Sprintf("%s.13.%d", ifXTableOID, idx), "ifHCOutBroadcastPkts", pdu.VariableTypeCounter64},
}
for _, counter := range counters {
item := handler.Add(counter.oid)
item.Type = counter.typ
m.counterItems[fmt.Sprintf("%d_%s", ifIdx, counter.key)] = item
}
// Set initial values
m.updateCounterValues(iface)
}
func (m *InterfaceMIB) updateCounterValues(iface *api.InterfaceCounters) {
ifIdx := iface.InterfaceIndex
// ifEntry counters
if item := m.counterItems[fmt.Sprintf("%d_ifInOctets", ifIdx)]; item != nil {
item.Value = uint32(iface.Rx.Bytes)
}
if item := m.counterItems[fmt.Sprintf("%d_ifInUcastPkts", ifIdx)]; item != nil {
if iface.RxUnicast.Packets == 0 {
item.Value = uint32(iface.Rx.Packets)
} else {
item.Value = uint32(iface.RxUnicast.Packets)
}
}
if item := m.counterItems[fmt.Sprintf("%d_ifInNUcastPkts", ifIdx)]; item != nil {
item.Value = uint32(iface.RxMulticast.Packets + iface.RxBroadcast.Packets)
}
if item := m.counterItems[fmt.Sprintf("%d_ifInDiscards", ifIdx)]; item != nil {
item.Value = uint32(iface.Drops)
}
if item := m.counterItems[fmt.Sprintf("%d_ifInErrors", ifIdx)]; item != nil {
item.Value = uint32(iface.RxErrors)
}
if item := m.counterItems[fmt.Sprintf("%d_ifOutOctets", ifIdx)]; item != nil {
item.Value = uint32(iface.Tx.Bytes)
}
if item := m.counterItems[fmt.Sprintf("%d_ifOutUcastPkts", ifIdx)]; item != nil {
if iface.TxUnicast.Packets == 0 {
item.Value = uint32(iface.Tx.Packets)
} else {
item.Value = uint32(iface.TxUnicast.Packets)
}
}
if item := m.counterItems[fmt.Sprintf("%d_ifOutNUcastPkts", ifIdx)]; item != nil {
item.Value = uint32(iface.TxMulticast.Packets + iface.TxBroadcast.Packets)
}
if item := m.counterItems[fmt.Sprintf("%d_ifOutErrors", ifIdx)]; item != nil {
item.Value = uint32(iface.TxErrors)
}
// ifXTable counters
if item := m.counterItems[fmt.Sprintf("%d_ifInMulticastPkts", ifIdx)]; item != nil {
item.Value = uint32(iface.RxMulticast.Packets)
}
if item := m.counterItems[fmt.Sprintf("%d_ifInBroadcastPkts", ifIdx)]; item != nil {
item.Value = uint32(iface.RxBroadcast.Packets)
}
if item := m.counterItems[fmt.Sprintf("%d_ifOutMulticastPkts", ifIdx)]; item != nil {
item.Value = uint32(iface.TxMulticast.Packets)
}
if item := m.counterItems[fmt.Sprintf("%d_ifOutBroadcastPkts", ifIdx)]; item != nil {
item.Value = uint32(iface.TxBroadcast.Packets)
}
if item := m.counterItems[fmt.Sprintf("%d_ifHCInOctets", ifIdx)]; item != nil {
item.Value = iface.Rx.Bytes
}
if item := m.counterItems[fmt.Sprintf("%d_ifHCInUcastPkts", ifIdx)]; item != nil {
if iface.RxUnicast.Packets == 0 {
item.Value = iface.Rx.Packets
} else {
item.Value = iface.RxUnicast.Packets
}
}
if item := m.counterItems[fmt.Sprintf("%d_ifHCInMulticastPkts", ifIdx)]; item != nil {
item.Value = iface.RxMulticast.Packets
}
if item := m.counterItems[fmt.Sprintf("%d_ifHCInBroadcastPkts", ifIdx)]; item != nil {
item.Value = iface.RxBroadcast.Packets
}
if item := m.counterItems[fmt.Sprintf("%d_ifHCOutOctets", ifIdx)]; item != nil {
item.Value = iface.Tx.Bytes
}
if item := m.counterItems[fmt.Sprintf("%d_ifHCOutUcastPkts", ifIdx)]; item != nil {
if iface.TxUnicast.Packets == 0 {
item.Value = iface.Tx.Packets
} else {
item.Value = iface.TxUnicast.Packets
}
}
if item := m.counterItems[fmt.Sprintf("%d_ifHCOutMulticastPkts", ifIdx)]; item != nil {
item.Value = iface.TxMulticast.Packets
}
if item := m.counterItems[fmt.Sprintf("%d_ifHCOutBroadcastPkts", ifIdx)]; item != nil {
item.Value = iface.TxBroadcast.Packets
}
}
func (m *InterfaceMIB) RegisterWithClient(client *agentx.Client) error {
m.mutex.Lock()
defer m.mutex.Unlock()
// Create separate sessions for each MIB
ifEntrySession, err := client.Session()
if err != nil {
return fmt.Errorf("failed to create ifEntry session: %v", err)
}
ifXTableSession, err := client.Session()
if err != nil {
return fmt.Errorf("failed to create ifXTable session: %v", err)
}
m.ifEntrySession = ifEntrySession
m.ifXTableSession = ifXTableSession
// Set handlers for both sessions
ifEntrySession.Handler = m.handler
ifXTableSession.Handler = m.handler
// Register the classic ifEntry
err = ifEntrySession.Register(127, value.MustParseOID(ifEntryOID))
if err != nil {
return fmt.Errorf("failed to register ifEntry: %v", err)
}
// Register the extended ifXTable
err = ifXTableSession.Register(127, value.MustParseOID(ifXTableOID))
if err != nil {
return fmt.Errorf("failed to register ifXTable: %v", err)
}
logger.Debugf("Registered IF-MIB ifEntry at OID %s", ifEntryOID)
logger.Debugf("Registered IF-MIB ifXTable at OID %s", ifXTableOID)
m.client = client
// Don't register anything yet - wait for first UpdateStats call
logger.Debugf("Stored AgentX client reference")
return nil
}
func (m *InterfaceMIB) Close() {
m.mutex.Lock()
defer m.mutex.Unlock()
if m.ifEntrySession != nil {
m.ifEntrySession.Close()
m.ifEntrySession = nil
}
if m.ifXTableSession != nil {
m.ifXTableSession.Close()
m.ifXTableSession = nil
}
}

View File

@@ -14,22 +14,27 @@ func TestNewInterfaceMIB(t *testing.T) {
if mib == nil {
t.Fatal("NewInterfaceMIB returned nil")
}
if mib.handler == nil {
t.Error("Expected handler to be initialized")
}
if mib.stats == nil {
t.Error("Expected stats map to be initialized")
return
}
if mib.descriptions == nil {
t.Error("Expected descriptions map to be initialized")
}
if len(mib.stats) != 0 {
t.Errorf("Expected stats map to be empty, got %d entries", len(mib.stats))
if mib.interfaceDetails == nil {
t.Error("Expected interfaceDetails map to be initialized")
}
if mib.currentInterfaces == nil {
t.Error("Expected currentInterfaces map to be initialized")
}
if mib.counterItems == nil {
t.Error("Expected counterItems map to be initialized")
}
if len(mib.currentInterfaces) != 0 {
t.Errorf("Expected currentInterfaces map to be empty, got %d entries", len(mib.currentInterfaces))
}
if len(mib.descriptions) != 0 {
@@ -39,14 +44,20 @@ func TestNewInterfaceMIB(t *testing.T) {
func TestGetHandler(t *testing.T) {
mib := NewInterfaceMIB()
handler := mib.GetHandler()
handler1 := mib.GetHandler()
handler2 := mib.GetHandler()
if handler == nil {
if handler1 == nil {
t.Error("GetHandler returned nil")
}
if handler != mib.handler {
t.Error("GetHandler returned different handler than expected")
if handler2 == nil {
t.Error("GetHandler returned nil")
}
// In the new implementation, GetHandler always returns a fresh handler
if handler1 == handler2 {
t.Error("Expected GetHandler to return fresh handlers, but got the same reference")
}
}
@@ -162,19 +173,12 @@ func TestUpdateStatsBasic(t *testing.T) {
// Call UpdateStats (this will test the basic flow without AgentX sessions)
mib.UpdateStats(stats)
// Check that stats were stored
if len(mib.stats) != 1 {
t.Errorf("Expected 1 interface in stats, got %d", len(mib.stats))
// Check that interface was registered
if len(mib.currentInterfaces) != 1 {
t.Errorf("Expected 1 interface in currentInterfaces, got %d", len(mib.currentInterfaces))
}
if storedStats, exists := mib.stats[0]; !exists {
t.Error("Expected interface 0 to be stored in stats")
} else {
if storedStats.InterfaceName != "test0" {
t.Errorf("Expected interface name 'test0', got '%s'", storedStats.InterfaceName)
}
if storedStats.Rx.Packets != 100 {
t.Errorf("Expected RX packets 100, got %d", storedStats.Rx.Packets)
}
if !mib.currentInterfaces[0] {
t.Error("Expected interface 0 to be registered in currentInterfaces")
}
}

View File

@@ -16,7 +16,7 @@ import (
"govpp-snmp-agentx/vpp"
)
const Version = "1.1.3-1"
const Version = "1.2.3-1"
func main() {
debug := flag.Bool("debug", false, "Enable debug logging")
@@ -45,11 +45,22 @@ func main() {
log.Fatalf("Failed to start AgentX: %v", err)
}
// Set up interface event callback to update interface details
vpp.SetInterfaceEventCallback(interfaceMIB.UpdateInterfaceDetails)
// Create VPP client and managers
vppClient := &vpp.VPPClient{}
interfaceManager := vpp.NewInterfaceManager(vppClient)
statsManager := vpp.NewStatsManager(vppClient, interfaceManager)
// Start VPP stats routine with callback to update MIB
vpp.StartStatsRoutine(interfaceMIB.UpdateStats)
// Set up interface event callback to update interface details
interfaceManager.SetEventCallback(interfaceMIB.UpdateInterfaceDetails)
// Set up stats callback to update MIB
statsManager.SetStatsCallback(interfaceMIB.UpdateStats)
// Start VPP stats routine
statsManager.StartStatsRoutine()
// Start interface event monitoring (handles reconnections automatically)
interfaceManager.StartEventMonitoring()
// Set up signal handling for graceful shutdown
sigChan := make(chan os.Signal, 1)
@@ -59,6 +70,11 @@ func main() {
<-sigChan
logger.Printf("Shutting down...")
// Stop stats routine and interface monitoring, then disconnect
statsManager.StopStatsRoutine()
interfaceManager.StopEventMonitoring()
vppClient.Disconnect()
// Flush any buffered log entries
logger.Sync()
}

173
src/vpp/vpp.go Normal file
View File

@@ -0,0 +1,173 @@
// Copyright 2025, IPng Networks GmbH, Pim van Pelt <pim@ipng.ch>
package vpp
import (
"flag"
"go.fd.io/govpp/adapter/socketclient"
"go.fd.io/govpp/adapter/statsclient"
"go.fd.io/govpp/api"
"go.fd.io/govpp/binapi/vpe"
"go.fd.io/govpp/core"
"govpp-snmp-agentx/logger"
)
var (
// Flags for VPP configuration
ApiAddr = flag.String("vppstats.api.addr", "/var/run/vpp/api.sock", "VPP API socket path")
StatsAddr = flag.String("vppstats.stats.addr", "/var/run/vpp/stats.sock", "VPP stats socket path")
IfIndexOffset = flag.Int("vppstats.ifindex-offset", 1000, "Offset to add to VPP interface indices for SNMP")
Period = flag.Int("vppstats.period", 10, "Interval in seconds for querying VPP interface stats")
)
// VPPClient manages VPP connections and provides a unified interface
type VPPClient struct {
apiConn *core.Connection
statsConn *core.StatsConnection
connected bool
}
// Connect establishes connections to both VPP API and Stats sockets
func (c *VPPClient) Connect() error {
logger.Debugf("Connecting to VPP (API: %s, Stats: %s)", *ApiAddr, *StatsAddr)
// Connect to API socket
apiConn, err := core.Connect(socketclient.NewVppClient(*ApiAddr))
if err != nil {
return err
}
// Connect to stats socket
statsClient := statsclient.NewStatsClient(*StatsAddr)
statsConn, err := core.ConnectStats(statsClient)
if err != nil {
// Clean up API connection on stats failure
func() {
defer func() {
if r := recover(); r != nil {
logger.Debugf("Recovered from API disconnect during stats error: %v", r)
}
}()
apiConn.Disconnect()
}()
return err
}
c.apiConn = apiConn
c.statsConn = statsConn
c.connected = true
logger.Printf("Connected to VPP (API: %s, Stats: %s)", *ApiAddr, *StatsAddr)
return nil
}
// Disconnect closes all VPP connections safely
func (c *VPPClient) Disconnect() {
if c.apiConn != nil {
func() {
defer func() {
if r := recover(); r != nil {
logger.Debugf("Recovered from API disconnect panic: %v", r)
}
}()
c.apiConn.Disconnect()
}()
c.apiConn = nil
}
if c.statsConn != nil {
func() {
defer func() {
if r := recover(); r != nil {
logger.Debugf("Recovered from stats disconnect panic: %v", r)
}
}()
c.statsConn.Disconnect()
}()
c.statsConn = nil
}
c.connected = false
}
// IsConnected returns true if both API and Stats connections are active
func (c *VPPClient) IsConnected() bool {
return c.connected && c.apiConn != nil && c.statsConn != nil
}
// GetAPIConnection returns the API connection for direct use
func (c *VPPClient) GetAPIConnection() *core.Connection {
return c.apiConn
}
// GetStatsConnection returns the stats connection for direct use
func (c *VPPClient) GetStatsConnection() *core.StatsConnection {
return c.statsConn
}
// NewAPIChannel creates a new API channel from the connection
func (c *VPPClient) NewAPIChannel() (api.Channel, error) {
if c.apiConn == nil {
return nil, &VPPError{Message: "API connection not established"}
}
return c.apiConn.NewAPIChannel()
}
// CheckLiveness performs a VPP liveness check using ShowVersion API call
func (c *VPPClient) CheckLiveness() bool {
if !c.IsConnected() {
return false
}
ch, err := c.NewAPIChannel()
if err != nil {
logger.Debugf("Failed to create API channel for liveness check: %v", err)
return false
}
var channelClosed bool
defer func() {
if !channelClosed {
defer func() {
if r := recover(); r != nil {
logger.Debugf("Recovered from channel close panic: %v", r)
}
}()
ch.Close()
}
}()
req := &vpe.ShowVersion{}
reply := &vpe.ShowVersionReply{}
if err := ch.SendRequest(req).ReceiveReply(reply); err != nil {
logger.Debugf("VPP ShowVersion failed: %v", err)
func() {
defer func() {
if r := recover(); r != nil {
logger.Debugf("Channel already closed during error handling")
}
}()
ch.Close()
channelClosed = true
}()
return false
}
ch.Close()
channelClosed = true
logger.Debugf("VPP liveness check passed (version: %s)", string(reply.Version))
return true
}
// VPPError represents a VPP-specific error
type VPPError struct {
Message string
}
func (e *VPPError) Error() string {
return e.Message
}

View File

@@ -4,6 +4,7 @@ package vpp
import (
"os"
"time"
"go.fd.io/govpp/api"
interfaces "go.fd.io/govpp/binapi/interface"
@@ -26,8 +27,146 @@ type InterfaceDetails struct {
// InterfaceEventCallback is called when interface events occur
type InterfaceEventCallback func(details []InterfaceDetails)
// InterfaceManager handles interface-related VPP operations
type InterfaceManager struct {
client *VPPClient
eventCallback InterfaceEventCallback
running bool
watchingEvents bool
}
// NewInterfaceManager creates a new interface manager
func NewInterfaceManager(client *VPPClient) *InterfaceManager {
return &InterfaceManager{
client: client,
}
}
// SetEventCallback sets the callback for interface events
func (im *InterfaceManager) SetEventCallback(callback InterfaceEventCallback) {
im.eventCallback = callback
}
// InitializeEventWatching starts event watching and retrieves initial interface details
func (im *InterfaceManager) InitializeEventWatching() error {
if !im.client.IsConnected() {
return &VPPError{Message: "VPP client not connected"}
}
// Start watching interface events
if err := im.StartEventWatcher(); err != nil {
logger.Debugf("Failed to start interface event watching: %v", err)
return err
}
logger.Debugf("Interface event watching started")
// Get initial interface details
if details, err := im.GetAllInterfaceDetails(); err != nil {
logger.Debugf("Failed to get initial interface details: %v", err)
return err
} else {
logger.Debugf("Retrieved initial interface details for %d interfaces", len(details))
if im.eventCallback != nil {
im.eventCallback(details)
}
}
im.watchingEvents = true
return nil
}
// StartEventMonitoring starts continuous monitoring for VPP connection and restarts event watching as needed
func (im *InterfaceManager) StartEventMonitoring() {
if im.running {
logger.Debugf("Interface event monitoring already running")
return
}
im.running = true
go im.eventMonitoringRoutine()
}
// StopEventMonitoring stops the event monitoring routine
func (im *InterfaceManager) StopEventMonitoring() {
im.running = false
}
// eventMonitoringRoutine continuously monitors VPP connection and manages event watching
func (im *InterfaceManager) eventMonitoringRoutine() {
logger.Debugf("Starting interface event monitoring routine")
for {
if !im.running {
logger.Debugf("Interface event monitoring routine stopping")
break
}
if im.client.IsConnected() {
if !im.watchingEvents {
if err := im.InitializeEventWatching(); err != nil {
logger.Printf("Failed to initialize interface event watching: %v", err)
} else {
logger.Printf("Interface event watching started")
}
}
} else {
if im.watchingEvents {
logger.Printf("VPP connection lost, interface event watching will restart on reconnection")
im.watchingEvents = false
}
}
time.Sleep(time.Second)
}
logger.Debugf("Interface event monitoring routine ended")
}
// GetAllInterfaceDetails retrieves detailed information for all interfaces
func GetAllInterfaceDetails(ch api.Channel) ([]InterfaceDetails, error) {
func (im *InterfaceManager) GetAllInterfaceDetails() ([]InterfaceDetails, error) {
if !im.client.IsConnected() {
return nil, &VPPError{Message: "VPP client not connected"}
}
ch, err := im.client.NewAPIChannel()
if err != nil {
return nil, err
}
defer ch.Close()
return getAllInterfaceDetails(ch)
}
// StartEventWatcher starts watching for interface events
func (im *InterfaceManager) StartEventWatcher() error {
if !im.client.IsConnected() {
return &VPPError{Message: "VPP client not connected"}
}
ch, err := im.client.NewAPIChannel()
if err != nil {
return err
}
return watchInterfaceEvents(ch, im.handleInterfaceEvent)
}
// handleInterfaceEvent handles interface events and calls the callback
func (im *InterfaceManager) handleInterfaceEvent() {
if im.eventCallback != nil {
details, err := im.GetAllInterfaceDetails()
if err != nil {
logger.Debugf("Failed to retrieve interface details after event: %v", err)
} else {
logger.Debugf("Calling interface event callback with %d interfaces", len(details))
im.eventCallback(details)
}
}
}
// getAllInterfaceDetails retrieves detailed information for all interfaces (internal function)
func getAllInterfaceDetails(ch api.Channel) ([]InterfaceDetails, error) {
logger.Debugf("Retrieving all interface details from VPP")
// Get all interfaces
@@ -73,7 +212,8 @@ func GetAllInterfaceDetails(ch api.Channel) ([]InterfaceDetails, error) {
return details, nil
}
func WatchInterfaceEvents(ch api.Channel, callback InterfaceEventCallback) error {
// watchInterfaceEvents watches for VPP interface events (internal function)
func watchInterfaceEvents(ch api.Channel, callback func()) error {
logger.Debugf("WatchInterfaceEvents() called - starting interface event monitoring")
notifChan := make(chan api.Message, 100)
@@ -124,18 +264,12 @@ func WatchInterfaceEvents(ch api.Channel, callback InterfaceEventCallback) error
logger.Debugf("Interface event listener waiting for events...")
for notif := range notifChan {
e := notif.(*interfaces.SwInterfaceEvent)
logger.Debugf("interface event: SwIfIndex=%d, Flags=%d, Deleted=%t",
logger.Printf("interface event: SwIfIndex=%d, Flags=%d, Deleted=%t",
e.SwIfIndex, e.Flags, e.Deleted)
// When an interface event occurs, retrieve all interface details and call callback
// When an interface event occurs, call the callback
if callback != nil {
details, err := GetAllInterfaceDetails(ch)
if err != nil {
logger.Debugf("Failed to retrieve interface details after event: %v", err)
} else {
logger.Debugf("Calling interface event callback with %d interfaces", len(details))
callback(details)
}
callback()
}
}
logger.Debugf("Interface event listener goroutine ended")

285
src/vpp/vpp_iface_test.go Normal file
View File

@@ -0,0 +1,285 @@
// Copyright 2025, IPng Networks GmbH, Pim van Pelt <pim@ipng.ch>
package vpp
import (
"testing"
"time"
"go.fd.io/govpp/binapi/interface_types"
)
func TestNewInterfaceManager(t *testing.T) {
client := &VPPClient{}
manager := NewInterfaceManager(client)
if manager == nil {
t.Fatal("NewInterfaceManager() returned nil")
return
}
if manager.client != client {
t.Error("InterfaceManager should store the provided client")
}
if manager.eventCallback != nil {
t.Error("InterfaceManager should have nil callback initially")
}
if manager.running {
t.Error("InterfaceManager should not be running initially")
}
if manager.watchingEvents {
t.Error("InterfaceManager should not be watching events initially")
}
}
func TestInterfaceManagerSetEventCallback(t *testing.T) {
client := &VPPClient{}
manager := NewInterfaceManager(client)
var callbackCalled bool
var receivedDetails []InterfaceDetails
callback := func(details []InterfaceDetails) {
callbackCalled = true
receivedDetails = details
}
manager.SetEventCallback(callback)
if manager.eventCallback == nil {
t.Error("SetEventCallback() should store the callback")
}
// Test callback execution
testDetails := []InterfaceDetails{
{
SwIfIndex: 1,
InterfaceName: "test-interface",
MacAddress: []byte{0xde, 0xad, 0xbe, 0xef, 0x00, 0x01},
Speed: 1000000000,
AdminStatus: true,
OperStatus: true,
MTU: 1500,
},
}
manager.eventCallback(testDetails)
if !callbackCalled {
t.Error("Callback should have been called")
}
if len(receivedDetails) != 1 {
t.Errorf("Expected 1 interface detail, got %d", len(receivedDetails))
}
if receivedDetails[0].InterfaceName != "test-interface" {
t.Errorf("Expected interface name 'test-interface', got %q", receivedDetails[0].InterfaceName)
}
}
func TestInterfaceManagerGetAllInterfaceDetailsWithoutConnection(t *testing.T) {
client := &VPPClient{}
manager := NewInterfaceManager(client)
_, err := manager.GetAllInterfaceDetails()
if err == nil {
t.Error("GetAllInterfaceDetails() should return error when not connected")
}
vppErr, ok := err.(*VPPError)
if !ok {
t.Errorf("Expected VPPError, got %T", err)
}
if vppErr.Message != "VPP client not connected" {
t.Errorf("Expected specific error message, got: %s", vppErr.Message)
}
}
func TestInterfaceManagerStartEventWatcherWithoutConnection(t *testing.T) {
client := &VPPClient{}
manager := NewInterfaceManager(client)
err := manager.StartEventWatcher()
if err == nil {
t.Error("StartEventWatcher() should return error when not connected")
}
vppErr, ok := err.(*VPPError)
if !ok {
t.Errorf("Expected VPPError, got %T", err)
}
if vppErr.Message != "VPP client not connected" {
t.Errorf("Expected specific error message, got: %s", vppErr.Message)
}
}
func TestInterfaceManagerHandleInterfaceEventWithoutCallback(t *testing.T) {
client := &VPPClient{}
manager := NewInterfaceManager(client)
// Should not panic when callback is nil
manager.handleInterfaceEvent()
}
func TestInterfaceManagerInitializeEventWatchingWithoutConnection(t *testing.T) {
client := &VPPClient{}
manager := NewInterfaceManager(client)
err := manager.InitializeEventWatching()
if err == nil {
t.Error("InitializeEventWatching() should return error when not connected")
}
vppErr, ok := err.(*VPPError)
if !ok {
t.Errorf("Expected VPPError, got %T", err)
}
if vppErr.Message != "VPP client not connected" {
t.Errorf("Expected specific error message, got: %s", vppErr.Message)
}
}
func TestInterfaceDetails(t *testing.T) {
details := InterfaceDetails{
SwIfIndex: interface_types.InterfaceIndex(42),
InterfaceName: "GigabitEthernet0/8/0",
MacAddress: []byte{0x02, 0xfe, 0x3c, 0x4d, 0x5e, 0x6f},
Speed: 10000000000, // 10 Gbps
AdminStatus: true,
OperStatus: false,
MTU: 9000,
}
if details.SwIfIndex != 42 {
t.Errorf("Expected SwIfIndex 42, got %d", details.SwIfIndex)
}
if details.InterfaceName != "GigabitEthernet0/8/0" {
t.Errorf("Expected interface name 'GigabitEthernet0/8/0', got %q", details.InterfaceName)
}
if len(details.MacAddress) != 6 {
t.Errorf("Expected MAC address length 6, got %d", len(details.MacAddress))
}
if details.Speed != 10000000000 {
t.Errorf("Expected speed 10000000000, got %d", details.Speed)
}
if !details.AdminStatus {
t.Error("Expected AdminStatus true")
}
if details.OperStatus {
t.Error("Expected OperStatus false")
}
if details.MTU != 9000 {
t.Errorf("Expected MTU 9000, got %d", details.MTU)
}
}
func TestInterfaceEventCallback(t *testing.T) {
var callbackInvoked bool
var callbackDetails []InterfaceDetails
callback := InterfaceEventCallback(func(details []InterfaceDetails) {
callbackInvoked = true
callbackDetails = details
})
testDetails := []InterfaceDetails{
{SwIfIndex: 1, InterfaceName: "test1"},
{SwIfIndex: 2, InterfaceName: "test2"},
}
callback(testDetails)
if !callbackInvoked {
t.Error("Callback should have been invoked")
}
if len(callbackDetails) != 2 {
t.Errorf("Expected 2 interface details, got %d", len(callbackDetails))
}
if callbackDetails[0].InterfaceName != "test1" {
t.Errorf("Expected first interface 'test1', got %q", callbackDetails[0].InterfaceName)
}
if callbackDetails[1].InterfaceName != "test2" {
t.Errorf("Expected second interface 'test2', got %q", callbackDetails[1].InterfaceName)
}
}
func TestInterfaceManagerStartStopEventMonitoring(t *testing.T) {
client := &VPPClient{}
manager := NewInterfaceManager(client)
if manager.running {
t.Error("InterfaceManager should not be running initially")
}
manager.StartEventMonitoring()
if !manager.running {
t.Error("InterfaceManager should be running after StartEventMonitoring()")
}
// Test starting again (should be safe)
manager.StartEventMonitoring()
if !manager.running {
t.Error("InterfaceManager should still be running after second StartEventMonitoring()")
}
manager.StopEventMonitoring()
if manager.running {
t.Error("InterfaceManager should not be running after StopEventMonitoring()")
}
}
func TestInterfaceManagerEventMonitoringWithConnectionChanges(t *testing.T) {
client := &VPPClient{}
manager := NewInterfaceManager(client)
// Set a callback to track calls
var callbackCount int
manager.SetEventCallback(func(details []InterfaceDetails) {
callbackCount++
})
manager.StartEventMonitoring()
// Let it run briefly
time.Sleep(50 * time.Millisecond)
// Simulate VPP connection and disconnection by checking state changes
initialWatchingState := manager.watchingEvents
// Stop monitoring
manager.StopEventMonitoring()
// Verify it stopped
if manager.running {
t.Error("Event monitoring should have stopped")
}
// The watching state should reflect the connection state
if !client.IsConnected() && manager.watchingEvents {
t.Error("Should not be watching events when disconnected")
}
// Initial state should be false since we're not connected to VPP in tests
if initialWatchingState {
t.Error("Should not be watching events initially when VPP is not connected")
}
}

View File

@@ -3,174 +3,118 @@
package vpp
import (
"flag"
"time"
"go.fd.io/govpp/adapter/socketclient"
"go.fd.io/govpp/adapter/statsclient"
"go.fd.io/govpp/api"
"go.fd.io/govpp/binapi/vpe"
"go.fd.io/govpp/core"
"govpp-snmp-agentx/logger"
)
// StatsCallback is called when interface stats are retrieved
type StatsCallback func(*api.InterfaceStats)
// Global callback for interface events
var interfaceEventCallback InterfaceEventCallback
var (
// Flags for VPP stats configuration
ApiAddr = flag.String("vppstats.api.addr", "/var/run/vpp/api.sock", "VPP API socket path")
StatsAddr = flag.String("vppstats.stats.addr", "/var/run/vpp/stats.sock", "VPP stats socket path")
IfIndexOffset = flag.Int("vppstats.ifindex-offset", 1000, "Offset to add to VPP interface indices for SNMP")
Period = flag.Int("vppstats.period", 10, "Interval in seconds for querying VPP interface stats")
)
// SetInterfaceEventCallback sets the callback for interface events
func SetInterfaceEventCallback(callback InterfaceEventCallback) {
interfaceEventCallback = callback
// StatsManager handles VPP statistics operations
type StatsManager struct {
client *VPPClient
interfaceManager *InterfaceManager
statsCallback StatsCallback
period time.Duration
running bool
}
// StartStatsRoutine starts a goroutine that queries VPP interface stats at the configured interval
func StartStatsRoutine(callback StatsCallback) {
period := time.Duration(*Period) * time.Second
go statsRoutine(period, callback)
// NewStatsManager creates a new stats manager
func NewStatsManager(client *VPPClient, interfaceManager *InterfaceManager) *StatsManager {
return &StatsManager{
client: client,
interfaceManager: interfaceManager,
period: time.Duration(*Period) * time.Second,
}
}
func statsRoutine(period time.Duration, callback StatsCallback) {
logger.Debugf("Starting VPP stats routine with API: %s, Stats: %s, period: %v", *ApiAddr, *StatsAddr, period)
// SetStatsCallback sets the callback for stats updates
func (sm *StatsManager) SetStatsCallback(callback StatsCallback) {
sm.statsCallback = callback
}
var conn *core.Connection
var statsConn *core.StatsConnection
var connected = false
var wasConnected = false
// SetPeriod sets the polling period for stats
func (sm *StatsManager) SetPeriod(period time.Duration) {
sm.period = period
}
ticker := time.NewTicker(period)
// StartStatsRoutine starts the stats polling routine
func (sm *StatsManager) StartStatsRoutine() {
if sm.running {
logger.Debugf("Stats routine already running")
return
}
sm.running = true
go sm.statsRoutine()
}
// StopStatsRoutine stops the stats polling routine
func (sm *StatsManager) StopStatsRoutine() {
sm.running = false
}
// GetInterfaceStats retrieves current interface statistics
func (sm *StatsManager) GetInterfaceStats() (*api.InterfaceStats, error) {
if !sm.client.IsConnected() {
return nil, &VPPError{Message: "VPP client not connected"}
}
statsConn := sm.client.GetStatsConnection()
if statsConn == nil {
return nil, &VPPError{Message: "Stats connection not available"}
}
stats := new(api.InterfaceStats)
if err := statsConn.GetInterfaceStats(stats); err != nil {
return nil, err
}
return stats, nil
}
// statsRoutine is the main stats polling loop
func (sm *StatsManager) statsRoutine() {
logger.Debugf("Starting VPP stats routine with period: %v", sm.period)
ticker := time.NewTicker(sm.period)
defer ticker.Stop()
defer func() {
// Safely disconnect connections with panic recovery
if conn != nil {
func() {
defer func() {
if r := recover(); r != nil {
logger.Debugf("Recovered from conn.Disconnect panic: %v", r)
}
}()
conn.Disconnect()
}()
}
if statsConn != nil {
func() {
defer func() {
if r := recover(); r != nil {
logger.Debugf("Recovered from statsConn.Disconnect panic: %v", r)
}
}()
statsConn.Disconnect()
}()
}
}()
var wasConnected = false
for {
// Check if we need to connect/reconnect
if !connected {
// Clean up existing connections
if conn != nil {
func() {
defer func() {
if r := recover(); r != nil {
logger.Debugf("Recovered from conn.Disconnect during reconnect: %v", r)
}
}()
conn.Disconnect()
}()
conn = nil
}
if statsConn != nil {
func() {
defer func() {
if r := recover(); r != nil {
logger.Debugf("Recovered from statsConn.Disconnect during reconnect: %v", r)
}
}()
statsConn.Disconnect()
}()
statsConn = nil
if !sm.running {
logger.Debugf("Stats routine stopping")
break
}
// Create API connection first - only proceed if this succeeds
var err error
conn, err = core.Connect(socketclient.NewVppClient(*ApiAddr))
if err != nil {
// Check if we need to connect/reconnect
if !sm.client.IsConnected() {
if wasConnected {
logger.Printf("VPP API connection lost: %v", err)
logger.Printf("VPP connection lost, attempting reconnect...")
wasConnected = false
} else {
logger.Debugf("Failed to connect to VPP API: %v", err)
logger.Printf("VPP not connected, attempting connection...")
}
connected = false
if err := sm.client.Connect(); err != nil {
logger.Printf("Failed to connect to VPP: %v", err)
time.Sleep(time.Second)
continue
}
// Only try stats connection if API connection succeeded
statsClient := statsclient.NewStatsClient(*StatsAddr)
statsConn, err = core.ConnectStats(statsClient)
if err != nil {
logger.Printf("VPP stats connection failed: %v", err)
// Close the API connection since we can't get stats
func() {
defer func() {
if r := recover(); r != nil {
logger.Debugf("Recovered from conn.Disconnect during stats error: %v", r)
}
}()
conn.Disconnect()
}()
conn = nil
connected = false
time.Sleep(time.Second)
continue
}
logger.Printf("Connected to VPP (API: %s, Stats: %s)", *ApiAddr, *StatsAddr)
connected = true
logger.Printf("VPP connection established")
wasConnected = true
// Start watching interface events
logger.Debugf("Creating API channel for interface events...")
ch, err := conn.NewAPIChannel()
if err != nil {
logger.Debugf("Failed to create API channel for interface events: %v", err)
} else {
logger.Debugf("API channel created successfully, calling WatchInterfaceEvents...")
if err := WatchInterfaceEvents(ch, interfaceEventCallback); err != nil {
logger.Debugf("Failed to start interface event watching: %v", err)
ch.Close()
} else {
logger.Printf("Interface event watching started successfully")
// Do initial retrieval of interface details
if interfaceEventCallback != nil {
details, err := GetAllInterfaceDetails(ch)
if err != nil {
logger.Debugf("Failed to get initial interface details: %v", err)
} else {
logger.Debugf("Retrieved initial interface details for %d interfaces", len(details))
interfaceEventCallback(details)
}
}
}
}
}
// Query stats if connected
if connected {
if !queryInterfaceStats(conn, statsConn, callback) {
connected = false
if sm.client.IsConnected() {
if !sm.queryAndReportStats() {
logger.Printf("Stats query failed, marking connection as lost")
sm.client.Disconnect()
continue
}
}
@@ -178,29 +122,43 @@ func statsRoutine(period time.Duration, callback StatsCallback) {
// Wait for next tick
<-ticker.C
}
logger.Debugf("Stats routine ended")
}
func queryInterfaceStats(conn *core.Connection, statsConn *core.StatsConnection, callback StatsCallback) bool {
// Check VPP liveness using API call
if !checkVPPLiveness(conn) {
logger.Printf("VPP liveness check failed")
// queryAndReportStats queries stats and calls the callback
func (sm *StatsManager) queryAndReportStats() bool {
// Check VPP liveness first
if !sm.client.CheckLiveness() {
logger.Debugf("VPP liveness check failed")
return false
}
// Create the proper struct for interface stats
stats := new(api.InterfaceStats)
// Use the GetInterfaceStats method - this is the correct approach
if err := statsConn.GetInterfaceStats(stats); err != nil {
// Get interface stats
stats, err := sm.GetInterfaceStats()
if err != nil {
logger.Printf("Failed to get interface stats: %v", err)
return false
}
// Always log basic info
logger.Printf("Retrieved stats for %d interfaces", len(stats.Interfaces))
// Filter out deleted interfaces by comparing with current interface list
filteredStats, err := sm.filterValidInterfaces(stats)
if err != nil {
logger.Printf("Failed to filter interface stats: %v", err)
return false
}
// Debug log basic info
originalCount := len(stats.Interfaces)
filteredCount := len(filteredStats.Interfaces)
logger.Debugf("Retrieved stats for %d interfaces, filtered to %d valid interfaces", originalCount, filteredCount)
if originalCount > filteredCount {
logger.Debugf("Filtered out %d deleted interfaces", originalCount-filteredCount)
}
// Debug logging for individual interfaces
for _, iface := range stats.Interfaces {
for _, iface := range filteredStats.Interfaces {
logger.Debugf("Interface %d (%s): RX %d pkts/%d bytes, TX %d pkts/%d bytes",
iface.InterfaceIndex, iface.InterfaceName,
iface.Rx.Packets, iface.Rx.Bytes,
@@ -208,60 +166,46 @@ func queryInterfaceStats(conn *core.Connection, statsConn *core.StatsConnection,
}
// Call the callback to update the MIB
if callback != nil {
callback(stats)
if sm.statsCallback != nil {
sm.statsCallback(filteredStats)
}
return true
}
func checkVPPLiveness(conn *core.Connection) bool {
// Create a channel for the API call
ch, err := conn.NewAPIChannel()
// filterValidInterfaces removes stats for deleted interfaces by comparing with current interface list
func (sm *StatsManager) filterValidInterfaces(stats *api.InterfaceStats) (*api.InterfaceStats, error) {
if sm.interfaceManager == nil {
logger.Debugf("No interface manager available, returning unfiltered stats")
return stats, nil
}
// Get current interface details
currentInterfaces, err := sm.interfaceManager.GetAllInterfaceDetails()
if err != nil {
logger.Debugf("Failed to create API channel: %v", err)
return false
logger.Debugf("Failed to get current interface list: %v", err)
return stats, err
}
// Use a flag to track if channel was closed successfully
var channelClosed bool
defer func() {
if !channelClosed {
// Recover from potential panic when closing already closed channel
defer func() {
if r := recover(); r != nil {
logger.Debugf("Recovered from channel close panic: %v", r)
}
}()
ch.Close()
}
}()
// Create ShowVersion request
req := &vpe.ShowVersion{}
reply := &vpe.ShowVersionReply{}
// Send the request with timeout
if err := ch.SendRequest(req).ReceiveReply(reply); err != nil {
logger.Debugf("VPP ShowVersion failed: %v", err)
// Try to close the channel properly on error
func() {
defer func() {
if r := recover(); r != nil {
logger.Debugf("Channel already closed during error handling")
}
}()
ch.Close()
channelClosed = true
}()
return false
// Create a map of valid sw_if_index values
validInterfaces := make(map[uint32]bool)
for _, iface := range currentInterfaces {
validInterfaces[uint32(iface.SwIfIndex)] = true
}
// Close channel successfully
ch.Close()
channelClosed = true
// Filter the stats to only include valid interfaces
filteredStats := &api.InterfaceStats{
Interfaces: make([]api.InterfaceCounters, 0, len(stats.Interfaces)),
}
// If we got here, VPP is responsive
logger.Debugf("VPP liveness check passed (version: %s)", string(reply.Version))
return true
for _, ifaceStat := range stats.Interfaces {
if validInterfaces[ifaceStat.InterfaceIndex] {
filteredStats.Interfaces = append(filteredStats.Interfaces, ifaceStat)
} else {
logger.Debugf("Filtering out stats for deleted interface %d (%s)",
ifaceStat.InterfaceIndex, ifaceStat.InterfaceName)
}
}
return filteredStats, nil
}

247
src/vpp/vpp_stats_test.go Normal file
View File

@@ -0,0 +1,247 @@
// Copyright 2025, IPng Networks GmbH, Pim van Pelt <pim@ipng.ch>
package vpp
import (
"testing"
"time"
"go.fd.io/govpp/api"
)
func TestNewStatsManager(t *testing.T) {
client := &VPPClient{}
interfaceManager := NewInterfaceManager(client)
manager := NewStatsManager(client, interfaceManager)
if manager == nil {
t.Fatal("NewStatsManager() returned nil")
return
}
if manager.client != client {
t.Error("StatsManager should store the provided client")
}
if manager.period != time.Duration(*Period)*time.Second {
t.Errorf("Expected period %v, got %v", time.Duration(*Period)*time.Second, manager.period)
}
if manager.running {
t.Error("StatsManager should not be running initially")
}
if manager.statsCallback != nil {
t.Error("StatsManager should have nil callback initially")
}
}
func TestStatsManagerSetStatsCallback(t *testing.T) {
client := &VPPClient{}
interfaceManager := NewInterfaceManager(client)
manager := NewStatsManager(client, interfaceManager)
var callbackCalled bool
var receivedStats *api.InterfaceStats
callback := func(stats *api.InterfaceStats) {
callbackCalled = true
receivedStats = stats
}
manager.SetStatsCallback(callback)
if manager.statsCallback == nil {
t.Error("SetStatsCallback() should store the callback")
}
// Test callback execution
testStats := &api.InterfaceStats{
Interfaces: []api.InterfaceCounters{
{
InterfaceIndex: 1,
InterfaceName: "test-interface",
Rx: api.InterfaceCounterCombined{Packets: 100, Bytes: 1500},
Tx: api.InterfaceCounterCombined{Packets: 50, Bytes: 750},
},
},
}
manager.statsCallback(testStats)
if !callbackCalled {
t.Error("Callback should have been called")
}
if receivedStats != testStats {
t.Error("Callback should receive the same stats object")
}
if len(receivedStats.Interfaces) != 1 {
t.Errorf("Expected 1 interface, got %d", len(receivedStats.Interfaces))
}
if receivedStats.Interfaces[0].InterfaceName != "test-interface" {
t.Errorf("Expected interface name 'test-interface', got %q", receivedStats.Interfaces[0].InterfaceName)
}
}
func TestStatsManagerSetPeriod(t *testing.T) {
client := &VPPClient{}
interfaceManager := NewInterfaceManager(client)
manager := NewStatsManager(client, interfaceManager)
newPeriod := 5 * time.Second
manager.SetPeriod(newPeriod)
if manager.period != newPeriod {
t.Errorf("Expected period %v, got %v", newPeriod, manager.period)
}
}
func TestStatsManagerStartStopStatsRoutine(t *testing.T) {
client := &VPPClient{}
interfaceManager := NewInterfaceManager(client)
manager := NewStatsManager(client, interfaceManager)
if manager.running {
t.Error("StatsManager should not be running initially")
}
manager.StartStatsRoutine()
if !manager.running {
t.Error("StatsManager should be running after StartStatsRoutine()")
}
// Test starting again (should be safe)
manager.StartStatsRoutine()
if !manager.running {
t.Error("StatsManager should still be running after second StartStatsRoutine()")
}
manager.StopStatsRoutine()
if manager.running {
t.Error("StatsManager should not be running after StopStatsRoutine()")
}
}
func TestStatsManagerGetInterfaceStatsWithoutConnection(t *testing.T) {
client := &VPPClient{}
interfaceManager := NewInterfaceManager(client)
manager := NewStatsManager(client, interfaceManager)
_, err := manager.GetInterfaceStats()
if err == nil {
t.Error("GetInterfaceStats() should return error when not connected")
}
vppErr, ok := err.(*VPPError)
if !ok {
t.Errorf("Expected VPPError, got %T", err)
}
if vppErr.Message != "VPP client not connected" {
t.Errorf("Expected specific error message, got: %s", vppErr.Message)
}
}
func TestStatsCallback(t *testing.T) {
var callbackInvoked bool
var callbackStats *api.InterfaceStats
callback := StatsCallback(func(stats *api.InterfaceStats) {
callbackInvoked = true
callbackStats = stats
})
testStats := &api.InterfaceStats{
Interfaces: []api.InterfaceCounters{
{
InterfaceIndex: 42,
InterfaceName: "test-callback-interface",
Rx: api.InterfaceCounterCombined{Packets: 200, Bytes: 3000},
Tx: api.InterfaceCounterCombined{Packets: 100, Bytes: 1500},
RxUnicast: api.InterfaceCounterCombined{Packets: 180, Bytes: 2700},
TxUnicast: api.InterfaceCounterCombined{Packets: 90, Bytes: 1350},
},
},
}
callback(testStats)
if !callbackInvoked {
t.Error("Callback should have been invoked")
}
if callbackStats != testStats {
t.Error("Callback should receive the same stats object")
}
if len(callbackStats.Interfaces) != 1 {
t.Errorf("Expected 1 interface, got %d", len(callbackStats.Interfaces))
}
iface := callbackStats.Interfaces[0]
if iface.InterfaceIndex != 42 {
t.Errorf("Expected interface index 42, got %d", iface.InterfaceIndex)
}
if iface.InterfaceName != "test-callback-interface" {
t.Errorf("Expected interface name 'test-callback-interface', got %q", iface.InterfaceName)
}
if iface.Rx.Packets != 200 {
t.Errorf("Expected RX packets 200, got %d", iface.Rx.Packets)
}
if iface.Tx.Bytes != 1500 {
t.Errorf("Expected TX bytes 1500, got %d", iface.Tx.Bytes)
}
if iface.RxUnicast.Packets != 180 {
t.Errorf("Expected RX unicast packets 180, got %d", iface.RxUnicast.Packets)
}
if iface.TxUnicast.Bytes != 1350 {
t.Errorf("Expected TX unicast bytes 1350, got %d", iface.TxUnicast.Bytes)
}
}
func TestStatsManagerQueryAndReportStatsWithoutConnection(t *testing.T) {
client := &VPPClient{}
interfaceManager := NewInterfaceManager(client)
manager := NewStatsManager(client, interfaceManager)
// Should return false when not connected
if manager.queryAndReportStats() {
t.Error("queryAndReportStats() should return false when not connected")
}
}
func TestStatsManagerWithShortPeriod(t *testing.T) {
client := &VPPClient{}
interfaceManager := NewInterfaceManager(client)
manager := NewStatsManager(client, interfaceManager)
// Set a very short period for testing
manager.SetPeriod(10 * time.Millisecond)
if manager.period != 10*time.Millisecond {
t.Errorf("Expected period 10ms, got %v", manager.period)
}
manager.StartStatsRoutine()
// Let it run briefly
time.Sleep(50 * time.Millisecond)
manager.StopStatsRoutine()
// Should stop gracefully
if manager.running {
t.Error("StatsManager should have stopped")
}
}

100
src/vpp/vpp_test.go Normal file
View File

@@ -0,0 +1,100 @@
// Copyright 2025, IPng Networks GmbH, Pim van Pelt <pim@ipng.ch>
package vpp
import (
"testing"
)
func TestNewVPPClient(t *testing.T) {
client := &VPPClient{}
if client == nil {
t.Fatal("NewVPPClient() returned nil")
}
if client.IsConnected() {
t.Error("NewVPPClient() should return disconnected client")
}
if client.GetAPIConnection() != nil {
t.Error("NewVPPClient() should have nil API connection initially")
}
if client.GetStatsConnection() != nil {
t.Error("NewVPPClient() should have nil stats connection initially")
}
}
func TestVPPClientDisconnect(t *testing.T) {
client := &VPPClient{}
// Should be safe to call disconnect on unconnected client
client.Disconnect()
if client.IsConnected() {
t.Error("Client should not be connected after Disconnect()")
}
}
func TestVPPClientNewAPIChannelWithoutConnection(t *testing.T) {
client := &VPPClient{}
_, err := client.NewAPIChannel()
if err == nil {
t.Error("NewAPIChannel() should return error when not connected")
}
vppErr, ok := err.(*VPPError)
if !ok {
t.Errorf("Expected VPPError, got %T", err)
}
if vppErr.Message != "API connection not established" {
t.Errorf("Expected specific error message, got: %s", vppErr.Message)
}
}
func TestVPPClientCheckLivenessWithoutConnection(t *testing.T) {
client := &VPPClient{}
if client.CheckLiveness() {
t.Error("CheckLiveness() should return false when not connected")
}
}
func TestVPPError(t *testing.T) {
err := &VPPError{Message: "test error"}
if err.Error() != "test error" {
t.Errorf("VPPError.Error() returned %q, expected %q", err.Error(), "test error")
}
}
func TestVPPClientConnectWithInvalidPaths(t *testing.T) {
// Save original values
origApiAddr := *ApiAddr
origStatsAddr := *StatsAddr
// Set invalid paths
*ApiAddr = "/tmp/nonexistent_api.sock"
*StatsAddr = "/tmp/nonexistent_stats.sock"
// Restore original values after test
defer func() {
*ApiAddr = origApiAddr
*StatsAddr = origStatsAddr
}()
client := &VPPClient{}
err := client.Connect()
if err == nil {
t.Error("Connect() should fail with invalid socket paths")
client.Disconnect() // Clean up if somehow it connected
}
if client.IsConnected() {
t.Error("Client should not be connected after failed Connect()")
}
}