TweetFollow Us on Twitter

Avoiding traps
Volume Number:2
Issue Number:10
Column Tag:Advanced Macing

Reduce Your Time in the Traps!

By Mike Morton, Senior Software Engineer, Lotus Development Corp., Cambridge, MA

Life in the fast lane

The Macintosh ROM subroutines are called with “trap” instructions, intercepted by dispatching software which interprets the trap and calls the routine. This method is very general, providing compatibility with future ROMs and allowing buggy routines to be replaced.

It's also slow, taking about 45 microseconds for the dispatch process. This article tells you a way to avoid the dispatcher without losing its generality. Since the timing differences are measured in microseconds, there's also a discussion of techniques for measuring the time consumed by a piece of code. Also, a program is included to show the alternate way to call the ROM and how to measure the times used by different methods.

Avoiding traps

When a program executes a trap instruction, the 68000 detects the “error” and transfers control to the trap dispatcher pointed to by the longword at $0028. The dispatching software must, among other things:

• preserve some registers on the stack

• fetch the trap instruction from the code

• decide if the trap is a Toolbox or OS call

• look up the trap number to find whether the routine is in RAM or ROM, and what its address is

• handle the “auto-pop” and “pass A0” bits

• call the routine

• restore registers from the stack

Most of this work can be avoided if you know the routine's address and call it directly, but this is a bad idea for two reasons. First, the address may change in future ROMs. Second, Apple distributes “patches” to ROM routines by changing the dispatch table to call new versions in RAM -- if your program “knows” the address, it'll call the old, buggy ROM routines, ignoring the new RAM-based ones.

There is a balance between hardwiring the address and using the trap dispatcher for every call. The Toolbox “GetTrapAddress” function decodes a trap instruction for you and returns the address of the routine, just as the dispatcher does. You can do this decoding just once in your program, save the address, and repeatedly call it later.

The main reason not to bypass the dispatcher is that it saves a few registers across each call. If you're working in assembler, this is no problem -- just save registers yourself, as needed. In most high-level languages, it also won't be a problem, since the registers lost are typically scratch registers: D1, D2, and A2.

Fig. 1 Our TrapTime Utility shows the difference!

A high-level example

First, let's look at the normal way of calling a Toolbox routine: the simple “SetPt” procedure, which sets the coordinates of a Quickdraw “point”. The following example and the timing program are in TML Pascal; they should be easy to convert to other languages.

Most programs include the Quickdraw unit, which declares “setPt” with

procedure SetPt(VAR pt: point; h, v: integer); INLINE $A880;

When you call the routine with the statement

 setPt (myPt, x, y); { set the point }

it pushes the parameters on the stack and executes the instruction $A880 to trap to the dispatcher, which calls the routine. If you want to skip the cost of repeatedly decoding the trap, you can do it once like this:

 var setPtAddr:longint; { addr of setPt }
  
 setPtAddr := getTrapAddress ($A880);

To call this address, declare a new routine like SetPt, but which produces different in-line 68000 code:

procedure mySetPt
 (VAR pt: point; h, v: integer;
 addr: longint);
 INLINE $205F, $4E90;

Note the extra parameter to this routine: the address of the routine to be called. The instructions given in hex after the “INLINE” do a JSR to that address. The result is nearly the same as executing a trap, but faster.

Calling with this interface is almost like a normal call; pass the address as a parameter:

 mySetPt (myPt, x, y, setPtAddr);

This can be used for most Toolbox calls - just declare your own routine (choose any name) with the same parameters plus the address parameter, and include the exact same “INLINE” code after it. Don't forget to initialize the address with GetTrapAddress before calling, or awful things will happen.

Other high-level languages

You should be able to use this method with almost any language which allows you to insert assembler code in your high-level program. Some languages may have trouble calling the ROM directly -- for instance, many C compilers pass parameters differently than ROM routines do. Some C compilers allow you to choose the method of parameter passing; this will allow you to dispense with assembler altogether and just call the routine through a pointer (ask your nearest C guru how to do this).

More straightforward approaches

This approach assumes that “SetPt” is too slow. If you actually need Toolbox operations to be faster, consider writing the code yourself. You can write a procedure or function to assign two integers to the coordinates of a point -- or just do the assignment yourself. For a simple operation, this approach is preferable to spending lots of effort avoiding the trap dispatcher. (The “K.I.S.S.” rule applies here: “Keep It Simple, Stupid.”)

