Squashed 'external/toxcore/c-toxcore/' changes from c9cdae001..9ed2fa80d
9ed2fa80d fix(toxav): remove extra copy of video frame on encode de30cf3ad docs: Add new file kinds, that should be useful to all clients. d5b5e879d fix(DHT): Correct node skipping logic timed out nodes. 30e71fe97 refactor: Generate event dispatch functions and add tox_events_dispatch. 8fdbb0b50 style: Format parameter lists in event handlers. d00dee12b refactor: Add warning logs when losing chat invites. b144e8db1 feat: Add a way to look up a file number by ID. 849281ea0 feat: Add a way to fetch groups by chat ID. a2c177396 refactor: Harden event system and improve type safety. 8f5caa656 refactor: Add MessagePack string support to bin_pack. 34e8d5ad5 chore: Add GitHub CodeQL workflow and local Docker runner. f7b068010 refactor: Add nullability annotations to event headers. 788abe651 refactor(toxav): Use system allocator for mutexes. 2e4b423eb refactor: Use specific typedefs for public API arrays. 2baf34775 docs(toxav): update idle iteration interval see 679444751876fa3882a717772918ebdc8f083354 2f87ac67b feat: Add Event Loop abstraction (Ev). f8dfc38d8 test: Fix data race in ToxScenario virtual_clock. 38313921e test(TCP): Add regression test for TCP priority queue integrity. f94a50d9a refactor(toxav): Replace mutable_mutex with dynamically allocated mutex. ad054511e refactor: Internalize DHT structs and add debug helpers. 8b467cc96 fix: Prevent potential integer overflow in group chat handshake. 4962bdbb8 test: Improve TCP simulation and add tests 5f0227093 refactor: Allow nullable data in group chat handlers. e97b18ea9 chore: Improve Windows Docker support. b14943bbd refactor: Move Logger out of Messenger into Tox. dd3136250 cleanup: Apply nullability qualifiers to C++ codebase. 1849f70fc refactor: Extract low-level networking code to net and os_network. 8fec75421 refactor: Delete tox_random, align on rng and os_random. a03ae8051 refactor: Delete tox_memory, align on mem and os_memory. 4c88fed2c refactor: Use `std::` prefixes more consistently in C++ code. 72452f2ae test: Add some more tests for onion and shared key cache. d5a51b09a cleanup: Use tox_attributes.h in tox_private.h and install it. b6f5b9fc5 test: Add some benchmarks for various high level things. 8a8d02785 test(support): Introduce threaded Tox runner and simulation barrier d68d1d095 perf(toxav): optimize audio and video intermediate buffers by keeping them around REVERT: c9cdae001 fix(toxav): remove extra copy of video frame on encode git-subtree-dir: external/toxcore/c-toxcore git-subtree-split: 9ed2fa80d582c714d6bdde6a7648220a92cddff8
This commit is contained in:
137
testing/support/public/tox_runner.hh
Normal file
137
testing/support/public/tox_runner.hh
Normal file
@@ -0,0 +1,137 @@
|
||||
/* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
* Copyright © 2026 The TokTok team.
|
||||
*/
|
||||
|
||||
#ifndef C_TOXCORE_TESTING_SUPPORT_TOX_RUNNER_H
|
||||
#define C_TOXCORE_TESTING_SUPPORT_TOX_RUNNER_H
|
||||
|
||||
#include <atomic>
|
||||
#include <functional>
|
||||
#include <future>
|
||||
#include <thread>
|
||||
#include <type_traits>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
|
||||
#include "../../../toxcore/attributes.h"
|
||||
#include "../../../toxcore/tox_events.h"
|
||||
#include "mpsc_queue.hh"
|
||||
#include "simulation.hh"
|
||||
|
||||
namespace tox::test {
|
||||
|
||||
class ToxRunner {
|
||||
public:
|
||||
explicit ToxRunner(SimulatedNode &node, const Tox_Options *_Nullable options = nullptr);
|
||||
~ToxRunner();
|
||||
|
||||
ToxRunner(const ToxRunner &) = delete;
|
||||
ToxRunner &operator=(const ToxRunner &) = delete;
|
||||
|
||||
struct ToxEventsDeleter {
|
||||
void operator()(Tox_Events *_Nonnull e) const { tox_events_free(e); }
|
||||
};
|
||||
using ToxEventsPtr = std::unique_ptr<Tox_Events, ToxEventsDeleter>;
|
||||
|
||||
/**
|
||||
* @brief Schedules a task for execution on the runner's thread.
|
||||
*
|
||||
* This method is thread-safe and non-blocking. The task is queued and will
|
||||
* be executed during the runner's event loop cycle.
|
||||
*
|
||||
* @param task The function to execute, taking a raw Tox pointer.
|
||||
*/
|
||||
void execute(std::function<void(Tox *_Nonnull)> task);
|
||||
|
||||
/**
|
||||
* @brief Executes a task on the runner's thread and waits for the result.
|
||||
*
|
||||
* This method blocks the calling thread until the task has been executed
|
||||
* by the runner. It automatically handles return value propagation and
|
||||
* exception safety (though exceptions are not currently propagated).
|
||||
*
|
||||
* @tparam Func The type of the callable object.
|
||||
* @param func The callable to execute, taking a raw Tox pointer.
|
||||
* @return The result of the callable execution.
|
||||
*/
|
||||
template <typename Func>
|
||||
auto invoke(Func &&func) -> std::invoke_result_t<Func, Tox *_Nonnull>
|
||||
{
|
||||
using R = std::invoke_result_t<Func, Tox *_Nonnull>;
|
||||
auto promise = std::make_shared<std::promise<R>>();
|
||||
auto future = promise->get_future();
|
||||
|
||||
execute([p = promise, f = std::forward<Func>(func)](Tox *_Nonnull tox) {
|
||||
if constexpr (std::is_void_v<R>) {
|
||||
f(tox);
|
||||
p->set_value();
|
||||
} else {
|
||||
p->set_value(f(tox));
|
||||
}
|
||||
});
|
||||
|
||||
return future.get();
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Retrieves all accumulated Tox event batches.
|
||||
*
|
||||
* Returns a vector of unique pointers to Tox_Events structures that have
|
||||
* been collected by the runner since the last call. Ownership is transferred
|
||||
* to the caller. This method is thread-safe.
|
||||
*
|
||||
* @return A vector of Tox_Events pointers.
|
||||
*/
|
||||
std::vector<ToxEventsPtr> poll_events();
|
||||
|
||||
/**
|
||||
* @brief Accesses the underlying Tox instance directly.
|
||||
*
|
||||
* @warning Thread-Safety Violation: This method provides unsafe access to the
|
||||
* Tox instance. It should ONLY be used when the runner thread is known to be
|
||||
* idle (e.g., before the loop starts) or for accessing constant/read-only properties.
|
||||
* For all other operations, use `execute` or `invoke`.
|
||||
*/
|
||||
Tox *_Nullable unsafe_tox() { return tox_.get(); }
|
||||
|
||||
/**
|
||||
* @brief Temporarily stops the runner from participating in the simulation.
|
||||
*
|
||||
* Unregisters the runner and its tick listener from the simulation.
|
||||
* While paused, the runner will not call tox_iterate.
|
||||
*/
|
||||
void pause();
|
||||
|
||||
/**
|
||||
* @brief Resumes the runner's participation in the simulation.
|
||||
*/
|
||||
void resume();
|
||||
|
||||
/**
|
||||
* @brief Returns true if the runner is currently active.
|
||||
*/
|
||||
bool is_active() const { return active_; }
|
||||
|
||||
private:
|
||||
void loop();
|
||||
|
||||
SimulatedNode::ToxPtr tox_;
|
||||
std::thread thread_;
|
||||
std::atomic<bool> active_{true};
|
||||
|
||||
struct Message {
|
||||
enum Type { Task, Tick, Stop } type;
|
||||
std::function<void(Tox *_Nonnull)> task;
|
||||
uint64_t generation = 0;
|
||||
};
|
||||
|
||||
MpscQueue<Message> queue_;
|
||||
MpscQueue<ToxEventsPtr> events_queue_;
|
||||
|
||||
Simulation::TickListenerId tick_listener_id_ = -1;
|
||||
SimulatedNode &node_;
|
||||
};
|
||||
|
||||
} // namespace tox::test
|
||||
|
||||
#endif // C_TOXCORE_TESTING_SUPPORT_TOX_RUNNER_H
|
||||
Reference in New Issue
Block a user