TweetFollow Us on Twitter

SADE Debugging
Volume Number:5
Issue Number:9
Column Tag:Programmer's Workshop

SADE™ Debugging

By Joe Pillera, Ann Arbor, MI

Debugging In MPW With SADE™

Joe Pillera is a Scientific Staff Member at Bell Northern Research (BNR) in Ann Arbor, Michigan. Prior to this he was a Systems Analyst at the Ford Motor Company. He earned his B.S. in Computer Science from Eastern Michigan University, and is now a Master’s of Computer Science degree candidate at Wayne State University. His primary area of research is object oriented programming and software engineering.

Introduction

A good debugger is a programmer’s best friend. One of the serious drawbacks to MPW (Macintosh Programmer’s Workshop) software development has always been a lack of a source level debugger (no, I don’t consider MacsBug hexadecimal dumps debugging!). Until now. Introducing SADE™ - the Symbolic Application Debugging Environment. This is Apple’s new source level debugger for MPW 3.0 and beyond.

In this article I plan to cover the following:

• An overview of SADE.

• SADE in action - debugging a sample C program.

• A numerical integrator - pushing the SADE script language to the limit.

• Talking straight - the good, the bad and the ugly.

Note that even though this is not a ‘comparison’ article, I will occasionally mention THINK’s Lightspeed™ debuggers (because of their excellent performance), as a frame of reference in discussing SADE.

Figure 1. The SADE Menu System

What Is SADE, Anyway?

SADE is not an MPW tool, nor is it physically part of the MPW shell. It is simply a stand-alone application that communicates with your target program under Multifinder. As in THINK’s Lightspeed C, this debugger must be operated under Multifinder, to allow interprocess communication. Two or more megs of memory are strongly recommended; however, the manual does indicate you can squeeze by with one meg. The only special requirements to run SADE are:

1. You must be using Multifinder 6.1b7 or later.

2. The (Pascal or C) compiler must be instructed to generate ‘symbol’ files during program compiles.

One of the more interesting design decisions Apple made was to make SADE appear almost identical to the MPW Shell. This has both an advantage and a disadvantage: the advantage is that of instant familiarity to existing MPW programmers; the disadvantage is that this precludes the use of a user-friendly, animated interface (such as the debuggers used in THINK’s Lightspeed C and Lightspeed Pascal).

Please refer to Figure 1 for a closer look at SADE’s functionality.

Wade Through Your Code With SADE

The most fundamental operation in using a debugger is setting a breakpoint in the source code. Because SADE is so sophisticated, there are four ways to do this:

1. Enter the break command from the SADE command interpreter. The syntax (for debugging a C program) is:

 break <function name>.(<line number>)

2. Call the function SysError from within the C code itself. The syntax of this approach is:

 #include <Errors.h>
 . . .
 SysError(<integer from 129..32511>).

3. Press the SADEKey (Command-Option-<period>).

4. Open a source code file (as read-only from SADE), and use the mouse to select a line of code. Then execute ‘Break’ from the SourceCmds menu.

Method number 1 is fine if your functions are small, otherwise counting the individual lines of code could prove cumbersome.

Why does method number 2 work? When using version 6.1b7 and above of Multifinder, MC68000 exceptions are passed to SADE, if present; if SADE isn’t a concurrently executing task, then a system exception occurs.

Personally, I think method number 3 is somewhat satirical; trying to guess which machine instruction you are now (ahem, were) executing can cause brain damage.

Method number 4, of course, appears to be the most user-friendly of them all.

So in practice, it would seem that all methods except number three can be easily used to set break points in your own code. Refer to Figure 2 for an example of starting up SADE and setting breakpoints. For an illustration of SADE stopping at a breakpoint, please refer to Figure 3. The MPW C source listings will also provide more information on how to set breakpoints within your own code.

One interesting thing I noticed is that a SysError() breakpoint will stop after that line of code is executed, whereas setting a normal breakpoint will stop before that line of code.

SADE has complete facilities for keeping track of variable values. You can either perform a Show Value, which shows the contents of the variable of your choice, or you can use the Watch feature. This feature is analogous to THINK’s Lightspeed Pascal’s ‘Observe’ window: every time a variable’s value changes, it is updated in a display window for you. Please refer to Figure 4 for an example from the ‘Test’ program.

