inline的用法详解

转自 http://blog.sina.com.cn/s/blog_96cf88680101j5kt.html

（一）inline函数（摘自C++ Primer的第三版）

           在函数声明或定义中函数返回类型前加上关键字inline即把min（）指定为内联。

         inline int min(int first, int secend) {};

         inline函数对编译器而言必须是可见的，以便它能够在调用点内展开该函数。与非inline函数不同的是，inline函数必须在调用该函数的每个文本文件中定义。当然，对于同一程序的不同文件，如果inline函数出现的话，其定义必须相同。对于由两个文件compute.c和draw.c构成的程序来说，程序员不能定义这样的min()函数，它在compute.c中指一件事情，而在draw.c中指另外一件事情。如果两个定义不相同，程序将会有未定义的行为：

          为保证不会发生这样的事情，建议把inline函数的定义放到头文件中。在每个调用该inline函数的文件中包含该头文件。这种方法保证对每个inline函数只有一个定义，且程序员无需复制代码，并且不可能在程序的生命期中引起无意的不匹配的事情。

（二）内联函数的编程风格(摘自高质量C++/C 编程指南)

           关键字inline 必须与函数定义体放在一起才能使函数成为内联，仅将inline 放在函数声明前面不起任何作用。

           如下风格的函数Foo 不能成为内联函数：

           inline void Foo(int x, int y);       // inline 仅与函数声明放在一起

           void Foo(int x, int y){}

           而如下风格的函数Foo 则成为内联函数：

           void Foo(int x, int y);

           inline void Foo(int x, int y)       // inline 与函数定义体放在一起

           所以说，inline 是一种“用于实现的关键字”，而不是一种“用于声明的关键字”。一般地，用户可以阅读函数的声明，但是看不到函数的定义。尽管在大多数教科书中内联函数的声明、定义体前面都加了inline 关键字，但我认为inline 不应该出现在函数的声明中。这个细节虽然不会影响函数的功能，但是体现了高质量C++/C 程序设计风格的一个基本原则：声明与定义不可混为一谈，用户没有必要、也不应该知道函数是否需要内联。

           定义在类声明之中的成员函数将自动地成为内联函数，例如

         class A{public:void Foo(int x, int y) {   } 

         // 自动地成为内联函数

         将成员函数的定义体放在类声明之中虽然能带来书写上的方便，但不是一种良好的编程风格，上例应该改成：

         // 头文件

         class A{public:void Foo(int x, int y)；

         // 定义文件

         inline void A::Foo(int x, int y){} 

         慎用内联内联能提高函数的执行效率，为什么不把所有的函数都定义成内联函数？如果所有的函数都是内联函数，还用得着“内联”这个关键字吗？内联是以代码膨胀（复制）为代价，仅仅省去了函数调用的开销，从而提高函数的执行效率。如果执行函数体内代码的时间，相比于函数调用的开销较大，那么效率的收获会很少。另一方面，每一处内联函数的调用都要复制代码，将使程序的总代码量增大，消耗更多的内存空间。

           以下情况不宜使用内联：（1）如果函数体内的代码比较长，使用内联将导致内存消耗代价较高。（2）如果函数体内出现循环，那么执行函数体内代码的时间要比函数调用的开销大。类的构造函数和析构函数容易让人误解成使用内联更有效。要当心构造函数和析构函数可能会隐藏一些行为，如“偷偷地”执行了基类或成员对象的构造函数和析构函数。所以不要随便地将构造函数和析构函数的定义体放在类声明中。一个好的编译器将会根据函数的定义体，自动地取消不值得的内联（这进一步说明了inline 不应该出现在函数的声明中）。

 

注意点:

              内联函数既能够去除函数调用所带来的效率负担又能够保留一般函数的优点。然而，内联函数并不是万能药， 在一些情况下，它甚至能够降低程序的性能。因此在使用的时候应该慎重。    

               1．我们先来看看内联函数给我们带来的好处：从一个用户的角度来看，内联函数看起来和普通函数一样， 它可以有参数和返回值，也可以有自己的作用域，然而它却不会引入一般函数调用所带来的负担。另外，    它可以比宏更安全更容易调试。    当然有一点应该意识到，inline    specifier仅仅是对编译器的建议，编译器有权利忽略这个建议。那么编译器是如何决定函数内联与否呢？一般情况下关键性因素包括函数体的大小，是否有局部对象被声明，函数的复杂性等等。    

               2．那么如果一个函数被声明为inline但是却没有被内联将会发生什么呢？理论上，当编译器拒绝内联一个函数的时候，那个函数会像普通函数一样被对待，但是还会出现一些其他的问题。例如下面这段代码：    

   //    filename    Time.h    

   #include    

   #include    

   using    namespace    std;    

   class    Time    

   {    

   public:    

               inline    void    Show()    {    for    (int    i    =    0;    i<10;    i++)    cout<<time(0)<<endl;}    

   };    

               因为成员函数Time::Show()包括一个局部变量和一个for循环，所以编译器一般拒绝inline，并且把它当作一个普通的成员函数。但是这个包含类声明的头文件会被单独的#include进各个独立的编译单元中：    

   //    filename    f1.cpp    

   #include    "Time.hj"    

   void    f1()    

   {    

               Time    t1;    

               t1.Show();    

   }    

      

   //    filename    f2.cpp    

   #include    "Time.h"    

   void    f2()    

   {    

               Time    t2;    

               t2.Show();    

   }    

   结果编译器为这个程序生成了两个相同成员函数的拷贝：    

   void    f1();    

   void    f2();    

   int    main()    

   {    

               f1();       

               f2();    

         return    0;    

   }    

      

            当程序被链接的时候，linker将会面对两个相同的Time::Show()拷贝，于是函数重定义的连接错误发生。但是老一些的C++实现对付这种情况的办法是通过把一个un-inlined函数当作static来处理。因此每一份函数拷贝仅仅在自己的编译单元中 。可见，这样链接错误就解决了，但是在程序中却会留下多份函数拷贝。在这种情况下，程序的性能不但没有提升，反而增加了编译和链接时间以及最终可执行体的大小。但是幸运的是，新的C++标准中关于un-inlined函数的说法已经改变。一个符合标准C++实现应该只生成一份函数拷贝。然而，要想所有的编译器都支持这一点可能还需要很长时间。    

           另外关于内联函数还有两个更令人头疼的问题。第一个问题是该如何进行维护。 一个函数开始的时候可能以内联的形式出现，但是随着系统的扩展，函数体可能要求添加额外的功能，结果内联函数就变得不太可能，因此需要把inline    specifier 去除以及把函数体放到一个单独的源文件中。另一个问题是当内联函数被应用在代码库的时候产生。当内联函数改变的时候，用户必须重新编译他们的代码以反映这    

种改变。然而对于一个非内联函数，用户仅仅需要重新链接就可以了。这里想要说的是，内联函数并不是一个增强性能的灵丹妙药。只有当函数非常短小的时候它才能得到我们想要的效果，但是如果函数并不是很短而且在很多地方都被调用的话，那么将会使得可执行体的体积增大。最令人烦恼的还是当编译器拒绝内联的时候。在老的实现中，结果很不尽人意，虽然在新的实现中有很大的改善，但是仍然还是不那么完善的。一些编译器能够足够的聪明来指出哪些函数可以内联哪些不能，但是，大多数编译器就不那么聪明了，因此这就需要我们的经验来判断。如果内联函数不能增强行能，就避免使用它！    

  用指针代替数组      

            在许多种情况下，可以用指针运算代替数组索引，这样做常常能产生又快又短的代码。与数组索引相比，指针一般能使代码速度更快，占用空间更少。使用多维数组时差异更明显。下面的代码作用是相同的，但是效率不一样。    

      

   char*    pBuffer    =    new    char[100];    

   nTestNumber    =    0;    

      

   for(dwIndex    =    0;dwIndex    <    100;dwIndex    ++)    

   {    

   nTestNumber    =    pBuffer[dwIndex];    

   }    

      

   char*    pTemp    =    pBuffer;    

   for(dwIndex    =    0;dwIndex    <    100;dwIndex    ++)    

   {    

   nTestNumber    =    *(pTemp    ++);    

   }    

      

              指针方法的优点是，pBuffer的地址每次装入地址pTemp后，在每次循环中只需对pTemp增量操作。在数组索引方法中，每次循环中都必须进行基于dwIndex值求数组下标的复杂运算。    

 

inline vs. __forceinline

MS Visual C++, 以及其它几种编译器，提供了一个非标准的用于控制函数内嵌（inline）的关键字，作为对标准关键字inline的补充。为什么要添加这个非标准关键字呢？先让我们来看看inline的一些局限，决定一个声明为inline的函数是否真的进行嵌入，完全取决于编译器的判断。因此inline只是一个建议，在一些情况下，比如在一些内嵌函数中包含有循环或是这个函数体太大了，那么即使这个函数声明为inline，编译器也将拒绝这个函数的嵌入。

与此相反，非标准关键字__forceinline 将忽略编译器的判断并强迫编译器去嵌入一个它本该拒绝嵌入的函数。我不太肯定使用这个关键字的意义， 它可能会使可执行文件变得臃肿并降低cache的命中率。幸运的是，在一些极端条件下，编译器可能不接受__forceinline的任何请求。所以，一般情况下最好是使用标准的inline，inline是可移植的并且让编译器去做出“正确的选择”。 __forceinline 只应在下列条件全为真的情况下使用：inline不被编译器接受；你的代码不需要向其它平台进行移植；并且你能肯定嵌入这个函数会提高性能。

inline本身还有另外一个意义： 

一个可执行文件的cpp文件中一个函数只能被定义一次。如果你把函数定义在一个.h文件中并让两个cpp包含就会造成这个函数分别在两个cpp中被定义产生错误。但是inline函数是允许在多个cpp中多次定义的，就解决了这个问题。

可参考《 google c++ style guide》

      1、inline函数不要超过10行代码，且不能包含循环、switch、if语句。

      2、在一个c文件中定义的inline函数是不能在其它c文件中直接使用，google推荐把inline函数定义在**-inl.h头文件中。

      3、不要过度使用inline函数定义，尤其对大函数来说。

        当我们过度使用inline函数，会造成程序文件变大，性能降低。现在的CPU上都有cache，紧凑的代码在cache中保存的时间更长，这样cache命中的机会更高。

      如果某个A函数未定义为inline，并且被很多其它函数调用，那个这个A函数很大的可能会长期被保存在cache中，这样CPU对代码的执行速度会提高很多。如果A函数被定义为了inline函数，代码分散各个调用函数中，这样每次指定都不命中都需要去内存把代码拷贝到cache中，然后执行，造成很大的抖动。当函数整个函数编译为的汇编代码，函数调用的上下文切换占用了大多的时间的时候，可以考虑把此函数定义为inline函数。

        inline不会引入一般函数调用所带来的负担，但又比宏更安全更容易调试。然而内联函数并不是万能药，在一些情况下，它甚至能够降低程序的性能。

        内联函数和普通函数的区别：普通函数被调用时，系统先要保存当前的上下文（context），然后进入函数内，返回时还要恢复保存的上下文环境，如果是一个简单的函数的话，调用前的入栈代码，调用后的出栈代码数量可能就已经超过函数本身的代码了，如果需要很频繁地调用这个函数，那么，会有很多的系统开销用在调用函数的代码上。内联函数可以解决这个问题，编译器将内联函数的代码在编译时就插入到被调用处，这样调用这些代码时就不再需要出入栈的开销了。

        内联函数与宏的区别：就如普通函数和宏的区别。有参数，有返回值，有作用域，相对宏而言安全性和可调试性强。

  定义内联函数的方法：

  1.在成员函数定义前加上 inline 关键字，并且将定义放入头文件中：

inline void Fred::f(int i, char c) { // ... }

通常将函数的定义（{...}之间的部分）放在头文件中是强制的。如果你将内联函数的定义放在 .cpp 文件中并且在其他 .cpp 文件中调用它，连接器将给出“unresolved external”错误。

2.在类声明体内部定义了函数体的函数，无须inline关键字即默认为内联函数。如： class MyClass { private: int a, b; public: int add( ) { return a + b; } inline int dec( ) { return a- b; } }; 这里函数add和dec都是内联函数。 尽管这对于写类的人来说很容易，但由于它将类是“什么”(what)和类“如何”(how)工作混在一起，给阅读的人带来了困难。我们通常更愿意在类体外使用inline关键字来定义成员函数来避免这种混合。这种感觉所基于的认识是：在一个面向重用的世界中，使用你的类的人有很多，而建造它的人只有一个（你自己）；因此你做任何事都应该照顾多数而不是少数。

3.在类声明体内声明了函数，在类声明体外部实现函数，但在函数体前加上inline关键词，如： class MyClass { private: int a, b; public: inline int add( ); int dec( ); }; inline int MyClass::add( ) { return a + b; } int MyClass::diff( ) { return a - b; } 这里add是内联函数，而dec则不是内联函数。

内联函数保证执行性能更好吗?

不。

小心过度使用内联函数可能导致代码膨胀。在页面调度环境中，它可能会给执行性能带来负面影响。

代码膨胀术语只表示代码的尺寸会增大（膨胀）。在有关内联函数的上下文中，更关心的是内联函数会增加执行代码的尺寸，并导致操作系统不稳定。这意味着操作系统要花费大部分的时间从磁盘取出代码。

当然，内联函数也可能减小执行代码的尺寸。看上去反了，其实是真的。特别是，调用函数的代码总量有时会大于展开的内联函数的代码总量。这样的情况会发生于非常小的函数，当优化器能删除很多冗余代码时——也就是当优化器能使长的函数变短时，也可能会发生于长的函数。 另外关于内联函数还有两个更令人头疼的问题。第一个问题是该如何进行维护。一个函数开始的时候可能以内联的形式出现，但是随着系统的扩展，函数体可能要求添加额外的功能，结果内联函数就变得不太可能，因此需要把inline specifier去除以及把函数体放到一个单独的源文件中。另一个问题是当内联函数被应用在代码库的时候产生。当内联函数改变的时候，用户必须重新编译他们的代码以反映这种改变。然而对于一个非内联函数，用户仅仅需要重新链接就可以了。 什么时候才适合使用内联函数呢？

微软的MSDN说最好用在代码量较少逻辑简单的函数上，如访问类私有数据成员的函数。当函数的代码量较大时，此时调用函数的开销对于函数本身的执行开销变得微不足道了，而插入代码却使得整个程序的代码量大大增加从而使系统执行这个程序的开销增加，这就有点得不偿失了，所以，通常编译器会权衡利弊，决定是否放弃使用某些内联函数，仍将其当作普通函数来编译。如果你非要自己决定将一个函数定义为内联函数，VC++中可以用__forceinline关键词来代替inline，但在某些情况下仍然没法让编译器使用内联，例如递归函数，可变参数函数。总的来说，inline specifier仅仅是对编译器的建议，编译器有权利忽略这个建议。那么编译器是如何决定函数内联与否呢？一般情况下关键性因素包括函数体的大小，是否有局部对象被声明，函数的复杂性等等。