Flexible array member

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search

C struct data types may end with a flexible array member[1] with no specified size:

struct vectord {
    short len;    // there must be at least one other data member
    double arr[]; // the flexible array member must be last
    // The compiler may reserve extra padding space here, like it can between struct members
};

Typically, such structures serve as the header in a larger, variable memory allocation:

struct vectord *vector = malloc(...);
vector->len = ...;
for (int i = 0; i < vector->len; i++)
     vector->arr[i] = ...;  // transparently uses the right type (double)

Effect on struct size and padding[edit]

The sizeof operator on such a struct gives the size of the structure as if the flexible array member was empty. This may include padding added to accommodate the flexible member; the compiler is also free to re-use such padding as part of the array itself.[2]

It is common to allocate sizeof(struct) + array_len*sizeof(array element) bytes.

This is not wrong, however it may allocate a few more bytes than necessary: the compiler may be re-purposing some of the padding that is included in sizeof(struct). Should this be a concern, macros are available[3] to compute the minimum size while ensuring that the compiler's padding is not disrupted.

As the array may start in the padding before the end of the structure, its content should always be accessed via indexing (arr[i]) or offsetof, not sizeof.

Availability[edit]

Flexible array members were officially standardized in C99,[4] however compilers accepted zero-sized array members with the same effect (e.g., GCC,[5] Microsoft Visual C[6]).

Flexible array members are not officially part of C++, but the same compatibility extensions[7] exist.

References[edit]

  1. ^ "Lesser known C features". Retrieved December 30, 2014.
  2. ^ "flexible array member". Jens Gustedt's Blog. March 14, 2011. Retrieved October 9, 2018.
  3. ^ "P99: Flexible array members". p99.gforge.inria.fr. Retrieved October 9, 2018.
  4. ^ C99 section §6.7.2.1, item 16, page 103, http://www.open-std.org/jtc1/sc22/WG14/www/docs/n1256.pdf
  5. ^ "Zero Length - Using the GNU Compiler Collection (GCC)". Retrieved December 30, 2014.
  6. ^ "Structure Declarations". Microsoft. Retrieved April 25, 2020.
  7. ^ E.g., "Arrays (C++)". Microsoft. Retrieved April 25, 2020. A zero-sized array is legal only when the array is the last field in a struct or union and when the Microsoft extensions (/Ze) are enabled.