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

beaTunes 5.0.2 - Organize your music col...
beaTunes is a full-featured music player and organizational tool for music collections. How well organized is your music library? Are your artists always spelled the same way? Any R.E.M. vs REM?... Read more
iFFmpeg 6.4.1 - Convert multimedia files...
iFFmpeg is a comprehensive media tool to convert movie, audio and media files between formats. The FFmpeg command line instructions can be very hard to master/understand, so iFFmpeg does all the hard... Read more
Hopper Disassembler 4.2.6- - Binary disa...
Hopper Disassembler is a binary disassembler, decompiler, and debugger for 32- and 64-bit executables. It will let you disassemble any binary you want, and provide you all the information about its... Read more
iExplorer 4.1.2.0 - View and transfer fi...
iExplorer is an iPhone browser for Mac lets you view the files on your iOS device. By using a drag and drop interface, you can quickly copy files and folders between your Mac and your iPhone or... Read more
TunnelBear 3.0.15 - Subscription-based p...
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
Carbon Copy Cloner 4.1.16 - Easy-to-use...
Carbon Copy Cloner backups are better than ordinary backups. Suppose the unthinkable happens while you're under deadline to finish a project: your Mac is unresponsive and all you hear is an ominous,... Read more
Day One 2.3 - Maintain a daily journal.
Day One is the easiest and best-looking way to use a journal / diary / text-logging application for the Mac. Day One is well designed and extremely focused to encourage you to write more through... Read more
Sketch 45 - Design app for UX/UI for iOS...
Sketch is an innovative and fresh look at vector drawing. Its intentionally minimalist design is based upon a drawing space of unlimited size and layers, free of palettes, panels, menus, windows, and... Read more
NeoFinder 7.1 - Catalog your external me...
NeoFinder (formerly CDFinder) rapidly organizes your data, either on external or internal disks, or any other volumes. It catalogs all your data, so you stay in control of your data archive or disk... Read more
Day One 2.3 - Maintain a daily journal.
Day One is the easiest and best-looking way to use a journal / diary / text-logging application for the Mac. Day One is well designed and extremely focused to encourage you to write more through... Read more

Latest Forum Discussions

See All

Kalimba™ (Games)
Kalimba™ 1.0 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0 (iTunes) Description: ** BAFTA-nominated ‘Best New Property’ 2015 ** Jump, slide and fly your way through a beautiful, mind-bending world in this award-... | Read more »
All That Remains: Part 1 (Games)
All That Remains: Part 1 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: “Duncan Price is paranoid” they used to say. He’s just a “local nut” they said. They used to say a lot of things about... | Read more »
Super Samurai Rampage (Games)
Super Samurai Rampage 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Super Samurai Rampage is a bloody, retro pixel style high score chaser. You play as a legendary Samurai warrior provoked... | Read more »
You can now travel to Skyrim in The Elde...
The Elder Scrolls: Legends' new expansion has opened up Skyrim's craggy mountains and snowy plains for exploration today. Heroes of Skyrim is out now, adding a bunch of new Skyrim content to Bethesda's recent CCG. [Read more] | Read more »
High-stakes solitaire game 'Missile...
Missile Command and Solitaire might seem like an odd couple, but indie developer Nathan Meunier has brought them together to create his first game, Missile Cards, which launched on the App Store today. [Read more] | Read more »
Eos 2 (Music)
Eos 2 2.0.2 Device: iOS Universal Category: Music Price: $5.99, Version: 2.0.2 (iTunes) Description: | Read more »
Supercell celebrates Hay Day's comm...
Before there was Clash Royale or Clash of Clans, there was Hay Day. Now, Supercell's first game is celebrating its fifth anniversary, and the developer is commemorating the event with this touching new video. Supercell picked one long-running Hay... | Read more »
Dive into epic summer adventure with Oce...
Summer may be the best time to enjoy ocean adventures, and now you don’t even have to leave the comfort of your own home, thanks to the folks at Joycity, creators of Oceans & Empires. The old-timey naval MMO is getting a sizable new June Grand... | Read more »
Missile Cards (Games)
Missile Cards 1.0.9 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.9 (iTunes) Description: "Missile Command meets Solitaire...only with more doomlasers, death, and explosions." | Read more »
Collect mini assassins in 'Assassin...
Assassin's Creed is traveling back in time to the Spanish Inquisition for its latest mobile entry, Assassin's Creed Rebellion. The game is giving the series a look that's a huge departure from its past design, recreating classic characters in a... | Read more »

