utlity: Add benchmark for string-utility functions

bazel/external/BUILD

@@ -4,9 +4,9 @@ cc_library(
     name = "all_external",
     srcs = [":empty.cc"],
     deps = [
-        "@io_opentracing_cpp//:opentracing",
-        "@com_lightstep_tracer_cpp//:lightstep_tracer",
         "@com_google_googletest//:gtest",
+        "@com_lightstep_tracer_cpp//:lightstep_tracer",
+        "@io_opentracing_cpp//:opentracing",
     ],
 )
 

bazel/target_recipes.bzl

@@ -3,6 +3,7 @@
 # ci/build_container/build_recipes.
 TARGET_RECIPES = {
     "ares": "cares",
+    "benchmark": "benchmark",
     "event": "libevent",
     "event_pthreads": "libevent",
     "tcmalloc_and_profiler": "gperftools",

ci/build_container/build_recipes/benchmark.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+set -x
+
+export COMMIT="e1c3a83b8197cf02e794f61228461c27d4e78cfb"  # benchmark @ Jan 11, 2018
+
+git clone https://github.com/google/benchmark.git
+(cd benchmark; git reset --hard "$COMMIT")
+git clone https://github.com/google/googletest.git benchmark/googletest
+mkdir build
+
+cd build
+cmake -G "Unix Makefiles" ../benchmark -DCMAKE_BUILD_TYPE=RELEASE
+make
+cp src/libbenchmark.a "$THIRDPARTY_BUILD"/lib
+cd ../benchmark
+
+pwd
+include_dir="$THIRDPARTY_BUILD/include/testing/base/public"
+mkdir -p "$include_dir"
+cp include/benchmark/benchmark.h "$include_dir"

ci/prebuilt/BUILD

@@ -9,6 +9,13 @@ cc_library(
     includes = ["thirdparty_build/include"],
 )
 
+cc_library(
+    name = "benchmark",
+    srcs = ["thirdparty_build/lib/libbenchmark.a"],
+    hdrs = ["thirdparty_build/include/testing/base/public/benchmark.h"],
+    includes = ["thirdparty_build/include"],
+)
+
 cc_library(
     name = "crypto",
     srcs = ["thirdparty_build/lib/libcrypto.a"],

source/common/common/BUILD

@@ -120,6 +120,7 @@ envoy_cc_library(
     name = "utility_lib",
     srcs = ["utility.cc"],
     hdrs = ["utility.h"],
+    external_deps = ["abseil_strings"],
     deps = ["//include/envoy/common:time_interface"],
 )
 

source/common/common/utility.cc

@@ -98,6 +98,11 @@ void StringUtil::rtrim(std::string& source) {
   }
 }
 
+absl::string_view StringUtil::rightTrim(absl::string_view source) {
+  source.remove_suffix(source.size() - source.find_last_not_of(" \t\f\v\n\r") - 1);
+  return source;
+}
+
 size_t StringUtil::strlcpy(char* dst, const char* src, size_t size) {
   strncpy(dst, src, size - 1);
   dst[size - 1] = '\0';

source/common/common/utility.h

@@ -10,6 +10,8 @@
 
 #include "envoy/common/time.h"
 
+#include "absl/strings/string_view.h"
+
 namespace Envoy {
 /**
  * Utility class for formatting dates given a strftime style format string.
@@ -136,6 +138,11 @@ class StringUtil {
    */
   static void rtrim(std::string& source);
 
+  /**
+   * Trim trailing whitespace from a string_view, returning result.
+   */
+  static absl::string_view rightTrim(absl::string_view source);
+
   /**
    * Size-bounded string copying and concatenation
    */

test/common/common/BUILD

@@ -2,6 +2,8 @@ licenses(["notice"])  # Apache 2
 
 load(
     "//bazel:envoy_build_system.bzl",
+    "envoy_cc_binary",
+    "envoy_cc_library",
     "envoy_cc_test",
     "envoy_package",
 )
@@ -69,3 +71,20 @@ envoy_cc_test(
     srcs = ["callback_impl_test.cc"],
     deps = ["//source/common/common:callback_impl_lib"],
 )
+
+envoy_cc_library(
+    name = "utility_speed_test_lib",
+    srcs = ["utility_speed_test.cc"],
+    external_deps = [
+        "abseil_strings",
+        "benchmark",
+    ],
+    deps = [
+        "//source/common/common:utility_lib",
+    ],
+)
+
+envoy_cc_binary(
+    name = "utility_speed_test",
+    deps = ["utility_speed_test_lib"],
+)

test/common/common/utility_speed_test.cc

@@ -0,0 +1,48 @@
+#include <iostream>
+
+#include "common/common/utility.h"
+
+#include "testing/base/public/benchmark.h"
+
+static const char TextToTrim[] = "\t  the quick brown fox jumps over the lazy dog\n\r\n";
+static size_t TextToTrimLength = sizeof(TextToTrim) - 1;
+
+// NOLINT(namespace-envoy)
+
+static void printResults(int accum, int iters) {
+  std::cout << "avg trimmed=" << static_cast<float>(accum) / iters << " of " << iters << " iters."
+            << std::endl;
+}
+
+static void BM_RTrimString(benchmark::State& state) {
+  int accum = 0;
+  int iters = 0;
+  for (auto _ : state) {
+    std::string text(TextToTrim, TextToTrimLength);
+    Envoy::StringUtil::rtrim(text);
+    accum += TextToTrimLength - text.size();
+    ++iters;
+  }
+  printResults(accum, iters);
+}
+BENCHMARK(BM_RTrimString);
+
+static void BM_RTrimStringView(benchmark::State& state) {
+  int accum = 0;
+  int iters = 0;
+  for (auto _ : state) {
+    absl::string_view text(TextToTrim, TextToTrimLength);
+    text = Envoy::StringUtil::rightTrim(text);
+    accum += TextToTrimLength - text.size();
+    ++iters;
+  }
+  printResults(accum, iters);
+}
+BENCHMARK(BM_RTrimStringView);
+
+int main(int argc, char** argv) {
+  benchmark::Initialize(&argc, argv);
+  if (benchmark::ReportUnrecognizedArguments(argc, argv))
+    return 1;
+  benchmark::RunSpecifiedBenchmarks();
+}

test/common/common/utility_test.cc

@@ -94,6 +94,11 @@ TEST(StringUtil, rtrim) {
   }
 }
 
+TEST(StringUtil, rtrimView) {
+  EXPECT_EQ("", StringUtil::rightTrim("  "));
+  EXPECT_EQ("   hello", StringUtil::rightTrim("   hello \r\t\r\n"));
+}
+
 TEST(StringUtil, strlcpy) {
   {
     char dest[6];