Migrate OVPhysX PVA sensor onto OvPhysxView (view series, part 5)#6229
Migrate OVPhysX PVA sensor onto OvPhysxView (view series, part 5)#6229AntoineRichard wants to merge 13 commits into
Conversation
OVPhysX exposes physics attributes as a loose dict of TensorType -> TensorBinding with no view object, unlike Newton's selection.ArticulationView and PhysX's typed tensor views. OvPhysxView wraps the bindings for one prim pattern behind a string-keyed get_attribute / set_attribute surface, addressing attributes by the lowercased TensorType enum name (e.g. "articulation_dof_stiffness"). It needs no Model/State/Control source object because the TensorType already implies where the data lives. Prototype per docs/superpowers/specs/2026-06-17-ovphysx-view-design.md. Adds unit tests covering name<->enum resolution, the read-only guard, discoverability, and get/set dispatch against a fake binding (no native simulation required).
Reworks the view from a convenience wrapper into a layer that can back the OVPhysX asset/data classes, per the PR review of isaac-sim#6224: - read_into(name, dst): zero-copy fill of a caller-owned, possibly structured-dtype buffer (e.g. wp.transformf) via a float32 reinterpret view -- the mechanism the data containers use today. - set_attribute: accepts structured-dtype sources via the same reinterpret; non-float32-width buffers are rejected rather than silently bit-cast. - prim_paths + key_aliases: support the fused multi-prim binding form (create_tensor_binding(prim_paths=[...])) and storing a binding under a different TensorType key, as RigidObjectCollection needs. - binding_for(): raw TensorBinding accessor for adoption. - _CPU_ONLY_NAMES is now derived from tensor_types._CPU_ONLY_TYPES (no drift). - Added joint/tendon/is_fixed_base metadata passthrough; eager construction raises if it creates zero bindings; get_attribute allocates a fresh buffer (no aliasing); nested error hierarchy; PhysX/binding Protocols. Device policy: no implicit CPU<->GPU conversion. CPU-resident property types are read/written on CPU; a buffer on the wrong device raises DeviceMismatch instead of being staged. Device-less host data (numpy/list) is materialized on the binding's native device.
The OvPhysxView addition is a significant new public surface for the OVPhysX backend, so promote the changelog fragment from a minor to a major bump. Reword the entry to describe the binding-manager surface (read_into, the no-device-conversion policy) and drop the internal design-note path from the user-facing changelog.
From the second PR review of isaac-sim#6224: - Critical: _as_binding_view now requires a float32 scalar dtype before the zero-copy reinterpret. A same-byte-width wrong dtype (int32) previously passed the count-only guard and was bit-reinterpreted into garbage on the write path; sub-4-byte dtypes (float16) produced a misleading "0 elements" error. Both are now rejected with a clear message. Regression tests added (verified failing without the guard). - _resolve enforces the str | TensorType union and raises UnknownAttribute on anything else, instead of letting a bogus key reach the wheel. - _binding accesses binding.count directly (a malformed binding surfaces instead of being masked as a phantom no-match) and surfaces the underlying create_tensor_binding exception in the AttributeUnavailable message. - Added docstrings to the six metadata properties; dropped the unused runtime_checkable decorator. - Tests: same-byte/sub-4-byte dtype rejection, get_attribute(out=) wrong device, both indices+mask forwarded, read/write through a prim_paths+key_aliases view, non-str/non-TensorType key, and a read-only-names-are-valid-vocabulary check.
From the API-hardening review of isaac-sim#6224. Validate at the boundary and fail loud instead of silently corrupting, mis-binding, or no-op'ing: - Reject non-contiguous buffers in _as_binding_view (a strided/sliced source would be reinterpreted as contiguous and read/write the wrong memory). - Canonicalize the device (wp.get_device) so a "cuda" view accepts a "cuda:0" buffer instead of raising a spurious, unsatisfiable DeviceMismatch; falls back to the raw string when the device can't be resolved locally. - Reject TensorType.INVALID via the member path too (string path already did). - Normalize key_aliases to TensorType members so string keys are honored rather than silently dropped, and reject aliases that cross the CPU/GPU residency or read-only boundary (the device/read-only guards key on the requested type). - Reject empty pattern/prim_paths and tensor_types-without-eager at construction. - Eager construction with an explicit tensor_types list now surfaces a failing type instead of swallowing it at debug level (default sweep still skips inapplicable types). - Document binding_for as an unguarded escape hatch, get_attribute's native-device return, and the has_attribute name-validity-vs-availability split. Adds regression tests for each (contiguity and INVALID verified failing without the guard).
Surfaced by dogfooding the view in the articulation migration: the assets branch on a "binding or None" pattern for optional/absent bindings (tendon types on a tendon-less articulation, not-yet-created bindings), which the raising binding_for can't express. try_binding_for returns None when the attribute is valid but not available for the view's prims, while still raising UnknownAttribute for an invalid name (a programming error, not an availability question).
…xView read_into now reuses the float32 reinterpret of a destination buffer across calls (keyed by buffer id, with a pointer-staleness guard), so the wheel's object-identity read cache stays warm even when callers hand a structured buffer each step -- they no longer need to maintain their own reinterpret cache. get_attribute returns a typed array for attributes with a known structured layout (transformf for poses, spatial_vectorf for velocities, via a hand-maintained _ATTR_DTYPE map) and flat float32 otherwise. This lets the asset data containers drop their bespoke _get_read_view caching and read structured buffers straight through the view.
OvPhysxView (and OvPhysxFrameView) live in isaaclab_ovphysx.sim.views, which had no API-docs page. Add the automodule stub and wire it into the isaaclab_ovphysx autosummary so the new binding-manager view shows up in the rendered API reference alongside assets / cloner / physics.
Three fixes from the Part 1 review: - get_attribute (no out): route the freshly allocated buffer through _as_binding_view directly instead of the id()-keyed read cache. A fresh buffer can never hit the cache and would leak one entry (keeping the buffer alive) per call in a step loop; the cache only pays off for a reused out/dst buffer. Add a regression test asserting the no-out path leaves _read_views empty. - Raise a dedicated DtypeMismatch instead of ShapeMismatch when a buffer's scalar element type is not float32, so a dtype error no longer reads as a dimensions error. Update the affected tests and the Raises docstrings. - Make the view Warp-native: drop the fragile __module__ string-match that auto-converted Torch tensors on writes. Callers bridge a Torch tensor with wp.from_torch(t), keeping the device policy explicit and avoiding an optional Torch dependency.
Documentation/comment clarifications from the isaac-sim#6224 review (no behavior change): - Narrow the documented contract to float32-only: attribute_names/has_attribute and the module docstring now state that a listed name is name-validity, not a dtype-support promise; non-float dtype handling awaits wheel dtype metadata. - Mark _READ_ONLY_NAMES explicitly temporary; name the three access modes (read/write, read-only, write-only) and the wheel access_mode enum that should replace the table. - Document key_aliases as an internal collection adapter, not general public API, pending descriptor metadata. - Make the view test scope explicit: mock API mechanics here; live CPU-only-on-GPU / read-only+write-only / structured read_into coverage lives in the asset-integration tests.
…xView Replace the three per-attribute create_tensor_binding calls and their manual float32 reinterpret views with a single OvPhysxView over the rigid-parent pattern. Bindings are obtained via binding_for and read via read_into, which fills the structured kernel buffers in place. The CPU-only RIGID_BODY_COM_POSE keeps its pinned-host staging on a GPU sim. No public API or numeric behavior changes.
41e41c6 to
f4d7c63
Compare
Greptile SummaryThis PR is part 5 of the OVPhysX view-migration series: it introduces
Confidence Score: 3/5The sensor migration is correct and safe to merge; the new OvPhysxView class has a subtle read-cache design issue that can silently corrupt data in a caller-misuse scenario. The source/isaaclab_ovphysx/isaaclab_ovphysx/sim/views/ovphysx_view.py — specifically the Important Files Changed
Sequence Diagram%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
participant PVA as Pva._update_buffers_impl
participant OPV as OvPhysxView
participant BC as _binding cache
participant RC as _read_view cache
participant PX as OVPhysX TensorBinding
PVA->>OPV: read_into(RIGID_BODY_POSE, self._transforms)
OPV->>BC: _binding(RIGID_BODY_POSE)
BC-->>OPV: binding
OPV->>RC: _read_view(transforms, binding)
RC-->>OPV: float32 reinterpret view
OPV->>PX: binding.read(float32_view)
PX-->>OPV: fills transforms buffer GPU
PVA->>OPV: read_into(RIGID_BODY_VELOCITY, self._velocities)
OPV->>BC: _binding(RIGID_BODY_VELOCITY)
BC-->>OPV: binding
OPV->>RC: _read_view(velocities, binding)
RC-->>OPV: float32 reinterpret view
OPV->>PX: binding.read(float32_view)
PX-->>OPV: fills velocities buffer GPU
PVA->>OPV: read_into(RIGID_BODY_COM_POSE, self._coms_read_view)
note over OPV: CPU-only type native device is cpu
OPV->>BC: _binding(RIGID_BODY_COM_POSE)
BC-->>OPV: binding
OPV->>RC: _read_view(coms_read_view, binding)
RC-->>OPV: float32 reinterpret pinned CPU
OPV->>PX: binding.read(float32_view)
PX-->>OPV: fills coms_read_view CPU
PVA->>PVA: wp.copy(coms_buffer_GPU, coms_read_view_CPU)
note over PVA: CPU to GPU copy only on GPU sim
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
sequenceDiagram
participant PVA as Pva._update_buffers_impl
participant OPV as OvPhysxView
participant BC as _binding cache
participant RC as _read_view cache
participant PX as OVPhysX TensorBinding
PVA->>OPV: read_into(RIGID_BODY_POSE, self._transforms)
OPV->>BC: _binding(RIGID_BODY_POSE)
BC-->>OPV: binding
OPV->>RC: _read_view(transforms, binding)
RC-->>OPV: float32 reinterpret view
OPV->>PX: binding.read(float32_view)
PX-->>OPV: fills transforms buffer GPU
PVA->>OPV: read_into(RIGID_BODY_VELOCITY, self._velocities)
OPV->>BC: _binding(RIGID_BODY_VELOCITY)
BC-->>OPV: binding
OPV->>RC: _read_view(velocities, binding)
RC-->>OPV: float32 reinterpret view
OPV->>PX: binding.read(float32_view)
PX-->>OPV: fills velocities buffer GPU
PVA->>OPV: read_into(RIGID_BODY_COM_POSE, self._coms_read_view)
note over OPV: CPU-only type native device is cpu
OPV->>BC: _binding(RIGID_BODY_COM_POSE)
BC-->>OPV: binding
OPV->>RC: _read_view(coms_read_view, binding)
RC-->>OPV: float32 reinterpret pinned CPU
OPV->>PX: binding.read(float32_view)
PX-->>OPV: fills coms_read_view CPU
PVA->>PVA: wp.copy(coms_buffer_GPU, coms_read_view_CPU)
note over PVA: CPU to GPU copy only on GPU sim
|
Add _invalidate_initialize_callback to clear _root_view on simulation stop so a stale view (caching post-reset bindings) is not held across the reset; _initialize_impl rebuilds a fresh OvPhysxView on the next play.
|
We dug into the read-cache "silent corruption" concern closely, including the wheel's native code, and it's a latent gap rather than a silent-corruption bug:
So we deliberately did not add a per-hit shape guard (it would add hot-path cost to defend an unreachable, already-raising case); a dtype-aware cache key is tracked as a wheel-metadata follow-up (the wheel exposes no dtype today). We did make the reset boundary explicitly tidy — every consumer now clears |
Description
Part 5 of the OVPhysX view-migration series — route the PVA sensor's tensor-binding management through
OvPhysxView. Internal refactor; no public API change (sensors do not expose aroot_view)._initialize_implbuilds oneOvPhysxViewinstead of separatecreate_tensor_bindingcalls; binding handles come frombinding_for.read_into(cachedfloat32reinterpret, typed off the binding shape), replacing the manualwp.array(ptr=...)reinterpret views.RIGID_BODY_COM_POSEkeeps its pinned-host staging +wp.copyto the sim device.Type of change
Checklist
pre-commitchecks with./isaaclab.sh --format.skip— internal refactor, no user-facing change / no bump)Testing
test_pva.py— cpu: 13 passed, cuda: 13 passed.