Home > Articles > Programming > C/C++

Accessing Shared Atomic Objects from within a Signal Handler in C

Robert C. Seacord, author of Secure Coding in C and C++, Second Edition, describes how accessing shared objects in signal handlers can result in race conditions that can leave data in an inconsistent state. Historically, the only conforming way to access a shared object from a signal handler was to read from or write to variables of type volatile sig_atomic_t. With the advent of C11, atomics are now a better choice for accessing shared objects in signal handlers.
Like this article? We recommend

The CERT® C Coding Standard, Second Edition: 98 Rules for Developing Safe, Reliable, and Secure Systems, Second Edition [1] will be published shortly. It has been updated for the C11 standard and for compatibility with the ISO/IEC TS 17961 C Secure Coding Rules. [2] The rule that gave me the most difficulty in this edition of the book was SIG31-C: "Do not access shared objects in signal handlers." This rule exists because accessing shared objects in signal handlers can result in race conditions that can leave data in an inconsistent state. In this article, I provide some additional background on accessing atomic objects from within a signal handler; I'll go beyond the description of the rule and the examples in the book.

This rule was present in the first edition of The CERT C Secure Coding Standard, but because the scope of that book was C99 and atomic objects were not yet defined, the only conforming way to access a shared object from a signal handler was to read from or write to variables of type volatile sig_atomic_t. The following conforming program installs a SIGINT handler that sets the volatile sig_atomic_t variable e_flag and then tests whether the handler was called before exiting:

#include <signal.h>
#include <stdlib.h>
#include <stdio.h>

volatile sig_atomic_t e_flag = 0;

void handler(int signum) {
  e_flag = 1;
}

int main(void) {

  if (signal(SIGINT, handler) == SIG_ERR) {
    return EXIT_FAILURE;
  }

  /* Main code loop */

  if (e_flag) {
    puts("SIGINT received.");
  }
  else {
    puts("SIGINT not received.");
  }
  return EXIT_SUCCESS;
}

C11, 5.1.2.3, paragraph 5 also allows for signal handlers to read from and write to lock-free atomic objects. [3] Following is a simple (but nonconforming) example of accessing an atomic flag. The atomic_flag type provides the classic test-and-set functionality. It has two states, set and clear, and the C Standard guarantees that operations on an object of type atomic_flag are lock-free.

#include <signal.h>
#include <stdlib.h>
#include <stdio.h>
#if __STDC_NO_ATOMICS__ != 1
#include <stdatomic.h>
#endif

atomic_flag e_flag = ATOMIC_FLAG_INIT;

void handler(int signum) {
  (void)atomic_flag_test_and_set(&e_flag);
}

int main(void) {

  if (signal(SIGINT, handler) == SIG_ERR) {
    return EXIT_FAILURE;
  }

  /* Main code loop */

  if (atomic_flag_test_and_set(&e_flag)) {
    puts("SIGINT received.");
  }
  else {
    puts("SIGINT not received.");
  }
  return EXIT_SUCCESS;
}

The atomic_flag type is the only type that is guaranteed to be lock-free, provided that atomics are supported. The atomic_flag type is also the only type that is guaranteed to be accessible from a signal handler. However, objects of this type can be meaningfully accessed only by calls to atomic functions, and such calls are not permitted. According to the C Standard 7.14.1.1, paragraph 5, undefined behavior exists if the signal handler calls any function in the standard library other than the abort function; the _Exit function; the quick_exit function; or the signal function, with the first argument equal to the signal number corresponding to the signal that caused the invocation of the handler.

This limitation exists because most C library functions need not be asynchronous-safe. (See SIG30-C: "Call only asynchronous-safe functions within signal handlers" in The CERT® C Coding Standard, Second Edition.) To solve this problem without a change to the standard, we need to rewrite the example using a different atomic type, such as atomic_int:

#include <signal.h>
#include <stdlib.h>
#if __STDC_NO_ATOMICS__ != 1
#include <stdatomic.h>
#endif

atomic_int e_flag = ATOMIC_VAR_INIT(0);

void handler(int signum) {
  e_flag = 1;
}

int main(void) {
  if (signal(SIGINT, handler) == SIG_ERR) {
    return EXIT_FAILURE;
  }

  /* Main code loop */

  if (e_flag) {
    puts("SIGINT received.");
  }
  else {
    puts("SIGINT not received.");
  }
  return EXIT_SUCCESS;
}

This solution succeeds on platforms where the atomic_int type is always lock-free. The following code will cause the compiler to produce a diagnostic message if atomics are not supported or the atomic_int type is never lock-free:

#if __STDC_NO_ATOMICS__ == 1
#error "Atomics is not supported"
#elif ATOMIC_INT_LOCK_FREE == 0
#error "int is never lock-free"
#endif

The ATOMIC_INT_LOCK_FREE macro may have a value of 0, indicating that the type is never lock-free; a value of 1, indicating that the type is sometimes lock-free; or a value of 2, indicating that the type is always lock-free. If the type is sometimes lock-free, the atomic_is_lock_free function must be called at runtime to determine whether the type is lock-free:

#if ATOMIC_INT_LOCK_FREE == 1
  if (!atomic_is_lock_free(&e_flag)) {
    return EXIT_FAILURE;
  }
#endif

