usr/src/man/man3c_db/td_ta_map_addr2sync.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_ADDR2SYNC 3C_DB "Oct 20, 1998"
   7 .SH NAME
   8 td_ta_map_addr2sync \- get a synchronization object handle from a
   9 synchronization object's address
  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_addr2sync\fR(\fBconst td_thragent_t *\fR\fIta_p\fR, \fBpsaddr_t\fR \fIaddr\fR, \fBtd_synchandle_t *\fR\fIsh_p\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBtd_ta_map_addr2sync()\fR function produces the synchronization object
  24 handle of type \fBtd_synchandle_t\fR that corresponds to the address of the
  25 synchronization object (mutex, semaphore, condition variable, or reader/writer
  26 lock). Some effort is made to validate \fIaddr\fR and verify that it does
  27 indeed point at a synchronization object. The handle is returned in
  28 *\fIsh_p\fR.
  29 .SH RETURN VALUES
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fBTD_OK\fR\fR
  34 .ad
  35 .RS 13n
  36 The call completed successfully.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBTD_BADTA\fR\fR
  43 .ad
  44 .RS 13n
  45 An invalid internal process handle was passed.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBTD_BADPH\fR\fR
  52 .ad
  53 .RS 13n
  54 There is a \fINULL\fR external process handle associated with this internal
  55 process handle.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBTD_BADSH\fR\fR
  62 .ad
  63 .RS 13n
  64 The \fIsh_p\fR argument is  \fINULL\fR or \fIaddr\fR does not appear to point
  65 to a valid synchronization object.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBTD_DBERR\fR \fR
  72 .ad
  73 .RS 13n
  74 A call to one of the imported interface routines failed.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBTD_ERR\fR \fR
  81 .ad
  82 .RS 13n
  83 \fBaddr\fR is  \fINULL,\fR or a \fBlibc_db\fR internal error occurred.
  84 .RE
  85
  86 .SH ATTRIBUTES
  87 .sp
  88 .LP
  89 See \fBattributes\fR(5) for description of the following attributes:
  90 .sp
  91
  92 .sp
  93 .TS
  94 box;
  95 c | c
  96 l | l .
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 _
  99 MT-Level        Safe
 100 .TE
 101
 102 .SH SEE ALSO
 103 .sp
 104 .LP
 105 \fBlibc_db\fR(3LIB), \fBattributes\fR(5)