From: Borislav Petkov <bp@alien8.de>
To: Jiri Slaby <jslaby@suse.cz>
Cc: mingo@redhat.com, linux-arch@vger.kernel.org,
linux-kernel@vger.kernel.org,
Andrew Morton <akpm@linux-foundation.org>,
Boris Ostrovsky <boris.ostrovsky@oracle.com>,
hpa@zytor.com, Ingo Molnar <mingo@kernel.org>,
jpoimboe@redhat.com, Juergen Gross <jgross@suse.com>,
Len Brown <len.brown@intel.com>,
Linus Torvalds <torvalds@linux-foundation.org>,
linux-pm@vger.kernel.org, Pavel Machek <pavel@ucw.cz>,
Peter Zijlstra <a.p.zijlstra@chello.nl>,
"Rafael J. Wysocki" <rjw@rjwysocki.net>,
Thomas Gleixner <tglx@linutronix.de>,
xen-devel@lists.xenproject.org, x86@kernel.org
Subject: Re: [PATCH v7 01/28] linkage: new macros for assembler symbols
Date: Thu, 31 Jan 2019 17:00:19 +0100 [thread overview]
Message-ID: <20190131160019.GM6749@zn.tnic> (raw)
In-Reply-To: <20190130124711.12463-2-jslaby@suse.cz>
On Wed, Jan 30, 2019 at 01:46:44PM +0100, Jiri Slaby wrote:
> Introduce new C macros for annotations of functions and data in
> assembly. There is a long-standing mess in macros like ENTRY, END,
> ENDPROC and similar. They are used in different manners and sometimes
> incorrectly.
>
> So introduce macros with clear use to annotate assembly as follows:
...
> Signed-off-by: Jiri Slaby <jslaby@suse.cz>
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: Boris Ostrovsky <boris.ostrovsky@oracle.com>
> Cc: hpa@zytor.com
> Cc: Ingo Molnar <mingo@kernel.org>
> Cc: jpoimboe@redhat.com
> Cc: Juergen Gross <jgross@suse.com>
> Cc: Len Brown <len.brown@intel.com>
> Cc: Linus Torvalds <torvalds@linux-foundation.org>
> Cc: linux-kernel@vger.kernel.org
> Cc: linux-pm@vger.kernel.org
> Cc: mingo@redhat.com
> Cc: Pavel Machek <pavel@ucw.cz>
> Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
> Cc: "Rafael J. Wysocki" <rjw@rjwysocki.net>
> Cc: Thomas Gleixner <tglx@linutronix.de>
> Cc: xen-devel@lists.xenproject.org
> Cc: x86@kernel.org
> ---
> Documentation/asm-annotations.rst | 217 ++++++++++++++++++++++++++
I guess you wanna integrate that into the doc hierarchy. Hunk ontop:
---
diff --git a/Documentation/index.rst b/Documentation/index.rst
index c858c2e66e36..754055d9565c 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -91,6 +91,14 @@ needed).
vm/index
bpf/index
+Architecture-agnostic documentation
+-----------------------------------
+
+.. toctree::
+ :maxdepth: 2
+
+ asm-annotations
+
Architecture-specific documentation
-----------------------------------
> arch/x86/include/asm/linkage.h | 10 +-
> include/linux/linkage.h | 245 +++++++++++++++++++++++++++++-
> 3 files changed, 461 insertions(+), 11 deletions(-)
> create mode 100644 Documentation/asm-annotations.rst
>
> diff --git a/Documentation/asm-annotations.rst b/Documentation/asm-annotations.rst
> new file mode 100644
> index 000000000000..265d64a1fc0b
> --- /dev/null
> +++ b/Documentation/asm-annotations.rst
> @@ -0,0 +1,217 @@
> +Assembler Annotations
> +=====================
> +
> +Copyright (c) 2017 Jiri Slaby
> +
> +This document describes the new macros for annotation of data and code in
> +assembler. In particular, it contains information about ``SYM_FUNC_START``,
s/assembler/assembly/
> +``SYM_FUNC_END``, ``SYM_CODE_START``, and similar.
> +
> +Rationale
> +---------
> +Some code like entries, trampolines, or boot code needs to be written in
> +assembly. The same as in C, we group such code into functions and accompany
> +them with data. Standard assemblers do not force users into precisely marking
> +these pieces as code, data, or even specifying their length. Nevertheless,
> +assemblers provide developers with such marks to aid debuggers throughout
> +assembly. On the top of that, developers also want to stamp some functions as
> +*global* to be visible outside of their translation units.
> +
> +Over the time, the Linux kernel took over macros from various projects (like
s/the //
> +``binutils``) to ease these markings. So for historic reasons, we have been
> +using ``ENTRY``, ``END``, ``ENDPROC``, and other annotations in assembly. Due
> +to the lack of their documentation, the macros are used in rather wrong
> +contexts at some locations. Clearly, ``ENTRY`` was intended for starts of
> +global symbols (be it data or code). ``END`` used to be the end of data or end
> +of special functions with *non-standard* calling convention. In contrast,
> +``ENDPROC`` should annotate only ends of *standard* functions.
...
--
Regards/Gruss,
Boris.
Good mailing practices for 400: avoid top-posting and trim the reply.
next prev parent reply other threads:[~2019-01-31 16:00 UTC|newest]
Thread overview: 48+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-30 12:46 [PATCH v7 00/28] New macros for assembler symbols Jiri Slaby
2019-01-30 12:46 ` [PATCH v7 01/28] linkage: new " Jiri Slaby
2019-01-31 16:00 ` Borislav Petkov [this message]
2019-02-01 13:53 ` Jiri Slaby
2019-01-30 12:46 ` [PATCH v7 02/28] x86/asm/suspend: drop ENTRY from local data Jiri Slaby
2019-01-30 15:12 ` [tip:x86/cleanups] x86/asm/suspend: Drop " tip-bot for Jiri Slaby
2019-01-30 12:46 ` [PATCH v7 03/28] x86/asm/suspend: use SYM_DATA for data Jiri Slaby
2019-02-04 20:18 ` Borislav Petkov
2019-02-05 7:34 ` Jiri Slaby
2019-02-05 8:07 ` Borislav Petkov
2019-01-30 12:46 ` [PATCH v7 04/28] x86/asm: annotate relocate_kernel Jiri Slaby
2019-02-08 19:53 ` Borislav Petkov
2019-01-30 12:46 ` [PATCH v7 05/28] x86/asm/entry: annotate THUNKs Jiri Slaby
2019-02-09 11:25 ` Borislav Petkov
2019-02-12 10:27 ` Jiri Slaby
2019-02-12 11:05 ` Borislav Petkov
2019-02-12 11:38 ` Jiri Slaby
2019-02-12 11:46 ` Borislav Petkov
2019-02-12 11:51 ` Jiri Slaby
2019-02-12 12:13 ` Borislav Petkov
2019-02-14 10:03 ` Jiri Slaby
2019-02-14 10:34 ` Borislav Petkov
2019-01-30 12:46 ` [PATCH v7 06/28] x86/asm: annotate local pseudo-functions Jiri Slaby
2019-02-09 12:24 ` Borislav Petkov
2019-01-30 12:46 ` [PATCH v7 07/28] x86/asm/crypto: annotate local functions Jiri Slaby
2019-02-25 10:13 ` Borislav Petkov
2019-01-30 12:46 ` [PATCH v7 08/28] x86/boot/compressed: " Jiri Slaby
2019-01-30 12:46 ` [PATCH v7 09/28] x86/asm: annotate aliases Jiri Slaby
2019-01-30 12:46 ` [PATCH v7 10/28] x86/asm/entry: annotate interrupt symbols properly Jiri Slaby
2019-01-30 12:46 ` [PATCH v7 11/28] x86/asm/head: annotate data appropriatelly Jiri Slaby
2019-02-25 14:53 ` Borislav Petkov
2019-01-30 12:46 ` [PATCH v7 12/28] x86/boot/compressed: " Jiri Slaby
2019-01-30 12:46 ` [PATCH v7 13/28] um: " Jiri Slaby
2019-01-30 12:46 ` [PATCH v7 14/28] xen/pvh: " Jiri Slaby
2019-01-30 12:46 ` [PATCH v7 15/28] x86/asm/purgatory: start using annotations Jiri Slaby
2019-01-30 12:46 ` [PATCH v7 16/28] x86/asm: do not annotate functions by GLOBAL Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 17/28] x86/asm: use SYM_INNER_LABEL instead of GLOBAL Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 18/28] x86/asm/realmode: use SYM_DATA_* " Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 19/28] x86/asm: kill the last GLOBAL user and remove the macro Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 20/28] x86/asm: make some functions local Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 21/28] x86/asm/ftrace: mark function_hook as function Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 22/28] x86_64/asm: add ENDs to some functions and relabel with SYM_CODE_* Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 23/28] x86_64/asm: change all ENTRY+END to SYM_CODE_* Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 24/28] x86_64/asm: change all ENTRY+ENDPROC to SYM_FUNC_* Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 25/28] x86_32/asm: add ENDs to some functions and relabel with SYM_CODE_* Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 26/28] x86_32/asm: change all ENTRY+END to SYM_CODE_* Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 27/28] x86_32/asm: change all ENTRY+ENDPROC to SYM_FUNC_* Jiri Slaby
2019-01-30 12:47 ` [PATCH v7 28/28] x86/asm: replace WEAK uses by SYM_INNER_LABEL_ALIGN Jiri Slaby
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=20190131160019.GM6749@zn.tnic \
--to=bp@alien8.de \
--cc=a.p.zijlstra@chello.nl \
--cc=akpm@linux-foundation.org \
--cc=boris.ostrovsky@oracle.com \
--cc=hpa@zytor.com \
--cc=jgross@suse.com \
--cc=jpoimboe@redhat.com \
--cc=jslaby@suse.cz \
--cc=len.brown@intel.com \
--cc=linux-arch@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=mingo@kernel.org \
--cc=mingo@redhat.com \
--cc=pavel@ucw.cz \
--cc=rjw@rjwysocki.net \
--cc=tglx@linutronix.de \
--cc=torvalds@linux-foundation.org \
--cc=x86@kernel.org \
--cc=xen-devel@lists.xenproject.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: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).