OMG: Our Machinery Guidebook

OMG: Our Machinery Guidebook(ourmachinery.com)

94 points by onekorg 6 years ago | 29 comments

Aardappel 6 years ago |

Generally a wonderful set of minimalistic rules, much could carry over beyond C.

Except for: "OMG-API-3: Unsigned integers are preferred over signed".. I feel they're on the wrong side of history with this one.

"Prefer unsigned" only works if you can do 99% of your codebase this way, which, besides LLVM, probably doesn't work for anyone. Having a codebase that is 99% signed is much more feasible. The worst is a codebase with plenty of both, which will be guaranteed endless subtle bugs and/or a ton of casts. That's what they'll end up with.

Apparently the C++ committee agrees that size_t being unsigned was a huge mistake (reference needed), and I would agree. Related discussion: https://github.com/ericniebler/stl2/issues/182 https://github.com/fish-shell/fish-shell/issues/3493 https://wesmckinney.com/blog/avoid-unsigned-integers/

Even LLVM has all this comical code dealing with negative values stored in unsigneds.

The idea that you should use unsigned to indicate that a value can't be negative is also pretty arbitrary. Your integer type doesn't represent the valid range of values in almost all cases, enforcing it is an unrelated concern.

flohofwoe 6 years ago | |

I can see where they're coming from, signed integers come with all sorts of caveats in C and C++ from overflow being undefined behaviour (yet modulo-math often makes sense when integers are used as array indices) to bit twiddling surprises. "Almost always unsigned" sounds like a good rule to me to avoid such pitfalls, especially when 'common math stuff' is usually done with floats or special fixed-point formats.

Aardappel 6 years ago | | |

Overflow being UB is not something you run into easily with typical math, index and size uses (not as often as your run into unsigned issues, in my experience). Yes, bit-twiddling should be unsigned, but it is very easy to make this code isolated, and convert from signed values storing these bits, if necessary.

But I am going to defer to authority here: http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p142...

niklasgray 6 years ago | |

We actually had a debate about this. I was initially in favor of "signed as default", but I acquiesced.

In retrospect, I think I was wrong and that "unsigned as default" works better.

I think the domain is important here. We're building a game engine, so there's actually plenty of bit fiddling. We also make use of the "overflow wraparound" of unsigneds in a lot of places.

I think in our case having 99 % unsigned is more feasible than having 99 % signed. There are actually not many things that we would need to use a signed integer for.

FYI, in our codebase right now we have

10038 uint32_t 123 int32_t 7843 uint64_t 58 int64_t

So at the moment we're actually 98.998 % unsigned.

I know it's not 99 %, but it's pretty close :)

Aardappel 6 years ago | | |

Well, you have the facts to back it up, so indeed it can work for you. I'd say it requires quite some commitment to push it that far though, and I still would think it's not the right default for almost all teams. Impressive you made it work :)

gumby 6 years ago | |

I actually like the distinction between std::size_t/std::ptrdiff_t (and even better std::vector's ::size_type and difference_type ). It makes the intent very clear.

It helps that I get to compile all my code -Wconversion.

vietjtnguyen 6 years ago |

Quick typo under OMG-CODEORG-2:

    #pragma once

    #ifdef __cpluspus // <-- should be __cplusplus
    extern "C" {
    #endif

    #include "api_types.h"

    // ...

    #ifdef __cplusplus
    }
    #endif

Can't say I'm a fan of OMG-CODEORG-3, however, it sounds like compilation time is a key metric for them.. I prefer a John Lakos style "physical components" set up which emulates a type-as-module inclusion style. At least OMG-CODEORG-3 clearly states that include order becomes important as a result.

bradknowles 6 years ago |

NB: For those who are not aware, ourmachinery.com is a game engine development company.

mwcremer 6 years ago |

I.e., use a double parameter that specifies seconds, instead of an uint32_t that specifies milliseconds.

This can have surprising and sometimes unpleasant consequences; see https://0.30000000000000004.com

United857 6 years ago | |

Better yet, use std::chrono. Yes, it's C++. But this is an example of how properly applied bits from C++ can make things easier to reason about and type-safe, rather than "let's avoid C++ as much as possible".

No ambiguity for the programmer as to what the underlying units are, and no unnecessary int/float conversions. All the book-keeping and conversions are taken care of by the compiler with zero run-time size or perf overhead.

flohofwoe 6 years ago | | |

std::chrono is a terribly overengineered API even for the STL, and many game companies have banned parts or all of the STL for good reasons (usually not std::chrono related though).

Using an uint64_t (instead of uint32_t or double) to carry "opaque ticks", and a handful conversion function to convert to real-world time units is fine and just a few lines of code.

chrisseaton 6 years ago | |

What practical problems do you think this could cause in specifying or measuring time?

bobdobbs666 6 years ago | | |

The patriot missile system tended to miss due to numerical error accumulated due to using floats to count time.

http://www-users.math.umn.edu/~arnold//disasters/patriot.htm...

boterock 6 years ago | |

it would still be an offset much less than the loss of precision by storing int milliseconds. There are also some techniques for dealing with the time inaccuracies, although I feel those aren't widely known.

mistrial9 6 years ago |

the layout and typesetting on this looks good in Firefox 70!

view-source:https://ourmachinery.com/files/guidebook.md.html

corysama 6 years ago | |

Formatted by http://casual-effects.com/markdeep/

Animats 6 years ago |

Objects as structs with function pointers? 1990 is calling. I'm not a huge C++ fan, but trying to emulate C++ concepts in C is kind of lame at this late date.

bobdobbs666 6 years ago | |

This is pretty much the standard way to write ABI compatible plugin interfaces in C that can be easily bound to multiple other languages.

rootlocus 6 years ago | |

Just goes to show C++ failed the zero overhead principle.

Animats 6 years ago | | |

If you don't have virtual functions, a C++ object is just an struct associated with static function links.

cjwoodall 6 years ago | | |

So sad that it did...

rootlocus 6 years ago |

OMG-DESIGN-4: Explicit is better than implicit

Ahh, straight out of the zen of Python!

    $ python -c "import this"

michaelcampbell 6 years ago | |

Django: "hold my beer"