usr/src/man/man3c/closefrom.3c

   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 CLOSEFROM 3C "Apr 27, 2000"
   7 .SH NAME
   8 closefrom, fdwalk \- close or iterate over open file descriptors
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <stdlib.h>
  13
  14 \fBvoid\fR \fBclosefrom\fR(\fBint\fR \fIlowfd\fR);
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBint\fR \fBfdwalk\fR(\fBint\fR (*\fIfunc\fR)(\fBvoid\fR *, \fBint\fR), \fBvoid *\fR\fIcd\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBclosefrom()\fR function calls \fBclose\fR(2) on all open file
  26 descriptors greater than or equal to \fIlowfd\fR.
  27 .sp
  28 .LP
  29 The effect of \fBclosefrom\fR(\fIlowfd\fR) is the same as the code
  30 .sp
  31 .in +2
  32 .nf
  33 #include <sys/resource.h>
  34 struct rlimit rl;
  35 int i;
  36
  37 getrlimit(RLIMIT_NOFILE, &rl);
  38 for (i = lowfd; i < rl.rlim_max; i++)
  39      (void) close(i);
  40 .fi
  41 .in -2
  42
  43 .sp
  44 .LP
  45 except that \fBclose()\fR is called only on file descriptors that are actually
  46 open, not on every possible file descriptor greater than or equal to
  47 \fIlowfd\fR, and \fBclose()\fR is also called on any open file descriptors
  48 greater than or equal to \fBrl.rlim_max\fR (and \fIlowfd\fR), should any exist.
  49 .sp
  50 .LP
  51 The \fBfdwalk()\fR function first makes a list of all currently open file
  52 descriptors. Then for each file descriptor in the list, it calls the
  53 user-defined function, \fIfunc\fR(\fIcd\fR, \fIfd\fR), passing it the pointer
  54 to the callback data, \fIcd\fR, and the value of the file descriptor from the
  55 list, \fIfd\fR.  The list is processed in file descriptor value order, lowest
  56 numeric value first.
  57 .sp
  58 .LP
  59 If \fIfunc\fR() returns a non-zero value, the iteration over the list is
  60 terminated and \fBfdwalk()\fR returns the non-zero value returned by
  61 \fIfunc\fR().  Otherwise, \fBfdwalk()\fR returns 0 after having called
  62 \fIfunc\fR() for every file descriptor in the list.
  63 .sp
  64 .LP
  65 The \fBfdwalk()\fR function can be used for fine-grained control over the
  66 closing of file descriptors.  For example, the \fBclosefrom()\fR function can
  67 be implemented as:
  68 .sp
  69 .in +2
  70 .nf
  71 static int
  72 close_func(void *lowfdp, int fd)
  73 {
  74      if (fd >= *(int *)lowfdp)
  75           (void) close(fd);
  76      return (0);
  77 }
  78
  79 void
  80 closefrom(int lowfd)
  81 {
  82      (void) fdwalk(close_func, &lowfd);
  83 }
  84 .fi
  85 .in -2
  86
  87 .sp
  88 .LP
  89 The \fBfdwalk()\fR function can then be used to count the number of open files
  90 in the process.
  91 .SH RETURN VALUES
  92 .sp
  93 .LP
  94 No return value is defined for \fBclosefrom()\fR. If \fBclose()\fR fails for
  95 any of the open file descriptors, the error is ignored and the file descriptors
  96 whose \fBclose()\fR operation failed might remain open on return from
  97 \fBclosefrom()\fR.
  98 .sp
  99 .LP
 100 The \fBfdwalk()\fR function returns the return value of the last call to the
 101 callback function \fIfunc\fR(), or 0 if \fIfunc\fR() is never called (no open
 102 files).
 103 .SH ERRORS
 104 .sp
 105 .LP
 106 No errors are defined. The \fBclosefrom()\fR and \fBfdwalk()\fR functions do
 107 not set \fBerrno\fR but \fBerrno\fR can be set by \fBclose()\fR or by another
 108 function called by the callback function, \fIfunc\fR().
 109 .SH FILES
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fB/proc/self/fd\fR\fR
 114 .ad
 115 .RS 17n
 116 directory (list of open files)
 117 .RE
 118
 119 .SH USAGE
 120 .sp
 121 .LP
 122 The act of closing all open file descriptors should be performed only as the
 123 first action of a daemon process.  Closing file descriptors that are in use
 124 elsewhere in the current process normally leads to disastrous results.
 125 .SH ATTRIBUTES
 126 .sp
 127 .LP
 128 See \fBattributes\fR(5)  for descriptions of the following attributes:
 129 .sp
 130
 131 .sp
 132 .TS
 133 box;
 134 c | c
 135 l | l .
 136 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 137 _
 138 MT-Level        Unsafe
 139 .TE
 140
 141 .SH SEE ALSO
 142 .sp
 143 .LP
 144 \fBclose\fR(2), \fBgetrlimit\fR(2), \fBproc\fR(4), \fBattributes\fR(5)