Data structure alignment

A memory address a is said to be n-byte aligned when a is a multiple of n (where n is a power of 2). In this context, a byte is the smallest unit of memory access, i.e. each memory address specifies a different byte. An n-byte aligned address would have a minimum of least-significant zeros when expressed in binary. The alternate wording b-bit aligned designates a b/8 byte aligned address (ex. 64-bit aligned is 8 bytes aligned). A memory access is said to be aligned when the data being accessed is n bytes long and the datum address is n-byte aligned. When a memory access is not aligned, it is said to be misaligned. Note that by definition byte memory accesses are always aligned. A memory pointer that refers to primitive data that is n bytes long is said to be aligned if it is only allowed to contain addresses that are n-byte aligned, otherwise it is said to be unaligned. A memory pointer that refers to a data aggregate (a data structure or array) is aligned if (and only if) each primitive datum in the aggregate is aligned. Note that the definitions above assume that each primitive datum is a power of two bytes long. When this is not the case (as with 80-bit floating-point on x86) the context influences the conditions where the datum is considered aligned or not. Data structures can be stored in memory on the stack with a static size known as bounded or on the heap with a dynamic size known as unbounded. ==Problems==

The CPU accesses memory by a single memory word at a time. As long as the memory word size is at least as large as the largest primitive data type supported by the computer, aligned accesses will always access a single memory word. This may not be true for misaligned data accesses. If the highest and lowest bytes in a datum are not within the same memory word, the computer must split the datum access into multiple memory accesses. This requires a lot of complex circuitry to generate the memory accesses and coordinate them. To handle the case where the memory words are in different memory pages the processor must either verify that both pages are present before executing the instruction or be able to handle a TLB miss or a page fault on any memory access during the instruction execution. Some processor designs deliberately avoid introducing such complexity, and instead yield alternative behavior in the event of a misaligned memory access. For example, implementations of the ARM architecture prior to the ARMv6 ISA require mandatory aligned memory access for all multi-byte load and store instructions. Depending on which specific instruction was issued, the result of attempted misaligned access might be to round down the least significant bits of the offending address turning it into an aligned access (sometimes with additional caveats), or to throw an MMU exception (if MMU hardware is present), or to silently yield other potentially unpredictable results. The ARMv6 and later architectures support unaligned access in many circumstances, but not necessarily all. When a single memory word is accessed the operation is atomic, i.e. the whole memory word is read or written at once and other devices must wait until the read or write operation completes before they can access it. This may not be true for unaligned accesses to multiple memory words, e.g. the first word might be read by one device, both words written by another device and then the second word read by the first device so that the value read is neither the original value nor the updated value. Although such failures are rare, they can be very difficult to identify. ==Data structure padding==

Although the compiler (or interpreter) normally allocates individual data items on aligned boundaries, data structures often have members with different alignment requirements. To maintain proper alignment the translator normally inserts additional unnamed data members so that each member is properly aligned. In addition, the data structure as a whole may be padded with a final unnamed member. This allows each member of an array of structures to be properly aligned. Padding is only inserted when a structure member is followed by a member with a larger alignment requirement or at the end of the structure. By changing the ordering of members in a structure, it is possible to change the amount of padding required to maintain alignment. For example, if members are sorted by descending alignment requirements a minimal amount of padding is required. The minimal amount of padding required is always less than the largest alignment in the structure. Computing the maximum amount of padding required is more complicated, but is always less than the sum of the alignment requirements for all members minus twice the sum of the alignment requirements for the least aligned half of the structure members. Although C and C++ do not allow the compiler to reorder structure members to save space, other languages might. It is also possible to tell most C and C++ compilers to "pack" the members of a structure to a certain level of alignment, e.g. "pack(2)" means align data members larger than a byte to a two-byte boundary so that any padding members are at most one byte long. Likewise, in PL/I a structure may be declared UNALIGNED to eliminate all padding except around bit strings. One use for such "packed" structures is to conserve memory. For example, a structure containing a single byte (such as a char) and a four-byte integer (such as uint32_t) would require three additional bytes of padding. A large array of such structures would use 37.5% less memory if they are packed, although accessing each structure might take longer. This compromise may be considered a form of space–time tradeoff. Although use of "packed" structures is most frequently used to conserve memory space, it may also be used to format a data structure for transmission using a standard protocol. However, in this usage, care must also be taken to ensure that the values of the struct members are stored with the endianness required by the protocol (often network byte order), which may be different from the endianness used natively by the host machine. Computing padding The following formulas provide the number of padding bytes required to align the start of a data structure (where mod is the modulo operator): padding = (align - (offset mod align)) mod align aligned = offset + padding = offset + ((align - (offset mod align)) mod align) For example, the padding to add to offset 0x59d for a 4-byte aligned structure is 3. The structure will then start at 0x5a0, which is a multiple of 4. However, when the alignment of offset is already equal to that of align, the second modulo in (align - (offset mod align)) mod align will return zero, therefore the original value is left unchanged. Since the alignment is by definition a power of two, the modulo operation can be reduced to a bitwise AND operation. The following formulas produce the correct values (where & is a bitwise AND and ~ is a bitwise NOT) – providing the offset is unsigned or the system uses two's complement arithmetic: padding = (align - (offset & (align - 1))) & (align - 1) = -offset & (align - 1) aligned = (offset + (align - 1)) & ~(align - 1) = (offset + (align - 1)) & -align ==Typical alignment of C structs on x86==

