Sidebar

Implementing and Maintaining Your User Entry Point Table (UEPT)

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

A UEPT will improve the performance of external program calls to user programs.

 

This article is a follow-up to my System Entry Point Table (SEPT) article. One of our readers, Mark Waterbury, suggested that I write it. In my SEPT article, I discussed the performance gains in API invocations brought by the SEPT object. Actually, to improve the performance of external program calls to user programs, you can also implement your own "SEPT," or, in other words, your User Entry Point Table (UEPT) objects for performance-critical applications following the same rationale of SEPT.

 

From the discussion in my SEPT article, you probably already realize that there's no doubt that a UEPT will also improve the performance of external program calls to user programs. This article will focus on the following topics:

  • How to implement a UEPT via a User Space (USRSPC) object and how to use it
  • When to maintain a UEPT

Implementing a UEPT via a User Space (USRSPC) Object

We always stand on the shoulders of giants. In most cases, we resolve problems by taking advantage of the knowledge left to us by our predecessors. Now, when you decide to implement a UEPT, you can simply borrow the design of the SEPT. Let's go through the process of implementing a UEPT step by step.

 

First, you must decide where to store the content (the system pointers to your user programs) of a UEPT. The SEPT object, QSYS/QINSEPT, is a permanent space object that resides in the machine context, or in other words, the QSYS library. The MI object type/sub-type code of the SEPT object is hex 19C3. The SEPT stores 16-byte system pointers to almost all APIs (user domain, system state programs in QSYS) and other programs in QSYS one by one in its associated space. So the object you use to store the content of your UEPT must fulfill the following criteria:

  • It is a space object in the user domain or its associated space is in the user domain so that the UEPT can be accessed from user programs at security level 40 or above.
  • It can be created, modified, or deleted conveniently by CL commands or APIs.

 

The answer is quite obvious: a user domain User Space (USRSPC) object. A user domain USRSPC has MI object type/sub-type code hex 1934. It can be created by the Create User Space (QUSCRTUS) API; it can be deleted by CL command Delete User Space (DLTUSRSPC); the content of a USRSPC can also be conveniently read or modified via User Space APIs or MI instructions. The Retrieve User Space (QUSRTVUS) API returns a piece of storage in a USRSPC directly. The Change User Space (QUSCHGUS) API modifies the content of a USRSPC directly; and the Retrieve Pointer to User Space (QUSPTRUS) API or the Set Space Pointer from Pointer (SETSPPFP) MI instruction retrieves a space pointer to the content of a user-domain user space so that the data in that user space can then be directly manipulated by high-level language (HLL) programs that support pointers. For example, you might create your UEPT object so that it can contain at least 2,048 system pointers, like the following.

 

CALL PGM(QUSCRTUS)

     PARM('UEPT      QGPL'   /* USRSPC name and library name */

          'UEPT'             /* Object attribute */

          X'00008000'        /* Initial size of the UEPT USRSPC: 32K */

          X'00'              /* Initial value of the UEPT USRSPC */

          '*USE'             /* Public authority of the created UEPT USRSPC */

          'Your first UEPT'  /* Text description */

     )

 

To store system pointers to your user programs into the created UEPT, you could use either the QUSPTRUS API or the SETSPPFSP MI instruction to retrieve a space pointer addressing the associated space of your UEPT and then store system pointers to your user programs into your UEPT. To reserve the validity of pointers, it is important to make sure that each system pointer written into your UEPT object is aligned at 16-byte boundaries. Note that you must not use the QUSCHGUS API to write system pointers directly into your UEPT. The QUSCHGUS API does not preserve the tagged bits in the input pointers; therefore, the pointers written into a space object become invalid.

 

Fill System Pointers to User Programs into Your UEPT

