2007-10-23 14:40:43 +00:00
|
|
|
.\" Copyright (C) 2007 Michael Kerrisk <mtk.manpages@gmail.com>
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
2007-10-23 14:40:43 +00:00
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
2007-10-23 14:40:43 +00:00
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
2007-10-23 14:40:43 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
2007-10-23 14:40:43 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
2007-10-23 14:40:43 +00:00
|
|
|
.\" 2007-10-23 mtk: moved the _syscallN specific material to the
|
|
|
|
.\" new _syscall(2) page, and substantially enhanced and rewrote
|
|
|
|
.\" the remaining material on this page.
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
2010-11-11 05:55:35 +00:00
|
|
|
.TH INTRO 2 2010-11-11 "Linux" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
2007-10-23 14:40:43 +00:00
|
|
|
intro \- Introduction to system calls
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
2007-10-23 14:40:43 +00:00
|
|
|
Section 2 of the manual describes the Linux system calls.
|
|
|
|
A system call is an entry point into the Linux kernel.
|
|
|
|
Usually, system calls are not invoked directly:
|
|
|
|
instead, most system calls have corresponding C library
|
|
|
|
wrapper functions which perform the steps required
|
|
|
|
(e.g., trapping to kernel mode) in order to invoke
|
|
|
|
the system call.
|
2007-11-24 07:25:34 +00:00
|
|
|
Thus, making a system call looks the same as invoking a normal
|
2007-10-23 14:40:43 +00:00
|
|
|
library function.
|
|
|
|
|
|
|
|
For a list of the Linux system calls, see
|
|
|
|
.BR syscalls (2).
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On error, most system calls return a negative error number
|
|
|
|
(i.e., the negated value of one of the constants described in
|
|
|
|
.BR errno (3)).
|
|
|
|
The C library wrapper hides this detail from the caller: when a
|
|
|
|
system call returns a negative value, the wrapper copies the
|
|
|
|
absolute value into the
|
|
|
|
.I errno
|
|
|
|
variable, and returns \-1 as the return value of the wrapper.
|
2004-11-03 13:51:07 +00:00
|
|
|
|
2007-10-23 14:40:43 +00:00
|
|
|
The value returned by a successful system call depends on the call.
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
Many system calls return 0 on success, but some can return nonzero
|
2007-10-23 14:40:43 +00:00
|
|
|
values from a successful call.
|
|
|
|
The details are described in the individual manual pages.
|
2004-11-03 13:51:07 +00:00
|
|
|
|
2007-10-23 14:40:43 +00:00
|
|
|
In some cases,
|
|
|
|
the programmer must define a feature test macro in order to obtain
|
|
|
|
the declaration of a system call from the header file specified
|
|
|
|
in the man page SYNOPSIS section.
|
2010-09-10 04:33:31 +00:00
|
|
|
(Where required, these feature test macros must be defined before including
|
|
|
|
.I any
|
|
|
|
header files.)
|
2007-10-23 14:40:43 +00:00
|
|
|
In such cases, the required macro is described in the man page.
|
|
|
|
For further information on feature test macros, see
|
|
|
|
.BR feature_test_macros (7).
|
2007-05-18 16:06:42 +00:00
|
|
|
.SH "CONFORMING TO"
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
Certain terms and abbreviations are used to indicate UNIX variants
|
2007-10-23 14:40:43 +00:00
|
|
|
and standards to which calls in this section conform.
|
2007-05-18 16:06:42 +00:00
|
|
|
See
|
|
|
|
.BR standards (7).
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NOTES
|
2007-10-23 14:40:43 +00:00
|
|
|
.SS "Calling Directly"
|
|
|
|
In most cases, it is unnecessary to invoke a system call directly,
|
|
|
|
but there are times when the Standard C library does not implement
|
|
|
|
a nice wrapper function for you.
|
|
|
|
In this case, the programmer must manually invoke the system call using
|
|
|
|
.BR syscall (2).
|
|
|
|
Historically, this was also possible using one of the _syscall macros
|
|
|
|
described in
|
|
|
|
.BR _syscall (2).
|
2010-02-03 05:14:26 +00:00
|
|
|
.SS Authors and Copyright Conditions
|
2007-10-23 14:40:43 +00:00
|
|
|
Look at the header of the manual page source for the author(s) and copyright
|
|
|
|
conditions.
|
|
|
|
Note that these can be different from page to page!
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
2010-11-11 05:55:35 +00:00
|
|
|
.ad l
|
|
|
|
.nh
|
2007-10-23 14:40:43 +00:00
|
|
|
.BR _syscall (2),
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR syscall (2),
|
2010-11-11 05:55:35 +00:00
|
|
|
.BR syscalls (2),
|
|
|
|
.BR errno (3),
|
|
|
|
.BR intro (3),
|
|
|
|
.BR capabilities (7),
|
|
|
|
.BR credentials (7),
|
|
|
|
.BR feature_test_macros (7),
|
|
|
|
.BR mq_overview (7),
|
|
|
|
.BR path_resolution (7),
|
|
|
|
.BR pipe (7),
|
|
|
|
.BR pty (7),
|
|
|
|
.BR sem_overview (7),
|
|
|
|
.BR shm_overview (7),
|
|
|
|
.BR signal (7),
|
|
|
|
.BR socket (7),
|
2012-03-12 14:58:56 +00:00
|
|
|
.BR standards (7),
|
|
|
|
.BR svipc (7),
|
2010-11-11 05:55:35 +00:00
|
|
|
.BR symlink (7),
|
|
|
|
.BR time (7)
|