[FEATURE] Audit authority, code quality and documentation in ramfsd #1
Labels
No labels
alpha-1
bug
ci
docs
duplicate
enhancement
help wanted
invalid
performance
phase-6
question
refactor
security
wontfix
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
erix/ramfsd#1
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Problem and motivation
Audit
ramfsdthroughout Phase 6. Serve volatile filesystem objects and exact-entry mutations with independent live-handle lifetimes.Review each changed boundary at the final published revision. Prioritize security, reliability, then performance.
Proposed behavior and scope
Current inventory: 1 Cargo target (1 bin); manifests:
Cargo.toml. Include explicit and automatically discovered targets, supported features and target-specific configurations.Inventory every startup/runtime grant and authenticated peer, then success, denial, cancellation, failed transfer, restart and teardown. Trace callers and downstream providers so names, numeric identities and retained aliases never become implicit authority.
Authority, security and reliability
Record each finding's affected revision, invariant, reproduction, owner, regression coverage and resolution. Report suspected vulnerabilities through SECURITY.md and keep sensitive details private. Record a result and rationale for each audit criterion, including caller responsibilities when this component has no process or Rust target.
Acceptance criteria
Checklist
missing_docsenforcement without blanket allowances or hidden-API escapes, warning-denied private-item rustdoc and an undocumented-public-API negative gate.cargo fmt --all -- --check, strict Clippy, unit/doctests and warning-denied builds/rustdoc for every owned crate/target under default and all valid feature, freestanding/host, SMP and profile combinations; test mutually exclusive combinations separately. Add focused VM regressions for runtime behavior and observe the older catalog and unit tests at the exact published heads.Alternatives and tradeoffs
Refactor within the component unless shared semantics justify extracting common code. Preserve regression coverage before deleting superseded paths. Profile before optimizing, and document ABI limits, hardware limits and explicit quotas. Preserve security and reliability requirements.
Matching catalog adoption and real consumer VMs remain requirements; complete realm and full in-guest build acceptance remain open.
Original coherent realm source CI acceptance — 18 September 2026: Signed
db389ae6dd80cdaa227b7c59fff1b87c1e8f3aeepasses CI 45 and CI 44. Coherent catalog publication, actual consumer VMs and full guest-build acceptance remain separate open requirements.Tracking and rollout
All 34 maintained local checks pass: development/release feature matrices (43, 44 unit tests per selection), strict host/native Clippy, warning-denied builds, private rustdoc, applicable doctests and component-specific checks, formatting and exact dependency-source validation. Native binaries have executable read-only entry pages and no writable executable pages. Original CI52 and CI53 pass; their complete logs are independently reviewed with zero warnings. No unchanged CI was rerun. Coordinated VM configuration/seal/four-client I/O, repeated managed-row reuse, profiler observation and both full builds inside EriX remain open under the phase checklist. This dependency work earns no separate feature-completion credit.
Counted private startup dependency adoption — 24 September 2026.
These host/build results do not establish actual running mediator readiness or retirement, a complete service-image pass, configuration/seal, client I/O, or either required guest rebuild.
Tracking: owning issue, WIP PR and Phase 6 acceptance.
VFS requires frozen Write for regular-file resize and live admitted file/directory custody for sync. Known refusals preserve original admission; uncertainty keeps cleanup-only custody, with no retry or pathname reopen.
No request or adapter adds a device, mount, credentials, new native rights or capability transfer.
They cover literal framing, unchanged output on refusal, full correlation, access direction, actual aliases and zero growth, storage/format refusal, clean recovery ownership, lost barriers/replies, retained cleanup and short reply capacity.
Existing ext logical-range conversions and sparse-gap traversal still need the size-boundary audit; compatibility truncate/ftruncate/fsync/fdatasync consumers, complete cancellation controls and new live workloads remain unfinished. Current phase completion remains 19.20% weighted, 7.61% whole acceptance: 27/460 parents and 486/949 children.
Both full guest EriX generations and external Rust/LLVM rebuilding remain required and unperformed.
Detailed scope and contracts
Cross-provider filesystem lifetime — signed source acceptance, 2 October 2026
Two live binding scenarios cover RAM, ext and separately selected FAT32/exFAT: conditional replacement/unlink, retained aliases and original identities, moved/detached directories, name reuse, supported links and read-only, cross-filesystem and unsupported-link refusals. Final media observers require reclaimed allocations, consistent reverse indices and clear undo ownership.
Both full EriX guest generations and external Rust/LLVM guest rebuilding remain required and unperformed.
Phase progress: 19.12% weighted, 7.61% whole acceptance; 27/460 parents and 485/949 sub-items.
Runtime consumer dependency alignment — 15 September 2026
The product catalog, product VM acceptance and guest build remain pending.
Full catalog equality and actual consumer-image validation remain required under Integration regression 68. This dependency checkpoint does not close full lifecycle, frame or self-hosting acceptance.
Full service CPU/profiler VM acceptance and guest builds remain open in Phase 6 completion.
Original namespace mutation plan and provider custody — 1 October 2026
The complete namespace feature remains open.
Known pre-effect refusal preserves original pending custody; existing-object touch and absent no-create observations retain their distinct lifetimes.
They cover original-name admission, actual RAM/literal-ext effects, hardlink entry distinction, known refusal, completed-operation retirement, cleanup and namespace reuse.
The namespace umbrella now checks its completed status/directory criterion, matching the already accepted feature and phase master. No new namespace criterion is accepted for the provider prerequisite. Both complete EriX guest generations and external Rust/LLVM rebuilding remain required and unperformed.
RAM open-object lifetime implemented — 1 October 2026
Completed exact-entry cleanup never selects a reused node. Same-name rename is a metadata-preserving no-op; trusted change events remain on held displaced objects and clockless effects invalidate the affected observation.
Both existing VM scenarios require the new OPEN_UNLINK_OK marker. Namespace output capacity is admitted before effects; changed provider controls preserve their original custody/refusal coverage with the new detachment behavior.
The complete namespace mutation and lifetime design remains open: RAM hardlink storage, directory navigation/detachment, ext/FAT object lifetime, complete conditional native contracts and compatibility namespace serving are unfinished. No broader namespace acceptance is inferred from this provider boundary.
Both complete EriX guest generations and external Rust/LLVM rebuilding remain required and unperformed.
Independent RAM entries and retained directories — 1 October 2026
Unlink/relink of the same object and name cannot revive an old exact-entry grant. Creation beneath a removed directory refuses before effects.
Ext/FAT original-object lifetime and complete compatibility namespace serving also remain unfinished in the owning design.
All 37 runtime configurations, packaging, fixtures, CLI/shell routing and reports adopt the new quota; obsolete layouts and missing entry policy are refused. Nineteen Rust and four Python controls, plus two shell policy refusal cases, are authored and unrun. The twenty-operation native VFS transcript requires shared hardlink metadata, retained bytes after both names disappear, and removal of a held empty directory before its final close. Both existing RAM VM scenarios require the corresponding observations.
Both complete EriX guest generations and external Rust/LLVM rebuilding remain required and unperformed.
Conditional retained-entry namespace custody — 1 October 2026
Exact response correlation distinguishes completed effects, definite no-effect refusals and uncertainty.
Missing, malformed or uncorrelated replies preserve cleanup and never permit replay. The installed namespace is currently immutable and append-only; future unmount/reconfiguration requires a persistent nonwrapping epoch.
Ext and FAT return explicit correlated unsupported no-effect dispositions for the new family. Their conditional transactions remain unfinished. Complete compatibility path/dirfd, ACL/sticky, final-link and trailing-separator mediation and legacy cwd migration remain open in the owning design. Required legacy cwd and administrative spelling guards remain.
Thirty-nine new Rust controls are authored and unrun: ten literal wire controls, seventeen RAM provider controls, eight actual Vfsd dispatch controls, and two explicit-refusal controls each for ext and FAT.
Both complete EriX guest generations and external Rust/LLVM rebuilding remain required and unperformed.
Counted RAM namespace and retained-selection names
Replace the RAM provider's fixed basename arrays in namespace entries and retained
selection handles with private generational name keys into caller-owned records
and a separately budgeted byte arena. Names are complete raw nonempty/NUL-free
basenames. Their storage and lifetime never create native authority or replace
original parent, target, binding, root, operation or cleanup identity.
Record capacity derives from the total possible entry/handle owners plus one
serialized replacement reservation; it does not impose a separate pathname or
name-count limit. Exact byte capacity is explicit image policy, separate from file
contents. Equal complete names may share immutable storage through checked owner
counts. A copied key alone does not acquire ownership. Prepare every storage and
identity reservation before effects; publication is infallible within the same
exclusive turn. Release only the original published owner. The last owner clears
retired bytes and compacts other ranges without changing their keys. Nonwrapping
identities reject reused records; original acquisition cleanup remains available.
Migrate namespace selection, fixed entry acquisition, create, mkdir, symlink,
hardlink, rename/replacement, metadata/touch, native enumeration, consumption,
close and mount retirement together. Held-name effects take keys rather than
borrowing a mutable arena across mutation or copying another fixed buffer.
Successor namespace bindings preserve shared original names independently of
spent selection rows. Admission failures leave bytes, namespace and owner counts
unchanged. Existing native root, permission, stale-binding, directory ancestry,
read-only and one-use effect rules remain independent. Legacy fixed reply codecs
must refuse unrepresentable output explicitly, never truncate native names.
RAM capacity layout V3 uses magic ERIXRAMCAPLAY003 and 18 words: version; the five
size/alignment pairs for mount, node, entry, handle and name records; then mount
count, nodes/mount, entries/mount, file bytes/node, handles, name bytes and arena
bytes. The arena orders mount/node/entry/handle/name records, name bytes, then file
bytes. Integration policy, target geometry, CLI/shell forwarding, tracked profiles
and authored fixtures must migrate together with checked addressable arithmetic.
Retired V2 layout is rejected; no inferred production name-byte budget. Existing
compiled Rootd helper selections and runtime catalogs remain unchanged pending
coherent adoption.
Author long/raw-name native namespace and fixed-entry controls, independent
selection/entry lifetime, rename replacement, stale binding, exact byte capacity,
failed admission atomicity, last-owner clearing/compaction, mount teardown and
literal image layout controls. Update component contracts and authored manual TeX.
Tests/builds/checks/generated documents/VM/profiler execution and CI observation
remain deferred. Containing cross-provider and self-hosting acceptance stays open.
Tracking: RAM audit/design,
native ownership,
Phase 6 tracker.
Review: RAM PR2,
Integration PR12,
Docs PR4.
Equal names share bytes through checked published-owner
counts; copying a descriptive key adds no owner or authority. Native enumeration
returns full raw names; fixed legacy replies explicitly refuse oversized output.
Integration requires independent name_bytes through runtime parser, CLI, shell
forwarding and reporting. Old V2 descriptors are rejected. Runtime catalog adoption remains open; compiled Rootd helpers are unchanged.
Allocator/provider/image controls are authored for complete 601/301-byte raw
names, exact capacity, shared ownership, caller reuse, stale replacement,
hardlinks, symlinks, native enumeration, short replies, original cleanup, mount
reuse, identity exhaustion, literal geometry and overflow/missing-policy refusal.
The containing consumer migration remains open for legacy
directory/consumer frames, complete cross-provider lifetime/refusal/restart
controls and coherent runtime adoption. Full EriX guest generations and external
Rust/LLVM rebuilding inside EriX remain required and unperformed.
State and name module cfg predicates now match their native/test
dependencies; source acceptance does not claim a compiler or CI reproduction.
Retire legacy provider pathname and spelling-pin adapters
Current contextual consumers use independently retained native anchors,
conditional component/fixed-entry acquisition and source-free retained effects.
The older provider cwd-open, whole-target readlink and path-selected exact-entry
families now remain in provider dispatch, compatibility adapters and tests.
Inventory every opcode, codec and direct caller before deleting its producer.
Retire cwd component open (0x639), its whole-target link observation (0x63A), and
the obsolete path-selected fixed-entry acquisition/effect adapters where all
ordinary consumers have migrated. Old operation numbers remain unassigned and
must refuse without fallback. Keep actual native metadata, raw link pages,
conditional namespace effects, retained entry effects, original anchors and
acquisition-key retirement. Do not remove ordinary namespace/file interfaces
that still have real users, including generic provider readdir.
Remove cwd spelling-pin fields and their move/unlink guards only after the
corresponding creation paths and dependent tests migrate. Remove legacy exact
binding/parent spelling guards with their final acquisition producers. Preserve
original object, parent and navigation-ceiling ownership; empty directory moves
and detachment must retain actual held objects without pathname reopening or
reuse. Conditional entry freshness, stale-binding refusal, original one-use
effect semantics, permission evidence and positive cleanup remain mandatory.
Imported filesystem-format limits remain explicit and are not bypassed.
Migrate controls to actual native root/anchor/component/fixed-entry acquisition
with original keys known before submission. Do not emulate removed APIs with
test-only path reopeners, fabricated handles, copied identity or renamed legacy
production code. Preserve independent identity/mount separation, maximal ID and
capacity refusal, raw link lifetime, moved/detached ancestors, wrong handle kind,
stale selection/replacement, timestamps, media recovery and cleanup ordering.
Retain literal rejection controls for retired operation numbers. Share cohesive
fixture helpers where useful; all authored code stays below 1,000 lines.
Work through RAM, ext and FAT producers and dependent controls, then remove the
unused shared codecs/IDs and remaining Vfsd adapter references. Publish signed
checkpoints regularly and coordinate adopting immutable dependency revisions.
Update component contracts and authored manual/API addenda. Tests/builds/checks,
generated references, VM/profiler execution and CI observation remain deferred.
Runtime catalogs and both compiled Rootd helper selections remain unchanged
until coherent runtime adoption; full guest EriX and Rust/LLVM rebuilding remains
required. Partial provider retirement does not close the complete lifetime item.
Tracking: codec audit,
RAM audit,
ext audit,
FAT audit,
native ownership,
Phase 6 tracker.
RAM/ext/FAT now reject retired cwd-open 0x639 and whole-link 0x63A without
fallback.
The RAM hardlink/held-directory criterion is source-complete after its final
cwd spelling-pin dependency is removed. The containing compatibility lifetime
and cross-provider criteria remain open for administrative path-selected
exact-entry retirement, remaining lifetime controls and coherent runtime adoption.
No broader acceptance is claimed. Full EriX guest generations and external
Rust/LLVM rebuilding inside EriX remain required and unperformed.
Ordinary V2 response correlation no longer admits retired effect operations.
They retain
root/parent/key fields, full-width handles and timestamps, optional trusted time,
explicit selected fields, invalid destination refusal and untouched short outputs. New literal stat controls cover framing, canaries and retired-family refusal. Retired numeric replies cannot satisfy ordinary V2 or native effect correlation. Vfsd's last old exported-name references become literal timestamp-adapter refusals
for all thirteen retired operations.
The existing superseded-bridge/provider-spelling-pin acceptance criterion in
the native ownership feature
is source-complete. Required imported FAT/exFAT binding and geometry guards remain. The remaining cwd/contextual-serving and complete lifecycle/control/graph criteria
need a current-source acceptance audit and any missing implementation, followed by
coherent runtime adoption. No synthetic weighted sub-item or full lifetime acceptance is added. Recomputed
phase progress remains 18.95% weighted and 6.81% whole acceptance: 25/460 parents
and 480/949 sub-items. Full EriX guest generations and external Rust/LLVM rebuilding
inside EriX remain required and unperformed.
Related records and contracts
[FEATURE] [P02.R66] Audit authority, code quality and documentation in ramfsdto [FEATURE] Audit authority, code quality and documentation in ramfsderikinkinen referenced this issue2026-09-15 18:22:30 +02:00
erikinkinen referenced this issue2026-10-01 02:02:47 +02:00
erikinkinen referenced this issue2026-10-01 22:32:23 +02:00
erikinkinen referenced this issue from erix/vfsd2026-10-01 22:32:23 +02:00
erikinkinen referenced this issue from erix/integration2026-10-01 22:33:08 +02:00
erikinkinen referenced this issue from erix/docs2026-10-01 22:33:08 +02:00
erikinkinen referenced this issue from erix/lib-ipc2026-10-01 22:33:10 +02:00
erikinkinen referenced this issue from erix/lib-ipc2026-10-01 22:33:11 +02:00
erikinkinen referenced this issue from erix/exsh2026-10-01 22:33:12 +02:00