Atomic types are sometimes lock-free because, for some architectures, some processor variants support lock-free compare-and-swap, while others don't (for example, 80386 vs. 80486). Depending on the processor variant, the application may be bound to a different dynamic library. Consequently, it is necessary to include a runtime check for implementations where ATOMIC_INT_LOCK_FREE == 1. This conforming program will work on implementations where the atomic_int type is lock-free:

#include <signal.h>
#include <stdlib.h>
#if __STDC_NO_ATOMICS__ != 1
#include <stdatomic.h>
#endif

#if __STDC_NO_ATOMICS__ == 1
#error "Atomics is not supported"
#elif ATOMIC_INT_LOCK_FREE == 0
#error "int is never lock-free"
#endif

atomic_int e_flag = ATOMIC_VAR_INIT(0);

void handler(int signum) {
  e_flag = 1;
}

int main(void) {
#if ATOMIC_INT_LOCK_FREE == 1
  if (!atomic_is_lock_free(&e_flag)) {
    return EXIT_FAILURE;
  }
#endif
  if (signal(SIGINT, handler) == SIG_ERR) {
    return EXIT_FAILURE;
  }

  /* Main code loop */

  if (e_flag) {
    puts("SIGINT received.");
  }
  else {
    puts("SIGINT not received.");
  }
  return EXIT_SUCCESS;
}

One remaining question is why the e_flag variable is not declared volatile. Unlike the first example that used volatile sig_atomic_t, loads and stores of objects with atomic types are performed with memory_order_seq_cst semantics. Sequentially consistent programs behave as though the operations executed by their constituent threads are simply interleaved, with each value computation of an object being the last value stored in that interleaving. The arguments to the atomic operations are specified as volatile A * to allow atomic objects to be declared volatile, not to require it.

The C Standards Committee (WG14) has generally followed the lead of the C++ Standards Committee (WG21) in defining support for concurrency. The intent of the WG21 committee was to make lock-free atomics usable in signal handlers in C++11. [4] Unfortunately, some mistakes were made that WG21 is now trying to fix in C++14. The latest proposal to specify the behavior of signal handlers in C++ is WG21/N3910, [5] which resulted in the following text being added to the C++14 Draft International Standard:

A signal handler that is executed as a result of a call to the raise function belongs to the same thread of execution as the call to the raise function. Otherwise it is unspecified which thread of execution contains a signal handler invocation.

POSIX® [6] requires that a determination be made if a signal has been generated for the process or for a specific thread within the process. Signals that are generated by some action attributable to a particular thread, such as a hardware fault, are generated for the thread that caused the signal to be generated. Signals that are generated in association with a process ID, a process group ID, or an asynchronous event such as terminal activity, are generated for the process.

Accesses to volatile objects are evaluated strictly according to the rules of the abstract machine. Actions on volatile objects cannot be optimized out by an implementation. Before atomic objects were available, volatile provided the closest approximation to the semantics required for an object shared by a signal handler. Atomics are now a better choice for accessing shared objects in signal handlers because volatile does not enforce visibility ordering with respect to other threads, making it exceedingly hard to specify how it works across threads. Consequently, volatile sig_atomic_t can be used to communicate only with a handler running in the same thread.

The C Standard does not allow signal handlers to be installed in multithreaded programs. Specifically, C11 states that the use of the signal function in a multithreaded program is undefined behavior, so much of the discussion of handling signals in multithreaded programs is moot for conforming C programs.

The following example is the most portable version of this program. Because type substitution is used in this example, everything must be known at compile time. The example uses atomics when the availability of a lock-free atomic type can be determined at compile time; otherwise, it uses volatile sig_atomic_t. Consequently, if ATOMIC_INT_LOCK_FREE == 1, it is treated the same as if it were zero.

#include <signal.h>
#include <stdlib.h>
#include <stdio.h>
#if __STDC_NO_ATOMICS__ != 1
#include <stdatomic.h>
#endif

#if __STDC_NO_ATOMICS__ == 1
  typedef volatile sig_atomic_t flag_type;
#elif ATOMIC_INT_LOCK_FREE == 0 || ATOMIC_INT_LOCK_FREE == 1
  typedef volatile sig_atomic_t flag_type;
#else
  typedef atomic_int flag_type;
#endif

flag_type e_flag;

void handler(int signum) {
  e_flag = 1;
}

int main(void) {
  if (signal(SIGINT, handler) == SIG_ERR) {
    return EXIT_FAILURE;
  }

  /* Main code loop */

  if (e_flag) {
    puts("SIGINT received.");
  }
  else {
    puts("SIGINT not received.");
  }

  return EXIT_SUCCESS;
}

According to the C Standard, "[T]he default (zero) initialization for objects with static or thread-local storage duration is guaranteed to produce a valid state," meaning that the e_flag object does not need to be initialized explicitly in this or any of the other examples.

Conclusions

Accessing shared objects from signal handlers is currently problematic for both C and C++ (which hopes to resolve these problems in C++14). Current opinion appears to be in favor of modifying the C Standard to allow atomic flag functions to be invoked from a signal handler, and such a proposal has been submitted to WG14. [7] The Austin Group is working on integrating C11 into POSIX for Issue 8. Because the use of the signal function in a multithreaded program is undefined behavior in C, POSIX can augment the language by providing a definition of the officially undefined behavior. In the long term, the C and C++ standards committees appear to be heading in the direction of abandoning volatile sig_atomic_t because it does not support multithreaded execution and because atomic types now provide a better alternative.

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