TweetFollow Us on Twitter

Fortran Debugging
Volume Number:9
Issue Number:3
Column Tag:Jörg's Folder

LS Tools for FORTRAN Debugging

The easy way to avoid those bugs that make you feel foolish.

By Jörg Langowski, MacTech Magazine Regular Contributing Author

Whoever has written a more or less complicated program (and you probably wouldn’t be reading this if you hadn’t) knows that the hardest bug to find is always the next-to last (you won’t find the last one, of course). I’m using Fortran for most of my programming (and even dare to admit that): it is nice to be able to use math libraries and other existing code and put that directly on the Macintosh. But whenever I sit for days over a piece of code and just don’t see why it won’t work, only to find out that I had mixed up the order of parameters or their types in some obscure subroutine call, I start hating programming in general and Fortran in particular. In C++ types are checked: if you try to pass an integer for a real, the compiler will complain. If I only had the time to recode all my stuff into C++, I’d probably do so.

But at the moment, I’m working a lot with Fortran, like many of my colleagues. So we’d better have some good debugging aids that save us time. Language Systems has just presented a series of such tools, which I’d like to tell you about.

FLint

A typical error in languages which don’t have type checking is to pass a parameter of a wrong type to a subroutine. Look at the following example:

 program calls
 
 real*8 x
 real*8 b(50,50)
 integer n
 character*40 c
 
 call sub_a (x, b, n, c)
 write (*,*) ((b(i,j),i=1,5),j=10,15)
 
 call sub_a (b, n, x, c)
 write (*,*) ((b(i,j),i=1,5),j=10,15)
 
 end
 
 subroutine sub_a(x, b, n, c)
 
 real*8 x
 real*4 b(50,50)
 integer n

 character*40 c

 do i=1,50
 do j=1,50
 b(i,j) = i + 0.01*j
 end do
 end do
 
 return
 end

where the subroutine sub_a, which writes into the array b, is called twice from a main program. Both calls are wrong: in the first case, an array of the wrong type is passed (real*4 instead of real*8), and on the second call, the order of the parameters is completely mixed up. Of course, the output values, after the calls to sub_a, will be totally wrong.

The example is trivial, and the error in this case would be rather easy to catch. The program even ran on my machine without complaints, even though the subroutine will write half the values for b into no-man’s land, the array passed being only half as big as it should be. However, errors of this kind do happen often enough, and will be much harder to catch in a complex program than in the isolated example given here.

The interesting thing is that the compiler swallows the code without any error or warning messages. It would be nice to have a tool which will indicate if a subroutine has been called with the wrong number or type of arguments.

LSFlint, contained in the debugging toolkit for LS Fortran distributed by Language Systems, does this kind of type checking, and a lot of other things. It runs under the MPW shell; for testing the example above (in file calls.f), you might type

LSFlint calls.f

and you’ll get this output:

      call sub_a (b, n, x, c)
### lsflint - Warning - SUB_A arg   2:N, possible size discrepancy exists
### lsflint - Warning - SUB_A arg   2:N, possible type discrepancy exists
### lsflint - Warning - SUB_A arg   3:X, possible size discrepancy exists
### lsflint - Warning - SUB_A arg   3:X, possible type discrepancy exists
    File "calls.f"; Line 11
#------------------------------------------------------------
    File "calls.f"; Line 8 # earlier usage
#------------------------------------------------------------

      subroutine sub_a(x, b, n, c)
### lsflint - Warning - SUB_A arg   2:B, possible size discrepancy exists
### lsflint - Warning - SUB_A arg   2:B, possible type discrepancy exists
    File "calls.f"; Line 16
#------------------------------------------------------------
    File "calls.f"; Line 8 # earlier usage
#------------------------------------------------------------

