share/man/man3lgrp/lgrp_mem_size.3lgrp

   1 '\" te
   2 .\" Copyright (c) 2005, 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_MEM_SIZE 3LGRP "Jan 26, 2005"
   7 .SH NAME
   8 lgrp_mem_size \- return the memory size of the given lgroup
   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 \fBlgrp_mem_size_t\fR \fBlgrp_mem_size\fR(\fBlgrp_cookie_t\fR \fIcookie\fR, \fBlgrp_id_t\fR \fIlgrp\fR,
  16      \fBint\fR \fItype\fR, \fBint\fR \fIcontent\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBlgrp_mem_size()\fR function takes a \fIcookie\fR representing a snapshot
  23 of the lgroup hierarchy. The \fIcookie\fR was obtained by calling
  24 \fBlgrp_init\fR(3LGRP). The \fBlgrp_mem_size()\fR function returns the memory
  25 size of the given lgroup in bytes. The \fItype\fR argument should be set to one
  26 of the following values:
  27 .sp
  28 .in +2
  29 .nf
  30 LGRP_MEM_SZ_FREE                /* free memory */
  31 LGRP_MEM_SZ_INSTALLED           /* installed memory */
  32 .fi
  33 .in -2
  34
  35 .sp
  36 .LP
  37 The \fIcontent\fR argument should be set to one of the following values to
  38 specify whether the direct contents or everything in this lgroup should be
  39 returned:
  40 .sp
  41 .in +2
  42 .nf
  43 LGRP_CONTENT_ALL        /* everything in this lgroup */
  44 LGRP_CONTENT_DIRECT     /* directly contained in lgroup */
  45 LGRP_CONTENT_HIERARCHY  /* everything within this hierarchy (for */
  46                            compatibility only, use LGRP_CONTENT_ALL) */
  47 .fi
  48 .in -2
  49
  50 .sp
  51 .LP
  52 The \fBLGRP_CONTENT_HIERARCHY\fR value can still be used, but is being replaced
  53 by \fBLGRP_CONTENT_ALL\fR.
  54 .sp
  55 .LP
  56 The total sizes include all the memory in the lgroup including its children,
  57 while the others reflect only the memory contained directly in the given
  58 lgroup.
  59 .SH RETURN VALUES
  60 .sp
  61 .LP
  62 Upon successful completion, the size in bytes is returned. Otherwise, \(mi1 is
  63 returned and \fBerrno\fR is set to indicate the error.
  64 .SH ERRORS
  65 .sp
  66 .LP
  67 The \fBlgrp_mem_size()\fR function will fail if:
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBEINVAL\fR\fR
  72 .ad
  73 .RS 10n
  74 The specified cookie, lgroup ID, or one of the flags is not valid.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBESRCH\fR\fR
  81 .ad
  82 .RS 10n
  83 The specified lgroup ID was not found.
  84 .RE
  85
  86 .SH ATTRIBUTES
  87 .sp
  88 .LP
  89 See \fBattributes\fR(5) for descriptions of the following attributes:
  90 .sp
  91
  92 .sp
  93 .TS
  94 box;
  95 c | c
  96 l | l .
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 _
  99 Interface Stability     Evolving
 100 _
 101 MT-Level        MT-Safe
 102 .TE
 103
 104 .SH SEE ALSO
 105 .sp
 106 .LP
 107 \fBlgrp_init\fR(3LGRP), \fBlgrp_cpus\fR(3LGRP), \fBlgrp_resources\fR(3LGRP),
 108 \fBliblgrp\fR(3LIB), \fBattributes\fR(5)