TweetFollow Us on Twitter

PowerPC Code
Volume Number:10
Issue Number:4
Column Tag:Powering Up

Connecting A 68k Object File
To PowerPC Code

A robust technique for loading and calling 68K modules from your PowerPC application

By Richard Clark, Apple Computer, Inc.

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

Many developers run into a major problem when porting code to PowerPC: incorporating 68K object models which came from an outside vendor. Since you can’t just hand a 68K module to the PowerPC linker, you have to find some alternative for loading the library and calling the library’s functions. Fortunately, developers can use the Code Fragment Manager and the Mixed Mode Manager together to solve this problem.

The solution involves creating a stand-alone version of the 68K code, then assembling a “jump table” of Universal Procedure Pointers which the application can use to call this code. Since applications (and, in fact, any PowerPC code fragment) can have global variables, it makes sense to allocate this table within the application. However, since the 68K library entry points are only available to the 68K code, that code has to create the universal procedure pointers. This would create an impossible dilemma except for one fact - both Mixed Mode and the Code Fragment Manager can be called from emulation on a Power Macintosh via A-Traps.

Thus we have a solution - the application must create the jump table as a global variable, and then pass its address to the 68K code which assembles the jump table. (An alternate method involves exporting the table from the application. The 68K code must open a connection back to the application, and ask the CFM for the address of the jump table.) The 68K code creates Universal Procedure Pointers to fill the table, which allows the application to call the library functions using Mixed Mode.

Creating the Jump Table

The first step is to prepare a list of all of the functions that your application calls in the library. Next, define ProcInfo values for each of these functions, using the MixedMode.h header and any header which defines callback functions (such as Controls.h) as a guide. You should also create macros for creating and calling a UniversalProcPtr in this way.

Next, create a data structure which contains Mixed Mode “Universal Procedure Pointers” for each of these functions. Put a copy of this data structure into a global variable in your PowerPC application, and don’t declare it as “static” (i.e. hidden.) You should also export this table, for a reason that will become clear shortly.


/* 1 */
// This is a header file common to the application and 68K code 

#include <ConditionalMacros.h>
#include <MixedMode.h>

typedef void (*CallbackPtr)(void); // A pointer which is fed to the library

typedef pascal OSErr (*Routine1ProcPtr)(CallbackPtr callbackRoutine);

enum {
 uppRoutine1ProcInfo = kPascalStackBased
  | RESULT_SIZE (SIZE_CODE(sizeof(OSErr)))
  | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(CallbackPtr)))
};

#if USESROUTINEDESCRIPTORS
// Use these definitions if we're compiling for Power Macintosh or another
// Macintosh system which supports Mixed Mode
typedef UniversalProcPtr Routine1UPP;

#define CallRoutine1Proc(userRoutine, longValue)         \
 CallUniversalProc((UniversalProcPtr)(userRoutine),\
 uppRoutine1ProcInfo, longValue)
#define NewRoutine1Proc(userRoutine) \
 (RoutineUPP) NewRoutineDescriptor((ProcPtr)userRoutine, \
    uppRoutine1ProcInfo, GetCurrentISA())
#else
// Use these definitions if we're compiling for a 68K-based Macintosh
typedef Routine1ProcPtr Routine1UPP;

#define CallRoutine1Proc(userRoutine, longValue)         \
 (*((Routine1ProcPtr )userRoutine))(longValue)
#define NewRoutine1Proc(userRoutine) \
 (Routine1UPP)(userRoutine)
#endif

 
// Here's the list of Universal Procedure Pointers
struct JumpTable {
 Routine1UPProutine1;
};

typedef struct JumpTable JumpTable, *JumpTablePtr;

// === Information on calling the 68K setup functions
typedef pascal OSErr (*SetupProcPtr)(JumpTablePtr);

enum {
 uppSetupProcInfo = kPascalStackBased
  | RESULT_SIZE (SIZE_CODE(sizeof(OSErr)))
  | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(JumpTablePtr)))
};

#if USESROUTINEDESCRIPTORS
// Use these definitions if we're compiling for Power Macintosh or another
// Macintosh system which supports Mixed Mode
typedef UniversalProcPtr SetupUPP;

#define CallSetupProc(userRoutine, jumpTableAddr)        \
 CallUniversalProc((UniversalProcPtr)(userRoutine),\
 uppSetupProcInfo, jumpTableAddr)
#define NewSetupProc(userRoutine)  \
 (SetupUPP) NewRoutineDescriptor((ProcPtr)userRoutine, \
    uppSetupProcInfo, GetCurrentISA())
#else
// Use these definitions if we're compiling for a 68K-based Macintosh
typedef SetupProcPtr SetupUPP;