And of course, you have complete code stepping facilities: single step lines of code, and even control whether or not you step into procedure calls.

Program Your Bugs Away

All of the aforementioned features can be found in most other debuggers. However, the feature that sets SADE apart from any other debugger I’ve used is its internal programming facility (henceforth, I’ll refer to SADE programs as ‘scripts’, to differentiate these from your C & Pascal programs). You can actually write SADE procedures and functions to automate debugging tasks. And if that’s not enough, how about a slew of predefined procedures (even printf ) and reserved system variables? Furthermore, complete expression evaluation is possible, including pointer manipulation, bit-wise operations, and string manipulation.

The script facility of SADE is so extensive, it strongly resembles Pascal. Not only that, SADE procedures and functions are fully capable of recursion. Unlike Pascal, however, all variables are dynamically typed - based on their use in the program; this would appear to be the result of an interpretative implementation of this language.

To execute a SADE script, enter the script name (followed by any arguments) and press ‘enter’ from the numeric keypad. Thus, script invocation is identical to executing MPW tools. Before a SADE subroutine can be run, the file that contains it must first be loaded into memory; this is done as follows:

 execute ‘<Full HFS Path>:<File Name>’

As an example, I’ve developed a general purpose numerical integration script, which when given any arbitrary function f(x), will find the (approximate) integral bounded between two values ‘a’ and ‘b’. The foundation to my algorithm is the SADE eval function; this function takes a string representing an expression, and then proceeds to parse it in search of an answer. For example:

 define x = 5
 eval(‘x * 2’)

When executed at the SADE command line, this would return ‘10’ as the result.

The technique of integration I use is called Simpson’s Rule, which partitions an interval from ‘a’ to ‘b’ an even number of times (i.e. N=2M partitions). We then approximate the graph of f(x) by M segments of parabolas; the technique is shown below:

In my case, I partition each region between n and n+1 four times, giving delta x the value of 0.25; integration then simply becomes a matter of alternating the coefficients of the intermediate data values.

Unfortunately, it wasn’t that easy - because I wanted to be able to integrate any continuous function I could think of, not just the simple ones. As it turns out, simple mathematical functions (such as x**n) are not known to SADE, so I had to write my own.

How did I do this for polynomials? Using something called a Taylor Expansion, it is possible to calculate x**n (x to the nth power), where either ‘x’ or ‘n’ can be floating point values. Taylor Expansions are open-ended functions, so it is necessary to determine a stopping criteria that is both accurate and efficient. The Taylor Expansion for x**n is shown below:

For example: because both ‘x’ and ‘n’ can be floating point numbers, integrating the square root of ‘x’ is simply a matter of integrating x**(1/2) power.

Just one more problem - ln(x) is not known to SADE either, so here’s the approximation for it:

This approximation, of course, is only valid for x > 0. For an example of a simple polynomial integration, please refer to Figure 5.

However, before you throw away your favorite numerical analysis package, I should warn you that I found SADE to have problems maintaining floating point precision. Take a look at my exponent script: I noticed that using tricks such as intermediate variables for subexpressions made the difference between a correct answer and something way out in left field. SADE’s natural habitat seems to be integers, which would make a lot of sense seeing how it’s a debugging environment. Therefore, even though Simpson’s Rule will (theoretically) work on any continuous function, my SADE script will only work in cases when SADE handles floating point calculations correctly. We should remember, that SADE is a debugging environment, so I don't consider this to be a drawback.

If all these features still aren’t enough, SADE even provides high level calls to prompt the user with dialog boxes, add custom menus, and even generate music! In short, SADE has every power-tool a programmer could ever ask for in a debugger.

Straight Talk About SADE

SADE is by far the most sophisticated and user-extendable debugger I’ve ever used - but I do have one complaint: its user interface. This drawback is caused by SADE’s own complexity: at times it seems to offer you too many features. All of these features in turn dictate a user-interface that’s not as elegant as the Lightspeed debuggers. If SADE were made to be more user-friendly, even at the expense of some of its bells and whistles, Apple would have a world-class debugger in their hands.

The End...

MacsBug, MPW, Multifinder and SADE are trademarks of Apple Computer, Inc. Lightspeed is a registered trademark of Lightspeed, Inc.

The opinions expressed here are solely those of the author, and not of Bell Northern Research Inc., or its employees.

BIBLIOGRAPHY

