From patchwork Fri Dec 17 16:22:15 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Florian Weimer X-Patchwork-Id: 49055 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 0F9C0385801A for ; Fri, 17 Dec 2021 16:22:44 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 0F9C0385801A DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1639758164; bh=3clMNQdFBBjrm7z4v2fpwnKBiWfP7eoYgCHCG6Kniw8=; h=To:Subject:Date:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=ZMSjsMy8kd80DrG8J5Oy52h+znjnHAOhgnVizzvlAC0e4KTLCiM5Sj5c20RBtj6ij y3S/ScgAwva+3a1DY65ZMJcbzBDlBEJnvGvL2rO17fJSU82V2C2D43CUsSeXpOycfX OFTgoGE0IvyKegwbCIIR3Vm61PgYoN/D4qYTEsSc= X-Original-To: libc-alpha@sourceware.org Delivered-To: libc-alpha@sourceware.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id 416CD3858410 for ; Fri, 17 Dec 2021 16:22:22 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 416CD3858410 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-340-fy81xGBSPI2spkKErJhMwA-1; Fri, 17 Dec 2021 11:22:18 -0500 X-MC-Unique: fy81xGBSPI2spkKErJhMwA-1 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 2776181EE60 for ; Fri, 17 Dec 2021 16:22:18 +0000 (UTC) Received: from oldenburg.str.redhat.com (unknown [10.39.192.46]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 4E67460C81 for ; Fri, 17 Dec 2021 16:22:17 +0000 (UTC) To: libc-alpha@sourceware.org Subject: [PATCH v2] stdio: Implement %#m for vfprintf and related functions Date: Fri, 17 Dec 2021 17:22:15 +0100 Message-ID: <87tuf7i4lk.fsf@oldenburg.str.redhat.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-12.5 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_SHORT, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_NONE, TXREP autolearn=ham autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org X-BeenThere: libc-alpha@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Florian Weimer via Libc-alpha From: Florian Weimer Reply-To: Florian Weimer Errors-To: libc-alpha-bounces+patchwork=sourceware.org@sourceware.org Sender: "Libc-alpha" %#m prints errno as an error constant if one is available, or a decimal number as a fallback. This intends to address the gap that strerrorname_np does not work well with printf for unknown error codes due to its NULL return values in those cases. --- v2: Rebased on top of current trunk. NEWS | 3 ++ manual/stdio.texi | 8 +++- stdio-common/Makefile | 4 +- stdio-common/tst-sprintf-errno.c | 93 ++++++++++++++++++++++++++++++++++++++++ stdio-common/vfprintf-internal.c | 25 ++++++++--- 5 files changed, 125 insertions(+), 8 deletions(-) diff --git a/NEWS b/NEWS index c7200cd4e8..9294a7b953 100644 --- a/NEWS +++ b/NEWS @@ -99,6 +99,9 @@ Major new features: is set to 'madvise' mode while the latter uses the system reserved huge pages. +* The printf family of functions now handles the flagged %#m conversion + specifier, printing errno as an error constant (similar to strerrorname_np). + Deprecated and removed features, and other changes affecting compatibility: * On x86-64, the LD_PREFER_MAP_32BIT_EXEC environment variable support diff --git a/manual/stdio.texi b/manual/stdio.texi index 29d01b9ec9..1fac8e5f78 100644 --- a/manual/stdio.texi +++ b/manual/stdio.texi @@ -1949,6 +1949,9 @@ which can be parsed by the @code{strtoul} function (@pxref{Parsing of Integers}) and @code{scanf} with the @samp{%i} conversion (@pxref{Numeric Input Conversions}). +For the @samp{%m} conversion, print an error constant or decimal error +number, instead of a (possibly translated) error message. + @item @samp{'} Separate the digits into groups as specified by the locale specified for the @code{LC_NUMERIC} category; @pxref{General Numeric}. This flag is a @@ -2271,8 +2274,9 @@ is equivalent to: fprintf (stderr, "can't open `%s': %s\n", filename, strerror (errno)); @end smallexample -@noindent -The @samp{%m} conversion is a @glibcadj{} extension. +The @samp{%m} conversion can be used with the @samp{#} flag to print an +error constant, as provided by @code{strerrorname_np}. Both @samp{%m} +and @samp{%#m} are @glibcadj{} extensions. The @samp{%p} conversion prints a pointer value. The corresponding argument must be of type @code{void *}. In practice, you can use any diff --git a/stdio-common/Makefile b/stdio-common/Makefile index bbb3a2ca56..a69a296343 100644 --- a/stdio-common/Makefile +++ b/stdio-common/Makefile @@ -71,7 +71,9 @@ tests := tstscanf test_rdwr test-popen tstgetln test-fseek \ tst-printf-fp-free \ tst-printf-fp-leak \ test-strerr \ - tst-printf-binary + tst-printf-binary \ + tst-sprintf-errno \ + # tests test-srcs = tst-unbputc tst-printf tst-printfsz-islongdouble diff --git a/stdio-common/tst-sprintf-errno.c b/stdio-common/tst-sprintf-errno.c new file mode 100644 index 0000000000..7622fdbc48 --- /dev/null +++ b/stdio-common/tst-sprintf-errno.c @@ -0,0 +1,93 @@ +/* Test the %m, %#m printf specifiers via asprintf. + Copyright (C) 2021 Free Software Foundation, Inc. + This file is part of the GNU C Library. + + The GNU C Library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + The GNU C Library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with the GNU C Library; if not, see + . */ + +#include +#include +#include +#include +#include + +/* GCC does not yet know about the %#m specifier. */ +DIAG_PUSH_NEEDS_COMMENT; +DIAG_IGNORE_NEEDS_COMMENT (11, "-Wformat="); + +static int +do_test (void) +{ + char buf[64]; + + errno = EINVAL; + TEST_COMPARE (sprintf (buf, "%m"), 16); + TEST_COMPARE_STRING (buf, "Invalid argument"); + + errno = EINVAL; + TEST_COMPARE (sprintf (buf, "%#m"), 6); + TEST_COMPARE_STRING (buf, "EINVAL"); + + errno = 0; + TEST_COMPARE (sprintf (buf, "%m"), 7); + TEST_COMPARE_STRING (buf, "Success"); + + errno = 0; + TEST_COMPARE (sprintf (buf, "%#m"), 1); + TEST_COMPARE_STRING (buf, "0"); + + errno = -1; + TEST_COMPARE (sprintf (buf, "%m"), 16); + TEST_COMPARE_STRING (buf, "Unknown error -1"); + + errno = -1; + TEST_COMPARE (sprintf (buf, "%#m"), 2); + TEST_COMPARE_STRING (buf, "-1"); + + errno = 1002003; + TEST_COMPARE (sprintf (buf, "%m"), 21); + TEST_COMPARE_STRING (buf, "Unknown error 1002003"); + + errno = 1002003; + TEST_COMPARE (sprintf (buf, "%#m"), 7); + TEST_COMPARE_STRING (buf, "1002003"); + + errno = EINVAL; + TEST_COMPARE (sprintf (buf, "%20m"), 20); + TEST_COMPARE_STRING (buf, " Invalid argument"); + + errno = EINVAL; + TEST_COMPARE (sprintf (buf, "%#20m"), 20); + TEST_COMPARE_STRING (buf, " EINVAL"); + + errno = EINVAL; + TEST_COMPARE (sprintf (buf, "%-20m"), 20); + TEST_COMPARE_STRING (buf, "Invalid argument "); + + errno = EINVAL; + TEST_COMPARE (sprintf (buf, "%-#20m"), 20); + TEST_COMPARE_STRING (buf, "EINVAL "); + + errno = 0; + TEST_COMPARE (sprintf (buf, "%-20m"), 20); + TEST_COMPARE_STRING (buf, "Success "); + + errno = 0; + TEST_COMPARE (sprintf (buf, "%-#20m"), 20); + TEST_COMPARE_STRING (buf, "0 "); + + return 0; +} + +#include diff --git a/stdio-common/vfprintf-internal.c b/stdio-common/vfprintf-internal.c index e717f50073..8547090d45 100644 --- a/stdio-common/vfprintf-internal.c +++ b/stdio-common/vfprintf-internal.c @@ -950,11 +950,26 @@ static const uint8_t jump_table[] = \ LABEL (form_strerror): \ /* Print description of error ERRNO. */ \ - string = \ - (CHAR_T *) __strerror_r (save_errno, (char *) work_buffer, \ - WORK_BUFFER_SIZE * sizeof (CHAR_T)); \ - is_long = 0; /* This is no wide-char string. */ \ - goto LABEL (print_string) + if (alt) \ + string = (CHAR_T *) __get_errname (save_errno); \ + else \ + string = (CHAR_T *) __strerror_r (save_errno, (char *) work_buffer, \ + WORK_BUFFER_SIZE * sizeof (CHAR_T));\ + if (string == NULL) \ + { \ + /* Print as a decimal number. */ \ + base = 10; \ + is_negative = save_errno < 0; \ + number.word = save_errno; \ + if (is_negative) \ + number.word = -number.word; \ + goto LABEL (number); \ + } \ + else \ + { \ + is_long = 0; /* This is no wide-char string. */ \ + goto LABEL (print_string); \ + } #ifdef COMPILE_WPRINTF # define process_string_arg() \