mikeash.com: just this guy, you know?

Posted at 2013-08-02 15:01 | RSS feed (Full text feed) | Blog Index
Next article: Friday Q&A 2013-08-16: Let's Build Dispatch Groups
Previous article: Friday Q&A 2013-06-28: Anatomy of a Compiler Bug
Tags: c fridayqna
Friday Q&A 2013-08-02: Type-Safe Scalars with Single-Field Structs
by Mike Ash  

Welcome back, and apologies for going silent without warning. Something resembling normality has resumed, and so I hope to also resume something resembling my normal schedule. In any case, for today's article, local reader Michael Manesh suggested that I talk about how you can use (or abuse) C's type system to obtain stronger typing guarantees by creating structs containing only a single field.

C's typedef facility is tremendously useful for turning primitives into more semantic types, and a typical C program will be full of them. Even if you never write them yourself, you typically inherit a ton of them from system frameworks and the like. For example, Cocoa gives you types like NSTimeInterval, NSInteger, and CGFloat.

However, the typedef facility is weak. It doesn't produce a new type, but rather it just creates a new name for the existing type. For example, NSTimeInterval is declared as:

    typedef double NSTimeInterval;

This means that an NSTimeInterval is just a double. They're two names for the same thing.

Sometimes that's exactly what we want. The whole point of NSInteger is just to be either an int or a long depending on architecture. Likewise, CGFloat just exists to give you either a float or a double depending on architecture.

NSTimeInterval is a different beast. Conceptually, it's not just a double, but a double representing a number of seconds. You might write this:

    NSTimeInterval interval = 5.0; // five seconds

But you probably wouldn't write this:

    NSTimeInterval interval = [view frame].size.width;

It's possible that you just happen to want an interval that's equal to the width of a view, interpreted as seconds. However, it's not very likely. It would be nice if the type system could notice that you're trying to assign a float or double to a NSTimeInterval and call this out as being wrong. Unfortunately, typedef can't do this, because NSTimeInterval is a double in the end.

An interesting feature of C structs is that structurally-identical structs are still different types. For example, given this:

    struct Foo { int x, y; };
    struct Bar { int x, y; };

This will not compile:

    struct Foo foo;
    struct Bar bar = foo;

Despite the fact that foo and bar have identical contents, they have different types, the compiler won't convert between the two.

This fact gives us the tool we need to create new types rather than simply creating new names for existing types.

Single-Field structs
The idea is simple. Rather than define a time interval using typedef, define it with a struct that contains a single element:

    typedef struct MATimeInterval {
        double seconds;
    } MATimeInterval;

This still uses typedef, of course, but just as a convenience, so that we can write the type as MATimeInterval instead of struct MATimeInterval.

The fact that it's a struct has some syntactic consequences which makes the code more verbose. While this is a minor disadvantage over a plain typedef, it's also an advantage in that it makes code more explicit. For example, you can no longer write something like this:

    MATimeInterval interval = 5;

Instead, you need some braces:

    MATimeInterval interval = { 5 };

Using field initializers, you can make it more explicit:

    MATimeInterval interval = { .seconds = 5 };

This way there's no doubt what unit of time is being used.

When passing a value to a function or method that takes a MATimeInterval as a parameter, you can no longer just pass a number. Instead, you can use C's compound literals syntax:

    [obj methodThatTakesATimeInterval: (MATimeInterval){ 5 }];

It can also be nice to make a helper function:

    MATimeInterval MATimeIntervalMakeSeconds(double seconds)
        return (MATimeInterval){ seconds };

    [obj methodThatTakesATimeInterval: MATimeIntervalMakeSeconds(5)];

One advantage of this, aside from slightly better syntax, is that you can make functions that take other units of time as well:

    MATimeInterval MATimeIntervalMakeMinutes(double minutes)
        return MATimeIntervalMakeSeconds(minutes * 60);

    [obj methodThatTakesATimeInterval: MATimeIntervalMakeMinutes(5)];

A major disadvantage of the struct approach is that it makes arithmetic much messier. For example, instead of this:

    NSTimeInterval delta = a - b;

