hs-test: support for multiple workers
[vpp.git] / extras / hs-test / vppinstance.go
index 3f9ea87..a9b97bc 100644 (file)
@@ -1,8 +1,14 @@
 package main
 
 import (
-       "encoding/json"
        "fmt"
+       "os"
+       "os/exec"
+       "os/signal"
+       "strings"
+       "syscall"
+       "time"
+
        "github.com/edwarnicke/exechelper"
 
        "go.fd.io/govpp"
@@ -11,13 +17,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 +40,7 @@ api-segment {
 }
 
 socksvr {
-  socket-name %[1]s/var/run/vpp/api.sock
+  socket-name %[1]s%[3]s
 }
 
 statseg {
@@ -50,111 +57,99 @@ 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)
-}
-
-func (vpp *VppInstance) set2VethsServer() {
-       vpp.actionFuncName = "Configure2Veths"
-       vpp.config.Variant = "srv"
+       container        *Container
+       additionalConfig []Stanza
+       connection       *core.Connection
+       apiChannel       api.Channel
+       cpus             []int
 }
 
-func (vpp *VppInstance) set2VethsClient() {
-       vpp.actionFuncName = "Configure2Veths"
-       vpp.config.Variant = "cln"
-}
-
-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) getSuite() *HstSuite {
+       return vpp.container.suite
 }
 
 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 {
-       return vpp.container.GetContainerWorkDir() + "/var/run/vpp"
+       return vpp.container.getContainerWorkDir() + "/var/run/vpp"
 }
 
 func (vpp *VppInstance) getLogDir() string {
-       return vpp.container.GetContainerWorkDir() + "/var/log/vpp"
+       return vpp.container.getContainerWorkDir() + "/var/log/vpp"
 }
 
 func (vpp *VppInstance) getEtcDir() string {
-       return vpp.container.GetContainerWorkDir() + "/etc/vpp"
-}
-
-func (vpp *VppInstance) legacyStart() error {
-       if vpp.actionFuncName == "" {
-               return fmt.Errorf("vpp start failed: action function name must not be blank")
-       }
-
-       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
+       return vpp.container.getContainerWorkDir() + "/etc/vpp"
 }
 
 func (vpp *VppInstance) start() error {
-       if vpp.actionFuncName != "" {
-               return vpp.legacyStart()
-       }
-
        // Create folders
-       containerWorkDir := vpp.container.GetContainerWorkDir()
+       containerWorkDir := vpp.container.getContainerWorkDir()
 
        vpp.container.exec("mkdir --mode=0700 -p " + vpp.getRunDir())
        vpp.container.exec("mkdir --mode=0700 -p " + vpp.getLogDir())
        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.generateCpuConfig()
+       for _, c := range vpp.additionalConfig {
+               configContent += c.toString()
+       }
        startupFileName := vpp.getEtcDir() + "/startup.conf"
        vpp.container.createFile(startupFileName, configContent)
 
-       // Start VPP
-       if err := vpp.container.execServer("vpp -c " + startupFileName); err != nil {
-               return err
+       // create wrapper script for vppctl with proper CLI socket path
+       cliContent := "#!/usr/bin/bash\nvppctl -s " + vpp.getRunDir() + "/cli.sock"
+       vppcliFileName := "/usr/bin/vppcli"
+       vpp.container.createFile(vppcliFileName, cliContent)
+       vpp.container.exec("chmod 0755 " + vppcliFileName)
+
+       if *isVppDebug {
+               sig := make(chan os.Signal, 1)
+               signal.Notify(sig, syscall.SIGINT)
+               cont := make(chan bool, 1)
+               go func() {
+                       <-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
+       sockAddress := vpp.container.getHostWorkDir() + defaultApiSocketFilePath
        conn, connEv, err := govpp.AsyncConnect(
                sockAddress,
                core.DefaultMaxReconnectAttempts,
@@ -186,49 +181,30 @@ func (vpp *VppInstance) start() error {
        return nil
 }
 
-func (vpp *VppInstance) vppctl(command string, arguments ...any) (string, error) {
+func (vpp *VppInstance) vppctl(command string, arguments ...any) string {
        vppCliCommand := fmt.Sprintf(command, arguments...)
        containerExecCommand := fmt.Sprintf("docker exec --detach=false %[1]s vppctl -s %[2]s %[3]s",
                vpp.container.name, vpp.getCliSocket(), vppCliCommand)
+       vpp.getSuite().log(containerExecCommand)
        output, err := exechelper.CombinedOutput(containerExecCommand)
-       if err != nil {
-               return "", fmt.Errorf("vppctl failed: %s", err)
-       }
-
-       return string(output), nil
-}
+       vpp.getSuite().assertNil(err)
 
-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
+       return string(output)
 }
 
-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.getSuite().assertNil(1, "Timeout while waiting for app '%s'", appName)
 }
 
 func (vpp *VppInstance) createAfPacket(
-       veth *NetworkInterfaceVeth,
+       veth *NetInterface,
 ) (interface_types.InterfaceIndex, error) {
        createReq := &af_packet.AfPacketCreateV2{
                UseRandomHwAddr: true,
@@ -257,17 +233,19 @@ func (vpp *VppInstance) createAfPacket(
        }
 
        // Add address
-       if veth.ip4Address == (AddressWithPrefix{}) {
-               ipPrefix, err := vpp.container.suite.NewAddress()
-               if err != nil {
+       if veth.addressWithPrefix() == (AddressWithPrefix{}) {
+               var err error
+               var ip4Address string
+               if ip4Address, err = veth.addresser.newIp4Address(veth.peer.networkNumber); err == nil {
+                       veth.ip4Address = ip4Address
+               } else {
                        return 0, err
                }
-               veth.ip4Address = ipPrefix
        }
        addressReq := &interfaces.SwInterfaceAddDelAddress{
                IsAdd:     true,
                SwIfIndex: veth.index,
-               Prefix:    veth.ip4Address,
+               Prefix:    veth.addressWithPrefix(),
        }
        addressReply := &interfaces.SwInterfaceAddDelAddressReply{}
 
@@ -306,7 +284,86 @@ 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.getSuite().T().Helper()
+       vpp.getSuite().log(cmd.String())
+       cmd.Run()
+}
+
 func (vpp *VppInstance) disconnect() {
        vpp.connection.Disconnect()
        vpp.apiChannel.Close()
 }
+
+func (vpp *VppInstance) generateCpuConfig() string {
+       var c Stanza
+       var s string
+       if len(vpp.cpus) < 1 {
+               return ""
+       }
+       c.newStanza("cpu").
+               append(fmt.Sprintf("main-core %d", vpp.cpus[0]))
+       workers := vpp.cpus[1:]
+
+       if len(workers) > 0 {
+               for i := 0; i < len(workers); i++ {
+                       if i != 0 {
+                               s = s + ", "
+                       }
+                       s = s + fmt.Sprintf("%d", workers[i])
+               }
+               c.append(fmt.Sprintf("corelist-workers %s", s))
+       }
+       return c.close().toString()
+}