TweetFollow Us on Twitter

I/O Routines
Volume Number:1
Issue Number:6
Column Tag:FILE SAVING, OPENING

I/O Completion Routines

By Steve Brecher

I/O Completion Routines

Application I/O requests are ultimately performed by low-level operating system trap routines: _Read, _Write, _Control, _Status, _Open, _Close. The program passes the address of an I/O parameter block to the trap routine. The parameter block specifies the device driver (e.g., Sony floppy driver, serial driver) and the particulars of the request such as (for _Read or _Write) the number of bytes and the address of the program’s buffer.

The operating system passes the parameter block on to the device driver; or, if the driver is currently busy, the parameter block is put onto the driver’s queue of pending work.

Mac I/O operations can be either synchronous or asynchronous. A synchronous operation will be completed before control is returned to the invoking program. An asynchronous operation will be initiated -- started upon by the driver, or put into its queue-- and then control will be returned to the program regardless of whether the operation is yet complete.

Asynchronous I/O is the heart of multi-tasking; indeed, the only rationale for multi-tasking is the overlapping of I/O and computation. Programs can imp- lement a primitive form of multi-tasking within themselves by using a multi-buffer I/O scheme. For instance, a program can request that a buffer full of data be written, and then -- before that write request is completed -- immediately start filling another buffer with data.

Completion routines can be a convenient mechanism for a program to manage multi-buffered I/O. The com- pletion routine is called asynchronously with respect to the rest of the program; it can mark the buffer associated with the just-completed I/O request as free (written) or ready for processing (read). If another buffer is ready to be read into or written from, the completion routine can initiate the next I/O request.

Completion routines can also be used to hide low-level I/O details from the mainline logic of a program. I attempted to use the Mac’s completion routine facility for that purpose in a program doing input from the modem port at high baud rates. The program started off by issuing an asynchronous read request for one byte, and specifying a completion routine. The completion routine looked like this:

-- Put the received byte into program’s input buffer;

-- Issue a _Status call to find out whether the serial input driver has more data in its own buffer;

-- If the driver has more data available, issue a _Read to transfer it to the program’s input buffer;

-- Re-issue the one-byte asynchronous _Read.

The idea was for the completion routine to handle the low-level details of managing input into the program’s buffer. The mainline of the program would then be freed from concern with those details, and could just take data from the buffer as it became available.

But this scheme didn’t work. Following is an explanation of why it didn’t, which relates to a severe limitation in the Mac’s implementation of completion routines.

Asynchronous I/O is requested by setting bit 10 ($0400) in the trap value. There are two ways for a program to detect the completion of asynchronous I/O. When an I/O operation is initiated, the ioResult field of the parameter block is set to 1; when the operation completes, ioResult is set to 0 (if no error) or to a negative error code. So the program may test ioResult to determine whether the operation is complete. Or, the program may specify the address of an I/O completion routine in the ioCompletion field of the parameter block. If ioCompletion is not nil (zero), then when the operation is complete the OS will JSR to the address contained in ioCompletion.

If bit 10 of the trap word is clear -- a synchronous I/O -- the Device Manager will clear ioCompletion before initiating the I/O; and the OS will test ioResult in a tight loop, waiting for it to become zero or negative before returning from the trap. Hence, you don’t need to clear ioCompletion prior to a synchronous I/O; but for asynchronous I/O you must either either clear ioCompletion or set it to the address of a completion routine.

When a completion routine is entered, register D0.W contains the ioResult value (and the condition codes reflect a TST of its value); A0 contains the parameter block address; 4(SP) -- just above the return address -- contains a pointer to the driver’s Device Control Entry (DCE); and registers D0-D3/A0-A3 may be altered by the completion routine. The I/O queue element (a.k.a. the parameter block) will have been unlinked from the driver’s queue. And -- here’s the catch -- interrupts may or may not be disabled.

The OS initiates an I/O operation by calling the appropriate entry point of the device driver. Let’s consider, for example, a read request to the serial input driver. The OS calls the serial input driver’s “Prime” (read) routine. There are two possibilities: either the request will be completed immediately by the Prime routine, or it will be completed later as the result of an interrupt.

