TweetFollow Us on Twitter

Libraries On The Mac

Volume Number: 14 (1998)
Issue Number: 6
Column Tag: Tools Of The Trade

Libraries on the Mac

by Jeremy Nelson

An overview of shared code mechanisms on the Macintosh

Libraries - precompiled collections of code - are a powerful tool for programmers. They allow us to distribute valuable technologies without disclosing the secrets of the proprietary source code from which those libraries were created. Because libraries are precompiled, they also encourage users of the technology to treat them as a black box - letting the user focus on their own code without worrying how library accomplishes its purpose. This article will survey library mechanisms on the Macintosh and offer a brief overview of the advantages of each.

Statically Linked Libraries

Libraries can be linked to other code statically or at runtime. A statically linked library, like code you have written yourself, is integrated into your application's binary during the compilation process. In contrast, a runtime library is loaded when the application executes, and calls made to the library are redirected to the loaded code. Both kinds of libraries are a good way to share new technologies.

Statically linked libraries are made up of a precompiled binary and an interface file which contains the API. Using a statically linked library is easy, simply include the binary and the C header file or Pascal interface file. During the linking stage of compilation the binary portion of the library is integrated into your application, exactly like the compiled code of the source you have written.

Most programs include some statically linked libraries. These libraries may provide language specific functions, basic Macintosh calls or mathematical functions.

Runtime Libraries

Runtime libraries, also known as Dynamically Linked Libraries (DLL), can reduce disk usage and lower memory requirements by allowing different applications to share a single copy of the code. Runtime libraries can also allow portions of an application to be selectively updated by simply replacing an old library file with a newer one.

Like statically linked libraries, runtime libraries are composed of a binary and an interface file. However the binary is simply a stub library which contains the names of the functions and version information. Mercifully, exactly how the functions are made available to your program when the program is executed is hidden from you. During your programs initialization phase, when your program is being readied to execute, the Operating System prepares any Shared Libraries you reference.

There are a variety of Shared Library mechanisms on the Mac, each with strengths and weakness. This diversity of library mechanisms exists largely due to historical factors. The formal library mechanisms are:

  • Apple Shared Library Manager (ASLM)
  • Code Fragment Manager (CFM and CFM-68K)
  • System Object Model (SOM)

For completeness, any discussion of shared code mechanisms also needs to include:

  • Component Manager
  • Code Resources

Custom mechanisms are also perfectly valid (if possibly application specific) ways of sharing code. Creating a custom mechanism allows developers to tailor a solution, but at the risk of recreating already tried and tested code- a somewhat ironic result.

Apple Shared Library Manager (ASLM)

ASLM is the one of the oldest solutions from Apple and it works under 68K and PPC. Unfortunately you can only make the libraries with MPW. While ASLM is available on every Mac and fairly straightforward to use, very little uses ASLM besides Open Transport 68K. Most programmers will never use ASLM directly.

Example: OpenTransport 68K.

Reference: ASLM Developer's Guide, Developer CD Series Mac OS SDK.

System Object Model (SOM)

SOM was developed by IBM to work on their AIX systems, runs under OS/2 and was ported to the Mac as part of the development of OpenDoc. SOM is both PowerPC and 68K and is probably the most technically advanced solution on the Macintosh. It is also a deprecated technology and as such it will probably not progress in the future.

SOM provides a number of desirable features. It can handle different calling conventions between caller and callee, and there are standard ways to patch and unpatch the code dynamically (so you can intercept a library call with your code). It even tackles the so-called 'fragile base class' problem and other changes to the interface of a library. SOM provides the calling program with full Object Oriented class libraries, even translating across different compilers' Object implementations.

While SOM is a technically wonderful solution it is a complex technology which has been quite difficult to use. Development tools have now reduced this difficulty somewhat. SOM was deprecated along with OpenDoc.

Examples: Opendoc and Cyberdog.

Reference: SOMobjects(tm) for Mac OS, Developer CD Series Mac OS SDK.

Code Fragment Manager (CFM and CFM-68K)

CFM was made specifically for PowerPC: when the PowerPC system came out there was no native shared library, so Apple developed a PowerPC native library format. CFM is used by both ASLM and SOM to load code fragments on the PowerPC.

In 1994 CFM was ported to 68K to provide a universal solution. CFM-68K had stability problems which discouraged its use for some time. This was fixed in version 4.0 of CFM-68K in November 1996 (as described in Technote 1084).

To use CFM-68K you need to use different versions of the runtime libraries, specially modified to work with CFM-68K. This makes your application a 'CFM-68K application', and you need to be careful about using custom preemptive threading methods (this problem relates to the version 4.0 bug fix mentioned above). (It is possible, but tricky, to call CFM-68K code from classic applications. See Technote 1077 for details.)

