X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=README.md;h=5581928cde14f3c75ccdecffbaccff197bd13133;hb=a4112fac7b86fe09650d2bb57969fe46404edd7d;hp=6e7862084c41dd444552d68885286bd1822b980a;hpb=b1006dced4cc0c23d9dc754e97d89500aeb55170;p=govpp.git diff --git a/README.md b/README.md index 6e78620..5581928 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,56 @@ # GoVPP -The GoVPP projects provides the API for communication with VPP from Go. - -It consists of the following packages: -- [adapter](adapter/): adapter between GoVPP core and the VPP binary/stats API -- [api](api/): API for communication with GoVPP core -- [cmd/binapi-generator](cmd/binapi-generator/): generator for the VPP binary API definitions in JSON format to Go code -- [codec](codec/): handles encoding/decoding of generated messages into binary form -- [core](core/): essential functionality of the GoVPP -- [examples](examples/): examples that use the GoVPP API in real use-cases of VPP management application -- [extras](extras/): contains Go implementation for libmemif library -- [govpp](govpp.go): provides the entry point to GoVPP functionality - -The design with separated GoVPP [API package](api/) and the GoVPP [core package](core/) enables -plugin-based infrastructure, where one entity acts as a master responsible for talking with VPP and multiple -entities act as clients that are using the master for the communication with VPP. -The clients can be built into standalone shared libraries without the need -of linking the GoVPP core and all its dependencies into them. - -``` - +--------------+ - +--------------+ | | - | | | plugin | - | | | | - | App | +--------------+ - | | +------+ GoVPP API | - | | | +--------------+ - +--------------+ GoVPP | - | | channels | +--------------+ - | GoVPP core +------------+ | | - | | | | plugin | - +------+-------+ | | | - | | +--------------+ - | +------+ GoVPP API | - | binary API +--------------+ - | - +------+-------+ - | | - | VPP process | - | | - +--------------+ -``` +[![stable](https://img.shields.io/github/v/tag/fdio/govpp.svg?label=release&logo=github)](https://github.com/ligato/vpp-agent/releases/latest) [![PkgGoDev](https://pkg.go.dev/badge/git.fd.io/govpp.git)](https://pkg.go.dev/git.fd.io/govpp.git) + +The GoVPP repository contains a Go client library for interacting with the VPP, +generator of Go bindings for the VPP binary API and various other tooling for VPP. + +## Overview + +Here is a brief overview for the repository structure. + +- [govpp](govpp.go) - the entry point for the GoVPP client + - [adapter](adapter) - VPP binary & stats API interface + - [mock](adapter/mock) - Mock adapter used for testing + - [socketclient](adapter/socketclient) - Go implementation of VPP API client for unix socket + - [statsclient](adapter/statsclient) - Go implementation of VPP Stats client for shared memory + - [vppapiclient](adapter/vppapiclient) - CGo wrapper of vppapiclient library (DEPRECATED!) + - [api](api) - GoVPP client API + - [binapigen](binapigen) - library for generating code from VPP API + - [vppapi](binapigen/vppapi) - VPP API parser + - cmd/ + - [binapi-generator](cmd/binapi-generator) - VPP binary API generator + - [vpp-proxy](cmd/vpp-proxy) - VPP proxy for remote access + - [codec](codec) - handles encoding/decoding of generated messages into binary form + - [core](core) - implementation of the GoVPP client + - [docs](docs) - documentation + - [examples](examples) - examples demonstrating GoVPP functionality + - [internal](internal) - packages used internally by GoVPP + - [proxy](proxy) - contains client/server implementation for proxy + - [test](test) - integration tests, benchmarks and performance tests ## Quick Start -#### Generate binapi (Go bindings) +Below are some code examples showing GoVPP client interacting with VPP API. -Generating Go bindings for VPP binary API from the JSON files located in the -`/usr/share/vpp/api/` directory into the Go packages that will be created -inside of the `binapi` directory: +### Using raw messages directly -``` -binapi-generator --input-dir=/usr/share/vpp/api/ --output-dir=binapi -``` +Here is a code for low-level way to access the VPP API using the generated messages directly for sending/receiving. -#### Example Usage +```go +package main -Here is a usage sample of the generated binapi messages: +import ( + "log" + + "git.fd.io/govpp.git" + "git.fd.io/govpp.git/binapi/interfaces" + "git.fd.io/govpp.git/binapi/vpe" +) -```go func main() { - // Connect to VPP - conn, _ := govpp.Connect() + // Connect to VPP + conn, _ := govpp.Connect("/run/vpp/api.sock") defer conn.Disconnect() // Open channel @@ -74,72 +63,66 @@ func main() { // Send the request err := ch.SendRequest(req).ReceiveReply(reply) + if err != nil { + log.Fatal("ERROR: ", err) + } + + log.Print("Version: ", reply.Version) } ``` -The example above uses GoVPP API to communicate over underlying go channels, -see [example client](examples/simple-client/simple_client.go) -for more examples, including the example on how to use the Go channels directly. - -## Build & Install +For a complete example see [simple-client](examples/simple-client). -### Using pure Go adapters (recommended) +### Using RPC service client -GoVPP now supports pure Go implementation for VPP binary API. This does -not depend on CGo or any VPP library and can be easily compiled. +Here is a sample code for an effortless way to access the VPP API using a generated RPC service client for calling. -There are two packages providing pure Go implementations in GoVPP: -- [`socketclient`](adapter/socketclient) - for VPP binary API (via unix socket) -- [`statsclient`](adapter/statsclient) - for VPP stats API (via shared memory) +```go +package main -### Using vppapiclient library wrapper (requires CGo) +import ( + "context" + "log" -GoVPP also provides vppapiclient package which actually uses -`vppapiclient.so` library from VPP codebase to communicate with VPP API. -To build GoVPP, `vpp-dev` package must be installed, -either [from packages][from-packages] or [from sources][from-sources]. + "git.fd.io/govpp.git" + "git.fd.io/govpp.git/binapi/vpe" +) -To build & install `vpp-dev` from sources: +func main() { + // Connect to VPP API socket + conn, _ := govpp.Connect("/run/vpp/api.sock") + defer conn.Disconnect() -```sh -git clone https://gerrit.fd.io/r/vpp -cd vpp -make install-dep -make pkg-deb -cd build-root -sudo dpkg -i vpp*.deb -``` + // Init vpe service client + client := vpe.NewServiceClient(conn) -To build & install GoVPP: + reply, err := client.ShowVersion(context.Background(), &vpe.ShowVersion{}) + if err != nil { + log.Fatal("ERROR: ", err) + } -```sh -go get -u git.fd.io/govpp.git -cd $GOPATH/src/git.fd.io/govpp.git -make test -make install + log.Print("Version: ", reply.Version) +} ``` -## Generating Go bindings with binapi-generator +For a complete example see [rpc-service](examples/rpc-service). -Once you have `binapi-generator` installed, you can use it to generate Go bindings for VPP binary API -using VPP APIs in JSON format. The JSON input can be specified as a single file (`input-file` argument), or -as a directory that will be scanned for all `.json` files (`input-dir`). The generated Go bindings will -be placed into `output-dir` (by default current working directory), where each Go package will be placed into -a separated directory, e.g.: +### More code examples -```sh -binapi-generator --input-file=acl.api.json --output-dir=binapi -binapi-generator --input-dir=/usr/share/vpp/api/core --output-dir=binapi -``` +More examples can be found in [examples](examples) directory. -In Go, [go generate](https://blog.golang.org/generate) tool can be leveraged to ease the code generation -process. It allows to specify generator instructions in any one of the regular (non-generated) `.go` files -that are dependent on generated code using special comments, e.g. the one from -[example client](examples/simple-client/simple_client.go): +- [api-trace](api-trace) - trace sent/received messages +- [binapi-types](binapi-types) - using common types from generated code +- [multi-vpp](multi-vpp) - connect to multiple VPP instances +- [perf-bench](perf-bench) - very basic performance test for measuring throughput +- [rpc-service](rpc-service) - effortless way to call VPP API via RPC client +- [simple-client](simple-client) - send and receive VPP API messages using GoVPP API directly +- [stats-client](stats-client) - client for retrieving VPP stats data +- [stream-client](stream-client) - using new stream API to call VPP API -```go -//go:generate binapi-generator --input-dir=bin_api --output-dir=bin_api -``` +## Documentation + +Further documentation can be found in [docs](docs) directory. -[from-packages]: https://wiki.fd.io/view/VPP/Installing_VPP_binaries_from_packages -[from-sources]: https://wiki.fd.io/view/VPP/Build,_install,_and_test_images#Build_A_VPP_Package +- [Adapters](docs/ADAPTERS.md) - detailed info about transport adapters and their implementations +- [Binapi Generator](docs/GENERATOR.md) - user guide for generating VPP binary API