xref: /illumos-gate/usr/src/man/man3lgrp/lgrp_parents.3lgrp (revision 14b24e2b79293068c8e016a69ef1d872fb5e2fd5)
te
Copyright (c) 2003, 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_PARENTS 3LGRP "Apr 16, 2003"
NAME
lgrp_parents - get parents of given lgroup
SYNOPSIS

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

int lgrp_parents(lgrp_cookie_t cookie, lgrp_id_t child,
 lgrp_id_t *lgrp_array, uint_t lgrp_array_size);
DESCRIPTION

The lgrp_parents() function takes a cookie representing a snapshot of the lgroup hierarchy obtained from lgrp_init(3LGRP) and returns the number of parent lgroups of the specified lgroup. If lgrp_array is non-null and the lgrp_array_size is non-zero, the array is filled with as many of the parent lgroup IDs as will fit given the size of the array. For the root lgroup, the number of parents returned is 0 and the lgrp_array argument is not filled in.

RETURN VALUES

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

ERRORS

The lgrp_parents() function will fail if: EINVAL

The specified cookie or lgroup ID is not valid.

ESRCH

The specified lgroup ID was not found.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe
SEE ALSO

lgrp_children(3LGRP), lgrp_init(3LGRP), lgrp_nlgrps(3LGRP), liblgrp(3LIB), attributes(5)