Document td_map_pth2thr(3) from libpthread_dbg(3)

td_map_pth2thr - convert the pthread_t to a thread handle

Sponsored by <The NetBSD Foundation>
This commit is contained in:
kamil 2016-11-22 03:52:01 +00:00
parent a5466eb716
commit 7b8609d5c0
4 changed files with 79 additions and 4 deletions

View File

@ -1,4 +1,4 @@
# $NetBSD: mi,v 1.2073 2016/11/22 01:49:36 kamil Exp $
# $NetBSD: mi,v 1.2074 2016/11/22 03:52:01 kamil Exp $
#
# Note: don't delete entries from here - mark them as "obsolete" instead.
./etc/mtree/set.comp comp-sys-root
@ -9364,6 +9364,7 @@
./usr/share/man/cat3/tcsetpgrp.0 comp-c-catman .cat
./usr/share/man/cat3/td_close.0 comp-c-catman .cat
./usr/share/man/cat3/td_open.0 comp-c-catman .cat
./usr/share/man/cat3/td_map_pth2thr.0 comp-c-catman .cat
./usr/share/man/cat3/td_thr_getname.0 comp-c-catman .cat
./usr/share/man/cat3/td_thr_info.0 comp-c-catman .cat
./usr/share/man/cat3/td_thr_iter.0 comp-c-catman .cat
@ -16625,6 +16626,7 @@
./usr/share/man/html3/tcsetpgrp.html comp-c-htmlman html
./usr/share/man/html3/td_close.html comp-c-htmlman html
./usr/share/man/html3/td_open.html comp-c-htmlman html
./usr/share/man/html3/td_map_pth2thr.html comp-c-htmlman html
./usr/share/man/html3/td_thr_getname.html comp-c-htmlman html
./usr/share/man/html3/td_thr_info.html comp-c-htmlman html
./usr/share/man/html3/td_thr_iter.html comp-c-htmlman html
@ -23947,6 +23949,7 @@
./usr/share/man/man3/tcsetpgrp.3 comp-c-man .man
./usr/share/man/man3/td_close.3 comp-c-man .man
./usr/share/man/man3/td_open.3 comp-c-man .man
./usr/share/man/man3/td_map_pth2thr.3 comp-c-man .man
./usr/share/man/man3/td_thr_getname.3 comp-c-man .man
./usr/share/man/man3/td_thr_info.3 comp-c-man .man
./usr/share/man/man3/td_thr_iter.3 comp-c-man .man

View File

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.15 2016/11/22 01:49:36 kamil Exp $
# $NetBSD: Makefile,v 1.16 2016/11/22 03:52:01 kamil Exp $
#
WARNS?= 5
@ -42,6 +42,7 @@ INCSDIR=/usr/include
MAN+= pthread_dbg.3
MAN+= td_open.3
MAN+= td_map_pth2thr.3
MAN+= td_thr_getname.3
MAN+= td_thr_info.3
MAN+= td_thr_iter.3

View File

@ -1,4 +1,4 @@
.\" $NetBSD: pthread_dbg.3,v 1.2 2016/11/22 01:49:36 kamil Exp $
.\" $NetBSD: pthread_dbg.3,v 1.3 2016/11/22 03:52:01 kamil Exp $
.\"
.\"
.\" Copyright (c) 2016 The NetBSD Foundation, Inc.
@ -102,10 +102,11 @@ functions:
The following functions comprise the core of the
.Nm
library:
.Bl -column -offset indent "td_thr_getname(3)" "iterate over the threads in the process"
.Bl -column -offset indent "td_thr_getname(3)" "convert the pthread_t to a thread handle"
.It Sy Function Ta Sy Description
.It Xr td_close 3 Ta close connection to a threaded process
.It Xr td_open 3 Ta make connection to a threaded process
.It Xr td_map_pth2thr 3 Ta convert the pthread_t to a thread handle
.It Xr td_thr_getname 3 Ta get the user-assigned name of a thread
.It Xr td_thr_info 3 Ta get information on a thread
.It Xr td_thr_iter 3 Ta iterate over the threads in the process

View File

@ -0,0 +1,70 @@
.\" $NetBSD: td_map_pth2thr.3,v 1.1 2016/11/22 03:52:01 kamil Exp $
.\"
.\" Copyright (c) 2016 The NetBSD Foundation, Inc.
.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
.\"
.Dd November 22, 2016
.Dt TD_MAP_PTH2THR 3
.Os
.Sh NAME
.Nm td_map_pth2thr
.Nd convert the pthread_t to a thread handle
.Sh LIBRARY
.Lb libpthread_dbg
.Sh SYNOPSIS
.In pthread_dbg.h
.Ft int
.Fn td_thr_getname "td_proc_t *proc" "pthread_t thread" "td_thread_t **threadp"
.Sh DESCRIPTION
The
.Nm
function converts
.Ta POSIX
thread
.Fa thread
to
.Xr pthread_dbg 3
specific thread passed in the
.Fa threadp
argument.
.Sh RETURN VALUES
If successful, the
.Nm
function will return
.Dv TD_ERR_OK .
Otherwise an error number will be returned to indicate failure as described in
.Xr pthread_dbg 3 .
.Sh SEE ALSO
.Xr pthread 3 ,
.Xr pthread_dbg 3
.Sh HISTORY
The
.Nm
function first appeared in
.Nx 2.0 .
.Sh AUTHORS
.An Nathan J. Williams Aq Mt nathanw@NetBSD.org
.Pp
This manual page was written by
.An Kamil Rytarowski Aq Mt kamil@NetBSD.org .