#534 Support for line debugging #656

99NIMI · 2022-11-17T15:07:03Z

Add support for line debugging
Debugging works on any assignment statement or function call
Loops and other conditions are still not supported
Variables are correctly associated during debugging.

Fixes: #534 #537

…etting-breakpoints-on-different-lines-in-code

Local variables and parameters are now supported

…etting-breakpoints-on-different-lines-in-code

…e new lines with the function context

codecov-commenter · 2022-12-02T06:42:21Z

Codecov Report

Base: 94.09% // Head: 94.11% // Increases project coverage by +0.01% 🎉

Coverage data is based on head (5b3d7ac) compared to base (b7d887d).
Patch coverage: 94.34% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #656      +/-   ##
==========================================
+ Coverage   94.09%   94.11%   +0.01%     
==========================================
  Files          46       46              
  Lines       18245    18763     +518     
==========================================
+ Hits        17168    17658     +490     
- Misses       1077     1105      +28

Impacted Files	Coverage Δ
src/codegen/debug.rs	`94.12% <91.76%> (-2.94%)`	⬇️
src/codegen/generators/pou_generator.rs	`93.75% <97.20%> (+0.77%)`	⬆️
src/codegen.rs	`99.25% <100.00%> (+0.04%)`	⬆️
src/codegen/generators/expression_generator.rs	`89.74% <100.00%> (+0.08%)`	⬆️
src/codegen/generators/statement_generator.rs	`97.91% <100.00%> (+0.06%)`	⬆️
src/codegen/generators/variable_generator.rs	`94.11% <100.00%> (ø)`
src/index.rs	`97.19% <100.00%> (-0.02%)`	⬇️
src/index/visitor.rs	`96.45% <100.00%> (+0.04%)`	⬆️
src/lib.rs	`87.91% <100.00%> (+0.34%)`	⬆️
src/resolver/generics.rs	`96.82% <100.00%> (+<0.01%)`	⬆️
... and 6 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.

…ifferent-lines-in-code

…etting-breakpoints-on-different-lines-in-code

…ifferent-lines-in-code

…etting-breakpoints-on-different-lines-in-code

src/codegen/debug.rs

riederm · 2022-12-02T12:43:59Z

src/codegen/debug.rs

