usr/src/man/man3lib/libkvm.3lib

   1 '\" te
   2 .\" Copyright (c) 2003, 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 LIBKVM 3LIB "May 22, 2003"
   7 .SH NAME
   8 libkvm \- Kernel Virtual Memory access library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lkvm\fR [ \fIlibrary\fR ... ]
  13 #include <\fBkvm.h\fR>
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 Functions in this library provide application access to kernel symbols,
  20 addresses and values. The individual functions are documented in Section 3KVM
  21 of the reference manual.
  22 .SH INTERFACES
  23 .sp
  24 .LP
  25 The shared object \fBlibkvm.so.1\fR provides the public interfaces defined
  26 below. See \fBIntro\fR(3) for additional information on shared object
  27 interfaces.
  28 .sp
  29
  30 .sp
  31 .TS
  32 l l
  33 l l .
  34 \fBkvm_close\fR \fBkvm_getcmd\fR
  35 \fBkvm_getproc\fR       \fBkvm_getu\fR
  36 \fBkvm_kread\fR \fBkvm_kwrite\fR
  37 \fBkvm_nextproc\fR      \fBkvm_nlist\fR
  38 \fBkvm_open\fR  \fBkvm_read\fR
  39 \fBkvm_setproc\fR       \fBkvm_uread\fR
  40 \fBkvm_uwrite\fR        \fBkvm_write\fR
  41 .TE
  42
  43 .SH FILES
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fB/usr/lib/libkvm.so.1\fR\fR
  48 .ad
  49 .RS 27n
  50 shared object
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fB/usr/lib/64/libkvm.so.1\fR\fR
  57 .ad
  58 .RS 27n
  59 64-bit shared object
  60 .RE
  61
  62 .SH ATTRIBUTES
  63 .sp
  64 .LP
  65 See \fBattributes\fR(7) for descriptions of the following attributes:
  66 .sp
  67
  68 .sp
  69 .TS
  70 box;
  71 c | c
  72 l | l .
  73 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  74 _
  75 Interface Stability     T{
  76 \fBkvm_read()\fR and \fBkvm_write()\fR  are Obsolete; the remaining functions are Stable.
  77 T}
  78 _
  79 MT-Level        Unsafe
  80 .TE
  81
  82 .SH SEE ALSO
  83 .sp
  84 .LP
  85 .BR pvs (1),
  86 .BR Intro (3),
  87 .BR attributes (7)