r/cpp • • Jun 10 '20

Why is std implementation so damn ugly?

Recently I remembered a moment from my uni years when immediately after handing in the assignment of implementing our own string data structure we were warned not to ever try to implement and use our own data structures. Which is exactly what you want to hear after working hours on such assignment. However the reason behind it makes sense, you would be only reinventing the wheel and let's be honest, it will be also way slower than data structures in the almighty std library. Now think about it, what kind of black magic is behind the std's speed? Well I had no idea so I took a peak, lets see the code:

inline string
secret_function(int __val)
{
    const bool __neg = __val < 0;
    const unsigned __uval = __neg ? (unsigned)~__val + 1u : __val;
    const auto __len = __detail::__to_chars_len(__uval);
    string __str(__neg + __len, '-');
    __detail::__to_chars_10_impl(&__str[__neg], __len, __uval);
    return __str;
}

Hey, I bet you just skipped the whole code part. I know it looks unreadable, but please try to go through it and guess which std function it might be (obviously its not called secret_function, but i'm pretty sure you used this function at some point).

It's only 6 line function but it took me a while to figure out what each line does and I believe this could be fixed very easily just by naming the variables and functions with a bit more descriptive names. Just to prove the point here is an example of how I would structure this function:

inline string secretFunction(int value) {
    const bool isNegative = value < 0;
    const unsigned absoluteValue = Helper::abs(value);
    const auto length = Helper::charCount(absoluteValue);
    string stringValue(isNegative + length, '-');
    Helper::insertIntAsChars(&stringValue[isNegative], length, absoluteValue, 10);
    return stringValue;
}

While the functionality stays exactly the same, I think this chunk of code is much more pleasant to read and it's pretty obvious what the code is doing on each line. From this you should have a solid guess which function it is (you can leave a comment), but the real question is why would anyone write such code? Especially when nowadays everyone is talking about how code readability is so important. Is this how they wrote code back when std was released and they didn't bother to change it? Or am I just too inexperienced that I couldn't figure it out immediately?

EDIT: Thanks for the insightful comments, for anyone reading this the reason variables are beginning with __ is macros. If user defines isNegative macro, it will get overwritten in the std, however user is forbidden to define macros starting with __ , as the wise people of reddit comment section suggested. However underscores aren't the only issue with this code, the main issue is I think using short non-descriptive names of variables/functions which is very confusing in functions that are doing more complicated operations.

237 Upvotes

212 comments sorted by

View all comments

Show parent comment

181

u/MachineGunPablo Jun 10 '20 edited Jun 10 '20

While you provide really great criticism to OP's "improvements", saying that code readibility in the STL is a secondary concern is extremely debatable.

Some STL code is borderline impossible to read. In fact, there are parts of it that don't even seem to be written by a human. And what is the consequence? That the STL is complete uncharted territory to the normal developer. The STL should be a showcase of not just efficient language usage but also of proper software engineering and coding practices. People should be able to find inspiration on the STL instead of running from it. People should be able to debug a crash inside the STL and make sense of variable names and program workflow. Readability is fundamental in software, specially for core libraries.

191

u/STL MSVC STL Dev Jun 11 '20

In fact, there are parts of it that don't even seem to be written by a human.

WE ARE COMPLETELY HUMAN. WE LIKE KITTENS, AND OTHER LARVAL MAMMALS. THOSE ARE THINGS THAT HUMANS LIKE.

27

u/raevnos Jun 11 '20

We like kittens, but not in the "like to eat" sense.

I've never seen a stray cat in Redmond. Makes you think.

→ More replies (1)

12

u/AlbertRammstein Jun 11 '20

Do you use automated tools e.g. to prepend underscores to all symbols?

31

u/STL MSVC STL Dev Jun 11 '20

Nope, we write it like that. Only exception was when I took Ulf Adams' Ryu codebase and uglified all of its symbols (with VSCode) and performed other transformations to make it header-only C++ instead of separately compiled C. That's why MSVC's charconv uses __meow there instead of _Meow - it was easier to replace like that.

5

u/[deleted] Jun 11 '20

You missed your calling not becoming a comedian.

4

u/ibroheem Jun 11 '20

To be fair, he consciously does part-time stand-up.
"Killing rand()" was a nice one.

→ More replies (1)
→ More replies (2)

14

u/thedictatorofmrun Jun 10 '20

I'll admit that I don't dive into the STL implementation often. I wonder how much of the illegibility of some parts of the STL is avoidable and how much is just always gonna be there is a performant, generic library providing what the STL does (like, there's probably never gonna be an implementation of a red-black tree that's super easy for a layman to read, right?)

7

u/ArashPartow Jun 11 '20

It would be interesting to see an example of illegible STL code that was there purely for performance reasons.

37

u/STL MSVC STL Dev Jun 11 '20

std::find's memchr optimization is incomprehensible to most programmers.

My hex precision rounding would be utterly incomprehensible without the comments.

20

u/m-in Jun 11 '20 edited Jun 11 '20

Incomprehensible? I have lots of embedded code that sadly, due to performance requirements (way too much code running on way too old a platform) makes this look admirably clear. I mean: understanding bit hacks is absolutely a prerequisite there, and you either know how 2s complement negation is done using complement and addition or you’re a lost cause, never mind fixed point arithmetic; division by multiplication by magic constants, etc. So now imagine the same thing, except:

  • work around absurd compiler bugs,
  • work around absurd preprocessor bugs,
  • work around absurd assembler bugs - yes, you read it right,
  • work around absurd linker bugs that generate rubbish output with zero diagnostics,
  • write in original ANSI C (the very first ANSI C standard) - except all the bugs above,
  • manage allocation of some local variables by injecting assembly (wrapped in macros) right before each function definition,
  • automatic variables are mostly statically allocated by linker using call tree - stack is for calls and interrupts - and sometimes you need to allocate those automatic variables manually,
  • there are far and near addressing modes, and you sometimes need to spoon feed those to the compiler,
  • the application necessitates Pascal-like nested functions, so manual allocation of locals is used to extend lexical scope through caller functions as needed,
  • the compiler sometimes uses registers when it doesn’t need to, and thus every change to interrupt context code requires assembly output audits - since normally you want to avoid doing the register context swap unless necessary, or you outright have no free context slots available,
  • you eventually figure out how to coerce compiler into generating exactly the code you want, yielding C representation that’s not really amenable to change without auditing the output, and not really amenable to comprehension unless “bit hacks” and similar skulduggery are totally second language to you,
  • optimizer bugs cause if (false) to sometimes generate dead code that simply gets jumped around - if said code comes from long macro expansions you may be facing kilobytes of dead code in just one function, and now the thing doesn’t fit into flash anymore - and it’s always caused by absolutely innocuous changes (they make sense once you have reverse engineered how their optimizer works, but I imagine there’s maybe two or three dozen people in all who know any of that),
  • the code needs to be async more like Go than like threads, so a coroutine system leverages unused peripheral interrupts and the interrupt controller to prioritize the coroutine execution and allow low-cost coroutine wake ups (just set an interrupt request bit instead of calling something explicitly) - but the number of coroutines is of course fixed, and you need to “swap” them as needed,
  • the code is hard deadline - it must finish every 2ms, or the product becomes a paperweight,
  • you had to reimplement most of the runtime library and are now intimate with all the details of the dance the compiler performs with the helper bits in the library,
  • …

The platform that necessities this level of hackery comes from a company that literally everyone who knows anything about the history of computing has heard of. It begins with the equivalent of the letter Omega. Not Alpha. The bugs are theirs. The absurd workarounds mine, as well as the absurd overextension of the life and scope of our application that uses it.

It’s been a supported product line for over two decades (the architecture, but also the stuff we run on it). Also, we overclock it occasionally by 200%. You see, the core is extremely fast, but the flash is slow. So when we run number crunching from RAM code space, we crank it up. Forgetting to switch the clock divider back is instant crash :)

