02
Sat, Nov
2 New Articles

Let's Try to Avoid Using Subroutines

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

One thing that is surely ingrained in RPG programmers' heads is the use of subroutines. Hardly an RPG program exists today without subroutines (although I have recently had the "privilege" of working with one that has no subroutines--it isn't pretty!)

If you have my original RPG book, you've probably read the passage about my RPG instructor in college who, after reviewing my assignment, pointed to my EXSR statement and asked, "What's that?" Obviously, RPG was not his first language.

With virtually all iSeries shops having made the decision to migrate to RPG IV, the issue of subroutines is going to be an important one. Let me state first that there is nothing wrong with subroutines, nor do I think using them makes for bad programming. In fact, I believe just the opposite; subroutines are an important part of any successful RPG II or RPG III application. In addition, they are a viable holding ground for any RPG III application converted to RPG IV.

But in RPG IV, subroutines have strong competition in subprocedures. Subprocedures are so powerful and effective that I would suggest that if the developers at IBM had designed RPG IV without the burden of being 100% compatible with RPG III, they may not have instituted both subroutines and subprocedures--I believe only subprocedures would have made it into RPG IV.

Let's compare these two technologies.

Subroutines have access to what is now referred to as "global variables." Global variables are what we call every field and data structure declared in an RPG III source member, as well as all fields and data structures declared outside of subprocedures in RPG IV.

Subprocedures have access to these global variables in exactly the same way as subroutines.

Subroutines do not provide a way to scope variables to the subroutine; that is, there is no way to declare a field within a subroutine and protect it from being modified outside of that subroutine. This makes declaring work fields an art form.

Subprocedures provide support for what are called "local variables." Local variables are fields and data structures that are declared within a subprocedure. Those fields do not exist to the parts of the program that are outside of the subprocedure. In fact, local variables (by default) are created when the subprocedure is called, and they are destroyed when the subprocedure ends. Because of this local declaration, local variable names do not need to be unique throughout the RPG IV source member. You can declare a field within one subprocedure and declare another field with the same name within a second subprocedure; the two fields are completely separate and have no relationship to one another. Thus work-field naming no longer requires such creativity.

Subroutines do not provide a way to pass parameters to them. When calling a subroutine, you have to move all your fields to a set of work fields, call the subroutine, and then move the data from the work fields back to the original fields. Alternatively, you could, of course, write a subroutine that works with the original field names, but that can be problematic itself.

Subprocedures provide an even greater level of support for parameters than traditional program-to-program calls. Imagine calling a subroutine and passing it the field names and values you want it to manipulate. You can do that easily with subprocedures.

Subroutines are nearly as fast as inline code. A subroutine call is (internally) nothing more than an enhanced GOTO opcode. So entering and returning from a subroutine is about as fast as you can get without writing inline code.

There's no question subroutines will for the foreseeable future be faster to call than subprocedures. Subprocedures have additional overhead when they are called, far above that of a subroutine. The reason subprocedures have more overhead is because they do so much more. There is, in some languages, the capability of asking the compiler to "inline" the code for a subprocedure; sadly, IBM did not include that feature in RPG IV.

Of course, the overhead of the call to the subroutine or subprocedure is only one part of the overhead of a routine. The code in the routine is also a consideration, and in this context, both subroutines and procedures perform identically.

Subroutines can only be evoked with the EXSR and CASxx operation codes. This limits the ability to call the subroutine to a few situations.

Subprocedures may be called with the CALLB or CALLP operation codes, allowing you to pass parameters. In addition, a subprocedure may be called implicitly by coding it in an expression or conditional statement. This means you can evoke a procedure from, for example, an IF statement and get a value returned back to you within the expression. This gives you the ability to extend RPG IV with new functionality. Extending RPG IV with new functions is the foundation behind third-party add-on libraries such as the RPG ToolKit.

Breaking Old Habits

One of the biggest obstacles to moving to subprocedures is breaking the habit of writing subroutines whenever a piece of code needs to be isolated. It is standard practice to write a subroutine.

We have to teach ourselves to start asking the question, "Would this code be a good candidate for a subprocedure?" The answer will almost always be "yes."

In fact, I believe you should stop writing subroutines altogether when you move to RPG IV. I've seen some pretty convoluted subprocedures being created by experienced RPG III developers after having just moved to RPG IV. These subprocedures are nothing more than traditional main-line calcs stuffed into a subprocedure. That subprocedure, in turn, calls several subroutines within the subprocedure. That's just wrong.

The best way to stop an old habit, in my view, is cold turkey; just stop doing it. Don't wean yourself off subroutines by mixing subroutines and subprocedures; they are different animals. Subprocedures can do everything subroutines can do and lots, lots more.

In 2003 and beyond, there is no reason to be using subroutines in RPG IV source code. Let's work together to try to put and end to subroutines in new code and migrate toward subprocedures. Believe me, it's for your own good.

Bob Cozzi has been programming in RPG since 1978. Since then, he has written many articles and several books, including The Modern RPG IV Language--the most widely used RPG reference manual in the world. Bob is also a very popular speaker at industry events such as COMMON and RPG World and is the author of his own Web site, www.rpgiv.com, and of the RPG ToolKit, an add-on library for RPG IV programmers. Bob runs his own one-man iSeries consulting and contract programming firm in the Chicago area.

BOB COZZI

Bob Cozzi is a programmer/consultant, writer/author, and software developer. His popular RPG xTools add-on subprocedure library for RPG IV is fast becoming a standard with RPG developers. His book The Modern RPG Language has been the most widely used RPG programming book for more than a decade. He, along with others, speaks at and produces the highly popular RPG World conference for RPG programmers.


MC Press books written by Robert Cozzi available now on the MC Press Bookstore.

RPG TnT RPG TnT
Get this jam-packed resource of quick, easy-to-implement RPG tips!
List Price $65.00

Now On Sale

The Modern RPG IV Language The Modern RPG IV Language
Cozzi on everything RPG! What more could you want?
List Price $99.95

Now On Sale

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: