Files
MobileGL/docs/Disaggregated/notes/p5e/TASK-c0e.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

66 lines
5.3 KiB
Markdown

# Package c0e — the contract and the wire (P5e; lands first, inert)
Read in this order, all of it: `PACKAGE-PREAMBLE-P5E.md`, `INTEGRATOR-DECISIONS-P5E.md`,
`BRIEF-P5E.md` (§0, §1, §2 "c0e", §3, §6), `CONTRACT-P5E-draft.md` (all of it — you are landing it),
then the scout reports your rows come from (`scout-S6.md` for the wait classes / knobs / caps bit,
`scout-S5.md` for `set_shader_buffers`' encoding and bit 13, `scout-S4.md` for `set_program_bindings`
/ `LinkStatus`, `scout-S3.md` for the image `Access` decode, `scout-S1.md` for `kDrawClientArrays`,
`scout-S7.md` for the seam declarations). All are in `//wsl.localhost/Arch/home/swung/w7/notes/p5e/`.
Your slug is `c0e`; your tree is `~/w7/p5e-c0e` (built, on branch `p5e/c0e` at `2fde7034`).
## Deliverables (all inert: no behaviour changes; unit + integration-split + gens stay green; G1 0/0/0/0)
1. `MobileGL/MG_Remote/CONTRACT-P5E.md` — the draft, edited into its landed form: apply the 19 rulings
as decided in `INTEGRATOR-DECISIONS-P5E.md` (they mostly match the draft's recommendations),
make every `file:line` resolve at the HEAD of your branch (run `gens`; the doc-citation lint covers
`MG_Remote/CONTRACT-P5*.md`), remove "draft" wording, keep the voice of CONTRACT-P5C.
2. `MobileGL/MG_Pipe/PipeCalls.def`: the `WaitClass` column on every row exactly as CONTRACT-P5E §2.2
(kWaitNone / kWaitApplied / kWaitReply / kWaitPresent / kWaitByPredicate…), `SetProgramBindings`
(opcode 80) appended in S4's shape. Extend the generator(s) that read the def (`scripts/gen_pipe.py`
and whatever emits the wire/route/thunk tables — find them) so that `MGPipeWaitClassFor(op)` is
generated, the new op has its codec layout / thunk / table slot / route row (null route, refused
by name until pg lands), and every `--check` / `--self-test` stays green with the regenerated
`MobileGL/MG_Pipe/generated/*.inc` committed. The ABI fingerprint (`SessionRings.h`) must change
with the new opcode; pin it.
3. `MobileGL/MG_Pipe/MGPipeTypes.h`: `kCapRunAheadApply` (bit 10, MGPCapBit), `MGPProgramBindings`
+ its tail PODs, `MGPProgramDesc::LinkStatus` in the spare bytes, `kDrawClientArrays` draw flag,
`kMGPipeMaxBufferBindingPoints` (84; pinned against `BufferState.h`'s constant where both are
visible), `MGP_ASSERT_POD` sizes; `MGPipeValueTypes.h`: `MGPipeImageAccess` enum with
encode/decode (the client encode in `ImageEmit.h` already exists — move/alias, do not duplicate).
4. `MobileGL/MG_Pipe/MGPipe.h`: subsystem bit 13 (`kMGPipeSubsystemBufferBindings`), default mask
`0x3fff`; `MG_Impl/Pipe/SetHashSuppressor.h`: the three `SetShaderBuffers` class slots;
`MG_Impl/Pipe/Tracker.h`: bits 15-17 mapped to subsystem 13 (`MGPipeSubsystemForDirty`);
`TrackerTest.cpp`'s bit table; `MG_Pipe/FieldOwnership.def` re-annotations (retiring phase P5e
on the rows the brief names); `MG_Pipe/Coverage.def` rows as the contract lists.
5. `MobileGL/Config.h` / `ConfigLoader.cpp`: `IpcTable::RunAhead` (`MOBILEGL_IPC_RUN_AHEAD`, default
1, forced 0 under `PipeVerify`, logged in the IPC line), `IpcTable::PresentCredit`
(`MOBILEGL_IPC_PRESENT_CREDIT`, default 1, range 1..8).
6. Seam declarations in `MobileGL/MG_Pipe/PipeApply.h` (+ `.cpp` bodies that assert "not landed" by
name, never silently succeed): `MGPipeApplierCurrentRecordIsBarriered()`,
`MGPipeBarriered(op, payload, applierState)` (the static column half implemented here; the
XFB/client-array halves read the fields the contract names), the sb applier fields
(`BoundShaderBuffers[3]`, `Start/Count/WritableMask[3]`, `ShaderBuffersSerial`) and
`MGPipeApplySetShaderBuffers` declaration, the pg fields on `MGPipeShaderCsoRecord`
(`BlockBindings`, `SamplerUnits`, `StorageOverrides`, `BindingsSerial`, `LinkStatus`) and
`MGPipeApplySetProgramBindings` declaration, the by-handle sync signatures the family packages
implement (`SyncTextureToBackendByHandle`, `SyncMipmapsToBackendByHandle`, `ResolveVaoTwin(handle)`,
`ResolveProgramTwin(handle)`, `ResolveTextureTwin(handle)`, the FBO/RBO `SyncToBackendByHandle`
overloads) — declared where the brief says (Managers.h ranges) with asserting bodies, so every
package compiles against the same names from day one.
7. `MobileGL/MG_Backend/Init.cpp`: `kMGPipeP5eRunAheadReady = false` and the DirectGLES arm that
will publish bit 10 only when it is true (Magma never); `MagmaPipeIdentityTest` pins no bit 10.
8. `MG_Test/Pipe/PipeCatalogueTest.cpp`: sizes, opcode 80, the null route pin, the wait-class table
(every row's class asserted against the contract table by name).
9. `docs/Disaggregated/ROADMAP.md`: the P5e row (status "进行中", the package list, the exit gate)
inserted after P5d; `CURRENT_STAGE_PROGRESS.md` §1 row + §6 next-step line. Keep the citation lint green.
## Red-once (execute, revert, record)
- Flip one row's `WaitClass` in the def without regenerating → `gen_pipe.py --check` red.
- Change the `MGPProgramBindings` POD size → `PipeCatalogueTest` red.
- Publish bit 10 on the Magma arm → `MagmaPipeIdentityTest` red.
## Gate
`build`, `unit`, `isplit`, `gens` green; `strict` unchanged vs base (record its marker list in the
report as the baseline the later packages must shrink). Commit in sensible slices (contract; def +
generators + generated; types; knobs; seams + tests; docs).