From patchwork Wed Mar 22 21:38:12 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: DJ Delorie X-Patchwork-Id: 66775 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 6E86C385802F for ; Wed, 22 Mar 2023 21:38:44 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 6E86C385802F DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1679521124; bh=gO/1xLrY+YkGkuLO4oQ1mQdzmEqoAwd23r1ZW9Gnjs4=; h=Date:To:Subject:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=nKDFaE+aXal/Z1X5bfH/IHvipwbuzs4tdLlrzoBScYa/Bb64sDsB07Ph/AiVzXsql 9VUl1TMsnOcuO5LzbDIzuqSqWLbrlTn/n9HMnzmC8cIMq2B7Dci/LNUuVMWicGcp6O 8a5kGsrr0CWhQhXMC9tCyVPjSVQSqY53A3E86KM8= 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 821423858436 for ; Wed, 22 Mar 2023 21:38:14 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 821423858436 Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-518-b4XvLNaAN_CCnLUx8zYzpA-1; Wed, 22 Mar 2023 17:38:13 -0400 X-MC-Unique: b4XvLNaAN_CCnLUx8zYzpA-1 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id DC150380611A for ; Wed, 22 Mar 2023 21:38:12 +0000 (UTC) Received: from greed.delorie.com (unknown [10.22.8.104]) by smtp.corp.redhat.com (Postfix) with ESMTPS id C77711121314 for ; Wed, 22 Mar 2023 21:38:12 +0000 (UTC) Received: from greed.delorie.com.redhat.com (localhost [127.0.0.1]) by greed.delorie.com (8.15.2/8.15.2) with ESMTP id 32MLcCSk3888597 for ; Wed, 22 Mar 2023 17:38:12 -0400 Date: Wed, 22 Mar 2023 17:38:12 -0400 Message-Id: To: libc-alpha@sourceware.org Subject: [patch v4] aligned_alloc: conform to C17 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.3 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-10.5 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_NUMSUBJECT, KAM_SHORT, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_NONE, TXREP 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.29 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: DJ Delorie via Libc-alpha From: DJ Delorie Reply-To: DJ Delorie Errors-To: libc-alpha-bounces+patchwork=sourceware.org@sourceware.org Sender: "Libc-alpha" Changes from V3: * Simplified aligned_alloc symbol definition. References: https://patchwork.sourceware.org/project/glibc/patch/33ec9e0c1e587813b90e8aa771c2c8e6e379dd48.camel@posteo.net/ https://sourceware.org/bugzilla/show_bug.cgi?id=20137 https://sourceware.org/pipermail/libc-alpha/2023-February/145858.html The memory.texi portion matches Martin's proposed patch. man page portion, quoted to avoid CI/CD issues (I can send an official patch separately after the glibc patch is applied): > diff --git a/man3/posix_memalign.3 b/man3/posix_memalign.3 > index f5d6618b7..a73ff0421 100644 > --- a/man3/posix_memalign.3 > +++ b/man3/posix_memalign.3 > @@ -91,9 +91,8 @@ The function > is the same as > .BR memalign (), > except for the added restriction that > -.I size > -should be a multiple of > -.IR alignment . > +.I alignment > +must be a power of two. > .PP > The obsolete function > .BR valloc () From 9cc7d558d9c06edb95102151212b319f21acf603 Mon Sep 17 00:00:00 2001 From: DJ Delorie Date: Tue, 21 Mar 2023 00:46:43 -0400 Subject: aligned_alloc: conform to C17 This patch adds the strict checking for power-of-two alignments in aligned_alloc(), and updates the manual accordingly. diff --git a/malloc/Makefile b/malloc/Makefile index dfb51d344c..691714fb52 100644 --- a/malloc/Makefile +++ b/malloc/Makefile @@ -43,10 +43,12 @@ tests := mallocbug tst-malloc tst-valloc tst-calloc tst-obstack \ tst-tcfree1 tst-tcfree2 tst-tcfree3 \ tst-safe-linking \ tst-mallocalign1 \ + tst-aligned-alloc \ tests-static := \ tst-interpose-static-nothread \ - tst-interpose-static-thread + tst-interpose-static-thread \ + tst-aligned-alloc-static # Test for the malloc_set_state symbol removed in glibc 2.25. ifeq ($(have-GLIBC_2.23)$(build-shared),yesyes) diff --git a/malloc/malloc-debug.c b/malloc/malloc-debug.c index 3867d15698..da9d2340d3 100644 --- a/malloc/malloc-debug.c +++ b/malloc/malloc-debug.c @@ -299,7 +299,14 @@ __debug_memalign (size_t alignment, size_t bytes) return _debug_mid_memalign (alignment, bytes, RETURN_ADDRESS (0)); } strong_alias (__debug_memalign, memalign) -strong_alias (__debug_memalign, aligned_alloc) +static void * +__debug_aligned_alloc (size_t alignment, size_t bytes) +{ + if (!powerof2 (alignment) || alignment == 0) + return NULL; + return _debug_mid_memalign (alignment, bytes, RETURN_ADDRESS (0)); +} +strong_alias (__debug_aligned_alloc, aligned_alloc) static void * __debug_pvalloc (size_t bytes) diff --git a/malloc/malloc.c b/malloc/malloc.c index 76c50e3f58..ece5b8a224 100644 --- a/malloc/malloc.c +++ b/malloc/malloc.c @@ -3509,6 +3509,27 @@ __libc_memalign (size_t alignment, size_t bytes) void *address = RETURN_ADDRESS (0); return _mid_memalign (alignment, bytes, address); } +libc_hidden_def (__libc_memalign) + +/* For ISO C11. */ +void * +weak_function +aligned_alloc (size_t alignment, size_t bytes) +{ + if (!__malloc_initialized) + ptmalloc_init (); + + /* Similar to memalign, but ISO C17 requires an error for invalid + alignments. Valid alignments are non-negative powers of two. */ + if (!powerof2 (alignment) || alignment == 0) + { + __set_errno (EINVAL); + return 0; + } + + void *address = RETURN_ADDRESS (0); + return _mid_memalign (alignment, bytes, address); +} static void * _mid_memalign (size_t alignment, size_t bytes, void *address) @@ -3567,9 +3588,6 @@ _mid_memalign (size_t alignment, size_t bytes, void *address) ar_ptr == arena_for_chunk (mem2chunk (p))); return tag_new_usable (p); } -/* For ISO C11. */ -weak_alias (__libc_memalign, aligned_alloc) -libc_hidden_def (__libc_memalign) void * __libc_valloc (size_t bytes) diff --git a/malloc/tst-aligned-alloc-static.c b/malloc/tst-aligned-alloc-static.c new file mode 100644 index 0000000000..d504473094 --- /dev/null +++ b/malloc/tst-aligned-alloc-static.c @@ -0,0 +1 @@ +#include "tst-aligned-alloc.c" diff --git a/malloc/tst-aligned-alloc.c b/malloc/tst-aligned-alloc.c new file mode 100644 index 0000000000..d6739376d4 --- /dev/null +++ b/malloc/tst-aligned-alloc.c @@ -0,0 +1,56 @@ +/* Copyright (C) 2023 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 +#include +#include +#include + +static int +do_test (void) +{ + void *p1; + void *p2; + void *p3; + + errno = 0; + + p1 = aligned_alloc (64, 64); + + if (p1 == NULL) + FAIL_EXIT1 ("aligned_alloc(64, 64) failed"); + + p2 = aligned_alloc (65, 64); + + if (p2 != NULL) + FAIL_EXIT1 ("aligned_alloc(65, 64) did not fail"); + + p3 = aligned_alloc (0, 64); + + if (p3 != NULL) + FAIL_EXIT1 ("aligned_alloc(0, 64) did not fail"); + + free (p1); + return 0; +} + +#define TEST_FUNCTION do_test () +#include "../test-skeleton.c" diff --git a/manual/memory.texi b/manual/memory.texi index 9d3398a326..8952ff2bfa 100644 --- a/manual/memory.texi +++ b/manual/memory.texi @@ -995,7 +995,7 @@ power of two than that, use @code{aligned_alloc} or @code{posix_memalign}. @c Alias to memalign. The @code{aligned_alloc} function allocates a block of @var{size} bytes whose address is a multiple of @var{alignment}. The @var{alignment} must be a -power of two and @var{size} must be a multiple of @var{alignment}. +power of two. The @code{aligned_alloc} function returns a null pointer on error and sets @code{errno} to one of the following values: