Do not print error reports in release builds #7404

SenRamakri · 2018-07-02T21:27:21Z

Description

This avoids printing error reports in release builds.

Pull request type

[x] Fix
[ ] Refactor
[ ] New target
[ ] Feature
[ ] Breaking change

cmonr · 2018-07-03T00:45:52Z

/morph build

mbed-ci · 2018-07-03T03:13:30Z

Build : SUCCESS

Build number : 2501
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/7404/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

mbed-ci · 2018-07-03T04:29:16Z

Exporter Build : FAILURE

Build number : 2150
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/7404/

mbed-ci · 2018-07-03T04:41:30Z

Test : SUCCESS

Build number : 2277
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/7404/2277

0xc0170 · 2018-07-03T07:04:28Z

Fixes #7387

0xc0170 · 2018-07-03T10:33:15Z

/morph export-build

mbed-ci · 2018-07-03T10:41:30Z

Exporter Build : FAILURE

Build number : 2160
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/7404/

deepikabhavnani · 2018-07-03T15:28:39Z

platform/mbed_error.c

@@ -78,7 +78,9 @@ WEAK void error(const char *format, ...)

    //Call handle_error/print_error_report permanently setting error_in_progress flag
    handle_error(MBED_ERROR_UNKNOWN, 0, NULL, 0);
+#ifndef NDEBUG
    print_error_report(&last_error_ctx, "Fatal Run-time error");


Shouldn't we guard everything in error function with NDEBUG? Should handle_error be called in case of NDEBUG?

We should not guard everything. We still need handle_error to be called because we need to record if its first/last error which is always tracked and we will report it externally(using devicehealth apis for example) when required.

But you could guard everything in print_error_report() with NDEBUG or have a dummy print_error_report() macro - neater than having multiple callers do ifdefs.

You should also watch out for "unused static function" warnings, which I think you'll get from the current version on some compilers.

deepikabhavnani

Implementation of print_error_report should be guarded by NDEBUG
https://github.com/SenRamakri/mbed-os/blob/6d6db5e3c8edcdae02282f1f25c98675fd17344d/platform/mbed_error.c#L309

Changes still needed

cmonr · 2018-07-05T19:22:05Z

@deepikabhavnani Are changes still needed after the current updated commits?

deepikabhavnani · 2018-07-05T19:46:02Z

platform/mbed_error.c

+#define ERROR_REPORT    print_error_report
+#else
+#define ERROR_REPORT
+#endif


Shall we not add an additional macro and instead just update the code as below:

#ifdef NDEBUG #define print_error_report #endif

That would be confusing and may affect the readability to have actual function name to be nulled out. The macro bound to NDEBUG or not name clearly indicates the issue being addressed. Also its not a public macro, should not be a concern.

Would kind of expect this version to generate a lot of warnings for release, as it expands to just

(&last_error_ctx, error_msg);

Which is legal, but a compiler is going to rightly think looks weird.

It's more conventional to define a function-like macro:

#ifdef NDEBUG #define print_error_report(ctx, error_msg) ((void) 0) #endif

or

#ifndef NDEBUG #define ERROR_REPORT(ctx, error_msg) print_error_report(ctx, error_msg) #else #define ERROR_REPORT(ctx, error_msg) ((void) 0) #endif

@kjbracey-arm - Ok, I can change it to include args. And I would go with second version, I have found the first version to be confusing and affects readability.

cmonr · 2018-07-05T20:03:38Z

/morph build

mbed-ci · 2018-07-05T22:34:03Z

Build : SUCCESS

Build number : 2540
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/7404/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

mbed-ci · 2018-07-05T23:59:24Z

Test : SUCCESS

Build number : 2296
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/7404/2296

mbed-ci · 2018-07-06T01:23:36Z

Exporter Build : SUCCESS

Build number : 2185
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/7404/

cmonr · 2018-07-06T15:46:19Z

@kjbracey-arm @deepikabhavnani Mind re-reviewing?

0xc0170 · 2018-07-10T11:01:59Z

/morph build

mbed-ci · 2018-07-10T12:40:35Z

Build : SUCCESS

Build number : 2558
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/7404/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

