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.

 
AAPL
$99.38
Apple Inc.
-1.37
MSFT
$46.00
Microsoft Corpora
-0.36
GOOG
$569.60
Google Inc.
-7.76

MacTech Search:
Community Search:

Software Updates via MacUpdate

Cocktail 8.0 Beta 2 - General maintenanc...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
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

Latest Forum Discussions

See All

Manage Your Cloud – Wunderlist Now Suppo...
Manage Your Cloud – Wunderlist Now Supports Dropbox Posted by Jessica Fisher on October 1st, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Nexticy Review
Nexticy Review By Jennifer Allen on October 1st, 2014 Our Rating: :: IDEAL FORM CREATIONiPad Only App - Designed for the iPad Nexticy allows you to make your own forms for research purposes or to organize your business better. It’s... | Read more »
Tiny Troopers: Alliance Marches onto the...
Tiny Troopers: Alliance Marches onto the App Store Tomorrow Posted by Jessica Fisher on October 1st, 2014 [ permalink ] Tiny Troopers: Alliance, by Kukouri, is a | Read more »
HeroCraft Introduces Unlimited Sequel to...
HeroCraft Introduces Unlimited Sequel to WW2: Sandbox. Strategy & Tactics Posted by Jessica Fisher on October 1st, 2014 [ permalink ] | Read more »
RGB Express Review
RGB Express Review By Jennifer Allen on October 1st, 2014 Our Rating: :: DELIGHTFUL PUZZLINGUniversal App - Designed for iPhone and iPad Guide trucks along their delivery routes in RGB Express, a testing but charming puzzle game... | Read more »
The Sagas of Fire*Wolf (Games)
The Sagas of Fire*Wolf 1.0 Device: iOS Universal Category: Games Price: $9.99, Version: 1.0 (iTunes) Description: | Read more »
BuggyFun Review
BuggyFun Review By Amy Solomon on October 1st, 2014 Our Rating: iPad Only App - Designed for the iPad BuggyFun allows children to create their own tracks for bugs to interact with for a unique open-ended experience.   | Read more »
Fold the Adventure Review
Fold the Adventure Review By Jennifer Allen on October 1st, 2014 Our Rating: :: AWKWARD FOLDSUniversal App - Designed for iPhone and iPad Fold pieces of paper to create platforms for a princely rabbit in this puzzle game; something... | Read more »
WW2: Sandbox. Strategy & Tactics (G...
WW2: Sandbox. Strategy & Tactics 1.0.0 Device: iOS Universal Category: Games Price: $9.99, Version: 1.0.0 (iTunes) Description: ***NOTE: Compatible with iPhone 4s and up, iPad 2 and up - may not work properly on earlier devices... | Read more »
apeFilter (Music)
apeFilter 1.0 Device: iOS Universal Category: Music Price: $6.99, Version: 1.0 (iTunes) Description: | Read more »

Price Scanner via MacPrices.net

Apple resting On Its iPhone Laurels? – The ‘B...
Apple calls its new iPhone 6 and 6 Plus “The Biggest Advancements in iPhone History,” but does reality live up to the hype? “Seldom have so many waited so breathlessly for so little,” tweeted veteran... Read more
Roundup of Apple Mac and iPad Education disco...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more
Apple Boycotts German Magazine Computer Bild...
Apple has revoked its PR accreditation of Germany’s Computer Bild, Europe’s best-selling PC magazine, in reaction to Bild’s posting of a “#Bentgate” YouTube video. Axel Telzerow, editor in chief of... Read more
iPhone 6 & iPhone 6 Plus Available in Chi...
Apple has announced that iPhone 6 and iPhone 6 Plus will be available in China beginning Friday, October 17 from the Apple Online Store (http://www.apple.com), Apple’s retail stores, and an expansive... Read more
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

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.