TweetFollow Us on Twitter

QC Review
Volume Number:12
Issue Number:8
Column Tag:Quality Control

Debugging with QC

Stress your software, not yourself

By Jeremy Vineyard

Introduction

The Memory Manager is one of the most commonly used components of the Mac Toolbox. Most applications are continually allocating and releasing memory - loading windows, pictures, and other resources, locking them, relocating them, resizing them, and purging them when they have served their purpose.

With all of this activity in memory, it is easy for a programmer in a hurry to overlook sections of code that could cause unforeseen problems for users. Attitudes like, “This memory operation will never fail”, and, “It’s only a small memory leak”, frequently lead to software that crashes, frustrating the user to the point of switching to your competitor and advising associates not to buy your product.

Because the Memory Manager is so crucial to any Mac application, it is crucial to ensure that the use of the Memory Manager is solid. The problem is that, most of the time, the effects of memory-related bugs are seen long after the bug occurs, making tracking them down a difficult and time-consuming task.

Thankfully, there is a tool available that makes preventing and tracking down hard-to-reproduce memory-related bugs easier. This is QC (as in “Quality Control”), a low-level debugging tool for use with the Mac OS Memory Manager.

Figure 1. QC Control Panel

Setting Up and Using QC

QC requires System 7 in order to run. It is developed by Onyx Technology and costs around $100. QC is copy-protected and will allow you to run only one serialized copy at a time on a network. Additional serial numbers are available by buying additional copies of QC.

QC consists of a control panel, on-line documentation, and a set of C APIs. All interaction with QC is done in the control panel.

QC can be set up to run tests and suites of tests on a “target” or “target program”. Target programs don’t have to be applications; they can be other executable code such as control panels. Test suites include tests that validate blocks of memory, tests that detect common Memory Manager errors, and tests that stress the application heap to ensure that the application code runs properly under difficult memory conditions.

How Does It Work?

Unless you are using the API, QC performs all of its tests by patching traps. QC will only report errors related to the tests that have been enabled for the target program, and it will not report errors when it is not running. QC reports every error with a _DebugStr call which will drop into MacsBug or your high-level debugger if it is set up to do so. In addition to reporting the error, QC reports the address of the last trap called in your code before the error occurred, allowing you to trace through the code to chase down the bug.

QC can automatically launch itself along with your target. You can choose to have QC launch when the target program calls _InitGraf or when a certain resource is loaded. Making QC wait until a resource is loaded is useful for non-applications such as control panels that will not call _InitGraf.

A key combination can be set that will launch and unlaunch QC while the target program is running. QC will pick the correct set of preferences for your target program when it is launched. As soon as QC is launched, the tests it performs are in progress.

Some tests in QC cannot distinguish when an error has occurred in an application other than the program being tested. It is therefore best to test your target program with only itself and the Finder running.

If you have all of the tests enabled, the slowdown caused by QC is quite noticeable, so be prepared. However, this is to be expected from such a low-level debugging tool, and is bearable.

Memory Validation Suite

QC offers a suite of tests that validate the Memory Manager structures themselves, rather than the use of those structures. These tests are valuable for tracking down corrupted or incorrectly specified data.

The first test in the validation suite, Cross-reference Master Pointers, looks at all relocatable blocks in the heap (handles) and makes sure that they are pointed to by a master pointer within a non-relocatable block. This test can catch orphaning of relocatable blocks and corruption of the master pointer list.

The Validate Handle/Pointer test verifies that each handle/pointer is pointing to a block of memory with the correct properties (locked/unlocked for a handle, non-relocatable for a pointer) as they are passed to Memory Manager calls.

Memory Manager Misuse

QC provides the programmer with a series of tests that detect common misuses and mistakes made while using the Memory Manager. It is the commonness of these problems that makes these tests so useful in debugging code.

