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
$101.32
Apple Inc.
+0.74
MSFT
$45.15
Microsoft Corpora
-0.07
GOOG
$582.56
Google Inc.
-0.81

MacTech Search:
Community Search:

Software Updates via MacUpdate

calibre 2.0.0 - Complete e-library manag...
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
Apple iMovie 10.0.5 - Edit personal vide...
With an all-new design, Apple iMovie lets you enjoy your videos like never before. Browse your clips more easily, instantly share your favorite moments, and create beautiful HD movies and Hollywood-... Read more
Apple Keynote 6.2.2 - Apple's prese...
Apple Keynote makes it simple to create and deliver beautiful presentations. Powerful tools and dazzling effects bring your ideas to life. You can work seamlessly between Mac and iOS devices. And... Read more
Apple Numbers 3.2.2 - Apple's sprea...
With Apple Numbers, sophisticated spreadsheets are just the start. The whole sheet is your canvas. Just add dramatic interactive charts, tables, and images that paint a revealing picture of your data... Read more
OpenOffice 4.1.1 - Free and open-source...
OpenOffice.org is both an Open Source product and a project. The product is a multi-platform office productivity suite. It includes the key desktop applications, such as a word processor,... Read more
Pages 5.2.2 - Apple's word processo...
Apple Pages is a powerful word processor that gives you everything you need to create documents that look beautiful. And read beautifully. It lets you work seamlessly between Mac and iOS devices. And... Read more
Quicken 2015 2.0.1 - Complete personal f...
The new Quicken 2015 helps you manage all your personal finances in one place, so you can see where you're spending and where you can save. Quicken automatically categorizes your financial... Read more
CleanMyMac 2.2.7 - Delete files that was...
CleanMyMac makes space for the things you love. Sporting a range of ingenious new features, CleanMyMac 2 lets you safely and intelligently scan and clean your entire system, delete large, unused... Read more
MacFamilyTree 7.2.4 - Create and explore...
MacFamilyTree gives genealogy a facelift: it's modern, interactive, incredibly fast, and easy to use. We're convinced that generations of chroniclers would have loved to trade in their genealogy... Read more
Videobox 4.1.1 - Download Flash video th...
Videobox allows you to quickly and easily download Flash video from most all of the popular video sites on the internet. Videobox will convert the video into a native Quicktime format so it's ready... Read more

Latest Forum Discussions

See All

Trolls vs Vikings Update Adds Over One H...
Trolls vs Vikings Update Adds Over One Hundred Levels, Reduces Item Cost, and More Posted by Ellis Spice on August 22nd, 2014 [ permalink ] | Read more »
SNK Celebrates the 20th Anniversary of T...
SNK Celebrates the 20th Anniversary of The King of Fighters With a Big Sale Posted by Ellis Spice on August 22nd, 2014 [ permalink ] | Read more »
It Came From Canada: Star Wars: Commande...
With a brand new Star Wars trilogy on the horizon, prepare yourselves for Disney and George Lucas’s space fantasy throwback to be more omnipresent than ever before. So it should come as no surprise that new adventures in that galaxy far, far away... | Read more »
Swing Copters Review
Swing Copters Review By Jordan Minor on August 22nd, 2014 Our Rating: :: DIE TRYINGUniversal App - Designed for iPhone and iPad The creator of Flappy Bird is back with a vengeance.   | Read more »
The Outcast Review
The Outcast Review By Nadia Oxford on August 22nd, 2014 Our Rating: :: HANDS OFF. WAY OFF.Universal App - Designed for iPhone and iPad It’s easy to see what The Outcast is trying for, but its execution needs a lot of work.   | Read more »
Brain+ Review
Brain+ Review By Nadia Oxford on August 22nd, 2014 Our Rating: :: DIM BULBUniversal App - Designed for iPhone and iPad Brain+ is just another entry in an over-saturated brain-training marketplace – and not a particularly fun entry... | Read more »
The Witcher Battle Arena – New Gameplay...
The Witcher Battle Arena – New Gameplay Trailer Revealed Posted by Jessica Fisher on August 22nd, 2014 [ permalink ] Based in the Witcher universe, | Read more »
Max Gentlemen Review
Max Gentlemen Review By Jennifer Allen on August 22nd, 2014 Our Rating: :: OUTSTAYING ITS WELCOMEiPhone App - Designed for the iPhone, compatible with the iPad Max Gentlemen seems pretty quirky initially but that appeal wears thin... | Read more »
Club Penguin Gets Frozen All Over in Lat...
Club Penguin Gets Frozen All Over in Latest Takeover Event Posted by Ellis Spice on August 22nd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Doctor Who: Legacy Review
Doctor Who: Legacy Review By Jennifer Allen on August 22nd, 2014 Our Rating: :: RUN OF THE MILLUniversal App - Designed for iPhone and iPad Doctor Who: Legacy is an ok match-3 puzzle game, but it lacks some much needed personality... | Read more »

