...
If the misaligned pointer is dereferenced, the program may terminate abnormally. On some architectures, the cast alone may cause a loss of information even if the value is not dereferenced if the types involved have differing alignment requirements.
Noncompliant Code Example
In this noncompliant example, the char
pointer &c
is converted to the more strictly aligned int
pointer ip
. On some implementations, cp
will not match &c
. As a result, if a pointer to one object type is converted to a pointer to a different object type, the second object type must not require stricter alignment than the first.
Code Block | ||||
---|---|---|---|---|
| ||||
#include <assert.h> void func(void) { char c = 'x'; int *ip = (int *)&c; /* This can lose information */ char *cp = (char *)ip; /* Will fail on some conforming implementations */ assert(cp == &c); } |
Compliant Solution (Intermediate Object)
In this compliant solution, the char
value is stored into an int
so that the pointer's value will be properly aligned:
Code Block | ||||
---|---|---|---|---|
| ||||
#include <assert.h> void func(void) { char c = 'x'; int i = c; int *ip = (int *)&i; assert(ip == &i); } |
Compliant Solution (C11, alignas()
)
This compliant solution uses the alignment specifier to declare the char
object c
with the same alignment as that of an int
. As a result, the two pointers reference equally aligned pointer types:
Code Block | ||||
---|---|---|---|---|
| ||||
#include <stdalign.h> #include <assert.h> void func(void) { /* Align c to the alignment of an int */ alignas(int) char c = 'x'; int *ip = (int *)&c; char *cp = (char *)ip; /* Both cp and &c point to equally aligned objects */ assert(cp == &c); } |
Noncompliant Code Example
The C Standard allows any object pointer to be cast to and from void *
. As a result, it is possible to silently convert from one pointer type to another without the compiler diagnosing the problem by storing or casting a pointer to void *
and then storing or casting it to the final type. In this noncompliant code example, loop_function()
is passed the char
pointer loop_ptr
but returns an int
pointer:
...
This example compiles without warning. However, v_pointer
can be more strictly aligned than an int *
.
Compliant Solution
Because the input parameter directly influences the return value, and loop_function()
returns an int *
, the formal parameter v_pointer
is redeclared to accept only int *
:
...
Another solution is to ensure that loop_ptr
points to an object returned by malloc()
because this object is guaranteed to be suitably aligned for the storage of any type of object. However, this subtlety is easily missed when the program is modified in the future. It is easier and safer to let the type system document the alignment needs.
Noncompliant Code Example
Some architectures require that pointers are correctly aligned when accessing objects larger than a byte. However, it is common is system code that unaligned data (for example, the network stacks) must be copied to a properly aligned memory location, such as in this noncompliant code example:
...
Assigning an unaligned value to a pointer that references a type that needs to be aligned is undefined behavior. An implementation may notice, for example, that tmp
and header
must be aligned and use an inline memcpy()
that uses instructions that assume aligned data.
Compliant Solution
This compliant solution avoids the use of the foo_header
pointer:
Code Block | ||||
---|---|---|---|---|
| ||||
#include <string.h> struct foo_header { int len; /* ... */ }; void func(char *data, size_t offset) { struct foo_header header; memcpy(&header, data + offset, sizeof(header)); /* ... */ } |
Exceptions
EXP36-EX1: Some hardware architectures have relaxed requirements with regard to pointer alignment. Using a pointer that is not properly aligned is correctly handled by the architecture, although there might be a performance penalty. On such an architecture, improper pointer alignment is permitted, but remains an efficiency problem.
Risk Assessment
Accessing a pointer or an object that is not properly aligned can cause a program to crash or give erroneous information, or it can cause slow pointer accesses (if the architecture allows misaligned accesses).
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
EXP36-C | Low | Probable | Medium | P4 | L3 |
Automated Detection
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
Compass/ROSE | Can detect violations of this rule. However, it does not flag explicit casts to | ||||||||
| CC2.EXP36 | Fully implemented | |||||||
EDG | |||||||||
GCC |
| Can detect some violations of this rule when the | |||||||
| 94 S | Fully implemented | |||||||
PRQA QA-C |
| 3305 | Fully implemented |
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
Related Guidelines
CERT C++ Secure Coding Standard | EXP36-CPP. Do not convert pointers into more strictly aligned pointer types |
ISO/IEC TR 24772:2013 | Pointer Casting and Pointer Type Changes [HFC] |
ISO/IEC TS 17961 | Converting pointer values to more strictly aligned pointer types [alignconv] |
MISRA C:2012 | Rule 11.1 (required) Rule 11.2 (required) Rule 11.5 (advisory) Rule 11.7 (required) |
Bibliography
[Bryant 2003] | |
[ISO/IEC 9899:2011] | 6.3.2.3, "Pointers" |
[Walfridsson 2003] | Aliasing, Pointer Casts and GCC 3.3 |
...