假设我使用结构数组(AoS)内存布局编写了很多代码。我想在C++中建立一个零成本的抽象,它使我能够以尽可能少的重构工作在AoS和SoA之间进行切换。
例如带访问成员函数的类
struct Item{
auto& myDouble(){ return mDouble; }
auto& myChar(){ return mChar; }
auto& myString(){ return mString; }
private:
double mDouble;
char mChar;
std::string mString;
};
在容器内循环使用
std::vector<Item> vec_(1000);
for (auto& i : vec_)
i.myDouble()=5.;
我想更改第一个代码段,而第二个代码段仍保持相似。有类似的东西
MyContainer<Item, SoA> vec_(1000)
for (auto& i : vec_)
i.myDouble()=5.;
在其中可以使用“SoA”或“AoS”模板参数选择内存布局。我的问题是:这样的东西存在于某处吗?如果没有,那么如何最好地实现呢?
最佳答案
我实现了一个通用的解决方案,我将在下面在此处进行解释(这将是一篇很长的文章)。当然,这不是唯一可能的答案,收集反馈会很棒。我在https://github.com/crosetto/SoAvsAoS处放置了此解决方案的完整代码
我们创建了两个帮助器类,根据标签模板参数,给定一个项目,该类将生成容器类型作为元组的 vector 或 vector 的元组。我们将此类称为DataLayoutPolicy,并将使用它,例如这样:
DataLayoutPolicy<std::vector, SoA, char, double, std::string>
生成char,int和double的 vector 的元组。
enum class DataLayout { SoA, //structure of arrays
AoS //array of structures
};
template <template <typename...> class Container, DataLayout TDataLayout, typename TItem>
struct DataLayoutPolicy;
此类仅包含与容器进行交互的静态成员函数(例如,提取元素,插入,调整大小等)。我们编写了两个模板专长。第一个(琐碎的)结构数组的情况:
template <template <typename...> class Container, template<typename...> class TItem, typename... Types>
struct DataLayoutPolicy<Container, DataLayout::AoS, TItem<Types...>> {
using type = Container<TItem<Types...>>;
using value_type = TItem<Types...>&;
constexpr static value_type get( type& c_, std::size_t position_ ){ return value_type(*static_cast<TItem<Types...>*>(&c_[ position_ ])); }
constexpr static void resize( type& c_, std::size_t size_ ) { c_.resize( size_ ); }
template <typename TValue>
constexpr static void push_back( type& c_, TValue&& val_ ){ c_.push_back( val_ ); }
static constexpr std::size_t size(type& c_){ return c_.size(); }
};
...只是转发。我们对数组案例的结构也做同样的事情。
注意:关于以下代码,有几件事需要解释。
它将所有类型包装在ref_wrap类型中,这是一个“装饰”的std::reference_wrapper。这是因为我们要访问元素作为左值引用,以便能够更改其值。使用常规引用,如果例如类型包含任何引用。值得注意的是,在AoS情况下,DataLayoutPolicy::value_type是引用,而在SoA情况下,是ref_wrap类型的值。
我们通过值返回一个新创建的值ref_wrap的元组。令人惊讶的是,这是因为编译器正在优化所有拷贝,而在C++ 17中,它甚至更好(返回的元组是“prvalue”),这是因为在标准中添加了保证的拷贝省略:如果没有复制,则即使std::tuple和std::reference_wrapper没有复制/移动构造函数,此代码也将起作用。
我们使用std::integer序列来静态展开参数包:这很丑陋,但是这是从C++ 14开始的“方式”(而且在C++ 11中,必须使用模板递归来实现相同的目的) )。对于参数包,还没有像“for_each”这样的东西。
我们使用C++ 17折叠表达式来调用多次返回void的函数。在C++ 17之前,这是通过棘手的技巧简洁地实现的。
template <typename T>
struct ref_wrap : public std::reference_wrapper<T>{
operator T&() const noexcept { return this->get(); }
ref_wrap(T& other_) : std::reference_wrapper<T>(other_){}
void operator =(T && other_) {this->get()=other_;}
};
template <template <typename...> class Container, template<typename...> class TItem, typename... Types>
struct DataLayoutPolicy<Container, DataLayout::SoA, TItem<Types...>> {
using type = std::tuple<Container<Types>...>;
using value_type = TItem<ref_wrap<Types>...>;
constexpr static value_type get( type& c_, std::size_t position_ )
{
return doGet( c_, position_, std::make_integer_sequence<unsigned, sizeof...( Types )>() ); // unrolling parameter pack
}
constexpr static void resize( type& c_, std::size_t size_ ) {
doResize( c_, size_, std::make_integer_sequence<unsigned, sizeof...( Types )>() ); // unrolling parameter pack
}
template <typename TValue>
constexpr static void push_back( type& c_, TValue&& val_ ){
doPushBack( c_, std::forward<TValue>(val_), std::make_integer_sequence<unsigned, sizeof...( Types )>() ); // unrolling parameter pack
}
static constexpr std::size_t size(type& c_){ return std::get<0>( c_ ).size(); }
private:
template <unsigned... Ids>
constexpr static auto doGet( type& c_, std::size_t position_, std::integer_sequence<unsigned, Ids...> )
{
return value_type{ ref_wrap( std::get<Ids>( c_ )[ position_ ] )... }; // guaranteed copy elision
}
template <unsigned... Ids>
constexpr static void doResize( type& c_, unsigned size_, std::integer_sequence<unsigned, Ids...> )
{
( std::get<Ids>( c_ ).resize( size_ ), ... ); //fold expressions
}
template <typename TValue, unsigned... Ids>
constexpr static void doPushBack( type& c_, TValue&& val_, std::integer_sequence<unsigned, Ids...> )
{
( std::get<Ids>( c_ ).push_back( std::get<Ids>( std::forward<TValue>( val_ ) ) ), ... ); // fold expressions
}
};
因此,现在这段代码非常清楚地显示了如何构建此抽象。我们在下面显示了使用它的可能策略。我们使用DataLayoutPolicy和通用的TItem类型定义policy_t类型
template <template <typename T> class TContainer, DataLayout TDataLayout, typename TItem>
using policy_t = DataLayoutPolicy<TContainer, TDataLayout, TItem>;
容器类将大多数调用转发到由policy_t类型定义的静态函数。它可能如下所示
template <template <typename ValueType> class TContainer, DataLayout TDataLayout, typename TItem>
struct BaseContainer
{
/*member functions like puhs_back, resize,...*/
value_type operator[]( std::size_t position_ )
{
return policy_t::get( mValues, position_ );
}
iterator begin() { return iterator( this, 0 ); }
iterator end() { return iterator( this, size() ); }
private:
typename policy_t::type mValues;
};
现在这不是标准容器,因此我们必须定义一个迭代器才能在STL算法中使用它。我们构建的迭代器看起来像是元组容器的STL迭代器,除了它必须包含对容器的引用这一事实,因为当我们调用解引用运算符时,我们要调用存储的operator [],它静态地调度容器的引用。使用容器的数据布局策略进行操作。
template <typename TContainer>
class Iterator
{
private:
using container_t = TContainer;
public:
/* ... usual iterator member functions and type definitions ...*/
template<typename TTContainer>
Iterator( TTContainer* container_, std::size_t position_ = 0 ):
mContainer( container_ )
, mIterPosition( position_ )
{
}
value_type operator*() {
return (*mContainer)[ mIterPosition ];
}
private:
container_t* mContainer = nullptr;
std::size_t mIterPosition = std::numeric_limits<std::size_t>::infinity();
};
最终,我们定义了“item”数据结构:将其构造为std::tuple的装饰器,并带有一些特定的成员函数(在这种情况下,仅是getter/setter)。
template<typename ... T>
struct Item : public std::tuple<T ...>{
using std::tuple<T...>::tuple;
auto & myDouble(){return std::get<0>(*this);}
auto & myChar() {return std::get<1>(*this);}
auto & myString(){return std::get<2>(*this);}
};
当我们调用Item的成员函数时,我们必须依靠编译器优化才能使我们的抽象成为“零成本”:我们不想调用Item构造函数,因为我们正在创建一个临时元组只是为了访问其中的一个成员每次,然后我们立即将其取消。
所以最终我们可以编写程序:
template<typename T>
using MyVector = std::vector<T, std::allocator<T>>;
int main(int argc, char** argv){
using container_t = BaseContainer<MyVector, DataLayout::SoA, Item<double, char, std::string, Pad> >;
container_t container_(1000);
for(auto&& i : container_){
i.myDouble()=static_cast<double>(argc);
}
而且我们可以编写通用且高效的代码,而无需考虑其下面的内存布局。剩下要做的就是检查这是否是零成本抽象。对我而言,最简单的检查方法是使用调试器:使用打开调试符号的示例进行编译,
> clang++ -std=c++1z -O3 -g main.cpp -o test
使用gdb运行它,在for循环中设置brakpoint,然后逐步执行汇编指令(layout split命令同时显示源代码和反汇编指令)
> gdb test
(gdb) break main.cpp : 10 # set breakpoint inside the loop
(gdb) run # execute until the breakpoint
(gdb) layout split # show assembly and source code in 2 separate frames
(gdb) stepi # execute one instruction
在AoS数据布局的情况下,在循环内部执行的指令
0x400b00 <main(int, char**)+192> movsd %xmm0,(%rsi)
0x400b04 <main(int, char**)+196> add $0x610,%rsi
0x400b0b <main(int, char**)+203> add $0xffffffffffffffff,%rcx
0x400b0f <main(int, char**)+207> jne 0x400b00 <main(int, char**)+192>
特别要注意的是,在第二行中,要计算地址的偏移量是0x160。这将根据item对象中数据成员的大小而变化。另一方面,对于SoA数据结构,我们拥有
0x400b60 <main(int, char**)+224> movups %xmm1,(%rdi,%rsi,8)
0x400b64 <main(int, char**)+228> movups %xmm1,0x10(%rdi,%rsi,8)
0x400b69 <main(int, char**)+233> movups %xmm1,0x20(%rdi,%rsi,8)
0x400b6e <main(int, char**)+238> movups %xmm1,0x30(%rdi,%rsi,8)
0x400b73 <main(int, char**)+243> movups %xmm1,0x40(%rdi,%rsi,8)
0x400b78 <main(int, char**)+248> movups %xmm1,0x50(%rdi,%rsi,8)
0x400b7d <main(int, char**)+253> movups %xmm1,0x60(%rdi,%rsi,8)
0x400b82 <main(int, char**)+258> movups %xmm1,0x70(%rdi,%rsi,8)
0x400b87 <main(int, char**)+263> movups %xmm1,0x80(%rdi,%rsi,8)
0x400b8f <main(int, char**)+271> movups %xmm1,0x90(%rdi,%rsi,8)
0x400b97 <main(int, char**)+279> movups %xmm1,0xa0(%rdi,%rsi,8)
0x400b9f <main(int, char**)+287> movups %xmm1,0xb0(%rdi,%rsi,8)
0x400ba7 <main(int, char**)+295> movups %xmm1,0xc0(%rdi,%rsi,8)
0x400baf <main(int, char**)+303> movups %xmm1,0xd0(%rdi,%rsi,8)
0x400bb7 <main(int, char**)+311> movups %xmm1,0xe0(%rdi,%rsi,8)
0x400bbf <main(int, char**)+319> movups %xmm1,0xf0(%rdi,%rsi,8)
0x400bc7 <main(int, char**)+327> add $0x20,%rsi
0x400bcb <main(int, char**)+331> add $0x8,%rbx
0x400bcf <main(int, char**)+335> jne 0x400b60 <main(int, char**)+224>
我们看到循环由Clang(版本6.0.0)展开并向量化,并且地址的增量为0x20,与item结构中存在的数据成员的数量无关。
关于c++ - SoA/AoS内存布局的C++零成本抽象,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/50574639/