Add script to convert XXXerr() to XXXerror #9441

richsalz · 2019-07-23T14:18:54Z

As discussed in the comment thread at #9391 (comment), this adds new XXXerror() defines that gets rid of the now-unused function name and deprecates the XXXerr() defines.

This is FYI to give a "taste" of what the conversion would be like. In numeric order, the ones remaining are shown below.

Does the OMC want to do this? If so, I'll continue with the conversion.

14 PROPerr(
16 OBJerr(
18 ASYNCerr(
34 PROVerr(
36 UIerr(
41 OCSPerr(
47 FUNCerr(
49 CONFerr(
50 CRYPTOerr(
50 DSAerr(
51 RANDerr(
57 CTerr(
58 CRMFerr(
60 DHerr(
63 OSSL_STOREerr(
63 PKCS12err(
64 KDFerr(
73 BNerr(
73 SM2err(
77 TSerr(
86 ENGINEerr(
86 PEMerr(
99 DSOerr(
108 BIOerr(
118 PKCS7err(
151 X509err(
184 CMSerr(
185 RSAerr(
195 X509V3err(
283 EVPerr(
295 ASN1err(
323 SSLerr(
470 ECerr(

t8m · 2019-07-23T14:39:21Z

Should there be underscore between MODULE and error to better align with other identifiers? Like BUF_error.

mattcaswell · 2019-07-23T16:49:00Z

I think this is much better. I do have a worry about the pain it will cause us when backporting fixes from master to 1.1.1. One option would be to do this - but delay it until shortly before we release 3.0. Or alternatively maybe it won't be so bad and we should just get on with it. I'm not sure.

mattcaswell · 2019-07-23T16:49:28Z

Travis failure is not relevant.

richsalz · 2019-07-23T17:13:17Z

I'm inclined to agree with @t8m that FOO_error is better than FOOerr; thoughts?

richsalz · 2019-07-23T17:16:07Z

I'll wait a few days and see what the other committers and OMC think before I do more work on this.
(And if it moves forward, I expect to do the complete solution, including an editing script)

richsalz · 2019-07-23T18:09:30Z

Added commit 08a88216176cc7fec454ebd3f1c4e87b15e51628 which includes the editing script and commit 14fb890f86926733a6b6d9f99d961650157aeb0e which shows what things look like using CRPTO_error style.

beldmit · 2019-07-23T18:17:05Z

I agree with Tomas about undescore and Matt about delay.

richsalz · 2019-07-30T19:41:22Z

Since #9452 is likely to go in, I have removed variations and made this based purely on that.

include/openssl/err.h

richsalz · 2019-08-02T13:04:23Z

Taking this out of WIP. It is reasonable to do the conversion (very) late in the development cycle, so I made it easier to do so. This PR now adds the conversion script, and it shows how the old XXXerr defines will get deprecated, by a hack in err.h that should be removed then the script is run.

richsalz · 2019-08-02T13:31:08Z

I changed the title, removed the WIP.

richsalz · 2019-08-09T15:23:58Z

I'd appreciate feedback on the comments in the script, starting at around line 14 of https://github.com/openssl/openssl/pull/9441/files#diff-101f5c3e883943d0b61879f71fa9d71fR14

richsalz · 2019-08-12T20:05:31Z

I added a script to merge XXXerr() calls that are broken across two lines. It think it's feasible to merge this PR now and then, when the project decides to do the conversion, just run the scripts and review their output.

richsalz · 2019-08-16T22:31:37Z

I pushed another commit to reformat some code. When I do that, I can run the automated scripts and build without errors:

; config no-deprecated
; perl -pi -e 's/1 \|\|//;'  include/openssl/err.h 
; git grep -l '[A-Z0-9]err([^)]*$' | xargs perl -pi util/merge-err-lines
; git ls-files | grep '\.c$' | xargs perl -pi util/err-to-raise
; make -sj10
; make test

I think this PR, which does not do the big conversion should be reviewed and merged. And then, when the project team is ready, they can run the scripts to do the conversion and merge it.

levitte · 2019-08-17T04:29:54Z

include/openssl/err.h

+#  define TSerr(f, r) ERR_raise_data(ERR_LIB_TS, (r), NULL)
+#  define UIerr(f, r) ERR_raise_data(ERR_LIB_UI, (r), NULL)
+#  define X509V3err(f, r) ERR_raise_data(ERR_LIB_X509V3, (r), NULL)
+#  define X509err(f, r) ERR_raise_data(ERR_LIB_X509, (r), NULL)


It seems a little unnecessary to make them into ERR_raise_data...

Well, it's hidden behind a macro. If I leave it as ERR_raise that will then get turned into ERR_raise_data so I figured it was more useful to developers to not have to chase down multiple define's. But if you want it changed, okay.

(By which I mean, be expilcit and say "please change it" :)

(I only made a comment, not a change request. I'll try to remember to be explicit about that)

It's not a big deal; I think we sometimes forget that discussion is one of the most important things about a PR. :)

richsalz · 2019-09-09T18:50:56Z

Related to #9333 (comment) this PR can be merged new, safely, and then the steps in #9441 (comment) can be done just before one of the pre-official releases.

Actually, for transition, they're not really deprecated. Remove the "1 ||" from the ifdef line (in include/openssl/err.h) when ready to do this in production/"for real"

It either makes the flow of control simpler and more obvious, or it is just a "cleanup" so that the editing scripts will find and fixup things.

richsalz · 2019-09-19T13:30:58Z

This is the infrastructure, and includes steps to do the work, for converting the old XXXerr calls. It's been a month. Ping for review.

beldmit · 2019-09-19T13:45:41Z

crypto/evp/evp_lib.c

+    if (ret == -2)
+        EVPerr(EVP_F_EVP_CIPHER_PARAM_TO_ASN1, ASN1_R_UNSUPPORTED_CIPHER);
+    else if (ret <= 0)
+        EVPerr(EVP_F_EVP_CIPHER_PARAM_TO_ASN1, EVP_R_CIPHER_PARAMETER_ERROR);


Sorry for being out of context, but is it OK that here we leave EVPerr(), and in https://github.com/openssl/openssl/pull/9441/files#diff-9f773e58c4cc40339f694534e55f6cb3 we replace EVPerr with ERR_raise()?

I think these are changes are made to make life easier with util/merge-err-lines, as that only handles this kind of split:

BLARGerr(BLARG_F_FOO, BLARG_R_BAR);

beldmit · 2019-09-19T13:46:03Z

crypto/evp/evp_lib.c

+    if (ret == -2)
+        EVPerr(EVP_F_EVP_CIPHER_ASN1_TO_PARAM, EVP_R_UNSUPPORTED_CIPHER);
+    else if (ret <= 0)
+        EVPerr(EVP_F_EVP_CIPHER_ASN1_TO_PARAM, EVP_R_CIPHER_PARAMETER_ERROR);


Similar question.

Same answer

levitte

I just made a test run, these scripts appear to do what they promise

Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from #9441)

Actually, for transition, they're not really deprecated. Remove the "1 ||" from the ifdef line (in include/openssl/err.h) when ready to do this in production/"for real" Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from #9441)

Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from #9441)

It either makes the flow of control simpler and more obvious, or it is just a "cleanup" so that the editing scripts will find and fixup things. Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from #9441)

levitte · 2019-09-19T14:23:07Z

Merged.

0f17ac2 Add script convert XXerr to ERR_raise
f6aca23 Deprecate XXXerr() macros
8c0e768 Add merge-err-lines script
51ba9eb Avoid ?: construct in XXXerr calls

richsalz · 2019-09-19T16:15:34Z

THANK YOU!

richsalz mentioned this pull request Jul 23, 2019

Rework EVP_MD support, enhance existing functions #9391

Closed

levitte mentioned this pull request Jul 24, 2019

Implement ERR_raise() / ERR_raise_data() #9452

Closed

levitte reviewed Jul 31, 2019

View reviewed changes

include/openssl/err.h Show resolved Hide resolved

levitte reviewed Jul 31, 2019

View reviewed changes

include/openssl/err.h Outdated Show resolved Hide resolved

levitte reviewed Jul 31, 2019

View reviewed changes

include/openssl/err.h Show resolved Hide resolved

richsalz changed the title ~~WIP: Convert XXXerr() to XXXerror~~ Add script to convert XXXerr() to XXXerror Aug 2, 2019

levitte reviewed Aug 17, 2019

View reviewed changes

richsalz added 4 commits September 19, 2019 09:27

Add script convert XXerr to ERR_raise

fa0ecc1

Deprecate XXXerr() macros

8bedbbc

Actually, for transition, they're not really deprecated. Remove the "1 ||" from the ifdef line (in include/openssl/err.h) when ready to do this in production/"for real"

Add merge-err-lines script

9c2f887

Avoid ?: construct in XXXerr calls

2e85061

It either makes the flow of control simpler and more obvious, or it is just a "cleanup" so that the editing scripts will find and fixup things.

beldmit reviewed Sep 19, 2019

View reviewed changes

levitte approved these changes Sep 19, 2019

View reviewed changes

beldmit approved these changes Sep 19, 2019

View reviewed changes

levitte pushed a commit that referenced this pull request Sep 19, 2019

Add script convert XXerr to ERR_raise

0f17ac2

Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from #9441)

levitte pushed a commit that referenced this pull request Sep 19, 2019

Add merge-err-lines script

8c0e768

Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from #9441)

levitte closed this Sep 19, 2019

richsalz deleted the err-to-error branch September 19, 2019 16:15

richsalz mentioned this pull request Jun 27, 2020

Completely remove "func" from ERR state. #12289

Closed

richsalz mentioned this pull request Aug 19, 2020

Rename OPENSSL_CTX type to OSSL_LIB_CTX #12621

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add script to convert XXXerr() to XXXerror #9441

Add script to convert XXXerr() to XXXerror #9441

richsalz commented Jul 23, 2019

t8m commented Jul 23, 2019

mattcaswell commented Jul 23, 2019

mattcaswell commented Jul 23, 2019

richsalz commented Jul 23, 2019

richsalz commented Jul 23, 2019

richsalz commented Jul 23, 2019

beldmit commented Jul 23, 2019

richsalz commented Jul 30, 2019

richsalz commented Aug 2, 2019

richsalz commented Aug 2, 2019

richsalz commented Aug 9, 2019 •

edited

richsalz commented Aug 12, 2019

richsalz commented Aug 16, 2019

levitte Aug 17, 2019

richsalz Aug 17, 2019

richsalz Aug 17, 2019

levitte Aug 18, 2019

richsalz Aug 18, 2019

richsalz commented Sep 9, 2019

richsalz commented Sep 19, 2019

beldmit Sep 19, 2019

levitte Sep 19, 2019

beldmit Sep 19, 2019

beldmit Sep 19, 2019

levitte Sep 19, 2019

levitte left a comment

levitte commented Sep 19, 2019

richsalz commented Sep 19, 2019

Add script to convert XXXerr() to XXXerror #9441

Add script to convert XXXerr() to XXXerror #9441

Conversation

richsalz commented Jul 23, 2019

t8m commented Jul 23, 2019

mattcaswell commented Jul 23, 2019

mattcaswell commented Jul 23, 2019

richsalz commented Jul 23, 2019

richsalz commented Jul 23, 2019

richsalz commented Jul 23, 2019

beldmit commented Jul 23, 2019

richsalz commented Jul 30, 2019

richsalz commented Aug 2, 2019

richsalz commented Aug 2, 2019

richsalz commented Aug 9, 2019 • edited

richsalz commented Aug 12, 2019

richsalz commented Aug 16, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richsalz commented Sep 9, 2019

richsalz commented Sep 19, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

levitte left a comment

Choose a reason for hiding this comment

levitte commented Sep 19, 2019

richsalz commented Sep 19, 2019

richsalz commented Aug 9, 2019 •

edited