Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.
Measure each program and its control flow
Recipe ID
io.moderne.mainframe.prethink.AnalyzeProgramMetricsArtifact
io.moderne.recipe:recipes-mainframeUsage
Run this recipe
This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe AnalyzeProgramMetrics
If the recipe is not available locally, then you can install it using:
RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.
- RELEASE
- LATEST
- Pinned version
mod config recipes jar install io.moderne.recipe:recipes-mainframe:RELEASE
mod config recipes jar install io.moderne.recipe:recipes-mainframe:LATEST
mod config recipes jar install io.moderne.recipe:recipes-mainframe:0.1.0
Data tables
Program complexity
io.moderne.mainframe.analysis.table.ProgramComplexitySize and complexity per program, for ranking a portfolio by risk and effort.
Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.mainframe.analysis.table.ProgramComplexity
| Column | Description |
|---|---|
| Program | The COBOL program. |
| Cyclomatic complexity | McCabe: one plus every decision the program can take, counting each operand of a compound condition separately. |
| Statements | Procedure division statements. |
| Source lines | Lines of the program as written. |
| Comment lines | Source lines that are comments: an asterisk or slash in the indicator column. |
| Expanded lines | Lines with every copybook inlined where it is copied, which is what the compiler reads. A copybook that was not found adds nothing. |
| Expanded comment lines | Comment lines with every copybook inlined. |
| Paragraphs | Paragraphs declared. |
| Sections | Sections declared. |
| Data items | Data items declared, including those copied in. |
| Copybooks | Distinct copybooks copied in. More than twenty marks a program that is expensive to change, because its shape is set by files it does not own. |
| Calls | Distinct programs called. |
| Halstead volume | Volume over COBOL operators and operands. The absolute value means little; the spread across a portfolio is what ranks programs. |
| Maintainability index | The conventional 171-based index. Below about 65 reads as hard to maintain, below 20 as effectively unmaintainable. |
| Flags | Thresholds crossed, from published operating experience rather than invented: more than 20 copybooks, more than 100 statements per paragraph on average, cyclomatic complexity over 50, or a maintainability index under 65. |
Dead data
io.moderne.mainframe.analysis.table.DeadDataDeclared fields that nothing reads, and fields written but never read back.
Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.mainframe.analysis.table.DeadData
| Column | Description |
|---|---|
| Program | The COBOL program. |
| Field | The field, qualified by the records containing it. |
| Section | Where it is declared. LINKAGE and FILE items are read and written by something outside this program, so they are reported separately rather than treated as unused. |
| Verdict | UNUSED for a field neither read nor written; DEAD_STORE for one written but never read back. |
| Picture | The declared picture, for sizing what would be saved by dropping it. |
| Copybook | The copybook the field came from, where it came from one. A field dead in this program may well be live in another that copies the same book, so a copybook field is only safe to drop once every program is checked. |
Unreachable procedures
io.moderne.mainframe.analysis.table.UnreachableProceduresParagraphs and sections that no path from the program's entry point reaches.
Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.mainframe.analysis.table.UnreachableProcedures
| Column | Description |
|---|---|
| Program | The COBOL program. |
| Procedure | The unreachable paragraph or section. |
| Kind | Whether it is a paragraph or a section. |
| Position | Its position in source order, counting from zero. |
| Reachable procedures | How many procedures the program does reach, for comparison against its total. |
| Total procedures | How many procedures the program declares. |
PERFORM THRU range pathology
io.moderne.mainframe.analysis.table.ProcedureRangePathologyRanges that overlap without nesting, and jumps that leave a range part-way through.
Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.mainframe.analysis.table.ProcedureRangePathology
| Column | Description |
|---|---|
| Program | The COBOL program. |
| Kind | OVERLAPPING_RANGE for two ranges that partly overlap; RANGE_JUMP for a GO TO that leaves a performed range before its exit. |
| Range | The range concerned, as START THRU END. |
| Conflicts with | For an overlap, the other range. For a jump, the procedure jumped to. |
| Detail | Why it matters for anyone trying to restructure or extract the code. |
Findings
io.moderne.mainframe.analysis.table.FindingsEverything the mainframe analyses found wrong, ranked, with the evidence for each and the line it is on. Sort on priority.
Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.mainframe.analysis.table.Findings
| Column | Description |
|---|---|
| Priority | 1 for CRITICAL down to 4 for LOW, so the table sorts. |
| Severity | CRITICAL for code that cannot do what it was written to do, HIGH for what will break a migration if not decided deliberately, MEDIUM for what is worth knowing first, LOW for cleanup. |
| Category | What kind of problem it is, which is what groups the report into sections: DEAD_RULE, UNREACHABLE_CODE, COPYBOOK_DRIFT, MIGRATION_BLOCKER, RANGE_PATHOLOGY, DEAD_DATA, COMPLEXITY, LAYOUT_DRIFT, IMS_PCB_MISMATCH, IMS_SEGMENT_NOT_SENSITIVE, IMS_IO_AREA_MISMATCH, MFS_MESSAGE_LENGTH, SCREEN_ITEM_UNREACHED, SCREEN_FIELD_UNREACHED, PARSE_FAILURE, UNDOCUMENTED, STALE_DOCUMENTATION, STALE_REFERENCE, UNENFORCED_BUILD_ORDER, UNSCHEDULED_JOB, AUTOCALL_RESOLVED_REFERENCE, UNRESOLVED_EXECUTION_PATH, INHERITED_SETTING, UNLOAD_NEEDS_REDESIGN, UNLOAD_ACCESS_MODE, UNLOAD_CONSISTENCY, UNLOAD_OUTPUT_WIRING, MIXED_SUBSTITUTION. |
| Program | The COBOL program, or the copybook where the finding is about one. |
| Summary | The finding in one sentence, written to be read on its own. |
| Evidence | Why this is claimed — the conditions that conflict, the two declarations that differ, the caller that made the paragraph unreachable. A finding nobody can check is a finding nobody will act on. |
| Where | The paragraph, section or data item the finding is in. |
| Source path | The file, so the finding can be opened. |
Source files that had results
org.openrewrite.table.SourcesFileResultsSource files that were modified by the recipe run.
Export after a run
mod study . --last-recipe-run \
--data-table org.openrewrite.table.SourcesFileResults
| Column | Description |
|---|---|
| Source path before the run | The source path of the file before the run. null when a source file was created during the run. |
| Source path after the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
| Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
| Recipe that made changes | The specific recipe that made a change. |
| Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
| Cycle | The recipe cycle in which the change was made. |
Source files that had search results
org.openrewrite.table.SearchResultsSearch results that were found during the recipe run.
Export after a run
mod study . --last-recipe-run \
--data-table org.openrewrite.table.SearchResults
| Column | Description |
|---|---|
| Source path of search result before the run | The source path of the file with the search result markers present. |
| Source path of search result after run the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
| Result | The trimmed printed tree of the LST element that the marker is attached to. |
| Description | The content of the description of the marker. |
| Recipe that added the search marker | The specific recipe that added the Search marker. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrorsThe details of all errors produced by a recipe run.
Export after a run
mod study . --last-recipe-run \
--data-table org.openrewrite.table.SourcesFileErrors
| Column | Description |
|---|---|
| Source path | The file that failed to parse. |
| Recipe that made changes | The specific recipe that made a change. |
| Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStatsStatistics used in analyzing the performance of recipes.
Export after a run
mod study . --last-recipe-run \
--data-table org.openrewrite.table.RecipeRunStats
| Column | Description |
|---|---|
| The recipe | The recipe whose stats are being measured both individually and cumulatively. |
| Source file count | The number of source files the recipe ran over. |
| Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
| Cumulative scanning time (ns) | The total time spent across the scanning phase of this recipe. |
| Max scanning time (ns) | The max time scanning any one source file. |
| Cumulative edit time (ns) | The total time spent across the editing phase of this recipe. |
| Max edit time (ns) | The max time editing any one source file. |