habrahabr

Идеальная передача и универсальные ссылки в C++

  • понедельник, 10 ноября 2014 г. в 02:10:52
http://habrahabr.ru/post/242639/

Недавно на isocpp.org была опубликована ссылка на статью Eli Bendersky «Perfect forwarding and universal references in C++». В этой небольшой статье есть простой ответ на простой вопрос — для решения каких задач и как нужно использовать rvalue.

Одно из нововведений C++11, которое нацелено на увеличение эффективности программ – это семейство методов emplace у контейнеров STL. Например, в std::vector появился метод emplace_back (практически аналог метода push_back) и метод emplace (практически аналог метода insert).
Вот небольшой пример, показывающий предназначение этих новых методов:
class MyKlass {
public:
  MyKlass(int ii_, float ff_) {...}
private:
  {...}
};

some function {
  std::vector<MyKlass> v;
  v.push_back(MyKlass(2, 3.14f));
  v.emplace_back(2, 3.14f);
}

Если проследить за вызовами конструкторов и деструкторов класса MyKlass, во время вызова push_back можно увидеть следующее:

  • Сначала выполняется конструктор временного объекта класса MyKlass
  • Затем, для объекта, непосредственно расположенного внутри вектора, вызывается конструктор перемещения (если такой определен в MyClass, если не определен – тогда вызывается конструктор копирования)
  • Деструктор временного объекта

Как видно, выполняется довольно много работы, большее количество которой не очень то и нужно, так как объект, передаваемый в метод push_back, очевидно является rvalue-ссылкой, и уничтожается сразу после выполнения этого выражения. Таким образом, нет никакой причины создавать и уничтожать временный объект. Почему же, в этом случае, не создать объект сразу внутри вектора? Это именно то, что делает метод emplace_back. Для выражения из примера v.emplace_back(2, 3.14f) выполнится только один конструктор, который создает объект внутри вектора. Без использования временных объектов. emplace_back сам вызывает конструктор MyKlass и передает ему нужные аргументы. Это поведение стало возможным благодаря двум нововведениям С++11: шаблоны с переменным количеством аргументов (variadic templates) и идеальная передача (perfect forwarding). В данной статье я хочу пояснить, как работает идеальная передача и как ее использовать.

Проблема идеальной передачи


Допустим, есть некоторая функция func, принимающая параметры типов E1, E2, …, En. Требуется создать функцию wrapper, принимающую такой же набор параметров. Другими словами – определить функцию, которая передаст принимаемые параметры в другую функцию, не создавая временные переменные, то есть выполнит идеальную передачу.
Для того чтобы конкретизировать задачу, рассмотрим метод emplace_back, который был описан выше. vector::emplace_back передает свои параметры конструктору T не зная ничего о том, чем является T.
Следующим шагом рассмотрим несколько примеров, показывающих как можно добиться подобного поведения без использования нововведений С++11. Для упрощения не будем учитывать необходимость использования шаблонов с переменным количеством параметров аргументов, предположим, что требуется передать только два аргумента.
Первый вариант, который приходит на ум:
template <typename T1, typename T2>
void wrapper(T1 e1, T2 e2) {
    func(e1, e2);
}

Но это очевидно не будет работать как нужно, если func принимает параметры по ссылке, так как wrapper принимает параметры по значению. В этом случае, если func изменяет получаемые по ссылке параметры, это не отразится на параметрах, переданных во wrapper (будут изменены копии, созданные внутри wrapper).
Хорошо, тогда мы можем переделать wrapper, чтобы он принимал параметры по ссылке. Это не будет помехой, если func будет принимать не по ссылке, а по значению, так как func внутри wrapper сделает себе необходимые копии.
template <typename T1, typename T2>
void wrapper(T1& e1, T2& e2) {
    func(e1, e2);
}

Здесь другая проблема. Rvalue не может быть передано в функцию в качестве ссылки. Таким образом вполне тривиальный вызов не скомпилируется:
wrapper(42, 3.14f);                  	// ошибка: инициализация неконстантной ссылки rvalue-значением
wrapper(i, foo_returning_float());   // та же ошибка

И сразу нет, если пришла мысль сделать эти ссылки константными – это тоже не решит проблему. Потому что func может требовать в качестве параметров неконстантные ссылки.
Остается только грубый подход, используемый в некоторых библиотеках: перегрузить функцию для константных не неконстантных ссылок:
template <typename T1, typename T2>
void wrapper(T1& e1, T2& e2)                { func(e1, e2); }

template <typename T1, typename T2>
void wrapper(const T1& e1, T2& e2)          { func(e1, e2); }

template <typename T1, typename T2>
void wrapper(T1& e1, const T2& e2)          { func(e1, e2); }

