Stack overflow detection (method 1 and 2) in FreeRTOS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Stack Overflow Detection Method 1 in FreeRTOS?

Method 1 checks the current stack pointer against the stack limits during context switches. If the stack pointer goes beyond the allowed stack area, an overflow is detected.

beginner

How does Stack Overflow Detection Method 2 work in FreeRTOS?

Method 2 uses a known pattern (a 'canary' value) placed at the end of the stack. FreeRTOS checks if this pattern is overwritten to detect stack overflow.

intermediate

Which FreeRTOS configuration option enables Stack Overflow Detection Method 1?

Setting configCHECK_FOR_STACK_OVERFLOW to 1 enables Method 1 stack overflow checking in FreeRTOS.

intermediate

Which FreeRTOS configuration option enables Stack Overflow Detection Method 2?

Setting configCHECK_FOR_STACK_OVERFLOW to 2 enables Method 2 stack overflow checking in FreeRTOS.

intermediate

What is a key difference between Method 1 and Method 2 stack overflow detection in FreeRTOS?

Method 1 checks the actual stack pointer position during context switches for overflow, while Method 2 detects overflow by checking a fixed pattern at stack end.

What does Stack Overflow Detection Method 1 in FreeRTOS rely on?

A Checking the stack pointer during context switches

B A known pattern placed at the stack end

C Using hardware memory protection

D Monitoring CPU usage

Method 1 checks the stack pointer during context switches to detect overflow.

Which configCHECK_FOR_STACK_OVERFLOW value enables Method 2 in FreeRTOS?

A 0

B 1

C 2

D 3

Setting configCHECK_FOR_STACK_OVERFLOW to 2 enables Method 2 stack overflow detection.

When does Method 2 check for stack overflow in FreeRTOS?

A During task creation

B During context switches

C At system startup

D When memory is allocated

Method 2 checks the pattern (canary) during context switches to detect overflow.

What happens if the canary value is overwritten in Method 2?

A Nothing happens

B Task is deleted

C System resets immediately

D Stack overflow is detected

Overwriting the canary value indicates stack overflow in Method 2.

Which method is more precise in detecting stack overflow in FreeRTOS?

A Method 1

B Neither detects overflow

C Both are equally precise

D Method 2

Method 1 is more precise because it checks the actual stack pointer position.

Explain how Stack Overflow Detection Method 1 works in FreeRTOS and how to enable it.

Think about the stack pointer relative to the stack base.

Describe the difference between Method 1 and Method 2 stack overflow detection in FreeRTOS.

Compare how each method detects overflow.

Practice

1. What is the main purpose of stack overflow detection in FreeRTOS?

easy

A. To reduce RAM usage by tasks

B. To prevent tasks from using more stack memory than allocated

C. To increase CPU clock speed

D. To speed up task switching

Solution

1. Step 1: Understand stack overflow concept

   Stack overflow happens when a task uses more stack memory than allocated, causing memory corruption.

2. Step 2: Identify purpose of detection

   Stack overflow detection helps catch this problem early to prevent crashes or unpredictable behavior.

3. Final Answer:

   To prevent tasks from using more stack memory than allocated -> Option B

4. Quick Check:

   Stack overflow detection = prevent excess stack use [OK]

Hint: Stack overflow detection stops tasks using too much stack [OK]

Common Mistakes:

• Confusing stack overflow with CPU speed
• Thinking it reduces RAM usage
• Assuming it speeds up task switching

2. Which FreeRTOS configuration enables Method 1 stack overflow detection?

easy

A. configMAX_PRIORITIES set to 5

B. configUSE_PREEMPTION set to 0

C. configUSE_IDLE_HOOK set to 1

D. configCHECK_FOR_STACK_OVERFLOW set to 1 or 2

Solution

1. Step 1: Identify config for stack overflow detection

   FreeRTOS uses configCHECK_FOR_STACK_OVERFLOW to enable Method 1 detection.

2. Step 2: Understand valid values

   Setting configCHECK_FOR_STACK_OVERFLOW to 1 or 2 activates automatic detection on context switches.

3. Final Answer:

   configCHECK_FOR_STACK_OVERFLOW set to 1 or 2 -> Option D

4. Quick Check:

   configCHECK_FOR_STACK_OVERFLOW = 1 or 2 [OK]

Hint: Method 1 uses configCHECK_FOR_STACK_OVERFLOW = 1 or 2 [OK]

Common Mistakes:

• Confusing unrelated config options
• Using configUSE_PREEMPTION for stack checks
• Setting configMAX_PRIORITIES thinking it affects stack

3. Given this FreeRTOS hook function for Method 1:

void vApplicationStackOverflowHook(TaskHandle_t xTask, char *pcTaskName) {
    printf("Stack overflow detected in task: %s\n", pcTaskName);
    while(1); // Halt
}

What will happen if a stack overflow is detected?

medium

A. Prints task name and halts the system

B. Resets the task automatically

C. Ignores the overflow and continues

D. Logs overflow but continues running

Solution

1. Step 1: Analyze the hook function code

   The function prints the task name where overflow occurred and then enters an infinite loop.

2. Step 2: Understand effect of infinite loop

   The infinite loop halts the system to prevent further damage after overflow detection.

3. Final Answer:

   Prints task name and halts the system -> Option A

4. Quick Check:

   Stack overflow hook prints and halts [OK]

Hint: Stack overflow hook prints and stops system [OK]

Common Mistakes:

• Thinking system resets automatically
• Assuming overflow is ignored
• Believing task restarts without halt

4. In Method 2 stack overflow detection, which mistake will cause incorrect detection?

medium

A. Using vApplicationStackOverflowHook function

B. Enabling configCHECK_FOR_STACK_OVERFLOW to 2

C. Not initializing the stack pointer check value properly

D. Setting configUSE_PREEMPTION to 1

Solution

1. Step 1: Understand Method 2 detection

   Method 2 manually checks stack pointer against a known value to detect overflow.

2. Step 2: Identify common error

   If the initial stack pointer check value is not set correctly, the comparison will be invalid, causing false negatives or positives.

3. Final Answer:

   Not initializing the stack pointer check value properly -> Option C

4. Quick Check:

   Method 2 needs correct stack pointer init [OK]

Hint: Method 2 needs proper stack pointer initialization [OK]

Common Mistakes:

• Confusing Method 1 config with Method 2
• Ignoring stack pointer initialization
• Assuming hook function is used in Method 2

5. You want to implement stack overflow detection in your FreeRTOS project using Method 1. Which steps should you follow to ensure it works correctly?

hard

A. Set configCHECK_FOR_STACK_OVERFLOW to 1 or 2 and implement vApplicationStackOverflowHook

B. Manually compare stack pointers in each task without config changes

C. Disable preemption and use configUSE_IDLE_HOOK for detection

D. Increase task stack size to avoid overflow without detection

Solution

1. Step 1: Enable Method 1 detection in config

   Set configCHECK_FOR_STACK_OVERFLOW to 1 or 2 to activate automatic detection during context switches.

2. Step 2: Implement the hook function

   Define vApplicationStackOverflowHook to handle overflow events, e.g., log and halt.

3. Final Answer:

   Set configCHECK_FOR_STACK_OVERFLOW to 1 or 2 and implement vApplicationStackOverflowHook -> Option A

4. Quick Check:

   Method 1 = config + hook function [OK]

Hint: Method 1 needs config and hook function implemented [OK]

Common Mistakes:

• Trying manual pointer checks for Method 1
• Disabling preemption thinking it helps detection
• Ignoring hook function implementation