Apple Computer, Inc. (1989) SADE: Symbolic Application Debugging Environment, Apple Programmer’s and Developer’s Association, Cupertino, California.

Beyer, William H., PhD. (1978) “Series Expansion,” p.387 in Standard Mathematical Tables - 25th Edition, CRC Press Inc., Boca Raton, Florida.

Shenk, Al, PhD. (1979) “Techniques of Integration,” pp. 424-425 in Calculus and Analytic Geometry - 2nd Edition, Scott, Foresman and Company, Glenview, Illinois.

Symantec, Inc. (1989) “Debugging Programs,” pp. 103-110 in THINK’s Lightspeed Pascal User’s Manual, The Symantec Corporation, Cupertino, California.

Symantec, Inc. (1989) “The Debugger,” pp. 129-145 in THINK’s Lightspeed C User’s Manual, The Symantec Corporation, Cupertino, California.

========== The Integrator Script ===========

# ----------------------------------------
# A simple but powerful use of the SADE™
# script langauge to perform numercial
# integration on almost any function.
# ----------------------------------------
# Copyright © Joe Pillera, 1989
# All Rights reserved
# ----------------------------------------

# ----------------------------------------
#            func integrate(a,b) 
# ----------------------------------------
# Integrate a global function ‘f(x)’ from 
# a to b.  
# ----------------------------------------
# INPUTS:
# a -> integer or floating point
# b -> integer or floating point
# ----------------------------------------
func integrate(lower,upper)
  define factor, result, index, x
  index := lower
  factor := 2
  result := 0
  while index <= upper
    x := index
    if (index = lower) or (index = upper) then
      result := result + eval(f)
   else
     result := result + (factor * eval(f))
   end
   index := index + 0.25
   if factor = 2 then
     factor := 4
   else
     factor := 2
    end
  end
  return (1.0/12.0) * result
end

# ----------------------------------------
# func ln(x)  -> Compute natural log of x
# ----------------------------------------
# INPUTS:
# x -> integer or floating point
# ----------------------------------------
func ln(x)
  define result, term, index, frac
  term   := (x - 1.0) / (x + 1.0)
  result := term + (0.3333 * power(term,3))
  index := 5
  while index <= 25 do
    frac := 1.0 / index
    result := result + 
              (frac * power(term,index))
    index := index + 2
  end
  return (2.0 * result)
end

# ----------------------------------------
# func exponent(a,x) -> Compute a ** x 
# ----------------------------------------
# INPUTS:
# a -> integer or floating point
# x -> integer or floating point
# ----------------------------------------
# NOTE: Use power(a,x) if ‘x’ is a integer,
#       because that routine is faster.
# ----------------------------------------
func exponent(a,x)
  define result,iteration,term
  define numerator,denominator
  term   := x * ln(a) 
  result := 1.0 + term
  for iteration := 2 to 15 do
    numerator   := power(term,iteration)
   denominator := fact(iteration)
    result := result + 
              (numerator / denominator)
  end
  return result
end 

# ----------------------------------------
# func power(x,n)  -> Compute x ** n
# ----------------------------------------
# INPUTS:
# x -> integer or floating point
# n -> integer
# ----------------------------------------
# NOTE: Use iteration for speed.
# ----------------------------------------
func power(x,n)
  define index, result
  if n = 0 then
    return 1
  elseif n = 1 then
    return x
  else
    result := x
    for index := 2 to n do
     result := result * x
  end
  return result
end

# ----------------------------------------
# func fact(n)  -> Compute n!
# ----------------------------------------
# INPUTS:
# n -> integer 
# ----------------------------------------
func fact(n)
  if n = 0 then
    return 1
  elseif n = 1 then
    return 1
  else
    return ( n * fact(n-1) )
  end
end

================== Main.C ==================

#include <Errors.h>

int  number;

main()
{    
  /* Set breakpoint #1 here (from SADE) */
  number = 1;
  
  /* Now pass control to func, and let */
  /* it alter the “number” variable.   */
  func();
 
  /* Hard code breakpoint #3 here */
  SysError(129); 
}

================== Func.C ==================

extern int number;

void func()
{
  /* Set breakpoint #2 here (from SADE) */
  number = 10;
}

================== Test.R ==================

#include “SysTypes.r”

