d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Finally! Document all undocumented functions in libc_r.

Browse Source 
Add manual pages for following functions:

. pthread_attr_setcreatesuspend_np(3)
. pthread_main_np(3)
. pthread_multi_np(3)
. pthread_single_np(3)
. pthread_mutexattr_getkind_np(3)
. pthread_mutexattr_setkind_np(3)
. pthread_resume_all_np(3)
. pthread_resume_np(3)
. pthread_set_name_np(3)
. pthread_suspend_all_np(3)
. pthread_suspend_np(3)
. pthread_switch_add_np(3)
. pthread_switch_delete_np(3)

MFC after:	3 days
This commit is contained in:
Alexey Zelkin 2003-02-13 22:10:10 +00:00
parent 1e514ebb71
commit 318d8cfd73
20 changed files with 1392 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
lib/libc_r/man/pthread_attr_setcreatesuspend_np.3 Normal file
View File

@ -0,0 +1,74 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_ATTR_SETCREATESUSPEND_NP 3
.Os
.Sh NAME
.Nm pthread_attr_setcreatesuspend_np
.Nd prepare attribute for creattion of suspended thread
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_attr_setcreatesuspend_np "pthread_attr_t *attr"
.Sh DESCRIPTION
The
.Fn pthread_attr_setcreatesuspend_np
instructs
.Fn pthread_create
that thread created with attribute
.Fa attr
should be created and left in suspended state until explicit resume call (by
.Fn pthread_resume_np
or
.Fn pthread_resume_all_np
function.)
.Sh RETURN VALUES
.Rv -std pthread_attr_setcreatesuspend_np
.Sh ERRORS
The
.Fn pthread_attr_setcreatesuspend_np
function will fail if:
.Bl -tag -witdh Er
.It Bq Er EINVAL
The value specified by
.Fa attr
is invalid
.El
.Sh SEE ALSO
.Xr pthread_attr_init 3 ,
.Xr pthread_attr_destroy 3 ,
.Xr pthread_create 3 ,
.Xr pthread_resume_all_np 3 ,
.Xr pthread_resume_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

67
lib/libc_r/man/pthread_main_np.3 Normal file
View File

@ -0,0 +1,67 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_MAIN_NP 3
.Os
.Sh NAME
.Nm pthread_main_np
.Nd identify the initial thread
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_main_np "void"
.Sh DESCRIPTION
The
.Fn pthread_main_np
is used in userland threads environment to identify initial thread.
Its semantics is similar to Solaris's
.Fn thr_main
function.
.Sh RETURN VALUES
The
.Fn pthread_main_np
function returns one of the following:
.Bl -tag
.It 1
if the calling thread is the initial thread
.It 0
if the calling thread is not the initial thread
.It -1
if threads initialization has not completed
.El
.Sh SEE ALSO
.Xr pthread_create 3 ,
.Xr pthread_equal 3 ,
.Xr pthread_self 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

64
lib/libc_r/man/pthread_multi_np.3 Normal file
View File

@ -0,0 +1,64 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_MULTI_NP 3
.Os
.Sh NAME
.Nm pthread_multi_np ,
.Nm pthread_single_np
.Nd switch betwen multi- and single-threaded scheduling modes
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_multi_np "void"
.Ft int
.Fn pthread_single_np "void"
.Sh DESCRIPTION
The
.Fn pthread_single_np
function call switches process to single-threaded mode, i.e.
suspend all threads except current.
Semantic of this function is similar to
.Fn pthread_suspend_all_np .
.Pp
The
.Fn pthread_multi_np
function call switches process to multi-threaded mode, entered by
.Fn pthread_single_np
Semantic of this function is similar to
.Fn pthread_resume_all_np .
.Sh SEE ALSO
.Xr pthread_resume_all_np 3 ,
.Xr pthread_single_all_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

84
lib/libc_r/man/pthread_mutexattr_getkind_np.3 Normal file
View File

