TweetFollow Us on Twitter

Mar 96 Tips
Volume Number:12
Issue Number:3
Column Tag:Tips & Tidbits

Tips & Tidbits

By Steve Sisak, Contributing Editor

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

Calling PowerPC Code
From 68K Code

There is a lot of information out there about calling 68K code from PowerPC code, but there is very little about calling PowerPC code from 68K code.

Here is a nice method for calling PowerPC code from 68K code. I am using CodeWarrior 7. This is a bit lengthy so hang in there:

There are three steps required to get things up and running. Let’s look at a sample scenario:

You have a 68K application that you just can’t convert to PowerPC code (I don’t know why you can’t convert it, but just bear with me), but you can take some of the time-critical code and convert it to a PowerPC shared library and call it from the 68K code.

Suppose you have two functions that perform data compression:

long  CompressData(  unsigned char *inBuffer, 
 unsigned char *outBuffer,
 unsigned long inBufferSize );
   
long  UncompressData(unsigned char *inBuffer, 
 unsigned char *outBuffer, 
 unsigned long inBufferSize );

Step 1 - Create a PPC shared library containing your functions.

We are going to export these functions using the #pragma export directive. This is set in the PPC Prefs area of Codewarrior preferences.

“the shared library”
// Prototypes

#pragma export on

#ifdef __cplusplus
extern "C" {
#endif

long  CompressData(  unsigned char *inBuffer, 
 unsigned char *outBuffer, 
 unsigned long inBufferSize );
   
long  UncompressData(   unsigned char *inBuffer,
 unsigned char *outBuffer,
 unsigned long inBufferSize );

#ifdef __cplusplus
}
#endif

#pragma export off
// CompressData

long  CompressData( unsigned char *inBuffer, unsigned char 
   *outBuffer, unsigned long inBufferSize )
{
    ... compress data code
}

// UncompressData
   
long  UncompressData( unsigned char *inBuffer, unsigned char 
     *outBuffer, unsigned long inBufferSize )
{
    ... uncompress data code
}

Set the project type to a shared library and build the project. We now have a PowerPC shared library that we will use in Step 2.


Step 2 - Create a resource-based PEF Fragment that references our shared library.

We create a header file that defines some mixed mode information.

