xref: /titanic_50/usr/src/man/man3lgrp/lgrp_resources.3lgrp (revision 0e8139c7ae64247b4d7b4a98fdae6557f5ba0b40) 
 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_resources 3LGRP "26 Jan 2005" "SunOS 5.11" "Locality Group Library Functions"
 NAME
lgrp_resources - get lgroup resources of given lgroup

 SYNOPSIS


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

int lgrp_resources(lgrp_cookie_t cookie, lgrp_id_t lgrp,
 lgrp_id_t *lgrpids, uint_t count, lgrp_rsrc_t type);




 DESCRIPTION

The lgrp_resources() function takes a cookie representing a snapshot
of the lgroup hierarchy obtained from lgrp_init(3LGRP) and returns the
number of resources in the lgroup specified by lgrp. The resources are
represented by a set of lgroups in which each lgroup directly contains CPU
and/or memory resources.


The type argument should be set to one of the following values to specify
whether the CPU or memory resources should be returned:

LGRP_RSRC_CPU /* CPU resources */
LGRP_RSRC_MEM /* Memory resources */





If the lgrpids[] argument is non-null and the count argument is
non-zero, lgrp_resources() stores up to the specified count of lgroup IDs
into the lgrpids[] array.

 RETURN VALUES

Upon successful completion, lgrp_resources() returns the number of
lgroup resources. Otherwise, -1 is returned and errno is set to indicate
the error.

 ERRORS

The lgrp_resources() function will fail if:


EINVAL


The specified cookie, lgroup ID, or type 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_children(3LGRP), lgrp_init(3LGRP), lgrp_parents(3LGRP),
liblgrp(3LIB), attributes(5)