P2079R6
System execution context

Published Proposal,

This version:
http://wg21.link/P2079R6
Authors:
(Garmin)
(Intel)
(Intel)
Audience:
SG1, LEWG
Project:
ISO/IEC 14882 Programming Languages — C++, ISO/IEC JTC1/SC22/WG21

Abstract

A standard execution context based on the facilities in [P2300R10] that implements parallel-forward-progress to maximize portability. A set of system_context`s share an underlying shared thread pool implementation, and may provide an interface to an OS-provided system thread pool.

1. Changes

1.1. R6

1.2. R5

1.3. R4

1.4. R3

1.5. R2

1.6. R1

1.7. R0

2. Introduction

[P2300R10] describes a rounded set of primitives for asynchronous and parallel execution that give a firm grounding for the future. However, the paper lacks a standard execution context and scheduler. It has been broadly accepted that we need some sort of standard scheduler.

As part of [P3109R0], system context was voted as a must-have for the initial release of senders/receivers. It provides a convenient and scalable way of spawning concurrent work for the users of senders/receivers.

As noted in [P2079R1], an earlier revision of this paper, the static_thread_pool included in later revisions of [P0443R14] had many shortcomings. This was removed from [P2300R10] based on that and other input.

One of the biggest problems with local thread pools is that they lead to CPU oversubscription. This introduces a performance problem for complex systems that are composed from many independent parts.

Another problem that system context is aiming to solve is the composability of components that may rely on different parallel engines. An application might have multiple parts, possibly in different binaries; different parts of the application may not know of each other. Thus, different parts of the application might use different parallel engines. This can create several problems:

To solve these problems we propose a parallel execution context that:

This parallel execution context is called in this paper the system context. The users can obtain a scheduler from this system context.

2.1. Design overview

The system context is a parallel execution context of undefined size, supporting explicitly parallel forward progress.

The execution resources of the system context are envisioned to be shared across all binaries in the same process. System scheduler works best with CPU-intensive workloads, and thus, limiting oversubscription is a key goal.

By default, the system context should be able to use the OS scheduler, if the OS has one. On systems where the OS scheduler is not available, the system context will have a generic implementation that acts like a thread pool.

For enabling the users to hand-tune the performance of their applications, and for fulfilling the composability requirements, the system context should be replaceable. The user should be able to replace the default implementation of the system context with a custom one that fits their needs.

Other key concerns of this design are:

3. Examples

As a simple parallel scheduler we can use it locally, and sync_wait on the work to make sure that it is complete. With forward progress delegation this would also allow the scheduler to delegate work to the blocked thread. This example is derived from the Hello World example in [P2300R10]. Note that it only adds a well-defined context object, and queries that for the scheduler. Everything else is unchanged about the example.
using namespace = std::execution;

scheduler auto sch = get_system_scheduler();

sender auto begin = schedule(sch);
sender auto hi = then(begin, []{
    std::cout << "Hello world! Have an int.";
    return 13;
});
sender auto add_42 = then(hi, [](int arg) { return arg + 42; });

auto [i] = std::this_thread::sync_wait(add_42).value();

We can structure the same thing using on, which better matches structured concurrency:

using namespace std::execution;

scheduler auto sch = get_system_scheduler();

sender auto hi = then(just(), []{
    std::cout << "Hello world! Have an int.";
    return 13;
});
sender auto add_42 = then(hi, [](int arg) { return arg + 42; });

auto [i] = std::this_thread::sync_wait(on(sch, add_42)).value();

The system_scheduler customizes bulk, so we can use bulk dependent on the scheduler. Here we use it in structured form using the parameterless get_scheduler that retrieves the scheduler from the receiver, combined with on:

using namespace std::execution;

auto bar() {
  return
    let_value(
      read_env(get_scheduler),      // Fetch scheduler from receiver.
      [](auto current_sched) {
        return bulk(
          current_sched.schedule(),
          1,                        // Only 1 bulk task as a lazy way of making cout safe
          [](auto idx){
            std::cout << "Index: " << idx << "\n";
          })
      });
}

void foo()
{
  auto [i] = std::this_thread::sync_wait(
    on(
      get_system_scheduler(),         // Start bar on the system_scheduler
      bar()))                         // and propagate it through the receivers
    .value();
}

Use async_scope and a custom system context implementation linked in to the process (through a mechanism undefined in the example). This might be how a given platform exposes a custom context. In this case we assume it has no threads of its own and has to take over the main thread through an custom drive() operation that can be looped until a callback requests exit on the context.

using namespace std::execution;

int result = 0;

{
  async_scope scope;
  scheduler auto sch = get_system_scheduler();

  sender auto work =
    then(just(), [&](auto sched) {

      int val = 13;

      auto print_sender = then(just(), [val]{
        std::cout << "Hello world! Have an int with value: " << val << "\n";
      });

      // spawn the print sender on sched to make sure it
      // completes before shutdown
      scope.spawn(on(sch, std::move(print_sender)));

      return val;
    });

  scope.spawn(on(sch, std::move(work)));

  // This is custom code for a single-threaded context that we have replaced
  // We need to drive it in main.
  // It is not directly sender-aware, like any pre-existing work loop, but
  // does provide an exit operation. We may call this from a callback chained
  // after the scope becomes empty.
  // We use a temporary terminal_scope here to separate the shut down
  // operation and block for it at the end of main, knowing it will complete.
  async_scope terminal_scope;
  terminal_scope.spawn(
    scope.on_empty() | then([](my_os::exit(sch))));
  my_os::drive(sch);
  std::this_thread::sync_wait(terminal_scope);
};

// The scope ensured that all work is safely joined, so result contains 13
std::cout << "Result: " << result << "\n";

// and destruction of the context is now safe

To replace the implementation of system scheduler at runtime, one might do it the following way:

namespace scr = std::execution::system_context_replaceability;

struct my_system_scheduler_impl : scr::system_scheduler {

  void schedule(scr::receiver* r, scr::storage s) noexcept override {
    r->set_value();
  }
  void bulk_schedule(uint32_t n, scr::bulk_item_receiver* r, scr::storage s) noexcept override {
    for (uint32_t i = 0; i < count; ++i)
      r->start(i);
    r->set_value();
  }
};

auto old_factory = scr::set_system_context_backend_factory<scr::system_scheduler>(
  []() -> std::shared_ptr<scr::system_scheduler> {
    return std::make_shared<my_system_scheduler_impl>();
  });
...
// Use the system scheduler here
...
(void) scr::set_system_context_backend_factory<scr::system_scheduler>(old_factory);

To change the implementation of system scheduler at link-time, one might do it the following way:

namespace std::execution::system_context_replaceability {
  template <>
  extern __attribute__((__weak__))
  std::shared_ptr<system_scheduler> query_system_context<system_scheduler>() {
    return std::make_shared<my_system_scheduler_impl>();
  }
}

4. Design

4.1. User facing API

system_scheduler get_system_scheduler();

class system_scheduler { // exposition only
public:
  system_scheduler() = delete;
  ~system_scheduler();

  system_scheduler(const system_scheduler&) noexcept;
  system_scheduler(system_scheduler&&) noexcept;
  system_scheduler& operator=(const system_scheduler&) noexcept;
  system_scheduler& operator=(system_scheduler&&) noexcept;

  bool operator==(const system_scheduler&) const noexcept;

  forward_progress_guarantee query(get_forward_progress_guarantee_t) const noexcept;

  impl-defined-system_sender schedule() const noexcept;
  // customization for bulk
};

class impl-defined-system_sender { // exposition only
public:
  using sender_concept = sender_t;
  using completion_signatures = execution::completion_signatures<
    set_value_t(),
    set_stopped_t(),
    set_error_t(exception_ptr)>;

  impl-defined-environment get_env() const noexcept;

  system_scheduler query(get_completion_scheduler_t<set_value_t>) const noexcept;

  template<receiver R>
  requires receiver_of<R>
  impl-defined-operation_state connect(R&&) &
      noexcept(std::is_nothrow_constructible_v<std::remove_cvref_t<R>, R>);
  template<receiver R>
  requires receiver_of<R>
  impl-defined-operation_state connect(R&&) &&
      noexcept(std::is_nothrow_constructible_v<std::remove_cvref_t<R>, R>);
};

4.2. Replaceability API

namespace std::execution::system_context_replaceability {
  template <class-type Interface> // class-type is defined in [execution.syn]
  extern shared_ptr<Interface> query_system_context();

  // exposition only
  template <class-type Interface>
  using factory-type = shared_ptr<Interface> (*)();

  template <class-type Interface>
  extern factory-type set_system_context_backend_factory(factory-type);

  struct receiver {
    virtual ~receiver() = default;

  protected:
    // exposition only
    virtual bool unspecified-query-env(unspecified-id, void*) noexcept = 0;

  public:

    receiver(const receiver&) = delete;
    receiver(receiver&&) = delete;
    receiver& operator=(const receiver&) = delete;
    receiver& operator=(receiver&&) = delete;

    virtual void set_value() noexcept = 0;
    virtual void set_error(std::exception_ptr) noexcept = 0;
    virtual void set_stopped() noexcept = 0;

    template <class-type P>
    std::optional<P> try_query() noexcept;
  };

  struct bulk_item_receiver : receiver {
    virtual void start(uint32_t) noexcept = 0;
  };

  struct storage {
    void* data;
    uint32_t size;
  };

  struct system_scheduler {
    virtual ~system_scheduler() = default;

    virtual void schedule(receiver*, storage) noexcept = 0;
    virtual void bulk_schedule(uint32_t, bulk_item_receiver*, storage) noexcept = 0;
  };
}

5. Design discussion and decisions

5.1. To drive or not to drive

On single-threaded systems (e.g., freestanding implementations) or on systems in which the main thread has special significance (e.g., to run the Qt main loop), it’s important to allow scheduling work on the main thread. For this, we need the main thread to drive work execution.

The earlier version of this paper, [P2079R2], included execute_all and execute_chunk operations to integrate with senders. In this version we have removed them because they imply certain requirements of forward progress delegation on the system context and it is not clear whether or not they should be called. We envision a separate paper that adds the support for drive-ability, which is decoupled by this paper.

We can simplify this discussion to a single function:

void drive(system_context& ctx, sender auto snd);

Let’s assume we have a single-threaded environment, and a means of customizing the system context for this environment. We know we need a way to donate main’s thread to this context, it is the only thread we have available. Assuming that we want a drive operation in some form, our choices are to:

With a standard drive of this sort (or of the more complex design in [P2079R2]) we might write an example to use it directly:

system_context ctx;
auto snd = on(ctx, doWork());
drive(ctx, std::move(snd));

Without drive, we rely on an async_scope to spawn the work and some system-specific drive operation:

system_context ctx;
async_scope scope;
auto snd = on(ctx, doWork());
scope.spawn(std::move(snd));
custom_drive_operation(ctx);

Neither of the two variants is very portable. The first variant requires applications that don’t care about drive-ability to call drive, while the second variant requires custom pluming to tie the main thread with the system scheduler.

We envision a new paper that adds support for a main scheduler similar to the system scheduler. The main scheduler, for hosted implementations would be typically different than the system scheduler. On the other hand, on freestanding implementations, the main scheduler and system scheduler can share the same underlying implementation, and both of them can execute work on the main thread; in this mode, the main scheduler is required to be driven, so that system scheduler can execute work.

Keeping those two topic as separate papers allows to make progress independently.

5.2. Freestanding implementations

This paper payed attention to freestanding implementations, but doesn’t make any wording proposals for them. We express a strong desire for the system scheduler to work on freestanding implementations, but leave the details to a different paper.

We envision that, a followup specification will ensure that the system scheduler will work in freestanding implementations by sharing the implementation with the main scheduler, which is driven by the main thread.

5.3. Making system context replaceable

The system context aims to allow people to implement an application that is dependent only on parallel forward progress and to port it to a wide range of systems. As long as an application does not rely on concurrency, and restricts itself to only the system context, we should be able to scale from single threaded systems to highly parallel systems.

In the extreme, this might mean porting to an embedded system with a very specific idea of an execution context. Such a system might not have a multi-threading support at all, and thus the system context not only runs with single thread, but actually runs on the system’s only thread. We might build the context on top of a UI thread, or we might want to swap out the system-provided implementation with one from a vendor (like Intel) with experience writing optimized threading runtimes.

The latter is also important for the composability of the existing code with the system context, i.e., if Intel Threading building blocks (oneTBB) is used by somebody and they want to start using the system context as well, it’s likely that the users want to replace system context implementation with oneTBB because in that case they would have one thread pool and work scheduler underneath.

We should allow customization of the system context to cover this full range of cases.

To achieve this we see options:

  1. Link-time replaceability. This could be achieved using weak symbols, or by choosing a runtime library to pull in using build options.

  2. Run-time replaceability. This could be achieved by subclassing and requiring certain calls to be made early in the process.

  3. Compile-time replaceability. This could be achieved by importing different headers, by macro definitions on the command line or various other mechanisms.

Link-time replaceability has the following characteristics:

Run-time replaceability has the following characteristics:

Compile-time replaceability has the following characteristics:

The paper considers compile-time replaceability as not being a viable option because it easily breaks one of the fundamental design principles of a system context, i.e. having one, shared, application-wide execution context, which avoids oversubscription.

Replaceability is also part of the [P2900R8] proposal for the contract-violation handler. The paper proposes that whether the handler is replaceable to be implementation-defined. If an implementation chooses to support replaceability, it shall be done similar to replacing the global operator new and operator delete (link-time replaceability).

The replaceability topic is highly controversial. Some people think that link-time replaceability is the way to go; Adobe supports this position. Others think that run-time replaceability is the way to go; Bloomberg supports this latter position.

The feedback we received from Microsoft, is that they will likely not support replaceability on their platforms. They would prefer that we offer implementations an option to not implement replaceability. Moreover, for systems where replaceability is supported they would prefer to make the replaceability mechanism to be implementation defined.

The authors disagree with the idea that replaceability is not needed for Windows platforms (or other platforms that provide an OS scheduler). The OS scheduler is optimized for certain workloads, and it’s not the best choice for all workloads. This way not providing replaceability options have the following drawbacks:

The poll taken in Wrocław, Poland, November 2024, showed that the majority of the participants support mandating replaceability, as well as specifying the mechanism of replaceability and the API for replaceability.

In accordance with the feedback, and the beliefs of the authors, the paper proposes the following:

5.4. Replaceability details

To replace the system scheduler, the user needs to do the following:

The above points raise a few questions:

A quick answer to all of the above questions is "yes".

Replacing the system scheduler multiple times can be achieved with runtime replaceability. Any call to std::get_system_scheduler() will return the last system scheduler set with std::set_system_scheduler(). The call to set the system scheduler and the subsequent calls to get the system scheduler are in a happens-before relation.

Changing the system scheduler can be done after work is scheduled/started. The old work will continue to execute on the previous system scheduler. This implies that, for brief periods of time, multiple system schedulers backends may be active at the same time (possibly leading to oversubscription).

The system scheduler can be replaced outside of main(). This implies that the underlying mechanisms should use something similar to a Phoenix singleton pattern to ensure that the system scheduler is alive while there are users to it. It is allowed for the implementation to attempt to destroy the system context backend after main() returns, just to create it again if system scheduler needs to be used again.

While, in theory it is possible to replace the system scheduler both at runtime and at link-time, in practice, it is not recommended. The paper leaves it to the implementation to decide what happens when both mechanisms are used. Implementations might choose to disable runtime replaceability if link-time replaceability is used. Alternatively, implementations might choose to allow the users to start the program with a link-time replaced system context, and then replace it at runtime with a different system context.

5.5. Extensibility

The std::execution framework is expected to grow over time. We expect to add time-based scheduling, async I/O, priority-based scheduling, and other for now unforeseen functionality. The system context framework needs to be designed in such a way that it allows for extensibility.

Whatever the replaceability mechanism is, we need to ensure that new features can be added to the system context in a backwards-compatible manner.

There are two levels in which we can extend the system context:

  1. Add more types of schedulers, beside the system scheduler.

  2. Add more features to the existing scheduler.

The first type of extensibility can easily be solved by adding new getters for the new types of schedulers. Different types of schedulers should be able to be replaced separately; e.g., one should be able to replace the I/O scheduler without replacing the system scheduler. The discussed replaceability mechanisms support this.

To extend existing schedulers, one can pass properties to it, via the receiver. For example, adding priorities to the system scheduler can be done by adding a priority property to the type-erased receiver object. The list of properties that can be passed to the backend is not finite; however both the frontend and the backend must have knowledge about the supported properties.

5.6. Shareability

One of the motivations of this paper is to stop the proliferation of local thread pools, which can lead to CPU oversubscription. If multiple binaries are used in the same process, we don’t want each binary to have its own implementation of system context. Instead, we would want to share the same underlying implementation.

The paper mandates shareability, but leaves the details of shareability to be implementation-defined (they are different for each backend).

5.7. Performance

To support shareability and replaceability, system context calls may need to go across binary boundaries, over the defined API. A common approach for this is to have COM-like objects. However, the problem with that approach is that it requires memory allocation, which might be a costly operation. This becomes problematic if we aim to encourage programmers to use the system context for spawning work in a concurrent system.

While there are some costs associated with implementing all the goals stated here, we want the implementation of the system context to be as efficient as possible. For example, a good implementation should avoid memory allocation for the common case in which the default implementation is utilized for a platform.

This paper cannot recommend the specific implementation techniques that should be used to maximize performance; these are considered Quality of Implementation (QOI) details.

5.8. Lifetime

Underneath the system scheduler, there is a singleton of some sort. We need to specify the lifetime of this object and everything that derives from it.

Revision R4 of the paper mandates that the lifetime of any system_context must be fully contained within the lifetime of main(). The reasoning behind this is that ensuring proper construction and destruction order of static objects is typically difficult in practice. This is especially challenging during the destruction of static objects; and, by symmetry, we also did not want to guarantee the lifetime of the system scheduler before main(). We argued that if we took a stricter approach, we could always relax it later.

We received feedback that this was too strict. First, there are many applications where the C++ part does not have a main() function. Secondly, this can be considered a quality of implementation issue; implementations can always use a Phoenix singleton pattern to ensure that the underlying system context object remains alive for the duration of the entire program.

R5 revision of the paper relaxes the lifetime requirements of the system scheduler. The system scheduler can now be used in any part of a C++ program.

5.9. Need for the system_context class

Our goal is to expose a global shared context to avoid oversubscription of threads in the system and to efficiently share a system thread pool. Underneath the system_context there is a singleton of some sort, potentially owned by the OS.

The question is how we expose the singleton. We have a few obvious options:

In R4 and earlier revisions, we opted for an explicit context object. The reasoning was that providing explicit contexts makes it easier to understand the lifetime of the schedulers. However, adding this extra class does not affect how one would reason about the lifetime of the schedulers or the work scheduled on them. Therefore, introducing an artificial scope object becomes an unnecessary burden.

There were also arguments made for adding system_context so that we can later add properties to it, that don’t necessarily belong to system_scheduler. However, if we would later find such properties, nothing prevents us to add system_context class later, and make get_system_scheduler() return get_system_context().get_scheduler().

Thus, the paper simply proposes a get_system_scheduler() function that returns a the system scheduler. The system context is implementation-defined and not exposed to the user.

5.10. Backend environment

For custom backend implementations, it is often necessary access properties of the environment that is connected to the sender that triggers a schedule operation. Because the backend is behind a type-erased boundary, the environment that can be passed to the backend also needs to be type-erased.

We’ve added the possibility to encode environment properties in the receiver object. The backend can query the receiver for environment properties by using the try_query template method, passing the type of the property that needs querying. If the property is available, the method returns an optional with the value of the property; otherwise it returns an empty optional.

The backend can query the receiver object for the entire lifetime of the asynchronous operation (until one of the completion signals is called).

One of the implication for using types to query properties is that the exchange of environment properties needs to use concrete types, and cannot use concepts. If, for example, the backend needs to obtain a stop token, it needs to ask for a specific stop token type (like inplace_stop_token), and not for a stoppable_token concept. As another example, if the backend needs an allocator, it needs to ask for a specific allocator type, and not use simple-allocator concept.

At this point, the paper requires that only inplace_stop_token is supported by the type-erased receiver object. Other types might be supported, but it is not required.

The authors envision that the list of supported properties will grow over time.

5.11. Priorities

It’s broadly accepted that we need some form of priorities to tweak the behavior of the system context. This paper does not include priorities, though early drafts of R2 did. We had different designs in flight for how to achieve priorities and decided they could be added later in either approach.

The first approach is to expand one or more of the APIs. The obvious way to do this would be to add a priority-taking version of system_context::get_scheduler():

implementation-defined-system_scheduler get_scheduler();
implementation-defined-system_scheduler get_scheduler(priority_t priority);

This approach would offer priorities at scheduler granularity and apply to large sections of a program at once.

The other approach, which matches the receiver query approach taken elsewhere in [P2300R10] is to add a get_priority() query on the receiver, which, if available, passes a priority to the scheduler in the same way that we pass an allocator or a stop_token. This would work at task granularity, for each schedule() call that we connect a receiver to we might pass a different priority.

In either case we can add the priority in a separate paper. It is thus not urgent that we answer this question, but we include the discussion point to explain why they were removed from the paper.

5.12. Reference implementation

The authors prepared a reference implementation in stdexec

A few key points of the implementation:

(as the time of writing this paper revision, not all these features are merged on the mainline).

5.13. Addressing received feedback

5.13.1. Allow for system context to borrow threads

Early feedback on the paper from Sean Parent suggested a need for the system context to support a configuration where it carries no threads of its own and takes over the main thread. While in [P2079R2] we proposed execute_chunk and execute_all, these enforce a particular implementation on the underlying execution context. Instead, we simplify the proposal by removing this functionality and assuming that it is implemented by link-time or run-time replacement of the context. We assume that the underlying mechanism to drive the context, should one be necessary, is implementation-defined. This allows for custom hooks into an OS thread pool, or a simple drive() method in main.

As we discussed previously, a separate paper is supposed to take care of the drive-ability aspect.

5.13.2. Allow implementations to use Grand Central Dispatch and Windows Thread Pool

In the current form of the paper, we allow implementations to define the best choice for implementing the system context for a particular system. This includes using Grand Central Dispatch on Apple platforms and Windows Thread Pool on Windows.

In addition, we propose implementations to allow the replaceability of the system context implementation. This means that users should be allowed to write their own system context implementations that depend on OS facilities or a necessity to use some vendor (like Intel) specific solutions for parallelism.

5.13.3. Priorities and elastic pools

Feedback from Sean Parent:

There is so much in that proposal that is not specified. What requirements are placed on the system scheduler? Most system schedulers support priorities and are elastic (i.e., blocking in the system thread pool will spin up additional threads to some limit).

The lack of details in the specification is intentional, allowing implementers to make the best compromises for each platform. As different platforms have different needs, constraints, and optimization goals, the authors believe that it is in the best interest of the users to leave some of these details as Quality of Implementation (QOI) details.

5.13.4. Implementation-defined may make things less portable

Some feedback gathered during discussions on this paper suggested that having many aspects of the paper to be implementation-defined would reduce the portability of the system context.

While it is true that people that would want to replace the system scheduler will have a harder time doing so, this will not affect the users of the system scheduler. They would still be able to the use system context and system scheduler without knowing the implementation details of those.

We have a precedence in the C++ standard for this approach with the global allocator.

5.13.5. Replaceability is not needed (at least on Windows)

Microsoft provided feedback that they will likely not support replaceability on their platforms. The feedback we received from Microsoft, is that they will likely not support replaceability on their platforms. They would prefer that we offer implementations an option to not implement replaceability. Moreover, for systems where replaceability is supported they would prefer to make the replaceability mechanism to be implementation defined.

The authors disagree with the idea that replaceability is not needed for Windows platforms (or other platforms that provide an OS scheduler). The OS scheduler is optimized for certain workloads, and it’s not the best choice for all workloads. This way not providing replaceability options have the following drawbacks:

The poll taken in Wrocław, Poland, November 2024, showed that the majority of the participants support mandating replaceability, as well as specifying the mechanism of replaceability and the API for replaceability.

6. Specification

6.1. Header <version> synopsis 17.3.2 [version.syn]

To the <version> synopsis 17.3.2 [version.syn], add the following:

#define __cpp_lib_syncbuf                           201803L // also in <syncstream>
#define __cpp_lib_system_scheduler                  2025XXL // also in <execution>
#define __cpp_lib_text_encoding                     202306L // also in <text_encoding>

6.2. 8.2 Header <execution> synopsis 34.4 [execution.syn]

To the <execution> synopsis 34.4 [execution.syn], add the following at the end of the code block:

namespace std::execution {
  // [exec.get_system_scheduler]
  system_scheduler get_system_scheduler();

  // [exec.system_scheduler]
  class system_scheduler { unspecified };

  // [exec.system_scheduler]
  class impl-defined-system_sender { unspecified };
}

// [exec.sysctxrepl]
namespace std::execution::system_context_replaceability {
  template <class-type Interface>
  extern shared_ptr<Interface> query_system_context();

  template <class-type Interface>
  using factory-type = shared_ptr<Interface> (*)(); // exposition only

  template <class-type Interface>
  extern factory-type set_system_context_backend_factory(factory-type);

  struct receiver {
    virtual ~receiver() = default;

    receiver(const receiver&) = delete;
    receiver(receiver&&) = delete;
    receiver& operator=(const receiver&) = delete;
    receiver& operator=(receiver&&) = delete;

  protected:
    // exposition only
    virtual bool unspecified-query-env(unspecified-id, void*) noexcept = 0;

  public:
    virtual void set_value() noexcept = 0;
    virtual void set_error(std::exception_ptr) noexcept = 0;
    virtual void set_stopped() noexcept = 0;

    template <class-type P>
    std::optional<P> try_query() noexcept;
  };

  struct bulk_item_receiver : receiver {
    virtual void start(uint32_t) noexcept = 0;
  };

  struct storage {
    void* data;
    uint32_t size;
  };

  struct system_scheduler {
    virtual ~system_scheduler() = default;

    virtual void schedule(receiver*, storage) noexcept = 0;
    virtual void bulk_schedule(uint32_t, bulk_item_receiver*, storage) noexcept = 0;
  };
}

6.3. System context

Add the following as a new subsection at the end of 33 [exec]:

33.N System context [exec.sysctx]

33.N.1 execution::get_system_scheduler [exec.get_system_scheduler]

  1. get_system_scheduler returns the system scheduler object that represents a parallel execution context that can be shared between applications, aiming at avoiding oversubscription.

  2. Returns: An instance of a execution::system_scheduler class.

    • The intended use for system scheduler is to have the parallel execution context shared between applications.

33.N.2 execution::system_scheduler class [exec.system_scheduler]

  1. system_scheduler is a class that models the scheduler concept and provides access to a parallel execution context that can be shared between applications, aiming at avoiding oversubscription.

    • Users might alter the behavior of the system scheduler by replacing the backend implementation, as discussed in [exec.sysctxrepl].

  2. An instance of the system_scheduler class will internally reference an instance of execution::system_context_replaceability::system_scheduler class. We call this the backend of the system scheduler; see [exec.sysctxrepl].

    • If the user does not specify a custom backend, a default is provided by the implementation.

    • If no system scheduler backend is available when an instance of the class system_scheduler is created, terminate() ([except.terminate]) is called.

  3. Two objects sch1 and sch2 of type execution::system_scheduler shall compare equal if and only if they point to the same backend.

  4. If sch is an object of type execution::system_scheduler, then get_forward_progress_guarantee(sch) returns execution::parallel.

  5. Let snd be the object returned by calling execution::schedule() on an object of type system_scheduler; snd has exposition-only type impl-defined-system_sender. If a receiver recv is connected to snd and the resulting operation state is started, then schedule(r, s) is called on the backend object of the system scheduler, where r and s are objects created by the frontend such as:

    • r is an object of type execution::system_context_replaceability::receiver such as:

      • when the backend calls r->set_value(), the value completion signal is sent to recv;

      • when the backend calls r->set_error() with a value ep, the error completion signal is sent to recv, passing error value ep;

      • when the backend calls r->set_done(), the stopped completion signal is sent to recv.

    • s is an object of type execution::system_context_replaceability::storage that points to a (possibly empty) storage space; if the storage space is not empty it shall be available until r->set_value(), r->set_error() or r->set_stopped() are called.

  6. Implementations shall provide customizations for the execution::bulk() algorithm [exec.bulk]. Let snd be te sender corresponding to the customized call to execution::bulk(sndr, shape, f). If a receiver recv is connected to snd and the resulting operation state is started, then bulk_schedule(n, r, s, e) is called on the backend object of the system scheduler such as:

    • r is an object of type execution::system_context_replaceability::bulk_item_receiver such as:

      • when the backend calls r->set_value(), the value completion signal is sent to recv;

      • when the backend calls r->set_error() with a value ep, the error completion signal is sent to recv, passing error value ep;

      • when the backend calls r->set_done(), the stopped completion signal is sent to recv;

      • when the backend calls r->start() with an index i, f(i) is invoked.

    • s is an object of type execution::system_context_replaceability::storage that points to a (possibly empty) storage space; if the storage space is not empty it shall be available until r->set_value(), r->set_error() or r->set_stopped() are called.

If [P3481R1] gets accepted, the text specifying the customization for bulk() should be updated to also reference bulk_chunked() and bulk_unchunked(). If bulk_chunked() is customized, the implementations may not provide a customization for bulk().

33.N.3 execution::system_context_replaceability namespace [exec.sysctxrepl]

  1. Facilities in execution::system_context_replaceability namespace allow users to replace the backend for the system scheduler. It provides facilities that allows extending system context and using these extensions between the backend and the frontend.

    we use the term backend to refer to the actual implementation of the system scheduler, which is hidden behind a type-erased boundary. At the same type, we refer to the frontend as the part of the system context that is exposed to the users, i.e., the execution::system_scheduler class and related functionality.

    • query_system_context() is used to query a backend for the implementations of certain interfaces.

    • set_system_context_backend_factory() allows run-time replaceability of system context backend components.

    • receiver represents the type-erased receiver that will be notified about the completion signals of the system scheduler backend; the frontend will provide implementations of receiver.

    • bulk_item_receiver represents the type-erased object that will be notified for different iterations of the bulk backend implementation; the frontend will provide implementations of bulk_item_receiver.

    • storage is a type that allows the frontend to pass to the backend information of a preallocated storage in which the operation state of the backend might be stored.

    • system_scheduler is the interface that the backend implements for the system scheduler.


    query_system_context<Interface>()

  2. Returns: a shared pointer to an object that implements the Interface type, or a null pointer if the backend does not implement the interface.

  3. Remarks:

    • A C++ program may provide replacements for different instantiations of query_system_context<Interface>(), similar to the mechanism defined in [replacement.functions].

    • Must return a non-null pointer for the execution::system_context_replaceability::system_scheduler interface.


    set_system_context_backend_factory(factory-type)

  4. Effects: stores the given factory functor for the given Interface.

  5. Returns: the previous factory functor for the given Interface.

  6. Remarks:

    • A C++ program may provide replacements for different instantiations of set_system_context_backend_factory<Interface>(), similar to the mechanism defined in [replacement.functions].

    • If no such replacements are provided for set_system_context_backend_factory<Interface>() and also for query_system_context<Interface>(), then for a type Interface for which query_system_context<Interface>() returns a non-null pointer, the following must hold:

      • calls to set_system_context_backend_factory<Interface>() synchronize with calls to query_system_context<Interface>();

      • after a call to set_system_context_backend_factory<system_scheduler>(f) for which f() produces value psch, a subsequent call to query_system_context<system_scheduler>() produces value equal to psch.

    • Calling set_system_context_backend_factory<system_scheduler>(f) while a system_scheduler object is already in use might produce a different value for system_scheduler; this can lead to oversubscription.


    std::optional<P> receiver::try_query() noexcept

  7. Returns: an optional object that contains the property of type P if the receiver’s environment has such a property, or an empty optional otherwise.

    • If, on the frontend side, the sender obtained from a system scheduler is connected to a receiver that has an environment for which get_stop_token returns an inplace_stop_token object, then try_query<inplace_stop_token>() returns an optional of a value equal with the stop token from the environment;

    • It is unspecified for which other properties P the method try_query returns non-empty optional objects.


    struct system_scheduler

  8. system_scheduler is an interface that the backend implements for the system scheduler.


    virtual void system_scheduler::schedule(receiver* r, storage s) noexcept = 0

  9. Effects: undefined behavior unless the following are met by implementations:

    • it schedules new work on a thread belonging to the execution context represented by this;

    • eventually, one of the following methods are called on the given object r: set_value(), set_error(), or set_stopped().

    • if no error occurs, and the work is not cancelled, r->set_value() must be called;

    • if an error occurs, r->set_error() must be called with an exception_ptr object representing the error;

    • if the work is cancelled, r->set_stopped() must be called.

    • The canonical way of cancelling the work is to store a stop token inside the type-erased receiver object r, such as r.try_query<inplace_stop_token>() returns a non-empty object for which stop was requested. However, implementations might choose to ignore this stop request (for example, if cancellation is handled on the frontend), or use alternative ways for signaling cancellation.

  10. Remarks:

    • The caller guarantees that, until r->set_value(), r->set_error() or r->set_stopped() are called, the following hold:

      • the this object of the system_scheduler instance is valid;

      • parameter objects r and s are valid;

      • the memory of size s.size pointed by s.data is valid (if s.size is not zero).


    virtual void system_scheduler::bulk_schedule(uint32_t n, bulk_item_receiver* r, storage s) noexcept = 0

  11. Effects: same as for schedule(r, s, e), and in addition:

    • if r->start(i) is called, then i must be in interval [0, n);

    • if r->set_value() is called, then r->start(i) must be called for each i in interval [0, n);

    • all calls to r->start(i) happen-before the call to either r->set_value(), r->set_error(), or r->set_stopped();

    • for a given i, there should not be more than one call to r->start(i);

    • all calls to r->start(i) need to be made on threads that belong to the execution context represented by this.

  12. Remarks: same as for schedule(r, s).

7. Polls

7.1. SG1, Wrocław, Poland, 2024

SG1 provided the following feedback, through a poll:

  1. Forward P2079R5 to LEWG for C++26 with changes:

    • Remove the wording about delegatee schedulers

    • Add wording about set_error

    | SF | F | N | A | SA |
    | 3  | 2 | 1 | 0 | 0  |
    

    Unanimous consent

7.2. LEWG, Wrocław, Poland, 2024

LEWG provided the following feedback, through polls:

  1. POLL: We support mandating (by specifying in the standard) replaceability, as described in: “P2079R5 System execution context”

    | SF | F | N | A | SA |
    | 10 | 5 | 1 | 0 | 1  |
    

    Attendance: 15 IP, 7 online

    # of Authors: 2

    Author’s Position: 2x SF

    Outcome: Consensus in favor

    SA: I think using this central point is equivalent to using global and is bad software engineering practice and I wouldn’t like to see it in the standard.

  2. POLL: We support mandating the specific mechanism(s) (link time/runtime/both) of replaceability as described in: “P2079R5 System execution context”

    | SF | F | N | A | SA |
    | 5  | 6 | 3 | 0 | 2  |
    

    Attendance: 15 IP, 7 online

    # of Authors: 2

    Author’s Position: 1x SF 1x N

    Outcome: Consensus in favor

    SA: I don’t believe it’s actually possible to describe this in terms of the abstract machine, we’ve never done that.

  3. POLL: We support specifying an API for the replaceability mechanism(s), as described in: “P2079R5 System execution context”

    | SF | F | N | A | SA |
    | 7  | 6 | 2 | 0 | 1  |
    

    Attendance: 15 (IP), 7 (R)

    # of Authors: 2

    Author’s Position: 2x SF

    Outcome: Consensus in favor

  4. POLL: For lifetime: “P2079R5 System execution context” (approval poll - allowed to vote multiple times):

    1. Not specified in the standard (valid to use the system scheduler everywhere) | 11 |

    2. Allow lifetime to start before main() (allow use of scheduler before entering main but not after main returns) | 1 |

    3. Constrain lifetime to only be inside of main() | 8 |

    Attendance: 15 (IP), 7 (R)

    Outcome: Slight preference towards 1 ( If authors advocate for 3, they need to add rationale for it)

In addition to these polls, LEWG provided the following action items:

References

Informative References

[P0443R14]
Jared Hoberock, Michael Garland, Chris Kohlhoff, Chris Mysen, H. Carter Edwards, Gordon Brown, D. S. Hollman. A Unified Executors Proposal for C++. 15 September 2020. URL: https://wg21.link/p0443r14
[P2079R1]
Ruslan Arutyunyan, Michael Voss. Parallel Executor. 15 August 2020. URL: https://wg21.link/p2079r1
[P2079R2]
Lee Howes, Ruslan Arutyunyan, Michael Voss. System execution context. 15 January 2022. URL: https://wg21.link/p2079r2
[P2300R10]
Eric Niebler, Michał Dominiak, Georgy Evtushenko, Lewis Baker, Lucian Radu Teodorescu, Lee Howes, Kirk Shoop, Michael Garland, Bryce Adelstein Lelbach. `std::execution`. 28 June 2024. URL: https://wg21.link/p2300r10
[P2900R8]
Joshua Berne, Timur Doumler, Andrzej Krzemieński. Contracts for C++. 27 July 2024. URL: https://wg21.link/p2900r8
[P3109R0]
Lewis Baker, Eric Niebler, Kirk Shoop, Lucian Radu. A plan for std::execution for C++26. 12 February 2024. URL: https://wg21.link/p3109r0
[P3481R1]
Lucian Radu Teodorescu; Lewis Baker; Ruslan Arutyunyan. std::execution::bulk() issues. URL: https://wg21.link/P3481R1