04
Mon, Nov
1 New Articles

The API Corner: More on UNIX-Type Time Values

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

There are some things you need to consider when using epoch-based time values.

 

Last month, in the article "Understanding and Using UNIX-Type Time Values," we looked at how to answer the specific question, "Does anyone know how to convert the time values that are returned from the stat() IFS api for an IFS file?" Two possible solutions were reviewed: using RPG timestamp support and also using C run-time API support. Today, we'll look at bit deeper into the time values returned by many UNIX-type APIs and some considerations related to the use of these time values.

 

As a review of the stat() API, this API (along with many other UNIX-type APIs) currently returns time values as a 4-byte signed integer value representing the number of seconds since the epoch, where the epoch is defined as January 1 1970 at time 00:00:00 UTC. A signed 4-byte integer can support a range of values from -2,147,483,648 to +2,147,483,647, which certainly seems like a whole lot of seconds, but just how much time is that?

 

If you add 2,147,483,647 seconds to January 1 1970 00:00:00, you end up with a maximum time that such an integer-based epoch time value can represent of January 19 2038 03:14:07 UTC. Rather reminiscent of Y2K, UNIX-type APIs such as stat() have a problem sometimes referred to as Y2K38. The problem is that depending on how an application is written, the second after January 19 2038 03:14:07 UTC may result in an error situation such as a numeric overflow, an incorrect date and time value such as January 1 1970 00:00:01 being returned, or some other failure just sure to ruin someone's day. This particular consideration, as it relates specifically to the stat() API, is not overly critical today (assuming that your system is currently running in the year 2012, which not all systems do, a little fact that might surprise some readers) as stat() only returns time values representing the date and time of a file's last access, last data change, and last status change.

 

The C run-time library does provide a set of APIs to expand the range of UNIX epoch-based time values. Last month, we looked at the ANSI C run-time APIs of ctime(), localtime(), and asctime(). Two of these APIs, ctime() and localtime(), have Y2K38 considerations as they represent time as 4-byte (32-bit) signed integer values. Starting with IBM i 6.1, the ILE C run-time library has provided extensions to these ANSI library functions that allow time to be represented as 8-byte signed integer (64-bit) values. Two of these APIs, named ctime64() and localtime64(), provide the same functionality of ctime() and localtime(), respectively, while supporting dates beyond the year 2038. Some other time-oriented APIs supporting 8-byte integer values based on the 1970 epoch are difftime64(), gmtime64(), mktime64(), and time64(). These APIs calculate the difference in seconds between two time values, convert a time value to a UTC-based time structure, convert a time value to a local-time-based time structure, and access the current UTC time, respectively.

 

An 8-byte integer (RPG 20i 0) can support a range of values from -9,223,372,036,854,775,808 to +9,223,372,036,854,775,807. This expanded range of values, when based on the January 1 1970 epoch, then allows for a maximum year value well in excess of the year 290 billion (109), a value I consider to provide sufficient breathing room over the previous Y2K38 limitation (though some of the time APIs encounter additional considerations earlier—for instance, after the year 9999 due to formatting considerations).

 

Use of these 64-bit APIs, if you're familiar with or already using the previous 32-bit APIs, is quite straightforward. Besides the change in the name of the API, the only other change is in the declaration of the time parameter (or for some APIs, the return value) being used, changing from 10i 0 to 20i 0. The one thing to keep in mind is that most industry APIs, like stat(), continue to define only 32-bit versions of the APIs, so you may need to assign the 32-bit time values to 64-bit values in order to use the 64-bit enabled APIs.

 

I'm confident that at some point in the future we'll see industry-defined APIs that replace existing APIs such as stat() and that support years beyond 2038. I also suspect that these new definitions may involve more changes than just going to 8-byte integer values for seconds since the 1970 epoch (that is, how the 64-bit ILE C extensions are implemented). Past industry discussions, for instance, have involved keeping track of time in milliseconds or microseconds as opposed to seconds. Increasing the granularity of  how time is measured would appear to make sense, given the rather small likelihood of 21st century (or even 25th century) applications needing to support years in excess of year 9999, let alone dates billions of years in the future.

 

For now, you will want to keep in mind that use of signed 4-byte integer epoch-based time values is going to require some application change prior to 2038. In order to minimize future impacts of Y2K38, you may want to come to a company agreement on how to track epoch-based time usage within your applications and how to implement coding standards in order to minimize future application program source code changes.

 

In the case of the stat() API, these coding standards might include the use of one central service program to actually call the stat() API, where the service program returns an 8-byte time value for subsequent application program usage. Alternatively, you may elect to replace calls to the stat() API with calls to the Get Attributes API (Qp0lGetAttr) documented here. The Get Attributes API, available since V4R3, returns creation time, last access time, and last data modification time as unsigned 4-byte integer values. Using an unsigned time value that is relative to the 1970 epoch does have the downside that stat()-like dates prior to 1970 are returned as Jan 1 1970 (which should not be a major concern for those systems running with a current year of 2012 as the i and the IFS didn't exist prior to 1970) and on the plus side, when used with the 64-bit enabled time APIs discussed earlier, provides an additional 60+ years of date support beyond Y2K38.

 

As usual, if you have any API questions, send them to me at This email address is being protected from spambots. You need JavaScript enabled to view it.. I'll see what I can do about answering your burning questions in future columns.

 

Bruce Vining

Bruce Vining is president and co-founder of Bruce Vining Services, LLC, a firm providing contract programming and consulting services to the System i community. He began his career in 1979 as an IBM Systems Engineer in St. Louis, Missouri, and then transferred to Rochester, Minnesota, in 1985, where he continues to reside. From 1992 until leaving IBM in 2007, Bruce was a member of the System Design Control Group responsible for OS/400 and i5/OS areas such as System APIs, Globalization, and Software Serviceability. He is also the designer of Control Language for Files (CLF).A frequent speaker and writer, Bruce can be reached at This email address is being protected from spambots. You need JavaScript enabled to view it.. 


MC Press books written by Bruce Vining available now on the MC Press Bookstore.

IBM System i APIs at Work IBM System i APIs at Work
Leverage the power of APIs with this definitive resource.
List Price $89.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: