lib/libc/sys/closefrom.2

   1 .\" Copyright (c) 2009 Hudson River Trading LLC
   2 .\" Written by: John H. Baldwin <jhb@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd March 3, 2022
  29 .Dt CLOSEFROM 2
  30 .Os
  31 .Sh NAME
  32 .Nm closefrom ,
  33 .Nm close_range
  34 .Nd delete open file descriptors
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In unistd.h
  39 .Ft void
  40 .Fn closefrom "int lowfd"
  41 .Ft int
  42 .Fn close_range "u_int lowfd" "u_int highfd" "int flags"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn closefrom
  46 system call deletes all open file descriptors greater than or equal to
  47 .Fa lowfd
  48 from the per-process object reference table.
  49 Any errors encountered while closing file descriptors are ignored.
  50 .Pp
  51 The
  52 .Fn close_range
  53 system call deletes all open file descriptors between
  54 .Fa lowfd
  55 and
  56 .Fa highfd
  57 inclusive, clamped to the range of open file descriptors.
  58 Any errors encountered while closing file descriptors are ignored.
  59 Supported
  60 .Fa flags :
  61 .Bl -tag -width ".Dv CLOSE_RANGE_CLOEXEC"
  62 .It Dv CLOSE_RANGE_CLOEXEC
  63 Set the close-on-exec flag on descriptors in the range instead of closing them.
  64 .El
  65 .Sh RETURN VALUES
  66 Upon successful completion,
  67 .Fn close_range
  68 returns a value
  69 of 0.
  70 Otherwise, a value of -1 is returned and the global variable
  71 .Va errno
  72 is set to indicate the error.
  73 .Sh ERRORS
  74 The
  75 .Fn close_range
  76 system call
  77 will fail if:
  78 .Bl -tag -width Er
  79 .It Bq Er EINVAL
  80 The
  81 .Fa highfd
  82 argument is lower than the
  83 .Fa lowfd
  84 argument.
  85 .It Bq Er EINVAL
  86 An invalid flag was set.
  87 .El
  88 .Sh SEE ALSO
  89 .Xr close 2
  90 .Sh HISTORY
  91 The
  92 .Fn closefrom
  93 function first appeared in
  94 .Fx 8.0 .