original/man2/syscall.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)syscall.2   8.1 (Berkeley) 6/16/93
  35 .\"
  36 .\"
  37 .\" 2002-03-20  Christoph Hellwig <hch@infradead.org>
  38 .\"     - adopted for Linux
  39 .\"
  40 .TH SYSCALL 2 2013-04-07 "Linux" "Linux Programmer's Manual"
  41 .SH NAME
  42 syscall \- indirect system call
  43 .SH SYNOPSIS
  44 .nf
  45 .BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
  46 .B #include <unistd.h>
  47 .BR "#include <sys/syscall.h>   "  "/* For SYS_xxx definitions */"
  48
  49 .BI "int syscall(int " number ", ...);"
  50 .fi
  51 .SH DESCRIPTION
  52 .BR syscall ()
  53 is a small library function that invokes
  54 the system call whose assembly language
  55 interface has the specified
  56 .I number
  57 with the specified arguments.
  58 Employing
  59 .BR syscall ()
  60 is useful, for example,
  61 when invoking a system call that has no wrapper function in the C library.
  62
  63 .BR syscall ()
  64 saves CPU registers before making the system call,
  65 restores the registers upon return from the system call,
  66 and stores any error code returned by the system call in
  67 .BR errno (3)
  68 if an error occurs.
  69
  70 Symbolic constants for system call numbers can be found in the header file
  71 .IR <sys/syscall.h> .
  72 .SH RETURN VALUE
  73 The return value is defined by the system call being invoked.
  74 In general, a 0 return value indicates success.
  75 A \-1 return value indicates an error,
  76 and an error code is stored in
  77 .IR errno .
  78 .SH NOTES
  79 .BR syscall ()
  80 first appeared in
  81 4BSD.
  82 .SS Architecture-specific requirements
  83 Each architecture ABI has its own requirements on how
  84 system call arguments are passed to the kernel.
  85 For system calls that have a glibc wrapper (e.g., most system calls),
  86 glibc handles the details of copying arguments to the right registers
  87 in a manner suitable for the architecture.
  88 However, when using
  89 .BR syscall ()
  90 to make a system call,
  91 the caller might need to handle architecture-dependent details;
  92 this requirement is most commonly encountered on certain 32-bit architectures.
  93
  94 For example, on the ARM architecture Embedded ABI (EABI), a
  95 64-bit value (e.g.,
  96 .IR "long long" )
  97 must be aligned to an even register pair.
  98 Thus, using
  99 .BR syscall ()
 100 instead of the wrapper provided by glibc,
 101 the
 102 .BR readahead ()
 103 system call would be invoked as follows on the ARM architecture with the EABI:
 104
 105 .in +4n
 106 .nf
 107 syscall(SYS_readahead, fd, 0,
 108         (unsigned int) (offset >> 32),
 109         (unsigned int) (offset & 0xFFFFFFFF),
 110         count);
 111 .fi
 112 .in
 113 .PP
 114 Since the offset argument is 64 bits, and the first argument
 115 .RI ( fd )
 116 is passed in
 117 .IR r0 ,
 118 the caller must manually split and align the 64-bit value
 119 so that it is passed in the
 120 .IR r2 / r3
 121 register pair.
 122 That means inserting a dummy value into
 123 .I r1
 124 (the second argument of 0).
 125
 126 Similar issues can occur on MIPS with the O32 ABI,
 127 on PowerPC with the 32-bit ABI, and on Xtensa.
 128 .\" Mike Frysinger: this issue ends up forcing MIPS
 129 .\" O32 to take 7 arguments to syscall()
 130
 131 The affected system calls are
 132 .BR fadvise64_64 (2),
 133 .BR ftruncate64 (2),
 134 .BR posix_fadvise (2),
 135 .BR pread64 (2),
 136 .BR pwrite64 (2),
 137 .BR readahead (2),
 138 .BR sync_file_range (2),
 139 and
 140 .BR truncate64 (2).
 141 .SS Architecture calling conventions
 142 Every architecture has its own way of invoking and passing arguments to the
 143 kernel.
 144 The details for various architectures are listed in the two tables below.
 145
 146 The first table lists the instruction used to transition to kernel mode,
 147 (which might not be the fastest or best way to transition to the kernel,
 148 so you might have to refer to the VDSO),
 149 the register used to indicate the system call number,
 150 and the register used to return the system call result.
 151 .if t \{\
 152 .ft CW
 153 \}
 154 .TS
 155 l l1 l l1 l.
 156 arch/ABI        instruction     syscall #       retval  Notes
 157 _
 158 arm/OABI        swi NR  -       a1      NR is syscall #
 159 arm/EABI        swi 0x0 r7      r1
 160 blackfin        excpt 0x0       P0      R0
 161 i386    int $0x80       eax     eax
 162 ia64    break 0x100000  r15     r10/r8
 163 parisc  ble 0x100(%sr2, %r0)    r20     r28
 164 sparc/32        t 0x10  g1      o0
 165 sparc/64        t 0x6d  g1      o0
 166 x86_64  syscall rax     rax
 167 .TE
 168 .if t \{\
 169 .in
 170 .ft P
 171 \}
 172 .PP
 173 The second table shows the registers used to pass the system call arguments.
 174 .if t \{\
 175 .ft CW
 176 \}
 177 .TS
 178 l l l l l l l l.
 179 arch/ABI        arg1    arg2    arg3    arg4    arg5    arg6    arg7
 180 _
 181 arm/OABI        a1      a2      a3      a4      v1      v2      v3
 182 arm/EABI        r1      r2      r3      r4      r5      r6      r7
 183 blackfin        R0      R1      R2      R3      R4      R5      -
 184 i386    ebx     ecx     edx     esi     edi     ebp     -
 185 ia64    r11     r9      r10     r14     r15     r13     -
 186 parisc  r26     r25     r24     r23     r22     r21     -
 187 sparc/32        o0      o1      o2      o3      o4      o5      -
 188 sparc/64        o0      o1      o2      o3      o4      o5      -
 189 x86_64  rdi     rsi     rdx     r10     r8      r9      -
 190 .TE
 191 .if t \{\
 192 .in
 193 .ft P
 194 \}
 195 .PP
 196 Note that these tables don't cover the entire calling convention\(emsome
 197 architectures may indiscriminately clobber other registers not listed here.
 198 .SH EXAMPLE
 199 .nf
 200 #define _GNU_SOURCE
 201 #include <unistd.h>
 202 #include <sys/syscall.h>
 203 #include <sys/types.h>
 204
 205 int
 206 main(int argc, char *argv[])
 207 {
 208     pid_t tid;
 209
 210     tid = syscall(SYS_gettid);
 211     tid = syscall(SYS_tgkill, getpid(), tid);
 212 }
 213 .fi
 214 .SH SEE ALSO
 215 .BR _syscall (2),
 216 .BR intro (2),
 217 .BR syscalls (2)