#define CallSetupProc(userRoutine, jumpTableAddr)        \
 (*((SetupProcPtr)userRoutine))(jumpTableAddr)
#define NewSetupProc(userRoutine)  \
 (SetupUPP)(userRoutine)
#endif

Next, you have to create the “setup” function in 68K code and link it to your 68K object library. This routine needs to fill in each of the pointers in the table. The resulting code should be compiled, linked, and made into a stand-alone 68K code resource.

Granted, this technique could prove difficult if the library depends on having an A5 world. If your 68K library requires global variables, you must apply one of the special coding techniques documented in the Macintosh Developer Technical Notes or develop magazine.) Also note that if you want this code to run on a 68K machine, you should check for the presence of Mixed Mode and react appropriately.


/* 2 */
pascal OSErr BuildJumpTable(JumpTablePtr theJumpTable)
// Build a table of pointers to functions in our linked library
{
 OSErr  err;
 // Fill in the table with pointers to each library function
 theJumpTable->routine1 = NewMyRoutineProc(Routine1);
 err = MemError();
 return err;
}

The alternate approach involves exporting the jump table from the Application using the CFM, and letting the 68K code ask the CFM for the table’s address. Note the use of a STR# resource to store the application and table name strings - this avoids needing an A5 world just for the string constants. (Note that this code will not work on a machine which doesn’t have the Code Fragment Manager or Mixed Mode.)


/* 3 */
OSErr   err;
 JumpTablePtr  theJumpTable;
 ConnectionID  connID = 0;
 Ptr    mainAddr;
 Str255 errName, appName, tableName;
 SymClass symClass;
// Locate the application that called us
 GetIndString(&appName, 128, 1); // Assuming the name is in a STR#
 err = GetSharedLibrary(&appName, kPowerPCArch, 0, 
 &connID, &mainAddr, &errName);
 if (err) goto done;
 
 // Now, locate the shared table
 // (it's a pointer stored in a global variable)
 GetIndString(&tableName, 128, 2);// The table name is in the same STR#
 err = FindSymbol(connID, &tableName, 
 (Ptr*)&myTablePointer, &symClass);
 if (err) goto done;
// Insert the code to create UniversalProcPtrs here
done:
 if (connID)
 CloseConnection(&connID);
  return err;

To initialize this table, simply load the code resource from the application and call it via Mixed Mode. When the resource returns, the jump table will be full of Universal Procedure Pointers. Therefore, you should then modify your application to use Mixed Mode and the pointers in the table to call the library functions.


/* 4 */
// include the usual macros for creating a UniversalProcPtr for our callback 
routine
JumpTable gJumpTable;
// Load the stand-alone code
Handle  theResource;
theResource= Get1IndResource('STUB', 1);
if (theResource) {
  MoveHHi(theResource);
  HLock(theResource);// Lock it -- and NEVER unlock it
  // Call the entry point, no parameters
  CallSetupProc(*theResource, &gJumpTable);  
 // we know it's 68K, so we didn't
 // bother with creating a Routine Descriptor
  // Create a UniversalProcPtr for our callback routine
  CallbackUPP ourCallback;
  ourCallback = NewCallbackProc(MyCallbackRoutine);
  result = CallRoutine1Proc(gJumpTable.routine1,ourCallback );
  DisposeRoutineDescriptor(ourCallback);
}

