Variables Debugging #544

ghaith · 2022-08-17T14:47:50Z

Support for debug information for variables that are accessible globally.
Solves #536

Added implementation for all types including structs, arrays and aliases
Strings are char arrays of type UTF-8 or 16
Structs can be nested.
- Nested structs cannot be recursive in this version
Global variables are generated correctly

Not tested : POU generation

codecov-commenter · 2022-08-17T14:58:07Z

Codecov Report

Base: 93.44% // Head: 93.61% // Increases project coverage by +0.17% 🎉

Coverage data is based on head (7b8809e) compared to base (180fb07).
Patch coverage: 94.77% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #544      +/-   ##
==========================================
+ Coverage   93.44%   93.61%   +0.17%     
==========================================
  Files          42       44       +2     
  Lines       15802    16420     +618     
==========================================
+ Hits        14766    15372     +606     
- Misses       1036     1048      +12

Impacted Files	Coverage Δ
src/diagnostics.rs	`82.19% <12.50%> (-0.83%)`	⬇️
src/cli.rs	`98.04% <71.42%> (-0.37%)`	⬇️
src/lib.rs	`85.80% <81.81%> (-0.16%)`	⬇️
src/typesystem.rs	`97.37% <91.00%> (+1.31%)`	⬆️
src/datalayout.rs	`96.66% <96.66%> (ø)`
src/codegen/debug.rs	`97.04% <97.04%> (ø)`
src/ast.rs	`93.45% <100.00%> (+0.04%)`	⬆️
src/codegen.rs	`99.20% <100.00%> (+8.52%)`	⬆️
src/codegen/generators/data_type_generator.rs	`93.63% <100.00%> (+0.04%)`	⬆️
src/codegen/generators/expression_generator.rs	`88.79% <100.00%> (ø)`
... and 8 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

ghaith · 2022-09-07T15:28:42Z

~~Note this branch is still linked to the custom inkwell branch until TheDan64/inkwell#349 is merged~~
The commit is based on master again.

…k to inkwell's master branch

src/cli.rs

src/codegen.rs

riederm · 2022-09-19T18:19:08Z

src/codegen/debug.rs

+
+#[derive(PartialEq, Eq)]
+#[allow(non_camel_case_types)]
+enum DebugEncoding {


maybe we can find a better name for that enum - i'm not 100% what it does

what does DW_ATE stand for?

DW = Dwarf
AT = Attribute
E = Encoding, hence the name.. The parameter this is passed as is also called encoding.

The encoding here is usually only used for Basic Types, which I updated in the comment

src/codegen/debug.rs

riederm · 2022-09-19T18:25:55Z

src/codegen/debug.rs

+    }
+}
+
+pub struct DebugObj<'ink> {


can we find a better name for this? i would have assumed that the DebugObject is a small unit of debugging (like the dwarf DebugItem)

this represents all debug information of one compilation-unit?

Would debug builder be OK? I didin't initially use it to avoid confusion with DebugInfoBuilder (The inkwell struct)

riederm · 2022-09-19T18:27:38Z

src/codegen/debug.rs

+}
+
+/// Wraps a debug object in an enum based on its level
+pub enum DebugWrapper<'ink> {


name too generic

src/codegen/debug.rs

src/datalayout.rs

src/codegen/debug.rs

Changed some names, and added documentation.

riederm

small issues, overall I like it!

riederm · 2022-09-21T07:44:58Z

src/codegen/debug.rs

