Files
MobileGL/docs/Disaggregated/notes/recovered/wf4/part1.md
T
swung0x48 aba329cc53 [Docs] (Disaggregated): P6's plan and contract draft; the working notes move from a local directory into the repository
Two things land together: the plan and contract draft P6 needs before it starts, and the
working notes that until now existed on exactly one machine.

1. P6's plan and contract draft (neither started; not one line of code)

     docs/Disaggregated/P6-SPAWN-PLAN.md      the package plan
     docs/Disaggregated/P6-CONTRACT-DRAFT.md  the contract draft (moves to
                                              MG_Remote/CONTRACT-P6.md when c6 lands)

   The three findings that mattered, all written into the documents:

   a. P6 is SMALLER than its roadmap cell suggests. The transport primitives are already in
      the tree and already tested: SocketDoorbell including hangup detection and the two
      lost-wakeup fences (Doorbell.cpp:211-360, four cases in FdPassingTest), SCM_RIGHTS fd
      passing, ShmSegment::Adopt, and the SurfaceOp / WindowKind schema already defined in
      protocol.fbs. inproc uses a real second shm mapping rather than an alias, and
      SessionRings.h:22-28 says that was done so today is not the first time it runs. P6 is
      assembly plus a control plane plus a process, not "write a socket transport".

   b. The evidence for "P6 is only a transport swap" has EXPIRED. It was bought by P5c, whose
      audit found 59 direct memory accesses in a tree that already looked clean. P5e changed
      the tree again. So the first package, a6, is a read-only audit that writes no code, and
      every contract row that depends on it is marked PENDING a6 rather than decided in
      advance.

   c. P6 does not get a game running on the phone. ANativeWindow* is meaningless in the child,
      and protocol.fbs:186-196's own comment says Android transfers the window out of band -
      that band is P12. P6 lands pbuffer / surfaceless / offscreen, which is what HeadlessGL,
      the split-equivalent lane and trace replay need, and which is exactly what P6's own exit
      gate measures. A real window reaching the server is a named refusal. This gets its own
      section because "P6 is done" would otherwise read as "the game runs now".

   The contract adds rule G: a role may not name a process-local handle. It extends P5c's
   rule E (a role may not name the other role's memory) from memory to identity - EGLDisplay /
   EGLSurface / EGLContext / ANativeWindow* / fd number / pid / mapped address either cross as
   a token this contract defines or they do not cross, and a descriptor crosses only through
   SCM_RIGHTS, where the kernel renumbers it.

   What P5e left for P6 gets its own section. The latch semantics are already designed
   (ARCHITECTURE.md:504) and are copied unchanged. What is new is that after run-ahead the
   client no longer waits while the peer process can DIE: the client holds records that were
   published and will never be applied, and Android's freezer suspends the child without
   closing anything. So slow and dead must be distinguishable WITHOUT a timeout threshold.
   That is P6's only new design; everything else is carriage. It shares a predicate with E1's
   outstanding re-specification (ID-122), and the two should be designed together.

   Two gates carried over from P5e's lessons: G2 requires integration-spawn's test-name set to
   match integration-split's name for name, because a differing set means the lane is quietly
   running less; and the arm-proof gate requires every entry to record the child pid and
   transport=spawn in its OWN private log - ID-124 established that this kind of false green
   really happens, and a spawn lane that actually ran monolith would pass every other gate.
   S2's shape must be settled before it is written, and the document says why: E1 is the
   cautionary case.

2. The working notes move into the repository (docs/Disaggregated/notes/, 415 .md files)

   ROADMAP / CURRENT_STAGE_PROGRESS / MEASUREMENTS cite ruling numbers, audit line numbers and
   the provenance of gate figures from ~/w7/notes/, a directory that exists on one machine and
   is under no version control. A record cited hundreds of times that lives only locally is not
   a record, so it moves in whole, with its directory structure intact.

   Only .md moves. Scripts, run logs, census and gate result JSON, patches, APKs and nm dumps
   stay where they are: they are evidence DATA rather than documents - large, regenerated per
   run, and mostly carrying absolute paths and device serials that mean something only on the
   machine that produced them. The mapping and this split are written in
   docs/Disaggregated/notes/README.md.

   Two exceptions are recorded there too: P6's BRIEF has been promoted to a first-class
   document and keeps no copy under notes/, so the two cannot drift apart; and recovered/ holds
   material salvaged from failed workflow runs, which may duplicate the like-named phase
   directories and is kept because a few of those were the only complete version at the time.

   CI's citation lint takes docs/Disaggregated/*.md only (non-recursive), and notes/ is
   deliberately outside it: those notes' file:line citations were written against their own
   code heads, and resolving them against today's HEAD would fail wholesale - which is not an
   error, it is their correct state as a historical record. To check one, use the revision it
   declares (--rev).

3. Inconsistencies fixed in passing

   - README.md's status line still said P5e was in progress while the stage table already said
     closed.
   - CURRENT_STAGE_PROGRESS's next-step item 1 still listed the exit gate as pending, though
     (a) and (b) were run in the previous commit; rewritten to closed plus the one item that
     actually remains (E1).
   - ROADMAP's P6 row still had the pre-phase plan in three of its cells; it now carries the
     package order, the scope boundary and the two new gates.

Checked with check_doc_citations.py: 125 citations across docs/Disaggregated/*.md, 0 problems.
2026-09-18 23:31:39 -04:00

117 lines
7.3 KiB
Markdown

# P1 pull-site catalogue — every backend read of frontend state
Tree: `C:/Users/geekerwan/AndroidStudioProjects/FoldCraftLauncher/MobileGL-disagg`, branch `feat/disaggregated` @ `5635e33f`.
Scope: `MobileGL/MG_Backend/**` (`.cpp` + `.h`), 55 files, both backends plus the shared `BackendObject.h` / `BackendObject.cpp` / `Init.cpp`.
Every file:line below was opened; expressions are verbatim from the tree.
## 0. Headline counts (measured on THIS tree, not on the vendored inventory)
| what | count | how it was measured |
|---|---|---|
| lines containing `pGLContext` anywhere in `MG_Backend` | **332** | `grep -rn pGLContext --include=*.cpp --include=*.h` |
| `pGLContext->` / `pGLContext.` **member-access sites** | **278** | regex `pGLContext\s*(?:->|\.)\s*(\w+)` over whole files, multi-hit lines counted once per hit |
| lines mentioning `pGLContext` with **no** arrow on that line | **58** | `grep -v 'pGLContext->'` — matches the design's 58 exactly |
| distinct GLContext accessors actually called | **62** (61 named accessors + one `.get()`) | histogram below |
| `SyncPersistentMappedRange()` call sites | **20** | matches the design's 20 |
| `SyncGpuWrites()` call sites | **6** | matches the design's 6 |
| lines declaring/passing `SharedPtr<MG_State…>` or `WeakPtr<MG_State…>` | **177** (76 in headers, 101 in .cpp) | these are the "handle-ify" rows |
| `GetLifetimeId()` reads on frontend objects | **39** | |
| version reads (`GetChangeSerial` / `GetContentVersion` / `GetVersion`) | **36** | |
| `BufferBackendOps` touchpoints | **17** lines in `MG_Backend` | 2 register calls + 2 tables + register/unregister plumbing |
| other `MG_State::` globals reached by the backends | **0** | only `MG_State::pGLContext`; everything else is `MG_State::GLState::<type>` |
### 0.1 Drift against the vendored inventory — READ THIS FIRST
`scripts/data/backend_read_inventory.md:1-30` is a **stale, vendored** copy (generated by
`extract_backend_read_inventory.py`, which lives in MobileGL-CS, not in this repo). It claims
"pGLContext accesses: **293**", "SharedPtr<MG_State wire args: **167**", "scanned files: **57**",
"total read points: 477". This tree has **278** arrow sites, **177** SharedPtr lines and **55**
scannable files. The design's "293" is therefore an over-count of about 15 relative to the code
P1 will actually edit; the "58 non-arrow lines" figure is exact.
Three concrete accessor-level drifts, each of which will bite a mechanical P1 sweep:
| drift | evidence |
|---|---|
| `GetBoundTransformFeedbackName` is a `MGPipeInputField` (`MG_Pipe/generated/PipeFilled.inc:32`) and a `Coverage.def` accessor (`MG_Pipe/Coverage.def:34`), but **no backend reads it any more**. Its only readers are the frontend (`MG_Impl/GLImpl/Drawing/GL_Drawing.cpp:1562`, `MG_Impl/GLImpl/Getter/GL_Getter.cpp:2678`). It is a dead PipeInputs field. | grep for the name over `MG_Backend` returns nothing |
| `GetBoundTransformFeedbackLifetimeId` **is** read by a backend (`DirectVulkan/Renderer/VulkanRenderer.cpp:11219`) and is **absent** from both `PipeFilled.inc` and `Coverage.def`. | `MG_State/GLState/Core.h:441` declares it |
| `HasOpenTransformFeedbackSpan` **is** read by a backend (`DirectVulkan/Renderer/VulkanRenderer.cpp:11236`) and is **absent** from both. | `MG_State/GLState/Core.h:450` declares it |
Net: the PipeInputs field set must go **61 → 62** (drop one dead field, add two real ones), and
`Coverage.def`'s `MGP_COVERAGE_ACCESSOR_LIST` must gain the same two rows or `gen_pipe.py`'s
coverage join will report them UNMAPPED.
Also note: there is **no** `MobileGL/MG_Pipe/generated/PipeInputs.inc`. The file the design means is
`MobileGL/MG_Pipe/generated/PipeFilled.inc`; the 61 is asserted at `PipeFilled.inc:92`
(`static_assert(kMGPipeInputFieldCount == 61, "the PipeInputs field set moved")`).
### 0.2 Accessor histogram (all 278 member-access sites)
| accessor | sites | accessor | sites |
|---|---|---|---|
| `GetBufferBindingSlot` | 29 | `GetPrimitiveRestartIndex` | 3 |
| `IsCapabilityEnabled` | 29 | `GetProgramForDispatch` | 3 |
| `GetFramebufferBindingSlot` | 19 | `GetProgramObject` | 3 |
| `GetTextureUnitObject` | 19 | `GetScissorBox` | 3 |
| `GetBoundVertexArray` | 12 | `GetTransformFeedbackProgram` | 3 |
| `GetRenderStateParameters` | 11 | `ValidateProgramName` | 3 |
| `GetBufferBindingPoint` | 9 | `GetCurrentVertexAttribute` | 2 |
| `GetSamplingResolutionGeneration` | 9 | `GetRenderStateParametersVersion` | 2 |
| `GetActiveTextureUnit` | 8 | `GetTouchedBufferBindingPointCount` | 2 |
| `GetStencilState` | 8 | `GetTransformFeedbackPausedPrimitiveCounter` | 2 |
| `GetImageTextureBinding` | 7 | `InvalidateCompileEnv` | 2 |
| `GetProgramForDraw` | 7 | `IsTransformFeedbackPaused` | 2 |
| `GetColorMaskIndexed` | 6 | `GetBlendColor` | 1 |
| `GetPixelStoreParameters` | 6 | `GetBlendEquationIndexed` | 1 |
| `GetTextureContextId` | 6 | `GetBlendFuncIndexed` | 1 |
| `RecordError` | 6 | `GetBoundTransformFeedbackLifetimeId` | 1 |
| `GetDepthMask` | 5 | `GetClampReadColor` | 1 |
| `GetTextureBindGeneration` | 5 | `GetClearColor` | 1 |
| `IsTransformFeedbackActive` | 5 | `GetClearDepth` | 1 |
| `GetBufferBindingPointCount` | 3 | `GetClearStencil` | 1 |
| `GetPatchDefaultInnerLevel` | 3 | `GetCullFaceMode` | 1 |
| `GetPatchDefaultOuterLevel` | 3 | `GetDepthFunc` | 1 |
| `GetPatchVertices` | 3 | `GetDepthRangeIndexed` | 1 |
| `GetPipelineStateVersion` | 3 | `GetLineWidth` | 1 |
| `GetLogicOp` | 1 | `GetMaxTouchedTextureUnit` | 1 |
| `GetMinSampleShadingValue` | 1 | `GetPolygonModeFront` | 1 |
| `GetPolygonOffsetFactor` | 1 | `GetPolygonOffsetUnits` | 1 |
| `GetProvokingVertexMode` | 1 | `GetTextureObject` | 1 |
| `GetTransformFeedbackCapturedVertices` | 1 | `GetTransformFeedbackGeneration` | 1 |
| `GetViewport` | 1 | `GetViewportIndexed` | 1 |
| `HasOpenTransformFeedbackSpan` | 1 | `IsCapabilityEnabledIndexed` | 1 |
| `.get()` (raw context pointer) | 1 | | |
### 0.3 Per-file distribution of the 278 sites
| file | sites |
|---|---|
| `DirectVulkan/Renderer/VulkanRenderer.cpp` | 130 |
| `DirectGLES/DirectGLES.cpp` | 92 |
| `DirectGLES/Managers.cpp` | 15 |
| `DirectVulkan/Renderer/UniformManager.cpp` | 14 |
| `DirectVulkan/DirectVulkan.cpp` | 12 |
| `DirectGLES/MultiDraw.cpp` | 5 |
| `DirectVulkan/Renderer/VkRenderPassManager.cpp` | 3 |
| `DirectGLES/Utils.cpp` | 2 |
| `DirectVulkan/BackendObject_DirectVulkan.cpp` | 2 |
| `DirectVulkan/Renderer/VkTextureManager.cpp` | 2 |
| `DirectVulkan/Renderer/VkClearManager.cpp` | 1 |
(`DirectGLES/BackendObject_DirectGLES.cpp`, `DirectGLES/Utils.h`, `DirectGLES/Managers.h`,
`DirectGLES/DirectGLES.h`, `DirectVulkan/DirectVulkan.h`, `DirectVulkan/Renderer/VulkanRenderer.h`,
`.../UniformManager.h`, `.../VkBufferManager.*`, `.../VkSamplerManager.cpp`,
`.../VertexInputStateFactory.*`, `.../ProgramFactory.*`, `.../PipelineFactory.*`,
`.../FrameContext.*`, `.../SwapchainObject.*`, `BackendObject.h/.cpp`, `Init.cpp` contain **zero**
`pGLContext` member accesses — they reach the frontend only through handles/objects, §2.)
---
## 1. The complete site catalogue
Legend for the `accessor` column: `_(non-arrow)_` marks one of the 58 lines that names `pGLContext`
without dereferencing it on that line (null guards, asserts, ternary conditions, the raw-pointer
cache, a comment). The `verb path` column names the verb boundary the site sits under; where a
helper serves more than one verb the entry says so.