You get something like this:

    MATimeInterval delta = MATimeIntervalMakeSeconds(a.seconds - b.seconds);

I think the benefits are well worth it even so. If this sort of thing is a common operation, you can make a helper function:

    MATimeInterval MATimeIntervalDelta(MATimeInterval a, MATimeInterval b)
        return MATimeIntervalMakeSeconds(a.seconds - b.seconds);

This hides the details of the calculation and makes the calling code a bit nicer:

    MATimeInterval delta = MATimeIntervalDelta(a, b);

Unit Interplay
Once you start doing this, you can come up with interesting helper functions that manipulate multiple types. For example, let's also create distance and velocity types:

    typedef struct MADistance {
        double meters;
    } MADistance;

    typedef struct MAVelocity {
        double metersPerSecond;
    } MAVelocity;

You can then write a nice function that takes a distance and a time and produces a velocity:

    MAVelocity MAVelocityFromDistanceAndTime(MADistance dist, MATimeInterval time)
        return (MAVelocity){ .metersPerSecond = dist.meters / time.seconds };

    MATimeInterval t = ...;
    MADistance d = ...;
    MAVelocity v = MAVelocityFromDistanceAndTime(d, t);

The function implementation is explicit and clear, with all the units spelled out, and the calling code is direct and to the point.

Runtime Costs
When replacing a bunch of simple primitives with structs, it's natural to be worried about the runtime costs. An int or a double can fit into a register and be directly manipulated with machine instructions, but a struct must require more work to load and unload the values within.

