include/xbt/functional.hpp

   1 /* Copyright (c) 2015-2020. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef XBT_FUNCTIONAL_HPP
   7 #define XBT_FUNCTIONAL_HPP
   8
   9 #include <xbt/sysdep.h>
  10
  11 #include <cstddef>
  12 #include <cstdlib>
  13 #include <cstring>
  14
  15 #include <algorithm>
  16 #include <array>
  17 #include <exception>
  18 #include <functional>
  19 #include <memory>
  20 #include <string>
  21 #include <tuple>
  22 #include <type_traits>
  23 #include <utility>
  24 #include <vector>
  25
  26 namespace simgrid {
  27 namespace xbt {
  28
  29 template <class F> class MainFunction {
  30   F code_;
  31   std::shared_ptr<const std::vector<std::string>> args_;
  32
  33 public:
  34   MainFunction(F code, std::vector<std::string>&& args)
  35       : code_(std::move(code)), args_(std::make_shared<const std::vector<std::string>>(std::move(args)))
  36   {
  37   }
  38   void operator()() const
  39   {
  40     const int argc                = args_->size();
  41     std::vector<std::string> args = *args_;
  42     std::vector<char*> argv(args.size() + 1); // argv[argc] is nullptr
  43     std::transform(begin(args), end(args), begin(argv), [](std::string& s) { return &s.front(); });
  44     code_(argc, argv.data());
  45   }
  46 };
  47
  48 template <class F> inline std::function<void()> wrap_main(F code, std::vector<std::string>&& args)
  49 {
  50   return MainFunction<F>(std::move(code), std::move(args));
  51 }
  52
  53 template <class F> inline std::function<void()> wrap_main(F code, int argc, const char* const argv[])
  54 {
  55   std::vector<std::string> args(argv, argv + argc);
  56   return MainFunction<F>(std::move(code), std::move(args));
  57 }
  58
  59 namespace bits {
  60 template <class F, class Tuple, std::size_t... I>
  61 constexpr auto apply(F&& f, Tuple&& t, std::index_sequence<I...>)
  62     -> decltype(std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...))
  63 {
  64   return std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...);
  65 }
  66 }
  67
  68 /** Call a functional object with the values in the given tuple (from C++17)
  69  *
  70  *  @code{.cpp}
  71  *  int foo(int a, bool b);
  72  *
  73  *  auto args = std::make_tuple(1, false);
  74  *  int res = apply(foo, args);
  75  *  @endcode
  76  **/
  77 template <class F, class Tuple>
  78 constexpr auto apply(F&& f, Tuple&& t) -> decltype(
  79     simgrid::xbt::bits::apply(std::forward<F>(f), std::forward<Tuple>(t),
  80                               std::make_index_sequence<std::tuple_size<typename std::decay<Tuple>::type>::value>()))
  81 {
  82   return simgrid::xbt::bits::apply(
  83       std::forward<F>(f), std::forward<Tuple>(t),
  84       std::make_index_sequence<std::tuple_size<typename std::decay<Tuple>::type>::value>());
  85 }
  86
  87 template<class T> class Task;
  88
  89 /** Type-erased run-once task
  90  *
  91  *  * Like std::function but callable only once.
  92  *    However, it works with move-only types.
  93  *
  94  *  * Like std::packaged_task<> but without the shared state.
  95  */
  96 template<class R, class... Args>
  97 class Task<R(Args...)> {
  98   // Placeholder for some class type:
  99   struct whatever {};
 100
 101   // Union used for storage:
 102   typedef typename std::aligned_union<0,
 103     void*,
 104     std::pair<void(*)(),void*>,
 105     std::pair<void(whatever::*)(), whatever*>
 106   >::type TaskUnion;
 107
 108   // Is F suitable for small buffer optimization?
 109   template<class F>
 110   static constexpr bool canSBO()
 111   {
 112     return sizeof(F) <= sizeof(TaskUnion) &&
 113       alignof(F) <= alignof(TaskUnion);
 114   }
 115
 116   static_assert(canSBO<std::reference_wrapper<whatever>>(),
 117     "SBO not working for reference_wrapper");
 118
 119   // Call (and possibly destroy) the function:
 120   typedef R (*call_function)(TaskUnion&, Args...);
 121   // Destroy the function (of needed):
 122   typedef void (*destroy_function)(TaskUnion&);
 123   // Move the function (otherwise memcpy):
 124   typedef void (*move_function)(TaskUnion& dest, TaskUnion& src);
 125
 126   // Vtable of functions for manipulating whatever is in the TaskUnion:
 127   struct TaskVtable {
 128     call_function call;
 129     destroy_function destroy;
 130     move_function move;
 131   };
 132
 133   TaskUnion buffer_;
 134   const TaskVtable* vtable_ = nullptr;
 135
 136   void clear()
 137   {
 138     if (vtable_ && vtable_->destroy)
 139       vtable_->destroy(buffer_);
 140   }
 141
 142 public:
 143   Task() = default;
 144   explicit Task(std::nullptr_t) { /* Nothing to do */}
 145   ~Task()
 146   {
 147     this->clear();
 148   }
 149
 150   Task(Task const&) = delete;
 151
 152   Task(Task&& that) noexcept
 153   {
 154     if (that.vtable_ && that.vtable_->move)
 155       that.vtable_->move(buffer_, that.buffer_);
 156     else
 157       std::memcpy(static_cast<void*>(&buffer_), static_cast<void*>(&that.buffer_), sizeof(buffer_));
 158     vtable_      = std::move(that.vtable_);
 159     that.vtable_ = nullptr;
 160   }
 161   Task& operator=(Task const& that) = delete;
 162   Task& operator=(Task&& that) noexcept
 163   {
 164     this->clear();
 165     if (that.vtable_ && that.vtable_->move)
 166       that.vtable_->move(buffer_, that.buffer_);
 167     else
 168       std::memcpy(static_cast<void*>(&buffer_), static_cast<void*>(&that.buffer_), sizeof(buffer_));
 169     vtable_      = std::move(that.vtable_);
 170     that.vtable_ = nullptr;
 171     return *this;
 172   }
 173
 174 private:
 175   template<class F>
 176   typename std::enable_if<canSBO<F>()>::type
 177   init(F code)
 178   {
 179     const static TaskVtable vtable {
 180       // Call:
 181       [](TaskUnion& buffer, Args... args) {
 182         auto* src = reinterpret_cast<F*>(&buffer);
 183         F code = std::move(*src);
 184         src->~F();
 185         // NOTE: std::forward<Args>(args)... is correct.
 186         return code(std::forward<Args>(args)...);
 187       },
 188       // Destroy:
 189       std::is_trivially_destructible<F>::value ?
 190       static_cast<destroy_function>(nullptr) :
 191       [](TaskUnion& buffer) {
 192         auto* code = reinterpret_cast<F*>(&buffer);
 193         code->~F();
 194       },
 195       // Move:
 196       [](TaskUnion& dst, TaskUnion& src) {
 197         auto* src_code = reinterpret_cast<F*>(&src);
 198         auto* dst_code = reinterpret_cast<F*>(&dst);
 199         new(dst_code) F(std::move(*src_code));
 200         src_code->~F();
 201       }
 202     };
 203     new(&buffer_) F(std::move(code));
 204     vtable_ = &vtable;
 205   }
 206
 207   template <class F> typename std::enable_if<not canSBO<F>()>::type init(F code)
 208   {
 209     const static TaskVtable vtable {
 210       // Call:
 211       [](TaskUnion& buffer, Args... args) {
 212         // Delete F when we go out of scope:
 213         std::unique_ptr<F> code(*reinterpret_cast<F**>(&buffer));
 214         // NOTE: std::forward<Args>(args)... is correct.
 215         return (*code)(std::forward<Args>(args)...);
 216       },
 217       // Destroy:
 218       [](TaskUnion& buffer) {
 219         F* code = *reinterpret_cast<F**>(&buffer);
 220         delete code;
 221       },
 222       // Move:
 223       nullptr
 224     };
 225     *reinterpret_cast<F**>(&buffer_) = new F(std::move(code));
 226     vtable_ = &vtable;
 227   }
 228
 229 public:
 230   template <class F> explicit Task(F code) { this->init(std::move(code)); }
 231
 232   operator bool() const { return vtable_ != nullptr; }
 233   bool operator!() const { return vtable_ == nullptr; }
 234
 235   R operator()(Args... args)
 236   {
 237     if (vtable_ == nullptr)
 238       throw std::bad_function_call();
 239     const TaskVtable* vtable = vtable_;
 240     vtable_ = nullptr;
 241     // NOTE: std::forward<Args>(args)... is correct.
 242     // see C++ [func.wrap.func.inv] for an example
 243     return vtable->call(buffer_, std::forward<Args>(args)...);
 244   }
 245 };
 246
 247 template<class F, class... Args>
 248 class TaskImpl {
 249   F code_;
 250   std::tuple<Args...> args_;
 251   typedef decltype(simgrid::xbt::apply(std::move(code_), std::move(args_))) result_type;
 252 public:
 253   TaskImpl(F code, std::tuple<Args...> args) :
 254     code_(std::move(code)),
 255     args_(std::move(args))
 256   {}
 257   result_type operator()()
 258   {
 259     return simgrid::xbt::apply(std::move(code_), std::move(args_));
 260   }
 261 };
 262
 263 template <class F, class... Args> auto make_task(F code, Args... args) -> Task<decltype(code(std::move(args)...))()>
 264 {
 265   TaskImpl<F, Args...> task(std::move(code), std::make_tuple(std::move(args)...));
 266   return Task<decltype(code(std::move(args)...))()>(std::move(task));
 267 }
 268
 269 } // namespace xbt
 270 } // namespace simgrid
 271 #endif