Of course, LSFlint includes complete syntax checking, you’ll get the same syntax error messages as the compiler would give you for wrong code. It works at almost the same speed as the compiler: in my test it took 7 minutes for checking a program of a total of 4355 lines of code, while the compiler (at opt=3) took 5:30 minutes. However, in that case it created pages of warning messages (that was on a program that ran correctly!): about variables that had been declared but never used, about possible problems with passing pointers to matrices in subroutine calls, and even about some places where I had called a subroutine with the wrong number of parameters! It is actually amazing that that program gave the correct answers. This will give me now some opportunity to really ‘lint out’ that code, which is what LSFlint is all about.

An obvious area of application for LSFlint is for those who use Macintosh system calls from Fortran. You can easily make a mistake about which parameters have to be passed by value, by reference, and which are 16 or 32 bits long. All those errors will be caught by LSFlint.

Finally, if you are still using common blocks in your code (which I think is an ugly practice, especially since LS Fortran now allows named global variables), the program will detect differences in the size of common blocks and other discrepancies between routines. Also, when structures are passed to subroutines it will not only be checked whether the size and type of the elements matched, but whether the structure actually has the correct name. All in all, a very useful tool for improving Fortran code (one must mention that Lint, a similar utility for C code, has been available on the Unix scene from various sources for a long time). Still, you have to write your own code.

DebugLib

The second tool included in the LS debugging toolkit is DebugLib, a debugging library. By linking your code with DebugLib.o (it contains routines which override some of those in FORTRANLib.o), you will have interactive control over the various debugging options that Language Systems Fortran offers: until now, you would have had to recompile the program for changing those options. Now, when you have compiled a program with -debug=3 -r -ov and linked with the debugging library, a dialog appears when you execute the program that allows you to set the debugging options interactively:

Figure 1

Each time the dialog comes up, it tells you where you are in the program (top two lines), and lets you check the debugging options. The last option is especially useful; it will let the program pause (and redisplay this dialog) on each subroutine entry, when you hold down the caps lock key. Thus, by releasing the caps lock key you may accelerate your program while it is executing uncritical sections of code. There is also an option that tries to recover from stack overflow errors by increasing the stack space; this can be important if you use lots of local variables that take up space on the stack on every subroutine call. The other options should be evident; you know already the trace window from earlier versions of LS Fortran (it displays continuously the line and routine name where the program is executing).

SourceBug

Finally, the debugging toolkit contains a copy of Apple’s SourceBug, an interactive source code debugger that is much easier to use (though less powerful) than the SADE debugger. It needs a symbol file that the compiler and linker create from your application; for LS Fortran, you use the -sym option for the compiler and the -sym on option for the linker. You then open up SourceBug, and use the Open command from its File menu to start up your application. SourceBug will then open the ‘program browser’ which contains a list of all the source files that make up your program and for each source file all its routines.

You can set breakpoints in your program simply by choosing a routine with the two lists on top, and then click next to the program line where you want to have the breakpoint. Of course, SADE would give you much better control, for instance you can have conditional breakpoints; but SourceBug is very straightforward to use and needs no long setting up, like SADE.

Figure 2

You start your application by selecting ‘Run’ from a Control menu. When the program then hits the breakpoint, a second browser will come up, the ‘stack crawl’ window, which shows the routine where the break occurred and the calling sequence starting with the main program:

Figure 3

Here, you may now inspect the values of all variables simply by selecting them with the mouse and selecting ‘Evaluate’. I should say that you may find some difficulties here when you select big arrays to display; it takes forever to refresh the window which displays its values. But for simple variables or smaller arrays, it works just fine.

Other goodies

There has been more information on my desk about new Products that run with Fortran. Two tools, also available through Language Systems for some time now, are a plotting library called SuperPlot and a ‘code structurer’ that converts spaghetti code into nicely stratified lasagna. A review of these two utilities is long overdue, and I’ll try to put it into this column before long. But until then, we should also hear again about C++ and Forth.