If the number of characters in the driver’s buffer is equal to or greater than the number specified in the I/O request, the Prime routine will fulfill the request immediately by transferring characters to the caller’s ioBuffer, and then jump to the OS ioDone routine, which will call the completion routine. Interrupts are enabled at entry to the completion routine, and it can therefore do anything that any other part of an application can do. In this case, when the completion routine is entered the original _Read trap has not yet returned and no other application code has been executed. Therefore the effect is similar to that of the application executing the following:

     _Read                          ;synchronous
     JSR    CompletionRoutine

If the completion routine initiates another I/O request to the same driver, specifying the same ioCompletion (i.e., itself), that request may also complete immediately in which case the completion routine will be re-entered.

If there are insufficient characters in the driver’s buffer to satisfy a read request, the Prime routine will return to the OS, which will return from the trap. Later, the driver’s received-character interrupt service will determine that the request is complete, and jump to the OS ioDone routine, which will call the completion routine. Now, however, the completion routine is entered with interrupts disabled; in effect the completion routine is part of the interrupt service.

The completion routine can do no significant processing, because that would hold off interrupts for too long a time -- for example, subsequent incoming serial data might be lost. This virtually excludes the possiblity of intitiating a new I/O operation from within the completion routine. Also, the completion routine (at interrupt level) cannot do anything that would alter the heap configuration -- the interrupt might have occurred while a handle was being dereferenced.

Since there is no point to doing asynchronous I/O unless it is assumed that the request will not complete immediately, the programmer must assume that a serial I/O completion routine will be executed at interrupt level. This makes the completion routine facility rather useless for serial I/O. The routine could set a flag indicating the completion -- but such a flag is already available in ioResult.

Wish list item... To make completion routines useful, the Mac OS would have to be enhanced to implement what the DEC PDP-11 operating systems refer to as “fork processes.” Fork processes are serialized and executed synchronously after all (possibly nested) interrupts have been dismissed, but before control is returned to the point at which the first interrupt occurred. This enables completion routines to be inter- ruptable, and gives them time to do useful work.

MS BASIC programmers: Stuff it!

The QuickDraw StuffHex routine is a fast way to convert lengthy hex machine language data to binary code in MS BASIC programs. The trick is to prefix each string of hex digits with a character whose ASCII value is equal to the number of hex digits: this character is thus a length byte, making the string a Pascal string which can be passed to StuffHex. Note that the address of the string data is not given by the address of the BASIC string variable. The string variable is actually a data structure containing information about the string, including its address. The address can change each time the string is assigned or read into. We get the address of the string data by PEEKing into the string variable. Example:

‘
‘ Machine language interface to StuffHex:
‘
DIM SH%(2)
SH%(0)=&H245F : SH%(1)=&HA866
SH%(2)=&H4ED2
‘ Array that gets the binary machine
‘ language:
DIM CODE%(SomeAdequateSize)
‘ Declare all scalars before getting array
‘ addresses:
CODEPTR!=0! : HEXLINE$=”” :  STRINGPTR!=0!
P!=0!
‘ Get addresses of arrays and the string
‘ variable:
STUFFHEX!=VARPTR(SH%(0))
CODEPTR!=VARPTR(CODE%(0))
P!=VARPTR(HEXLINE$)
‘ Read lines of hex data, convert to binary:
READ HEXLINE$
WHILE HEXLINE$<>””
  ‘ Get address of first byte of string data
  ‘ (the length byte):
  STRINGPTR!=(PEEK(P!+2!)*65536!)
               +(PEEK(P!+3!)*256!)+PEEK(P!+4!)
  ‘ Convert the line’s hex data to binary:
  CALL STUFFHEX!(CODEPTR!,STRINGPTR!)
  ‘ Adjust pointer into CODE! array for next
  ‘ data (if any):
  CODEPTR!=CODEPTR!+(ASC(HEXLINE$)/2)
  READ HEXLINE$
WEND
‘
‘ The ASCII value of the first character
‘ of each string must be equal to the
‘ number of characters in the rest of the
‘ string.  Thus the number of hex digits
‘ in each string must be at least 32
‘ (ASCII space) and no greater than
‘ 126 (ASCII ~) so that the length is a
‘ displayable ASCII character.  But the
‘ length must be other than 34 -- 34 is
‘ the ASCII code for quotation mark!
‘ Note the following DATA line has 36 hex
‘ digits, and that the first character of the
‘ string is “$”, i.e., CHR$(36).
‘
DATA”$0123456789ABCDEF0123456789ABCDEF0123"
‘
‘ More lines of hex data would go here
‘ Empty string marks end of data:
‘
DATA “”

