From patchwork Fri Aug 30 19:52:10 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Florian Weimer X-Patchwork-Id: 96820 X-Patchwork-Delegate: dj@redhat.com 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 DF8933864879 for ; Fri, 30 Aug 2024 19:53:56 +0000 (GMT) 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.129.124]) by sourceware.org (Postfix) with ESMTP id 1B81D386486F for ; Fri, 30 Aug 2024 19:52:17 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 1B81D386486F Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 1B81D386486F Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.129.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1725047540; cv=none; b=Rri4DppBsQ/AnzRcQkmd7igifWiwloahvMxanBnbkn178XeXFNakSgcRMwyEQwF8JRq38alZpNqVKfe86uj1awLtax0n2IXUZiHX2Ht/wu0njekX6RD9ANNjU9dhHkIHG/ysxGLkGYZtM5/B34JhgmqHxz7oMyvA0AM1MmrfX8s= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1725047540; c=relaxed/simple; bh=qHtYvaLFNa5slA4FljEd6ahtFoTG5uD/zTbE+5CNIwM=; h=DKIM-Signature:From:To:Subject:Message-ID:Date:MIME-Version; b=LG6Zwt6Gc4E684H6gV+rMeHsmGI0oAj66FXxkc7g3a7axcDffkcAfzc0vdJktnDGwwbsV4xCdEi79ZGAam8fNxZVFOzr5Il2HfsOudjTQIOT+32vQDaFeHBiU1RzX95HjVc6R7QXEeedWYoZLj+UpPDFM68PtfKRJXdRsAQnBxQ= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1725047536; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=1/ZTmb5XMjOSQEhHYf5zKfq1DCB2Oi6sG1Ja4u+tTQI=; b=QlZxOPaVNAbhdnGkyJ86ZmMvk3XYOXdPQ73JAJnFyOPNG6o2z3YYdhgFakFFSJUrZchb7H DkQCLANyzuPD6wHffRcmR8Nc3rleT4Dt28UFQMHNoa3IOsAILU6vXSv01QJCtH/N10ucqr qNScUPUGpWcDE/sqttqEiirWeAAfiZM= Received: from mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-611-IirAydaaOlGCpur3_4QbFA-1; Fri, 30 Aug 2024 15:52:15 -0400 X-MC-Unique: IirAydaaOlGCpur3_4QbFA-1 Received: from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.17]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 749641955BF2 for ; Fri, 30 Aug 2024 19:52:14 +0000 (UTC) Received: from oldenburg.str.redhat.com (unknown [10.2.16.7]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 46D5E1955F44 for ; Fri, 30 Aug 2024 19:52:13 +0000 (UTC) From: Florian Weimer To: libc-alpha@sourceware.org Subject: [PATCH v4 02/13] support: Add In-Reply-To: Message-ID: <873f5e4f2eecf46cda17c9b2d01a19cd5eec7386.1725047142.git.fweimer@redhat.com> References: X-From-Line: 873f5e4f2eecf46cda17c9b2d01a19cd5eec7386 Mon Sep 17 00:00:00 2001 Date: Fri, 30 Aug 2024 21:52:10 +0200 User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-10.8 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_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: libc-alpha@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libc-alpha-bounces~patchwork=sourceware.org@sourceware.org Use static functions for readdir/readdir_r, so that -D_FILE_OFFSET_BITS=64 does not improperly redirect calls to the wrong implementation. Reviewed-by: DJ Delorie --- support/Makefile | 6 +++ support/support_readdir_check.c | 29 +++++++++++++ support/support_readdir_r_check.c | 29 +++++++++++++ support/tst-xdirent.c | 70 +++++++++++++++++++++++++++++++ support/xclosedir.c | 28 +++++++++++++ support/xdirent.h | 53 +++++++++++++++++++++++ support/xfdopendir.c | 30 +++++++++++++ support/xopendir.c | 30 +++++++++++++ 8 files changed, 275 insertions(+) create mode 100644 support/support_readdir_check.c create mode 100644 support/support_readdir_r_check.c create mode 100644 support/tst-xdirent.c create mode 100644 support/xclosedir.c create mode 100644 support/xdirent.h create mode 100644 support/xfdopendir.c create mode 100644 support/xopendir.c diff --git a/support/Makefile b/support/Makefile index 6e3c55394f..ce194bfdd4 100644 --- a/support/Makefile +++ b/support/Makefile @@ -73,6 +73,8 @@ libsupport-routines = \ support_quote_blob \ support_quote_blob_wide \ support_quote_string \ + support_readdir_check \ + support_readdir_r_check \ support_record_failure \ support_run_diff \ support_select_modifies_timeout \ @@ -115,6 +117,7 @@ libsupport-routines = \ xclock_settime_time64 \ xclone \ xclose \ + xclosedir \ xconnect \ xcopy_file_range \ xdlfcn \ @@ -122,6 +125,7 @@ libsupport-routines = \ xdup2 \ xfchmod \ xfclose \ + xfdopendir \ xfgets \ xfopen \ xfork \ @@ -143,6 +147,7 @@ libsupport-routines = \ xmunmap \ xnewlocale \ xopen \ + xopendir \ xpipe \ xpoll \ xposix_memalign \ @@ -327,6 +332,7 @@ tests = \ tst-test_compare_string \ tst-test_compare_string_wide \ tst-timespec \ + tst-xdirent \ tst-xreadlink \ tst-xsigstack \ # tests diff --git a/support/support_readdir_check.c b/support/support_readdir_check.c new file mode 100644 index 0000000000..8d48a4c5a4 --- /dev/null +++ b/support/support_readdir_check.c @@ -0,0 +1,29 @@ +/* Error-checking helper for xreaddir, xreaddir64. + Copyright (C) 2024 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 + +void * +support_readdir_check (const char *name, void *result) +{ + if (result == NULL && errno != 0) + FAIL_EXIT1 ("%s: %m", name); + return result; +} diff --git a/support/support_readdir_r_check.c b/support/support_readdir_r_check.c new file mode 100644 index 0000000000..8675b08ff3 --- /dev/null +++ b/support/support_readdir_r_check.c @@ -0,0 +1,29 @@ +/* Error-checking helper for xreaddir_r, xreaddir64_r. + Copyright (C) 2024 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 + +int +support_readdir_r_check (const char *name, int result) +{ + if (result != 0) + FAIL_EXIT1 ("%s: %m", name); + return result; +} diff --git a/support/tst-xdirent.c b/support/tst-xdirent.c new file mode 100644 index 0000000000..7012b3185b --- /dev/null +++ b/support/tst-xdirent.c @@ -0,0 +1,70 @@ +/* Compile test for error-checking wrappers for + Copyright (C) 2024 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 + +static int +do_test (void) +{ + { + DIR *d = xopendir ("."); + struct dirent *e = xreaddir (d); + /* Assume that the "." special entry always comes first. */ + TEST_COMPARE_STRING (e->d_name, "."); + xclosedir (d); + } + + { + DIR *d = xopendir ("."); + struct dirent64 *e = xreaddir64 (d); + TEST_COMPARE_STRING (e->d_name, "."); + xclosedir (d); + } + + /* The functions readdir_r, readdir64_r were deprecated in glibc 2.24. */ + DIAG_PUSH_NEEDS_COMMENT; + DIAG_IGNORE_NEEDS_COMMENT (4.9, "-Wdeprecated-declarations"); + + { + DIR *d = xopendir ("."); + struct dirent buf; + struct dirent *e; + TEST_COMPARE (xreaddir_r (d, &buf, &e), 0); + TEST_COMPARE_STRING (e->d_name, "."); + xclosedir (d); + } + + { + DIR *d = xopendir ("."); + struct dirent64 buf; + struct dirent64 *e; + TEST_COMPARE (xreaddir64_r (d, &buf, &e), 0); + TEST_COMPARE_STRING (e->d_name, "."); + xclosedir (d); + } + + DIAG_POP_NEEDS_COMMENT; + + return 0; +} + +#include diff --git a/support/xclosedir.c b/support/xclosedir.c new file mode 100644 index 0000000000..b490df5598 --- /dev/null +++ b/support/xclosedir.c @@ -0,0 +1,28 @@ +/* Error-checking wrapper for closedir. + Copyright (C) 2024 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 + +void +xclosedir (DIR *dir) +{ + if (closedir (dir) != 0) + FAIL_EXIT1 ("closedir: %m"); +} diff --git a/support/xdirent.h b/support/xdirent.h new file mode 100644 index 0000000000..83f41dba6b --- /dev/null +++ b/support/xdirent.h @@ -0,0 +1,53 @@ +/* Error-checking wrappers for + Copyright (C) 2024 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 + . */ + +#ifndef SUPPORT_XDIRENT_H +#define SUPPORT_XDIRENT_H + +#include +#include +#include + +__BEGIN_DECLS + +DIR *xopendir (const char *path); +DIR *xfdopendir (int fd); +void xclosedir (DIR *); + +void *support_readdir_check (const char *, void *); +#define xreaddir(d) \ + ((struct dirent *) support_readdir_check ("readdir", \ + (errno = 0, readdir ((d))))) +#define xreaddir64(d) \ + ((struct dirent64 *) support_readdir_check ("readdir64", \ + (errno = 0, readdir64 ((d))))) + +int support_readdir_r_check (const char *, int); + +/* The functions readdir_r, readdir64_r were deprecated in glibc 2.24. */ +DIAG_PUSH_NEEDS_COMMENT; +DIAG_IGNORE_NEEDS_COMMENT (4.9, "-Wdeprecated-declarations"); +#define xreaddir_r(d, e, r) \ + (support_readdir_r_check ("readdir_r", readdir_r ((d), (e), (r)))) +#define xreaddir64_r(d, e, r) \ + (support_readdir_r_check ("readdir64_r", readdir64_r ((d), (e), (r)))) +DIAG_POP_NEEDS_COMMENT; + +__END_DECLS + +#endif /* SUPPORT_XDIRENT_H */ diff --git a/support/xfdopendir.c b/support/xfdopendir.c new file mode 100644 index 0000000000..d881d28c73 --- /dev/null +++ b/support/xfdopendir.c @@ -0,0 +1,30 @@ +/* Error-checking wrapper for fdopendir. + Copyright (C) 2024 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 + +DIR * +xfdopendir (int fd) +{ + DIR *result = fdopendir (fd); + if (result == NULL) + FAIL_EXIT1 ("fdopendir (%d): %m", fd); + return result; +} diff --git a/support/xopendir.c b/support/xopendir.c new file mode 100644 index 0000000000..e4aee07fee --- /dev/null +++ b/support/xopendir.c @@ -0,0 +1,30 @@ +/* Error-checking wrapper for opendir. + Copyright (C) 2024 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 + +DIR * +xopendir (const char *path) +{ + DIR *result = opendir (path); + if (result == NULL) + FAIL_EXIT1 ("opendir (\"%s\"): %m", path); + return result; +}