Stack analyzer #1529

rakons · 2019-11-18T14:41:02Z

A code to make stack analysis simple on our examples.

rakons · 2019-11-18T14:41:52Z

include/debug/stack_analyzer.rst

NordicBuilder · 2019-11-18T14:51:38Z

All checks are passing now.

Tip: The bot edits this comment instead of posting a new one, so you can check the comment's history to see earlier messages.

subsys/debug/stack_analyzer/Kconfig

subsys/debug/stack_size_analyzer/Kconfig

grochu

This is going to be a useful module for NCS users - it greatly simplifies setup of monitoring of the thread stacks.

lemrey · 2019-11-19T15:52:05Z

This is very nice 🥇 I suggest letting the user pull in this functionality by simply enabling its Kconfig entry (without the addition of any code). That way we'll be able to use from any sample just by editing its project configuration.

rakons · 2019-11-20T08:25:00Z

This is very nice 🥇 I suggest letting the user pull in this functionality by simply enabling its Kconfig entry (without the addition of any code). That way we'll be able to use from any sample just by editing its project configuration.

Good point.
Maybe I will add a configuration to do it automatically - we can use a timer or workqueue for that instead of creating additional thread.
I would leave a possibility to disable automatic printing anyway, as it is possible then to implement any callback function and use the module in different ways than just printing.

lemrey · 2019-11-20T08:53:08Z

I would leave a possibility to disable automatic printing

Yes, or print only when the stack usage is above a certain threshold.

rakons · 2019-11-20T10:41:06Z

Is there any way to start a timer without the need to call start function? Currently I do not see a way to implement this code without a modification of the application code when not using additional thread.

lemrey · 2019-11-20T11:47:33Z

I think having a dedicated thread for this is fine. I prefer a separate thread rather than a task for the system work queue, because otherwise it will affect the stack usage of the system work queue thread :)
I have not used timers yet, but if you want to call a function automatically at startup you could do that with SYS_INIT (see /include/init.h), note that some OS components are initialized during SYS_INIT so if you rely on any of those you should set the correct priority for your task.

kapi-no

A few nitpicks

include/debug/stack_size_analyzer.h

include/debug/stack_size_analyzer.rst

joerchan · 2019-11-21T15:19:10Z

This looks very useful. Who should we put into the code-owners file as responsible for the subsys/debug? @carlescufi Any thoughts on this

rakons · 2019-12-23T10:13:40Z

@carlescufi @joerchan
I can add myself to the new files. It seems reasonable.

ioannisg · 2020-01-02T08:11:02Z

There's got to be a code-owner, at least, co-owning debug/ subsystem, IMO.

carlescufi · 2020-01-09T13:37:57Z

@rakons can you add yourself as an owner for these files along with @ioannisg and also fix CI?

joerchan · 2020-01-09T13:40:14Z

rakons can you add yourself as an owner for these files along with ioannisg and also fix CI?

@carlescufi AFAIK we have to wait for upmerge to complete this one.

rakons · 2020-01-09T14:23:05Z

rakons can you add yourself as an owner for these files along with ioannisg and also fix CI?

@carlescufi AFAIK we have to wait for upmerge to complete this one.

Indeed. I have to use k_thread_foreach_unlocked that will be there after upmerge.

joerchan · 2020-02-25T16:18:50Z

@rakons Could this be picked up again now?

rakons · 2020-02-28T12:20:11Z

@ru-fu - What documentation is missed?

b-gent

I will check documentation early next week

nordic-krch

few findings

nordic-krch · 2020-03-02T06:54:32Z

subsys/debug/stack_size_analyzer/stack_size_analyzer.c

+	const char *stack = (const char *)thread->stack_info.start;
+	unsigned int size = thread->stack_info.size;
+	unsigned int unused = stack_unused_space_get(stack, size);
+	char name[21];


magic number?

subsys/debug/stack_size_analyzer/Kconfig

include/debug/stack_size_analyzer.h

subsys/debug/stack_size_analyzer/Kconfig

nordic-krch · 2020-03-02T07:25:29Z

include/debug/stack_size_analyzer.h

+ *
+ * Callback function with stack size statistics.
+ *
+ * @param name  The name of the thread


or stringified address of the thread handle if name is not set.

Comment added

subsys/debug/stack_size_analyzer/Kconfig

nordic-krch · 2020-03-02T07:28:20Z

