2010-12-03 05:34:57 +01:00
|
|
|
// Copyright 2009 The Go Authors. All rights reserved.
|
|
|
|
// Use of this source code is governed by a BSD-style
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
2011-10-27 01:57:58 +02:00
|
|
|
// +build darwin freebsd linux openbsd
|
|
|
|
|
2010-12-03 05:34:57 +01:00
|
|
|
package os
|
|
|
|
|
|
|
|
import (
|
|
|
|
"runtime"
|
|
|
|
"syscall"
|
|
|
|
)
|
|
|
|
|
2011-09-16 17:47:21 +02:00
|
|
|
// File represents an open file descriptor.
|
|
|
|
type File struct {
|
2011-12-13 00:40:51 +01:00
|
|
|
*file
|
|
|
|
}
|
|
|
|
|
|
|
|
// file is the real representation of *File.
|
|
|
|
// The extra level of indirection ensures that no clients of os
|
|
|
|
// can overwrite this data, which could cause the finalizer
|
|
|
|
// to close the wrong file descriptor.
|
|
|
|
type file struct {
|
2011-09-16 17:47:21 +02:00
|
|
|
fd int
|
|
|
|
name string
|
|
|
|
dirinfo *dirInfo // nil unless directory being read
|
|
|
|
nepipe int // number of consecutive EPIPE in Write
|
|
|
|
}
|
|
|
|
|
|
|
|
// Fd returns the integer Unix file descriptor referencing the open file.
|
2011-12-13 20:16:27 +01:00
|
|
|
func (f *File) Fd() int {
|
|
|
|
if f == nil {
|
2011-09-16 17:47:21 +02:00
|
|
|
return -1
|
|
|
|
}
|
2011-12-13 20:16:27 +01:00
|
|
|
return f.fd
|
2011-09-16 17:47:21 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// NewFile returns a new File with the given file descriptor and name.
|
|
|
|
func NewFile(fd int, name string) *File {
|
|
|
|
if fd < 0 {
|
|
|
|
return nil
|
|
|
|
}
|
2011-12-13 00:40:51 +01:00
|
|
|
f := &File{&file{fd: fd, name: name}}
|
|
|
|
runtime.SetFinalizer(f.file, (*file).close)
|
2011-09-16 17:47:21 +02:00
|
|
|
return f
|
|
|
|
}
|
|
|
|
|
2010-12-03 05:34:57 +01:00
|
|
|
// Auxiliary information if the File describes a directory
|
|
|
|
type dirInfo struct {
|
2011-12-07 02:11:29 +01:00
|
|
|
buf []byte // buffer for directory I/O
|
2010-12-03 05:34:57 +01:00
|
|
|
dir *syscall.DIR // from opendir
|
|
|
|
}
|
|
|
|
|
|
|
|
// DevNull is the name of the operating system's ``null device.''
|
|
|
|
// On Unix-like systems, it is "/dev/null"; on Windows, "NUL".
|
|
|
|
const DevNull = "/dev/null"
|
|
|
|
|
2011-04-07 19:09:10 +02:00
|
|
|
// OpenFile is the generalized open call; most users will use Open
|
|
|
|
// or Create instead. It opens the named file with specified flag
|
|
|
|
// (O_RDONLY etc.) and perm, (0666 etc.) if applicable. If successful,
|
|
|
|
// methods on the returned File can be used for I/O.
|
2011-12-03 03:17:34 +01:00
|
|
|
// It returns the File and an error, if any.
|
|
|
|
func OpenFile(name string, flag int, perm uint32) (file *File, err error) {
|
2010-12-03 05:34:57 +01:00
|
|
|
r, e := syscall.Open(name, flag|syscall.O_CLOEXEC, perm)
|
2011-12-13 00:40:51 +01:00
|
|
|
if e != nil {
|
|
|
|
return nil, &PathError{"open", name, e}
|
2010-12-03 05:34:57 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// There's a race here with fork/exec, which we are
|
|
|
|
// content to live with. See ../syscall/exec.go
|
|
|
|
if syscall.O_CLOEXEC == 0 { // O_CLOEXEC not supported
|
|
|
|
syscall.CloseOnExec(r)
|
|
|
|
}
|
|
|
|
|
|
|
|
return NewFile(r, name), nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Close closes the File, rendering it unusable for I/O.
|
2011-12-03 03:17:34 +01:00
|
|
|
// It returns an error, if any.
|
2011-12-13 20:16:27 +01:00
|
|
|
func (f *File) Close() error {
|
|
|
|
return f.file.close()
|
2011-12-13 00:40:51 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
func (file *file) close() error {
|
2010-12-03 05:34:57 +01:00
|
|
|
if file == nil || file.fd < 0 {
|
|
|
|
return EINVAL
|
|
|
|
}
|
2011-12-03 03:17:34 +01:00
|
|
|
var err error
|
2011-12-13 00:40:51 +01:00
|
|
|
if e := syscall.Close(file.fd); e != nil {
|
|
|
|
err = &PathError{"close", file.name, e}
|
2010-12-03 05:34:57 +01:00
|
|
|
}
|
2011-01-28 01:01:08 +01:00
|
|
|
|
|
|
|
if file.dirinfo != nil {
|
2011-12-07 02:11:29 +01:00
|
|
|
if libc_closedir(file.dirinfo.dir) < 0 && err == nil {
|
2011-12-13 00:40:51 +01:00
|
|
|
err = &PathError{"closedir", file.name, syscall.GetErrno()}
|
2011-01-28 01:01:08 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2010-12-03 05:34:57 +01:00
|
|
|
file.fd = -1 // so it can't be closed again
|
|
|
|
|
|
|
|
// no need for a finalizer anymore
|
|
|
|
runtime.SetFinalizer(file, nil)
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Stat returns the FileInfo structure describing file.
|
|
|
|
// It returns the FileInfo and an error, if any.
|
2011-12-13 20:16:27 +01:00
|
|
|
func (f *File) Stat() (fi FileInfo, err error) {
|
2010-12-03 05:34:57 +01:00
|
|
|
var stat syscall.Stat_t
|
2011-12-13 20:16:27 +01:00
|
|
|
err = syscall.Fstat(f.fd, &stat)
|
|
|
|
if err != nil {
|
|
|
|
return nil, &PathError{"stat", f.name, err}
|
2010-12-03 05:34:57 +01:00
|
|
|
}
|
2011-12-13 20:16:27 +01:00
|
|
|
return fileInfoFromStat(&stat, f.name), nil
|
2010-12-03 05:34:57 +01:00
|
|
|
}
|
|
|
|
|
2011-12-13 20:16:27 +01:00
|
|
|
// Stat returns a FileInfo describing the named file and an error, if any.
|
2011-10-27 01:57:58 +02:00
|
|
|
// If name names a valid symbolic link, the returned FileInfo describes
|
|
|
|
// the file pointed at by the link and has fi.FollowedSymlink set to true.
|
|
|
|
// If name names an invalid symbolic link, the returned FileInfo describes
|
|
|
|
// the link itself and has fi.FollowedSymlink set to false.
|
2011-12-13 20:16:27 +01:00
|
|
|
func Stat(name string) (fi FileInfo, err error) {
|
|
|
|
var stat syscall.Stat_t
|
|
|
|
err = syscall.Stat(name, &stat)
|
|
|
|
if err != nil {
|
|
|
|
return nil, &PathError{"stat", name, err}
|
2011-10-27 01:57:58 +02:00
|
|
|
}
|
2011-12-13 20:16:27 +01:00
|
|
|
return fileInfoFromStat(&stat, name), nil
|
2011-10-27 01:57:58 +02:00
|
|
|
}
|
|
|
|
|
2011-12-13 20:16:27 +01:00
|
|
|
// Lstat returns a FileInfo describing the named file and an
|
2011-10-27 01:57:58 +02:00
|
|
|
// error, if any. If the file is a symbolic link, the returned FileInfo
|
|
|
|
// describes the symbolic link. Lstat makes no attempt to follow the link.
|
2011-12-13 20:16:27 +01:00
|
|
|
func Lstat(name string) (fi FileInfo, err error) {
|
2011-10-27 01:57:58 +02:00
|
|
|
var stat syscall.Stat_t
|
2011-12-13 20:16:27 +01:00
|
|
|
err = syscall.Lstat(name, &stat)
|
|
|
|
if err != nil {
|
|
|
|
return nil, &PathError{"lstat", name, err}
|
2011-10-27 01:57:58 +02:00
|
|
|
}
|
2011-12-13 20:16:27 +01:00
|
|
|
return fileInfoFromStat(&stat, name), nil
|
2011-10-27 01:57:58 +02:00
|
|
|
}
|
|
|
|
|
2010-12-03 05:34:57 +01:00
|
|
|
// Readdir reads the contents of the directory associated with file and
|
2011-12-13 20:16:27 +01:00
|
|
|
// returns an array of up to n FileInfo values, as would be returned
|
2011-09-16 17:47:21 +02:00
|
|
|
// by Lstat, in directory order. Subsequent calls on the same file will yield
|
2010-12-03 05:34:57 +01:00
|
|
|
// further FileInfos.
|
2011-09-16 17:47:21 +02:00
|
|
|
//
|
|
|
|
// If n > 0, Readdir returns at most n FileInfo structures. In this case, if
|
|
|
|
// Readdir returns an empty slice, it will return a non-nil error
|
2011-12-07 02:11:29 +01:00
|
|
|
// explaining why. At the end of a directory, the error is io.EOF.
|
2011-09-16 17:47:21 +02:00
|
|
|
//
|
|
|
|
// If n <= 0, Readdir returns all the FileInfo from the directory in
|
|
|
|
// a single slice. In this case, if Readdir succeeds (reads all
|
|
|
|
// the way to the end of the directory), it returns the slice and a
|
2011-12-03 03:17:34 +01:00
|
|
|
// nil error. If it encounters an error before the end of the
|
2011-09-16 17:47:21 +02:00
|
|
|
// directory, Readdir returns the FileInfo read until that point
|
|
|
|
// and a non-nil error.
|
2011-12-13 20:16:27 +01:00
|
|
|
func (f *File) Readdir(n int) (fi []FileInfo, err error) {
|
|
|
|
dirname := f.name
|
2010-12-03 05:34:57 +01:00
|
|
|
if dirname == "" {
|
|
|
|
dirname = "."
|
|
|
|
}
|
|
|
|
dirname += "/"
|
2011-12-13 20:16:27 +01:00
|
|
|
names, err := f.Readdirnames(n)
|
2010-12-03 05:34:57 +01:00
|
|
|
fi = make([]FileInfo, len(names))
|
|
|
|
for i, filename := range names {
|
|
|
|
fip, err := Lstat(dirname + filename)
|
2011-12-13 20:16:27 +01:00
|
|
|
if err == nil {
|
|
|
|
fi[i] = fip
|
2010-12-03 05:34:57 +01:00
|
|
|
} else {
|
2011-12-13 20:16:27 +01:00
|
|
|
fi[i] = &FileStat{name: filename}
|
2010-12-03 05:34:57 +01:00
|
|
|
}
|
|
|
|
}
|
2011-12-13 20:16:27 +01:00
|
|
|
return fi, err
|
2010-12-03 05:34:57 +01:00
|
|
|
}
|
|
|
|
|
2011-05-20 02:18:15 +02:00
|
|
|
// read reads up to len(b) bytes from the File.
|
|
|
|
// It returns the number of bytes read and an error, if any.
|
2011-12-13 00:40:51 +01:00
|
|
|
func (f *File) read(b []byte) (n int, err error) {
|
2011-05-20 02:18:15 +02:00
|
|
|
return syscall.Read(f.fd, b)
|
|
|
|
}
|
|
|
|
|
|
|
|
// pread reads len(b) bytes from the File starting at byte offset off.
|
|
|
|
// It returns the number of bytes read and the error, if any.
|
|
|
|
// EOF is signaled by a zero count with err set to 0.
|
2011-12-13 00:40:51 +01:00
|
|
|
func (f *File) pread(b []byte, off int64) (n int, err error) {
|
2011-05-20 02:18:15 +02:00
|
|
|
return syscall.Pread(f.fd, b, off)
|
|
|
|
}
|
|
|
|
|
|
|
|
// write writes len(b) bytes to the File.
|
|
|
|
// It returns the number of bytes written and an error, if any.
|
2011-12-13 00:40:51 +01:00
|
|
|
func (f *File) write(b []byte) (n int, err error) {
|
2011-05-20 02:18:15 +02:00
|
|
|
return syscall.Write(f.fd, b)
|
|
|
|
}
|
|
|
|
|
|
|
|
// pwrite writes len(b) bytes to the File starting at byte offset off.
|
|
|
|
// It returns the number of bytes written and an error, if any.
|
2011-12-13 00:40:51 +01:00
|
|
|
func (f *File) pwrite(b []byte, off int64) (n int, err error) {
|
2011-05-20 02:18:15 +02:00
|
|
|
return syscall.Pwrite(f.fd, b, off)
|
|
|
|
}
|
|
|
|
|
|
|
|
// seek sets the offset for the next Read or Write on file to offset, interpreted
|
|
|
|
// according to whence: 0 means relative to the origin of the file, 1 means
|
|
|
|
// relative to the current offset, and 2 means relative to the end.
|
|
|
|
// It returns the new offset and an error, if any.
|
2011-12-13 00:40:51 +01:00
|
|
|
func (f *File) seek(offset int64, whence int) (ret int64, err error) {
|
2011-05-20 02:18:15 +02:00
|
|
|
return syscall.Seek(f.fd, offset, whence)
|
|
|
|
}
|
|
|
|
|
2010-12-03 05:34:57 +01:00
|
|
|
// Truncate changes the size of the named file.
|
|
|
|
// If the file is a symbolic link, it changes the size of the link's target.
|
2011-12-03 03:17:34 +01:00
|
|
|
func Truncate(name string, size int64) error {
|
2011-12-13 00:40:51 +01:00
|
|
|
if e := syscall.Truncate(name, size); e != nil {
|
|
|
|
return &PathError{"truncate", name, e}
|
2010-12-03 05:34:57 +01:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
2011-03-30 17:33:16 +02:00
|
|
|
|
|
|
|
// basename removes trailing slashes and the leading directory name from path name
|
|
|
|
func basename(name string) string {
|
|
|
|
i := len(name) - 1
|
|
|
|
// Remove trailing slashes
|
|
|
|
for ; i > 0 && name[i] == '/'; i-- {
|
|
|
|
name = name[:i]
|
|
|
|
}
|
|
|
|
// Remove leading directory name
|
|
|
|
for i--; i >= 0; i-- {
|
|
|
|
if name[i] == '/' {
|
|
|
|
name = name[i+1:]
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return name
|
|
|
|
}
|
2011-09-16 17:47:21 +02:00
|
|
|
|
|
|
|
// Pipe returns a connected pair of Files; reads from r return bytes written to w.
|
2011-12-03 03:17:34 +01:00
|
|
|
// It returns the files and an error, if any.
|
|
|
|
func Pipe() (r *File, w *File, err error) {
|
2011-09-16 17:47:21 +02:00
|
|
|
var p [2]int
|
|
|
|
|
|
|
|
// See ../syscall/exec.go for description of lock.
|
|
|
|
syscall.ForkLock.RLock()
|
|
|
|
e := syscall.Pipe(p[0:])
|
2011-12-13 00:40:51 +01:00
|
|
|
if e != nil {
|
2011-09-16 17:47:21 +02:00
|
|
|
syscall.ForkLock.RUnlock()
|
|
|
|
return nil, nil, NewSyscallError("pipe", e)
|
|
|
|
}
|
|
|
|
syscall.CloseOnExec(p[0])
|
|
|
|
syscall.CloseOnExec(p[1])
|
|
|
|
syscall.ForkLock.RUnlock()
|
|
|
|
|
|
|
|
return NewFile(p[0], "|0"), NewFile(p[1], "|1"), nil
|
|
|
|
}
|
2011-12-13 00:40:51 +01:00
|
|
|
|
|
|
|
// TempDir returns the default directory to use for temporary files.
|
|
|
|
func TempDir() string {
|
|
|
|
dir := Getenv("TMPDIR")
|
|
|
|
if dir == "" {
|
|
|
|
dir = "/tmp"
|
|
|
|
}
|
|
|
|
return dir
|
|
|
|
}
|