Activating the Detect Write to Zero test checks, on each trap call, as to whether your target program has overwritten location zero. QC cannot determine whether it was your target program or another running application that overwrote zero, so again it is best to test with as few applications open as possible.

The Dereferencing Zero test puts data into location zero that will cause a bus error when a nil pointer/handle is dereferenced by the target program (a very common mistake).

Reasonable Allocations checks to make sure that allocations of data with _NewHandle, _NewPtr, etc., are passed reasonable values for the data size. Unreasonable allocations might include a negative data size or a data size that exceeds the size of the application heap.

QC’s ability to detect when a resource is disposed of incorrectly with _DisposeHandle or a handle is disposed of incorrectly with _ReleaseResource is a very useful feature. This is probably one of the mistakes most easily made by Mac programmers when writing code that uses both handles and resources. Enabling this test almost immediately showed me places in my (untested) code where I wasn’t releasing resources with _ReleaseResource, causing memory leaks and a possibly damaged resource map.

BlockMove Checking checks the values passed to _BlockMove to make sure that all addresses and data sizes are valid. With Block Bounds Checking enabled, QC adds a small tag value to every allocated block. QC periodically checks to see if this tag has been overwritten and reports an error if so. This is useful in catching errors related to writing past the boundaries of an array or a block of data.

MemErr Detection is a warning test that reports an error every time the low-level global MemErr is set to be anything other than noErr. This does not mean that the code is bad, but it can alert the programmer to places in the code where failed memory operations are not handled correctly. Grow Lock warns about attempts to resize a locked relocatable block. Grow Non-Reloc reports attempts to change the size of a pointer. Both of these operations are very likely to fail if a locked or non-relocatable block is ahead of the block being grown larger, but, as before, this may not represent an error if it is handled correctly in the code.

Scrambled Heaps

Many times, a program is written, tested, and approved under ideal memory conditions, but when someone else uses the software with a lowered memory partition and several other applications running simultaneously, the program cannot handle the stress. It can be difficult to simulate these stressful conditions if you don’t know what to look for. Of course, you can always lower the application memory size yourself and launch several other applications every time you test your own program, but this is a difficult solution at best. QC offers a seamless method of ensuring that all of your code will continue to operate under even the most stressful memory conditions.

Scramble Heap continuously moves all relocatable blocks of memory. If you use a pointer to point to the data represented by a relocatable block and that block is moved in memory, your pointer will no longer be valid. Scrambling the heap is a good way to make sure your code handles this possibility.

Purge Heap will purge handles marked as “purgeable” whenever possible. This is a useful tool for detecting sections of your code where you did not think it possible for a handle to become purged, but it has. This is a likely situation if you have always tested your application with lots of extra memory, but the user lowers the memory partition.

Check Heap checks the structure of the heap before every Memory Manager call to ensure its reliability. Invalidate Free Memory fills all free blocks with a value that will cause a bus error if dereferenced by the target program. This will prevent you from accessing a block of data that has been released from memory.

QC API

The QC API provides a set of routines in C for accessing directly from the target program code the individual tests that QC is able to perform. This is useful for making a special “debug” build of a product that routinely checks for memory-related errors near crucial portions of code.

Any of the tests that can be enabled from the QC control panel can also be enabled with the QC API. QC must be installed for the QC API to work.

Conclusion

QC is ideal for small developers who don’t have the resources to write tools to extensively stress-test their products. Larger developers are more likely to have their own customized stress-testing tools, but QC may fill the gap for those memory-testing features that are missing.

If you are a small developer who doesn’t have the time to track down memory-related bugs after your product ships, QC is worth the money. Buy it. If your program has problems, QC will alert you to them and will protect you from being embarassed by unforeseen glitches in your code. If your program is spotless, QC will provide you with that needed bit of extra security (and extra sleep) when your product is shipped. For only $100, it is a worthwile investment in the quality of your products and the satisfaction of your customers.

