TweetFollow Us on Twitter

A4, Code Resources
Volume Number:9
Issue Number:12
Column Tag:Think Top 10

Code Resources
and the A4 World

By Scott Shurr, Symantec Technical Support, Symantec Corp.

This article will describe the various kinds of code resources, and talk about the differences between writing applications and code resources. In applications, the machine code produced by the compiler uses the A5 register as a base address from which to access the applications global variables. Code resources are intended to be run simultaneously with applications, so they use a scheme designed to prevent interference with the application which called them up. In this case the A4 register is used as the base address for the resource’s global variables, as illustrated in the following diagram:

It is important when writing a code resource to be aware of how and when to set up A4. The different types of code resources require different declarations of the main() routine. The example consists of a single segment code resource which takes 2 arguments, which are a number of beeps, and the address of a string to receive a value. The code resource beeps the appropriate number of times, and then puts “Hello world” into the string. Here is the first version of the code resource:

/* 1 */

/* CodeResource.c */
void CRdoBeep(int beepSize);

void main(int beepSize, char *receiveString)
{
static char sLiteral[] = "Hello world"; 

strcpy(receiveString,sLiteral);
CRdoBeep(beepSize);
}

void CRdoBeep(int beepSize)
{
int i;

for (i=0; i<beepSize; i++)
  SysBeep(beepSize);
}

Create a new project, Resource.pi, and add the CodeResource.c file and the ANSI-A4 library to the project. Go to Set Project Type... and select the Code Resource button. Set Name to myCodeResource, Type to CODE, and ID to 31. One of the effects of changing the project type to anything other than Application is to cause the compiler to use the A4 register instead of the A5 as the address of the beginning of the application globals. Now select Build Code Resource..., and save the resource into Main.pi.rsrc. Another project called Main.pi will be used to test the code resource, and it will expect to find the code resource in that file in the folder. Create another new project in the same folder as Resource.pi, and add this program to it:

/* 2 */

/* UsesCodeResource.c */
#include <stdio.h>

typedef void (*CRPtr) (int,char*);

void main()
{
char myString[20];
Handle myCRhandle;

myCRhandle = GetNamedResource('CODE',"\pmyCodeResource");
HLock(myCRhandle);
(* (CRPtr) (*myCRhandle))(5,myString);
HUnlock(myCRhandle);
printf("myString=\"%s\"\n",myString);
}

Add UsesCodeResource.c and the ANSI library, and give it a try. The code resource will be loaded, it will beep 5 times, and then display some garbage instead of “Hello world”. The Disassemble command is useful in pointing out the problem. For the code resource:

main:
00000000: 4E56 0000          LINK      A6,#$0000
00000004: 486C 0000          PEA       sLiteral(A4)
00000008: 2F2E 000A          MOVE.L    receiveString(A6),-(A7)
0000000C: 4EAC 0000          JSR       strcpy(A4)
00000010: 3EAE 0008          MOVE.W    beepSize(A6),(A7)
00000014: 4EAC 0000          JSR       CRdoBeep(A4)
00000018: 4E5E               UNLK      A6
0000001A: 4E75               RTS
0000001C

CRdoBeep:
00000000: 4E56 0000          LINK      A6,#$0000
00000004: 2F07               MOVE.L    D7,-(A7)
00000006: 7E00               MOVEQ     #$00,D7
00000008: 6008               BRA.S     *+$000A      ; 00000012
0000000A: 3F2E 0008          MOVE.W    beepSize(A6),-(A7)
0000000E: A9C8               _SysBeep
00000010: 5247               ADDQ.W    #$1,D7
00000012: BE6E 0008          CMP.W     beepSize(A6),D7
00000016: 6DF2               BLT.S     *-$000C      ; 0000000A
00000018: 2E1F               MOVE.L    (A7)+,D7
0000001A: 4E5E               UNLK      A6
0000001C: 4E75               RTS
0000001E

