share/man/man3lib/liblgrp.3lib

   1 '\" te
   2 .\" Copyright (c) 2005, 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 LIBLGRP 3LIB "Jan 26, 2005"
   7 .SH NAME
   8 liblgrp \- locality group library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-llgrp\fR [ \fIlibrary\fR... ]
  13 #include <\fBsys/lgrp_user.h\fR>
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The functions in this library traverse the lgroup (locality group) hierarchy,
  20 discover its contents, and set a thread's affinity for an lgroup. A locality
  21 group represents the set of CPU-like and memory-like hardware devices that are
  22 at most some locality apart from each other.
  23 .SH INTERFACES
  24 .sp
  25 .LP
  26 The shared object \fBliblgrp.so.1\fR provides the public interfaces defined
  27 below. See \fBIntro\fR(3) for additional information on shared object
  28 interfaces.
  29 .sp
  30
  31 .sp
  32 .TS
  33 l l
  34 l l .
  35 \fBlgrp_affinity_get\fR \fBlgrp_affinity_set\fR
  36 \fBlgrp_children\fR     \fBlgrp_cookie_stale\fR
  37 \fBlgrp_cpus\fR \fBlgrp_fini\fR
  38 \fBlgrp_home\fR \fBlgrp_init\fR
  39 \fBlgrp_latency\fR      \fBlgrp_latency_cookie\fR
  40 \fBlgrp_mem_size\fR     \fBlgrp_nlgrps\fR
  41 \fBlgrp_parents\fR      \fBlgrp_resourcess\fR
  42 \fBlgrp_root\fR \fBlgrp_version\fR
  43 \fBlgrp_view\fR
  44 .TE
  45
  46 .SH FILES
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fB/usr/lib/liblgrp.so.1\fR\fR
  51 .ad
  52 .RS 28n
  53 shared object
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fB/usr/lib/64/liblgrp.so.1\fR\fR
  60 .ad
  61 .RS 28n
  62 64-bit shared object
  63 .RE
  64
  65 .SH ATTRIBUTES
  66 .sp
  67 .LP
  68 See \fBattributes\fR(5) for descriptions of the following attributes:
  69 .sp
  70
  71 .sp
  72 .TS
  73 box;
  74 c | c
  75 l | l .
  76 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  77 _
  78 Interface Stability     Evolving
  79 _
  80 MT-Level        MT-Safe
  81 .TE
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBIntro\fR(3), \fBlgrp_affinity_get\fR(3LGRP), \fBlgrp_children\fR(3LGRP),
  87 \fBlgrp_cookie_stale\fR(3LGRP), \fBlgrp_cpus\fR(3LGRP), \fBlgrp_fini\fR(3LGRP),
  88 \fBlgrp_home\fR(3LGRP), \fBlgrp_init\fR(3LGRP), \fBlgrp_latency\fR(3LGRP),
  89 \fBlgrp_mem_size\fR(3LGRP), \fBlgrp_nlgrps\fR(3LGRP),
  90 \fBlgrp_parents\fR(3LGRP), \fBlgrp_root\fR(3LGRP), \fBlgrp_version\fR(3LGRP),
  91 \fBlgrp_view\fR(3LGRP), \fBattributes\fR(5)