forbid rtti and exceptions
authorChris Lattner <sabre@nondot.org>
Tue, 30 Nov 2010 19:20:40 +0000 (19:20 +0000)
committerChris Lattner <sabre@nondot.org>
Tue, 30 Nov 2010 19:20:40 +0000 (19:20 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@120450 91177308-0d34-0410-b5e6-96231b3b80d8

docs/CodingStandards.html

index ff00c8167381e8df4cffbc1769e05b43731ba47a..a2420805ec64cf5fecead148baf0cd1deaaf8b15 100644 (file)
@@ -29,6 +29,7 @@
           <li><a href="#ci_warningerrors">Treat Compiler Warnings Like
               Errors</a></li>
           <li><a href="#ci_portable_code">Write Portable Code</a></li>
+          <li><a href="#ci_rtti_exceptions">Do not use RTTI or Exceptions</a></li>
           <li><a href="#ci_class_struct">Use of <tt>class</tt>/<tt>struct</tt> Keywords</a></li>
         </ol></li>
     </ol></li>
@@ -404,6 +405,28 @@ libSystem.</p>
 
 </div>
 
+<!-- _______________________________________________________________________ -->
+<div class="doc_subsubsection">
+<a name="ci_rtti_exceptions">Do not use RTTI or Exceptions</a>
+</div>
+<div class="doc_text">
+
+<p>LLVM does not use RTTI (e.g. dynamic_cast&lt;&gt;) or exceptions, in an
+effort to reduce code and executable size.  These two language features violate
+the general C++ principle of "you only pay for what you use", causing executable
+bloat even if exceptions are never used in a code base, or if RTTI is never used
+for a class.  Because of this, we turn them off globally in the code.
+</p>
+
+<p>
+That said, LLVM does make extensive use of a hand-rolled form of RTTI that use
+templates like <a href="ProgrammersManual.html#isa">isa&lt;&gt;, cast&lt;&gt;,
+and dyn_cast&lt;&gt;</a>.  This form of RTTI is opt-in and can be added to any
+class.  It is also substantially more efficient than dynamic_cast&lt;&gt;.
+</p>
+
+</div>
+
 <!-- _______________________________________________________________________ -->
 <div class="doc_subsubsection">
 <a name="ci_class_struct">Use of <tt>class</tt> and <tt>struct</tt> Keywords</a>