template <typename T1, typename T2>
void wrapper(const T1& e1, const T2& e2)    { func(e1, e2); }

Экспоненциальный рост. Можно представить, сколько веселья это доставит, когда потребуется обработать какое-то разумное количество параметров реальных функций. Чтобы ухудшить ситуацию С++11 добавляет rvalue ссылки, которые тоже нужно учесть в функции wrapper, и это точно не является расширяемым решением.

Сжатие ссылок и особый вывод типа для rvalue-ссылок


Для объяснения того, как в С++11 реализуется идеальная передача, нужно сначала понять два новых правила, которые были добавлены в этот язык программирования.
Начнем с простого – сжатия ссылок (reference collapsing). Как известно, взятие ссылки на ссылку в С++ не допускается, но это иногда может происходить при реализации шаблонов:
template <typename T>
void baz(T t) {
  T& k = t;
}

Что случится, если вызвать эту функцию следующим образом:
int ii = 4;
baz<int&>(ii);

При инстанцировании шаблона T установится равным int&. Какой же тип будет у переменной k внутри функции? Компилятор «увидит» int& & — а так как это запрещенная конструкция, компилятор просто преобразует это в обычную ссылку. Фактически, до С++11 такое поведение не было стандартизированным, но многие компиляторы принимали и преобразовывали такой код, так как он часто встречается в метапрограммировании. После того, как в С++11 были добавлены rvalue-ссылки, стало важным определить поведение при совмещении различных типов ссылок (например, что значит int&& & ?).
Так появилось правило сжатия ссылок. Это правило очень простое – одиночный амперсанд (&) всегда побеждает. Таким образом – (& и &) это (&), также как и (&& и &), и (& и &&). Единственный случай, при котором в результате сжатия получается (&&) — это (&& и &&). Это правило можно сравнить с результатом выполнения логического ИЛИ, в котором & это 1, а && это 0.
Другое дополнение С++, имеющее прямое отношение к рассматриваемой теме – это правила особого вывода типа (special type deduction rules) для rvalue-ссылок в различных случаях [1]. Рассмотрим пример шаблонной функции:
template <class T>
void func(T&& t) {
}

Не позволяйте двойному амперсанду обмануть Вас – t здесь не является rvalue-ссылкой [2]. При появлении в данной ситуации (когда необходим особый вывод типа), T&& принимает особое значение – когда func инстанцируется, T изменяется в зависимости от переданного типа. Если была передана lvalue типа U, то Т становится U&. Если же U это rvalue, то Т становится просто U. Пример:
func(4);            // 4 это rvalue: T становится int

double d = 3.14;
func(d);            // d это lvalue; T становится double&

float f() {...}
func(f());          // f() это rvalue; T становится float

int bar(int i) {
  func(i);          // i это lvalue; T становится int&
}


Это правило может показаться необычным и даже странным. Оно такое и есть. Но, тем не менее, это правило становится вполне очевидным, когда приходит понимание что это правило помогает решить проблему идеальной передачи.

Реализация идеальной передачи с использованием std::forward


Теперь давайте вернемся к нашей описанной выше шаблонной функции wrapper. Вот как она должна быть реализована с использованием С++11:
template <typename T1, typename T2>
void wrapper(T1&& e1, T2&& e2) {
    func(forward<T1>(e1), forward<T2>(e2));
}

А вот как реализован forward [3]:
template<class T>
T&& forward(typename std::remove_reference<T>::type& t) noexcept {
  return static_cast<T&&>(t);
}

Рассмотрим следующий вызов:
int ii ...;
float ff ...;
wrapper(ii, ff);

Рассмотрим первый аргумент (второй аналогичен): ii является lvalue, таким образом T1 становится int& в соответствии с правилом особого вывода типа. Получается вызов func(forvard<int&>(e1), …). Таким образом, шаблон forward инстанцирован типом int& и получаем следующую версию этой функции:
int& && forward(int& t) noexcept {
    return static_cast<int& &&>(t);
}

Время применить правило сжатия ссылок:
int& forward(int& t) noexcept {
    return static_cast<int&>(t);
}

Другими словами, аргумент передан по ссылке в func, как и требуется для lvalue.
Следующий пример:
wrapper(42, 3.14f);

Здесь аргументы являются rvalue, таким образом T1 становится int. Получаем вызов func(forward(e1), ...). Таким образом, шаблонная функция forward инстанцирована типом int и получаем следующую версию функции:
int&& forward(int& t) noexcept {
    return static_cast<int&&>(t);
}