Reports from Miss Elaine E.

Due to a QuickDraw bug, DrawText in srcCopy mode will erase four or five character positions after the position of the last character in the string. It’s OK to use srcXor if no character position will be overwritten; but if you need srcCopy, a workaround is to set the right side of the port’s clipRegion to the right edge of the last character before calling DrawText. If the font is not monospace, this implies calling TextWidth first to find out the screen width of the string to be drawn.

The QuickDraw ScrollRect routine will be slowed by a factor or 3 or 4 if you include the borders of the GrafPort in the rect that is scrolled. Make sure the rect passed to ScollRect is inset at least a couple of pixels from the port’s border(s).

Thanks to Steve Hanna for this tip on the alternate screen buffer... To have QuickDraw draw in the alternate screen buffer, change the BaseAddr field of the GrafPort to $72700. When you use QD calls with that GrafPort as the current port, the drawing will be done in the alternate screen buffer. To flip the display between the main and alternate screen buffers, complement bit 6 of VIA buffer A, which is mapped to address $EFFFFE. (Steve Hanna also notes that the low-order 3 bits of buffer A control sound volume [0..7]. Bit 7 is tied to the SCC -- see below). The following instruction will flip the display to the other screen buffer:

Bchg.B  #6,$EFFFFE

Thanks to Dennis Brothers for pointing out that the MacsBug HD (heap display) command is a way find your program in memory -- the first CODE resource in the heap is most likely the first (or only) segment of your program.

The reason the ROM serial driver doesn’t support input flow control is that a D0 was coded where a D3 should have been; a two-bit error. And the reason mouse interrupts will be lost if you close the ROM serial driver (without immediately opening the RAM serial driver) is that the ROM serial driver neglects to finish its cleanup by setting the master interrupt enable bit in the SCC chip -- a one-word omission from a table. (Mouse movement signals come in through the DCD pins of the SCC and generate SCC external status interrupts.)

If you want to program the SCC yourself, ask your local Zilog office for a copy of the “Z8030/Z8530 SCC Serial Communications Controller Technical Manual.” The memory-mapped addresses of the the SCC are in the MDS equate file SysEquates.Txt. The SCC WAIT/REQUEST (asserted low) pin state is brought over to bit 7 of VIA (6522 chip) buffer A, which is mapped to memory address $EFFFFE. The serial driver’s Open routine configures the SCC to assert WAIT/REQUEST when an input character is available in the SCC buffer. This enables the Sony floppy driver to feed incoming data to the serial driver’s input buffer while the Sony driver has disabled interrupts. When the byte at $EFFFFE is positive (bit 7 clear), the Sony driver fetches the character waiting in the SCC and calls code in the serial driver interrupt service routine.

Inside Macintosh says of the serial status ctsHold flag (Serial Driver, p. 13), “If output has been suspended because the hardware handshake has been negated, ctsHold will be nonzero.” The conditional clause could be misleading: provided that the output driver has been opened, ctsHold always reflects the state of the CTS (asserted low) pin of the SCC (pin 7 of the DB-9 connector) regardless of the status (or existence) of any output request. If CTS is asserted, ctsHold is zero.

Need a quick (and dirty!) test of whether any OS events are pending? Address $014C contains the OS event queue header (a pointer); if it’s nil (zero), the queue is empty.

Think you have a good (homemade) backup of Macintosh Pascal? Make sure you can click the mouse 101 times in the source edit window. On the 101st click, Mac Pascal goes to the disk to check that the master is there; if it doesn’t like what it finds, it abrubtly quits to the Finder (trashing any of your unsaved work). In my book, this qualifies as a “worm” and, since it’s not documented, is tasteless at best and unethical at worst. If a publisher wants to frustrate users who attempt to backup a product or use it on a hard disk without inserting the master, the program should either quit at the outset or put up a dialog box demanding the master. The more experienced the programmer, the more violent his aversion to being forced to use distribution media in production work.

Consulair Mac C users who want all string constants to be compiled in Pascal format (length-byte prefix) can include the following at near the top of the source file:

 #asm
         STRING_FORMAT 3
 #endasm 