Notice the instruction PEA sLiteral(A4). This depends on having A4 set to the address of the beginning of the code resource, so that sLiteral can be found. If MacsBug is used by putting a Debugger() call in CallsCodeResource.c, it can be seen that upon entry to the code resource’s main, A0 is set to the correct place, but A4 isn’t. Global variables always use offsets from A4 in code resources. In multi-segment code resources, all string literals also use an A4 offset. This works the same in C++, except that C++ has an option “Put string literals in code”, that will keep them from using A4. To fix the bug, change the code resource to look like this:

/* 3 */

/* CodeResource.c */
#include <SetUpA4.h>
void CRdoBeep(int beepSize);

void main(int beepSize, char *receiveString)
{
static char sLiteral[] = "Hello world"; 

RememberA0();
SetUpA4();
strcpy(receiveString,sLiteral);
CRdoBeep(beepSize);
RestoreA4();
}

void CRdoBeep(int beepSize)
{
int i;

for (i=0; i<beepSize; i++)
  SysBeep(beepSize);
}

To understand why this change makes the code resource work, see the disassembly of CallsCodeResource.c:

main:
00000000: 4E56 FFEC          LINK      A6,#$FFEC
00000004: 2F0C               MOVE.L    A4,-(A7)
00000006: 42A7               CLR.L     -(A7)
00000008: 2F3C 434F 4445     MOVE.L    #$434F4445,-(A7)
  ; 'CODE'
0000000E: 486D 0000          PEA       "\pmyCodeResource"
00000012: A9A1               _GetNamedResource
00000014: 285F               MOVEA.L   (A7)+,A4
00000016: 204C               MOVEA.L   A4,A0
00000018: A029               _HLock
0000001A: 486E FFEC          PEA       myString(A6)
0000001E: 3F3C 0005          MOVE.W    #$0005,-(A7)
00000022: 2054               MOVEA.L   (A4),A0
00000024: 4E90               JSR       (A0)
00000026: 204C               MOVEA.L   A4,A0
00000028: A02A               _HUnlock
0000002A: 486E FFEC          PEA       myString(A6)
0000002E: 486D 0000          PEA       "myString="%s""
00000032: 4EAD 0000          JSR       printf
00000036: 286E FFE8          MOVEA.L   $FFE8(A6),A4
0000003A: 4E5E               UNLK      A6
0000003C: 4E75               RTS

The _GetNamedResource trap returns a handle to the code resource on the stack. It is saved in A4 (A4 is not special in this case, it’s just what the compiler chose to use). Its dereferenced value is placed in A0, and the program does a JSR to the address in A0, the start of the code resource. The code resource itself begins with a header. It is possible to write your own header by including it in the source code for the code resource, and checking the Custom Header option in the Set Project Type dialog. In most cases, the option will not be selected, and the compiler will provide a default header for the code resource, like this:

00000000: BRA.S  *+$0010
     ...
00000010: LEA    start-of-resource,A0
00000014: NOP
00000016: NOP
00000018: BRA    main-of-code-resource

This sets A0 to the current address of the beginning of the code resource, and then jumps to the LINK instruction in the main function of the resource. A commented version of SetUpA4.h is useful in seeing the change made in the second version of the code resource:

/* 4 */

/*
 *  SetUpA4.h
 *
 *  Copyright (c) 1991 Symantec Corporation.
 *   All rights reserved.
 *
 *  This defines "SetUpA4()" and "RestoreA4()" routines that 
 *  will work in all A4-based projects.
 *
 *  "RememberA4()" or "RememberA0()" must be called in advance 
 *  to store away the value of A4 where it can be found by 
 *  "SetUpA4()".  The matching calls to "RememberA4()" (or 
 *  "RememberA0()") and "SetUpA4()" *MUST* occur in the same 
 *  file.
 *
 *  Note that "RememberA4()", "RememberA0()" "SetUpA4()", and
 *  "RestoreA4()" are not external.  Each file that uses them 
 *  must include its own copy.
 *
 *  If this file is used in the main file of a code resource 
 *  with "Custom Headers", be sure to #include it *AFTER* the 
 *  custom header!  Otherwise, the code resource will begin 
 *  with the code for the function "__GetA4()", defined below.
 *
 */

