08
Tue, Oct
2 New Articles

Partner TechTip: The Science Behind Analyzing Complex RPG Code

General
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

How do you deal with large, complex systems?

 

The field of science that studies how programmers interpret programs is called Program Comprehension. With the world's ever-growing pile of software, it's an important subject.

 

Research has led to useful ways to understand what programmers do, especially those who work with legacy systems. This is particularly important in the RPG world, which exhibits persistent attrition of programmers with application knowledge.

Mental Modeling of Programs

There's broad agreement that when presented with an unfamiliar program, programmers build knowledge and construct mental models, somewhat concurrently, in these areas:

 

  • Concept assignment—The mapping of real-world domain knowledge, e.g., business knowledge to statements or sections of code

 

  • Data flow—A model of the data input to and output by the program, along with categorization of transformations that take place

 

  • Control flow—A model of the sequence of operations that occur during execution, typically consisting of the primary driving loops in the program, key conditions and calls to subroutines, procedures, other programs; etc.

 

  • Static structure—The organization of the source code, irrespective of execution, e.g., what the subroutines and procedures are, how they're connected, what data descriptions exist, etc.

 

  • Feature location—The locating of all relevant source code pertaining to a particular feature— typically, a feature related to an assigned task

 

 

These models exist at both program and system levels. Obviously, building these mental models across many objects in a large system is far more challenging.

 

Here's a three-minute video on Agile Analysis of Legacy RPG Applications.

Strategies for Building Mental Models

Programmers follow different strategies, depending on their existing knowledge of the business domain and the program.

 

  • Bottom-up—Programmers who have little knowledge of the business or the program follow a bottom-up strategy by reading lines of code and "chunking" them together. These chunks can be grouped into larger chunks.

 

  • Top-down—Programmers who have business and/or program knowledge engage in the concept assignment and feature location functions described above and build the remainder of the models using these as drivers, resorting to chunking in unfamiliar sections.

 

  • Beacons—Not really a strategy, but an important concept and tool: beacons are key words, phrases, or just letters  that programmers scan for based on knowledge of domain, program, and software in general. Example: scan for occurrences of "write" in the code or perhaps "discount" and other words or phrases from the business or general software domains.

 

Not to be dismissed is the "read code for an hour" strategy, which we've all done when necessary, using whatever we can muster of the above techniques.

Crucial Barriers to Program Comprehension

One huge obstacle to comprehending a program is something rarely identified as an obstacle and is indeed often viewed as a language feature: delocalization. In Program Comprehension, delocalization is considered a fundamental problem.

 

What's delocalization? Basically, it's when you have to leave the source code you're looking at and navigate to source code somewhere else to look at that. Typically, this also involves a return trip. For example:

 

KEYLS1   CHAIN  ITMCONTP

What are those key fields? What fields are in the file?

 

EXSR  CALCLINS

What happens there?

 

CALL  IV100R

What's in that program?

 

If you're unfamiliar with a program, these statements require that you leave the statement and go elsewhere to understand what's happening. While this is a great way to organize programs, it has a high cost on the process of constructing mental models.

 

Here's a three-minute video on Hyper-Navigation of RPG Systems.

 

Delocalized statements require navigation. Navigation requires thinking—specifically, short-term memory. Scientists now believe that humans are able to hold only about three items in short-term memory. Engaging in navigation requires programmers to "swap out" what they had been constructing in their minds in order to do the navigation. Will that model be swapped backed in completely and accurately? This is a key source of defects and lower productivity in maintenance tasks.

Improving Productivity and Accuracy

While the challenges of delocalization and navigation don't present the only opportunities to improve software maintenance, they're highly significant, especially because static analysis tools exist that can make a big difference. X-Analysis from Databorough is surely the most comprehensive of these tools for AS/400 developers.

 

A good static analysis tool enables programmers to quickly and effortlessly navigate objects, routines, definitions, etc. throughout an application, with minimal mental disruption. Few ways are more effective at improving quality and productivity of software maintenance and enhancement tasks.

as/400, os/400, iseries, system i, i5/os, ibm i, power systems, 6.1, 7.1, V7, V6R1

Steve Kilner

Steve Kilner is a leading expert in the field of static analysis, software complexity metrics, and program comprehension. He is a specialist in the maintenance and migration of legacy software systems for the IBM i and has written extensively on the subject. As the founder of and current CEO of vLegaci, he developed a combination static and dynamic analysis tool for RPG. He currently leverages his experience through his partnership with Databorough, makers of X-Analysis.

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: