Mercurial > hg > CbC > CbC_llvm
diff docs/SourceLevelDebugging.rst @ 121:803732b1fca8
LLVM 5.0
author | kono |
---|---|
date | Fri, 27 Oct 2017 17:07:41 +0900 |
parents | 1172e4bd9c6f |
children | 3a76565eade5 |
line wrap: on
line diff
--- a/docs/SourceLevelDebugging.rst Fri Nov 25 19:14:25 2016 +0900 +++ b/docs/SourceLevelDebugging.rst Fri Oct 27 17:07:41 2017 +0900 @@ -171,7 +171,48 @@ ---------------------------- LLVM uses several intrinsic functions (name prefixed with "``llvm.dbg``") to -provide debug information at various points in generated code. +track source local variables through optimization and code generation. + +``llvm.dbg.addr`` +^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: llvm + + void @llvm.dbg.addr(metadata, metadata, metadata) + +This intrinsic provides information about a local element (e.g., variable). +The first argument is metadata holding the address of variable, typically a +static alloca in the function entry block. The second argument is a +`local variable <LangRef.html#dilocalvariable>`_ containing a description of +the variable. The third argument is a `complex expression +<LangRef.html#diexpression>`_. An `llvm.dbg.addr` intrinsic describes the +*address* of a source variable. + +.. code-block:: llvm + + %i.addr = alloca i32, align 4 + call void @llvm.dbg.addr(metadata i32* %i.addr, metadata !1, + metadata !DIExpression()), !dbg !2 + !1 = !DILocalVariable(name: "i", ...) ; int i + !2 = !DILocation(...) + ... + %buffer = alloca [256 x i8], align 8 + ; The address of i is buffer+64. + call void @llvm.dbg.addr(metadata [256 x i8]* %buffer, metadata !3, + metadata !DIExpression(DW_OP_plus, 64)), !dbg !4 + !3 = !DILocalVariable(name: "i", ...) ; int i + !4 = !DILocation(...) + +A frontend should generate exactly one call to ``llvm.dbg.addr`` at the point +of declaration of a source variable. Optimization passes that fully promote the +variable from memory to SSA values will replace this call with possibly +multiple calls to `llvm.dbg.value`. Passes that delete stores are effectively +partial promotion, and they will insert a mix of calls to ``llvm.dbg.value`` +and ``llvm.dbg.addr`` to track the source variable value when it is available. +After optimization, there may be multiple calls to ``llvm.dbg.addr`` describing +the program points where the variables lives in memory. All calls for the same +concrete source variable must agree on the memory location. + ``llvm.dbg.declare`` ^^^^^^^^^^^^^^^^^^^^ @@ -180,25 +221,28 @@ void @llvm.dbg.declare(metadata, metadata, metadata) -This intrinsic provides information about a local element (e.g., variable). -The first argument is metadata holding the alloca for the variable. The second -argument is a `local variable <LangRef.html#dilocalvariable>`_ containing a -description of the variable. The third argument is a `complex expression -<LangRef.html#diexpression>`_. +This intrinsic is identical to `llvm.dbg.addr`, except that there can only be +one call to `llvm.dbg.declare` for a given concrete `local variable +<LangRef.html#dilocalvariable>`_. It is not control-dependent, meaning that if +a call to `llvm.dbg.declare` exists and has a valid location argument, that +address is considered to be the true home of the variable across its entire +lifetime. This makes it hard for optimizations to preserve accurate debug info +in the presence of ``llvm.dbg.declare``, so we are transitioning away from it, +and we plan to deprecate it in future LLVM releases. + ``llvm.dbg.value`` ^^^^^^^^^^^^^^^^^^ .. code-block:: llvm - void @llvm.dbg.value(metadata, i64, metadata, metadata) + void @llvm.dbg.value(metadata, metadata, metadata) This intrinsic provides information when a user source variable is set to a new value. The first argument is the new value (wrapped as metadata). The second -argument is the offset in the user source variable where the new value is -written. The third argument is a `local variable -<LangRef.html#dilocalvariable>`_ containing a description of the variable. The -fourth argument is a `complex expression <LangRef.html#diexpression>`_. +argument is a `local variable <LangRef.html#dilocalvariable>`_ containing a +description of the variable. The third argument is a `complex expression +<LangRef.html#diexpression>`_. Object lifetimes and scoping ============================ @@ -227,6 +271,9 @@ 8. X = Y; 9. } +.. FIXME: Update the following example to use llvm.dbg.addr once that is the + default in clang. + Compiled to LLVM, this function would be represented like this: .. code-block:: text