subsys/debug/stack_size_analyzer/Kconfig

+endchoice
+
+config STACK_SIZE_ANALYZER_AUTO
+	bool "Enable Stack size analyzer automatic printing"


since it's already in stack size analyzer menu it should be shorter. Just Enable automatic printing is sufficient.

subsys/debug/stack_size_analyzer/Kconfig

joerchan · 2020-03-02T08:50:31Z

@rakons Thank you for picking it up. Could you rebase it to fix the conflict?

joerchan · 2020-03-03T13:37:14Z

Due to the need to have this functionality easily available for the Bluetooth HCI driver in upstream I suggest we move this functionality to zephyr instead.
HCI Driver uses this: https://github.com/zephyrproject-rtos/zephyr/blob/master/subsys/bluetooth/controller/hci/hci_driver.c#L403

This has already a few mentions for providing this functionality from the kernel:
zephyrproject-rtos/zephyr#23104 (comment)

If nobody disagrees then I will start to port this to upstream as @rakons has indicated he does not have the time.

We will then not merge this downstream since we would just have to remove it again in the next upmerge.

rakons · 2020-03-03T14:05:37Z

@joerchan - wait until I fix the issues reported by krch.

b-gent · 2020-03-03T21:10:00Z

@joerchan I'm not sure how you want to handle this PR now, I'm adding a small commit with a language review of the RST file that also fixes some RST output issues. I'm pretty sure this will go through another doc review when getting into zephyr.

nordic-krch

looks ok (checkpatch issues should be fixed at some point)

Stack size analyzer is simple module that helps in printing stacks usage statistics. Signed-off-by: Radoslaw Koppel <radoslaw.koppel@nordicsemi.no> Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no>

joerchan · 2020-03-04T08:43:30Z

@b-gent Ok. I'll wait for your RST commit and then port the changes to upstream. Then the rest will be handled in a zephyr PR.

b-gent · 2020-03-04T08:45:46Z

@b-gent Ok. I'll wait for your RST commit and then port the changes to upstream. Then the rest will be handled in a zephyr PR.

the commit already went it and got squashed.

joerchan · 2020-04-28T15:43:57Z

This has been merged upstream now.

rakons · 2020-04-29T07:56:06Z

Impossible! It was blazingly fast :)

rakons requested review from anangl, carlescufi, joerchan, lemrey, pizi-nordic, rlubos and SebastianBoe as code owners November 18, 2019 14:41

SebastianBoe reviewed Nov 18, 2019

View reviewed changes

include/debug/stack_analyzer.rst Outdated Show resolved Hide resolved

SebastianBoe reviewed Nov 18, 2019

View reviewed changes

subsys/debug/stack_analyzer/Kconfig Outdated Show resolved Hide resolved

SebastianBoe reviewed Nov 18, 2019

View reviewed changes

subsys/debug/stack_analyzer/Kconfig Outdated Show resolved Hide resolved

joerchan requested a review from b-gent November 18, 2019 16:53

rakons force-pushed the stack_analyzer branch from a22d3c5 to 32dd56f Compare November 19, 2019 09:41

SebastianBoe reviewed Nov 19, 2019

View reviewed changes

subsys/debug/stack_size_analyzer/Kconfig Outdated Show resolved Hide resolved

SebastianBoe reviewed Nov 19, 2019

View reviewed changes

subsys/debug/stack_size_analyzer/Kconfig Outdated Show resolved Hide resolved

grochu approved these changes Nov 19, 2019

View reviewed changes

KAGA164 approved these changes Nov 20, 2019

View reviewed changes

kapi-no approved these changes Nov 21, 2019

View reviewed changes

include/debug/stack_size_analyzer.h Outdated Show resolved Hide resolved

include/debug/stack_size_analyzer.h Outdated Show resolved Hide resolved

include/debug/stack_size_analyzer.h Outdated Show resolved Hide resolved

include/debug/stack_size_analyzer.rst Outdated Show resolved Hide resolved

rakons force-pushed the stack_analyzer branch 5 times, most recently from 398561b to 7b7ad85 Compare November 21, 2019 14:33

ru-fu added the doc-required PR must not be merged without tech writer approval. label Jan 14, 2020

ru-fu removed request for ru-fu and pizi-nordic January 22, 2020 12:43

rakons force-pushed the stack_analyzer branch from 321be20 to 6ea456e Compare February 28, 2020 11:07

