I am going though some C code written for the Microchip C30 compiler and I often see structs defined as follows:
typedef struct __attribute__((__packed__))
{
IP_ADDR MyIPAddr; // IP address
IP_ADDR MyMask; // Subnet mask
IP_ADDR MyGateway; // Default Gateway
// etc...
} APP_CONFIG;
What does packed mean?
Let me explain the concept of padding in structures and then packed structures by taking an example.
And then let us see why packing is required.
Padding:
When the structure is declared as above on a 16 bit architecture, the variable
abc
would be assigned some address. The next address is not assigned to variablexyz
, instead one extra byte is added, and then the next address would be assigned to the variablexyz
.In the end, the structure looks something like below:
Padding makes addresses of member variables easily accessible to the microcontroller. The disadvantage is extra unnecessary bytes that come into the picture.
Packing:
If same structure is declared using the attribute “
packed
”, the extra byte will not be added after the variableabc
.Let me give one example where packing is needed:
Consider a microcontroller interfaced with an EEPROM where some structure is being stored.
Imagine a function writing to the EEPROM would look as below:
Now if packing is not done, the extra padded bytes would occupy space in the EEPROM, which is of no use.
_attribute__((__packed__))
means (most probably) "do not insert any padding to make things faster" and may also mean "do not insert any alignments to preserve alignment".It instructs the compiler to not add any padding between members of the
struct
.See, for example, this page.
When structures are defined, the compiler is allowed to add paddings (spaces without actual data) so that members fall in address boundaries that are easier to access for the CPU.
For example, on a 32-bit CPU, 32-bit members should start at addresses that are multiple of 4 bytes in order to be efficiently accessed (read and written). The following structure definition adds a 16-bit padding between both members, so that the second member falls in a proper address boundary:
The structure in memory of the above structure in a 32-bit architecture is (~ = padding):
When a structure is packed, these paddings are not inserted. The compiler has to generate more code (which runs slower) to extract the non-aligned data members, and also to write to them.
The same structure, when packed, will appear in memory as something like:
One thing that has not been explicitly called out is that packing usually is done to match predefined field structures. For example, at the low level layer of a network interface, a series of bytes is exchanged between networked machines. After the data is received, it will need to be mapped to a high level structure so that the data can be manipulated easily. This is when no-padding is usually necessary, so that the structure directly maps to the bytes.
Network data interchange also involves byte endianness issue (i.e. almost all network data uses big endian format regardless the endianness of the source and destination machines).
Furthermore, some machines cannot access wide data in non-aligned address, for example, Cortex-M0 cores cannot access 32-bit data in non-32-bit aligned address, so care must be taken on writing networking code in such cases.