xref: /titanic_52/usr/src/man/man3lgrp/lgrp_cookie_stale.3lgrp (revision 353d0ed92f217f4451141e1efb06f10aa1a0f1a7) 
 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_cookie_stale 3LGRP "16 Apr 2003" "SunOS 5.11" "Locality Group Library Functions"
 NAME
lgrp_cookie_stale - determine whether snapshot of lgroup hierarchy is stale

 SYNOPSIS


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

int lgrp_cookie_stale(lgrp_cookie_t cookie);




 DESCRIPTION

The lgrp_cookie_stale() function takes a cookie representing the
snapshot of the lgroup hierarchy obtained from lgrp_init(3LGRP) and
returns whether it is stale. The snapshot can become out-of-date for a number
of reasons depending on its view. If the snapshot was taken with
LGRP_VIEW_OS, changes in the lgroup hierarchy from dynamic
reconfiguration, CPU on/offline, or other conditions can cause the snapshot to
become out-of-date. A snapshot taken with LGRP_VIEW_CALLER can be
affected by the caller's processor set binding and changes in its processor set
itself, as well as changes in the lgroup hierarchy.


If the snapshot needs to be updated, lgrp_fini(3LGRP) should be called
with the old cookie and lgrp_init() should be called to obtain a new
snapshot.

 RETURN VALUES

Upon successful completion, lgrp_cookie_stale() returns whether the
cookie is stale. Otherwise, it returns -1 and sets errno to indicate
the error.

 ERRORS

The lgrp_cookie_stale() function will fail if:


EINVAL


The cookie is not valid.




 ATTRIBUTES

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







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe



 SEE ALSO

lgrp_init(3LGRP), lgrp_fini(3LGRP), lgrp_view(3LGRP),
liblgrp(3LIB), attributes(5)