lib/libc/sys/syscall.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)syscall.2   8.1 (Berkeley) 6/16/93
  33 .\" $FreeBSD: src/lib/libc/sys/syscall.2,v 1.5.2.3 2001/12/14 18:34:02 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/syscall.2,v 1.4 2006/05/26 19:39:37 swildner Exp $
  35 .\"
  36 .Dd June 16, 1993
  37 .Dt SYSCALL 2
  38 .Os
  39 .Sh NAME
  40 .Nm syscall ,
  41 .Nm __syscall
  42 .Nd indirect system call
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In sys/syscall.h
  47 .In unistd.h
  48 .Ft int
  49 .Fn syscall "int number" ...
  50 .Ft off_t
  51 .Fn __syscall "quad_t number" ...
  52 .Sh DESCRIPTION
  53 .Fn Syscall
  54 performs the system call whose assembly language
  55 interface has the specified
  56 .Fa number
  57 with the specified arguments.
  58 Symbolic constants for system calls can be found in the header file
  59 .In sys/syscall.h .
  60 The
  61 .Fn __syscall
  62 form should be used when one or more of the parameters is a
  63 64-bit argument to ensure that argument alignment is correct.
  64 This system call is useful for testing new system calls that
  65 do not have entries in the C library.
  66 .Sh RETURN VALUES
  67 The return values are defined by the system call being invoked.
  68 In general, a 0 return value indicates success.
  69 A -1 return value indicates an error,
  70 and an error code is stored in
  71 .Va errno .
  72 .Sh HISTORY
  73 The
  74 .Fn syscall
  75 function call appeared in
  76 .Bx 4.0 .
  77 .Sh BUGS
  78 There is no way to simulate system calls that have multiple return values
  79 such as
  80 .Xr pipe 2 .