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

 
AAPL
$101.15
Apple Inc.
+1.04
MSFT
$46.33
Microsoft Corpora
-0.11
GOOG
$577.06
Google Inc.
+0.70

MacTech Search:
Community Search:

Software Updates via MacUpdate

QuickBooks 2015 16.0.0.1352 R1 - Financi...
QuickBooks 2015 helps you manage your business easily and efficiently. Organize your finances all in one place, track money going in and out of your business, and spot areas where you can save.... Read more
Mac DVDRipper Pro 5.0.1 - Copy, backup,...
Mac DVDRipper Pro is the DVD backup solution that lets you protect your DVDs from scratches, save your batteries by reading your movies from your hard disk, manage your collection with just a few... Read more
Apple OS X bash Update 1.0 - Fix for sec...
The OS X bash Update fixes a security flaw in the bash UNIX shell on OS X 10.9.5 (also on OS X 10.8 and 10.7 [see Related Links below]). OS X 10.9.5 or later Downloads for OS X 10.8 and OS X 10.7 in... Read more
SyncTwoFolders 2.0.5 - Syncs two user-sp...
SyncTwoFolders simply synchronizes two folders. It supports synchronization across mounted network drives and it is a possibility to run a simulation showing in a log what will be done. Please visit... Read more
FinderPop 2.5.7 - Classic Mac utility, n...
FinderPop is a Universal preference pane that extends OS X's contextual menus using a FinderPop Items folder much as the Apple Menu Items folder used to do for the Apple menu. It has other features... Read more
VueScan 9.4.45 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
LibreOffice 4.3.2.2 - Free Open Source o...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
calibre 2.4 - Complete e-library managem...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital... Read more
Default Folder X 4.6.9b1 - Enhances Open...
Default Folder X attaches a toolbar to the right side of the Open and Save dialogs in any OS X-native application. The toolbar gives you fast access to various folders and commands. You just click... Read more
Beamer 2.0.4 - Stream any movie file fro...
Beamer streams to your Apple TV.... Plays any movie file - Just like the popular desktop movie players, Beamer accepts all common formats, codecs and resolutions. AVI, MKV, MOV, MP4, WMV, FLV. To... Read more

Latest Forum Discussions

See All

Shred It! Review
Shred It! Review By Jennifer Allen on September 30th, 2014 Our Rating: :: GORGEOUS BUT BASICUniversal App - Designed for iPhone and iPad It might look lovely, but Shred It! is a pretty shallow endless runner/snowboarding game.   | Read more »
It Came From Canada: Angry Birds: Transf...
Anyone afraid that throwing Transformers into the Angry Birds mix would result in a Michael Bay-level of childhood pillaging can rest easy. While Rovio’s famous fowls may be a 21st century staple, Angry Birds: Transformers wears its affection for... | Read more »
Galaxy Trucker Review
Galaxy Trucker Review By Rob Thomas on September 30th, 2014 Our Rating: :: IN FOR THE LONG HAULiPad Only App - Designed for the iPad We got a great big convoy, rockin’ through the night… the endless night of outer space, that is.... | Read more »
Moon and Sun – children’s book Review
Moon and Sun – children’s book Review By Amy Solomon on September 30th, 2014 Our Rating: Moon and Sun is a fable-like children’s book with lush illustrations.   Developer: Marcio Monteiro Price: $3.99 Version: 1.0 App Reviewed on... | Read more »
Kairosoft Finally Brings The Pyraplex to...
Kairosoft Finally Brings The Pyraplex to iOS Posted by Jessica Fisher on September 30th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Yeti’s Parole Officer Review
Yeti’s Parole Officer Review By Jennifer Allen on September 30th, 2014 Our Rating: Universal App - Designed for iPhone and iPad Yeti’s Parole Officer proves that looks aren’t everything in this entertaining, if plain, piece of... | Read more »
Record Keeper and World Wide Words – Two...
Record Keeper and World Wide Words – Two New Final Fantasy Games Arrive on iOS in Japan Posted by Ellis Spice on September 30th, 2014 [ permalink ] | Read more »
iPollute Review
iPollute Review By Nadia Oxford on September 30th, 2014 Our Rating: :: iPOLLUTE, uPOLLUTEUniversal App - Designed for iPhone and iPad iPollute is a delightful-looking pollution simulator, though it’s a bit light on “game” content... | Read more »
This Week at 148Apps: September 22-26, 2...
Your Source For The Latest App Reviews   | Read more »
Kill Shot Review
Kill Shot Review By Jennifer Allen on September 29th, 2014 Our Rating: :: OCCASIONAL MISFIRESUniversal App - Designed for iPhone and iPad Kill Shot is often satisfying, but its more than pushy in-app purchases will leave you... | Read more »

Price Scanner via MacPrices.net

MacBook Airs on sale for $100 off MSRP, start...
Best Buy has the new 2014 MacBook Airs on sale for $100 off MSRP on their online store. Choose free home shipping or free local store pickup (if available). Prices valid for online orders only, in-... Read more
Apple Releases OS X Mavericks bash Update 1.0...
Apple has released a patch update for OS X Mavericks users to address the recently-detected “Shellshock” security bug in BSD UNIX’s bash shell. Apple says only a few Mac users who had manually... Read more
Pivotal Payments Ready for Apple Pay – FlexPo...
Pivotal Payments, a provider of merchant services and global payment processing solutions, has announced its proprietary FlexPoint platform will support credit and debit transactions through Apple’s... Read more
iStabilizer Announces Tabarm — First Friction...
iStabilizer, a specialist in universal lightweight compact tripods, steady cams, dollies, mounts, and remotes for smartphones, tablets, and cameras, announced today the iStabilizer tabArm, the first... Read more
IStabilizer Flex Smartphone Tripod Wins Usa T...
iStabilizer, a specialist in universal lightweight compact tripods, steady cams, and other products for smartphones, tablets, and cameras, has announced today that its iStabilizer Flex smartphone... Read more
13-inch 2.8GHz Retina MacBook Pro on sale for...
B&H Photo has the new 2014 13″ 2.8GHz Retina MacBook Pro on sale for $1699.99 including free shipping plus NY sales tax only. They’ll also include free copies of Parallels Desktop and LoJack for... Read more
15-inch Retina MacBook Pros on sale for up to...
B&H Photo has the new 2014 15″ Retina MacBook Pros on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY sales tax only. They’ll also include free copies of Parallels Desktop... Read more
Get Down to Business On Your iPad With Free N...
Utah based Poem LLC has introduced Nexticy 1.0, a full-featured, affordable (Free) forms application for iPad. Nexticy makes it ‘way easy’ to create, store, retrieve and analyze paper-like forms of... Read more
13-inch Retina MacBook Pros on sale for $100...
Best Buy has 13-inch 2.6GHz Retina MacBook Pros on sale for $100 off MSRP on their online store. Choose free shipping or free local store pickup (if available). Prices are for online orders only, in-... Read more
Reports Outline Claimed 12-Inch Macbook Air D...
Blogger Jack March says that according to information he’s received from an anonymous “source familiar with Apple’s plans,” the next-generation MacBook Air will launch in mid-2015 and be available... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.