Speed improvements: hard data

Let's get quantitative. Consider four ways to assign to a point:

• the usual trap

• calling the ROM directly with INLINE

• calling your own procedure

• doing the assignment in-line

I wrote all four in Lisa Pascal and found these times on a Mac, and on a Lisa running MacWorks:

Table: Time to assign to a point

(all times in microseconds)

Mac Lisa/MacWorks

Normal “SetPt” trap 67.7 84.9

Pre-decoded call 22.8 25.6

Roll-your-own 34.5 35.2

Assign in-line 4.8 4.8

Writing your own procedure is slower than using the trap routine's address! The ROM is so fast, compared to compiled Pascal, that it's worth the slightly more complicated call. Part of the speed is because the ROM is tightly-coded; part is because the Mac's video refresh slows down code in RAM.

The fastest method is to forget about writing a procedure and do the assignment normally. This is fourteen times faster than using traps to call the ROM! (There's something to be said for the do-it-yourself approach.)

I tried running the program on a Mac Plus, since its ROM dispatch table has been expanded for faster trap calls. The time for a normal trap is 58.9 microseconds, instead of 67.7 microseconds. All the other times are nearly the same.

Speed improvements: summary

First, all this isn't worthwhile for most traps. If you want to speed up disk I/O, resource operations, etc., the microseconds saved at trap time are dwarfed by the amount of time for a disk transfer or to search a large resource. This trick is appropriate only in some situations.

Second, some routines are best done by hand in simple code in your program. ROM tools such as “SetPt” exist for your convenience, not because they're hard to code. If you find they're taking too much time, change them to a few lines of your own code.

But suppose you're trying to draw lines at top speed with repeated “LineTo” calls? Or use one of the simple bit manipulators in a loop? You may find that you can't easily write it yourself, but you can save 45 microseconds by calling into the ROM using a previously determined address. My estimate is that if a trap takes between 200 and 800 microseconds, you should consider skipping the dispatcher.

The timing program

The program “traptime” found the times given in the table. It has four procedures to time methods, and a “getbasetime” procedure to find the overhead of a loop with no calls. You can write a similar program using the same design in nearly any language.

Note that the program prints its results in ticks (60ths of a second) and doesn't compute the time for a loop iteration; I did the conversions to microseconds-per-iteration by hand, rather than trying to get Pascal to do fractional arithmetic.

Timing methods

Unfortunately, doing accurate timings is fraught with problems. This program tries to avoid these. Some points on timings:

• Repeat your measurements to help detect “random” factors. Small discrepancies should be averaged; large ones should be found and removed.

• Be careful when comparing routines: the four timing routines (and the “overhead” routine) are identical except for one section. Keeping this parallel structure makes your program a controlled experiment, helping you time only the differences between procedures.

• Vary the loop size; make sure that your time per iteration converges as your loop gets bigger.

• When waiting for the program, don't move the mouse or fiddle with the keyboard. This causes interrupts and affects the timings.

• I suspect you shouldn't have the disk spinning, nor have a debugger active while timing. (In practice, I can't detect any timing differences due to either of these factors.)

In short, timing is a scientific experiment and is easy to ruin by not controlling the environment carefully.

Conclusion

Bypassing the trap dispatcher can be a valuable technique in a limited number of situations, allowing you to cut about 45 microseconds off the time to call the ROM. It has some drawbacks such as losing register contents, and may be hard to implement in some higher-level languages. In addition, many ROM calls take so long that the savings isn't significant.

Whatever technique you're interesting in optimizing and timing, accurate measurement is a matter of a careful, controlled approach.

{ traptime -- A program to time various methods of doing a toolbox trap:
  The usual method, calling a user-written routine to do the work, doing 
the work in-line, and calling the ROM routine directly without going 
through the trap dispatcher. Times for all routines are written on the 
screen in ticks for a given number of calls, then the number of calls 
is varied for improved accuracy.

  Mike Morton, November 1985. Modified for TML Pascal, June 1986. }

program traptime (output);{ "(output)" lets us do writelns }

{$I MemTypes.ipas  }
{$I QuickDraw.ipas } { we use Quickdraw graphics }
{$I OSIntf.ipas }{ and OS definitions }
{$I ToolIntf.ipas }{ and Toolbox calls }

