xref: /freebsd/lib/libsys/syscall.2 (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
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.Dd June 16, 1993
29.Dt SYSCALL 2
30.Os
31.Sh NAME
32.Nm syscall ,
33.Nm __syscall
34.Nd indirect system call
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In sys/syscall.h
39.In unistd.h
40.Ft int
41.Fn syscall "int number" ...
42.Ft off_t
43.Fn __syscall "quad_t number" ...
44.Sh DESCRIPTION
45The
46.Fn syscall
47function
48performs the system call whose assembly language
49interface has the specified
50.Fa number
51with the specified arguments.
52Symbolic constants for system calls can be found in the header file
53.In sys/syscall.h .
54The
55.Fn __syscall
56form should be used when one or more of the arguments is a
5764-bit argument to ensure that argument alignment is correct.
58This system call is useful for testing new system calls that
59do not have entries in the C library.
60.Sh RETURN VALUES
61The return values are defined by the system call being invoked.
62In general, a 0 return value indicates success.
63A -1 return value indicates an error,
64and an error code is stored in
65.Va errno .
66.Sh HISTORY
67The
68.Fn syscall
69function appeared in
70.Bx 4.0 .
71.Sh BUGS
72There is no way to simulate system calls that have multiple return values
73such as
74.Xr pipe 2 .
75