resource ‘vers’ (1) {
    0x1,
    0x00,
    release,
    0x0,
    verUS,
    “”,
    “1.0 / MacTutor Magazine”
};

resource ‘vers’ (2) {
    0x1,
    0x00,
    release,
    0x0,
    verUS,
    “”,
    “For Use With MPW SADE™ Only!”
};

=============== Make File =================

Test ƒƒ Test.make test.r
 Rez test.r -append -o Test
func.c.o ƒ Test.make func.c
  C -sym on func.c
main.c.o ƒ Test.make main.c
  C -sym on main.c

SOURCES = test.r func.c main.c
OBJECTS = func.c.o main.c.o

Test ƒƒ Test.make {OBJECTS}
 Link -w -t APPL -c ‘????’ -sym on -mf 
 {OBJECTS} 
 “{CLibraries}”CRuntime.o 
 “{Libraries}”Interface.o 
 “{CLibraries}”StdCLib.o 
 “{CLibraries}”CSANELib.o 
 “{CLibraries}”Math.o 
 “{CLibraries}”CInterface.o 
 -o Test

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

TunnelBear 3.0.1 - Subscription-based pr...
TunnelBear is a subscription-based virtual private network (VPN) service and companion app, enabling you to browse the internet privately and securely. Features Browse privately - Secure your data... Read more
ExpanDrive 5.4.0 - Access cloud storage...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
Opera 40.0.2308.62 - High-performance We...
Opera is a fast and secure browser trusted by millions of users. With the intuitive interface, Speed Dial and visual bookmarks for organizing favorite sites, news feature with fresh, relevant content... Read more
Apple iOS 10.0.2 - The latest version of...
iOS 10 is the biggest release of iOS ever. A massive update to Messages brings the power of the App Store to your conversations and makes messaging more personal than ever. Find your route with... Read more
Herald 7.0 - Notification plugin for Mai...
Note: Versions 2.1.3 (for OS X 10.7), 3.0.6 (for OS X 10.8), 4.0.8 (for OS X 10.9), 5.0.2 (for OS X 10.10), and 6.0.3 (for OS X 10.11) are no longer supported by the developer. Herald is a... Read more
Postbox 5.0.2 - Powerful and flexible em...
Postbox is a new email application that helps you organize your work life and get stuff done. It has all the elegance and simplicity of Apple Mail, but with more power and flexibility to manage even... Read more
Yummy FTP Pro 1.11.10 - $29.99
Yummy FTP Pro is an advanced Mac file transfer app which provides a full-featured professional toolkit combined with blazing speeds and impeccable reliability, so whether you want to transfer a few... Read more
Tidy Up 4.1.17 - $29.99
Tidy Up is a full-featured duplicate finder and disk-tidiness utility. Features With Tidy Up you can search for duplicate files and packages by the owner application, content, type, creator,... Read more
Logitech Control Center 3.9.5 - Keyboard...
Logitech Control Center (LCC) is designed to support OS X and allows you to take full advantage of your Logitech keyboard, mouse, or trackball. With the LCC you can: Browse the Internet using... Read more
Macgo Blu-ray Player 2.16.17 - Blu-ray p...
Macgo Blu-ray Player can bring you the most unforgettable Blu-ray experience on your Mac. Overview Macgo Mac Blu-ray Player can satisfy just about every need you could possibly have in a Blu-ray... Read more

