Page History

The C Standard, 6.7.3.2, paragraph 20 [ISO/IEC 9899:2024], says

As a special case, the last element of a structure with more than one named member may have an incomplete array type; this is called a flexible array member. In most situations, the flexible array member is ignored. In particular, the size of the structure is as if the flexible array member were omitted except that it may have more trailing padding than the omission would imply.

The following is an example of a structure that contains a flexible array member:

struct flex_array_struct {
  int num;
  int data[];
};

This definition means that when computing the size of such a structure, only the first member, num, is considered. Unless the appropriate size of the flexible array member has been explicitly added when allocating storage for an object of the struct, the result of accessing the member data of a variable of nonpointer type struct flex_array_struct is undefined. DCL38-C. Use the correct syntax when declaring a flexible array member describes the correct way to declare a struct with a flexible array member.

To avoid the potential for undefined behavior, structures that contain a flexible array member should always be allocated dynamically. Flexible array structures must

• Have dynamic storage duration (be allocated via malloc() or another dynamic allocation function)
• Be dynamically copied using memcpy() or a similar function and not by assignment
• When used as an argument to a function, be passed by pointer and not copied by value

Noncompliant Code Example (Storage Duration)

This noncompliant code example uses automatic storage for a structure containing a flexible array member:

#include <stddef.h>
 
struct flex_array_struct {
  size_t num;
  int data[];
};
 
void func(void) {
  struct flex_array_struct flex_struct;
  size_t array_size = 4;

  /* Initialize structure */
  flex_struct.num = array_size;

  for (size_t i = 0; i < array_size; ++i) {
    flex_struct.data[i] = 0;
  }
}

Because the memory for flex_struct is reserved on the stack, no space is reserved for the data member. Accessing the data member is undefined behavior.

Compliant Solution (Storage Duration)

This compliant solution dynamically allocates storage for flex_array_struct:

#include <stdlib.h>
 
