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

Default Folder X 5.1.6 - Enhances Open a...
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 on... Read more
Geekbench 4.1.2 - Measure processor and...
Geekbench provides a comprehensive set of benchmarks engineered to quickly and accurately measure processor and memory performance. Designed to make benchmarks easy to run and easy to understand,... Read more
GraphicConverter 10.5 - $39.95
GraphicConverter is an all-purpose image-editing program that can import 200 different graphic-based formats, edit the image, and export it to any of 80 available file formats. The high-end editing... Read more
Dropbox 35.4.20 - Cloud backup and synch...
Dropbox is an application that creates a special Finder folder that automatically syncs online and between your computers. It allows you to both backup files and keep them up-to-date between systems... Read more
XMind 8 Update 4 - Popular mind mapping...
XMind is the most popular mind mapping tool. Millions of people use XMind to clarify thinking, manage complex information, run brainstorming and get work organized. It couldn't be easier to get... Read more
Safari Technology Preview 11.1 - The new...
Safari Technology Preview contains the most recent additions and improvements to WebKit and the latest advances in Safari web technologies. And once installed, you will receive notifications of... Read more
Chromium 61.0.3163.91 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. Version 61.0.3163.91: Release notes were unavailable... Read more
RapidWeaver 7.5.1 - Create template-base...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more
Google Chrome 61.0.3163.91 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
Quicken 4.6.3 - Complete personal financ...
Quicken makes managing your money easier than ever. Whether paying bills, upgrading from Windows, enjoying more reliable downloads, or getting expert product help, Quicken's new and improved features... Read more

Stormbound: Kingdom Wars guide - how to...
Stormbound: Kingdom Wars is an excellent new RTS turned card battler out now on iOS and Android. Lovers of strategy will get a lot of enjoyment out of Stormbound's chess-like mechanics, and it's cardbased units are perfect for anyone who loves the... | Read more »
The best AR apps and games on iOS right...
iOS 11 has officially launched, and with it comes Apple's ARKit, a helpful framework that makes it easier than ever for developers to create mobile AR experiences. To celebrate the occassion, we're featuring some of the best AR apps and games on... | Read more »
Phoenix Wright: Ace Attorney - Spirit of...
Phoenix Wright: Ace Attorney - Spirit of Justice 1.00.00 Device: iOS Universal Category: Games Price: $.99, Version: 1.00.00 (iTunes) Description: ************************************************※IMPORTANT※・Please read the “When... | Read more »
Kpressor (Utilities)
Kpressor 1.0.0 Device: iOS Universal Category: Utilities Price: $4.99, Version: 1.0.0 (iTunes) Description: The ultimate ZIP compression application for iPhone and iPad. - Full integration of iOS 11 with support for multitasking.-... | Read more »
Find out how you can save £35 and win a...
Nothing raises excitement like a good competition, and we’re thrilled to announce our latest contest. We’ll be sending one lucky reader and a friend to the Summoners War World Arena Championship at Le Comedia in Paris on October 7th. It’s the... | Read more »
Another Lost Phone: Laura's Story...
Another Lost Phone: Laura's Story 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Another Lost Phone is a game about exploring the social life of a young woman whose phone you have just... | Read more »
The Witness (Games)
The Witness 1.0 Device: iOS Universal Category: Games Price: $9.99, Version: 1.0 (iTunes) Description: You wake up, alone, on a strange island full of puzzles that will challenge and surprise you. You don't remember who you are, and... | Read more »
Egg, Inc. guide - how to build your gold...
Egg, Inc.'s been around for some time now, but don't you believe for one second that this quirky clicker game has gone out of style. The game keeps popping up on Reddit and other community forums thanks to the outlandish gameplay (plus, the... | Read more »
The best deals on the App Store this wee...
Good news, everyone! Your favorite day of the week has arrived at last -- it's discount roundup day! This fine Wednesday evening we're gathering up the hottest deals on the App Store. We've got action platformers, we've got puzzle games, we've got... | Read more »
Morphite (Games)
Morphite 1.08 Device: iOS Universal Category: Games Price: $7.99, Version: 1.08 (iTunes) Description: | Read more »

Price Scanner via MacPrices.net

Apple Refurbished 2017 13-inch MacBook Pros a...
Apple has Certified Refurbished 2017 13″ Touch Bar MacBook Pros in stock today and available for $200-$300 off MSRP. A standard Apple one-year warranty is included with each MacBook, and shipping is... Read more
OWC USB-C Travel Dock with 5 Ports Connectivi...
OWC have announced the new OWC USB-C Travel Dock, the latest addition to their line of connectivity solutions. The USB-C Travel Dock lets you connect its integrated USB-C cable to a Mac or PC laptop... Read more
Pelican Products, Inc. Unveils Cases For All...
Pelican Products, Inc. has announced the launch of its full line of cases including Voyager, Adventurer, Protector, Ambassador, Interceptor (for the Apple iPhone 8 and 8 Plus backwards compatible... Read more
$100 off new 2017 13-inch MacBook Airs
B&H Photo has 2017 13″ MacBook Airs on sale today for $100 off MSRP including free shipping. B&H charges NY & NJ sales tax only: – 13″ 1.8GHz/128GB MacBook Air (MQD32LL/A): $899, $100 off... Read more
Apple restocks Certified Refurbished 13-inch...
Apple has Certified Refurbished 2015 13″ MacBook Airs available starting at $719 and 2016 models available starting at $809. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Is iPhone X Really The Future Of The Smartpho...
Should iPhone X even be called a telephone? It does of course support telephony and texting, but its main feature set is oriented to other things. It is also debatable whether it makes any rational... Read more
OtterBox Announces Full Case Lineup for iPhon...
Apple revolutionized the smartphone industry 10 years ago with the original iPhone, and OtterBox has set the standard of protection from the very beginning by protecting every generation of iPhone.... Read more
LifeProof Introduces What’s NEXT Cases for iP...
LifeProof built its reputation on sleek, ultra-protective iPhone cases. From 360-degree coverage to the first screenless waterproof case, the protection pioneer has always pushed the limits.... Read more
Apple Refurbished 2016 15-inch MacBook Pros a...
Apple has Certified Refurbished 2016 15″ Touch Bar MacBook Pros available starting at $1949. An Apple one-year warranty is included with each model, and shipping is free: – 15″ 2.7GHz Touch Bar Space... Read more
Wednesday deal: 15-inch MacBook Pros for up t...
B&H Photo has 2017 15″ MacBook Pros on sale for $150-$200 off MSRP. Shipping is free, and B&H charges sales tax in NY & NJ only: – 15″ 2.8GHz MacBook Pro Space Gray: $2199, $200 off MSRP... Read more

Jobs Board

Development Operations and Site Reliability E...
Development Operations and Site Reliability Engineer, Apple Payment Gateway Job Number: 57572631 Santa Clara Valley, California, United States Posted: Jul. 27, 2017 Read more
Full time *Apple* Hardware Tech needed - ma...
…high level of attention to detail Ethics, integrity and trust Be a geek & Previous Apple experience a must. Previous Apple Retail or other Apple Specialist Read more
Development Operations and Site Reliability E...
Development Operations and Site Reliability Engineer, Apple Payment Gateway Job Number: 57572631 Santa Clara Valley, California, United States Posted: Jul. 27, 2017 Read more
*Apple* Store - Technical Specialist - Apple...
…customers purchase our products, you're the one who helps them get more out of their new Apple technology. Your day in the Apple Store is filled with a range of 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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.