1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
|
//go:build linux && cgo
package instancewriter
import (
"archive/tar"
"fmt"
"io"
"os"
"strings"
"golang.org/x/sys/unix"
"github.com/lxc/incus/v6/internal/linux"
"github.com/lxc/incus/v6/shared/idmap"
"github.com/lxc/incus/v6/shared/logger"
)
// InstanceTarWriter provides a TarWriter implementation that handles ID shifting and hardlink tracking.
type InstanceTarWriter struct {
tarWriter *tar.Writer
idmapSet *idmap.Set
linkMap map[uint64]string
}
// NewInstanceTarWriter returns a ContainerTarWriter for the provided target Writer and id map.
func NewInstanceTarWriter(writer io.Writer, idmapSet *idmap.Set) *InstanceTarWriter {
ctw := &InstanceTarWriter{}
ctw.tarWriter = tar.NewWriter(writer)
ctw.idmapSet = idmapSet
ctw.linkMap = map[uint64]string{}
return ctw
}
// ResetHardLinkMap resets the hard link map. Use when copying multiple instances (or snapshots) into a tarball.
// So that the hard link map doesn't work across different instances/snapshots.
func (ctw *InstanceTarWriter) ResetHardLinkMap() {
ctw.linkMap = map[uint64]string{}
}
// WriteFile adds a file to the tarball with the specified name using the srcPath file as the contents of the file.
// The ignoreGrowth argument indicates whether to error if the srcPath file increases in size beyond the size in fi
// during the write. If false the write will return an error. If true, no error is returned, instead only the size
// specified in fi is written to the tarball. This can be used when you don't need a consistent copy of the file.
func (ctw *InstanceTarWriter) WriteFile(name string, srcPath string, fi os.FileInfo, ignoreGrowth bool) error {
var err error
var major, minor uint32
var nlink int
var ino uint64
link := ""
if fi.Mode()&os.ModeSymlink == os.ModeSymlink {
link, err = os.Readlink(srcPath)
if err != nil {
return fmt.Errorf("Failed to resolve symlink for %q: %w", srcPath, err)
}
}
// Sockets cannot be stored in tarballs, just skip them (consistent with tar).
if fi.Mode()&os.ModeSocket == os.ModeSocket {
return nil
}
hdr, err := tar.FileInfoHeader(fi, link)
if err != nil {
return fmt.Errorf("Failed to create tar info header: %w", err)
}
hdr.Name = name
if fi.IsDir() || fi.Mode()&os.ModeSymlink == os.ModeSymlink {
hdr.Size = 0
} else {
hdr.Size = fi.Size()
}
// Get file stat.
var stat unix.Stat_t
err = unix.Lstat(srcPath, &stat)
if err != nil {
return fmt.Errorf("Failed to get file stat: %w", err)
}
hdr.Uid = int(stat.Uid)
hdr.Gid = int(stat.Gid)
ino = stat.Ino
nlink = int(stat.Nlink)
if stat.Mode&unix.S_IFBLK != 0 || stat.Mode&unix.S_IFCHR != 0 {
major = unix.Major(uint64(stat.Rdev))
minor = unix.Minor(uint64(stat.Rdev))
}
// Unshift the id under rootfs/ for unpriv containers.
if strings.HasPrefix(hdr.Name, "rootfs") && ctw.idmapSet != nil {
hUID, hGID := ctw.idmapSet.ShiftFromNS(int64(hdr.Uid), int64(hdr.Gid))
hdr.Uid = int(hUID)
hdr.Gid = int(hGID)
if hdr.Uid == -1 || hdr.Gid == -1 {
return nil
}
}
hdr.Devmajor = int64(major)
hdr.Devminor = int64(minor)
// If it's a hardlink we've already seen use the old name.
if fi.Mode().IsRegular() && nlink > 1 {
firstPath, found := ctw.linkMap[ino]
if found {
hdr.Typeflag = tar.TypeLink
hdr.Linkname = firstPath
hdr.Size = 0
} else {
ctw.linkMap[ino] = hdr.Name
}
}
// Handle xattrs (for real files only).
if link == "" {
xattrs, err := linux.GetAllXattr(srcPath)
if err != nil {
return fmt.Errorf("Failed to read xattr for %q: %w", srcPath, err)
}
hdr.PAXRecords = make(map[string]string, len(xattrs))
for key, val := range xattrs {
if key == "system.posix_acl_access" && ctw.idmapSet != nil {
aclAccess, err := idmap.UnshiftACL(val, ctw.idmapSet)
if err != nil {
logger.Debugf("Failed to unshift ACL access permissions of %q: %v", srcPath, err)
continue
}
val = aclAccess
} else if key == "system.posix_acl_default" && ctw.idmapSet != nil {
aclDefault, err := idmap.UnshiftACL(val, ctw.idmapSet)
if err != nil {
logger.Debugf("Failed to unshift ACL default permissions of %q: %v", srcPath, err)
continue
}
val = aclDefault
} else if key == "security.capability" && ctw.idmapSet != nil {
vfsCaps, err := idmap.UnshiftCaps(val, ctw.idmapSet)
if err != nil {
logger.Debugf("Failed to unshift VFS capabilities of %q: %v", srcPath, err)
continue
}
val = vfsCaps
}
hdr.PAXRecords["SCHILY.xattr."+key] = val
}
}
err = ctw.tarWriter.WriteHeader(hdr)
if err != nil {
return fmt.Errorf("Failed to write tar header: %w", err)
}
if hdr.Typeflag == tar.TypeReg {
f, err := os.Open(srcPath)
if err != nil {
return fmt.Errorf("Failed to open file %q: %w", srcPath, err)
}
defer func() { _ = f.Close() }()
r := io.Reader(f)
if ignoreGrowth {
r = io.LimitReader(r, fi.Size())
}
_, err = io.Copy(ctw.tarWriter, r)
if err != nil {
return fmt.Errorf("Failed to copy file content %q: %w", srcPath, err)
}
err = f.Close()
if err != nil {
return fmt.Errorf("Failed to close file %q: %w", srcPath, err)
}
}
return nil
}
// WriteFileFromReader streams a file into the tarball using the src reader.
// A manually generated os.FileInfo should be supplied so that the tar header can be added before streaming starts.
func (ctw *InstanceTarWriter) WriteFileFromReader(src io.Reader, fi os.FileInfo) error {
hdr, err := tar.FileInfoHeader(fi, "")
if err != nil {
return fmt.Errorf("Failed to create tar info header: %w", err)
}
err = ctw.tarWriter.WriteHeader(hdr)
if err != nil {
return fmt.Errorf("Failed to write tar header: %w", err)
}
_, err = io.Copy(ctw.tarWriter, src)
return err
}
// Close finishes writing the tarball.
func (ctw *InstanceTarWriter) Close() error {
err := ctw.tarWriter.Close()
if err != nil {
return fmt.Errorf("Failed to close tar writer: %w", err)
}
return nil
}
|