var         { program-wide variables }
  basetime: longint; { constant overhead for the loop }
  loops: longint;         { number of iterations to time }
  start: longint;         { starting tickcount for timing }
  Event:EventRecord; {simple event loop for cmd-3}
  DoIt: Boolean; {getnextevent boolean}
  Finished:Boolean;{event loop terminator}

{ getbasetime -- Find the time for the loop when nothing is done inside 
it.This tells us the overhead which should be subtracted from other timings. 
}

function getbasetime: longint;
var count: longint;        { loop counter }
begin;
  start := tickcount;        { snapshot starting time }
  for count := 1 to loops do        { loop a bunch of times... }
    ;           { ...doing nothing each time }
  getbasetime := tickcount-start;       { calculate elapsed time }
end;            { function "getbasetime" }

{ usualtime -- Find the time used to call the ROM the usual way.  This, 
and all timing routines, should look as much as possible like "getbasetime". 
}

function usualtime: longint;
var
  count: longint;        { loop counter }
  pt: point;        { point to assign to }
  x, y: integer;         { coordinates to assign to the point }
begin;
  start := tickcount;        { snapshot starting time }
  for count := 1 to loops do        { this time, inside the loop... }
    setpt (pt, x, y);        { ...we do the ROM call }
  usualtime := tickcount-start;          { calculate elapsed time }
end;            { function "usualtime" }


{ setmypt -- This isn't a timing function like the others; it's a replacement 
for the ROM's "setpt" routine, to see how fast we can do it ourselves. 
}
procedure setmypt (VAR pt: point; x, y: integer);
begin;
  pt.h := x; pt.v := y; { assign to the coordinates; easy! }
end;    { procedure "setmypt" }

{ myowntime -- Time assignment using our own procedure. }

function myowntime: longint;
var
  count: longint;        { loop counter }
  pt: point;        { point to assign to }
  x, y: integer;         { coordinates to assign to point }
begin;
  start := tickcount;        { snapshot starting time }
  for count := 1 to loops do        { this time, inside the loop... }
    setmypt (pt, x, y);           { ...we call our own routine }
  myowntime := tickcount-start;          { calculate elapsed time }
end;            { function myowntime }

{ inlintime -- The most straightforward way: we do the assignment in 
the loop. }

function inlintime: longint;
var
  count: longint;        { loop counter }
  pt: point;        { point to assign to }
  x, y: integer;         { coordinates to assign to point }
begin;
  start := tickcount;        { snapshot starting time }
  for count := 1 to loops do        { this time, inside the loop... }
    begin; pt.h := x; pt.v := y; end;   { ...we do assignment here }
  inlintime := tickcount-start;          { calculate elapsed time }
end;            { function inlintime }