@ -0,0 +1,84 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_MUTEXATTR_GETKIND_NP 3
.Os
.Sh NAME
.Nm pthread_mutexattr_getkind_np ,
.Nm pthread_mutexattr_setkind_np
.Nd mutex attribute operations (LEGACY)
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_mutexattr_getkind_np "pthread_mutexattr_t attr"
.Ft int
.Fn pthread_mutexattr_setkind_np "pthread_mutexattr_t *attr" "int kind"
.Sh DESCRIPTION
These functions are DEPRECATED and NON-PORTABLE implementation of mutex types
manipulation.
.Pp
It's recomended to use
.Fn pthread_mutexattr_gettype
and
.Fn pthread_mutexattr_settype
functions instead.
.Sh RETURN VALUES
The
.Fn pthread_mutexattr_getkind_np
function returns positive value representing
.Ft kind
of mutex attribute
.Fa attr
if successful; otherwise the value -1 is returned and the global variable
.Fa errno
is set to indicate the error.
.Pp
The
.Fn pthread_mutexattr_settype
function returns the value 0 if successful; otherwise
the value -1 is returned and the global variable
.Fa errno
is set to indicate the error.
.Sh ERRORS
The
.Fn pthread_mutexattr_getkind_np
and
.Fn pthread_mutexattr_setkind_np
functions will fail if:
.Bl -tag -witdh Er
.It Bq Er EINVAL
The value specified by
.Fa attr
is invalid
.El
.Sh SEE ALSO
.Xr pthread_mutex_create 3 ,
.Xr pthread_mutex_destroy 3 ,
.Xr pthread_mutexattr_gettype 3 ,
.Xr pthread_mutexattr_settype 3

55
lib/libc_r/man/pthread_resume_all_np.3 Normal file
View File

@ -0,0 +1,55 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_RESUME_ALL_NP 3
.Os
.Sh NAME
.Nm pthread_resume_all_np
.Nd resume all suspended threads
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft void
.Fn pthread_resume_all_np "void"
.Sh DESCRIPTION
The
.Fn pthread_resume_all_np
function call causes all active thread to be scanned
and resume those which were suspended previously.
.Sh SEE ALSO
.Xr pthread_attr_setcreatesuspend_np 3 ,
.Xr pthread_resume_np 3 ,
.Xr pthread_suspend_all_np 3 ,
.Xr pthread_suspend_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

76
lib/libc_r/man/pthread_resume_np.3 Normal file
View File

@ -0,0 +1,76 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_RESUME_NP 3
.Os
.Sh NAME
.Nm pthread_resume_np
.Nd resume suspended thread
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_resume_np "pthread_t tid"
.Sh DESCRIPTION
The
.Fn pthread_resume_np
function called on suspended thread cause it to resume.
If thread specified by
.Fa tid
argument is not suspended, no actions will be performed.
.Sh RETURN VALUES
If successful,
.Fn pthread_resume_np
function returns 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
The
.Fn pthread_resume_np
function will fail if:
.Bl -tag -witdh Er
.It Bq Er EINVAL
The value specified by
.Fa tid
is invalid
.It Bq ESRC
No thread could be found corresponding to thread ID specified by
.Fa tid
argument.
.El
.Sh SEE ALSO
.Xr pthread_attr_setcreatesuspend_np 3 ,
.Xr pthread_resume_all_np 3 ,
.Xr pthread_suspend_all_np 3 ,
.Xr pthread_suspend_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

59
lib/libc_r/man/pthread_set_name_np.3 Normal file
View File

@ -0,0 +1,59 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_SET_NAME_NP 3
.Os
.Sh NAME
.Nm pthread_set_name_np
.Nd set the thread name
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft void
.Fn pthread_set_name_np "pthread_t tid" "const char *name"
.Sh DESCRIPTION
The
.Fn pthread_set_name_np
function sets internal name for thread specified by
.Fa tid
argument to string value specified by
.Fa name
argument.
.Pp
This is rather debuging interface and using it at day-by-day basis makes
no sense.
.Sh ERRORS
Because of debuging orientation of this function all errors that may
appear inside are sliently ignored.
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

56
lib/libc_r/man/pthread_suspend_all_np.3 Normal file
View File

@ -0,0 +1,56 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_SUSPEND_ALL_NP 3
.Os
.Sh NAME
.Nm pthread_suspend_all_np
.Nd suspend all active threads
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft void
.Fn pthread_suspend_all_np "void"
.Sh DESCRIPTION
The
.Fn pthread_suspend_all_np
function call causes all active thread to be suspended.
The only exception is current thread, i.e. thread which called
.Fn pthread_suspend_all_np
function.
.Sh SEE ALSO
.Xr pthread_resume_all_np 3 ,
.Xr pthread_resume_np 3 ,
.Xr pthread_suspend_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