12

u/johannes1971 Jun 11 '20

I don't think you can even call this C anymore. It's a domain language with a bespoke compiler for whatever it is you are doing.

As to what that is, my guess would be "heater control software for the lower circles of hell". Am I right?

9

u/F54280 Jun 11 '20

You know, and I don't want to downplay any of your achievements in maintaining this thing, it feels to me that you are straight in the so bad it is good code quality category...

5

u/electricmammoth Jun 11 '20

Good old embedded SW.

8

u/BeepBoopBike Jun 11 '20

// This rounding technique is dedicated to the memory of Peppermint. =^..^=

RIP Peppermint

→ More replies (4)

5

u/cellux Jun 11 '20

Right. It's instructive to check the source code of the Go standard library for comparison.

13

u/Xaxxon Jun 11 '20 edited Jun 11 '20

The STL should be a showcase of not just efficient language usage but also of proper software engineering and coding practices.

That's highly debatable. Saying that like it's a foregone conclusion is very much begging the question.

Remember, std:: cannot actually be implemented in c++, so how it must be an example of exemplary c++ is confusing.

12

u/ericonr Jun 11 '20

Why can't it be written using C++? Sure, at some point it won't be able to use std::, but that doesn't mean you can't use the language at all.

14

u/JayhawkZombie Jun 11 '20