Suppose you have three user programs—QGPL/PGMA, QGPL/PGMB, and QGPL/PGMC—that you want to store into your UEPT at offsets 0, 16, and 32, respectively. The following example ILE RPG program, filluept.rpgle, will add system pointers to PGMA, PGMB, and PGMC into your created UEPT.

 

     /**

      * @file filluept.rpgle

      *

      */

     h dftactgrp(*no)

 

      /copy mih52

     d                 ds

     d uept                            *

     d uept_fellow                     *   procptr

     d                                     overlay(uept)

     d uept_ptr        s               *

     d uepts           s               *   dim(3)

     d                                     based(uept_ptr)

     d qgpl            s               *

 

      /free

           // resolve your UEPT [1]

           rslvsp_tmpl.obj_type = x'1934';

           rslvsp_tmpl.obj_name = 'UEPT';

           rslvsp2(uept : rslvsp_tmpl);

 

           // retrieve a space pointer addressing the

           // associated space of the UEPT. [2]

           uept_ptr = setsppfp(uept_fellow);

 

           // save system pointers to user programs

           // into the UEPT [3]

           rslvsp_tmpl.obj_type = x'0401';

           rslvsp_tmpl.obj_name = 'QGPL';

           rslvsp2(qgpl : rslvsp_tmpl);

 

           rslvsp_tmpl.obj_type = x'0201';

           rslvsp_tmpl.obj_name = 'PGMA';

           rslvsp4(uepts(1) : rslvsp_tmpl : qgpl);

 

           rslvsp_tmpl.obj_type = x'0201';

           rslvsp_tmpl.obj_name = 'PGMB';

           rslvsp4(uepts(2) : rslvsp_tmpl : qgpl);

 

           rslvsp_tmpl.obj_type = x'0201';

           rslvsp_tmpl.obj_name = 'PGMC';

           rslvsp4(uepts(3) : rslvsp_tmpl : qgpl);

 

           *inlr = *on;

      /end-free

 

Notes on the above example program:

  • [1] Resolve the system pointer uept to your UEPT.
  • [2] Retrieve the space pointer uept_ptr, addressing the associated space of your UEPT. An array of system pointers to your user programs, uepts, is declared to be based on uept_ptr.
  • Resolve each system pointer to your user programs in uepts by first resolving the system pointer to the context (library) in which your user programs reside and then resolving system pointers to your user programs via system built-in _RSLVSP4.

 

Prototypes of system built-ins _RSLVSP2 and _RSLVSP4 can be found in mih52.rpgleinc.

 

Alternatively, you may also use the Change User Space (CHGUSRSPC) command provided by the Space Object Tools subproject of open-source project i5/OS Programmer's Toolkit. Figure 1 is a screen-shot of writing a system pointer to program PGMA into the UEPT at offset 0 via the CHGUSRSPC command.

 

120110JunleiLi-Figure-1
Figure 1: Write a system pointer to program PGMA into the UEPT. (Click image to enlarge.)

 

Using the following CL commands, you could implement the same jobs as the above-mentioned FILLUEPT program.

 

CHGUSRSPC USRSPC(UEPT)

          DTATYPE(*PTR)

          SYSOBJ(PGMA)

          OBJTYPE(*PGM)

CHGUSRSPC USRSPC(UEPT)

          OFFSET(16)  

          DTATYPE(*PTR)

          SYSOBJ(PGMB)

          OBJTYPE(*PGM)

CHGUSRSPC USRSPC(UEPT)

          OFFSET(32)  

          DTATYPE(*PTR)

          SYSOBJ(PGMC)

          OBJTYPE(*PGM)

 

Use Your UEPT

Here is a simple example of how to use your prepared UEPT object to do external program calls to your user programs, testuept.rpgle.

 

     /**

      * @file testuept.rpgle

      *

      */

     h dftactgrp(*no)

 

      /copy mih54

     d                 ds

     d uept                            *

     d uept_fellow                     *   procptr

     d                                     overlay(uept)

     d uept_ptr        s               *

     d uepts           s               *   dim(3)

     d                                     based(uept_ptr)

     d argv            s               *   dim(3)

     d UEPT_PGMA       c                   1

 

      /free

           // resolve your UEPT

           rslvsp_tmpl.obj_type = x'1934';

           rslvsp_tmpl.obj_name = 'UEPT';

           rslvsp2(uept : rslvsp_tmpl);

           uept_ptr = setsppfp(uept_fellow);

 

           // ...

           callpgmv( uepts(UEPT_PGMA)

                   : argv

                   : 0 );

 

           *inlr = *on;

      /end-free

 

Note that declaring a list of constants for index numbers of entries in your UEPT and including it into your programs that use the UEPT will make maintaining programs using the UEPT more convenient when your UEPT is upgraded from version to version.