rakons requested a review from nordic-krch as a code owner February 28, 2020 11:07

b-gent requested changes Feb 28, 2020

View reviewed changes

nordic-krch reviewed Mar 2, 2020

View reviewed changes

joerchan requested a review from b-gent March 2, 2020 08:46

rakons force-pushed the stack_analyzer branch from d4aa848 to 9948873 Compare March 3, 2020 09:26

rakons force-pushed the stack_analyzer branch from 9948873 to 275cfc3 Compare March 3, 2020 15:19

nordic-krch approved these changes Mar 4, 2020

View reviewed changes

debug: stack_size_analyzer: Implement stack size analyzer

af22c7d

Stack size analyzer is simple module that helps in printing stacks usage statistics. Signed-off-by: Radoslaw Koppel <radoslaw.koppel@nordicsemi.no> Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no>

rakons force-pushed the stack_analyzer branch from 0fa3979 to af22c7d Compare March 4, 2020 07:24

b-gent approved these changes Mar 4, 2020

View reviewed changes

joerchan closed this Apr 28, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Stack analyzer #1529

Stack analyzer #1529

rakons commented Nov 18, 2019

rakons commented Nov 18, 2019

NordicBuilder commented Nov 18, 2019 •

edited

Loading

grochu left a comment

lemrey commented Nov 19, 2019

rakons commented Nov 20, 2019

lemrey commented Nov 20, 2019

rakons commented Nov 20, 2019

lemrey commented Nov 20, 2019

kapi-no left a comment

joerchan commented Nov 21, 2019

rakons commented Dec 23, 2019

ioannisg commented Jan 2, 2020

carlescufi commented Jan 9, 2020

joerchan commented Jan 9, 2020 •

edited

Loading

rakons commented Jan 9, 2020

joerchan commented Feb 25, 2020

rakons commented Feb 28, 2020

b-gent left a comment

nordic-krch left a comment

nordic-krch Mar 2, 2020

rakons Mar 3, 2020

nordic-krch Mar 2, 2020

rakons Mar 3, 2020

nordic-krch Mar 2, 2020

joerchan commented Mar 2, 2020

joerchan commented Mar 3, 2020 •

edited

Loading

rakons commented Mar 3, 2020

b-gent commented Mar 3, 2020

nordic-krch left a comment

joerchan commented Mar 4, 2020

b-gent commented Mar 4, 2020

joerchan commented Apr 28, 2020

rakons commented Apr 29, 2020

Stack analyzer #1529

Stack analyzer #1529

Conversation

rakons commented Nov 18, 2019

rakons commented Nov 18, 2019

NordicBuilder commented Nov 18, 2019 • edited Loading

grochu left a comment

Choose a reason for hiding this comment

lemrey commented Nov 19, 2019

rakons commented Nov 20, 2019

lemrey commented Nov 20, 2019

rakons commented Nov 20, 2019

lemrey commented Nov 20, 2019

kapi-no left a comment

Choose a reason for hiding this comment

joerchan commented Nov 21, 2019

rakons commented Dec 23, 2019

ioannisg commented Jan 2, 2020

carlescufi commented Jan 9, 2020

joerchan commented Jan 9, 2020 • edited Loading

rakons commented Jan 9, 2020

joerchan commented Feb 25, 2020

rakons commented Feb 28, 2020

b-gent left a comment

Choose a reason for hiding this comment

nordic-krch left a comment

Choose a reason for hiding this comment

nordic-krch Mar 2, 2020

Choose a reason for hiding this comment

rakons Mar 3, 2020

Choose a reason for hiding this comment

nordic-krch Mar 2, 2020

Choose a reason for hiding this comment

rakons Mar 3, 2020

Choose a reason for hiding this comment

nordic-krch Mar 2, 2020

Choose a reason for hiding this comment

joerchan commented Mar 2, 2020

joerchan commented Mar 3, 2020 • edited Loading

rakons commented Mar 3, 2020

b-gent commented Mar 3, 2020

nordic-krch left a comment

Choose a reason for hiding this comment

joerchan commented Mar 4, 2020

b-gent commented Mar 4, 2020

joerchan commented Apr 28, 2020

rakons commented Apr 29, 2020

NordicBuilder commented Nov 18, 2019 •

edited

Loading

joerchan commented Jan 9, 2020 •

edited

Loading

joerchan commented Mar 3, 2020 •

edited

Loading