Dispatch returns a result envelope

dpm_execute fills a dpm_result on every call: status and error_code
from the module's return value, and a payload the module hands back
through dpm_set_result. The payload's layout belongs to the module and
is documented per command; its release function is carried in the
envelope and invoked by dpm_result_release. The context keeps a stack
of the envelopes in progress, so a module calling a peer receives the
peer's payload in its own envelope and its caller sees only what the
module sets itself.

The good fixture returns a payload and counts its releases, and the
modules test covers the envelope fields, the payload round trip, single
release, discard on a NULL envelope, and a payload set outside any
dispatch. The prose documents describe the envelope and the payload
header a module ships.
This commit is contained in:
2026-09-07 14:53:24 -04:00
parent 0291e61fd8
commit 55c852586b
13 changed files with 404 additions and 39 deletions

View File

@@ -77,12 +77,64 @@ int main(void) {
/* dispatch returns the module's own value, so a round trip is
observable with no compile-time knowledge of the module */
CHECK(dpm_execute(ctx, good, "ping", 0, nullptr) == 42);
CHECK(dpm_execute(ctx, good, "anything_else", 0, nullptr) == 0);
CHECK(dpm_execute(ctx, good, nullptr, 0, nullptr) == 0);
dpm_result result;
CHECK(dpm_execute(ctx, good, "ping", 0, nullptr, &result) == 42);
CHECK(result.status == DPM_RESULT_ERROR);
CHECK(result.error_code == 42);
CHECK(result.data == nullptr);
CHECK(result.release == nullptr);
CHECK(dpm_execute(nullptr, good, "ping", 0, nullptr) == 1);
CHECK(dpm_execute(ctx, nullptr, "ping", 0, nullptr) == 1);
CHECK(dpm_execute(ctx, good, "anything_else", 0, nullptr, &result) == 0);
CHECK(result.status == DPM_RESULT_OK);
CHECK(result.error_code == 0);
CHECK(result.data == nullptr);
CHECK(dpm_execute(ctx, good, nullptr, 0, nullptr, &result) == 0);
CHECK(result.status == DPM_RESULT_OK);
CHECK(dpm_execute(nullptr, good, "ping", 0, nullptr, &result) == 1);
CHECK(result.status == DPM_RESULT_ERROR);
CHECK(dpm_execute(ctx, nullptr, "ping", 0, nullptr, &result) == 1);
CHECK(result.status == DPM_RESULT_ERROR);
}
/* ---- a payload reaches the caller and is released once ---- */
{
dpm_module* good = dpm_require(ctx, "good");
CHECK(good != nullptr);
if (!good) {
dpm_close(ctx);
return harness_report("modules");
}
dpm_result result;
CHECK(dpm_execute(ctx, good, "payload", 0, nullptr, &result) == 0);
CHECK(result.status == DPM_RESULT_OK);
CHECK(result.data != nullptr);
CHECK(result.release != nullptr);
CHECK(result.data != nullptr &&
std::strcmp(static_cast<const char*>(result.data), "pong") == 0);
/* nothing has been released yet */
CHECK(dpm_execute(ctx, good, "releases", 0, nullptr, nullptr) == 0);
dpm_result_release(&result);
CHECK(result.data == nullptr);
CHECK(result.release == nullptr);
CHECK(result.status == DPM_RESULT_OK);
CHECK(dpm_execute(ctx, good, "releases", 0, nullptr, nullptr) == 1);
/* releasing again calls nothing */
dpm_result_release(&result);
CHECK(dpm_execute(ctx, good, "releases", 0, nullptr, nullptr) == 1);
/* a NULL envelope discards the payload before dispatch returns */
CHECK(dpm_execute(ctx, good, "payload", 0, nullptr, nullptr) == 0);
CHECK(dpm_execute(ctx, good, "releases", 0, nullptr, nullptr) == 2);
/* setting a payload outside any dispatch releases it at once */
dpm_set_result(ctx, &result, nullptr);
dpm_result_release(nullptr);
}
dpm_close(ctx);