'\" te
.\" Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
.TH lgrp_cpus 3LGRP "18 Jun 2012" "SunOS 5.11" "Locality Group Library Functions"
.SH NAME
lgrp_cpus \- get CPU IDs contained in specified lgroup
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-llgrp\fR [ \fIlibrary\fR\&.\|.\|. ] 
#include <sys/lgrp_user.h>

\fBint\fR \fBlgrp_cpus\fR(\fBlgrp_cookie_t\fR \fIcookie\fR, \fBlgrp_id_t\fR \fIlgrp\fR,
     \fBprocessorid_t *\fR\fIcpuids\fR, \fBuint_t\fR \fIcount\fR, \fBint\fR \fIcontent\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBlgrp_cpus()\fR function takes a \fIcookie\fR representing a snapshot of the lgroup hierarchy obtained from \fBlgrp_init\fR(3LGRP) and returns the number of CPUs in the lgroup specified by \fIlgrp\fR. If both the \fIcpuids\fR[] argument is non-null and the count is non-zero, \fBlgrp_cpus()\fR stores up to the specified count of CPU IDs into the \fIcpuids\fR[] array.
.sp
.LP
The \fIcontent\fR argument should be set to one of the following values to specify whether the direct contents or everything in this lgroup should be returned:
.sp
.in +2
.nf
LGRP_CONTENT_ALL        /* everything in this lgroup */
LGRP_CONTENT_DIRECT     /* directly contained in lgroup */
LGRP_CONTENT_HIERARCHY  /* everything within this hierarchy (for 
                           compatibility only, use LGRP_CONTENT_ALL) */
.fi
.in -2

.sp
.LP
The \fBLGRP_CONTENT_HIERARCHY\fR value can still be used, but is being replaced by \fBLGRP_CONTENT_ALL\fR.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, the number of CPUs in the given lgroup is returned. Otherwise, \(mi1 is returned and \fBerrno\fR is set to indicate the error.
.SH ERRORS
.sp
.LP
The \fBlgrp_cpus()\fR function will fail if:
.sp
.ne 2
.mk
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
.rt  
The specified cookie is \fINULL\fR, or the lgroup ID or one of the flags is not valid.
.RE

.sp
.ne 2
.mk
.na
\fB\fBESRCH\fR\fR
.ad
.RS 10n
.rt  
The specified lgroup ID was not found.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBlgrp_init\fR(3LGRP), \fBlgrp_mem_size\fR(3LGRP), \fBlgrp_resources\fR(3LGRP), \fBliblgrp\fR(3LIB), \fBattributes\fR(5)