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 April 21, 2013
  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 new descriptor returned by the call
  60 is the lowest numbered descriptor
  61 currently not in use by the process.
  62 .Pp
  63 The object referenced by the descriptor does not distinguish
  64 between
  65 .Fa oldd
  66 and
  67 .Fa newd
  68 in any way.
  69 Thus if
  70 .Fa newd
  71 and
  72 .Fa oldd
  73 are duplicate references to an open
  74 file,
  75 .Xr read 2 ,
  76 .Xr write 2
  77 and
  78 .Xr lseek 2
  79 calls all move a single pointer into the file,
  80 and append mode, non-blocking I/O and asynchronous I/O options
  81 are shared between the references.
  82 If a separate pointer into the file is desired, a different
  83 object reference to the file must be obtained by issuing an
  84 additional
  85 .Xr open 2
  86 system call.
  87 The close-on-exec flag on the new file descriptor is unset.
  88 .Pp
  89 In
  90 .Fn dup2 ,
  91 the value of the new descriptor
  92 .Fa newd
  93 is specified.
  94 If this descriptor is already in use and
  95 .Fa oldd
  96 \*(Ne
  97 .Fa newd ,
  98 the descriptor is first deallocated as if the
  99 .Xr close 2
 100 system call had been used.
 101 If
 102 .Fa oldd
 103 is not a valid descriptor, then
 104 .Fa newd
 105 is not closed.
 106 If
 107 .Fa oldd
 108 ==
 109 .Fa newd
 110 and
 111 .Fa oldd
 112 is a valid descriptor, then
 113 .Fn dup2
 114 is successful, and does nothing.
 115 .Pp
 116 The related
 117 .Xr cap_new 2
 118 system call allows file descriptors to be duplicated with restrictions on
 119 their use.
 120 .Sh RETURN VALUES
 121 The value -1 is returned if an error occurs in either call.
 122 The external variable
 123 .Va errno
 124 indicates the cause of the error.
 125 .Sh ERRORS
 126 The
 127 .Fn dup
 128 system call fails if:
 129 .Bl -tag -width Er
 130 .It Bq Er EBADF
 131 The
 132 .Fa oldd
 133 argument
 134 is not a valid active descriptor
 135 .It Bq Er EMFILE
 136 Too many descriptors are active.
 137 .El
 138 The
 139 .Fn dup2
 140 system call fails if:
 141 .Bl -tag -width Er
 142 .It Bq Er EBADF
 143 The
 144 .Fa oldd
 145 argument is not a valid active descriptor or the
 146 .Fa newd
 147 argument is negative or exceeds the maximum allowable descriptor number
 148 .El
 149 .Sh SEE ALSO
 150 .Xr accept 2 ,
 151 .Xr cap_new 2 ,
 152 .Xr close 2 ,
 153 .Xr fcntl 2 ,
 154 .Xr getdtablesize 2 ,
 155 .Xr open 2 ,
 156 .Xr pipe 2 ,
 157 .Xr socket 2 ,
 158 .Xr socketpair 2
 159 .Sh STANDARDS
 160 The
 161 .Fn dup
 162 and
 163 .Fn dup2
 164 system calls are expected to conform to
 165 .St -p1003.1-90 .
 166 .Sh HISTORY
 167 The
 168 .Fn dup
 169 and
 170 .Fn dup2
 171 functions appeared in
 172 .At v7 .