Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove features marked with DEPRECATED_v323.
[simgrid.git] / include / xbt / functional.hpp
index f37b9dd..386830b 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2015-2016. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2015-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -7,53 +6,58 @@
 #ifndef XBT_FUNCTIONAL_HPP
 #define XBT_FUNCTIONAL_HPP
 
+#include <xbt/sysdep.h>
+#include <xbt/utility.hpp>
+
 #include <cstddef>
 #include <cstdlib>
+#include <cstring>
 
+#include <array>
 #include <exception>
 #include <functional>
 #include <memory>
 #include <string>
 #include <tuple>
+#include <type_traits>
 #include <utility>
 #include <vector>
 
-#include <xbt/sysdep.h>
-#include <xbt/utility.hpp>
-
 namespace simgrid {
 namespace xbt {
 
-template<class F>
-class MainFunction {
+template <class F> class MainFunction {
 private:
   F code_;
   std::shared_ptr<const std::vector<std::string>> args_;
+
 public:
-  MainFunction(F code, std::vector<std::string> args) :
-    code_(std::move(code)),
-    args_(std::make_shared<const std::vector<std::string>>(std::move(args)))
-  {}
-  int operator()() const
+  MainFunction(F code, std::vector<std::string>&& args)
+      : code_(std::move(code)), args_(std::make_shared<const std::vector<std::string>>(std::move(args)))
   {
-    const int argc = args_->size();
+  }
+  void operator()() const
+  {
+    const int argc                = args_->size();
     std::vector<std::string> args = *args_;
-    std::unique_ptr<char*[]> argv(new char*[argc + 1]);
-    for (int i = 0; i != argc; ++i)
-      argv[i] = args[i].empty() ? const_cast<char*>(""): &args[i].front();
-    argv[argc] = nullptr;
-    return code_(argc, argv.get());
+    if (not args.empty()) {
+      char noarg[] = {'\0'};
+      std::unique_ptr<char* []> argv(new char*[argc + 1]);
+      for (int i = 0; i != argc; ++i)
+        argv[i] = args[i].empty() ? noarg : &args[i].front();
+      argv[argc] = nullptr;
+      code_(argc, argv.get());
+    } else
+      code_(argc, nullptr);
   }
 };
 
-template<class F> inline
-std::function<void()> wrapMain(F code, std::vector<std::string> args)
+template <class F> inline std::function<void()> wrap_main(F code, std::vector<std::string>&& args)
 {
   return MainFunction<F>(std::move(code), std::move(args));
 }
 
-template<class F> inline
-std::function<void()> wrapMain(F code, int argc, const char*const argv[])
+template <class F> inline std::function<void()> wrap_main(F code, int argc, const char* const argv[])
 {
   std::vector<std::string> args(argv, argv + argc);
   return MainFunction<F>(std::move(code), std::move(args));
@@ -75,7 +79,7 @@ constexpr auto apply(F&& f, Tuple&& t, simgrid::xbt::index_sequence<I...>)
  *
  *  auto args = std::make_tuple(1, false);
  *  int res = apply(foo, args);
- *  @encode
+ *  @endcode
  **/
 template <class F, class Tuple>
 constexpr auto apply(F&& f, Tuple&& t)
@@ -106,42 +110,151 @@ template<class T> class Task;
 template<class R, class... Args>
 class Task<R(Args...)> {
 private:
-  // Type-erasure for the code:
-  class Base {
-  public:
-    virtual ~Base() {}
-    virtual R operator()(Args...) = 0;
-  };
+
+  // Placeholder for some class type:
+  struct whatever {};
+
+  // Union used for storage:
+  typedef typename std::aligned_union<0,
+    void*,
+    std::pair<void(*)(),void*>,
+    std::pair<void(whatever::*)(), whatever*>
+  >::type TaskUnion;
+
+  // Is F suitable for small buffer optimization?
   template<class F>
-  class Impl : public Base {
-  public:
-    Impl(F&& code) : code_(std::move(code)) {}
-    Impl(F const& code) : code_(code) {}
-    ~Impl() override {}
-    R operator()(Args... args) override
-    {
-      return code_(std::forward<Args>(args)...);
-    }
-  private:
-    F code_;
+  static constexpr bool canSBO()
+  {
+    return sizeof(F) <= sizeof(TaskUnion) &&
+      alignof(F) <= alignof(TaskUnion);
+  }
+
+  static_assert(canSBO<std::reference_wrapper<whatever>>(),
+    "SBO not working for reference_wrapper");
+
+  // Call (and possibly destroy) the function:
+  typedef R (*call_function)(TaskUnion&, Args...);
+  // Destroy the function (of needed):
+  typedef void (*destroy_function)(TaskUnion&);
+  // Move the function (otherwise memcpy):
+  typedef void (*move_function)(TaskUnion& dest, TaskUnion& src);
+
+  // Vtable of functions for manipulating whatever is in the TaskUnion:
+  struct TaskVtable {
+    call_function call;
+    destroy_function destroy;
+    move_function move;
   };
-  std::unique_ptr<Base> code_;
+
+  TaskUnion buffer_;
+  const TaskVtable* vtable_ = nullptr;
+
+  void clear()
+  {
+    if (vtable_ && vtable_->destroy)
+      vtable_->destroy(buffer_);
+  }
+
 public:
-  Task() {}
-  Task(std::nullptr_t) {}
+  Task() { /* Nothing to do */}
+  explicit Task(std::nullptr_t) { /* Nothing to do */}
+  ~Task()
+  {
+    this->clear();
+  }
+
+  Task(Task const&) = delete;
+
+  Task(Task&& that)
+  {
+    if (that.vtable_ && that.vtable_->move)
+      that.vtable_->move(buffer_, that.buffer_);
+    else
+      std::memcpy(static_cast<void*>(&buffer_), static_cast<void*>(&that.buffer_), sizeof(buffer_));
+
+    vtable_ = that.vtable_;
+    that.vtable_ = nullptr;
+  }
+  Task& operator=(Task const& that) = delete;
+  Task& operator=(Task&& that)
+  {
+    this->clear();
+    if (that.vtable_ && that.vtable_->move)
+      that.vtable_->move(buffer_, that.buffer_);
+    else
+      std::memcpy(static_cast<void*>(&buffer_), static_cast<void*>(&that.buffer_), sizeof(buffer_));
+    vtable_ = that.vtable_;
+    that.vtable_ = nullptr;
+    return *this;
+  }
+
+private:
 
   template<class F>
-  Task(F&& code) :
-    code_(new Impl<F>(std::forward<F>(code))) {}
+  typename std::enable_if<canSBO<F>()>::type
+  init(F code)
+  {
+    const static TaskVtable vtable {
+      // Call:
+      [](TaskUnion& buffer, Args... args) {
+        F* src = reinterpret_cast<F*>(&buffer);
+        F code = std::move(*src);
+        src->~F();
+        return code(std::forward<Args>(args)...);
+      },
+      // Destroy:
+      std::is_trivially_destructible<F>::value ?
+      static_cast<destroy_function>(nullptr) :
+      [](TaskUnion& buffer) {
+        F* code = reinterpret_cast<F*>(&buffer);
+        code->~F();
+      },
+      // Move:
+      [](TaskUnion& dst, TaskUnion& src) {
+        F* src_code = reinterpret_cast<F*>(&src);
+        F* dst_code = reinterpret_cast<F*>(&dst);
+        new(dst_code) F(std::move(*src_code));
+        src_code->~F();
+      }
+    };
+    new(&buffer_) F(std::move(code));
+    vtable_ = &vtable;
+  }
+
+  template <class F> typename std::enable_if<not canSBO<F>()>::type init(F code)
+  {
+    const static TaskVtable vtable {
+      // Call:
+      [](TaskUnion& buffer, Args... args) {
+        // Delete F when we go out of scope:
+        std::unique_ptr<F> code(*reinterpret_cast<F**>(&buffer));
+        return (*code)(std::forward<Args>(args)...);
+      },
+      // Destroy:
+      [](TaskUnion& buffer) {
+        F* code = *reinterpret_cast<F**>(&buffer);
+        delete code;
+      },
+      // Move:
+      nullptr
+    };
+    *reinterpret_cast<F**>(&buffer_) = new F(std::move(code));
+    vtable_ = &vtable;
+  }
 
-  operator bool() const { return code_ != nullptr; }
-  bool operator!() const { return code_ == nullptr; }
+public:
+  template <class F> explicit Task(F code) { this->init(std::move(code)); }
 
-  template<class... OtherArgs>
-  R operator()(OtherArgs&&... args)
+  operator bool() const { return vtable_ != nullptr; }
+  bool operator!() const { return vtable_ == nullptr; }
+
+  R operator()(Args... args)
   {
-    std::unique_ptr<Base> code = std::move(code_);
-    return (*code)(std::forward<OtherArgs>(args)...);
+    if (vtable_ == nullptr)
+      throw std::bad_function_call();
+    const TaskVtable* vtable = vtable_;
+    vtable_ = nullptr;
+    return vtable->call(buffer_, std::forward<Args>(args)...);
   }
 };
 
@@ -162,15 +275,12 @@ public:
   }
 };
 
-template<class F, class... Args>
-auto makeTask(F code, Args... args)
--> Task< decltype(code(std::move(args)...))() >
+template <class F, class... Args> auto make_task(F code, Args... args) -> Task<decltype(code(std::move(args)...))()>
 {
   TaskImpl<F, Args...> task(std::move(code), std::make_tuple(std::move(args)...));
-  return std::move(task);
-}
-
-}
+  return Task<decltype(code(std::move(args)...))()>(std::move(task));
 }
 
+} // namespace xbt
+} // namespace simgrid
 #endif