News for hackers. Stuff that matters.
Re:The Lost Art of C Structure Packing (2014) by kazinator on Friday August 05, 2016 @12:29PM (#12233594)
TL;DR: to get smaller structures, don't do stuff like this:

   struct foo {
     char a;
     int b;
     char c;
     int d;
   };
but this:

   struct foo {
     int b;  // or int b, c;
     int c;
     char a;
     char c;
   };
Basically if you sort the types by size in reverse descending order, you get optimal packing without messing with compiler-specific packing extensions that skew alignment and possibly bloat code.

The worst that you will get is padding at the end of the structure so that if two or more of them are arrayed, the first member is correctly aligned at all the array indices.

Re:The Lost Art of C Structure Packing (2014) by dysoco on Friday August 05, 2016 @12:55PM (#12233882)
Alright this might be a stupid question, but if packing is about the order in which the fields are arranged... shouldn't the compiler optimize that? I mean, it does much more complex optimizations already doesn't it?
Re:The Lost Art of C Structure Packing (2014) by kazinator on Friday August 05, 2016 @02:24PM (#12234669)
ISO C has codified the C tradition that structure members are laid out in the order in which they are declared. The first member has the same address as the struct itself. The remaining members are then at increasing offsets from that address.

Languages which allow compilers to reorganize structures for better packing (like, I think, Ada) have to have some provision to disable that in cases when the programmer requires the structure to conform to some externally imposed layout.

I wish we could say that C does this to adhere to some principle of being predictable and obeying the programmer literally. However, that cannot be claimed with a straight face by anyone who knows anything about this language, in which you can cause undefined behavior just by giving the code a dirty look in the text editor window. What C gives you with predictable structure layout, it immediately takes away with scrambled evaluation order of function arguments and constituent subexpressions of most operators.

Anyway, one consequence of a predictable layout is that C programs can do punning among structures which share a common initial sequence of members. One form of such punning is even required by ISO C to work: when a union is made of such struct types. Related hacks not involving binding through a union, however, also broadly work in de facto practice.

Re:The Lost Art of C Structure Packing (2014) by Arnavion on Friday August 05, 2016 @12:59PM (#12233916)
The language spec prevents it from doing so for ABI reasons.

The optimization is present in other languages that did not start with this restriction, but it's too late for C now.

Re:The Lost Art of C Structure Packing (2014) by valarauca1 on Friday August 05, 2016 @01:57PM (#12234440)
>The optimization is present in other languages that did not start with this restriction, but it's too late for C now.

Which?

.NET is the only one I could find that appears to do some from of smart packing [1]

The new hotness languages behave like:

Go doesn't sort by size. It packs to the byte, but guarantees structures within structures will start on the 32/64bit boundary (depending on 32/64bit system) so it'll pad for them.

Rust ignores field size and just aligns to the 32bit boundary, unless you trigger `#[repr(C)]` which will pack like C. Rust doesn't give any guarantees about a structure is laid out to be perfectly honest.

C++, NIM, D.

I can find no reference on Crystal except that you can opt into C behavior. So I don't know what default is.

[1] https://msdn.microsoft.com/en-us/library/ms253935(v=vs.80).a...

Re:The Lost Art of C Structure Packing (2014) by dbaupp on Friday August 05, 2016 @04:21PM (#12235479)
Rust doesn't ignore field size nor does it align to any particular boundary. E.g. struct Foo { x: u8 } is one byte and has alignment 1, and similarly struct Bar { x: u8, y: i16 } is 4 bytes and has alignment 2. The compiler doesn't give guarantees about structure layout so that it is able to reduce the size by reordering fields.
Re:The Lost Art of C Structure Packing (2014) by valarauca1 on Friday August 05, 2016 @06:31PM (#12236141)
So the nomicon is out of date?

It says Struct fields are aligned to to the 32/64bit boundary based on system architecture. Then you have #[repr(u8/u16/u32/u64)] which will align to 8/16/32/64 boundary.

Re:The Lost Art of C Structure Packing (2014) by Gankro on Friday August 05, 2016 @06:57PM (#12236244)
No you're just making stuff up.

https://doc.rust-lang.org/nomicon/repr-rust.html

The bulk of this section is describing how Rust has reserved the right to reorder and pack stuff. The first example happens to be 32-bit aligned because it contains a value that is.

Re:The Lost Art of C Structure Packing (2014) by ygra on Friday August 05, 2016 @03:29PM (#12235140)
The linked site explains structure packing for C/C++ and the related compiler options. It has nothing to do with the CLR.
Re:The Lost Art of C Structure Packing (2014) by jlarocco on Friday August 05, 2016 @03:14PM (#12235037)
No.

A huge and important use of structs is to communicate with other things, like hardware, libraries, and other languages, and in in those cases it's very important that the struct matches what the other side expects. You don't want the compiler to rearrange your TCP packet, for example.

It might make sense to have a compiler extension to optimize packing for internal-only data structures, but I doubt any compilers bother. It's just another entry on the long list of things that C assumes the programmer will do themselves if it's important to them.

Re:The Lost Art of C Structure Packing (2014) by superuser2 on Friday August 05, 2016 @02:58PM (#12234927)
Structs get written directly to disk and network. Copies of the same program would produce different output depending on the optimization strategy they were compiled with. That's vigorously not allowed.
Re:The Lost Art of C Structure Packing (2014) by kazinator on Friday August 05, 2016 @04:52PM (#12235671)
Also, the translation unit compilation model of C would be troublesome here, if optimization settings could influence struct layout. You can't have different translation units interpreting the same struct type declaration differently.
Re:The Lost Art of C Structure Packing (2014) by maccard on Friday August 05, 2016 @06:52PM (#12236223)
> You can't have different translation units interpreting the same struct type declaration differently.

Sure you can!

    // MyHeader.h  
    struct MyStruct {  
    int A;  
    char b;  
    int* c;  
    };

    // A.cpp  
    #include "MyHeader.h"

    <...>

    // B.cpp  
    #pragma pack(push, 16)  
    #include "MyHeader.h"  
    #pragma pack(pop)

    <...>
Re:The Lost Art of C Structure Packing (2014) by gaius on Friday August 05, 2016 @01:57PM (#12234434)
What if your struct is actually a memory-mapped I/O device? Far from optimizing you need to give a hard guarantee that it will NEVER be optimized by the compiler.
Re:The Lost Art of C Structure Packing (2014) by kazinator on Friday August 05, 2016 @02:36PM (#12234774)
Suppose C didn't require order of struct members. How could we support I/O devices? Simply by wrapping them behind functions or macros which take a base address and access a specific register relative to that address using pointer arithmetic and dereferencing. You see this being done anyway!

    if ((SERIAL_STATUS_PORT(port_addr) & SERIAL_DTR) != 0) {
      /* DTR line is asserted */
    }
Re:The Lost Art of C Structure Packing (2014) by gaius on Friday August 05, 2016 @04:21PM (#12235480)
More likely you'd have to drop down into ASM for those bits...

You see in a lot of high performance networking code too, you just get a block of bytes off the wire, cast it to a struct and use it straight away. High risk, high reward :-)

Re:The Lost Art of C Structure Packing (2014) by Grishnakh on Friday August 05, 2016 @02:38PM (#12234789)
Well if we were making an all-new C-like language, we could just add a compiler directive which prevents optimization for cases like this.

For all I know, other languages may do just this (there's a comment farther down about Rust which appears to say this).

Re:The Lost Art of C Structure Packing (2014) by MaulingMonkey on Friday August 05, 2016 @05:35PM (#12235893)
Aside from the ABI, file I/O, and memory mapping concerns voiced by others, it's also not always a performance optimization: Occasionally you really want two members of a struct to e.g. reside in different cachelines to avoid "false sharing" murdering your performance in multithreaded code (where multiple cores repeatedly fight over who owns / can update the cacheline in question.)

Modern compilers all have warnings you can opt into, to alert you when the compiler inserts implicit padding, if you want to ensure things get packed nicely.

Re:The Lost Art of C Structure Packing (2014) by marmaduke on Saturday August 06, 2016 @04:11PM (#12239681)
> false sharing

I wasn't aware of that sort of thing. any resources on learning these sorts of details of performance tuning, aside from hard-earned experience?

Re:The Lost Art of C Structure Packing (2014) by MaulingMonkey on Saturday August 06, 2016 @09:17PM (#12240632)
I mostly just vacuum up a huge amount of material from as many sources as I can. My focus on game development might help here. A lot of it flows from understanding CPUs from a low level hardware perspective - you might be able to reverse engineer this kind of knowledge from the wikipedia articles, although I haven't tried doing so myself.

E.g. the page for "CPU cache" references:

- CPUs read/write by cacheline

- Caches need to coordinate to avoid stale data through "cache coherence protocols" (which have a cost as mentioned on their own wiki page)

"False sharing" is just the interplay of those two mechanisms in worst case scenarios and such corner cases.

About the only time I've used this knowledge of false sharing has been when implementing a work-stealing task queue system. And I suppose the few times I've written a parallel for loop of some description.

Trying to think of similar performance issues to guide you towards, a few come to mind:

1) CPU caches are basically implemented as fixed sized hashmaps with a really poor hash - the address modulo some power of two, with a fixed limit of collisions supported.

http://www.lshift.net/blog/2013/10/08/cpu-cache-collisions-i...

I've never actually used this knowledge, although I could see it coming up if I were working on the design of a database's in-memory storage or something.

2) Reading "write combined" memory is really bad, including implicitly reading by failing to write entire cachelines (comes up with GPU resources such as textures)

https://fgiesen.wordpress.com/2013/01/29/write-combining-is-...

This one I'm mindful of whenever I'm porting programs to use new graphics APIs, or writing the low level systems that deal with them in the first place. I feel there's at least one more situation where write combined memory has come up for me in practice (since typical memory access is not write combined), but it escapes me at the moment. Fortunately most graphics API docs at least warn you not to read the memory they're pointing you towards, although they're not always as explicit as "memcpy entire cachelines from orbit, just to be sure."

3) Performance of atomics touching multiple cachelines is terrible, when it's even supported:

https://fgiesen.wordpress.com/2014/08/18/atomics-and-content...

Normally I find out that this has been happening when I port a program to ARM and suddenly it crashes doing some kind of atomic operation or lock, because someone reinterpreted a char buffer instead of allocating properly, because cross-cacheline atomics are too crazy for ARM to bother implementing. Things like SSE and AVX also tend to perform... not so great, unless stuff is properly aligned for them.

EDIT: I guess fgiesen is one resource, at least, as it cropped up twice trying to google for sources for the things I'm talking about ;)

Re:The Lost Art of C Structure Packing (2014) by marmaduke on Thursday August 18, 2016 @03:06AM (#12310855)
Thanks for the details!
Re:The Lost Art of C Structure Packing (2014) by cdavid on Friday August 05, 2016 @01:00PM (#12233935)
The compiler can't optimize this in general as this affects the ABI when the struct itself is exposed (that's one of the reason why it is useful to avoid exposing struct themselves but just pointer when you can).
Re:The Lost Art of C Structure Packing (2014) by dalailambda on Friday August 05, 2016 @01:01PM (#12233939)
A lot of systems code involves directly messing with the memory of a specific struct, and if a compiler moved the struct fields around with the programmer knowing, there would be a lot of memory problems.
Re:The Lost Art of C Structure Packing (2014) by easytiger on Friday August 05, 2016 @04:58PM (#12235720)
Then the memory layout of the struct will be different. So when you serialise it read it back it would be different, if you perhaps used a different non optimising compiler.
Re:The Lost Art of C Structure Packing (2014) by throwanem on Friday August 05, 2016 @01:32PM (#12234195)
> reverse descending order

...so, ascending order?

Re:The Lost Art of C Structure Packing (2014) by blaisio on Friday August 05, 2016 @02:31PM (#12234737)
What they mean is put the largest fields at the top and the smallest fields at the bottom.
Re:The Lost Art of C Structure Packing (2014) by throwanem on Friday August 05, 2016 @02:32PM (#12234748)
So, descending order.
Re:The Lost Art of C Structure Packing (2014) by vonmoltke on Friday August 05, 2016 @12:47PM (#12233783)
> The worst that you will get is padding at the end of the structure so that if two or more of them are arrayed, the first member is correctly aligned at all the array indices.

This is not guaranteed. If you want to ensure all array member starting addresses are aligned for all compilers and platforms you need to add explicit dead space. You should also be using the fixed-width numeric types.

Re:The Lost Art of C Structure Packing (2014) by kazinator on Friday August 05, 2016 @02:18PM (#12234626)
It's not guaranteed (as in "money back" or whatever). It's merely required by ISO C for conformance.

If a struct is declared like this:

   struct foo {
     whatever_type_t first_member;
     // ...
   };
then an array of this type can also be declared:

    struct foo farray[42];
A conforming ISO C implementation has to ensure that farray[1].first_member, and farray[2].first_member, and so on, are all allocated such that they meet the alignment requirements fro whatever_type_t. It cannot be that farray[0].first_member is accessible, but farray[1].first_member throws an alignment exception or whatever. Programmers should not have to do anything to ensure this.

So, if necessary, padding is added at the end of struct foo to make this alignment happen.

In practice, compilers add the padding even if it's not required for at least two reasons: performance (misaligned accesses, though supported, may be slow) and compatibility (having the structure look the same across multiple architectures supported by the same compiler, at most modulo byte order).

> You should also be using the fixed-width numeric types.

I'm not aware that C provides any other, currently. Though you can simulate them with libraries, of course.

Re:The Lost Art of C Structure Packing (2014) by yuubi on Friday August 05, 2016 @03:53PM (#12235302)
> fixed-width numeric types

uint32_t and friends instead of the implementation-defined unsigned int/long.

See http://pubs.opengroup.org/onlinepubs/007904975/basedefs/stdi... for many details (including things like the name for "the fastest signed integer type with at least 8 bits", which could be signed char on machines that support byte access in hardware and signed 32-bit on machines where byte addressing means loading a word, bit-bashing the new value in, and storing it back).

Re:The Lost Art of C Structure Packing (2014) by david-given on Friday August 05, 2016 @02:41PM (#12234810)
I agree with you, but it'd be nicer if it were easier to figure this out from the standard --- either I'm missing something or else you have to infer it from reading between the lines:

6.7.2.1 para 15 of the C11 standard:

Within a structure object, the non-bit-field members and the units in which bit-fields reside have addresses that increase in the order in which they are declared. A pointer to a structure object, suitably converted, points to its initial member (or if that member is a bit-field, then to the unit in which it resides), and vice versa.

6.7.2.1 para 17:

There may be unnamed padding at the end of a structure or union.

6.2.5 para 20:

An array type describes a contiguously allocated nonempty set of objects with a particular member object type, called the element type.

http://www.open-std.org/jtc1/sc22/WG14/www/docs/n1570.pdf

So, on a platform with strict alignment, in order to achieve contiguous packing of structures (required by the last) and to achieve each structure member having a valid pointer (required by the first) the implementation must add enough optional padding (allowed by the middle) to make the size of the structure aligned.

> You should also be using the fixed-width numeric types.

I believe the parent is referring to the int8_t, int16_t types rather than the implementation-defined int, short, long types here.

Re:The Lost Art of C Structure Packing (2014) by vonmoltke on Friday August 05, 2016 @03:05PM (#12234981)
> I agree with you, but it'd be nicer if it were easier to figure this out from the standard --- either I'm missing something or else you have to infer it from reading between the lines:

> So, on a platform with strict alignment, in order to achieve contiguous packing of structures (required by the last) and to achieve each structure member having a valid pointer (required by the first) the implementation must add enough optional padding (allowed by the middle) to make the size of the structure aligned.

It's not in the standard per se. It's a requirement for machine code to function on certain platforms. The standard basically just says that in all cases compilers have to generate machine code that works properly. It is imposed by the designers of the processor, not the C standard.

> I believe the parent is referring to the int8_t, int16_t types rather than the implementation-defined int, short, long types here.

This is indeed what I was talking about.

Re:The Lost Art of C Structure Packing (2014) by vonmoltke on Friday August 05, 2016 @02:59PM (#12234929)
> A conforming ISO C implementation has to ensure that farray[1].first_member, and farray[2].first_member, and so on, are all allocated such that they meet the alignment requirements fro whatever_type_t. It cannot be that farray[0].first_member is accessible, but farray[1].first_member throws an alignment exception or whatever. Programmers should not have to do anything to ensure this.

The alignment requirement is platform-dependent. Some platforms can perform unaligned loads, which means an object can be allocated at any byte offset in memory. There are no requirements in the C standard for alignment other than conforming to the specific hardware.

> In practice, compilers add the padding even if it's not required for at least two reasons: performance (misaligned accesses, though supported, may be slow) and compatibility (having the structure look the same across multiple architectures supported by the same compiler, at most modulo byte order).

Yes, and in practice this depends on the compiler and the platform, which was my point.

> I'm not aware that C provides any other, currently. Though you can simulate them with libraries, of course.

None of the numeric types enumerated in the standard have a fixed size associated with them in the C standard[1]. They have minimum representation ranges, but that is it.

[1] I'm not counting IEEE754 floating-point types, since that is a standard imposed on the C standard itself.

Re:The Lost Art of C Structure Packing (2014) by vonmoltke on Friday August 05, 2016 @05:18PM (#12235813)
I like how I'm getting downvoted, yet nobody is telling me how I'm wrong.
Re:The Lost Art of C Structure Packing (2014) by blaisio on Friday August 05, 2016 @02:32PM (#12234749)
Can you give an example of a compiler and platform where this isn't true? I thought it was part of the standard, and I've never seen C code that didn't make the assumption that this is true.
Re:The Lost Art of C Structure Packing (2014) by vonmoltke on Friday August 05, 2016 @03:01PM (#12234950)
IIRC, icc does not normally pad structures, since x86-64 supports unaligned loads fairly well. xlc on POWER generally tries to do what kazinator stated above because unaligned loads are expensive, if even possible, on those platforms.
Re:The Lost Art of C Structure Packing (2014) by Grishnakh on Friday August 05, 2016 @01:50PM (#12234369)
Wouldn't it make sense for the compiler to automatically optimize stuff like this? The compiler knows all about the underlying architecture the code will be running on, so it's best positioned to determine how to order data for optimal efficiency.
Re:The Lost Art of C Structure Packing (2014) by to3m on Friday August 05, 2016 @01:54PM (#12234406)
The C rules don't permit it. Putting fields in the order specified is not the worst possible default.

(The option would be nice, though... most of the time, you don't care.)

Re:The Lost Art of C Structure Packing (2014) by nwmcsween on Friday August 05, 2016 @02:38PM (#12234793)
No as you might be poking hardware and having the compiler at best make something not work or at worst brick hardware is not good. Compilers can earn on padding, most with -Wpadding