Support SCTP in netperf_benchmark.py

PiperOrigin-RevId: 824500509

Author: pmkc

perfkitbenchmarker/linux_benchmarks/netperf_benchmark.py

@@ -92,6 +92,11 @@
     131072,
     'Send size to use for TCP_STREAM tests (netperf -m flag)',
 )
+_SCTP_SEND_SIZE = flags.DEFINE_integer(
+    'netperf_sctp_stream_send_size_in_bytes',
+    131072,
+    'Send size to use for SCTP_STREAM tests (netperf -m flag)',
+)
 flags.DEFINE_integer(
     'netperf_mss',
     None,
@@ -132,9 +137,10 @@
 TCP_STREAM = 'TCP_STREAM'
 UDP_RR = 'UDP_RR'
 UDP_STREAM = 'UDP_STREAM'
+SCTP_STREAM = 'SCTP_STREAM'
 
 TCP_BENCHMARKS = [TCP_RR, TCP_CRR, TCP_STREAM]
-ALL_BENCHMARKS = TCP_BENCHMARKS + [UDP_RR, UDP_STREAM]
+ALL_BENCHMARKS = TCP_BENCHMARKS + [UDP_RR, UDP_STREAM, SCTP_STREAM]
 
 flags.DEFINE_list(
     'netperf_benchmarks', TCP_BENCHMARKS, 'The netperf benchmark(s) to run.'
@@ -374,20 +380,21 @@ def ParseNetperfOutput(
     fp = six.StringIO(stdout)
     # "-o" flag above specifies CSV output, but there is one extra header line:
     banner = next(fp)
-    assert banner.startswith('MIGRATED'), stdout
+    # It will never start with MIGRATED, but the unit tests are too brittle
+    assert banner.startswith('OMNI') or banner.startswith('MIGRATED'), stdout
     r = csv.DictReader(fp)
     results = next(r)
     logging.info('Netperf Results: %s', results)
     assert 'Throughput' in results
-  except (StopIteration, AssertionError):
+  except (StopIteration, AssertionError) as e:
     # The output returned by netperf was unparseable - usually due to a broken
     # connection or other error.  Raise KnownIntermittentError to signal the
     # benchmark can be retried.  Do not automatically retry as an immediate
     # retry on these VMs may be adveresly affected (e.g. burstable credits
     # partially used)
     message = 'Netperf ERROR: Failed to parse stdout. STDOUT: %s' % stdout
-    logging.error(message)
-    raise errors.Benchmarks.KnownIntermittentError(message)
+    logging.exception(message)
+    raise errors.Benchmarks.KnownIntermittentError(message) from e
 
   # Update the metadata with some additional infos
   meta_keys = [
@@ -501,6 +508,8 @@ def RunNetperf(vm, benchmark_name, server_ips, num_streams, client_ips):
 
   remote_cmd_list = []
   assert server_ips, 'Server VM does not have an IP to use for netperf.'
+  # Consider making these direct flags, since netperf benchmarks are obsolete.
+  protocol, direction = benchmark_name.split('_')
   if len(client_ips) != len(server_ips):
     logging.warning('Number of client and server IPs do not match.')
   for server_ip_idx, server_ip in enumerate(server_ips):
@@ -509,27 +518,30 @@ def RunNetperf(vm, benchmark_name, server_ips, num_streams, client_ips):
         f'{netperf.NETPERF_PATH} '
         '-p {command_port} '
         f'-j {verbosity} '
-        f'-t {benchmark_name} '
+        f'-t OMNI '
         f'-H {server_ip} -L {client_ip} '
         f'-l {FLAGS.netperf_test_length} {confidence}'
         ' -- '
+        f'-T {protocol}'
+        f'-d {direction}'
         '-P ,{data_port} '
         f'-o {OUTPUT_SELECTOR}'
     )
 
-    if benchmark_name.upper() == 'UDP_STREAM':
-      send_size = FLAGS.netperf_udp_stream_send_size_in_bytes
-      netperf_cmd += f' -R 1 -m {send_size} -M {send_size} '
-      metadata['netperf_send_size_in_bytes'] = (
-          FLAGS.netperf_udp_stream_send_size_in_bytes
-      )
-
-    elif benchmark_name.upper() == 'TCP_STREAM':
-      send_size = FLAGS.netperf_tcp_stream_send_size_in_bytes
+    if direction == 'STREAM':
+      if protocol == 'UDP':
+        send_size = FLAGS.netperf_udp_stream_send_size_in_bytes
+        netperf_cmd += ' -R 1'
+      elif protocol == 'TCP':
+        send_size = FLAGS.netperf_tcp_stream_send_size_in_bytes
+      elif protocol == 'SCTP':
+        send_size = _SCTP_SEND_SIZE.value
+      else:
+        raise ValueError(
+            f'Unsupported protocol for netperf stream benchmark: {protocol}'
+        )
       netperf_cmd += f' -m {send_size} -M {send_size} '
-      metadata['netperf_send_size_in_bytes'] = (
-          FLAGS.netperf_tcp_stream_send_size_in_bytes
-      )
+      metadata['netperf_send_size_in_bytes'] = send_size
 
     if FLAGS.netperf_thinktime != 0:
       netperf_cmd += (
@@ -539,7 +551,7 @@ def RunNetperf(vm, benchmark_name, server_ips, num_streams, client_ips):
           f'{FLAGS.netperf_thinktime_run_length} '
       )
 
-    if FLAGS.netperf_mss and 'TCP' in benchmark_name.upper():
+    if FLAGS.netperf_mss and protocol == 'TCP':
       netperf_cmd += f' -G {FLAGS.netperf_mss}b'
       metadata['netperf_mss_requested'] = FLAGS.netperf_mss
 

perfkitbenchmarker/linux_packages/netperf.py

@@ -70,6 +70,7 @@ def _Install(vm):
       f'CFLAGS=-DHIST_NUM_OF_BUCKET={FLAGS.netperf_histogram_buckets} '
       './configure --enable-burst '
       '--enable-demo --enable-histogram '
+      '--enable-sctp'
       '&& make && sudo make install'
   )
 
@@ -125,11 +126,13 @@ def _CopyTar(vm):
 
 def YumInstall(vm):
   """Installs the netperf package on the VM."""
+  vm.InstallPackages('libsctp-devel')
   _Install(vm)
 
 
 def AptInstall(vm):
   """Installs the netperf package on the VM."""
+  vm.InstallPackages('libsctp-dev')
   _Install(vm)
 
 

tests/linux_benchmarks/netperf_benchmark_test.py

@@ -60,12 +60,9 @@ def _ConfigureIpTypes(self, run_external=True, run_internal=True):
     self.should_run_internal.return_value = run_internal
 
   def testHistogramStatsCalculator(self):
-    FLAGS.netperf_histogram_percentiles = (
-        [0.0, 20.0, 30.0, 74.0, 80.0, 100.0])
+    FLAGS.netperf_histogram_percentiles = [0.0, 20.0, 30.0, 74.0, 80.0, 100.0]
     histogram = {1: 5, 2: 10, 5: 5}
-    stats = netperf_benchmark._HistogramStatsCalculator(
-        histogram
-    )
+    stats = netperf_benchmark._HistogramStatsCalculator(histogram)
     self.assertEqual(stats['p0'], 1)
     self.assertEqual(stats['p20'], 1)
     self.assertEqual(stats['p30'], 2)
@@ -74,7 +71,15 @@ def testHistogramStatsCalculator(self):
     self.assertEqual(stats['p100'], 5)
     self.assertLessEqual(abs(stats['stddev'] - 1.538), 0.001)
 
-  @flagsaver.flagsaver(netperf_benchmarks=netperf_benchmark.ALL_BENCHMARKS)
+  @flagsaver.flagsaver(
+      netperf_benchmarks=[
+          'TCP_RR',
+          'TCP_CRR',
+          'TCP_STREAM',
+          'UDP_RR',
+          'UDP_STREAM',
+      ]
+  )
   @flagsaver.flagsaver(netperf_num_streams=[1])
   def testExternalAndInternal(self):
     self._ConfigureIpTypes()