74
lib/libc_r/man/pthread_suspend_np.3 Normal file
View File

@ -0,0 +1,74 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_SUSPEND_NP 3
.Os
.Sh NAME
.Nm pthread_suspend_np
.Nd suspend a thread
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_suspend_np "pthread_t tid"
.Sh DESCRIPTION
The
.Fn pthread_suspend_np
function called on active thread cause it to suspend.
.Sh RETURN VALUES
If successful,
.Fn pthread_suspend_np
function returns 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
The
.Fn pthread_suspend_np
function will fail if:
.Bl -tag -witdh Er
.It Bq Er EDEADLK
Attempt to suspend current thread
.It Bq Er EINVAL
The value specified by
.Fa tid
is invalid
.It Bq ESRC
No thread could be found corresponding to thread ID specified by
.Fa tid
argument.
.El
.Sh SEE ALSO
.Xr pthread_resume_all_np 3 ,
.Xr pthread_resume_np 3 ,
.Xr pthread_suspend_all_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

87
lib/libc_r/man/pthread_switch_add_np.3 Normal file
View File

@ -0,0 +1,87 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_SWITCH_ADD_NP 3
.Os
.Sh NAME
.Nm pthread_switch_add_np ,
.Nm pthread_switch_delete_np
.Nd threads context switches debugging primitives
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_switch_add_np "pthread_switch_routine_t routine"
.Ft int
.Fn pthread_switch_delete_np "pthread_switch_routine_t routine"
.Sh DESCRIPTION
The application is allowed to monitor thread context switches inside
threading library.
An application can install routine that gets called everytime a thread
(explicitly created by the application with
.Fn pthread_create
function) gets context switched.
This routine gets passed the pthread IDs of the threads that are
being switched in and out.
Installation and removal of these hooks may be done using
.Fn pthread_switch_add_np
and
.Fn pthread_switch_delete_np
functions respectively.
.Sh RETURN VALUES
If successful,
functions return 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
The
.Fn pthread_switch_add_np
may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
NULL pointer passed as
.Fa routine
argument.
.El
The
.Fn pthread_switch_delete_np
may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa routine
argument is different from argument previously passed to
.Fn pthread_switch_add_np
.El
.Sh SEE ALSO
.Xr pthread_create 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

74
share/man/man3/pthread_attr_setcreatesuspend_np.3 Normal file
View File

@ -0,0 +1,74 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_ATTR_SETCREATESUSPEND_NP 3
.Os
.Sh NAME
.Nm pthread_attr_setcreatesuspend_np
.Nd prepare attribute for creattion of suspended thread
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_attr_setcreatesuspend_np "pthread_attr_t *attr"
.Sh DESCRIPTION
The
.Fn pthread_attr_setcreatesuspend_np
instructs
.Fn pthread_create
that thread created with attribute
.Fa attr
should be created and left in suspended state until explicit resume call (by
.Fn pthread_resume_np
or
.Fn pthread_resume_all_np
function.)
.Sh RETURN VALUES
.Rv -std pthread_attr_setcreatesuspend_np
.Sh ERRORS
The
.Fn pthread_attr_setcreatesuspend_np
function will fail if:
.Bl -tag -witdh Er
.It Bq Er EINVAL
The value specified by
.Fa attr
is invalid
.El
.Sh SEE ALSO
.Xr pthread_attr_init 3 ,
.Xr pthread_attr_destroy 3 ,
.Xr pthread_create 3 ,
.Xr pthread_resume_all_np 3 ,
.Xr pthread_resume_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

67
share/man/man3/pthread_main_np.3 Normal file
View File

@ -0,0 +1,67 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_MAIN_NP 3
.Os
.Sh NAME
.Nm pthread_main_np
.Nd identify the initial thread
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_main_np "void"
.Sh DESCRIPTION
The
.Fn pthread_main_np
is used in userland threads environment to identify initial thread.
Its semantics is similar to Solaris's
.Fn thr_main
function.
.Sh RETURN VALUES
The
.Fn pthread_main_np
function returns one of the following:
.Bl -tag
.It 1
if the calling thread is the initial thread
.It 0
if the calling thread is not the initial thread
.It -1
if threads initialization has not completed
.El
.Sh SEE ALSO
.Xr pthread_create 3 ,
.Xr pthread_equal 3 ,
.Xr pthread_self 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

