usr/src/man/man3lgrp/lgrp_cookie_stale.3lgrp

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH LGRP_COOKIE_STALE 3LGRP "Apr 16, 2003"
   7 .SH NAME
   8 lgrp_cookie_stale \- determine whether snapshot of lgroup hierarchy is stale
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag \&.\|.\|.\fR ] \fIfile\fR\&.\|.\|. \fB-llgrp\fR [ \fIlibrary \&.\|.\|.\fR ]
  13 #include <sys/lgrp_user.h>
  14
  15 \fBint\fR \fBlgrp_cookie_stale\fR(\fBlgrp_cookie_t\fR \fIcookie\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBlgrp_cookie_stale()\fR function takes a \fIcookie\fR representing the
  22 snapshot of the lgroup hierarchy obtained from \fBlgrp_init\fR(3LGRP) and
  23 returns whether it is stale. The snapshot can become out-of-date for a number
  24 of reasons depending on its view.  If the snapshot was taken with
  25 \fBLGRP_VIEW_OS\fR, changes in the lgroup hierarchy from dynamic
  26 reconfiguration, CPU on/offline, or other conditions can cause the snapshot to
  27 become out-of-date. A snapshot taken with \fBLGRP_VIEW_CALLER\fR can be
  28 affected by the caller's processor set binding and changes in its processor set
  29 itself, as well as changes in the lgroup hierarchy.
  30 .sp
  31 .LP
  32 If the snapshot needs to be updated, \fBlgrp_fini\fR(3LGRP) should be called
  33 with the old cookie and \fBlgrp_init()\fR should be called to obtain a new
  34 snapshot.
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 Upon successful completion, \fBlgrp_cookie_stale()\fR returns whether the
  39 cookie is stale. Otherwise, it returns \(mi1 and sets \fBerrno\fR to indicate
  40 the error.
  41 .SH ERRORS
  42 .sp
  43 .LP
  44 The \fBlgrp_cookie_stale()\fR function will fail if:
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBEINVAL\fR\fR
  49 .ad
  50 .RS 10n
  51 The cookie is not valid.
  52 .RE
  53
  54 .SH ATTRIBUTES
  55 .sp
  56 .LP
  57 See \fBattributes\fR(5) for descriptions of the following attributes:
  58 .sp
  59
  60 .sp
  61 .TS
  62 box;
  63 c | c
  64 l | l .
  65 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  66 _
  67 Interface Stability     Evolving
  68 _
  69 MT-Level        MT-Safe
  70 .TE
  71
  72 .SH SEE ALSO
  73 .sp
  74 .LP
  75 \fBlgrp_init\fR(3LGRP), \fBlgrp_fini\fR(3LGRP), \fBlgrp_view\fR(3LGRP),
  76 \fBliblgrp\fR(3LIB), \fBattributes\fR(5)