linux-api.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Documentation: syscalls: add a note about  ABI-agnostic types
@ 2021-04-09 20:43 Yury Norov
  2021-04-14  4:40 ` Yury Norov
  2021-04-27  2:24 ` Yury Norov
  0 siblings, 2 replies; 9+ messages in thread
From: Yury Norov @ 2021-04-09 20:43 UTC (permalink / raw)
  To: linux-api, linux-arch, linux-doc, linux-kernel
  Cc: Yury Norov, Alexander A. Klimov, André Almeida,
	Andrew Morton, Arnd Bergmann, David Sterba, Joe Perches,
	Jonathan Corbet, Mauro Carvalho Chehab, Mike Rapoport

Recently added memfd_secret() syscall had a flags parameter passed
as unsigned long, which requires creation of compat entry for it.
It was possible to change the type of flags to unsigned int and so
avoid bothering with compat layer.

https://www.spinics.net/lists/linux-mm/msg251550.html

Documentation/process/adding-syscalls.rst doesn't point clearly about
preference of ABI-agnostic types. This patch adds such notification.

Signed-off-by: Yury Norov <yury.norov@gmail.com>
---
 Documentation/process/adding-syscalls.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/Documentation/process/adding-syscalls.rst b/Documentation/process/adding-syscalls.rst
index 9af35f4ec728..46add16edf14 100644
--- a/Documentation/process/adding-syscalls.rst
+++ b/Documentation/process/adding-syscalls.rst
@@ -172,6 +172,13 @@ arguments (i.e. parameter 1, 3, 5), to allow use of contiguous pairs of 32-bit
 registers.  (This concern does not apply if the arguments are part of a
 structure that's passed in by pointer.)
 
+Whenever possible, try to use ABI-agnostic types for passing parameters to
+a syscall in order to avoid creating compat entry for it. Linux supports two
+ABI models - ILP32 and LP64. The types like ``void *``, ``long``, ``size_t``,
+``off_t`` have different size in those ABIs; types like ``char`` and  ``int``
+have the same size and don't require a compat layer support. For flags, it's
+always better to use ``unsigned int``.
+
 
 Proposing the API
 -----------------
-- 
2.25.1


^ permalink raw reply related	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2021-04-27  2:24 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-09 20:43 [PATCH] Documentation: syscalls: add a note about ABI-agnostic types Yury Norov
2021-04-14  4:40 ` Yury Norov
2021-04-14  6:14   ` Mauro Carvalho Chehab
2021-04-14  8:46     ` Christian Brauner
2021-04-14  9:46       ` Mike Rapoport
2021-04-14 13:38         ` Christian Brauner
2021-04-15 19:34           ` Yury Norov
2021-04-14 16:06     ` Yury Norov
2021-04-27  2:24 ` Yury Norov

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).