mbed-ci · 2018-07-10T14:54:47Z

Test : SUCCESS

Build number : 2315
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/7404/2315

cmonr · 2018-07-11T03:18:31Z

/morph export-build

mbed-ci · 2018-07-11T05:21:34Z

Exporter Build : SUCCESS

Build number : 2204
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/7404/

…kForRelease Do not print error reports in release builds

SenRamakri mentioned this pull request Jul 2, 2018

mbed_error should provide a way to avoid linking to vprintf #7387

Closed

cmonr previously approved these changes Jul 3, 2018

View reviewed changes

cmonr added needs: CI release-version: 5.9.3 labels Jul 3, 2018

cmonr requested a review from deepikabhavnani July 3, 2018 00:45

0xc0170 requested a review from a team July 3, 2018 07:03

0xc0170 previously approved these changes Jul 3, 2018

View reviewed changes

deepikabhavnani reviewed Jul 3, 2018

View reviewed changes

deepikabhavnani suggested changes Jul 3, 2018

View reviewed changes

cmonr added needs: work and removed needs: CI labels Jul 3, 2018

SenRamakri dismissed stale reviews from 0xc0170 and cmonr via 61458d5 July 5, 2018 16:55

SenRamakri force-pushed the sen_FixErrorReportLinkForRelease branch from 6d6db5e to 61458d5 Compare July 5, 2018 16:55

cmonr previously approved these changes Jul 5, 2018

View reviewed changes

deepikabhavnani reviewed Jul 5, 2018

View reviewed changes

deepikabhavnani previously approved these changes Jul 5, 2018

View reviewed changes

SenRamakri added 2 commits July 6, 2018 09:56

Don't print error reports in release builds

a29eee4

Remove error reporting for release builds

b6179d2

SenRamakri dismissed deepikabhavnani’s stale review via b6179d2 July 6, 2018 15:16

SenRamakri force-pushed the sen_FixErrorReportLinkForRelease branch from 61458d5 to b6179d2 Compare July 6, 2018 15:16

cmonr added needs: review and removed needs: work labels Jul 6, 2018

deepikabhavnani approved these changes Jul 6, 2018

View reviewed changes

0xc0170 approved these changes Jul 9, 2018

View reviewed changes

0xc0170 added needs: CI and removed needs: review labels Jul 10, 2018

0xc0170 added ready for merge and removed needs: CI labels Jul 11, 2018

cmonr merged commit 6130744 into ARMmbed:master Jul 11, 2018

0xc0170 removed the ready for merge label Jul 11, 2018

pan- pushed a commit to pan-/mbed that referenced this pull request Aug 22, 2018

Merge pull request ARMmbed#7404 from SenRamakri/sen_FixErrorReportLin…

7dab87e

…kForRelease Do not print error reports in release builds

Do not print error reports in release builds #7404

Do not print error reports in release builds #7404

Uh oh!

Conversation

SenRamakri commented Jul 2, 2018

Description

Pull request type

Uh oh!

cmonr commented Jul 3, 2018

Uh oh!

mbed-ci commented Jul 3, 2018

Triggering tests

Uh oh!

mbed-ci commented Jul 3, 2018

Uh oh!

mbed-ci commented Jul 3, 2018

Uh oh!

0xc0170 commented Jul 3, 2018

Uh oh!

0xc0170 commented Jul 3, 2018

Uh oh!

mbed-ci commented Jul 3, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

deepikabhavnani left a comment

Choose a reason for hiding this comment

Uh oh!

cmonr commented Jul 5, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cmonr commented Jul 5, 2018

Uh oh!

mbed-ci commented Jul 5, 2018

Triggering tests

Uh oh!

mbed-ci commented Jul 5, 2018

Uh oh!

mbed-ci commented Jul 6, 2018

Uh oh!

cmonr commented Jul 6, 2018

Uh oh!

0xc0170 commented Jul 10, 2018

Uh oh!

mbed-ci commented Jul 10, 2018

Triggering tests

Uh oh!

mbed-ci commented Jul 10, 2018

Uh oh!

cmonr commented Jul 11, 2018

Uh oh!

mbed-ci commented Jul 11, 2018

Uh oh!

Uh oh!