lib/libc/sys/dup.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)dup.2       8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd August 14, 2011
  32 .Dt DUP 2
  33 .Os
  34 .Sh NAME
  35 .Nm dup ,
  36 .Nm dup2
  37 .Nd duplicate an existing file descriptor
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In unistd.h
  42 .Ft int
  43 .Fn dup "int oldd"
  44 .Ft int
  45 .Fn dup2 "int oldd" "int newd"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn dup
  49 system call
  50 duplicates an existing object descriptor and returns its value to
  51 the calling process
  52 .Fa ( newd
  53 =
  54 .Fn dup oldd ) .
  55 The argument
  56 .Fa oldd
  57 is a small non-negative integer index in
  58 the per-process descriptor table.
  59 The value must be less
  60 than the size of the table, which is returned by
  61 .Xr getdtablesize 2 .
  62 The new descriptor returned by the call
  63 is the lowest numbered descriptor
  64 currently not in use by the process.
  65 .Pp
  66 The object referenced by the descriptor does not distinguish
  67 between
  68 .Fa oldd
  69 and
  70 .Fa newd
  71 in any way.
  72 Thus if
  73 .Fa newd
  74 and
  75 .Fa oldd
  76 are duplicate references to an open
  77 file,
  78 .Xr read 2 ,
  79 .Xr write 2
  80 and
  81 .Xr lseek 2
  82 calls all move a single pointer into the file,
  83 and append mode, non-blocking I/O and asynchronous I/O options
  84 are shared between the references.
  85 If a separate pointer into the file is desired, a different
  86 object reference to the file must be obtained by issuing an
  87 additional
  88 .Xr open 2
  89 system call.
  90 The close-on-exec flag on the new file descriptor is unset.
  91 .Pp
  92 In
  93 .Fn dup2 ,
  94 the value of the new descriptor
  95 .Fa newd
  96 is specified.
  97 If this descriptor is already in use and
  98 .Fa oldd
  99 \*(Ne
 100 .Fa newd ,
 101 the descriptor is first deallocated as if the
 102 .Xr close 2
 103 system call had been used.
 104 If
 105 .Fa oldd
 106 is not a valid descriptor, then
 107 .Fa newd
 108 is not closed.
 109 If
 110 .Fa oldd
 111 ==
 112 .Fa newd
 113 and
 114 .Fa oldd
 115 is a valid descriptor, then
 116 .Fn dup2
 117 is successful, and does nothing.
 118 .Pp
 119 The related
 120 .Xr cap_new 2
 121 system call allows file descriptors to be duplicated with restrictions on
 122 their use.
 123 .Sh RETURN VALUES
 124 The value -1 is returned if an error occurs in either call.
 125 The external variable
 126 .Va errno
 127 indicates the cause of the error.
 128 .Sh ERRORS
 129 The
 130 .Fn dup
 131 system call fails if:
 132 .Bl -tag -width Er
 133 .It Bq Er EBADF
 134 The
 135 .Fa oldd
 136 argument
 137 is not a valid active descriptor
 138 .It Bq Er EMFILE
 139 Too many descriptors are active.
 140 .El
 141 The
 142 .Fn dup2
 143 system call fails if:
 144 .Bl -tag -width Er
 145 .It Bq Er EBADF
 146 The
 147 .Fa oldd
 148 argument is not a valid active descriptor or the
 149 .Fa newd
 150 argument is negative or exceeds the maximum allowable descriptor number
 151 .El
 152 .Sh SEE ALSO
 153 .Xr accept 2 ,
 154 .Xr cap_new 2 ,
 155 .Xr close 2 ,
 156 .Xr fcntl 2 ,
 157 .Xr getdtablesize 2 ,
 158 .Xr open 2 ,
 159 .Xr pipe 2 ,
 160 .Xr socket 2 ,
 161 .Xr socketpair 2
 162 .Sh STANDARDS
 163 The
 164 .Fn dup
 165 and
 166 .Fn dup2
 167 system calls are expected to conform to
 168 .St -p1003.1-90 .
 169 .Sh HISTORY
 170 The
 171 .Fn dup
 172 and
 173 .Fn dup2
 174 functions appeared in
 175 .At v7 .