hs-test: add support for running vpp in gdb
[vpp.git] / extras / hs-test / vppinstance.go
index 257798a..1c28ec9 100644 (file)
@@ -1,9 +1,14 @@
 package main
 
 import (
-       "encoding/json"
        "fmt"
        "github.com/edwarnicke/exechelper"
+       "os"
+       "os/exec"
+       "os/signal"
+       "strings"
+       "syscall"
+       "time"
 
        "go.fd.io/govpp"
        "go.fd.io/govpp/api"
@@ -11,13 +16,14 @@ import (
        interfaces "go.fd.io/govpp/binapi/interface"
        "go.fd.io/govpp/binapi/interface_types"
        "go.fd.io/govpp/binapi/session"
+       "go.fd.io/govpp/binapi/tapv2"
        "go.fd.io/govpp/binapi/vpe"
        "go.fd.io/govpp/core"
 )
 
 const vppConfigTemplate = `unix {
   nodaemon
-  log %[1]s/var/log/vpp/vpp.log
+  log %[1]s%[4]s
   full-coredump
   cli-listen %[1]s%[2]s
   runtime-dir %[1]s/var/run
@@ -33,7 +39,7 @@ api-segment {
 }
 
 socksvr {
-  socket-name %[1]s/var/run/vpp/api.sock
+  socket-name %[1]s%[3]s
 }
 
 statseg {
@@ -50,49 +56,32 @@ plugins {
   plugin http_plugin.so { enable }
 }
 
+logging {
+  default-log-level debug
+  default-syslog-log-level debug
+}
+
 `
 
 const (
        defaultCliSocketFilePath = "/var/run/vpp/cli.sock"
        defaultApiSocketFilePath = "/var/run/vpp/api.sock"
+       defaultLogFilePath       = "/var/log/vpp/vpp.log"
 )
 
 type VppInstance struct {
-       container      *Container
-       config         *VppConfig
-       actionFuncName string
-       connection     *core.Connection
-       apiChannel     api.Channel
-}
-
-type VppConfig struct {
-       Variant           string
-       CliSocketFilePath string
-       additionalConfig  Stanza
-}
-
-func (vc *VppConfig) getTemplate() string {
-       return fmt.Sprintf(vppConfigTemplate, "%[1]s", vc.CliSocketFilePath)
+       container        *Container
+       additionalConfig Stanza
+       connection       *core.Connection
+       apiChannel       api.Channel
 }
 
 func (vpp *VppInstance) Suite() *HstSuite {
        return vpp.container.suite
 }
 
-func (vpp *VppInstance) setVppProxy() {
-       vpp.actionFuncName = "ConfigureVppProxy"
-}
-
-func (vpp *VppInstance) setEnvoyProxy() {
-       vpp.actionFuncName = "ConfigureEnvoyProxy"
-}
-
-func (vpp *VppInstance) setCliSocket(filePath string) {
-       vpp.config.CliSocketFilePath = filePath
-}
-
 func (vpp *VppInstance) getCliSocket() string {
-       return fmt.Sprintf("%s%s", vpp.container.GetContainerWorkDir(), vpp.config.CliSocketFilePath)
+       return fmt.Sprintf("%s%s", vpp.container.GetContainerWorkDir(), defaultCliSocketFilePath)
 }
 
 func (vpp *VppInstance) getRunDir() string {
@@ -107,24 +96,7 @@ func (vpp *VppInstance) getEtcDir() string {
        return vpp.container.GetContainerWorkDir() + "/etc/vpp"
 }
 
-func (vpp *VppInstance) legacyStart() error {
-       serializedConfig, err := serializeVppConfig(vpp.config)
-       if err != nil {
-               return fmt.Errorf("serialize vpp config: %v", err)
-       }
-       args := fmt.Sprintf("%s '%s'", vpp.actionFuncName, serializedConfig)
-       _, err = vpp.container.execAction(args)
-       if err != nil {
-               return fmt.Errorf("vpp start failed: %s", err)
-       }
-       return nil
-}
-
 func (vpp *VppInstance) start() error {
-       if vpp.actionFuncName != "" {
-               return vpp.legacyStart()
-       }
-
        // Create folders
        containerWorkDir := vpp.container.GetContainerWorkDir()
 
@@ -133,13 +105,38 @@ func (vpp *VppInstance) start() error {
        vpp.container.exec("mkdir --mode=0700 -p " + vpp.getEtcDir())
 
        // Create startup.conf inside the container
-       configContent := fmt.Sprintf(vppConfigTemplate, containerWorkDir, vpp.config.CliSocketFilePath)
-       configContent += vpp.config.additionalConfig.ToString()
+       configContent := fmt.Sprintf(
+               vppConfigTemplate,
+               containerWorkDir,
+               defaultCliSocketFilePath,
+               defaultApiSocketFilePath,
+               defaultLogFilePath,
+       )
+       configContent += vpp.additionalConfig.ToString()
        startupFileName := vpp.getEtcDir() + "/startup.conf"
        vpp.container.createFile(startupFileName, configContent)
 
-       // Start VPP
-       vpp.container.execServer("vpp -c " + startupFileName)
+       if *IsVppDebug {
+               sig := make(chan os.Signal, 1)
+               signal.Notify(sig, syscall.SIGINT)
+               cont := make(chan bool, 1)
+               go func() {
+                       sig := <-sig
+                       fmt.Println(sig)
+                       cont <- true
+               }()
+
+               // Start VPP in GDB and wait for user to attach it
+               vpp.container.execServer("su -c \"gdb -ex run --args vpp -c " + startupFileName + " &> /proc/1/fd/1\"")
+               fmt.Println("run following command in different terminal:")
+               fmt.Println("docker exec -it " + vpp.container.name + " gdb -ex \"attach $(docker exec " + vpp.container.name + " pidof gdb)\"")
+               fmt.Println("Afterwards press CTRL+C to continue")
+               <-cont
+               fmt.Println("continuing...")
+       } else {
+               // Start VPP
+               vpp.container.execServer("su -c \"vpp -c " + startupFileName + " &> /proc/1/fd/1\"")
+       }
 
        // Connect to VPP and store the connection
        sockAddress := vpp.container.GetHostWorkDir() + defaultApiSocketFilePath
@@ -185,41 +182,21 @@ func (vpp *VppInstance) vppctl(command string, arguments ...any) string {
        return string(output)
 }
 
-func NewVppInstance(c *Container) *VppInstance {
-       vppConfig := new(VppConfig)
-       vppConfig.CliSocketFilePath = defaultCliSocketFilePath
-       vpp := new(VppInstance)
-       vpp.container = c
-       vpp.config = vppConfig
-       return vpp
-}
-
-func serializeVppConfig(vppConfig *VppConfig) (string, error) {
-       serializedConfig, err := json.Marshal(vppConfig)
-       if err != nil {
-               return "", fmt.Errorf("vpp start failed: serializing configuration failed: %s", err)
-       }
-       return string(serializedConfig), nil
-}
-
-func deserializeVppConfig(input string) (VppConfig, error) {
-       var vppConfig VppConfig
-       err := json.Unmarshal([]byte(input), &vppConfig)
-       if err != nil {
-               // Since input is not a  valid JSON it is going be used as a variant value
-               // for compatibility reasons
-               vppConfig.Variant = input
-               vppConfig.CliSocketFilePath = defaultCliSocketFilePath
+func (vpp *VppInstance) waitForApp(appName string, timeout int) {
+       for i := 0; i < timeout; i++ {
+               o := vpp.vppctl("show app")
+               if strings.Contains(o, appName) {
+                       return
+               }
+               time.Sleep(1 * time.Second)
        }
-       return vppConfig, nil
+       vpp.Suite().assertNil(1, "Timeout while waiting for app '%s'", appName)
+       return
 }
 
 func (vpp *VppInstance) createAfPacket(
-       netInterface NetInterface,
+       veth *NetInterface,
 ) (interface_types.InterfaceIndex, error) {
-       var veth *NetworkInterfaceVeth
-       veth = netInterface.(*NetworkInterfaceVeth)
-
        createReq := &af_packet.AfPacketCreateV2{
                UseRandomHwAddr: true,
                HostIfName:      veth.Name(),
@@ -247,29 +224,19 @@ func (vpp *VppInstance) createAfPacket(
        }
 
        // Add address
-       if veth.Ip4AddressWithPrefix() == (AddressWithPrefix{}) {
-               if veth.peerNetworkNamespace != "" {
-                       ip4Address, err := veth.addresser.
-                               NewIp4AddressWithNamespace(veth.peerNetworkNamespace)
-                       if err == nil {
-                               veth.SetAddress(ip4Address)
-                       } else {
-                               return 0, err
-                       }
+       if veth.AddressWithPrefix() == (AddressWithPrefix{}) {
+               var err error
+               var ip4Address string
+               if ip4Address, err = veth.addresser.NewIp4Address(veth.Peer().networkNumber); err == nil {
+                       veth.SetAddress(ip4Address)
                } else {
-                       ip4Address, err := veth.addresser.
-                               NewIp4Address()
-                       if err == nil {
-                               veth.SetAddress(ip4Address)
-                       } else {
-                               return 0, err
-                       }
+                       return 0, err
                }
        }
        addressReq := &interfaces.SwInterfaceAddDelAddress{
                IsAdd:     true,
                SwIfIndex: veth.Index(),
-               Prefix:    veth.Ip4AddressWithPrefix(),
+               Prefix:    veth.AddressWithPrefix(),
        }
        addressReply := &interfaces.SwInterfaceAddDelAddressReply{}
 
@@ -308,6 +275,63 @@ func (vpp *VppInstance) addAppNamespace(
        return nil
 }
 
+func (vpp *VppInstance) createTap(
+       tap *NetInterface,
+       tapId ...uint32,
+) error {
+       var id uint32 = 1
+       if len(tapId) > 0 {
+               id = tapId[0]
+       }
+       createTapReq := &tapv2.TapCreateV2{
+               ID:               id,
+               HostIfNameSet:    true,
+               HostIfName:       tap.Name(),
+               HostIP4PrefixSet: true,
+               HostIP4Prefix:    tap.IP4AddressWithPrefix(),
+       }
+       createTapReply := &tapv2.TapCreateV2Reply{}
+
+       // Create tap interface
+       if err := vpp.apiChannel.SendRequest(createTapReq).ReceiveReply(createTapReply); err != nil {
+               return err
+       }
+
+       // Add address
+       addAddressReq := &interfaces.SwInterfaceAddDelAddress{
+               IsAdd:     true,
+               SwIfIndex: createTapReply.SwIfIndex,
+               Prefix:    tap.Peer().AddressWithPrefix(),
+       }
+       addAddressReply := &interfaces.SwInterfaceAddDelAddressReply{}
+
+       if err := vpp.apiChannel.SendRequest(addAddressReq).ReceiveReply(addAddressReply); err != nil {
+               return err
+       }
+
+       // Set interface to up
+       upReq := &interfaces.SwInterfaceSetFlags{
+               SwIfIndex: createTapReply.SwIfIndex,
+               Flags:     interface_types.IF_STATUS_API_FLAG_ADMIN_UP,
+       }
+       upReply := &interfaces.SwInterfaceSetFlagsReply{}
+
+       if err := vpp.apiChannel.SendRequest(upReq).ReceiveReply(upReply); err != nil {
+               return err
+       }
+
+       return nil
+}
+
+func (vpp *VppInstance) saveLogs() {
+       logTarget := vpp.container.getLogDirPath() + "vppinstance-" + vpp.container.name + ".log"
+       logSource := vpp.container.GetHostWorkDir() + defaultLogFilePath
+       cmd := exec.Command("cp", logSource, logTarget)
+       vpp.Suite().T().Helper()
+       vpp.Suite().log(cmd.String())
+       cmd.Run()
+}
+
 func (vpp *VppInstance) disconnect() {
        vpp.connection.Disconnect()
        vpp.apiChannel.Close()