Data structure members are stored sequentially in memory so that, in the structure below, the member data1 will always precede data2; and data2 will always precede data3: struct MyData { short data1; short data2; short data3; }; If the type short is stored in two bytes of memory then each member of the data structure depicted above would be 2-byte aligned. data1 would be at offset 0, data2 at offset 2, and data3 at offset 4. The size of this structure would be 6 bytes. The type of each member of the structure usually has a default alignment, meaning that it will, unless otherwise requested by the programmer, be aligned on a pre-determined boundary. The following typical alignments are valid for compilers from Microsoft (Visual C++), Borland/CodeGear (C++Builder), Digital Mars (DMC), and GNU (GCC) when compiling for 32-bit x86: • A char (one byte) will be 1-byte aligned. • A short (two bytes) will be 2-byte aligned. • An int (four bytes) will be 4-byte aligned. • A long (four bytes) will be 4-byte aligned. • A float (four bytes) will be 4-byte aligned. • A double (eight bytes) will be 8-byte aligned on Windows and 4-byte aligned on Linux (8-byte with the '''' compile time option). • A long long (eight bytes) will be 8-byte aligned on Windows and 4-byte aligned on Linux (8-byte with the '''' compile time option). • A long double (ten bytes with C++Builder and DMC, eight bytes with Visual C++, twelve bytes with GCC) will be 8-byte aligned with C++Builder, 2-byte aligned with DMC, 8-byte aligned with Visual C++, and 4-byte aligned with GCC. • Any pointer (four bytes) will be 4-byte aligned. (e.g.: char*, int*) The only notable differences in alignment for an LP64 64-bit system when compared to a 32-bit system are: • A long (eight bytes) will be 8-byte aligned. • A double (eight bytes) will be 8-byte aligned. • A long long (eight bytes) will be 8-byte aligned. • A long double (eight bytes with Visual C++, sixteen bytes with GCC) will be 8-byte aligned with Visual C++ and 16-byte aligned with GCC. • Any pointer (eight bytes) will be 8-byte aligned. Some data types are dependent on the implementation. Here is a structure with members of various types, totaling 8 bytes before compilation: struct MixedData { char c1; short s; int i; char c2; }; After compilation the data structure will be supplemented with padding bytes to ensure a proper alignment for each of its members: // After compilation in 32-bit x86 machine struct MixedData { char c1; // 1 byte // 1 byte for the following 'short' to be aligned on a 2-byte boundary // assuming that the address where structure begins is an even number char padding1[1]; short s; // 2 bytes int i; // 4 bytes - largest structure member char c2; // 1 byte char padding2[3]; // 3 bytes to make total size of the structure 12 bytes }; The compiled size of the structure is now 12 bytes. The last member is padded with the number of bytes required so that the total size of the structure should be a multiple of the largest alignment of any structure member ( in this case, which = 4 on linux-32bit/gcc). In this case 3 bytes are added to the last member to pad the structure to the size of 12 bytes (). struct FinalPad { float x; char n[1]; }; In this example the total size of the structure , not 5 (so that the size is a multiple of 4 ()). struct FinalPadShort { short s; char n[3]; }; In this example the total size of the structure , not 5 (not 8 either) (so that the size is a multiple of 2 ( on linux-32bit/gcc)). It is possible to change the alignment of structures to reduce the memory they require (or to conform to an existing format) by reordering structure members or changing the compiler's alignment (or “packing”) of structure members. // after reordering struct MixedData { char c1; char c2; short s; int i; }; The compiled size of the structure now matches the pre-compiled size of 8 bytes. Note that has been replaced (and thus eliminated) by and is no longer necessary as the structure is already aligned to the size of a long word. The alternative method of enforcing the structure to be aligned to a one byte boundary will cause the pre-processor to discard the pre-determined alignment of the structure members and thus no padding bytes would be inserted. While there is no standard way of defining the alignment of structure members (while C and C++ allow using the specifier for this purpose it can be used only for specifying a stricter alignment), some compilers use directives to specify packing inside source files. Here is an example: • pragma pack(push) // push current alignment to stack • pragma pack(1) // set alignment to 1-byte boundary struct MyPackedData { char c1; long l; char c2; }; • pragma pack(pop) // restore original alignment from stack This structure would have a compiled size of 6 bytes on a 32-bit system. The above directives are available in compilers from Microsoft, Borland, GNU, and many others. Another example: struct MyPackedData { char c1; long l; char c2; } __attribute__((packed)); Default packing and On some Microsoft compilers, particularly for RISC processors, there is an unexpected relationship between project default packing (the /Zp directive) and the directive. The directive can only be used to reduce the packing size of a structure from the project default packing. This leads to interoperability problems with library headers which use, for example, , if the project packing is smaller than this. For this reason, setting the project packing to any value other than the default of 8 bytes would break the directives used in library headers and result in binary incompatibilities between structures. This limitation is not present when compiling for x86. ==Allocating memory aligned to cache lines==

It would be beneficial to allocate memory aligned to cache lines. If an array is partitioned for more than one thread to operate on, having the sub-array boundaries unaligned to cache lines could lead to performance degradation. Here is an example to allocate memory (double array of size 10) aligned to cache of 64 bytes. • include // create array of size 10 double* foo(void) { double* a; if (posix_memalign((void**)&a, 64, 10 * sizeof(double)) == 0) { return a; } return NULL; } ==Hardware significance of alignment requirements==

Alignment concerns can affect areas much larger than a C structure when the purpose is the efficient mapping of that area through a hardware address translation mechanism (PCI remapping, operation of a MMU). For instance, on a 32-bit operating system, a 4 KiB (4096 bytes) page is not just an arbitrary 4 KiB chunk of data. Instead, it is usually a region of memory that is aligned on a 4 KiB boundary. This is because aligning a page on a page-sized boundary lets the hardware map a virtual address to a physical address by substituting the higher bits in the address, rather than doing complex arithmetic. Example: Assume that we have a TLB mapping of virtual address to physical address . (Note that both these addresses are aligned at 4 KiB boundaries.) Accessing data located at virtual address va=0x2CFC7ABC causes a TLB resolution of to to issue a physical access to . Here, the 20/12-bit split luckily matches the hexadecimal representation split at 5/3 digits. The hardware can implement this translation by simply combining the first 20 bits of the physical address () and the last 12 bits of the virtual address (). This is also referred to as virtually indexed () physically tagged (). A block of data of size 2(n+1) − 1 always has one sub-block of size 2n aligned on 2n bytes. This is how a dynamic allocator that has no knowledge of alignment, can be used to provide aligned buffers, at the price of a factor two in space loss. // Example: get 4096 bytes aligned on a 4096-byte buffer with malloc() // unaligned pointer to large area void* up = malloc((1 where ALIGN_TO_NEXT(p, r) works by adding an aligned increment, then clearing the r least significant bits of p. A possible implementation is // Assume `uint32_t p, bits;` for readability • define ALIGN_TO(p, bits) (((p) >> bits) ==Notes==