usr/src/man/man3c_db/td_ta_map_id2thr.3c_db

   1 '\" te
   2 .\"  Copyright (c) 1998 Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH TD_TA_MAP_ID2THR 3C_DB "Oct 20, 1998"
   7 .SH NAME
   8 td_ta_map_id2thr, td_ta_map_lwp2thr \- convert a thread ID or LWP ID to a
   9 thread handle
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR... ] \fIfile\fR... -lc_db [ \fIlibrary\fR... ]
  14 #include <proc_service.h>
  15 #include <thread_db.h>
  16
  17 \fB\fR\fBtd_ta_map_id2thr\fR(\fBconst td_thragent_t *\fR\fIta_p\fR, \fBthread_t tid,td_thrhandle_t *\fR\fIth_p\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fB\fR\fBtd_ta_map_lwp2thr\fR(\fBconst td_thragent_t *\fR\fIta_p\fR, \fBlwpid_t lwpid,td_thrhandle_t *\fR\fIth_p\fR);
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBtd_ta_map_id2thr()\fR function produces the \fBtd_thrhandle_t\fR thread
  29 handle that corresponds to a particular thread ID, as returned by
  30 \fBthr_create\fR(3C) or \fBthr_self\fR(3C). The thread handle is returned in
  31 *\fIth_p\fR.
  32 .sp
  33 .LP
  34 The \fBtd_ta_map_lwp2thr()\fR function produces the \fBtd_thrhandle_t\fR thread
  35 handle for the thread that is currently executing on the light weight process (
  36 \fBLWP\fR) and has an ID of \fBlwpid\fR.
  37 .SH RETURN VALUES
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBTD_OK\fR\fR
  42 .ad
  43 .RS 12n
  44 The call completed successfully.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBTD_BADTA\fR\fR
  51 .ad
  52 .RS 12n
  53 An invalid internal process handle was passed in.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBTD_BADPH\fR\fR
  60 .ad
  61 .RS 12n
  62 There is a  \fINULL\fR external process handle associated with this internal
  63 process handle.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBTD_DBERR\fR\fR
  70 .ad
  71 .RS 12n
  72 A call to one of the imported interface routines failed.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBTD_NOTHR\fR\fR
  79 .ad
  80 .RS 12n
  81 Either there is no thread with the given thread ID ( \fBtd_ta_map_id2thr\fR) or
  82 no thread is currently executing on the given \fBLWP\fR (
  83 \fBtd_ta_map_lwp2thr\fR).
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBTD_ERR\fR\fR
  90 .ad
  91 .RS 12n
  92 The call did not complete successfully.
  93 .RE
  94
  95 .SH ATTRIBUTES
  96 .sp
  97 .LP
  98 See \fBattributes\fR(5) for description of the following attributes:
  99 .sp
 100
 101 .sp
 102 .TS
 103 box;
 104 c | c
 105 l | l .
 106 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 107 _
 108 MT-Level        Safe
 109 .TE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBlibc_db\fR(3LIB), \fBthr_create\fR(3C), \fBthr_self\fR(3C),
 115 \fBattributes\fR(5)