SandstromPLandClaude Opus 5.5
0dc254e83f
progress.py skips every definition whose name ends in _nid_no_patch or _nid_no_patch_cut, which are meant to be internal helpers. Some libraries export such functions with APS5_EXPORT under an explicit NID or name: libSceAgcVsh (150), libSceNKWebKit (150) and libSceJson2's inventory (66), all of them calling NotImplemented_nid_no_patch. None of the 366 was counted, so those three libraries showed 151 of 151 functions where they declare 517, and import_audit, which takes its stub list from the same scan, reported imports of them as implemented. A _nid_no_patch definition is now skipped only when no APS5_EXPORT in its library exports it. The library totals go from 6104 of 12305 to 6104 of 12671 on main. Co-Authored-By: Claude Opus 5.5 <[email protected]>
7.0 KiB
Progress reporting
tools/progress.py generates progress.json, HTML, SVG maps and badges. The Pages workflow publishes them with the web converter after pushes to main that change the converter, the web page or these tools. The Pages progress workflow runs after pushes that change core/libs/prx or the opcode list, compares the generated progress.json with the deployed one and dispatches the Pages workflow only when they differ, so the history chart gains new days only when the progress changes. The Progress report workflow compares the base and head trees of pull requests.
Library counts
The scanner reads APS5_VABI function definitions under core/libs/prx/<library>/, excluding tests subdirectories and their descendants. Test callbacks do not contribute to library counts. Definitions whose names end in _nid_no_patch or _nid_no_patch_cut are internal helpers and are not counted, unless an APS5_EXPORT in the library exports them under an explicit name. A definition is pending when its body calls NotImplemented_nid_no_patch, directly or through a recognized local stub wrapper. Call matching uses complete identifiers and accepts whitespace or comments before (. Other definitions are counted as implemented. Braces inside string literals, character literals and comments do not delimit bodies. These counts describe declared functions, not every firmware export, verified ABI compatibility or playable games. Silent behavior and unverified assumptions remain in Technical debt.
A library with no scanned definitions can include a sibling library's source builder. The scanner recognizes literal include(${CMAKE_CURRENT_SOURCE_DIR}/../<library>/<file>.cmake) references, including quoted paths. It does not evaluate arbitrary CMake expressions. It also recognizes a top-level .cpp that includes another library's source with #include "prx/<library>/<file>.cpp".
For these wrappers, the JSON group adds shared_sources with the source library's directory name. Its own counts and name lists remain empty. The HTML table links to the source library instead of showing 0/0; the source library's map tooltip lists its wrappers. Global totals count the definitions at the source library once.
A library with no scanned definitions and no shared sources, such as one whose Export.cpp only has APS5_DUMMY_FUN because its functions are implemented in another library, is listed as having no exports instead of 0/0. It is left out of the map.
History
tools/progress_history.py measures the first-parent history of main with the same rules as progress.py and writes history.json, history.svg and history.html (the chart with a tooltip per day plus a table, linked from the README and the end of the progress page). The chart plots counts, not percentages, so it shows how much is added over time: one panel for library functions and one for shader instructions, each on its own scale with the implemented count as a solid line and the declared total as a dashed one (for shaders the declared total is the instruction list in tools/rdna_isa.txt); the current percentage sits next to each panel's implemented label. It takes one point per UTC day, at the last commit of the day, and skips commits whose tree lacks the scanned paths. The chart compacts as days accumulate: up to 14 days it labels every day, up to 150 days one label per Monday, beyond that one per month; points are drawn up to 45 days, and every day keeps a hover tooltip, while the table and history.json keep every day. Old trees are measured with today's counting rules and instruction list, so the series is comparable but not what the page showed on that day. The workflow checks out the full history for it.
Comparisons
Comparisons identify functions by library and name. When a head group becomes a shared-source wrapper, its previous definitions are compared under the source library's identity. Removing a duplicate implementation is reported as sharing sources, without reporting the retained functions as removed.
Real removals and transitions back to stubs remain visible. Percentages retain the original snapshot totals, so eliminating duplicate accounting can change a percentage without changing available functionality. Older JSON snapshots without shared_sources are accepted.
PR reports include a table of changed libraries with implemented export counts, declared totals, percentages before and after, and changes in percentage points (pp). The table uses the same two JSON snapshots as the global report. A library appears when its counts, export names or shared-source owner change, including when its counts stay equal. Unchanged libraries are omitted, and the table lists at most 100 libraries in name order with a count of omitted rows.
New or removed libraries show Not present on the missing side. Libraries whose snapshots contain both counts and report zero exports show No exports; if either count is absent, the table shows Counts unavailable. Wrappers show Shared sources with the source library's name. These rows show n/a for the percentage change. The table retains the scanner's counting rules; it does not measure compatibility.
Implemented definitions are also classified as behaviourally empty when their body holds only (void)name; discards and at most one constant return, bare return; or throw, including a return of a local static wrapper that is itself behaviourally empty; wrapper calls whose arguments contain calls do not qualify. Comparisons list newly implemented behaviourally empty functions without changing any count. Older JSON snapshots without inert_names are accepted.
One library
--module NAME limits the library totals to those directories under core/libs/prx. Repeat the flag to include several. A name that is not a directory is an error. Shader counts stay complete. A shared-source wrapper is included only when its own directory is named. --json prints the object written to progress.json on stdout, instead of the two summary lines. Either flag makes the output directory optional. Without them the directory is still required, and a run that names only the directory still writes the whole tree.
Verification
python3 tools/tests/test_progress.py
python3 tools/progress.py /tmp/anyps5-progress
python3 tools/progress.py --module libScePad
python3 tools/progress.py --json
python3 tools/tests/test_progress_history.py
The regressions check that adding test callbacks leaves counts and comparisons unchanged, including when a callback shares a pending function's name or a wrapper uses shared sources. They also create a source library and a copied wrapper, move the wrapper to a shared builder, check output labels and totals, then verify real regressions and removals are still reported. With BUILD_TESTING=ON and Python available, CTest registers them as progress_report.