Home > Articles > Programming > C#

Like this article? We recommend

Empty Empty Strings

I came across another C-language issue in some C++ code, when I encountered a strange bug in my Smalltalk compiler. A number of people were complaining that a program would compile when it contained an unreferenced constant string, but when you removed this string the program would crash.

I wasn't able to reproduce this bug, but I did find one in which assignments to variables as the result of arithmetic were sometimes becoming NULL rather than the correct result. Before explaining this issue, I need to sidetrack a little and talk about how arithmetic works in Smalltalk. Since Smalltalk is a pure object-oriented language, everything is an object, including integers. This is fudged slightly, however. Objects are structures containing a pointer to their class and any local state. Allocating a real object and going via the dynamic dispatch mechanism for integer arithmetic would take up a lot of space and be very slow, so there's a means of short-circuiting it. Since objects must be aligned on at least word boundaries, the lowest bit is always 0 in any object pointer. Setting this bit to 1 indicates that the object is a SmallInt—a special kind of object that stores its state in the other 31 or 63 bits.

When you send a + message to a SmallInt, a special lookup mechanism is used. In my implementation, SmallInt methods are implemented as C functions in an Objective-C file, which is compiled to LLVM bitcode with clang and then linked to the Smalltalk code. The LLVM inliner can then inline the implementations.

The issue, I discovered, was in cases where the arithmetic overflowed. In Smalltalk, arithmetic overflow is meant to result in a BigInt, a real object containing an arbitrary-precision integer, and this is exactly what I had implemented. My BigInt object was implemented in Objective-C and constructed in the SmallInt method by sending a message to the BigInt class.

I discovered that the constructor was not being called. I added a debugging line that called printf(), and I got a different result. Now it worked correctly. I added a static variable to which I assigned an intermediate value. This arrangement worked the first time, and then failed.

By this stage, I was quite confused. I added a breakpoint in the Objective-C runtime function for resolving the class name to a class pointer, and discovered that it was being called with "BigInt\129\205..." as the argument, not "BigInt", as I expected.

At this point, a light went on in my head, and I checked the bitcode that clang was generating. Sure enough, the "BigInt" string literal was missing the NULL terminator. Still a compiler bug, but since I also wrote the Objective-C code-generation stuff for the GNU runtime in clang, this one was still my fault.

Only it wasn't. Looking at the code, I saw that it was calling the correct function for emitting a NULL-terminated string. I went to the definition of this function, and here it is:

llvm::Constant *CodeGenModule::GetAddrOfConstantCString(const std::string &str,
                            const char *GlobalName){
 return GetAddrOfConstantString(str + "\0", GlobalName);
}

GetAddrOfConstantString() emits a constant array of bytes, whereas GetAddrOfConstantCString() emits a constant C string—an array of bytes with a NULL terminator. At first glance, it takes a string argument, ensures that it's NULL-terminated, and then emits it as an array of bytes.

This is where I realized why I hate the C++ type system. A good type system reduces the number of valid-but-incorrect programs. In my experience, the C++ type system rejects programs that are correct and completely fails to spot most real errors.

Understanding this error requires you to understand that there are two kinds of string in C++. The first is C strings, which are NULL-terminated arrays of bytes. The second is C++ std::string objects. These are like Pascal strings—an array of bytes and a length—with some operations defined on them. Most of the time, you can pass a C string to something that expects a C++ string, and the compiler will do the correct conversion for you. This allows you to use the double-quote notation for constructing std::string objects—it's not really what you're doing, but you can pretend that it is.

In this case, the distinction is important. "\0" is a C string, being passed to the + operator method on a C++ string. What is "\0" really? It's a two-byte array, where both bytes are NULL. And what is a C string? It's a variable-sized array of bytes from some pointer to the first NULL byte. And herein lies the problem: The string literals "" and "\0" are semantically equivalent when treated as C strings.

This function was appending the empty string to the C++ string and then emitting the result. Appending the empty string is a no-op, so GetAddrOfConstantCString() did exactly the same thing as GetAddrOfConstantString().

Sometimes the string literals would be followed by a variable that happened to be 0. Sometimes they would be followed by nothing, so reading along the string would cause a crash. Sometimes they'd be followed by another string, or something else followed by a 0 byte, so they would just contain the wrong value.

Once this bug was identified, it was easy to fix. Replace the double quotes with single quotes, so you get this:

return GetAddrOfConstantString(str + '\0', GlobalName);

This now appends the 0 character to the string, which is what the original author wanted. Again, this was something that could have been prevented by a more defensive programming style. Style guidelines could have said that single-character strings should not be used. Operator overloading in C++ lets you implement methods that do the same thing on a single character as on a single-character string, and a character literal is always what you mean it to be, while a C string might not be.

More importantly, there's no good reason for emitting array constants that aren't NULL-terminated. If you add a NULL to the end of something that doesn't check beyond a fixed length, you just waste one byte of space in your data segment. If you write the extra byte, you can treat the array as NULL-terminated. The result? For a very low space cost, you get a result that doesn't fail for valid code and doesn't fail for some categories of invalid code.

Technically speaking, doing the right thing on incorrect input is a bug, but it's the kind of bug no one ever complains about, and this is a good rule for avoiding bugs. The general rule is to be strict in what you send and relaxed in what you receive. (Always generate data that's easy to use to do the right thing, but don't expect anyone else to follow that principle.)

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