static void
__GetA4(void)
{
 asm {
 bsr.s  @1;  PC, (points to next line) goes on the stack
 ;  Branch to @1
 
 dc.l 0 ;  store A4 here
@1 move.l (sp)+,a1 ;  pop item from stack (which points
 ;  to previous line) into a1
 }
}

#define RememberA4() do { __GetA4(); asm { move.l a4,(a1) } } while (0)
 // __GetA4() puts pointer to spot for storing a4 in a1
 // move a4 to spot a1 points to
 
#define RememberA0() do { __GetA4(); asm { move.l a0,(a1) } } while (0)
 // __GetA4() puts pointer to spot for storing a4 in a1
 // move a0 to spot a1 points to
 
#define SetUpA4()do { asm { move.l a4,-(sp) } __GetA4(); /
  asm { move.l (a1),a4 } } while (0);
 // push a4 onto the stack
 // Call __GetA4 which puts a pointer to the space into a1
 // move whatever a1 is pointing to into a4
 
#define RestoreA4()do { asm { move.l (sp)+,a4 } } while (0)
 // pop item from stack into a4
 
/* In other words:

 RememberA4 puts the value in A4 in special spot.
 RememberA0 puts the value in A0 in special spot.
 
 SetUpA4 puts current value in A4 on the stack and gets 
 value in special spot and puts it in A4.
 RestoreA4 pops saved value of A4 from stack into A4.
*/

Here is the disassembly of the changed portion of the code resource:

__GetA4:
00000000: 6104               BSR.S     *+$0006      ; 00000006
00000002: 0000 0000          ORI.B     #$00,D0
00000006: 225F               MOVEA.L   (A7)+,A1
00000008: 4E75               RTS
0000000A

main:
00000000: 4E56 0000          LINK      A6,#$0000
00000004: 4EAC 0000          JSR       __GetA4(A4)
00000008: 2288               MOVE.L    A0,(A1)
0000000A: 2F0C               MOVE.L    A4,-(A7)
0000000C: 4EAC 0000          JSR       __GetA4(A4)
00000010: 2851               MOVEA.L   (A1),A4
00000012: 486C 0000          PEA       sLiteral(A4)
00000016: 2F2E 000A          MOVE.L    receiveString(A6),-(A7)
0000001A: 4EAC 0000          JSR       strcpy(A4)
0000001E: 508F               ADDQ.L    #$8,A7
00000020: 3F2E 0008          MOVE.W    beepSize(A6),-(A7)
00000024: 4EAC 0000          JSR       CRdoBeep(A4)
00000028: 548F               ADDQ.L    #$2,A7
0000002A: 285F               MOVEA.L   (A7)+,A4
0000002C: 4E5E               UNLK      A6
0000002E: 4E75               RTS
00000030

The RememberA0() in the source creates the 2 instructions after the LINK. It first does a JSR to __GetA4, whose job it is to get an address into A1. Notice that the second line of __GetA4 is a DC.L, which allocates 4 bytes, which are used for storing the addresses. The fact that the SetUpA4.h actually reserves some memory, unlike most other header files, is why it must always be included in each segment that uses any of RememberA4(), RememberA0(), SetUpA4(), or RestoreA4(). The BSR.S pushes the address of the 4 bytes onto the stack and then jumps over the 4 bytes. Then the address is popped from the stack into A1, and the function returns. The value of A0 is then saved at that address. The next 3 instructions in the code resource’s main are generated from SetUpA4(). It first pushes the current value of A4 onto the stack, so that it can be restored before returning to the application, which was probably using A4 for its own purposes. Then, the JSR to __GetA4 again gets the address of the storage area into A1. The address stored there is then placed into A4, which now holds the correct base address for the code resource. After the code resource does its work, it finishes up with RestoreA4(). That generates the MOVEA.L instruction which restores the old value of A4 from the stack before the code resource returns to the application which called it. This example may have raised some more questions, which I will try to answer here.

Q. Does this work the same in C++ as it works in C?

