configASSERT() for development debugging in FreeRTOS

Introduction

configASSERT() helps catch mistakes early by stopping the program when something unexpected happens. It is like a safety net during development to find bugs quickly.

When you want to check if a pointer is not NULL before using it.

When you want to verify that a variable has a valid value during program execution.

When you want to catch errors in task creation or resource allocation.

When you want to make sure assumptions in your code are true while testing.

When you want to stop the program immediately if something goes wrong to debug easily.

Syntax

FreeRTOS

configASSERT( condition );

The condition is an expression that should be true for the program to continue.

If condition is false, the program will stop (usually in an infinite loop) to help you find the problem.

Examples

Check that pointer x is not NULL before using it.

FreeRTOS

configASSERT( x != NULL );

Ensure the queue is not full before adding a new message.

FreeRTOS

configASSERT( uxQueueMessagesWaiting(queue) < QUEUE_LENGTH );

Verify that a task was created successfully.

FreeRTOS

configASSERT( taskHandle != NULL );

Sample Program

This program creates a task that uses configASSERT() to check if the pointer passed to the task is not NULL. If the pointer is NULL, the program will stop, helping you find the bug early.

FreeRTOS

#include "FreeRTOS.h"
#include "task.h"
#include <stdio.h>

void vTaskFunction(void *pvParameters) {
    int *ptr = (int *)pvParameters;
    configASSERT(ptr != NULL);  // Check pointer is valid

    printf("Value pointed to: %d\n", *ptr);
    vTaskDelete(NULL);
}

int main(void) {
    int value = 42;
    xTaskCreate(vTaskFunction, "Task1", configMINIMAL_STACK_SIZE, &value, 1, NULL);
    vTaskStartScheduler();
    return 0;
}

Important Notes

configASSERT() is usually enabled only in development builds to avoid slowing down the final product.

If configASSERT() fails, the program typically enters an infinite loop to halt execution for debugging.

You can customize the behavior of configASSERT() by defining your own assert handler in FreeRTOSConfig.h.

Summary

configASSERT() helps catch bugs early by stopping the program when a condition is false.

Use it to check pointers, task creation, and other important assumptions during development.

It improves debugging by making errors obvious and easy to find.

Practice

1. What is the main purpose of configASSERT() in FreeRTOS development?

easy

A. To stop the program when a condition is false, helping catch bugs early

B. To speed up the program execution by optimizing code

C. To automatically fix errors in the code during runtime

D. To log messages without affecting program flow

Solution

1. Step 1: Understand the role of configASSERT()

   configASSERT() is used to check conditions during development and halt execution if the condition is false.

2. Step 2: Compare options with this role

   Only To stop the program when a condition is false, helping catch bugs early describes stopping the program on false conditions to catch bugs early, which matches configASSERT()'s purpose.

3. Final Answer:

   To stop the program when a condition is false, helping catch bugs early -> Option A

4. Quick Check:

   configASSERT() stops program on false condition = D [OK]

Hint: Remember: configASSERT() halts on false condition to find bugs fast [OK]

Common Mistakes:

• Thinking configASSERT() speeds up code
• Believing it fixes errors automatically
• Confusing it with logging functions

2. Which of the following is the correct syntax to use configASSERT() to check if a pointer ptr is not NULL?

easy

A. configASSERT(ptr);

B. configASSERT(ptr == NULL);

C. configASSERT(ptr = NULL);

D. configASSERT(ptr != NULL);

Solution

1. Step 1: Understand the condition to check pointer validity

   We want to assert that the pointer is NOT NULL, so the condition should be true when ptr is valid.

2. Step 2: Analyze each option

   configASSERT(ptr != NULL); checks ptr != NULL, which is correct. configASSERT(ptr == NULL); checks ptr == NULL (wrong), C uses assignment (=) which is a syntax error, and D checks ptr as a boolean but is less explicit.

3. Final Answer:

   configASSERT(ptr != NULL); -> Option D

4. Quick Check:

   Check pointer not NULL with ptr != NULL [OK]

Hint: Use != NULL to assert pointer is valid, not == NULL [OK]

Common Mistakes:

• Using assignment (=) instead of comparison (== or !=)
• Checking for NULL instead of not NULL
• Relying on implicit pointer truthiness

3. Consider this FreeRTOS code snippet:

int x = 5;
configASSERT(x > 10);
printf("Reached here\n");

What will be the output when this code runs in a debug build?

medium

A. Compilation error due to configASSERT

B. Reached here

C. Program halts at configASSERT, no output

D. Undefined behavior, may crash later

Solution

1. Step 1: Evaluate the condition inside configASSERT()

   The condition is x > 10, but x is 5, so condition is false.

2. Step 2: Understand configASSERT() behavior on false condition

   configASSERT() halts the program immediately when the condition is false, so the printf line is never reached.

3. Final Answer:

   Program halts at configASSERT, no output -> Option C

4. Quick Check:

   False condition stops program = A [OK]

Hint: False condition in configASSERT() stops program before next lines [OK]

Common Mistakes:

• Assuming code after configASSERT() runs anyway
• Thinking configASSERT() causes compile error
• Ignoring that condition is false

4. You wrote this code:

int *ptr = NULL;
configASSERT(ptr != NULL);

But the program crashes immediately. What is the most likely cause?

medium

A. The pointer should be NULL to avoid crash

B. The pointer ptr is NULL, so configASSERT() halts the program

C. configASSERT() syntax is incorrect and causes crash

D. configASSERT() only works in release builds

Solution

1. Step 1: Analyze the pointer value and assertion

   ptr is NULL, but configASSERT checks ptr != NULL, which is false.

2. Step 2: Understand configASSERT() behavior on false condition

   When the condition is false, configASSERT() halts the program immediately, causing the crash.

3. Final Answer:

   The pointer ptr is NULL, so configASSERT() halts the program -> Option B

4. Quick Check:

   NULL pointer fails assert halting program = C [OK]

Hint: Crash means assert condition was false, check pointer value [OK]

Common Mistakes:

• Thinking configASSERT() syntax caused crash
• Believing NULL pointer is safe here
• Assuming configASSERT() runs only in release

5. You want to use configASSERT() to check that a task creation function returns pdPASS. Which is the best way to write this assertion?

hard

A. configASSERT(xTaskCreate(...) == pdPASS);

B. if (xTaskCreate(...) != pdPASS) configASSERT(0);

C. configASSERT(xTaskCreate(...) != pdPASS);

D. configASSERT(xTaskCreate(...) = pdPASS);

Solution

1. Step 1: Understand the goal of the assertion

   We want to assert that xTaskCreate returns pdPASS, meaning task creation succeeded.

2. Step 2: Analyze each option's correctness

   configASSERT(xTaskCreate(...) == pdPASS); asserts the return equals pdPASS directly, which is clear and correct. if (xTaskCreate(...) != pdPASS) configASSERT(0); uses an if statement with configASSERT(0), which is less direct. configASSERT(xTaskCreate(...) != pdPASS); asserts return not equal pdPASS, which is wrong. configASSERT(xTaskCreate(...) = pdPASS); uses assignment (=) instead of comparison, causing syntax error.

3. Final Answer:

   configASSERT(xTaskCreate(...) == pdPASS); -> Option A

4. Quick Check:

   Assert equality to pdPASS directly = B [OK]

Hint: Assert task creation equals pdPASS directly with == [OK]

Common Mistakes:

• Using assignment (=) instead of comparison (==)
• Asserting inequality instead of equality
• Using if with configASSERT(0) unnecessarily