MacForth people, please take note that we are desperately looking for good examples written for MacForth - we’d like to cover the only commercial Forth product for the Macintosh a little more than we have usually been doing (which should not be difficult).

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Creative Kit 1.1 - $149.99
Creative Kit 2016--made exclusively for Mac users--is your ticket to the most amazing images you've ever created. With a variety of powerful tools at your fingertips, you'll not only repair and fine-... Read more
iMazing 2.2.3 - Complete iOS device mana...
iMazing (was DiskAid) is the ultimate iOS device manager with capabilities far beyond what iTunes offers. With iMazing and your iOS device (iPhone, iPad, or iPod), you can: Copy music to and from... Read more
Fantastical 2.3.6 - Create calendar even...
Fantastical 2 is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event... Read more
Apple Configurator 2.4 - Configure and d...
Apple Configurator makes it easy to deploy iPad, iPhone, iPod touch, and Apple TV devices in your school or business. Use Apple Configurator to quickly configure large numbers of devices connected to... Read more
WhatRoute 2.0.18 - Geographically trace...
WhatRoute is designed to find the names of all the routers an IP packet passes through on its way from your Mac to a destination host. It also measures the round-trip time from your Mac to the router... Read more
Fantastical 2.3.6 - Create calendar even...
Fantastical 2 is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event... Read more
Creative Kit 1.1 - $149.99
Creative Kit 2016--made exclusively for Mac users--is your ticket to the most amazing images you've ever created. With a variety of powerful tools at your fingertips, you'll not only repair and fine-... Read more
iMazing 2.2.3 - Complete iOS device mana...
iMazing (was DiskAid) is the ultimate iOS device manager with capabilities far beyond what iTunes offers. With iMazing and your iOS device (iPhone, iPad, or iPod), you can: Copy music to and from... Read more
Apple Configurator 2.4 - Configure and d...
Apple Configurator makes it easy to deploy iPad, iPhone, iPod touch, and Apple TV devices in your school or business. Use Apple Configurator to quickly configure large numbers of devices connected to... Read more
WhatRoute 2.0.18 - Geographically trace...
WhatRoute is designed to find the names of all the routers an IP packet passes through on its way from your Mac to a destination host. It also measures the round-trip time from your Mac to the router... Read more

Power Rangers: Legacy Wars beginner...
Rita Repulsa is back, but this time she's invading your mobile phone in Power Rangers: Legacy Wars. What looks to be a straightforward beat 'em up is actually a tough-as-nails multiplayer strategy game that requires some deft tactical maneuvering.... | Read more »
Hearthstone celebrates the upcoming Jour...
Hearthstone gets a new expansion, Journey to Un'Goro, in a little over a week, and they'll be welcoming the Year of the Mammoth, the next season, at the same time. There's a lot to be excited about, so Blizzard is celebrating in kind. Players will... | Read more »
4 smart and stylish puzzle games like Ty...
TypeShift launched a little over a week ago, offering some puzzling new challenges for word nerds equipped with an iOS device. Created by Zach Gage, the mind behind Spelltower, TypeShift boasts, like its predecessor, a sleak design and some very... | Read more »
The best deals on the App Store this wee...
Deals, deals, deals. We're all about a good bargain here on 148Apps, and luckily this was another fine week in App Store discounts. There's a big board game sale happening right now, and a few fine indies are still discounted through the weekend.... | Read more »
The best new games we played this week
It's been quite the week, but now that all of that business is out of the way, it's time to hunker down with some of the excellent games that were released over the past few days. There's a fair few to help you relax in your down time or if you're... | Read more »
Orphan Black: The Game (Games)
Orphan Black: The Game 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Dive into a dark and twisted puzzle-adventure that retells the pivotal events of Orphan Black. | Read more »
The Elder Scrolls: Legends is now availa...
| Read more »
Ticket to Earth beginner's guide: H...
Robot Circus launched Ticket to Earth as part of the App Store's indie games event last week. If you're not quite digging the space operatics Mass Effect: Andromeda is serving up, you'll be pleased to know that there's a surprising alternative on... | Read more »
Leap to victory in Nexx Studios new plat...
You’re always a hop, skip, and a jump away from a fiery death in Temple Jump, a new platformer-cum-endless runner from Nexx Studio. It’s out now on both iOS and Android if you’re an adventurer seeking treasure in a crumbling, pixel-laden temple. | Read more »
Failbetter Games details changes coming...
Sunless Sea, Failbetter Games' dark and gloomy sea explorer, sets sail for the iPad tomorrow. Ahead of the game's launch, Failbetter took to Twitter to discuss what will be different in the mobile version of the game. Many of the changes make... | Read more »

