Do not send an uncaught signal to kill a thread because the signal kills the entire process, not just the individual thread. This rule is a specific instance of recommendation SIG02-C. Avoid using signals to implement normal functionality.Calling the signal()
function in a multithreaded program is undefined behavior. (See undefined behavior 135.)
Noncompliant Code Example
This code uses the pthread_killnoncompliant code example invokes the signal()
function to send a SIGKILL
signal to the created thread. The thread receives the signal, and the entire process is terminated.from a multithreaded program:
Code Block | ||||
---|---|---|---|---|
| ||||
#include <signal.h> #include <stddef.h> #include <threads.h> volatile sig_atomic_t flag = 0; void funchandler(voidint *foosignum) { flag = 1; } /* Runs until Executionuser ofsends threadSIGUSR1 */ } int mainfunc(void *data) { int result;while (!flag) { pthread_t thread; /* if ((result = pthread_create(&thread, NULL, func, 0)) != 0... */ } return 0; } int main(void) { signal(SIGUSR1, handler); /* HandleUndefined Errorbehavior */ }thrd_t tid; if ((resultthrd_success != pthreadthrd_kill(threadcreate(&tid, func, SIGKILL)) != 0NULL)) { /* Handle Errorerror */ } /* Continue executing until the signal kills the process */ ... */ return 0; } |
NOTE: The SIGUSR1
signal value is not defined in the C Standard; consequently, this is not a C-compliant code example.
Compliant Solution
This compliant code uses instead the pthread_cancel()
function to terminate the thread. The thread continues to run until it reaches a cancellation point. See [Open Group 2004] for lists of functions that are required and allowed to be cancellation points. If the cancellation type is set to asynchronous, the thread is terminated immediately. However, POSIX only requires the pthread_cancel()
, pthread_setcancelstate()
, and pthread_setcanceltype()
functions to be async-cancel safe. An application that calls other POSIX functions with asynchronous cancellation enabled is non-conforming. Consequently, we recommend disallowing asynchronous cancellation, as explained by rule POS47-C. Do not use threads that can be canceled asynchronously.solution uses an object of type atomic_bool
to indicate when the child thread should terminate its loop:
Code Block | ||||
---|---|---|---|---|
| ||||
void#include <stdatomic.h> #include <stdbool.h> #include <stddef.h> #include <threads.h> atomic_bool flag = ATOMIC_VAR_INIT(false); int func(void *foodata) { while (!flag) { /* Execution of thread */... */ } return 0; } int main(void) { intthrd_t resulttid; pthread_t thread; if ((resultthrd_success != pthreadthrd_create(&threadtid, NULL, func, 0NULL)) != 0) { /* Handle Errorerror */ } if ((result = pthread_cancel(thread)) != 0) {/* ... */ /* Set /*flag Handlewhen Errordone */ } flag /* Continue executing */= true; return 0; } |
Exceptions
CON37-C-EX1: Implementations such as POSIX that provide defined behavior when multithreaded programs use custom signal handlers are exempt from this rule [IEEE Std 1003.1-2013].
Risk Assessment
Sending the signal to a process causes it to be abnormally terminatedMixing signals and threads causes undefined behavior.
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|
CON37-C |
Low |
Probable |
Low | P6 | L2 |
Bibliography
Wiki Markup |
---|
\[[OpenBSD|AA. Bibliography#OpenBSD]\] [{{signal()}} Man Page|http://www.openbsd.org/cgi-bin/man.cgi?query=signal]
\[[MKS|AA. Bibliography#MKS]\] [{{pthread_cancel()}} Man Page|http://www.mkssoftware.com/docs/man3/pthread_cancel.3.asp]
\[[Open Group 2004|AA. Bibliography#Open Group 04]\] [Threads Overview|http://www.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_09.html] |
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
Automated Detection
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
Astrée |
| stdlib-use-signal | Fully checked | ||||||
CodeSonar |
| BADFUNC.SIGNAL | Use of signal | ||||||
Coverity |
| MISRA C 2012 Rule 21.5 | Over-constraining | ||||||
Cppcheck Premium |
| premium-cert-con37-c | Fully implemented | ||||||
Helix QAC |
| C5021 C++5022 | |||||||
Klocwork |
| MISRA.STDLIB.SIGNAL | |||||||
LDRA tool suite |
| 44 S | Enhanced enforcement | ||||||
Parasoft C/C++test |
| CERT_C-CON37-a | The signal handling facilities of <signal.h> shall not be used | ||||||
PC-lint Plus |
| 586 | Fully supported | ||||||
Polyspace Bug Finder |
| CERT C: Rule CON37-C | Checks for signal call in multithreaded program (rule fully covered) | ||||||
RuleChecker |
| stdlib-use-signal | Fully checked |
Bibliography
[IEEE Std 1003.1-2013] | XSH 2.9.1, "Thread Safety" |
...
POS41-C. When a thread exit status is not of concern, pthread_detach() or an equivalent function must be used 50. POSIX (POS) POS45-C. Avoid memory leaks and clean up thread-specific data for a key by defining an explicit destructor