Price Scanner via MacPrices.net

New 15-inch 2.8GHz Touch Bar MacBook Pros on...
MacMall has the new 2017 15″ 2.8GHz MacBook Pros in stock and on sale for $2279 including free shipping. Their price is $120 off MSRP, and it’s the lowest price available for these models: - 15″ 2.... Read more
Will iPad Running iOS 11 Be The ‘Ute’ Of The...
Steve Jobs’ analogy comparing iPads and PCs to cars and trucks respectively is seven years old but still stimulates discussion and debate. Appearing on an All Things D panel in 2010 shortly after the... Read more
Free CarePassport App gives Patients control...
Boston based CarePassport is on a mission to enable patients to take control of their medical records by allowing patients to aggregate, store, share and manage all their medical data including... Read more
Western Digital Launches New My Passport Ultr...
Western Digital Corporation has expanded its WD brand My Passport portable drive line with the redesigned My Passport Ultra drive. In addition to a new metallic look, the drive offers intuitive WD... Read more
Clearance 2016 13-inch MacBook Pros available...
B&H Photo has clearance 2016 13″ MacBook Pros in stock today for up to $210 off original MSRP. Shipping is free, and B&H charges NY & NJ sales tax only: - 13″ 2.9GHz/512GB Touch Bar... Read more
Apple Releases iOS 11 Public Beta; How To Get...
The official release of Apple’s latest mobile operating system iOS 11 is vaguely slated for the fall, but as of June 26, ordinary users can download an iOS 11 public beta. To download the iOS 11... Read more
Extend Life of MacBook Pro Retina 2.0TB With...
MacSales.com/Other World Computing has announced availability of the new OWC 2.0TB Aura Pro Solid State Drive for mid-2012 to early 2013 Apple MacBook Pro with Retina display. One of the fastest... Read more
BBEdit SummerFest 2017 Discount Ends Friday,...
You can get 20% off BBEdit for a limited time in Bare Bones Software’s http://www.eastgate.com/Tinderbox/Specials/SummerFest.html?mc_cid=f2101ca260&mc_eid=[UNIQID]SummerFest 2017 sale and... Read more
Use Apple’s Education discount to save up to...
Purchase a new Mac using Apple’s Education discount, and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free: - 15″ 2... Read more
Clearance 27-inch 3.3GHz 5K iMac available fo...
Amazon clearance 27″ 3.3GHz 5K iMacs (MK482LL/A) available for $1799.90 including free shipping. Their price is $500 off original MSRP, and it’s the lowest price available for this model from any... Read more

Jobs Board

*Apple* Online Store WW Customer Insights -...
…with data mining tools: R, SAS, etc.Experience with common shell scripting tools: unix, python, apple script, Swift etc. Apple Online is one of the largest and Read more
Engineering Project Manager, *Apple* Online...
…the electronic commerce (eCommerce) systems and solutions that enable and support the Apple Online Store (AOS) - one of world's largest online retail businesses, Read more
*Apple* News Product Marketing Mgr., Publish...
…organizational consensus on strategy and vision for publisher tools, authoring, and Apple News Format.Carries this strategy and vision across the organization to Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Security Data Analyst - *Apple* Information...
…data sources need to be collected to allow Information Security to better protect Apple employees and customers from a wide range of threats.Act as the subject matter Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.