A. The code produced by C++ for a code resource that contains #include <SetUpA4.h> is almost identical to that produced by C, but the mechanism for producing it is different. If you look at SetUpA4.h (in Mac #includes: THINK #includes) you will see #if THINK_C which will select the C or the C++ version of the source. The __GetA4 is essentially the same for both versions, but the C++ version reflects its less powerful asm capabilities. In C, the calls like RememberA4() are implemented as #defines, while in C++ they are inline functions.

Q. Does any of this also apply to the other non-application projects, like Desk Accessories and Device Drivers?

A. The non-application projects are similar in that they all use offsets from A4 instead of A5 to access globals. You don't need to use SetUpA4 for desk accessories and device drivers, because the compiler provides a header which sets up the A4 for you.

Q. Why would one want to use a custom header in a code resource?

A. You can use the 18 bytes of the header for any purpose, as long as the first word is reserved for the code which will branch to where the resource is to begin execution. You could put flags for the version of the resource, or similar information, to be read by the code resource or by the program that is calling it. Just remember when you do that to put the #include <SetUpA4.h> after the header, or the code resource will start in the code SetUpA4.h generates, which isn’t desireable.

Q. What are the prototypes for the main() functions of various kinds of code resources?

A.

CDEF control definition
pascal long main(short varCode, ControlHandle theControl, 
 short message, long param);
FKEY function key
main();
INIT
main();
LDEF list definition
pascal main(short lMessage, Boolean lSelect, Rect lRect, 
 Cell lCell, short lDataOffset, short lDataLen, 
 ListHandle lHandle);
MDEF menu definition
pascal main(short message, MenuHandle theMenu, 
 Rect *menuRect, Point hitPt, short *whichItem);
WDEF window definition
pascal long main(short varCode, WindowPtr theWindow, 
 short message, long param);

 
AAPL
$104.87
Apple Inc.
+1.88
MSFT
$44.74
Microsoft Corpora
+0.36
GOOG
$543.85
Google Inc.
+11.14

MacTech Search:
Community Search:

Software Updates via MacUpdate

jAlbum Pro 12.2.4 - Organize your digita...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code!... Read more
jAlbum 12.2.4 - Create custom photo gall...
With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly, with pro results Simply drag and drop photos into groups, choose a design... Read more
ExpanDrive 4.1.7 - Access remote files o...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
OmniOutliner Pro 4.1.3 - Pro version of...
OmniOutliner Pro is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It'... Read more
Evernote 5.6.2 - Create searchable notes...
Evernote allows you to easily capture information in any environment using whatever device or platform you find most convenient, and makes this information accessible and searchable at anytime, from... Read more
OmniOutliner 4.1.3 - Organize your ideas...
OmniOutliner is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It's... Read more
BBEdit 11.0 - Powerful text and HTML edi...
BBEdit is the leading professional HTML and text editor for the Mac. Specifically crafted in response to the needs of Web authors and software developers, this award-winning product provides a... Read more
Apple Security Update 2014-005 - For OS...
Apple Security Update is recommended for all users and improves the security of Mac OS X. For information on the security content of this update, please visit this website: http://support.apple.com/... Read more
EyeTV 3.6.6 - Watch and record TV on you...
EyeTV brings a rich TV experience to your Mac. Watch live TV on your Mac. Pause, rewind, and record whenever you want. EyeTV gives you powerful control over what you watch and how you watch it. Put... Read more
RapidWeaver 6.0 - Create template-based...
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

Latest Forum Discussions

See All