64
share/man/man3/pthread_multi_np.3 Normal file
View File

@ -0,0 +1,64 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_MULTI_NP 3
.Os
.Sh NAME
.Nm pthread_multi_np ,
.Nm pthread_single_np
.Nd switch betwen multi- and single-threaded scheduling modes
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_multi_np "void"
.Ft int
.Fn pthread_single_np "void"
.Sh DESCRIPTION
The
.Fn pthread_single_np
function call switches process to single-threaded mode, i.e.
suspend all threads except current.
Semantic of this function is similar to
.Fn pthread_suspend_all_np .
.Pp
The
.Fn pthread_multi_np
function call switches process to multi-threaded mode, entered by
.Fn pthread_single_np
Semantic of this function is similar to
.Fn pthread_resume_all_np .
.Sh SEE ALSO
.Xr pthread_resume_all_np 3 ,
.Xr pthread_single_all_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

84
share/man/man3/pthread_mutexattr_getkind_np.3 Normal file
View File

@ -0,0 +1,84 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_MUTEXATTR_GETKIND_NP 3
.Os
.Sh NAME
.Nm pthread_mutexattr_getkind_np ,
.Nm pthread_mutexattr_setkind_np
.Nd mutex attribute operations (LEGACY)
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_mutexattr_getkind_np "pthread_mutexattr_t attr"
.Ft int
.Fn pthread_mutexattr_setkind_np "pthread_mutexattr_t *attr" "int kind"
.Sh DESCRIPTION
These functions are DEPRECATED and NON-PORTABLE implementation of mutex types
manipulation.
.Pp
It's recomended to use
.Fn pthread_mutexattr_gettype
and
.Fn pthread_mutexattr_settype
functions instead.
.Sh RETURN VALUES
The
.Fn pthread_mutexattr_getkind_np
function returns positive value representing
.Ft kind
of mutex attribute
.Fa attr
if successful; otherwise the value -1 is returned and the global variable
.Fa errno
is set to indicate the error.
.Pp
The
.Fn pthread_mutexattr_settype
function returns the value 0 if successful; otherwise
the value -1 is returned and the global variable
.Fa errno
is set to indicate the error.
.Sh ERRORS
The
.Fn pthread_mutexattr_getkind_np
and
.Fn pthread_mutexattr_setkind_np
functions will fail if:
.Bl -tag -witdh Er
.It Bq Er EINVAL
The value specified by
.Fa attr
is invalid
.El
.Sh SEE ALSO
.Xr pthread_mutex_create 3 ,
.Xr pthread_mutex_destroy 3 ,
.Xr pthread_mutexattr_gettype 3 ,
.Xr pthread_mutexattr_settype 3

55
share/man/man3/pthread_resume_all_np.3 Normal file
View File

@ -0,0 +1,55 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_RESUME_ALL_NP 3
.Os
.Sh NAME
.Nm pthread_resume_all_np
.Nd resume all suspended threads
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft void
.Fn pthread_resume_all_np "void"
.Sh DESCRIPTION
The
.Fn pthread_resume_all_np
function call causes all active thread to be scanned
and resume those which were suspended previously.
.Sh SEE ALSO
.Xr pthread_attr_setcreatesuspend_np 3 ,
.Xr pthread_resume_np 3 ,
.Xr pthread_suspend_all_np 3 ,
.Xr pthread_suspend_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

76
share/man/man3/pthread_resume_np.3 Normal file
View File

@ -0,0 +1,76 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_RESUME_NP 3
.Os
.Sh NAME
.Nm pthread_resume_np
.Nd resume suspended thread
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_resume_np "pthread_t tid"
.Sh DESCRIPTION
The
.Fn pthread_resume_np
function called on suspended thread cause it to resume.
If thread specified by
.Fa tid
argument is not suspended, no actions will be performed.
.Sh RETURN VALUES
If successful,
.Fn pthread_resume_np
function returns 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
The
.Fn pthread_resume_np
function will fail if:
.Bl -tag -witdh Er
.It Bq Er EINVAL
The value specified by
.Fa tid
is invalid
.It Bq ESRC
No thread could be found corresponding to thread ID specified by
.Fa tid
argument.
.El
.Sh SEE ALSO
.Xr pthread_attr_setcreatesuspend_np 3 ,
.Xr pthread_resume_all_np 3 ,
.Xr pthread_suspend_all_np 3 ,
.Xr pthread_suspend_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

