mirror of
https://github.com/esphome/esphome.git
synced 2026-03-23 18:43:27 +08:00
Merge branch 'dev' into benchmark/sensor-binary-sensor-filters
This commit is contained in:
@@ -205,7 +205,13 @@ def setup_codspeed_lib(output_dir: Path) -> None:
|
||||
if hooks_dist_c.exists():
|
||||
_copy_if_missing(hooks_dist_c, lib_src / "instrument_hooks.c")
|
||||
|
||||
# 4. Write library.json
|
||||
# 4. Copy instrument-hooks headers (core.h, callgrind.h, valgrind.h) next to
|
||||
# measurement.hpp so they are found before any same-named headers from
|
||||
# other libraries (e.g. libsodium's core.h).
|
||||
for header in hooks_include.glob("*.h"):
|
||||
_copy_if_missing(header, core_include / header.name)
|
||||
|
||||
# 5. Write library.json
|
||||
version = _read_codspeed_version(output_dir / CORE_CMAKE)
|
||||
_write_library_json(
|
||||
benchmark_dir, core_include, hooks_include, version, project_root
|
||||
|
||||
7
tests/benchmarks/components/api/__init__.py
Normal file
7
tests/benchmarks/components/api/__init__.py
Normal file
@@ -0,0 +1,7 @@
|
||||
from tests.testing_helpers import ComponentManifestOverride
|
||||
|
||||
|
||||
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
||||
# api must run its to_code to define USE_API, USE_API_PLAINTEXT,
|
||||
# and add the noise-c library dependency.
|
||||
manifest.enable_codegen()
|
||||
177
tests/benchmarks/components/api/bench_noise_encrypt.cpp
Normal file
177
tests/benchmarks/components/api/bench_noise_encrypt.cpp
Normal file
@@ -0,0 +1,177 @@
|
||||
#include "esphome/core/defines.h"
|
||||
#ifdef USE_API_NOISE
|
||||
|
||||
#include <benchmark/benchmark.h>
|
||||
#include <cstring>
|
||||
#include <memory>
|
||||
|
||||
#include "noise/protocol.h"
|
||||
|
||||
namespace esphome::api::benchmarks {
|
||||
|
||||
static constexpr int kInnerIterations = 2000;
|
||||
|
||||
// Helper to create and initialize a NoiseCipherState with ChaChaPoly.
|
||||
// Returns nullptr on failure.
|
||||
static NoiseCipherState *create_cipher() {
|
||||
NoiseCipherState *cipher = nullptr;
|
||||
int err = noise_cipherstate_new_by_id(&cipher, NOISE_CIPHER_CHACHAPOLY);
|
||||
if (err != NOISE_ERROR_NONE || cipher == nullptr)
|
||||
return nullptr;
|
||||
|
||||
// Initialize with a dummy 32-byte key (same pattern as handshake split produces)
|
||||
uint8_t key[32];
|
||||
memset(key, 0xAB, sizeof(key));
|
||||
err = noise_cipherstate_init_key(cipher, key, sizeof(key));
|
||||
if (err != NOISE_ERROR_NONE) {
|
||||
noise_cipherstate_free(cipher);
|
||||
return nullptr;
|
||||
}
|
||||
return cipher;
|
||||
}
|
||||
|
||||
// Benchmark helper matching the exact pattern from
|
||||
// APINoiseFrameHelper::write_protobuf_messages:
|
||||
// - noise_buffer_init + noise_buffer_set_inout (same as production)
|
||||
// - No explicit set_nonce (production relies on internal nonce increment)
|
||||
// - Error checking on encrypt return
|
||||
static void noise_encrypt_bench(benchmark::State &state, size_t plaintext_size) {
|
||||
NoiseCipherState *cipher = create_cipher();
|
||||
if (cipher == nullptr) {
|
||||
state.SkipWithError("Failed to create cipher state");
|
||||
return;
|
||||
}
|
||||
|
||||
size_t mac_len = noise_cipherstate_get_mac_length(cipher);
|
||||
size_t buf_capacity = plaintext_size + mac_len;
|
||||
auto buffer = std::make_unique<uint8_t[]>(buf_capacity);
|
||||
memset(buffer.get(), 0x42, plaintext_size);
|
||||
|
||||
for (auto _ : state) {
|
||||
for (int i = 0; i < kInnerIterations; i++) {
|
||||
// Match production: init buffer, set inout, encrypt
|
||||
NoiseBuffer mbuf;
|
||||
noise_buffer_init(mbuf);
|
||||
noise_buffer_set_inout(mbuf, buffer.get(), plaintext_size, buf_capacity);
|
||||
|
||||
int err = noise_cipherstate_encrypt(cipher, &mbuf);
|
||||
if (err != NOISE_ERROR_NONE) {
|
||||
state.SkipWithError("noise_cipherstate_encrypt failed");
|
||||
noise_cipherstate_free(cipher);
|
||||
return;
|
||||
}
|
||||
}
|
||||
benchmark::DoNotOptimize(buffer[0]);
|
||||
}
|
||||
state.SetItemsProcessed(state.iterations() * kInnerIterations);
|
||||
|
||||
noise_cipherstate_free(cipher);
|
||||
}
|
||||
|
||||
// --- Encrypt a typical sensor state message (small payload ~14 bytes) ---
|
||||
// This is the most common message encrypted on every sensor update.
|
||||
// 4 bytes type+len header + ~10 bytes payload.
|
||||
|
||||
static void NoiseEncrypt_SmallMessage(benchmark::State &state) { noise_encrypt_bench(state, 14); }
|
||||
BENCHMARK(NoiseEncrypt_SmallMessage);
|
||||
|
||||
// --- Encrypt a medium message (~128 bytes, typical for LightStateResponse) ---
|
||||
|
||||
static void NoiseEncrypt_MediumMessage(benchmark::State &state) { noise_encrypt_bench(state, 128); }
|
||||
BENCHMARK(NoiseEncrypt_MediumMessage);
|
||||
|
||||
// --- Encrypt a large message (~1024 bytes, typical for DeviceInfoResponse) ---
|
||||
|
||||
static void NoiseEncrypt_LargeMessage(benchmark::State &state) { noise_encrypt_bench(state, 1024); }
|
||||
BENCHMARK(NoiseEncrypt_LargeMessage);
|
||||
|
||||
// Benchmark helper matching the exact pattern from
|
||||
// APINoiseFrameHelper::read_packet:
|
||||
// - noise_buffer_init + noise_buffer_set_inout with capacity == size (decrypt shrinks)
|
||||
// - Error checking on decrypt return
|
||||
//
|
||||
// Pre-encrypts kInnerIterations messages with sequential nonces before the
|
||||
// timed loop. Each outer iteration re-inits the decrypt key to reset the
|
||||
// nonce back to 0, then decrypts all pre-encrypted messages in sequence.
|
||||
// The init_key cost is amortized over kInnerIterations decrypts.
|
||||
static void noise_decrypt_bench(benchmark::State &state, size_t plaintext_size) {
|
||||
NoiseCipherState *encrypt_cipher = create_cipher();
|
||||
NoiseCipherState *decrypt_cipher = create_cipher();
|
||||
if (encrypt_cipher == nullptr || decrypt_cipher == nullptr) {
|
||||
state.SkipWithError("Failed to create cipher state");
|
||||
if (encrypt_cipher)
|
||||
noise_cipherstate_free(encrypt_cipher);
|
||||
if (decrypt_cipher)
|
||||
noise_cipherstate_free(decrypt_cipher);
|
||||
return;
|
||||
}
|
||||
|
||||
size_t mac_len = noise_cipherstate_get_mac_length(encrypt_cipher);
|
||||
size_t encrypted_size = plaintext_size + mac_len;
|
||||
|
||||
// Pre-encrypt kInnerIterations messages with sequential nonces (0..N-1).
|
||||
auto ciphertexts = std::make_unique<uint8_t[]>(encrypted_size * kInnerIterations);
|
||||
for (int i = 0; i < kInnerIterations; i++) {
|
||||
uint8_t *ct = ciphertexts.get() + i * encrypted_size;
|
||||
memset(ct, 0x42, plaintext_size);
|
||||
NoiseBuffer enc_buf;
|
||||
noise_buffer_init(enc_buf);
|
||||
noise_buffer_set_inout(enc_buf, ct, plaintext_size, encrypted_size);
|
||||
int err = noise_cipherstate_encrypt(encrypt_cipher, &enc_buf);
|
||||
if (err != NOISE_ERROR_NONE) {
|
||||
state.SkipWithError("Pre-encrypt failed");
|
||||
noise_cipherstate_free(encrypt_cipher);
|
||||
noise_cipherstate_free(decrypt_cipher);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// Working buffer — decrypt modifies in place
|
||||
auto buffer = std::make_unique<uint8_t[]>(encrypted_size);
|
||||
static constexpr uint8_t KEY[32] = {0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB,
|
||||
0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB,
|
||||
0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB, 0xAB};
|
||||
|
||||
for (auto _ : state) {
|
||||
// Reset nonce to 0 by re-initing the key (amortized over kInnerIterations)
|
||||
noise_cipherstate_init_key(decrypt_cipher, KEY, sizeof(KEY));
|
||||
|
||||
for (int i = 0; i < kInnerIterations; i++) {
|
||||
// Copy ciphertext into working buffer (decrypt modifies in place)
|
||||
memcpy(buffer.get(), ciphertexts.get() + i * encrypted_size, encrypted_size);
|
||||
|
||||
// Decrypt matching production pattern
|
||||
NoiseBuffer mbuf;
|
||||
noise_buffer_init(mbuf);
|
||||
noise_buffer_set_inout(mbuf, buffer.get(), encrypted_size, encrypted_size);
|
||||
|
||||
int err = noise_cipherstate_decrypt(decrypt_cipher, &mbuf);
|
||||
if (err != NOISE_ERROR_NONE) {
|
||||
state.SkipWithError("noise_cipherstate_decrypt failed");
|
||||
noise_cipherstate_free(encrypt_cipher);
|
||||
noise_cipherstate_free(decrypt_cipher);
|
||||
return;
|
||||
}
|
||||
}
|
||||
benchmark::DoNotOptimize(buffer[0]);
|
||||
}
|
||||
state.SetItemsProcessed(state.iterations() * kInnerIterations);
|
||||
|
||||
noise_cipherstate_free(encrypt_cipher);
|
||||
noise_cipherstate_free(decrypt_cipher);
|
||||
}
|
||||
|
||||
// --- Decrypt benchmarks (matching read_packet path) ---
|
||||
|
||||
static void NoiseDecrypt_SmallMessage(benchmark::State &state) { noise_decrypt_bench(state, 14); }
|
||||
BENCHMARK(NoiseDecrypt_SmallMessage);
|
||||
|
||||
static void NoiseDecrypt_MediumMessage(benchmark::State &state) { noise_decrypt_bench(state, 128); }
|
||||
BENCHMARK(NoiseDecrypt_MediumMessage);
|
||||
|
||||
static void NoiseDecrypt_LargeMessage(benchmark::State &state) { noise_decrypt_bench(state, 1024); }
|
||||
BENCHMARK(NoiseDecrypt_LargeMessage);
|
||||
|
||||
} // namespace esphome::api::benchmarks
|
||||
|
||||
#endif // USE_API_NOISE
|
||||
@@ -108,6 +108,7 @@ esphome:
|
||||
area_id: area_20
|
||||
|
||||
api:
|
||||
encryption:
|
||||
sensor:
|
||||
binary_sensor:
|
||||
light:
|
||||
|
||||
5
tests/benchmarks/components/mdns/__init__.py
Normal file
5
tests/benchmarks/components/mdns/__init__.py
Normal file
@@ -0,0 +1,5 @@
|
||||
from tests.testing_helpers import ComponentManifestOverride
|
||||
|
||||
|
||||
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
||||
manifest.enable_codegen()
|
||||
5
tests/benchmarks/components/network/__init__.py
Normal file
5
tests/benchmarks/components/network/__init__.py
Normal file
@@ -0,0 +1,5 @@
|
||||
from tests.testing_helpers import ComponentManifestOverride
|
||||
|
||||
|
||||
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
||||
manifest.enable_codegen()
|
||||
7
tests/benchmarks/components/socket/__init__.py
Normal file
7
tests/benchmarks/components/socket/__init__.py
Normal file
@@ -0,0 +1,7 @@
|
||||
from tests.testing_helpers import ComponentManifestOverride
|
||||
|
||||
|
||||
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
||||
# socket must run its to_code to define USE_SOCKET_IMPL_BSD_SOCKETS
|
||||
# which is needed by the api frame helper benchmarks.
|
||||
manifest.enable_codegen()
|
||||
Reference in New Issue
Block a user