assignements: tc-l: Add section for debug information

* assignements.texi: Here.

assignments.texi

@@ -5,7 +5,7 @@
 @settitle The Tiger Compiler Project Assignment
 
 @c Updated when you save this file:
-@set lastupdate April 14, 2016
+@set lastupdate December 12, 2016
 @set class 2019
 
 @c Name of the project.
@@ -452,6 +452,7 @@ TC-L, @acro{llvm ir}
 * TC-L Code to Write::          Explanation on what you have to write
 * TC-L FAQ::                    Questions not to ask
 * TC-L Improvements::           Other Designs
+* TC-L Debug information::      Debugger bonus
 
 Tools
 
@@ -10306,6 +10307,7 @@ between strings.
 * TC-L Code to Write::          Explanation on what you have to write
 * TC-L FAQ::                    Questions not to ask
 * TC-L Improvements::           Other Designs
+* TC-L Debug information::      Debugger bonus
 @end menu
 
 @node TC-L Goals
@@ -10576,6 +10578,42 @@ class.
 
 @end table
 
+@node TC-L Debug information
+@subsection TC-L Debug information
+
+Adding debugging information is not easy and you should have a TC-L working
+correctly we will add some code into @code{src/llvmtranslate/translator.*} obviously you will
+need to modify or create other files that we will deal with bellow.
+This link might help you to have a better understanding of how support debug information
+is done with llvm @href{http://llvm.org/docs/SourceLevelDebugging.html, Source Level Debugging}
+
+What you will have to do and deal with:
+@table @asis
+@item TC-R
+When adding debug information you don't want your symbols to be renamed into
+unique symbol. Indeed when debugging you want the actual name (the one from the source)
+of a function to break on it, or the actual name of variable to print it without
+as you have no idea of their renamed one. Thus renamer must be disable.
+
+@item Src/llvmtranslate/translator.*
+There you will have to emit locations for the node that you care about, manage scopes,
+and generate calls to @acro{llvm} intrinsic functions as @code{llvm.dbg.declare}
+and @code{llvm.dbg.value} that use the metadata you generate (like locations for example)
+to provide debug information.
+
+@item Debug-type visitor
+As have been done for TC-L tiger types have been translated to llvm types thanks to
+a visitor. This time you will have to create a new visitor to translate Tiger types
+to llvm ditypes.
+
+@item Common problems
+- When trying to debug your program using gdb after the debug informations have been
+correctly generated, you can't step correctly in your source file then you should check
+your locations emission or nodes location.
+- You generate wrong llvm code and nothing work anymore.
+
+@end table
+
 @c ============================================================
 @c ============================================================ Tools
 @c ============================================================

[Francis Visoiu Mistrih]

should have a correctly working TC-L. We will add some code into... and you can obviously add other files...

[Francis Visoiu Mistrih]

below*

[Guillaume Marques]

on* how support

[Guillaume Marques]

When adding debug information,* you don't

[Francis Visoiu Mistrih]

symbols*

[Guillaume Marques]

Indeed,* when debugging,*

[Guillaume Marques]

name of a* variable

[Francis Visoiu Mistrih]

without knowing their renamed one. disabled*

[Francis Visoiu Mistrih]

src*

[Guillaume Marques]

There,*

[Guillaume Marques]

As it has been done for TC-L,*

[Francis Visoiu Mistrih]

Explain the difference between Type and DIType?

[Francis Visoiu Mistrih]

if you can't

[Guillaume Marques]

in your source files,* then

[Francis Visoiu Mistrih]

works*