Note that since the library function takes a callback pointer, we had to create a UniversalProcPtr and pass that instead of the address of the actual code. (If we hadn't done this, the machine would crash.) Since this causes memory to be allocated for a Routine Descriptor, we call DisposeRoutineDescriptor afterwards to release the memory.

That’s all there is to it! This is a robust technique which is now being used in several commercial applications - perhaps it will prove useful in yours.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

How to become the ultimate robot warrior...
Chrono Strike is a delightfully immersive beat ‘em up with a sense of humor (any game with a good Sims reference gets points in my book). [Read more] | Read more »
Tips and tricks to get a higher score in...
Snow Roll is a devilish endless runner very much in the vein of Flappy Bird. It revels in its dastardly level of difficulty, and doesn’t really care how angry you get at it as it knows you’ll keep coming back for more. [Read more] | Read more »
How to win big in Slots Deluxe
Cheating while gambling is illegal and morally wrong, and in some parts of the world it leads to men with names like Vinnie "Six Knuckles" Manchenzo beating you to a pulp in a dark alley. [Read more] | Read more »
How to take over the world in Dictator 2
Running a country isn't easy - especially when you're a dictator who wants to take over the world and crush everyone in your path while you do it. [Read more] | Read more »
Tips and tricks to get a higher score in...
Tank.iois - you guessed it! - another multiplayer arena battler likeAgar.io and Slither.io. It does differentiate itself by putting you in a tiny tank though, so it's not exactly the same. To help you get that all-important high score, we've got a... | Read more »
How to unlock characters in One Tap Tenn...
As the title suggests, One Tap Tennis requires only a single tap to play its particular brand of tennis, and rewards you with a ton of unlockable characters if you perform well. Fortunately for you, we at 148Apps have got a few tips and tricks to... | Read more »
Grab it now: Game Craft’s Legend of War...
The real time strategy game is now available for you to sink your teeth into, through the App Store and Google Play. Combining elements of skill, strategy and empire building, Legend of War is a real gamers’ game. [Read more] | Read more »
Skateboard Party 3 ft. Greg Lutzka (Gam...
Skateboard Party 3 ft. Greg Lutzka 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Skateboard Party is back! This third edition of the popular sports franchise features professional skater... | Read more »
Cubious (Games)
Cubious 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: Cubious – How smart are you? How high is your IQube? Solve the impossible puzzles to find out, and help a lost little cube find his... | Read more »
Goat Simulator Waste of Space (Games)
Goat Simulator Waste of Space 1.1 Device: iOS Universal Category: Games Price: $4.99, Version: 1.1 (iTunes) Description: ** IMPORTANT - SUPPORTED DEVICESiPhone 4S, iPad 2, iPod Touch 5 or better.** | Read more »

Price Scanner via MacPrices.net

Enterprise Workers Pick Technology Over Perks...
New Adobe study shows surprising attitudes about office jobs and where the future of work is heading. Adobe has released survey findings revealing that a surprising 70 percent of U.S. office workers... Read more
Memorial Day Weekend Sale: $50-$100 off 11-in...
B&H Photo has 13″ and 11″ MacBook Airs with 256GB SSDs on sale for $50-$100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 11″ 1.6GHz/256GB MacBook Air: $999 $100 off MSRP... Read more
Memorial Day Weekend Sales: Apple MacBook Pro...
B&H Photo has 13″ and 15″ Retina MacBook Pros on sale for up to $210 off MSRP. Shipping is free, and B&H charges NY tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799 $200 off MSRP - 15″ 2.5GHz... Read more
Memorial Day Weekend Sales: Apple iMacs and M...
Take up to $150 off the price of a new iMac or Mac mini at the following Apple resellers this Memorial Day weekend: iMacs: B&H Photo has 21″ and 27″ iMacs on sale for up to $150 off MSRP... Read more
Apple refurbished Retina MacBook Pros availab...
Apple has Certified Refurbished 2015 13″ and 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... 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
Goal Zero and OtterBox Partner to Expand iPh...
Goal Zero, specialists in portable power, have announced a partnership with OtterBox, brand smartphone case protection, to offer the Slide and Slide Plus Batteries as modules compatible with the new... Read more
15-inch Retina MacBook Pros on sale for up to...
B&H Photo has 15″ Retina MacBook Pros on sale for up to $210 off MSRP. Shipping is free, and B&H charges NY tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799 $200 off MSRP - 15″ 2.5GHz Retina... Read more
Clearance 2015 13-inch MacBook Airs available...
B&H Photo has clearance 2015 13″ MacBook Airs available for $250 off original MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/4GB/128GB MacBook Air (MJVE2LL/A): $799... Read more
Apple refurbished Apple TVs available for up...
Apple has Certified Refurbished 32GB and 64GB Apple TVs available for up to $30 off the cost of new models. Apple’s standard one-year warranty is included with each model, and shipping is free: -... Read more

Jobs Board

*Apple* Architect - AECOM (United States)
**Requisition/Vacancy No.** 132759BR **Position Title** Apple Architect **Job Category** Information Technology **Business Line** Government **Country** United Read more
*Apple* Solutions Consultant - APPLE (United...
Job Summary As an Apple Solutions Consultant, you'll be the link between our future customers and our products. You'll showcase your entrepreneurial spirit as you Read more
*Apple* Project Engineer - Smart Source Inc...
SmartSource is in need of an Apple Project Engineer for a 12 month contract opportunity in Pittsburg, PA. Role: Apple Project Engineer Location: Pittsburg, PA Read more
Automotive Sales Consultant - Apple Ford Linc...
…you. The best candidates are smart, technologically savvy and are customer focused. Apple Ford Lincoln Apple Valley is different, because: $30,000 annual salary Read more
Service Assistant - *Apple* Chevrolet *App...
Apple Automotive is one of the fastest growing dealer...and it shows. Consider making the switch to the Apple Automotive Group today! At Apple Automotive, we Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.