usr/src/man/man3lgrp/lgrp_view.3lgrp

   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 LGRP_VIEW 3LGRP "April 9, 2016"
   7 .SH NAME
   8 lgrp_view \- get view of lgroup hierarchy
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag \&.\|.\|.\fR ] \fIfile\fR\&.\|.\|. \fB-llgrp\fR [ \fIlibrary \&.\|.\|.\fR ]
  13 #include <sys/lgrp_user.h>
  14
  15 \fBlgrp_view_t\fR \fBlgrp_view\fR(\fBlgrp_cookie_t\fR \fIcookie\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .LP
  20 The \fBlgrp_view()\fR function takes a \fIcookie\fR representing the snapshot
  21 of the lgroup hierarchy obtained from \fBlgrp_init\fR(3LGRP) and returns the
  22 snapshot's view of the lgroup hierarchy.
  23 .sp
  24 .LP
  25 If the given view is \fBLGRP_VIEW_CALLER\fR, the snapshot contains only the
  26 resources that are available to the caller (such as those with respect to
  27 processor sets).  When the view is \fBLGRP_VIEW_OS\fR, the snapshot contains
  28 what is available to the operating system.
  29 .SH RETURN VALUES
  30 .LP
  31 Upon successful completion, \fBlgrp_view()\fR returns the view for the snapshot
  32 of the lgroup hierarchy represented by the given cookie.  Otherwise, \(mi1 is
  33 returned and \fBerrno\fR is set to indicate the error.
  34 .SH ERRORS
  35 .LP
  36 The \fBlgrp_view()\fR function will fail if:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBEINVAL\fR\fR
  41 .ad
  42 .RS 10n
  43 The \fIcookie\fR is not valid.
  44 .RE
  45
  46 .SH ATTRIBUTES
  47 .LP
  48 See \fBattributes\fR(5) for descriptions of the following attributes:
  49 .sp
  50
  51 .sp
  52 .TS
  53 box;
  54 c | c
  55 l | l .
  56 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  57 _
  58 Interface Stability     Evolving
  59 _
  60 MT-Level        MT-Safe
  61 .TE
  62
  63 .SH SEE ALSO
  64 .LP
  65 \fBlgrp_cookie_stale\fR(3LGRP), \fBlgrp_fini\fR(3LGRP), \fBlgrp_init\fR(3LGRP),
  66 \fBliblgrp\fR(3LIB), \fBattributes\fR(5)