{ setptx -- This is another replacement for "setpt".  It takes an extra 
parameter, the previously determined address of "setpt", and calls that 
address, leaving the other parameters for "setpt".  Unfortunately, TMLPascal 
doesn't mimic Lisa Pascal closely enough to allow us to generate more 
than one word of code in a single declaration.  So we have two procedures 
-- these MUST always be used together!  TML says their 2.0
 release of the compiler will be Lisa-compatible on this score, so this 
unsightly workaround won't be needed any more. }

procedure setptx1 (var pt: point; h, v: integer; addr: longint);
      INLINE   $205F; { MOVE.L   (A7)+,A0  
 ; pop routine's address into A0  }
procedure setptx2;
      INLINE   $4E90;{ JSR(A0);  and call that address }

{ gettrtime -- The last and most complicated way of calling the routine. 
 We use the trap address to call it directly. }

function gettrtime: longint;
var
  addr: longint;         { actual address of "setpt" }
  count: longint;        { loop counter }
  pt: point;        { point to assign to }
  x, y: integer;         { coordinates to assign to point }
begin;
  addr := gettrapaddress ($a880);    { find where routine lives }
  start := tickcount;         { snapshot starting time }
  for count := 1 to loops do begin { inside the loop... }
    setptx1 (pt, x, y, addr);          { ...we call on ROM  }
    setptx2;{ (kludge to sneak in 2nd instruction }
  end;
  gettrtime := tickcount-start;              { calculate elapsed time 
}
end;             { function gettrtime }

begin;          { *** main program *** }
  writeln ('If launching from a floppy, wait for it to stop and click 
to begin...');
  while not button do; while button do;      { wait for a click }

  loops := 10000;          { start with a small loop size... }
  while loops <= 1000000 do  { and go through several sizes}
  begin;
    basetime := getbasetime;        { find constant overhead }

    writeln ('number of loops:', loops, '; base time is:', basetime);
    writeln ('time for usual method is..........: ', usualtime - basetime);
    writeln ('time for calling my own routine is: ', myowntime - basetime);
    writeln ('time for doing it in-line is......: ', inlintime - basetime);
    writeln ('time for doing it with gettrapaddr: ', gettrtime - basetime);
    writeln;

    loops := loops * 10;   { loop sizes increase exponentially }
  end;

  flushevents(EveryEvent,0);
   writeln ('click to exit or take snapshot ');
  Repeat
  systemtask;
 DoIt:=GetNextEvent(EveryEvent,Event);
 if DoIt then
 Case Event.what of
  KeyDown: begin end;
  Mousedown: begin Finished:=true; end;
  End;
Until Finished;
end.            { of main program "traptime"  }



!PAS$Xfer

trapspeed
PAS$Library
OSTraps
ToolTraps
$ 
 

Community Search:
MacTech Search:

Software Updates via MacUpdate

OmniOutliner Pro 4.2 - Pro version of th...
OmniOutliner Pro is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It's... Read more
VLC Media Player 2.2.1 - Popular multime...
VLC Media Player is a highly portable multimedia player for various audio and video formats (MPEG-1, MPEG-2, MPEG-4, DivX, MP3, OGG, ...) as well as DVDs, VCDs, and various streaming protocols. It... Read more
Nisus Writer Pro 2.1.1 - Multilingual wo...
Nisus Writer Pro is a powerful multilingual word processor, similar to its entry level products, but brings new features such as table of contents, indexing, bookmarks, widow and orphan control,... Read more
Tinderbox 6.2.0 - Store and organize you...
Tinderbox is a personal content management assistant. It stores your notes, ideas, and plans. It can help you organize and understand them. And Tinderbox helps you share ideas through Web journals... Read more
OmniOutliner 4.2 - Organize your ideas,...
OmniOutliner is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It's... Read more
Things 2.5.4 - Elegant personal task man...
Things is a task management solution that helps to organize your tasks in an elegant and intuitive way. Things combines powerful features with simplicity through the use of tags and its intelligent... Read more
NeoOffice 2014.10 - Mac-tailored, OpenOf...
NeoOffice is a complete office suite for OS X. With NeoOffice, users can view, edit, and save OpenOffice documents, PDF files, and most Microsoft Word, Excel, and PowerPoint documents. NeoOffice 3.x... Read more
iPhoto Library Manager 4.2 - Manage mult...
iPhoto Library Manager allows you to organize your photos among multiple iPhoto libraries, rather than having to store all of your photos in one giant library. You can browse the photos in all your... Read more
Web Snapper 3.3.8 - Capture entire Web p...
Web Snapper lets you capture Web pages exactly as they appear in your browser. You can send them to a file as images or vector-based, multi-page PDFs. It captures the whole Web page - eliminating the... Read more
TeamViewer 10.0.41404 - Establish remote...
TeamViewer gives you remote control of any computer or Mac over the Internet within seconds, or can be used for online meetings. Find out why more than 200 million users trust TeamViewer! Free for... Read more

Chainsaw Warrior: Lords of the Night has...
It's time to put the Darkness back in its place now that Chainsaw Warrior: Lords of the Night has officially made it to iOS. | Read more »
A World of Ice and Fire Lets You Stalk 2...
George R. R. Martin’s A World of Ice and Fire, by Random House, is a mobile guide to the epic series. The new update gives you the Journeys map feture that will let you track the movements of 25 different characters. But don't worry, you can protect... | Read more »
Gameloft Announces Battle Odyssey, a New...
Battle Odyssey, Gameloft's newest puzzle RPG, is coming to the App Store next week. Set in the world of Pondera, you will need to control the power of the elements to defend the world from evil. You'll be able to entlist over 500 allies to aid you... | Read more »
Fusion - HDR Camera (Photography)
Fusion - HDR Camera 1.0.0 Device: iOS Universal Category: Photography Price: $1.99, Version: 1.0.0 (iTunes) Description: Fusion creates HDR (high dynamic range) photos by capturing different exposures and then combining them into one... | Read more »
Sago Mini Toolbox (Education)
Sago Mini Toolbox 1.1 Device: iOS Universal Category: Education Price: $2.99, Version: 1.1 (iTunes) Description: Come build with the Sago Mini friends! Use a wrench, try a saw, or hammer some nails. From sewing hand puppets to... | Read more »
You Should Probably Grab Hitman GO While...
Hitman GO is a surprisingly cool (yet also incredibly drastic) departure from the Hitman series. It's well worth playing for any puzzle game fans out there, and at the moment you can get your hands - or garrotte if you will - on it for a mere $0.99... | Read more »
IFTTT is Bringing Do Button and Do Note...
IFTTT has announced Do Button and Do Note for the Apple Watch. Do Button lets you make your own personalized button that can connect to things like your Google Drive, control the temperature in your home with Nest Thermostat, or turn the lights on... | Read more »
How Many Days, Hours, and Minutes Are Le...
Countdown, by Yves Tscherry, is now available on the App Store. The app keeps track of countdowns to your favorite things such as someones birthday or days till the New Year. You can display the time in seconds, minutes, hours, days, weeks, months,... | Read more »
The All-New Misfit 2.0 App is Available...
Misfit has just given their app a complete overhaul. Misfit 2.0 now has a brand new interface with a sleek design and is easier to navigate. You'll be able to sync your Misfit device and look up health and fitness information faster than ever before... | Read more »
Halo: Spartan Strike (Games)
Halo: Spartan Strike 1.0 Device: iOS Universal Category: Games Price: $5.99, Version: 1.0 (iTunes) Description: Delve into 30 challenging missions through cities and jungles using a devastating arsenal of weapons, abilities and... | Read more »

Price Scanner via MacPrices.net

TigerText Introduces First Secure Enterprise...
TigerText, a provider of secure, real-time messaging for the enterprise, has announced the launch of TigerText for the Apple Watch. TigerText for the Apple Watch enables users to securely send and... Read more
The Conservation Fund Partners with Apple To...
The Conservation Fund has announced that it will partner with Apple to help protect working forests in the United States. The Apple initiative will conserve more than 36,000 acres of working... Read more
Clearance 13-inch 2.6GHz Retina MacBook Pro a...
B&H Photo has clearance 2014 13″ 2.6GHz/128GB Retina MacBook Pros now available for $1099, or $200 off original MSRP. Shipping is free, and B&H charges NY sales tax only. Read more
Apple refurbished 2014 13-inch Retina MacBook...
The Apple Store has Apple Certified Refurbished 2014 13″ Retina MacBook Pros available for up to $400 off original MSRP, starting at $979. An Apple one-year warranty is included with each model, and... Read more
iMacs on sale for up to $205 off MSRP, NY tax...
B&H Photo has 21″ and 27″ iMacs on sale for up to $205 off MSRP including free shipping plus NY sales tax only: - 21″ 1.4GHz iMac: $1019 $80 off - 21″ 2.7GHz iMac: $1189 $110 off - 21″ 2.9GHz... Read more
Sale! 16GB iPhone 5S for $1 with service
Best Buy is offering 16GB iPhone 5Ss for $1.00 with 2-year activation at a participating cellular provider. Choose free home shipping and activation, or buy online and activate during in-store pickup... Read more
Apple refurbished 2014 MacBook Airs available...
The Apple Store has Apple Certified Refurbished 2014 MacBook Airs available starting at $679. An Apple one-year warranty is included with each MacBook, and shipping is free. These are currently the... Read more
27-inch 3.5GHz 5K iMac on sale for $2349, sav...
 Adorama has the 27″ 3.5GHz 5K iMac in stock today and on sale for $2349 including free shipping plus NY & NJ sales tax only. Their price is $150 off MSRP. For a limited time, Adorama will... Read more
Save up to $380 on an iMac with Apple refurbi...
The Apple Store has Apple Certified Refurbished iMacs available for up to $380 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 27″ 3.5GHz 5K iMac – $2119 $... Read more
iFixIt Teardown Awards 12-IInch Retina MacBoo...
iFixIt has posted its illustrated teardown of the new 12-inch MacBook Retina. They note that this new MacBook is less than half the thickness of the last Apple notebook called just “MacBook” back in... Read more

Jobs Board

*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* Watch SW Application Project Manager...
**Job Summary** The Apple Watch software team is looking for an Application Engineering Project Manager to work on new projects for Apple . The successful candidate Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail 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.