Suppress MISRA C rule 21.6 in MISRA.md #858

kar-rahul-aws · 2023-10-24T04:11:25Z

This PR suppresses MISRA C rule 21.6 in MISRA.md.

Description

MISRA C:2012 Rule 21.6

The Standard Library input/output functions shall not be used.

MISRA violation

FreeRTOS Kernel uses snprintf to print out the buffer in vTaskListTasks and vTaskGetRunTimeStatistics API.

iSnprintfReturnValue = snprintf( pcWriteBuffer,
                                 uxBufferLength - uxConsumedBufferLength, 
                                 "\t%c\t%u\t%u\t%u\r\n",
                                 cStatus,
                                 ( unsigned int ) pxTaskStatusArray[ x ].uxCurrentPriority,
                                 ( unsigned int ) pxTaskStatusArray[ x ].usStackHighWaterMark,
                                 ( unsigned int ) pxTaskStatusArray[ x ].xTaskNumber );

Fix in this PR

We are suppressing this rule to allow use of snprintf library.

Test Steps

N/A

Checklist:

~~I have tested my changes. No regression in existing tests.~~
~~I have modified and/or added unit-tests to cover the code changes in this Pull Request.~~

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

codecov · 2023-10-24T04:20:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a8650b9) 93.64% compared to head (6cebd01) 93.64%.
Report is 6 commits behind head on main.

❗ Current head 6cebd01 differs from pull request most recent head da472ab. Consider uploading reports for the commit da472ab to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #858   +/-   ##
=======================================
  Coverage   93.64%   93.64%           
=======================================
  Files           6        6           
  Lines        2549     2549           
  Branches      608      608           
=======================================
  Hits         2387     2387           
  Misses        107      107           
  Partials       55       55

Flag	Coverage Δ
unittests	`93.64% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

moninom1 · 2023-10-31T05:29:34Z

MISRA.md

@@ -67,6 +67,10 @@ Copy below content to `misra.conf` to run Coverity on FreeRTOS-Kernel.
            deviation: "Rule 11.5",
            reason: "Allow casts from `void *`. List owner, pvOwner, is stored as `void *` and are cast to various types for use in functions."
        }
+        {
+            deviation: "Rule 21.6",
+            reason: "snprintf is used in APIs vTaskListTasks and vTaskGetRunTimeStatistics to print the buffer."