“the header file”
#ifdef __cplusplus
extern "C" {
#endif

typedef long (*CompressDataProcPtr)( unsigned char *inBuffer, 
 unsigned char *outBuffer, unsigned long inBufferSize );
typedef long (*UncompressDataProcPtr)( unsigned char *inBuffer, 
 unsigned char *outBuffer, unsigned long inBufferSize);

#if GENERATINGCFM || USESROUTINEDESCRIPTORS

typedef UniversalProcPtr CompressDataUPP;
typedef UniversalProcPtr UncompressDataUPP;

enum {
 uppCompressDataProcInfo = kCStackBased
 | RESULT_SIZE( SIZE_CODE( sizeof( long ) ) )
 | STACK_ROUTINE_PARAMETER( 1, SIZE_CODE( 
 sizeof( unsigned char *) ) )
 | STACK_ROUTINE_PARAMETER( 2, SIZE_CODE( 
 sizeof( unsigned char *) ) ) | STACK_ROUTINE_PARAMETER( 3, SIZE_CODE( 

 sizeof( long ) ) )
};

enum {
 uppUncompressDataProcInfo = kCStackBased
 | RESULT_SIZE( SIZE_CODE( sizeof( long ) ) )
 | STACK_ROUTINE_PARAMETER( 1, SIZE_CODE( 
 sizeof( unsigned char *) ) )
 | STACK_ROUTINE_PARAMETER( 2, SIZE_CODE( 
 sizeof( unsigned char *) ) )
 | STACK_ROUTINE_PARAMETER( 3, SIZE_CODE( 
 sizeof( long ) ) )
};

#else

typedef CompressDataProcPtr CompressDataUPP;
typedef UncompressDataProcPtr UncompressDataUPP;
#endif

//============================================================
// Extern Globals
//

#ifndef powerc

extern CompressDataUPP    myCompressDataUPP;
extern UncompressDataUPP  myUncompressDataUPP;

#endif

//============================================================
// Macros
//

#if GENERATINGPOWERPC || defined(powerc) || defined (__powerc)

#define myCompressData( a, b, c )  CompressData( a, b, c )
#define myUncompressData( a, b, c )UncompressData( a, b, c )

#else

#define myCompressData( a, b, c ) \  
 (*(CompressDataUPP)myCompressDataUPP( a, b, c )
#define myUncompressData( a, b, c  ) \
 (*(CompressDataUPP)myUncompressDataUPP( a, b, c )

#endif

//============================================================
// Prototypes
//

long CompressData( unsigned char *inBuffer, unsigned char 
    *outBuffer, unsigned long inBufferSize );
long UncompressData( unsigned char *inBuffer, unsigned char 
  *outBuffer, unsigned long inBufferSize );

#ifdef __cplusplus
}
#endif

Now we define the source file:

“the source file”
#include "the header file"

#ifdef __cplusplus
extern "C" {
#endif

#if GENERATINGPOWERPC || defined(powerc) || defined (__powerc)
#pragma options align=mac68k
#endif

#ifdef __CFM68K__
#pragma lib_export on
#endif

RoutineDescriptorCompressDataRD = 
 BUILD_ROUTINE_DESCRIPTOR(  uppCompressDataProcInfo, 
 CompressData );

RoutineDescriptorUncompressDataRD = 
 BUILD_ROUTINE_DESCRIPTOR(  uppUncompressDataProcInfo, 
 UncompressData );


#ifdef __CFM68K__
#pragma lib_export off
#endif

#if GENERATINGPOWERPC || defined(powerc) || defined (__powerc)
#pragma options align=reset
#endif

#ifdef __cplusplus
}
#endif

Add the shared library we built in Step 1 to this project.

Set the project type to shared library and build the project. We now have a PowerPC shared library that we want to convert to a resource. (Note: we don’t export this as a PowerPC code resource with no header, since we would get link errors for an undefined main entry.)

Open the file up in a resource editor and create a new resource (I use a type of 'PEF ', but any will do). Move the PEF code from the data fork into this resource. (If your resource editor will not do this, then it is a simple matter of creating a small application that will do this for you; this excercise is left for the reader.)

We now have a resource file that we will add to our 68K project.


Step 3 - Add 68K support code to your project

Your 68K project needs to have a bit of support code to get the code resource and load it in as a code fragment. Add to your code:

#include "the header file"

We need to declare some globals for the universal procs that will store the address of the routine descriptors. Add to your code:

#ifndef powerc
CompressDataUPP  myCompressDataUPP;
UncompressDataUPPmyUncompressDataUPP;
#endif

The following function takes care of checking for the existence of the CFM and Mixed Mode managers. We pass it a pointer to a CFragConnectionID variable and a Handle variable, which we will use later on for clean up. Add to your code:

#ifndef powerc

// SetupPPCNativeCode

OSErr SetupPPCNativeCode( CFragConnectionID *connID, 
 Handle *PEFHandle,
   ResType codeFragmentType, 
 short codeFragmentID )
{
 OSErr  theErr = noErr;
 long   templong;
 Str255 failedFragName;
 

    // get PEF container resource from our resource fork
 
 *PEFHandle = ::Get1Resource( codeFragmentType, codeFragmentID );
 theErr = ::ResError();
 if( !(*PEFHandle) )
 {
 if( theErr )  
 return( theErr );
 else
 return( ::MemError() );
 }
 
    // Check for Mixed Mode Manager and Code Fragment Manager (CFM)
 
 Boolean  hasMixedMode = !Gestalt( gestaltMixedModeAttr, 
 &templong );
 Boolean  hasCFM = !Gestalt( gestaltCFMAttr, &templong );
 
 theErr = Gestalt( gestaltSysArchitecture, &templong );
 if( ( theErr ) || 
 ( templong == gestalt68k ) ||
 ( !hasCFM ) ||
 ( !hasMixedMode ) )
 {
 ::ReleaseResource( *PEFHandle );
 return( -1 );
 }
 
 DetachResource( *PEFHandle );
 MoveHHi( *PEFHandle );
 HLock( *PEFHandle );
 
    // Assume this is PowerPC code, so it must be “prepared”
 
 theErr = ::GetMemFragment( (Ptr)**PEFHandle, 0, 0,            
 kNewCFragCopy, connID, 0, failedFragName );
 if( theErr )
 {
 DisposeHandle( *PEFHandle );
 return( theErr );
 }

 CFragSymbolClassmyClass;
 
 if( !theErr )
 theErr = ::FindSymbol( *connID, 
    (ConstStr255Param)"\pCompressDataRD", 
    (Ptr*)&myCompressDataUPP, 
    &myClass );
 if( !theErr )
 theErr = ::FindSymbol( *connID, 
    (ConstStr255Param)"\pUncompressDataRD", 
    (Ptr*)&myUncompressDataUPP, 
    &myClass );

 if( theErr )
 {
 DisposeHandle( *PEFHandle );
 return( theErr );
 }
 
 return( noErr );
}

The following function takes the connection id and handle returned from SetupPPCNativeCode, frees the connection and disposes of the handle. Add to your code:

// TearDownPPCNativeCode

void TearDownPPCNativeCode( CFragConnectionID connID, Handle PEFHandle 
)
{
 ::CloseConnection( &connID );
 if( PEFHandle )
 ::DisposeHandle( PEFHandle );
}

#endif

Build your 68K project as you normally would and be sure to include the resource file we created in Step 2 and ensure the the shared library we created in Step 1 is either in the Extensions folder of the System Folder or in the same directory as the application.

Here is what you would do the call the PowerPC code from 68K:

long PowerPC_Compress( unsigned char *inBuffer, unsigned char 
    *outBuffer, unsigned long inBufferSize )
{
 #ifndef powerc
 
    // For efficiency you would probably put this call in initialization code.
    // sConnID and sPEFHandle are static globals.
 
 OSErr err = SetupPPCNativeCode( &sConnID, &sPEFHandle, 
 'PEF ', 128 );
 if( err )
 return( 0 );  // We couldn’t compress anything so return 0
 #endif
 
 long   result = 0;
 
 result = myCompressData( inBuffer, outBuffer, inBufferSize );
 
 #ifndef powerc
 
    // For efficiency you would probably put this call in termination code.
 
 TearDownPPCNativeCode( sConnID, sPEFHandle );
 #endif
}

long PowerPC_Uncompress( unsigned char *inBuffer, 
 unsigned char *outBuffer, unsigned long inBufferSize )
{
 #ifndef powerc
 
    // For efficiency you would probably put this call in initialization code.
    // sConnID and sPEFHandle are static globals.
 
 OSErr err = SetupPPCNativeCode( &sConnID, &sPEFHandle, 
 'PEF ', 128 );
 if( err )
 return( 0 );  // We couldn’t compress anything so return 0
 #endif
 
 long   result = 0;
 
 result = myUncompressData( inBuffer, outBuffer, inBufferSize );
 
 #ifndef powerc
 
    // For efficiency you would probably put this call in termination code.
 
 TearDownPPCNativeCode( sConnID, sPEFHandle );
 #endif
}


That’s all there is to it. Enjoy and happy coding.

- Chris Rudolph

[BuildRoutineDescriptor() doesn’t work right with CFM68k; use NewRoutineDescriptor() instead. BuildRoutineDescriptor() generates code so you need to call MakeDataExecutable() after it. - sgs]

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

The beginner's guide to Warbits
Warbits is a turn-based strategy that's clearly inspired by Nintendo's Advance Wars series. Since turn-based strategy games can be kind of tricky to dive into, see below for a few tips to help you in the beginning. Positioning is crucial [Read... | Read more »
How to upgrade your character in Spellsp...
So you’ve mastered the basics of Spellspire. By which I mean you’ve realised it’s all about spelling things in a spire. What next? Well you’re going to need to figure out how to toughen up your character. It’s all well and good being able to spell... | Read more »
5 slither.io mash-ups we'd love to...
If there's one thing that slither.io has proved, it's that the addictive gameplay of Agar.io can be transplanted onto basically anything and it will still be good fun. It wouldn't be surprising if we saw other developers jumping on the bandwagon,... | Read more »
How to navigate the terrain in Sky Charm...
Sky Charms is a whimsical match-'em up adventure that uses creative level design to really ramp up the difficulty. [Read more] | Read more »
Victorious Knight (Games)
Victorious Knight 1.3 Device: iOS Universal Category: Games Price: $1.99, Version: 1.3 (iTunes) Description: New challenges awaits you! Experience fresh RPG experience with a unique combat mechanic, packed with high quality 3D... | Read more »
Agent Gumball - Roguelike Spy Game (Gam...
Agent Gumball - Roguelike Spy Game 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Someone’s been spying on Gumball. What the what?! Two can play at that game! GO UNDERCOVERSneak past enemy... | Read more »
Runaway Toad (Games)
Runaway Toad 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: It ain’t easy bein’ green! Tap, hold, and swipe to help Toad hop to safety in this gorgeous new action game from the creators of... | Read more »
PsyCard (Games)
PsyCard 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: From the makers och Card City Nights, Progress To 100 and Ittle Dew PSYCARD is a minesweeper-like game set in a cozy cyberpunk... | Read more »
Sago Mini Robot Party (Education)
Sago Mini Robot Party 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: -- Children's Technology Review Editor's Choice -- | Read more »
How to get a high score in every level o...
Sky Charms is an adorable match three puzzler that provides a decent challenge thanks to its creative level design. It regularly presents something new, forcing you to think on your feet. [Read more] | Read more »

Price Scanner via MacPrices.net

Apple restocks Certified Refurbished Mac mini...
Apple has restocked Certified Refurbished 2014 Mac minis, with models available starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: - 1.4GHz Mac mini: $419 $... Read more
15-inch 2.2GHz Retina MacBook Pro on sale for...
Amazon.com has the 15″ 2.2GHz Retina MacBook Pro on sale for $1699.99 including free shipping. Their price is $300 off MSRP, and it’s the lowest price available for this model from any reseller (and... Read more
Apple Beats Microsoft at Own Game; Amazon Pri...
First quarter seasonality combined with an overall disinterested customer base led to an annual decline of 14.7% in worldwide tablet shipments during the first quarter of 2016 (1Q16). Worldwide... Read more
Tablets Had Worst Quarter Since 2012, says St...
The global tablet market began 2016 just as 2015 left off, down. Tablet shipments fell 10% to 46.5 million units during the Q1 2016, according to the new “Preliminary Global Tablet Shipments and... Read more
Clearance 13-inch MacBook Airs, Apple refurbi...
Apple recently dropped prices on certified refurbished 2015 13″ MacBook Airs with 4GB of RAM with models now available starting at $759. An Apple one-year warranty is included with each MacBook, and... Read more
Clearance 12-inch Retina MacBooks, Apple refu...
Apple has dropped prices on Certified Refurbished 2015 12″ Retina MacBooks with models now available starting at $929. Apple will include a standard one-year warranty with each MacBook, and shipping... Read more
Aleratec Releases Mac Software Upgrade for 1...
California based Aleratec Inc., designer, developer and manufacturer of Portable Device Management (PDM) charge/sync products for mobile devices and professional-grade duplicators for hard disk... Read more
Sale! Amazon offers 27-inch iMac, 13-inch 2.9...
Amazon has the 27″ 3.2GHz 5K iMac and the 13″ 3.9GHz Retina MacBook Pro on sale for $300 off MSRP, each including free shipping, for a limited time: - 27″ 3.2GHz/1TB HD 5K iMac (model MK462LL/A): $... Read more
Apple refurbished 13-inch Retina MacBook Pros...
Apple has Certified Refurbished 13″ Retina MacBook Pros available for up to $270 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 13″ 2.7GHz... Read more
13-inch 2.7GHz/128GB Retina MacBook Pro on sa...
Take $200 off MSRP on the price of a new 13″ 2.7GHz/128GB Retina MacBook Pro (model MF839LL/A) at Amazon. Shipping is free: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1099.99 $200 off MSRP Act now if... Read more

Jobs Board

Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and 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
*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
*Apple* Solutions Consultant - Apple (United...
# Apple Solutions Consultant Job Number: 48260200 Phoenix, Arizona, United States Posted: Apr. 22, 2016 Weekly Hours: 40.00 **Job Summary** As an Apple Solutions Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.