From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-0.5 required=3.0 tests=BAYES_00,DKIM_ADSP_CUSTOM_MED, DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5F311C433F5 for ; Wed, 22 Sep 2021 07:24:14 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id E3F7361178 for ; Wed, 22 Sep 2021 07:24:13 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org E3F7361178 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=kvack.org Received: by kanga.kvack.org (Postfix) id 4CA2B6B006C; Wed, 22 Sep 2021 03:24:13 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 479556B0072; Wed, 22 Sep 2021 03:24:13 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 341CD6B0073; Wed, 22 Sep 2021 03:24:13 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0038.hostedemail.com [216.40.44.38]) by kanga.kvack.org (Postfix) with ESMTP id 245A86B006C for ; Wed, 22 Sep 2021 03:24:13 -0400 (EDT) Received: from smtpin16.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay05.hostedemail.com (Postfix) with ESMTP id D33BE181A8DD8 for ; Wed, 22 Sep 2021 07:24:12 +0000 (UTC) X-FDA: 78614370744.16.CE0E5BC Received: from mail-wr1-f54.google.com (mail-wr1-f54.google.com [209.85.221.54]) by imf14.hostedemail.com (Postfix) with ESMTP id 8D3C86001981 for ; Wed, 22 Sep 2021 07:24:12 +0000 (UTC) Received: by mail-wr1-f54.google.com with SMTP id u18so3903837wrg.5 for ; Wed, 22 Sep 2021 00:24:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:content-transfer-encoding:in-reply-to; bh=ULwoOoLedOT4q7QVhiTfuMRJL+g42ZvtZLso5l9rgRY=; b=mUlp7aX+AbdUf8t/iQV/vo+r+mLJL7e/qWLY5UNFxABQv07ML9RXYBeZJycroCNdrR nYqG8tfJNFkuYOKW7WlHBnUezqqFkQm6K2/RL7B5j6WkSLS2dd9haJUPR7b68uFYvD7l cf6CwkVU6sbzGdkiCGVfWCxXT+7Y7vrvJn2egaqCe8EZh/dIzwW49U7MAhoDlLDyFEa9 /Ei39y5F+UyjybB7Q9cpWd2Q6+0d9cb91L8CA8CmHMZjy9/vqoaBmYtJC/p07wHjP9YF RYRsfAr2TTDhFqYCSbgbhUy4e7sfreV6a3CbA8FMQAjssbh8X1sBd2QpADRdQJk6wxdf kdsQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:content-transfer-encoding :in-reply-to; bh=ULwoOoLedOT4q7QVhiTfuMRJL+g42ZvtZLso5l9rgRY=; b=I2pm/sBp9o5vPP1MiMVQAa0gthMhb+lNB8RPdlSxZX2ehb+bYqV+TZKtYcLHv353aU orkr2mf/Rwp7uBvwFA88lDscqqKexS3vPK+sBoKLKo0MmgUl1szR3t59YvxuF1L6k6TP WICBZb9QP1rFkbXSkcsT6OylSAw428lGbQNR23UMhTO+gjQPnjhfO4Tz6llBRG87rWin Zut7OZgv7IDfSkUhG4tkVV4cqyAHmoshCASjgKopcwJIULJrjhn5BKUyHnYxkXSvsi7q 7emB7zSLl0UJvV61ZQBAdA8V2NznwSqNRPK7dUz1BpEnuqUYXxJpomgJPfNYYyZD104G BQwA== X-Gm-Message-State: AOAM5327pWZejdiGb1J4jrA7eqYi/vynFJC+qKRbApmAbvGUqTbs+fj0 /B019GMOlhMgYGRy2mEYxA== X-Google-Smtp-Source: ABdhPJy7HsSVUaQeuyvJ6ZcmsmbeD912UQv/jB8HzcSjxN589QnfzOcYK9boFdHVuTUAqmqTwGDiZw== X-Received: by 2002:adf:a745:: with SMTP id e5mr28910852wrd.406.1632295451096; Wed, 22 Sep 2021 00:24:11 -0700 (PDT) Received: from localhost.localdomain ([46.53.252.100]) by smtp.gmail.com with ESMTPSA id s10sm1309856wrg.42.2021.09.22.00.24.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Sep 2021 00:24:10 -0700 (PDT) Date: Wed, 22 Sep 2021 10:24:08 +0300 From: Alexey Dobriyan To: linux-kernel@vger.kernel.org Cc: Linus Torvalds , Joe Perches , Andrew Morton , apw@canonical.com, Christoph Lameter , Daniel Micay , Dennis Zhou , dwaipayanray1@gmail.com, Joonsoo Kim , Linux-MM , Lukas Bulwahn , mm-commits@vger.kernel.org, Nathan Chancellor , Nick Desaulniers , Miguel Ojeda , Pekka Enberg , David Rientjes , Tejun Heo , Vlastimil Babka , linux-doc@vger.kernel.org Subject: Re: function prototype element ordering Message-ID: References: <20210909200948.090d4e213ca34b5ad1325a7e@linux-foundation.org> <20210910031046.G76dQvPhV%akpm@linux-foundation.org> <202109211630.2D00627@keescook> <202109211757.F38DF644@keescook> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: <202109211757.F38DF644@keescook> X-Rspamd-Server: rspam05 X-Rspamd-Queue-Id: 8D3C86001981 X-Stat-Signature: ni8wuczbnduxniex1f4e8bafojch53gq Authentication-Results: imf14.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=mUlp7aX+; spf=pass (imf14.hostedemail.com: domain of adobriyan@gmail.com designates 209.85.221.54 as permitted sender) smtp.mailfrom=adobriyan@gmail.com; dmarc=pass (policy=none) header.from=gmail.com X-HE-Tag: 1632295452-526104 Content-Transfer-Encoding: quoted-printable X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: On Tue, Sep 21, 2021 at 07:25:53PM -0700, Kees Cook wrote: > On Tue, Sep 21, 2021 at 04:45:44PM -0700, Joe Perches wrote: > > On Tue, 2021-09-21 at 16:37 -0700, Kees Cook wrote: > > > On Fri, Sep 10, 2021 at 10:23:48AM -0700, Linus Torvalds wrote: > > > > On Thu, Sep 9, 2021 at 8:10 PM Andrew Morton wrote: > > > > >=20 > > > > > +__alloc_size(1) > > > > > =C2=A0extern void *vmalloc(unsigned long size); > > > > [...] > > > >=20 > > > > All of these are added in the wrong place - inconsistent with the= very > > > > compiler documentation the patches add. > > > >=20 > > > > The function attributes are generally added _after_ the function, > > > > although admittedly we've been quite confused here before. > > > >=20 > > > > But the very compiler documentation you point to in the patch tha= t > > > > adds these macros gives that as the examples both for gcc and cla= ng: > > > >=20 > > > > + * gcc: https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Att= ributes.html#index-alloc_005fsize-function-attribute > > > > + * clang: https://clang.llvm.org/docs/AttributeReference.html#al= loc-size > > > >=20 > > > > and honestly I think that is the preferred format because this is > > > > about the *function*, not about the return type. > > > >=20 > > > > Do both placements work? Yes. > > >=20 > > > I'm cleaning this up now, and have discovered that the reason for t= he > > > before-function placement is consistency with static inlines. If I = do this: > > >=20 > > > static __always_inline void * kmalloc(size_t size, gfp_t flags) __a= lloc_size(1) > > > { > > > ... > > > } > > >=20 > > > GCC is very angry: > > >=20 > > > ./include/linux/slab.h:519:1: error: attributes should be specified= before the declarator in a function definition > > > =C2=A0=C2=A0519 | static __always_inline void *kmalloc_large(size_t= size, gfp_t flags) __alloc_size(1) > > > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0| ^~~~~~ > > >=20 > > > It's happy if I treat it as a "return type attribute" in the orderi= ng, > > > though: > > >=20 > > > static __always_inline void * __alloc_size(1) kmalloc(size_t size, = gfp_t flags) > > >=20 > > > I'll do that unless you have a preference for somewhere else... > >=20 > > _please_ put it before the return type on a separate line. > >=20 > > [__attributes] > > [static inline const] function() >=20 > Somehow Linus wasn't in CC. :P >=20 > Linus, what do you want here? I keep getting conflicting (or > uncompilable) advice. I'm also trying to prepare a patch for > Documentation/process/coding-style.rst ... >=20 > Looking through what was written before[1] and through examples in the > source tree, I find the following categories: >=20 > 1- storage class: static extern inline __always_inline > 2- storage class attributes/hints/???: __init __cold > 3- return type: void * > 4- return type attributes: __must_check __noreturn __assume_aligned(n) > 5- function attributes: __attribute_const__ __malloc > 6- function argument attributes: __printf(n, m) __alloc_size(n) >=20 > Everyone seems to basically agree on: >=20 > [storage class] [return type] [return type attributes] [name]([arg1type= ] [arg1name], ...) >=20 > There is a lot of disagreement over where 5 and 6 should fit in above. = And > there is a lot of confusion over 4 (mixed between before and after the > function name) and 2 (see below). >=20 > What's currently blocking me is that 6 cannot go after the function > (for definitions) because it angers GCC (see quoted bit above), but 5 > can (e.g. __attribute_const__). >=20 > Another inconsistency seems to be 2 (mainly section markings like > __init). Sometimes it's after the storage class and sometimes after the > return type, but it certainly feels more like a storage class than a > return type attribute: >=20 > $ git grep 'static __init int' | wc -l > 349 > $ git grep 'static int __init' | wc -l > 8402 >=20 > But it's clearly positioned like a return type attribute in most of the > tree. What's correct? >=20 > Regardless, given the constraints above, it seems like what Linus may > want is (on "one line", though it will get wrapped in pathological case= s > like kmem_cache_alloc_node_trace): >=20 > [storage class] [storage class attributes] [return type] [return type a= ttributes] [function argument attributes] [name]([arg1type] [arg1name], .= ..) [function attributes] >=20 > Joe appears to want (on two lines): >=20 > [storage class attributes] [function attributes] [function argument att= ributes] > [storage class] [return type] [return type attributes] [name]([arg1type= ] [arg1name], ...) >=20 > I would just like to have an arrangement that won't get NAKed by > someone. ;) And I'm willing to document it. :) Attributes should be on their own line, they can be quite lengthy. __attribute__((...)) [static] [inline] T f(A1 arg1, ...) { ... } There will be even more attributes in the future, both added by compilers and developers (const, pure, WUR), so let's make "prototype lan= e" for them. Same for structures: __attribute__((packed)) struct S { }; Kernel practice of hiding attributes under defines (__ro_after_init) breaks ctags which parses the last identifier before semicolon as object name. Naturally, it is ctags bug, but placing attributes before declaration will autmatically unbreak such cases.