02
Sat, Nov
2 New Articles

RPG Academy: Debug Done Right - Working with Watch Conditions

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

Knowing your way around a debug source and knowing how to set and remove breakpoints is very important, but sometimes you need more than that. That’s where watch conditions come into play.

You use a watch condition to monitor whether the current value of an expression or a variable changes while your program runs. Setting watch conditions is similar to setting conditional breakpoints, with one important difference: Watch conditions stop the execution of the program as soon as the value of a watched expression or variable changes from its current value, regardless of the place in the code where that change occurs. Conditional breakpoints, on the other hand, stop the program only if the variable has the value specified in the breakpoint condition when the execution reaches the line where the breakpoint was set. In other words, a watch condition monitors the value of the variable globally, while the breakpoint simply checks whether a certain condition is met before the execution of a given line of code.

The watch condition monitors a variable through the content of a storage address, computed at the time the watch condition is set. When the content at the storage address is changed from the value it had when the watch condition was set, the program stops. The same thing occurs when you tell the debugger to continue the execution (I’ll explain this later), and the value of the watched variable changes again. To put it in another way, once you put a watch on a variable, whenever that variable’s content changes, the program stops, relinquishing control back to you.

There are a few more important facts you need to be aware of when it comes to watches:

  • Watches are monitored systemwide; a maximum of 256 watches can be active simultaneously. This number includes watches set by the system, which are invisible to you. Depending on the overall system use, you might be limited in the number of watch conditions you can set at a given time. If you try to set a watch condition while the maximum number of active watches across the system is exceeded, you receive an error message, and the watch condition is not set. Personally, I’ve never seen this happen, but IBM says it’s possible.
  • Unlike breakpoints, watch conditions can be set only when a program is stopped under debug and the variable to be watched is in scope. When you try to add a watch before the program execution begins, an error message is issued when a watch is requested, indicating that the corresponding call stack entry does not exist.
  • After the command is successfully run, your program is stopped if a program in your session changes the contents of the watched storage location, and the Display Module Source screen is shown. If the program has debug data and a source text view is available (i.e., if it was compiled with a dbgview keyword other than *none and *stmt), it will be shown, popping up “magically.” The source line of the statement that was about to be run and would change the contents of the watched variable is highlighted. A message indicates which watch condition was met. Unfortunately, if the program cannot be debugged, the text area of the display will be blank.
  • Eligible programs are automatically added to the debug session if they cause the watch-stop condition, which is a tremendous help when you have a complex service program structure.
  • When multiple watch conditions are triggered on the same program statement, only the first one will be reported.
  • You can also set watch conditions when you are using service jobs for debugging (that’s when you debug one job from another job). Typically, this is used to debug batch jobs, as explained later in this subseries.

Having said all of that, it’s time to show how to add and remove watches. As with breakpoints, there’s more than one way to do it. Let’s start with the debug command: Simply type watch <variable name> followed by Enter, and a watch will be set for that variable, saving the current content of <variable name> for later comparison. You can also position the cursor on top of the variable you want to watch (in the Display Module screen) and press F17.

When it comes to removing watches, you can press F18 in the Display Module screen or type WATCH and press Enter. Note that I didn’t specify any parameters. Either course of action will cause the Work with Watch window to pop up. In this window, similar to the Work with Module Breakpoints window, you can use option 4 to remove a watch. Finally, the CLEAR debug command can also be used for watches; simply type CLEAR WATCH <watch number> to remove a given watch. (Watch numbers can be obtained in the Work with Watches window.)

You’re probably wondering if you couldn’t simply use CLEAR PGM to nuke breakpoints and watches at the same time. The very smart people at IBM decided (wisely, if you ask me) that this would be a very bad idea, so you need to use CLEAR WATCH ALL instead to remove all the debug session’s watches. Note that it’s also possible to display details about a watch in the Work with Watches window by using option 5. Something similar to Figure 1 will be displayed.

RPG Academy: Debug Done Right - Working with Watch Conditions - Firgure 1

Figure 1: Watch-related information, obtained via option 5 of the Work with Watch window.

This is nearly all the theory you need to know about the ILE debugger. The next logical step, which we’ll begin exploring in next month’s TechTip, is to start working with the real thing. For now, feel free to comment, suggest, or share your experience in the Comments section below or in the LinkedIn groups where my articles usually pop up.

 

Rafael Victoria-Pereira

Rafael Victória-Pereira has more than 20 years of IBM i experience as a programmer, analyst, and manager. Over that period, he has been an active voice in the IBM i community, encouraging and helping programmers transition to ILE and free-format RPG. Rafael has written more than 100 technical articles about topics ranging from interfaces (the topic for his first book, Flexible Input, Dazzling Output with IBM i) to modern RPG and SQL in his popular RPG Academy and SQL 101 series on mcpressonline.com and in his books Evolve Your RPG Coding and SQL for IBM i: A Database Modernization Guide. Rafael writes in an easy-to-read, practical style that is highly popular with his audience of IBM technology professionals.

Rafael is the Deputy IT Director - Infrastructures and Services at the Luis Simões Group in Portugal. His areas of expertise include programming in the IBM i native languages (RPG, CL, and DB2 SQL) and in "modern" programming languages, such as Java, C#, and Python, as well as project management and consultancy.


MC Press books written by Rafael Victória-Pereira available now on the MC Press Bookstore.

Evolve Your RPG Coding: Move from OPM to ILE...and Beyond Evolve Your RPG Coding: Move from OPM to ILE...and Beyond
Transition to modern RPG programming with this step-by-step guide through ILE and free-format RPG, SQL, and modernization techniques.
List Price $79.95

Now On Sale

Flexible Input, Dazzling Output with IBM i Flexible Input, Dazzling Output with IBM i
Uncover easier, more flexible ways to get data into your system, plus some methods for exporting and presenting the vital business data it contains.
List Price $79.95

Now On Sale

SQL for IBM i: A Database Modernization Guide SQL for IBM i: A Database Modernization Guide
Learn how to use SQL’s capabilities to modernize and enhance your IBM i database.
List Price $79.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: