xref: /illumos-gate/usr/src/man/man3lgrp/lgrp_root.3lgrp (revision 7ffba875a0c7cf118aef7a2c9bfd00c3935e230a)
te
Copyright (c) 2008, 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_root 3LGRP "31 Jan 2008" "SunOS 5.11" "Locality Group Library Functions"
NAME
lgrp_root - return root lgroup ID
SYNOPSIS

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

lgrp_id_t lgrp_root(lgrp_cookie_t cookie);
DESCRIPTION

The lgrp_root() function returns the root lgroup ID.

RETURN VALUES

Upon successful completion, lgrp_root() returns the lgroup ID of the root lgroup. Otherwise, it returns -1 and sets errno to indicate the error.

ERRORS

The lgrp_root() function will fail if:

EINVAL

The cookie is not valid.

ATTRIBUTES

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

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

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