When to Maintain a UEPT

Entries (system pointers) of the SEPT are resolved in the installation stage of the system and will never need to be updated until next installation, since the APIs they point to will never change. In contrast with the SEPT, user programs pointed to by entries (system pointers) in a UEPT are likely to change from time to time. So you must know when entries in your UEPT should be re-resolved to ensure that they point to the correct programs.

 

Just like other permanent objects in IBM i's single-level storage (SLS) address space, the segment ID of the base segment in the system pointer to a user program changes when one of the following occurs, which will then cause a resolved system pointer to the user program to become invalid:

  • The user program is saved and restored to either the same library it has resided in or a different library.
  • The user program is moved from one library to another library by using the Move Object (MOVOBJ) command.
  • The user program is re-created by compiler commands, such as CRTBNDRPG or CRTPGM.
  • The user program is modified by a Change Program (CHGPGM) command, unless the CHGPGM command is changing the program's text description only.

 

Note that a Rename Object (RNMOBJ) operation on a permanent object will not change the system pointer to it. Actually, according to the rationale that context objects (libraries) manage objects' addressabilities, there isn't a direct relationship between an object's symbolic ID (object name and MI object type) and the system pointer to it. That's why an object that has been renamed and moved to the QRPLOBJ library as the result of a create command with parameter REPLACE(*YES) has the system pointer pointing to it unchanged.

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

 

Junlei Li

Junlei Li is a programmer from Tianjin, China, with 10 years of experience in software design and programming. Junlei Li began programming under i5/OS (formerly known as AS/400, iSeries) in late 2005. He is familiar with most programming languages available on i5/OS—from special-purpose languages such as OPM/ILE RPG to CL to general-purpose languages such as C, C++, Java; from strong-typed languages to script languages such as QShell and REXX. One of his favorite programming languages on i5/OS is machine interface (MI) instructions, through which one can discover some of the internal behaviors of i5/OS and some of the highlights of i5/OS in terms of operating system design.

 

