share/man/man3lgrp/lgrp_cpus.3lgrp

   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 LGRP_CPUS 3LGRP "Jan 26, 2005"
   7 .SH NAME
   8 lgrp_cpus \- get CPU IDs contained in specified lgroup
   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 \fBint\fR \fBlgrp_cpus\fR(\fBlgrp_cookie_t\fR \fIcookie\fR, \fBlgrp_id_t\fR \fIlgrp\fR,
  16      \fBprocessorid_t *\fR\fIcpuids\fR, \fBuint_t\fR \fIcount\fR, \fBint\fR \fIcontent\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBlgrp_cpus()\fR function takes a \fIcookie\fR representing a snapshot of
  23 the lgroup hierarchy obtained from \fBlgrp_init\fR(3LGRP) and returns the
  24 number of CPUs in the lgroup specified by \fIlgrp\fR. If both the
  25 \fIcpuids\fR[] argument is non-null and the count is non-zero,
  26 \fBlgrp_cpus()\fR stores up to the specified count of CPU IDs into the
  27 \fIcpuids\fR[] array.
  28 .sp
  29 .LP
  30 The \fIcontent\fR argument should be set to one of the following values to
  31 specify whether the direct contents or everything in this lgroup should be
  32 returned:
  33 .sp
  34 .in +2
  35 .nf
  36 LGRP_CONTENT_ALL        /* everything in this lgroup */
  37 LGRP_CONTENT_DIRECT     /* directly contained in lgroup */
  38 LGRP_CONTENT_HIERARCHY  /* everything within this hierarchy (for
  39                            compatibility only, use LGRP_CONTENT_ALL) */
  40 .fi
  41 .in -2
  42
  43 .sp
  44 .LP
  45 The \fBLGRP_CONTENT_HIERARCHY\fR value can still be used, but is being replaced
  46 by \fBLGRP_CONTENT_ALL\fR.
  47 .SH RETURN VALUES
  48 .sp
  49 .LP
  50 Upon successful completion, the number of CPUs in the given lgroup is returned.
  51 Otherwise, \(mi1 is returned and \fBerrno\fR is set to indicate the error.
  52 .SH ERRORS
  53 .sp
  54 .LP
  55 The \fBlgrp_cpus()\fR function will fail if:
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBEINVAL\fR\fR
  60 .ad
  61 .RS 10n
  62 The specified cookie, lgroup ID, or one of the flags is not valid.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBESRCH\fR\fR
  69 .ad
  70 .RS 10n
  71 The specified lgroup ID was not found.
  72 .RE
  73
  74 .SH ATTRIBUTES
  75 .sp
  76 .LP
  77 See \fBattributes\fR(5) for descriptions of the following attributes:
  78 .sp
  79
  80 .sp
  81 .TS
  82 box;
  83 c | c
  84 l | l .
  85 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  86 _
  87 Interface Stability     Evolving
  88 _
  89 MT-Level        MT-Safe
  90 .TE
  91
  92 .SH SEE ALSO
  93 .sp
  94 .LP
  95 \fBlgrp_init\fR(3LGRP), \fBlgrp_mem_size\fR(3LGRP),
  96 \fBlgrp_resources\fR(3LGRP), \fBliblgrp\fR(3LIB), \fBattributes\fR(5)