xref: /titanic_52/usr/src/man/man3lgrp/lgrp_cpus.3lgrp (revision 6a1af1a67532df169a657cce07140be64bdea084)
te
Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
lgrp_cpus 3LGRP "26 Jan 2005" "SunOS 5.11" "Locality Group Library Functions"
NAME
lgrp_cpus - get CPU IDs contained in specified lgroup
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -llgrp [ library.\|.\|. ] 
#include <sys/lgrp_user.h>

int lgrp_cpus(lgrp_cookie_t cookie, lgrp_id_t lgrp,
 processorid_t *cpuids, uint_t count, int content);
DESCRIPTION

The lgrp_cpus() function takes a cookie representing a snapshot of the lgroup hierarchy obtained from lgrp_init(3LGRP) and returns the number of CPUs in the lgroup specified by lgrp. If both the cpuids[] argument is non-null and the count is non-zero, lgrp_cpus() stores up to the specified count of CPU IDs into the cpuids[] array.

The content argument should be set to one of the following values to specify whether the direct contents or everything in this lgroup should be returned:

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) */

The LGRP_CONTENT_HIERARCHY value can still be used, but is being replaced by LGRP_CONTENT_ALL.

RETURN VALUES

Upon successful completion, the number of CPUs in the given lgroup is returned. Otherwise, -1 is returned and errno is set to indicate the error.

ERRORS

The lgrp_cpus() function will fail if:

EINVAL

The specified cookie, lgroup ID, or one of the flags is not valid.

ESRCH

The specified lgroup ID was not found.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe
SEE ALSO

lgrp_init(3LGRP), lgrp_mem_size(3LGRP), lgrp_resources(3LGRP), liblgrp(3LIB), attributes(5)