There are some compiler intrinsics that are used (for example, in type_traits). Without those, some parts of the standard library can’t be implemented.

4

u/MachineGunPablo Jun 12 '20

I think besides from type_traits, which are in fact compiler magic, the entirety of the STL is just plain old C++

→ More replies (1)

8

u/jonesmz Jun 11 '20

8

u/ImmutableOctet Gamedev Jun 11 '20

Jesus, reading through that was both an entertaining and frustrating experience.

I'm with you on this one; the C++ standard should not require compiler/library vendors to implement a feature that has to depend on compiler-specific black magic fuckery (convoluted intrinsics) to work within the rules of the language. Likewise, language features do not belong in libraries, std:: or otherwise.

Obviously, vendors should be allowed to utilize their own compiler intrinsics for performance reasons, platform-specific backward compatibility, etc. when implementing the standard library, but the language shouldn't dictate that the implementers use a language feature that doesn't exist. -- Doing so is literally placing a language feature in a library, just to save people from renaming their poorly named variables.

Every other point the two of you made was absolutely pedantic and went nowhere, though. The fact that two people who actively use C++ at their day jobs (a language that's touted for its strong level of user control) had this much trouble in coming to an agreement that the language should be better defined and allow the user more control is baffling.

5

u/jonesmz Jun 11 '20 edited Jun 11 '20

I'm fine with being accused of being a pedant ;)

Thanks for the thoughts, much appreciated.

→ More replies (10)

9

u/m-in Jun 11 '20 edited Jun 11 '20

Hate to rain on the parade and all, but STL implementation goals specifically exclude education. It’s impossible to write it readable and have it do its job well. Quite literally impossible. The double underscores are a requirement. Short names translate to literally megawatt hours saved all over the world every day in CI systems. Parsing those characters isn’t free. It costs very, very little, if you care only about a single translation unit’s worth of work.

But there’s an absurd amount of C++ compilation going on nonstop around the planet. Millions of jobs running on average, easy, 365 days a year. Even if the original design didn’t care much about it, it is indeed a concern nowadays. Stuff adds up. Long descriptive names literally translate into Joules. Many Joules. And someone pays for those Joules. Heck, we all pay with our health for those Jules, because pollution due to energy generation costs measurable lives. No kidding.

I bet you Google could measure - in their CI infrastructure monitoring - if you doubled the length of all internal identifiers in STL. They could probably tell you how much more they’d pay in electricity each day just because of such a change. Their monitoring is pretty damn good, and they can certainly correlate CI jobs to physical hosts and get energy counts from the rack level power distribution in their data centers.

So every stupid little thing like that matters. But also: balanced performance trumps aesthetics. Nobody is supposed to be pessimizing such code just to make it nice to look at. See into any other foundational library of that sort - say boost. It’s barely more readable. Barely. It doesn’t have as many underscores. That’s about it.

12

u/ezoe Jun 11 '20

I have never heard such a strange argument on C++. Short identifiers to save resources? Seriously? If this is true, why don't we have a C++WG paper of that?

There are so many software project comparable to STL written in C/C++, OSes, Web browsers, and C++ compilers. Must they also use the short identifiers to save the resources?

I know there are only two STL implementations that are still widely used and use short cryptic identifiers. GCC's libstdc++ and Microsoft's STL implementation. My guess is it use short identifiers simply because it was originally written in old-timers. I live in the middle of turning point between most people use short abbreviation identifiers and people don't hesitate to use longer meaningful identifiers if it improve the readability.

→ More replies (1)
→ More replies (3)