+
+    fn create_array_type(
+        &mut self,
+        array: &DataTypeInformation,


i would deconstruct this when calling.

you have to check for array before you call this AND you do an if-let check right at the start.
its only 3 params you're interested in

riederm · 2022-09-21T07:45:38Z

src/codegen/debug.rs

+
+    fn create_pointer_type(
+        &mut self,
+        pointer: &DataTypeInformation,


deconstruct before calling

riederm · 2022-09-21T07:45:59Z

src/codegen/debug.rs

+    fn create_string_type(
+        &mut self,
+        name: &str,
+        string: &DataTypeInformation,


deconstruct before calling

riederm · 2022-09-21T07:59:43Z

src/codegen/generators/expression_generator.rs

@@ -2348,8 +2348,8 @@ impl<'ink, 'b> ExpressionCodeGenerator<'ink, 'b> {
            let target_size = self.get_string_size(left_type, right_statement.get_location())?; //we report error on parameter :-/
            let value_size = self.get_string_size(right_type, right_statement.get_location())?;
            let size = std::cmp::min(target_size - 1, value_size) as i64;
-            let align_left = left_type.get_alignment();
-            let align_right = right_type.get_alignment();
+            let align_left = left_type.get_string_inner_alignment(self.index).bytes();


you had the feeling that the old name was bad ... i agree
but I think we're not talking about alignment here when considering string-encoding

i would use: bytes_per_character - and yes i know there are multi-byte characters
but i would not agree that utf16 is 2byte aligned (it would mean that a utf16 char can only start at an even byte-adress!). for me, alignment talks about the start-adress of a some data, not the inner structure.

riederm · 2022-09-21T08:20:03Z

src/typesystem.rs

+        self.get_size(index).bits()
+    }
+
+    pub fn get_size(&self, index: &Index) -> Offset {


is this useful to have an Offset here?

riederm · 2022-09-21T08:20:37Z

src/typesystem.rs

            DataTypeInformation::Generic { .. } => unimplemented!("generics"),
        }
    }

-    pub fn get_alignment(&self) -> u32 {
+    /// Returns the String encoding's alignment (charachter)


typo: charachter

ghaith added 5 commits August 16, 2022 08:29

Wip - Debug structure

ee68a2f

Debug for float and int

265e6f6

Merge remote-tracking branch 'origin/master' into debugging

d6f5cd8

Add support for boolean

eaa128e

Add tests for float debugging

efc5c60

ghaith linked an issue Aug 17, 2022 that may be closed by this pull request

Debug - Identify/display variable values #536

Closed

ghaith and others added 4 commits August 22, 2022 16:35

Debug Structs - WIP

a8d9fe6

Add size information to the index, add struct field support to the debug

44a3423

Merge remote-tracking branch 'origin/master' into debugging

17d93a5

Merge remote-tracking branch 'origin/master' into debugging

fda4981

ghaith force-pushed the debugging branch 2 times, most recently from 02c1e78 to cd27995 Compare August 31, 2022 13:49

Debugging - Struct sizes - WIP

5ae800e

ghaith force-pushed the debugging branch from cd27995 to 5ae800e Compare September 2, 2022 08:12

ghaith and others added 6 commits September 5, 2022 16:09

String, array and pointer debug info support

2159853

Remove dbg! and run clippy/fmt

e389b99

Merge remote-tracking branch 'origin/master' into debugging

4bc9322

Debug dommand on cli, add typedef (tests missing)

ef0edc5

Finish typedef implementation, added tests

e446845

Make sure the debug info metadata is attached to the variables

444a0d3

ghaith marked this pull request as ready for review September 7, 2022 15:23

ghaith requested a review from riederm September 7, 2022 15:27

Removed the optional debug obj, replaced it with a wrapper, moved bac…

3ad8428

…k to inkwell's master branch

riederm reviewed Sep 19, 2022

View reviewed changes

= added 3 commits September 20, 2022 07:56

Review comments

6bec955

Changed some names, and added documentation.

Run cargo fmt

6144905

Remove the refcell, make the codegen mutable where needed

9ae73b4

riederm requested changes Sep 21, 2022

View reviewed changes

ghaith added 3 commits September 23, 2022 07:59

Merge remote-tracking branch 'origin/master' into debugging

8faeddc

Merge remote-tracking branch 'origin/master' into debugging

cbb6287

Split offset into memory location and bytes

2b873ef

riederm approved these changes Sep 24, 2022

View reviewed changes

Merge branch 'master' into debugging

7b8809e

ghaith merged commit 74e42d0 into master Sep 27, 2022

ghaith deleted the debugging branch September 27, 2022 04:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Variables Debugging #544

Variables Debugging #544

ghaith commented Aug 17, 2022 •

edited

Loading

codecov-commenter commented Aug 17, 2022 •

edited

Loading

ghaith commented Sep 7, 2022 •

edited

Loading

riederm Sep 19, 2022

ghaith Sep 20, 2022

ghaith Sep 20, 2022

riederm Sep 19, 2022

ghaith Sep 20, 2022

riederm Sep 19, 2022

riederm left a comment

riederm Sep 21, 2022

riederm Sep 21, 2022

riederm Sep 21, 2022

riederm Sep 21, 2022

riederm Sep 21, 2022

riederm Sep 21, 2022

Variables Debugging #544

Variables Debugging #544

Conversation

ghaith commented Aug 17, 2022 • edited Loading

codecov-commenter commented Aug 17, 2022 • edited Loading

Codecov Report

ghaith commented Sep 7, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

riederm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghaith commented Aug 17, 2022 •

edited

Loading

codecov-commenter commented Aug 17, 2022 •

edited

Loading

ghaith commented Sep 7, 2022 •

edited

Loading