If there’s no semantic difference between pre-incrementing and post-incrementing a variable in your Mac C program (i.e., you can choose either ++i or i++), use pre-increment -- it generates more efficient code. Same applies to decrements. If you use post- inc(dec)rement, the generated code will inc(dec)rement the variable in memory, then offset that operation by dec(inc)rementing it in a register in preparation for its previous value being used in an expression -- even if it’s not so used.

A Mac C update is expected to be available this spring with floating point, register variables, structure assignments, and slicker code generation. Look for the Greenhills C compiler under the Apple name on the Mac later this year -- it’s being ported from the Lisa along with the Workshop. I haven’t used it, but it’s reported to generate slick code.

 
AAPL
$113.99
Apple Inc.
+1.98
MSFT
$47.88
Microsoft Corpora
-0.26
GOOG
$534.03
Google Inc.
+5.26

MacTech Search:
Community Search:

Software Updates via MacUpdate

Google Drive 1.18.7821.2489 - File backu...
Google Drive is a place where you can create, share, collaborate, and keep all of your stuff. Whether you're working with a friend on a joint research project, planning a wedding with your fiancé, or... Read more
Eye Candy 7.1.0.1203 - 30 professional P...
Eye Candy renders realistic effects that are difficult or impossible to achieve in Photoshop alone, such as Fire, Chrome, and the new Lightning. Effects like Animal Fur, Smoke, and Reptile Skin are... Read more
MegaSeg 5.9.4 - Professional MP3 DJ appl...
MegaSeg is a complete solution for pro audio/video DJ mixing, radio automation, and music scheduling with rock-solid performance and an easy-to-use design. Mix with visual waveforms and Magic... Read more
Parallels Desktop 10.1.2 - Run Windows a...
Parallels Desktop is simply the world's bestselling, top-rated, and most trusted solution for running Windows applications on your Mac. With Parallels Desktop for Mac, you can seamlessly run both... Read more
GarageSale 6.9.1 - Create outstanding eB...
GarageSale is a slick, full-featured client application for the eBay online auction system. Create and manage your auctions with ease. With GarageSale, you can create, edit, track, and manage... Read more
Quicksilver 1.2.2 - Application launcher...
Quicksilver is a light, fast and free Mac application that gives you the power to control your Mac with keystrokes alone. Quicksilver allows you to find what you need quickly and easily, then act... Read more
Mac DVDRipper Pro 5.0.1 - Copy, backup,...
Mac DVDRipper Pro is the DVD backup solution that lets you protect your DVDs from scratches, save your batteries by reading your movies from your hard disk, manage your collection with just a few... Read more
ClamXav 2.7 - Free virus checker, based...
ClamXav is a free virus checker for OS X. It uses the tried, tested, and very popular ClamAV open source antivirus engine as a back end. I hope you like and use ClamXav a lot and that it helps keep... Read more
FoldersSynchronizer 4.2 - Synchronize or...
FoldersSynchronizer is a popular and useful utility that synchronizes and backs-up files, folders, disks and boot disks. On each session you can apply special options like Timers, Multiple Folders,... Read more
Waltr 1.0.6 - Drag-and-drop any media fi...
WALTR is designed to make it easy to upload and convert any music or video file to an iPad or iPhone format for native playback. It supports a huge variety of media file types, including MP3, MP4,... Read more

Latest Forum Discussions

See All