Аргумент, полученный по ссылке, приводится к rvalue-ссылке, которую и требуется получить от forward.
Шаблонную функцию forward можно рассматривать как некоторую обертку над static_cast<T&&>(t), когда T может принять значение U& или U&&, в зависимости от типа входного аргумента (lvalue или rvalue). Теперь wrapper является одним шаблоном, который обрабатывает любые сочетания типов аргументов.
Шаблонная функция forward реализована в С++11, в заголовочном файле «utility», в пространстве имен std.

Еще один момент, который нужно отметить: использование std::remove_reference. На самом деле forward может быть реализован и без использования этой функции. Сжатие ссылок выполнит всю работу, таким образом, применение std::remove_reference для этого избыточно. Однако, эта функция позволяет вывести T& t в ситуации, когда этот тип не может быть выведен (согласно стандарту С++, 14.8.2.5), поэтому необходимо явно указывать параметры шаблона при вызове std::forward.

Универсальные ссылки


В своих выступлениях, постах в блоге и книгах, Скотт Майерс дает наименование «универсальные ссылки» (universal reference) для rvalue, которые в контексте вывода типов. Удачное это наименование или нет, сложно сказать. Что касается меня, когда я первый раз прочитал относящуюся к данной теме главу из новой книги «Effective C++», я почувствовал, что запутался. Более-менее стало все понятно позже, когда я разобрался с лежащими в основе этого механизмами (сжатия ссылок и правил особого вывода типов).
Ловушка заключается в том, что фраза «универсальные ссылки» [4] конечно более кратка и красива, чем «rvalue-ссылки в контексте вывода типов». Но если есть желание на самом деле понять некоторый код, не получится избежать полного описания.

Примеры использования идеальной передачи


Идеальная передача довольно полезна, потому что делает возможным программирование на более высоком уровне. Функции высшего порядка – это функции, которые могут принять другие функции в качестве аргументов или возвращать их. Без идеальной передачи, применение функций высшего порядка довольно обременительно, так как нет удобного способа передать аргументы в функцию внутри функции-обертки. Под термином «функция» я здесь кроме самих функций также имею в виду и классы, конструкторы которых фактически тоже являются функциями.
В начале данной статьи я описывал метод контейнеров emplace_back. Другой хороший пример – это стандартная шаблонная функция make_unique, которую я описывал в предыдущей статье:
template<typename T, typename... Args>
unique_ptr<T> make_unique(Args&&... args)
{
    return unique_ptr<T>(new T(std::forward<Args>(args)...));
}

Признаюсь честно, что в той статье я просто игнорировал странный двойной амперсанд и фокусировался на переменном количестве аргументов шаблона. Но сейчас совершенно несложно полностью понять код. Само собой разумеется, что идеальная передача и шаблоны с переменным количеством аргументов очень часто используются вместе, потому что, в большинстве случаев неизвестно, какое количество аргументов принимают функция или конструктор, которым мы передаем эти аргументы.
В качестве примера со значительно более сложным использованием идеальной передачи Вы можете посмотреть реализацию std::bind.

Ссылки на источники


Вот некоторые источники, которые мне очень помогли при подготовке материала:
  1. The 4th edition of «The C++ Programming Language» by Bjarne Stroustrup
  2. The new «Effective Modern C++» by Scott Myers. В этой книге широко обсуждаются «универсальные ссылки». Фактически, данной теме посвящено более пятой части этой книги.
  3. Technical paper n1385: «The forwarding problem: Arguments».
  4. Thomas Becker C++ Rvalue references explained – отлично написанная и очень полезная статья

Примечания:
[1] Также может применяться auto и decltype, здесь я описываю только случай использования шаблона.
[2] Я считаю неудачным решение комитета стандартизации С++ по выбору обозначения для rvalue (перегрузка &&). Скотт Майерс признался в своем выступлении (и немного комментировал в своем блоге), что после 3 лет этот материал до сих пор непрост в изучении. И Бьерн Страуструп в The 4th edition of «The C++ Programming Language» при описании std::forward забыл явное указание аргумента шаблона. Можно сделать вывод, что это действительно довольно непростая область.
[3] Это упрощенная версия std::forward из STL C++11. Там еще есть дополнительная версия, перегруженная явно для rvalue аргументов. Я до сих пор стараюсь разобраться, зачем она нужна. Дайте знать, если есть какая-либо идея.
[4] Передающиеся ссылки (forwarding references) – еще одно обозначение, которое я встречал

От переводчика: на CppCon2014 многими (в том числе Мейерсом, Страуструпом, Саффером) было принято решение использовать термин forwarding references вместо universal references.

Пара статей на хабре по данной теме:
Краткое введение в rvalue-ссылки
«Универсальные» ссылки в C++11 или T&& не всегда означает «Rvalue Reference»