Junlei Li's Web site is http://i5toolkit.sourceforge.net/, where his open-source project i5/OS Programmer's Toolkit (https://sourceforge.net/projects/i5toolkit/) is documented.

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

RESOURCE CENTER

  • WHITE PAPERS

  • WEBCAST

  • TRIAL SOFTWARE

  • White Paper: Node.js for Enterprise IBM i Modernization

    SB Profound WP 5539

    If your business is thinking about modernizing your legacy IBM i (also known as AS/400 or iSeries) applications, you will want to read this white paper first!

    Download this paper and learn how Node.js can ensure that you:
    - Modernize on-time and budget - no more lengthy, costly, disruptive app rewrites!
    - Retain your IBM i systems of record
    - Find and hire new development talent
    - Integrate new Node.js applications with your existing RPG, Java, .Net, and PHP apps
    - Extend your IBM i capabilties to include Watson API, Cloud, and Internet of Things


    Read Node.js for Enterprise IBM i Modernization Now!

     

  • Profound Logic Solution Guide

    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 companyare not aligned with the current IT environment.

    Get your copy of this important guide today!

     

  • 2022 IBM i Marketplace Survey Results

    Fortra2022 marks the eighth edition of the IBM i Marketplace Survey Results. Each year, Fortra captures data on how businesses use the IBM i platform and the IT and cybersecurity initiatives it supports.

    Over the years, this survey has become a true industry benchmark, revealing to readers the trends that are shaping and driving the market and providing insight into what the future may bring for this technology.

  • Brunswick bowls a perfect 300 with LANSA!

    FortraBrunswick is the leader in bowling products, services, and industry expertise for the development and renovation of new and existing bowling centers and mixed-use recreation facilities across the entertainment industry. However, the lifeblood of Brunswick’s capital equipment business was running on a 15-year-old software application written in Visual Basic 6 (VB6) with a SQL Server back-end. The application was at the end of its life and needed to be replaced.
    With the help of Visual LANSA, they found an easy-to-use, long-term platform that enabled their team to collaborate, innovate, and integrate with existing systems and databases within a single platform.
    Read the case study to learn how they achieved success and increased the speed of development by 30% with Visual LANSA.

     

  • Progressive Web Apps: Create a Universal Experience Across All Devices

    LANSAProgressive Web Apps allow you to reach anyone, anywhere, and on any device with a single unified codebase. This means that your applications—regardless of browser, device, or platform—instantly become more reliable and consistent. They are the present and future of application development, and more and more businesses are catching on.
    Download this whitepaper and learn:

    • How PWAs support fast application development and streamline DevOps
    • How to give your business a competitive edge using PWAs
    • What makes progressive web apps so versatile, both online and offline

     

     

  • The Power of Coding in a Low-Code Solution

    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:

    • Discover the benefits of Low-code's quick application creation
    • Understand the differences in model-based and language-based Low-Code platforms
    • Explore the strengths of LANSA's Low-Code Solution to Low-Code’s biggest drawbacks

     

     

  • Why Migrate When You Can Modernize?

    LANSABusiness 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.
    In this white paper, you’ll learn how to think of these issues as opportunities rather than problems. We’ll explore motivations to migrate or modernize, their risks and considerations you should be aware of before embarking on a (migration or modernization) project.
    Lastly, we’ll discuss how modernizing IBM i applications with optimized business workflows, integration with other technologies and new mobile and web user interfaces will enable IT – and the business – to experience time-added value and much more.

     

  • UPDATED: Developer Kit: Making a Business Case for Modernization and Beyond

    Profound Logic Software, Inc.Having trouble getting management approval for modernization projects? The problem may be you're not speaking enough "business" to them.

    This Developer Kit provides you study-backed data and a ready-to-use business case template to help get your very next development project approved!

  • What to Do When Your AS/400 Talent Retires

    FortraIT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators is small.

    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:

    • Why IBM i skills depletion is a top concern
    • How leading organizations are coping
    • Where automation will make the biggest impact

     

  • Node.js on IBM i Webinar Series Pt. 2: Setting Up Your Development Tools

    Profound Logic Software, Inc.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. In Part 2, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Attend this webinar to learn:

    • Different tools to develop Node.js applications on IBM i
    • Debugging Node.js
    • The basics of Git and tools to help those new to it
    • Using NodeRun.com as a pre-built development environment

     

     

  • Expert Tips for IBM i Security: Beyond the Basics

    SB PowerTech WC GenericIn this session, IBM i security expert Robin Tatam provides a quick recap of IBM i security basics and guides you through some advanced cybersecurity techniques that can help you take data protection to the next level. Robin will cover:

    • Reducing the risk posed by special authorities
    • Establishing object-level security
    • Overseeing user actions and data access

    Don't miss this chance to take your knowledge of IBM i security beyond the basics.

     

     

  • 5 IBM i Security Quick Wins

    SB PowerTech WC GenericIn today’s threat landscape, upper management is laser-focused on cybersecurity. You need to make progress in securing your systems—and make it fast.
    There’s no shortage of actions you could take, but what tactics will actually deliver the results you need? And how can you find a security strategy that fits your budget and time constraints?
    Join top IBM i security expert Robin Tatam as he outlines the five fastest and most impactful changes you can make to strengthen IBM i security this year.
    Your system didn’t become unsecure overnight and you won’t be able to turn it around overnight either. But quick wins are possible with IBM i security, and Robin Tatam will show you how to achieve them.

  • Security Bulletin: Malware Infection Discovered on IBM i Server!

    SB PowerTech WC GenericMalicious programs can bring entire businesses to their knees—and IBM i shops are not immune. It’s critical to grasp the true impact malware can have on IBM i and the network that connects to it. Attend this webinar to gain a thorough understanding of the relationships between:

    • Viruses, native objects, and the integrated file system (IFS)
    • Power Systems and Windows-based viruses and malware
    • PC-based anti-virus scanning versus native IBM i scanning

    There are a number of ways you can minimize your exposure to viruses. IBM i security expert Sandi Moore explains the facts, including how to ensure you're fully protected and compliant with regulations such as PCI.

     

     

  • Encryption on IBM i Simplified

    SB PowerTech WC GenericDB2 Field Procedures (FieldProcs) were introduced in IBM i 7.1 and have greatly simplified encryption, often without requiring any application changes. Now you can quickly encrypt sensitive data on the IBM i including PII, PCI, PHI data in your physical files and tables.
    Watch this webinar to learn how you can quickly implement encryption on the IBM i. During the webinar, security expert Robin Tatam will show you how to:

    • Use Field Procedures to automate encryption and decryption
    • Restrict and mask field level access by user or group
    • Meet compliance requirements with effective key management and audit trails

     

  • Lessons Learned from IBM i Cyber Attacks

    SB PowerTech WC GenericDespite the many options IBM has provided to protect your systems and data, many organizations still struggle to apply appropriate security controls.
    In this webinar, you'll get insight into how the criminals accessed these systems, the fallout from these attacks, and how the incidents could have been avoided by following security best practices.

    • Learn which security gaps cyber criminals love most
    • Find out how other IBM i organizations have fallen victim
    • Get the details on policies and processes you can implement to protect your organization, even when staff works from home

    You will learn the steps you can take to avoid the mistakes made in these examples, as well as other inadequate and misconfigured settings that put businesses at risk.

     

     

  • The Power of Coding in a Low-Code Solution

    SB PowerTech WC GenericWhen 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:

    • Discover the benefits of Low-code's quick application creation
    • Understand the differences in model-based and language-based Low-Code platforms
    • Explore the strengths of LANSA's Low-Code Solution to Low-Code’s biggest drawbacks

     

     

  • Node Webinar Series Pt. 1: The World of Node.js on IBM i

    SB Profound WC GenericHave 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.
    Part 1 will teach you what Node.js is, why it's a great option for IBM i shops, and how to take advantage of the ecosystem surrounding Node.
    In addition to background information, our Director of Product Development Scott Klement will demonstrate applications that take advantage of the Node Package Manager (npm).
    Watch Now.

  • The Biggest Mistakes in IBM i Security

    SB Profound WC Generic The Biggest Mistakes in IBM i Security
    Here’s the harsh reality: cybersecurity pros have to get their jobs right every single day, while an attacker only has to succeed once to do incredible damage.
    Whether that’s thousands of exposed records, millions of dollars in fines and legal fees, or diminished share value, it’s easy to judge organizations that fall victim. IBM i enjoys an enviable reputation for security, but no system is impervious to mistakes.
    Join this webinar to learn about the biggest errors made when securing a Power Systems server.
    This knowledge is critical for ensuring integrity of your application data and preventing you from becoming the next Equifax. It’s also essential for complying with all formal regulations, including SOX, PCI, GDPR, and HIPAA
    Watch Now.

  • Comply in 5! Well, actually UNDER 5 minutes!!

    SB CYBRA PPL 5382

    TRY 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.

    Request your trial now!

  • Backup and Recovery on IBM i: Your Strategy for the Unexpected

    FortraRobot automates the routine 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:
    - Simplified backup procedures
    - Easy data encryption
    - Save media management
    - Guided restoration
    - Seamless product integration
    Make sure your data survives when catastrophe hits. Try the Robot Backup and Recovery Solution FREE for 30 days.

  • Manage IBM i Messages by Exception with Robot

    SB HelpSystems SC 5413Managing messages on your IBM i can be more than a full-time job if you have to do it manually. 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:
    - Automated message management
    - Tailored notifications and automatic escalation
    - System-wide control of your IBM i partitions
    - Two-way system notifications from your mobile device
    - Seamless product integration
    Try the Robot Message Management Solution FREE for 30 days.

  • Easiest Way to Save Money? Stop Printing IBM i Reports

    FortraRobot 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:

    - Automated report distribution
    - View online without delay
    - Browser interface to make notes
    - Custom retention capabilities
    - Seamless product integration
    Rerun another report? Never again. Try the Robot Report Management Solution FREE for 30 days.

  • Hassle-Free IBM i Operations around the Clock

    SB HelpSystems SC 5413For over 30 years, Robot has been a leader in systems management for IBM i.
    Manage your job schedule with the Robot Job Scheduling Solution. Key features include:
    - Automated batch, interactive, and cross-platform scheduling
    - Event-driven dependency processing
    - Centralized monitoring and reporting
    - Audit log and ready-to-use reports
    - Seamless product integration
    Scale your software, not your staff. Try the Robot Job Scheduling Solution FREE for 30 days.