加速 C++ Template 編譯時間：優化編譯效率的方法

這是個冷門的知識

所以我打算紀錄一下

Template

template 並不是一般的 code，只是一個模板，需要等我們把數值填進去後，才會形成一般的 code，一般來說，C++ template 的宣告和定義會寫在一起，因為我們可以同時拿到填入數值後的宣告和定義，像下方這樣：

有一個 template 的檔案。

template<class T>
class Foo {
 private:
  T data;
 public:
  void setData(const T &val) {
    data = val;
  }
};

然後引用這個 template。

#include "template.hpp"

int main(){
  Foo<int> foo;
  foo.setData(100);
}

但把宣告和定義寫在一起除了 code 會很混雜之外，假設我們同時有好幾個 cpp 檔案都要用到 Foo<int>，我們會處理 Foo<int> 好幾次，每個 translation unit 中 compiler 都要 instantiate Foo<int> 一次，會增加編譯時間。

分開宣告和定義

於是乎，有了上述說的缺點，你可能會想說：那我就把宣告和定義分開，就如同我一般寫 header 和 cpp 時候的作法，這樣就可以只要編譯一次，然後將架構改成這樣：

有一個 template 的宣告檔案。

template<class T>
class Foo {
 private:
  T data;
 public:
  void setData(const T &val);
};

還有一個 template 的定義檔案。

#include "template.hpp"

template<class T>
void Foo<T>::setData(const T &val) {
  data = val;
}

然後引用這個 template。

#include "template.hpp"

int main(){
  Foo<int> foo;
  foo.setData(100);
}

看起來都沒有問題，但 Link 的時候發現出錯了，找不到 Foo<int>::setData 的定義，這是因為 main.cpp 並看不到 template.cpp 裡面的定義，在編譯 template.cpp 的時候，compiler 也沒有產生和處理 Foo<int>::setData 的部分，因為 compiler 也不知道 T 要填甚麼，只知道這是個 template。

Extern Template Declarations

那怎麼辦？既然沒有定義，那我們就產生定義出來吧，我們直接明確的產生實例，也就是 explicit template instantiation，如下：

一樣有一個 template 的宣告檔案。

template<class T>
class Foo {
 private:
  T data;
 public:
  void setData(const T &val);
};

還有一個 template 的定義檔案，但我們加了 explicit template instantiation，由於在 main.cpp 需要的是 Foo<int>，因此這邊也是 Foo<int>。

#include "template.hpp"

template<class T>
void Foo<T>::setData(const T &val) {
  data = val;
}

template class Foo<int>;

然後用 extern template declarations 跟 compiler 說，我有 Foo 的實例，但是在其他檔案中。

#include "template.hpp"

extern template class Foo<int>;

int main(){
  Foo<int> foo;
  foo.setData(100);
}

這樣我們就可以成功編譯，並且 compiler 只會 instantiate Foo<int> 一次。

Reference

• https://stackoverflow.com/questions/495021/why-can-templates-only-be-implemented-in-the-header-file
• https://isocpp.org/wiki/faq/templates#templates-defn-vs-decl
• https://stackoverflow.com/questions/8130602/using-extern-template-c11-to-avoid-instantiation
• https://arne-mertz.de/2019/02/extern-template-reduce-compile-times/
• https://www.reddit.com/r/cpp/comments/wcskvj/do_you_think_template_classes_will_ever_be_able/
• https://ithelp.ithome.com.tw/articles/10308673
• https://goodspeedlee.blogspot.com/2016/01/c-pimpl.html
• https://blog.modest-destiny.com/posts/split-cpp-template-declaration-and-implementation/
• https://isocpp.org/wiki/faq/cpp11-language-templates