MacTech’s resident programmer, Don Bresee, adds: “QC gives you the ability to consistently reproduce the nastiest of bugs, which is always the first step to finding bad code. QC immediately helped me find a bug in THINK Reference that was no less than four years old.”

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Parallels Desktop 10.2.0 - 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
LaunchBar 6.2 - 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
Firefox 37.0 - Fast, safe Web browser. (...
Firefox offers a fast, safe Web browsing experience. Browse quickly, securely, and effortlessly. With its industry-leading features, Firefox is the choice of Web development professionals and casual... Read more
Arq 4.11 - Online backup to Google Drive...
Arq is super-easy online backup for the Mac. Back up to your own Google Drive storage (15GB free storage), your own Amazon Glacier ($.01/GB per month storage) or S3, or any SFTP server. Arq backs up... Read more
MacFamilyTree 7.3.4 - Create and explore...
MacFamilyTree gives genealogy a facelift: it's modern, interactive, incredibly fast, and easy to use. We're convinced that generations of chroniclers would have loved to trade in their genealogy... Read more
Yummy FTP 1.10.2 - FTP/SFTP/FTPS client...
Yummy FTP is an FTP + SFTP + FTPS file transfer client which focuses on speed, reliability and productivity. Whether you need to transfer a few files or a few thousand, schedule automatic backups, or... Read more
VueScan 9.5.08 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
Iridient Developer 3.0.1 - Powerful imag...
Iridient Developer (was RAW Developer) is a powerful image conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more
Monodraw 0.8.4.1 - Powerful ASCII art ed...
Monodraw allows you to easily create text-based art (like diagrams, layouts, flow charts) and visually represent algorithms, data structures, binary formats and more. Because it's all just text, it... Read more
Air Video Server HD 2.1.0 - Stream video...
Air Video Server HD streams videos instantly from your computer on your iPhone, iPad, iPod touch or Apple TV. No need to worry about converting or transferring files. We took everything that was... Read more

Marvel Mighty Heroes, the Ultimate Marve...
DeNA and Marvel Entertainment have brought us a new action-packed brawler: Marvel Mighty Heroes. You can play with up to four of your friends as you favorite marvel heroes like Iron Man, Thor, Spider-Man, Captain America, Star-Lord, Hulk, and... | Read more »
Take Note - The Jot Script 2 Evernote Ed...
Adonit's Jot Script 2 sylus has an all-new edition that's meant to be Evernote's BFF. The sylus has been redesigned to work better with iPads and give you faster stroke tracking, smoother line rendering, and better tip-to-line accuracy. | Read more »
INFINIT Lets Mobile Users Send Files of...
Infinit  is a file sharing app that ignores file size limits. It maintains the original quality of your photos and videos so you can be sure they look awesome after sending. You can move entire albums of photos or full HD films from your iPhone to... | Read more »
Serious Sam Double D Developer is Making...
There's nothing like the thrill of watching a horse race, especially when the horses are drunk.  | Read more »
2K Announces WWE 2K, Mobile's First...
It seems like this month has been pretty big for wrestling. First Wrestlemania, then 2K has announces that they're releasing  WWE 2K for iOS. It's a simulation-based WWE game where you'll get to play with several WWE superstars such as John Cena, ... | Read more »
How the Apple Watch Could Change the Fac...
The Apple Watch is still a ways out, but my previous musings on the wearable’s various features got me thinking: what might it be like a year after launch? Two years? Five years? What if it becomes a symbiotic part of the iOS framework to the point... | Read more »
You Can Start Challenging Your Friends t...
Last year we reported that Sebastian Gosztyla's new game, Dual, was theorized to be released sometime during the summer of 2014. Sadly that did not become a reality, but the good news it there is now an official release date. | Read more »
Forgotten Memories : Alternate Realities...
Forgotten Memories : Alternate Realities, from Psychoz Interactive, is planned for release on April 23. The Resident Evil, Silent Hill, and Alone in the Dark inspired horror game puts you in the shoes of Rose Hawkins as she searches for a missing... | Read more »
Pie In The Sky: A Pizza Odyssey (Games)
Pie In The Sky: A Pizza Odyssey 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: A game about delivering pizza. In space. | Read more »
Chosen Gives Hopeful Singers, Songwriter...
If YouTube videos and reality TV shows like The Voice have taught us one thing, it’s that there are a lot of people out there who are anxious to show the world their talents. And if they’ve taught us a second thing, it’s that there’s an almost... | Read more »

Price Scanner via MacPrices.net

Will Microsoft’s Surface 3 Give The 12-inch M...
The more I ruminate over the new 12-inch MacBook, the more it occurs that it’s probably going to be more of a cannibalization threat to high-end iPads (including a new 12-inch ‘Pad when/if that... Read more
13-inch 2.4GHz Retina MacBook Pro available f...
MacMall has the 2013 13″ 2.4GHz/128GB Retina MacBook Pro available for $949.99 for a limited time. Shipping is free. Their price is $350 off original MSRP, and it’s the only sub-$1000 new Retina... Read more
Adobe Brings Powerful Layout-Design Capabilit...
Adobe today announced the availability of Adobe Comp CC, a free iPad app that enables rapid creation of layout concepts for mobile, Web and print projects. With Comp CC, designers can rough out and... Read more
13-inch 2.6GHz/256GB Retina MacBook Pro avail...
Best Buy has clearance 2014 13″ 2.6GHz/256GB Retina MacBook Pros available for $1199.99 including free shipping. Their price is $300 off original MSRP, and it’s the lowest price for this model.... Read more
Updated Mac Price Trackers
We’ve updated our Mac Price Trackers with the latest information on prices, bundles, and availability on systems from Apple’s authorized internet/catalog resellers: - 15″ MacBook Pros - 13″ MacBook... Read more
21-inch 1.4GHz iMac on sale for $999, save $1...
Best Buy has the 21″ 1.4GHz iMac on sale for $999.99 on their online store. Choose free shipping or free local store pick up. Price is for online orders only, in-store prices may vary. Their price is... Read more
2.6GHz Mac mini on sale for $649, save $50
Amazon has the 2.6GHz Mac mini on sale for $649.99 including free shipping. Their price is $50 off MSRP, and it’s the lowest price available for this model. Read more
Textkraft Professional 3.2 Powerful iPad Text...
Finally it’s springtime, at least theoretically in my neck of the woods, where we’re still navigating canyons between towering snowbanks with temperatures well below freezing in winter weather that... Read more
Apple offering refurbished 27-inch 5K iMacs f...
The Apple Store is offering Apple Certified Refurbished 27″ 3.5GHz 5K iMacs for $2119 including free shipping. Their price is $380 off the price of new models, and it’s the lowest price available for... Read more
16GB iPad mini on sale for $199, save $50
Walmart has 16GB iPad minis (1st generation) available for $199.99 on their online store, including free shipping. Their price is $50 off MSRP. Online orders only. Read more

Jobs Board

DevOps Software Engineer - *Apple* Pay, iOS...
**Job Summary** Imagine what you could do here. At Apple , great ideas have a way of becoming great products, services, and customer experiences very quickly. Bring Read more
*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
Sr. Technical Services Consultant, *Apple*...
**Job Summary** Apple Professional Services (APS) has an opening for a senior technical position that contributes to Apple 's efforts for strategic and transactional Read more
Lead *Apple* Solutions Consultant - Retail...
**Job Summary** Job Summary The Lead ASC is an Apple employee who serves as the Apple business manager and influencer in a hyper-business critical Reseller's store Read more
*Apple* Pay - Site Reliability Engineer - Ap...
**Job Summary** Imagine what you could do here. At Apple , great ideas have a way of becoming great products, services, and customer experiences very quickly. Bring Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.