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