2008-10-25 00:02:50 +00:00
|
|
|
.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
|
|
|
|
.\" <mtk.manpages@gmail.com>
|
|
|
|
.\"
|
intro.1, _exit.2, access.2, alarm.2, alloc_hugepages.2, arch_prctl.2, bind.2, chdir.2, chmod.2, chown.2, chroot.2, clock_getres.2, clock_nanosleep.2, close.2, connect.2, delete_module.2, dup.2, execve.2, exit_group.2, faccessat.2, fchmodat.2, fchownat.2, fcntl.2, fork.2, fstatat.2, fsync.2, futimesat.2, get_robust_list.2, getdents.2, getdomainname.2, getgid.2, getgroups.2, gethostname.2, getpagesize.2, getpid.2, getresuid.2, getrlimit.2, getrusage.2, gettid.2, gettimeofday.2, getuid.2, getunwind.2, idle.2, init_module.2, intro.2, iopl.2, kcmp.2, kexec_load.2, kill.2, link.2, linkat.2, llseek.2, lookup_dcookie.2, madvise.2, mincore.2, mkdirat.2, mknodat.2, mmap.2, mmap2.2, mount.2, mprotect.2, mq_getsetattr.2, msgctl.2, msgget.2, msgop.2, msync.2, nice.2, open.2, openat.2, pause.2, perfmonctl.2, personality.2, pipe.2, poll.2, posix_fadvise.2, prctl.2, pread.2, process_vm_readv.2, quotactl.2, read.2, readahead.2, readdir.2, readlinkat.2, readv.2, reboot.2, recvmmsg.2, remap_file_pages.2, rename.2, renameat.2, rmdir.2, rt_sigqueueinfo.2, select.2, select_tut.2, semctl.2, semget.2, semop.2, sendmmsg.2, set_tid_address.2, seteuid.2, setfsgid.2, setfsuid.2, setgid.2, setresuid.2, setuid.2, setup.2, sgetmask.2, shmctl.2, shmget.2, shmop.2, sigaction.2, sigaltstack.2, signal.2, sigpending.2, sigprocmask.2, sigreturn.2, sigsuspend.2, sigwaitinfo.2, splice.2, stat.2, statfs.2, stime.2, subpage_prot.2, swapon.2, symlink.2, symlinkat.2, sync.2, sync_file_range.2, syscalls.2, sysctl.2, sysfs.2, syslog.2, tee.2, time.2, timer_create.2, timer_delete.2, timer_getoverrun.2, timer_settime.2, times.2, tkill.2, umask.2, umount.2, uname.2, unlink.2, unlinkat.2, uselib.2, ustat.2, utime.2, utimensat.2, vfork.2, vhangup.2, vm86.2, vmsplice.2, wait.2, wait4.2, write.2, CPU_SET.3, INFINITY.3, abort.3, abs.3, acos.3, acosh.3, adjtime.3, aio_init.3, asin.3, asinh.3, asprintf.3, assert.3, assert_perror.3, atan.3, atan2.3, atanh.3, atexit.3, atof.3, atoi.3, basename.3, bcmp.3, bcopy.3, bindresvport.3, bsd_signal.3, bsearch.3, bstring.3, byteorder.3, bzero.3, catgets.3, catopen.3, cbrt.3, ceil.3, clearenv.3, clock.3, clock_getcpuclockid.3, closedir.3, confstr.3, copysign.3, cos.3, cosh.3, ctermid.3, ctime.3, difftime.3, dirfd.3, div.3, dl_iterate_phdr.3, dprintf.3, drand48.3, drand48_r.3, dysize.3, ecvt.3, ecvt_r.3, end.3, endian.3, erf.3, erfc.3, ether_aton.3, euidaccess.3, exit.3, exp.3, exp10.3, exp2.3, expm1.3, fabs.3, fcloseall.3, fexecve.3, ffs.3, fgetgrent.3, fgetpwent.3, finite.3, flockfile.3, floor.3, fmod.3, fnmatch.3, fopencookie.3, fpathconf.3, fpurge.3, frexp.3, fseeko.3, ftok.3, futimes.3, gcvt.3, get_nprocs_conf.3, getaddrinfo.3, getaddrinfo_a.3, getauxval.3, getcontext.3, getcwd.3, getdate.3, getdirentries.3, getdtablesize.3, getenv.3, getfsent.3, getgrent.3, getgrnam.3, getgrouplist.3, gethostbyname.3, gethostid.3, getifaddrs.3, getipnodebyname.3, getline.3, getlogin.3, getmntent.3, getnetent.3, getnetent_r.3, getopt.3, getprotoent.3, getprotoent_r.3, getpw.3, getpwent.3, getpwnam.3, getrpcent_r.3, gets.3, getservent.3, getservent_r.3, getumask.3, getusershell.3, getutmp.3, getw.3, glob.3, gnu_get_libc_version.3, gsignal.3, hypot.3, if_nameindex.3, if_nametoindex.3, ilogb.3, index.3, inet.3, inet_ntop.3, inet_pton.3, infnan.3, initgroups.3, insque.3, intro.3, isalpha.3, isatty.3, j0.3, ldexp.3, localeconv.3, log.3, log10.3, log1p.3, log2.3, logb.3, lrint.3, lround.3, lsearch.3, lseek64.3, makecontext.3, makedev.3, mallinfo.3, malloc.3, malloc_get_state.3, malloc_info.3, malloc_stats.3, malloc_trim.3, malloc_usable_size.3, mallopt.3, matherr.3, mcheck.3, memccpy.3, memchr.3, memcmp.3, memcpy.3, memfrob.3, memmem.3, memmove.3, memset.3, mkdtemp.3, mkfifo.3, mkfifoat.3, mkstemp.3, mktemp.3, modf.3, mq_close.3, mq_getattr.3, mq_notify.3, mq_open.3, mq_receive.3, mq_send.3, mq_unlink.3, mtrace.3, on_exit.3, opendir.3, posix_fallocate.3, posix_memalign.3, posix_openpt.3, pow.3, pow10.3, profil.3, psignal.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_cleanup_push_defer_np.3, pthread_create.3, pthread_detach.3, pthread_equal.3, pthread_exit.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_join.3, pthread_kill.3, pthread_kill_other_threads_np.3, pthread_self.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setname_np.3, pthread_setschedparam.3, pthread_setschedprio.3, pthread_sigmask.3, pthread_sigqueue.3, pthread_testcancel.3, pthread_tryjoin_np.3, pthread_yield.3, putenv.3, putpwent.3, puts.3, qecvt.3, qsort.3, raise.3, rand.3, random.3, random_r.3, re_comp.3, readdir.3, realpath.3, regex.3, remainder.3, remove.3, resolver.3, rewinddir.3, rint.3, round.3, scalb.3, scalbln.3, scandir.3, sched_getcpu.3, seekdir.3, sem_close.3, sem_destroy.3, sem_getvalue.3, sem_init.3, sem_open.3, sem_post.3, sem_unlink.3, sem_wait.3, setenv.3, setlocale.3, setlogmask.3, shm_open.3, siginterrupt.3, sigpause.3, sigqueue.3, sigset.3, sigsetops.3, sigvec.3, sigwait.3, sin.3, sinh.3, sleep.3, sockatmark.3, sqrt.3, statvfs.3, stdio_ext.3, stpcpy.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strdup.3, strerror.3, strfry.3, strftime.3, string.3, strlen.3, strpbrk.3, strptime.3, strsep.3, strsignal.3, strspn.3, strstr.3, strtok.3, strtol.3, strtoul.3, strverscmp.3, strxfrm.3, swab.3, sysconf.3, syslog.3, system.3, sysv_signal.3, tan.3, tanh.3, tcgetpgrp.3, tcgetsid.3, telldir.3, tempnam.3, timegm.3, timeradd.3, tmpfile.3, tmpnam.3, toascii.3, toupper.3, trunc.3, tsearch.3, ttyslot.3, tzset.3, ulimit.3, undocumented.3, unlocked_stdio.3, usleep.3, y0.3, cpuid.4, full.4, initrd.4, mouse.4, msr.4, sd.4, st.4, acct.5, core.5, services.5, slabinfo.5, aio.7, capabilities.7, credentials.7, feature_test_macros.7, hier.7, inotify.7, libc.7, locale.7, man-pages.7, man.7, math_error.7, mq_overview.7, numa.7, path_resolution.7, pipe.7, pthreads.7, pty.7, rtld-audit.7, sem_overview.7, shm_overview.7, sigevent.7, signal.7, suffixes.7, svipc.7, termio.7, time.7, udplite.7, units.7, uri.7, sln.8: s/LICENSE_START(verbatim)/LICENSE_START(VERBATIM)/
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-10 09:29:01 +00:00
|
|
|
.\" %%%LICENSE_START(VERBATIM)
|
2008-10-25 00:02:50 +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.
|
|
|
|
.\"
|
|
|
|
.\" 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.
|
|
|
|
.\"
|
|
|
|
.\" 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.
|
|
|
|
.\"
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
intro.1, _exit.2, access.2, alarm.2, alloc_hugepages.2, arch_prctl.2, bind.2, chdir.2, chmod.2, chown.2, chroot.2, clock_getres.2, clock_nanosleep.2, close.2, connect.2, delete_module.2, dup.2, execve.2, exit_group.2, faccessat.2, fchmodat.2, fchownat.2, fcntl.2, fork.2, fstatat.2, fsync.2, futimesat.2, get_robust_list.2, getdents.2, getdomainname.2, getgid.2, getgroups.2, gethostname.2, getpagesize.2, getpid.2, getresuid.2, getrlimit.2, getrusage.2, gettid.2, gettimeofday.2, getuid.2, getunwind.2, idle.2, init_module.2, intro.2, iopl.2, kcmp.2, kexec_load.2, kill.2, link.2, linkat.2, llseek.2, lookup_dcookie.2, madvise.2, mincore.2, mkdirat.2, mknodat.2, mmap.2, mmap2.2, mount.2, mprotect.2, mq_getsetattr.2, msgctl.2, msgget.2, msgop.2, msync.2, nice.2, open.2, openat.2, pause.2, perfmonctl.2, personality.2, pipe.2, poll.2, posix_fadvise.2, prctl.2, pread.2, process_vm_readv.2, quotactl.2, read.2, readahead.2, readdir.2, readlinkat.2, readv.2, reboot.2, recvmmsg.2, remap_file_pages.2, rename.2, renameat.2, rmdir.2, rt_sigqueueinfo.2, select.2, select_tut.2, semctl.2, semget.2, semop.2, sendmmsg.2, set_tid_address.2, seteuid.2, setfsgid.2, setfsuid.2, setgid.2, setresuid.2, setuid.2, setup.2, sgetmask.2, shmctl.2, shmget.2, shmop.2, sigaction.2, sigaltstack.2, signal.2, sigpending.2, sigprocmask.2, sigreturn.2, sigsuspend.2, sigwaitinfo.2, splice.2, stat.2, statfs.2, stime.2, subpage_prot.2, swapon.2, symlink.2, symlinkat.2, sync.2, sync_file_range.2, syscalls.2, sysctl.2, sysfs.2, syslog.2, tee.2, time.2, timer_create.2, timer_delete.2, timer_getoverrun.2, timer_settime.2, times.2, tkill.2, umask.2, umount.2, uname.2, unlink.2, unlinkat.2, uselib.2, ustat.2, utime.2, utimensat.2, vfork.2, vhangup.2, vm86.2, vmsplice.2, wait.2, wait4.2, write.2, CPU_SET.3, INFINITY.3, abort.3, abs.3, acos.3, acosh.3, adjtime.3, aio_init.3, asin.3, asinh.3, asprintf.3, assert.3, assert_perror.3, atan.3, atan2.3, atanh.3, atexit.3, atof.3, atoi.3, basename.3, bcmp.3, bcopy.3, bindresvport.3, bsd_signal.3, bsearch.3, bstring.3, byteorder.3, bzero.3, catgets.3, catopen.3, cbrt.3, ceil.3, clearenv.3, clock.3, clock_getcpuclockid.3, closedir.3, confstr.3, copysign.3, cos.3, cosh.3, ctermid.3, ctime.3, difftime.3, dirfd.3, div.3, dl_iterate_phdr.3, dprintf.3, drand48.3, drand48_r.3, dysize.3, ecvt.3, ecvt_r.3, end.3, endian.3, erf.3, erfc.3, ether_aton.3, euidaccess.3, exit.3, exp.3, exp10.3, exp2.3, expm1.3, fabs.3, fcloseall.3, fexecve.3, ffs.3, fgetgrent.3, fgetpwent.3, finite.3, flockfile.3, floor.3, fmod.3, fnmatch.3, fopencookie.3, fpathconf.3, fpurge.3, frexp.3, fseeko.3, ftok.3, futimes.3, gcvt.3, get_nprocs_conf.3, getaddrinfo.3, getaddrinfo_a.3, getauxval.3, getcontext.3, getcwd.3, getdate.3, getdirentries.3, getdtablesize.3, getenv.3, getfsent.3, getgrent.3, getgrnam.3, getgrouplist.3, gethostbyname.3, gethostid.3, getifaddrs.3, getipnodebyname.3, getline.3, getlogin.3, getmntent.3, getnetent.3, getnetent_r.3, getopt.3, getprotoent.3, getprotoent_r.3, getpw.3, getpwent.3, getpwnam.3, getrpcent_r.3, gets.3, getservent.3, getservent_r.3, getumask.3, getusershell.3, getutmp.3, getw.3, glob.3, gnu_get_libc_version.3, gsignal.3, hypot.3, if_nameindex.3, if_nametoindex.3, ilogb.3, index.3, inet.3, inet_ntop.3, inet_pton.3, infnan.3, initgroups.3, insque.3, intro.3, isalpha.3, isatty.3, j0.3, ldexp.3, localeconv.3, log.3, log10.3, log1p.3, log2.3, logb.3, lrint.3, lround.3, lsearch.3, lseek64.3, makecontext.3, makedev.3, mallinfo.3, malloc.3, malloc_get_state.3, malloc_info.3, malloc_stats.3, malloc_trim.3, malloc_usable_size.3, mallopt.3, matherr.3, mcheck.3, memccpy.3, memchr.3, memcmp.3, memcpy.3, memfrob.3, memmem.3, memmove.3, memset.3, mkdtemp.3, mkfifo.3, mkfifoat.3, mkstemp.3, mktemp.3, modf.3, mq_close.3, mq_getattr.3, mq_notify.3, mq_open.3, mq_receive.3, mq_send.3, mq_unlink.3, mtrace.3, on_exit.3, opendir.3, posix_fallocate.3, posix_memalign.3, posix_openpt.3, pow.3, pow10.3, profil.3, psignal.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_cleanup_push_defer_np.3, pthread_create.3, pthread_detach.3, pthread_equal.3, pthread_exit.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_join.3, pthread_kill.3, pthread_kill_other_threads_np.3, pthread_self.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setname_np.3, pthread_setschedparam.3, pthread_setschedprio.3, pthread_sigmask.3, pthread_sigqueue.3, pthread_testcancel.3, pthread_tryjoin_np.3, pthread_yield.3, putenv.3, putpwent.3, puts.3, qecvt.3, qsort.3, raise.3, rand.3, random.3, random_r.3, re_comp.3, readdir.3, realpath.3, regex.3, remainder.3, remove.3, resolver.3, rewinddir.3, rint.3, round.3, scalb.3, scalbln.3, scandir.3, sched_getcpu.3, seekdir.3, sem_close.3, sem_destroy.3, sem_getvalue.3, sem_init.3, sem_open.3, sem_post.3, sem_unlink.3, sem_wait.3, setenv.3, setlocale.3, setlogmask.3, shm_open.3, siginterrupt.3, sigpause.3, sigqueue.3, sigset.3, sigsetops.3, sigvec.3, sigwait.3, sin.3, sinh.3, sleep.3, sockatmark.3, sqrt.3, statvfs.3, stdio_ext.3, stpcpy.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strdup.3, strerror.3, strfry.3, strftime.3, string.3, strlen.3, strpbrk.3, strptime.3, strsep.3, strsignal.3, strspn.3, strstr.3, strtok.3, strtol.3, strtoul.3, strverscmp.3, strxfrm.3, swab.3, sysconf.3, syslog.3, system.3, sysv_signal.3, tan.3, tanh.3, tcgetpgrp.3, tcgetsid.3, telldir.3, tempnam.3, timegm.3, timeradd.3, tmpfile.3, tmpnam.3, toascii.3, toupper.3, trunc.3, tsearch.3, ttyslot.3, tzset.3, ulimit.3, undocumented.3, unlocked_stdio.3, usleep.3, y0.3, cpuid.4, full.4, initrd.4, mouse.4, msr.4, sd.4, st.4, acct.5, core.5, services.5, slabinfo.5, aio.7, capabilities.7, credentials.7, feature_test_macros.7, hier.7, inotify.7, libc.7, locale.7, man-pages.7, man.7, math_error.7, mq_overview.7, numa.7, path_resolution.7, pipe.7, pthreads.7, pty.7, rtld-audit.7, sem_overview.7, shm_overview.7, sigevent.7, signal.7, suffixes.7, svipc.7, termio.7, time.7, udplite.7, units.7, uri.7, sln.8: Global fix: Add LICENSE_START(verbatim)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-10 09:28:40 +00:00
|
|
|
.\" %%%LICENSE_END
|
2008-10-25 00:02:50 +00:00
|
|
|
.\"
|
intro.1, locale.1, _exit.2, access.2, bpf.2, brk.2, capget.2, chmod.2, chroot.2, clock_getres.2, clone.2, eventfd.2, fallocate.2, fork.2, getgroups.2, gethostname.2, getpid.2, getpriority.2, getrlimit.2, getrusage.2, gettid.2, iopl.2, ioprio_set.2, killpg.2, mlock.2, mprotect.2, perf_event_open.2, poll.2, posix_fadvise.2, pread.2, ptrace.2, read.2, readv.2, recv.2, rename.2, sched_setaffinity.2, sched_setattr.2, seccomp.2, select.2, send.2, seteuid.2, setgid.2, setresuid.2, setreuid.2, setuid.2, sigaltstack.2, signalfd.2, sigpending.2, sigprocmask.2, sigreturn.2, sigsuspend.2, sigwaitinfo.2, socket.2, stat.2, timer_create.2, uname.2, utimensat.2, wait.2, wait4.2, write.2, MB_LEN_MAX.3, __ppc_get_timebase.3, clearenv.3, dl_iterate_phdr.3, error.3, fexecve.3, fpurge.3, fread.3, fts.3, getaddrinfo.3, getaddrinfo_a.3, getauxval.3, getgrent_r.3, gethostbyname.3, getifaddrs.3, getnameinfo.3, getnetent_r.3, getprotoent.3, getprotoent_r.3, getpw.3, getpwent_r.3, getrpcent.3, getrpcent_r.3, getrpcport.3, getservent.3, getservent_r.3, gsignal.3, key_setsecret.3, malloc_get_state.3, malloc_info.3, malloc_stats.3, malloc_trim.3, memcpy.3, mq_notify.3, mq_open.3, perror.3, profil.3, psignal.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_create.3, pthread_detach.3, pthread_getattr_np.3, pthread_join.3, pthread_setname_np.3, pthread_tryjoin_np.3, putgrent.3, rcmd.3, rpc.3, rpmatch.3, sem_close.3, sem_open.3, setaliasent.3, shm_open.3, sigqueue.3, strfmon.3, xcrypt.3, xdr.3, console_codes.4, null.4, core.5, host.conf.5, hosts.equiv.5, locale.5, repertoiremap.5, locale.7, man-pages.7, pty.7, rtld-audit.7, sched.7, vdso.7: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2015-07-23 14:12:28 +00:00
|
|
|
.TH PTHREAD_CREATE 3 2015-07-23 "Linux" "Linux Programmer's Manual"
|
2008-10-25 00:02:50 +00:00
|
|
|
.SH NAME
|
|
|
|
pthread_create \- create a new thread
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <pthread.h>
|
|
|
|
|
|
|
|
.BI "int pthread_create(pthread_t *" thread ", const pthread_attr_t *" attr ,
|
|
|
|
.BI " void *(*" start_routine ") (void *), void *" arg );
|
|
|
|
.fi
|
|
|
|
.sp
|
|
|
|
Compile and link with \fI\-pthread\fP.
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The
|
|
|
|
.BR pthread_create ()
|
2008-10-25 02:17:47 +00:00
|
|
|
function starts a new thread in the calling process.
|
2008-10-25 00:02:50 +00:00
|
|
|
The new thread starts execution by invoking
|
|
|
|
.IR start_routine ();
|
|
|
|
.IR arg
|
|
|
|
is passed as the sole argument of
|
|
|
|
.IR start_routine ().
|
|
|
|
|
|
|
|
The new thread terminates in one of the following ways:
|
|
|
|
.IP * 2
|
|
|
|
It calls
|
|
|
|
.BR pthread_exit (3),
|
|
|
|
specifying an exit status value that is available to another thread
|
|
|
|
in the same process that calls
|
|
|
|
.BR pthread_join (3).
|
|
|
|
.IP *
|
|
|
|
It returns from
|
|
|
|
.IR start_routine ().
|
|
|
|
This is equivalent to calling
|
|
|
|
.BR pthread_exit (3)
|
|
|
|
with the value supplied in the
|
|
|
|
.I return
|
|
|
|
statement.
|
|
|
|
.IP *
|
|
|
|
It is canceled (see
|
|
|
|
.BR pthread_cancel (3)).
|
|
|
|
.IP *
|
|
|
|
Any of the threads in the process calls
|
|
|
|
.BR exit (3),
|
|
|
|
or the main thread performs a return from
|
|
|
|
.IR main ().
|
|
|
|
This causes the termination of all threads in the process.
|
|
|
|
.PP
|
|
|
|
The
|
|
|
|
.I attr
|
|
|
|
argument points to a
|
|
|
|
.I pthread_attr_t
|
|
|
|
structure whose contents are used at thread creation time to
|
|
|
|
determine attributes for the new thread;
|
|
|
|
this structure is initialized using
|
|
|
|
.BR pthread_attr_init (3)
|
|
|
|
and related functions.
|
|
|
|
If
|
|
|
|
.I attr
|
|
|
|
is NULL,
|
|
|
|
then the thread is created with default attributes.
|
|
|
|
|
|
|
|
Before returning, a successful call to
|
|
|
|
.BR pthread_create ()
|
|
|
|
stores the ID of the new thread in the buffer pointed to by
|
|
|
|
.IR thread ;
|
|
|
|
this identifier is used to refer to the thread
|
|
|
|
in subsequent calls to other pthreads functions.
|
|
|
|
|
|
|
|
The new thread inherits a copy of the creating thread's signal mask
|
|
|
|
.RB ( pthread_sigmask (3)).
|
2008-10-29 20:43:44 +00:00
|
|
|
The set of pending signals for the new thread is empty
|
2008-10-25 00:02:50 +00:00
|
|
|
.RB ( sigpending (2)).
|
|
|
|
The new thread does not inherit the creating thread's
|
|
|
|
alternate signal stack
|
|
|
|
.RB ( sigaltstack (2)).
|
|
|
|
|
|
|
|
The new thread inherits the calling thread's floating-point environment
|
|
|
|
.RB ( fenv (3)).
|
|
|
|
|
|
|
|
The initial value of the new thread's CPU-time clock is 0
|
|
|
|
(see
|
|
|
|
.BR pthread_getcpuclockid (3)).
|
clock_nanosleep.2, getrusage.2, timerfd_create.2, clock.3, clock_getcpuclockid.3, ftime.3, pthread_create.3, pthread_getcpuclockid.3, pthread_tryjoin_np.3, sem_wait.3, time.7: Global fix: Fix xrefs to clock_*.? pages to reflect move to section 2
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2009-02-07 21:10:39 +00:00
|
|
|
.\" CLOCK_THREAD_CPUTIME_ID in clock_gettime(2)
|
2008-10-25 00:02:50 +00:00
|
|
|
.SS Linux-specific details
|
|
|
|
The new thread inherits copies of the calling thread's capability sets
|
|
|
|
(see
|
|
|
|
.BR capabilities (7))
|
|
|
|
and CPU affinity mask (see
|
|
|
|
.BR sched_setaffinity (2)).
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success,
|
|
|
|
.BR pthread_create ()
|
|
|
|
returns 0;
|
|
|
|
on error, it returns an error number, and the contents of
|
|
|
|
.IR *thread
|
|
|
|
are undefined.
|
|
|
|
.SH ERRORS
|
|
|
|
.TP
|
|
|
|
.B EAGAIN
|
2014-05-14 04:20:33 +00:00
|
|
|
Insufficient resources to create another thread.
|
|
|
|
.TP
|
|
|
|
.B EAGAIN
|
|
|
|
.\" NOTE! The following should match the description in fork(2)
|
|
|
|
A system-imposed limit on the number of threads was encountered.
|
|
|
|
There are a number of limits that may trigger this error: the
|
2008-10-25 00:02:50 +00:00
|
|
|
.BR RLIMIT_NPROC
|
|
|
|
soft resource limit (set via
|
|
|
|
.BR setrlimit (2)),
|
2014-05-14 04:20:33 +00:00
|
|
|
which limits the number of processes and threads for a real user ID,
|
2008-10-25 00:02:50 +00:00
|
|
|
was reached;
|
2014-08-04 20:32:23 +00:00
|
|
|
the kernel's system-wide limit on the number of processes and threads,
|
2008-10-25 00:02:50 +00:00
|
|
|
.IR /proc/sys/kernel/threads-max ,
|
2014-05-14 04:20:33 +00:00
|
|
|
was reached (see
|
|
|
|
.BR proc (5));
|
|
|
|
or the maximum number of PIDs,
|
|
|
|
.IR /proc/sys/kernel/pid_max ,
|
|
|
|
was reached (see
|
|
|
|
.BR proc (5)).
|
2008-10-25 00:02:50 +00:00
|
|
|
.TP
|
|
|
|
.B EINVAL
|
|
|
|
Invalid settings in
|
|
|
|
.IR attr .
|
|
|
|
.TP
|
|
|
|
.\" FIXME . Test the following
|
|
|
|
.B EPERM
|
|
|
|
No permission to set the scheduling policy and parameters specified in
|
|
|
|
.IR attr .
|
2015-05-20 10:00:07 +00:00
|
|
|
.SH ATTRIBUTES
|
|
|
|
For an explanation of the terms used in this section, see
|
|
|
|
.BR attributes (7).
|
|
|
|
.TS
|
|
|
|
allbox;
|
|
|
|
lb lb lb
|
|
|
|
l l l.
|
|
|
|
Interface Attribute Value
|
|
|
|
T{
|
|
|
|
.BR pthread_create ()
|
|
|
|
T} Thread safety MT-Safe
|
|
|
|
.TE
|
|
|
|
|
2008-10-25 00:02:50 +00:00
|
|
|
.SH CONFORMING TO
|
2015-04-18 08:41:23 +00:00
|
|
|
POSIX.1-2001, POSIX.1-2008.
|
2008-10-25 00:02:50 +00:00
|
|
|
.SH NOTES
|
|
|
|
See
|
|
|
|
.BR pthread_self (3)
|
|
|
|
for further information on the thread ID returned in
|
|
|
|
.IR *thread
|
|
|
|
by
|
|
|
|
.BR pthread_create ().
|
|
|
|
Unless real-time scheduling policies are being employed,
|
|
|
|
after a call to
|
|
|
|
.BR pthread_create (),
|
|
|
|
it is indeterminate which thread\(emthe caller or the new thread\(emwill
|
|
|
|
next execute.
|
|
|
|
|
|
|
|
A thread may either be
|
|
|
|
.I joinable
|
|
|
|
or
|
|
|
|
.IR detached .
|
|
|
|
If a thread is joinable, then another thread can call
|
|
|
|
.BR pthread_join (3)
|
|
|
|
to wait for the thread to terminate and fetch its exit status.
|
|
|
|
Only when a terminated joinable thread has been joined are
|
|
|
|
the last of its resources released back to the system.
|
|
|
|
When a detached thread terminates,
|
|
|
|
its resources are automatically released back to the system:
|
|
|
|
it is not possible to join with the thread in order to obtain
|
|
|
|
its exit status.
|
|
|
|
Making a thread detached is useful for some types of daemon threads
|
|
|
|
whose exit status the application does not need to care about.
|
|
|
|
By default, a new thread is created in a joinable state, unless
|
|
|
|
.I attr
|
|
|
|
was set to create the thread in a detached state (using
|
|
|
|
.BR pthread_attr_setdetachstate (3)).
|
|
|
|
|
|
|
|
.\" FIXME . Perhaps some of the following detail should be in
|
|
|
|
.\" a future pthread_attr_setstacksize(3) page.
|
|
|
|
On Linux/x86-32, the default stack size for a new thread is 2 megabytes.
|
|
|
|
Under the NPTL threading implementation, if the
|
|
|
|
.BR RLIMIT_STACK
|
|
|
|
soft resource limit
|
|
|
|
.IR "at the time the program started"
|
|
|
|
has any value other than "unlimited",
|
|
|
|
then it determines the default stack size of new threads.
|
|
|
|
Using
|
|
|
|
.BR pthread_attr_setstacksize (3),
|
|
|
|
the stack size attribute can be explicitly set in the
|
|
|
|
.I attr
|
|
|
|
argument used to create a thread,
|
|
|
|
in order to obtain a stack size other than the default.
|
2012-03-12 15:16:33 +00:00
|
|
|
.SH BUGS
|
|
|
|
In the obsolete LinuxThreads implementation,
|
|
|
|
each of the threads in a process has a different process ID.
|
|
|
|
This is in violation of the POSIX threads specification,
|
|
|
|
and is the source of many other nonconformances to the standard; see
|
|
|
|
.BR pthreads (7).
|
2008-10-25 00:02:50 +00:00
|
|
|
.SH EXAMPLE
|
|
|
|
The program below demonstrates the use of
|
|
|
|
.BR pthread_create (),
|
|
|
|
as well as a number of other functions in the pthreads API.
|
|
|
|
|
|
|
|
In the following run,
|
|
|
|
on a system providing the NPTL threading implementation,
|
|
|
|
the stack size defaults to the value given by the
|
|
|
|
"stack size" resource limit:
|
|
|
|
|
|
|
|
.in +4n
|
|
|
|
.nf
|
eventfd.2, execve.2, getdents.2, ioprio_set.2, mprotect.2, signalfd.2, timerfd_create.2, wait.2, backtrace.3, clock_getcpuclockid.3, end.3, fmemopen.3, fopencookie.3, frexp.3, getdate.3, getgrouplist.3, getprotoent_r.3, getservent_r.3, gnu_get_libc_version.3, inet.3, inet_pton.3, makecontext.3, malloc.3, matherr.3, offsetof.3, pthread_attr_init.3, pthread_create.3, pthread_getattr_np.3, sem_wait.3, strftime.3, strtok.3, strtol.3, core.5, proc.5, cpuset.7, mq_overview.7: Global fix: Format user input in shell sessions in boldface
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-10-28 15:37:22 +00:00
|
|
|
.RB "$" " ulimit \-s"
|
2013-05-27 02:46:36 +00:00
|
|
|
8192 # The stack size limit is 8 MB (0x800000 bytes)
|
eventfd.2, execve.2, getdents.2, ioprio_set.2, mprotect.2, signalfd.2, timerfd_create.2, wait.2, backtrace.3, clock_getcpuclockid.3, end.3, fmemopen.3, fopencookie.3, frexp.3, getdate.3, getgrouplist.3, getprotoent_r.3, getservent_r.3, gnu_get_libc_version.3, inet.3, inet_pton.3, makecontext.3, malloc.3, matherr.3, offsetof.3, pthread_attr_init.3, pthread_create.3, pthread_getattr_np.3, sem_wait.3, strftime.3, strtok.3, strtol.3, core.5, proc.5, cpuset.7, mq_overview.7: Global fix: Format user input in shell sessions in boldface
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-10-28 15:37:22 +00:00
|
|
|
.RB "$" " ./a.out hola salut servus"
|
2008-10-25 00:02:50 +00:00
|
|
|
Thread 1: top of stack near 0xb7dd03b8; argv_string=hola
|
|
|
|
Thread 2: top of stack near 0xb75cf3b8; argv_string=salut
|
|
|
|
Thread 3: top of stack near 0xb6dce3b8; argv_string=servus
|
|
|
|
Joined with thread 1; returned value was HOLA
|
|
|
|
Joined with thread 2; returned value was SALUT
|
|
|
|
Joined with thread 3; returned value was SERVUS
|
|
|
|
.fi
|
|
|
|
.in
|
|
|
|
|
|
|
|
In the next run, the program explicitly sets a stack size of 1MB (using
|
|
|
|
.BR pthread_attr_setstacksize (3))
|
|
|
|
for the created threads:
|
|
|
|
|
|
|
|
.in +4n
|
|
|
|
.nf
|
eventfd.2, execve.2, getdents.2, ioprio_set.2, mprotect.2, signalfd.2, timerfd_create.2, wait.2, backtrace.3, clock_getcpuclockid.3, end.3, fmemopen.3, fopencookie.3, frexp.3, getdate.3, getgrouplist.3, getprotoent_r.3, getservent_r.3, gnu_get_libc_version.3, inet.3, inet_pton.3, makecontext.3, malloc.3, matherr.3, offsetof.3, pthread_attr_init.3, pthread_create.3, pthread_getattr_np.3, sem_wait.3, strftime.3, strtok.3, strtol.3, core.5, proc.5, cpuset.7, mq_overview.7: Global fix: Format user input in shell sessions in boldface
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-10-28 15:37:22 +00:00
|
|
|
.RB "$" " ./a.out \-s 0x100000 hola salut servus"
|
2008-10-25 00:02:50 +00:00
|
|
|
Thread 1: top of stack near 0xb7d723b8; argv_string=hola
|
|
|
|
Thread 2: top of stack near 0xb7c713b8; argv_string=salut
|
|
|
|
Thread 3: top of stack near 0xb7b703b8; argv_string=servus
|
|
|
|
Joined with thread 1; returned value was HOLA
|
|
|
|
Joined with thread 2; returned value was SALUT
|
|
|
|
Joined with thread 3; returned value was SERVUS
|
|
|
|
.fi
|
|
|
|
.in
|
eventfd.2, getdents.2, mprotect.2, signalfd.2, timerfd_create.2, wait.2, backtrace.3, clock_getcpuclockid.3, end.3, fmemopen.3, fopencookie.3, getdate.3, getgrouplist.3, getprotoent_r.3, getservent_r.3, gnu_get_libc_version.3, inet.3, inet_pton.3, makecontext.3, matherr.3, offsetof.3, pthread_attr_init.3, pthread_create.3, pthread_getattr_np.3, sem_wait.3, strtol.3, core.5: global fix: Add ".SS Program source" to EXAMPLE
Add ".SS Program source" to clearly distinguish shell session and
descriptive text from actual program code.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-10-28 15:51:05 +00:00
|
|
|
.SS Program source
|
eventfd.2, getdents.2, mprotect.2, signalfd.2, timerfd_create.2, wait.2, backtrace.3, clock_getcpuclockid.3, end.3, fmemopen.3, fopencookie.3, frexp.3, getaddrinfo.3, getdate.3, getgrouplist.3, getprotoent_r.3, getservent_r.3, gnu_get_libc_version.3, inet.3, inet_pton.3, makecontext.3, matherr.3, offsetof.3, pthread_attr_init.3, pthread_create.3, pthread_getattr_np.3, sem_wait.3, strftime.3, strtok.3, strtol.3, core.5: srcfix
s/\.R " "/\\\&/ as a way of getting a blank line after a .SS heading.
(Suggested by Sam Varshavchik <mrsam@courier-mta.com>)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-11-05 01:42:45 +00:00
|
|
|
\&
|
2008-10-25 00:02:50 +00:00
|
|
|
.nf
|
|
|
|
#include <pthread.h>
|
|
|
|
#include <string.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <unistd.h>
|
|
|
|
#include <errno.h>
|
|
|
|
#include <ctype.h>
|
|
|
|
|
2008-11-11 13:35:25 +00:00
|
|
|
#define handle_error_en(en, msg) \\
|
|
|
|
do { errno = en; perror(msg); exit(EXIT_FAILURE); } while (0)
|
2008-10-25 00:02:50 +00:00
|
|
|
|
2008-11-11 13:35:25 +00:00
|
|
|
#define handle_error(msg) \\
|
|
|
|
do { perror(msg); exit(EXIT_FAILURE); } while (0)
|
2008-10-25 00:02:50 +00:00
|
|
|
|
|
|
|
struct thread_info { /* Used as argument to thread_start() */
|
2008-11-14 16:20:56 +00:00
|
|
|
pthread_t thread_id; /* ID returned by pthread_create() */
|
2008-10-25 00:02:50 +00:00
|
|
|
int thread_num; /* Application\-defined thread # */
|
|
|
|
char *argv_string; /* From command\-line argument */
|
|
|
|
};
|
|
|
|
|
|
|
|
/* Thread start function: display address near top of our stack,
|
|
|
|
and return upper\-cased copy of argv_string */
|
|
|
|
|
|
|
|
static void *
|
|
|
|
thread_start(void *arg)
|
|
|
|
{
|
2012-08-03 06:10:17 +00:00
|
|
|
struct thread_info *tinfo = arg;
|
2008-10-25 00:02:50 +00:00
|
|
|
char *uargv, *p;
|
|
|
|
|
|
|
|
printf("Thread %d: top of stack near %p; argv_string=%s\\n",
|
ldd.1, execve.2, getdents.2, quotactl.2, select_tut.2, clock_getcpuclockid.3, fopencookie.3, getservent_r.3, matherr.3, mq_notify.3, pthread_create.3, pthread_getattr_np.3, wordexp.3: Global fix: s/-/\\-/ when real hyphen is required (e.g., in code)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-08-29 10:04:28 +00:00
|
|
|
tinfo\->thread_num, &p, tinfo\->argv_string);
|
2008-10-25 00:02:50 +00:00
|
|
|
|
|
|
|
uargv = strdup(tinfo\->argv_string);
|
|
|
|
if (uargv == NULL)
|
2008-11-11 13:35:25 +00:00
|
|
|
handle_error("strdup");
|
2008-10-25 00:02:50 +00:00
|
|
|
|
2008-11-06 16:44:25 +00:00
|
|
|
for (p = uargv; *p != \(aq\\0\(aq; p++)
|
2008-10-25 00:02:50 +00:00
|
|
|
*p = toupper(*p);
|
|
|
|
|
|
|
|
return uargv;
|
|
|
|
}
|
|
|
|
|
|
|
|
int
|
|
|
|
main(int argc, char *argv[])
|
|
|
|
{
|
|
|
|
int s, tnum, opt, num_threads;
|
|
|
|
struct thread_info *tinfo;
|
|
|
|
pthread_attr_t attr;
|
|
|
|
int stack_size;
|
|
|
|
void *res;
|
|
|
|
|
|
|
|
/* The "\-s" option specifies a stack size for our threads */
|
|
|
|
|
|
|
|
stack_size = \-1;
|
|
|
|
while ((opt = getopt(argc, argv, "s:")) != \-1) {
|
|
|
|
switch (opt) {
|
2008-11-06 16:44:25 +00:00
|
|
|
case \(aqs\(aq:
|
2008-10-25 00:02:50 +00:00
|
|
|
stack_size = strtoul(optarg, NULL, 0);
|
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
|
|
|
fprintf(stderr, "Usage: %s [\-s stack-size] arg...\\n",
|
|
|
|
argv[0]);
|
|
|
|
exit(EXIT_FAILURE);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
num_threads = argc \- optind;
|
|
|
|
|
|
|
|
/* Initialize thread creation attributes */
|
|
|
|
|
|
|
|
s = pthread_attr_init(&attr);
|
|
|
|
if (s != 0)
|
2008-11-11 13:35:25 +00:00
|
|
|
handle_error_en(s, "pthread_attr_init");
|
2008-10-25 00:02:50 +00:00
|
|
|
|
|
|
|
if (stack_size > 0) {
|
|
|
|
s = pthread_attr_setstacksize(&attr, stack_size);
|
|
|
|
if (s != 0)
|
2008-11-11 13:35:25 +00:00
|
|
|
handle_error_en(s, "pthread_attr_setstacksize");
|
2008-10-25 00:02:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Allocate memory for pthread_create() arguments */
|
|
|
|
|
2008-11-05 14:26:44 +00:00
|
|
|
tinfo = calloc(num_threads, sizeof(struct thread_info));
|
2008-10-25 00:02:50 +00:00
|
|
|
if (tinfo == NULL)
|
2008-11-11 13:35:25 +00:00
|
|
|
handle_error("calloc");
|
2008-10-25 00:02:50 +00:00
|
|
|
|
|
|
|
/* Create one thread for each command\-line argument */
|
|
|
|
|
|
|
|
for (tnum = 0; tnum < num_threads; tnum++) {
|
|
|
|
tinfo[tnum].thread_num = tnum + 1;
|
|
|
|
tinfo[tnum].argv_string = argv[optind + tnum];
|
|
|
|
|
|
|
|
/* The pthread_create() call stores the thread ID into
|
|
|
|
corresponding element of tinfo[] */
|
|
|
|
|
|
|
|
s = pthread_create(&tinfo[tnum].thread_id, &attr,
|
|
|
|
&thread_start, &tinfo[tnum]);
|
|
|
|
if (s != 0)
|
2008-11-11 13:35:25 +00:00
|
|
|
handle_error_en(s, "pthread_create");
|
2008-10-25 00:02:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Destroy the thread attributes object, since it is no
|
|
|
|
longer needed */
|
|
|
|
|
|
|
|
s = pthread_attr_destroy(&attr);
|
|
|
|
if (s != 0)
|
2008-11-11 13:35:25 +00:00
|
|
|
handle_error_en(s, "pthread_attr_destroy");
|
2008-10-25 00:02:50 +00:00
|
|
|
|
|
|
|
/* Now join with each thread, and display its returned value */
|
|
|
|
|
|
|
|
for (tnum = 0; tnum < num_threads; tnum++) {
|
|
|
|
s = pthread_join(tinfo[tnum].thread_id, &res);
|
|
|
|
if (s != 0)
|
2008-11-11 13:35:25 +00:00
|
|
|
handle_error_en(s, "pthread_join");
|
2008-10-25 00:02:50 +00:00
|
|
|
|
|
|
|
printf("Joined with thread %d; returned value was %s\\n",
|
|
|
|
tinfo[tnum].thread_num, (char *) res);
|
|
|
|
free(res); /* Free memory allocated by thread */
|
|
|
|
}
|
|
|
|
|
2008-10-25 02:17:47 +00:00
|
|
|
free(tinfo);
|
2008-10-25 00:02:50 +00:00
|
|
|
exit(EXIT_SUCCESS);
|
|
|
|
}
|
|
|
|
.fi
|
|
|
|
.SH SEE ALSO
|
sched_get_priority_max.2, sched_setparam.2, sched_setaffinity.2, sched_setscheduler.2, timer_create.2, malloc.3, pthread_attr_init.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_getattr_np.3, pthread_cancel.3, pthread_create.3, pthread_setschedparam.3, pthread_setschedprio.3, aio.7, time.7: Global ffix: disable justification and hyphenation in SEE ALSO
For a better visual result, disable justification and hyphenation
in SEE ALSO where page names are long.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-09-25 04:34:17 +00:00
|
|
|
.ad l
|
|
|
|
.nh
|
2008-10-25 00:02:50 +00:00
|
|
|
.BR getrlimit (2),
|
|
|
|
.BR pthread_attr_init (3),
|
|
|
|
.BR pthread_cancel (3),
|
|
|
|
.BR pthread_detach (3),
|
|
|
|
.BR pthread_equal (3),
|
|
|
|
.BR pthread_exit (3),
|
|
|
|
.BR pthread_getattr_np (3),
|
|
|
|
.BR pthread_join (3),
|
|
|
|
.BR pthread_self (3),
|
|
|
|
.BR pthreads (7)
|