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);

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

FotoMagico 5.6.12 - Powerful slideshow c...
FotoMagico lets you create professional slideshows from your photos and music with just a few, simple mouse clicks. It sports a very clean and intuitive yet powerful user interface. High image... Read more
OmniGraffle Pro 7.12.1 - Create diagrams...
OmniGraffle Pro helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use... Read more
beaTunes 5.2.1 - Organize your music col...
beaTunes is a full-featured music player and organizational tool for music collections. How well organized is your music library? Are your artists always spelled the same way? Any R.E.M. vs REM?... Read more
HandBrake 1.3.0 - Versatile video encode...
HandBrake is a tool for converting video from nearly any format to a selection of modern, widely supported codecs. Features Supported Sources VIDEO_TS folder, DVD image or real DVD (unencrypted... Read more
Macs Fan Control 1.5.1.6 - 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
TunnelBear 3.9.3 - Subscription-based pr...
TunnelBear is a subscription-based virtual private network (VPN) service and companion app, enabling you to browse the internet privately and securely. Features Browse privately - Secure your data... Read more
calibre 4.3.0 - Complete e-book library...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital librarian... Read more
Lyn 1.13 - Lightweight image browser and...
Lyn is a fast, lightweight image browser and viewer designed for photographers, graphic artists, and Web designers. Featuring an extremely versatile and aesthetically pleasing interface, it delivers... Read more
Visual Studio Code 1.40.0 - Cross-platfo...
Visual Studio Code provides developers with a new choice of developer tool that combines the simplicity and streamlined experience of a code editor with the best of what developers need for their... Read more
OmniGraffle 7.12.1 - Create diagrams, fl...
OmniGraffle helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use Graffle to... Read more

Latest Forum Discussions

See All

The House of Da Vinci 2 gets a new gamep...
The House of Da Vinci launched all the way back in 2017. Now, developer Blue Brain Games is gearing up to deliver a second dose of The Room-inspired puzzling. Some fresh details have now emerged, alongside the game's first official trailer. [Read... | Read more »
Shoot 'em up action awaits in Battl...
BattleBrew Productions has just introduced another entry into its award winning, barrelpunk inspired, BattleSky Brigade series. Whilst its previous title BattleSky Brigade TapTap provided fans with idle town building gameplay, this time the... | Read more »
Arcade classic R-Type Dimensions EX blas...
If you're a long time fan of shmups and have been looking for something to play lately, Tozai Games may have just released an ideal game for you on iOS. R-Type Dimensions EX brings the first R-Type and its sequel to iOS devices. [Read more] | Read more »
Intense VR first-person shooter Colonicl...
Our latest VR obsession is Colonicle, an intense VR FPS, recently released on Oculus and Google Play, courtesy of From Fake Eyes and Goboogie Games. It's a pulse-pounding multiplayer shooter which should appeal to genre fanatics and newcomers alike... | Read more »
PUBG Mobile's incoming update bring...
PUGB Mobile's newest Royale Pass season they're calling Fury of the Wasteland arrives tomorrow and with it comes a fair chunk of new content to the game. We'll be seeing a new map, weapon and even a companion system. [Read more] | Read more »
PSA: Download Bastion for free, but wait...
There hasn’t been much news from Supergiant Games on mobile lately regarding new games, but there’s something going on with their first game. Bastion released on the App Store in 2012, and back then it was published by Warner Bros. This Warner... | Read more »
Apple Arcade: Ranked - 51+ [Updated 11.5...
This is Part 2 of our Apple Arcade Ranking list. To see part 1, go here. 51. Patterned [Read more] | Read more »
NABOKI is a blissful puzzler from acclai...
Acclaimed developer Rainbow Train's latest game, NABOKI, is set to launch for iOS, Android, and Steam on November 13th. It's a blissful puzzler all about taking levels apart in interesting, inventive ways. [Read more] | Read more »
A Case of Distrust is a narrative-driven...
A Case of Distrust a narrative-focused mystery game that's set in the roaring 20s. In it, you play as a detective with one of the most private eye sounding names ever – Phyllis Cadence Malone. You'll follow her journey in San Francisco as she... | Read more »
Brown Dust’s October update offers playe...
October is turning out to be a productive month for the Neowiz team, and a fantastic month to be a Brown Dust player. First, there was a crossover event with the popular manga That Time I Got Reincarnated as a Slime. Then, there was the addition of... | Read more »

Price Scanner via MacPrices.net

Score a 37% discount on Apple Smart Keyboards...
Amazon has Apple Smart Keyboards for current-generation 10″ iPad Airs and previous-generation 10″ iPad Pros on sale today for $99.99 shipped. That’s a 37% discount over Apple’s regular MSRP of $159... Read more
Apple has refurbished 2019 13″ 1.4GHz MacBook...
Apple has a full line of Certified Refurbished 2019 13″ 1.4GHz 4-Core Touch Bar MacBook Pros available starting at $1099 and up to $230 off MSRP. Apple’s one-year warranty is included, shipping is... Read more
2019 13″ 1.4GHz 4-Core MacBook Pros on sale f...
Amazon has new 2019 13″ 1.4GHz 4-Core Touch Bar MacBook Pros on sale for $150-$200 off Apple’s MSRP. These are the same MacBook Pros sold by Apple in its retail and online stores: – 2019 13″ 1.4GHz/... Read more
11″ 64GB Gray WiFi iPad Pro on sale for $674,...
Amazon has the 11″ 64GB Gray WiFi iPad Pro on sale today for $674 shipped. Their price is $125 off MSRP for this iPad, and it’s the lowest price available for the 64GB model from any Apple reseller. Read more
2019 15″ MacBook Pros available for up to $42...
Apple has a full line of 2019 15″ 6-Core and 8-Core Touch Bar MacBook Pros, Certified Refurbished, available for up to $420 off the cost of new models. Each model features a new outer case, shipping... Read more
2019 15″ MacBook Pros on sale this week for $...
Apple resellers B&H Photo and Amazon are offering the new 2019 15″ MacBook Pros for up to $300 off Apple’s MSRP including free shipping. These are the same MacBook Pros sold by Apple in its... Read more
Sunday Sale: AirPods with Wireless Charging C...
B&H Photo has Apple AirPods with Wireless Charging Case on sale for $159.99 through 11:59pm ET on November 11th. Their price is $40 off Apple’s MSRP, and it’s the lowest price available for these... Read more
Details of Sams Club November 9th one day App...
Through midnight Saturday night (November 9th), Sams Club online has several Apple products on sale as part of their One Day sales event. Choose free shipping or free local store pickup (if available... Read more
Sprint is offering the 64GB Apple iPhone 11 f...
Sprint has the new 64GB iPhone 11 available for $15 per month for new lines. That’s about 50% off their standard monthly lease of $29.17. Over is valid until November 24, 2019. The fine print: “Lease... Read more
New Sprint November iPhone deal: Lease one iP...
Switch to Sprint and purchase an Apple iPhone 11, 11 Pro, or 11 Pro Max, and get a second 64GB iPhone 11 for free. Requires 2 new lines or 1 upgrade-eligible line and 1 new line. Offer is valid from... Read more

Jobs Board

*Apple* Mobility Pro - Best Buy (United Stat...
**746087BR** **Job Title:** Apple Mobility Pro **Job Category:** Store Associates **Store NUmber or Department:** 000319-Harlem & Irving-Store **Job Description:** Read more
Best Buy *Apple* Computing Master - Best Bu...
**743392BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Store Associates **Store NUmber or Department:** 001171-Southglenn-Store **Job Read more
Best Buy *Apple* Computing Master - Best Bu...
**746015BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Store NUmber or Department:** 000372-Federal Way-Store **Job Description:** Read more
*Apple* Mobility Pro - Best Buy (United Stat...
**744658BR** **Job Title:** Apple Mobility Pro **Job Category:** Store Associates **Store NUmber or Department:** 000586-South Hills-Store **Job Description:** At Read more
Best Buy *Apple* Computing Master - Best Bu...
**741552BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Store NUmber or Department:** 000277-Metcalf-Store **Job Description:** **What Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.