generated from networkservicemesh/cmd-template
-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Read parameters for vpp host interface creation from config file (#1027)
* Parameters for vpp's host interface creation read from config file Signed-off-by: Laszlo Kiraly <[email protected]> * Parameters for vpp's host interface creation read from config file - move to vppinit module Signed-off-by: Laszlo Kiraly <[email protected]> * Parameters for vpp's host interface creation read from config file - do not dump default configuration Signed-off-by: Laszlo Kiraly <[email protected]> * Parameters for vpp's host interface creation read from config file - rename the configuration struct Signed-off-by: Laszlo Kiraly <[email protected]> * Parameters for vpp's host interface creation read from config file - fix linter errors Signed-off-by: Laszlo Kiraly <[email protected]> * Parameters for vpp's host interface creation read from config file - read the path of the configuration file from an environment variable Signed-off-by: Laszlo Kiraly <[email protected]> --------- Signed-off-by: Laszlo Kiraly <[email protected]>
- Loading branch information
Showing
6 changed files
with
297 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| // Copyright (c) 2024 Nordix Foundation. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| // 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. | ||
|
|
||
| package tests | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
| "path" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| yaml "gopkg.in/yaml.v3" | ||
|
|
||
| "github.com/networkservicemesh/govpp/binapi/af_packet" | ||
|
|
||
| "github.com/networkservicemesh/cmd-forwarder-vpp/internal/vppinit" | ||
| ) | ||
|
|
||
| const ( | ||
| configFilePath = "/var/lib/networkservicemesh/vppapi-hostint-args.yaml" | ||
| ) | ||
|
|
||
| type SomeValuesType struct { | ||
| AfPacket *SomeAfPacketParams `yaml:"AF_PACKET"` | ||
| AfXdp *SomeAfXDPParams `yaml:"AF_XDP"` | ||
| } | ||
|
|
||
| type SomeAfPacketParams struct { | ||
| RxFrameSize uint32 `yaml:"rxFrameSize"` | ||
| RxFramesPerBlock uint32 `yaml:"rxFramesPerBlock"` | ||
| } | ||
|
|
||
| type SomeAfXDPParams struct { | ||
| RxqSize uint16 `yaml:"rxqSize"` | ||
| } | ||
|
|
||
| var someValues = &SomeValuesType{ | ||
| AfPacket: &SomeAfPacketParams{ | ||
| RxFrameSize: 20480, | ||
| RxFramesPerBlock: 2048, | ||
| }, | ||
| AfXdp: &SomeAfXDPParams{ | ||
| RxqSize: 16384, | ||
| }, | ||
| } | ||
|
|
||
| func (c *SomeValuesType) DumpToFile(filename string) error { | ||
| contents, err := yaml.Marshal(c) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if err := os.MkdirAll(path.Dir(filename), 0o700); err != nil { | ||
| return err | ||
| } | ||
| return os.WriteFile(filename, contents, 0o600) | ||
| } | ||
|
|
||
| func TestDefaults(t *testing.T) { | ||
| packetValues := vppinit.GetAfPacketValues(context.Background()) | ||
| require.Equal(t, &vppinit.AfPacketParams{ | ||
| Mode: af_packet.AF_PACKET_API_MODE_ETHERNET, | ||
| Flags: af_packet.AF_PACKET_API_FLAG_VERSION_2, | ||
| RxFrameSize: 10240, | ||
| TxFrameSize: 10240, | ||
| RxFramesPerBlock: 1024, | ||
| TxFramesPerBlock: 1024, | ||
| NumRxQueues: 1, | ||
| NumTxQueues: 0, | ||
| }, | ||
| packetValues) | ||
|
|
||
| xdpValues := vppinit.GetAfXdpValues(context.Background()) | ||
| require.Equal(t, &vppinit.AfXDPParams{ | ||
| Mode: 0, | ||
| RxqSize: 8192, | ||
| TxqSize: 8192, | ||
| Flags: 0, | ||
| }, | ||
| xdpValues) | ||
| } | ||
|
|
||
| func TestSomeValuesSet(t *testing.T) { | ||
| _ = os.Setenv("NSM_VPP_INIT_PARAMS", configFilePath) | ||
| err := someValues.DumpToFile(configFilePath) | ||
| require.NoError(t, err) | ||
| defer func() { | ||
| if errRem := os.RemoveAll(configFilePath); errRem != nil { | ||
| t.Fatalf("no file generated or the generated file cannot removed") | ||
| } | ||
| }() | ||
|
|
||
| packetValues := vppinit.GetAfPacketValues(context.Background()) | ||
| require.Equal(t, &vppinit.AfPacketParams{ | ||
| Mode: af_packet.AF_PACKET_API_MODE_ETHERNET, | ||
| Flags: af_packet.AF_PACKET_API_FLAG_VERSION_2, | ||
| RxFrameSize: 20480, | ||
| TxFrameSize: 10240, | ||
| RxFramesPerBlock: 2048, | ||
| TxFramesPerBlock: 1024, | ||
| NumRxQueues: 1, | ||
| NumTxQueues: 0, | ||
| }, | ||
| packetValues) | ||
|
|
||
| xdpValues := vppinit.GetAfXdpValues(context.Background()) | ||
| require.Equal(t, &vppinit.AfXDPParams{ | ||
| Mode: 0, | ||
| RxqSize: 16384, | ||
| TxqSize: 8192, | ||
| Flags: 0, | ||
| }, | ||
| xdpValues) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| // Copyright (c) 2024 Nordix Foundation. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| // 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. | ||
|
|
||
| package vppinit | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
|
|
||
| "github.com/pkg/errors" | ||
| yaml "gopkg.in/yaml.v3" | ||
|
|
||
| "github.com/networkservicemesh/govpp/binapi/af_packet" | ||
| "github.com/networkservicemesh/govpp/binapi/af_xdp" | ||
| "github.com/networkservicemesh/sdk/pkg/tools/log" | ||
| ) | ||
|
|
||
| // Parameters contains parameters for various AF types | ||
| type Parameters struct { | ||
| AfPacket *AfPacketParams `yaml:"AF_PACKET"` | ||
| AfXdp *AfXDPParams `yaml:"AF_XDP"` | ||
| } | ||
|
|
||
| func (c *Parameters) String() string { | ||
| sb := &strings.Builder{} | ||
| _, _ = sb.WriteString("&{") | ||
| _, _ = sb.WriteString("AF_PACKET:{") | ||
| var strs []string | ||
| strs = append(strs, fmt.Sprintf("%+v", c.AfPacket)) | ||
| _, _ = sb.WriteString(strings.Join(strs, " ")) | ||
| _, _ = sb.WriteString("},") | ||
|
|
||
| _, _ = sb.WriteString("AF_XDP:{") | ||
| var xdpStrs []string | ||
| xdpStrs = append(xdpStrs, fmt.Sprintf("%+v", c.AfXdp)) | ||
| _, _ = sb.WriteString(strings.Join(xdpStrs, " ")) | ||
| _, _ = sb.WriteString("},") | ||
| _, _ = sb.WriteString("}") | ||
| return sb.String() | ||
| } | ||
|
|
||
| // AfPacketParams contains configuration parameters for AF_PACKET interface | ||
| type AfPacketParams struct { | ||
| Mode af_packet.AfPacketMode `yaml:"mode"` | ||
| RxFrameSize uint32 `yaml:"rxFrameSize"` | ||
| TxFrameSize uint32 `yaml:"txFrameSize"` | ||
| RxFramesPerBlock uint32 `yaml:"rxFramesPerBlock"` | ||
| TxFramesPerBlock uint32 `yaml:"txFramesPerBlock"` | ||
| NumRxQueues uint16 `yaml:"numRxQueues"` | ||
| NumTxQueues uint16 `yaml:"numTxQueues"` | ||
| Flags af_packet.AfPacketFlags `yaml:"flags"` | ||
| } | ||
|
|
||
| // AfXDPParams contains configuration parameters for AF_XDP interface | ||
| type AfXDPParams struct { | ||
| Mode af_xdp.AfXdpMode `yaml:"mode"` | ||
| RxqSize uint16 `yaml:"rxqSize"` | ||
| TxqSize uint16 `yaml:"txqSize"` | ||
| Flags af_xdp.AfXdpFlag `yaml:"flags"` | ||
| } | ||
|
|
||
| func getDefaults() *Parameters { | ||
| return &Parameters{ | ||
| AfPacket: &AfPacketParams{ | ||
| Mode: af_packet.AF_PACKET_API_MODE_ETHERNET, | ||
| RxFrameSize: 10240, | ||
| TxFrameSize: 10240, | ||
| RxFramesPerBlock: 1024, | ||
| TxFramesPerBlock: 1024, | ||
| NumRxQueues: 1, | ||
| NumTxQueues: 0, | ||
| Flags: af_packet.AF_PACKET_API_FLAG_VERSION_2, | ||
| }, | ||
| AfXdp: &AfXDPParams{ | ||
| Mode: af_xdp.AF_XDP_API_MODE_AUTO, | ||
| RxqSize: 8192, | ||
| TxqSize: 8192, | ||
| Flags: 0, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // GetAfPacketValues get parameter values for af-packet interface creation | ||
| func GetAfPacketValues(ctx context.Context) *AfPacketParams { | ||
| return getConfig(ctx).AfPacket | ||
| } | ||
|
|
||
| // GetAfXdpValues get parameter values for af-xdp interface creation | ||
| func GetAfXdpValues(ctx context.Context) *AfXDPParams { | ||
| return getConfig(ctx).AfXdp | ||
| } | ||
|
|
||
| func getConfig(ctx context.Context) *Parameters { | ||
| cfg := getDefaults() | ||
| confFilename := os.Getenv("NSM_VPP_INIT_PARAMS") | ||
| logger := log.FromContext(ctx).WithField("ReadConfig", confFilename) | ||
| if confFilename == "" { | ||
| logger.Infof("Using default VPP init parameters %+v", cfg) | ||
| return cfg | ||
| } | ||
| if _, err := os.Stat(confFilename); os.IsNotExist(err) { | ||
| logger.Infof("Configuration file: %q not found, using default VPP init parameters (%+v)", confFilename, cfg) | ||
| return cfg | ||
| } | ||
| err := readConfig(confFilename, cfg) | ||
| if err != nil { | ||
| defaultCfg := getDefaults() | ||
| logger.Warnf("Failed to read VPP init parameters %+v Using: %+v", err, defaultCfg) | ||
| return defaultCfg | ||
| } | ||
| logger.Infof("Unmarshalled VPP init parameters: %s", cfg) | ||
| return cfg | ||
| } | ||
|
|
||
| func readConfig(configFile string, cfg *Parameters) error { | ||
| bytes, err := os.ReadFile(filepath.Clean(configFile)) | ||
| if err != nil { | ||
| return errors.Wrapf(err, "error reading file: %v", configFile) | ||
| } | ||
| if err = yaml.Unmarshal(bytes, cfg); err != nil { | ||
| return errors.Wrapf(err, "error unmarshalling yaml: %s", bytes) | ||
| } | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters