Boost C++ Libraries of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the develop branch, built from commit 2f77332407.
Prev Up HomeNext


The genesis of Outcome v1
Outcome v2
Outcome v2.1
Outcome v2.2

Outcome has had an interesting history, and it is worth summarising it here to show how a Boost library comes to life. The following recollections are by Niall Douglas, and may be faulty due to his aging memory.

The genesis of Outcome v1

The git repo began life as a “Boost.Spinlock” in June 2014 hived out of Boost.AFIO v1 where it had existed for some time as an internal library. In October 2014 I added in the original prototype Boost.Expected reference library as a git submodule, and began developing a non-allocating future<T>/promise<T> as an extension of expected<T, std::exception_ptr> as a faster, monadic future-promise was something which AFIO v1 sorely needed.

The original prototype Boost.Expected library was a large and very complex beastie. I was fortunate to be employed on a contract in late 2014 early 2015 where I saw it deployed at scale into an existing large C++ codebase. Expected was really great and powerful, but it absolutely murdered compile times in a large C++ codebase, and made LTO effectively infeasible. I also found its implementation non-conducive to implementing future-promise with it, and so I resolved to implement a much more powerful policy driven monad factory which could stamp out everything from an option<T> right through to a future-promise pair, all using the exact same basic_monad<> and therefore all with a full monadic programming API, C++ 17 continuations/monadic bind and intelligently convertible into one another. Moreover, all this needed to have an absolute minimum impact on compile times and runtime overheads, neither of which were strengths of the original prototype Boost.Expected library.

By August 2015 “Boost.Monad” was delivering on all those requirements and then some, but it lacked maturity through use in other code. Summer 2015 saw the Boost peer review of AFIO v1 which was roundly rejected. After considering the ample review feedback, it was realised that AFIO v2 would be a very different design, one no longer using futures, memory allocation nor C++ exceptions. As AFIO v2 was started from scratch and using Outcome heavily from the very beginning (every AFIO v2 API returns a result<T>), Outcome began to gain bug fixes and shed features, with the non-allocating future-promise implementation being dropped in May 2016 and a large chunk of type based metaprogramming being replaced with cleaner variable template metaprogramming in June. After CppCon 2016 in September, then began the long process of getting Outcome ready for Boost peer review in Q1 2017 which involved a repeated sequence of complete rewrites of the tutorial in response to multiple rounds of feedback from the C++ community, with at least four complete rewrites currently at the time of writing.

In parallel to all this development on Outcome, Expected went before the LEWG and entered the C++ standards track. As the WG21 meetings went by, Expected experienced a period of being stripped back and much of the complexity which had so murdered compile and link times in 2014-2015 fell away, thus the Expected proposed in P0323R1 ended up landing so close to Outcome that in January 2017 it was just a few hours work to implement Expected using the core basic_monad infrastructure in Outcome. That highly flexible policy based design which made monadic future-promise possible made it similarly easy to implement a highly conforming Expected, indeed in early 2017 Outcome’s Expected was much closer to P0323R1 than any other implementation including the LEWG reference implementation. And unlike the LEWG reference implementation, Outcome has had eighteen months of that finely tuned patina you only get when a library is in use by other code bases.

In February 2017 it became realised that the userbase really wanted a high quality expected<T, E> implementation rather than anything similar but not the same which Outcome had invented. The only just implemented Expected implementation based on basic_monad therefore took primacy. The final rewrite of the documentation before peer review submission was one which made it look like Outcome was primarily an expected<T, E> implementation with a few useful extensions like outcome<T> and result<T>. I was sad to so pivot, but it was obvious that Outcome would see far wider popularity and usage as primarily an Expected implementation.

Almost three years after its beginning, Outcome v1 finally went before Boost peer review in May 2017 which turned into one of the longest and most detailed peer reviews Boost has done in recent years, with over 800 pieces of review feedback submitted. It was by consensus rejected, with substantial feedback on what to do instead.

Outcome v2

During the very lengthy peer review, roughly three groups of opinion emerged as to what a value|error transporting class ought to look like:

1. Lightweight
A simple-as-possible T and/or E transport without any implementation complexity.
2. Medium
A variant stored T or E1 ... En where T is the expected value and E1 ... are the potential unexpected values. This implemention really ought to be implemented using C++ 17's std::variant<...> except with stronger never-empty guarantees.
3. Heavy
A full fat Either monad participating fully in a wider monadic programming framework for C++.