59
share/man/man3/pthread_set_name_np.3 Normal file
View File

@ -0,0 +1,59 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_SET_NAME_NP 3
.Os
.Sh NAME
.Nm pthread_set_name_np
.Nd set the thread name
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft void
.Fn pthread_set_name_np "pthread_t tid" "const char *name"
.Sh DESCRIPTION
The
.Fn pthread_set_name_np
function sets internal name for thread specified by
.Fa tid
argument to string value specified by
.Fa name
argument.
.Pp
This is rather debuging interface and using it at day-by-day basis makes
no sense.
.Sh ERRORS
Because of debuging orientation of this function all errors that may
appear inside are sliently ignored.
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

56
share/man/man3/pthread_suspend_all_np.3 Normal file
View File

@ -0,0 +1,56 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_SUSPEND_ALL_NP 3
.Os
.Sh NAME
.Nm pthread_suspend_all_np
.Nd suspend all active threads
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft void
.Fn pthread_suspend_all_np "void"
.Sh DESCRIPTION
The
.Fn pthread_suspend_all_np
function call causes all active thread to be suspended.
The only exception is current thread, i.e. thread which called
.Fn pthread_suspend_all_np
function.
.Sh SEE ALSO
.Xr pthread_resume_all_np 3 ,
.Xr pthread_resume_np 3 ,
.Xr pthread_suspend_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

74
share/man/man3/pthread_suspend_np.3 Normal file
View File

@ -0,0 +1,74 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_SUSPEND_NP 3
.Os
.Sh NAME
.Nm pthread_suspend_np
.Nd suspend a thread
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_suspend_np "pthread_t tid"
.Sh DESCRIPTION
The
.Fn pthread_suspend_np
function called on active thread cause it to suspend.
.Sh RETURN VALUES
If successful,
.Fn pthread_suspend_np
function returns 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
The
.Fn pthread_suspend_np
function will fail if:
.Bl -tag -witdh Er
.It Bq Er EDEADLK
Attempt to suspend current thread
.It Bq Er EINVAL
The value specified by
.Fa tid
is invalid
.It Bq ESRC
No thread could be found corresponding to thread ID specified by
.Fa tid
argument.
.El
.Sh SEE ALSO
.Xr pthread_resume_all_np 3 ,
.Xr pthread_resume_np 3 ,
.Xr pthread_suspend_all_np 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org

87
share/man/man3/pthread_switch_add_np.3 Normal file
View File

@ -0,0 +1,87 @@
.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd February 13, 2003
.Dt PTHREAD_SWITCH_ADD_NP 3
.Os
.Sh NAME
.Nm pthread_switch_add_np ,
.Nm pthread_switch_delete_np
.Nd threads context switches debugging primitives
.Sh LIBRARY
.Lb libc_r
.Sh SYNOPSIS
.In pthread_np.h
.Ft int
.Fn pthread_switch_add_np "pthread_switch_routine_t routine"
.Ft int
.Fn pthread_switch_delete_np "pthread_switch_routine_t routine"
.Sh DESCRIPTION
The application is allowed to monitor thread context switches inside
threading library.
An application can install routine that gets called everytime a thread
(explicitly created by the application with
.Fn pthread_create
function) gets context switched.
This routine gets passed the pthread IDs of the threads that are
being switched in and out.
Installation and removal of these hooks may be done using
.Fn pthread_switch_add_np
and
.Fn pthread_switch_delete_np
functions respectively.
.Sh RETURN VALUES
If successful,
functions return 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
The
.Fn pthread_switch_add_np
may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
NULL pointer passed as
.Fa routine
argument.
.El
The
.Fn pthread_switch_delete_np
may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa routine
argument is different from argument previously passed to
.Fn pthread_switch_add_np
.El
.Sh SEE ALSO
.Xr pthread_create 3
.Sh AUTHORS
The
.Nm
manpage was written by
.An Alexey Zelkin
.Aq phantom@FreeBSD.org