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
|
// Copyright 2018 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package composefs provides a way to compose p9 files and file systems into
// one p9 file server.
package composefs
import (
"errors"
"fmt"
"path/filepath"
"strings"
"github.com/hugelgupf/p9/fsimpl/qids"
"github.com/hugelgupf/p9/fsimpl/readdir"
"github.com/hugelgupf/p9/fsimpl/templatefs"
"github.com/hugelgupf/p9/linux"
"github.com/hugelgupf/p9/p9"
"golang.org/x/exp/maps"
"golang.org/x/exp/slices"
)
var (
ErrFlatHierarchy = errors.New("composefs only supports a flat hierarchy")
ErrFileExists = errors.New("file already exists")
)
type Opt func(fs *FS) error
// FS is a p9.Attacher.
type FS struct {
mounts map[string]p9.File
qids *qids.PathGenerator
}
func WithMount(dir string, attacher p9.Attacher) Opt {
return func(fs *FS) error {
if strings.Contains(dir, string(filepath.Separator)) {
return fmt.Errorf("%w: directories are not supported: %s", ErrFlatHierarchy, dir)
}
if _, ok := fs.mounts[dir]; ok {
return fmt.Errorf("%w: %s", ErrFileExists, dir)
}
f, err := attacher.Attach()
if err != nil {
return err
}
fs.mounts[dir] = qids.NewWrapperFile(f, qids.NewMapper(fs.qids))
return nil
}
}
// WithDir creates a composefs from the given options and mounts it at dir.
func WithDir(dir string, mounts ...Opt) Opt {
return func(fs *FS) error {
subfs, err := New(mounts...)
if err != nil {
return err
}
return WithMount(dir, subfs)(fs)
}
}
func WithFile(file string, f p9.File) Opt {
return func(fs *FS) error {
if strings.Contains(file, "/") {
return fmt.Errorf("%w: directories are not supported: %s", ErrFlatHierarchy, file)
}
if _, ok := fs.mounts[file]; ok {
return fmt.Errorf("%w: %s", ErrFileExists, file)
}
fs.mounts[file] = qids.NewWrapperFile(f, qids.NewMapper(fs.qids))
return nil
}
}
func New(mounts ...Opt) (*FS, error) {
fs := &FS{
mounts: make(map[string]p9.File),
qids: &qids.PathGenerator{},
}
for _, m := range mounts {
if err := m(fs); err != nil {
return nil, err
}
}
return fs, nil
}
type root struct {
p9.DefaultWalkGetAttr
templatefs.ReadOnlyDir
templatefs.NilCloser
fs *FS
}
// Attach implements p9.Attacher.Attach.
func (fs *FS) Attach() (p9.File, error) {
return &root{fs: fs}, nil
}
var (
_ p9.File = &root{}
_ p9.Attacher = &FS{}
)
var (
// PathGenerator leaves Path: 0 unused.
rootQID = p9.QID{Type: p9.TypeDir, Path: 0, Version: 0}
)
// Walk implements p9.File.Walk.
func (r *root) Walk(names []string) ([]p9.QID, p9.File, error) {
if len(names) == 0 {
return nil, &root{fs: r.fs}, nil
}
file, ok := r.fs.mounts[names[0]]
if !ok {
return nil, nil, linux.ENOENT
}
// Even if len(names) == 1, get a cloned p9.File. Never return the
// original root File from r.fs.mounts, because if the caller
// Clunks/Closes it, it may become unusable for walks (e.g. because
// Close closes the underlying os.File object, or whatever).
qids, file, err := file.Walk(names[1:])
if err != nil {
return nil, nil, err
}
// Clones may omit the QID. Since this is not actually a clone from the
// caller's perspective, get the QID.
if len(names) == 1 && len(qids) == 0 {
qid, _, _, err := file.GetAttr(p9.AttrMask{Mode: true})
if err != nil {
return nil, nil, err
}
qids = []p9.QID{qid}
}
return qids, file, nil
}
// Open implements p9.File.Open.
func (r *root) Open(mode p9.OpenFlags) (p9.QID, uint32, error) {
if mode.Mode() != p9.ReadOnly {
return p9.QID{}, 0, linux.EACCES
}
return p9.QID{}, 0, nil
}
// Readdir implements p9.File.Readdir.
func (r *root) Readdir(offset uint64, count uint32) (p9.Dirents, error) {
names := maps.Keys(r.fs.mounts)
slices.Sort(names)
qids := make(map[string]p9.QID)
for _, name := range names {
qid, _, _, err := r.fs.mounts[name].GetAttr(p9.AttrMask{Mode: true})
if err != nil {
return p9.Dirents{}, err
}
qids[name] = qid
}
return readdir.Readdir(offset, count, names, qids)
}
// StatFS implements p9.File.StatFS.
func (*root) StatFS() (p9.FSStat, error) {
return p9.FSStat{}, linux.ENOSYS
}
// GetAttr implements p9.File.GetAttr.
func (r *root) GetAttr(req p9.AttrMask) (p9.QID, p9.AttrMask, p9.Attr, error) {
attr := p9.Attr{
Mode: p9.FileMode(0777) | p9.ModeDirectory,
NLink: p9.NLink(1 + len(r.fs.mounts)),
BlockSize: uint64(4096),
}
return rootQID, req, attr, nil
}
|