Home > Articles > Programming > C/C++

Like this article? We recommend

Like this article? We recommend

Autoreleasing Performance

Autoreleasing Performance

It's always tempting to optimize code, and it's a temptation that most programmers learn to resist shortly after the first time they try maintaining code someone else has optimized.

As I said earlier, the first time I ran this unoptimized program, it took a fraction of a second to run. If I'd spent a few minute optimizing it, I'd have spent more time than I'd have saved over the number of times that I ran it, even if I made it run in no time at all.

In another program that I wrote with some similar code, however, there was some opportunity for optimization. I noticed that my code was running slowly. The first thing I tried was running top, to see if another process was using my CPU. This showed me that the CPU load was only about 20 percent, which was surprising when I was running a compute-bound process.

Looking more carefully, I saw that the program I was testing had consumed more than 500MB of RAM and was growing at about 10MB/second. It turned out that this was inside a loop that was allocating a lot of short-lived objects.

It's a very common pattern in Objective-C to use autoreleased objects as temporaries. There are two ways that you might do this. You might get an autoreleased object returned from another method, or you might create the autorelease object yourself, typically by using a named constructor. For example, you might create a temporary string object like this:

NSMutableString *buffer = [NSMutableString string];

This is equivalent to:

NSMutableString *buffer = [[[NSMutableString alloc] init] autorelease];

This is convenient, because it means that you don't have to worry about destroying the object—it will be cleaned up for you later. The problem is that “later” might be quite a long way in the future. Typically, it's at the end of the current run-loop iteration.

If you have a line like this inside a loop, then you would be allocating a new object each iteration, but not destroying it until the end of the run loop. This isn't quite a memory leak, but it looks a lot like one.

Most of the time, this isn't a problem because you are only meant to do a small amount of work each time the run loop runs. For non-interactive applications (or even threads), this may not be the case, and memory usage can balloon.

Fortunately, it's usually easy to fix. You can simply add an extra autorelease pool. This is quite simple:

while (someCondition)
{
    NSAutoreleasePool *pool = [NSAutoreleasePool new];
    @try
    {
        NSMutableString *buffer = [NSMutableString string];
        // Other stuff with temporary objects.
    }
    @finally
    {
        [pool release];
    }
}

There are a few things to be careful about here. The first is to remember to include the @finally block, to make sure that the objects are automatically destroyed, even if the stack is unwound by an exception. This is not entirely necessary. Autorelease pools are arranged in a stack, and trying to destroy one that has children that have not been destroyed will also destroy the inner ones, but it means that you won't accidentally defer destruction (which is the problem that you're trying to solve in the first place).

The second thing to remember is that you can't pass autoreleased objects out of the @try block. If you want something to persist outside of the block, then you need to send it a -retain message before destroying the autorelease pool, then an -autorelease message afterwards. This will add it to the next autorelease pool up the stack.

If you are creating the temporary objects yourself, you can dispense with the autorelease pool entirely and just explicitly release them later. The loop would instead look like this:

while (someCondition)
{
    NSMutableString *buffer = [NSMutableString new];
    @try
    {
        // Other stuff with temporary objects.
    }
    @finally
    {
        [buffer release];
    }
}

One of the main reasons that people resort to using autoreleased objects in the first place is that this is quite tedious. You need to make sure that every possible exit from the scope—including exception throwing—has a -release message for every temporary object. Fortunately, GCC introduced an extension to C that makes this much easier.

The cleanup attribute uses the same mechanism that is used to generate C++ object destructors for on-stack objects. It lets you define a destructor for a variable, like this:

__attribute__((cleanup(releaseObject))) NSMutableString *buffer = [NSMutableString new];

At every point where the buffer variable goes out of scope (including in an implicit exception cleanup block), the compiler will insert this:

releaseObject(&buffer);

You can define this function simply as:

void releaseObject(id *obj)
{
    [*obj release];
}

This is quite a lot of typing too, but fortunately this version is easily reusable. In the EtoileFoundation framework, I defined a macro that uses this facility, so the entire loop would now look like this:

while (someCondition)
{
    STACK_SCOPED NSMutableString *buffer = [NSMutableString new];
    // Other stuff with temporary objects.
}

The cleanup function is defined in the header, and the STACK_SCOPED macro defines the attribute. You can now use buffer almost as if it were an autoreleased object, and it will be automatically cleaned up for you as it leaves scope.

After making this tweak to my program, it went from taking a long time and a huge amount of memory to finishing in less than a second and using 30MB of RAM at peak. This is a big improvement over several minutes and hundreds of megabytes of RAM.

Most of the time, you don't need to do this in Objective-C projects. It's important to remember that you can, for the few situations where you do need to. The Objective-C philosophy includes the idea of “no magic.” Autorelease pools are simple—you could easily implement your own version—and understanding exactly how your Objective-C code is executed makes it easy to optimize it.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020