CFM is Apple's announced direction in shared code. There are good development tools for CFM in both CodeWarrior and MPW. If you were developing a library for a PowerPC application this should be your preferred choice. Under 68K some developers may be discouraged from adopting CFM-68K applications because of the changes necessary to their application.

Example: OpenTransport, MathLib, AppearanceLib.

References: IM PowerPC System Software, Chapter 3: Code Fragment Manager.

Component Manager

The Component Manager was written by the QuickTime team to meet their need for a universal plug-in architecture. As a result, the Component Manager is available under both 68K and PPC.

Components are code fragments with a particular type (like File Types in the file system). All components of the same type have the same interface. This allows applications to chose from a list of different code fragments, each of which may have different behaviour, but can be loaded and used identically. This is equivalent to having multiple different versions of a single library, each with different performance characteristics.

Components can also be captured which permits functions to be overridden and modified. A captured component is removed from the list of available components, but can still be called by the capturing component.

The drawback is that this added versatility introduces additional complexity. Applications must deal with selecting and loading the component: the code is not loaded automatically when the program is being loaded.

QuickTime is the most obvious user of the Component Manager. An interesting user of the Component Manager is Internet Config. When Internet Config was written this was the only solution which worked well under PowerPC and 68K, and provided the override functionality, which was a desired feature of Internet Config.

Examples: QuickTime, Internet Config.

Reference: IM More Toolbox, Chapter 6: Component Manager.

Code Resources

The most common example of code resources are List Definition Functions (LDEF), Window Definitions Functions (WDEF) and Control Definition Functions (CDEF). These are functions which are loaded using the Resource Manager. It is up to the programmer to define the API and the program is responsible for loading and unloading the code.

Typically Code Resources only have a single entry point (function call) with an argument which selects the actual function and a small number of other arguments, often contained in a parameter block. Which values are extracted from the parameter block may depend on what function is called.

Code Resources have been used in a number of applications and good example code is available. For instance, on the Code Warrior Pro 2 CD, the "Pascal Code Resources" shows how to create 68K or PPC code resources, either of which can be called from both 68K and PowerPC applications. (This is a useful way to update time-critical portions of a 68K application to run under PowerPC without updating the entire application.)

Examples: LDEFs, CDEFs, Codewarrior Plug-Ins under 68K.

Reference: IM More Toolbox, Chapter 1: Resource Manager.

Dangers

Probably the most confusing thing about libraries is that the binary can be compiled using a variety of different compiler options. Thus there are usually many different versions of any given library. For a splendid example of this, look in Codewarrior's MSL C:Bin folder. There are over a dozen different versions of the Metrowerks Standard C library (MSL C for 68K).

You need to make sure you include the appropriate version of the library in your code. You will not always get compiler warnings if you include the wrong version, and some mismatched program/library compiler settings can lead to intermittent errors which may be very difficult to debug.

There are several common compiler options unique to 68K which result in different versions. The main settings include:

  • Near or Far: Under 68K calls to functions can use so called 'Near' or 'Far' references.
  • 2i or 4i: Two or four byte integers. You need to be careful here since it is easy to include the wrong version, you will not get an error when the application is compiled, and it can result in obscure bugs which are hard to track down.

The PowerPC Runtime Architecture is much more precisely defined than under 68K. For example, under PowerPC all code references use the same convention and all integers are four bytes. As a result there are usually many fewer versions of the PowerPC library.

Different compilers can also generate different implementations of the same library. This is because the calling conventions for the functions (such as how the function parameters are ordered on the stack) are not generally defined by the language so it is up to the compiler vendors to choose. One good way around this is to export functions using the 'pascal' keyword. The Pascal calling conventions are well defined, so libraries compiled this way will work under different compilers and with different languages (all other options being equal).

It is also advisable to avoid the 'int' integer type in the library interface, instead use 'Int16' or 'Int32'. This gives more robustness across different compilers, languages and environments.

Conclusion

Libraries provide conceptually clean interfaces to code, which can be well tested and re-used. They can also lower compile time and allow large projects to be factored into smaller chunks. Runtime libraries provide additional benefits such as reduced disk and memory overhead, plus they can provide novel functionality through dynamic patching.

On the Macintosh under PowerPC the Code Fragment Manager is Apple's announced direction in shared code, has good tool support and is relatively easy to use. CFM is guaranteed to exist on all PowerPC Macs.

Unfortunately CFM-68K requires additional effort on behalf of programmers who wish to utilise CFM-68K libraries and CFM-68K support is not always present on older Macintoshes. For this reason Code Resources are often used as a relatively straightforward library mechanism.


Jeremy Nelson is a programmer and Technical Support Droid for Stairways Software Pty Ltd.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Latest Forum Discussions

See All

