LGRP_ROOT(3LGRP) Locality Group Library Functions LGRP_ROOT(3LGRP)
lgrp_root - return root lgroup ID
cc [ flag ... ] file... -llgrp [ library ... ]
#include <sys/lgrp_user.h>
lgrp_id_t lgrp_root(lgrp_cookie_t cookie);
The lgrp_root() function returns the root lgroup ID.
Upon successful completion, lgrp_root() returns the lgroup ID of the
root lgroup. Otherwise, it returns -1 and sets errno to indicate the
error.
The lgrp_root() function will fail if:
EINVAL
The cookie is not valid.
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+
lgrp_children(3LGRP), lgrp_init(3LGRP), lgrp_nlgrps(3LGRP),
lgrp_parents(3LGRP), liblgrp(3LIB), attributes(7)
January 31, 2008 LGRP_ROOT(3LGRP)
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(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+
SEE ALSO
lgrp_children(3LGRP), lgrp_init(3LGRP), lgrp_nlgrps(3LGRP),
lgrp_parents(3LGRP), liblgrp(3LIB), attributes(7)
January 31, 2008 LGRP_ROOT(3LGRP)