aboutsummaryrefslogtreecommitdiffstats
path: root/examples/cmd
diff options
context:
space:
mode:
Diffstat (limited to 'examples/cmd')
-rw-r--r--examples/cmd/simple-client/simple_client.go166
-rw-r--r--examples/cmd/stats-client/stats_client.go53
-rw-r--r--examples/cmd/union-example/union_example.go63
3 files changed, 203 insertions, 79 deletions
diff --git a/examples/cmd/simple-client/simple_client.go b/examples/cmd/simple-client/simple_client.go
index 7b7dbcd..b9e8052 100644
--- a/examples/cmd/simple-client/simple_client.go
+++ b/examples/cmd/simple-client/simple_client.go
@@ -12,23 +12,21 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-// Binary simple-client is an example VPP management application that exercises the
+// simple-client is an example VPP management application that exercises the
// govpp API on real-world use-cases.
package main
-// Generates Go bindings for all VPP APIs located in the json directory.
-//go:generate binapi-generator --input-dir=../../bin_api --output-dir=../../bin_api
-
import (
"fmt"
"net"
"os"
+ "strings"
"git.fd.io/govpp.git"
"git.fd.io/govpp.git/api"
"git.fd.io/govpp.git/examples/bin_api/acl"
"git.fd.io/govpp.git/examples/bin_api/interfaces"
- "git.fd.io/govpp.git/examples/bin_api/tap"
+ "git.fd.io/govpp.git/examples/bin_api/ip"
)
func main() {
@@ -50,31 +48,18 @@ func main() {
}
defer ch.Close()
- // check whether the VPP supports our version of some messages
- compatibilityCheck(ch)
-
// individual examples
aclVersion(ch)
aclConfig(ch)
aclDump(ch)
- tapConnect(ch)
-
interfaceDump(ch)
- interfaceNotifications(ch)
-}
+ ipAddressDump(ch)
-// compatibilityCheck shows how an management application can check whether generated API messages are
-// compatible with the version of VPP which the library is connected to.
-func compatibilityCheck(ch api.Channel) {
- err := ch.CheckMessageCompatibility(
- &interfaces.SwInterfaceDump{},
- &interfaces.SwInterfaceDetails{},
- )
- if err != nil {
- fmt.Println(err)
- os.Exit(1)
- }
+ setIpUnnumbered(ch)
+ ipUnnumberedDump(ch)
+
+ interfaceNotifications(ch)
}
// aclVersion is the simplest API example - one empty request message and one reply message.
@@ -121,9 +106,15 @@ func aclConfig(ch api.Channel) {
if err != nil {
fmt.Println("Error:", err)
- } else {
- fmt.Printf("%+v\n", reply)
+ return
}
+ if reply.Retval != 0 {
+ fmt.Println("Retval:", reply.Retval)
+ return
+ }
+
+ fmt.Printf("%+v\n", reply)
+
}
// aclDump shows an example where SendRequest and ReceiveReply are not chained together.
@@ -131,60 +122,91 @@ func aclDump(ch api.Channel) {
req := &acl.ACLDump{}
reply := &acl.ACLDetails{}
- reqCtx := ch.SendRequest(req)
- err := reqCtx.ReceiveReply(reply)
-
- if err != nil {
+ if err := ch.SendRequest(req).ReceiveReply(reply); err != nil {
fmt.Println("Error:", err)
} else {
fmt.Printf("%+v\n", reply)
}
}
-// tapConnect example shows how the Go channels in the API channel can be accessed directly instead
-// of using SendRequest and ReceiveReply wrappers.
-func tapConnect(ch api.Channel) {
- req := &tap.TapConnect{
- TapName: []byte("testtap"),
- UseRandomMac: 1,
+// interfaceDump shows an example of multipart request (multiple replies are expected).
+func interfaceDump(ch api.Channel) {
+ fmt.Println("Dumping interfaces")
+
+ req := &interfaces.SwInterfaceDump{}
+ reqCtx := ch.SendMultiRequest(req)
+
+ for {
+ msg := &interfaces.SwInterfaceDetails{}
+ stop, err := reqCtx.ReceiveReply(msg)
+ if stop {
+ break // break out of the loop
+ }
+ if err != nil {
+ fmt.Println("ERROR:", err)
+ }
+ ifaceName := strings.TrimFunc(string(msg.InterfaceName), func(r rune) bool {
+ return r == 0x00
+ })
+ fmt.Printf("Interface: %q %+v\n", ifaceName, msg)
}
+}
- // send the request to the request go channel
- ch.GetRequestChannel() <- &api.VppRequest{Message: req}
+func ipAddressDump(ch api.Channel) {
+ fmt.Println("Dumping IP addresses")
- // receive a reply from the reply go channel
- vppReply := <-ch.GetReplyChannel()
- if vppReply.Error != nil {
- fmt.Println("Error:", vppReply.Error)
- return
+ req := &ip.IPAddressDump{
+ SwIfIndex: 1, //^uint32(0),
}
+ reqCtx := ch.SendMultiRequest(req)
- // decode the message
- reply := &tap.TapConnectReply{}
- err := ch.GetMessageDecoder().DecodeMsg(vppReply.Data, reply)
+ for {
+ msg := &ip.IPAddressDetails{}
+ stop, err := reqCtx.ReceiveReply(msg)
+ if stop {
+ break // break out of the loop
+ }
+ if err != nil {
+ fmt.Println("ERROR:", err)
+ }
+ fmt.Printf("ip address: %d %+v\n", msg.SwIfIndex, msg)
+ }
+}
- if err != nil {
+// aclDump shows an example where SendRequest and ReceiveReply are not chained together.
+func setIpUnnumbered(ch api.Channel) {
+ req := &interfaces.SwInterfaceSetUnnumbered{
+ SwIfIndex: 1,
+ UnnumberedSwIfIndex: 2,
+ IsAdd: 1,
+ }
+ reply := &interfaces.SwInterfaceSetUnnumberedReply{}
+
+ if err := ch.SendRequest(req).ReceiveReply(reply); err != nil {
fmt.Println("Error:", err)
} else {
fmt.Printf("%+v\n", reply)
}
}
-// interfaceDump shows an example of multipart request (multiple replies are expected).
-func interfaceDump(ch api.Channel) {
- req := &interfaces.SwInterfaceDump{}
+func ipUnnumberedDump(ch api.Channel) {
+ fmt.Println("Dumping IP unnumbered")
+
+ req := &ip.IPUnnumberedDump{
+ SwIfIndex: ^uint32(0),
+ }
reqCtx := ch.SendMultiRequest(req)
for {
- msg := &interfaces.SwInterfaceDetails{}
+ msg := &ip.IPUnnumberedDetails{}
stop, err := reqCtx.ReceiveReply(msg)
if stop {
break // break out of the loop
}
if err != nil {
- fmt.Println("Error:", err)
+ fmt.Println("ERROR:", err)
}
- fmt.Printf("%+v\n", msg)
+ fmt.Printf("ip unnumbered: %+v\n", msg)
}
}
@@ -194,28 +216,52 @@ func interfaceDump(ch api.Channel) {
func interfaceNotifications(ch api.Channel) {
// subscribe for specific notification message
notifChan := make(chan api.Message, 100)
- subs, _ := ch.SubscribeNotification(notifChan, interfaces.NewSwInterfaceSetFlags)
+ subs, err := ch.SubscribeNotification(notifChan, interfaces.NewSwInterfaceEvent)
+ if err != nil {
+ panic(err)
+ }
// enable interface events in VPP
- ch.SendRequest(&interfaces.WantInterfaceEvents{
- Pid: uint32(os.Getpid()),
+ err = ch.SendRequest(&interfaces.WantInterfaceEvents{
+ PID: uint32(os.Getpid()),
EnableDisable: 1,
}).ReceiveReply(&interfaces.WantInterfaceEventsReply{})
+ if err != nil {
+ panic(err)
+ }
// generate some events in VPP
- ch.SendRequest(&interfaces.SwInterfaceSetFlags{
+ err = ch.SendRequest(&interfaces.SwInterfaceSetFlags{
SwIfIndex: 0,
AdminUpDown: 0,
}).ReceiveReply(&interfaces.SwInterfaceSetFlagsReply{})
- ch.SendRequest(&interfaces.SwInterfaceSetFlags{
+ if err != nil {
+ panic(err)
+ }
+ err = ch.SendRequest(&interfaces.SwInterfaceSetFlags{
SwIfIndex: 0,
AdminUpDown: 1,
}).ReceiveReply(&interfaces.SwInterfaceSetFlagsReply{})
+ if err != nil {
+ panic(err)
+ }
// receive one notification
- notif := (<-notifChan).(*interfaces.SwInterfaceSetFlags)
- fmt.Printf("%+v\n", notif)
+ notif := (<-notifChan).(*interfaces.SwInterfaceEvent)
+ fmt.Printf("NOTIF: %+v\n", notif)
+
+ // disable interface events in VPP
+ err = ch.SendRequest(&interfaces.WantInterfaceEvents{
+ PID: uint32(os.Getpid()),
+ EnableDisable: 0,
+ }).ReceiveReply(&interfaces.WantInterfaceEventsReply{})
+ if err != nil {
+ panic(err)
+ }
// unsubscribe from delivery of the notifications
- ch.UnsubscribeNotification(subs)
+ err = ch.UnsubscribeNotification(subs)
+ if err != nil {
+ panic(err)
+ }
}
diff --git a/examples/cmd/stats-client/stats_client.go b/examples/cmd/stats-client/stats_client.go
index 5f9966f..4ea4659 100644
--- a/examples/cmd/stats-client/stats_client.go
+++ b/examples/cmd/stats-client/stats_client.go
@@ -16,9 +16,6 @@
// govpp API for interface counters together with asynchronous connection to VPP.
package main
-// Generates Go bindings for all VPP APIs located in the json directory.
-//go:generate binapi-generator --input-dir=../../bin_api --output-dir=../../bin_api
-
import (
"fmt"
"os"
@@ -27,7 +24,6 @@ import (
"git.fd.io/govpp.git"
"git.fd.io/govpp.git/api"
"git.fd.io/govpp.git/core"
- "git.fd.io/govpp.git/examples/bin_api/interfaces"
"git.fd.io/govpp.git/examples/bin_api/stats"
)
@@ -48,6 +44,7 @@ func main() {
fmt.Println("Error:", err)
os.Exit(1)
}
+ defer fmt.Println("calling close")
defer ch.Close()
// create channel for Interrupt signal
@@ -79,10 +76,10 @@ loop:
case msg := <-notifChan:
switch notif := msg.(type) {
- case *interfaces.VnetInterfaceSimpleCounters:
+ case *stats.VnetInterfaceSimpleCounters:
// simple counter notification received
processSimpleCounters(notif)
- case *interfaces.VnetInterfaceCombinedCounters:
+ case *stats.VnetInterfaceCombinedCounters:
// combined counter notification received
processCombinedCounters(notif)
default:
@@ -102,27 +99,41 @@ loop:
// subscribeNotifications subscribes for interface counters notifications.
func subscribeNotifications(ch api.Channel) (*api.NotifSubscription, *api.NotifSubscription, chan api.Message) {
-
notifChan := make(chan api.Message, 100)
- simpleCountersSubs, _ := ch.SubscribeNotification(notifChan, interfaces.NewVnetInterfaceSimpleCounters)
- combinedCountersSubs, _ := ch.SubscribeNotification(notifChan, interfaces.NewVnetInterfaceCombinedCounters)
+
+ simpleCountersSubs, err := ch.SubscribeNotification(notifChan, stats.NewVnetInterfaceSimpleCounters)
+ if err != nil {
+ panic(err)
+ }
+ combinedCountersSubs, err := ch.SubscribeNotification(notifChan, stats.NewVnetInterfaceCombinedCounters)
+ if err != nil {
+ panic(err)
+ }
return simpleCountersSubs, combinedCountersSubs, notifChan
}
// requestStatistics requests interface counters notifications from VPP.
func requestStatistics(ch api.Channel) {
- ch.SendRequest(&stats.WantStats{
- Pid: uint32(os.Getpid()),
+ if err := ch.SendRequest(&stats.WantStats{
+ PID: uint32(os.Getpid()),
EnableDisable: 1,
- }).ReceiveReply(&stats.WantStatsReply{})
+ }).ReceiveReply(&stats.WantStatsReply{}); err != nil {
+ panic(err)
+ }
}
// processSimpleCounters processes simple counters received from VPP.
-func processSimpleCounters(counters *interfaces.VnetInterfaceSimpleCounters) {
- fmt.Printf("%+v\n", counters)
-
- counterNames := []string{"Drop", "Punt", "IPv4", "IPv6", "RxNoBuf", "RxMiss", "RxError", "TxError", "MPLS"}
+func processSimpleCounters(counters *stats.VnetInterfaceSimpleCounters) {
+ fmt.Printf("SimpleCounters: %+v\n", counters)
+
+ counterNames := []string{
+ "Drop", "Punt",
+ "IPv4", "IPv6",
+ "RxNoBuf", "RxMiss",
+ "RxError", "TxError",
+ "MPLS",
+ }
for i := uint32(0); i < counters.Count; i++ {
fmt.Printf("Interface '%d': %s = %d\n",
@@ -131,14 +142,18 @@ func processSimpleCounters(counters *interfaces.VnetInterfaceSimpleCounters) {
}
// processCombinedCounters processes combined counters received from VPP.
-func processCombinedCounters(counters *interfaces.VnetInterfaceCombinedCounters) {
- fmt.Printf("%+v\n", counters)
+func processCombinedCounters(counters *stats.VnetInterfaceCombinedCounters) {
+ fmt.Printf("CombinedCounters: %+v\n", counters)
counterNames := []string{"Rx", "Tx"}
for i := uint32(0); i < counters.Count; i++ {
+ if len(counterNames) <= int(counters.VnetCounterType) {
+ continue
+ }
fmt.Printf("Interface '%d': %s packets = %d, %s bytes = %d\n",
- counters.FirstSwIfIndex+i, counterNames[counters.VnetCounterType], counters.Data[i].Packets,
+ counters.FirstSwIfIndex+i,
+ counterNames[counters.VnetCounterType], counters.Data[i].Packets,
counterNames[counters.VnetCounterType], counters.Data[i].Bytes)
}
}
diff --git a/examples/cmd/union-example/union_example.go b/examples/cmd/union-example/union_example.go
new file mode 100644
index 0000000..bb6c8a1
--- /dev/null
+++ b/examples/cmd/union-example/union_example.go
@@ -0,0 +1,63 @@
+// Copyright (c) 2018 Cisco and/or its affiliates.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at:
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// union-example is an example to show how to use unions in VPP binary API.
+package main
+
+import (
+ "bytes"
+ "log"
+
+ "git.fd.io/govpp.git/examples/bin_api/ip"
+ "github.com/lunixbochs/struc"
+)
+
+func main() {
+ // create union with IPv4 address
+ var unionIP4 ip.AddressUnion
+ unionIP4.SetIP4(ip.IP4Address{Address: []byte{192, 168, 1, 10}})
+
+ // use it in the Address type
+ addr := &ip.Address{
+ Af: ip.ADDRESS_IP4,
+ Un: unionIP4,
+ }
+ log.Printf("encoding union IPv4: %v", addr.Un.GetIP4())
+
+ // encode the address with union
+ data := encode(addr)
+ // decode the address with union
+ addr2 := decode(data)
+
+ log.Printf("decoded union IPv4: %v", addr2.Un.GetIP4())
+}
+
+func encode(addr *ip.Address) []byte {
+ log.Printf("encoding address: %#v", addr)
+ buf := new(bytes.Buffer)
+ if err := struc.Pack(buf, addr); err != nil {
+ panic(err)
+ }
+ return buf.Bytes()
+}
+
+func decode(data []byte) *ip.Address {
+ addr := new(ip.Address)
+ buf := bytes.NewReader(data)
+ if err := struc.Unpack(buf, addr); err != nil {
+ panic(err)
+ }
+ log.Printf("decoded address: %#v", addr)
+ return addr
+}