How to evolve Eevee in Pokemon GO
By now, almost everyone should be hip to how to evolve Pokemon in Pokemon GO (and if not, there's a guide for that). Just gather enough candy of the appropriate type, feed them all to the Pokemon, and evolution happens. It's a miracle that would... | Read more »
CSR Racing 2: Guide to all game modes
It might not seem like there are all that many ways to go fast in a straight line, but CSR Racing 2 begs to differ. [Read more] | Read more »
Bulb Boy (Games)
Bulb Boy 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Multi-award winning 2D point & click horror adventure about a boy with a glowing head. | Read more »
5 top free emoji keyboard apps
If we're not at peak emoji yet as a society, it feels like we definitely should be. The emoji concept has gone far beyond what anyone in Japan could have envisioned when the people there unleashed it on an unsuspecting world, but the West has... | Read more »
How to unlock more characters in Disney...
One of the big charms of Disney Emoji Blitz is seeing a wide variety of beloved Disney and Pixar characters transformed into smiling emojis. Even someone like the sneaky Randall from Monsters Inc., who probably never cracked a smile on film, is... | Read more »
Cubway (Games)
Cubway 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Cubway is a journey with an abstract story of lifecycle of rebirth, called Samsara. Guide the cube through the long way full of dangers... | Read more »
Colorcube (Games)
Colorcube 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Turn pieces and blend colours in this minimal yet visually stunning puzzler.Over 200 handcrafted and challenging levels. Features... | Read more »
Doodle God Griddlers (Games)
Doodle God Griddlers 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: | Read more »
Crusader Kings: Chronicles (Games)
Crusader Kings: Chronicles 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Crusader Kings: Chronicles is an interactive text based game that puts you in the shoes of Guy de Rose as you make... | Read more »
Roads of Rome: New Generation (Games)
Roads of Rome: New Generation 1.0 Device: iOS Universal Category: Games Price: $5.99, Version: 1.0 (iTunes) Description: | Read more »

Price Scanner via MacPrices.net

Apple price trackers, updated continuously
Scan our Apple Price Trackers for the latest information on sales, bundles, and availability on systems from Apple’s authorized internet/catalog resellers. We update the trackers continuously: - 15″... Read more
13-inch 2.5GHz MacBook Pro (Apple refurbished...
Apple has Certified Refurbished 13″ 2.5GHz MacBook Pros available for $829, or $270 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.5GHz MacBook Pros... Read more
21-inch iMacs on sale for up to $120 off MSRP
B&H Photo has 21″ iMacs on sale for up to $120 off MSRP including free shipping plus NY sales tax only: - 21″ 3.1GHz iMac 4K: $1379 $120 off MSRP - 21″ 2.8GHz iMac: $1199.99 $100 off MSRP - 21″ 1... Read more
Charitybuzz Set to Auction Unique Apple-1 Com...
Offering an opportunity to own the computer that sparked a revolution, on Monday, July 25, leading online charity auction platform Charitybuzz will auction what is claimed to be the world’s most... Read more
MacBook Airs on sale for up to $150 off MSRP
Amazon has 11″ and 13″ MacBook Airs on sale for up to $150 off MSRP for a limited time. Shipping is free: - 13″ 1.6GHz/128GB MacBook Air (sku MMGF2LL/A): $899.99 $100 off MSRP - 13″ 1.6GHz/256GB... 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
Apple refurbished 11-inch MacBook Airs availa...
Apple has Certified Refurbished 11″ MacBook Airs (the latest models), available for up to $170 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Apple iPad Pro Sales Far Outpacing Microsoft...
A report on Appleinsider notes that despite Microsoft Surface tablet PC sales growing by 9 percent year over year, revenues remained below $1 billion, and are down sequentially from the $1.1 billion... Read more
DEVONthink 2.9 Features Ultra-fast, Robust, A...
DEVONthink 2.9 allows users to keep databases synchronized using many means of transport. It transmits them between Macs on the local network or stores them in a syncable form on removable hard... Read more
12-inch WiFi Apple iPad Pros on sale for up t...
B&H Photo has 12″ WiFi iPad Pros on sale for up to $100 off MSRP, each including free shipping. B&H charges sales tax in NY only: - 12″ Space Gray 32GB WiFi iPad Pro: $749 $50 off MSRP - 12″... Read more

Jobs Board

*Apple* Solutions Consultant - APPLE (United...
Job Summary As an Apple Solutions Consultant, you'll be the link between our future customers and our products. You'll showcase your entrepreneurial spirit as you Read more
*Apple* Professional Learning Specialist - A...
Job Summary The Apple Professional Learning Specialist is a full-time position for one year with Apple in the Phoenix, AZ area. This position requires a high Read more
*Apple* Picker - Apple Hill Orchard (United...
Apple Hill Orchard, Co. Rte. 21,Whitehall, NY 9/7/16-10/228/16. Pick fresh market or processing apples Productivity of 60 boxes and 80 boxes processing fruit per Read more
*Apple* Solutions Consultant - APPLE (United...
Job Summary As an Apple Solutions Consultant, you'll be the link between our future customers and our products. You'll showcase your entrepreneurial spirit as you Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform 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.