mirror of
https://github.com/MobileGL-Dev/MobileGL
synced 2026-09-17 08:38:30 +09:00
swung0x48
41992649c9
# Conflicts: # MobileGL/MG_Remote/Client/ClientSession.cpp # MobileGL/MG_Test/Wire/CMakeLists.txt
151 lines
9.4 KiB
C++
151 lines
9.4 KiB
C++
// MobileGL - MobileGL/MG_Remote/Client/EmitTables.h
|
|
// Copyright (c) 2025-2026 MobileGL-Dev
|
|
// Licensed under the GNU Lesser General Public License v3.0:
|
|
// https://www.gnu.org/licenses/gpl-3.0.txt
|
|
// https://www.gnu.org/licenses/lgpl-3.0.txt
|
|
// SPDX-License-Identifier: LGPL-3.0-only
|
|
// End of Source File Header
|
|
|
|
// The client's emitting function table. Owner: package c1. Signatures by c0.
|
|
//
|
|
// MG_Backend/Init.cpp:44 assigns gBackendFunctionsTable from the active backend object, and
|
|
// 91 MG_Impl/GLImpl sites call through it directly. So a BackendObject_Remote has to return a
|
|
// COMPLETE table, and "complete" is a bigger number than R-4's headline:
|
|
//
|
|
// GLFunctionsTable (BackendObject.h:117-292) = 69 function pointers
|
|
// + Bool PrefersCpuXfbPrimitiveAccounting
|
|
// GlobalBackendFunctionsTable (BackendObject.h:293-299) = the above, + Present, + SetSwapInterval
|
|
// = 71 function pointers in total
|
|
//
|
|
// R-4's rule, restated over all 71: NO SLOT MAY BE NULL, and no slot may fall through to a
|
|
// driver. A null slot is 91 potential null calls; a pass-through slot is a split lane quietly
|
|
// running monolith and going green, which is the one outcome every gate in this phase exists
|
|
// to prevent. A verb P5 does not implement gets a slot that raises
|
|
// Fatal{UnmigratedVerb, "<slot>"} - the same shape as MGPipeInputPoisonFatal, live at every
|
|
// log level, MGLOG_F + std::abort.
|
|
//
|
|
// WHICH SLOTS GET A REAL EMITTER IS DECIDED BY THE VERB CENSUS (R-4), not guessed here:
|
|
// ~/w7/notes/p5/verb-census.md. CONTRACT-P5.md §7 carries the resulting THREE-CLASS SPLIT and
|
|
// it is not to be re-derived:
|
|
//
|
|
// A. ANSWERED LOCALLY from the caps mirror, never emitted and never Fatal (R-15) - two
|
|
// slots, GetIntegeri_v and IsTimerQuerySupported, plus the Bool member
|
|
// PrefersCpuXfbPrimitiveAccounting, which is not a slot. GetIntegeri_v is the one that
|
|
// would otherwise sink the phase: it is reached by the FIRST glCompileShader of every
|
|
// context (CompileEnv.cpp:134-138 <- Core.cpp:39), not by any verb, so a Fatal there
|
|
// aborts every scenario before it draws anything.
|
|
// B. EMITTED in P5 - five slots: Clear, DrawArrays, ReadPixels, BlitFramebuffer, Present.
|
|
// Present has ZERO MG_Impl call sites: it is reached through EGLImpl.cpp:178 ->
|
|
// BackendObject.cpp:396, so mirroring GLImpl will not find it.
|
|
// C. Fatal{UnmigratedVerb} - the remaining 64, SetSwapInterval and GetGpuTimestampNs among
|
|
// them.
|
|
//
|
|
// AND THE RULE R-4 WOULD OTHERWISE BREAK. 41 of the 69 slots are null-checked at their call
|
|
// site, and several of those checks are CAPABILITY PROBES, not safety checks - BeginOcclusionQuery
|
|
// (GL_Query.cpp:481, :785), BeginXfbPrimitivesQuery (:534), SubDataResident. With no null slot
|
|
// in this table every one of them answers "supported" and the fallback behind it silently
|
|
// disappears. A null check on a slot may not survive into the client: it becomes a caps-mirror
|
|
// read, which is what ARCHITECTURE.md:114 means by "CallMask replaces 'is this table slot null'".
|
|
//
|
|
// NOTE the asymmetry this table does not resolve, AND WHERE IT IS RESOLVED (R-17): the
|
|
// resource, CSO, framebuffer, texture, sampler and program families do NOT come through here.
|
|
// They were emitted from MG_Impl/Pipe/* by 40 direct calls to the 37 MGPipeApply* entry
|
|
// points; those call sites now go through the two generated tables
|
|
// (MG_Pipe/PipeRoute.h -> MG_Remote/Client/WireTables.cpp). This table covers only the verbs -
|
|
// the draws, clears, blits, readbacks, queries, fences and present.
|
|
|
|
#pragma once
|
|
#include <Includes.h>
|
|
|
|
#include <MG_Backend/BackendObject.h>
|
|
#include <MG_Pipe/MGPipeValueTypes.h>
|
|
|
|
namespace MobileGL::MG_Remote::Client {
|
|
|
|
// MGPClear::Kind. MGPipeTypes.h:1273 states the list as a COMMENT - "Whole | Color | Depth
|
|
// | Stencil | DepthStencil" - and mints no enumerator, because until P5 the record had no
|
|
// producer. These are the values, in that comment's own order, and they are here rather
|
|
// than in MGPipeTypes.h because that file is c0's and this phase produces exactly ONE of
|
|
// them: glClear is the only entry point that reaches the Clear slot (the four
|
|
// glClearBuffer* and the four glClearNamedFramebuffer* are class C). v1's
|
|
// WireVerbSink::OnClear must therefore Fatal on anything but Whole rather than guess, and
|
|
// the phase that migrates the other eight moves these into the contract.
|
|
enum MGRemoteClearKind : Uint32 {
|
|
kRemoteClearWhole = 0,
|
|
kRemoteClearColor = 1,
|
|
kRemoteClearDepth = 2,
|
|
kRemoteClearStencil = 3,
|
|
kRemoteClearDepthStencil = 4,
|
|
};
|
|
|
|
// The table MG_Backend::Init() installs into gBackendFunctionsTable for the remote role.
|
|
// A reference to a never-destroyed block, like every other MG_Remote singleton (ID-8).
|
|
const MG_Backend::GlobalBackendFunctionsTable& RemoteEmitTable();
|
|
|
|
// Called by the Fatal slots. Named separately so a death test can filter on it and so
|
|
// that the message wording lives in exactly one place.
|
|
[[noreturn]] void UnmigratedVerbFatal(const char* slot);
|
|
|
|
// How many of the 71 slots have a real emitter. Reported at bring-up and asserted by the
|
|
// gate: a table that silently loses an emitter should not be able to look the same as one
|
|
// that never had it.
|
|
Uint32 ImplementedVerbCount();
|
|
|
|
// The total the count above is out of. Asserted against the struct in EmitTables.cpp, so
|
|
// a slot added to GLFunctionsTable without a decision here is a build break.
|
|
inline constexpr Uint32 kRemoteEmitSlotCount = 71;
|
|
|
|
// The other two thirds of the census, so a case can assert the WHOLE partition rather than
|
|
// only the half that emits. CONTRACT-P5.md §7's three classes are 2 + 5 + 64, and
|
|
// EmitTables.cpp static_asserts that they sum to kRemoteEmitSlotCount: a slot that quietly
|
|
// changes class shows up as a build break in the sum, not as a silent behaviour change.
|
|
Uint32 LocallyAnsweredSlotCount(); // class A - answered from the caps mirror, R-15
|
|
Uint32 UnmigratedSlotCount(); // class C - Fatal{UnmigratedVerb}
|
|
|
|
// THE E2 NEGATIVE CONTROL (t1's debt against c1, BRIEF §7). When set, the Clear emitter
|
|
// SKIPS its record - it still runs the pre-verb hooks and still returns - so a replay that
|
|
// is really going through the wire loses one clear per frame and its SSIM falls below the
|
|
// 0.99 threshold, while a replay that fell through to the driver is unaffected. It is a
|
|
// function rather than a knob in Config.h for two reasons: the control has to be settable
|
|
// from a test process that has already started, and a knob would be a
|
|
// MOBILEGL_IPC_-shaped name for something no operator may ever set.
|
|
//
|
|
// Emissions actually skipped, so the control can assert that it DID something rather than
|
|
// that a picture changed - a control that silently never fired is the third shape of R-16's
|
|
// "a gate that cannot go red for its own reason".
|
|
void SetDropClearEmissionForNegativeControl(Bool drop);
|
|
Uint64 DroppedClearEmissions();
|
|
|
|
// ID-47. The CLIENT refuses a readback whose answer would not fit a reply slot, BEFORE it
|
|
// emits the record, and names the read. THE REFUSAL ITSELF IS s1's -
|
|
// ClientSession::RequireReadPixelsReplyFits, forwarding to
|
|
// ReplySlotPool::RequireReadPixelsFits - and this package does not own a second copy of the
|
|
// message: two spellings of one refusal is how the two sides come to disagree about which
|
|
// reads are legal. What c1 owns is the CALL SITE and the number it passes, which is ID-49's
|
|
// tight extent; the control below is over that, and s1-v3.md §1's cases are over the
|
|
// helper.
|
|
|
|
// ID-49. `MGPReadbackInfo::DstSize` is the TIGHT w*h*bytesPerPixel extent - the reply
|
|
// payload - and nothing about the application's pack state crosses the wire. The server
|
|
// reads with a NEUTRAL pack state into that run; this is the number both sides derive.
|
|
Uint64 TightReadbackByteCount(GLsizei width, GLsizei height, GLenum format, GLenum type);
|
|
|
|
// ID-49. Scatters the tight rows into the application's pointer per the application's own
|
|
// pack state (ROW_LENGTH, SKIP_*, ALIGNMENT), which only the client holds. Exposed for the
|
|
// same reason as the refusal above: the control drives the function the emitter calls
|
|
// rather than a second copy of GL 4.6 8.4.4's arithmetic. THE GAPS ARE NEVER WRITTEN -
|
|
// they belong to the application - and that is what the control checks with a sentinel.
|
|
void ScatterTightReadbackIntoPackState(const void* tight, void* destination, GLsizei width,
|
|
GLsizei height, Uint64 bytesPerPixel,
|
|
const PixelStoreParameters& pack);
|
|
|
|
// ID-49. True when the destination layout IS the tight layout, which is the only condition
|
|
// under which EmitReadPixels may read the reply straight into the application pointer and
|
|
// skip the bounce. Exported because the FAST PATH and the SCATTER have to agree, and the
|
|
// only honest way to state that is to drive both and compare - a case that tested either
|
|
// alone would pass a predicate that said yes to a layout the scatter would have rearranged.
|
|
Bool ReadbackPackStateIsTightForTest(GLsizei width, Uint64 bytesPerPixel,
|
|
const PixelStoreParameters& pack);
|
|
|
|
} // namespace MobileGL::MG_Remote::Client
|