From 8eb53fc7b5c004d93153ba7c7f6b520ff8fd9e79 Mon Sep 17 00:00:00 2001 From: kishanps Date: Fri, 16 Jun 2023 13:20:30 -0700 Subject: [PATCH] [P4-Symbolic] Remove assumption on argument order matching parameter definition order. Match parameter to argument based on name. k --- p4_symbolic/symbolic/BUILD.bazel | 1 + p4_symbolic/symbolic/action.cc | 35 ++-- tests/forwarding/ouroboros_test.cc | 312 +++++++++++++++++++++++++++++ 3 files changed, 333 insertions(+), 15 deletions(-) create mode 100644 tests/forwarding/ouroboros_test.cc diff --git a/p4_symbolic/symbolic/BUILD.bazel b/p4_symbolic/symbolic/BUILD.bazel index c729f154..606102cb 100644 --- a/p4_symbolic/symbolic/BUILD.bazel +++ b/p4_symbolic/symbolic/BUILD.bazel @@ -44,6 +44,7 @@ cc_library( "values.h", ], deps = [ + "//gutil:collections", "//gutil:status", "//p4_pdpi:ir_cc_proto", "//p4_pdpi/internal:ordered_map", diff --git a/p4_symbolic/symbolic/action.cc b/p4_symbolic/symbolic/action.cc index e5b55b4f..f0625a86 100644 --- a/p4_symbolic/symbolic/action.cc +++ b/p4_symbolic/symbolic/action.cc @@ -17,7 +17,9 @@ #include "absl/status/status.h" #include "absl/strings/str_cat.h" #include "absl/strings/str_format.h" +#include "absl/strings/string_view.h" #include "glog/logging.h" +#include "gutil/collections.h" #include "p4_symbolic/symbolic/operators.h" #include "p4_symbolic/symbolic/symbolic.h" #include "p4_symbolic/z3_util.h" @@ -320,27 +322,30 @@ absl::Status EvaluateAction(const ir::Action &action, VLOG(1) << "evaluating action '" << context.action_name << "'"; // Add action parameters to scope. - const auto ¶meters = action.action_definition().params_by_id(); + const auto ¶meters = action.action_definition().params_by_name(); if (static_cast(parameters.size()) != args.size()) { return absl::InvalidArgumentError( absl::StrCat("Action ", action.action_definition().preamble().name(), " called with incompatible number of parameters")); } - // Find each parameter value in argument by parameter's name. - for (size_t i = 1; i <= parameters.size(); i++) { - // parameter id is the same as its index + 1. - const pdpi::IrActionDefinition::IrActionParamDefinition ¶meter = - parameters.at(i); - const std::string ¶meter_name = parameter.param().name(); - const std::string ¶meter_type_name = - parameter.param().type_name().name(); - const int bitwidth = parameter.param().bitwidth(); - ASSIGN_OR_RETURN(z3::expr parameter_value, - values::FormatP4RTValue( - Z3Context(), /*field_name=*/"", parameter_type_name, - args.at(i - 1).value(), bitwidth, translator)); - context.scope.insert({parameter_name, parameter_value}); + // Find each parameter value in arguments by argument name. We should not rely + // on argument order matching param definition order, because the P4 runtime + // spec does not enforce this assumption in implementations, and furthermore + // the spec explicitly states that read entries do not have to preserve the + // order of repeated fields in written entries. + for (const auto &arg : args) { + absl::string_view arg_name = arg.name(); + ASSIGN_OR_RETURN(const pdpi::IrActionDefinition::IrActionParamDefinition + *param_definition, + gutil::FindPtrOrStatus(parameters, arg_name)); + ASSIGN_OR_RETURN( + z3::expr parameter_value, + values::FormatP4RTValue( + Z3Context(), /*field_name=*/"", + param_definition->param().type_name().name(), arg.value(), + param_definition->param().bitwidth(), translator)); + context.scope.insert({param_definition->param().name(), parameter_value}); } // Iterate over the body in order, and evaluate each statement. diff --git a/tests/forwarding/ouroboros_test.cc b/tests/forwarding/ouroboros_test.cc new file mode 100644 index 00000000..24a7cb00 --- /dev/null +++ b/tests/forwarding/ouroboros_test.cc @@ -0,0 +1,312 @@ +// Copyright 2024 Google LLC +// +// 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 +// +// https://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. + +#include "tests/forwarding/ouroboros_test.h" + +#include +#include +#include +#include +#include + +#include "absl/algorithm/container.h" +#include "absl/container/btree_map.h" +#include "absl/container/btree_set.h" +#include "absl/container/flat_hash_map.h" +#include "absl/random/random.h" +#include "absl/status/status.h" +#include "absl/status/statusor.h" +#include "absl/strings/escaping.h" +#include "absl/strings/str_cat.h" +#include "absl/strings/str_format.h" +#include "absl/strings/str_join.h" +#include "absl/strings/string_view.h" +#include "absl/strings/substitute.h" +#include "absl/time/clock.h" +#include "absl/time/time.h" +#include "absl/types/span.h" +#include "dvaas/dataplane_validation.h" +#include "glog/logging.h" +#include "gmock/gmock.h" +#include "google/protobuf/descriptor.h" +#include "gtest/gtest.h" +#include "gutil/proto.h" +#include "gutil/status.h" +#include "gutil/status_matchers.h" +#include "lib/gnmi/gnmi_helper.h" +#include "lib/gnmi/openconfig.pb.h" +#include "lib/p4rt/p4rt_port.h" +#include "p4/config/v1/p4info.pb.h" +#include "p4/v1/p4runtime.pb.h" +#include "p4_fuzzer/annotation_util.h" +#include "p4_fuzzer/fuzz_util.h" +#include "p4_fuzzer/fuzzer.pb.h" +#include "p4_fuzzer/fuzzer_config.h" +#include "p4_fuzzer/switch_state.h" +#include "p4_pdpi/ir.h" +#include "p4_pdpi/ir.pb.h" +#include "p4_pdpi/p4_runtime_session.h" +#include "p4_pdpi/p4_runtime_session_extras.h" +#include "p4_pdpi/packetlib/packetlib.h" +#include "p4_pdpi/packetlib/packetlib.pb.h" +#include "p4_pdpi/pd.h" +#include "p4_pdpi/string_encodings/decimal_string.h" +#include "proto/gnmi/gnmi.grpc.pb.h" +#include "sai_p4/instantiations/google/sai_pd.pb.h" +#include "tests/forwarding/test_vector.h" +#include "tests/forwarding/test_vector.pb.h" +#include "tests/forwarding/util.h" +#include "tests/lib/switch_test_setup_helpers.h" +#include "thinkit/mirror_testbed.h" +#include "thinkit/test_environment.h" + +namespace pins_test { +namespace { + +using ::dvaas::Switch; +using ::p4_fuzzer::FuzzerConfig; + +// -- Auxiliary functions ------------------------------------------------------ + +std::string CreateHeader(absl::string_view title) { + return absl::StrCat(std::string(80, '#'), "\n### ", title, "\n", + std::string(80, '#'), "\n"); +} + +// Reads table entries on `sut` and outputs them into an artifact given by +// `artifact_name`. +absl::Status OutputTableEntriesToArtifact(Switch& sut, + thinkit::TestEnvironment& environment, + absl::string_view artifact_name, + int iteration) { + RETURN_IF_ERROR(environment.AppendToTestArtifact( + artifact_name, + CreateHeader(absl::StrCat("Entries after iteration ", iteration)))); + // Read sorted entries back (for determinism) and store in an artifact. + ASSIGN_OR_RETURN(pdpi::IrTableEntries entries, + pdpi::ReadIrTableEntriesSorted(*sut.p4rt)); + return environment.AppendToTestArtifact(artifact_name, entries.DebugString()); +} + +// Augments the given FuzzerConfig to fit the `sut` and Ouroboros Test by +// replacing the IrP4Info and available ports with those read from the switch +// and setting mutation probability to 0. +absl::Status AugmentFuzzerConfig(Switch& sut, FuzzerConfig& fuzzer_config) { + ASSIGN_OR_RETURN(p4::v1::GetForwardingPipelineConfigResponse response, + pdpi::GetForwardingPipelineConfig(sut.p4rt.get())); + ASSIGN_OR_RETURN(pdpi::IrP4Info ir_info, + pdpi::CreateIrP4Info(response.config().p4info())); + + fuzzer_config.info = ir_info; + ASSIGN_OR_RETURN(fuzzer_config.ports, + pins_test::GetMatchingP4rtPortIds( + *sut.gnmi, pins_test::IsEnabledEthernetInterface)); + fuzzer_config.mutate_update_probability = 0.0; + // Our validator, BMv2, does not support empty action profile groups. + fuzzer_config.no_empty_action_profile_groups = true; + return absl::OkStatus(); +} + +// Creates connections to the SUT and Control switch and configures them with a +// `gnmi_config` and `p4info` (if given). Mirrors the SUTs interfaces on the +// control switch and waits for them to be Up. +// Returns a configured (SUT, Control Switch) pair. +absl::StatusOr> ConfigureMirrorTestbed( + thinkit::MirrorTestbed& testbed, std::optional gnmi_config, + std::optional p4info) { + // Configure both switches and set up gNMI and P4Runtime sessions to them. + Switch sut; + Switch control_switch; + ASSIGN_OR_RETURN(sut.gnmi, testbed.Sut().CreateGnmiStub()); + ASSIGN_OR_RETURN(control_switch.gnmi, + testbed.ControlSwitch().CreateGnmiStub()); + // TODO: Update to use whole ForwardingPipelineConfig when the + // function supports that. + ASSIGN_OR_RETURN( + std::tie(sut.p4rt, control_switch.p4rt), + ConfigureSwitchPairAndReturnP4RuntimeSessionPair( + testbed.Sut(), testbed.ControlSwitch(), gnmi_config, p4info)); + + // Mirror testbed ports. + RETURN_IF_ERROR(MirrorSutP4rtPortIdConfigToControlSwitch(testbed)); + + // Ensure that all enabled ports are up. + RETURN_IF_ERROR(WaitForEnabledInterfacesToBeUp(testbed.Sut())).SetPrepend() + << "expected enabled interfaces on SUT to be up: "; + RETURN_IF_ERROR(WaitForEnabledInterfacesToBeUp(testbed.ControlSwitch())) + .SetPrepend() + << "expected enabled interfaces on control switch to be up: "; + + return std::make_pair(std::move(sut), std::move(control_switch)); +} + +// -- Main functions ----------------------------------------------------------- + +// Generates updates to switch state using the P4-Fuzzer and sends them to the +// switch. +absl::Status FuzzSwitchState(absl::BitGen& gen, Switch& sut, + thinkit::TestEnvironment& environment, + int iteration, const FuzzerConfig& fuzzer_config, + int min_num_updates, + p4_fuzzer::SwitchState& state) { + int num_updates = 0; + int num_fuzzing_cycles = 0; + while (num_updates < min_num_updates) { + num_fuzzing_cycles++; + p4_fuzzer::AnnotatedWriteRequest annotated_request = + p4_fuzzer::FuzzWriteRequest(&gen, fuzzer_config, state); + p4::v1::WriteRequest request = + p4_fuzzer::RemoveAnnotations(annotated_request); + num_updates += request.updates_size(); + + // Send to switch. + ASSIGN_OR_RETURN(pdpi::IrWriteRpcStatus response, + pdpi::SendPiUpdatesAndReturnPerUpdateStatus( + *sut.p4rt, request.updates())); + + RETURN_IF_ERROR(p4_fuzzer::OutputInterleavedRequestAndResponseToArtifact( + environment, /*artifact_name=*/"ouroboros_requests_and_responses.txt", + /*identifying_prefix=*/ + absl::StrCat("Iteration ", iteration, ".", num_fuzzing_cycles), + annotated_request, response)); + + // Update the switch state to reflect any accepted updates. + for (int i = 0; i < request.updates_size(); ++i) { + if (response.rpc_response().statuses(i).code() == google::rpc::OK) { + RETURN_IF_ERROR(state.ApplyUpdate(request.updates(i))); + } + } + } + + constexpr absl::string_view kSwitchStateArtifactName = + "ouroboros_switch_state_after_iterations.txt"; + RETURN_IF_ERROR(environment.AppendToTestArtifact( + kSwitchStateArtifactName, + CreateHeader(absl::StrCat("SwitchState after iteration ", iteration)))); + RETURN_IF_ERROR(environment.AppendToTestArtifact(kSwitchStateArtifactName, + state.SwitchStateSummary())); + RETURN_IF_ERROR( + environment.AppendToTestArtifact(kSwitchStateArtifactName, "\n\n")); + return absl::OkStatus(); +} + +TEST_P( + OuroborosTest, + SwitchUnderTestConformsToP4ModelUnderSyntheticStreamOfEntriesAndPackets) { + thinkit::MirrorTestbed& testbed = + GetParam().mirror_testbed->GetMirrorTestbed(); + thinkit::TestEnvironment& environment = testbed.Environment(); + + // Get the start time to determine when to stop the test. + const absl::Time deadline = absl::Now() + GetParam().target_test_time; + + // Store the original control switch gNMI interface config before changing + // it. + // WARNING: This may fail if a gNMI config has not been pushed. + ASSERT_OK_AND_ASSIGN( + std::unique_ptr control_gnmi_stub, + testbed.ControlSwitch().CreateGnmiStub()); + ASSERT_OK_AND_ASSIGN( + const pins_test::openconfig::Interfaces original_control_interfaces, + pins_test::GetInterfacesAsProto(*control_gnmi_stub, + gnmi::GetRequest::CONFIG)); + + Switch sut, control_switch; + ASSERT_OK_AND_ASSIGN(std::tie(sut, control_switch), + ConfigureMirrorTestbed(testbed, GetParam().gnmi_config, + GetParam().config.p4info())); + + ASSERT_OK_AND_ASSIGN(auto ir_p4info, + pdpi::CreateIrP4Info(GetParam().config.p4info())); + ASSERT_OK(environment.AppendToTestArtifact("sut_initial_ir_p4info.txt", + ir_p4info.DebugString())); + + // Set up SUT with initial entries. + ASSERT_OK(pdpi::InstallIrTableEntries(*sut.p4rt, + GetParam().initial_sut_table_entries)); + + FuzzerConfig fuzzer_config = GetParam().fuzzer_config; + ASSERT_OK(AugmentFuzzerConfig(sut, fuzzer_config)); + p4_fuzzer::SwitchState fuzzer_switch_state(fuzzer_config.info); + + absl::BitGen gen; + + LOG(INFO) << "Running Ouroboros for up to " << GetParam().target_test_time + << " or " << GetParam().max_iterations << " iterations."; + + // We keep track of the last iteration time to run the test for as close to + // `target_test_time` while ensuring we don't go above it. We expect that the + // next iteration will take no more than 2x the time of the last iteration. + absl::Duration last_iteration_time = absl::ZeroDuration(); + int iteration = 0; + while (iteration < GetParam().max_iterations && + deadline - absl::Now() > 2 * last_iteration_time) { + iteration++; + SCOPED_TRACE(absl::StrCat("Iteration: ", iteration)); + absl::Time iteration_start_time = absl::Now(); + + ASSERT_OK(FuzzSwitchState(gen, sut, environment, iteration, fuzzer_config, + GetParam().min_num_updates_per_loop, + fuzzer_switch_state)); + + ASSERT_OK(OutputTableEntriesToArtifact( + sut, environment, /*artifact_name=*/"ouroboros_table_entries.txt", + iteration)); + + ASSERT_OK_AND_ASSIGN( + dvaas::ValidationResult validation_result_unused, + GetParam().validator->ValidateDataplane( + sut, control_switch, /*params=*/ + dvaas::DataplaneValidationParams{ + .ignored_fields_for_validation = + GetParam().ignored_fields_for_validation, + .ignored_metadata_for_validation = + GetParam().ignored_packetin_metadata_for_validation, + .artifact_prefix = "ouroboros", + .get_artifact_header = + [=]() { + return CreateHeader( + absl::StrCat("Iteration ", iteration)); + }, + .max_packets_to_send_per_second = + GetParam().max_packets_to_send_per_second, + })); + // Mark that the validation result is currently unused. + (void)validation_result_unused; + + last_iteration_time = absl::Now() - iteration_start_time; + } + + dvaas::PacketStatistics statistics = + GetParam().validator->GetCurrentPacketStatistics(); + + LOG(INFO) << "Ran for " << iteration << " iterations."; + LOG(INFO) << "The last iteration took " << last_iteration_time << "."; + LOG(INFO) << "Total number of packets sent: " + << statistics.total_packets_injected; + LOG(INFO) << "Total number of packets forwarded: " + << statistics.total_packets_forwarded; + LOG(INFO) << "Total number of packets punted: " + << statistics.total_packets_punted; + LOG(INFO) << "Final switch forwarding state is:\n" + << fuzzer_switch_state.SwitchStateSummary(); + + // Restore the original control switch gNMI interface config's P4RT IDs. + ASSERT_OK(pins_test::SetInterfaceP4rtIds(*control_switch.gnmi, + original_control_interfaces)); +} + +} // namespace + +} // namespace pins_test