include/xbt/functional.hpp

   1 /* Copyright (c) 2015-2018. 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 #include <xbt/utility.hpp>
  11
  12 #include <cstddef>
  13 #include <cstdlib>
  14 #include <cstring>
  15
  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 private:
  31   F code_;
  32   std::shared_ptr<const std::vector<std::string>> args_;
  33
  34 public:
  35   MainFunction(F code, std::vector<std::string> args)
  36       : code_(std::move(code)), args_(std::make_shared<const std::vector<std::string>>(std::move(args)))
  37   {
  38   }
  39   void operator()() const
  40   {
  41     const int argc                = args_->size();
  42     std::vector<std::string> args = *args_;
  43     if (not args.empty()) {
  44       char noarg[] = {'\0'};
  45       std::unique_ptr<char* []> argv(new char*[argc + 1]);
  46       for (int i = 0; i != argc; ++i)
  47         argv[i] = args[i].empty() ? noarg : &args[i].front();
  48       argv[argc] = nullptr;
  49       code_(argc, argv.get());
  50     } else
  51       code_(argc, nullptr);
  52   }
  53 };
  54
  55 template <class F> inline std::function<void()> wrap_main(F code, std::vector<std::string> args)
  56 {
  57   return MainFunction<F>(std::move(code), std::move(args));
  58 }
  59
  60 template <class F> inline std::function<void()> wrap_main(F code, int argc, const char* const argv[])
  61 {
  62   std::vector<std::string> args(argv, argv + argc);
  63   return MainFunction<F>(std::move(code), std::move(args));
  64 }
  65
  66 namespace bits {
  67 template <class F, class Tuple, std::size_t... I>
  68 constexpr auto apply(F&& f, Tuple&& t, simgrid::xbt::index_sequence<I...>)
  69   -> decltype(std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...))
  70 {
  71   return std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...);
  72 }
  73 }
  74
  75 /** Call a functional object with the values in the given tuple (from C++17)
  76  *
  77  *  @code{.cpp}
  78  *  int foo(int a, bool b);
  79  *
  80  *  auto args = std::make_tuple(1, false);
  81  *  int res = apply(foo, args);
  82  *  @endcode
  83  **/
  84 template <class F, class Tuple>
  85 constexpr auto apply(F&& f, Tuple&& t)
  86   -> decltype(simgrid::xbt::bits::apply(
  87     std::forward<F>(f),
  88     std::forward<Tuple>(t),
  89     simgrid::xbt::make_index_sequence<
  90       std::tuple_size<typename std::decay<Tuple>::type>::value
  91     >()))
  92 {
  93   return simgrid::xbt::bits::apply(
  94     std::forward<F>(f),
  95     std::forward<Tuple>(t),
  96     simgrid::xbt::make_index_sequence<
  97       std::tuple_size<typename std::decay<Tuple>::type>::value
  98     >());
  99 }
 100
 101 template<class T> class Task;
 102
 103 /** Type-erased run-once task
 104  *
 105  *  * Like std::function but callable only once.
 106  *    However, it works with move-only types.
 107  *
 108  *  * Like std::packaged_task<> but without the shared state.
 109  */
 110 template<class R, class... Args>
 111 class Task<R(Args...)> {
 112 private:
 113
 114   // Placeholder for some class type:
 115   struct whatever {};
 116
 117   // Union used for storage:
 118 #if 0
 119   typedef typename std::aligned_union<0,
 120     void*,
 121     std::pair<void(*)(),void*>,
 122     std::pair<void(whatever::*)(), whatever*>
 123   >::type TaskUnion;
 124 #else
 125   union TaskUnion {
 126     void* ptr;
 127     std::pair<void(*)(),void*> funcptr;
 128     std::pair<void(whatever::*)(), whatever*> memberptr;
 129     char any1[sizeof(std::pair<void(*)(),void*>)];
 130     char any2[sizeof(std::pair<void(whatever::*)(), whatever*>)];
 131     TaskUnion() { /* Nothing to do */}
 132     ~TaskUnion() { /* Nothing to do */}
 133   };
 134 #endif
 135
 136   // Is F suitable for small buffer optimization?
 137   template<class F>
 138   static constexpr bool canSBO()
 139   {
 140     return sizeof(F) <= sizeof(TaskUnion) &&
 141       alignof(F) <= alignof(TaskUnion);
 142   }
 143
 144   static_assert(canSBO<std::reference_wrapper<whatever>>(),
 145     "SBO not working for reference_wrapper");
 146
 147   // Call (and possibly destroy) the function:
 148   typedef R (*call_function)(TaskUnion&, Args...);
 149   // Destroy the function (of needed):
 150   typedef void (*destroy_function)(TaskUnion&);
 151   // Move the function (otherwise memcpy):
 152   typedef void (*move_function)(TaskUnion& dest, TaskUnion& src);
 153
 154   // Vtable of functions for manipulating whatever is in the TaskUnion:
 155   struct TaskVtable {
 156     call_function call;
 157     destroy_function destroy;
 158     move_function move;
 159   };
 160
 161   TaskUnion buffer_;
 162   const TaskVtable* vtable_ = nullptr;
 163
 164   void clear()
 165   {
 166     if (vtable_ && vtable_->destroy)
 167       vtable_->destroy(buffer_);
 168   }
 169
 170 public:
 171   Task() { /* Nothing to do */}
 172   explicit Task(std::nullptr_t) { /* Nothing to do */}
 173   ~Task()
 174   {
 175     this->clear();
 176   }
 177
 178   Task(Task const&) = delete;
 179
 180   Task(Task&& that)
 181   {
 182     if (that.vtable_ && that.vtable_->move)
 183       that.vtable_->move(buffer_, that.buffer_);
 184     else
 185       std::memcpy(static_cast<void*>(&buffer_), static_cast<void*>(&that.buffer_), sizeof(buffer_));
 186
 187     vtable_ = that.vtable_;
 188     that.vtable_ = nullptr;
 189   }
 190   Task& operator=(Task that)
 191   {
 192     this->clear();
 193     if (that.vtable_ && that.vtable_->move)
 194       that.vtable_->move(buffer_, that.buffer_);
 195     else
 196       std::memcpy(static_cast<void*>(&buffer_), static_cast<void*>(&that.buffer_), sizeof(buffer_));
 197     vtable_ = that.vtable_;
 198     that.vtable_ = nullptr;
 199     return *this;
 200   }
 201
 202 private:
 203
 204   template<class F>
 205   typename std::enable_if<canSBO<F>()>::type
 206   init(F code)
 207   {
 208     const static TaskVtable vtable {
 209       // Call:
 210       [](TaskUnion& buffer, Args... args) {
 211         F* src = reinterpret_cast<F*>(&buffer);
 212         F code = std::move(*src);
 213         src->~F();
 214         return code(std::forward<Args>(args)...);
 215       },
 216       // Destroy:
 217       std::is_trivially_destructible<F>::value ?
 218       static_cast<destroy_function>(nullptr) :
 219       [](TaskUnion& buffer) {
 220         F* code = reinterpret_cast<F*>(&buffer);
 221         code->~F();
 222       },
 223       // Move:
 224       [](TaskUnion& dst, TaskUnion& src) {
 225         F* src_code = reinterpret_cast<F*>(&src);
 226         F* dst_code = reinterpret_cast<F*>(&dst);
 227         new(dst_code) F(std::move(*src_code));
 228         src_code->~F();
 229       }
 230     };
 231     new(&buffer_) F(std::move(code));
 232     vtable_ = &vtable;
 233   }
 234
 235   template <class F> typename std::enable_if<not canSBO<F>()>::type init(F code)
 236   {
 237     const static TaskVtable vtable {
 238       // Call:
 239       [](TaskUnion& buffer, Args... args) {
 240         // Delete F when we go out of scope:
 241         std::unique_ptr<F> code(*reinterpret_cast<F**>(&buffer));
 242         return (*code)(std::forward<Args>(args)...);
 243       },
 244       // Destroy:
 245       [](TaskUnion& buffer) {
 246         F* code = *reinterpret_cast<F**>(&buffer);
 247         delete code;
 248       },
 249       // Move:
 250       nullptr
 251     };
 252     *reinterpret_cast<F**>(&buffer_) = new F(std::move(code));
 253     vtable_ = &vtable;
 254   }
 255
 256 public:
 257   template <class F> explicit Task(F code) { this->init(std::move(code)); }
 258
 259   operator bool() const { return vtable_ != nullptr; }
 260   bool operator!() const { return vtable_ == nullptr; }
 261
 262   R operator()(Args... args)
 263   {
 264     if (vtable_ == nullptr)
 265       throw std::bad_function_call();
 266     const TaskVtable* vtable = vtable_;
 267     vtable_ = nullptr;
 268     return vtable->call(buffer_, std::forward<Args>(args)...);
 269   }
 270 };
 271
 272 template<class F, class... Args>
 273 class TaskImpl {
 274 private:
 275   F code_;
 276   std::tuple<Args...> args_;
 277   typedef decltype(simgrid::xbt::apply(std::move(code_), std::move(args_))) result_type;
 278 public:
 279   TaskImpl(F code, std::tuple<Args...> args) :
 280     code_(std::move(code)),
 281     args_(std::move(args))
 282   {}
 283   result_type operator()()
 284   {
 285     return simgrid::xbt::apply(std::move(code_), std::move(args_));
 286   }
 287 };
 288
 289 template <class F, class... Args> auto make_task(F code, Args... args) -> Task<decltype(code(std::move(args)...))()>
 290 {
 291   TaskImpl<F, Args...> task(std::move(code), std::make_tuple(std::move(args)...));
 292   return Task<decltype(code(std::move(args)...))()>(std::move(task));
 293 }
 294
 295 // Deprecated
 296 template <class F, class... Args>
 297 XBT_ATTRIB_DEPRECATED_v323("Please use make_task()") auto makeTask(F code, Args... args)
 298     -> Task<decltype(code(std::move(args)...))()>
 299 {
 300   TaskImpl<F, Args...> task(std::move(code), std::make_tuple(std::move(args)...));
 301   return Task<decltype(code(std::move(args)...))()>(std::move(task));
 302 }
 303
 304 template <class F>
 305 inline XBT_ATTRIB_DEPRECATED_v323("Please use wrap_main()") std::function<void()> wrapMain(
 306     F code, std::vector<std::string> args)
 307 {
 308   return MainFunction<F>(std::move(code), std::move(args));
 309 }
 310
 311 template <class F>
 312 inline XBT_ATTRIB_DEPRECATED_v323("Please use wrap_main()") std::function<void()> wrapMain(F code, int argc,
 313                                                                                            const char* const argv[])
 314 {
 315   std::vector<std::string> args(argv, argv + argc);
 316   return MainFunction<F>(std::move(code), std::move(args));
 317 }
 318
 319 } // namespace xbt
 320 } // namespace simgrid
 321 #endif