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

DiskCatalogMaker 6.4.12 - Catalog your d...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast. Finder-like intuitive look and feel. Super-fast search algorithm. Can compress catalog data... Read more
Macs Fan Control 1.3.0.0 - Monitor and c...
Macs Fan Control allows you to monitor and control almost any aspect of your computer's fans, with support for controlling fan speed, temperature sensors pane, menu-bar icon, and autostart with... Read more
Lyn 1.5.11 - Lightweight image browser a...
Lyn is a lightweight and fast image browser and viewer designed for photographers, graphic artists and Web designers. Featuring an extremely versatile and aesthetically pleasing interface, it... Read more
NeoOffice 2014.11 - Mac-tailored, OpenOf...
NeoOffice is a complete office suite for OS X. With NeoOffice, users can view, edit, and save OpenOffice documents, PDF files, and most Microsoft Word, Excel, and PowerPoint documents. NeoOffice 3.x... Read more
LaunchBar 6.4 - Powerful file/URL/email...
LaunchBar is an award-winning productivity utility that offers an amazingly intuitive and efficient way to search and access any kind of information stored on your computer or on the Web. It provides... Read more
Remotix 3.1.4 - Access all your computer...
Remotix is a fast and powerful application to easily access multiple Macs (and PCs) from your own Mac. Features Complete Apple Screen Sharing support - including Mac OS X login, clipboard... Read more
DesktopLyrics 2.6.6 - Displays current i...
DesktopLyrics is an application that displays the lyrics of the song currently playing in "iTunes" right on your desktop. The lyrics for the song have to be set in iTunes; DesktopLyrics does nothing... Read more
VOX 2.5.1 - Music player that supports m...
VOX is a beautiful music player that supports many filetypes. The beauty is in its simplicity, yet behind the minimal exterior lies a powerful music player with a ton of features and support for all... Read more
NetNewsWire 4.0.0 - RSS and Atom news re...
NetNewsWire is the best way to keep up with the sites and authors you read most regularly. Let NetNewsWire pull down the latest articles, and read them in a distraction-free and Mac-like way. Native... Read more
MacUpdate Desktop 6.0.6 - Search and ins...
MacUpdate Desktop 6 brings seamless 1-click installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on macupdate.... Read more

Biz Builder Delux (Games)
Biz Builder Delux 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Ah, there's nothing like the rhythmic bustle of a burgeoning business burg... especially when you're the one building it... | Read more »
Auroch Digital is Bringing Back Games Wo...
| Read more »
Carbo - Handwriting in the Digital Age...
Carbo - Handwriting in the Digital Age 1.0 Device: iOS Universal Category: Productivity Price: $3.99, Version: 1.0 (iTunes) Description: | Read more »
Draggy Dead (Games)
Draggy Dead 1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1 (iTunes) Description: Ditch your dead end job and take up a rewarding career in Grave Robbing today!Guide the recently deceased to a fun filled life of... | Read more »
Bad Dinos (Games)
Bad Dinos 1.0.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.0 (iTunes) Description: | Read more »
The Apple Watch isn't Great as a Fi...
| Read more »
Show the World What You See With Stre.am...
Live broadcasting is getting popular on mobile devices, which is why you can now get Stre.am, by Infinite Takes. [Read more] | Read more »
PhotoTime's 2.1 Update Adds Apple W...
The latest PhotoTime update is adding even more functionality to the handy photo organizing app. Yep, including Apple Watch support. [Read more] | Read more »
Oh My Glob! Adventure Time Puzzle Quest...
Finn and Jake are taking over D3 Go!'s popular puzzle game series in the upcoming Adventure Time Puzzle Quest. [Read more] | Read more »
Earthcore: Shattered Elements - Tips, Tr...
At first glance, Earthcore: Shattered Elements seems like a rather simple card-battling game. Once you’re introduced to skills that will change quite a bit. Even more so once you start to acquire hero cards. But it’s not so complicated that we... | Read more »

Price Scanner via MacPrices.net

OtterBox Maximizes Portability, Productivity...
From the kitchen recipe book to the boarsroom presentation, the OtterBox Agility Tablet System turns tablets into one of the most versatile pieces of handheld technology available. Available now, the... Read more
Launch of New Car App Gallery and Open Develo...
Automatic, a company on a mission to bring the power of the Internet into every car, has announced the launch of the Automatic App Gallery, an app store for nearly every car or truck on the road... Read more
Memorial Day Weekend Sale: 13-inch 1.6GHz Mac...
Best Buy has the new 13″ 1.6GHz/128GB MacBook Air on sale for $849 on their online store this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders... Read more
Memorial Day Weekend Sale: 27-inch 3.5GHz 5K...
Best Buy has the 27″ 3.5GHz 5K iMac on sale for $2099.99 this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-store prices may vary.... Read more
Sale! 16GB iPad mini 3 for $349, save $50
B&H Photo has the 16GB iPad mini 3 WiFi on sale for $349 including free shipping plus NY sales tax only. Their price is $50 off MSRP, and it’s the lowest price available for this model. Read more
Price drop on 2014 15-inch Retina MacBook Pro...
B&H Photo has dropped prices on 2014 15″ Retina MacBook Pros by $200. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799.99 save $200 - 15″ 2.5GHz... Read more
With a Mission to Make Mobile Free, Scratch W...
Scratch Wireless, claiming to be the world’s first truly free mobile service, has announced the availability of a new Scratch-enabled Android smartphone, the Coolpad Arise. The smartphone is equipped... Read more
First-Ever Titanium Alloy Curved iPhone 6 Scr...
One of the most common problems with mobile phones is damage to the screens. The slightest drop can cause a dreaded spider web of gashes and cracks in the glass panel surface that can cost $hundreds... Read more
Preorder new 12-inch MacBook, $10 off, save o...
Adorama has new 12″ Retina MacBooks available for preorder for $10 off MSRP including free shipping plus NY & NJ sales tax only. For a limited time, Adorama will include a free Apple USB-C to USB... Read more
Will iOS 9 Finally Bring Productivity Friendl...
Ah, the irony. From its original announcement in 2010, Apple has doggedly insisted that the iPad remain “simple,” thus arbitrarily limiting its considerable potential as a content creation and... 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
Architect / Senior Software Engineer, *Apple...
Changing the world is all in a day039s work at Apple . If you love innovation, here039s your chance to make a career of it. You039ll work hard. But the job comes with Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* Pay Support Readiness Project Manage...
Changing the world is all in a day039s work at Apple . If you love innovation, here039s your chance to make a career of it. You039ll work hard. But the job comes with Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.