usr/src/man/man2/shmids.2

   1 '\" te
   2 .\" Copyright (c) 2000, 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 SHMIDS 2 "Mar 8, 2000"
   7 .SH NAME
   8 shmids \- discover all shared memory identifiers
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/shm.h>
  13
  14 \fBint\fR \fBshmids\fR(\fBint *\fR\fIbuf\fR, \fBuint_t\fR \fInids\fR, \fBuint_t *\fR\fIpnids\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBshmids()\fR function copies all active shared memory identifiers from
  21 the system into the user-defined buffer specified by \fIbuf\fR, provided that
  22 the number of such identifiers is not greater than the number of integers the
  23 buffer can contain, as specified by \fInids\fR.  If the size of the buffer is
  24 insufficient to contain all of the active shared memory identifiers in the
  25 system, none are copied.
  26 .sp
  27 .LP
  28 Whether or not the size of the buffer is sufficient to contain all of them, the
  29 number of active shared memory identifiers in the system is copied into the
  30 unsigned integer pointed to by \fIpnids\fR.
  31 .sp
  32 .LP
  33 If \fInids\fR is 0 or less than the number of active shared memory identifiers
  34 in the system, \fIbuf\fR is ignored.
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 Upon successful completion, \fBshmids()\fR returns \fB0\fR.  Otherwise,
  39 \fB\(mi1\fR is returned and \fBerrno\fR is set to indicate the error.
  40 .SH ERRORS
  41 .sp
  42 .LP
  43 The \fBshmids()\fR function will fail if:
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBEFAULT\fR\fR
  48 .ad
  49 .RS 10n
  50 The \fIbuf\fR or \fIpnids\fR argument points to an illegal address.
  51 .RE
  52
  53 .SH USAGE
  54 .sp
  55 .LP
  56 The \fBshmids()\fR function returns a snapshot of all the active shared memory
  57 identifiers in the system.  More may be added and some may be removed before
  58 they can be used by the caller.
  59 .SH EXAMPLES
  60 .LP
  61 \fBExample 1 \fR\fBshmids()\fR example
  62 .sp
  63 .LP
  64 This is sample C code indicating how to use the \fBshmids()\fR function.
  65
  66 .sp
  67 .in +2
  68 .nf
  69 void
  70 examine_shmids()
  71 {
  72      int *ids = NULL;
  73      uint_t nids = 0;
  74      uint_t n;
  75      int i;
  76
  77      for (;;) {
  78           if (shmids(ids, nids, &n) != 0) {
  79                perror("shmids");
  80                exit(1);
  81           }
  82           if (n <= nids)     /* we got them all */
  83                break;
  84           /* we need a bigger buffer */
  85           ids = realloc(ids, (nids = n) * sizeof (int));
  86      }
  87
  88      for (i = 0; i < n; i++)
  89           process_shmid(ids[i]);
  90
  91      free(ids);
  92 }
  93 .fi
  94 .in -2
  95
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101
 102 .sp
 103 .TS
 104 box;
 105 c | c
 106 l | l .
 107 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 108 _
 109 MT-Level        Async-Signal-Safe
 110 .TE
 111
 112 .SH SEE ALSO
 113 .sp
 114 .LP
 115 \fBipcrm\fR(1), \fBipcs\fR(1), \fBIntro\fR(2), \fBshmctl\fR(2),
 116 \fBshmget\fR(2), \fBshmop\fR(2), \fBattributes\fR(5)