1 2.. _addsyscalls: 3 4Adding a New System Call 5======================== 6 7This document describes what's involved in adding a new system call to the 8Linux kernel, over and above the normal submission advice in 9:ref:`Documentation/process/submitting-patches.rst <submittingpatches>`. 10 11 12System Call Alternatives 13------------------------ 14 15The first thing to consider when adding a new system call is whether one of 16the alternatives might be suitable instead. Although system calls are the 17most traditional and most obvious interaction points between userspace and the 18kernel, there are other possibilities -- choose what fits best for your 19interface. 20 21 - If the operations involved can be made to look like a filesystem-like 22 object, it may make more sense to create a new filesystem or device. This 23 also makes it easier to encapsulate the new functionality in a kernel module 24 rather than requiring it to be built into the main kernel. 25 26 - If the new functionality involves operations where the kernel notifies 27 userspace that something has happened, then returning a new file 28 descriptor for the relevant object allows userspace to use 29 ``poll``/``select``/``epoll`` to receive that notification. 30 - However, operations that don't map to 31 :manpage:`read(2)`/:manpage:`write(2)`-like operations 32 have to be implemented as :manpage:`ioctl(2)` requests, which can lead 33 to a somewhat opaque API. 34 35 - If you're just exposing runtime system information, a new node in sysfs 36 (see ``Documentation/filesystems/sysfs.rst``) or the ``/proc`` filesystem may 37 be more appropriate. However, access to these mechanisms requires that the 38 relevant filesystem is mounted, which might not always be the case (e.g. 39 in a namespaced/sandboxed/chrooted environment). Avoid adding any API to 40 debugfs, as this is not considered a 'production' interface to userspace. 41 - If the operation is specific to a particular file or file descriptor, then 42 an additional :manpage:`fcntl(2)` command option may be more appropriate. However, 43 :manpage:`fcntl(2)` is a multiplexing system call that hides a lot of complexity, so 44 this option is best for when the new function is closely analogous to 45 existing :manpage:`fcntl(2)` functionality, or the new functionality is very simple 46 (for example, getting/setting a simple flag related to a file descriptor). 47 - If the operation is specific to a particular task or process, then an 48 additional :manpage:`prctl(2)` command option may be more appropriate. As 49 with :manpage:`fcntl(2)`, this system call is a complicated multiplexor so 50 is best reserved for near-analogs of existing ``prctl()`` commands or 51 getting/setting a simple flag related to a process. 52 53 54Designing the API: Planning for Extension 55----------------------------------------- 56 57A new system call forms part of the API of the kernel, and has to be supported 58indefinitely. As such, it's a very good idea to explicitly discuss the 59interface on the kernel mailing list, and it's important to plan for future 60extensions of the interface. 61 62(The syscall table is littered with historical examples where this wasn't done, 63together with the corresponding follow-up system calls -- 64``eventfd``/``eventfd2``, ``dup2``/``dup3``, ``inotify_init``/``inotify_init1``, 65``pipe``/``pipe2``, ``renameat``/``renameat2`` -- so 66learn from the history of the kernel and plan for extensions from the start.) 67 68For simpler system calls that only take a couple of arguments, the preferred 69way to allow for future extensibility is to include a flags argument to the 70system call. To make sure that userspace programs can safely use flags 71between kernel versions, check whether the flags value holds any unknown 72flags, and reject the system call (with ``EINVAL``) if it does:: 73 74 if (flags & ~(THING_FLAG1 | THING_FLAG2 | THING_FLAG3)) 75 return -EINVAL; 76 77(If no flags values are used yet, check that the flags argument is zero.) 78 79For more sophisticated system calls that involve a larger number of arguments, 80it's preferred to encapsulate the majority of the arguments into a structure 81that is passed in by pointer. Such a structure can cope with future extension 82by including a size argument in the structure:: 83 84 struct xyzzy_params { 85 u32 size; /* userspace sets p->size = sizeof(struct xyzzy_params) */ 86 u32 param_1; 87 u64 param_2; 88 u64 param_3; 89 }; 90 91As long as any subsequently added field, say ``param_4``, is designed so that a 92zero value gives the previous behaviour, then this allows both directions of 93version mismatch: 94 95 - To cope with a later userspace program calling an older kernel, the kernel 96 code should check that any memory beyond the size of the structure that it 97 expects is zero (effectively checking that ``param_4 == 0``). 98 - To cope with an older userspace program calling a newer kernel, the kernel 99 code can zero-extend a smaller instance of the structure (effectively 100 setting ``param_4 = 0``). 101 102See :manpage:`perf_event_open(2)` and the ``perf_copy_attr()`` function (in 103``kernel/events/core.c``) for an example of this approach. 104 105 106Designing the API: Other Considerations 107--------------------------------------- 108 109If your new system call allows userspace to refer to a kernel object, it 110should use a file descriptor as the handle for that object -- don't invent a 111new type of userspace object handle when the kernel already has mechanisms and 112well-defined semantics for using file descriptors. 113 114If your new :manpage:`xyzzy(2)` system call does return a new file descriptor, 115then the flags argument should include a value that is equivalent to setting 116``O_CLOEXEC`` on the new FD. This makes it possible for userspace to close 117the timing window between ``xyzzy()`` and calling 118``fcntl(fd, F_SETFD, FD_CLOEXEC)``, where an unexpected ``fork()`` and 119``execve()`` in another thread could leak a descriptor to 120the exec'ed program. (However, resist the temptation to re-use the actual value 121of the ``O_CLOEXEC`` constant, as it is architecture-specific and is part of a 122numbering space of ``O_*`` flags that is fairly full.) 123 124If your system call returns a new file descriptor, you should also consider 125what it means to use the :manpage:`poll(2)` family of system calls on that file 126descriptor. Making a file descriptor ready for reading or writing is the 127normal way for the kernel to indicate to userspace that an event has 128occurred on the corresponding kernel object. 129 130If your new :manpage:`xyzzy(2)` system call involves a filename argument:: 131 132 int sys_xyzzy(const char __user *path, ..., unsigned int flags); 133 134you should also consider whether an :manpage:`xyzzyat(2)` version is more appropriate:: 135 136 int sys_xyzzyat(int dfd, const char __user *path, ..., unsigned int flags); 137 138This allows more flexibility for how userspace specifies the file in question; 139in particular it allows userspace to request the functionality for an 140already-opened file descriptor using the ``AT_EMPTY_PATH`` flag, effectively 141giving an :manpage:`fxyzzy(3)` operation for free:: 142 143 - xyzzyat(AT_FDCWD, path, ..., 0) is equivalent to xyzzy(path,...) 144 - xyzzyat(fd, "", ..., AT_EMPTY_PATH) is equivalent to fxyzzy(fd, ...) 145 146(For more details on the rationale of the \*at() calls, see the 147:manpage:`openat(2)` man page; for an example of AT_EMPTY_PATH, see the 148:manpage:`fstatat(2)` man page.) 149 150If your new :manpage:`xyzzy(2)` system call involves a parameter describing an 151offset within a file, make its type ``loff_t`` so that 64-bit offsets can be 152supported even on 32-bit architectures. 153 154If your new :manpage:`xyzzy(2)` system call involves privileged functionality, 155it needs to be governed by the appropriate Linux capability bit (checked with 156a call to ``capable()``), as described in the :manpage:`capabilities(7)` man 157page. Choose an existing capability bit that governs related functionality, 158but try to avoid combining lots of only vaguely related functions together 159under the same bit, as this goes against capabilities' purpose of splitting 160the power of root. In particular, avoid adding new uses of the already 161overly-general ``CAP_SYS_ADMIN`` capability. 162 163If your new :manpage:`xyzzy(2)` system call manipulates a process other than 164the calling process, it should be restricted (using a call to 165``ptrace_may_access()``) so that only a calling process with the same 166permissions as the target process, or with the necessary capabilities, can 167manipulate the target process. 168 169Finally, be aware that some non-x86 architectures have an easier time if 170system call parameters that are explicitly 64-bit fall on odd-numbered 171arguments (i.e. parameter 1, 3, 5), to allow use of contiguous pairs of 32-bit 172registers. (This concern does not apply if the arguments are part of a 173structure that's passed in by pointer.) 174 175 176Proposing the API 177----------------- 178 179To make new system calls easy to review, it's best to divide up the patchset 180into separate chunks. These should include at least the following items as 181distinct commits (each of which is described further below): 182 183 - The core implementation of the system call, together with prototypes, 184 generic numbering, Kconfig changes and fallback stub implementation. 185 - Wiring up of the new system call for one particular architecture, usually 186 x86 (including all of x86_64, x86_32 and x32). 187 - A demonstration of the use of the new system call in userspace via a 188 selftest in ``tools/testing/selftests/``. 189 - A draft man-page for the new system call, either as plain text in the 190 cover letter, or as a patch to the (separate) man-pages repository. 191 192New system call proposals, like any change to the kernel's API, should always 193be cc'ed to linux-api@vger.kernel.org. 194 195 196Generic System Call Implementation 197---------------------------------- 198 199The main entry point for your new :manpage:`xyzzy(2)` system call will be called 200``sys_xyzzy()``, but you add this entry point with the appropriate 201``SYSCALL_DEFINEn()`` macro rather than explicitly. The 'n' indicates the 202number of arguments to the system call, and the macro takes the system call name 203followed by the (type, name) pairs for the parameters as arguments. Using 204this macro allows metadata about the new system call to be made available for 205other tools. 206 207The new entry point also needs a corresponding function prototype, in 208``include/linux/syscalls.h``, marked as asmlinkage to match the way that system 209calls are invoked:: 210 211 asmlinkage long sys_xyzzy(...); 212 213Some architectures (e.g. x86) have their own architecture-specific syscall 214tables, but several other architectures share a generic syscall table. Add your 215new system call to the generic list by adding an entry to the list in 216``include/uapi/asm-generic/unistd.h``:: 217 218 #define __NR_xyzzy 292 219 __SYSCALL(__NR_xyzzy, sys_xyzzy) 220 221Also update the __NR_syscalls count to reflect the additional system call, and 222note that if multiple new system calls are added in the same merge window, 223your new syscall number may get adjusted to resolve conflicts. 224 225The file ``kernel/sys_ni.c`` provides a fallback stub implementation of each 226system call, returning ``-ENOSYS``. Add your new system call here too:: 227 228 COND_SYSCALL(xyzzy); 229 230Your new kernel functionality, and the system call that controls it, should 231normally be optional, so add a ``CONFIG`` option (typically to 232``init/Kconfig``) for it. As usual for new ``CONFIG`` options: 233 234 - Include a description of the new functionality and system call controlled 235 by the option. 236 - Make the option depend on EXPERT if it should be hidden from normal users. 237 - Make any new source files implementing the function dependent on the CONFIG 238 option in the Makefile (e.g. ``obj-$(CONFIG_XYZZY_SYSCALL) += xyzzy.o``). 239 - Double check that the kernel still builds with the new CONFIG option turned 240 off. 241 242To summarize, you need a commit that includes: 243 244 - ``CONFIG`` option for the new function, normally in ``init/Kconfig`` 245 - ``SYSCALL_DEFINEn(xyzzy, ...)`` for the entry point 246 - corresponding prototype in ``include/linux/syscalls.h`` 247 - generic table entry in ``include/uapi/asm-generic/unistd.h`` 248 - fallback stub in ``kernel/sys_ni.c`` 249 250 251.. _syscall_generic_6_11: 252 253Since 6.11 254~~~~~~~~~~ 255 256Starting with kernel version 6.11, general system call implementation for the 257following architectures no longer requires modifications to 258``include/uapi/asm-generic/unistd.h``: 259 260 - arc 261 - arm64 262 - csky 263 - hexagon 264 - loongarch 265 - nios2 266 - openrisc 267 - riscv 268 269Instead, you need to update ``scripts/syscall.tbl`` and, if applicable, adjust 270``arch/*/kernel/Makefile.syscalls``. 271 272As ``scripts/syscall.tbl`` serves as a common syscall table across multiple 273architectures, a new entry is required in this table:: 274 275 468 common xyzzy sys_xyzzy 276 277Note that adding an entry to ``scripts/syscall.tbl`` with the "common" ABI 278also affects all architectures that share this table. For more limited or 279architecture-specific changes, consider using an architecture-specific ABI or 280defining a new one. 281 282If a new ABI, say ``xyz``, is introduced, the corresponding updates should be 283made to ``arch/*/kernel/Makefile.syscalls`` as well:: 284 285 syscall_abis_{32,64} += xyz (...) 286 287To summarize, you need a commit that includes: 288 289 - ``CONFIG`` option for the new function, normally in ``init/Kconfig`` 290 - ``SYSCALL_DEFINEn(xyzzy, ...)`` for the entry point 291 - corresponding prototype in ``include/linux/syscalls.h`` 292 - new entry in ``scripts/syscall.tbl`` 293 - (if needed) Makefile updates in ``arch/*/kernel/Makefile.syscalls`` 294 - fallback stub in ``kernel/sys_ni.c`` 295 296 297x86 System Call Implementation 298------------------------------ 299 300To wire up your new system call for x86 platforms, you need to update the 301master syscall tables. Assuming your new system call isn't special in some 302way (see below), this involves a "common" entry (for x86_64 and x32) in 303arch/x86/entry/syscalls/syscall_64.tbl:: 304 305 333 common xyzzy sys_xyzzy 306 307and an "i386" entry in ``arch/x86/entry/syscalls/syscall_32.tbl``:: 308 309 380 i386 xyzzy sys_xyzzy 310 311Again, these numbers are liable to be changed if there are conflicts in the 312relevant merge window. 313 314 315Compatibility System Calls (Generic) 316------------------------------------ 317 318For most system calls the same 64-bit implementation can be invoked even when 319the userspace program is itself 32-bit; even if the system call's parameters 320include an explicit pointer, this is handled transparently. 321 322However, there are a couple of situations where a compatibility layer is 323needed to cope with size differences between 32-bit and 64-bit. 324 325The first is if the 64-bit kernel also supports 32-bit userspace programs, and 326so needs to parse areas of (``__user``) memory that could hold either 32-bit or 32764-bit values. In particular, this is needed whenever a system call argument 328is: 329 330 - a pointer to a pointer 331 - a pointer to a struct containing a pointer (e.g. ``struct iovec __user *``) 332 - a pointer to a varying sized integral type (``time_t``, ``off_t``, 333 ``long``, ...) 334 - a pointer to a struct containing a varying sized integral type. 335 336The second situation that requires a compatibility layer is if one of the 337system call's arguments has a type that is explicitly 64-bit even on a 32-bit 338architecture, for example ``loff_t`` or ``__u64``. In this case, a value that 339arrives at a 64-bit kernel from a 32-bit application will be split into two 34032-bit values, which then need to be re-assembled in the compatibility layer. 341 342(Note that a system call argument that's a pointer to an explicit 64-bit type 343does **not** need a compatibility layer; for example, :manpage:`splice(2)`'s arguments of 344type ``loff_t __user *`` do not trigger the need for a ``compat_`` system call.) 345 346The compatibility version of the system call is called ``compat_sys_xyzzy()``, 347and is added with the ``COMPAT_SYSCALL_DEFINEn()`` macro, analogously to 348SYSCALL_DEFINEn. This version of the implementation runs as part of a 64-bit 349kernel, but expects to receive 32-bit parameter values and does whatever is 350needed to deal with them. (Typically, the ``compat_sys_`` version converts the 351values to 64-bit versions and either calls on to the ``sys_`` version, or both of 352them call a common inner implementation function.) 353 354The compat entry point also needs a corresponding function prototype, in 355``include/linux/compat.h``, marked as asmlinkage to match the way that system 356calls are invoked:: 357 358 asmlinkage long compat_sys_xyzzy(...); 359 360If the system call involves a structure that is laid out differently on 32-bit 361and 64-bit systems, say ``struct xyzzy_args``, then the include/linux/compat.h 362header file should also include a compat version of the structure (``struct 363compat_xyzzy_args``) where each variable-size field has the appropriate 364``compat_`` type that corresponds to the type in ``struct xyzzy_args``. The 365``compat_sys_xyzzy()`` routine can then use this ``compat_`` structure to 366parse the arguments from a 32-bit invocation. 367 368For example, if there are fields:: 369 370 struct xyzzy_args { 371 const char __user *ptr; 372 __kernel_long_t varying_val; 373 u64 fixed_val; 374 /* ... */ 375 }; 376 377in struct xyzzy_args, then struct compat_xyzzy_args would have:: 378 379 struct compat_xyzzy_args { 380 compat_uptr_t ptr; 381 compat_long_t varying_val; 382 u64 fixed_val; 383 /* ... */ 384 }; 385 386The generic system call list also needs adjusting to allow for the compat 387version; the entry in ``include/uapi/asm-generic/unistd.h`` should use 388``__SC_COMP`` rather than ``__SYSCALL``:: 389 390 #define __NR_xyzzy 292 391 __SC_COMP(__NR_xyzzy, sys_xyzzy, compat_sys_xyzzy) 392 393To summarize, you need: 394 395 - a ``COMPAT_SYSCALL_DEFINEn(xyzzy, ...)`` for the compat entry point 396 - corresponding prototype in ``include/linux/compat.h`` 397 - (if needed) 32-bit mapping struct in ``include/linux/compat.h`` 398 - instance of ``__SC_COMP`` not ``__SYSCALL`` in 399 ``include/uapi/asm-generic/unistd.h`` 400 401 402Since 6.11 403~~~~~~~~~~ 404 405This applies to all the architectures listed in :ref:`Since 6.11<syscall_generic_6_11>` 406under "Generic System Call Implementation", except arm64. See 407:ref:`Compatibility System Calls (arm64)<compat_arm64>` for more information. 408 409You need to extend the entry in ``scripts/syscall.tbl`` with an extra column 410to indicate that a 32-bit userspace program running on a 64-bit kernel should 411hit the compat entry point:: 412 413 468 common xyzzy sys_xyzzy compat_sys_xyzzy 414 415To summarize, you need: 416 417 - ``COMPAT_SYSCALL_DEFINEn(xyzzy, ...)`` for the compat entry point 418 - corresponding prototype in ``include/linux/compat.h`` 419 - modification of the entry in ``scripts/syscall.tbl`` to include an extra 420 "compat" column 421 - (if needed) 32-bit mapping struct in ``include/linux/compat.h`` 422 423 424.. _compat_arm64: 425 426Compatibility System Calls (arm64) 427^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 428 429On arm64, there is a dedicated syscall table for compatibility system calls 430targeting 32-bit (AArch32) userspace: ``arch/arm64/tools/syscall_32.tbl``. 431You need to add an additional line to this table specifying the compat 432entry point:: 433 434 468 common xyzzy sys_xyzzy compat_sys_xyzzy 435 436 437Compatibility System Calls (x86) 438-------------------------------- 439 440To wire up the x86 architecture of a system call with a compatibility version, 441the entries in the syscall tables need to be adjusted. 442 443First, the entry in ``arch/x86/entry/syscalls/syscall_32.tbl`` gets an extra 444column to indicate that a 32-bit userspace program running on a 64-bit kernel 445should hit the compat entry point:: 446 447 380 i386 xyzzy sys_xyzzy __ia32_compat_sys_xyzzy 448 449Second, you need to figure out what should happen for the x32 ABI version of 450the new system call. There's a choice here: the layout of the arguments 451should either match the 64-bit version or the 32-bit version. 452 453If there's a pointer-to-a-pointer involved, the decision is easy: x32 is 454ILP32, so the layout should match the 32-bit version, and the entry in 455``arch/x86/entry/syscalls/syscall_64.tbl`` is split so that x32 programs hit 456the compatibility wrapper:: 457 458 333 64 xyzzy sys_xyzzy 459 ... 460 555 x32 xyzzy __x32_compat_sys_xyzzy 461 462If no pointers are involved, then it is preferable to re-use the 64-bit system 463call for the x32 ABI (and consequently the entry in 464arch/x86/entry/syscalls/syscall_64.tbl is unchanged). 465 466In either case, you should check that the types involved in your argument 467layout do indeed map exactly from x32 (-mx32) to either the 32-bit (-m32) or 46864-bit (-m64) equivalents. 469 470 471System Calls Returning Elsewhere 472-------------------------------- 473 474For most system calls, once the system call is complete the user program 475continues exactly where it left off -- at the next instruction, with the 476stack the same and most of the registers the same as before the system call, 477and with the same virtual memory space. 478 479However, a few system calls do things differently. They might return to a 480different location (``rt_sigreturn``) or change the memory space 481(``fork``/``vfork``/``clone``) or even architecture (``execve``/``execveat``) 482of the program. 483 484To allow for this, the kernel implementation of the system call may need to 485save and restore additional registers to the kernel stack, allowing complete 486control of where and how execution continues after the system call. 487 488This is arch-specific, but typically involves defining assembly entry points 489that save/restore additional registers and invoke the real system call entry 490point. 491 492For x86_64, this is implemented as a ``stub_xyzzy`` entry point in 493``arch/x86/entry/entry_64.S``, and the entry in the syscall table 494(``arch/x86/entry/syscalls/syscall_64.tbl``) is adjusted to match:: 495 496 333 common xyzzy stub_xyzzy 497 498The equivalent for 32-bit programs running on a 64-bit kernel is normally 499called ``stub32_xyzzy`` and implemented in ``arch/x86/entry/entry_64_compat.S``, 500with the corresponding syscall table adjustment in 501``arch/x86/entry/syscalls/syscall_32.tbl``:: 502 503 380 i386 xyzzy sys_xyzzy stub32_xyzzy 504 505If the system call needs a compatibility layer (as in the previous section) 506then the ``stub32_`` version needs to call on to the ``compat_sys_`` version 507of the system call rather than the native 64-bit version. Also, if the x32 ABI 508implementation is not common with the x86_64 version, then its syscall 509table will also need to invoke a stub that calls on to the ``compat_sys_`` 510version. 511 512For completeness, it's also nice to set up a mapping so that user-mode Linux 513still works -- its syscall table will reference stub_xyzzy, but the UML build 514doesn't include ``arch/x86/entry/entry_64.S`` implementation (because UML 515simulates registers etc). Fixing this is as simple as adding a #define to 516``arch/x86/um/sys_call_table_64.c``:: 517 518 #define stub_xyzzy sys_xyzzy 519 520 521Other Details 522------------- 523 524Most of the kernel treats system calls in a generic way, but there is the 525occasional exception that may need updating for your particular system call. 526 527The audit subsystem is one such special case; it includes (arch-specific) 528functions that classify some special types of system call -- specifically 529file open (``open``/``openat``), program execution (``execve``/``exeveat``) or 530socket multiplexor (``socketcall``) operations. If your new system call is 531analogous to one of these, then the audit system should be updated. 532 533More generally, if there is an existing system call that is analogous to your 534new system call, it's worth doing a kernel-wide grep for the existing system 535call to check there are no other special cases. 536 537 538Testing 539------- 540 541A new system call should obviously be tested; it is also useful to provide 542reviewers with a demonstration of how user space programs will use the system 543call. A good way to combine these aims is to include a simple self-test 544program in a new directory under ``tools/testing/selftests/``. 545 546For a new system call, there will obviously be no libc wrapper function and so 547the test will need to invoke it using ``syscall()``; also, if the system call 548involves a new userspace-visible structure, the corresponding header will need 549to be installed to compile the test. 550 551Make sure the selftest runs successfully on all supported architectures. For 552example, check that it works when compiled as an x86_64 (-m64), x86_32 (-m32) 553and x32 (-mx32) ABI program. 554 555For more extensive and thorough testing of new functionality, you should also 556consider adding tests to the Linux Test Project, or to the xfstests project 557for filesystem-related changes. 558 559 - https://linux-test-project.github.io/ 560 - git://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git 561 562 563Man Page 564-------- 565 566All new system calls should come with a complete man page, ideally using groff 567markup, but plain text will do. If groff is used, it's helpful to include a 568pre-rendered ASCII version of the man page in the cover email for the 569patchset, for the convenience of reviewers. 570 571The man page should be cc'ed to linux-man@vger.kernel.org 572For more details, see https://www.kernel.org/doc/man-pages/patches.html 573 574 575Do not call System Calls in the Kernel 576-------------------------------------- 577 578System calls are, as stated above, interaction points between userspace and 579the kernel. Therefore, system call functions such as ``sys_xyzzy()`` or 580``compat_sys_xyzzy()`` should only be called from userspace via the syscall 581table, but not from elsewhere in the kernel. If the syscall functionality is 582useful to be used within the kernel, needs to be shared between an old and a 583new syscall, or needs to be shared between a syscall and its compatibility 584variant, it should be implemented by means of a "helper" function (such as 585``ksys_xyzzy()``). This kernel function may then be called within the 586syscall stub (``sys_xyzzy()``), the compatibility syscall stub 587(``compat_sys_xyzzy()``), and/or other kernel code. 588 589At least on 64-bit x86, it will be a hard requirement from v4.17 onwards to not 590call system call functions in the kernel. It uses a different calling 591convention for system calls where ``struct pt_regs`` is decoded on-the-fly in a 592syscall wrapper which then hands processing over to the actual syscall function. 593This means that only those parameters which are actually needed for a specific 594syscall are passed on during syscall entry, instead of filling in six CPU 595registers with random user space content all the time (which may cause serious 596trouble down the call chain). 597 598Moreover, rules on how data may be accessed may differ between kernel data and 599user data. This is another reason why calling ``sys_xyzzy()`` is generally a 600bad idea. 601 602Exceptions to this rule are only allowed in architecture-specific overrides, 603architecture-specific compatibility wrappers, or other code in arch/. 604 605 606References and Sources 607---------------------- 608 609 - LWN article from Michael Kerrisk on use of flags argument in system calls: 610 https://lwn.net/Articles/585415/ 611 - LWN article from Michael Kerrisk on how to handle unknown flags in a system 612 call: https://lwn.net/Articles/588444/ 613 - LWN article from Jake Edge describing constraints on 64-bit system call 614 arguments: https://lwn.net/Articles/311630/ 615 - Pair of LWN articles from David Drysdale that describe the system call 616 implementation paths in detail for v3.14: 617 618 - https://lwn.net/Articles/604287/ 619 - https://lwn.net/Articles/604515/ 620 621 - Architecture-specific requirements for system calls are discussed in the 622 :manpage:`syscall(2)` man-page: 623 http://man7.org/linux/man-pages/man2/syscall.2.html#NOTES 624 - Collated emails from Linus Torvalds discussing the problems with ``ioctl()``: 625 https://yarchive.net/comp/linux/ioctl.html 626 - "How to not invent kernel interfaces", Arnd Bergmann, 627 https://www.ukuug.org/events/linux2007/2007/papers/Bergmann.pdf 628 - LWN article from Michael Kerrisk on avoiding new uses of CAP_SYS_ADMIN: 629 https://lwn.net/Articles/486306/ 630 - Recommendation from Andrew Morton that all related information for a new 631 system call should come in the same email thread: 632 https://lore.kernel.org/r/20140724144747.3041b208832bbdf9fbce5d96@linux-foundation.org 633 - Recommendation from Michael Kerrisk that a new system call should come with 634 a man page: https://lore.kernel.org/r/CAKgNAkgMA39AfoSoA5Pe1r9N+ZzfYQNvNPvcRN7tOvRb8+v06Q@mail.gmail.com 635 - Suggestion from Thomas Gleixner that x86 wire-up should be in a separate 636 commit: https://lore.kernel.org/r/alpine.DEB.2.11.1411191249560.3909@nanos 637 - Suggestion from Greg Kroah-Hartman that it's good for new system calls to 638 come with a man-page & selftest: https://lore.kernel.org/r/20140320025530.GA25469@kroah.com 639 - Discussion from Michael Kerrisk of new system call vs. :manpage:`prctl(2)` extension: 640 https://lore.kernel.org/r/CAHO5Pa3F2MjfTtfNxa8LbnkeeU8=YJ+9tDqxZpw7Gz59E-4AUg@mail.gmail.com 641 - Suggestion from Ingo Molnar that system calls that involve multiple 642 arguments should encapsulate those arguments in a struct, which includes a 643 size field for future extensibility: https://lore.kernel.org/r/20150730083831.GA22182@gmail.com 644 - Numbering oddities arising from (re-)use of O_* numbering space flags: 645 646 - commit 75069f2b5bfb ("vfs: renumber FMODE_NONOTIFY and add to uniqueness 647 check") 648 - commit 12ed2e36c98a ("fanotify: FMODE_NONOTIFY and __O_SYNC in sparc 649 conflict") 650 - commit bb458c644a59 ("Safer ABI for O_TMPFILE") 651 652 - Discussion from Matthew Wilcox about restrictions on 64-bit arguments: 653 https://lore.kernel.org/r/20081212152929.GM26095@parisc-linux.org 654 - Recommendation from Greg Kroah-Hartman that unknown flags should be 655 policed: https://lore.kernel.org/r/20140717193330.GB4703@kroah.com 656 - Recommendation from Linus Torvalds that x32 system calls should prefer 657 compatibility with 64-bit versions rather than 32-bit versions: 658 https://lore.kernel.org/r/CA+55aFxfmwfB7jbbrXxa=K7VBYPfAvmu3XOkGrLbB1UFjX1+Ew@mail.gmail.com 659 - Patch series revising system call table infrastructure to use 660 scripts/syscall.tbl across multiple architectures: 661 https://lore.kernel.org/lkml/20240704143611.2979589-1-arnd@kernel.org 662