How to build and care for your team in D...
Before you hit the trail and become a dog sledding legend, there’s actually a fair bit of prep work to be done. In Dog Sled Saga, you’re not only racing, you’re also building and caring for a team of furry friends. There’s a lot to consider—... | Read more »
How to win every race in Dog Sled Saga
If I had to guess, I’d say Dog Sled Saga is the most adorable racing game on the App Store right now. It’s a dog sled racing sim full of adorable, loyal puppies. Just look at those fluffy little tails wagging. Behind that cute, pixelated facade is... | Read more »
Let the war games commence in Gunship Ba...
Buzz Lightyear famously said, “This isn’t flying, this is falling – with style!” In the case of Gunship Battle: Second War, though, this really is flying - with style! The flight simulator app from Joycity puts you in control of 20 faithfully... | Read more »
How to get a high score in Fired Up
Fired Up is Noodlecake Games’ high score chasing, firefighting adventure. You take control of a wayward firefighter who propels himself up the side of a highrise with blasts of water. Sound silly? It is. It’s also pretty difficult. You can’t... | Read more »
NBA 2K17 (Games)
NBA 2K17 1.0 Device: iOS iPhone Category: Games Price: $7.99, Version: 1.0 (iTunes) Description: Following the record-breaking launch of NBA 2K16, the NBA 2K franchise continues to stake its claim as the most authentic sports video... | Read more »
Dog Sled Saga (Games)
Dog Sled Saga 1.0.1 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0.1 (iTunes) Description: A game by Dan + Lisa As a rookie musher, foster a dogsledding team whose skills will grow if they're treated right. Week by... | Read more »
60 Seconds! Atomic Adventure (Games)
60 Seconds! Atomic Adventure 1.2 Device: iOS Universal Category: Games Price: $2.99, Version: 1.2 (iTunes) Description: 60 Seconds! is a dark comedy atomic adventure of scavenge and survival. Collect supplies and rescue your family... | Read more »
Tons of Bullets! (Games)
Tons of Bullets! 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Tons of BulletsA retro 2D pixel platformer infused with tons of bullets and tons of features!Fight as Kenji the Ninja and... | Read more »
Sorcery! 4 (Games)
Sorcery! 4 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: *** PLEASE NOTE: Sorcery! 4 requires a minimum of iPad 3 or iPhone 4 *** An epic adventure through a cursed citadel of monsters,... | Read more »
Building the perfect Animation Throwdown...
Animation Throwdown is a casual card game full of plenty of inside jokes from some of your favorite cartoons. It’s accessible as far as card games go, but that’s not to say that it hands your victories to you easily. There’s quite a bit that goes... | Read more »

Price Scanner via MacPrices.net

Duplicate Sweeper Free On Mac App Store For O...
To celebrate the launch of Apple’s latest macOS Sierra, Stafford, United Kingdom based Wide Angle Software has announced that its duplicate file finder software, Duplicate Sweeper, is now available... Read more
13-inch Retina MacBook Pros on sale for up to...
B&H Photo has 13″ Retina Apple MacBook Pros on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1174.99 $125 off MSRP - 13... Read more
Evidence Surfaces Pointing To New A10X Chip F...
Citing a job description for a Project Lead position at Apple’s Austin, Texas engineering labs, Motley Fool’s Ashraf Eassa deduces that development is progressing well on Apple’s next-generation in-... Read more
Check Print’R for macOS Allows Anyone to Easi...
Delaware-based Match Software has announced the release and immediate availability of Check Print’R 3.21, an important update to their easy-to-use check printing application for macOS. Check Print’R... Read more
Apple refurbished 11-inch MacBook Airs availa...
Apple has Certified Refurbished 11″ MacBook Airs (the latest models), available for up to $170 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Apple refurbished 15-inch Retina MacBook Pros...
Apple has Certified Refurbished 2015 15″ Retina MacBook Pros available for up to $380 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 15″ 2... Read more
Major Version 5 Release Of Free myTuner Radio...
AppGeneration Software has announced the release of myTuner Radio 5.0.1, an important update to their live radio app for iOS and Android platforms. With myTuner Radio, you can listen to more than 30,... Read more
TheAppStore Searches And Filters iOS And macO...
Boston based InchWest has announced the official launch of TheAppStore, a free web based service that lets users search iOS and Mac apps on the web without iTunes or the App store. TheAppStore... Read more
2TB Time Capsule on sale for $199, save $100
Amazon has 2TB Apple Time Capsules on sale for $199 including free shipping. Their price is $100 off MSRP. Choose Amazon as the seller when making your purchase, rather than a third party seller. Read more
12-inch 1.2GHz Rose Gold Retina MacBook on sa...
Amazon.com has the 2016 12″ 1.2GHz Rose Gold Retina MacBook on sale for $1254.02 including free shipping. Their price is $345 off MSRP, and it’s the lowest price available for this model from any... Read more

Jobs Board

Senior *Apple* Administrator - Pratt Instit...
POSITION SUMMARY: Directs the coordination and standardization of campus-wide Apple systems, including planning, analysis and implementation of Apple -related Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
*Apple* Retail - Multiple Positions- Napervi...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
US- *Apple* Store Leader Program - Apple (Un...
…Summary Learn and grow as you explore the art of leadership at the Apple Store. You'll master our retail business inside and out through training, hands-on Read more
*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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.