Forget the Gloves – It’s a Cage Match in...
Forget the Gloves – It’s a Cage Match in Real Boxing’s Underground Update Posted by Jessica Fisher on December 23rd, 2014 [ permalink ] | Read more »
Who Wore it Best? Best of 2014
It’s the end of the year, so it’s time for some arbitrary internet awards! In this wrap-up episode of Who Wore it Best? we present our winners for the best, worst, and flat-out weirdest cloned games that graced the App Store in 2014. [ Who... | Read more »
Now You Can Explore Mayan Temples in Ass...
Now You Can Explore Mayan Temples in Assassin’s Creed Pirates’ Newest Update Posted by Jessica Fisher on December 23rd, 2014 [ permalink ] | Read more »
Soft Design aims to do free-to-play righ...
They say a team is only as big as its fans and that’s also certainly the case with video games, judging from the sales certain AAA ‘heavyweights’ get year-after-year. Soft Design took that principle as a core design philosophy and worked closely... | Read more »
Bogga Christmas Tree
Bogga Christmas Tree By Amy Solomon on December 23rd, 2014 Our Rating: Universal App - Designed for iPhone and iPad Bogga Christmas Tree allows young children to trim a tree, any time or place.   | Read more »
Opera Coast 4.0 Launches on iOS with 4 N...
Opera Coast 4.0 Launches on iOS with 4 New Features Posted by Jessica Fisher on December 23rd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Cricket Kids: Christmas Presents
Cricket Kids: Christmas Presents By Amy Solomon on December 23rd, 2014 Our Rating: Universal App - Designed for iPhone and iPad Cricket Kids: Christmas Presents allows children to play with digital toys opened for the Christmas... | Read more »
Lara Croft & Tomb Raider Mobile Bund...
Lara Croft & Tomb Raider Mobile Bundle – Only $4.99 Posted by Jessica Fisher on December 23rd, 2014 [ permalink ] Lara Croft is coming to you in | Read more »
SimCity BuildIt Review
SimCity BuildIt Review By Nadia Oxford on December 23rd, 2014 Our Rating: :: BUILDING AN OK TOMORROWUniversal App - Designed for iPhone and iPad SimCity BuildIt is a competent city-building game, but its free-to-play trappings are... | Read more »
SimCity Buildit – Tips, Tricks, and Stra...
Hello, Budding Mayors Want to know what we made of all this upgrading and inevitable waiting? Check out our SimCity BuildIt review! SimCity BuildIt is a city-building game from EA. Your job as mayor is to build houses for people to live in, industry... | Read more »

Price Scanner via MacPrices.net

Sony Fixing To Launch Large-Screen Android Ta...
Digitimes’ Aaron Lee and Joseph Tsai report that Sony, which last February exited the laptop computer market with the sale of its VIAO PC-making unit to a group of JApanese investors, is now expected... Read more
After Christmas sale: 13-inch Retina MacBook...
B&H Photo has new 13″ MacBook Pros on sale for up to $150 off MSRP as part of their Holiday pricing. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.5GHz MacBook Pro: $1043 save... Read more
After Christmas sale: 15-inch Retina MacBook...
Adorama has 15″ Retina MacBook Pros on sale for up to $150 off MSRP. Shipping is free, and Adorama charges NY & NJ sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1899 save $100 - 15″ 2.5GHz... Read more
After Christmas sale: MacBook Airs for up to...
B&H Photo has 2014 MacBook Airs on sale for up to $120 off MSRP, for a limited time, for the Thanksgiving/Christmas Holiday shopping season. Shipping is free, and B&H charges NY sales tax... Read more
Apple now offering Certified Refurbished Mac...
The Apple Store is now offering Apple Certified Refurbished 2014 Mac minis, with models available starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: - 1.... Read more
Will Apple Build An A-series ARM Processor Po...
In computer terms, it’s been a very long time since the MacBook Air had a major redesign. More than four years have elapsed since Apple recast what had originally been more a pricy boutique device... Read more
iPhone 6s mini With Four-Inch Screen Rumored...
The Times of India’s Komal Mohan, citing a story in The Electronic Times of Taiwan, says that unnamed upstream supply chain sources report that Apple is gearing up to launch a new 4-inch screen... Read more
What’s The Current Value Of Your iOS Apps?
Basel, Switzerland based ConIT AG has announced AppZapp Notify and its free PC and Mac tool available for download. What is the present value of all my downloaded Apps? With AppZapp Notify, for the... Read more
PhatWare Releases WritePad Pro Advanced iOS W...
PhatWare Corporation has announced immediate availability of WritePad Pro 2.0, its advanced word processing, note-taking, and document management app which also takes full advantage of PhatWare’s... Read more
Last minute gift idea: Send an Apple Store Gi...
Send an Apple Store Gift Card by email this season, perhaps as a last minute Christmas gift. According to Apple, “Apple Store Gift Cards can be used to purchase Apple hardware and accessories at any... Read more

Jobs Board

Position Opening at *Apple* - Apple (United...
…Summary** As a Specialist, you help create the energy and excitement around Apple products, providing the right solutions and getting products into customers' hands. You Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** Being a Business Manager at an Apple Store means you're the catalyst for businesses to discover and leverage the power, ease, and flexibility of Apple 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
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* Store Leader Program (US) - Apple, I...
…Summary Learn and grow as you explore the art of leadership at the Apple Store. You'll master our retail business inside and out through training, hands-on experience, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.