[libcxx-commits] [PATCH] D148478: [libc++][PSTL] Add design docs

[Nikolas Klauser via Phabricator via libcxx-commits]

philnik created this revision.
philnik added reviewers: ldionne, Mordante.
Herald added a subscriber: arphaman.
Herald added a project: All.
philnik requested review of this revision.
Herald added a project: libc++.
Herald added a subscriber: libcxx-commits.
Herald added a reviewer: libc++.

Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D148478

Files:
  libcxx/docs/DesignDocs/PSTL.rst
  libcxx/docs/index.rst


Index: libcxx/docs/index.rst
===================================================================
--- libcxx/docs/index.rst
+++ libcxx/docs/index.rst
@@ -179,6 +179,7 @@
    DesignDocs/FileTimeType
    DesignDocs/HeaderRemovalPolicy
    DesignDocs/NoexceptPolicy
+   DesignDocs/PSTL
    DesignDocs/ThreadingSupportAPI
    DesignDocs/UniquePtrTrivialAbi
    DesignDocs/UnspecifiedBehaviorRandomization
Index: libcxx/docs/DesignDocs/PSTL.rst
===================================================================
--- /dev/null
+++ libcxx/docs/DesignDocs/PSTL.rst
@@ -0,0 +1,20 @@
+================
+PSTL integration
+================
+
+The PSTL project is quite complex in it's current form and does not provide everything that libc++ requires, for example
+``_LIBCPP_HIDE_FROM_ABI`` or similar annotations and including granularized headers. Because of these drawbacks, we
+decided to adopt a modified PSTL in libc++. Specifically, the goals of the modified PSTL are
+
+- No ``<__pstl_algorithm>`` and similar glue headers -- instead, the implementation files are included directly in
+  ``<algorithm>`` and friends.
+- No ``<pstl/internal/algorithm_impl.h>`` and ``<pstl/internal/algorithm_fwd.h>`` headers and friends -- these contain
+  the implementation and forward declarations for internal functions respectively. The implementation lives inside
+  ``<__algorithm/pstl_any_of.h>`` and friends, and the forward declarations are not needed inside libc++.
+- No ``<pstl/internal/glue_algorithm_defs.h>`` and ``<pstl/internal/glue_algorithm_impl.h>`` headers and friends --
+  these contain the public API. It lives inside ``<__algorithm/pstl_any_of.h>`` and friends instead.
+- The headers implementing backends are kept with as few changes as possible to make it easier to keep the backends in
+  sync with the backends from the original PSTL.
+- The configuration headers ``__pstl_config_site.in`` and ``pstl_config.h`` are removed, and any required configuration
+  is done inside ``__config_site.in`` and ``__config`` respectively.
+- libc++-style tests for the public PSTL API


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D148478.514049.patch
Type: text/x-patch
Size: 2082 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/libcxx-commits/attachments/20230416/d96f326a/attachment.bin>