Price Scanner via MacPrices.net

Leftover 15-inch 2.0GHz Retina MacBook Pros a...
B&H Photo has leftover previous-generation 15″ 2.0GHz Retina MacBook Pros now available for $1599 including free shipping plus NY sales tax only. Their price is $400 off original MSRP. B&H... Read more
Pro.Calendar – New Productivity App for iPad...
Austin, Texas based mobile business and productivity app developer LightArrow, Inc. has announced Pro.Calendar, a powerful and intuitive calendar app with eight versatile calendar options including... Read more
SanDisk Ultra II SSD — Supercharge Your Syste...
SanDisk Corporation has announced the new SanDisk Ultra II SSD with enhanced SSD Dashboard. The new drive is designed to deliver a cost-effective and easy upgrade solution for PC owners looking to... Read more
Samsung and Barnes & Noble Introduce New...
Samsung Electronics America and NOOK Media, a subsidiary of Barnes & Noble, Inc. have announced the introduction of the new Samsung Galaxy Tab 4 NOOK, a 7-inch tablet combining Samsung’s leading... Read more
21-inch iMacs on sale for up to $150 off MSRP
B&H Photo has 21″ iMacs on sale for up to $150 off MSRP including free shipping plus NY sales tax only. B&H will also include a free copy of Parallels Desktop software: - 21″ 2.7GHz iMac: $... Read more
27-inch 3.2GHz iMac on sale for $1698, save $...
Abt has the 27″ 3.2GHz iMac on sale for $1698 including free shipping. Their price is $101 off MSRP. Read more
Mac Backup Guru 2.0 Drive Backup/Cloneing Uti...
Mac Backup Guru developer MacDaddy has released Mac Backup Guru 2.0, offering new and enhanced advanced features, such as bootable backups, synchronised volumes and folders, and a Snapshot mode that... Read more
Operate GE’s New Free-Standing KItchen Range...
Think you accidentally left the oven on? Switch it off while on the go. The new free-standing Profile™ Series gas and electric ranges are GE’s second cooking appliances, following their wall oven, to... Read more
Parallels Announces Parallels Desktop 10 for...
The no. 1-selling software for running Windows applications on a Mac becomes an even easier choice for millions of consumers and IT professionals worldwide with the launch of the most powerful... Read more
Apple now offering certified refurbished 2014...
 The Apple Store is now offering Apple Certified Refurbished 2014 MacBook Airs for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... 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
Position Opening at *Apple* - Apple (United...
**Job Summary** As more and more people discover Apple , they visit our stores seeking ways to incorporate our products into their lives. It's your job, as a Store Read more
Position Opening at *Apple* - Apple (United...
…Summary** As a Specialist, you help create the energy and excitement around Apple products, providing the right solutions and getting products into customers' hands. You Read more
Project Manager, *Apple* Financial Services...
**Job Summary** Apple Financial Services (AFS) offers consumers, businesses and educational institutions ways to finance Apple purchases. We work with national and Read more
*Apple* Solutions Consultant (ASC)- Retail S...
**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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.