Price Scanner via MacPrices.net

Is A New 10.5-inch iPad Still Coming In April...
There was no sign or mention of a long-rumored and much anticipated 10.5-inch iPad Pro in Apple’s product announcements last week. The exciting iPad news was release of an upgraded iPad Air with a... Read more
T-Mobile’s Premium Device Protection Now Incl...
Good news for T-Mobile customers who love their iPhones and iPads. The “Un-carrier” has become the first national wireless company to give customers AppleCare Services at zero additional cost as part... Read more
FileWave Ensures Support for Latest Apple OS...
FileWave multi-platform device management providers announced support for Apple’s release yesterday of iOS 10.3, macOS Sierra 10.12.4, and tvOS 11.2. FileWave has a history of providing zero-day... Read more
Use Apple’s Education discount to save up to...
Purchase a new Mac or iPad using Apple’s Education Store and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free: -... Read more
Apple refurbished Apple Watches available sta...
Apple is now offering Certified Refurbished Series 1 and Series 2 Apple Watches for 14-16% off MSRP, starting at $229. An Apple one-year warranty is included with each watch. Shipping is free: Series... Read more
9-inch 32GB Space Gray iPad Pro on sale for $...
B&H Photo has the 9.7″ 32GB Space Gray Apple iPad Pro on sale for $549 for a limited time. Shipping is free, and B&H charges NY sales tax only. Their price is $50 off MSRP. Read more
13-inch MacBook Airs on sale for $100-$150 of...
B&H Photo has 13″ MacBook Airs on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/128GB MacBook Air (MMGF2LL/A): $899 $100 off MSRP - 13″ 1.... Read more
13-inch MacBook Airs, Apple refurbished, in s...
Apple has Certified Refurbished 2016 13″ MacBook Airs available starting at $849. An Apple one-year warranty is included with each MacBook, and shipping is free: - 13″ 1.6GHz/8GB/128GB MacBook Air: $... Read more
12-inch Retina MacBooks on sale for $1199, sa...
B&H has 12″ 1.1GHz Retina MacBooks on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 12″ 1.1GHz Space Gray Retina MacBook: $1199 $100 off MSRP - 12″ 1.1GHz... Read more
Save up to $260 with Apple refurbished 12-inc...
Apple has Certified Refurbished 2016 12″ Retina MacBooks available for $200-$260 off MSRP. Apple will include a standard one-year warranty with each MacBook, and shipping is free. The following... Read more

Jobs Board

Fulltime aan de slag als shopmanager in een h...
Ben jij helemaal gek van Apple -producten en vind je het helemaal super om fulltime shopmanager te zijn in een jonge en hippe elektronicazaak? Wil jij werken in Read more
Desktop Analyst - *Apple* Products - Montef...
…technology to improve patient care. JOB RESPONSIBILITIES: Provide day-to-day support for Apple Hardware and Software in the environment based on the team's support Read more
*Apple* Mobile Master - Best Buy (United Sta...
**493168BR** **Job Title:** Apple Mobile Master **Location Number:** 000827-Denton-Store **Job Description:** **What does a Best Buy Apple Mobile Master do?** At Read more
Fulltime aan de slag als shopmanager in een h...
Ben jij helemaal gek van Apple -producten en vind je het helemaal super om fulltime shopmanager te zijn in een jonge en hippe elektronicazaak? Wil jij werken in Read more
*Apple* Mobile Master - Best Buy (United Sta...
**492889BR** **Job Title:** Apple Mobile Master **Location Number:** 000886-Norwalk-Store **Job Description:** **What does a Best Buy Apple Mobile Master do?** Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.