Build Your Own Fantasy Football Dynasty...
Build Your Own Fantasy Football Dynasty with Draft Day Posted by Jessica Fisher on October 23rd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Jam Messenger Review
Jam Messenger Review By Jennifer Allen on October 23rd, 2014 Our Rating: :: SIMPLE MESSAGINGiPhone App - Designed for the iPhone, compatible with the iPad Want a very quick way to send push-based messages? Jam Messenger is basic... | Read more »
Felllice (Games)
Felllice 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: EXCLUSIVE PRICE DROP! 50% OFF FOR A LIMITED TIME! EAT EAT EAT AND GROW ! | Read more »
The Arrow Game: by Grazie Media (Games)
The Arrow Game: by Grazie Media 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: Guide a flying arrow through skyscrapers and city streets to hit a distant target. Experience an endless... | Read more »
Worldly (Games)
Worldly 1.2 Device: iOS Universal Category: Games Price: $2.99, Version: 1.2 (iTunes) Description: | Read more »
Money Pro - EASY! Bills, Budgets and Acc...
Money Pro - EASY! Bills, Budgets and Accounts w/ Sync 1.0 Device: iOS Universal Category: Finance Price: $4.99, Version: 1.0 (iTunes) Description: Manage money like a pro. Money Pro is the next generation of Money app (over 2 million... | Read more »
Pro Strategy Football 2014 (Games)
Pro Strategy Football 2014 2014.141001 Device: iOS Universal Category: Games Price: $4.99, Version: 2014.141001 (iTunes) Description: Take the proven strategy of the PSF franchise and add in Casual Play, improved graphics and... | Read more »
Super Glyph Quest (Games)
Super Glyph Quest 1.01 Device: iOS Universal Category: Games Price: $2.99, Version: 1.01 (iTunes) Description: Adventure is back Questers! Combine elemental glyphs together to cast powerful spells and vanquish adorable monsters in... | Read more »
Fighting Fantasy: Caverns of the Snow Wi...
Fighting Fantasy: Caverns of the Snow Witch 1.0 Device: iOS Universal Category: Games Price: $5.99, Version: 1.0 (iTunes) Description: Travel to Northern Allansia’s perilous Icefinger Mountains to defeat the wicked Snow Witch in this... | Read more »
Star Warfare 2: Payback Review
Star Warfare 2: Payback Review By Blake Grundman on October 22nd, 2014 Our Rating: :: ONE-TRICK PONYUniversal App - Designed for iPhone and iPad Unfortunately, it doesn’t take long for Star Warfare 2’s free-firing fun to turn into... | Read more »

Price Scanner via MacPrices.net

Apple refurbished Time Capsules available sta...
The Apple Store has certified refurbished Time Capsules available for up to $60 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $255... Read more
Textilus New Word, Notes and PDF Processor fo...
Textilus is new word-crunching, notes, and PDF processor designed exclusively for the iPad. I haven’t had time to thoroughly check it out yet, but it looks great and early reviews are positive.... Read more
WD My Passport Pro Bus-Powered Thunderbolt RA...
WD’s My Passport Pro RAID solution is powered by an integrated Thunderbolt cable for true portability and speeds as high as 233 MB/s. HighlightsOverviewSpecifications Transfer, Back Up And Edit In... Read more
Save with Best Buy’s College Student Deals
Take an additional $50 off all MacBooks and iMacs at Best Buy Online with their College Students Deals Savings, valid through November 1st. Anyone with a valid .EDU email address can take advantage... Read more
iPad Air 2 & iPad mini 3 Best Tablets Yet...
The new iPads turned out to be pretty much everything I’d been hoping for and more than I’d expected.”More” particularly in terms of a drinking-from-a-firehose choice of models and configurations,... Read more
Drafts 4 Reinvents iOS Productivity App
N Richland Hills, Texas based Agile Tortoise has announced the release of Drafts 4 for iPhone and iPad. Drafts is a quick capture note taking app with flexible output actions. Drafts 4 scales from... Read more
AT&T accepting preorders for new iPads fo...
AT&T Wireless is accepting preorders for the new iPad Air 2 and iPad mini 3, cellular models, for $100 off MSRP with a 2-year service agreement: - 16GB iPad Air 2 WiFi + Cellular: $529.99 - 64GB... Read more
Apple offering refurbished Mac Pros for up to...
The Apple Store is offering Apple Certified Refurbished 2013 Mac Pros for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The... Read more
Select MacBook Airs $100 off MSRP, free shipp...
B&H Photo has 2014 a couple of MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels Desktop and LoJack for... Read more
13-inch 2.5GHz MacBook Pro on sale for $100 o...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999.99 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more

Jobs Board

Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**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
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Position Opening at *Apple* - Apple (United...
…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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.