The branch master has been updated via 16c6534b961a723781bb827211c705c7d7fb3727 (commit) via 174f4a4d6a8e54429732e01ea4448d2d08b2bf98 (commit) via dc18781550d5df62074d0ad16680a6dda862df6e (commit) via 43b2e9e0088192f7e116b9b198a8c662ade193eb (commit) via a77571c34f61ceb455a4aa357d4d95e412f9e9f8 (commit) from 53043311560f836ce65e7ad55423363901d1287a (commit)
- Log ----------------------------------------------------------------- commit 16c6534b961a723781bb827211c705c7d7fb3727 Author: Dr. David von Oheimb <david.von.ohe...@siemens.com> Date: Thu Jun 25 11:55:56 2020 +0200 check-format.pl: Add an entry about it to NEWS.md and to CHANGES.md Reviewed-by: Paul Dale <paul.d...@oracle.com> (Merged from https://github.com/openssl/openssl/pull/12270) commit 174f4a4d6a8e54429732e01ea4448d2d08b2bf98 Author: Dr. David von Oheimb <david.von.ohe...@siemens.com> Date: Sun Jun 7 14:53:20 2020 +0200 check-format.pl: Report empty lines only if -s (--sloppy-spc) is not used Reviewed-by: Paul Dale <paul.d...@oracle.com> (Merged from https://github.com/openssl/openssl/pull/12270) commit dc18781550d5df62074d0ad16680a6dda862df6e Author: Dr. David von Oheimb <david.von.ohe...@siemens.com> Date: Sun Jun 7 14:47:16 2020 +0200 check-format.pl: Add check for essentially empty line at beginning of file Reviewed-by: Paul Dale <paul.d...@oracle.com> (Merged from https://github.com/openssl/openssl/pull/12270) commit 43b2e9e0088192f7e116b9b198a8c662ade193eb Author: Dr. David von Oheimb <david.von.ohe...@siemens.com> Date: Sat Jun 6 21:14:29 2020 +0200 check-format.pl: Add check for multiples essentially empty lines in a row Reviewed-by: Paul Dale <paul.d...@oracle.com> (Merged from https://github.com/openssl/openssl/pull/12270) commit a77571c34f61ceb455a4aa357d4d95e412f9e9f8 Author: Dr. David von Oheimb <david.von.ohe...@siemens.com> Date: Tue Apr 7 14:27:08 2020 +0200 check-format.pl: Allow comment start '/*' after opening '(','[','{' On this occasion fix uses of the word 'nor'. Reviewed-by: Paul Dale <paul.d...@oracle.com> (Merged from https://github.com/openssl/openssl/pull/12270) ----------------------------------------------------------------------- Summary of changes: CHANGES.md | 7 + NEWS.md | 1 + util/check-format-test-negatives.c | 806 ++++++++++++++++++------------------- util/check-format-test-positives.c | 405 ++++++++++--------- util/check-format.pl | 26 +- 5 files changed, 630 insertions(+), 615 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 3a267d6c25..5ff188c18c 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -240,6 +240,13 @@ OpenSSL 3.0 *David von Oheimb* + * Added `util/check-format.pl`, a tool for checking adherence to the + OpenSSL coding style <https://www.openssl.org/policies/codingstyle.html>. + The checks performed are incomplete and yield some false positives. + Still the tool should be useful for detecting most typical glitches. + + *David von Oheimb* + * BIO_do_connect and BIO_do_handshake have been extended: If domain name resolution yields multiple IP addresses all of them are tried after connect() failures. diff --git a/NEWS.md b/NEWS.md index ed99e8cd00..801016f2b5 100644 --- a/NEWS.md +++ b/NEWS.md @@ -41,6 +41,7 @@ OpenSSL 3.0 All widely used CMP features are supported for both clients and servers. * Added a proper HTTP(S) client to libcrypto supporting GET and POST, redirection, plain and ASN.1-encoded contents, proxies, and timeouts. + * Added util/check-format.pl for checking adherence to the coding guidelines. * Added OSSL_SERIALIZER, a generic serializer API. * Added OSSL_PARAM_BLD, an easier to use API to OSSL_PARAM. * Added error raising macros, ERR_raise() and ERR_raise_data(). diff --git a/util/check-format-test-negatives.c b/util/check-format-test-negatives.c index 33d0e9445d..478fe62e16 100644 --- a/util/check-format-test-negatives.c +++ b/util/check-format-test-negatives.c @@ -22,7 +22,7 @@ int f(void) /* */ { if (ctx == NULL) { /* non-leading intra-line comment */ - if (pem_name != NULL) + if (/* comment after '(' */ pem_name != NULL /* comment before ')' */) /* entire-line comment indent usually like for the following line */ return NULL; /* hanging indent also for this line after comment */ /* leading comment has same indentation as normal code */ stmt; @@ -308,410 +308,410 @@ ASN1_ITEM_TEMPLATE_END(OSSL_CRMF_MSGS) void f_looong_body_200() { /* function body length up to 200 lines accepted */ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; } void f_looong_body_201() { /* function body length > 200 lines, but LONG BODY marker present */ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; } diff --git a/util/check-format-test-positives.c b/util/check-format-test-positives.c index 809ecaa355..7d9bbea5c7 100644 --- a/util/check-format-test-positives.c +++ b/util/check-format-test-positives.c @@ -134,212 +134,211 @@ int f (int a, /*@ space after fn before '(', reported unless sloppy-spc */ void f_looong_body() { - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + ; + + + ; /*@ 2 essentially empty lines before, if !sloppy-spc */ } /*@ function body length > 200 lines */ - #if 0 /*@0 unclosed #if */ struct t { /*@0 unclosed brace at decl/block level */ enum { /*@0 unclosed brace at enum/expression level */ v = (1 /*@0 unclosed parenthesis */ - etyp /*@0 empty line follows just before EOF: */ + etyp /*@0 empty line follows just before EOF, if !sloppy-spc: */ diff --git a/util/check-format.pl b/util/check-format.pl index b7c28f15ef..0619240f82 100755 --- a/util/check-format.pl +++ b/util/check-format.pl @@ -259,7 +259,7 @@ sub check_indent { # used for lines outside multi-line string literals ($alt_desc, $alt_indent) = ("outermost position", 1) if $expr_indent == 0 && $has_label; if (@nested_conds_indents != 0 && substr($_, $count, 1) eq ":") { - # leading ':' within stmt/expr/decl - this cannot happen for labels nor leading '&&' or '||' + # leading ':' within stmt/expr/decl - this cannot happen for labels, leading '&&', or leading '||' # allow special indent at level of corresponding "?" ($alt_desc, $alt_indent) = ("leading ':'", @nested_conds_indents[-1]); } @@ -512,7 +512,7 @@ while (<>) { # loop over all lines of all input files # detect end of comment, must be within multi-line comment, check if it is preceded by non-whitespace text if ((my ($head, $tail) = m|^(.*?)\*/(.*)$|) && $1 ne '/') { # ending comment: '*/' - report("no SPC nor '*' before '*/'") if $head =~ m/[^*\s]$/; + report("neither SPC nor '*' before '*/'") if $head =~ m/[^*\s]$/; report("no SPC after '*/'") if $tail =~ m/^[^\s,;)}\]]/; # no space or ,;)}] after '*/' if (!($head =~ m|/\*|)) { # not begin of comment '/*', which is is handled below if ($in_comment == 0) { @@ -537,8 +537,8 @@ while (<>) { # loop over all lines of all input files MATCH_COMMENT: if (my ($head, $opt_minus, $tail) = m|^(.*?)/\*(-?)(.*)$|) { # begin of comment: '/*' report("no SPC before '/*'") - if $head =~ m/[^\s\*]$/; # no space (nor '*', needed to allow '*/' here) before comment delimiter - report("no SPC nor '*' after '/*' or '/*-'") if $tail =~ m/^[^\s*$self_test_exception]/; + if $head =~ m/[^\s(\*]$/; # not space, '(', or or '*' (needed to allow '*/') before comment delimiter + report("neither SPC nor '*' after '/*' or '/*-'") if $tail =~ m/^[^\s*$self_test_exception]/; my $cmt_text = $opt_minus.$tail; # preliminary if ($in_comment > 0) { report("unexpected '/*' inside multi-line comment"); @@ -647,8 +647,10 @@ while (<>) { # loop over all lines of all input files $intra_line =~ s/[A-Z_]+/int/g if $contents =~ m/^(.*?)\s*\\\s*$/; # treat double &&, ||, <<, and >> as single ones, simplifying matching below $intra_line =~ s/(&&|\|\||<<|>>)/substr($1, 0, 1)/eg; - # remove blinded comments etc. directly before ,;)} - while ($intra_line =~ s/\s*@+([,;)}\]])/$1/e) {} # /g does not work here + # remove blinded comments etc. directly after [{( + while ($intra_line =~ s/([\[\{\(])@+\s?/$1/e) {} # /g does not work here + # remove blinded comments etc. directly before ,;)}] + while ($intra_line =~ s/\s?@+([,;\)\}\]])/$1/e) {} # /g does not work here # treat remaining blinded comments and string literal contents as (single) space during matching below $intra_line =~ s/@+/ /g; # note that double SPC has already been handled above $intra_line =~ s/\s+$//; # strip any (resulting) space at EOL @@ -826,7 +828,7 @@ while (<>) { # loop over all lines of all input files # check for code block containing a single line/statement if ($line_before2 > 0 && !$outermost_level && # within function body - $in_typedecl == 0 && @nested_indents == 0 && # not within type declaration nor inside stmt/expr + $in_typedecl == 0 && @nested_indents == 0 && # neither within type declaration nor inside stmt/expr m/^[\s@]*\}/) { # leading closing brace '}', any preceding blinded comment must not be matched # TODO extend detection from single-line to potentially multi-line statement if ($line_opening_brace > 0 && @@ -1072,7 +1074,13 @@ while (<>) { # loop over all lines of all input files $hanging_offset = 0; # compensate for this in case macro ends, e.g., as 'while (0)' } - unless (m/^\s*$/) { # essentially empty line: just whitespace (and maybe a '\') + if (m/^\s*$/) { # essentially empty line: just whitespace (and maybe a '\') + report("empty line at beginnig of file") if $line == 1 && !$sloppy_SPC; + } else { + if ($line_before > 0) { + my $linediff = $line - $line_before - 1; + report("$linediff empty lines before") if $linediff > 1 && !$sloppy_SPC; + } $line_before2 = $line_before; $contents_before2 = $contents_before; $contents_before_2 = $contents_before_; @@ -1095,7 +1103,7 @@ while (<>) { # loop over all lines of all input files if (eof) { # check for essentially empty line (which may include a '\') just before EOF report(($1 eq "\n" ? "empty line" : $2 ne "" ? "'\\'" : "whitespace")." at EOF") - if $contents =~ m/^(\s*(\\?)\s*)$/; + if $contents =~ m/^(\s*(\\?)\s*)$/ && !$sloppy_SPC; # report unclosed expression-level nesting check_nested_nonblock_indents("expr at EOF"); # also adapts @nested_block_indents