Peter Dimov was very quickly able to implement an expected<T, E1, ...> using his variant2 library, and thus there seemed little point in replicating his work in an Outcome v2. The lightweight choice seemed to be the best path forwards, so in June 2017 the bare minimum result<T, E> and outcome<T, EC, P> as presented in this library was built, using the same constructor design as std::variant<...>. Significant backwards compatibility with v1 Outcome code was retained, as the review had felt the basic proposed design fine.

A period of maturation then followed by porting a large existing codebase using Outcome v1 to v2, and writing a significant amount of new code using v2 to test it for unanticipated surprises and bugs. Quite a few corner cases were found and fixed. At the end of September 2017, Outcome v2 was deemed to be “mature”, and a script generated “Boost edition” made available.

All that remained before it was ready for a second Boost peer review was the documentation. This took four months to write (same time as to write the library itself!), and in January 2018 Outcome had its second Boost peer review, which it passed!

Outcome v2.1

The changes requsted during the review of v2.0 were fairly modest: result and outcome would be renamed to basic_result and basic_outcome, and a clean separation of concerns between the basic_* layer and the “convenience” layer would be created. That suited Outcome nicely, as the basic_* layer could have minimum possible header dependencies and thus minimum possible build times impact, which was great for big iron users with multi-million line C++ codebases. This also had the nice side effect of permitting both Boost and std implementations to be supported concurrently in both Outcome and Boost.Outcome.

By April 2018, v2.1 was feature complete and entered a six month period of maturation and battle hardening under its already extensive userbase. However Outcome passing its review in January 2018 had much more consequence than I could have ever expected. Unbeknownst to me, some of the WG21 leadership had interpreted the success of Outcome, and especially its divergences from WG21 Expected into a more complete substitute for C++ exception handling, as a sign that the C++ exception handling mechanism was no longer fit for purpose. It was thus proposed to remedy the standard exception handling mechanism into something much more efficient, thus rendering Outcome obsolete in future C++ standards (P0709 Zero overhead exceptions).

Concurrently to that, just before the review of Outcome 2.0, I had mooted a number of semantic and compile time performance improvements to <system_error> with the proposal that we mildly break Boost.System with improvements and see how badly real world code broke in response. This was not widely accepted at that time (though they have been since incorporated into Boost.System, and proposed defect remedies for <system_error> for C++ 23). I therefore wrote an improved <system_error2> which fixed all the problems listed at P0824 (Summary of SG14 discussion on <system_error>) and fixed up Outcome so one could use it without any system error implementation, or with the STL one or with the proposed improved one. This improved <system_error2> was then proposed as the standard library support for Zero overhead exceptions as proposed std::error.

A flurry of papers and discussion then resulted, running up to the Prague 2020 WG21 meeting where WG21 liked the library part of deterministic exceptions i.e. std::error, and wanted to see a working implementation of a compiler implementing the language part before moving further. The covid pandemic then ceased face to face meetings which deeply impacted WG21 productivity, so everything large which was not yet approved for entry into C++ 23 went on pause.

Outcome v2.2

Outcome was sufficiently popular, and widely known as the closest simulacrum of deterministic exceptions currently available in C++, that it was regularly benchmarked as such on an ‘as if’ basis by a number of people in the wider C++ ecosystem, including comparing their ‘better Outcome alternatives’ to Outcome, where invariably Outcome appeared to lose badly in various synthetic tests. Whilst any empirical measurements in the real world code never showed a statistically significant difference, it was certainly true that v2.1’s codegen in assembler was not ideal.

On the behalf of WG21, Ben Craig did some benchmarking work on Outcome v2.1 in P1886 Error speed benchmarking, where it did not perform as well as expected compared to alternatives such as returning a simple integer from a function. This led to a better_optimisation branch. The changes were felt worth merging into Outcome as v2.2.0, the first major version release since Outcome entered Boost in early 2019. To give enough time to sign post to users that these source incompatible changes were coming, all of 2020 was given over to announcement of the upcoming merge of the breaking v2.2 branch into master branch in early 2021.

In terms of codegen benefits for proposed std::error based code (i.e. code using Outcome experimental), v2.2 implements a library-based emulation of P1029 move = bitcopies, a proposed compiler enhancement which can treat some move-only types as bags of bits. This very significantly improves the appearance in assembler of experimental Outcome based code.

Last revised: September 16, 2020 at 11:58:04 +0100

Prev Up HomeNext