struct flex_array_struct {
  size_t

Flexible array members are a special type of array where the last element of a structure with more than one named member has an incomplete array type; that is, the size of the array is not specified explicitly within the structure.  A variety of different syntaxes have been used for declaring flexible array members.  For C99-compliant implementations, use the syntax guaranteed valid by C99 \[[ISO/IEC 9899:1999|AA. C References#ISO/IEC 9899-1999]\].

Non-Compliant Code Example

In this non-compliant code, an array of size 1 is declared, but when the structure itself is instantiated, the size computed for malloc() is modified to account for the actual size of the dynamic array. This is the syntax used by ISO C89.

struct flexArrayStruct {
  int num;
  int data[1];
};

/* ... */
/* Space is allocated 
void func(void) {
  struct flex_array_struct *flex_struct;
  size_t array_size = 4;

  /* Dynamically allocate memory for the struct */
struct flexArrayStruct *structP 
  flex_struct = (struct flexArrayStructflex_array_struct *) malloc(
     malloc(sizeof(struct flexArrayStructflex_array_struct) 
           + sizeof(int) * (ARRAY_SIZE - 1))array_size);
  if (structPflex_struct == NULL) {
    /* handleHandle malloc failureerror */
  }
structP->num
 = SOME_NUMBER;

/* AccessInitialize data[] as if it had been allocated
 * as data[ARRAY_SIZE] */
for (structure */
  flex_struct->num = array_size;

  for (size_t i = 0; i < ARRAYarray_SIZEsize; i++i) {
  structP  flex_struct->data[i] = i0;
  }

The problem with this code is that the only member that is guaranteed to be valid, by strict C99 definition, is {{structP->data\[0\]}}. Consequently, for all {{i > 0}}, the results of the assignment are undefined.

Implementation Details

The non-compliant example may be the only alternative for compilers that do not yet implement the C99 syntax.  Microsoft Visual Studio 2005 does not implement the C99 syntax.

Compliant Solution

}

Noncompliant Code Example (Copying)

This noncompliant code example attempts to copy an instance of a structure containing a flexible array member (struct flex_array_struct) by assignment:

#include <stddef.h>
 
struct flex_array_struct {
  size_t num;
  int data[];
};
 
void func(struct flex_array_struct *struct_a,
          struct flex_array_struct *struct_b) {
  *struct_b = *struct_a;
}

When the structure is copied, the size of the flexible array member is not considered, and only the first member of the structure, num, is copied, leaving the array contents untouched.

Compliant Solution (Copying)

This compliant solution uses memcpy() to properly copy the content of struct_a into struct_b:This compliant solution uses the flexible array member to achieve a dynamically sized structure.

#include <string.h>
 
struct flexArrayStructflex_array_struct {
  intsize_t num;
  int data[];
};

/* ... */
/* Space is allocated for the struct */
struct flexArrayStruct *structP 
  = (struct flexArrayStruct *)
 
void func(struct flex_array_struct *struct_a,
          struct flex_array_struct *struct_b) {
  if (struct_a->num > struct_b->num) {
    /* Insufficient space; handle error */
    return;
  }
  memcpy(struct_b, struct_a,
         malloc(sizeof(struct flexArrayStruct) 
flex_array_struct) + (sizeof(int)
           + sizeof(int) * ARRAY_SIZE);
if (structP == NULL) {
  /* handle malloc failure */
}

structP->num = SOME_NUMBER;

/* Access data[] as if it had been allocated 
 * as data[ARRAY_SIZE] */
for (* struct_a->num));
}

Noncompliant Code Example (Function Arguments)

In this noncompliant code example, the flexible array structure is passed by value to a function that prints the array elements:

#include <stdio.h>
#include <stdlib.h>
 
struct flex_array_struct {
  size_t num;
  int data[];
};
 
void print_array(struct flex_array_struct struct_p) {
  puts("Array is: ");
  for (size_t i = 0; i < struct_p.num; ++i) {
    printf("%d ", struct_p.data[i]);
  }
  putchar('\n');
}

void func(void) {
  struct flex_array_struct *struct_p;
  size_t array_size = 4;

  /* Space is allocated for the struct */
  struct_p = (struct flex_array_struct *)malloc(
    sizeof(struct flex_array_struct)
    + sizeof(int) * array_size);
  if (struct_p == NULL) {
    /* Handle error */
  }
  struct_p->num = array_size;

  for (size_t i = 0; i < ARRAYarray_SIZEsize; i++i) {
  structP  struct_p->data[i] = i;
  }

This compliant solution allows the structure to be treated as if it had declared the member {{data\[\]}} to be {{data\[ARRAY_SIZE\]}} in a manner that conforms to the C99 standard.

However, some restrictions apply:

1. The incomplete array type must be the last element within the structure.
2. There cannot be an array of structures that contain flexible array members.
3. Structures that contain a flexible array member cannot be used as a member in the middle of another structure.
4. The sizeof operator cannot be applied to a flexible array.

Risk Assessment

  print_array(*struct_p);
}

Because the argument is passed by value, the size of the flexible array member is not considered when the structure is copied, and only the first member of the structure, num, is copied.

Compliant Solution (Function Arguments)

In this compliant solution, the structure is passed by reference and not by value:

#include <stdio.h>
#include <stdlib.h>
 
struct flex_array_struct {
  size_t num;
  int data[];
};
 
void print_array(struct flex_array_struct *struct_p) {
  puts("Array is: ");
  for (size_t i = 0; i < struct_p->num; ++i) {
    printf("%d ", struct_p->data[i]);
  }
  putchar('\n');
}

void func(void) {
  struct flex_array_struct *struct_p;
  size_t array_size = 4;

  /* Space is allocated for the struct and initialized... */

  print_array(struct_p);
}

Risk Assessment

Failure to use structures with flexible array members correctly can result in undefined behavior. Failing to use the correct syntax can result in undefined behavior, although the (incorrect) syntax will work on most implementations.

Automated Detection

Related Vulnerabilities

Search for vulnerabilities resulting from the violation of this rule on the CERT website.

Related Guidelines

Key here (explains table format and definitions)

...

References

...

CERT-CWE Mapping Notes

Key here for mapping notes

CWE-401 and MEM33-CPP

There is no longer a C++ rule for MEM33-CPP. (In fact, all C++ rules from 30-50 are gone, because we changed the numbering system to be 50-99 for C++ rules.)

Bibliography

...

...

...

...

...

Image Added Image Added and union specifiers" \[[McCluskey 01|AA. C References#McCluskey 01]\] ;login:, July 2001, Volume 26, Number 4MEM32-C. Detect and handle memory allocation errors      08. Memory Management (MEM)       Image Modified