Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
archive/tar: add Header.DetectSparseHoles and Header.PunchSparseHoles
To support the detection and creation of sparse files, add two new methods: func Header.DetectSparseHoles(*os.File) error func Header.PunchSparseHoles(*os.File) error DetectSparseHoles is intended to be used after FileInfoHeader prior to serializing the Header with WriteHeader. For each OS, it uses specialized logic to detect the location of sparse holes. On most Unix systems, it uses SEEK_HOLE and SEEK_DATA to query for the holes. On Windows, it uses a specialized the FSCTL_QUERY_ALLOCATED_RANGES syscall to query for all the holes. PunchSparseHoles is intended to be used after Reader.Next prior to populating the file with Reader.WriteTo. On Windows, this uses the FSCTL_SET_ZERO_DATA syscall. On other operating systems it simply truncates the file to the end-offset of SparseHoles. DetectSparseHoles and PunchSparseHoles are added as methods on Header because they are heavily tied to the operating system, for which there is already an existing precedence for (since FileInfoHeader makes uses of OS-specific details). Fixes #13548 Change-Id: I98a321dd1ce0165f3d143d4edadfda5e7db67746 Reviewed-on: https://go-review.googlesource.com/60871 Run-TryBot: Joe Tsai <thebrokentoaster@gmail.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Ian Lance Taylor <iant@golang.org>
- Loading branch information
Showing
7 changed files
with
416 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
// Copyright 2017 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. | ||
|
||
// +build linux darwin dragonfly freebsd openbsd netbsd solaris | ||
|
||
package tar | ||
|
||
import ( | ||
"io" | ||
"os" | ||
"syscall" | ||
) | ||
|
||
func init() { | ||
sysSparseDetect = sparseDetectUnix | ||
} | ||
|
||
func sparseDetectUnix(f *os.File) (sph sparseHoles, err error) { | ||
// SEEK_DATA and SEEK_HOLE originated from Solaris and support for it | ||
// has been added to most of the other major Unix systems. | ||
const seekData = 3 // SEEK_DATA from unistd.h | ||
const seekHole = 4 // SEEK_HOLE from unistd.h | ||
|
||
// Check for seekData/seekHole support. | ||
if _, err := f.Seek(0, seekHole); errno(err) == syscall.EINVAL { | ||
return nil, nil // Either old kernel or FS does not support this | ||
} | ||
|
||
// Populate the SparseHoles. | ||
var last, pos int64 = -1, 0 | ||
for { | ||
// Get the location of the next hole section. | ||
if pos, err = fseek(f, pos, seekHole); pos == last || err != nil { | ||
return sph, err | ||
} | ||
offset := pos | ||
last = pos | ||
|
||
// Get the location of the next data section. | ||
if pos, err = fseek(f, pos, seekData); pos == last || err != nil { | ||
return sph, err | ||
} | ||
length := pos - offset | ||
last = pos | ||
|
||
if length > 0 { | ||
sph = append(sph, SparseEntry{offset, length}) | ||
} | ||
} | ||
} | ||
|
||
func fseek(f *os.File, pos int64, whence int) (int64, error) { | ||
pos, err := f.Seek(pos, whence) | ||
if errno(err) == syscall.ENXIO { | ||
// SEEK_DATA returns ENXIO when past the last data fragment, | ||
// which makes determining the size of the last hole difficult. | ||
pos, err = f.Seek(0, io.SeekEnd) | ||
} | ||
return pos, err | ||
} | ||
|
||
func errno(err error) error { | ||
if perr, ok := err.(*os.PathError); ok { | ||
return perr.Err | ||
} | ||
return err | ||
} |
Oops, something went wrong.