The good news is that this is not the case. It would be true if we were using, say, full-fledged Objective-C objects, but structs are sufficiently low-level that they can be completely optimized away. The compiler is able to treat each element of a struct as a separate value:

    struct Foo {
        int a;
        long b;
        double c;

    struct Foo foo;
    foo.a = 42;
    foo.b = 99;
    foo.c = 3.14;

As long as you don't take the address of foo, the compiler is free to rearrange the storage at will. It can put a, b, and c into individual registers. It can even eliminate or short-circuit the assignments altogether if circumstances allow. Take this function for example:

    CGFloat f(void)
        CGSize s = { 12, 34 };
        return sqrt(s.width * s.width + s.height * s.height);

You might expect this to allocate 16 bytes on the stack (two double components in the CGSize, when targeting x86-64), then perform two multiplies, a subtraction, and finally a call to sqrt(). Here is the code that clang produces when compiling this function with optimizations:

        movq  %rsp, %rbp
        movsd LCPI0_0(%rip), %xmm0
        popq  %rbp

        .quad 4630271179615950904     ## double 3.605551e+01

It's able to peel away the struct and precalculate the entire expression, so that the executed code does nothing but returning that precalculated value.

There's never a case where a single-field struct can't be treated as being the same as the field it contains at runtime. Manipulating the struct to get or set the value inside becomes free. Even passing them as parameters to methods or returning them from methods imposes no additional overhead compared to using the underlying type directly, at least on any architecture we're likely to encounter. The field access ends up as nothing more than compile-time syntax.

The C type system is fairly weak, and the common technique of using typedef to produce new type names makes it easy to mix up values of different conceptual types in code. The struct keyword creates an entirely new type which can be used to avoid this, allowing the compiler to enforce the difference between your types. The resulting code becomes more verbose, which can be good or bad, depending on your perspective and situation. While constantly packing and unpacking structs can be a pain, wisely chosen field names can help make it more obvious just what kind of values the code is working with.

That wraps it up for today! Come back next time for more craziness. Friday Q&A is driven by reader suggestions, so if you have a topic you'd like to see covered that next time, or some time after that, please send it in!

Did you enjoy this article? I'm selling a whole book full of them. It's available for iBooks and Kindle, plus a direct download in PDF and ePub format. It's also available in paper for the old-fashioned. Click here for more information.


Chong at 2013-08-04 23:31:52:
In ios, if return value is a struct, the caller will prepare a buffer for the struct, and pass the buffer pointer as first argument for return value. This is a bit less efficient than returning a primitive type.

In x86, there is no such issue. If struct size <= 8 byte, the return value will be put in eat:edx(32bit).

mikeash at 2013-08-05 14:28:57:
That is mostly not true, although you are correct for some cases. To quote the ABI:

A Composite Type not larger than 4 bytes is returned in r0.

However, you do get different behavior for 64-bit primitives (e.g. double or long long). When returned directly, they are returned in r0 and r1, while a struct containing one of those types is returned using the caller-provided buffer as you say.

mvc at 2013-08-15 13:19:35:
nice - this methodology reminds me of the win32 STRICT define creating single field structs for HWND, HDC etc.

Magnus at 2013-08-21 11:50:00:
One case where this fails, though, is when you want to return a pointer from a function: using plain values you can do

int global_which_needs_to_be_a_plain_int;
int* get_value_ref(void)
  return &global_which_needs_to_be_a_plain_int;

but you cannot do

int global_which_needs_to_be_a_plain_int;
struct foo {
  int i;
struct foo* get_value_ref(void)
  return &(struct foo){global_which_needs_to_be_a_plain_int};

since that returns a pointer to a stack local.

Aristotle Pagaltzis at 2013-08-28 23:40:07:

Well yes, you’re not taking the address of the global, you’re initialising a newly constructed struct with its value, so the address is necessarily going to be on the stack.

But on any compiler that produces identical code for accesses to plain ints as for accesses to single-int-member structs, you should be able to get away with a (foo*)&global_which_needs_to_be_a_plain_int cast.

Steven Stewart-Gallus at 2013-09-03 00:10:12:
Can't you just get the address of the member? Also inconsistent ABI specifications really, really bother me.

#include <stdio.h>

typedef struct {
    unsigned seconds;
} time;

 time the_time = { .seconds = 4 };

const unsigned * get_the_time() {
    return &the_time.seconds;

int main() {
    return printf("The time value is %u\n", *get_the_time()) >= 0;

Aristotle Pagaltzis at 2013-09-03 01:58:54:
The task was to return a struct foo * pointing to an existing int, whereas you wrote code returning an unsigned * from a struct foo member. You missed the point entirely.

You need to somehow construct a struct foo aliased over the top of an existing int-typed variable. There seems to be no type-safe, spec-blessed way of doing this.

Magnus at 2013-09-03 11:21:18:
@Aristotle: The cast is (as I presume you know) undefined behaviour but should kind-of work for getting the return value. The (practical) problem is that you now may end up with pointers of different type pointing to the same location. Type-based alias analysis could bite you at any point after that.

Aristotle Pagaltzis at 2013-09-06 04:39:28:
Oh – yes, you are right of course. I guess that makes the answer “no can do” after all. Oh well.

Peter N Lewis at 2014-05-05 03:47:08:
What you call "field initializers " are more commonly refered to as "designated initializers". They are supported in C99, but not C++, although for this usage there is no real point it using them given there is only one field anyway. <http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html>;

For a bit of initial work, C++ can work around a lot of the failings of the structs, in that it can allow things like adding or subtracting MADistance without allowing you to add MADistance and MAVelocity, while retaining the lack of runtime overhead.

I don't use Boost myself, but it has Strong Type support <http://www.boost.org/doc/libs/1_37_0/boost/strong_typedef.hpp>;.

Nate at 2015-01-28 12:44:11:
The notion that not being able to return the address of an int in place of a struct pointer return is a PROBLEM for this technique seems to miss the point. The technique is intended to disallow treatment of different types as the same thing. That it is effective at accomplishing its intended purpose is a demonstration of its effectiveness, not its deficiency.

Comments RSS feed for this page

Add your thoughts, post a comment:

Spam and off-topic posts will be deleted without notice. Culprits may be publicly humiliated at my sole discretion.

Web site:
Formatting: <i> <b> <blockquote> <code>. URLs are automatically hyperlinked.
Code syntax highlighting thanks to Pygments.
Hosted at DigitalOcean.