src/proxy/logging/unit-tests/benchmark_LogObject.cc

/** @file

Simple benchmark for LogObject

@section license License

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you 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.
*/

/*

To run this, add this to Makefile.am in the proxy/logging directory

noinst_PROGRAMS = benchmark_LogObject
benchmark_LogObject_SOURCES = unit-tests/benchmark_LogObject.cc LogConfig.cc
benchmark_LogObject_CPPFLAGS = \
       $(AM_CPPFLAGS) \
       -I$(abs_top_srcdir)/tests/include
benchmark_LogObject_LDADD = \
       $(top_builddir)/src/tscore/libtscore.a \
       $(top_builddir)/src/tsutil/libtscpputil.la \
       $(top_builddir)/iocore/eventsystem/libinkevent.a \
       $(top_builddir)/proxy/logging/liblogging.a \
       $(top_builddir)/lib/records/librecords_p.a \
       $(top_builddir)/lib/records/librecords_lm.a \
       $(top_builddir)/proxy/logging/liblogging.a \
       $(top_builddir)/proxy/http/libhttp.a \
       $(top_builddir)/proxy/hdrs/libhdrs.a \
       $(top_builddir)/iocore/eventsystem/libinkevent.a \
       $(top_builddir)/proxy/shared/libdiagsconfig.a \
       @HWLOC_LIBS@

 */

#define CATCH_CONFIG_ENABLE_BENCHMARKING
#include <catch2/catch_test_macros.hpp>

#include "proxy/logging/LogConfig.h"
#include "proxy/logging/Log.h"
#include "proxy/shared/DiagsConfig.h"
#include "records/RecLocal.h"
#include "tscore/Layout.h"

#include <thread>
#include <condition_variable>
#include <chrono>

static char bind_stdout[512] = "";
static char bind_stderr[512] = "";

namespace notstd
{
struct barrier {
  int                     count;
  std::mutex              m;
  std::condition_variable cv;

  barrier(int count) : count(count) {}

  void
  arrive_and_wait()
  {
    std::unique_lock lock{m};
    if (0 == --count) {
      cv.notify_all();
    } else {
      cv.wait(lock, [this] { return count == 0; });
    }
  }
};
} // namespace notstd

TEST_CASE("LogObject", "[proxy/logging]")
{
  ink_freelist_init_ops(true, true);
  init_buffer_allocators(0);

  Thread *main_thread = new EThread;
  main_thread->set_specific();

  // unused, but constructor must be called for side effects.
  new DiagsConfig("Server", "diags.log", "", "", false);

  diags()->set_std_output(StdStream::STDOUT, bind_stdout);
  diags()->set_std_output(StdStream::STDERR, bind_stderr);

  if (DbgCtl dc{"diags"}; dc.on()) {
    diags()->dump();
  }
  Layout::create("/opt/ats");
  RecProcessInit();

  size_t stacksize;
  stacksize = RecGetRecordInt("proxy.config.thread.default.stacksize").value_or(0);
  eventProcessor.start(10, stacksize);

  pmgmt = new ProcessManager(false);

  Log::init();

  LogFormat *fmt = MakeTextLogFormat();

  fmt->display(stdout);

  Log::config->format_list.add(fmt, false);
  Log::config->display(stdout);

  LogObject *slowo = new LogObject(Log::config, fmt, "/tmp", "atsbenchlogslow.txt", LOG_FILE_ASCII, "testheader", Log::NO_ROLLING,
                                   1, 100, 100, 10, false, 0, 0, false, 0);
  LogObject *fasto = new LogObject(Log::config, fmt, "/tmp", "atsbenchlogfast.txt", LOG_FILE_ASCII, "testheader", Log::NO_ROLLING,
                                   1, 100, 100, 10, false, 0, 0, false, 0, true);

  Log::config->log_object_manager.manage_object(slowo);
  Log::config->log_object_manager.manage_object(fasto);

  BENCHMARK("logobject fast")
  {
    int             thread_cnt = 40;
    notstd::barrier barrier(thread_cnt);
    auto            test_object = [&](LogObject *o) {
      Thread *me = new EThread;
      me->set_specific();
      barrier.arrive_and_wait();

      std::string_view logline = "012345678901234567890123456789012345678901234567890";
      int              total   = 0;
      while (total < Log::config->log_buffer_size * 100) {
        o->log(nullptr, logline);
        total += logline.size();
      }
    };

    REQUIRE(fasto->writes_to_disk());
    REQUIRE(!fasto->writes_to_pipe());

    std::vector<std::thread> threads;
    threads.reserve(thread_cnt);

    for (int i = 0; i < thread_cnt; ++i) {
      threads.emplace_back(test_object, fasto);
    }
    for (int i = 0; i < thread_cnt; ++i) {
      threads[i].join();
    }
  };

  BENCHMARK("logobject slow")
  {
    int             thread_cnt = 40;
    notstd::barrier barrier(thread_cnt);

    auto test_object = [&](LogObject *o) {
      Thread *me = new EThread;
      me->set_specific();
      barrier.arrive_and_wait();

      std::string_view logline = "abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvw";
      int              total   = 0;
      while (total < Log::config->log_buffer_size * 100) {
        o->log(nullptr, logline);
        total += logline.size();
      }
    };

    REQUIRE(slowo->writes_to_disk());
    REQUIRE(!slowo->writes_to_pipe());

    std::vector<std::thread> threads;
    threads.reserve(thread_cnt);

    for (int i = 0; i < thread_cnt; ++i) {
      threads.emplace_back(test_object, slowo);
    }
    for (int i = 0; i < thread_cnt; ++i) {
      threads[i].join();
    }
  };
}