29
Fri, Nov
0 New Articles

Copying Data Faster

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

I recently did an unscientific performance test comparing MOVEL, EVAL, the C runtime function named memcpy, and an MI instruction named CPYBYTES. I was surprised by the results. So let's review those results and look at the basic purpose of each of these functions.

MOVEL Opcode

The MOVEL and MOVE opcodes are always converted to the CPYBLA or CPYBRA MI instructions for character data copying. If the P (pad) operation extender is used, then the opcodes are converted to CPYBLAP and CPYBRAP respectively. The CPYBLAx and CPYBRAx instructions have been around for decades and perform very well.

The MOVEL opcode sometimes generates additional code that copies its value to a work field and then copies that value to the target. This is rare, but it can happen.

You can call CPYBLAx or CPYBRAx directly by prototyping the MI instruction. In RPG IV, the prototypes would appear as follows:

D cpybla          PR                  ExtProc('cpybla')   
D  pTarget                        *   Value               
D  pSource                        *   Value               
D  nSrcLen                      10I 0 Value               
                                                          
D cpyblap         PR                  ExtProc('cpyblap')  
D  pTarget                        *   Value               
D  nTgtLen                      10I 0 Value               
D  pSource                        *   Value               
D  nSrcLen                      10I 0 Value               
D  cPadChar                      1A   Value               

It is obviously more complicated to prototype and call these MI instructions than it is to simply use the MOVEL opcode, but you do gain a very slight performance advantage.

EVAL Opcode

Probably one of the most surprising results of my performance test was that EVAL is slower than most other methods of copying data. This is a major disappointment. You would think that IBM would have optimized EVAL, considering that the company advocates free-format syntax as well as the hybrid syntax most people use. In both cases, EVAL is the foundation for copying character data and should be the most optimized of any operation.

Since RPG IV is a new compiler, I can't simply dump the IRP (MI instruction stream) listing and see what code EVAL generates. I can't read the new MI used for ILE, so I don't know what the issue is with EVAL. Granted, it isn't a show-stopper, and I will continue to use it, but in performance-critical situations, I may choose other methods.

This performance issue with EVAL may have originated with the original programmer of that opcode (who left the RPG IV team before RPG IV was announced), or it may have been code from the extremely poorly designed CAT, SUBST, and XLATE opcodes introduced back in RPG III. Originally, those opcodes were so poorly implemented that I spent hours on the phone with IBM trying to get them to change things. Eventually, IBM did correct the problem, and the flaws in that original code have been worked out. But I worry that, because something so poorly designed made it into the compiler, maybe the same thing happened with EVAL.

C Function: memcpy()

The memcpy() function is actually pretty cool once you get used to using it. When I learned C some 15+ years ago, I thought it was the C function that was most like the RPG MOVEL opcode.

The memcpy() function copies data from one field to another. It uses pointers to identify the source and target locations, giving you the ability to use it like a substring operation or a straight copy function. When I run out of room on an RPG IV statement because of the length of the %SUBST, I'll often use memcpy(). Consider this line of code, for example:

eval   %subst(target : 7) = %subst(source:7:5)

That can often be replaced with this:

callp   memcpy(%addr(target)+7: %addr(source)+7:5)

However, I might do this instead:

Eval  pTarget = %addr(target)+7
Eval  pSource = %addr(source)+7
callp   memcpy(pTarget: pSource : 5)

The prototype for memcpy() follows. Note that there are two underscore characters (_) at the beginning of the function name in the EXTPROC keyword:

D memcpy          PR                  ExtProc('__memcpy') 
D  pTarget                        *   Value 
D  pSource                        *   Value 
D  nLength                      10U 0 Value 

CPYBYTES MI Instruction

The final method to copy character data that I investigated was the CPYBYTES MI instruction. This instruction is supposed to run twice as fast as memcpy() or CPYBLAx. I recently learned of this instruction from a long-time friend from IBM Rochester (now retired) who is probably the smartest person I know. In fact, they've banned him from Las Vegas casinos because he can count cards seemingly without end.

In any event, he said that CPYBYTES runs two times as fast as memcpy because it does not copy data that contains pointers. This gives the optimizer a bit of an advantage as it doesn't have to do the normal things it would do when handling data that may contain pointers.

Virtually none of the data in RPG programs contains pointers--or rather, none that is copied normally contains pointers. So CPYBYTES can, generally speaking, be used anytime RPG IV applications need better performance.

Calling CPYBYTES is about the same as calling memcpy(): You specify the address of the target, followed by the address of the source, followed by the number of bytes to copy. Here is the prototype:

D cpybytes        PR                  ExtProc('_CPYBYTES') 
D  pTarget                        *   Value 
D  pSource                        *   Value 
D  nLength                      10U 0 Value 

I use memcpy() or CPYBYTES to copy large variables (several thousand characters in length) or repeatedly copy data over and over (thousands of copies). In the RPG xTools, I use memcpy() in the CPYUSRSPACE (Copy User Space Data) procedure because user space may contain pointers; therefore, CPYBYTES was not a viable option.

So give these alternatives to MOVEL and EVAL a try if you have a performance-critical situation or just want to have fun.

To download the prototypes from this article, visit the RPGLab, where you can find a set of free source code, including all the MI and C prototypes featured in this article. It's hosted free on the RPGIV.com Web site.

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.

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: