std::function を使いたいけど、 new したくない。

困っていること

std::function 。便利。大好き。
でも、std::function に格納されるもののサイズは不明なので、代入のタイミングでメモリ確保が行われる。

具体的にはこんな感じ:

c++11

// clang++ -Wall -std=c++11 
# include <functional>
# include <iostream>

struct foo {
  int m[10];
  void operator()() const {
    // 略
  }
};

struct bar {
  int m[100];
  void operator()() const {
    // 略
  }
};

void hoge() {
  std::function<void()> func; // 何が入るのかわからない。
  func = foo{}; // sizeof(foo) の分のメモリ確保が必要
  func = bar{}; // sizeof(foo)<sizeof(bar) なので、メモリの確保と開放が必要。
}

代入されるまで大きさがわからないものを格納する必要があるんだから、仕方ない。

アロケータつきコンストラクタを使えば解決するかと思いきや、C++17 で削除。使う気にならない。

解決するためのアイディア

std::function が、自分に代入されうるオブジェクトの最大値を知っていればいい。
それより大きなもの入れられそうになったら、コンパイルエラー にすればいい。

アイディア

struct larger_than_bar {
  int m[1000];
  void operator()() const {
    // 略
  }
};

void hoge() {
  nabetani::function<
    void(),
    nabetani::function_size<bar>() // bar の大きさまでは受け入れる。
  > func;
  func = foo{}; // sizeof(foo)≦sizeof(bar) なので、OK
  func = bar{}; // sizeof(bar)≦sizeof(bar) なので、OK
  func = larger_than_bar{}; // コンパイルエラー
}

func に必要なメモリはコンパイル時に手動で伝える。
コンパイル時に大きさがわかっていれば、動的なメモリ確保は回避できる。

実装

書いてみた。
だいぶ長いけど、遠慮なく書くと：

c++11

// A. 本ソフトウェアは Everyone'sWare です。このソフトを手にした一人一人が、
//    ご自分の作ったものを扱うのと同じように、自由に利用することが出来ます。
//   A-1. フリーウェアです。作者からは使用料等を要求しません。
//   A-2. 有料無料や媒体の如何を問わず、自由に転載・再配布できます。
//   A-3. いかなる種類の 改変・他プログラムでの利用 を行っても構いません。
//   A-4. 変更したものや部分的に使用したものは、あなたのものになります。
//        公開する場合は、あなたの名前の下で行って下さい。
// B. このソフトを利用することによって生じた損害等について、作者は
//    責任を負わないものとします。各自の責任においてご利用下さい。
// C. 著作者人格権は 鍋谷武典 に帰属します。著作権は放棄します。
// D. 以上の A, B, C は、ソース・実行バイナリの双方に適用されます。

# if !defined fixfunc_hpp_h_
# define fixfunc_hpp_h_

# include <array>

namespace nabetani {
namespace detail {

template <typename> class funcbase_t; // undefined

template <typename ret_t_, typename... args_t>
class funcbase_t<ret_t_(args_t...)> {
public:
  using ret_t = ret_t_;
  virtual ret_t operator()(args_t... args) = 0;
  virtual void clone_to(char *memory) const = 0;
  virtual ~funcbase_t() {}
};

template <typename instance_t, typename> class func_t; // undefined

template <typename instance_t, typename ret_t_, typename... args_t>
class func_t<instance_t, ret_t_(args_t...)>
    : public funcbase_t<ret_t_(args_t...)> {
public:
  using ret_t = ret_t_;
  func_t() = delete;
  instance_t i_;
  func_t(instance_t const &i) : i_(i) {}
  func_t(instance_t &&i) : i_(std::move(i)) {}
  void clone_to(char *memory) const override { new (memory) func_t(i_); }
  ret_t operator()(args_t... args) override { return i_(args...); }
};

template <typename t> inline void destruct(t *p) { p->~t(); }
} // namespace detail

template <typename> class func_type; // undefined
template <typename ret_t, typename ... args_t>
class func_type< ret_t(args_t...)>
{
  template< bool empty, typename ... arg_types  > struct size_impl;
  static constexpr size_t max_size_t( size_t a, size_t b ){
    return a<b ? b : a;
  }
  template< typename t > struct portable { using type=t; };
  template< typename r, typename ...a > struct portable< r(a...) >{ using type=r(*)(a...); };
public:
  template< typename args_t0, typename ... arg_types >//
  static constexpr size_t size()
  {
    using f0 = detail::func_t< typename portable<args_t0>::type, ret_t(args_t...)>;
    return max_size_t( sizeof(f0), size_impl<sizeof...(arg_types)==0, arg_types...>::count );
  }
private:
  template<typename ... arg_types  > struct size_impl<true, arg_types...>{
    enum{ count=0 };
  };
  template<typename ... arg_types  > struct size_impl<false, arg_types...>{
    enum{ count=func_type::size<arg_types...>() };
  };

};

template <typename, size_t> class fixfunc; // undefined

template <typename ret_t_, typename... args_t, size_t size_>
class fixfunc<ret_t_(args_t...), size_> {
public:
  using ret_t = ret_t_;
  constexpr static size_t size() { return size_; }

private:
  mutable std::array<char, size()> memory_;
  using func_t = detail::funcbase_t<ret_t(args_t...)>;
  func_t *func() { return reinterpret_cast<func_t *>(memory_.data()); };
  func_t *func() const { return reinterpret_cast<func_t *>(memory_.data()); };

public:
  ~fixfunc() { detail::destruct(func()); }

  // NOT explicit
  template <typename t> fixfunc(t const &v) {
    using actual_func_t = detail::func_t<t, ret_t(args_t...)>;
    static_assert(
        sizeof(actual_func_t) <= size(),
        "sizeof(actual_func_t) should not be greater than size of buffer");
    new (memory_.data()) actual_func_t(v);
  }
  // NOT explicit
  fixfunc(ret_t (*v)(args_t...)) {
    using actual_func_t = detail::func_t<decltype(v), ret_t(args_t...)>;
    static_assert(
        sizeof(actual_func_t) <= size(),
        "sizeof(actual_func_t) should not be greater than size of buffer");
    new (memory_.data()) actual_func_t(v);
  }

  fixfunc(fixfunc const &that) { that.func()->clone_to(memory_.data()); }

  fixfunc &operator=(fixfunc const &that) {
    fixfunc tmp(that);
    tmp.swap(*this);
    return *this;
  }

  void swap(fixfunc &that) noexcept { std::swap(memory_, that.memory_); }

  template <typename... proc_args_t> ret_t operator()(args_t... args) const {
    return (*func())(args...);
  }
  template <typename... proc_args_t> ret_t operator()(args_t... args) {
    return (*func())(args...);
  }
};
} // namespace nabetani

# endif

高機能な std::function と違って、いろいろサボっている。

• 「関数が入っていない」という状態を作れない。
• reset 関数もないし、bool への変換もない。
• デフォルトコンストラクタもない。
• 右辺値参照 対応が不十分(あるいは間違っている)のように思う。
• アライメントの指定が足りてないと思う。amd64 でしか動かしてないので、足りてなくても動いてしまっている。

辺り。

あと、 mutable を書いてしまったんだけど、良かったのかどうかわからない。

ライセンスは NYSL で。

使用例

こんな感じで：

c++11

// clang++ -Wall -std=c++11
# include "fixfunc.hpp"
# include <functional>
# include <iostream>

struct foo {
  int m[10];
  void operator()() const {
    std::cout << "foo" << std::endl;
    // 略
  }
};

struct bar {
  int m[100];
  void operator()() const {
    std::cout << "bar" << std::endl;
    // 略
  }
};

struct too_large {
  int m[200];
  void operator()() const {
    // 略
  }
};

void fuga() {
  using ft = nabetani::func_type<void(void)>;
  constexpr size_t size = ft::size<foo, bar>();
  nabetani::fixfunc<void(void), size> func = foo{};
  func(); // calls foo::operator()
  func = bar{}; // okay
  func(); // calls bar::operator()
  func = too_large{}; // compile error
}

int main() {
  fuga();
}

クラスとか生の関数を入れている分にはわりと気持ちよく使えると思う。

でも、 lambda式を受け取ろうと思うと、 size の計算が難しくなる。
lambda 式を受け取る側から lambda 式が見えないと、size に何を入れたらいいのかわからない。コンパイルが通る最小値を 二分探索で探すとか、そういうバカバカしい作業が必要になるかもしれない。

実行時エラーじゃないからぎりぎり我慢できるかなという感じ。

処理時間

適当に処理時間を測ってみると。
※ 以下、std::function の処理時間を 100 とした相対値。

代入

処理系	std::function	nabetani::fixfunc
g++-9 on macOS	100	34
clang++ on macOS	100	91

なぜか g++ では大差がつく。

呼び出し

処理系	std::function	nabetani::fixfunc
g++-9 on macOS	100	19
clang++ on macOS	100	72

こちらもなぜか g++ では大差がつく。

呼び出しコストは大差ないという予想だったんだけど、わりと差がついた。