File descriptor

From Wikipedia, the free encyclopedia
  (Redirected from File handles)
Jump to: navigation, search

In computer programming, a file descriptor (FD) is an abstract indicator for accessing a file. The term is generally used in POSIX operating systems.

In POSIX, a file descriptor is an integer, specifically of the C type int. There are three standard POSIX file descriptors, corresponding to the three standard streams, which presumably every process (save perhaps a daemon) should expect to have:

Integer value Name <unistd.h> symbolic constant[1] <stdio.h> file stream[2]
0 Standard input STDIN_FILENO stdin
1 Standard output STDOUT_FILENO stdout
2 Standard error STDERR_FILENO stderr

Generally, a file descriptor is an index for an entry in a kernel-resident array data structure containing the details of open files. In POSIX this data structure is called a file descriptor table, and each process has its own file descriptor table. The process passes the file descriptor to the kernel through a system call, and the kernel will access the file on behalf of the process. The process itself cannot read or write the file descriptor table directly.

On Linux, the set of file descriptors open in a process can be accessed under the path /proc/PID/fd/, where PID is the process identifier.

In Unix-like systems, file descriptors can refer to any Unix file type named in a file system. As well as regular files, this includes directories, block and character devices (also called "special files"), Unix domain sockets, and named pipes. File descriptors can also refer to other objects that do not normally exist in the file system, such as anonymous pipes and network sockets.

The FILE data structure in the C standard I/O library usually includes a low level file descriptor for the object in question on Unix-like systems. The overall data structure provides additional abstraction and is instead known as a file handle.

Operations on file descriptors[edit]

The following lists typical operations on file descriptors on modern Unix-like systems. Some of these functions are declared in the <fcntl.h> header.

Creating file descriptors[edit]

  • open(), open64()
  • creat(), creat64()
  • socket()
  • accept()
  • socketpair()
  • epoll_create() (Linux only)[3]
  • pipe()
  • signalfd() (Linux only)[4]
  • eventfd() (Linux only)[5]
  • opendir()
  • timerfd() (Linux only)[6]

Deriving file descriptors[edit]

  • dirfd()
  • fileno()

Operations on a single file descriptor[edit]

  • read(), write()
  • readv(), writev()
  • pread(), pwrite()
  • pread64(), pwrite64() (linux only, since kernel 2.1, transparently rewritten since 2.6)
  • recv(), send()
  • recvmsg(), sendmsg() (including allowing sending FDs)
  • sendfile()
  • lseek(), lseek64()
  • fstat(), fstat64()
  • fchmod()
  • fchown()
  • fdopen()
  • gzdopen()
  • ftruncate()
  • fsync()
  • fdatasync()
  • fstatvfs()

Operations on multiple file descriptors[edit]

Operations on the file descriptor table[edit]

The fcntl() function is used to perform various operations on a file descriptor, depending on the command argument passed to it. There are commands to get and set attributes associated with a file descriptor, including F_GETFD, F_SETFD, F_GETFL and F_SETFL.

  • close()
  • closefrom() (BSD and Solaris only; deletes all file descriptors greater than or equal to specified number)
  • dup() (duplicates an existing file descriptor guaranteeing to be the lowest number available file descriptor)
  • dup2() (the new file descriptor will have the value passed as an argument)
  • fcntl(F_DUPFD)

Operations that modify process state[edit]

  • fchdir() (sets the process's current working directory based on a directory file descriptor)
  • mmap() (maps ranges of a file into the process's address space)

File locking[edit]

  • flock()
  • fcntl (F_GETLK, F_SETLK and F_SETLKW)
  • lockf()

Sockets[edit]

  • connect()
  • bind()
  • listen()
  • accept() (creates a new file descriptor for an incoming connection)
  • getsockname()
  • getpeername()
  • getsockopt()
  • setsockopt()
  • shutdown() (shuts down one or both halves of a full duplex connection)

Miscellaneous[edit]

  • ioctl() (a large collection of miscellaneous operations on a single file descriptor, often associated with a device)

Upcoming operations[edit]

A series of new operations on file descriptors has been added to many modern Unix-like systems, as well as numerous C libraries, to be standardized in a future version of POSIX.[7] The at suffix signifies that the function takes an additional first argument supplying a file descriptor from which relative paths are resolved, the forms lacking the at suffix thus becoming equivalent to passing a file descriptor corresponding to the current working directory. The purpose of these new operations is to defend against a certain class of TOCTTOU attacks.

  • openat()
  • faccessat()
  • fchmodat()
  • fchownat()
  • fstatat()
  • futimesat()
  • linkat()
  • mkdirat()
  • mknodat()
  • readlinkat()
  • renameat()
  • symlinkat()
  • unlinkat()
  • mkfifoat()
  • fdopendir()

File descriptors as capabilities[edit]

Unix file descriptors behave in many ways as capabilities. They can be passed between processes across Unix domain sockets using the sendmsg() system call. Note, however, that what is actually passed is a reference to an "open file description" that has mutable state (the file offset, and the file status and access flags). This complicates the secure use of file descriptors as capabilities, since when programs share access to the same open file description, they can interfere with each other's use of it by changing its offset or whether it is blocking or non-blocking, for example.[8][9] In operating systems that are specifically designed as capability systems, there is very rarely any mutable state associated with a capability itself.

A Unix process' file descriptor table is an example of a C-list.

See also[edit]

  • lsof - a utility that displays information about open file descriptors.

References[edit]

  1. ^ The IEEE and The Open Group. "<unistd.h>". The Open Group Base Specifications Issue 6, IEEE Std 1003.1, 2004 Edition. Retrieved May 31, 2014. 
  2. ^ The IEEE and The Open Group. "<stdio.h>". The Open Group Base Specifications Issue 6, IEEE Std 1003.1, 2004 Edition. Retrieved May 31, 2014. 
  3. ^ http://man7.org/linux/man-pages/man2/epoll_create.2.html
  4. ^ http://man7.org/linux/man-pages/man2/signalfd.2.html
  5. ^ http://man7.org/linux/man-pages/man3/eventfd_write.3.html
  6. ^ http://man7.org/linux/man-pages/man2/timerfd_create.2.html
  7. ^ Extended API Set, Part 2. The Open Group. October 2006. ISBN 1-931624-67-4. 
  8. ^ [1]
  9. ^ Jonathan de Boyne Pollard (2007). "Don't set shared file descriptors to non-blocking I/O mode.". Frequently Given Answers.