Home > Articles > Programming > C#

Debugging C-Family Languages

C-family languages expose a lot of detail about the computer to the programmer, which can give rise to some very tricky debugging situations. David Chisnall takes a look at the details of some subtle bugs that can occur in these languages.
Like this article? We recommend

Recently I've come across some interesting bugs in C-family programs. In this article, I'll share a few of these experiences. As with most debugging problems, the second time you see the issue it's obvious, so hopefully this will save at least one reader from spending a few days chasing down a problem.

The C family is generally regarded as being low-level, and therefore exposes a lot of detail about the implementation to the programmer. If you've never worked on a C compiler, a lot of these details might be slightly surprising to you.

Schrödinger's Variable

For some reason, I've come across this problem a lot recently. I hadn't paid particular attention to it, probably because it had gone away after doing a clean build. This particular instance was on someone else's system, however, and remote debugging meant that I wanted to fully understand the issue.

The code in this case was Objective-C, although you can see something similar in most C-like languages. A simplified version of the problem looks something like this:

static MapTable *table = NULL;
void doInitialisation()
{
    ...
    MapInsert(table, key, value);
}

...

@implementation AClass
+ (void) initialize
{
    table = createMapTable();
    ...
    doInitialisation();
}
...
@end

In Objective-C, the +initialize method has special significance—it's automatically called (in a thread-safe way) before the first message is sent to a class. This setup allows lazy initialization of variables referenced in a compilation unit, and is one of the main reasons why Objective-C programs start a lot faster than their C++ counterparts.

The issue in this case was that the function was crashing because table was NULL. In the stack trace, it was clear that the function was called from the method. Looking further up the stack trace, you could see the table variable was a pointer to something in memory. Stepping back down the stack trace, it suddenly became NULL again.

What was the problem? It turned out to be the first word in the snippet I've shown here: static. What does static mean in a C program? To the programmer, it means that the variable is visible only in this file. To the compiler, it means almost the same thing. To the linker, however, it means something different. The linker (on UNIX-like systems, at least) has no notion of visibility. A variable that's static to the programmer is "renaming" to the linker. Rather than restricting access to it, the linker simply renames the variable if there's a conflict.

Linker renaming was exactly the problem in this case. Running ldd showed that the program was linked against two copies of the library containing this module. In most cases, this conflict would just cause one copy of the variable to be invisible. In this case, however, the renaming caused a problem due to the interference between two loaders.

In Objective-C, there are two ways of resolving a symbol to a function. The first option is via the C linker. At load time, the linker resolves all function names to pointers to functions. The second approach is via the Objective-C runtime library. The runtime library resolves method names to methods when they are caused. Due to implementation differences, one reference to the variable used the first mapping it came across, while the other used the second mapping. Again, normally this mismatch wouldn't be a problem. In this case, however, the duplication meant that the method was seeing the function (which wasn't static) in the other copy of the module. Since the variable was static, it was renamed when the second version of the module was loaded. This meant that the method was setting its local copy of the variable and then calling the function, which saw its own copy of the variable, which was still NULL.

So, what's the correct solution? There are several things wrong with this particular code. The first is that the function was not written defensively, and therefore was not checking that the variable was not NULL before doing something that would fail if it were NULL. A test could have initialized the variable. (Although in this case it would have actually made things worse—there would have been two valid but independent versions of the variable.) This omission is understandable, however, since the function was called from only one place, so the variable could never be NULL.

Or was it? The second thing that's wrong with this code is that the function, which was meant to be called only inside this module, wasn't static. Because it wasn't static, it could have been called from any other code in the program. Since it was in a library, it could have been called accidentally from anywhere if other programmers had picked the same name for one of their functions. (This is a huge problem with many current languages, and largely ignored. Modeling it is a subject for some of my current research.) If the function had been static, the method would have called its private copy, and the function would have seen the same copy of the variable as the method did.

Of course, the real bug is the loader, which should have thrown an error as soon as two modules containing different symbols with the same name in the same scope were loaded. This problem is well known, but no one seems keen to fix 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