From: Joseph Richey <joerichey94@gmail.com> To: Mark Rutland <mark.rutland@arm.com> Cc: trivial@kernel.org, Joe Richey <joerichey@google.com>, Thomas Gleixner <tglx@linutronix.de>, Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>, x86@kernel.org, "H. Peter Anvin" <hpa@zytor.com>, Paolo Bonzini <pbonzini@redhat.com>, Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>, Mauro Carvalho Chehab <mchehab@kernel.org>, Zhangfei Gao <zhangfei.gao@linaro.org>, Zhou Wang <wangzhou1@hisilicon.com>, linux-kernel@vger.kernel.org, kvm@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-media@vger.kernel.org, linux-accelerators@lists.ozlabs.org Subject: Re: [PATCH 0/6] Don't use BIT() macro in UAPI headers Date: Thu, 20 May 2021 04:40:23 -0700 [thread overview] Message-ID: <CAAXkRofTpf7R31V8vQOghkzWL+Ofqu0eCNV-WOmpm8pmpTvtLg@mail.gmail.com> (raw) In-Reply-To: <20210520111119.GC17233@C02TD0UTHF1T.local> On Thu, May 20, 2021 at 4:11 AM Mark Rutland <mark.rutland@arm.com> wrote: > > Hi, > > On Thu, May 20, 2021 at 03:43:37AM -0700, Joe Richey wrote: > > From: Joe Richey <joerichey@google.com> > > > > The BIT(n) macro is used in the kernel as an alias for (1 << n). > > However, it is not defined in the UAPI headers, which means that any > > UAPI header files must be careful not to use it, or else the user > > will get a linker error. > > Beware that the common definition of BIT() (in include/vdso/bits.h) is: > > | #define BIT(nr) (UL(1) << (nr)) > > That UL() can be important if `nr` is ever greater than bits per int. > > > For example, compiling the following program: > > > > #include <sys/auxv.h> > > #include <asm/hwcap2.h> > > > > // Detect if FSGSBASE instructions are enabled > > int main() { > > unsigned long val = getauxval(AT_HWCAP2); > > return !(val & HWCAP2_FSGSBASE); > > } > > > > Results in the following likner error: > > > > /usr/bin/ld: /tmp/cceFpAdR.o: in function `main': > > gs.c:(.text+0x21): undefined reference to `BIT' > > > > This patch series changes all UAPI uses of BIT() to just be open-coded. > > In include/uapi/linux/const.h we have an equivaleint _BITUL() macro, > which I think should be used in preference of open-coding this (and is > already used in a number of uapi headers). That's a good idea. I mostly just did the open-coding for consistency with the surrounding code, but aside from kvm.h there aren't really many usages to change, so I can do it. For kvm.h, I think it might be best to leave it open-coded and move the entire file to _BITUL() at once. > > > However, there really should be a check for this in checkpatch.pl > > Currently, the script actually _encourages_ users to use the BIT macro > > even if adding things to UAPI. > > I think having something that suggests s/BIT()/_BITUL()/ under uapi > would be good. I'll just change the script to recommend _BITUL() (instead of BIT()) if the code path contains "uapi". > > Thanks, > Mark. > > > > > Running `rg "BIT\(" **/uapi/**` shows no more usage of BIT() in any > > UAPI headers. Tested by building a basic kernel. Changes are trivial. > > > > Joe Richey (6): > > x86/elf: Don't use BIT() macro in UAPI headers > > KVM: X86: Don't use BIT() macro in UAPI headers > > drivers: firmware: psci: Don't use BIT() macro in UAPI headers > > uacce: Don't use BIT() macro in UAPI headers > > media: vicodec: Don't use BIT() macro in UAPI headers > > tools headers UAPI: Sync pkt_sched.h with the kernel sources > > > > arch/x86/include/uapi/asm/hwcap2.h | 2 +- > > include/uapi/linux/kvm.h | 4 +- > > include/uapi/linux/psci.h | 2 +- > > include/uapi/linux/v4l2-controls.h | 22 ++--- > > include/uapi/misc/uacce/uacce.h | 2 +- > > tools/include/uapi/linux/kvm.h | 4 +- > > tools/include/uapi/linux/pkt_sched.h | 122 ++++++++++++++++++++++++--- > > 7 files changed, 130 insertions(+), 28 deletions(-) > > > > -- > > 2.31.1 > >
WARNING: multiple messages have this Message-ID (diff)
From: Joseph Richey <joerichey94@gmail.com> To: Mark Rutland <mark.rutland@arm.com> Cc: trivial@kernel.org, Joe Richey <joerichey@google.com>, Thomas Gleixner <tglx@linutronix.de>, Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>, x86@kernel.org, "H. Peter Anvin" <hpa@zytor.com>, Paolo Bonzini <pbonzini@redhat.com>, Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>, Mauro Carvalho Chehab <mchehab@kernel.org>, Zhangfei Gao <zhangfei.gao@linaro.org>, Zhou Wang <wangzhou1@hisilicon.com>, linux-kernel@vger.kernel.org, kvm@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-media@vger.kernel.org, linux-accelerators@lists.ozlabs.org Subject: Re: [PATCH 0/6] Don't use BIT() macro in UAPI headers Date: Thu, 20 May 2021 04:40:23 -0700 [thread overview] Message-ID: <CAAXkRofTpf7R31V8vQOghkzWL+Ofqu0eCNV-WOmpm8pmpTvtLg@mail.gmail.com> (raw) In-Reply-To: <20210520111119.GC17233@C02TD0UTHF1T.local> On Thu, May 20, 2021 at 4:11 AM Mark Rutland <mark.rutland@arm.com> wrote: > > Hi, > > On Thu, May 20, 2021 at 03:43:37AM -0700, Joe Richey wrote: > > From: Joe Richey <joerichey@google.com> > > > > The BIT(n) macro is used in the kernel as an alias for (1 << n). > > However, it is not defined in the UAPI headers, which means that any > > UAPI header files must be careful not to use it, or else the user > > will get a linker error. > > Beware that the common definition of BIT() (in include/vdso/bits.h) is: > > | #define BIT(nr) (UL(1) << (nr)) > > That UL() can be important if `nr` is ever greater than bits per int. > > > For example, compiling the following program: > > > > #include <sys/auxv.h> > > #include <asm/hwcap2.h> > > > > // Detect if FSGSBASE instructions are enabled > > int main() { > > unsigned long val = getauxval(AT_HWCAP2); > > return !(val & HWCAP2_FSGSBASE); > > } > > > > Results in the following likner error: > > > > /usr/bin/ld: /tmp/cceFpAdR.o: in function `main': > > gs.c:(.text+0x21): undefined reference to `BIT' > > > > This patch series changes all UAPI uses of BIT() to just be open-coded. > > In include/uapi/linux/const.h we have an equivaleint _BITUL() macro, > which I think should be used in preference of open-coding this (and is > already used in a number of uapi headers). That's a good idea. I mostly just did the open-coding for consistency with the surrounding code, but aside from kvm.h there aren't really many usages to change, so I can do it. For kvm.h, I think it might be best to leave it open-coded and move the entire file to _BITUL() at once. > > > However, there really should be a check for this in checkpatch.pl > > Currently, the script actually _encourages_ users to use the BIT macro > > even if adding things to UAPI. > > I think having something that suggests s/BIT()/_BITUL()/ under uapi > would be good. I'll just change the script to recommend _BITUL() (instead of BIT()) if the code path contains "uapi". > > Thanks, > Mark. > > > > > Running `rg "BIT\(" **/uapi/**` shows no more usage of BIT() in any > > UAPI headers. Tested by building a basic kernel. Changes are trivial. > > > > Joe Richey (6): > > x86/elf: Don't use BIT() macro in UAPI headers > > KVM: X86: Don't use BIT() macro in UAPI headers > > drivers: firmware: psci: Don't use BIT() macro in UAPI headers > > uacce: Don't use BIT() macro in UAPI headers > > media: vicodec: Don't use BIT() macro in UAPI headers > > tools headers UAPI: Sync pkt_sched.h with the kernel sources > > > > arch/x86/include/uapi/asm/hwcap2.h | 2 +- > > include/uapi/linux/kvm.h | 4 +- > > include/uapi/linux/psci.h | 2 +- > > include/uapi/linux/v4l2-controls.h | 22 ++--- > > include/uapi/misc/uacce/uacce.h | 2 +- > > tools/include/uapi/linux/kvm.h | 4 +- > > tools/include/uapi/linux/pkt_sched.h | 122 ++++++++++++++++++++++++--- > > 7 files changed, 130 insertions(+), 28 deletions(-) > > > > -- > > 2.31.1 > > _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2021-05-20 12:33 UTC|newest] Thread overview: 63+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-05-20 10:43 [PATCH 0/6] Don't use BIT() macro in UAPI headers Joe Richey 2021-05-20 10:43 ` Joe Richey 2021-05-20 10:43 ` [PATCH 1/6] x86/elf: " Joe Richey 2021-05-20 10:43 ` Joe Richey 2021-05-20 10:43 ` [PATCH 2/6] KVM: X86: " Joe Richey 2021-05-20 10:43 ` Joe Richey 2021-05-20 15:46 ` Sean Christopherson 2021-05-20 15:46 ` Sean Christopherson 2021-05-20 10:43 ` [PATCH 3/6] drivers: firmware: psci: " Joe Richey 2021-05-20 10:43 ` Joe Richey 2021-05-20 10:43 ` [PATCH 4/6] uacce: " Joe Richey 2021-05-20 10:43 ` Joe Richey 2021-05-20 10:43 ` [PATCH 5/6] media: vicodec: " Joe Richey 2021-05-20 10:43 ` Joe Richey 2021-05-20 10:43 ` [PATCH 6/6] tools headers UAPI: Sync pkt_sched.h with the kernel sources Joe Richey 2021-05-20 10:43 ` Joe Richey 2021-05-20 11:07 ` [PATCH 0/6] Don't use BIT() macro in UAPI headers Borislav Petkov 2021-05-20 11:07 ` Borislav Petkov 2021-05-20 11:50 ` Joseph Richey 2021-05-20 11:50 ` Joseph Richey 2021-05-20 15:59 ` Borislav Petkov 2021-05-20 15:59 ` Borislav Petkov 2021-05-20 15:50 ` Sean Christopherson 2021-05-20 15:50 ` Sean Christopherson 2021-05-20 11:11 ` Mark Rutland 2021-05-20 11:11 ` Mark Rutland 2021-05-20 11:40 ` Joseph Richey [this message] 2021-05-20 11:40 ` Joseph Richey 2021-05-20 12:09 ` Paolo Bonzini 2021-05-20 12:09 ` Paolo Bonzini 2021-05-20 15:47 ` Sean Christopherson 2021-05-20 15:47 ` Sean Christopherson 2021-05-21 8:58 ` [PATCH v2 0/7] " Joe Richey 2021-05-21 8:58 ` Joe Richey 2021-05-21 8:58 ` [PATCH v2 1/7] x86/elf: Use _BITUL() " Joe Richey 2021-05-21 8:58 ` Joe Richey 2021-05-21 9:25 ` [tip: x86/misc] " tip-bot2 for Joe Richey 2021-05-21 8:58 ` [PATCH v2 2/7] KVM: X86: " Joe Richey 2021-05-21 8:58 ` Joe Richey 2021-05-24 12:28 ` Paolo Bonzini 2021-05-24 12:28 ` Paolo Bonzini 2021-05-21 8:58 ` [PATCH v2 3/7] drivers: firmware: psci: " Joe Richey 2021-05-21 8:58 ` Joe Richey 2021-05-21 13:25 ` Mark Rutland 2021-05-21 13:25 ` Mark Rutland 2021-05-21 8:58 ` [PATCH v2 4/7] uacce: " Joe Richey 2021-05-21 8:58 ` Joe Richey 2021-05-21 13:56 ` Zhangfei Gao 2021-05-21 13:56 ` Zhangfei Gao 2021-05-21 8:58 ` [PATCH v2 5/7] media: vicodec: " Joe Richey 2021-05-21 8:58 ` Joe Richey 2021-05-21 8:58 ` [PATCH v2 6/7] tools headers UAPI: Sync pkt_sched.h with the kernel sources Joe Richey 2021-05-21 8:58 ` Joe Richey 2021-05-21 8:58 ` [PATCH v2 7/7] checkpatch: suggest _BITULL() and _BITUL() for UAPI headers Joe Richey 2021-05-21 8:58 ` Joe Richey 2021-05-21 14:45 ` Joe Perches 2021-05-21 14:45 ` Joe Perches 2021-05-24 11:46 ` [PATCH 0/6] Don't use BIT() macro in " Christoph Hellwig 2021-05-24 11:46 ` Christoph Hellwig 2021-05-24 12:29 ` Mark Rutland 2021-05-24 12:29 ` Mark Rutland 2021-05-24 16:34 ` David Laight 2021-05-24 16:34 ` David Laight
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=CAAXkRofTpf7R31V8vQOghkzWL+Ofqu0eCNV-WOmpm8pmpTvtLg@mail.gmail.com \ --to=joerichey94@gmail.com \ --cc=bp@alien8.de \ --cc=hpa@zytor.com \ --cc=joerichey@google.com \ --cc=kvm@vger.kernel.org \ --cc=linux-accelerators@lists.ozlabs.org \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-media@vger.kernel.org \ --cc=lorenzo.pieralisi@arm.com \ --cc=mark.rutland@arm.com \ --cc=mchehab@kernel.org \ --cc=mingo@redhat.com \ --cc=pbonzini@redhat.com \ --cc=tglx@linutronix.de \ --cc=trivial@kernel.org \ --cc=wangzhou1@hisilicon.com \ --cc=x86@kernel.org \ --cc=zhangfei.gao@linaro.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.