+        scope: DIScope<'ink>,
+        line: usize,
+        column: usize,
+    ) -> Result<DILocation, Diagnostic> {


Result not required - in fact I believe most of these functions will never return an Err?

They should, I think I mostly forgot to remove / change some panics, I'll take another look

Correction: I had not seen the methods this is on, this one was useless i removed the method

3 methods in DebugBuilder impl look like they will never fail
others could benefit from a .expect(...)( when calling types.get(...)

riederm · 2022-12-02T12:47:09Z

src/codegen/debug.rs

+            .expect("A POU will have an impl at this stage");
+        if implementation.implementation_type != ImplementationType::Function {
+            if implementation.get_implementation_type() == &ImplementationType::Method {
+                todo!("Method debugging");


will codegen now panic for methods?

not unless it's being compiled with -g, but I could make this a diagnostic instead.

its now an Err(...). we should just ignore it for the moment so a method will not permit a debug-build

src/codegen/generators/expression_generator.rs

riederm · 2022-12-02T13:05:42Z

src/codegen/debug.rs

+            .map(|dt| {
+                self.types
+                    .get(dt.get_name().to_lowercase().as_str())
+                    .expect("at this point we should have all types") // TODO: error msg


mention dt.get_name() in the message

src/codegen/generators/pou_generator.rs

riederm · 2022-12-02T13:20:24Z

src/codegen/generators/pou_generator.rs

@@ -413,14 +484,27 @@ impl<'ink, 'cg> PouGenerator<'ink, 'cg> {
                    m.get_name(),
                    &index.get_associated_type(m.get_type_name())?,
                );
+
+                if let Some(block) = self.llvm.builder.get_insert_block() {
+                    debug.add_variable_declaration(


shall we also register variable declaration for the return variable? (aggregate and normal ones?)

We already do, there's also a test for aggregate return types
We can maybe do a walkthrough for it

src/index.rs

…etting-breakpoints-on-different-lines-in-code

…ifferent-lines-in-code

#534 debug locations wip

a6ad476

99NIMI requested a review from ghaith November 17, 2022 15:07

99NIMI linked an issue Nov 17, 2022 that may be closed by this pull request

Debug - Support setting breakpoints on different lines in code. #534

Closed

ghaith and others added 3 commits November 18, 2022 13:45

Merge remote-tracking branch 'origin/master' into 534-debug-support-s…

013d388

…etting-breakpoints-on-different-lines-in-code

Merge remote-tracking branch 'origin/master' into 534-debug-support-s…

14f050a

…etting-breakpoints-on-different-lines-in-code

Add tests, add debug only on calls and assignments

74204a1

ghaith force-pushed the 534-debug-support-setting-breakpoints-on-different-lines-in-code branch 2 times, most recently from 0527b99 to 37bf7b8 Compare November 25, 2022 04:39

ghaith added 3 commits November 28, 2022 05:46

Add support for debut variables

b824d29

Local variables and parameters are now supported

Merge remote-tracking branch 'origin/master' into 534-debug-support-s…

0a48128

…etting-breakpoints-on-different-lines-in-code

Rework the variables

8d3eeb8

ghaith force-pushed the 534-debug-support-setting-breakpoints-on-different-lines-in-code branch from dd5d20c to 8d3eeb8 Compare November 28, 2022 15:53

ghaith and others added 4 commits November 29, 2022 14:13

Adjust line information for function start and rework variables

ae9377b

Fix line number and variables for POUs

1f44d2a

Accept the tests, implement variable tests

4f3a68f

Cleanup parameters for the debugging remove the Debug context, combin…

048fe61

…e new lines with the function context

Remove the debug.st example

7860049

ghaith changed the title ~~#534 debug locations wip~~ #534 Support for line debugging Dec 2, 2022

ghaith requested a review from riederm December 2, 2022 06:47

ghaith marked this pull request as ready for review December 2, 2022 06:48

Merge branch 'master' into 534-debug-support-setting-breakpoints-on-d…

182573d

…ifferent-lines-in-code

ghaith linked an issue Dec 2, 2022 that may be closed by this pull request

Debug - Jump into / out of functions #537

Closed

ghaith added 3 commits December 2, 2022 09:05

Merge remote-tracking branch 'origin/master' into 534-debug-support-s…

2039972

…etting-breakpoints-on-different-lines-in-code

Merge branch 'master' into 534-debug-support-setting-breakpoints-on-d…

01f9e23

…ifferent-lines-in-code

Merge remote-tracking branch 'origin/master' into 534-debug-support-s…

57458ed

…etting-breakpoints-on-different-lines-in-code

riederm reviewed Dec 2, 2022

View reviewed changes

src/codegen/debug.rs Outdated Show resolved Hide resolved

riederm reviewed Dec 2, 2022

View reviewed changes

src/codegen/generators/expression_generator.rs Show resolved Hide resolved

riederm reviewed Dec 2, 2022

View reviewed changes

src/codegen/generators/pou_generator.rs Outdated Show resolved Hide resolved

riederm reviewed Dec 2, 2022

View reviewed changes

src/index.rs Outdated Show resolved Hide resolved

Merge remote-tracking branch 'origin/master' into 534-debug-support-s…

285d190

…etting-breakpoints-on-different-lines-in-code

ghaith removed their request for review December 2, 2022 14:05

ghaith and others added 3 commits December 2, 2022 15:29

Review comments

7a80571

Merge remote-tracking branch 'origin/master' into 534-debug-support-s…

c5d9441

…etting-breakpoints-on-different-lines-in-code

Removed most of the Result returns

0844e4b

riederm approved these changes Dec 7, 2022

View reviewed changes

Merge branch 'master' into 534-debug-support-setting-breakpoints-on-d…

5b3d7ac

…ifferent-lines-in-code

ghaith merged commit 54301a0 into master Dec 7, 2022

ghaith deleted the 534-debug-support-setting-breakpoints-on-different-lines-in-code branch December 7, 2022 12:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#534 Support for line debugging #656

#534 Support for line debugging #656

99NIMI commented Nov 17, 2022 •

edited by ghaith

Loading

codecov-commenter commented Dec 2, 2022 •

edited

Loading

riederm Dec 2, 2022 •

edited

Loading

ghaith Dec 2, 2022

ghaith Dec 2, 2022

riederm Dec 6, 2022

riederm Dec 2, 2022 •

edited

Loading

ghaith Dec 2, 2022

riederm Dec 6, 2022

riederm Dec 2, 2022 •

edited

Loading

riederm Dec 2, 2022

ghaith Dec 2, 2022

#534 Support for line debugging #656

#534 Support for line debugging #656

Conversation

99NIMI commented Nov 17, 2022 • edited by ghaith Loading

codecov-commenter commented Dec 2, 2022 • edited Loading

Codecov Report

riederm Dec 2, 2022 • edited Loading

Choose a reason for hiding this comment

ghaith Dec 2, 2022

Choose a reason for hiding this comment

ghaith Dec 2, 2022

Choose a reason for hiding this comment

riederm Dec 6, 2022

Choose a reason for hiding this comment

riederm Dec 2, 2022 • edited Loading

Choose a reason for hiding this comment

ghaith Dec 2, 2022

Choose a reason for hiding this comment

riederm Dec 6, 2022

Choose a reason for hiding this comment

riederm Dec 2, 2022 • edited Loading

Choose a reason for hiding this comment

riederm Dec 2, 2022

Choose a reason for hiding this comment

ghaith Dec 2, 2022

Choose a reason for hiding this comment

99NIMI commented Nov 17, 2022 •

edited by ghaith

Loading

codecov-commenter commented Dec 2, 2022 •

edited

Loading

riederm Dec 2, 2022 •

edited

Loading

riederm Dec 2, 2022 •

edited

Loading

riederm Dec 2, 2022 •

edited

Loading