/
githubmirror
/
nghttp2
Обзор
Документация
Войти
/
githubmirror
/
nghttp2
Код
Запросы
0
Пакеты
0
Релизы
0
Аналитика
Безопасность
master
src/h2load.cc
3 963 строки
115 KB
Tatsuhiro Tsujikawa
h2load: Fix build error with gcc-16
30 июн 2026, 13:35
30 июн 2026, 13:35
28d1290
Код
Авторство
О чём код?
/* * nghttp2 - HTTP/2 C Library * * Copyright (c) 2014 Tatsuhiro Tsujikawa * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #include "h2load.h" #include <getopt.h> #include <signal.h> #ifdef HAVE_NETINET_IN_H # include <netinet/in.h> #endif // defined(HAVE_NETINET_IN_H) #include <netinet/tcp.h> #include <sys/stat.h> #ifdef HAVE_FCNTL_H # include <fcntl.h> #endif // defined(HAVE_FCNTL_H) #include <sys/mman.h> #include <netinet/udp.h> #include <cstdio> #include <cassert> #include <cstdlib> #include <iostream> #include <iomanip> #include <fstream> #include <chrono> #include <thread> #include <future> #include <random> #include <string_view> #include <print> #include "ssl_compat.h" #ifdef NGHTTP2_OPENSSL_IS_WOLFSSL # include <wolfssl/options.h> # include <wolfssl/openssl/err.h> #else // !defined(NGHTTP2_OPENSSL_IS_WOLFSSL) # include <openssl/err.h> #endif // !defined(NGHTTP2_OPENSSL_IS_WOLFSSL) #ifdef ENABLE_HTTP3 # if defined(HAVE_LIBNGTCP2_CRYPTO_QUICTLS) || \ defined(HAVE_LIBNGTCP2_CRYPTO_LIBRESSL) # include <ngtcp2/ngtcp2_crypto_quictls.h> # endif // defined(HAVE_LIBNGTCP2_CRYPTO_QUICTLS) || // defined(HAVE_LIBNGTCP2_CRYPTO_LIBRESSL) # ifdef HAVE_LIBNGTCP2_CRYPTO_BORINGSSL # include <ngtcp2/ngtcp2_crypto_boringssl.h> # endif // defined(HAVE_LIBNGTCP2_CRYPTO_BORINGSSL) # ifdef HAVE_LIBNGTCP2_CRYPTO_WOLFSSL # include <ngtcp2/ngtcp2_crypto_wolfssl.h> # endif // defined(HAVE_LIBNGTCP2_CRYPTO_WOLFSSL) # ifdef HAVE_LIBNGTCP2_CRYPTO_OSSL # include <ngtcp2/ngtcp2_crypto_ossl.h> # endif // defined(HAVE_LIBNGTCP2_CRYPTO_OSSL) #endif // defined(ENABLE_HTTP3) #include "urlparse.h" #include "h2load_http1_session.h" #include "h2load_http2_session.h" #ifdef ENABLE_HTTP3 # include "h2load_http3_session.h" # include "h2load_quic.h" #endif // defined(ENABLE_HTTP3) #include "tls.h" #include "http2.h" #include "util.h" #include "template.h" #ifndef O_BINARY # define O_BINARY (0) #endif // !defined(O_BINARY) using namespace nghttp2; namespace h2load { namespace { bool recorded(std::chrono::steady_clock::time_point t) { return std::chrono::steady_clock::duration::zero() != t.time_since_epoch(); } } // namespace Config::~Config() { if (tls_session) { SSL_SESSION_free(tls_session); } if (addrs) { if (base_uri_unix) { delete addrs; } else { freeaddrinfo(addrs); } } if (data_fd != -1) { close(data_fd); } } bool Config::is_rate_mode() const { return (this->rate != 0); } bool Config::is_timing_based_mode() const { return (this->duration > 0); } bool Config::has_base_uri() const { return (!this->base_uri.empty()); } bool Config::rps_enabled() const { return this->rps > 0.0; } bool Config::is_quic() const { #ifdef ENABLE_HTTP3 return !alpn_list.empty() && (alpn_list[0] == NGHTTP3_ALPN_H3 || alpn_list[0] == "\x5h3-29"); #else // !defined(ENABLE_HTTP3) return false; #endif // !defined(ENABLE_HTTP3) } Config config; constexpr size_t MAX_SAMPLES = 1000000; Stats::Stats(size_t req_todo, size_t nclients) : req_todo(req_todo) {} namespace { std::random_device rd; } // namespace namespace { std::mt19937 gen(rd()); } // namespace namespace { void sampling_init(Sampling &smp, size_t max_samples) { smp.n = 0; smp.max_samples = max_samples; } } // namespace namespace { void writecb(struct ev_loop *loop, ev_io *w, int revents) { auto client = static_cast<Client *>(w->data); client->restart_timeout(); if (auto rv = client->do_write(); !rv) { if (rv.error() == Error::CONNECT_FAIL) { client->disconnect(); // Try next address client->current_addr = nullptr; if (!client->connect()) { client->fail(); client->worker->free_client(client); delete client; return; } return; } client->fail(); client->worker->free_client(client); delete client; } } } // namespace namespace { void readcb(struct ev_loop *loop, ev_io *w, int revents) { auto client = static_cast<Client *>(w->data); client->restart_timeout(); if (!client->do_read()) { if (client->try_again_or_fail()) { return; } client->worker->free_client(client); delete client; return; } client->signal_write(); } } // namespace namespace { // Called every rate_period when rate mode is being used void rate_period_timeout_w_cb(struct ev_loop *loop, ev_timer *w, int revents) { auto worker = static_cast<Worker *>(w->data); auto nclients_per_second = worker->rate; auto conns_remaining = worker->nclients - worker->nconns_made; auto nclients = std::min(nclients_per_second, conns_remaining); for (size_t i = 0; i < nclients; ++i) { auto req_todo = worker->nreqs_per_client; if (worker->nreqs_rem > 0) { ++req_todo; --worker->nreqs_rem; } auto client_id = worker->next_client_id++; auto client = std::make_unique<Client>(client_id, worker, req_todo); ++worker->nconns_made; if (!client->connect()) { std::println(stderr, "client could not connect to host"); client->fail(); } else { if (worker->config->is_timing_based_mode()) { worker->clients.emplace(client_id, client.release()); } else { client.release(); } } worker->report_rate_progress(); } if (!worker->config->is_timing_based_mode()) { if (worker->nconns_made >= worker->nclients) { ev_timer_stop(worker->loop, w); } } else { // To check whether all created clients are pushed correctly assert(worker->nclients == worker->clients.size()); } } } // namespace namespace { // Called when the duration for infinite number of requests are over void duration_timeout_cb(struct ev_loop *loop, ev_timer *w, int revents) { auto worker = static_cast<Worker *>(w->data); worker->current_phase = Phase::DURATION_OVER; std::println( "Main benchmark duration is over for thread #{}. Stopping all clients.", worker->id); worker->stop_all_clients(); std::println("Stopped all clients for thread #{}", worker->id); } } // namespace namespace { // Called when the warmup duration for infinite number of requests are over void warmup_timeout_cb(struct ev_loop *loop, ev_timer *w, int revents) { auto worker = static_cast<Worker *>(w->data); std::println("Warm-up phase is over for thread #{}.", worker->id); std::println("Main benchmark duration is started for thread #{}.", worker->id); assert(worker->stats.req_started == 0); assert(worker->stats.req_done == 0); for (const auto [_, client] : worker->clients) { if (client) { assert(client->req_todo == 0); assert(client->req_left == 1); assert(client->req_inflight == 0); assert(client->req_started == 0); assert(client->req_done == 0); client->record_client_start_time(); client->clear_connect_times(); client->record_connect_start_time(); } } worker->current_phase = Phase::MAIN_DURATION; ev_timer_start(worker->loop, &worker->duration_watcher); } } // namespace namespace { void rps_cb(struct ev_loop *loop, ev_timer *w, int revents) { auto client = static_cast<Client *>(w->data); auto &session = client->session; assert(!config.timing_script); if (client->req_left == 0) { ev_timer_stop(loop, w); return; } auto now = std::chrono::steady_clock::now(); auto d = now - client->rps_duration_started; auto n = static_cast<size_t>( round(std::chrono::duration<double>(d).count() * config.rps)); client->rps_req_pending += n; client->rps_duration_started += util::duration_from(static_cast<double>(n) / config.rps); if (client->rps_req_pending == 0) { return; } auto nreq = session->max_concurrent_streams() - client->rps_req_inflight; if (nreq == 0) { return; } nreq = config.is_timing_based_mode() ? std::max(nreq, client->req_left) : std::min(nreq, client->req_left); nreq = std::min(nreq, client->rps_req_pending); client->rps_req_inflight += nreq; client->rps_req_pending -= nreq; for (; nreq > 0; --nreq) { if (!client->submit_request()) { client->process_request_failure(); break; } } client->signal_write(); } } // namespace namespace { // Called when an a connection has been inactive for a set period of time // or a fixed amount of time after all requests have been made on a // connection void conn_timeout_cb(EV_P_ ev_timer *w, int revents) { auto client = static_cast<Client *>(w->data); ev_timer_stop(client->worker->loop, &client->conn_inactivity_watcher); ev_timer_stop(client->worker->loop, &client->conn_active_watcher); if (util::check_socket_connected(client->fd)) { client->timeout(); } } } // namespace namespace { bool check_stop_client_request_timeout(Client *client, ev_timer *w) { if (client->req_left == 0) { // no more requests to make, stop timer ev_timer_stop(client->worker->loop, w); return true; } return false; } } // namespace namespace { void client_request_timeout_cb(struct ev_loop *loop, ev_timer *w, int revents) { auto client = static_cast<Client *>(w->data); if (client->streams.size() >= config.max_concurrent_streams) { ev_timer_stop(client->worker->loop, w); return; } if (!client->submit_request()) { ev_timer_stop(client->worker->loop, w); client->process_request_failure(); return; } client->signal_write(); if (check_stop_client_request_timeout(client, w)) { return; } auto duration = config.timings[client->reqidx] - config.timings[client->reqidx - 1]; while (duration < std::chrono::duration<double>(1e-9)) { if (!client->submit_request()) { ev_timer_stop(client->worker->loop, w); client->process_request_failure(); return; } client->signal_write(); if (check_stop_client_request_timeout(client, w)) { return; } duration = config.timings[client->reqidx] - config.timings[client->reqidx - 1]; } client->request_timeout_watcher.repeat = util::ev_tstamp_from(duration); ev_timer_again(client->worker->loop, &client->request_timeout_watcher); } } // namespace Client::Client(uint32_t id, Worker *worker, size_t req_todo) : wb(&worker->mcpool), worker(worker), next_addr(config.addrs), req_todo(req_todo), req_left(req_todo), id(id) { if (req_todo == 0) { // this means infinite number of requests are to be made // This ensures that number of requests are unbounded // Just a positive number is fine, we chose the first positive number req_left = 1; } ev_io_init(&wev, writecb, 0, EV_WRITE); ev_io_init(&rev, readcb, 0, EV_READ); wev.data = this; rev.data = this; ev_timer_init(&conn_inactivity_watcher, conn_timeout_cb, 0., worker->config->conn_inactivity_timeout); conn_inactivity_watcher.data = this; ev_timer_init(&conn_active_watcher, conn_timeout_cb, worker->config->conn_active_timeout, 0.); conn_active_watcher.data = this; ev_timer_init(&request_timeout_watcher, client_request_timeout_cb, 0., 0.); request_timeout_watcher.data = this; ev_timer_init(&rps_watcher, rps_cb, 0., 0.); rps_watcher.data = this; #ifdef ENABLE_HTTP3 ev_timer_init(&quic.pkt_timer, quic_pkt_timeout_cb, 0., 0.); quic.pkt_timer.data = this; # ifndef UDP_SEGMENT quic.tx.no_gso = true; # endif // !defined(UDP_SEGMENT) if (config.is_quic()) { ev_set_priority(&rev, EV_MAXPRI); quic.tx.data = std::make_unique<uint8_t[]>(QUIC_TX_DATALEN); } ngtcp2_ccerr_default(&quic.last_error); #endif // defined(ENABLE_HTTP3) } Client::~Client() { disconnect(); // Free ssl before freeing QUIC resources because // libngtcp2_crypto_ossl requires that ngtcp2_conn is still alive. if (ssl) { SSL_free(ssl); } #ifdef ENABLE_HTTP3 if (config.is_quic()) { quic_free(); } #endif // defined(ENABLE_HTTP3) worker->sample_client_stat(&cstat); ++worker->client_smp.n; } std::expected<void, Error> Client::do_read() { return readfn(*this); } std::expected<void, Error> Client::do_write() { return writefn(*this); } std::expected<void, Error> Client::make_socket(addrinfo *addr) { int rv; if (config.is_quic()) { #ifdef ENABLE_HTTP3 auto maybe_fd = util::create_nonblock_udp_socket(addr->ai_family); if (!maybe_fd) { return std::unexpected{maybe_fd.error()}; } fd = *maybe_fd; # ifdef UDP_GRO int val = 1; if (setsockopt(fd, IPPROTO_UDP, UDP_GRO, &val, sizeof(val)) != 0) { std::println(stderr, "setsockopt UDP_GRO failed"); return std::unexpected{Error::SYSCALL}; } # endif // defined(UDP_GRO) if (auto rv = util::bind_any_addr_udp(fd, addr->ai_family); !rv) { close(fd); fd = -1; return std::unexpected{rv.error()}; } sockaddr_storage ss; socklen_t addrlen = sizeof(ss); rv = getsockname(fd, reinterpret_cast<sockaddr *>(&ss), &addrlen); if (rv == -1) { return std::unexpected{Error::SYSCALL}; } local_addr.set(reinterpret_cast<const sockaddr *>(&ss)); if (auto rv = quic_init(local_addr.as_sockaddr(), local_addr.size(), addr->ai_addr, addr->ai_addrlen); !rv) { std::println(stderr, "quic_init failed"); return rv; } #endif // defined(ENABLE_HTTP3) } else { auto maybe_fd = util::create_nonblock_socket(addr->ai_family); if (!maybe_fd) { return std::unexpected{maybe_fd.error()}; } fd = *maybe_fd; if (config.scheme == "https") { if (!ssl) { ssl = SSL_new(worker->ssl_ctx); if (config.tls_session && !SSL_set_session(ssl, config.tls_session)) { std::println(stderr, "Could not set TLS session"); } if (!config.tls_session_file.empty()) { SSL_set_ex_data(ssl, 1, worker); } } SSL_set_connect_state(ssl); } } if (ssl) { if (!config.sni.empty()) { SSL_set_tlsext_host_name(ssl, config.sni.c_str()); } else if (!util::numeric_host(config.host.c_str())) { SSL_set_tlsext_host_name(ssl, config.host.c_str()); } } if (config.is_quic()) { return {}; } rv = ::connect(fd, addr->ai_addr, addr->ai_addrlen); if (rv != 0 && errno != EINPROGRESS) { if (ssl) { SSL_free(ssl); ssl = nullptr; } close(fd); fd = -1; return std::unexpected{Error::SYSCALL}; } return {}; } std::expected<void, Error> Client::connect() { if (!worker->config->is_timing_based_mode() || worker->current_phase == Phase::MAIN_DURATION) { record_client_start_time(); clear_connect_times(); record_connect_start_time(); } else if (worker->current_phase == Phase::INITIAL_IDLE) { worker->current_phase = Phase::WARM_UP; std::println("Warm-up started for thread #{}.", worker->id); ev_timer_start(worker->loop, &worker->warmup_watcher); } if (worker->config->conn_inactivity_timeout > 0.) { ev_timer_again(worker->loop, &conn_inactivity_watcher); } if (current_addr) { if (auto rv = make_socket(current_addr); !rv) { return rv; } } else { addrinfo *addr = nullptr; while (next_addr) { addr = next_addr; next_addr = next_addr->ai_next; if (make_socket(addr)) { break; } } if (fd == -1) { return std::unexpected{Error::SYSCALL}; } assert(addr); current_addr = addr; } ev_io_set(&rev, fd, EV_READ); ev_io_set(&wev, fd, EV_WRITE); ev_io_start(worker->loop, &wev); if (config.is_quic()) { #ifdef ENABLE_HTTP3 ev_io_start(worker->loop, &rev); readfn = &Client::read_quic; writefn = &Client::write_quic; #endif // defined(ENABLE_HTTP3) } else { writefn = &Client::connected; } return {}; } void Client::timeout() { process_timedout_streams(); disconnect(); } void Client::restart_timeout() { if (worker->config->conn_inactivity_timeout > 0.) { ev_timer_again(worker->loop, &conn_inactivity_watcher); } } std::expected<void, Error> Client::try_again_or_fail() { disconnect(); if (new_connection_requested) { new_connection_requested = false; if (req_left) { if (worker->current_phase == Phase::MAIN_DURATION) { // At the moment, we don't have a facility to re-start request // already in in-flight. Make them fail. worker->stats.req_failed += req_inflight; worker->stats.req_error += req_inflight; req_inflight = 0; } else if (worker->current_phase == Phase::DURATION_OVER) { // fix a race condition when h2load is sending connection: close over h1 // prevents new clients from spawning after the test should have ended. return std::unexpected{Error::INTERNAL}; } // Keep using current address if (connect()) { return {}; } std::println(stderr, "client could not connect to host"); } } process_abandoned_streams(); return std::unexpected{Error::INTERNAL}; } void Client::fail() { disconnect(); process_abandoned_streams(); } void Client::disconnect() { record_client_end_time(); #ifdef ENABLE_HTTP3 if (config.is_quic()) { quic_close_connection(); } #endif // defined(ENABLE_HTTP3) #ifdef ENABLE_HTTP3 ev_timer_stop(worker->loop, &quic.pkt_timer); #endif // defined(ENABLE_HTTP3) ev_timer_stop(worker->loop, &conn_inactivity_watcher); ev_timer_stop(worker->loop, &conn_active_watcher); ev_timer_stop(worker->loop, &rps_watcher); ev_timer_stop(worker->loop, &request_timeout_watcher); streams.clear(); session.reset(); wb.reset(); state = CLIENT_IDLE; ev_io_stop(worker->loop, &wev); ev_io_stop(worker->loop, &rev); if (ssl) { if (config.is_quic()) { SSL_free(ssl); ssl = nullptr; } else { SSL_set_shutdown(ssl, SSL_get_shutdown(ssl) | SSL_RECEIVED_SHUTDOWN); ERR_clear_error(); if (SSL_shutdown(ssl) != 1) { SSL_free(ssl); ssl = nullptr; } } } if (fd != -1) { shutdown(fd, SHUT_WR); close(fd); fd = -1; } final = false; } std::expected<void, Error> Client::submit_request() { if (auto rv = session->submit_request(); !rv) { return rv; } if (worker->current_phase != Phase::MAIN_DURATION) { return {}; } ++worker->stats.req_started; ++req_started; ++req_inflight; if (!worker->config->is_timing_based_mode()) { --req_left; } // if an active timeout is set and this is the last request to be submitted // on this connection, start the active timeout. if (worker->config->conn_active_timeout > 0. && req_left == 0) { ev_timer_start(worker->loop, &conn_active_watcher); } return {}; } void Client::process_timedout_streams() { if (worker->current_phase != Phase::MAIN_DURATION) { return; } for (auto &p : streams) { auto &req_stat = p.second.req_stat; if (!req_stat.completed) { req_stat.stream_close_time = std::chrono::steady_clock::now(); } } worker->stats.req_timedout += req_inflight; process_abandoned_streams(); } void Client::process_abandoned_streams() { if (worker->current_phase != Phase::MAIN_DURATION) { return; } auto req_abandoned = req_inflight + req_left; worker->stats.req_failed += req_abandoned; worker->stats.req_error += req_abandoned; req_inflight = 0; req_left = 0; } void Client::process_request_failure() { if (worker->current_phase != Phase::MAIN_DURATION) { return; } worker->stats.req_failed += req_left; worker->stats.req_error += req_left; req_left = 0; if (req_inflight == 0) { (void)terminate_session(); } std::println("Process Request Failure: {}", worker->stats.req_failed); } namespace { #if OPENSSL_3_0_0_API std::string pkey_get_group_name(EVP_PKEY *pkey) { std::array<char, 64> name; size_t nwrite; if (!EVP_PKEY_get_group_name(pkey, name.data(), name.size(), &nwrite)) { return ""s; } return name.data(); } #else // !OPENSSL_3_0_0_API std::string_view pkey_get_group_name(EVP_PKEY *pkey) { auto nid = EVP_PKEY_id(pkey); if (nid == EVP_PKEY_EC) { auto ec = EVP_PKEY_get0_EC_KEY(pkey); nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec)); } auto cname = EC_curve_nid2nist(nid); if (cname) { return cname; } cname = OBJ_nid2sn(nid); if (cname) { return cname; } return ""sv; } #endif // !OPENSSL_3_0_0_API } // namespace namespace { std::string_view get_negotiated_group_name(SSL *ssl) { #if OPENSSL_3_5_0_API auto name = SSL_get0_group_name(ssl); if (!name) { return ""sv; } return name; #elif OPENSSL_3_0_0_API auto name = SSL_group_to_name(ssl, static_cast<int>(SSL_get_negotiated_group(ssl))); if (!name) { return ""sv; } return name; #elif defined(NGHTTP2_OPENSSL_IS_BORINGSSL) auto name = SSL_get_group_name(SSL_get_group_id(ssl)); if (!name) { return ""sv; } return name; #elif defined(NGHTTP2_OPENSSL_IS_WOLFSSL) auto name = wolfSSL_get_curve_name(ssl); if (!name) { return ""sv; } return name; #elif defined(NGHTTP2_OPENSSL_IS_LIBRESSL) return ""sv; #else // !OPENSSL_3_5_0_API && !OPENSSL_3_0_0_API && // !defined(NGHTTP2_OPENSSL_IS_BORINGSSL) && // !defined(NGHTTP2_OPENSSL_IS_WOLFSSL) && // !defined(NGHTTP2_OPENSSL_IS_LIBRESSL) EVP_PKEY *pkey; if (!SSL_get_tmp_key(ssl, &pkey)) { return ""sv; } auto key_del = defer([pkey] { EVP_PKEY_free(pkey); }); return pkey_get_group_name(pkey); #endif // !OPENSSL_3_5_0_API && !OPENSSL_3_0_0_API && // !defined(NGHTTP2_OPENSSL_IS_BORINGSSL) && // !defined(NGHTTP2_OPENSSL_IS_WOLFSSL) && // !defined(NGHTTP2_OPENSSL_IS_LIBRESSL) } } // namespace #ifndef NGHTTP2_OPENSSL_IS_BORINGSSL namespace { void print_server_tmp_key(SSL *ssl) { EVP_PKEY *key; if (!SSL_get_server_tmp_key(ssl, &key)) { return; } auto key_del = defer([key] { EVP_PKEY_free(key); }); static constexpr auto title = "Server Temp Key:"sv; auto pkey_id = EVP_PKEY_id(key); switch (pkey_id) { case EVP_PKEY_RSA: std::println("{} RSA {} bits", title, EVP_PKEY_bits(key)); break; case EVP_PKEY_DH: std::println("{} DH {} bits", title, EVP_PKEY_bits(key)); break; case EVP_PKEY_EC: { auto group = pkey_get_group_name(key); if (group.empty()) { group = "<unknown>"sv; } std::println("{} ECDH {} {} bits", title, group, EVP_PKEY_bits(key)); break; } default: std::println("{} {} {} bits", title, OBJ_nid2sn(pkey_id), EVP_PKEY_bits(key)); break; } } } // namespace #endif // !defined(NGHTTP2_OPENSSL_IS_BORINGSSL) namespace { void print_server_cert(SSL *ssl) { #if OPENSSL_3_0_0_API auto cert = SSL_get0_peer_certificate(ssl); #else // !OPENSSL_3_0_0_API auto cert = SSL_get_peer_certificate(ssl); #endif // !OPENSSL_3_0_0_API if (!cert) { return; } #if !OPENSSL_3_0_0_API auto cert_d = defer([cert] { X509_free(cert); }); #endif // !OPENSSL_3_0_0_API auto pkey = X509_get0_pubkey(cert); if (!pkey) { return; } #ifdef NGHTTP2_OPENSSL_IS_WOLFSSL auto pkey_d = defer([pkey] { // X509_get0_pubkey is mapped to wolfSSL_X509_get_pubkey, which // increases the reference count despite the name "get0" suggests. EVP_PKEY_free(pkey); }); #endif // defined(NGHTTP2_OPENSSL_IS_WOLFSSL) static constexpr auto title = "Certificate:"sv; switch (EVP_PKEY_id(pkey)) { case EVP_PKEY_RSA: std::println("{} RSA {} bits", title, EVP_PKEY_bits(pkey)); break; case EVP_PKEY_EC: std::println("{} ECDSA {} {} bits", title, pkey_get_group_name(pkey), EVP_PKEY_bits(pkey)); break; #ifdef NGHTTP2_GENUINE_OPENSSL case EVP_PKEY_ED448: std::println("{} ED448 {} bits", title, EVP_PKEY_bits(pkey)); break; case EVP_PKEY_ED25519: std::println("{} ED25519 {} bits", title, EVP_PKEY_bits(pkey)); break; #endif // defined(NGHTTP2_GENUINE_OPENSSL) default: #if OPENSSL_3_0_0_API if (auto name = EVP_PKEY_get0_type_name(pkey); name) { std::println("{} {} {} bits", title, name, EVP_PKEY_bits(pkey)); break; } #endif // OPENSSL_3_0_0_API std::println("{} <unknown> {} bits", title, EVP_PKEY_bits(pkey)); } } } // namespace namespace { void print_negotiated_group(SSL *ssl) { std::println("Negotiated Group: {}", get_negotiated_group_name(ssl)); } } // namespace void Client::report_tls_info() { if (worker->id == 0 && !worker->tls_info_report_done) { worker->tls_info_report_done = true; auto cipher = SSL_get_current_cipher(ssl); std::println("TLS Protocol: {}", tls::get_tls_protocol(ssl)); std::println("Cipher: {}", SSL_CIPHER_get_name(cipher)); #ifndef NGHTTP2_OPENSSL_IS_BORINGSSL print_server_tmp_key(ssl); #endif // !defined(NGHTTP2_OPENSSL_IS_BORINGSSL) print_server_cert(ssl); print_negotiated_group(ssl); std::println("Resumption: {}", SSL_session_reused(ssl) ? "yes"sv : "no"sv); } } void Client::report_app_info() { if (worker->id == 0 && !worker->app_info_report_done) { worker->app_info_report_done = true; std::println("Application protocol: {}", selected_proto); } } std::expected<void, Error> Client::terminate_session() { #ifdef ENABLE_HTTP3 if (config.is_quic()) { quic.close_requested = true; } #endif // defined(ENABLE_HTTP3) if (session) { session->terminate(); } else { return std::unexpected{Error::INTERNAL}; } // http1 session needs writecb to tear down session. signal_write(); return {}; } void Client::on_request(int64_t stream_id) { streams[stream_id] = Stream(); } void Client::on_header(int64_t stream_id, std::span<const uint8_t> name, std::span<const uint8_t> value) { auto itr = streams.find(stream_id); if (itr == std::ranges::end(streams)) { return; } auto &stream = (*itr).second; if (worker->current_phase != Phase::MAIN_DURATION) { // If the stream is for warm-up phase, then mark as a success // But we do not update the count for 2xx, 3xx, etc status codes // Same has been done in on_status_code function stream.status_success = 1; return; } if (stream.status_success == -1 && name.size() == 7 && ":status"sv == as_string_view(name)) { int status = 0; for (auto c : value) { if (util::is_digit(static_cast<char>(c))) { status *= 10; status += c - '0'; if (status > 999) { stream.status_success = 0; return; } } else { break; } } if (status < 200) { return; } stream.req_stat.status = status; if (status >= 200 && status < 300) { ++worker->stats.status[2]; stream.status_success = 1; } else if (status < 400) { ++worker->stats.status[3]; stream.status_success = 1; } else if (status < 600) { ++worker->stats.status[static_cast<size_t>(status / 100)]; stream.status_success = 0; } else { stream.status_success = 0; } } } void Client::on_status_code(int64_t stream_id, uint16_t status) { auto itr = streams.find(stream_id); if (itr == std::ranges::end(streams)) { return; } auto &stream = (*itr).second; if (worker->current_phase != Phase::MAIN_DURATION) { stream.status_success = 1; return; } stream.req_stat.status = status; if (status >= 200 && status < 300) { ++worker->stats.status[2]; stream.status_success = 1; } else if (status < 400) { ++worker->stats.status[3]; stream.status_success = 1; } else if (status < 600) { ++worker->stats.status[status / 100]; stream.status_success = 0; } else { stream.status_success = 0; } } void Client::on_stream_close(int64_t stream_id, bool success, bool final) { if (worker->current_phase == Phase::MAIN_DURATION) { if (req_inflight > 0) { --req_inflight; } auto req_stat = get_req_stat(stream_id); if (!req_stat) { return; } req_stat->stream_close_time = std::chrono::steady_clock::now(); if (success) { req_stat->completed = true; ++worker->stats.req_success; ++cstat.req_success; if (streams[stream_id].status_success == 1) { ++worker->stats.req_status_success; } else { ++worker->stats.req_failed; } worker->sample_req_stat(req_stat); // Count up in successful cases only ++worker->request_times_smp.n; } else { ++worker->stats.req_failed; ++worker->stats.req_error; } ++worker->stats.req_done; ++req_done; if (worker->config->log_fd != -1) { auto start = std::chrono::duration_cast<std::chrono::microseconds>( req_stat->request_wall_time.time_since_epoch()); auto delta = std::chrono::duration_cast<std::chrono::microseconds>( req_stat->stream_close_time - req_stat->request_time); std::array<uint8_t, 256> buf; auto p = std::ranges::begin(buf); p = util::utos(as_unsigned(start.count()), p); *p++ = '\t'; if (success) { p = util::utos(as_unsigned(req_stat->status), p); } else { *p++ = '-'; *p++ = '1'; } *p++ = '\t'; p = util::utos(as_unsigned(delta.count()), p); *p++ = '\n'; auto nwrite = static_cast<size_t>(std::ranges::distance(std::ranges::begin(buf), p)); assert(nwrite <= buf.size()); while (write(worker->config->log_fd, buf.data(), nwrite) == -1 && errno == EINTR) ; } } worker->report_progress(); streams.erase(stream_id); if (req_left == 0 && req_inflight == 0) { (void)terminate_session(); return; } if (!final && req_left > 0) { if (config.timing_script) { if (!ev_is_active(&request_timeout_watcher)) { ev_feed_event(worker->loop, &request_timeout_watcher, EV_TIMER); } } else if (!config.rps_enabled()) { if (!submit_request()) { process_request_failure(); } } else if (rps_req_pending) { --rps_req_pending; if (!submit_request()) { process_request_failure(); } } else { assert(rps_req_inflight); --rps_req_inflight; } } } RequestStat *Client::get_req_stat(int64_t stream_id) { auto it = streams.find(stream_id); if (it == std::ranges::end(streams)) { return nullptr; } return &(*it).second.req_stat; } std::expected<void, Error> Client::connection_made() { if (ssl) { report_tls_info(); const unsigned char *next_proto = nullptr; unsigned int next_proto_len; SSL_get0_alpn_selected(ssl, &next_proto, &next_proto_len); if (next_proto) { auto proto = as_string_view(next_proto, next_proto_len); if (config.is_quic()) { #ifdef ENABLE_HTTP3 assert(session); if ("h3"sv != proto && "h3-29"sv != proto) { return std::unexpected{Error::ALPN}; } #endif // defined(ENABLE_HTTP3) } else if (util::check_h2_is_selected(proto)) { session = std::make_unique<Http2Session>(this); } else if (NGHTTP2_H1_1 == proto) { session = std::make_unique<Http1Session>(this); } // Just assign next_proto to selected_proto anyway to show the // negotiation result. selected_proto = proto; } else if (config.is_quic()) { std::println(stderr, "QUIC requires ALPN negotiation"); return std::unexpected{Error::ALPN}; } else { std::println( "No protocol negotiated. Fallback behaviour may be activated"); for (const auto &proto : config.alpn_list) { if (NGHTTP2_H1_1_ALPN == proto) { std::println( "Server does not support ALPN. Falling back to HTTP/1.1."); session = std::make_unique<Http1Session>(this); selected_proto = NGHTTP2_H1_1; break; } } } if (!selected_proto.empty()) { report_app_info(); } if (!session) { std::println( "No supported protocol was negotiated. Supported protocols were:"); for (const auto &proto : config.alpn_list) { std::println("{}", proto.substr(1)); } disconnect(); return std::unexpected{Error::ALPN}; } } else { switch (config.no_tls_proto) { case Config::PROTO_HTTP2: session = std::make_unique<Http2Session>(this); selected_proto = NGHTTP2_CLEARTEXT_PROTO_VERSION_ID; break; case Config::PROTO_HTTP1_1: session = std::make_unique<Http1Session>(this); selected_proto = NGHTTP2_H1_1; break; default: // unreachable assert(0); } report_app_info(); } state = CLIENT_CONNECTED; session->on_connect(); record_connect_time(); if (config.rps_enabled()) { rps_watcher.repeat = std::max(0.01, 1. / config.rps); ev_timer_again(worker->loop, &rps_watcher); rps_duration_started = std::chrono::steady_clock::now(); } if (config.rps_enabled()) { assert(req_left); ++rps_req_inflight; if (!submit_request()) { process_request_failure(); } } else if (!config.timing_script) { auto nreq = config.is_timing_based_mode() ? std::max(req_left, session->max_concurrent_streams()) : std::min(req_left, session->max_concurrent_streams()); for (; nreq > 0; --nreq) { if (!submit_request()) { process_request_failure(); break; } } } else { auto duration = config.timings[reqidx]; while (duration < std::chrono::duration<double>(1e-9)) { if (!submit_request()) { process_request_failure(); break; } duration = config.timings[reqidx]; if (reqidx == 0) { // if reqidx wraps around back to 0, we uses up all lines and // should break break; } } if (duration >= std::chrono::duration<double>(1e-9)) { // double check since we may have break due to reqidx wraps // around back to 0 request_timeout_watcher.repeat = util::ev_tstamp_from(duration); ev_timer_again(worker->loop, &request_timeout_watcher); } } signal_write(); return {}; } std::expected<void, Error> Client::on_read(std::span<const uint8_t> data) { auto rv = session->on_read(data); if (worker->current_phase == Phase::MAIN_DURATION) { worker->stats.bytes_total += data.size(); } if (!rv) { return rv; } signal_write(); return {}; } std::expected<void, Error> Client::on_write() { if (wb.rleft() >= BACKOFF_WRITE_BUFFER_THRES) { return {}; } return session->on_write(); } std::expected<void, Error> Client::read_clear() { std::array<uint8_t, 8_k> rawbuf; auto buf = std::span<uint8_t>{rawbuf}; for (;;) { ssize_t nread; while ((nread = read(fd, buf.data(), buf.size())) == -1 && errno == EINTR) ; if (nread == -1) { if (errno == EAGAIN || errno == EWOULDBLOCK) { return {}; } return std::unexpected{Error::SYSCALL}; } if (nread == 0) { return std::unexpected{Error::RECV_EOF}; } if (auto rv = on_read(buf.first(as_unsigned(nread))); !rv) { return rv; } } return {}; } std::expected<void, Error> Client::write_clear() { std::array<struct iovec, 2> iovbuf; for (;;) { if (auto rv = on_write(); !rv) { return rv; } auto iov = wb.riovec(iovbuf); if (iov.empty()) { break; } ssize_t nwrite; while ((nwrite = writev(fd, iov.data(), static_cast<int>(iov.size()))) == -1 && errno == EINTR) ; if (nwrite == -1) { if (errno == EAGAIN || errno == EWOULDBLOCK) { ev_io_start(worker->loop, &wev); return {}; } return std::unexpected{Error::SYSCALL}; } wb.drain(as_unsigned(nwrite)); } ev_io_stop(worker->loop, &wev); return {}; } std::expected<void, Error> Client::connected() { if (!util::check_socket_connected(fd)) { return std::unexpected{Error::CONNECT_FAIL}; } ev_io_start(worker->loop, &rev); ev_io_stop(worker->loop, &wev); if (ssl) { SSL_set_fd(ssl, fd); readfn = &Client::tls_handshake; writefn = &Client::tls_handshake; return do_write(); } readfn = &Client::read_clear; writefn = &Client::write_clear; return connection_made(); } std::expected<void, Error> Client::tls_handshake() { ERR_clear_error(); auto rv = SSL_do_handshake(ssl); if (rv <= 0) { auto err = SSL_get_error(ssl, rv); switch (err) { case SSL_ERROR_WANT_READ: ev_io_stop(worker->loop, &wev); return {}; case SSL_ERROR_WANT_WRITE: ev_io_start(worker->loop, &wev); return {}; default: return std::unexpected{Error::CRYPTO}; } } ev_io_stop(worker->loop, &wev); readfn = &Client::read_tls; writefn = &Client::write_tls; return connection_made(); } std::expected<void, Error> Client::read_tls() { std::array<uint8_t, 8_k> rawbuf; ERR_clear_error(); auto buf = std::span<uint8_t>{rawbuf}; for (;;) { auto nread = SSL_read(ssl, buf.data(), static_cast<int>(buf.size())); if (nread <= 0) { auto err = SSL_get_error(ssl, nread); switch (err) { case SSL_ERROR_WANT_READ: return {}; case SSL_ERROR_WANT_WRITE: // renegotiation started default: return std::unexpected{Error::CRYPTO}; } } if (auto rv = on_read(buf.first(static_cast<size_t>(nread))); !rv) { return rv; } } } std::expected<void, Error> Client::write_tls() { ERR_clear_error(); for (;;) { if (auto rv = on_write(); !rv) { return rv; } auto data = wb.peek(); if (data.empty()) { break; } auto nwrite = SSL_write(ssl, data.data(), static_cast<int>(data.size())); if (nwrite <= 0) { auto err = SSL_get_error(ssl, nwrite); switch (err) { case SSL_ERROR_WANT_WRITE: ev_io_start(worker->loop, &wev); return {}; case SSL_ERROR_WANT_READ: // renegotiation started default: return std::unexpected{Error::CRYPTO}; } } wb.drain(static_cast<size_t>(nwrite)); } ev_io_stop(worker->loop, &wev); return {}; } #ifdef ENABLE_HTTP3 // Returns remaining bytes if sendmsg is blocked. std::span<const uint8_t> Client::write_udp(const sockaddr *addr, socklen_t addrlen, std::span<const uint8_t> data, size_t gso_size) { if (quic.tx.no_gso && data.size() > gso_size) { for (; !data.empty();) { auto len = std::min(data.size(), gso_size); if (!write_udp(addr, addrlen, data.first(len), len).empty()) { return data; } data = data.subspan(len); } return {}; } iovec msg_iov{ .iov_base = const_cast<uint8_t *>(data.data()), .iov_len = data.size(), }; msghdr msg{ .msg_name = const_cast<sockaddr *>(addr), .msg_namelen = addrlen, .msg_iov = &msg_iov, .msg_iovlen = 1, }; # ifdef UDP_SEGMENT std::array<uint8_t, CMSG_SPACE(sizeof(uint16_t))> msg_ctrl{}; if (data.size() > gso_size) { msg.msg_control = msg_ctrl.data(); msg.msg_controllen = msg_ctrl.size(); auto cm = CMSG_FIRSTHDR(&msg); cm->cmsg_level = SOL_UDP; cm->cmsg_type = UDP_SEGMENT; cm->cmsg_len = CMSG_LEN(sizeof(uint16_t)); auto n = static_cast<uint16_t>(gso_size); memcpy(CMSG_DATA(cm), &n, sizeof(n)); } # endif // defined(UDP_SEGMENT) auto nwrite = sendmsg(fd, &msg, 0); if (nwrite < 0) { if (errno == EAGAIN || errno == EWOULDBLOCK) { return data; } if (errno == EIO && !quic.tx.no_gso) { quic.tx.no_gso = true; return write_udp(addr, addrlen, data, gso_size); } std::println(stderr, "sendmsg: errno={}", errno); } else { worker->stats.udp_dgram_sent += (data.size() + gso_size - 1) / gso_size; } ev_io_stop(worker->loop, &wev); return {}; } #endif // defined(ENABLE_HTTP3) void Client::record_request_time(RequestStat *req_stat) { req_stat->request_time = std::chrono::steady_clock::now(); req_stat->request_wall_time = std::chrono::system_clock::now(); } void Client::record_connect_start_time() { cstat.connect_start_time = std::chrono::steady_clock::now(); } void Client::record_connect_time() { cstat.connect_time = std::chrono::steady_clock::now(); } void Client::record_ttfb() { if (recorded(cstat.ttfb)) { return; } cstat.ttfb = std::chrono::steady_clock::now(); } void Client::clear_connect_times() { cstat.connect_start_time = std::chrono::steady_clock::time_point(); cstat.connect_time = std::chrono::steady_clock::time_point(); cstat.ttfb = std::chrono::steady_clock::time_point(); } void Client::record_client_start_time() { // Record start time only once at the very first connection is going // to be made. if (recorded(cstat.client_start_time)) { return; } cstat.client_start_time = std::chrono::steady_clock::now(); } void Client::record_client_end_time() { // Unlike client_start_time, we overwrite client_end_time. This // handles multiple connect/disconnect for HTTP/1.1 benchmark. cstat.client_end_time = std::chrono::steady_clock::now(); } void Client::signal_write() { ev_io_start(worker->loop, &wev); } void Client::try_new_connection() { new_connection_requested = true; } uint32_t Client::get_id() const { return id; } namespace { unsigned int get_ev_loop_flags() { if (ev_supported_backends() & ~ev_recommended_backends() & EVBACKEND_KQUEUE) { return ev_recommended_backends() | EVBACKEND_KQUEUE; } return 0; } } // namespace Worker::Worker(uint32_t id, SSL_CTX *ssl_ctx, size_t req_todo, size_t nclients, size_t rate, size_t max_samples, Config *config) : randgen(util::make_mt19937()), stats(req_todo, nclients), loop(ev_loop_new(get_ev_loop_flags())), ssl_ctx(ssl_ctx), config(config), id(id), tls_info_report_done(false), app_info_report_done(false), nconns_made(0), nclients(nclients), nreqs_per_client(req_todo / nclients), nreqs_rem(req_todo % nclients), rate(rate), max_samples(max_samples), next_client_id(0) { if (!config->is_rate_mode() && !config->is_timing_based_mode()) { progress_interval = std::max(1UZ, req_todo / 10); } else { progress_interval = std::max(1UZ, nclients / 10); } // Below timeout is not needed in case of timing-based benchmarking // create timer that will go off every rate_period ev_timer_init(&timeout_watcher, rate_period_timeout_w_cb, 0., config->rate_period); timeout_watcher.data = this; if (config->is_timing_based_mode()) { stats.req_stats.reserve(std::max(req_todo, max_samples)); stats.client_stats.reserve(std::max(nclients, max_samples)); } else { stats.req_stats.reserve(std::min(req_todo, max_samples)); stats.client_stats.reserve(std::min(nclients, max_samples)); } sampling_init(request_times_smp, max_samples); sampling_init(client_smp, max_samples); sampling_init(gro_smp, max_samples); ev_timer_init(&duration_watcher, duration_timeout_cb, config->duration, 0.); duration_watcher.data = this; ev_timer_init(&warmup_watcher, warmup_timeout_cb, config->warm_up_time, 0.); warmup_watcher.data = this; if (config->is_timing_based_mode()) { current_phase = Phase::INITIAL_IDLE; } else { current_phase = Phase::MAIN_DURATION; } } Worker::~Worker() { if (tls_session) { SSL_SESSION_free(tls_session); } ev_timer_stop(loop, &timeout_watcher); ev_timer_stop(loop, &duration_watcher); ev_timer_stop(loop, &warmup_watcher); ev_loop_destroy(loop); } void Worker::stop_all_clients() { for (auto [_, client] : clients) { if (client) { if (!client->terminate_session()) { client->fail(); free_client(client); delete client; } } } } void Worker::free_client(Client *deleted_client) { auto it = clients.find(deleted_client->get_id()); if (it == std::ranges::end(clients)) { return; } auto &client = (*it).second; if (!client) { return; } client->req_todo = client->req_done; stats.req_todo += client->req_todo; client = nullptr; } void Worker::run() { if (!config->is_rate_mode() && !config->is_timing_based_mode()) { for (size_t i = 0; i < nclients; ++i) { auto req_todo = nreqs_per_client; if (nreqs_rem > 0) { ++req_todo; --nreqs_rem; } auto client = std::make_unique<Client>(next_client_id++, this, req_todo); if (!client->connect()) { std::println(stderr, "client could not connect to host"); client->fail(); } else { client.release(); } } } else if (config->is_rate_mode()) { ev_timer_again(loop, &timeout_watcher); // call callback so that we don't waste the first rate_period rate_period_timeout_w_cb(loop, &timeout_watcher, 0); } else { // call the callback to start for one single time rate_period_timeout_w_cb(loop, &timeout_watcher, 0); } ev_run(loop, 0); } namespace { template <typename Stats, typename Stat> void sample(Sampling &smp, Stats &stats, Stat *s) { ++smp.n; if (stats.size() < smp.max_samples) { stats.push_back(*s); return; } auto d = std::uniform_int_distribution<unsigned long>(0, smp.n - 1); auto i = d(gen); if (i < smp.max_samples) { stats[i] = *s; } } } // namespace void Worker::sample_req_stat(RequestStat *req_stat) { sample(request_times_smp, stats.req_stats, req_stat); } void Worker::sample_client_stat(ClientStat *cstat) { sample(client_smp, stats.client_stats, cstat); } void Worker::sample_gro_stat(const GROStat &gro_stat) { sample(gro_smp, stats.gro_stats, &gro_stat); } void Worker::report_progress() { if (id != 0 || config->is_rate_mode() || stats.req_done % progress_interval || config->is_timing_based_mode()) { return; } std::println("progress: {}% done", stats.req_done * 100 / stats.req_todo); } void Worker::report_rate_progress() { if (id != 0 || nconns_made % progress_interval) { return; } std::println("progress: {}% of clients started", nconns_made * 100 / nclients); } void Worker::write_tls_session(const std::string &path) { if (!tls_session) { return; } #ifdef NGHTTP2_OPENSSL_IS_WOLFSSL auto datalen = wolfSSL_i2d_SSL_SESSION(tls_session, nullptr); if (datalen <= 0) { std::println(stderr, "Could not write TLS session to {}", path); return; } auto data = std::make_unique_for_overwrite<uint8_t[]>(static_cast<size_t>(datalen)); auto p = data.get(); datalen = wolfSSL_i2d_SSL_SESSION(tls_session, &p); assert(datalen > 0); auto f = wolfSSL_BIO_new_file(path.c_str(), "w"); if (!f) { std::println(stderr, "Could not write TLS session to {}", path); return; } if (!wolfSSL_PEM_write_bio(f, "WOLFSSL SESSION PARAMETERS", "", data.get(), datalen)) { std::println(stderr, "Could not write TLS session to {}", path); } wolfSSL_BIO_free(f); #else // !defined(NGHTTP2_OPENSSL_IS_WOLFSSL) auto f = BIO_new_file(path.c_str(), "w"); if (!f) { std::println(stderr, "Could not write TLS session to {}", path); return; } if (!PEM_write_bio_SSL_SESSION(f, tls_session)) { std::println(stderr, "Could not write TLS session to {}", path); } BIO_free(f); #endif // !defined(NGHTTP2_OPENSSL_IS_WOLFSSL) } namespace { int new_session_cb(SSL *ssl, SSL_SESSION *session) { auto worker = static_cast<Worker *>(SSL_get_ex_data(ssl, 1)); if (!worker || worker->id != 0 || worker->tls_session_store_done) { return 0; } worker->tls_session = session; worker->tls_session_store_done = true; return 1; } } // namespace namespace { // Returns percentage of number of samples within mean +/- sd. template <typename T> double within_sd(const std::vector<T> &samples, double mean, double sd) { if (samples.size() == 0) { return 0.0; } auto lower = mean - sd; auto upper = mean + sd; auto m = std::ranges::count_if( samples, [&lower, &upper](double t) { return lower <= t && t <= upper; }, [](auto t) { return static_cast<double>(t); }); return (static_cast<double>(m) / static_cast<double>(samples.size())) * 100; } } // namespace namespace { // Computes statistics using |samples|. The min, max, mean, sd, and // percentage of number of samples within mean +/- sd are computed. // If |sampling| is true, this computes sample variance. Otherwise, // population variance. template <typename T> SDStat<T> compute_time_stat(std::vector<T> samples, bool sampling = false) { if (samples.empty()) { return {}; } // standard deviation calculated using Rapid calculation method: // https://en.wikipedia.org/wiki/Standard_deviation#Rapid_calculation_methods double a = 0, q = 0; size_t n = 0; T sum = 0; auto res = SDStat<T>{std::numeric_limits<T>::max(), std::numeric_limits<T>::min()}; for (const auto &t : samples) { ++n; res.min = std::min(res.min, t); res.max = std::max(res.max, t); sum += t; auto d = static_cast<double>(t); auto na = a + (d - a) / static_cast<double>(n); q += (d - a) * (d - na); a = na; } assert(n > 0); res.mean = a; res.sd = sqrt(q / static_cast<double>(sampling && n > 1 ? n - 1 : n)); res.within_sd = within_sd(samples, res.mean, res.sd); if (samples.size() & 1) { res.median = samples[samples.size() / 2]; } else { auto half = samples.size() / 2; res.median = (samples[half - 1] + samples[half]) / 2; } res.p95 = samples[static_cast<size_t>(static_cast<double>(samples.size()) * 0.95)]; res.p99 = samples[static_cast<size_t>(static_cast<double>(samples.size()) * 0.99)]; res.samples = std::move(samples); return res; } } // namespace namespace { SDStats process_time_stats(const std::vector<std::unique_ptr<Worker>> &workers) { auto request_times_sampling = false; auto client_times_sampling = false; auto gro_pkts_sampling = false; size_t nrequest_times = 0; size_t nclient_times = 0; size_t ngro_pkts = 0; for (const auto &w : workers) { nrequest_times += w->stats.req_stats.size(); request_times_sampling = w->request_times_smp.n > w->stats.req_stats.size(); nclient_times += w->stats.client_stats.size(); client_times_sampling = w->client_smp.n > w->stats.client_stats.size(); ngro_pkts += w->stats.gro_stats.size(); gro_pkts_sampling = w->gro_smp.n > w->stats.gro_stats.size(); } std::vector<double> request_times; request_times.reserve(nrequest_times); std::vector<double> connect_times, ttfb_times, rps_values, min_rtt_times, smoothed_rtt_times; connect_times.reserve(nclient_times); ttfb_times.reserve(nclient_times); rps_values.reserve(nclient_times); std::vector<uint64_t> pkt_sent_values, pkt_recv_values, pkt_lost_values; if (config.is_quic()) { min_rtt_times.reserve(nclient_times); smoothed_rtt_times.reserve(nclient_times); pkt_sent_values.reserve(nclient_times); pkt_recv_values.reserve(nclient_times); pkt_lost_values.reserve(nclient_times); } std::vector<uint64_t> gro_pkts; if (config.is_quic()) { gro_pkts.reserve(ngro_pkts); } for (const auto &w : workers) { for (const auto &req_stat : w->stats.req_stats) { if (!req_stat.completed) { continue; } request_times.push_back( std::chrono::duration_cast<std::chrono::duration<double>>( req_stat.stream_close_time - req_stat.request_time) .count()); } const auto &stat = w->stats; for (const auto &cstat : stat.client_stats) { if (recorded(cstat.client_start_time) && recorded(cstat.client_end_time)) { auto t = std::chrono::duration_cast<std::chrono::duration<double>>( cstat.client_end_time - cstat.client_start_time) .count(); if (t > 1e-9) { rps_values.push_back(static_cast<double>(cstat.req_success) / t); } } if (config.is_quic()) { min_rtt_times.push_back( std::chrono::duration<double>(cstat.min_rtt).count()); smoothed_rtt_times.push_back( std::chrono::duration<double>(cstat.smoothed_rtt).count()); pkt_sent_values.push_back(cstat.pkt_sent); pkt_recv_values.push_back(cstat.pkt_recv); pkt_lost_values.push_back(cstat.pkt_lost); } // We will get connect event before FFTB. if (!recorded(cstat.connect_start_time) || !recorded(cstat.connect_time)) { continue; } connect_times.push_back( std::chrono::duration_cast<std::chrono::duration<double>>( cstat.connect_time - cstat.connect_start_time) .count()); if (!recorded(cstat.ttfb)) { continue; } ttfb_times.push_back( std::chrono::duration_cast<std::chrono::duration<double>>( cstat.ttfb - cstat.connect_start_time) .count()); } if (config.is_quic()) { for (const auto &gstat : stat.gro_stats) { gro_pkts.push_back(gstat.num_pkts); } } } std::ranges::sort(request_times); std::ranges::sort(connect_times); std::ranges::sort(ttfb_times); std::ranges::sort(rps_values); if (config.is_quic()) { std::ranges::sort(min_rtt_times); std::ranges::sort(smoothed_rtt_times); std::ranges::sort(pkt_sent_values); std::ranges::sort(pkt_recv_values); std::ranges::sort(pkt_lost_values); std::ranges::sort(gro_pkts); } return { .request = compute_time_stat(std::move(request_times), request_times_sampling), .connect = compute_time_stat(std::move(connect_times), client_times_sampling), .ttfb = compute_time_stat(std::move(ttfb_times), client_times_sampling), .rps = compute_time_stat(std::move(rps_values), client_times_sampling), .min_rtt = compute_time_stat(std::move(min_rtt_times), client_times_sampling), .smoothed_rtt = compute_time_stat(std::move(smoothed_rtt_times), client_times_sampling), .pkt_sent = compute_time_stat(std::move(pkt_sent_values), client_times_sampling), .pkt_recv = compute_time_stat(std::move(pkt_recv_values), client_times_sampling), .pkt_lost = compute_time_stat(std::move(pkt_lost_values), client_times_sampling), .gro_pkts = compute_time_stat(std::move(gro_pkts), gro_pkts_sampling), }; } } // namespace namespace { void resolve_host() { if (config.base_uri_unix) { auto res = std::make_unique<addrinfo>(); res->ai_family = config.unix_addr.sun_family; res->ai_socktype = SOCK_STREAM; res->ai_addrlen = sizeof(config.unix_addr); res->ai_addr = static_cast<struct sockaddr *>(static_cast<void *>(&config.unix_addr)); config.addrs = res.release(); return; } int rv; addrinfo *res; addrinfo hints{ .ai_flags = AI_ADDRCONFIG, .ai_family = AF_UNSPEC, .ai_socktype = SOCK_STREAM, }; const auto &resolve_host = config.connect_to_host.empty() ? config.host : config.connect_to_host; auto port = config.connect_to_port == 0 ? config.port : config.connect_to_port; rv = getaddrinfo(resolve_host.c_str(), util::utos(port).c_str(), &hints, &res); if (rv != 0) { std::println(stderr, "getaddrinfo() failed: {}", gai_strerror(rv)); exit(EXIT_FAILURE); } if (res == nullptr) { std::println(stderr, "No address returned"); exit(EXIT_FAILURE); } config.addrs = res; } } // namespace namespace { std::string get_reqline(const char *uri, const urlparse_url &u) { std::string reqline; if (util::has_uri_field(u, URLPARSE_PATH)) { reqline = util::get_uri_field(uri, u, URLPARSE_PATH); } else { reqline = "/"; } if (util::has_uri_field(u, URLPARSE_QUERY)) { reqline += '?'; reqline += util::get_uri_field(uri, u, URLPARSE_QUERY); } return reqline; } } // namespace constexpr auto UNIX_PATH_PREFIX = "unix:"sv; namespace { bool parse_base_uri(std::string_view base_uri) { urlparse_url u; if (urlparse_parse_url(base_uri.data(), base_uri.size(), 0, &u) != 0 || !util::has_uri_field(u, URLPARSE_SCHEMA) || !util::has_uri_field(u, URLPARSE_HOST)) { return false; } config.scheme = util::get_uri_field(base_uri.data(), u, URLPARSE_SCHEMA); config.host = util::get_uri_field(base_uri.data(), u, URLPARSE_HOST); config.default_port = util::get_default_port(base_uri.data(), u); if (util::has_uri_field(u, URLPARSE_PORT)) { config.port = u.port; } else { config.port = config.default_port; } return true; } } // namespace namespace { // Use std::vector<std::string>::iterator explicitly, without that, // urlparse_url u{} fails with clang-3.4. std::vector<std::string> parse_uris(std::vector<std::string>::iterator first, std::vector<std::string>::iterator last) { std::vector<std::string> reqlines; if (first == last) { std::println(stderr, "no URI available"); exit(EXIT_FAILURE); } if (!config.has_base_uri()) { if (!parse_base_uri(*first)) { std::println(stderr, "invalid URI: {}", *first); exit(EXIT_FAILURE); } config.base_uri = *first; } for (; first != last; ++first) { urlparse_url u; auto uri = (*first).c_str(); if (urlparse_parse_url(uri, (*first).size(), 0, &u) != 0) { std::println(stderr, "invalid URI: {}", uri); exit(EXIT_FAILURE); } reqlines.push_back(get_reqline(uri, u)); } return reqlines; } } // namespace namespace { std::vector<std::string> read_uri_from_file(std::istream &infile) { std::vector<std::string> uris; std::string line_uri; while (std::getline(infile, line_uri)) { uris.push_back(line_uri); } return uris; } } // namespace namespace { void read_script_from_file( std::istream &infile, std::vector<std::chrono::steady_clock::duration> &timings, std::vector<std::string> &uris) { std::string script_line; int line_count = 0; while (std::getline(infile, script_line)) { line_count++; if (script_line.empty()) { std::println(stderr, "Empty line detected at line {}. Ignoring and continuing.", line_count); continue; } std::size_t pos = script_line.find("\t"); if (pos == std::string::npos) { std::println( stderr, "Invalid line format detected, no tab character at line {}. \n\t{}", line_count, script_line); exit(EXIT_FAILURE); } const char *start = script_line.c_str(); char *end; auto v = std::strtod(start, &end); errno = 0; if (v < 0.0 || !std::isfinite(v) || end == start || errno != 0) { auto error = errno; std::println(stderr, "Time value error at line {}. \n\tvalue = {}", line_count, script_line.substr(0, pos)); if (error != 0) { std::println(stderr, "\t{}", strerror(error)); } exit(EXIT_FAILURE); } timings.emplace_back( std::chrono::duration_cast<std::chrono::steady_clock::duration>( std::chrono::duration<double, std::milli>(v))); uris.push_back(script_line.substr(pos + 1, script_line.size())); } } } // namespace namespace { std::unique_ptr<Worker> create_worker(uint32_t id, SSL_CTX *ssl_ctx, size_t nreqs, size_t nclients, size_t rate, size_t max_samples) { if (config.is_timing_based_mode()) { std::println( "spawning thread #{}: {} total client(s). Timing-based test with {}s of " "warm-up time and {}s of main duration for measurements.", id, nclients, config.warm_up_time, config.duration); } else { std::print("spawning thread #{}: {} total client(s).", id, nclients); if (config.is_rate_mode() && nclients > rate) { std::print(" Up to {} client(s) will be created every {}", rate, util::duration_str(config.rate_period)); } std::println(" {} total requests", nreqs); } if (config.is_rate_mode()) { return std::make_unique<Worker>(id, ssl_ctx, nreqs, nclients, rate, max_samples, &config); } else { // Here rate is same as client because the rate_timeout callback // will be called only once return std::make_unique<Worker>(id, ssl_ctx, nreqs, nclients, nclients, max_samples, &config); } } } // namespace namespace { int parse_header_table_size(uint32_t &dst, const char *opt, const char *optarg) { auto n = util::parse_uint_with_unit(optarg); if (!n) { std::println(stderr, "--{}: Bad option value: {}", opt, optarg); return -1; } if (*n > std::numeric_limits<uint32_t>::max()) { std::println( stderr, "--{}: Value too large. It should be less than or equal to {}", opt, std::numeric_limits<uint32_t>::max()); return -1; } dst = static_cast<uint32_t>(*n); return 0; } } // namespace namespace { std::string make_http_authority(const Config &config) { std::string host; if (util::numeric_host(config.host.c_str(), AF_INET6)) { host += '['; host += config.host; host += ']'; } else { host = config.host; } if (config.port != config.default_port) { host += ':'; host += util::utos(config.port); } return host; } } // namespace namespace { // plot_histogram plots histogram. It assumes that data is sorted in // ascending order. template <typename F, typename T> requires std::invocable<F, double> void plot_histogram(FILE *o, const std::vector<T> &data, F formatter) { if (data.empty()) { return; } constexpr size_t nbkts = 10; constexpr size_t max_bar = 40; auto min = static_cast<double>(data[0]); auto max = static_cast<double>(data.back()); if (min == max) { return; } auto range = max - min; auto width = range / nbkts; std::vector<size_t> counts(nbkts, 0); for (auto v : data) { auto idx = static_cast<size_t>((static_cast<double>(v) - min) / width); if (idx >= nbkts) { idx = counts.size() - 1; } ++counts[idx]; } auto max_count = *std::ranges::max_element(counts); size_t cum_counts = 0; for (size_t i = 0; i < counts.size(); ++i) { auto lower = min + static_cast<double>(i) * width; auto upper = min + static_cast<double>(i + 1) * width; cum_counts += counts[i]; size_t len; if (counts[i]) { len = std::max(1UZ, counts[i] * max_bar / max_count); } else { len = 0; } std::println(o, "{:>10}-{:>10} [{:/<{}}{:{}}]({:6.2f}/{:6.2f}%)", formatter(lower), formatter(upper), "", len, "", max_bar - len, static_cast<double>(counts[i]) * 100. / static_cast<double>(data.size()), static_cast<double>(cum_counts) * 100. / static_cast<double>(data.size())); } } } // namespace namespace { template <typename F, typename T> void output_sd_stat(FILE *o, std::string_view title, const SDStat<T> &st, F formatter) { std::println( o, "{:12}: {:>10} {:>10} {:>10} {:>10} {:>10} {:>10} {:>10}{:>9}%", title, formatter(st.min), formatter(st.max), formatter(st.median), formatter(st.p95), formatter(st.p99), formatter(st.mean), formatter(st.sd), util::dtos(st.within_sd)); if (config.histogram) { plot_histogram(o, st.samples, formatter); } } } // namespace namespace { template <typename T> void output_sd_stat_duration(FILE *o, std::string_view title, const SDStat<T> &st) { output_sd_stat(o, title, st, [](auto v) { return util::format_duration(v); }); } } // namespace namespace { template <typename T> void output_sd_stat(FILE *o, std::string_view title, const SDStat<T> &st) { output_sd_stat(o, title, st, [](auto v) { if constexpr (std::integral<decltype(v)>) { return util::utos(v); } else { return util::dtos(v); } }); } } // namespace namespace { std::expected<SSL_SESSION *, Error> read_tls_session(const std::string &path) { #ifdef NGHTTP2_OPENSSL_IS_WOLFSSL auto f = wolfSSL_BIO_new_file(path.c_str(), "r"); if (!f) { std::println(stderr, "Could not read TLS session file from {}", path); return std::unexpected{Error::IO}; } auto f_del = defer([f] { wolfSSL_BIO_free(f); }); char *name, *header; uint8_t *data; long datalen; if (!wolfSSL_PEM_read_bio(f, &name, &header, &data, &datalen)) { std::println(stderr, "Could not read TLS session file from {}", path); return std::unexpected{Error::IO}; } auto data_del = defer([name, header, data] { wolfSSL_OPENSSL_free(name); wolfSSL_OPENSSL_free(header); wolfSSL_OPENSSL_free(data); }); if ("WOLFSSL SESSION PARAMETERS"sv != name) { std::println(stderr, "Could not read TLS session file from {}", path); return std::unexpected{Error::INVALID_PEM_TYPE}; } const uint8_t *pdata = data; auto session = wolfSSL_d2i_SSL_SESSION(nullptr, &pdata, datalen); if (!session) { std::println(stderr, "Could not read TLS session file from {}", path); return std::unexpected{Error::CRYPTO}; } return session; #else // !defined(NGHTTP2_OPENSSL_IS_WOLFSSL) auto f = BIO_new_file(path.c_str(), "r"); if (!f) { std::println(stderr, "Could not read TLS session file from {}", path); return std::unexpected{Error::IO}; } auto session = PEM_read_bio_SSL_SESSION(f, nullptr, 0, nullptr); BIO_free(f); if (!session) { std::println(stderr, "Could not read TLS session file from {}", path); return std::unexpected{Error::IO}; } return session; #endif // !defined(NGHTTP2_OPENSSL_IS_WOLFSSL) } } // namespace namespace { template <typename T> void write_sd_stat_result(std::ostream &o, std::string_view title, const SDStat<T> &st) { o << R"(")" << title << R"(":{)" << R"("min":)" << st.min << "," << R"("max":)" << st.max << "," << R"("median":)" << st.median << "," << R"("p95":)" << st.p95 << "," << R"("p99":)" << st.p99 << "," << R"("mean":)" << st.mean << "," << R"("sd":)" << st.sd << "," << R"("within_sd":)" << st.within_sd << "," << R"("samples":[)"; if (!st.samples.empty()) { o << st.samples[0]; for (size_t i = 1; i < st.samples.size(); ++i) { o << ',' << st.samples[i]; } } o << "]}"; } } // namespace namespace { void write_result(const std::string &path, std::chrono::duration<double> duration, double rps, int64_t bps, const Stats &stats, const SDStats &ts) { std::ofstream o{path}; if (!o) { std::println(stderr, "Could not write the result to file {}", path); return; } auto prec = o.precision(); auto guard = defer([&o, prec]() { o.precision(prec); }); o << std::setprecision(9) << R"({"version":"v1","metadata":{)" << R"("generator":"h2load )" << NGHTTP2_VERSION << R"(")" << "}," << R"("measurements":{)" << R"("duration":)" << duration.count() << "," << R"("request_per_second":)" << rps << "," << R"("bytes_per_second":)" << bps << "," << R"("requests":{)" << R"("total":)" << stats.req_todo << "," << R"("started":)" << stats.req_started << "," << R"("done":)" << stats.req_done << "," << R"("succeeded":)" << stats.req_status_success << "," << R"("failed":)" << stats.req_failed << "," << R"("errored":)" << stats.req_error << "," << R"("timeout":)" << stats.req_timedout << "}," << R"("status_codes":{)" << R"("2xx":)" << stats.status[2] << "," << R"("3xx":)" << stats.status[3] << "," << R"("4xx":)" << stats.status[4] << "," << R"("5xx":)" << stats.status[5] << "}," << R"("traffic":{)" << R"("total":)" << stats.bytes_total << "," << R"("headers":)" << stats.bytes_head << "," << R"("headers_decompressed":)" << stats.bytes_head_decomp << "," << R"("data":)" << stats.bytes_body << "},"; #ifdef ENABLE_HTTP3 if (config.is_quic()) { o << R"("udp_datagram":{)" << R"("sent":)" << stats.udp_dgram_sent << "," << R"("recv":)" << stats.udp_dgram_recv << "},"; } #endif // ENABLE_HTTP3 o << R"("performance":{)"; write_sd_stat_result(o, "request", ts.request); o << ","; write_sd_stat_result(o, "connect", ts.connect); o << ","; write_sd_stat_result(o, "ttfb", ts.ttfb); o << ","; write_sd_stat_result(o, "request_per_second", ts.rps); #ifdef ENABLE_HTTP3 if (config.is_quic()) { o << ","; write_sd_stat_result(o, "min_rtt", ts.min_rtt); o << ","; write_sd_stat_result(o, "smoothed_rtt", ts.smoothed_rtt); o << ","; write_sd_stat_result(o, "packets_sent", ts.pkt_sent); o << ","; write_sd_stat_result(o, "packets_recv", ts.pkt_recv); o << ","; write_sd_stat_result(o, "packets_lost", ts.pkt_lost); o << ","; write_sd_stat_result(o, "gro_packets", ts.gro_pkts); } #endif // ENABLE_HTTP3 o << "}}}"; } } // namespace namespace { void print_version() { std::println("h2load nghttp2/" NGHTTP2_VERSION); } } // namespace namespace { void print_usage(std::ostream &out) { out << R"(Usage: h2load [OPTIONS]... [URI]... benchmarking tool for HTTP/2 server)" << std::endl; } } // namespace constexpr auto DEFAULT_ALPN_LIST = "h2,http/1.1"sv; namespace { void print_help(std::ostream &out) { print_usage(out); auto config = Config(); out << R"( <URI> Specify URI to access. Multiple URIs can be specified. URIs are used in this order for each client. All URIs are used, then first URI is used and then 2nd URI, and so on. The scheme, host and port in the subsequent URIs, if present, are ignored. Those in the first URI are used solely. Definition of a base URI overrides all scheme, host or port values. Options: -n, --requests=<N> Number of requests across all clients. If it is used with --timing-script-file option, this option specifies the number of requests each client performs rather than the number of requests across all clients. This option is ignored if timing-based benchmarking is enabled (see --duration option). Default: )" << config.nreqs << R"( -c, --clients=<N> Number of concurrent clients. With -r option, this specifies the maximum number of connections to be made. Default: )" << config.nclients << R"( -t, --threads=<N> Number of native threads. Default: )" << config.nthreads << R"( -i, --input-file=<PATH> Path of a file with multiple URIs are separated by EOLs. This option will disable URIs getting from command-line. If '-' is given as <PATH>, URIs will be read from stdin. URIs are used in this order for each client. All URIs are used, then first URI is used and then 2nd URI, and so on. The scheme, host and port in the subsequent URIs, if present, are ignored. Those in the first URI are used solely. Definition of a base URI overrides all scheme, host or port values. -m, --max-concurrent-streams=<N> Max concurrent streams to issue per session. When http/1.1 is used, this specifies the number of HTTP pipelining requests in-flight. Default: 1 -f, --max-frame-size=<SIZE> Maximum frame size that the local endpoint is willing to receive. Default: )" << util::utos_unit(config.max_frame_size) << R"( -w, --window-bits=<N> Sets the stream level initial window size to (2**<N>)-1. For QUIC, <N> is capped to 26 (roughly 64MiB). It defaults to 24 (16MiB) for QUIC, and 30 for other protocols. -W, --connection-window-bits=<N> Sets the connection level initial window size to (2**<N>)-1. Default: )" << config.connection_window_bits << R"( -H, --header=<HEADER> Add/Override a header to the requests. --ciphers=<SUITE> Set allowed cipher list for TLSv1.2 or earlier. The format of the string is described in OpenSSL ciphers(1). Default: )" << config.ciphers << R"( --tls13-ciphers=<SUITE> Set allowed cipher list for TLSv1.3. The format of the string is described in OpenSSL ciphers(1). Default: )" << config.tls13_ciphers << R"( -p, --no-tls-proto=<PROTOID> Specify ALPN identifier of the protocol to be used when accessing http URI without SSL/TLS. Available protocols: )" << NGHTTP2_CLEARTEXT_PROTO_VERSION_ID << R"( and )" << NGHTTP2_H1_1 << R"( Default: )" << NGHTTP2_CLEARTEXT_PROTO_VERSION_ID << R"( -d, --data=<PATH> Post FILE to server. The request method is changed to POST. For http/1.1 connection, if -d is used, the maximum number of in-flight pipelined requests is set to 1. -r, --rate=<N> Specifies the fixed rate at which connections are created. The rate must be a positive integer, representing the number of connections to be made per rate period. The maximum number of connections to be made is given in -c option. This rate will be distributed among threads as evenly as possible. For example, with -t2 and -r4, each thread gets 2 connections per period. When the rate is 0, the program will run as it normally does, creating connections at whatever variable rate it wants. The default value for this option is 0. -r and -D are mutually exclusive. --rate-period=<DURATION> Specifies the time period between creating connections. The period must be a positive number, representing the length of the period in time. This option is ignored if the rate option is not used. The default value for this option is 1s. -D, --duration=<DURATION> Specifies the main duration for the measurements in case of timing-based benchmarking. -D and -r are mutually exclusive. --warm-up-time=<DURATION> Specifies the time period before starting the actual measurements, in case of timing-based benchmarking. Needs to provided along with -D option. -T, --connection-active-timeout=<DURATION> Specifies the maximum time that h2load is willing to keep a connection open, regardless of the activity on said connection. <DURATION> must be a positive integer, specifying the amount of time to wait. When no timeout value is set (either active or inactive), h2load will keep a connection open indefinitely, waiting for a response. -N, --connection-inactivity-timeout=<DURATION> Specifies the amount of time that h2load is willing to wait to see activity on a given connection. <DURATION> must be a positive integer, specifying the amount of time to wait. When no timeout value is set (either active or inactive), h2load will keep a connection open indefinitely, waiting for a response. --timing-script-file=<PATH> Path of a file containing one or more lines separated by EOLs. Each script line is composed of two tab-separated fields. The first field represents the time offset from the start of execution, expressed as a positive value of milliseconds with microsecond resolution. The second field represents the URI. This option will disable URIs getting from command-line. If '-' is given as <PATH>, script lines will be read from stdin. Script lines are used in order for each client. If -n is given, it must be less than or equal to the number of script lines, larger values are clamped to the number of script lines. If -n is not given, the number of requests will default to the number of script lines. The scheme, host and port defined in the first URI are used solely. Values contained in other URIs, if present, are ignored. Definition of a base URI overrides all scheme, host or port values. --timing-script-file and --rps are mutually exclusive. -B, --base-uri=(<URI>|unix:<PATH>) Specify URI from which the scheme, host and port will be used for all requests. The base URI overrides all values defined either at the command line or inside input files. If argument starts with "unix:", then the rest of the argument will be treated as UNIX domain socket path. The connection is made through that path instead of TCP. In this case, scheme is inferred from the first URI appeared in the command line or inside input files as usual. --alpn-list=<LIST> Comma delimited list of ALPN protocol identifier sorted in the order of preference. That means most desirable protocol comes first. The parameter must be delimited by a single comma only and any white spaces are treated as a part of protocol string. Default: )" << DEFAULT_ALPN_LIST << R"( --h1 Short hand for --alpn-list=http/1.1 --no-tls-proto=http/1.1, which effectively force http/1.1 for both http and https URI. --h3 Short hand for --alpn-list=h3, which effectively forces HTTP/3. --header-table-size=<SIZE> Specify decoder header table size. Default: )" << util::utos_unit(config.header_table_size) << R"( --encoder-header-table-size=<SIZE> Specify encoder header table size. The decoder (server) specifies the maximum dynamic table size it accepts. Then the negotiated dynamic table size is the minimum of this option value and the value which server specified. Default: )" << util::utos_unit(config.encoder_header_table_size) << R"( --log-file=<PATH> Write per-request information to a file as tab-separated columns: start time as microseconds since epoch; HTTP status code; microseconds until end of response. More columns may be added later. Rows are ordered by end-of- response time when using one worker thread, but may appear slightly out of order with multiple threads due to buffering. Status code is -1 for failed streams. --qlog-file-base=<PATH> Enable qlog output and specify base file name for qlogs. Qlog is emitted for each connection. For a given base name "base", each output file name becomes "base.M.N.sqlog" where M is worker ID and N is client ID (e.g. "base.0.3.sqlog"). Only effective in QUIC runs. --connect-to=<HOST>[:<PORT>] Host and port to connect instead of using the authority in <URI>. --rps=<N> Specify request per second for each client. --rps and --timing-script-file are mutually exclusive. --groups=<GROUPS> Specify the supported groups. Default: )" << config.groups << R"( --no-udp-gso Disable UDP GSO. --max-udp-payload-size=<SIZE> Specify the maximum outgoing UDP datagram payload size. --ktls Enable ktls. --sni=<DNSNAME> Send <DNSNAME> in TLS SNI, overriding the host name specified in URI. --histogram Plot histogram for performance statistics. --tls-session-file=<PATH> Read TLS session from <PATH>, and set it to all TLS connections to perform the session resumption. It is also used to store the new TLS session. At most one session is written to the given file. --output-file=<PATH> Write the measurement results to <PATH> in JSON format. This basically includes all numbers reported to the normal output. In addition, for performance measurements, all raw samples are included. -v, --verbose Output debug information. --version Display version information and exit. -h, --help Display this help and exit. -- The <SIZE> argument is an integer and an optional unit (e.g., 10K is 10 * 1024). Units are K, M and G (powers of 1024). The <DURATION> argument is an integer and an optional unit (e.g., 1s is 1 second and 500ms is 500 milliseconds). Units are h, m, s or ms (hours, minutes, seconds and milliseconds, respectively). If a unit is omitted, a second is used as unit.)" << std::endl; } } // namespace int main(int argc, char **argv) { std::string datafile; std::string logfile; bool nreqs_set_manually = false; auto window_bits_set_manually = false; while (1) { static int flag = 0; constexpr static option long_options[] = { {"requests", required_argument, nullptr, 'n'}, {"clients", required_argument, nullptr, 'c'}, {"data", required_argument, nullptr, 'd'}, {"threads", required_argument, nullptr, 't'}, {"max-concurrent-streams", required_argument, nullptr, 'm'}, {"window-bits", required_argument, nullptr, 'w'}, {"max-frame-size", required_argument, nullptr, 'f'}, {"connection-window-bits", required_argument, nullptr, 'W'}, {"input-file", required_argument, nullptr, 'i'}, {"header", required_argument, nullptr, 'H'}, {"no-tls-proto", required_argument, nullptr, 'p'}, {"verbose", no_argument, nullptr, 'v'}, {"help", no_argument, nullptr, 'h'}, {"version", no_argument, &flag, 1}, {"ciphers", required_argument, &flag, 2}, {"rate", required_argument, nullptr, 'r'}, {"connection-active-timeout", required_argument, nullptr, 'T'}, {"connection-inactivity-timeout", required_argument, nullptr, 'N'}, {"duration", required_argument, nullptr, 'D'}, {"timing-script-file", required_argument, &flag, 3}, {"base-uri", required_argument, nullptr, 'B'}, {"npn-list", required_argument, &flag, 4}, {"rate-period", required_argument, &flag, 5}, {"h1", no_argument, &flag, 6}, {"header-table-size", required_argument, &flag, 7}, {"encoder-header-table-size", required_argument, &flag, 8}, {"warm-up-time", required_argument, &flag, 9}, {"log-file", required_argument, &flag, 10}, {"connect-to", required_argument, &flag, 11}, {"rps", required_argument, &flag, 12}, {"groups", required_argument, &flag, 13}, {"tls13-ciphers", required_argument, &flag, 14}, {"no-udp-gso", no_argument, &flag, 15}, {"qlog-file-base", required_argument, &flag, 16}, {"max-udp-payload-size", required_argument, &flag, 17}, {"ktls", no_argument, &flag, 18}, {"alpn-list", required_argument, &flag, 19}, {"sni", required_argument, &flag, 20}, {"histogram", no_argument, &flag, 21}, {"tls-session-file", required_argument, &flag, 22}, {"output-file", required_argument, &flag, 23}, {"h3", no_argument, &flag, 24}, {nullptr, 0, nullptr, 0}}; int option_index = 0; auto c = getopt_long(argc, argv, "hvW:c:d:m:n:p:t:w:f:H:i:r:T:N:D:B:", long_options, &option_index); if (c == -1) { break; } switch (c) { case 'n': { auto n = util::parse_uint(optarg); if (!n) { std::println(stderr, "-n: bad option value: {}", optarg); exit(EXIT_FAILURE); } config.nreqs = static_cast<size_t>(*n); nreqs_set_manually = true; break; } case 'c': { auto n = util::parse_uint(optarg); if (!n) { std::println(stderr, "-c: bad option value: {}", optarg); exit(EXIT_FAILURE); } config.nclients = static_cast<size_t>(*n); break; } case 'd': datafile = optarg; break; case 't': { #ifdef NOTHREADS std::println( stderr, "-t: WARNING: Threading disabled at build time, no threads created."); #else // !defined(NOTHREADS) auto n = util::parse_uint(optarg); if (!n) { std::println(stderr, "-t: bad option value: {}", optarg); exit(EXIT_FAILURE); } config.nthreads = static_cast<size_t>(*n); #endif // !defined(NOTHREADS) break; } case 'm': { auto n = util::parse_uint(optarg); if (!n) { std::println(stderr, "-m: bad option value: {}", optarg); exit(EXIT_FAILURE); } config.max_concurrent_streams = static_cast<size_t>(*n); break; } case 'w': case 'W': { auto n = util::parse_uint(optarg); if (!n || *n > 30) { std::println(stderr, "-{}: specify the integer in the range [0, 30], inclusive", static_cast<char>(c)); exit(EXIT_FAILURE); } if (c == 'w') { window_bits_set_manually = true; config.window_bits = static_cast<size_t>(*n); } else { config.connection_window_bits = static_cast<size_t>(*n); } break; } case 'f': { auto n = util::parse_uint_with_unit(optarg); if (!n) { std::println(stderr, "--max-frame-size: bad option value: {}", optarg); exit(EXIT_FAILURE); } if (static_cast<uint64_t>(*n) < 16_k) { std::println(stderr, "--max-frame-size: minimum 16384"); exit(EXIT_FAILURE); } if (static_cast<uint64_t>(*n) > 16_m - 1) { std::println(stderr, "--max-frame-size: maximum 16777215"); exit(EXIT_FAILURE); } config.max_frame_size = static_cast<size_t>(*n); break; } case 'H': { char *header = optarg; // Skip first possible ':' in the header name auto name_end = strchr(optarg + 1, ':'); if (!name_end || (header[0] == ':' && header + 1 == name_end)) { std::println(stderr, "-H: invalid header: {}", optarg); exit(EXIT_FAILURE); } *name_end = 0; auto value = name_end + 1; while (isspace(*value)) { value++; } if (*value == 0) { // This could also be a valid case for suppressing a header // similar to curl std::println(stderr, "-H: invalid header - value missing: {}", optarg); exit(EXIT_FAILURE); } // Note that there is no processing currently to handle multiple // message-header fields with the same field name util::tolower(header, name_end, header); config.custom_headers.emplace_back(header, value); break; } case 'i': config.ifile = optarg; break; case 'p': { auto proto = std::string_view{optarg}; if (util::strieq(NGHTTP2_CLEARTEXT_PROTO_VERSION_ID ""sv, proto)) { config.no_tls_proto = Config::PROTO_HTTP2; } else if (util::strieq(NGHTTP2_H1_1, proto)) { config.no_tls_proto = Config::PROTO_HTTP1_1; } else { std::println(stderr, "-p: unsupported protocol {}", proto); exit(EXIT_FAILURE); } break; } case 'r': { auto n = util::parse_uint(optarg); if (!n) { std::println(stderr, "-r: bad option value: {}", optarg); exit(EXIT_FAILURE); } if (n == 0) { std::println( stderr, "-r: the rate at which connections are made must be positive."); exit(EXIT_FAILURE); } config.rate = static_cast<size_t>(*n); break; } case 'T': { auto d = util::parse_duration_with_unit(optarg); if (!d) { std::println(stderr, "-T: bad value for the conn_active_timeout wait time: {}", optarg); exit(EXIT_FAILURE); } config.conn_active_timeout = *d; break; } case 'N': { auto d = util::parse_duration_with_unit(optarg); if (!d) { std::println( stderr, "-N: bad value for the conn_inactivity_timeout wait time: {}", optarg); exit(EXIT_FAILURE); } config.conn_inactivity_timeout = *d; break; } case 'B': { auto arg = std::string_view{optarg}; config.base_uri = ""; config.base_uri_unix = false; if (util::istarts_with(arg, UNIX_PATH_PREFIX)) { // UNIX domain socket path sockaddr_un un; auto path = std::string_view{std::ranges::begin(arg) + UNIX_PATH_PREFIX.size(), std::ranges::end(arg)}; if (path.size() == 0 || path.size() + 1 > sizeof(un.sun_path)) { std::println(stderr, "--base-uri: invalid UNIX domain socket path: {}", arg); exit(EXIT_FAILURE); } config.base_uri_unix = true; auto &unix_addr = config.unix_addr; std::ranges::copy(path, unix_addr.sun_path); unix_addr.sun_path[path.size()] = '\0'; unix_addr.sun_family = AF_UNIX; break; } if (!parse_base_uri(arg)) { std::println(stderr, "--base-uri: invalid base URI: {}", arg); exit(EXIT_FAILURE); } config.base_uri = arg; break; } case 'D': { auto d = util::parse_duration_with_unit(optarg); if (!d) { std::println(stderr, "-D: value error {}", optarg); exit(EXIT_FAILURE); } config.duration = *d; break; } case 'v': config.verbose = true; break; case 'h': print_help(std::cout); exit(EXIT_SUCCESS); case '?': util::show_candidates(argv[optind - 1], long_options); exit(EXIT_FAILURE); case 0: switch (flag) { case 1: // version option print_version(); exit(EXIT_SUCCESS); case 2: // ciphers option config.ciphers = optarg; break; case 3: // timing-script option config.ifile = optarg; config.timing_script = true; break; case 5: { // rate-period auto d = util::parse_duration_with_unit(optarg); if (!d) { std::println(stderr, "--rate-period: value error {}", optarg); exit(EXIT_FAILURE); } config.rate_period = *d; break; } case 6: // --h1 config.alpn_list = util::parse_config_str_list("http/1.1"sv); config.no_tls_proto = Config::PROTO_HTTP1_1; break; case 7: // --header-table-size if (parse_header_table_size(config.header_table_size, "header-table-size", optarg) != 0) { exit(EXIT_FAILURE); } break; case 8: // --encoder-header-table-size if (parse_header_table_size(config.encoder_header_table_size, "encoder-header-table-size", optarg) != 0) { exit(EXIT_FAILURE); } break; case 9: { // --warm-up-time auto d = util::parse_duration_with_unit(optarg); if (!d) { std::println(stderr, "--warm-up-time: value error {}", optarg); exit(EXIT_FAILURE); } config.warm_up_time = *d; break; } case 10: // --log-file logfile = optarg; break; case 11: { // --connect-to auto maybe_hostport = util::split_hostport(std::string_view{optarg}); if (!maybe_hostport) { std::println(stderr, "--connect-to: Invalid value {}", optarg); exit(EXIT_FAILURE); } const auto &p = *maybe_hostport; uint16_t port{}; if (!p.second.empty()) { auto maybe_port = util::parse_uint(p.second); if (!maybe_port || *maybe_port > std::numeric_limits<uint16_t>::max()) { std::println(stderr, "--connect-to: Invalid value {}", optarg); exit(EXIT_FAILURE); } port = static_cast<uint16_t>(*maybe_port); } config.connect_to_host = p.first; config.connect_to_port = port; break; } case 12: { char *end; auto v = std::strtod(optarg, &end); if (end == optarg || *end != '\0' || !std::isfinite(v) || 1. / v < 1e-6) { std::println(stderr, "--rps: Invalid value {}", optarg); exit(EXIT_FAILURE); } config.rps = v; break; } case 13: // --groups config.groups = optarg; break; case 14: // --tls13-ciphers config.tls13_ciphers = optarg; break; case 15: // --no-udp-gso config.no_udp_gso = true; break; case 16: // --qlog-file-base config.qlog_file_base = optarg; break; case 17: { // --max-udp-payload-size auto n = util::parse_uint_with_unit(optarg); if (!n) { std::println(stderr, "--max-udp-payload-size: bad option value: {}", optarg); exit(EXIT_FAILURE); } if (static_cast<uint64_t>(*n) > 64_k) { std::println(stderr, "--max-udp-payload-size: must not exceed 65536"); exit(EXIT_FAILURE); } config.max_udp_payload_size = static_cast<size_t>(*n); break; } case 18: // --ktls config.ktls = true; break; case 4: // npn-list option std::println(stderr, "--npn-list: deprecated. Use --alpn-list instead."); // fall through case 19: // alpn-list option config.alpn_list = util::parse_config_str_list(std::string_view{optarg}); break; case 20: // --sni config.sni = optarg; break; case 21: // --histogram config.histogram = true; break; case 22: // --tls-session-file config.tls_session_file = optarg; break; case 23: // --output-file config.output_file = optarg; break; case 24: // --h3 config.alpn_list = util::parse_config_str_list("h3"sv); break; } break; default: break; } } if (argc == optind) { if (config.ifile.empty()) { std::println(stderr, "no URI or input file given"); exit(EXIT_FAILURE); } } if (config.nclients == 0) { std::println(stderr, "-c: the number of clients must be strictly greater than 0."); exit(EXIT_FAILURE); } if (config.alpn_list.empty()) { config.alpn_list = util::parse_config_str_list(DEFAULT_ALPN_LIST); } // serialize the APLN tokens for (auto &proto : config.alpn_list) { proto.insert(std::ranges::begin(proto), static_cast<char>(proto.size())); } if (config.is_quic() && !window_bits_set_manually) { config.window_bits = 24; } if (!config.tls_session_file.empty()) { auto maybe_session = read_tls_session(config.tls_session_file); if (maybe_session) { config.tls_session = *maybe_session; } } std::vector<std::string> reqlines; if (config.ifile.empty()) { std::vector<std::string> uris; std::ranges::copy(&argv[optind], &argv[argc], std::back_inserter(uris)); reqlines = parse_uris(std::ranges::begin(uris), std::ranges::end(uris)); } else { std::vector<std::string> uris; if (!config.timing_script) { if (config.ifile == "-") { uris = read_uri_from_file(std::cin); } else { std::ifstream infile(config.ifile); if (!infile) { std::println(stderr, "cannot read input file: {}", config.ifile); exit(EXIT_FAILURE); } uris = read_uri_from_file(infile); } } else { if (config.ifile == "-") { read_script_from_file(std::cin, config.timings, uris); } else { std::ifstream infile(config.ifile); if (!infile) { std::println(stderr, "cannot read input file: {}", config.ifile); exit(EXIT_FAILURE); } read_script_from_file(infile, config.timings, uris); } if (nreqs_set_manually) { if (config.nreqs > uris.size()) { std::println( stderr, "-n: the number of requests must be less than or equal to the " "number of timing script entries. Setting number of requests to {}", uris.size()); config.nreqs = uris.size(); } } else { config.nreqs = uris.size(); } } reqlines = parse_uris(std::ranges::begin(uris), std::ranges::end(uris)); } if (reqlines.empty()) { std::println(stderr, "No URI given"); exit(EXIT_FAILURE); } if (config.is_timing_based_mode() && config.is_rate_mode()) { std::println(stderr, "-r, -D: they are mutually exclusive."); exit(EXIT_FAILURE); } if (config.timing_script && config.rps_enabled()) { std::println(stderr, "--timing-script-file, --rps: they are mutually exclusive."); exit(EXIT_FAILURE); } if (config.nreqs == 0 && !config.is_timing_based_mode()) { std::println(stderr, "-n: the number of requests must be strictly greater " "than 0 if timing-based test is not being run."); exit(EXIT_FAILURE); } if (config.max_concurrent_streams == 0) { std::println( stderr, "-m: the max concurrent streams must be strictly greater than 0."); exit(EXIT_FAILURE); } if (config.nthreads == 0) { std::println(stderr, "-t: the number of threads must be strictly greater than 0."); exit(EXIT_FAILURE); } if (config.nthreads > std::thread::hardware_concurrency()) { std::println( stderr, "-t: warning: the number of threads is greater than hardware cores."); } // With timing script, we don't distribute config.nreqs to each // client or thread. if (!config.timing_script && config.nreqs < config.nclients && !config.is_timing_based_mode()) { std::println(stderr, "-n, -c: the number of requests must be greater than " "or equal to the clients."); exit(EXIT_FAILURE); } if (config.nclients < config.nthreads) { std::println(stderr, "-c, -t: the number of clients must be greater than " "or equal to the number of threads."); exit(EXIT_FAILURE); } if (config.is_timing_based_mode()) { config.nreqs = 0; } if (config.is_rate_mode()) { if (config.rate < config.nthreads) { std::println(stderr, "-r, -t: the connection rate must be greater than " "or equal to the number of threads."); exit(EXIT_FAILURE); } if (config.rate > config.nclients) { std::println(stderr, "-r, -c: the connection rate must be smaller than " "or equal to the number of clients."); exit(EXIT_FAILURE); } } if (!datafile.empty()) { config.data_fd = open(datafile.c_str(), O_RDONLY | O_BINARY); if (config.data_fd == -1) { std::println(stderr, "-d: Could not open file {}", datafile); exit(EXIT_FAILURE); } struct stat data_stat; if (fstat(config.data_fd, &data_stat) == -1) { std::println(stderr, "-d: Could not stat file {}", datafile); exit(EXIT_FAILURE); } config.data_length = data_stat.st_size; auto addr = mmap(nullptr, static_cast<size_t>(config.data_length), PROT_READ, MAP_SHARED, config.data_fd, 0); if (addr == MAP_FAILED) { std::println(stderr, "-d: Could not mmap file {}", datafile); exit(EXIT_FAILURE); } config.data = static_cast<uint8_t *>(addr); } if (!logfile.empty()) { config.log_fd = open(logfile.c_str(), O_WRONLY | O_CREAT | O_APPEND, S_IRUSR | S_IWUSR | S_IRGRP); if (config.log_fd == -1) { std::println(stderr, "--log-file: Could not open file {}", logfile); exit(EXIT_FAILURE); } } if (!config.qlog_file_base.empty() && !config.is_quic()) { std::println( stderr, "Warning: --qlog-file-base: only effective in quic, ignoring."); } struct sigaction act{}; act.sa_handler = SIG_IGN; sigaction(SIGPIPE, &act, nullptr); #ifdef ENABLE_HTTP3 # if defined(HAVE_LIBNGTCP2_CRYPTO_QUICTLS) || \ defined(HAVE_LIBNGTCP2_CRYPTO_LIBRESSL) if (ngtcp2_crypto_quictls_init() != 0) { std::println(stderr, "ngtcp2_crypto_quictls_init failed"); exit(EXIT_FAILURE); } # endif // defined(HAVE_LIBNGTCP2_CRYPTO_QUICTLS) || // defined(HAVE_LIBNGTCP2_CRYPTO_LIBRESSL) # ifdef HAVE_LIBNGTCP2_CRYPTO_OSSL if (ngtcp2_crypto_ossl_init() != 0) { std::println(stderr, "ngtcp2_crypto_ossl_init failed"); exit(EXIT_FAILURE); } # endif // defined(HAVE_LIBNGTCP2_CRYPTO_OSSL) #endif // defined(ENABLE_HTTP3) auto ssl_ctx = SSL_CTX_new(TLS_client_method()); if (!ssl_ctx) { std::println(stderr, "Failed to create SSL_CTX: {}", ERR_error_string(ERR_get_error(), nullptr)); exit(EXIT_FAILURE); } auto ssl_opts = static_cast<nghttp2_ssl_op_type>( (SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS) | SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION | SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION); #ifdef SSL_OP_ENABLE_KTLS if (config.ktls) { ssl_opts |= SSL_OP_ENABLE_KTLS; } #endif // defined(SSL_OP_ENABLE_KTLS) SSL_CTX_set_options(ssl_ctx, ssl_opts); SSL_CTX_set_mode(ssl_ctx, SSL_MODE_AUTO_RETRY); SSL_CTX_set_mode(ssl_ctx, SSL_MODE_RELEASE_BUFFERS); if (config.is_quic()) { #ifdef ENABLE_HTTP3 # if defined(HAVE_LIBNGTCP2_CRYPTO_QUICTLS) || \ defined(HAVE_LIBNGTCP2_CRYPTO_LIBRESSL) if (ngtcp2_crypto_quictls_configure_client_context(ssl_ctx) != 0) { std::println(stderr, "ngtcp2_crypto_quictls_configure_client_context failed"); exit(EXIT_FAILURE); } # endif // defined(HAVE_LIBNGTCP2_CRYPTO_QUICTLS) || // defined(HAVE_LIBNGTCP2_CRYPTO_LIBRESSL) # ifdef HAVE_LIBNGTCP2_CRYPTO_BORINGSSL if (ngtcp2_crypto_boringssl_configure_client_context(ssl_ctx) != 0) { std::println(stderr, "ngtcp2_crypto_boringssl_configure_client_context failed"); exit(EXIT_FAILURE); } # endif // defined(HAVE_LIBNGTCP2_CRYPTO_BORINGSSL) # ifdef HAVE_LIBNGTCP2_CRYPTO_WOLFSSL if (ngtcp2_crypto_wolfssl_configure_client_context(ssl_ctx) != 0) { std::println(stderr, "ngtcp2_crypto_wolfssl_configure_client_context failed"); exit(EXIT_FAILURE); } # endif // defined(HAVE_LIBNGTCP2_CRYPTO_WOLFSSL) #endif // defined(ENABLE_HTTP3) } else if (!nghttp2::tls::ssl_ctx_set_proto_versions( ssl_ctx, nghttp2::tls::NGHTTP2_TLS_MIN_VERSION, nghttp2::tls::NGHTTP2_TLS_MAX_VERSION)) { std::println(stderr, "Could not set TLS versions"); exit(EXIT_FAILURE); } if (SSL_CTX_set_cipher_list(ssl_ctx, config.ciphers.c_str()) == 0) { std::println(stderr, "SSL_CTX_set_cipher_list with {} failed: {}", config.ciphers, ERR_error_string(ERR_get_error(), nullptr)); exit(EXIT_FAILURE); } #if defined(NGHTTP2_GENUINE_OPENSSL) || \ defined(NGHTTP2_OPENSSL_IS_LIBRESSL) || defined(NGHTTP2_OPENSSL_IS_WOLFSSL) if (SSL_CTX_set_ciphersuites(ssl_ctx, config.tls13_ciphers.c_str()) == 0) { std::println(stderr, "SSL_CTX_set_ciphersuites with {} failed: {}", config.tls13_ciphers, ERR_error_string(ERR_get_error(), nullptr)); exit(EXIT_FAILURE); } #endif // defined(NGHTTP2_GENUINE_OPENSSL) || // defined(NGHTTP2_OPENSSL_IS_LIBRESSL) || // defined(NGHTTP2_OPENSSL_IS_WOLFSSL) if (SSL_CTX_set1_groups_list(ssl_ctx, config.groups.c_str()) != 1) { std::println(stderr, "SSL_CTX_set1_groups_list failed"); exit(EXIT_FAILURE); } std::vector<unsigned char> proto_list; for (const auto &proto : config.alpn_list) { std::ranges::copy(proto, std::back_inserter(proto_list)); } SSL_CTX_set_alpn_protos(ssl_ctx, proto_list.data(), static_cast<uint32_t>(proto_list.size())); if (!tls::setup_keylog_callback(ssl_ctx)) { std::println(stderr, "Failed to setup keylog"); exit(EXIT_FAILURE); } if (!config.tls_session_file.empty()) { SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_NO_INTERNAL); SSL_CTX_sess_set_new_cb(ssl_ctx, new_session_cb); } #if defined(NGHTTP2_OPENSSL_IS_BORINGSSL) && defined(HAVE_LIBBROTLI) if (!SSL_CTX_add_cert_compression_alg( ssl_ctx, nghttp2::tls::CERTIFICATE_COMPRESSION_ALGO_BROTLI, nghttp2::tls::cert_compress, nghttp2::tls::cert_decompress)) { std::println(stderr, "SSL_CTX_add_cert_compression_alg failed"); exit(EXIT_FAILURE); } #endif // defined(NGHTTP2_OPENSSL_IS_BORINGSSL) && // defined(HAVE_LIBBROTLI) std::string user_agent = "h2load nghttp2/" NGHTTP2_VERSION; Headers shared_nva; shared_nva.emplace_back(":scheme", config.scheme); shared_nva.emplace_back(":authority", make_http_authority(config)); shared_nva.emplace_back(":method", config.data_fd == -1 ? "GET" : "POST"); shared_nva.emplace_back("user-agent", user_agent); // list header fields that can be overridden. auto override_hdrs = std::to_array<std::string_view>( {":authority", "host", ":method", ":scheme", "user-agent"}); for (auto &kv : config.custom_headers) { if (util::contains(override_hdrs, kv.name)) { // override header for (auto &nv : shared_nva) { if ((nv.name == ":authority" && kv.name == "host") || (nv.name == kv.name)) { nv.value = kv.value; } } } else { // add additional headers shared_nva.push_back(kv); } } std::string content_length_str; if (config.data_fd != -1) { content_length_str = util::utos(as_unsigned(config.data_length)); } auto method_it = std::ranges::find_if( shared_nva, [](const Header &nv) { return nv.name == ":method"; }); assert(method_it != std::ranges::end(shared_nva)); config.h1reqs.reserve(reqlines.size()); config.nva.reserve(reqlines.size()); for (auto &req : reqlines) { // For HTTP/1.1 auto h1req = (*method_it).value; h1req += ' '; h1req += req; h1req += " HTTP/1.1\r\n"; for (auto &nv : shared_nva) { if (nv.name == ":authority") { h1req += "Host: "; h1req += nv.value; h1req += "\r\n"; continue; } if (nv.name[0] == ':') { continue; } h1req += nv.name; h1req += ": "; h1req += nv.value; h1req += "\r\n"; } if (!content_length_str.empty()) { h1req += "Content-Length: "; h1req += content_length_str; h1req += "\r\n"; } h1req += "\r\n"; config.h1reqs.push_back(std::move(h1req)); // For nghttp2 std::vector<nghttp2_nv> nva; // 2 for :path, and possible content-length nva.reserve(2 + shared_nva.size()); nva.push_back(http2::make_field_v(":path"sv, req)); for (auto &nv : shared_nva) { nva.push_back(http2::make_field_nv(nv.name, nv.value)); } if (!content_length_str.empty()) { nva.push_back( http2::make_field_nv("content-length"sv, content_length_str)); } config.nva.push_back(std::move(nva)); } // Don't DOS our server! if (config.host == "nghttp2.org") { std::println(stderr, "Using h2load against public server {} should be prohibited.", config.host); exit(EXIT_FAILURE); } resolve_host(); std::println("starting benchmark..."); std::vector<std::unique_ptr<Worker>> workers; workers.reserve(config.nthreads); #ifndef NOTHREADS size_t nreqs_per_thread = 0; size_t nreqs_rem = 0; if (!config.timing_script) { nreqs_per_thread = config.nreqs / config.nthreads; nreqs_rem = config.nreqs % config.nthreads; } auto nclients_per_thread = config.nclients / config.nthreads; auto nclients_rem = config.nclients % config.nthreads; auto rate_per_thread = config.rate / config.nthreads; auto rate_per_thread_rem = config.rate % config.nthreads; size_t max_samples_per_thread = std::max(256UZ, MAX_SAMPLES / config.nthreads); std::mutex mu; std::condition_variable cv; auto ready = false; std::vector<std::future<void>> futures; for (size_t i = 0; i < config.nthreads; ++i) { auto rate = rate_per_thread; if (rate_per_thread_rem > 0) { --rate_per_thread_rem; ++rate; } auto nclients = nclients_per_thread; if (nclients_rem > 0) { --nclients_rem; ++nclients; } size_t nreqs; if (config.timing_script) { // With timing script, each client issues config.nreqs requests. // We divide nreqs by number of clients in Worker ctor to // distribute requests to those clients evenly, so multiply // config.nreqs here by config.nclients. nreqs = config.nreqs * nclients; } else { nreqs = nreqs_per_thread; if (nreqs_rem > 0) { --nreqs_rem; ++nreqs; } } workers.push_back(create_worker(static_cast<uint32_t>(i), ssl_ctx, nreqs, nclients, rate, max_samples_per_thread)); auto &worker = workers.back(); futures.push_back( std::async(std::launch::async, [&worker, &mu, &cv, &ready] { { std::unique_lock<std::mutex> ulk(mu); cv.wait(ulk, [&ready] { return ready; }); } worker->run(); # ifdef NGHTTP2_OPENSSL_IS_WOLFSSL wc_ecc_fp_free(); # endif // defined(NGHTTP2_OPENSSL_IS_WOLFSSL) })); } { std::lock_guard<std::mutex> lg(mu); ready = true; cv.notify_all(); } auto start = std::chrono::steady_clock::now(); for (auto &fut : futures) { fut.get(); } #else // defined(NOTHREADS) auto rate = config.rate; auto nclients = config.nclients; auto nreqs = config.timing_script ? config.nreqs * config.nclients : config.nreqs; workers.push_back( create_worker(0, ssl_ctx, nreqs, nclients, rate, MAX_SAMPLES)); auto start = std::chrono::steady_clock::now(); workers.back()->run(); #endif // defined(NOTHREADS) auto end = std::chrono::steady_clock::now(); auto duration = std::chrono::duration_cast<std::chrono::microseconds>(end - start); workers[0]->write_tls_session(config.tls_session_file); Stats stats(0, 0); for (const auto &w : workers) { const auto &s = w->stats; stats.req_todo += s.req_todo; stats.req_started += s.req_started; stats.req_done += s.req_done; stats.req_timedout += s.req_timedout; stats.req_success += s.req_success; stats.req_status_success += s.req_status_success; stats.req_failed += s.req_failed; stats.req_error += s.req_error; stats.bytes_total += s.bytes_total; stats.bytes_head += s.bytes_head; stats.bytes_head_decomp += s.bytes_head_decomp; stats.bytes_body += s.bytes_body; stats.udp_dgram_recv += s.udp_dgram_recv; stats.udp_dgram_sent += s.udp_dgram_sent; for (size_t i = 0; i < stats.status.size(); ++i) { stats.status[i] += s.status[i]; } } auto ts = process_time_stats(workers); // Requests which have not been issued due to connection errors, are // counted towards req_failed and req_error. auto req_not_issued = (stats.req_todo - stats.req_status_success - stats.req_failed); stats.req_failed += req_not_issued; stats.req_error += req_not_issued; // UI is heavily inspired by weighttp[1] and wrk[2] // // [1] https://github.com/lighttpd/weighttp // [2] https://github.com/wg/wrk double rps = 0; int64_t bps = 0; if (duration.count() > 0) { if (config.is_timing_based_mode()) { // we only want to consider the main duration if warm-up is given rps = static_cast<ev_tstamp>(stats.req_success) / config.duration; bps = static_cast<int64_t>(static_cast<ev_tstamp>(stats.bytes_total) / config.duration); } else { auto secd = std::chrono::duration_cast< std::chrono::duration<double, std::chrono::seconds::period>>(duration); rps = static_cast<double>(stats.req_success) / secd.count(); bps = static_cast<int64_t>(static_cast<double>(stats.bytes_total) / secd.count()); } } double header_space_savings = 0.; if (stats.bytes_head_decomp > 0) { header_space_savings = 1. - static_cast<double>(stats.bytes_head) / static_cast<double>(stats.bytes_head_decomp); } std::println(""); std::println("finished in {}, {:.2f} req/s, {}B/s", util::format_duration(duration), rps, util::utos_funit(as_unsigned(bps))); std::println("requests: {} total, {} started, {} done, {} succeeded, {} " "failed, {} errored, {} timeout", stats.req_todo, stats.req_started, stats.req_done, stats.req_status_success, stats.req_failed, stats.req_error, stats.req_timedout); std::println("status codes: {} 2xx, {} 3xx, {} 4xx, {} 5xx", stats.status[2], stats.status[3], stats.status[4], stats.status[5]); std::println( "traffic: {}B ({}) total, {}B ({}) headers (space savings {:.2f}%), {}B " "({}) data", util::utos_funit(as_unsigned(stats.bytes_total)), stats.bytes_total, util::utos_funit(as_unsigned(stats.bytes_head)), stats.bytes_head, header_space_savings * 100, util::utos_funit(as_unsigned(stats.bytes_body)), stats.bytes_body); #ifdef ENABLE_HTTP3 if (config.is_quic()) { std::println("UDP datagram: {} sent, {} received", stats.udp_dgram_sent, stats.udp_dgram_recv); } #endif // defined(ENABLE_HTTP3) std::println(" " "min max median p95 " "p99 mean sd +/- sd"); output_sd_stat_duration(stdout, "request"sv, ts.request); output_sd_stat_duration(stdout, "connect"sv, ts.connect); output_sd_stat_duration(stdout, "TTFB"sv, ts.ttfb); output_sd_stat(stdout, "req/s"sv, ts.rps); #ifdef ENABLE_HTTP3 if (config.is_quic()) { output_sd_stat_duration(stdout, "min RTT"sv, ts.min_rtt); output_sd_stat_duration(stdout, "smoothed RTT"sv, ts.smoothed_rtt); output_sd_stat(stdout, "packets sent"sv, ts.pkt_sent); output_sd_stat(stdout, "packets recv"sv, ts.pkt_recv); output_sd_stat(stdout, "packets lost"sv, ts.pkt_lost); output_sd_stat(stdout, "GRO packets"sv, ts.gro_pkts); } #endif // ENABLE_HTTP3 if (!config.output_file.empty()) { write_result(config.output_file, duration, rps, bps, stats, ts); } SSL_CTX_free(ssl_ctx); if (config.log_fd != -1) { close(config.log_fd); } return 0; } } // namespace h2load int main(int argc, char **argv) { return h2load::main(argc, argv); }